@sisense/sdk-data 1.0.0 → 1.2.0

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

@@ -355,3 +355,44 @@ export interface FilterRelation {
 export declare type FilterRelationJaqlNode = {
     instanceid: string;
 };
+/**
+ * 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;

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/index.d.ts

@@ -12,13 +12,13 @@ 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
+ * Functions to create date, text, or numeric filters on specified data.
  *
- * 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 to:
  *
- * 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}.
+ * + 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.

package/dist/index.js

@@ -12,13 +12,13 @@ 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
+ * Functions to create date, text, or numeric filters on specified data.
  *
- * 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 to:
  *
- * 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}.
+ * + 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.

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/package.json

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