@sisense/sdk-data 1.34.0 → 2.1.0

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

@@ -1,6 +1,5 @@
-import { TranslatableError } from '../../translation/translatable-error.js';
-import { createCalculatedMeasureHelper } from '../../utils.js';
 import { normalizeName } from '../base.js';
+import { withComposeCodeForMeasure } from '../compose-code-utils.js';
 import { AggregationTypes, MetadataTypes } from '../types.js';
 import { DimensionalBaseMeasure, DimensionalCalculatedMeasure } from './measures.js';
 /**
@@ -72,22 +71,6 @@ function measureFunction(measure, name, func, options) {
     builder.push(')');
     return new DimensionalCalculatedMeasure(name, builder.join(''), context);
 }
-/**
- * Transforms a custom formula jaql into a calculated measure instance.
- *
- * As custom formulas can be nested, the function performs a recursive transformation via a helper function.
- *
- * @param jaql - Custom formula jaql
- * @returns Calculated measure instance
- * @internal
- */
-export function transformCustomFormulaJaql(jaql) {
-    const isFormulaJaql = 'formula' in jaql;
-    if (!isFormulaJaql) {
-        throw new TranslatableError('errors.measure.notAFormula');
-    }
-    return createCalculatedMeasureHelper(jaql);
-}
 /**
  * Creates a calculated measure for a valid custom formula built from [base functions](/guides/sdk/reference/functions.html#measured-value-functions).
  *
@@ -140,13 +123,11 @@ export function transformCustomFormulaJaql(jaql) {
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export function customFormula(title, formula, context) {
-    const newContext = Object.entries(context).reduce((acc, [key, val]) => {
-        acc[`[${key}]`] = val.jaql().jaql;
-        return acc;
-    }, {});
-    return transformCustomFormulaJaql({ title, formula, context: newContext });
-}
+export const customFormula = withComposeCodeForMeasure((title, formula, context) => {
+    // context keys must be in brackets
+    const newContext = Object.fromEntries(Object.entries(context).map(([key, val]) => [key.startsWith('[') ? key : `[${key}]`, val]));
+    return new DimensionalCalculatedMeasure(title, formula, newContext);
+}, 'customFormula');
 function arithmetic(operand1, operator, operand2, name, withParentheses) {
     const builder = [];
     const context = {};
@@ -180,9 +161,7 @@ function arithmetic(operand1, operator, operand2, name, withParentheses) {
  * @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);
-}
+export const aggregate = withComposeCodeForMeasure((attribute, aggregationType, name, format) => new DimensionalBaseMeasure(name !== null && name !== void 0 ? name : `${aggregationType.toString()} ${attribute.name}`, attribute, aggregationType, format), 'aggregate');
 /**
  * Creates a calculated measure from a numeric value.
  *
@@ -195,9 +174,7 @@ export function aggregate(attribute, aggregationType, name, format) {
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export function constant(value) {
-    return new DimensionalCalculatedMeasure(`${value}`, `${value}`, {});
-}
+export const constant = withComposeCodeForMeasure((value) => new DimensionalCalculatedMeasure(`${value}`, `${value}`, {}), 'constant');
 /**
  * Creates a sum aggregation measure over the given attribute.
  *
@@ -214,9 +191,7 @@ export function constant(value) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function sum(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Sum, name, format);
-}
+export const sum = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Sum, name, format), 'sum');
 /**
  * Creates an average aggregation measure over the given attribute.
  *
@@ -233,9 +208,7 @@ export function sum(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function average(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Average, name, format);
-}
+export const average = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Average, name, format), 'average');
 /**
  * {@inheritDoc average}
  *
@@ -244,11 +217,13 @@ export function average(attribute, name, format) {
  * ```ts
  * measureFactory.avg(DM.Commerce.Cost)
  * ```
+ * @param attribute - Attribute to aggregate
+ * @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 avg(attribute, name, format) {
-    return average(attribute, name, format);
-}
+export const avg = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Average, name, format), 'avg');
 /**
  * Creates a min aggregation measure over the given attribute.
  *
@@ -263,9 +238,7 @@ export function avg(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function min(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Min, name, format);
-}
+export const min = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Min, name, format), 'min');
 /**
  * Creates a max aggregation measure over the given attribute.
  *
@@ -280,9 +253,7 @@ export function min(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function max(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Max, name, format);
-}
+export const max = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Max, name, format), 'max');
 /**
  * Creates a median aggregation measure over the given attribute.
  *
@@ -297,9 +268,7 @@ export function max(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function median(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Median, name, format);
-}
+export const median = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Median, name, format), 'median');
 /**
  * Creates a count aggregation measure over the given attribute.
  *
@@ -316,9 +285,7 @@ export function median(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function count(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.Count, name, format);
-}
+export const count = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.Count, name, format), 'count');
 /**
  * Creates a count distinct aggregation measure over the given attribute.
  *
@@ -335,9 +302,7 @@ export function count(attribute, name, format) {
  * @returns A measure instance
  * @group Aggregation
  */
