@sisense/sdk-data 0.15.0 → 1.0.0

package/dist/dimensional-model/measures/measures.js

@@ -8,12 +8,12 @@
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable sonarjs/cognitive-complexity */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
-/* eslint-disable @typescript-eslint/no-throw-literal */
 import * as m from './factory.js';
 import { Sort, AggregationTypes, MetadataTypes } from '../types.js';
 import { DimensionalElement } from '../base.js';
 import { DimensionalAttribute, createAttribute } from '../attributes.js';
 import { create } from '../factory.js';
+import { TranslatableError } from '../../translation/translatable-error.js';
 /**
  * @internal
  */
@@ -360,7 +360,7 @@ export function createMeasure(json) {
     }
     if (MetadataTypes.isCalculatedMeasure(json)) {
         if (json.context === undefined) {
-            throw new Error(`DimensionalCalculatedMeasure must have context property`);
+            throw new TranslatableError('errors.measure.dimensionalCalculatedMeasure.noContext');
         }
         const context = {};
         Object.getOwnPropertyNames(json.context).forEach((pname) => {
@@ -370,19 +370,19 @@ export function createMeasure(json) {
     }
     else if (MetadataTypes.isMeasureTemplate(json)) {
         if (att === undefined) {
-            throw new Error(`DimensionalBaseMeasure must have attribute/dim/expression property`);
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression');
         }
         return new DimensionalMeasureTemplate(name, att, format, desc);
     }
     else if (MetadataTypes.isBaseMeasure(json)) {
         if (att === undefined) {
-            throw new Error(`DimensionalBaseMeasure must have attribute/dim/expression property`);
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression');
         }
         const agg = json.agg || json.aggregation;
         if (!agg) {
-            throw `DimensionalBaseMeasure must have agg or aggregation property`;
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAggAggregation');
         }
         return new DimensionalBaseMeasure(name, att, agg, format, desc);
     }
-    throw 'unsupported measure type';
+    throw new TranslatableError('errors.measure.unsupportedType');
 }

package/dist/index.d.ts

@@ -1,6 +1,6 @@
+import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
- * @beta
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -21,31 +21,32 @@ export * from './dimensional-model/filters/filters.js';
  * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
  *
  * @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>;
  *   }
- * }
- * </ExecuteQuery>
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   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.
@@ -55,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>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   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,6 +1,6 @@
+import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
- * @beta
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -21,31 +21,32 @@ export * from './dimensional-model/filters/filters.js';
  * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
  *
  * @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>;
  *   }
- * }
- * </ExecuteQuery>
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   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.
@@ -55,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>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
  *   }
- * }
- * </ExecuteQuery>
+ *   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/interfaces.d.ts

@@ -184,7 +184,7 @@ export declare type ForecastFormulaOptions = {
      *
      * @defaultValue 3
      */
-    forecastHorizon: number;
+    forecastHorizon?: number;
     /**
      * Forecasting model type. The 'auto' option automatically
      * fits the best combination of models.

package/dist/translation/initialize-i18n.d.ts

@@ -0,0 +1,2 @@
+export declare function initializeI18n(): import("@sisense/sdk-common").I18NextInitResult;
+export declare const i18nextInstance: import("i18next").i18n;

package/dist/translation/initialize-i18n.js

@@ -0,0 +1,10 @@
+import { initI18next } from '@sisense/sdk-common';
+import { resources, PACKAGE_NAMESPACE } from './resources/index.js';
+export function initializeI18n() {
+    return initI18next({
+        resource: resources,
+        language: 'en',
+        namespace: PACKAGE_NAMESPACE,
+    });
+}
+export const { i18nextInstance } = initializeI18n();

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

@@ -0,0 +1,28 @@
+/**
+ * Translation dictionary for English language.
+ */
+export declare const translation: {
+    errors: {
+        measure: {
+            unsupportedType: string;
+            dimensionalCalculatedMeasure: {
+                noContext: string;
+            };
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: string;
+                noAggAggregation: string;
+            };
+        };
+        dataModelConfig: {
+            noName: string;
+            noMetadata: string;
+        };
+        filter: {
+            unsupportedType: string;
+            unsupportedDatetimeLevel: string;
+            membersFilterNullMember: string;
+        };
+        unsupportedDimensionalElement: string;
+    };
+};
+export declare type TranslationDictionary = typeof translation;

package/dist/translation/resources/en.js

@@ -0,0 +1,27 @@
+/**
+ * Translation dictionary for English language.
+ */
+export const translation = {
+    errors: {
+        measure: {
+            unsupportedType: 'Unsupported measure type',
+            dimensionalCalculatedMeasure: {
+                noContext: "DimensionalCalculatedMeasure must have 'context' property",
+            },
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: "DimensionalBaseMeasure must have 'attribute'/'dim'/'expression' property",
+                noAggAggregation: "DimensionalBaseMeasure must have 'agg' or 'aggregation' property",
+            },
+        },
+        dataModelConfig: {
+            noName: "'name' must be specified in config for DataModel",
+            noMetadata: "'metadata' must be specified in config for DataModel",
+        },
+        filter: {
+            unsupportedType: 'Unsupported filter type: {{filterType}}',
+            unsupportedDatetimeLevel: 'Filters do not support the next "datetime" levels: Hours, MinutesRoundTo30, MinutesRoundTo15',
+            membersFilterNullMember: 'MembersFilter of {{attributeId}} - member cannot be null',
+        },
+        unsupportedDimensionalElement: 'Unsupported dimensional element type',
+    },
+};

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

