@sisense/sdk-data 1.10.1 → 1.12.0

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

@@ -0,0 +1,47 @@
+import type { Attribute, Measure } from '../interfaces.js';
+/** @internal */
+export declare const BOX_WHISKER: {
+    BOX_MIN_VALUE_NAME: string;
+    BOX_MEDIAN_VALUE_NAME: string;
+    BOX_MAX_VALUE_NAME: string;
+    WHISKER_MIN_VALUE_NAME: string;
+    WHISKER_MAX_VALUE_NAME: string;
+    OUTLIER_COUNT_VALUE_NAME: string;
+    OUTLIER_MIN_VALUE_NAME: string;
+    OUTLIER_MAX_VALUE_NAME: string;
+};
+/**
+ * Returns an array of values for box whisker plot using interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing IQR values for box whisker plots.
+ */
+export declare function boxWhiskerIqrValues(target: Attribute): Measure[];
+/**
+ * Returns an array of extremum values for box whisker plot.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing extremum values for box whisker plots.
+ */
+export declare function boxWhiskerExtremumsValues(target: Attribute): Measure[];
+/**
+ * Returns an array of values for box whisker plot using standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing standard deviation values for box whisker plots.
+ */
+export declare function boxWhiskerStdDevValues(target: Attribute): Measure[];
+/**
+ * Returns an attribute representing outlier points based on interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using IQR.
+ */
+export declare const boxWhiskerIqrOutliers: (target: Attribute) => Attribute;
+/**
+ * Returns an attribute representing outlier points based on standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using standard deviation.
+ */
+export declare const boxWhiskerStdDevOutliers: (target: Attribute) => Attribute;

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

