@sisense/sdk-data 0.14.0 → 0.15.0

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

@@ -339,3 +339,6 @@ export interface Filter extends Element {
      */
     filterJaql(): any;
 }
+export interface CustomFormulaContext {
+    [key: string]: Attribute | Measure;
+}

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

@@ -1,4 +1,4 @@
-import { Attribute, Measure, Filter, CalculatedMeasure, BaseMeasure } from '../interfaces.js';
+import { Attribute, Measure, Filter, CalculatedMeasure, BaseMeasure, CustomFormulaContext } from '../interfaces.js';
 import { ForecastFormulaOptions, TrendFormulaOptions } from '../../interfaces.js';
 /**
  * Defines the different numeric operators that can be used with numeric filters
@@ -32,6 +32,66 @@ export declare const RankingSortTypes: {
     Ascending: string;
     Descending: string;
 };
+/**
+ * Creates a calculated measure for a [valid custom formula](https://docs.sisense.com/main/SisenseLinux/dashboard-functions-reference.htm).
+ *
+ * Use square brackets within the `formula` to include dimensions or measures.
+ * Each unique dimension or measure included in the `formula` must be defined using a property:value pair in the `context` parameter.
+ *
+ * You can nest custom formulas by placing one inside the `formula` parameter of another
+ *
+ *
+ * Note: Shared formula must be fetched prior to use (see {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}).
+ *
+ * @example
+ * An example of constructing a `customFormula` using dimensions, measures, and nested custom formulas:
+ * ```tsx
+ *  const profitabilityRatio = measures.customFormula(
+ *   'Profitability Ratio',
+ *   '([totalRevenue] - SUM([cost])) / [totalRevenue]',
+ *   {
+ *     totalRevenue: measures.sum(DM.Commerce.Revenue),
+ *     cost: DM.Commerce.Cost,
+ *   },
+ * );
+ *
+ * const profitabilityRatioRank = measures.customFormula(
+ *   'Profitability Ratio Rank',
+ *   'RANK([profRatio], "ASC", "1224")',
+ *   {
+ *     profRatio: profitabilityRatio,
+ *   },
+ * );
+ *
+ * return (
+ *   <Chart
+ *     dataSet={DM.DataSource}
+ *     chartType="line"
+ *     dataOptions={{
+ *       category: [DM.Commerce.AgeRange],
+ *       value: [
+ *         profitabilityRatioRank,
+ *         {
+ *           column: measures.sum(DM.Commerce.Revenue, 'Total Revenue'),
+ *           showOnRightAxis: true,
+ *           chartType: 'column',
+ *         },
+ *         {
+ *           column: measures.sum(DM.Commerce.Cost, 'Total Cost'),
+ *           showOnRightAxis: true,
+ *           chartType: 'column',
+ *         },
+ *       ],
+ *     }}
+ *   />
+ * );
+ * ```
+ * @param title - Title of the measure to be displayed in legend
+ * @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 object that may be used in a chart or a query
+ */
+export declare function customFormula(title: string, formula: string, context: CustomFormulaContext): Attribute | Measure;
 /**
  * Creates a basic aggregated measure.
  * This is a base function to build other aggregation functions (e.g., `sum`, `average`, etc)

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

@@ -1,6 +1,9 @@
 import { DimensionalBaseMeasure, DimensionalCalculatedMeasure } from './measures.js';
-import { AggregationTypes, MetadataTypes } from '../types.js';
+import { AggregationTypes, MetadataTypes, Sort } from '../types.js';
 import { normalizeName } from '../base.js';
+import { mapValues } from 'lodash';
+import { DimensionalAttribute, DimensionalLevelAttribute } from '../attributes.js';
+import { isDatetime, isNumber } from './../simple-column-types.js';
 /**
  * Defines the different numeric operators that can be used with numeric filters
  *
@@ -70,6 +73,96 @@ function measureFunction(measure, name, func, options) {
     builder.push(')');
     return new DimensionalCalculatedMeasure(name, builder.join(''), context);
 }
+function transformCustomFormulaJaql(jaql) {
+    var _a;
+    const isFormulaJaql = 'formula' in jaql;
+    let sort;
+    if (jaql.sort) {
+        sort = jaql.sort === 'asc' ? Sort.Ascending : Sort.Descending;
+    }
+    if (isFormulaJaql) {
+        const context = mapValues((_a = jaql.context) !== null && _a !== void 0 ? _a : {}, (jaqlContextValue) => jaqlContextValue ? transformCustomFormulaJaql(jaqlContextValue) : {});
+        return new DimensionalCalculatedMeasure(jaql.title, jaql.formula, context, undefined, undefined, sort);
+    }
+    const hasAggregation = !!jaql.agg;
+    const isDatatypeDatetime = isDatetime(jaql.datatype);
+    const attributeType = isNumber(jaql.datatype)
+        ? MetadataTypes.NumericAttribute
+        : MetadataTypes.TextAttribute;
+    const attribute = isDatatypeDatetime
+        ? new DimensionalLevelAttribute(jaql.title, jaql.dim, DimensionalLevelAttribute.translateJaqlToGranularity(jaql), undefined, undefined, sort)
+        : new DimensionalAttribute(jaql.title, jaql.dim, attributeType, undefined, sort);
+    if (hasAggregation) {
+        return new DimensionalBaseMeasure(jaql.title, attribute, DimensionalBaseMeasure.aggregationFromJAQL(jaql.agg || ''), undefined, undefined, sort);
+    }
+    return attribute;
+}
+/**
+ * Creates a calculated measure for a [valid custom formula](https://docs.sisense.com/main/SisenseLinux/dashboard-functions-reference.htm).
+ *
+ * Use square brackets within the `formula` to include dimensions or measures.
+ * Each unique dimension or measure included in the `formula` must be defined using a property:value pair in the `context` parameter.
+ *
+ * You can nest custom formulas by placing one inside the `formula` parameter of another
+ *
+ *
+ * Note: Shared formula must be fetched prior to use (see {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}).
+ *
+ * @example
+ * An example of constructing a `customFormula` using dimensions, measures, and nested custom formulas:
+ * ```tsx
+ *  const profitabilityRatio = measures.customFormula(
+ *   'Profitability Ratio',
+ *   '([totalRevenue] - SUM([cost])) / [totalRevenue]',
+ *   {
+ *     totalRevenue: measures.sum(DM.Commerce.Revenue),
+ *     cost: DM.Commerce.Cost,
+ *   },
+ * );
+ *
+ * const profitabilityRatioRank = measures.customFormula(
+ *   'Profitability Ratio Rank',
+ *   'RANK([profRatio], "ASC", "1224")',
+ *   {
+ *     profRatio: profitabilityRatio,
+ *   },
+ * );
+ *
+ * return (
+ *   <Chart
+ *     dataSet={DM.DataSource}
+ *     chartType="line"
+ *     dataOptions={{
+ *       category: [DM.Commerce.AgeRange],
+ *       value: [
+ *         profitabilityRatioRank,
+ *         {
+ *           column: measures.sum(DM.Commerce.Revenue, 'Total Revenue'),
+ *           showOnRightAxis: true,
+ *           chartType: 'column',
+ *         },
+ *         {
+ *           column: measures.sum(DM.Commerce.Cost, 'Total Cost'),
+ *           showOnRightAxis: true,
+ *           chartType: 'column',
+ *         },
+ *       ],
+ *     }}
+ *   />
+ * );
+ * ```
+ * @param title - Title of the measure to be displayed in legend
+ * @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 object that may be used in a chart or a query
+ */
+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 });
+}
 function arithmetic(operand1, operator, operand2, name, withParentheses) {
     const builder = [];
     const context = {};

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

@@ -150,3 +150,55 @@ export declare const DateLevels: {
     /** @internal */
     readonly all: string[];
 };
+export declare enum DataType {
+    TEXT = "text",
+    NUMERIC = "numeric",
+    DATETIME = "datetime"
+}
+export declare enum SortDirection {
+    ASC = "asc",
+    DESC = "desc"
+}
+export declare type Jaql = BaseJaql | FormulaJaql | FilterJaql;
+export declare type BaseJaql = {
+    agg?: string;
+    datatype: DataType;
+    dim: string;
+    table: string;
+    column: string;
+    title: string;
+    level?: 'years' | 'quarters' | 'months' | 'weeks' | 'minutes' | 'days';
+    sort?: SortDirection;
+};
+export declare type FormulaID = string;
+export declare type FormulaContext = BaseJaql | FormulaJaql | FilterJaql;
+export declare type FormulaJaql = {
+    type?: 'measure';
+    sort?: SortDirection;
+    title: string;
+    formula: string;
+    context?: Record<FormulaID, FormulaContext>;
+};
+export declare type BaseFilter = IncludeAllFilter | IncludeMembersFilter | ExcludeMembersFilter;
+export declare type BackgroundFilter = BaseFilter & {
+    level?: 'string';
+};
+export declare type IncludeAllFilter = {
+    all: true;
+};
+export declare type IncludeMembersFilter = {
+    members: string[];
+};
+export declare type ExcludeMembersFilter = {
+    exclude: {
+        members: string[];
+    };
+};
+export declare type TurnOffMembersFilter = ExcludeMembersFilter & {
+    turnedOff: boolean;
+};
+export declare type FilterJaql = BaseJaql & {
+    filter: BaseFilter & {
+        filter?: BackgroundFilter | TurnOffMembersFilter;
+    };
+};

package/dist/dimensional-model/types.js

@@ -282,3 +282,14 @@ export const DateLevels = {
         ];
     },
 };
+export var DataType;
+(function (DataType) {
+    DataType["TEXT"] = "text";
+    DataType["NUMERIC"] = "numeric";
+    DataType["DATETIME"] = "datetime";
+})(DataType = DataType || (DataType = {}));
+export var SortDirection;
+(function (SortDirection) {
+    SortDirection["ASC"] = "asc";
+    SortDirection["DESC"] = "desc";
+})(SortDirection = SortDirection || (SortDirection = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-data",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -12,8 +12,9 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-rest-client": "^0.14.0",
+    "@sisense/sdk-rest-client": "^0.15.0",
     "guid-typescript": "^1.0.9",
+    "lodash": "^4.17.21",
     "numeral": "^2.0.6",
     "object-hash": "^3.0.0"
   },
@@ -37,6 +38,7 @@
   ],
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
+    "@types/lodash": "^4.14.201",
     "@types/numeral": "2.0.2",
     "@types/object-hash": "^3.0.5",
     "eslint": "^8.40.0",