@sisense/sdk-data 0.16.0 → 1.1.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
- * @beta
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -13,40 +12,41 @@ export * from './dimensional-model/dimensions.js';
 export * from './dimensional-model/factory.js';
 export * from './dimensional-model/filters/filters.js';
 /**
- * Functions to create date, text, or numeric filters on certain data columns
+ * Functions to create date, text, or numeric filters on specified data.
  *
- * They are similar to [Dashboard and Widget Filters](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
+ * Filters created with these functions can be used to:
  *
- * Filters created with these functions can be used in the data options of UI components such as
- * {@link @sisense/sdk-ui!ChartProps | Chart}, {@link @sisense/sdk-ui!ChartWidgetProps | ChartWidget},
- * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
+ * + Filter explicit queries by query components or query functions
+ * + Filter or highlight queries used by UI components, such as charts
+ * + Set the filters of filter components
  *
  * @example
- * Example of using the component to query the `Sample ECommerce` data source.
- * Function `filters.greaterThan` is used to create a filter on `Revenue` to get values
+ * Example of using React hook `useExecuteQuery` to query the `Sample ECommerce` data source.
+ * Factory function `filterFactory.greaterThan()` is used to create a filter on `Revenue` to get values
  * greater than 1000.
  * ```tsx
- * <ExecuteQuery
- *   dataSource={DM.DataSource}
- *   dimensions={[DM.Commerce.AgeRange]}
- *   measures={[measures.sum(DM.Commerce.Revenue)]}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
- * >
- * {
- *   (data) => {
- *     if (data) {
- *       console.log(data);
- *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
- *     }
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   return null;
  * ```
  */
-export * as filters from './dimensional-model/filters/factory.js';
+export * as filterFactory from './dimensional-model/filters/factory.js';
 export * from './dimensional-model/measures/measures.js';
 /**
- * Functions to build formulas that aggregate, summarize, and accumulate data,
+ * Functions to create measures that aggregate, summarize, and accumulate data,
  * plus show changes in data over time.
  *
  * They are similar to [Formulas](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
@@ -56,25 +56,31 @@ export * from './dimensional-model/measures/measures.js';
  * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
  *
  * @example
- * Example of using the component to query the `Sample ECommerce` data source.
- * Function `measures.sum` is used to create a measure that sums the `Revenue` column.
+ * Example of using React hook useExecuteQuery to query the `Sample ECommerce` data source.
+ * Factory function `measureFactory.sum()` is used to create a measure that sums the `Revenue` column.
  * ```tsx
- * <ExecuteQuery
- *   dataSource={DM.DataSource}
- *   dimensions={[DM.Commerce.AgeRange]}
- *   measures={[measures.sum(DM.Commerce.Revenue)]}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
- * >
- * {
- *   (data) => {
- *     if (data) {
- *       console.log(data);
- *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
- *     }
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
  * ```
  */
-export * as measures from './dimensional-model/measures/factory.js';
+export * as measureFactory from './dimensional-model/measures/factory.js';
 export * from './dimensional-model/simple-column-types.js';
+/**
+ * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
+ */
+export * as analyticsFactory from './dimensional-model/analytics/factory.js';
+export * from './utils.js';

package/dist/index.js

@@ -1,7 +1,6 @@
 import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
