@sisense/sdk-data 1.11.0 → 1.12.0

package/dist/cjs/dimensional-model/types.js

@@ -0,0 +1,298 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/*
+ * Types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JaqlSortDirection = exports.DataType = exports.DateLevels = exports.MetadataTypes = exports.Sort = exports.AggregationTypes = void 0;
+/**
+ * Different aggregation types
+ */
+exports.AggregationTypes = {
+    /** Sum aggregation type */
+    Sum: 'sum',
+    /** Average aggregation type */
+    Average: 'avg',
+    /** Min aggregation type */
+    Min: 'min',
+    /** Max aggregation type */
+    Max: 'max',
+    /** Count aggregation type */
+    Count: 'count',
+    /** Count distinct aggregation type */
+    CountDistinct: 'countDistinct',
+    /** Median aggregation type */
+    Median: 'median',
+    /** Variance aggregation type */
+    Variance: 'var',
+    /** Standard deviation aggregation type */
+    StandardDeviation: 'stdev',
+};
+/**
+ * Different sort types.
+ */
+var Sort;
+(function (Sort) {
+    /** No sort definition  */
+    Sort[Sort["None"] = 0] = "None";
+    /** Sort Ascending */
+    Sort[Sort["Ascending"] = 1] = "Ascending";
+    /** Sort Descending */
+    Sort[Sort["Descending"] = 2] = "Descending";
+})(Sort = exports.Sort || (exports.Sort = {}));
+/**
+ * Different metadata types
+ *
+ * @internal
+ */
+exports.MetadataTypes = {
+    Measure: 'measure',
+    MeasureTemplate: 'measuretemplate',
+    BaseMeasure: 'basemeasure',
+    CalculatedMeasure: 'calculatedmeasure',
+    Dimension: 'dimension',
+    DateDimension: 'datedimension',
+    TextDimension: 'textdimension',
+    NumericDimension: 'numericdimension',
+    DateLevel: 'datelevel',
+    Attribute: 'attribute',
+    TextAttribute: 'text-attribute',
+    NumericAttribute: 'numeric-attribute',
+    Filter: 'filter',
+    DimensionFilter: 'dimensionfilter',
+    MeasureFilter: 'measurefilter',
+    /**
+     * Checks whether the given object or type is a metadata element
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a metadata element
+     */
+    isMetadata(o) {
+        return (exports.MetadataTypes.isMeasure(o) ||
+            exports.MetadataTypes.isDimension(o) ||
+            exports.MetadataTypes.isAttribute(o) ||
+            exports.MetadataTypes.isFilter(o));
+    },
+    /**
+     * Checks whether the given object or type is a measure template
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a measure template
+     */
+    isMeasureTemplate(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.MeasureTemplate;
+        }
+        return (o.agg === '*' ||
+            o.aggregation === '*' ||
+            (o.type && o.type.toLowerCase() === exports.MetadataTypes.MeasureTemplate));
+    },
+    /**
+     * Checks whether the given object or type is a base measure
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a base measure
+     */
+    isBaseMeasure(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.BaseMeasure;
+        }
+        return (o.agg || o.aggregation) && o.attribute && !this.isMeasureTemplate(o);
+    },
+    /**
+     * Checks whether the given object or type is a measure - of any type
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a measure - of any type
+     */
+    isMeasure(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return (type.toLowerCase() === exports.MetadataTypes.Measure ||
+                type.toLowerCase() === exports.MetadataTypes.BaseMeasure ||
+                type.toLowerCase() === exports.MetadataTypes.MeasureTemplate ||
+                type.toLowerCase() === exports.MetadataTypes.CalculatedMeasure);
+        }
+        return this.isBaseMeasure(o) || this.isCalculatedMeasure(o) || this.isMeasureTemplate(o);
+    },
+    /**
+     * Checks whether the given object or type is a calculated measure
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a calculated measure
+     */
+    isCalculatedMeasure(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.CalculatedMeasure;
+        }
+        return (o.expression || o.formula) && o.context;
+    },
+    /**
+     * Checks whether the given object or type is a date dimension
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a date dimension
+     */
+    isDateDimension(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.DateDimension;
+        }
+        return (o.dim || o.expression) && o.level;
+    },
+    /**
+     * Checks whether the given object or type is a text dimension
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a text dimension
+     */
+    isTextDimension(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.TextDimension;
+        }
+        return false;
+    },
+    /**
+     * Checks whether the given object or type is a numeric dimension
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a numeric dimension
+     */
+    isNumericDimension(o) {
+        if (!o) {
+            return false;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return type.toLowerCase() === exports.MetadataTypes.NumericDimension;
+        }
+        return false;
+    },
+    /**
+     * Checks whether the given object or type is a dimension - of any type
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a dimension - of any type
+     */
+    isDimension(o) {
+        if (typeof o === 'object') {
+            o = o.type;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return (type.toLowerCase() === exports.MetadataTypes.DateDimension ||
+                type.toLowerCase() === exports.MetadataTypes.Dimension ||
+                type.toLowerCase() === exports.MetadataTypes.TextDimension ||
+                type.toLowerCase() === exports.MetadataTypes.NumericDimension);
+        }
+        return false;
+    },
+    /**
+     * Checks whether the given object or type is an attribute - of any type
+     *
+     * @param o - object to check
+     * @returns true if the object or type is an attribute - of any type
+     */
+    isAttribute(o) {
+        if (typeof o === 'string') {
+            const type = o;
+            return (type.toLowerCase() === exports.MetadataTypes.Attribute ||
+                type.toLowerCase() === exports.MetadataTypes.TextAttribute ||
+                type.toLowerCase() === exports.MetadataTypes.NumericAttribute ||
+                type.toLowerCase() === exports.MetadataTypes.DateLevel);
+        }
+        if (o && o.type) {
+            return this.isAttribute(o.type);
+        }
+        return false;
+    },
+    /**
+     * Checks whether the given object or type is a filter
+     *
+     * @param o - object to check
+     * @returns true if the object or type is a filter
+     */
+    isFilter(o) {
+        if (typeof o === 'object') {
+            o = o.type;
+        }
+        if (typeof o === 'string') {
+            const type = o;
+            return (type.toLowerCase() === exports.MetadataTypes.Filter ||
+                type.toLowerCase() === exports.MetadataTypes.DimensionFilter ||
+                type.toLowerCase() === exports.MetadataTypes.MeasureFilter);
+        }
+        return false;
+    },
+};
+/**
+ * Levels for {@link DateDimension}
+ */
+exports.DateLevels = {
+    Years: 'Years',
+    Quarters: 'Quarters',
+    Months: 'Months',
+    Weeks: 'Weeks',
+    Days: 'Days',
+    Hours: 'Hours',
+    MinutesRoundTo30: 'MinutesRoundTo30',
+    MinutesRoundTo15: 'MinutesRoundTo15',
+    AggHours: 'AggHours',
+    AggMinutesRoundTo30: 'AggMinutesRoundTo30',
+    AggMinutesRoundTo15: 'AggMinutesRoundTo15',
+    AggMinutesRoundTo1: 'AggMinutesRoundTo1',
+    /** @internal */
+    get all() {
+        return [
+            exports.DateLevels.Years,
+            exports.DateLevels.Quarters,
+            exports.DateLevels.Months,
+            exports.DateLevels.Weeks,
+            exports.DateLevels.Days,
+            exports.DateLevels.Hours,
+            exports.DateLevels.MinutesRoundTo30,
+            exports.DateLevels.MinutesRoundTo15,
+            exports.DateLevels.AggHours,
+            exports.DateLevels.AggMinutesRoundTo30,
+            exports.DateLevels.AggMinutesRoundTo15,
+            exports.DateLevels.AggMinutesRoundTo1,
+        ];
+    },
+};
+/** @internal */
+var DataType;
+(function (DataType) {
+    DataType["TEXT"] = "text";
+    DataType["NUMERIC"] = "numeric";
+    DataType["DATETIME"] = "datetime";
+})(DataType = exports.DataType || (exports.DataType = {}));
+/** @internal */
+var JaqlSortDirection;
+(function (JaqlSortDirection) {
+    JaqlSortDirection["ASC"] = "asc";
+    JaqlSortDirection["DESC"] = "desc";
+})(JaqlSortDirection = exports.JaqlSortDirection || (exports.JaqlSortDirection = {}));

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

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

