@sisense/sdk-data 1.28.0 → 1.29.0

package/dist/utils.d.ts

@@ -1,7 +1,7 @@
 import { JaqlDataSource } from './dimensional-model/filters/utils/types.js';
-import { Attribute, Filter, FilterRelations, FilterRelationsJaql, SortDirection } from './dimensional-model/interfaces.js';
+import { Attribute, BaseMeasure, CalculatedMeasure, Filter, FilterRelations, FilterRelationsJaql, LevelAttribute, SortDirection } from './dimensional-model/interfaces.js';
 import { DataSource, DataSourceInfo } from './interfaces.js';
-import { FilterJaql, JaqlSortDirection, Sort } from './dimensional-model/types.js';
+import { FilterJaql, FormulaJaql, Jaql, JaqlSortDirection, Sort } from './dimensional-model/types.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -80,3 +80,75 @@ export declare function getColumnNameFromAttribute(attribute: Attribute): string
  * @internal
  */
 export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined): SortDirection;
+/**
+ * Creates an attribute or level attribute from the provided parameters
+ * @returns attribute or level attribute
+ *
+ * @internal
+ */
+export declare const createAttributeHelper: ({ dim, table, column, dataType, level, format, sort, title, dataSource, }: {
+    /** Dimension expression */
+    dim: string;
+    /** Table name */
+    table: string | undefined;
+    /** Column name */
+    column: string | undefined;
+    /** Data type */
+    dataType: string;
+    /** Date level */
+    level: string | undefined;
+    /** Format */
+    format: string | undefined;
+    /** Sort */
+    sort: string | undefined;
+    /** Attribute title */
+    title?: string | undefined;
+    /** Jaql data source */
+    dataSource?: JaqlDataSource | undefined;
+}) => Attribute | LevelAttribute;
+/**
+ * Creates a measure from the provided parameters
+ *
+ * @returns measure
+ *
+ * @internal
+ */
+export declare const createMeasureHelper: ({ dim, table, column, dataType, agg, level, format, sort, title, dataSource, }: {
+    /** Dimension expression */
+    dim: string;
+    /** Table name */
+    table: string | undefined;
+    /** Column name */
+    column: string;
+    /** Data type */
+    dataType: string;
+    /** Aggregation function */
+    agg: string;
+    /** Date level */
+    level: string | undefined;
+    /** Format */
+    format: string | undefined;
+    /** Sort */
+    sort: string | undefined;
+    /** Measure title */
+    title?: string | undefined;
+    /** Jaql data source */
+    dataSource?: JaqlDataSource | undefined;
+}) => BaseMeasure;
+/**
+ * Creates a measure from the provided parameters
+ *
+ * @returns calculated measure
+ *
+ * @internal
+ */
+export declare const createCalculatedMeasureHelper: (jaql: FormulaJaql) => CalculatedMeasure;
+/**
+ * Creates a dimensional element from a JAQL object.
+ * @param jaql - The JAQL object.
+ * @param datetimeFormat - The datetime format.
+ * @returns The created dimensional element.
+ *
+ * @internal
+ */
+export declare function createDimensionalElementFromJaql(jaql: Jaql, datetimeFormat?: string): Attribute | BaseMeasure | CalculatedMeasure | Filter;

package/dist/utils.js

@@ -1,7 +1,12 @@
 import cloneDeep from 'lodash-es/cloneDeep.js';
-import { isCascadingFilter } from './index.js';
+import mapValues from 'lodash-es/mapValues.js';
 import { createFilterFromJaqlInternal } from './dimensional-model/filters/utils/filter-from-jaql-util.js';