- * @beta
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -13,40 +12,41 @@ export * from './dimensional-model/dimensions.js';
 export * from './dimensional-model/factory.js';
 export * from './dimensional-model/filters/filters.js';
 /**
- * Functions to create date, text, or numeric filters on certain data columns
+ * Functions to create date, text, or numeric filters on specified data.
  *
- * They are similar to [Dashboard and Widget Filters](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
+ * Filters created with these functions can be used to:
  *
- * Filters created with these functions can be used in the data options of UI components such as
- * {@link @sisense/sdk-ui!ChartProps | Chart}, {@link @sisense/sdk-ui!ChartWidgetProps | ChartWidget},
- * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
+ * + Filter explicit queries by query components or query functions
+ * + Filter or highlight queries used by UI components, such as charts
+ * + Set the filters of filter components
  *
  * @example
- * Example of using the component to query the `Sample ECommerce` data source.
- * Function `filters.greaterThan` is used to create a filter on `Revenue` to get values
+ * Example of using React hook `useExecuteQuery` to query the `Sample ECommerce` data source.
+ * Factory function `filterFactory.greaterThan()` is used to create a filter on `Revenue` to get values
  * greater than 1000.
  * ```tsx
- * <ExecuteQuery
- *   dataSource={DM.DataSource}
- *   dimensions={[DM.Commerce.AgeRange]}
- *   measures={[measures.sum(DM.Commerce.Revenue)]}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
- * >
- * {
- *   (data) => {
- *     if (data) {
- *       console.log(data);
- *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
- *     }
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   return null;
  * ```
  */
-export * as filters from './dimensional-model/filters/factory.js';
+export * as filterFactory from './dimensional-model/filters/factory.js';
 export * from './dimensional-model/measures/measures.js';
 /**
- * Functions to build formulas that aggregate, summarize, and accumulate data,
+ * Functions to create measures that aggregate, summarize, and accumulate data,
  * plus show changes in data over time.
  *
  * They are similar to [Formulas](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
@@ -56,25 +56,31 @@ export * from './dimensional-model/measures/measures.js';
  * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
  *
  * @example
- * Example of using the component to query the `Sample ECommerce` data source.
- * Function `measures.sum` is used to create a measure that sums the `Revenue` column.
+ * Example of using React hook useExecuteQuery to query the `Sample ECommerce` data source.
+ * Factory function `measureFactory.sum()` is used to create a measure that sums the `Revenue` column.
  * ```tsx
- * <ExecuteQuery
- *   dataSource={DM.DataSource}
- *   dimensions={[DM.Commerce.AgeRange]}
- *   measures={[measures.sum(DM.Commerce.Revenue)]}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
- * >
- * {
- *   (data) => {
- *     if (data) {
- *       console.log(data);
- *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
- *     }
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
  * ```
  */
-export * as measures from './dimensional-model/measures/factory.js';
+export * as measureFactory from './dimensional-model/measures/factory.js';
 export * from './dimensional-model/simple-column-types.js';
+/**
+ * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
+ */
+export * as analyticsFactory from './dimensional-model/analytics/factory.js';
+export * from './utils.js';

package/dist/translation/resources/en.d.ts

@@ -22,7 +22,7 @@ export declare const translation: {
             unsupportedDatetimeLevel: string;
             membersFilterNullMember: string;
         };
-        unsupportedDimesionalElement: string;
+        unsupportedDimensionalElement: string;
     };
 };
 export declare type TranslationDictionary = typeof translation;

package/dist/translation/resources/en.js

@@ -22,6 +22,6 @@ export const translation = {
             unsupportedDatetimeLevel: 'Filters do not support the next "datetime" levels: Hours, MinutesRoundTo30, MinutesRoundTo15',
             membersFilterNullMember: 'MembersFilter of {{attributeId}} - member cannot be null',
         },
-        unsupportedDimesionalElement: 'Unsupported dimensional element type',
+        unsupportedDimensionalElement: 'Unsupported dimensional element type',
     },
 };

package/dist/translation/resources/index.d.ts

@@ -23,7 +23,7 @@ export declare const resources: {
                 unsupportedDatetimeLevel: string;
                 membersFilterNullMember: string;
             };
-            unsupportedDimesionalElement: string;
+            unsupportedDimensionalElement: string;
         };
     };
     uk: {
@@ -47,7 +47,7 @@ export declare const resources: {
                 unsupportedDatetimeLevel: string;
                 membersFilterNullMember: string;
             };
-            unsupportedDimesionalElement: string;
+            unsupportedDimensionalElement: string;
         };
     };
 };

