@sisense/sdk-data 1.4.1 → 1.6.0

package/dist/dimensional-model/attributes.d.ts

@@ -115,10 +115,13 @@ export declare class DimensionalLevelAttribute extends DimensionalAttribute impl
  *
  * @param json - JSON object representing the attribute
  * @returns An Attribute instance
+ * @group Data Model Utilities
  */
 export declare function createAttribute(json: any): Attribute;
 /**
- * @param json
+ * Creates a LevelAttribute instance from the given JSON object.
+ *
+ * @param json - JSON object representing the level attribute
  * @internal
  */
 export declare function createLevel(json: any): LevelAttribute;

package/dist/dimensional-model/attributes.js

@@ -264,15 +264,18 @@ export class DimensionalLevelAttribute extends DimensionalAttribute {
  *
  * @param json - JSON object representing the attribute
  * @returns An Attribute instance
+ * @group Data Model Utilities
  */
 export function createAttribute(json) {
     if (json.granularity) {
         return createLevel(json);
     }
-    return new DimensionalAttribute(json.name || json.title, json.attribute || json.expression || json.dim, json.type || json.desc || json.description);
+    return new DimensionalAttribute(json.name || json.title, json.attribute || json.expression || json.dim, json.type, json.desc || json.description);
 }
 /**
- * @param json
+ * Creates a LevelAttribute instance from the given JSON object.
+ *
+ * @param json - JSON object representing the level attribute
  * @internal
  */
 export function createLevel(json) {

package/dist/dimensional-model/base.js

@@ -42,5 +42,12 @@ export class DimensionalElement {
  * @internal
  */
 export function normalizeName(name) {
-    return name.replace(/[\/\\!#,+()$~%.'":*?<>{}\-` \[\]]/g, '');
+    // Remove all invalid characters
+    let normalizedName = name.replace(/[^a-zA-Z0-9_]/g, '');
+    // Prefix with '_' if it starts with a number
+    const firstChar = normalizedName.charAt(0);
+    if (firstChar.match(/[0-9]/)) {
+        normalizedName = '_' + normalizedName;
+    }
+    return normalizedName;
 }

package/dist/dimensional-model/data-model.d.ts

@@ -1,11 +1,11 @@
 import { DataModel, Element } from './interfaces.js';
-import { DataSource } from '../interfaces.js';
+import { DataSource, DataSourceInfo } from '../interfaces.js';
 /**
  * @internal
  */
 export declare class DimensionalDataModel implements DataModel {
     static fromConfig(config: any): DimensionalDataModel;
-    constructor(name: string, dataSource: DataSource, metadata: Element[]);
+    constructor(name: string, dataSource: DataSourceInfo, metadata: Element[]);
     readonly name: string;
     readonly dataSource: DataSource;
     readonly metadata: Element[];

package/dist/dimensional-model/dimensions.d.ts

@@ -150,6 +150,7 @@ export declare class DimensionalDateDimension extends DimensionalDimension imple
  *
  * @param json - JSON object representing the Dimension
  * @returns A new Dimension instance
+ * @group Data Model Utilities
  */
 export declare function createDimension(json: any): Dimension;
 /**
@@ -161,5 +162,6 @@ export declare function createDimension(json: any): Dimension;
  *
  * @param json - JSON object representing the Date Dimension
  * @returns A new Date Dimension instance
+ * @group Data Model Utilities
  */
 export declare function createDateDimension(json: any): DateDimension;

package/dist/dimensional-model/dimensions.js

@@ -238,6 +238,7 @@ export class DimensionalDateDimension extends DimensionalDimension {
  *
  * @param json - JSON object representing the Dimension
  * @returns A new Dimension instance
+ * @group Data Model Utilities
  */
 export function createDimension(json) {
     const name = json.name || json.title;
@@ -289,6 +290,7 @@ export function createDimension(json) {
  *
  * @param json - JSON object representing the Date Dimension
  * @returns A new Date Dimension instance
+ * @group Data Model Utilities
  */
 export function createDateDimension(json) {
     const name = json.name || json.title;

package/dist/dimensional-model/interfaces.d.ts

@@ -1,9 +1,11 @@
+import { DataSource } from '../interfaces.js';
 import { Sort } from './types.js';
 /**
  * @internal
  */
 export interface DataModel {
     readonly name: string;
+    readonly dataSource: DataSource;
     readonly metadata: Element[];
     [propName: string]: any;
 }

package/dist/dimensional-model/measures/factory.d.ts

@@ -70,6 +70,7 @@ export declare const RankingSortTypes: {
  * @param formula - Formula to be used for the measure
  * @param context - Formula context as a map of strings to measures or attributes
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export declare function customFormula(title: string, formula: string, context: CustomFormulaContext): Attribute | Measure;
 /**
@@ -88,6 +89,7 @@ export declare function customFormula(title: string, formula: string, context: C
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function aggregate(attribute: Attribute, aggregationType: string, name?: string, format?: string): BaseMeasure;
 /**
@@ -100,6 +102,7 @@ export declare function aggregate(attribute: Attribute, aggregationType: string,
  * ```
  * @param value - Value to be returned as a measure
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export declare function constant(value: number): CalculatedMeasure;
 /**
@@ -116,6 +119,7 @@ export declare function constant(value: number): CalculatedMeasure;
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function sum(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -130,6 +134,7 @@ export declare function sum(attribute: Attribute, name?: string, format?: string
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function average(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -144,6 +149,7 @@ export declare function average(attribute: Attribute, name?: string, format?: st
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function min(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -158,6 +164,7 @@ export declare function min(attribute: Attribute, name?: string, format?: string
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function max(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -172,6 +179,7 @@ export declare function max(attribute: Attribute, name?: string, format?: string
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function median(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -188,6 +196,7 @@ export declare function median(attribute: Attribute, name?: string, format?: str
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function count(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -204,6 +213,7 @@ export declare function count(attribute: Attribute, name?: string, format?: stri
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export declare function countDistinct(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
@@ -231,6 +241,7 @@ export declare function countDistinct(attribute: Attribute, name?: string, forma
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export declare function measuredValue(measure: Measure, filters: Filter[], name?: string, format?: string): CalculatedMeasure;
 /**
@@ -247,6 +258,7 @@ export declare function measuredValue(measure: Measure, filters: Filter[], name?
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export declare function add(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
 /**
@@ -263,6 +275,7 @@ export declare function add(value1: Measure | number, value2: Measure | number,
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export declare function subtract(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
 /**
@@ -279,6 +292,7 @@ export declare function subtract(value1: Measure | number, value2: Measure | num
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export declare function multiply(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
 /**
@@ -295,6 +309,7 @@ export declare function multiply(value1: Measure | number, value2: Measure | num
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export declare function divide(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
 /**
@@ -313,6 +328,7 @@ export declare function divide(value1: Measure | number, value2: Measure | numbe
  * @param measure - Measure to apply the YTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function yearToDateSum(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -331,6 +347,7 @@ export declare function yearToDateSum(measure: Measure, name?: string): Calculat
  * @param measure - Measure to apply the QTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function quarterToDateSum(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -349,6 +366,7 @@ export declare function quarterToDateSum(measure: Measure, name?: string): Calcu
  * @param measure - Measure to apply the MTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function monthToDateSum(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -367,6 +385,7 @@ export declare function monthToDateSum(measure: Measure, name?: string): Calcula
  * @param measure - Measure to apply the WTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function weekToDateSum(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -395,6 +414,7 @@ export declare function weekToDateSum(measure: Measure, name?: string): Calculat
  * when there are two or more dimensions. The default value is false.
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function runningSum(measure: Measure, _continuous?: boolean, name?: string): CalculatedMeasure;
 /**
@@ -422,6 +442,7 @@ export declare function runningSum(measure: Measure, _continuous?: boolean, name
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growth(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -449,6 +470,7 @@ export declare function growth(measure: Measure, name?: string): CalculatedMeasu
  * @param measure - Measure to apply the Growth rate
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growthRate(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -475,6 +497,7 @@ export declare function growthRate(measure: Measure, name?: string): CalculatedM
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growthPastWeek(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -501,6 +524,7 @@ export declare function growthPastWeek(measure: Measure, name?: string): Calcula
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growthPastMonth(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -527,6 +551,7 @@ export declare function growthPastMonth(measure: Measure, name?: string): Calcul
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growthPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -553,6 +578,7 @@ export declare function growthPastQuarter(measure: Measure, name?: string): Calc
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function growthPastYear(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -571,6 +597,7 @@ export declare function growthPastYear(measure: Measure, name?: string): Calcula
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function difference(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -588,6 +615,7 @@ export declare function difference(measure: Measure, name?: string): CalculatedM
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function diffPastWeek(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -605,6 +633,7 @@ export declare function diffPastWeek(measure: Measure, name?: string): Calculate
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function diffPastMonth(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -622,6 +651,7 @@ export declare function diffPastMonth(measure: Measure, name?: string): Calculat
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function diffPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -639,6 +669,7 @@ export declare function diffPastQuarter(measure: Measure, name?: string): Calcul
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function diffPastYear(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -652,6 +683,7 @@ export declare function diffPastYear(measure: Measure, name?: string): Calculate
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function pastDay(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -668,6 +700,7 @@ export declare function pastDay(measure: Measure, name?: string): CalculatedMeas
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function pastWeek(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -685,6 +718,7 @@ export declare function pastWeek(measure: Measure, name?: string): CalculatedMea
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function pastMonth(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -702,6 +736,7 @@ export declare function pastMonth(measure: Measure, name?: string): CalculatedMe
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function pastQuarter(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -719,6 +754,7 @@ export declare function pastQuarter(measure: Measure, name?: string): Calculated
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export declare function pastYear(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -753,6 +789,7 @@ export declare function pastYear(measure: Measure, name?: string): CalculatedMea
  * @param measure - Measure to apply the Contribution logic to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function contribution(measure: Measure, name?: string): CalculatedMeasure;
 /**
@@ -779,6 +816,7 @@ export declare function contribution(measure: Measure, name?: string): Calculate
  * @param name - Name for the new measure
  * @param options - Trend options
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export declare function trend(measure: Measure, name?: string, options?: TrendFormulaOptions): CalculatedMeasure;
 /**
@@ -813,6 +851,7 @@ export declare function trend(measure: Measure, name?: string, options?: TrendFo
  * @param name - Name for the new measure
  * @param options - Forecast options
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export declare function forecast(measure: Measure, name?: string, options?: ForecastFormulaOptions): CalculatedMeasure;
 /**
@@ -863,5 +902,6 @@ export declare function forecast(measure: Measure, name?: string, options?: Fore
  * @param rankType - How to handle equally ranked items. By default the type is standard competition ranking.
  * @param groupBy - Rank partition attributes
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export declare function rank(measure: Measure, name?: string, sort?: string, rankType?: string, groupBy?: Attribute[]): CalculatedMeasure;

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

@@ -135,6 +135,7 @@ function transformCustomFormulaJaql(jaql) {
  * @param formula - Formula to be used for the measure
  * @param context - Formula context as a map of strings to measures or attributes
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export function customFormula(title, formula, context) {
     const newContext = Object.entries(context).reduce((acc, [key, val]) => {
@@ -174,6 +175,7 @@ function arithmetic(operand1, operator, operand2, name, withParentheses) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function aggregate(attribute, aggregationType, name, format) {
     return new DimensionalBaseMeasure(name !== null && name !== void 0 ? name : `${aggregationType.toString()} ${attribute.name}`, attribute, aggregationType, format);
@@ -188,6 +190,7 @@ export function aggregate(attribute, aggregationType, name, format) {
  * ```
  * @param value - Value to be returned as a measure
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export function constant(value) {
     return new DimensionalCalculatedMeasure(`${value}`, `${value}`, {});
@@ -206,6 +209,7 @@ export function constant(value) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function sum(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Sum, name, format);
@@ -222,6 +226,7 @@ export function sum(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function average(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Average, name, format);
@@ -238,6 +243,7 @@ export function average(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function min(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Min, name, format);
@@ -254,6 +260,7 @@ export function min(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function max(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Max, name, format);
@@ -270,6 +277,7 @@ export function max(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function median(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Median, name, format);
@@ -288,6 +296,7 @@ export function median(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function count(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Count, name, format);
@@ -306,6 +315,7 @@ export function count(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A measure instance
+ * @group Aggregation
  */
 export function countDistinct(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.CountDistinct, name, format);
@@ -335,6 +345,7 @@ export function countDistinct(attribute, name, format) {
  * @param name - Optional name for the new measure
  * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export function measuredValue(measure, filters, name, format) {
     const builder = [];
@@ -363,6 +374,7 @@ export function measuredValue(measure, filters, name, format) {
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export function add(value1, value2, name, withParentheses) {
     return arithmetic(value1, '+', value2, name, withParentheses);
@@ -381,6 +393,7 @@ export function add(value1, value2, name, withParentheses) {
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export function subtract(value1, value2, name, withParentheses) {
     return arithmetic(value1, '-', value2, name, withParentheses);
@@ -399,6 +412,7 @@ export function subtract(value1, value2, name, withParentheses) {
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export function multiply(value1, value2, name, withParentheses) {
     return arithmetic(value1, '*', value2, name, withParentheses);
@@ -417,6 +431,7 @@ export function multiply(value1, value2, name, withParentheses) {
  * @param name - Optional name for the new measure
  * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
  * @returns A calculated measure instance
+ * @group Arithmetic
  */
 export function divide(value1, value2, name, withParentheses) {
     return arithmetic(value1, '/', value2, name, withParentheses);
@@ -437,6 +452,7 @@ export function divide(value1, value2, name, withParentheses) {
  * @param measure - Measure to apply the YTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function yearToDateSum(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : 'YTD ' + measure.name, 'YTDSum');
@@ -457,6 +473,7 @@ export function yearToDateSum(measure, name) {
  * @param measure - Measure to apply the QTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function quarterToDateSum(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : 'QTD ' + name, 'QTDSum');
@@ -477,6 +494,7 @@ export function quarterToDateSum(measure, name) {
  * @param measure - Measure to apply the MTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function monthToDateSum(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'MTDSum');
@@ -497,6 +515,7 @@ export function monthToDateSum(measure, name) {
  * @param measure - Measure to apply the WTD Sum to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function weekToDateSum(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'WTDSum');
@@ -527,6 +546,7 @@ export function weekToDateSum(measure, name) {
  * when there are two or more dimensions. The default value is false.
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function runningSum(measure, _continuous, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : 'Running Sum ' + measure.name, 'RSum');
@@ -556,6 +576,7 @@ export function runningSum(measure, _continuous, name) {
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growth(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growth');
@@ -585,6 +606,7 @@ export function growth(measure, name) {
  * @param measure - Measure to apply the Growth rate
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growthRate(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthrate');
@@ -613,6 +635,7 @@ export function growthRate(measure, name) {
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growthPastWeek(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastweek');
@@ -641,6 +664,7 @@ export function growthPastWeek(measure, name) {
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growthPastMonth(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastmonth');
@@ -669,6 +693,7 @@ export function growthPastMonth(measure, name) {
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growthPastQuarter(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastquarter');
@@ -697,6 +722,7 @@ export function growthPastQuarter(measure, name) {
  * @param measure - Measure to apply growth to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function growthPastYear(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastyear');
@@ -717,6 +743,7 @@ export function growthPastYear(measure, name) {
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function difference(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastperiod');
@@ -736,6 +763,7 @@ export function difference(measure, name) {
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function diffPastWeek(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastweek');
@@ -755,6 +783,7 @@ export function diffPastWeek(measure, name) {
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function diffPastMonth(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastmonth');
@@ -774,6 +803,7 @@ export function diffPastMonth(measure, name) {
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function diffPastQuarter(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastquarter');
@@ -793,6 +823,7 @@ export function diffPastQuarter(measure, name) {
  * @param measure - Measure to apply difference to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function diffPastYear(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastyear');
@@ -808,6 +839,7 @@ export function diffPastYear(measure, name) {
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function pastDay(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Day', 'pastday');
@@ -826,6 +858,7 @@ export function pastDay(measure, name) {
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function pastWeek(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Week', 'pastweek');
@@ -845,6 +878,7 @@ export function pastWeek(measure, name) {
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function pastMonth(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Month', 'pastmonth');
@@ -864,6 +898,7 @@ export function pastMonth(measure, name) {
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function pastQuarter(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Quarter', 'pastquarter');
@@ -883,6 +918,7 @@ export function pastQuarter(measure, name) {
  * @param measure - Measure to apply past value to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Time-based
  */
 export function pastYear(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Year', 'pastyear');
@@ -919,6 +955,7 @@ export function pastYear(measure, name) {
  * @param measure - Measure to apply the Contribution logic to
  * @param name - Name for the new measure
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function contribution(measure, name) {
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Contribution', 'contribution');
@@ -947,6 +984,7 @@ export function contribution(measure, name) {
  * @param name - Name for the new measure
  * @param options - Trend options
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export function trend(measure, name, options) {
     let params;
@@ -992,6 +1030,7 @@ export function trend(measure, name, options) {
  * @param name - Name for the new measure
  * @param options - Forecast options
  * @returns A calculated measure instance
+ * @group Advanced Analytics
  */
 export function forecast(measure, name, options) {
     let params;
@@ -1065,6 +1104,7 @@ export function forecast(measure, name, options) {
  * @param rankType - How to handle equally ranked items. By default the type is standard competition ranking.
  * @param groupBy - Rank partition attributes
  * @returns A calculated measure instance
+ * @group Statistics
  */
 export function rank(measure, name, sort = RankingSortTypes.Descending, rankType = RankingTypes.StandardCompetition, groupBy = []) {
     const builder = [];

package/dist/index.d.ts

@@ -1,6 +1,10 @@
 import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
+ * @group Factories
+ * Functions for creating measures, filters, and advanced analytics elements.
+ * @group Data Model Utilities
+ * Utility functions for creating attributes and dimensions in code.
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -42,6 +46,7 @@ export * from './dimensional-model/filters/filters.js';
  *   }
  *   return null;
  * ```
+ * @group Factories
  */
 export * as filterFactory from './dimensional-model/filters/factory.js';
 export * from './dimensional-model/measures/measures.js';
@@ -76,11 +81,14 @@ export * from './dimensional-model/measures/measures.js';
  *   }
  *   return null;
  * ```
+ * @group Factories
  */
 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
+ *
+ * @group Factories
  */
 export * as analyticsFactory from './dimensional-model/analytics/factory.js';
 export * from './utils.js';

package/dist/index.js

@@ -1,6 +1,10 @@
 import './translation/initialize-i18n.js';
 /**
  * @packageDocumentation
+ * @group Factories
+ * Functions for creating measures, filters, and advanced analytics elements.
+ * @group Data Model Utilities
+ * Utility functions for creating attributes and dimensions in code.
  */
 export * from './interfaces.js';
 export * from './dimensional-model/types.js';
@@ -42,6 +46,7 @@ export * from './dimensional-model/filters/filters.js';
  *   }
  *   return null;
  * ```
+ * @group Factories
  */
 export * as filterFactory from './dimensional-model/filters/factory.js';
 export * from './dimensional-model/measures/measures.js';
@@ -76,11 +81,14 @@ export * from './dimensional-model/measures/measures.js';
  *   }
  *   return null;
  * ```
+ * @group Factories
  */
 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
+ *
+ * @group Factories
  */
 export * as analyticsFactory from './dimensional-model/analytics/factory.js';
 export * from './utils.js';

package/dist/interfaces.d.ts

@@ -122,10 +122,17 @@ export interface CalculatedMeasureColumn {
      */
     title?: string;
 }
+/**
+ * Info of data source
+ */
+export declare type DataSourceInfo = {
+    title: string;
+    type: 'live' | 'elasticube';
+};
 /**
  * Data source for queries to run against
  */
-export declare type DataSource = string;
+export declare type DataSource = string | DataSourceInfo;
 /**
  * Data set, which is made up of an array of {@link Column | columns}
  * and a two-dimensional array of data {@link Cell | cells}.

package/dist/interfaces.js

@@ -13,5 +13,5 @@ export const EMPTY_PIVOT_QUERY_RESULT_DATA = {
  * @internal
  */
 export function isDataSource(arg) {
-    return arg === undefined || typeof arg === 'string';
+    return arg === undefined || typeof arg === 'string' || ('title' in arg && 'type' in arg);
 }

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { Filter, FilterRelations, FilterRelationsJaql } from './index.js';
+import { Filter, FilterRelations, FilterRelationsJaql, DataSource, DataSourceInfo } from './index.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -14,3 +14,13 @@ export declare const getFilterListAndRelations: (filterRelations: FilterRelation
     filters: Filter[] | undefined;
     relations: FilterRelationsJaql | undefined;
 };
+/**
+ * Gets the name of the data source
+ * @internal
+ */
+export declare function getDataSourceName(dataSource: DataSource): string;
+/**
+ * Checks if the provided 'dataSource' is a data source info structure that contains more than just the data source name.
+ * @internal
+ */
+export declare function isDataSourceInfo(dataSource: DataSource): dataSource is DataSourceInfo;

package/dist/utils.js

@@ -61,3 +61,17 @@ export const getFilterListAndRelations = (filterRelations) => {
     const relations = traverse(copiedFilterRelations);
     return { filters: Array.from(filters), relations };
 };
+/**
+ * Gets the name of the data source
+ * @internal
+ */
+export function getDataSourceName(dataSource) {
+    return typeof dataSource === 'string' ? dataSource : dataSource.title;
+}
+/**
+ * Checks if the provided 'dataSource' is a data source info structure that contains more than just the data source name.
+ * @internal
+ */
+export function isDataSourceInfo(dataSource) {
+    return typeof dataSource === 'object' && 'type' in dataSource && 'title' in dataSource;
+}

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.4.1",
+  "version": "1.6.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -23,8 +23,8 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^1.4.1",
-    "@sisense/sdk-rest-client": "^1.4.1",
+    "@sisense/sdk-common": "^1.6.0",
+    "@sisense/sdk-rest-client": "^1.6.0",
     "guid-typescript": "^1.0.9",
     "lodash": "^4.17.21",
     "numeral": "^2.0.6",