Update readme.md (#53)

* chore: add api-gov workflow

* chore: add on

* chore: add jobs

.circleci/config.yml

@@ -1,45 +0,0 @@
-version: 2
-
-defaults: &defaults
-  working_directory: ~/qlik-network-chart
-  docker:
-    - image: circleci/node:stretch
-  environment:
-    GITHUB_ORG: "qlik-oss"
-    GITHUB_REPO: "network-vis-chart"
-    PACKAGE_NAME: "qlik-network-chart"
-
-jobs:
-  build:
-    docker:
-    - image: circleci/node:stretch-browsers
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: yarn
-      - run:
-          name: Lint
-          command: yarn eslint
-      - run:
-          name: BlackDuck scan
-          command: curl -s https://detect.synopsys.com/detect.sh | bash -s -- \
-            --blackduck.url="https://qliktech.blackducksoftware.com" \
-            --blackduck.trust.cert=true \
-            --blackduck.username="svc-blackduck" \
-            --blackduck.password=${svc_blackduck} \
-            --detect.project.name="viz-bundle-qlik-network-chart"
-      - run:
-          name: Build
-          command: yarn build && yarn sense
-          environment:
-            NODE_ENV: production
-      - store_artifacts:
-          path: dist
-          destination: dist
-
-workflows:
-  version: 2
-  master_flow:
-    jobs:
-      - build

.codeclimate.yml

@@ -0,0 +1,19 @@
+version: "2"
+checks:
+  method-lines:
+    config:
+      threshold: 100
+  method-complexity:
+    config:
+      threshold: 10
+  similar-code:
+    config:
+      threshold: 65
+  identical-code:
+    config:
+      threshold: 65
+exclude_patterns:
+  - "src/**/*.test.ts"
+  - "src/**/*.test.tsx"
+  - "*config*"
+  - "test/**/__fixtures__"

.eslintrc.js

@@ -3,15 +3,15 @@ module.exports = {
     ecmaVersion: 6,
     ecmaFeatures: {
       jsx: true,
-      modules: true
+      modules: true,
     },
-    sourceType: "module"
+    sourceType: "module",
   },
-  parser: "babel-eslint",
+  parser: "@babel/eslint-parser",
   env: {
     browser: true,
     es6: true,
-    node: true
+    node: true,
   },
   globals: {
     $: false,
@@ -21,41 +21,48 @@ module.exports = {
     document: false,
     expect: false,
     it: false,
-    require: false
+    require: false,
   },
   rules: {
-    "indent": ["error", 2, { "SwitchCase": 1 }],
+    indent: ["error", 2, { SwitchCase: 1 }],
     "linebreak-style": ["error", "unix"],
     "object-curly-spacing": ["error", "always"],
     "max-lines": ["warn", 300],
     "max-len": ["warn", 120],
     "no-console": ["warn"],
-    "no-mixed-operators": ["warn", {
-      "groups": [
-        ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
-        ["&&", "||"],
-        ["in", "instanceof"]
-      ],
-      "allowSamePrecedence": true
-    }],
+    "no-mixed-operators": [
+      "warn",
+      {
+        groups: [
+          ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+          ["&&", "||"],
+          ["in", "instanceof"],
+        ],
+        allowSamePrecedence: true,
+      },
+    ],
     "no-multi-spaces": ["error"],
     "no-cond-assign": ["warn"],
     "no-fallthrough": ["warn"],
     "no-undef": ["warn"],
     "no-unused-vars": ["error"],
-    "no-use-before-define": ["warn", { "functions": false, "classes": false, "variables": false }],
+    "no-use-before-define": [
+      "warn",
+      { functions: false, classes: false, variables: false },
+    ],
     "no-useless-escape": ["warn"],
     "no-useless-return": ["warn"],
-    "no-underscore-dangle": ["warn", { "allow": ["_id"] }],
+    "no-underscore-dangle": ["warn", { allow: ["_id"] }],
     "no-redeclare": ["warn"],
     "no-restricted-syntax": ["warn"],
     "operator-linebreak": ["warn", "before"],
     "prefer-promise-reject-errors": ["warn"],
-    "padded-blocks": ["warn", { "blocks": "never", "switches": "never", "classes": "never" }],
-    "semi": ["error", "always"],
-    "valid-typeof": ["warn"]
+    "padded-blocks": [
+      "warn",
+      { blocks: "never", switches: "never", classes: "never" },
+    ],
+    semi: ["error", "always"],
+    "valid-typeof": ["warn"],
   },
-  extends: [
-    "eslint:recommended"
-  ]
-}
+  extends: ["eslint:recommended"],
+};

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "yarn" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.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

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build
+on:
+  workflow_dispatch:
+    inputs:
+      release:
+        type: boolean
+        required: true
+        default: false
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    uses: qlik-oss/sn-gh-workflows/.github/workflows/build.yaml@v1
+    secrets: inherit
+    with:
+      release: ${{ inputs.release || false}}
+      api_specification_path: api-specifications/properties.json

