@sisense/sdk-data 1.34.0 → 2.1.0

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

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rank = exports.forecast = exports.trend = exports.contribution = exports.pastYear = exports.pastQuarter = exports.pastMonth = exports.pastWeek = exports.pastDay = exports.diffPastYear = exports.diffPastQuarter = exports.diffPastMonth = exports.diffPastWeek = exports.difference = exports.growthPastYear = exports.growthPastQuarter = exports.growthPastMonth = exports.growthPastWeek = exports.growthRate = exports.growth = exports.runningSum = exports.weekToDateSum = exports.monthToDateSum = exports.quarterToDateSum = exports.yearToDateSum = exports.divide = exports.multiply = exports.subtract = exports.add = exports.measuredValue = exports.countDistinct = exports.count = exports.median = exports.max = exports.min = exports.avg = exports.average = exports.sum = exports.constant = exports.aggregate = exports.customFormula = exports.transformCustomFormulaJaql = exports.RankingSortTypes = exports.RankingTypes = void 0;
-const translatable_error_js_1 = require("../../translation/translatable-error.js");
-const utils_js_1 = require("../../utils.js");
+exports.rank = exports.forecast = exports.trend = exports.contribution = exports.pastYear = exports.pastQuarter = exports.pastMonth = exports.pastWeek = exports.pastDay = exports.diffPastYear = exports.diffPastQuarter = exports.diffPastMonth = exports.diffPastWeek = exports.difference = exports.growthPastYear = exports.growthPastQuarter = exports.growthPastMonth = exports.growthPastWeek = exports.growthRate = exports.growth = exports.runningSum = exports.weekToDateSum = exports.monthToDateSum = exports.quarterToDateSum = exports.yearToDateSum = exports.divide = exports.multiply = exports.subtract = exports.add = exports.measuredValue = exports.countDistinct = exports.count = exports.median = exports.max = exports.min = exports.avg = exports.average = exports.sum = exports.constant = exports.aggregate = exports.customFormula = exports.RankingSortTypes = exports.RankingTypes = void 0;
 const base_js_1 = require("../base.js");
+const compose_code_utils_js_1 = require("../compose-code-utils.js");
 const types_js_1 = require("../types.js");
 const measures_js_1 = require("./measures.js");
 /**
@@ -75,23 +74,6 @@ function measureFunction(measure, name, func, options) {
     builder.push(')');
     return new measures_js_1.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
- */
-function transformCustomFormulaJaql(jaql) {
-    const isFormulaJaql = 'formula' in jaql;
-    if (!isFormulaJaql) {
-        throw new translatable_error_js_1.TranslatableError('errors.measure.notAFormula');
-    }
-    return (0, utils_js_1.createCalculatedMeasureHelper)(jaql);
-}
-exports.transformCustomFormulaJaql = transformCustomFormulaJaql;
 /**
  * Creates a calculated measure for a valid custom formula built from [base functions](/guides/sdk/reference/functions.html#measured-value-functions).
  *
@@ -144,14 +126,11 @@ exports.transformCustomFormulaJaql = transformCustomFormulaJaql;
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-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 });
-}
-exports.customFormula = customFormula;
+exports.customFormula = (0, compose_code_utils_js_1.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 measures_js_1.DimensionalCalculatedMeasure(title, formula, newContext);
+}, 'customFormula');
 function arithmetic(operand1, operator, operand2, name, withParentheses) {
     const builder = [];
     const context = {};
@@ -185,10 +164,7 @@ function arithmetic(operand1, operator, operand2, name, withParentheses) {
  * @returns A measure instance
  * @group Aggregation
  */
-function aggregate(attribute, aggregationType, name, format) {
-    return new measures_js_1.DimensionalBaseMeasure(name !== null && name !== void 0 ? name : `${aggregationType.toString()} ${attribute.name}`, attribute, aggregationType, format);
-}
-exports.aggregate = aggregate;
+exports.aggregate = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, aggregationType, name, format) => new measures_js_1.DimensionalBaseMeasure(name !== null && name !== void 0 ? name : `${aggregationType.toString()} ${attribute.name}`, attribute, aggregationType, format), 'aggregate');
 /**
  * Creates a calculated measure from a numeric value.
  *
@@ -201,10 +177,7 @@ exports.aggregate = aggregate;
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-function constant(value) {
-    return new measures_js_1.DimensionalCalculatedMeasure(`${value}`, `${value}`, {});
-}
-exports.constant = constant;
+exports.constant = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((value) => new measures_js_1.DimensionalCalculatedMeasure(`${value}`, `${value}`, {}), 'constant');
 /**
  * Creates a sum aggregation measure over the given attribute.
  *
@@ -221,10 +194,7 @@ exports.constant = constant;
  * @returns A measure instance
  * @group Aggregation
  */
