@nebula.js/stardust 3.0.0-rc.2 → 3.0.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.3",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -42,17 +42,17 @@
     "@types/qlik-engineapi": "12.67.12"
   },
   "devDependencies": {
-    "@emotion/react": "^11.10.0",
-    "@emotion/styled": "^11.10.0",
-    "@mui/icons-material": "^5.8.4",
-    "@mui/material": "^5.9.3",
-    "@nebula.js/conversion": "^3.0.0-rc.2",
-    "@nebula.js/enigma-mocker": "^3.0.0-rc.2",
-    "@nebula.js/locale": "^3.0.0-rc.2",
-    "@nebula.js/nucleus": "^3.0.0-rc.2",
-    "@nebula.js/supernova": "^3.0.0-rc.2",
-    "@nebula.js/theme": "^3.0.0-rc.2",
-    "@nebula.js/ui": "^3.0.0-rc.2",
+    "@emotion/react": "^11.10.4",
+    "@emotion/styled": "^11.10.4",
+    "@mui/icons-material": "^5.10.3",
+    "@mui/material": "^5.10.3",
+    "@nebula.js/conversion": "^3.0.0-rc.3",
+    "@nebula.js/enigma-mocker": "^3.0.0-rc.3",
+    "@nebula.js/locale": "^3.0.0-rc.3",
+    "@nebula.js/nucleus": "^3.0.0-rc.3",
+    "@nebula.js/supernova": "^3.0.0-rc.3",
+    "@nebula.js/theme": "^3.0.0-rc.3",
+    "@nebula.js/ui": "^3.0.0-rc.3",
     "@scriptappy/cli": "0.1.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
     "extend": "3.0.2",
@@ -66,5 +66,5 @@
     "regenerator-runtime": "0.13.9",
     "semver": "6.3.0"
   },
-  "gitHead": "898b5acf0ecf16f2e988a9c01a06f681e0d5bf5e"
+  "gitHead": "6ffc4105c1f52e785a67e1c87bd64ff2f0351b52"
 }

package/types/index.d.ts

@@ -169,6 +169,19 @@ export function useRenderState(): stardust.RenderState;
  */
 export function useKeyboard(): stardust.Keyboard;
 
+declare type EnigmaMocker = {
+    /**
+     * Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visulization and specifies how it behaves. For example, what layout to use the data to present.
+     * 
+     * The generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for `app.getObject(id)`. For example, the property `getLayout` in the generic object is used to define `app.getObject(id).getLayout()`. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).
+     * 
+     * The value for each property is either fixed (string / boolean / number / object) or a function. Arguments are forwarded to the function to allow for greater flexibility. For example, this can be used to return different hypercube data when scrolling in the chart.
+     * @param genericObjects Generic objects controling behaviour of visualizations.
+     * @param options Options
+     */
+    fromGenericObjects(genericObjects: object[], options: stardust.EnigmaMockerOptions): Promise<EngineAPI.IApp>;
+};
+
 declare namespace stardust {
     interface Context {
         keyboardNavigation?: boolean;
@@ -367,16 +380,6 @@ declare namespace stardust {
 
     }
 
-    /**
-     * An object literal containing meta information about the plugin and a function containing the plugin implementation.
-     */
-    interface Plugin {
-        info: {
-            name: string;
-        };
-        fn: ()=>void;
-    }
-
     type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
 
     /**
@@ -410,6 +413,16 @@ declare namespace stardust {
         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;
@@ -693,5 +706,12 @@ declare namespace stardust {
     interface hyperCubeConversion {
     }
 
+    /**
+     * Options for Enigma Mocker
+     */
+    interface EnigmaMockerOptions {
+        delay: number;
+    }
+
 }