@sisense/sdk-data 1.33.0 → 2.0.0

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

@@ -1,6 +1,5 @@
-import { Attribute, Measure, Filter, CalculatedMeasure, BaseMeasure, CustomFormulaContext } from '../interfaces.js';
 import { ForecastFormulaOptions, TrendFormulaOptions } from '../../interfaces.js';
-import { CustomFormulaJaql } from '../filters/utils/types.js';
+import { Attribute, BaseMeasure, CalculatedMeasure, CustomFormulaContext, Filter, Measure } from '../interfaces.js';
 /**
  * Defines the different numeric operators that can be used with numeric filters
  *
@@ -33,16 +32,6 @@ export declare const RankingSortTypes: {
     Ascending: string;
     Descending: string;
 };
-/**
- * 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 declare function transformCustomFormulaJaql(jaql: CustomFormulaJaql): CalculatedMeasure;
 /**
  * Creates a calculated measure for a valid custom formula built from [base functions](/guides/sdk/reference/functions.html#measured-value-functions).
  *
@@ -95,7 +84,7 @@ export declare function transformCustomFormulaJaql(jaql: CustomFormulaJaql): Cal
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export declare function customFormula(title: string, formula: string, context: CustomFormulaContext): CalculatedMeasure;
+export declare const customFormula: (title: string, formula: string, context: CustomFormulaContext) => CalculatedMeasure;
 /**
  * Creates an aggregated measure.
  *
@@ -114,7 +103,7 @@ export declare function customFormula(title: string, formula: string, context: C
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function aggregate(attribute: Attribute, aggregationType: string, name?: string, format?: string): BaseMeasure;
+export declare const aggregate: (attribute: Attribute, aggregationType: string, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a calculated measure from a numeric value.
  *
@@ -127,7 +116,7 @@ export declare function aggregate(attribute: Attribute, aggregationType: string,
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export declare function constant(value: number): CalculatedMeasure;
+export declare const constant: (value: number) => CalculatedMeasure;
 /**
  * Creates a sum aggregation measure over the given attribute.
  *
@@ -144,7 +133,7 @@ export declare function constant(value: number): CalculatedMeasure;
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function sum(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const sum: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates an average aggregation measure over the given attribute.
  *
@@ -161,7 +150,7 @@ export declare function sum(attribute: Attribute, name?: string, format?: string
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function average(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const average: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * {@inheritDoc average}
  *
@@ -170,9 +159,13 @@ export declare function average(attribute: Attribute, name?: string, format?: st
  * ```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 declare function avg(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const avg: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a min aggregation measure over the given attribute.
  *
@@ -187,7 +180,7 @@ export declare function avg(attribute: Attribute, name?: string, format?: string
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function min(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const min: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a max aggregation measure over the given attribute.
  *
@@ -202,7 +195,7 @@ export declare function min(attribute: Attribute, name?: string, format?: string
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function max(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const max: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a median aggregation measure over the given attribute.
  *
@@ -217,7 +210,7 @@ export declare function max(attribute: Attribute, name?: string, format?: string
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function median(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const median: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a count aggregation measure over the given attribute.
  *
@@ -234,7 +227,7 @@ export declare function median(attribute: Attribute, name?: string, format?: str
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function count(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const count: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a count distinct aggregation measure over the given attribute.
  *
@@ -251,7 +244,7 @@ export declare function count(attribute: Attribute, name?: string, format?: stri
  * @returns A measure instance
  * @group Aggregation
  */