-export function countDistinct(attribute, name, format) {
-    return aggregate(attribute, AggregationTypes.CountDistinct, name, format);
-}
+export const countDistinct = withComposeCodeForMeasure((attribute, name, format) => aggregate(attribute, AggregationTypes.CountDistinct, name, format), 'countDistinct');
 /**
  * Creates a measured value with the given measure and set of filters.
  *
@@ -365,7 +330,7 @@ export function countDistinct(attribute, name, format) {
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export function measuredValue(measure, filters, name, format) {
+export const measuredValue = withComposeCodeForMeasure((measure, filters, name, format) => {
     const builder = [];
     const context = {};
     builder.push('(');
@@ -377,7 +342,7 @@ export function measuredValue(measure, filters, name, format) {
     builder.push(')');
     const exp = builder.join('');
     return new DimensionalCalculatedMeasure(name !== null && name !== void 0 ? name : exp, exp, context, format);
-}
+}, 'measuredValue');
 /**
  * Creates a calculated measure by adding two given numbers or measures.
  *
@@ -394,9 +359,7 @@ export function measuredValue(measure, filters, name, format) {
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export function add(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '+', value2, name, withParentheses);
-}
+export const add = withComposeCodeForMeasure((value1, value2, name, withParentheses) => arithmetic(value1, '+', value2, name, withParentheses), 'add');
 /**
  * Creates a calculated measure by subtracting two given numbers or measures. Subtracts `value2` from `value1`.
  *
@@ -413,9 +376,7 @@ export function add(value1, value2, name, withParentheses) {
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export function subtract(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '-', value2, name, withParentheses);
-}
+export const subtract = withComposeCodeForMeasure((value1, value2, name, withParentheses) => arithmetic(value1, '-', value2, name, withParentheses), 'subtract');
 /**
  * Creates a calculated measure by multiplying two given numbers or measures.
  *
@@ -432,9 +393,7 @@ export function subtract(value1, value2, name, withParentheses) {
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export function multiply(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '*', value2, name, withParentheses);
-}
+export const multiply = withComposeCodeForMeasure((value1, value2, name, withParentheses) => arithmetic(value1, '*', value2, name, withParentheses), 'multiply');
 /**
  * Creates a calculated measure by dividing two given numbers or measures. Divides `value1` by `value2`.
  *
@@ -451,9 +410,7 @@ export function multiply(value1, value2, name, withParentheses) {
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export function divide(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '/', value2, name, withParentheses);
-}
+export const divide = withComposeCodeForMeasure((value1, value2, name, withParentheses) => arithmetic(value1, '/', value2, name, withParentheses), 'divide');
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the year up to the current day, week, month, or quarter.
@@ -472,9 +429,7 @@ export function divide(value1, value2, name, withParentheses) {
  * @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');
-}
+export const yearToDateSum = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : 'YTD ' + measure.name, 'YTDSum'), 'yearToDateSum');
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the quarter up to the current day, week, or month.
@@ -493,9 +448,7 @@ export function yearToDateSum(measure, name) {
  * @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');
-}
+export const quarterToDateSum = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : 'QTD ' + name, 'QTDSum'), 'quarterToDateSum');
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the month up to the current day or week.
@@ -514,9 +467,7 @@ export function quarterToDateSum(measure, name) {
  * @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');
-}
+export const monthToDateSum = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'MTDSum'), 'monthToDateSum');
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the week up to the current day.
@@ -535,9 +486,7 @@ export function monthToDateSum(measure, name) {
  * @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');
-}
+export const weekToDateSum = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'WTDSum'), 'weekToDateSum');
 /**
  * Creates a calculated measure that calculates the running total of a given measure.
  *
@@ -566,9 +515,7 @@ export function weekToDateSum(measure, name) {
  * @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');
-}
+export const runningSum = withComposeCodeForMeasure((measure, _continuous, name) => measureFunction(measure, name !== null && name !== void 0 ? name : 'Running Sum ' + measure.name, 'RSum'), 'runningSum');
 /**
  * Creates a calculated measure that calculates growth over a period of time.
  *
@@ -596,9 +543,7 @@ export function runningSum(measure, _continuous, name) {
  * @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');
-}
+export const growth = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growth'), 'growth');
 /**
  * Creates a calculated measure that calculates growth rate over a period of time.
  *
@@ -626,9 +571,7 @@ export function growth(measure, name) {
  * @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');
-}
+export const growthRate = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthrate'), 'growthRate');
 /**
  * Creates a calculated measure that calculates the growth from the previous week to the current week.
  *
@@ -655,9 +598,7 @@ export function growthRate(measure, name) {
  * @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');
-}
+export const growthPastWeek = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastweek'), 'growthPastWeek');
 /**
  * Creates a calculated measure that calculates the growth from the previous month to the current month.
  *
@@ -684,9 +625,7 @@ export function growthPastWeek(measure, name) {
  * @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');
-}
+export const growthPastMonth = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastmonth'), 'growthPastMonth');
 /**
  * Creates a calculated measure that calculates the growth from the previous quarter to the current quarter.
  *
@@ -713,9 +652,7 @@ export function growthPastMonth(measure, name) {
  * @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');
-}
+export const growthPastQuarter = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastquarter'), 'growthPastQuarter');
 /**
  * Creates a calculated measure that calculates the growth from the previous year to the current year.
  *
@@ -742,9 +679,7 @@ export function growthPastQuarter(measure, name) {
  * @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');
-}
+export const growthPastYear = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastyear'), 'growthPastYear');
 /**
  * Creates a calculated measure that calculates the difference between this period's data
  * and the data from the previous period for the given measure.
@@ -763,9 +698,7 @@ export function growthPastYear(measure, name) {
  * @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');
-}
+export const difference = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastperiod'), 'difference');
 /**
  * Creates a calculated measure that calculates the difference between this week's data
  * and the data from the previous week for the given measure.
@@ -783,9 +716,7 @@ export function difference(measure, name) {
  * @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');
-}
+export const diffPastWeek = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastweek'), 'diffPastWeek');
 /**
  * Creates a calculated measure that calculates the difference between this month's data
  * and the data from the previous month for the given measure.
@@ -803,9 +734,7 @@ export function diffPastWeek(measure, name) {
  * @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');
-}
+export const diffPastMonth = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastmonth'), 'diffPastMonth');
 /**
  * Creates a calculated measure that calculates the difference between this quarter's data
  * and the data from the previous quarter for the given measure.
@@ -823,9 +752,7 @@ export function diffPastMonth(measure, name) {
  * @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');
-}
+export const diffPastQuarter = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastquarter'), 'diffPastQuarter');
 /**
  * Creates a calculated measure that calculates the difference between this year's data
  * and the data from the previous year for the given measure.
@@ -843,9 +770,7 @@ export function diffPastQuarter(measure, name) {
  * @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');
-}
+export const diffPastYear = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastyear'), 'diffPastYear');
 /**
  * Creates a calculated measure that calculates the value for the previous day.
  *
@@ -859,9 +784,7 @@ export function diffPastYear(measure, name) {
  * @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');
-}
+export const pastDay = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Day', 'pastday'), 'pastDay');
 /**
  * Creates a calculated measure that calculates the value for the same day in the previous week.
  *
@@ -878,9 +801,7 @@ export function pastDay(measure, name) {
  * @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');
-}
+export const pastWeek = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Week', 'pastweek'), 'pastWeek');
 /**
  * Creates a calculated measure that calculates the value for the same day or week in the previous month.
  *
@@ -898,9 +819,7 @@ export function pastWeek(measure, name) {
  * @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');
-}
+export const pastMonth = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Month', 'pastmonth'), 'pastMonth');
 /**
  * Creates a calculated measure that calculates the value for the same day, week, or month in the previous quarter.
  *
@@ -918,9 +837,7 @@ export function pastMonth(measure, name) {
  * @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');
-}
+export const pastQuarter = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Quarter', 'pastquarter'), 'pastQuarter');
 /**
  * Creates a calculated measure that calculates the value for the same day, week, month, or quarter in the previous year.
  *
@@ -938,9 +855,7 @@ export function pastQuarter(measure, name) {
  * @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');
-}
+export const pastYear = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Year', 'pastyear'), 'pastYear');
 /**
  * Creates a calculated contribution measure.
  *
@@ -975,9 +890,7 @@ export function pastYear(measure, name) {
  * @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');
-}
+export const contribution = withComposeCodeForMeasure((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Contribution', 'contribution'), 'contribution');
 /**
  * Creates a calculated measure that computes a specified trend type for a given measure.
  *
@@ -1004,7 +917,7 @@ export function contribution(measure, name) {
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export function trend(measure, name, options) {
+export const trend = withComposeCodeForMeasure((measure, name, options) => {
     let params;
     const adjustValues = (value) => value.replace('advancedSmoothing', 'smooth').replace('localEstimates', 'local');
     if (options) {
@@ -1015,7 +928,7 @@ export function trend(measure, name, options) {
             .join(',');
     }
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Trend', 'trend', params);
-}
+}, 'trend');
 /**
  * Creates a calculated measure that generates a forecast based on a specified measure employing
  * advanced autoML techniques.
@@ -1050,7 +963,7 @@ export function trend(measure, name, options) {
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export function forecast(measure, name, options) {
+export const forecast = withComposeCodeForMeasure((measure, name, options) => {
     let params;
     if (options) {
         // create ISO string values for any Date objects
@@ -1073,7 +986,7 @@ export function forecast(measure, name, options) {
         params = '"forecastHorizon=3"';
     }
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Forecast', 'forecast', params);
-}
+}, 'forecast');
 /**
  * Creates a calculated measure that calculates the rank of a value in a list of values.
  *
@@ -1124,7 +1037,7 @@ export function forecast(measure, name, options) {
  * @returns A calculated measure instance
  * @group Statistics
  */
