@sisense/sdk-data 1.11.0 → 1.12.0

package/dist/cjs/interfaces.d.ts

@@ -0,0 +1,367 @@
+import type { MeasureContext } from './dimensional-model/interfaces.js';
+/**
+ * Data cell, which is a storage unit in a {@link Data | user-provided data set}
+ * or {@link QueryResultData | query result data set}.
+ */
+export interface Cell {
+    /** Cell data value */
+    data: any;
+    /** Display text */
+    text?: string;
+    /** Boolean flag whether the data value should be blurred when visualized in a chart */
+    blur?: boolean;
+    /** Color associated with the data value when visualized in a chart */
+    color?: string;
+}
+/**
+ * Represents a data-cell in a query result
+ *
+ * @internal
+ */
+export interface DataCell {
+    /**
+     * Gets the cell's data in its native type {@link (number|string|Date|boolean)}
+     */
+    data: any;
+    /**
+     * Gets the string representation of the cell
+     */
+    text: string;
+    /**
+     * Used to differentiate cell data that is highlighted/blurred by a filter.
+     *
+     * Means different things depending on if it is specified in the returned dataset.
+     *
+     * The absence of `selected` across all cells means that all data is highlighted.
+     * The presence of `selected` in at least one cell means that some cells are highlighted
+     * and some are blurred.
+     */
+    selected?: boolean;
+}
+/**
+ * Column (or field) in a data set.
+ * When associated with a dimensional model, a column is equivalent to an {@link Attribute}.
+ */
+export interface Column {
+    /**
+     * Identifier. Required when associated with a model
+     *
+     * @internal
+     */
+    id?: string;
+    /** Column name */
+    name: string;
+    /** Column type */
+    type: string;
+    /**
+     * Column description
+     *
+     * @internal
+     */
+    description?: string;
+}
+/**
+ * Aggregate function applied to a {@link Column}.
+ * When associated with a dimensional model, a Measure Column is equivalent to a {@link Measure}.
+ */
+export interface MeasureColumn {
+    /**
+     * Identifier. Required when associated with a model.
+     *
+     * @internal
+     */
+    id?: string;
+    /** Column name */
+    name: string;
+    /**
+     * Aggregate function -- for example, `sum`, `count`.
+     * If not specified, default value, `sum`, will be used.
+     */
+    aggregation?: string;
+    /**
+     * Optional title for the column after aggregation.
+     * If not specified, the column `name` will be used.
+     */
+    title?: string;
+    /**
+     * Aggregate function description
+     *
+     * @internal
+     */
+    description?: string;
+}
+/**
+ * Calculated Aggregate function applied to a {@link Column}(s).
+ * When associated with a dimensional model, a Calculated Measure Column is
+ * equivalent to a {@link CalculatedMeasure}.
+ */
+export interface CalculatedMeasureColumn {
+    /**
+     * Identifier. Required when associated with a model.
+     *
+     * @internal
+     */
+    id?: string;
+    /** Column name */
+    name: string;
+    /** Measure type */
+    type: string;
+    /** Measure context */
+    context: MeasureContext;
+    /** Expression representing the element in a {@link https://sisense.dev/guides/querying/useJaql/ | JAQL query}. */
+    expression: string;
+    /**
+     * Aggregate function description
+     *
+     * @internal
+     */
+    description?: string;
+    /**
+     * Optional title for the column after aggregation.
+     * If not specified, the column `name` will be used.
+     */
+    title?: string;
+}
+/**
+ * Info of data source
+ */
+export declare type DataSourceInfo = {
+    title: string;
+    type: 'live' | 'elasticube';
+};
+/**
+ * Data source for queries to run against
+ */
+export declare type DataSource = string | DataSourceInfo;
+/**
+ * Data set, which is made up of an array of {@link Column | columns}
+ * and a two-dimensional array of data {@link Cell | cells}.
+ *
+ * This structure can be used for user-provided data in {@link @sisense/sdk-ui!ChartProps | Chart components}.
+ */
+export interface Data {
+    /** Array of {@link Column | columns} */
+    columns: Column[];
+    /** Two-dimensional array of data cells, each of which is either a string, number, or type {@link Cell} */
+    rows: (string | number | Cell)[][];
+}
+/**
+ * Query result data set, which is made of an array of {@link Column | columns}
+ * and a two-dimensional array of data {@link Cell | cells}.
+ */
+export interface QueryResultData {
+    /** Array of {@link Column | columns} */
+    columns: Column[];
+    /** Two-dimensional array of data {@link Cell | cells} */
+    rows: Cell[][];
+}
+/**
+ * Tree node representing data in a pivot table
+ */
+export declare type TreeNode = {
+    /**
+     * Raw data
+     */
+    value?: string;
+    /**
+     * Raw data
+     *
+     * @internal
+     */
+    content?: string;
+    /**
+     * Matched index for condition formatting
+     *
+     * @internal
+     */
+    cf?: number;
+    /**
+     * List of children of this node
+     */
+    children?: Array<TreeNode>;
+    /**
+     * Data list for rows nodes
+     */
+    data?: Array<any>;
+    /**
+     * Index in data list for columns nodes
+     */
+    index?: number;
+    /**
+     * Current node's index divergence
+     *
+     * @internal
+     */
+    indexDivergence?: number;
+    /**
+     * Initial child count in raw data from server
+     *
+     * @internal
+     */
+    size?: number;
+    /**
+     * Boolean flag if node is some part of real node
+     *
+     * @internal
+     */
+    isPart?: boolean;
+    /**
+     * Max number of children (measures) nodes to insert
+     *
+     * @internal
+     */
+    maxChilds?: number;
+    /**
+     * Node deep level
+     *
+     * @internal
+     */
+    level?: number;
+    /**
+     * Node min deep level, for columns nodes with values at the and
+     *
+     * @internal
+     */
+    minLevel?: number;
+    /**
+     * Internal cache, to make sure that node was already mapped
+     *
+     * @internal
+     */
+    isMapped?: boolean;
+    /**
+     * Internal cache, for child count
+     *
+     * @internal
+     */
+    childCount?: number;
+    /**
+     * Internal cache, for child deep
+     *
+     * @internal
+     */
+    childDeep?: number;
+    /**
+     * Internal data store
+     *
+     * @internal
+     */
+    store?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Grid of tree nodes
+ */
+export declare type PivotGrid = Array<Array<TreeNode | string>>;
+/**
+ * Pivot query result data set, which includes both a flat table of {@link QueryResultData} and grids of tree structures.
+ */
+export interface PivotQueryResultData {
+    /**
+     * Flat table structure
+     *
+     * @category Table
+     */
+    table: QueryResultData;
+    /**
+     * Grids of tree structures
+     *
+     * @category Tree Structures
+     */
+    grids?: {
+        corner: PivotGrid;
+        rows: PivotGrid;
+        columns: PivotGrid;
+        values: PivotGrid;
+    };
+}
+/**
+ * Empty pivot query result data set
+ *
+ * @internal
+ */
+export declare const EMPTY_PIVOT_QUERY_RESULT_DATA: PivotQueryResultData;
+/**
+ * Runs type guard check for DataSource.
+ *
+ * @param arg
+ * @internal
+ */
+export declare function isDataSource(arg: DataSource | Data | undefined): arg is DataSource;
+/**
+ * Trend formula options.
+ */
+export declare type TrendFormulaOptions = {
+    /**
+     * Trend analysis model type to be used for the operation.
+     *
+     * @defaultValue "linear"
+     */
+    modelType?: 'linear' | 'logarithmic' | 'advancedSmoothing' | 'localEstimates';
+    /**
+     * Boolean flag that enables the function to automatically identify and ignore
+     * anomalous values in the series. This can be particularly useful when you want
+     * to maintain the integrity of your analysis by avoiding potential outliers.
+     *
+     * @defaultValue false
+     */
+    ignoreAnomalies?: boolean;
+};
+/**
+ * Forecast formula options.
+ */
+export declare type ForecastFormulaOptions = {
+    /**
+     * Number of data points to be predicted.
+     * The accepted value range is between 1-1,000
+     *
+     * @defaultValue 3
+     */
+    forecastHorizon?: number;
+    /**
+     * Forecasting model type. The 'auto' option automatically
+     * fits the best combination of models.
+     *
+     * @defaultValue "auto"
+     */
+    modelType?: 'auto' | 'autoArima' | 'holtWinters' | 'prophet';
+    /**
+     * Start date of the time series data that the forecasting model will
+     * be trained on. This parameter can be used to discard the beginning of
+     * the series. Specify a ISO 8601 date string or Date object.
+     */
+    startDate?: string | Date;
+    /**
+     * End date of the time series data that the forecasting model will be
+     * trained on. This parameter can be used to discard the end of the series.
+     * Specify a ISO 8601 date string or Date object.
+     */
+    endDate?: string | Date;
+    /**
+     * Confidence interval showing the probabilistic upper and lower limits of the
+     * forecasted series according to the uncertainty level. The valid range is (0.8 <= X < 1).
+     *
+     * @defaultValue 0.8
+     */
+    confidenceInterval?: number;
+    /**
+     * Expected lower limit to improve the forecast accuracy when reaching
+     * the limit. Note that values in the confidence interval can exceed
+     * this limit.
+     */
+    lowerBound?: number;
+    /**
+     * Expected upper limit to improve the forecast accuracy when reaching
+     * the limit. Note that values in the confidence interval can exceed
+     * this limit.
+     */
+    upperBound?: number;
+    /**
+     * Boolean flag to round the predicted result to an integer if set to true.
+     * Otherwise, the predicted result is left as a float
+     *
+     * @defaultValue false
+     */
+    roundToInt?: boolean;
+};

package/dist/cjs/interfaces.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDataSource = exports.EMPTY_PIVOT_QUERY_RESULT_DATA = void 0;
+/**
+ * Empty pivot query result data set
+ *
+ * @internal
+ */
+exports.EMPTY_PIVOT_QUERY_RESULT_DATA = {
+    table: { columns: [], rows: [] },
+};
+/**
+ * Runs type guard check for DataSource.
+ *
+ * @param arg
+ * @internal
+ */
+function isDataSource(arg) {
+    return arg === undefined || typeof arg === 'string' || ('title' in arg && 'type' in arg);
+}
+exports.isDataSource = isDataSource;

package/dist/cjs/translation/initialize-i18n.d.ts

@@ -0,0 +1,2 @@
+export declare function initializeI18n(): import("@sisense/sdk-common").I18NextInitResult;
+export declare const i18nextInstance: import("i18next").i18n;

package/dist/cjs/translation/initialize-i18n.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.i18nextInstance = exports.initializeI18n = void 0;
+const sdk_common_1 = require("@sisense/sdk-common");
+const index_js_1 = require("./resources/index.js");
+function initializeI18n() {
+    return (0, sdk_common_1.initI18next)({
+        resource: index_js_1.resources,
+        language: 'en',
+        namespace: index_js_1.PACKAGE_NAMESPACE,
+    });
+}
+exports.initializeI18n = initializeI18n;
+exports.i18nextInstance = initializeI18n().i18nextInstance;

package/dist/cjs/translation/resources/en.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Translation dictionary for English language.
+ */
+export declare const translation: {
+    errors: {
+        measure: {
+            unsupportedType: string;
+            dimensionalCalculatedMeasure: {
+                noContext: string;
+            };
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: string;
+                noAggAggregation: string;
+            };
+        };
+        dataModelConfig: {
+            noName: string;
+            noMetadata: string;
+        };
+        filter: {
+            unsupportedType: string;
+            unsupportedDatetimeLevel: string;
+            membersFilterNullMember: string;
+        };
+        unsupportedDimensionalElement: string;
+    };
+};
+export declare type TranslationDictionary = typeof translation;

