@nebula.js/stardust 5.7.0 → 5.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -41,18 +41,18 @@
     "version": "yarn run spec && yarn run ts && git add ./api-spec/spec.json ./api-spec/listbox-spec.json ./types/index.d.ts"
   },
   "devDependencies": {
-    "@emotion/react": "^11.13.0",
+    "@emotion/react": "^11.13.3",
     "@emotion/styled": "^11.13.0",
-    "@mui/icons-material": "^5.16.6",
-    "@mui/material": "^5.16.6",
-    "@nebula.js/conversion": "^5.7.0",
-    "@nebula.js/enigma-mocker": "^5.7.0",
-    "@nebula.js/locale": "^5.7.0",
-    "@nebula.js/nucleus": "^5.7.0",
-    "@nebula.js/supernova": "^5.7.0",
-    "@nebula.js/theme": "^5.7.0",
-    "@nebula.js/ui": "^5.7.0",
-    "@qlik/api": "^1.14.0",
+    "@mui/icons-material": "^5.16.7",
+    "@mui/material": "^5.16.7",
+    "@nebula.js/conversion": "^5.8.0",
+    "@nebula.js/enigma-mocker": "^5.8.0",
+    "@nebula.js/locale": "^5.8.0",
+    "@nebula.js/nucleus": "^5.8.0",
+    "@nebula.js/supernova": "^5.8.0",
+    "@nebula.js/theme": "^5.8.0",
+    "@nebula.js/ui": "^5.8.0",
+    "@qlik/api": "^1.25.0",
     "@scriptappy/cli": "0.10.0",
     "@scriptappy/from-jsdoc": "0.19.0",
     "@scriptappy/to-dts": "1.0.0",
@@ -67,5 +67,5 @@
     "regenerator-runtime": "0.14.1",
     "semver": "7.6.3"
   },
-  "gitHead": "65c649cbfd09488d59c835f78869672678b8266c"
+  "gitHead": "7bbcb057c2dadd606a2a5377a41ba5030381968c"
 }

package/types/index.d.ts

@@ -41,6 +41,16 @@ export function useEffect(effect: stardust.EffectCallback, deps?: any[]): void;
  */
 export function useMemo<T>(factory: ()=>T, deps: any[]): T;
 
+/**
+ * Creates a reference to a value not needed for rendering
+ * 
+ * While Nebula does not have a virtual DOM, it is still useful
+ * to have a reference to an object that is retained across
+ * renders and in it self does not trigger a render.
+ * @param initialValue The initial value.
+ */
+export function useRef<R>(initialValue: R): stardust.Ref<R>;
+
 /**
  * Runs a callback function when a dependent changes.
  * 
@@ -464,14 +474,6 @@ declare namespace stardust {
 
     }
 
-    interface Flags {
-        /**
-         * Checks whether the specified flag is enabled.
-         * @param flag The value flag to check.
-         */
-        isEnabled(flag: string): boolean;
-    }
-
     class AppSelections {
         constructor();
 
@@ -546,6 +548,14 @@ declare namespace stardust {
 
     }
 
+    interface Flags {
+        /**
+         * Checks whether the specified flag is enabled.
+         * @param flag The value flag to check.
+         */
+        isEnabled(flag: string): boolean;
+    }
+
     type Field = string | qix.NxDimension | qix.NxMeasure | stardust.LibraryField;
 
     /**
@@ -564,6 +574,15 @@ declare namespace stardust {
     interface RenderConfig {
         element: HTMLElement;
         options?: object;
+        /**
+         * Callback function called after rendering successfully
+         */
+        onRender?(): void;
+        /**
+         * Callback function called if an error occurs
+         * @param $
+         */
+        onError?($: stardust.RenderError): void;
         plugins?: stardust.Plugin[];
         id?: string;
         type?: string;
@@ -602,6 +621,13 @@ declare namespace stardust {
         meta?: object;
     }
 
+    class RenderError extends Error {
+        constructor(message: string, originalError: Error);
+
+        originalError: Error;
+
+    }
+
     class Navigation implements stardust.Emitter {
         constructor();
 
@@ -679,6 +705,13 @@ declare namespace stardust {
      */
     type EffectCallback = ()=>void | (()=>void);
 
+    /**
+     * Reference object returned from useRef
+     */
+    interface Ref<R> {
+        current: R;
+    }
+
     interface Rect {
         top: number;
         left: number;