@sisense/sdk-data 0.11.3

package/dist/index.js

@@ -0,0 +1,79 @@
+/**
+ * @packageDocumentation
+ * @beta
+ */
+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';
+/**
+ * Functions to create date, text, or numeric filters on certain data columns
+ *
+ * They are similar to [Dashboard and Widget Filters](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
+ *
+ * Filters 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 the component to query the `Sample ECommerce` data source.
+ * Function `filters.greaterThan` is used to create a filter on `Revenue` to get values
+ * greater than 1000.
+ * ```tsx
+ * <ExecuteQuery
+ *   dataSource={DM.DataSource}
+ *   dimensions={[DM.Commerce.AgeRange]}
+ *   measures={[measures.sum(DM.Commerce.Revenue)]}
+ *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ * >
+ * {
+ *   (data) => {
+ *     if (data) {
+ *       console.log(data);
+ *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *     }
+ *   }
+ * }
+ * </ExecuteQuery>
+ * ```
+ */
+export * as filters from './dimensional-model/filters/factory.js';
+export * from './dimensional-model/measures/measures.js';
+/**
+ * Functions to build formulas that aggregate, summarize, and accumulate data,
+ * plus show changes in data over time.
+ *
+ * They are similar to [Formulas](https://docs.sisense.com/main/SisenseLinux/build-formulas.htm) in Sisense.
+ *
+ * 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 the component to query the `Sample ECommerce` data source.
+ * Function `measures.sum` is used to create a measure that sums the `Revenue` column.
+ * ```tsx
+ * <ExecuteQuery
+ *   dataSource={DM.DataSource}
+ *   dimensions={[DM.Commerce.AgeRange]}
+ *   measures={[measures.sum(DM.Commerce.Revenue)]}
+ *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ * >
+ * {
+ *   (data) => {
+ *     if (data) {
+ *       console.log(data);
+ *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
+ *     }
+ *   }
+ * }
+ * </ExecuteQuery>
+ * ```
+ */
+export * as measures from './dimensional-model/measures/factory.js';
+export * from './dimensional-model/simple-column-types.js';

package/dist/interfaces.d.ts

@@ -0,0 +1,233 @@
+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;
+}
+/**
+ * Data source for queries to run against
+ */
+export declare type DataSource = string;
+/**
+ * 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[][];
+}
+/**
+ * Runs type guard check for DataSource.
+ *
+ * @param arg
+ * @internal
+ */
+export declare function isDataSource(arg: DataSource | Data): 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/interfaces.js

@@ -0,0 +1,9 @@
+/**
+ * Runs type guard check for DataSource.
+ *
+ * @param arg
+ * @internal
+ */
+export function isDataSource(arg) {
+    return arg === undefined || typeof arg === 'string';
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@sisense/sdk-data",
+  "version": "0.11.3",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./dist/dimensional-model/filters/filters": "./dist/dimensional-model/filters/filters.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Sisense ",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "@sisense/sdk-rest-client": "^0.11.3",
+    "guid-typescript": "^1.0.9",
+    "numeral": "^2.0.6"
+  },
+  "scripts": {
+    "type-check": "tsc --noEmit",
+    "build": "tsc --build tsconfig.build.json",
+    "build:prod": "tsc --project tsconfig.prod.json",
+    "build.watch": "tsc --build --watch",
+    "clean": "rm -rf dist coverage tsconfig.build.tsbuildinfo tsconfig.prod.tsbuildinfo",
+    "lint": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "vitest": "run -T vitest",
+    "test": "run vitest run",
+    "test:watch": "run vitest watch",
+    "test:coverage": "run vitest run --coverage"
+  },
+  "files": [
+    "dist/**/*",
+    "esm/**/*"
+  ],
+  "devDependencies": {
+    "@babel/preset-env": "^7.20.2",
+    "@types/numeral": "2.0.2",
+    "eslint": "^8.40.0",
+    "prettier": "2.8.4",
+    "typescript": "4.8.4"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}