.github/workflows/semantic.yml

@@ -0,0 +1,17 @@
+name: "Semantic PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -3,3 +3,5 @@ dist/
 BUMPED_VERSION
 sn-network-chart-ext/
 core/esm
+coverage
+yarn-error.log

api-specifications/properties.json

@@ -1,136 +1,168 @@
 {
-  "scriptappy": "1.0.0",
+  "scriptappy": "1.1.0",
   "info": {
-    "name": "sn-network-chart:properties",
+    "name": "@nebula.js/sn-network-chart:properties",
     "description": "Network chart generic object definition",
-    "version": "0.0.1",
+    "version": "1.0.4",
     "license": "MIT",
-    "stability": "experimental",
+    "stability": "stable",
     "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": [
+  "entries": {
+    "properties": {
+      "extends": [
         {
-          "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": "GenericObjectProperties"
         }
       ],
-      "type": "string"
-    },
-    "module.exports.nodeShape": {
-      "optional": true,
-      "defaultValue": "dot",
-      "kind": "union",
-      "items": [
-        {
-          "kind": "literal",
-          "value": "'dot'"
+      "entries": {
+        "version": {
+          "description": "Current version of this generic object definition",
+          "type": "string"
         },
-        {
-          "kind": "literal",
-          "value": "'square'"
+        "qHyperCubeDef": {
+          "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
+          "extends": [
+            {
+              "type": "EngineAPI.HyperCubeDef"
+            }
+          ],
+          "kind": "object"
         },
-        {
-          "kind": "literal",
-          "value": "'star'"
+        "showTitles": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
         },
-        {
-          "kind": "literal",
-          "value": "'triangle'"
+        "title": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
         },
-        {
-          "kind": "literal",
-          "value": "'triangleDown'"
+        "subtitle": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
         },
-        {
-          "kind": "literal",
-          "value": "'diamond'"
+        "footnote": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "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'"
+            }
+          ]
+        },
+        "displayEdgeLabel": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "posEdgeLabel": {
+          "optional": true,
+          "defaultValue": "top",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'top'"
+            },
+            {
+              "kind": "literal",
+              "value": "'middle'"
+            },
+            {
+              "kind": "literal",
+              "value": "'bottom'"
+            },
+            {
+              "kind": "literal",
+              "value": "'horizontal'"
+            }
+          ]
+        },
+        "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'"
+            }
+          ]
+        },
+        "shadowMode": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
         }
-      ],
-      "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"
+      },
+      "kind": "object"
     }
-  }
+  },
+  "definitions": {}
 }

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ['@babel/preset-env'],
+};

jest.config.js

@@ -0,0 +1,196 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/dc/j98t7yvj11n21psdq_xy0y8snk5538/T/jest_tq54ko",
+
+  // Automatically clear mock calls, instances and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  setupFilesAfterEnv: ["<rootDir>/jest/setup.js"],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "jsdom",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  //"**/src/**/__tests__/*.test.ts?(x)",
+  testMatch: ["<rootDir>/src/_test/*.jest.test.js?(x)"],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+
+  moduleNameMapper: {
+    "\\.(css|less)$": "<rootDir>/src/tests/jest/mocks/css-mock.js"
+  }
+};

jest/setup.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/sn-network-chart",
-  "version": "0.1.0",
+  "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",
@@ -13,8 +13,8 @@
     "build": "nebula build --core core",
     "sense": "nebula sense --meta resources/meta.json && shx cp resources/network_chart_v1.png sn-network-chart-ext",
     "eslint": "eslint src",
-    "spec": "scriptappy-from-jsdoc -c ./spec-configs/props.conf.js",
-    "prepublishOnly": "shx rm -rf dist && shx rm -rf core/esm && shx rm -rf sn-network-chart-ext && yarn build && yarn sense"
+    "spec": "sy from-jsdoc -c ./spec-configs/props.conf.js",
+    "test:unit": "jest"
   },
   "files": [
     "api-specifications",
@@ -23,20 +23,26 @@
     "sn-network-chart-ext"
   ],
   "main": "dist/sn-network-chart.js",
