@sisense/sdk-data 1.1.0 → 1.3.0

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

@@ -1,4 +1,4 @@
-import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationNode, FilterRelation } from '../interfaces.js';
+import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationsNode, FilterRelations } from '../interfaces.js';
 /**
  * Creates a filter representing the union of multiple filters on the same attribute. The resulting
  * union filter filters on items that match any of the given filters.
@@ -632,7 +632,7 @@ export declare function topRanking(attribute: Attribute, measure: Measure, count
  */
 export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number): Filter;
 /**
- * Set of logic operators for filter relation construction
+ * Set of logic operators for filter relations construction
  *
  * These operators are still in beta.
  *
@@ -646,7 +646,7 @@ export declare function bottomRanking(attribute: Attribute, measure: Measure, co
  * const genderFilter = filterFactory.doesntContain(DM.Commerce.Gender, 'Unspecified');
  * const costFilter = filterFactory.between(DM.Commerce.Cost, 1000, 2000);
  *
- * // create filter relation of two filters
+ * // create filter relations of two filters
  * const orFilerRelations = filterFactory.logic.or(revenueFilter, countryFilter);
  * // revenueFilter OR countryFilter
  *
@@ -662,10 +662,10 @@ export declare function bottomRanking(attribute: Attribute, measure: Measure, co
  */
 export declare namespace logic {
     /**
-     * Creates an 'AND' filter relation
+     * Creates an 'AND' filter relations
      *
      * @example
-     * Create a filter relation for items that have a revenue greater than 100 and are in new condition
+     * Create filter relations for items that have a revenue greater than 100 and are in new condition
      * in the Sample ECommerce data model.
      * ```ts
      * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);
@@ -673,17 +673,17 @@ export declare namespace logic {
      *
      * const andFilerRelation = filterFactory.logic.and(revenueFilter, conditionFilter);
      * ```
-     * @param left First filter or filter relation
-     * @param right Second filter or filter relation
-     * @returns A filter relation
+     * @param left First filter or filter relations
+     * @param right Second filter or filter relations
+     * @returns Filter relations
      * @beta
      */
-    const and: (left: FilterRelationNode, right: FilterRelationNode) => FilterRelation;
+    const and: (left: FilterRelationsNode, right: FilterRelationsNode) => FilterRelations;
     /**
-     * Creates an 'OR' filter relation
+     * Creates an 'OR' filter relations
      *
      * @example
-     * Create a filter relation for items that have a revenue greater than 100 or are in new condition
+     * Create filter relations for items that have a revenue greater than 100 or are in new condition
      * in the Sample ECommerce data model.
      * ```ts
      * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);
@@ -691,10 +691,10 @@ export declare namespace logic {
      *
      * const orFilerRelation = filterFactory.logic.or(revenueFilter, conditionFilter);
      * ```
-     * @param left First filter or filter relation
-     * @param right Second filter or filter relation
-     * @returns A filter relation
+     * @param left First filter or filter relations
+     * @param right Second filter or filter relations
+     * @returns Filter relations
      * @beta
      */
-    const or: (left: FilterRelationNode, right: FilterRelationNode) => FilterRelation;
+    const or: (left: FilterRelationsNode, right: FilterRelationsNode) => FilterRelations;
 }

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