-function sum(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Sum, name, format);
-}
-exports.sum = sum;
+exports.sum = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Sum, name, format), 'sum');
 /**
  * Creates an average aggregation measure over the given attribute.
  *
@@ -241,10 +211,7 @@ exports.sum = sum;
  * @returns A measure instance
  * @group Aggregation
  */
-function average(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Average, name, format);
-}
-exports.average = average;
+exports.average = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Average, name, format), 'average');
 /**
  * {@inheritDoc average}
  *
@@ -253,12 +220,13 @@ exports.average = average;
  * ```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
  */
-function avg(attribute, name, format) {
-    return average(attribute, name, format);
-}
-exports.avg = avg;
+exports.avg = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Average, name, format), 'avg');
 /**
  * Creates a min aggregation measure over the given attribute.
  *
@@ -273,10 +241,7 @@ exports.avg = avg;
  * @returns A measure instance
  * @group Aggregation
  */
-function min(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Min, name, format);
-}
-exports.min = min;
+exports.min = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Min, name, format), 'min');
 /**
  * Creates a max aggregation measure over the given attribute.
  *
@@ -291,10 +256,7 @@ exports.min = min;
  * @returns A measure instance
  * @group Aggregation
  */
-function max(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Max, name, format);
-}
-exports.max = max;
+exports.max = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Max, name, format), 'max');
 /**
  * Creates a median aggregation measure over the given attribute.
  *
@@ -309,10 +271,7 @@ exports.max = max;
  * @returns A measure instance
  * @group Aggregation
  */
-function median(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Median, name, format);
-}
-exports.median = median;
+exports.median = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Median, name, format), 'median');
 /**
  * Creates a count aggregation measure over the given attribute.
  *
@@ -329,10 +288,7 @@ exports.median = median;
  * @returns A measure instance
  * @group Aggregation
  */
-function count(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.Count, name, format);
-}
-exports.count = count;
+exports.count = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.Count, name, format), 'count');
 /**
  * Creates a count distinct aggregation measure over the given attribute.
  *
@@ -349,10 +305,7 @@ exports.count = count;
  * @returns A measure instance
  * @group Aggregation
  */