+  "systemjs": "dist/sn-network-chart.systemjs.js",
   "devDependencies": {
-    "@nebula.js/cli": "1.7.0",
-    "@nebula.js/cli-build": "1.7.0",
-    "@nebula.js/cli-sense": "1.7.0",
-    "@nebula.js/cli-serve": "1.7.0",
-    "@nebula.js/stardust": "1.7.0",
-    "babel-eslint": "10.1.0",
-    "scriptappy-from-jsdoc": "^0.7.0",
-    "eslint": "7.32.0",
-    "shx": "^0.3.3",
-    "vis-network": "9.1.0",
-    "vis-data": "^7.0.0"
+    "@nebula.js/cli": "4.0.3",
+    "@nebula.js/cli-build": "4.0.3",
+    "@nebula.js/cli-sense": "4.0.3",
+    "@nebula.js/cli-serve": "4.0.3",
+    "@nebula.js/stardust": "4.0.3",
+    "@testing-library/jest-dom": "5.16.5",
+    "@babel/eslint-parser": "7.21.8",
+    "eslint": "8.40.0",
+    "jest": "29.5.0",
+    "jest-environment-jsdom": "29.5.0",
+    "jest-junit": "^16.0.0",
+    "@scriptappy/cli": "0.8.0",
+    "@scriptappy/from-jsdoc": "0.17.0",
+    "shx": "0.3.4",
+    "vis-data": "7.1.6",
+    "vis-network": "9.1.6"
   },
   "peerDependencies": {
-    "@nebula.js/stardust": ">=1.0.0"
+    "@nebula.js/stardust": ">=1.7.0"
   }
 }

readme.md

@@ -1,6 +1,11 @@
-# @nebula.js/sn-network-chart
+> **Warning** This repository is now archived and will not be updated
 
-The network chart is built using [visjs network visualization](https://github.com/visjs/vis-network) to display networks of nodes and edges. It was originally forked from [miclae76/network-vis-chart](miclae76/network-vis-chart) and has since been converted to use Nebula.
+> 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.
 
 ## Requirements
 

readme_legacy.md

@@ -0,0 +1,4 @@
+## Legacy build
+The chart before Nebula conversion and dependency updates can be found on the *release/legacy* branch.
+
+Originally forked from [miclae76/network-vis-chart](miclae76/network-vis-chart) and has since been converted to use Nebula.

spec-configs/props.conf.js

@@ -1,26 +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: {},
+  toDts: {
+    spec: "./api-specifications/properties.json",
+    output: {
+      file: "./types/index.d.ts",
+    },
+    dependencies: {
+      references: ["qlik-engineapi"],
     },
   },
 };

src/_test/tooltip.jest.test.js

@@ -0,0 +1,11 @@
+import { createTooltipHTML } from "../tooltip";
+
+describe("createTooltipHTML", () => {
+  it("Testing createTooltipHtml function - Name- GroupNumber- nodeMeasure", () => {
+    expect(
+      createTooltipHTML({ name: "Venice", groupNumber: 1, nodeMeasure: 2 })
+    ).toContainHTML(
+      "<div><div><span>Name: </span><b>Venice</b></div><div><span>Group number: </span><b>1</b></div><div><span>Node measure: </span><b>2</b></div></div>"
+    );
+  });
+});

src/extension/properties.js

@@ -1,36 +1,44 @@
-export default {
+/**
+ * @type {object}
+ * @extends {GenericObjectProperties}
+ * @entry
+ */
+const properties = {
   /**
    * Current version of this generic object definition
    * @type {string}
    */
   version: process.env.PACKAGE_VERSION,
   /**
-   * @typedef
+   * Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
+   * @extends {EngineAPI.HyperCubeDef}
    */
   qHyperCubeDef: {
     qDimensions: [],
     qMeasures: [],
-    qInitialDataFetch: [{
-      qWidth: 7,
-      qHeight: 1400
-    }]
+    qInitialDataFetch: [
+      {
+        qWidth: 7,
+        qHeight: 1400,
+      },
+    ],
   },
   /**
-  * @type {boolean=}
-  */
+   * @type {boolean=}
+   */
   showTitles: false,
   /**
-  * @type {string=}
-  */
-  title: '',
+   * @type {string=}
+   */
+  title: "",
   /**
-  * @type {string=}
-  */
-  subtitle: '',
+   * @type {string=}
+   */
+  subtitle: "",
   /**
-  * @type {string=}
-  */
-  footnote: '',
+   * @type {string=}
+   */
+  footnote: "",
   /**
    * @type {('dynamic'|'continuous'|'discrete'|'diagonalCross'|'straightCross'|'horizontal'|'vertical'|'curvedCW'|'curvedCCW'|'cubicBezier')=}
    */
@@ -51,4 +59,6 @@ export default {
    * @type {boolean=}
    */
   shadowMode: false,
-};
+};
+
+export default properties;

src/tooltip.js

@@ -24,5 +24,5 @@ export function createTooltipHTML({ name, groupNumber, nodeMeasure }) {
   tooltip.appendChild(groupNumberEntry);
   tooltip.appendChild(nodeMeasureEntry);
 
-  return tooltip.innerHTML;
+  return tooltip;
 }