package/dist/cjs/translation/resources/en.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translation = void 0;
+/**
+ * Translation dictionary for English language.
+ */
+exports.translation = {
+    errors: {
+        measure: {
+            unsupportedType: 'Unsupported measure type',
+            dimensionalCalculatedMeasure: {
+                noContext: "DimensionalCalculatedMeasure must have 'context' property",
+            },
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: "DimensionalBaseMeasure must have 'attribute'/'dim'/'expression' property",
+                noAggAggregation: "DimensionalBaseMeasure must have 'agg' or 'aggregation' property",
+            },
+        },
+        dataModelConfig: {
+            noName: "'name' must be specified in config for DataModel",
+            noMetadata: "'metadata' must be specified in config for DataModel",
+        },
+        filter: {
+            unsupportedType: 'Unsupported filter type: {{filterType}}',
+            unsupportedDatetimeLevel: 'Filters do not support the next "datetime" levels: Hours, MinutesRoundTo30, MinutesRoundTo15',
+            membersFilterNullMember: 'MembersFilter of {{attributeId}} - member cannot be null',
+        },
+        unsupportedDimensionalElement: 'Unsupported dimensional element type',
+    },
+};

package/dist/cjs/translation/resources/index.d.ts

@@ -0,0 +1,53 @@
+import { TranslationDictionary } from './en.js';
+export type { TranslationDictionary };
+export declare const PACKAGE_NAMESPACE: "sdkData";
+export declare const resources: {
+    en: {
+        errors: {
+            measure: {
+                unsupportedType: string;
+                dimensionalCalculatedMeasure: {
+                    noContext: string;
+                };
+                dimensionalBaseMeasure: {
+                    noAttributeDimExpression: string;
+                    noAggAggregation: string;
+                };
+            };
+            dataModelConfig: {
+                noName: string;
+                noMetadata: string;
+            };
+            filter: {
+                unsupportedType: string;
+                unsupportedDatetimeLevel: string;
+                membersFilterNullMember: string;
+            };
+            unsupportedDimensionalElement: string;
+        };
+    };
+    uk: {
+        errors: {
+            measure: {
+                unsupportedType: string;
+                dimensionalCalculatedMeasure: {
+                    noContext: string;
+                };
+                dimensionalBaseMeasure: {
+                    noAttributeDimExpression: string;
+                    noAggAggregation: string;
+                };
+            };
+            dataModelConfig: {
+                noName: string;
+                noMetadata: string;
+            };
+            filter: {
+                unsupportedType: string;
+                unsupportedDatetimeLevel: string;
+                membersFilterNullMember: string;
+            };
+            unsupportedDimensionalElement: string;
+        };
+    };
+};