-import { JaqlSortDirection, Sort } from './dimensional-model/types.js';
+import { DataType, JaqlSortDirection, MetadataTypes, Sort, } from './dimensional-model/types.js';
+import { escapeSingleQuotes } from '@sisense/sdk-common';
+import { DimensionalBaseMeasure, DimensionalCalculatedMeasure, } from './dimensional-model/measures/measures.js';
+import { isCascadingFilter } from './dimensional-model/filters/filters.js';
+import { DimensionalAttribute, DimensionalLevelAttribute, normalizeAttributeName, } from './dimensional-model/attributes.js';
+import { isNumber } from './dimensional-model/simple-column-types.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -215,3 +220,129 @@ 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, level, format, sort, title, 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;
+    const sortEnum = convertSort(sort);
+    const isDataTypeDatetime = dataType === DataType.DATETIME;
+    if (isDataTypeDatetime) {
+        const dateLevel = DimensionalLevelAttribute.translateJaqlToGranularity({ level });
+        const composeCode = normalizeAttributeName(dimTable, dimColumn, level, DATA_MODEL_MODULE_NAME);
+        const levelAttribute = new DimensionalLevelAttribute(title !== null && title !== void 0 ? title : dimColumn, dim, dateLevel, format || DimensionalLevelAttribute.getDefaultFormatForGranularity(dateLevel), undefined, sortEnum, dataSource, composeCode);
+        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);
+    return attribute;
+};
+/**
+ * Creates a measure from the provided parameters
+ *
+ * @returns measure
+ *
+ * @internal
+ */
+export const createMeasureHelper = ({ dim, table, column, dataType, agg, level, format, sort, title, dataSource, }) => {
+    const sortEnum = convertSort(sort);
+    const attribute = createAttributeHelper({
+        dim,
+        table,
+        column,
+        dataType,
+        level,
+        format,
+        sort,
+        title,
+        dataSource,
+    });
+    const tranformedAgg = DimensionalBaseMeasure.aggregationFromJAQL(agg);
+    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;
+        }, '') +
+        '}');
+};
+/**
+ * Creates a measure from the provided parameters
+ *
+ * @returns calculated measure
+ *
+ * @internal
+ */
+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);
+};
+/**
+ * Creates a dimensional element from a JAQL object.
+ * @param jaql - The JAQL object.
+ * @param datetimeFormat - The datetime format.
+ * @returns The created dimensional element.
+ *
+ * @internal
+ */
+export function createDimensionalElementFromJaql(jaql, datetimeFormat) {
+    const isFilterJaql = 'filter' in jaql;
+    if (isFilterJaql) {
+        return createFilterFromJaql(jaql);
+    }
+    const isFormulaJaql = 'formula' in jaql;
+    if (isFormulaJaql) {
+        return createCalculatedMeasureHelper(jaql);
+    }
+    const dataSource = 'datasource' in jaql ? jaql.datasource : undefined;
+    const hasAggregation = !!jaql.agg;
+    if (hasAggregation) {
+        return createMeasureHelper({
+            dim: jaql.dim,
+            table: jaql.table,
+            column: jaql.column,
+            dataType: jaql.datatype,
+            agg: jaql.agg || '',
+            level: jaql.level,
+            format: datetimeFormat,
+            sort: jaql.sort,
+            title: jaql.title,
+            dataSource,
+        });
+    }
+    return createAttributeHelper({
+        dim: jaql.dim,
+        table: jaql.table,
+        column: jaql.column,
+        dataType: jaql.datatype,
+        level: jaql.level,
+        format: datetimeFormat,
+        sort: jaql.sort,
+        title: jaql.title,
+        dataSource,
+    });
+}

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.28.0",
+  "version": "1.29.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.28.0",
-    "@sisense/sdk-rest-client": "^1.28.0",
+    "@sisense/sdk-common": "^1.29.0",
+    "@sisense/sdk-rest-client": "^1.29.0",
     "guid-typescript": "^1.0.9",
     "hash-it": "^6.0.0",
     "lodash-es": "^4.17.21",
@@ -55,6 +55,7 @@
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
     "@types/lodash": "^4.14.201",
+    "@types/lodash-es": "^4.17.12",
     "@types/numeral": "2.0.2",
     "eslint": "^8.40.0",
     "prettier": "2.8.4",

package/dist/cjs/dimensional-model/filter-relations.d.ts

@@ -1,9 +0,0 @@
-import { Filter, FilterRelations } from './interfaces.js';
-/**
- * Type guard for checking if the provided filters are FilterRelations.
- *
- * @param filters - The filters to check.
- * @returns `true` if the filters are FilterRelations, `false` otherwise.
- * @group Filter Utilities
- */
-export declare function isFilterRelations(filters: Filter[] | FilterRelations | undefined): filters is FilterRelations;

package/dist/cjs/dimensional-model/filter-relations.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFilterRelations = void 0;
-/**
- * Type guard for checking if the provided filters are FilterRelations.
- *
- * @param filters - The filters to check.
- * @returns `true` if the filters are FilterRelations, `false` otherwise.
- * @group Filter Utilities
- */
-function isFilterRelations(filters) {
-    return (!!filters &&
-        'operator' in filters &&
-        (filters.operator === 'AND' || filters.operator === 'OR') &&
-        !!filters.right &&
-        !!filters.left);
-}
-exports.isFilterRelations = isFilterRelations;

package/dist/dimensional-model/filter-relations.d.ts

@@ -1,9 +0,0 @@
-import { Filter, FilterRelations } from './interfaces.js';
-/**
- * Type guard for checking if the provided filters are FilterRelations.
- *
- * @param filters - The filters to check.
- * @returns `true` if the filters are FilterRelations, `false` otherwise.
- * @group Filter Utilities
- */
-export declare function isFilterRelations(filters: Filter[] | FilterRelations | undefined): filters is FilterRelations;

package/dist/dimensional-model/filter-relations.js

@@ -1,14 +0,0 @@
-/**
- * Type guard for checking if the provided filters are FilterRelations.
- *
- * @param filters - The filters to check.
- * @returns `true` if the filters are FilterRelations, `false` otherwise.
- * @group Filter Utilities
- */
-export function isFilterRelations(filters) {
-    return (!!filters &&
-        'operator' in filters &&
-        (filters.operator === 'AND' || filters.operator === 'OR') &&
-        !!filters.right &&
-        !!filters.left);
-}