@nebula.js/stardust 4.0.0-alpha.8 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "4.0.0-alpha.8",
+  "version": "4.0.0",
   "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.15",
-    "@nebula.js/conversion": "^4.0.0-alpha.8",
-    "@nebula.js/enigma-mocker": "^4.0.0-alpha.8",
-    "@nebula.js/locale": "^4.0.0-alpha.8",
-    "@nebula.js/nucleus": "^4.0.0-alpha.8",
-    "@nebula.js/supernova": "^4.0.0-alpha.8",
-    "@nebula.js/theme": "^4.0.0-alpha.8",
-    "@nebula.js/ui": "^4.0.0-alpha.8",
+    "@emotion/react": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
+    "@mui/icons-material": "^5.11.16",
+    "@mui/material": "^5.12.3",
+    "@nebula.js/conversion": "^4.0.0",
+    "@nebula.js/enigma-mocker": "^4.0.0",
+    "@nebula.js/locale": "^4.0.0",
+    "@nebula.js/nucleus": "^4.0.0",
+    "@nebula.js/supernova": "^4.0.0",
+    "@nebula.js/theme": "^4.0.0",
+    "@nebula.js/ui": "^4.0.0",
     "@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.11",
-    "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": "f8bf3d9036d17809c6f2c511b1e1b5928d4ddcf7"
+  "gitHead": "25856057bb28d545839e8118b0fd96db1af6f4aa"
 }

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.
  * 
@@ -212,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 {
@@ -235,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.
@@ -357,7 +377,7 @@ declare namespace stardust {
 
         id: string;
 
-        model: string;
+        model: EngineAPI.IGenericObject;
 
         /**
          * Destroys the visualization and removes it from the the DOM.
@@ -376,14 +396,14 @@ declare namespace stardust {
          * @param eventName Event name to listen to
          * @param listener Callback function to invoke
          */
-        on(eventName: string, listener: ()=>void): void;
+        addListener(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;
+        removeListener(eventName: string, listener: ()=>void): void;
 
     }
 
@@ -395,6 +415,62 @@ declare namespace stardust {
         isEnabled(flag: string): boolean;
     }
 
+    type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
+
+    /**
+     * Rendering configuration for creating and rendering a new object
+     */
+    interface CreateConfig {
+        type: string;
+        version?: string;
+        fields?: stardust.Field[];
+        properties?: EngineAPI.IGenericObjectProperties;
+    }
+
+    /**
+     * Configuration for rendering a visualisation, either creating or fetching an existing object.
+     */
+    interface RenderConfig {
+        element: HTMLElement;
+        options?: object;
+        plugins?: stardust.Plugin[];
+        id?: string;
+        type?: string;
+        version?: string;
+        fields?: stardust.Field[];
+        extendProperties?: boolean;
+        properties?: EngineAPI.IGenericObjectProperties;
+    }
+
+    interface LibraryField {
+        qLibraryId: string;
+        type: "dimension" | "measure";
+    }
+
+    /**
+     * An object literal containing meta information about the plugin and a function containing the plugin implementation.
+     */
+    interface Plugin {
+        info: {
+            name: string;
+        };
+        fn: ()=>void;
+    }
+
+    interface LoadType {
+        (type: {
+            name: string;
+            version: string;
+        }): Promise<stardust.Visualization>;
+    }
+
+    interface TypeInfo {
+        name: string;
+        version?: string;
+        load: stardust.LoadType;
+        meta?: object;
+    }
+
     class AppSelections {
         constructor();
 
@@ -414,6 +490,20 @@ declare namespace stardust {
     class ObjectSelections {
         constructor();
 
+        /**
+         * Event listener function on instance
+         * @param eventType event type that function needs to listen
+         * @param callback a callback function to run when event emits
+         */
+        addListener(eventType: string, callback: ()=>void): void;
+
+        /**
+         * Remove listener function on instance
+         * @param eventType event type that function needs to listen
+         * @param callback a callback function to run when event emits
+         */
+        removeListener(eventType: string, callback: ()=>void): void;
+
         /**
          * @param paths
          */
@@ -455,64 +545,6 @@ declare namespace stardust {
 
     }
 
-    type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
-
-    /**
-     * Rendering configuration for creating and rendering a new object
-     */
-    interface CreateConfig extends stardust.BaseConfig{
-        type: string;
-        version?: string;
-        fields?: stardust.Field[];
-        extendProperties?: boolean;
-        properties?: EngineAPI.IGenericObjectProperties;
-    }
-
-    /**
-     * Basic rendering configuration for rendering an object
-     */
-    interface BaseConfig {
-        element: HTMLElement;
-        options?: object;
-        plugins?: stardust.Plugin[];
-    }
-
-    /**
-     * Rendering configuration for rendering an existing object
-     */
-    interface GetConfig extends stardust.BaseConfig{
-        id: string;
-    }
-
-    interface LibraryField {
-        qLibraryId: string;
-        type: "dimension" | "measure";
-    }
-
-    /**
-     * An object literal containing meta information about the plugin and a function containing the plugin implementation.
-     */
-    interface Plugin {
-        info: {
-            name: string;
-        };
-        fn: ()=>void;
-    }
-
-    interface LoadType {
-        (type: {
-            name: string;
-            version: string;
-        }): Promise<stardust.Visualization>;
-    }
-
-    interface TypeInfo {
-        name: string;
-        version?: string;
-        load: stardust.LoadType;
-        meta?: object;
-    }
-
     interface ActionToolbarElement extends HTMLElement{
         className: "njs-action-toolbar-popover";
     }
@@ -586,10 +618,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 {
@@ -601,17 +644,19 @@ declare namespace stardust {
         enabled: boolean;
         active: boolean;
         /**
-         * Function used by the visualization to tell Nebula to it wants to relinquish focus
+         * Function used by the visualization to tell Nebula it wants to relinquish focus
+         * @param $
          */
-        blur?(): void;
+        blur?($: boolean): void;
         /**
-         * Function used by the visualization to tell Nebula to it wants focus
+         * Function used by the visualization to tell Nebula it wants to focus
          */
         focus?(): void;
         /**
-         * Function used by the visualization to tell Nebula to focus the selection toolbar
+         * Function used by the visualization to tell Nebula that focus the selection toolbar
+         * @param $
          */
-        focusSelection?(): void;
+        focusSelection?($: boolean): void;
     }
 
     /**
@@ -662,6 +707,12 @@ declare namespace stardust {
     class Translator {
         constructor();
 
+        /**
+         * Returns current locale.
+         * @param lang language Locale to updated the currentLocale value
+         */
+        language(lang?: string): string;
+
         /**
          * Registers a string in multiple locales
          * @param item
@@ -683,6 +734,11 @@ declare namespace stardust {
     class Theme {
         constructor();
 
+        /**
+         * Returns theme name
+         */
+        name(): string;
+
         getDataColorScales(): stardust.Theme.ScalePalette[];
 
         getDataColorPalettes(): stardust.Theme.DataPalette[];