@nebula.js/stardust 4.8.1 → 4.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "4.8.1",
+  "version": "4.10.0",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -44,17 +44,17 @@
     "@types/qlik-engineapi": "12.67.16"
   },
   "devDependencies": {
-    "@emotion/react": "^11.11.1",
+    "@emotion/react": "^11.11.3",
     "@emotion/styled": "^11.11.0",
-    "@mui/icons-material": "^5.14.18",
-    "@mui/material": "^5.14.18",
-    "@nebula.js/conversion": "^4.8.1",
-    "@nebula.js/enigma-mocker": "^4.8.1",
-    "@nebula.js/locale": "^4.8.1",
-    "@nebula.js/nucleus": "^4.8.1",
-    "@nebula.js/supernova": "^4.8.1",
-    "@nebula.js/theme": "^4.8.1",
-    "@nebula.js/ui": "^4.8.1",
+    "@mui/icons-material": "^5.15.6",
+    "@mui/material": "^5.15.6",
+    "@nebula.js/conversion": "^4.10.0",
+    "@nebula.js/enigma-mocker": "^4.10.0",
+    "@nebula.js/locale": "^4.10.0",
+    "@nebula.js/nucleus": "^4.10.0",
+    "@nebula.js/supernova": "^4.10.0",
+    "@nebula.js/theme": "^4.10.0",
+    "@nebula.js/ui": "^4.10.0",
     "@scriptappy/cli": "0.10.0",
     "@scriptappy/from-jsdoc": "0.19.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
@@ -63,11 +63,11 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-test-renderer": "18.2.0",
-    "react-virtualized-auto-sizer": "1.0.20",
+    "react-virtualized-auto-sizer": "1.0.21",
     "react-window": "1.8.10",
     "react-window-infinite-loader": "1.0.9",
-    "regenerator-runtime": "0.14.0",
+    "regenerator-runtime": "0.14.1",
     "semver": "7.5.4"
   },
-  "gitHead": "9c53625d63aa583a333cd1874d8520a81a068855"
+  "gitHead": "1be7d26b3c063c05c6d3e85c1ad2b097177dccb3"
 }

package/types/index.d.ts

@@ -26,6 +26,9 @@ export function useState<S>(initialState: S | (()=>S)): [S, stardust.SetStateFn<
 
 /**
  * Triggers a callback function when a dependent value changes.
+ * 
+ * Omitting the dependency array will have the hook run on each update
+ * and an empty dependency array runs only once.
  * @param effect The callback.
  * @param deps The dependencies that should trigger the callback.
  */
@@ -40,6 +43,9 @@ export function useMemo<T>(factory: ()=>T, deps: any[]): T;
 
 /**
  * Runs a callback function when a dependent changes.
+ * 
+ * Useful for async operations that otherwise cause no side effects.
+ * Do not add for example listeners withing the callback as there is no teardown function.
  * @param factory The factory function that calls the promise.
  * @param deps The dependencies.
  */
@@ -227,7 +233,11 @@ declare namespace stardust {
     }
 
     interface Configuration {
-        load?: stardust.LoadType;
+        /**
+         * Fallback load function for missing types
+         * @param $
+         */
+        load($: stardust.LoadType): Promise<stardust.Visualization>;
         context?: stardust.Context;
         types?: stardust.TypeInfo[];
         themes?: stardust.ThemeInfo[];
@@ -242,6 +252,7 @@ declare namespace stardust {
         interactions?: stardust.Interactions;
         keyboardNavigation?: boolean;
         disableCellPadding?: boolean;
+        dataViewType?: string;
     }
 
     interface Galaxy {
@@ -338,6 +349,7 @@ declare namespace stardust {
             frequencyMode?: stardust.FrequencyMode;
             histogram?: boolean;
             search?: stardust.SearchMode;
+            showLock?: boolean;
             toolbar?: boolean;
             checkboxes?: boolean;
             dense?: boolean;
@@ -411,6 +423,16 @@ declare namespace stardust {
          */
         convertTo(newType: string, forceUpdate?: boolean, forcePatch?: boolean): Promise<object>;
 
+        /**
+         * Toggles the chart to a data view of the chart.
+         * 
+         * The chart will be toggled to the type defined in the nebula context (dataViewType).
+         * 
+         * The default dataViewType for nebula is sn-table. The specified chart type needs to be registered as well, in order to make it possible to render the data view.
+         * @param showDataView If included, forces the chart into a specific state. True will show data view, and false will show the original chart. If not included it will always toggle between the two views.
+         */
+        toggleDataView(showDataView?: boolean): void;
+
         /**
          * Listens to custom events from inside the visualization. See useEmitter
          * @param eventName Event name to listen to
@@ -623,6 +645,11 @@ declare namespace stardust {
         (newState: S | (($: S)=>S)): void;
     }
 
+    /**
+     * Callback function that should return a function that in turns gets
+     * called before the hook runs again or when the component is destroyed.
+     * For example to remove any listeners added in the callback itself.
+     */
     type EffectCallback = ()=>void | (()=>void);
 
     interface Rect {