package/dist/cjs/translation/resources/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resources = exports.PACKAGE_NAMESPACE = void 0;
+const en_js_1 = require("./en.js");
+const uk_js_1 = require("./uk.js");
+exports.PACKAGE_NAMESPACE = 'sdkData';
+exports.resources = {
+    en: en_js_1.translation,
+    uk: uk_js_1.translation,
+};

package/dist/cjs/translation/resources/uk.d.ts

@@ -0,0 +1,5 @@
+import { TranslationDictionary } from './index.js';
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+export declare const translation: TranslationDictionary;

package/dist/cjs/translation/resources/uk.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translation = void 0;
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+exports.translation = {
+    errors: {
+        measure: {
+            unsupportedType: 'Непідтримуваний тип measure',
+            dimensionalCalculatedMeasure: {
+                noContext: "DimensionalCalculatedMeasure має мати властивість 'context'",
+            },
+            dimensionalBaseMeasure: {
+                noAttributeDimExpression: "DimensionalBaseMeasure має мати властивість 'attribute'/'dim'/'expression'",
+                noAggAggregation: "DimensionalBaseMeasure має мати властивість 'agg' або 'aggregation'",
+            },
+        },
+        dataModelConfig: {
+            noName: "'name' має бути вказано в конфігурації для DataModel",
+            noMetadata: "'metadata' має бути вказано в конфігурації для DataModel",
+        },
+        filter: {
+            unsupportedType: 'Непідтримуваний тип фільтра: {{filterType}}',
+            unsupportedDatetimeLevel: 'Фільтри не підтримують наступні рівні "datetime": Hours, MinutesRoundTo30, MinutesRoundTo15',
+            membersFilterNullMember: 'MembersFilter у {{attributeId}} - member не може бути нульовим',
+        },
+        unsupportedDimensionalElement: 'Непідтримуваний тип елемента',
+    },
+};