@@ -734,7 +734,7 @@ const relate = (node) => {
     return node;
 };
 /**
- * Set of logic operators for filter relation construction
+ * Set of logic operators for filter relations construction
  *
  * These operators are still in beta.
  *
@@ -748,7 +748,7 @@ const relate = (node) => {
  * const genderFilter = filterFactory.doesntContain(DM.Commerce.Gender, 'Unspecified');
  * const costFilter = filterFactory.between(DM.Commerce.Cost, 1000, 2000);
  *
- * // create filter relation of two filters
+ * // create filter relations of two filters
  * const orFilerRelations = filterFactory.logic.or(revenueFilter, countryFilter);
  * // revenueFilter OR countryFilter
  *
@@ -766,10 +766,10 @@ const relate = (node) => {
 export var logic;
 (function (logic) {
     /**
-     * Creates an 'AND' filter relation
+     * Creates an 'AND' filter relations
      *
      * @example
-     * Create a filter relation for items that have a revenue greater than 100 and are in new condition
+     * Create filter relations for items that have a revenue greater than 100 and are in new condition
      * in the Sample ECommerce data model.
      * ```ts
      * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);
@@ -777,9 +777,9 @@ export var logic;
      *
      * const andFilerRelation = filterFactory.logic.and(revenueFilter, conditionFilter);
      * ```
-     * @param left First filter or filter relation
-     * @param right Second filter or filter relation
-     * @returns A filter relation
+     * @param left First filter or filter relations
+     * @param right Second filter or filter relations
+     * @returns Filter relations
      * @beta
      */
     logic.and = (left, right) => ({
@@ -788,10 +788,10 @@ export var logic;
         right: relate(right),
     });
     /**
-     * Creates an 'OR' filter relation
+     * Creates an 'OR' filter relations
      *
      * @example
-     * Create a filter relation for items that have a revenue greater than 100 or are in new condition
+     * Create filter relations for items that have a revenue greater than 100 or are in new condition
      * in the Sample ECommerce data model.
      * ```ts
      * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);
@@ -799,9 +799,9 @@ export var logic;
      *
      * const orFilerRelation = filterFactory.logic.or(revenueFilter, conditionFilter);
      * ```
-     * @param left First filter or filter relation
-     * @param right Second filter or filter relation
-     * @returns A filter relation
+     * @param left First filter or filter relations
+     * @param right Second filter or filter relations
+     * @returns Filter relations
      * @beta
      */
     logic.or = (left, right) => ({

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

@@ -346,12 +346,105 @@ export interface Filter extends Element {
 export interface CustomFormulaContext {
     [key: string]: Attribute | Measure;
 }
-export declare type FilterRelationNode = Filter | Filter[] | FilterRelation | FilterRelationJaqlNode;
-export interface FilterRelation {
-    left: FilterRelationNode;
-    right: FilterRelationNode;
+/**
+ * Wrapped attribute with additional options for pivot table
+ */
+export interface PivotAttribute {
+    attribute: Attribute;
+    includeSubTotals?: boolean;
+}
+/**
+ * Runs type guard check for PivotAttribute.
+ *
+ * @param arg - object to check
+ * @internal
+ */
+export declare function isPivotAttribute(arg: Attribute | PivotAttribute): arg is PivotAttribute;
+export declare type TotalsCalculation = 'sum' | 'max' | 'min' | 'avg' | 'median';
+/**
+ * Wrapped measure with additional options for pivot table
+ */
+export interface PivotMeasure {
+    measure: Measure;
+    totalsCalculation: TotalsCalculation;
+}
+/**
+ * Runs type guard check for PivotMeasure.
+ *
+ * @param arg - object to check
+ * @internal
+ */
+export declare function isPivotMeasure(arg: Measure | PivotMeasure): arg is PivotMeasure;
+/**
+ * Data options for grand totals of a pivot table
+ */
+export declare type PivotGrandTotals = {
+    title?: string;
+    rows?: boolean;
+    columns?: boolean;
+};
+/**
+ * @internal
+ */
+export declare const DEFAULT_PIVOT_GRAND_TOTALS: PivotGrandTotals;
+/** A node or a subtree of a {@link FilterRelations} tree */
+export declare type FilterRelationsNode = Filter | Filter[] | FilterRelations;
+/**
+ * A node or a subtree of a {@link FilterRelationsModel} tree
+ *
+ * @internal
+ */
+export declare type FilterRelationsModelNode = FilterRelationsModelIdNode | FilterRelationsModelBracketNode | FilterRelationsModel;
+/**
+ * A node or a subtree of a {@link FilterRelationsJaql} tree
+ *
+ * @internal
+ */
+export declare type FilterRelationsJaqlNode = FilterRelationsJaqlIdNode | FilterRelationsJaql;
+/**
+ * Representation of filter logical relations (AND/OR)
+ *
+ * Unlike {@link FilterRelationsModel} or {@link FilterRelationsJaql},
+ * this interface contains filter objects, not just id nodes
+ */
+export interface FilterRelations {
+    left: FilterRelationsNode;
+    right: FilterRelationsNode;
+    operator: 'AND' | 'OR';
+}
+/**
+ * Incoming filter logical relations (AND/OR) when fetched from the instance
+ *
+ * @internal
+ */
+export interface FilterRelationsModel {
+    left: FilterRelationsModelNode;
+    right: FilterRelationsModelNode;
     operator: 'AND' | 'OR';
 }
-export declare type FilterRelationJaqlNode = {
+/**
+ * Outgoing filter logical relations (AND/OR) when added to a query
+ *
+ * @internal
+ */
+export interface FilterRelationsJaql {
+    left: FilterRelationsJaqlNode;
+    right: FilterRelationsJaqlNode;
+    operator: 'AND' | 'OR';
+}
+/** A node of a {@link FilterRelationsJaql} tree that represents a filter */
+export declare type FilterRelationsJaqlIdNode = {
     instanceid: string;
 };
+/** A node of a {@link FilterRelationsModel} tree that represents a filter */
+export declare type FilterRelationsModelIdNode = {
+    instanceId: string;
+};
+/**
+ * A node of a {@link FilterRelationsModel} tree that represents a bracket expression
+ *
+ * @internal
+ */
+export declare type FilterRelationsModelBracketNode = {
+    value: FilterRelationsModelNode;
+};

package/dist/dimensional-model/interfaces.js

@@ -1 +1,26 @@
-export {};
+/**
+ * Runs type guard check for PivotAttribute.
+ *
+ * @param arg - object to check
+ * @internal
+ */
+export function isPivotAttribute(arg) {
+    return 'attribute' in arg;
+}
+/**
+ * Runs type guard check for PivotMeasure.
+ *
+ * @param arg - object to check
+ * @internal
+ */
+export function isPivotMeasure(arg) {
+    return 'measure' in arg;
+}
+/**
+ * @internal
+ */
+export const DEFAULT_PIVOT_GRAND_TOTALS = {
+    title: 'Grand Total',
+    rows: false,
+    columns: false,
+};

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

@@ -150,16 +150,20 @@ export declare const DateLevels: {
     /** @internal */
     readonly all: string[];
 };
+/** @internal */
 export declare enum DataType {
     TEXT = "text",
     NUMERIC = "numeric",
     DATETIME = "datetime"
 }
+/** @internal */
 export declare enum SortDirection {
     ASC = "asc",
     DESC = "desc"
 }
+/** @internal */
 export declare type Jaql = BaseJaql | FormulaJaql | FilterJaql;
+/** @internal */
 export declare type BaseJaql = {
     agg?: string;
     datatype: DataType;
@@ -170,8 +174,11 @@ export declare type BaseJaql = {
     level?: 'years' | 'quarters' | 'months' | 'weeks' | 'minutes' | 'days';
     sort?: SortDirection;
 };
+/** @internal */
 export declare type FormulaID = string;
+/** @internal */
 export declare type FormulaContext = BaseJaql | FormulaJaql | FilterJaql;
+/** @internal */
 export declare type FormulaJaql = {
     type?: 'measure';
     sort?: SortDirection;
@@ -179,24 +186,31 @@ export declare type FormulaJaql = {
     formula: string;
     context?: Record<FormulaID, FormulaContext>;
 };
+/** @internal */
 export declare type BaseFilter = IncludeAllFilter | IncludeMembersFilter | ExcludeMembersFilter;
+/** @internal */
 export declare type BackgroundFilter = BaseFilter & {
     level?: 'string';
 };
+/** @internal */
 export declare type IncludeAllFilter = {
     all: true;
 };
+/** @internal */
 export declare type IncludeMembersFilter = {
     members: string[];
 };
+/** @internal */
 export declare type ExcludeMembersFilter = {
     exclude: {
         members: string[];
     };
 };
+/** @internal */
 export declare type TurnOffMembersFilter = ExcludeMembersFilter & {
     turnedOff: boolean;
 };
+/** @internal */
 export declare type FilterJaql = BaseJaql & {
     filter: BaseFilter & {
         filter?: BackgroundFilter | TurnOffMembersFilter;

package/dist/dimensional-model/types.js

@@ -282,12 +282,14 @@ export const DateLevels = {
         ];
     },
 };
+/** @internal */
 export var DataType;
 (function (DataType) {
     DataType["TEXT"] = "text";
     DataType["NUMERIC"] = "numeric";
     DataType["DATETIME"] = "datetime";
 })(DataType = DataType || (DataType = {}));
+/** @internal */
 export var SortDirection;
 (function (SortDirection) {
     SortDirection["ASC"] = "asc";

package/dist/interfaces.d.ts

@@ -148,6 +148,133 @@ export interface QueryResultData {
     /** 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.
  *

package/dist/interfaces.js

@@ -1,3 +1,11 @@
+/**
+ * Empty pivot query result data set
+ *
+ * @internal
+ */
+export const EMPTY_PIVOT_QUERY_RESULT_DATA = {
+    table: { columns: [], rows: [] },
+};
 /**
  * Runs type guard check for DataSource.
  *

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { Filter, FilterRelation } from './index.js';
+import { Filter, FilterRelations, FilterRelationsJaql } from './index.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -10,7 +10,7 @@ export declare const guidFast: (len?: number) => string;
  *
  * @internal
  */
-export declare const getFilterListAndRelations: (filterRelations: FilterRelation | Filter[] | undefined) => {
+export declare const getFilterListAndRelations: (filterRelations: FilterRelations | Filter[] | undefined) => {
     filters: Filter[] | undefined;
-    relations: FilterRelation | undefined;
+    relations: FilterRelationsJaql | undefined;
 };

package/package.json

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