-function countDistinct(attribute, name, format) {
-    return aggregate(attribute, types_js_1.AggregationTypes.CountDistinct, name, format);
-}
-exports.countDistinct = countDistinct;
+exports.countDistinct = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((attribute, name, format) => (0, exports.aggregate)(attribute, types_js_1.AggregationTypes.CountDistinct, name, format), 'countDistinct');
 /**
  * Creates a measured value with the given measure and set of filters.
  *
@@ -380,7 +333,7 @@ exports.countDistinct = countDistinct;
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-function measuredValue(measure, filters, name, format) {
+exports.measuredValue = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((measure, filters, name, format) => {
     const builder = [];
     const context = {};
     builder.push('(');
@@ -392,8 +345,7 @@ function measuredValue(measure, filters, name, format) {
     builder.push(')');
     const exp = builder.join('');
     return new measures_js_1.DimensionalCalculatedMeasure(name !== null && name !== void 0 ? name : exp, exp, context, format);
-}
-exports.measuredValue = measuredValue;
+}, 'measuredValue');
 /**
  * Creates a calculated measure by adding two given numbers or measures.
  *
@@ -410,10 +362,7 @@ exports.measuredValue = measuredValue;
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-function add(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '+', value2, name, withParentheses);
-}
-exports.add = add;
+exports.add = (0, compose_code_utils_js_1.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`.
  *
@@ -430,10 +379,7 @@ exports.add = add;
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-function subtract(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '-', value2, name, withParentheses);
-}
-exports.subtract = subtract;
+exports.subtract = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((value1, value2, name, withParentheses) => arithmetic(value1, '-', value2, name, withParentheses), 'subtract');
 /**
  * Creates a calculated measure by multiplying two given numbers or measures.
  *
@@ -450,10 +396,7 @@ exports.subtract = subtract;
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-function multiply(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '*', value2, name, withParentheses);
-}
-exports.multiply = multiply;
+exports.multiply = (0, compose_code_utils_js_1.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`.
  *
@@ -470,10 +413,7 @@ exports.multiply = multiply;
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-function divide(value1, value2, name, withParentheses) {
-    return arithmetic(value1, '/', value2, name, withParentheses);
-}
-exports.divide = divide;
+exports.divide = (0, compose_code_utils_js_1.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.
@@ -492,10 +432,7 @@ exports.divide = divide;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function yearToDateSum(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : 'YTD ' + measure.name, 'YTDSum');
-}
-exports.yearToDateSum = yearToDateSum;
+exports.yearToDateSum = (0, compose_code_utils_js_1.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.
@@ -514,10 +451,7 @@ exports.yearToDateSum = yearToDateSum;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function quarterToDateSum(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : 'QTD ' + name, 'QTDSum');
-}
-exports.quarterToDateSum = quarterToDateSum;
+exports.quarterToDateSum = (0, compose_code_utils_js_1.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.
@@ -536,10 +470,7 @@ exports.quarterToDateSum = quarterToDateSum;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function monthToDateSum(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'MTDSum');
-}
-exports.monthToDateSum = monthToDateSum;
+exports.monthToDateSum = (0, compose_code_utils_js_1.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.
@@ -558,10 +489,7 @@ exports.monthToDateSum = monthToDateSum;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function weekToDateSum(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : 'MTD ' + measure.name, 'WTDSum');
-}
-exports.weekToDateSum = weekToDateSum;
+exports.weekToDateSum = (0, compose_code_utils_js_1.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.
  *
@@ -590,10 +518,7 @@ exports.weekToDateSum = weekToDateSum;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function runningSum(measure, _continuous, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : 'Running Sum ' + measure.name, 'RSum');
-}
-exports.runningSum = runningSum;
+exports.runningSum = (0, compose_code_utils_js_1.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.
  *
@@ -621,10 +546,7 @@ exports.runningSum = runningSum;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growth(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growth');
-}
-exports.growth = growth;
+exports.growth = (0, compose_code_utils_js_1.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.
  *
@@ -652,10 +574,7 @@ exports.growth = growth;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growthRate(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthrate');
-}
-exports.growthRate = growthRate;
+exports.growthRate = (0, compose_code_utils_js_1.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.
  *
@@ -682,10 +601,7 @@ exports.growthRate = growthRate;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growthPastWeek(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastweek');
-}
-exports.growthPastWeek = growthPastWeek;
+exports.growthPastWeek = (0, compose_code_utils_js_1.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.
  *
@@ -712,10 +628,7 @@ exports.growthPastWeek = growthPastWeek;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growthPastMonth(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastmonth');
-}
-exports.growthPastMonth = growthPastMonth;
+exports.growthPastMonth = (0, compose_code_utils_js_1.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.
  *
@@ -742,10 +655,7 @@ exports.growthPastMonth = growthPastMonth;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growthPastQuarter(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastquarter');
-}
-exports.growthPastQuarter = growthPastQuarter;
+exports.growthPastQuarter = (0, compose_code_utils_js_1.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.
  *
@@ -772,10 +682,7 @@ exports.growthPastQuarter = growthPastQuarter;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function growthPastYear(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Growth', 'growthpastyear');
-}
-exports.growthPastYear = growthPastYear;
+exports.growthPastYear = (0, compose_code_utils_js_1.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.
@@ -794,10 +701,7 @@ exports.growthPastYear = growthPastYear;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function difference(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastperiod');
-}
-exports.difference = difference;
+exports.difference = (0, compose_code_utils_js_1.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.
@@ -815,10 +719,7 @@ exports.difference = difference;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function diffPastWeek(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastweek');
-}
-exports.diffPastWeek = diffPastWeek;
+exports.diffPastWeek = (0, compose_code_utils_js_1.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.
@@ -836,10 +737,7 @@ exports.diffPastWeek = diffPastWeek;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function diffPastMonth(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastmonth');
-}
-exports.diffPastMonth = diffPastMonth;
+exports.diffPastMonth = (0, compose_code_utils_js_1.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.
@@ -857,10 +755,7 @@ exports.diffPastMonth = diffPastMonth;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function diffPastQuarter(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastquarter');
-}
-exports.diffPastQuarter = diffPastQuarter;
+exports.diffPastQuarter = (0, compose_code_utils_js_1.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.
@@ -878,10 +773,7 @@ exports.diffPastQuarter = diffPastQuarter;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function diffPastYear(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Difference', 'diffpastyear');
-}
-exports.diffPastYear = diffPastYear;
+exports.diffPastYear = (0, compose_code_utils_js_1.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.
  *
@@ -895,10 +787,7 @@ exports.diffPastYear = diffPastYear;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function pastDay(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Day', 'pastday');
-}
-exports.pastDay = pastDay;
+exports.pastDay = (0, compose_code_utils_js_1.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.
  *
@@ -915,10 +804,7 @@ exports.pastDay = pastDay;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function pastWeek(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Week', 'pastweek');
-}
-exports.pastWeek = pastWeek;
+exports.pastWeek = (0, compose_code_utils_js_1.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.
  *
@@ -936,10 +822,7 @@ exports.pastWeek = pastWeek;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function pastMonth(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Month', 'pastmonth');
-}
-exports.pastMonth = pastMonth;
+exports.pastMonth = (0, compose_code_utils_js_1.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.
  *
@@ -957,10 +840,7 @@ exports.pastMonth = pastMonth;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function pastQuarter(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Quarter', 'pastquarter');
-}
-exports.pastQuarter = pastQuarter;
+exports.pastQuarter = (0, compose_code_utils_js_1.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.
  *
@@ -978,10 +858,7 @@ exports.pastQuarter = pastQuarter;
  * @returns A calculated measure instance
  * @group Time-based
  */
