chore: specs and stuff

.github/workflows/build.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build:
-    uses: qlik-oss/sn-gh-workflows/.github/workflows/build.yaml@v1
+    uses: qlik-oss/sn-gh-workflows/.github/workflows/build.yaml@v2
     secrets: inherit
     with:
       release: ${{ inputs.release || false}}

api-spec/props.conf.js

@@ -0,0 +1,48 @@
+const path = require("path");
+
+const pkg = require(path.resolve(__dirname, "../package.json")); // eslint-disable-line
+
+module.exports = {
+  fromJsdoc: {
+    glob: ["./src/ext/initial-properties.js"],
+    api: {
+      stability: "stable",
+      visibility: "public",
+      properties: {
+        "x-qlik-visibility": "public",
+      },
+      name: `${pkg.name}:properties`,
+      version: pkg.version,
+      description: "Variance waterfall 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",
+        },
+      },
+    },
+  },
+  toDts: {
+    spec: "./api-specifications/properties.json",
+    output: {
+      file: "./types/index.d.ts",
+    },
+    dependencies: {
+      references: ["qlik-engineapi"],
+    },
+  },
+};

api-specifications/properties.json

@@ -0,0 +1,72 @@
+{
+  "scriptappy": "1.1.0",
+  "info": {
+    "name": "@nebula/sn-variance-waterfall:properties",
+    "description": "Variance waterfall generic object definition",
+    "version": "0.0.1",
+    "license": "MIT",
+    "stability": "stable",
+    "x-qlik-visibility": "public"
+  },
+  "entries": {
+    "properties": {
+      "extends": [
+        {
+          "type": "GenericObjectProperties"
+        }
+      ],
+      "entries": {
+        "version": {
+          "description": "Current version of this generic object definition",
+          "type": "string"
+        },
+        "qHyperCubeDef": {
+          "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
+          "extends": [
+            {
+              "type": "EngineAPI.HyperCubeDef"
+            }
+          ],
+          "kind": "object"
+        },
+        "showTitles": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "title": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "subtitle": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "footnote": {
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "disableNavMenu": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "showDetails": {
+          "optional": true,
+          "defaultValue": true,
+          "type": "boolean"
+        },
+        "showDetailsExpression": {
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        }
+      },
+      "kind": "object"
+    }
+  },
+  "definitions": {}
+}

core/package.json

@@ -1,6 +1,10 @@
 {
   "module": "esm/index.js",
   "peerDependencies": {
-    "@nebula.js/stardust": ">=2.0.0"
+    "@nebula.js/stardust": ">=4.6.1",
+    "hammerjs": "^2.0.8",
+    "picasso-plugin-hammer": ">=2.2.5",
+    "picasso-plugin-q": ">=2.2.5",
+    "picasso.js": ">=2.2.5"
   }
 }

src/ext/initial-properties.js

@@ -1,12 +1,18 @@
 // TODO: Fill in the rest of the json spec
-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: [],
@@ -105,3 +111,5 @@ export default {
     dock: "near",
   },
 };
+
+export default properties;

src/utils/initialize.js

@@ -33,7 +33,7 @@ export default function init({
   const chart = pic.chart({
     element,
     updated: () => {
-      //$scope.updated = true; // NEED TO CHECK WHAT THESE ARE FOR?
+      //$scope.updated = true; // TODO: NEED TO CHECK WHAT THESE ARE FOR?
     },
     beforeUpdated: () => {
       //$scope.updated = false;