-export declare function countDistinct(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+export declare const countDistinct: (attribute: Attribute, name?: string, format?: string) => BaseMeasure;
 /**
  * Creates a measured value with the given measure and set of filters.
  *
@@ -279,7 +272,7 @@ export declare function countDistinct(attribute: Attribute, name?: string, forma
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export declare function measuredValue(measure: Measure, filters: Filter[], name?: string, format?: string): CalculatedMeasure;
+export declare const measuredValue: (measure: Measure, filters: Filter[], name?: string, format?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure by adding two given numbers or measures.
  *
@@ -296,7 +289,7 @@ export declare function measuredValue(measure: Measure, filters: Filter[], name?
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export declare function add(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+export declare const add: (value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean) => CalculatedMeasure;
 /**
  * Creates a calculated measure by subtracting two given numbers or measures. Subtracts `value2` from `value1`.
  *
@@ -313,7 +306,7 @@ export declare function add(value1: Measure | number, value2: Measure | number,
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export declare function subtract(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+export declare const subtract: (value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean) => CalculatedMeasure;
 /**
  * Creates a calculated measure by multiplying two given numbers or measures.
  *
@@ -330,7 +323,7 @@ export declare function subtract(value1: Measure | number, value2: Measure | num
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export declare function multiply(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+export declare const multiply: (value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean) => CalculatedMeasure;
 /**
  * Creates a calculated measure by dividing two given numbers or measures. Divides `value1` by `value2`.
  *
@@ -347,7 +340,7 @@ export declare function multiply(value1: Measure | number, value2: Measure | num
  * @returns A calculated measure instance
  * @group Arithmetic
  */
-export declare function divide(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+export declare const divide: (value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean) => CalculatedMeasure;
 /**
  * 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.
@@ -366,7 +359,7 @@ export declare function divide(value1: Measure | number, value2: Measure | numbe
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function yearToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+export declare const yearToDateSum: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the quarter up to the current day, week, or month.
@@ -385,7 +378,7 @@ export declare function yearToDateSum(measure: Measure, name?: string): Calculat
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function quarterToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+export declare const quarterToDateSum: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the month up to the current day or week.
@@ -404,7 +397,7 @@ export declare function quarterToDateSum(measure: Measure, name?: string): Calcu
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function monthToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+export declare const monthToDateSum: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the running total starting from the beginning
  * of the week up to the current day.
@@ -423,7 +416,7 @@ export declare function monthToDateSum(measure: Measure, name?: string): Calcula
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function weekToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+export declare const weekToDateSum: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the running total of a given measure.
  *
@@ -452,7 +445,7 @@ export declare function weekToDateSum(measure: Measure, name?: string): Calculat
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function runningSum(measure: Measure, _continuous?: boolean, name?: string): CalculatedMeasure;
+export declare const runningSum: (measure: Measure, _continuous?: boolean, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates growth over a period of time.
  *
@@ -480,7 +473,7 @@ export declare function runningSum(measure: Measure, _continuous?: boolean, name
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growth(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growth: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates growth rate over a period of time.
  *
@@ -508,7 +501,7 @@ export declare function growth(measure: Measure, name?: string): CalculatedMeasu
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growthRate(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growthRate: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the growth from the previous week to the current week.
  *
@@ -535,7 +528,7 @@ export declare function growthRate(measure: Measure, name?: string): CalculatedM
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growthPastWeek(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growthPastWeek: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the growth from the previous month to the current month.
  *
@@ -562,7 +555,7 @@ export declare function growthPastWeek(measure: Measure, name?: string): Calcula
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growthPastMonth(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growthPastMonth: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the growth from the previous quarter to the current quarter.
  *
@@ -589,7 +582,7 @@ export declare function growthPastMonth(measure: Measure, name?: string): Calcul
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growthPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growthPastQuarter: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the growth from the previous year to the current year.
  *
@@ -616,7 +609,7 @@ export declare function growthPastQuarter(measure: Measure, name?: string): Calc
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function growthPastYear(measure: Measure, name?: string): CalculatedMeasure;
+export declare const growthPastYear: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the difference between this period's data
  * and the data from the previous period for the given measure.
@@ -635,7 +628,7 @@ export declare function growthPastYear(measure: Measure, name?: string): Calcula
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function difference(measure: Measure, name?: string): CalculatedMeasure;
+export declare const difference: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the difference between this week's data
  * and the data from the previous week for the given measure.
@@ -653,7 +646,7 @@ export declare function difference(measure: Measure, name?: string): CalculatedM
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function diffPastWeek(measure: Measure, name?: string): CalculatedMeasure;
+export declare const diffPastWeek: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the difference between this month's data
  * and the data from the previous month for the given measure.
@@ -671,7 +664,7 @@ export declare function diffPastWeek(measure: Measure, name?: string): Calculate
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function diffPastMonth(measure: Measure, name?: string): CalculatedMeasure;
+export declare const diffPastMonth: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the difference between this quarter's data
  * and the data from the previous quarter for the given measure.
@@ -689,7 +682,7 @@ export declare function diffPastMonth(measure: Measure, name?: string): Calculat
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function diffPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+export declare const diffPastQuarter: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the difference between this year's data
  * and the data from the previous year for the given measure.
@@ -707,7 +700,7 @@ export declare function diffPastQuarter(measure: Measure, name?: string): Calcul
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function diffPastYear(measure: Measure, name?: string): CalculatedMeasure;
+export declare const diffPastYear: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the value for the previous day.
  *
@@ -721,7 +714,7 @@ export declare function diffPastYear(measure: Measure, name?: string): Calculate
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function pastDay(measure: Measure, name?: string): CalculatedMeasure;
+export declare const pastDay: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the value for the same day in the previous week.
  *
@@ -738,7 +731,7 @@ export declare function pastDay(measure: Measure, name?: string): CalculatedMeas
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function pastWeek(measure: Measure, name?: string): CalculatedMeasure;
+export declare const pastWeek: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the value for the same day or week in the previous month.
  *
@@ -756,7 +749,7 @@ export declare function pastWeek(measure: Measure, name?: string): CalculatedMea
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function pastMonth(measure: Measure, name?: string): CalculatedMeasure;
+export declare const pastMonth: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the value for the same day, week, or month in the previous quarter.
  *
@@ -774,7 +767,7 @@ export declare function pastMonth(measure: Measure, name?: string): CalculatedMe
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function pastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+export declare const pastQuarter: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the value for the same day, week, month, or quarter in the previous year.
  *
@@ -792,7 +785,7 @@ export declare function pastQuarter(measure: Measure, name?: string): Calculated
  * @returns A calculated measure instance
  * @group Time-based
  */
-export declare function pastYear(measure: Measure, name?: string): CalculatedMeasure;
+export declare const pastYear: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated contribution measure.
  *
@@ -827,7 +820,7 @@ export declare function pastYear(measure: Measure, name?: string): CalculatedMea
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function contribution(measure: Measure, name?: string): CalculatedMeasure;
+export declare const contribution: (measure: Measure, name?: string) => CalculatedMeasure;
 /**
  * Creates a calculated measure that computes a specified trend type for a given measure.
  *
@@ -854,7 +847,7 @@ export declare function contribution(measure: Measure, name?: string): Calculate
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export declare function trend(measure: Measure, name?: string, options?: TrendFormulaOptions): CalculatedMeasure;
+export declare const trend: (measure: Measure, name?: string, options?: TrendFormulaOptions) => CalculatedMeasure;
 /**
  * Creates a calculated measure that generates a forecast based on a specified measure employing
  * advanced autoML techniques.
@@ -889,7 +882,7 @@ export declare function trend(measure: Measure, name?: string, options?: TrendFo
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export declare function forecast(measure: Measure, name?: string, options?: ForecastFormulaOptions): CalculatedMeasure;
+export declare const forecast: (measure: Measure, name?: string, options?: ForecastFormulaOptions) => CalculatedMeasure;
 /**
  * Creates a calculated measure that calculates the rank of a value in a list of values.
  *
@@ -940,4 +933,4 @@ export declare function forecast(measure: Measure, name?: string, options?: Fore
  * @returns A calculated measure instance
  * @group Statistics
  */
-export declare function rank(measure: Measure, name?: string, sort?: string, rankType?: string, groupBy?: Attribute[]): CalculatedMeasure;
+export declare const rank: (measure: Measure, name?: string, sort?: string, rankType?: string, groupBy?: Attribute[]) => CalculatedMeasure;