@@ -0,0 +1,151 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.boxWhiskerStdDevOutliers = exports.boxWhiskerIqrOutliers = exports.boxWhiskerStdDevValues = exports.boxWhiskerExtremumsValues = exports.boxWhiskerIqrValues = exports.BOX_WHISKER = void 0;
+const cloneDeep_js_1 = __importDefault(require("lodash/cloneDeep.js"));
+const factory_js_1 = require("../measures/factory.js");
+/** @internal */
+exports.BOX_WHISKER = {
+    BOX_MIN_VALUE_NAME: 'Box Min',
+    BOX_MEDIAN_VALUE_NAME: 'Box Median',
+    BOX_MAX_VALUE_NAME: 'Box Max',
+    WHISKER_MIN_VALUE_NAME: 'Whisker Min',
+    WHISKER_MAX_VALUE_NAME: 'Whisker Max',
+    OUTLIER_COUNT_VALUE_NAME: 'Outlier Count',
+    OUTLIER_MIN_VALUE_NAME: 'Outlier Min',
+    OUTLIER_MAX_VALUE_NAME: 'Outlier Max',
+};
+function boxWhiskerCommonValues(target) {
+    return [
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.BOX_MIN_VALUE_NAME, 'QUARTILE([Attr], 1)', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.BOX_MEDIAN_VALUE_NAME, 'MEDIAN([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.BOX_MAX_VALUE_NAME, 'QUARTILE([Attr], 3)', {
+            Attr: target,
+        }),
+    ];
+}
+/**
+ * Returns an array of values for box whisker plot using interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing IQR values for box whisker plots.
+ */
+function boxWhiskerIqrValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'LOWERWHISKERMAX_IQR([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'UPPERWHISKERMIN_IQR([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_COUNT_VALUE_NAME, 'OUTLIERSCOUNT_IQR([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+exports.boxWhiskerIqrValues = boxWhiskerIqrValues;
+/**
+ * Returns an array of extremum values for box whisker plot.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing extremum values for box whisker plots.
+ */
+function boxWhiskerExtremumsValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'MIN([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'MAX([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+exports.boxWhiskerExtremumsValues = boxWhiskerExtremumsValues;
+/**
+ * Returns an array of values for box whisker plot using standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing standard deviation values for box whisker plots.
+ */
+function boxWhiskerStdDevValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'LOWERWHISKERMAX_STDEVP([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'UPPERWHISKERMIN_STDEVP([Attr])', {
+            Attr: target,
+        }),
+        (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_COUNT_VALUE_NAME, 'OUTLIERSCOUNT_STDEVP([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+exports.boxWhiskerStdDevValues = boxWhiskerStdDevValues;
+/**
+ * Returns an attribute representing outlier points based on interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using IQR.
+ */
+const boxWhiskerIqrOutliers = (target) => {
+    const outliersAttrWithInnerFilter = (0, cloneDeep_js_1.default)(target);
+    const outliersMax = (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_MAX_VALUE_NAME, '(UPPERWHISKERMIN_IQR([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    const outliersMin = (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_MIN_VALUE_NAME, '(LOWERWHISKERMAX_IQR([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    outliersAttrWithInnerFilter.name = `${outliersAttrWithInnerFilter.name} (Outliers)`;
+    outliersAttrWithInnerFilter.jaql = () => {
+        return Object.assign(Object.assign({}, target.jaql(true)), { filter: {
+                or: [
+                    {
+                        fromNotEqual: outliersMax.jaql(true),
+                    },
+                    {
+                        toNotEqual: outliersMin.jaql(true),
+                    },
+                ],
+            } });
+    };
+    return outliersAttrWithInnerFilter;
+};
+exports.boxWhiskerIqrOutliers = boxWhiskerIqrOutliers;
+/**
+ * Returns an attribute representing outlier points based on standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using standard deviation.
+ */
+const boxWhiskerStdDevOutliers = (target) => {
+    const outliersAttrWithInnerFilter = (0, cloneDeep_js_1.default)(target);
+    const outliersMax = (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_MAX_VALUE_NAME, '(UPPERWHISKERMIN_STDEVP([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    const outliersMin = (0, factory_js_1.customFormula)(exports.BOX_WHISKER.OUTLIER_MIN_VALUE_NAME, '(LOWERWHISKERMAX_STDEVP([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    outliersAttrWithInnerFilter.jaql = () => {
+        return Object.assign(Object.assign({}, target.jaql(true)), { filter: {
+                or: [
+                    {
+                        fromNotEqual: outliersMax.jaql(true),
+                    },
+                    {
+                        toNotEqual: outliersMin.jaql(true),
+                    },
+                ],
+            } });
+    };
+    return outliersAttrWithInnerFilter;
+};
+exports.boxWhiskerStdDevOutliers = boxWhiskerStdDevOutliers;

package/dist/cjs/dimensional-model/analytics/factory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/dimensional-model/analytics/factory.test.js

@@ -0,0 +1,99 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const analyticsFactory = __importStar(require("./factory.js"));
+const attributes_js_1 = require("../attributes.js");
+const attribute = (0, attributes_js_1.createAttribute)({
+    name: 'text',
+    type: 'text',
+    expression: '[Text]',
+});
+function validateBoxWhiskerValues(values, targetAttribute, expectedFormulas) {
+    const valuesJaqls = values.map((v) => v.jaql(true));
+    expect(values).toHaveLength(expectedFormulas.length);
+    expectedFormulas.forEach((expectedFormula) => {
+        var _a;
+        const relatedValueJaql = valuesJaqls.find(({ formula }) => formula.includes(expectedFormula));
+        expect(relatedValueJaql).toBeDefined();
+        expect(((_a = relatedValueJaql === null || relatedValueJaql === void 0 ? void 0 : relatedValueJaql.context) === null || _a === void 0 ? void 0 : _a['[Attr]']).dim).toBe(targetAttribute.expression);
+    });
+}
+function validateBoxWhiskerOutliers(outliersAttr, targetAttribute, expectedFilterFormulas) {
+    expect(outliersAttr).toBeDefined();
+    const outliersAttrJaql = outliersAttr.jaql(true);
+    expect(outliersAttrJaql.dim).toBe(targetAttribute.expression);
+    expect(outliersAttrJaql.filter).toBeDefined();
+    expectedFilterFormulas.forEach((expectedFormula) => {
+        var _a;
+        const filterJaql = outliersAttrJaql.filter.or
+            .map(({ fromNotEqual, toNotEqual }) => (fromNotEqual || toNotEqual))
+            .find((formulaJaql) => formulaJaql.formula.includes(expectedFormula));
+        expect(filterJaql).toBeDefined();
+        expect(((_a = filterJaql === null || filterJaql === void 0 ? void 0 : filterJaql.context) === null || _a === void 0 ? void 0 : _a['[Attr]']).dim).toBe(targetAttribute.expression);
+    });
+}
+describe('analyticsFactory', () => {
+    test('analyticsFactory.boxWhiskerIqrValues()', () => {
+        validateBoxWhiskerValues(analyticsFactory.boxWhiskerIqrValues(attribute), attribute, [
+            'QUARTILE([Attr], 1)',
+            'MEDIAN([Attr])',
+            'QUARTILE([Attr], 3)',
+            'LOWERWHISKERMAX_IQR([Attr])',
+            'UPPERWHISKERMIN_IQR([Attr])',
+            'OUTLIERSCOUNT_IQR([Attr])',
+        ]);
+    });
+    test('analyticsFactory.boxWhiskerExtremumsValues()', () => {
+        validateBoxWhiskerValues(analyticsFactory.boxWhiskerExtremumsValues(attribute), attribute, [
+            'QUARTILE([Attr], 1)',
+            'MEDIAN([Attr])',
+            'QUARTILE([Attr], 3)',
+            'MIN([Attr])',
+            'MAX([Attr])',
+        ]);
+    });
+    test('analyticsFactory.boxWhiskerStdDevValues()', () => {
+        validateBoxWhiskerValues(analyticsFactory.boxWhiskerStdDevValues(attribute), attribute, [
+            'QUARTILE([Attr], 1)',
+            'MEDIAN([Attr])',
+            'QUARTILE([Attr], 3)',
+            'LOWERWHISKERMAX_STDEVP([Attr])',
+            'UPPERWHISKERMIN_STDEVP([Attr])',
+            'OUTLIERSCOUNT_STDEVP([Attr])',
+        ]);
+    });
+    test('analyticsFactory.boxWhiskerIqrOutliers()', () => {
+        validateBoxWhiskerOutliers(analyticsFactory.boxWhiskerIqrOutliers(attribute), attribute, [
+            '(UPPERWHISKERMIN_IQR([Attr]), all([Attr]))',
+            '(LOWERWHISKERMAX_IQR([Attr]), all([Attr]))',
+        ]);
+    });
+    test('analyticsFactory.boxWhiskerStdDevOutliers()', () => {
+        validateBoxWhiskerOutliers(analyticsFactory.boxWhiskerStdDevOutliers(attribute), attribute, [
+            '(UPPERWHISKERMIN_STDEVP([Attr]), all([Attr]))',
+            '(LOWERWHISKERMAX_STDEVP([Attr]), all([Attr]))',
+        ]);
+    });
+});

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

@@ -0,0 +1,139 @@
+import { Attribute, LevelAttribute } from './interfaces.js';
+import { Sort } from './types.js';
+import { DimensionalElement } from './base.js';
+/**
+ * @internal
+ */
+export declare const jaqlSimpleColumnType: (datatype: string) => string;
+/**
+ * @internal
+ */
+export declare class DimensionalAttribute extends DimensionalElement implements Attribute {
+    readonly expression: string;
+    protected _sort: Sort;
+    constructor(name: string, expression: string, type?: string, desc?: string, sort?: Sort);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets the sort definition of this instance
+     *
+     * @returns The Sort definition of this instance
+     */
+    getSort(): Sort;
+    /**
+     * Gets a sorted {@link Attribute} with the given definition
+     *
+     * @param sort - Sort definition
+     * @returns An instance representing the sorted {@link Attribute} of this instance
+     */
+    sort(sort: Sort): Attribute;
+    /**
+     * Gets the JAQL representation of this instance
+     *
+     * @param nested - defines whether the JAQL is nested within parent JAQL statement or a root JAQL element
+     */
+    jaql(nested?: boolean): any;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+}
+/**
+ * @internal
+ */
+export declare class DimensionalLevelAttribute extends DimensionalAttribute implements LevelAttribute {
+    private _format;
+    readonly granularity: string;
+    constructor(l: string, expression: string, granularity: string, format?: string, desc?: string, sort?: Sort);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets the sort definition of this instance
+     *
+     * @returns The Sort definition of this instance
+     */
+    getSort(): Sort;
+    /**
+     * Gets a sorted {@link LevelAttribute} with the given definition
+     *
+     * @param sort - Sort definition
+     * @returns An instance representing the sorted {@link LevelAttribute} of this instance
+     */
+    sort(sort: Sort): Attribute;
+    /**
+     * The string formatting of this instance
+     *
+     * @returns string formatting
+     */
+    getFormat(): string | undefined;
+    /**
+     * Gets a formatted {@link LevelAttribute} with the given definition
+     *
+     * @param format - Format string
+     * @returns An instance representing the formatted {@link LevelAttribute} of this instance
+     */
+    format(format: string): LevelAttribute;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets the JAQL representation of this instance
+     *
+     * @param nested - defines whether the JAQL is nested within parent JAQL statement or a root JAQL element
+     */
+    jaql(nested?: boolean): any;
+    /**
+     * Obtain the JAQL representation of the level that depends on the granularity
+     */
+    translateGranularityToJaql(): {
+        level: string;
+        dateTimeLevel?: undefined;
+        bucket?: undefined;
+    } | {
+        dateTimeLevel: string;
+        bucket: string;
+        level?: undefined;
+    } | {
+        level: string;
+        bucket: string;
+        dateTimeLevel?: undefined;
+    };
+    static translateJaqlToGranularity(json: any): string;
+    static getDefaultFormatForGranularity(granularity: string): string;
+}
+/**
+ * Creates an Attribute instance from the given JSON object.
+ * If the JSON object contains a granularity property, a {@link LevelAttribute} instance is created.
+ *
+ * This function is used in the generated data model code to create dimension attributes from an input data source.
+ *
+ * See also functions {@link createDimension} and {@link createDateDimension}.
+ *
+ * @param json - JSON object representing the attribute
+ * @returns An Attribute instance
+ * @group Data Model Utilities
+ */
+export declare function createAttribute(json: any): Attribute;
+/**
+ * Creates a LevelAttribute instance from the given JSON object.
+ *
+ * @param json - JSON object representing the level attribute
+ * @internal
+ */
+export declare function createLevel(json: any): LevelAttribute;
+/**
+ * Normalize attribute name
+ *
+ * @param tableName - Table name (e.g., Commerce Sales)
+ * @param columnName - Column name (e.g., Order Date)
+ * @param dateLevel - Date level (e.g., Years)
+ * @param modelName - module name (e.g., DM)
+ * @return full normalized attribute name (e.g., DM.CommerceSales.OrderDate.Years)
+ * @internal
+ */
+export declare function normalizeAttributeName(tableName: string, columnName: string, dateLevel?: string, modelName?: string): string;