@sisense/sdk-data 1.33.0 → 2.0.0

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

@@ -31,23 +31,22 @@ exports.createMeasure = exports.DimensionalMeasureTemplate = exports.Dimensional
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
-const m = __importStar(require("./factory.js"));
-const types_js_1 = require("../types.js");
-const base_js_1 = require("../base.js");
+const translatable_error_js_1 = require("../../translation/translatable-error.js");
 const attributes_js_1 = require("../attributes.js");
+const base_js_1 = require("../base.js");
 const factory_js_1 = require("../factory.js");
-const translatable_error_js_1 = require("../../translation/translatable-error.js");
+const types_js_1 = require("../types.js");
+const m = __importStar(require("./factory.js"));
 /**
  * @internal
  */
 class AbstractMeasure extends base_js_1.DimensionalElement {
-    constructor(name, type, format, desc, sort, composeCode) {
-        super(name, type, desc);
+    constructor(name, type, format, desc, sort, dataSource, composeCode) {
+        super(name, type, desc, dataSource, composeCode);
         this._sort = types_js_1.Sort.None;
         this._format = '#,#.00';
         this._format = format;
         this._sort = sort || types_js_1.Sort.None;
-        this.composeCode = composeCode;
     }
     /**
      * Gets the sort definition of this instance
@@ -68,8 +67,8 @@ class AbstractMeasure extends base_js_1.DimensionalElement {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
         if (this.getFormat() !== undefined) {
             result.format = this.getFormat();
         }
@@ -86,8 +85,8 @@ exports.AbstractMeasure = AbstractMeasure;
  * @internal
  */
 class DimensionalBaseMeasure extends AbstractMeasure {
-    constructor(name, attribute, agg, format, desc, sort, composeCode) {
-        super(name, types_js_1.MetadataTypes.BaseMeasure, format, desc, sort, composeCode);
+    constructor(name, attribute, agg, format, desc, sort, dataSource, composeCode) {
+        super(name, types_js_1.MetadataTypes.BaseMeasure, format, desc, sort, dataSource, composeCode);
         this.attribute = attribute;
         this.aggregation = agg;
     }
@@ -144,7 +143,7 @@ class DimensionalBaseMeasure extends AbstractMeasure {
      * @returns An instance representing the sorted {@link Measure} of this instance
      */
     sort(sort) {
-        return new DimensionalBaseMeasure(this.name, this.attribute, this.aggregation, this._format, this.description, sort, this.composeCode);
+        return new DimensionalBaseMeasure(this.name, this.attribute, this.aggregation, this._format, this.description, sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets a formatted {@link Measure} with the given definition
@@ -155,7 +154,7 @@ class DimensionalBaseMeasure extends AbstractMeasure {
      * @returns An instance representing the formatted {@link Measure} of this instance
      */
     format(format) {
-        return new DimensionalBaseMeasure(this.name, this.attribute, this.aggregation, format, this.description, this._sort, this.composeCode);
+        return new DimensionalBaseMeasure(this.name, this.attribute, this.aggregation, format, this.description, this._sort, this.dataSource, this.composeCode);
     }
     /**
      * gets the element's ID
@@ -166,10 +165,11 @@ class DimensionalBaseMeasure extends AbstractMeasure {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'DimensionalBaseMeasure';
         result.aggregation = this.aggregation;
-        result.attribute = this.attribute.serializable();
+        result.attribute = this.attribute.serialize();
         return result;
     }
     jaql(nested) {
@@ -194,8 +194,8 @@ exports.DimensionalBaseMeasure = DimensionalBaseMeasure;
  * @internal
  */
 class DimensionalCalculatedMeasure extends AbstractMeasure {
-    constructor(name, expression, context, format, desc, sort, composeCode) {
-        super(name, types_js_1.MetadataTypes.CalculatedMeasure, format, desc, sort, composeCode);
+    constructor(name, expression, context, format, desc, sort, dataSource, composeCode) {
+        super(name, types_js_1.MetadataTypes.CalculatedMeasure, format, desc, sort, dataSource, composeCode);
         this.expression = expression;
         this.context = context;
     }
@@ -206,7 +206,7 @@ class DimensionalCalculatedMeasure extends AbstractMeasure {
      * @returns An instance representing the sorted {@link Measure} of this instance
      */
     sort(sort) {
-        return new DimensionalCalculatedMeasure(this.name, this.expression, this.context, this._format, this.description, sort, this.composeCode);
+        return new DimensionalCalculatedMeasure(this.name, this.expression, this.context, this._format, this.description, sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets a formatted {@link Measure} with the given definition
@@ -217,7 +217,7 @@ class DimensionalCalculatedMeasure extends AbstractMeasure {
      * @returns An instance representing the formatted {@link Measure} of this instance
      */
     format(format) {
-        return new DimensionalCalculatedMeasure(this.name, this.expression, this.context, format, this.description, this._sort, this.composeCode);
+        return new DimensionalCalculatedMeasure(this.name, this.expression, this.context, format, this.description, this._sort, this.dataSource, this.composeCode);
     }
     /**
      * gets the element's ID
@@ -228,13 +228,14 @@ class DimensionalCalculatedMeasure extends AbstractMeasure {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'DimensionalCalculatedMeasure';
         result.expression = this.expression;
-        result.context = {};
-        Object.getOwnPropertyNames(this.context).forEach((p) => {
-            result.context[p] = this.context[p].serializable();
-        });
+        result.context = Object.fromEntries(Object.entries(this.context).map(([key, value]) => [
+            key,
+            value.serialize ? value.serialize(value) : value,
+        ]));
         return result;
     }
     jaql(nested) {
@@ -264,8 +265,8 @@ exports.DimensionalCalculatedMeasure = DimensionalCalculatedMeasure;
  * @internal
  */
 class DimensionalMeasureTemplate extends AbstractMeasure {
-    constructor(name, attribute, format, desc, sort) {
-        super(name, types_js_1.MetadataTypes.MeasureTemplate, format, desc, sort);
+    constructor(name, attribute, format, desc, sort, dataSource, composeCode) {
+        super(name, types_js_1.MetadataTypes.MeasureTemplate, format, desc, sort, dataSource, composeCode);
         this.attribute = attribute;
     }
     /**
@@ -277,9 +278,10 @@ class DimensionalMeasureTemplate extends AbstractMeasure {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
-        result.attribute = this.attribute.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'DimensionalMeasureTemplate';
+        result.attribute = this.attribute.serialize();
         return result;
     }
     /**
@@ -289,7 +291,7 @@ class DimensionalMeasureTemplate extends AbstractMeasure {
      * @returns An instance representing the sorted {@link MeasureTemplate} of this instance
      */
     sort(sort) {
-        return new DimensionalMeasureTemplate(this.name, this.attribute, this._format, this.description, sort);
+        return new DimensionalMeasureTemplate(this.name, this.attribute, this._format, this.description, sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets a formatted {@link Measure} with the given definition
@@ -298,7 +300,7 @@ class DimensionalMeasureTemplate extends AbstractMeasure {
      * @returns An instance representing the formatted {@link Measure} of this instance
      */
     format(format) {
-        return new DimensionalMeasureTemplate(this.name, this.attribute, format, this.description, this._sort);
+        return new DimensionalMeasureTemplate(this.name, this.attribute, format, this.description, this._sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets the JAQL representation of this instance

package/dist/cjs/dimensional-model/types.d.ts

@@ -1,9 +1,9 @@
-import { JaqlDataSource, type ConditionFilterJaql } from './filters/utils/types.js';
+import type { ConditionFilterJaql, JaqlDataSource, JaqlDataSourceForDto } from './filters/utils/types.js';
 import { Attribute } from './interfaces.js';
 /**
  * @internal
  */
-export type { JaqlDataSource };
+export type { JaqlDataSource, JaqlDataSourceForDto };
 /**
  * Different aggregation types
  */
@@ -141,24 +141,26 @@ export declare const MetadataTypes: {
  * Levels for {@link DateDimension}
  */
 export declare const DateLevels: {
-    Years: string;
-    Quarters: string;
-    Months: string;
-    Weeks: string;
-    Days: string;
-    Hours: string;
-    MinutesRoundTo30: string;
-    MinutesRoundTo15: string;
-    Minutes: string;
-    Seconds: string;
-    AggHours: string;
-    AggMinutesRoundTo30: string;
-    AggMinutesRoundTo15: string;
-    AggMinutesRoundTo1: string;
+    readonly Years: "Years";
+    readonly Quarters: "Quarters";
+    readonly Months: "Months";
+    readonly Weeks: "Weeks";
+    readonly Days: "Days";
+    readonly Hours: "Hours";
+    readonly MinutesRoundTo30: "MinutesRoundTo30";
+    readonly MinutesRoundTo15: "MinutesRoundTo15";
+    readonly Minutes: "Minutes";
+    readonly Seconds: "Seconds";
+    readonly AggHours: "AggHours";
+    readonly AggMinutesRoundTo30: "AggMinutesRoundTo30";
+    readonly AggMinutesRoundTo15: "AggMinutesRoundTo15";
+    readonly AggMinutesRoundTo1: "AggMinutesRoundTo1";
     /** @internal */
     readonly all: string[];
 };
 /** @internal */
+export declare type DateLevel = Exclude<(typeof DateLevels)[keyof typeof DateLevels], typeof DateLevels.all>;
+/** @internal */
 export declare enum DataType {
     TEXT = "text",
     NUMERIC = "numeric",
@@ -210,6 +212,7 @@ export declare type FormulaJaql = {
     title: string;
     formula: string;
     context?: Record<FormulaID, FormulaContext>;
+    datasource?: JaqlDataSource;
 };
 /** @internal */
 export declare type BaseFilterJaql = IncludeAllFilterJaql | IncludeMembersFilterJaql | ExcludeMembersFilterJaql | NumericFilterJaql | ConditionFilterJaql | AndFilterJaql<NumericFilterJaql | ConditionFilterJaql> | OrFilterJaql<NumericFilterJaql | ConditionFilterJaql>;
@@ -269,6 +272,27 @@ export declare type OrFilterJaql<FilterItem> = {
  * Abstract object with any unknown values
  */
 export declare type AnyObject = Record<string, any>;
+/**
+ * JSON Value
+ *
+ * @internal
+ */
+export declare type JSONValue = string | number | boolean | undefined | null | JSONArray | JSONObject;
+/**
+ * JSON Array
+ *
+ * @internal
+ */
+export interface JSONArray extends Array<JSONValue> {
+}
+/**
+ * JSON Object
+ *
+ * @internal
+ */
+export interface JSONObject {
+    [key: string]: JSONValue;
+}
 /**
  * @internal
  */
@@ -393,6 +417,7 @@ export declare type MetadataItemJaql = {
         sortingLastDimension?: boolean;
         initialized?: boolean;
     };
+    datasource?: JaqlDataSource;
 };
 /**
  * @internal

package/dist/cjs/index.d.ts

@@ -6,18 +6,18 @@ import './translation/initialize-i18n.js';
  * @group Data Model Utilities
  * Utility functions for creating attributes and dimensions in code.
  */
-export * from './interfaces.js';
-export * from './dimensional-model/types.js';
-export * from './dimensional-model/interfaces.js';
+export * from './dimensional-model/attributes.js';
 export * from './dimensional-model/base.js';
 export * from './dimensional-model/data-model.js';
-export * from './dimensional-model/attributes.js';
 export * from './dimensional-model/dimensions/index.js';
 export * from './dimensional-model/factory.js';
-export * from './dimensional-model/jaql-element.js';
-export * from './dimensional-model/filters/filters.js';
 export * from './dimensional-model/filters/filter-config-utils.js';
+export * from './dimensional-model/filters/filters.js';
 export { createFilterMatcher } from './dimensional-model/filters/utils/filter-matcher-utils.js';
+export * from './dimensional-model/interfaces.js';
+export * from './dimensional-model/jaql-element.js';
+export * from './dimensional-model/types.js';
+export * from './interfaces.js';
 /**
  * Functions to create date, text, or numeric filters on specified data.
  *
@@ -92,6 +92,6 @@ export * from './dimensional-model/simple-column-types.js';
  * @group Factories
  */
 export * as analyticsFactory from './dimensional-model/analytics/factory.js';
-export * from './utils.js';
 export * from './dimensional-model/filters/index.js';
 export { type TranslationDictionary, PACKAGE_NAMESPACE as translationNamespace, } from './translation/resources/index.js';
+export * from './utils.js';

package/dist/cjs/index.js

@@ -35,19 +35,19 @@ require("./translation/initialize-i18n.js");
  * @group Data Model Utilities
  * Utility functions for creating attributes and dimensions in code.
  */
-__exportStar(require("./interfaces.js"), exports);
-__exportStar(require("./dimensional-model/types.js"), exports);
-__exportStar(require("./dimensional-model/interfaces.js"), exports);
+__exportStar(require("./dimensional-model/attributes.js"), exports);
 __exportStar(require("./dimensional-model/base.js"), exports);
 __exportStar(require("./dimensional-model/data-model.js"), exports);
-__exportStar(require("./dimensional-model/attributes.js"), exports);
 __exportStar(require("./dimensional-model/dimensions/index.js"), exports);
 __exportStar(require("./dimensional-model/factory.js"), exports);
-__exportStar(require("./dimensional-model/jaql-element.js"), exports);
-__exportStar(require("./dimensional-model/filters/filters.js"), exports);
 __exportStar(require("./dimensional-model/filters/filter-config-utils.js"), exports);
+__exportStar(require("./dimensional-model/filters/filters.js"), exports);
 var filter_matcher_utils_js_1 = require("./dimensional-model/filters/utils/filter-matcher-utils.js");
 Object.defineProperty(exports, "createFilterMatcher", { enumerable: true, get: function () { return filter_matcher_utils_js_1.createFilterMatcher; } });
+__exportStar(require("./dimensional-model/interfaces.js"), exports);
+__exportStar(require("./dimensional-model/jaql-element.js"), exports);
+__exportStar(require("./dimensional-model/types.js"), exports);
+__exportStar(require("./interfaces.js"), exports);
 /**
  * Functions to create date, text, or numeric filters on specified data.
  *
@@ -122,7 +122,7 @@ __exportStar(require("./dimensional-model/simple-column-types.js"), exports);
  * @group Factories
  */
 exports.analyticsFactory = __importStar(require("./dimensional-model/analytics/factory.js"));
-__exportStar(require("./utils.js"), exports);
 __exportStar(require("./dimensional-model/filters/index.js"), exports);
 var index_js_1 = require("./translation/resources/index.js");
 Object.defineProperty(exports, "translationNamespace", { enumerable: true, get: function () { return index_js_1.PACKAGE_NAMESPACE; } });
+__exportStar(require("./utils.js"), exports);

package/dist/cjs/utils.d.ts

@@ -1,7 +1,7 @@
-import { JaqlDataSource } 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';
-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()
  *
@@ -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
  *
@@ -49,6 +55,14 @@ export declare function convertJaqlDataSource(dataSource: DataSource): JaqlDataS
  * @internal
  */
 export declare function convertSort(sort?: string): Sort;
+/**
+ * Converts a SortDirection to a Sort enum
+ *
+ * @param sortDirection - The SortDirection to convert
+ * @returns The converted Sort enum
+ * @internal
+ */
+export declare function convertSortDirectionToSort(sortDirection: SortDirection): Sort;
 /**
  * Creates a filter from a JAQL object.
  *
@@ -60,6 +74,15 @@ export declare function convertSort(sort?: string): Sort;
  * @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.
  *
@@ -86,21 +109,17 @@ export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined
  * @returns attribute or level attribute
  * @internal
  */
-export declare const createAttributeHelper: ({ dim, table, column, dataType, level, 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 level */
-    level: string | undefined;
+    /** Date granularity */
+    granularity?: string | undefined;
     /** Format */
-    format: string | undefined;
+    format?: string | undefined;
     /** Sort */
-    sort: string | undefined;
+    sort?: string | undefined;
     /** Attribute title */
     title?: string | undefined;
     /** Panel */
@@ -114,23 +133,19 @@ export declare const createAttributeHelper: ({ dim, table, column, dataType, lev
  * @returns measure
  * @internal
  */
-export declare const createMeasureHelper: ({ dim, table, column, dataType, agg, level, 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 level */
-    level: string | undefined;
+    /** Date granularity */
+    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 */
@@ -152,3 +167,11 @@ export declare const createCalculatedMeasureHelper: (jaql: FormulaJaql) => Calcu
  * @internal
  */
 export declare function createDimensionalElementFromJaql(jaql: Jaql, datetimeFormat?: string, panel?: string): Attribute | BaseMeasure | CalculatedMeasure | Filter;
+/**
+ * Returns the granularity from the provided JAQL object.
+ *
+ * @param jaql - The JAQL object.
+ * @returns string.
+ * @internal
+ */
+export declare function getGranularityFromJaql(jaql: BaseJaql | FilterJaql | FilterJaqlInternal | RankingFilterJaql): string | undefined;