-export function rank(measure, name, sort = RankingSortTypes.Descending, rankType = RankingTypes.StandardCompetition, groupBy = []) {
+export const rank = withComposeCodeForMeasure((measure, name, sort = RankingSortTypes.Descending, rankType = RankingTypes.StandardCompetition, groupBy = []) => {
     const builder = [];
     const context = {};
     builder.push('rank(');
@@ -1141,4 +1054,4 @@ export function rank(measure, name, sort = RankingSortTypes.Descending, rankType
         name = `${measure.name} rank`;
     }
     return new DimensionalCalculatedMeasure(name, exp, context);
-}
+}, 'rank');

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

@@ -1,13 +1,13 @@
 import { DimensionalElement } from '../base.js';
 import { Attribute, BaseMeasure, CalculatedMeasure, Measure, MeasureContext, MeasureTemplate } from '../interfaces.js';
-import { Sort } from '../types.js';
+import { JaqlDataSource, JSONObject, Sort } from '../types.js';
 /**
  * @internal
  */
 export declare abstract class AbstractMeasure extends DimensionalElement {
     protected _sort: Sort;
     protected _format: string | undefined;
-    constructor(name: string, type: string, format?: string, desc?: string, sort?: Sort, composeCode?: string);
+    constructor(name: string, type: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -27,7 +27,7 @@ export declare abstract class AbstractMeasure extends DimensionalElement {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets a sorted {@link Measure} with the given definition
      *
@@ -51,7 +51,7 @@ export declare abstract class AbstractMeasure extends DimensionalElement {
 export declare class DimensionalBaseMeasure extends AbstractMeasure implements BaseMeasure {
     static aggregationFromJAQL(agg: string): string;
     static aggregationToJAQL(agg: string): string;
-    constructor(name: string, attribute: Attribute, agg: string, format?: string, desc?: string, sort?: Sort, composeCode?: string);
+    constructor(name: string, attribute: Attribute, agg: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Aggregating attribute
      */
@@ -83,7 +83,7 @@ export declare class DimensionalBaseMeasure extends AbstractMeasure implements B
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     jaql(nested?: boolean): any;
 }
 /**
@@ -93,7 +93,7 @@ export declare class DimensionalBaseMeasure extends AbstractMeasure implements B
  * @internal
  */
 export declare class DimensionalCalculatedMeasure extends AbstractMeasure implements CalculatedMeasure {
-    constructor(name: string, expression: string, context: MeasureContext, format?: string, desc?: string, sort?: Sort, composeCode?: string);
+    constructor(name: string, expression: string, context: MeasureContext, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Defines the Calculated measure's expression
      */
@@ -125,7 +125,7 @@ export declare class DimensionalCalculatedMeasure extends AbstractMeasure implem
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     jaql(nested?: boolean): any;
 }
 /**
@@ -134,7 +134,7 @@ export declare class DimensionalCalculatedMeasure extends AbstractMeasure implem
  * @internal
  */
 export declare class DimensionalMeasureTemplate extends AbstractMeasure implements MeasureTemplate {
-    constructor(name: string, attribute: Attribute, format?: string, desc?: string, sort?: Sort);
+    constructor(name: string, attribute: Attribute, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Aggregating attribute
      */
@@ -146,7 +146,7 @@ export declare class DimensionalMeasureTemplate extends AbstractMeasure implemen
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets a sorted {@link MeasureTemplate} with the given definition
      *