@sisense/sdk-data 1.34.0 → 2.1.0

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { FilterJaqlInternal, JaqlDataSource, RankingFilterJaql } from './dimensional-model/filters/utils/types.js';
+import { FilterJaqlInternal, JaqlDataSource, JaqlDataSourceForDto, RankingFilterJaql } from './dimensional-model/filters/utils/types.js';
 import { Attribute, BaseMeasure, CalculatedMeasure, Filter, FilterRelations, FilterRelationsJaql, LevelAttribute, SortDirection } from './dimensional-model/interfaces.js';
 import { BaseJaql, FilterJaql, FormulaJaql, Jaql, JaqlSortDirection, Sort } from './dimensional-model/types.js';
 import { DataSource, DataSourceInfo } from './interfaces.js';
@@ -41,6 +41,12 @@ export declare function convertDataSource(jaqlDataSource: JaqlDataSource): DataS
  * @internal
  */
 export declare function convertJaqlDataSource(dataSource: DataSource): JaqlDataSource;
+/**
+ * Converts a DataSource to JaqlDataSourceForDto.
+ *
+ * @internal
+ */
+export declare function convertJaqlDataSourceForDto(dataSource: DataSource): JaqlDataSourceForDto;
 /**
  * Converts a string to a Sort enum
  *
@@ -68,6 +74,15 @@ export declare function convertSortDirectionToSort(sortDirection: SortDirection)
  * @internal
  */
 export declare const createFilterFromJaql: (jaql: FilterJaql, instanceid?: string, disabled?: boolean, locked?: boolean) => Filter;
+/**
+ * Extracts the table and column names from the given expression string.
+ *
+ * @internal
+ */
+export declare function parseExpression(expression: string): {
+    table: string;
+    column: string;
+};
 /**
  * Retrieves the table value from the attribute.
  *
@@ -94,21 +109,17 @@ export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined
  * @returns attribute or level attribute
  * @internal
  */
