@nebula.js/stardust 2.6.1 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/stardust",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "description": "Product and framework agnostic integration API for Qlik's Associative Engine",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -39,18 +39,18 @@
     "version": "yarn run spec && yarn run ts && git add ./api-spec/spec.json ./types/index.d.ts"
   },
   "dependencies": {
-    "@types/qlik-engineapi": "12.67.11"
+    "@types/qlik-engineapi": "12.67.12"
   },
   "devDependencies": {
     "@material-ui/core": "4.12.3",
     "@material-ui/icons": "4.11.2",
     "@material-ui/styles": "4.11.4",
-    "@nebula.js/conversion": "^2.6.1",
-    "@nebula.js/locale": "^2.6.1",
-    "@nebula.js/nucleus": "^2.6.1",
-    "@nebula.js/supernova": "^2.6.1",
-    "@nebula.js/theme": "^2.6.1",
-    "@nebula.js/ui": "^2.6.1",
+    "@nebula.js/conversion": "^2.7.0",
+    "@nebula.js/locale": "^2.7.0",
+    "@nebula.js/nucleus": "^2.7.0",
+    "@nebula.js/supernova": "^2.7.0",
+    "@nebula.js/theme": "^2.7.0",
+    "@nebula.js/ui": "^2.7.0",
     "@scriptappy/cli": "0.1.0",
     "@scriptappy/to-dts": "1.0.0-beta.4",
     "extend": "3.0.2",
@@ -64,5 +64,5 @@
     "regenerator-runtime": "0.13.9",
     "semver": "6.3.0"
   },
-  "gitHead": "c06af7d8139127521baf8229406db290d7ee0b17"
+  "gitHead": "2b595cabaa08b22ca50e2b72c5c349342725fecd"
 }

package/types/index.d.ts

@@ -231,6 +231,14 @@ declare namespace stardust {
 
     }
 
+    type Direction = "ltr" | "rtl";
+
+    type ListLayout = "vertical" | "horizontal";
+
+    type FrequencyMode = "none" | "value" | "percent" | "relative";
+
+    type SearchMode = "false" | "true" | "toggle";
+
     /**
      * A callback function which receives another function as input.
      */
@@ -246,9 +254,12 @@ declare namespace stardust {
          */
         mount(element: HTMLElement, options?: {
             title?: string;
-            direction?: string;
-            listLayout?: string;
-            search?: boolean;
+            direction?: stardust.Direction;
+            listLayout?: stardust.ListLayout;
+            frequencyMode?: stardust.FrequencyMode;
+            histogram?: boolean;
+            search?: stardust.SearchMode;
+            focusSearch?: boolean;
             toolbar?: boolean;
             checkboxes?: boolean;
             rangeSelect?: boolean;
@@ -257,6 +268,10 @@ declare namespace stardust {
             properties?: object;
             sessionModel?: object;
             selectionsApi?: object;
+            /**
+             * Define a function which tells when selections are disabled (true) or enabled (false). By default, always returns false.
+             */
+            "selectDisabled="?(): boolean;
             update?: stardust.ReceiverFunction;
         }): void;
 
@@ -424,23 +439,6 @@ declare namespace stardust {
         meta?: object;
     }
 
-    type Range = {
-    };
-
-    type Segment = {
-    };
-
-    type getSegmentsFromRange = (label: string, range: stardust.Range, startIndex?: number)=>stardust.Segment[];
-
-    type MinMaxResult = {
-    };
-
-    /**
-     * Returns the min and max indices of elemNumbersOrdered which contains
-     * all numbers in elementNbrs.
-     */
-    type getMinMax = (elementNbrs: number[], elemNumbersOrdered: number[])=>stardust.MinMaxResult;
-
     interface ActionToolbarElement extends HTMLElement{
         className: "njs-action-toolbar-popover";
     }
@@ -634,14 +632,18 @@ declare namespace stardust {
         getContrastingColorTo(color: string): string;
 
         /**
-         * Get the value of a style attribute in the theme by searching in the theme's JSON structure.
-         * The search starts at the specified base path and continues upwards until the value is found.
+         * Get the value of a style attribute in the theme
+         * by searching in the theme's JSON structure.
+         * The search starts at the specified base path
+         * and continues upwards until the value is found.
          * If possible it will get the attribute's value using the given path.
+         * When attributes separated by dots are provided, such as 'hover.color',
+         * they are required in the theme JSON file
          * @param basePath Base path in the theme's JSON structure to start the search in (specified as a name path separated by dots).
          * @param path Expected path for the attribute (specified as a name path separated by dots).
-         * @param attribute Name of the style attribute.
+         * @param attribute Name of the style attribute. (specified as a name attribute separated by dots).
          */
-        getStyle(basePath: string, path: string, attribute: string): string;
+        getStyle(basePath: string, path: string, attribute: string): string | undefined;
 
     }