@sisense/sdk-data 1.7.2 → 1.9.0

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

@@ -10,8 +10,7 @@ export interface DataModel {
     [propName: string]: any;
 }
 /**
- * Common interface for elements of
- * [dimensional modeling](https://docs.sisense.com/main/SisenseLinux/data-model-building-practices.htm?tocpath=Modeling%20Data%7C_____4).
+ * Common interface for elements of a dimensional model.
  *
  * @internal
  */
@@ -61,6 +60,12 @@ export interface Element {
      * @internal
      */
     skipValidation?: boolean;
+    /**
+     * Optional CSDK code to initialize this element
+     *
+     * @internal
+     */
+    composeCode?: string;
 }
 /**
  * Base interface for measure, which is typically numeric aggregation over {@link Attribute}(s).
@@ -210,9 +215,6 @@ export interface Dimension extends Element, Attribute {
 }
 /**
  * Date Dimension extending {@link Dimension}.
- *
- * See [here](https://docs.sisense.com/main/SisenseLinux/date-and-time-fields.htm)
- * for more details on Date and Time Resolution for ElastiCubes and for Live Models.
  */
 export interface DateDimension extends Dimension {
     /**
@@ -265,9 +267,9 @@ export interface DateDimension extends Dimension {
     readonly AggMinutesRoundTo1: LevelAttribute;
 }
 /**
- * Common interface of an Attribute as defined in
- * [Dimensional Modeling](https://docs.sisense.com/main/SisenseLinux/data-model-building-practices.htm?tocpath=Modeling%20Data%7C_____4).
- * It is an extension of a {@link Column} in a generic {@link Data | Data Set}.
+ * Common interface of an attribute as in a dimensional model.
+ *
+ * An attribute is an extension of a {@link Column} in a generic {@link Data | data set}.
  */
 export interface Attribute extends Element {
     /**
@@ -354,6 +356,7 @@ export interface CustomFormulaContext {
 export interface PivotAttribute {
     attribute: Attribute;
     includeSubTotals?: boolean;
+    sort?: PivotRowsSort;
 }
 /**
  * Runs type guard check for PivotAttribute.
@@ -454,3 +457,50 @@ export declare type FilterRelationsModelIdNode = {
 export declare type FilterRelationsModelBracketNode = {
     value: FilterRelationsModelNode;
 };
+/** Sorting direction, either in Ascending order, Descending order, or None */
+export declare type SortDirection = 'sortAsc' | 'sortDesc' | 'sortNone';
+/**
+ * Sorting configuration for pivot "rows".
+ *
+ * This configuration allows sorting pivot "rows" either by their data or by data in a specific "values" column.
+ *
+ * @example
+ * Examples of sorting configurations for various scenarios:
+ *
+ * (1) Row sorted in ascending order by its data:
+ * ```ts
+ * { direction: 'sortAsc' }
+ * ```
+ *
+ * (2) Row sorted in descending order by data in the first "values" column (index 0):
+ * ```ts
+ * {
+ *    direction: 'sortDesc',
+ *    by: {
+ *      valuesIndex: 0,
+ *    }
+ * }
+ * ```
+ *
+ * (3) Row sorted in ascending order by data in the second "values" column (index 1) under the "columns" values of "Female" (for Gender) and "0-18" (for AgeRange):
+ * ```ts
+ * {
+ *    direction: 'sortAsc',
+ *    by: {
+ *      valuesIndex: 1,
+ *      columnsMembersPath: ['Female', '0-18']
+ *    }
+ * }
+ * ```
+ */
+export declare type PivotRowsSort = {
+    /** {@inheritDoc SortDirection} */
+    direction: SortDirection;
+    /** Sorting target configuration, allowing sorting "rows" by the data in a specific "values" column */
+    by?: {
+        /** Index of the target "values" item (measure) */
+        valuesIndex?: number;
+        /** Path to the target column if selected "columns" items (dimensions) are involved */
+        columnsMembersPath?: (string | number)[];
+    };
+};

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

@@ -40,8 +40,8 @@ export declare const RankingSortTypes: {
  *
  * You can nest custom formulas by placing one inside the `formula` parameter of another.
  *
- * Note: [Shared formulas](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) must be
- * fetched prior to use (see {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}).
+ * Note: To use [shared formulas](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm)
+ * from a Fusion Embed instance, you must fetch them first using {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}.
  *
  * @example
  * An example of constructing a custom formulas using dimensions, measures, and nested custom formulas
@@ -125,6 +125,8 @@ export declare function sum(attribute: Attribute, name?: string, format?: string
 /**
  * Creates an average aggregation measure over the given attribute.
  *
+ * Both `average()` and `avg()` can be used interchangeably.
+ *
  * @example
  * Calculate the average cost across all items in a category from the Sample Ecommerce data model.
  * ```ts
@@ -137,6 +139,17 @@ export declare function sum(attribute: Attribute, name?: string, format?: string
  * @group Aggregation
  */
 export declare function average(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * {@inheritDoc average}
+ *
+ * @example
+ * Calculate the average cost across all items in a category from the Sample Ecommerce data model.
+ * ```ts
+ * measureFactory.avg(DM.Commerce.Cost)
+ * ```
+ * @group Aggregation
+ */
+export declare function avg(attribute: Attribute, name?: string, format?: string): BaseMeasure;
 /**
  * Creates a min aggregation measure over the given attribute.
  *

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

@@ -105,8 +105,8 @@ function transformCustomFormulaJaql(jaql) {
  *
  * You can nest custom formulas by placing one inside the `formula` parameter of another.
  *
- * Note: [Shared formulas](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) must be
- * fetched prior to use (see {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}).
+ * Note: To use [shared formulas](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm)
+ * from a Fusion Embed instance, you must fetch them first using {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}.
  *
  * @example
  * An example of constructing a custom formulas using dimensions, measures, and nested custom formulas
@@ -217,6 +217,8 @@ export function sum(attribute, name, format) {
 /**
  * Creates an average aggregation measure over the given attribute.
  *
+ * Both `average()` and `avg()` can be used interchangeably.
+ *
  * @example
  * Calculate the average cost across all items in a category from the Sample Ecommerce data model.
  * ```ts
@@ -231,6 +233,19 @@ export function sum(attribute, name, format) {
 export function average(attribute, name, format) {
     return aggregate(attribute, AggregationTypes.Average, name, format);
 }
+/**
+ * {@inheritDoc average}
+ *
+ * @example
+ * Calculate the average cost across all items in a category from the Sample Ecommerce data model.
+ * ```ts
+ * measureFactory.avg(DM.Commerce.Cost)
+ * ```
+ * @group Aggregation
+ */
+export function avg(attribute, name, format) {
+    return average(attribute, name, format);
+}
 /**
  * Creates a min aggregation measure over the given attribute.
  *

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

@@ -2,11 +2,8 @@
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable complexity */
-/* eslint-disable max-lines */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable sonarjs/cognitive-complexity */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 import * as m from './factory.js';
 import { Sort, AggregationTypes, MetadataTypes } from '../types.js';
@@ -352,7 +349,7 @@ export function createMeasure(json) {
     // legacy
     const exp = json.dim || json.expression;
     if (exp) {
-        att = new DimensionalAttribute(exp, exp);
+        att = new DimensionalAttribute(exp, exp, undefined, desc);
     }
     // official SDK
     if (json.attribute) {

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

@@ -157,12 +157,21 @@ export declare enum DataType {
     DATETIME = "datetime"
 }
 /** @internal */
-export declare enum SortDirection {
+export declare enum JaqlSortDirection {
     ASC = "asc",
     DESC = "desc"
 }
 /** @internal */
-export declare type Jaql = BaseJaql | FormulaJaql | FilterJaql;
+export declare type Jaql = BaseJaql | FormulaJaql | FilterJaql | PivotJaql;
+/** @internal */
+export declare type PivotJaql = (BaseJaql | FormulaJaql) & {
+    sortDetails?: {
+        dir: JaqlSortDirection;
+        field: number;
+        measurePath?: Record<string, string> | null;
+    };
+    subtotalAgg?: 'sum' | 'min' | 'max' | 'avg' | 'median';
+};
 /** @internal */
 export declare type BaseJaql = {
     agg?: string;
@@ -172,7 +181,7 @@ export declare type BaseJaql = {
     column: string;
     title: string;
     level?: 'years' | 'quarters' | 'months' | 'weeks' | 'minutes' | 'days';
-    sort?: SortDirection;
+    sort?: JaqlSortDirection;
 };
 /** @internal */
 export declare type FormulaID = string;
@@ -181,13 +190,13 @@ export declare type FormulaContext = BaseJaql | FormulaJaql | FilterJaql;
 /** @internal */
 export declare type FormulaJaql = {
     type?: 'measure';
-    sort?: SortDirection;
+    sort?: JaqlSortDirection;
     title: string;
     formula: string;
     context?: Record<FormulaID, FormulaContext>;
 };
 /** @internal */
-export declare type BaseFilter = IncludeAllFilter | IncludeMembersFilter | ExcludeMembersFilter;
+export declare type BaseFilter = IncludeAllFilter | IncludeMembersFilter | ExcludeMembersFilter | JaqlNumericFilter | AndFilter<JaqlNumericFilter> | OrFilter<JaqlNumericFilter>;
 /** @internal */
 export declare type BackgroundFilter = BaseFilter & {
     level?: 'string';
@@ -216,3 +225,26 @@ export declare type FilterJaql = BaseJaql & {
         filter?: BackgroundFilter | TurnOffMembersFilter;
     };
 };
+declare type NumericFilterValue = number | FormulaJaql;
+/** @internal */
+export declare type JaqlNumericFilter = {
+    equals?: NumericFilterValue;
+    doesntEqual?: NumericFilterValue;
+    toNotEqual?: NumericFilterValue;
+    to?: NumericFilterValue;
+    fromNotEqual?: NumericFilterValue;
+    from?: NumericFilterValue;
+    '='?: NumericFilterValue;
+    '<'?: NumericFilterValue;
+    '>'?: NumericFilterValue;
+    '>='?: NumericFilterValue;
+    '<='?: NumericFilterValue;
+};
+declare type AndFilter<FilterItem> = {
+    and: FilterItem[];
+};
+/** @internal */
+export declare type OrFilter<FilterItem> = {
+    or: FilterItem[];
+};
+export {};

package/dist/dimensional-model/types.js

@@ -1,8 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable complexity */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable max-lines */
 /*
  * Types
  */
@@ -21,7 +19,7 @@ export const AggregationTypes = {
     /** Count aggregation type */
     Count: 'count',
     /** Count distinct aggregation type */
-    CountDistinct: 'countdistinct',
+    CountDistinct: 'countDistinct',
     /** Median aggregation type */
     Median: 'median',
     /** Variance aggregation type */
@@ -290,8 +288,8 @@ export var DataType;
     DataType["DATETIME"] = "datetime";
 })(DataType = DataType || (DataType = {}));
 /** @internal */
-export var SortDirection;
-(function (SortDirection) {
-    SortDirection["ASC"] = "asc";
-    SortDirection["DESC"] = "desc";
-})(SortDirection = SortDirection || (SortDirection = {}));
+export var JaqlSortDirection;
+(function (JaqlSortDirection) {
+    JaqlSortDirection["ASC"] = "asc";
+    JaqlSortDirection["DESC"] = "desc";
+})(JaqlSortDirection = JaqlSortDirection || (JaqlSortDirection = {}));

package/dist/index.d.ts

@@ -54,8 +54,6 @@ export * from './dimensional-model/measures/measures.js';
  * Functions to create measures 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}.

package/dist/index.js

@@ -54,8 +54,6 @@ export * from './dimensional-model/measures/measures.js';
  * Functions to create measures 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}.

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { Filter, FilterRelations, FilterRelationsJaql, DataSource, DataSourceInfo } from './index.js';
+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()
  *
@@ -16,11 +16,22 @@ export declare const getFilterListAndRelations: (filterRelations: FilterRelation
 };
 /**
  * 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;

package/dist/utils.js

@@ -1,4 +1,5 @@
 import cloneDeep from 'lodash/cloneDeep.js';
+import { createFilterFromJaqlInternal } from './dimensional-model/filters/utils/filter-from-jaql-util.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -63,6 +64,7 @@ export const getFilterListAndRelations = (filterRelations) => {
 };
 /**
  * Gets the name of the data source
+ *
  * @internal
  */
 export function getDataSourceName(dataSource) {
@@ -70,8 +72,23 @@ export function getDataSourceName(dataSource) {
 }
 /**
  * Checks if the provided 'dataSource' is a data source info structure that contains more than just the data source name.
+ *
  * @internal
  */
 export function isDataSourceInfo(dataSource) {
     return typeof dataSource === 'object' && 'type' in dataSource && 'title' in dataSource;
 }
+/**
+ * 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 const createFilterFromJaql = (jaql, instanceid) => {
+    // translation logic is based on FilterJaqlInternal type (from internal modern-analytics-filters)
+    // TODO reconcile FilterJaql and FilterJaqlInternal
+    const jaqlInternal = jaql;
+    return createFilterFromJaqlInternal(jaqlInternal, instanceid);
+};

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.7.2",
+  "version": "1.9.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
@@ -23,8 +23,8 @@
   "author": "Sisense ",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^1.7.2",
-    "@sisense/sdk-rest-client": "^1.7.2",
+    "@sisense/sdk-common": "^1.9.0",
+    "@sisense/sdk-rest-client": "^1.9.0",
     "guid-typescript": "^1.0.9",
     "lodash": "^4.17.21",
     "numeral": "^2.0.6",