@nebula.js/stardust 4.0.0-alpha.1 → 4.0.0-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-alpha.10",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -34,25 +34,27 @@
     "build:dev": "rollup --config ../../rollup.config.js",
     "build:watch": "rollup --config ../../rollup.config.js -w",
     "prepublishOnly": "rm -rf dist && yarn run build",
-    "spec": "sy from-jsdoc -c ./api-spec/spec.conf.js",
+    "spec:stardust": "sy from-jsdoc -c ./api-spec/spec.conf.js",
+    "spec:listbox": "sy from-jsdoc -c ./api-spec/listbox-spec.conf.js",
+    "spec": "yarn run spec:stardust && yarn run spec:listbox",
     "ts": "sy to-dts -c ./api-spec/spec.conf.js",
-    "version": "yarn run spec && yarn run ts && git add ./api-spec/spec.json ./types/index.d.ts"
+    "version": "yarn run spec && yarn run ts && git add ./api-spec/spec.json ./api-spec/listbox-spec.json ./types/index.d.ts"
   },
   "dependencies": {
     "@types/qlik-engineapi": "12.67.12"
   },
   "devDependencies": {
-    "@emotion/react": "^11.10.6",
-    "@emotion/styled": "^11.10.6",
-    "@mui/icons-material": "^5.11.11",
-    "@mui/material": "^5.11.11",
-    "@nebula.js/conversion": "^4.0.0-alpha.1",
-    "@nebula.js/enigma-mocker": "^4.0.0-alpha.1",
-    "@nebula.js/locale": "^4.0.0-alpha.1",
-    "@nebula.js/nucleus": "^4.0.0-alpha.1",
-    "@nebula.js/supernova": "^4.0.0-alpha.1",
-    "@nebula.js/theme": "^4.0.0-alpha.1",
-    "@nebula.js/ui": "^4.0.0-alpha.1",
+    "@emotion/react": "^11.10.8",
+    "@emotion/styled": "^11.10.8",
+    "@mui/icons-material": "^5.11.16",
+    "@mui/material": "^5.12.3",
+    "@nebula.js/conversion": "^4.0.0-alpha.10",
+    "@nebula.js/enigma-mocker": "^4.0.0-alpha.10",
+    "@nebula.js/locale": "^4.0.0-alpha.10",
+    "@nebula.js/nucleus": "^4.0.0-alpha.10",
+    "@nebula.js/supernova": "^4.0.0-alpha.10",
+    "@nebula.js/theme": "^4.0.0-alpha.10",
+    "@nebula.js/ui": "^4.0.0-alpha.10",
     "@scriptappy/cli": "0.6.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
     "extend": "3.0.2",
@@ -60,11 +62,11 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-test-renderer": "18.2.0",
-    "react-virtualized-auto-sizer": "^1.0.7",
-    "react-window": "1.8.8",
-    "react-window-infinite-loader": "1.0.8",
+    "react-virtualized-auto-sizer": "1.0.15",
+    "react-window": "1.8.9",
+    "react-window-infinite-loader": "1.0.9",
     "regenerator-runtime": "0.13.11",
     "semver": "6.3.0"
   },
-  "gitHead": "e88250ef22efa7796ff3049153b31fdd6740c0d0"
+  "gitHead": "0ffa335271ce6e7f4bc58df9b2e7681ff1487984"
 }

package/types/index.d.ts

