Update readme.md (#53)

* chore: add api-gov workflow

* chore: add on

* chore: add jobs

.github/workflows/api-gov.yml

@@ -0,0 +1,38 @@
+name: "API Governance"
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        type: string
+        description: Version to run against
+        default: ''
+      SHA:
+        type: string
+        description: Sha of tag
+        default: ''
+
+jobs:
+  api-gov:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Prepare API Compliance
+        shell: bash
+        run: |
+          docker pull ghcr.io/qlik-download/api-compliance
+          docker create -v /specs --name specs alpine:3.4 /bin/true
+          docker cp api-specifications/properties.json specs:/specs/properties.json
+
+      - name: Run API Compliance
+        shell: bash
+        run: |
+          docker run --volumes-from specs \
+              -e SPEC_PATHS="${{ secrets.API_KEY }}@/specs/properties.json" \
+              -e COMMIT_SHA="${{ inputs.SHA }}" \
+              -e RELEASE_TAG="${{ inputs.VERSION }}" \
+              -e CREDENTIALS_S3_SECRETKEY="${{ secrets.APICULTURIST_S3 }}" \
+              -e CREDENTIALS_GITHUB="${{ secrets.APICULTURIST_GITHUB }}" \
+              -e CREDENTIALS_COLONY="${{ secrets.APICULTURIST_TOKEN }}" \
+              ghcr.io/qlik-download/api-compliance

api-specifications/properties.json

@@ -3,15 +3,18 @@
   "info": {
     "name": "@nebula.js/sn-network-chart:properties",
     "description": "Network chart generic object definition",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "license": "MIT",
-    "stability": "experimental",
+    "stability": "stable",
     "x-qlik-visibility": "public"
   },
   "entries": {
     "properties": {
-      "kind": "function",
-      "params": [],
+      "extends": [
+        {
+          "type": "GenericObjectProperties"
+        }
+      ],
       "entries": {
         "version": {
           "description": "Current version of this generic object definition",
@@ -21,7 +24,7 @@
           "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
           "extends": [
             {
-              "type": "HyperCubeDef"
+              "type": "EngineAPI.HyperCubeDef"
             }
           ],
           "kind": "object"
@@ -157,7 +160,8 @@
           "defaultValue": false,
           "type": "boolean"
         }
-      }
+      },
+      "kind": "object"
     }
   },
   "definitions": {}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/sn-network-chart",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Displays hierarchical or relational dimensions as nodes and edges´, with measures to show the significance of its links.",
   "homepage": "",
   "repository": "https://github.com/qlik-oss/network-vis-chart",

readme.md

@@ -1,3 +1,8 @@
+> **Warning** This repository is now archived and will not be updated
+
+> This repository was originally published to foster collaboration and engagement with developers as they customized or developed visualizations, but due to customer feedback and usage data, it is now moved back to closed source. Moving this and other projects back to closed source will support better integration with internal build and test tooling, and free up resources for investment in these and other visualizations.
+
+
 # sn-network-chart
 
 A network chart to be used with nebula.js, built using [visjs network visualization](https://github.com/visjs/vis-network) to display networks of nodes and edges.

spec-configs/props.conf.js

@@ -1,27 +1,48 @@
-const path = require('path');
+const path = require("path");
 
-const pkg = require(path.resolve(__dirname, '../package.json')); // eslint-disable-line
+const pkg = require(path.resolve(__dirname, "../package.json")); // eslint-disable-line
 
 module.exports = {
-  glob: ["./src/extension/properties.js"],
-  package: path.resolve(__dirname, "../package.json"),
-  api: {
-    stability: "experimental",
-    properties: {
-      "x-qlik-visibility": "public",
+  fromJsdoc: {
+    glob: ["./src/extension/properties.js"],
+    api: {
+      stability: "stable",
+      visibility: "public",
+      properties: {
+        "x-qlik-visibility": "public",
+      },
+      name: `${pkg.name}:properties`,
+      version: pkg.version,
+      description: "Network chart generic object definition",
+    },
+    output: {
+      sort: {
+        alpha: false,
+      },
+      file: "./api-specifications/properties.json",
+    },
+    parse: {
+      types: {
+        GenericObjectProperties: {
+          url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties",
+        },
+        undefined: {},
+        "EngineAPI.ValueExpression": {
+          url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FValueExpression",
+        },
+        "EngineAPI.HyperCubeDef": {
+          url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FListObjectDef",
+        },
+      },
     },
-    visibility: "public",
-    name: `${pkg.name}:properties`,
-    version: pkg.version,
-    description: "Network chart generic object definition",
   },
-  output: {
-    file: path.resolve(__dirname, "../api-specifications/properties.json"),
-  },
-  parse: {
-    types: {
-      NxMeasure: {},
-      HyperCubeDef: {},
+  toDts: {
+    spec: "./api-specifications/properties.json",
+    output: {
+      file: "./types/index.d.ts",
+    },
+    dependencies: {
+      references: ["qlik-engineapi"],
     },
   },
 };

src/extension/properties.js

@@ -1,5 +1,6 @@
 /**
- * @typedef {object}
+ * @type {object}
+ * @extends {GenericObjectProperties}
  * @entry
  */
 const properties = {
@@ -10,7 +11,7 @@ const properties = {
   version: process.env.PACKAGE_VERSION,
   /**
    * Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
-   * @extends {HyperCubeDef}
+   * @extends {EngineAPI.HyperCubeDef}
    */
   qHyperCubeDef: {
     qDimensions: [],