-function pastYear(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Year', 'pastyear');
-}
-exports.pastYear = pastYear;
+exports.pastYear = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((measure, name) => measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + '  Past Year', 'pastyear'), 'pastYear');
 /**
  * Creates a calculated contribution measure.
  *
@@ -1016,10 +893,7 @@ exports.pastYear = pastYear;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function contribution(measure, name) {
-    return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Contribution', 'contribution');
-}
-exports.contribution = contribution;
+exports.contribution = (0, compose_code_utils_js_1.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.
  *
@@ -1046,7 +920,7 @@ exports.contribution = contribution;
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-function trend(measure, name, options) {
+exports.trend = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((measure, name, options) => {
     let params;
     const adjustValues = (value) => value.replace('advancedSmoothing', 'smooth').replace('localEstimates', 'local');
     if (options) {
@@ -1057,8 +931,7 @@ function trend(measure, name, options) {
             .join(',');
     }
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Trend', 'trend', params);
-}
-exports.trend = trend;
+}, 'trend');
 /**
  * Creates a calculated measure that generates a forecast based on a specified measure employing
  * advanced autoML techniques.
@@ -1093,7 +966,7 @@ exports.trend = trend;
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-function forecast(measure, name, options) {
+exports.forecast = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((measure, name, options) => {
     let params;
     if (options) {
         // create ISO string values for any Date objects
@@ -1116,8 +989,7 @@ function forecast(measure, name, options) {
         params = '"forecastHorizon=3"';
     }
     return measureFunction(measure, name !== null && name !== void 0 ? name : measure.name + ' Forecast', 'forecast', params);
-}
-exports.forecast = forecast;
+}, 'forecast');
 /**
  * Creates a calculated measure that calculates the rank of a value in a list of values.
  *
@@ -1168,7 +1040,7 @@ exports.forecast = forecast;
  * @returns A calculated measure instance
  * @group Statistics
  */
-function rank(measure, name, sort = exports.RankingSortTypes.Descending, rankType = exports.RankingTypes.StandardCompetition, groupBy = []) {
+exports.rank = (0, compose_code_utils_js_1.withComposeCodeForMeasure)((measure, name, sort = exports.RankingSortTypes.Descending, rankType = exports.RankingTypes.StandardCompetition, groupBy = []) => {
     const builder = [];
     const context = {};
     builder.push('rank(');
@@ -1185,5 +1057,4 @@ function rank(measure, name, sort = exports.RankingSortTypes.Descending, rankTyp
         name = `${measure.name} rank`;
     }
     return new measures_js_1.DimensionalCalculatedMeasure(name, exp, context);
-}
-exports.rank = rank;
+}, 'rank');

package/dist/cjs/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
      *