@@ -132,10 +132,19 @@ export function useAction<A>(factory: ()=>stardust.ActionDefinition<A>, deps?: a
  * Gets the desired constraints that should be applied when rendering the visualization.
  * 
  * The constraints are set on the embed configuration before the visualization is rendered
- * and should respected by you when implementing the visualization.
+ * and should be respected when implementing the visualization.
+ * @deprecated
  */
 export function useConstraints(): stardust.Constraints;
 
+/**
+ * Gets the desired interaction states that should be applied when rendering the visualization.
+ * 
+ * The interactions are set on the embed configuration before the visualization is rendered
+ * and should be respected when implementing the visualization.
+ */
+export function useInteractionState(): stardust.Interactions;
+
 /**
  * Gets the options object provided when rendering the visualization.
  * 
@@ -160,6 +169,11 @@ export function onTakeSnapshot(snapshotCallback: ($: EngineAPI.IGenericObjectLay
  */
 export function useRenderState(): stardust.RenderState;
 
+/**
+ * Gets an event emitter instance for the visualization.
+ */
+export function useEmitter(): Emitter;
+
 /**
  * Gets the desired keyboard settings and status to applied when rendering the visualization.
  * A visualization should in general only have tab stops if either `keyboard.enabled` is false or if active is true.
@@ -207,15 +221,13 @@ declare namespace stardust {
     }
 
     interface Context {
-        keyboardNavigation?: boolean;
-        constraints?: {
-            active?: boolean;
-            passive?: boolean;
-            select?: boolean;
-        };
         theme?: string;
         language?: string;
         deviceType?: string;
+        constraints?: stardust.Constraints;
+        interactions?: stardust.Interactions;
+        keyboardNavigation?: boolean;
+        disableCellPadding?: boolean;
     }
 
     interface Galaxy {
@@ -230,10 +242,23 @@ declare namespace stardust {
 
         /**
          * Renders a visualization or sheet into an HTMLElement.
+         * Visualizations can either be existing objects or created on the fly.
          * Support for sense sheets is experimental.
          * @param cfg The render configuration.
          */
-        render(cfg: stardust.CreateConfig | stardust.GetConfig): Promise<stardust.Viz | stardust.Sheet>;
+        render(cfg: stardust.RenderConfig): Promise<stardust.Viz | stardust.Sheet>;
+
+        /**
+         * Creates a visualization model
+         * @param cfg The create configuration.
+         */
+        create(cfg: stardust.CreateConfig): Promise<EngineAPI.IGenericObject>;
+
+        /**
+         * Generates properties for a visualization object
+         * @param cfg The create configuration.
+         */
+        generateProperties(cfg: stardust.CreateConfig): Promise<object>;
 
         /**
          * Updates the current context of this embed instance.
@@ -304,7 +329,7 @@ declare namespace stardust {
             dense?: boolean;
             stateName?: string;
             properties?: object;
-        }): void;
+        }): Promise<void>;
 
         /**
          * Unmounts the field listbox from the DOM.
@@ -352,7 +377,7 @@ declare namespace stardust {
 
         id: string;
 
-        model: string;
+        model: EngineAPI.IGenericObject;
 
         /**
          * Destroys the visualization and removes it from the the DOM.
@@ -366,6 +391,20 @@ declare namespace stardust {
          */
         convertTo(newType: string, forceUpdate?: boolean): Promise<object>;
 
+        /**
+         * Listens to custom events from inside the visualization. See useEmitter
+         * @param eventName Event name to listen to
+         * @param listener Callback function to invoke
+         */
+        on(eventName: string, listener: ()=>void): void;
+
+        /**
+         * Removes a listener
+         * @param eventName Event name to remove from
+         * @param listener Callback function to remove
+         */
+        off(eventName: string, listener: ()=>void): void;
+
     }
 
     interface Flags {
@@ -441,28 +480,26 @@ declare namespace stardust {
     /**
      * Rendering configuration for creating and rendering a new object
      */
-    interface CreateConfig extends stardust.BaseConfig{
+    interface CreateConfig {
         type: string;
         version?: string;
         fields?: stardust.Field[];
-        extendProperties?: boolean;
         properties?: EngineAPI.IGenericObjectProperties;
     }
 
     /**
-     * Basic rendering configuration for rendering an object
+     * Configuration for rendering a visualisation, either creating or fetching an existing object.
      */
-    interface BaseConfig {
+    interface RenderConfig {
         element: HTMLElement;
         options?: object;
         plugins?: stardust.Plugin[];
-    }
-
-    /**
-     * Rendering configuration for rendering an existing object
-     */
-    interface GetConfig extends stardust.BaseConfig{
-        id: string;
+        id?: string;
+        type?: string;
+        version?: string;
+        fields?: stardust.Field[];
+        extendProperties?: boolean;
+        properties?: EngineAPI.IGenericObjectProperties;
     }
 
     interface LibraryField {
@@ -567,10 +604,21 @@ declare namespace stardust {
         };
     }
 
+    /**
+     * @deprecated
+     */
     interface Constraints {
         passive?: boolean;
         active?: boolean;
         select?: boolean;
+        edit?: boolean;
+    }
+
+    interface Interactions {
+        passive?: boolean;
+        active?: boolean;
+        select?: boolean;
+        edit?: boolean;
     }
 
     interface RenderState {