package/dist/translation/resources/uk.js

@@ -22,6 +22,6 @@ export const translation = {
             unsupportedDatetimeLevel: 'Фільтри не підтримують наступні рівні "datetime": Hours, MinutesRoundTo30, MinutesRoundTo15',
             membersFilterNullMember: 'MembersFilter у {{attributeId}} - member не може бути нульовим',
         },
-        unsupportedDimesionalElement: 'Непідтримуваний тип елемента',
+        unsupportedDimensionalElement: 'Непідтримуваний тип елемента',
     },
 };

package/dist/utils.d.ts

@@ -0,0 +1,16 @@
+import { Filter, FilterRelation } from './index.js';
+/**
+ * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
+ *
+ * @internal
+ */
+export declare const guidFast: (len?: number) => string;
+/**
+ * Function to separate list of filters from the provided relation and get logical relations for jaql
+ *
+ * @internal
+ */
+export declare const getFilterListAndRelations: (filterRelations: FilterRelation | Filter[] | undefined) => {
+    filters: Filter[] | undefined;
+    relations: FilterRelation | undefined;
+};

package/dist/utils.js

@@ -0,0 +1,63 @@
+import cloneDeep from 'lodash/cloneDeep.js';
+/**
+ * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
+ *
+ * @internal
+ */
+export const guidFast = function (len) {
+    if (!len) {
+        len = 20;
+    }
+    const chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.split('');
+    const uuid = new Array(len);
+    let rnd = 0;
+    let r;
+    for (let i = 0; i < len; i += 1) {
+        if (i > 0 && i % 5 == 0) {
+            uuid[i] = '-';
+            continue;
+        }
+        if (rnd <= 0x02) {
+            rnd = (0x2000000 + Math.random() * 0x1000000) | 0;
+        }
+        r = rnd & 0xf;
+        rnd = rnd >> 4;
+        uuid[i] = chars[i == 19 ? (r & 0x3) | 0x8 : r];
+    }
+    return uuid.join('');
+};
+/**
+ * Function to separate list of filters from the provided relation and get logical relations for jaql
+ *
+ * @internal
+ */
+export const getFilterListAndRelations = (filterRelations) => {
+    if (!filterRelations) {
+        return { filters: undefined, relations: undefined };
+    }
+    if (Array.isArray(filterRelations)) {
+        return { filters: filterRelations, relations: undefined };
+    }
+    const filters = new Set();
+    function traverse(node) {
+        if (!node)
+            return node;
+        if ('guid' in node) {
+            filters.add(node);
+            return { instanceid: node.guid };
+        }
+        else {
+            if ('left' in node) {
+                node.left = traverse(node.left);
+            }
+            if ('right' in node) {
+                node.right = traverse(node.right);
+            }
+            return node;
+        }
+    }
+    // Create a deep copy of filterRelations to avoid mutation
+    const copiedFilterRelations = cloneDeep(filterRelations);
+    const relations = traverse(copiedFilterRelations);
+    return { filters: Array.from(filters), relations };
+};

package/package.json

@@ -1,6 +1,17 @@
 {
   "name": "@sisense/sdk-data",
-  "version": "0.16.0",
+  "homepage": "https://sisense.dev/guides/sdk/",
+  "description": "Compose SDK package for implementing the elements of dimensional modeling",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sisense/compose-sdk-monorepo",
+    "directory": "packages/sdk-data"
+  },
+  "keywords": [
+    "Sisense",
+    "Compose SDK"
+  ],
+  "version": "1.1.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -12,8 +23,8 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^0.16.0",
-    "@sisense/sdk-rest-client": "^0.16.0",
+    "@sisense/sdk-common": "^1.1.0",
+    "@sisense/sdk-rest-client": "^1.1.0",
     "guid-typescript": "^1.0.9",
     "lodash": "^4.17.21",
     "numeral": "^2.0.6",