package/dist/cjs/dimensional-model/types.test.js

@@ -0,0 +1,33 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_js_1 = require("./types.js");
+describe('MetadataTypes', () => {
+    describe('isMeasure', () => {
+        it('should fail validation for an invalid measure', () => {
+            const measure = {
+                name: 'Quantity',
+                aggregation: 'sum',
+                title: 'Total Quantity',
+            };
+            expect(types_js_1.MetadataTypes.isMeasure(measure)).toBeFalsy();
+        });
+        it('should pass validation for a valid measure', () => {
+            const measure = {
+                name: 'sum Revenue',
+                type: 'basemeasure',
+                desc: '',
+                sort: 0,
+                aggregation: 'sum',
+                attribute: {
+                    name: 'Revenue',
+                    type: 'numeric-attribute',
+                    desc: '',
+                    expression: '[Commerce.Revenue]',
+                },
+            };
+            expect(types_js_1.MetadataTypes.isMeasure(measure)).toBeTruthy();
+        });
+    });
+});

package/dist/cjs/index.d.ts

@@ -0,0 +1,93 @@
+import './translation/initialize-i18n.js';
+/**
+ * @packageDocumentation
+ * @group Factories
+ * Functions for creating measures, filters, and advanced analytics elements.
+ * @group Data Model Utilities
+ * Utility functions for creating attributes and dimensions in code.
+ */
+export * from './interfaces.js';
+export * from './dimensional-model/types.js';
+export * from './dimensional-model/interfaces.js';
+export * from './dimensional-model/base.js';
+export * from './dimensional-model/data-model.js';
+export * from './dimensional-model/attributes.js';
+export * from './dimensional-model/dimensions.js';
+export * from './dimensional-model/factory.js';
+export * from './dimensional-model/filters/filters.js';
+export { createFilterMatcher } from './dimensional-model/filters/utils/filter-matcher-utils.js';
+/**
+ * Functions to create date, text, or numeric filters on specified data.
+ *
+ * Filters created with these functions can be used to:
+ *
+ * + Filter explicit queries by query components or query functions
+ * + Filter or highlight queries used by UI components, such as charts
+ * + Set the filters of filter components
+ *
+ * @example
+ * Example of using React hook `useExecuteQuery` to query the `Sample ECommerce` data source.
+ * Factory function `filterFactory.greaterThan()` is used to create a filter on `Revenue` to get values
+ * greater than 1000.
+ * ```tsx
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
+ * ```
+ * @group Factories
+ */
+export * as filterFactory from './dimensional-model/filters/factory.js';
+export * from './dimensional-model/measures/measures.js';
+/**
+ * Functions to create measures that aggregate, summarize, and accumulate data,
+ * plus show changes in data over time.
+ *
+ * Measures created with these functions can be used in the data options of UI components such as
+ * {@link @sisense/sdk-ui!ChartProps | Chart}, {@link @sisense/sdk-ui!ChartWidgetProps | ChartWidget},
+ * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
+ *
+ * @example
+ * Example of using React hook useExecuteQuery to query the `Sample ECommerce` data source.
+ * Factory function `measureFactory.sum()` is used to create a measure that sums the `Revenue` column.
+ * ```tsx
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
+ * ```
+ * @group Factories
+ */
+export * as measureFactory from './dimensional-model/measures/factory.js';
+export * from './dimensional-model/simple-column-types.js';
+/**
+ * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
+ *
+ * @group Factories
+ */
+export * as analyticsFactory from './dimensional-model/analytics/factory.js';
+export * from './utils.js';

