chore: rename package to sn-network-chart

.circleci/config.yml

@@ -31,7 +31,7 @@ jobs:
             --detect.project.name="viz-bundle-qlik-network-chart"
       - run:
           name: Build
-          command: yarn build
+          command: yarn build && yarn sense
           environment:
             NODE_ENV: production
       - store_artifacts:

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/
 BUMPED_VERSION
+sn-network-chart-ext/

api-specifications/properties.json

@@ -0,0 +1,136 @@
+{
+  "scriptappy": "1.0.0",
+  "info": {
+    "name": "sn-network-chart:properties",
+    "description": "Network chart generic object definition",
+    "version": "0.0.1",
+    "license": "MIT",
+    "stability": "experimental",
+    "x-qlik-visibility": "public"
+  },
+  "entries": {},
+  "definitions": {
+    "module.exports.displayEdgeLabel": {
+      "optional": true,
+      "defaultValue": false,
+      "type": "boolean"
+    },
+    "module.exports.edgeType": {
+      "optional": true,
+      "defaultValue": "dynamic",
+      "kind": "union",
+      "items": [
+        {
+          "kind": "literal",
+          "value": "'dynamic'"
+        },
+        {
+          "kind": "literal",
+          "value": "'continuous'"
+        },
+        {
+          "kind": "literal",
+          "value": "'discrete'"
+        },
+        {
+          "kind": "literal",
+          "value": "'diagonalCross'"
+        },
+        {
+          "kind": "literal",
+          "value": "'straightCross'"
+        },
+        {
+          "kind": "literal",
+          "value": "'horizontal'"
+        },
+        {
+          "kind": "literal",
+          "value": "'vertical'"
+        },
+        {
+          "kind": "literal",
+          "value": "'curvedCW'"
+        },
+        {
+          "kind": "literal",
+          "value": "'curvedCCW'"
+        },
+        {
+          "kind": "literal",
+          "value": "'cubicBezier'"
+        }
+      ],
+      "type": "string"
+    },
+    "module.exports.nodeShape": {
+      "optional": true,
+      "defaultValue": "dot",
+      "kind": "union",
+      "items": [
+        {
+          "kind": "literal",
+          "value": "'dot'"
+        },
+        {
+          "kind": "literal",
+          "value": "'square'"
+        },
+        {
+          "kind": "literal",
+          "value": "'star'"
+        },
+        {
+          "kind": "literal",
+          "value": "'triangle'"
+        },
+        {
+          "kind": "literal",
+          "value": "'triangleDown'"
+        },
+        {
+          "kind": "literal",
+          "value": "'diamond'"
+        }
+      ],
+      "type": "string"
+    },
+    "module.exports.posEdgeLabel": {
+      "optional": true,
+      "defaultValue": "top",
+      "kind": "union",
+      "items": [
+        {
+          "kind": "literal",
+          "value": "'top'"
+        },
+        {
+          "kind": "literal",
+          "value": "'middle'"
+        },
+        {
+          "kind": "literal",
+          "value": "'bottom'"
+        },
+        {
+          "kind": "literal",
+          "value": "'horizontal'"
+        }
+      ],
+      "type": "string"
+    },
+    "module.exports.qHyperCubeDef": {
+      "kind": "object",
+      "entries": {}
+    },
+    "module.exports.shadowMode": {
+      "optional": true,
+      "defaultValue": false,
+      "type": "boolean"
+    },
+    "module.exports.version": {
+      "description": "Current version of this generic object definition",
+      "type": "string"
+    }
+  }
+}

package.json

@@ -1,18 +1,27 @@
 {
-  "name": "qlik-network-chart",
+  "name": "sn-network-chart",
   "version": "0.0.1",
   "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",
-  "author": "Michael Laenen (miclae76) <m.laenen@contactoffice.net>",
+  "author": "QLIK",
   "license": "MIT",
   "scripts": {
-    "start": "nebula serve  --build false  --type qlik-network-chart",
+    "start": "nebula serve --build false --type qlik-network-chart",
-    "watch": "nebula serve --type qlik-network-chart",
+    "watch": "nebula serve --type sn-network-chart",
-    "build": "nebula build ",
+    "watch:legacy": "nebula serve --type qlik-network-chart",
-    "eslint": "eslint src"
+    "build": "nebula build",
+    "sense": "nebula sense --meta resources/meta.json",
+    "eslint": "eslint src",
+    "spec": "scriptappy-from-jsdoc -c ./spec-configs/props.conf.js"
   },
-  "main": "dist/qlik-network-chart.js",
+  "files": [
+    "api-specifications",
+    "dist",
+    "core",
+    "sn-network-chart-ext"
+  ],
+  "main": "dist/sn-network-chart.js",
   "devDependencies": {
     "@nebula.js/cli": "1.7.0",
     "@nebula.js/cli-build": "1.7.0",
@@ -20,13 +29,12 @@
     "@nebula.js/cli-serve": "1.7.0",
     "@nebula.js/stardust": "1.7.0",
     "babel-eslint": "10.1.0",
-    "eslint": "7.32.0"
+    "scriptappy-from-jsdoc": "^0.7.0",
+    "eslint": "7.32.0",
+    "vis-network": "9.1.0",
+    "vis-data": "^7.0.0"
   },
   "peerDependencies": {
     "@nebula.js/stardust": ">=1.0.0"
-  },
-  "dependencies": {
-    "vis-network": "9.1.0",
-    "vis-data": "^7.0.0"
   }
 }

resources/meta.json

@@ -0,0 +1,4 @@
+{
+  "name": "Network chart",
+  "icon": "bubbles"
+}

spec-configs/props.conf.js

@@ -0,0 +1,26 @@
+const path = require('path');
+
+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',
+    },
+    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: {},
+    },
+  },
+};

src/extension/properties.js

@@ -1,5 +1,12 @@
 export default {
-  version: 1.0,
+  /**
+   * Current version of this generic object definition
+   * @type {string}
+   */
+  version: process.env.PACKAGE_VERSION,
+  /**
+   * @typedef
+   */
   qHyperCubeDef: {
     qDimensions: [],
     qMeasures: [],
@@ -8,9 +15,24 @@ export default {
       qHeight: 1400
     }]
   },
+  /**
+   * @type {('dynamic'|'continuous'|'discrete'|'diagonalCross'|'straightCross'|'horizontal'|'vertical'|'curvedCW'|'curvedCCW'|'cubicBezier')=}
+   */
   edgeType: "dynamic",
+  /**
+   * @type {boolean=}
+   */
   displayEdgeLabel: false,
+  /**
+   * @type {('top'|'middle'|'bottom'|'horizontal')=}
+   */
   posEdgeLabel: "top",
+  /**
+   * @type {('dot'|'square'|'star'|'triangle'|'triangleDown'|'diamond')=}
+   */
   nodeShape: "dot",
+  /**
+   * @type {boolean=}
+   */
   shadowMode: false,
 };