@@ -0,0 +1,53 @@
+import { TranslationDictionary } from './en.js';
+export type { TranslationDictionary };
+export declare const PACKAGE_NAMESPACE: "sdkData";
+export declare const resources: {
+    en: {
+        errors: {
+            measure: {
+                unsupportedType: string;
+                dimensionalCalculatedMeasure: {
+                    noContext: string;
+                };
+                dimensionalBaseMeasure: {
+                    noAttributeDimExpression: string;
+                    noAggAggregation: string;
+                };
+            };
+            dataModelConfig: {
+                noName: string;
+                noMetadata: string;
+            };
+            filter: {
+                unsupportedType: string;
+                unsupportedDatetimeLevel: string;
+                membersFilterNullMember: string;
+            };
+            unsupportedDimensionalElement: string;
+        };
+    };
+    uk: {
+        errors: {
+            measure: {
+                unsupportedType: string;
+                dimensionalCalculatedMeasure: {
+                    noContext: string;
+                };
+                dimensionalBaseMeasure: {
+                    noAttributeDimExpression: string;
+                    noAggAggregation: string;
+                };
+            };
+            dataModelConfig: {
+                noName: string;
+                noMetadata: string;
+            };
+            filter: {
+                unsupportedType: string;
+                unsupportedDatetimeLevel: string;
+                membersFilterNullMember: string;
+            };
+            unsupportedDimensionalElement: string;
+        };
+    };
+};

package/dist/translation/resources/index.js

@@ -0,0 +1,7 @@
+import { translation as enDictionary } from './en.js';
+import { translation as ukDictionary } from './uk.js';
+export const PACKAGE_NAMESPACE = 'sdkData';
+export const resources = {
+    en: enDictionary,
+    uk: ukDictionary,
+};

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

@@ -0,0 +1,5 @@
+import { TranslationDictionary } from './index.js';
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+export declare const translation: TranslationDictionary;

package/dist/translation/resources/uk.js

@@ -0,0 +1,27 @@
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+export const translation = {
+    errors: {
+        measure: {
+            unsupportedType: 'Непідтримуваний тип measure',
+            dimensionalCalculatedMeasure: {
+                noContext: "DimensionalCalculatedMeasure має мати властивість 'context'",
+            },
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: "DimensionalBaseMeasure має мати властивість 'attribute'/'dim'/'expression'",
+                noAggAggregation: "DimensionalBaseMeasure має мати властивість 'agg' або 'aggregation'",
+            },
+        },
+        dataModelConfig: {
+            noName: "'name' має бути вказано в конфігурації для DataModel",
+            noMetadata: "'metadata' має бути вказано в конфігурації для DataModel",
+        },
+        filter: {
+            unsupportedType: 'Непідтримуваний тип фільтра: {{filterType}}',
+            unsupportedDatetimeLevel: 'Фільтри не підтримують наступні рівні "datetime": Hours, MinutesRoundTo30, MinutesRoundTo15',
+            membersFilterNullMember: 'MembersFilter у {{attributeId}} - member не може бути нульовим',
+        },
+        unsupportedDimensionalElement: 'Непідтримуваний тип елемента',
+    },
+};

package/dist/translation/translatable-error.d.ts

@@ -0,0 +1,5 @@
+import { AbstractTranslatableError } from '@sisense/sdk-common';
+import { PACKAGE_NAMESPACE } from './resources/index.js';
+export declare class TranslatableError extends AbstractTranslatableError<typeof PACKAGE_NAMESPACE> {
+    constructor(translationKey: string, interpolationOptions?: Record<string, string>);
+}

package/dist/translation/translatable-error.js

@@ -0,0 +1,11 @@
+import { AbstractTranslatableError } from '@sisense/sdk-common';
+import { i18nextInstance } from './initialize-i18n.js';
+import { PACKAGE_NAMESPACE } from './resources/index.js';
+export class TranslatableError extends AbstractTranslatableError {
+    constructor(translationKey, interpolationOptions) {
+        super(PACKAGE_NAMESPACE, {
+            key: translationKey,
+            interpolationOptions: interpolationOptions,
+        }, i18nextInstance.t);
+    }
+}

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.15.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.0.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -12,7 +23,8 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-rest-client": "^0.15.0",
+    "@sisense/sdk-common": "^1.0.0",
+    "@sisense/sdk-rest-client": "^1.0.0",
     "guid-typescript": "^1.0.9",
     "lodash": "^4.17.21",
     "numeral": "^2.0.6",