package/dist/cjs/index.js

@@ -0,0 +1,123 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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 });
+exports.analyticsFactory = exports.measureFactory = exports.filterFactory = exports.createFilterMatcher = void 0;
+require("./translation/initialize-i18n.js");
+/**
+ * @packageDocumentation
+ * @group Factories
+ * Functions for creating measures, filters, and advanced analytics elements.
+ * @group Data Model Utilities
+ * Utility functions for creating attributes and dimensions in code.
+ */
+__exportStar(require("./interfaces.js"), exports);
+__exportStar(require("./dimensional-model/types.js"), exports);
+__exportStar(require("./dimensional-model/interfaces.js"), exports);
+__exportStar(require("./dimensional-model/base.js"), exports);
+__exportStar(require("./dimensional-model/data-model.js"), exports);
+__exportStar(require("./dimensional-model/attributes.js"), exports);
+__exportStar(require("./dimensional-model/dimensions.js"), exports);
+__exportStar(require("./dimensional-model/factory.js"), exports);
+__exportStar(require("./dimensional-model/filters/filters.js"), exports);
+var filter_matcher_utils_js_1 = require("./dimensional-model/filters/utils/filter-matcher-utils.js");
+Object.defineProperty(exports, "createFilterMatcher", { enumerable: true, get: function () { return filter_matcher_utils_js_1.createFilterMatcher; } });
+/**
+ * Functions to create date, text, or numeric filters on specified data.
+ *
+ * Filters created with these functions can be used to:
+ *
+ * + Filter explicit queries by query components or query functions
+ * + Filter or highlight queries used by UI components, such as charts
+ * + Set the filters of filter components
+ *
+ * @example
+ * Example of using React hook `useExecuteQuery` to query the `Sample ECommerce` data source.
+ * Factory function `filterFactory.greaterThan()` is used to create a filter on `Revenue` to get values
+ * greater than 1000.
+ * ```tsx
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
+ * ```
+ * @group Factories
+ */
+exports.filterFactory = __importStar(require("./dimensional-model/filters/factory.js"));
+__exportStar(require("./dimensional-model/measures/measures.js"), exports);
+/**
+ * Functions to create measures that aggregate, summarize, and accumulate data,
+ * plus show changes in data over time.
+ *
+ * Measures created with these functions can be used in the data options of UI components such as
+ * {@link @sisense/sdk-ui!ChartProps | Chart}, {@link @sisense/sdk-ui!ChartWidgetProps | ChartWidget},
+ * and {@link @sisense/sdk-ui!ExecuteQueryProps | ExecuteQuery}.
+ *
+ * @example
+ * Example of using React hook useExecuteQuery to query the `Sample ECommerce` data source.
+ * Factory function `measureFactory.sum()` is used to create a measure that sums the `Revenue` column.
+ * ```tsx
+ *   const { data, isLoading, isError } = useExecuteQuery({
+ *     dataSource: DM.DataSource,
+ *     dimensions: [DM.Commerce.AgeRange],
+ *     measures: [measureFactory.sum(DM.Commerce.Revenue)],
+ *     filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
+ *   });
+ *   if (isLoading) {
+ *     return <div>Loading...</div>;
+ *   }
+ *   if (isError) {
+ *     return <div>Error</div>;
+ *   }
+ *   if (data) {
+ *     return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *   }
+ *   return null;
+ * ```
+ * @group Factories
+ */
+exports.measureFactory = __importStar(require("./dimensional-model/measures/factory.js"));
+__exportStar(require("./dimensional-model/simple-column-types.js"), exports);
+/**
+ * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
+ *
+ * @group Factories
+ */
+exports.analyticsFactory = __importStar(require("./dimensional-model/analytics/factory.js"));
+__exportStar(require("./utils.js"), exports);