package/dist/cjs/translation/translatable-error.d.ts

@@ -0,0 +1,5 @@
+import { AbstractTranslatableError } from '@sisense/sdk-common';
+import { PACKAGE_NAMESPACE } from './resources/index.js';
+export declare class TranslatableError extends AbstractTranslatableError<typeof PACKAGE_NAMESPACE> {
+    constructor(translationKey: string, interpolationOptions?: Record<string, string>);
+}

package/dist/cjs/translation/translatable-error.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslatableError = void 0;
+const sdk_common_1 = require("@sisense/sdk-common");
+const initialize_i18n_js_1 = require("./initialize-i18n.js");
+const index_js_1 = require("./resources/index.js");
+class TranslatableError extends sdk_common_1.AbstractTranslatableError {
+    constructor(translationKey, interpolationOptions) {
+        super(index_js_1.PACKAGE_NAMESPACE, {
+            key: translationKey,
+            interpolationOptions: interpolationOptions,
+        }, initialize_i18n_js_1.i18nextInstance.t);
+    }
+}
+exports.TranslatableError = TranslatableError;

package/dist/cjs/utils.d.ts

@@ -0,0 +1,37 @@
+import { Filter, FilterRelations, FilterRelationsJaql, DataSource, DataSourceInfo, FilterJaql } from './index.js';
+/**
+ * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
+ *
+ * @internal
+ */
+export declare const guidFast: (len?: number) => string;
+/**
+ * Function to separate list of filters from the provided relation and get logical relations for jaql
+ *
+ * @internal
+ */
+export declare const getFilterListAndRelations: (filterRelations: FilterRelations | Filter[] | undefined) => {
+    filters: Filter[] | undefined;
+    relations: FilterRelationsJaql | undefined;
+};
+/**
+ * Gets the name of the data source
+ *
+ * @internal
+ */
+export declare function getDataSourceName(dataSource: DataSource): string;
+/**
+ * Checks if the provided 'dataSource' is a data source info structure that contains more than just the data source name.
+ *
+ * @internal
+ */
+export declare function isDataSourceInfo(dataSource: DataSource): dataSource is DataSourceInfo;
+/**
+ * Creates a filter from a JAQL object.
+ *
+ * @param jaql - The filter JAQL object.
+ * @param instanceid - The instance ID.
+ * @returns - The created Filter object.
+ * @internal
+ */
+export declare const createFilterFromJaql: (jaql: FilterJaql, instanceid?: string) => Filter;