-export declare const createAttributeHelper: ({ dim, table, column, dataType, granularity, format, sort, title, panel, dataSource, }: {
+export declare const createAttributeHelper: ({ expression, dataType, granularity, format, sort, title, panel, dataSource, }: {
     /** Dimension expression */
-    dim: string;
-    /** Table name */
-    table: string | undefined;
-    /** Column name */
-    column: string | undefined;
+    expression: string;
     /** Data type */
     dataType: string;
     /** Date granularity */
-    granularity: string | undefined;
+    granularity?: string | undefined;
     /** Format */
-    format: string | undefined;
+    format?: string | undefined;
     /** Sort */
-    sort: string | undefined;
+    sort?: string | undefined;
     /** Attribute title */
     title?: string | undefined;
     /** Panel */
@@ -122,23 +133,19 @@ export declare const createAttributeHelper: ({ dim, table, column, dataType, gra
  * @returns measure
  * @internal
  */
-export declare const createMeasureHelper: ({ dim, table, column, dataType, agg, granularity, format, sort, title, dataSource, }: {
+export declare const createMeasureHelper: ({ expression, dataType, agg, granularity, format, sort, title, dataSource, }: {
     /** Dimension expression */
-    dim: string;
-    /** Table name */
-    table: string | undefined;
-    /** Column name */
-    column: string;
+    expression: string;
     /** Data type */
     dataType: string;
     /** Aggregation function */
     agg: string;
     /** Date granularity */
-    granularity: string | undefined;
+    granularity?: string | undefined;
     /** Format */
-    format: string | undefined;
+    format?: string | undefined;
     /** Sort */
-    sort: string | undefined;
+    sort?: string | undefined;
     /** Measure title */
     title?: string | undefined;
     /** Jaql data source */

package/dist/utils.js

@@ -1,12 +1,12 @@
-import { escapeSingleQuotes } from '@sisense/sdk-common';
 import cloneDeep from 'lodash-es/cloneDeep.js';
 import mapValues from 'lodash-es/mapValues.js';
-import { DimensionalAttribute, DimensionalLevelAttribute, normalizeAttributeName, } from './dimensional-model/attributes.js';
+import { DimensionalAttribute, DimensionalLevelAttribute } from './dimensional-model/attributes.js';
 import { isCascadingFilter } from './dimensional-model/filters/filters.js';
 import { createFilterFromJaqlInternal } from './dimensional-model/filters/utils/filter-from-jaql-util.js';
-import { DimensionalBaseMeasure, DimensionalCalculatedMeasure, } from './dimensional-model/measures/measures.js';
+import * as measureFactory from './dimensional-model/measures/factory.js';
+import { DimensionalBaseMeasure } from './dimensional-model/measures/measures.js';
 import { isDatetime, isNumber } from './dimensional-model/simple-column-types.js';
-import { DataType, DateLevels, JaqlSortDirection, MetadataTypes, Sort, } from './dimensional-model/types.js';
+import { AggregationTypes, DataType, DateLevels, JaqlSortDirection, MetadataTypes, Sort, } from './dimensional-model/types.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -74,6 +74,9 @@ export const getFilterListAndRelationsJaql = (filterRelations) => {
             if ('right' in node) {
                 node.right = traverse(node.right);
             }
+            if ('composeCode' in node) {
+                delete node.composeCode;
+            }
             return node;
         }
     }
@@ -130,6 +133,28 @@ export function convertJaqlDataSource(dataSource) {
             live: false,
         };
 }
+/**
+ * Converts a DataSource to JaqlDataSourceForDto.
+ *
+ * @internal
+ */
+export function convertJaqlDataSourceForDto(dataSource) {
+    var _a;
+    if (isDataSourceInfo(dataSource)) {
+        return {
+            title: dataSource.title,
+            live: dataSource.type === 'live',
+            id: (_a = dataSource.id) !== null && _a !== void 0 ? _a : '',
+            address: dataSource.address,
+        };
+    }
+    else {
+        return {
+            title: dataSource,
+            id: '',
+        };
+    }
+}
 /**
  * Converts a string to a Sort enum
  *
@@ -192,7 +217,7 @@ export const createFilterFromJaql = (jaql, instanceid, disabled = false, locked
  *
  * @internal
  */
-function parseExpression(expression) {
+export function parseExpression(expression) {
     const [table, column] = expression.slice(1, -1).split('.');
     return {
         table,
@@ -237,29 +262,23 @@ export function getSortType(jaqlSort) {
             return 'sortNone';
     }
 }
-const DATA_MODEL_MODULE_NAME = 'DM';
 /**
  * Creates an attribute or level attribute from the provided parameters
  *
  * @returns attribute or level attribute
  * @internal
  */
-export const createAttributeHelper = ({ dim, table, column, dataType, granularity, format, sort, title, panel, dataSource, }) => {
-    // if table is undefined, extract it from dim
-    const dimTable = table !== null && table !== void 0 ? table : parseExpression(dim).table;
-    // if column is undefined, extract it from dim
-    const dimColumn = column !== null && column !== void 0 ? column : parseExpression(dim).column;
+export const createAttributeHelper = ({ expression, dataType, granularity, format, sort, title, panel, dataSource, }) => {
+    const column = parseExpression(expression).column;
     const sortEnum = convertSort(sort);
     const isDataTypeDatetime = dataType === DataType.DATETIME;
     if (isDataTypeDatetime) {
-        const composeCode = normalizeAttributeName(dimTable, dimColumn, granularity, DATA_MODEL_MODULE_NAME);
-        const levelAttribute = new DimensionalLevelAttribute(title !== null && title !== void 0 ? title : dimColumn, dim, granularity || DateLevels.Years, format ||
-            DimensionalLevelAttribute.getDefaultFormatForGranularity(granularity || DateLevels.Years), undefined, sortEnum, dataSource, composeCode, panel);
+        const levelAttribute = new DimensionalLevelAttribute(title !== null && title !== void 0 ? title : column, expression, granularity || DateLevels.Years, format ||
+            DimensionalLevelAttribute.getDefaultFormatForGranularity(granularity || DateLevels.Years), undefined, sortEnum, dataSource, undefined, panel);
         return levelAttribute;
     }
     const attributeType = !dataType || isNumber(dataType) ? MetadataTypes.NumericAttribute : MetadataTypes.TextAttribute;
-    const composeCode = normalizeAttributeName(dimTable, dimColumn, undefined, DATA_MODEL_MODULE_NAME);
-    const attribute = new DimensionalAttribute(title !== null && title !== void 0 ? title : dimColumn, dim, attributeType, undefined, sortEnum, dataSource, composeCode, panel);
+    const attribute = new DimensionalAttribute(title !== null && title !== void 0 ? title : column, expression, attributeType, undefined, sortEnum, dataSource, undefined, panel);
     return attribute;
 };
 /**
@@ -268,12 +287,9 @@ export const createAttributeHelper = ({ dim, table, column, dataType, granularit
  * @returns measure
  * @internal
  */
-export const createMeasureHelper = ({ dim, table, column, dataType, agg, granularity, format, sort, title, dataSource, }) => {
-    const sortEnum = convertSort(sort);
+export const createMeasureHelper = ({ expression, dataType, agg, granularity, format, sort, title, dataSource, }) => {
     const attribute = createAttributeHelper({
-        dim,
-        table,
-        column,
+        expression,
         dataType,
         granularity,
         format,
@@ -282,21 +298,30 @@ export const createMeasureHelper = ({ dim, table, column, dataType, agg, granula
         dataSource,
     });
     const tranformedAgg = DimensionalBaseMeasure.aggregationFromJAQL(agg);
+    const column = parseExpression(expression).column;
     const updatedTitle = title !== null && title !== void 0 ? title : `${tranformedAgg} ${column}`;
-    // currently, sort and format applied to attribute but not to measure
-    const composeCode = `measureFactory.${tranformedAgg}(${attribute.composeCode}, '${escapeSingleQuotes(updatedTitle)}')`;
-    const measure = new DimensionalBaseMeasure(updatedTitle, attribute, tranformedAgg, undefined, undefined, sortEnum, composeCode);
-    return measure;
-};
-const getContextComposeCode = (context) => {
-    return ('{' +
-        Object.entries(context).reduce((acc, [key, value]) => {
-            acc =
-                acc +
-                    `'${key.slice(1, -1)}': ${value && 'composeCode' in value ? value.composeCode : JSON.stringify(value)},`;
-            return acc;
-        }, '') +
-        '}');
+    switch (tranformedAgg) {
+        case AggregationTypes.Sum:
+            return measureFactory.sum(attribute, updatedTitle, format);
+        case AggregationTypes.Average:
+            return measureFactory.avg(attribute, updatedTitle, format);
+        case AggregationTypes.Min:
+            return measureFactory.min(attribute, updatedTitle, format);
+        case AggregationTypes.Max:
+            return measureFactory.max(attribute, updatedTitle, format);
+        case AggregationTypes.Count:
+            return measureFactory.count(attribute, updatedTitle, format);
+        case AggregationTypes.CountDistinct:
+            return measureFactory.countDistinct(attribute, updatedTitle, format);
+        case AggregationTypes.Median:
+            return measureFactory.median(attribute, updatedTitle, format);
+        case AggregationTypes.Variance:
+            return measureFactory.aggregate(attribute, AggregationTypes.Variance, updatedTitle, format);
+        case AggregationTypes.StandardDeviation:
+            return measureFactory.aggregate(attribute, AggregationTypes.StandardDeviation, updatedTitle, format);
+        default:
+            return measureFactory.sum(attribute, updatedTitle, format);
+    }
 };
 /**
  * Creates a measure from the provided parameters
@@ -306,15 +331,13 @@ const getContextComposeCode = (context) => {
  */
 export const createCalculatedMeasureHelper = (jaql) => {
     var _a;
-    const sortEnum = convertSort(jaql.sort);
     const context = mapValues((_a = jaql.context) !== null && _a !== void 0 ? _a : {}, (jaqlContextValue) => {
         if (typeof jaqlContextValue === 'string') {
             return jaqlContextValue;
         }
         return jaqlContextValue && createDimensionalElementFromJaql(jaqlContextValue);
     });
-    const composeCode = `measureFactory.customFormula('${escapeSingleQuotes(jaql.title)}', '${jaql.formula}', ${getContextComposeCode(context)})`;
-    return new DimensionalCalculatedMeasure(jaql.title, jaql.formula, context, undefined, undefined, sortEnum, composeCode);
+    return measureFactory.customFormula(jaql.title, jaql.formula, context);
 };
 /**
  * Creates a dimensional element from a JAQL object.
@@ -337,9 +360,7 @@ export function createDimensionalElementFromJaql(jaql, datetimeFormat, panel) {
     const hasAggregation = !!jaql.agg;
     if (hasAggregation) {
         return createMeasureHelper({
-            dim: jaql.dim,
-            table: jaql.table,
-            column: jaql.column,
+            expression: jaql.dim,
             dataType: jaql.datatype,
             agg: jaql.agg || '',
             granularity: getGranularityFromJaql(jaql),
@@ -350,9 +371,7 @@ export function createDimensionalElementFromJaql(jaql, datetimeFormat, panel) {
         });
     }
     return createAttributeHelper({
-        dim: jaql.dim,
-        table: jaql.table,
-        column: jaql.column,
+        expression: jaql.dim,
         dataType: jaql.datatype,
         granularity: getGranularityFromJaql(jaql),
         format: datetimeFormat,

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.34.0",
+  "version": "2.1.0",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -27,8 +27,8 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^1.34.0",
-    "@sisense/sdk-rest-client": "^1.34.0",
+    "@sisense/sdk-common": "^2.1.0",
+    "@sisense/sdk-rest-client": "^2.1.0",
     "guid-typescript": "^1.0.9",
     "hash-it": "^6.0.0",
     "lodash-es": "^4.17.21",

package/dist/cjs/dimensional-model/filters/utils/filter-code-util.d.ts

@@ -1,17 +0,0 @@
-/**
- * Stringifies the argument, with an option to exclude specific properties.
- *
- * @param arg - The argument to stringify.
- * @param excludeProps - Optional array of property names to exclude when stringifying objects.
- * @returns The stringified representation of the argument.
- */
-export declare function stringifyHelper(arg: any, excludeProps?: string[]): string;
-/**
- * High order function to construct compose code for filter factory functions
- *
- * @param func - filter factory function
- * @param funcName - name of the filter factory function. Needed if the function name is minified.
- * @param ignoreIndexes - Indexes of parameters to ignore in the generated composeCode
- * @returns filter factory function with composeCode property added to the filter
- */
-export declare function withComposeCode<T extends (...args: any[]) => any>(func: T, funcName?: string, ignoreIndexes?: number[]): T;

package/dist/cjs/dimensional-model/filters/utils/filter-code-util.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withComposeCode = exports.stringifyHelper = void 0;
-/**
- * Stringifies the argument, with an option to exclude specific properties.
- *
- * @param arg - The argument to stringify.
- * @param excludeProps - Optional array of property names to exclude when stringifying objects.
- * @returns The stringified representation of the argument.
- */
-function stringifyHelper(arg, excludeProps = []) {
-    try {
-        if (arg === null || arg === undefined) {
-            return JSON.stringify(arg);
-        }
-        if (arg === Object(arg) && 'composeCode' in arg) {
-            return arg.composeCode;
-        }
-        if (Array.isArray(arg)) {
-            return ('[' +
-                arg
-                    .map((e) => {
-                    return stringifyHelper(e, excludeProps);
-                })
-                    .join(', ') +
-                ']');
-        }
-        if (typeof arg === 'string') {
-            return `'${arg}'`;
-        }
-        if (typeof arg === 'number' || !isNaN(arg)) {
-            return arg;
-        }
-        if (typeof arg === 'object') {
-            const filteredObject = Object.keys(arg)
-                .filter((key) => !excludeProps.includes(key))
-                .reduce((acc, key) => {
-                acc[key] = arg[key];
-                return acc;
-            }, {});
-            // Check if the filtered object is empty
-            if (Object.keys(filteredObject).length === 0) {
-                return '';
-            }
-            return JSON.stringify(filteredObject);
-        }
-    }
-    catch (e) {
-        console.error(e);
-    }
-    return JSON.stringify(arg);
-}
-exports.stringifyHelper = stringifyHelper;
-/**
- * High order function to construct compose code for filter factory functions
- *
- * @param func - filter factory function
- * @param funcName - name of the filter factory function. Needed if the function name is minified.
- * @param ignoreIndexes - Indexes of parameters to ignore in the generated composeCode
- * @returns filter factory function with composeCode property added to the filter
- */
-function withComposeCode(func, funcName, ignoreIndexes = []) {
-    return function (...args) {
-        const argValues = args
-            .map((arg, index) => {
-            if (ignoreIndexes.includes(index)) {
-                return ''; // Placeholder for ignored parameters
-            }
-            return stringifyHelper(arg, ['guid']);
-        })
-            .join(', ')
-            // remove any number of trailing commas
-            .replace(/(,\s*)+$/, '');
-        const signature = `filterFactory.${funcName !== null && funcName !== void 0 ? funcName : func.name}(${argValues})`;
-        // Call the original function and get the filter
-        const filter = func(...args);
-        // Add the composeCode property
-        filter.composeCode = signature;
-        return filter;
-    };
-}
-exports.withComposeCode = withComposeCode;

package/dist/dimensional-model/filters/utils/filter-code-util.d.ts

@@ -1,17 +0,0 @@
-/**
- * Stringifies the argument, with an option to exclude specific properties.
- *
- * @param arg - The argument to stringify.
- * @param excludeProps - Optional array of property names to exclude when stringifying objects.
- * @returns The stringified representation of the argument.
- */
-export declare function stringifyHelper(arg: any, excludeProps?: string[]): string;
-/**
- * High order function to construct compose code for filter factory functions
- *
- * @param func - filter factory function
- * @param funcName - name of the filter factory function. Needed if the function name is minified.
- * @param ignoreIndexes - Indexes of parameters to ignore in the generated composeCode
- * @returns filter factory function with composeCode property added to the filter
- */
-export declare function withComposeCode<T extends (...args: any[]) => any>(func: T, funcName?: string, ignoreIndexes?: number[]): T;

package/dist/dimensional-model/filters/utils/filter-code-util.js

@@ -1,77 +0,0 @@
-/**
- * Stringifies the argument, with an option to exclude specific properties.
- *
- * @param arg - The argument to stringify.
- * @param excludeProps - Optional array of property names to exclude when stringifying objects.
- * @returns The stringified representation of the argument.
- */
-export function stringifyHelper(arg, excludeProps = []) {
-    try {
-        if (arg === null || arg === undefined) {
-            return JSON.stringify(arg);
-        }
-        if (arg === Object(arg) && 'composeCode' in arg) {
-            return arg.composeCode;
-        }
-        if (Array.isArray(arg)) {
-            return ('[' +
-                arg
-                    .map((e) => {
-                    return stringifyHelper(e, excludeProps);
-                })
-                    .join(', ') +
-                ']');
-        }
-        if (typeof arg === 'string') {
-            return `'${arg}'`;
-        }
-        if (typeof arg === 'number' || !isNaN(arg)) {
-            return arg;
-        }
-        if (typeof arg === 'object') {
-            const filteredObject = Object.keys(arg)
-                .filter((key) => !excludeProps.includes(key))
-                .reduce((acc, key) => {
-                acc[key] = arg[key];
-                return acc;
-            }, {});
-            // Check if the filtered object is empty
-            if (Object.keys(filteredObject).length === 0) {
-                return '';
-            }
-            return JSON.stringify(filteredObject);
-        }
-    }
-    catch (e) {
-        console.error(e);
-    }
-    return JSON.stringify(arg);
-}
-/**
- * High order function to construct compose code for filter factory functions
- *
- * @param func - filter factory function
- * @param funcName - name of the filter factory function. Needed if the function name is minified.
- * @param ignoreIndexes - Indexes of parameters to ignore in the generated composeCode
- * @returns filter factory function with composeCode property added to the filter
- */
-export function withComposeCode(func, funcName, ignoreIndexes = []) {
-    return function (...args) {
-        const argValues = args
-            .map((arg, index) => {
-            if (ignoreIndexes.includes(index)) {
-                return ''; // Placeholder for ignored parameters
-            }
-            return stringifyHelper(arg, ['guid']);
-        })
-            .join(', ')
-            // remove any number of trailing commas
-            .replace(/(,\s*)+$/, '');
-        const signature = `filterFactory.${funcName !== null && funcName !== void 0 ? funcName : func.name}(${argValues})`;
-        // Call the original function and get the filter
-        const filter = func(...args);
-        // Add the composeCode property
-        filter.composeCode = signature;
-        return filter;
-    };
-}