@sisense/sdk-data 1.31.0 → 1.33.0

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

@@ -10,8 +10,9 @@ export declare const jaqlSimpleColumnType: (datatype: string) => string;
  */
 export declare class DimensionalAttribute extends DimensionalElement implements Attribute {
     readonly expression: string;
+    readonly panel: string;
     protected _sort: Sort;
-    constructor(name: string, expression: string, type?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
+    constructor(name: string, expression: string, type?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string, panel?: string);
     /**
      * gets the element's ID
      */
@@ -46,7 +47,8 @@ export declare class DimensionalAttribute extends DimensionalElement implements
 export declare class DimensionalLevelAttribute extends DimensionalAttribute implements LevelAttribute {
     private _format;
     readonly granularity: string;
-    constructor(l: string, expression: string, granularity: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
+    readonly panel: string;
+    constructor(l: string, expression: string, granularity: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string, panel?: string);
     /**
      * gets the element's ID
      */

package/dist/dimensional-model/attributes.js

@@ -9,10 +9,14 @@ export const jaqlSimpleColumnType = (datatype) => simpleColumnType(datatype).rep
  * @internal
  */
 export class DimensionalAttribute extends DimensionalElement {
-    constructor(name, expression, type, desc, sort, dataSource, composeCode) {
+    constructor(name, expression, type, desc, sort, dataSource, composeCode, panel) {
         super(name, type || MetadataTypes.Attribute, desc, dataSource, composeCode);
         this._sort = Sort.None;
         this.expression = expression;
+        // panel is not needed in most cases, this is to support break by columns functionality
+        if (panel === 'columns') {
+            this.panel = panel;
+        }
         this._sort = sort || Sort.None;
     }
     /**
@@ -36,7 +40,7 @@ export class DimensionalAttribute extends DimensionalElement {
      * @returns An instance representing the sorted {@link Attribute} of this instance
      */
     sort(sort) {
-        return new DimensionalAttribute(this.name, this.expression, this.type, this.description, sort, this.dataSource, this.composeCode);
+        return new DimensionalAttribute(this.name, this.expression, this.type, this.description, sort, this.dataSource, this.composeCode, this.panel);
     }
     /**
      * Gets the JAQL representation of this instance
@@ -51,6 +55,9 @@ export class DimensionalAttribute extends DimensionalElement {
                 datatype: jaqlSimpleColumnType(this.type),
             },
         };
+        if (this.panel) {
+            result.panel = this.panel;
+        }
         if (this._sort != Sort.None) {
             result.jaql.sort = this._sort == Sort.Ascending ? 'asc' : 'desc';
         }
@@ -72,10 +79,14 @@ export class DimensionalAttribute extends DimensionalElement {
  * @internal
  */
 export class DimensionalLevelAttribute extends DimensionalAttribute {
-    constructor(l, expression, granularity, format, desc, sort, dataSource, composeCode) {
+    constructor(l, expression, granularity, format, desc, sort, dataSource, composeCode, panel) {
         super(l, expression, MetadataTypes.DateLevel, desc, sort, dataSource, composeCode);
         this._format = format;
         this.granularity = granularity;
+        // panel is not needed in most cases, this is to support break by columns functionality
+        if (panel === 'columns') {
+            this.panel = panel;
+        }
     }
     /**
      * gets the element's ID
@@ -143,6 +154,9 @@ export class DimensionalLevelAttribute extends DimensionalAttribute {
         const r = {
             jaql: Object.assign({ title: this.name, dim: this.expression, datatype: jaqlSimpleColumnType(this.type) }, this.translateGranularityToJaql()),
         };
+        if (this.panel) {
+            r.panel = this.panel;
+        }
         if (this._format !== undefined) {
             const levelName = r.jaql.dateTimeLevel || r.jaql.level;
             r.format = { mask: {} };

package/dist/dimensional-model/dimensions/__mocks__/sample-ecommerce-fields.d.ts

@@ -0,0 +1,5 @@
+import { AnyObject, DataSourceField } from '../../types.js';
+/**
+ * Actual fields from the Sample ECommerce datasource returned by server.
+ */
+export declare const sampleEcommerceFields: (DataSourceField & AnyObject)[];

package/dist/dimensional-model/dimensions/__mocks__/sample-ecommerce-fields.js

@@ -0,0 +1,243 @@
+/**
+ * Actual fields from the Sample ECommerce datasource returned by server.
+ */
+export const sampleEcommerceFields = [
+    {
+        id: '[Brand.Brand]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Brand',
+        table: 'Brand',
+        column: 'Brand',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Brand.Brand ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Brand ID',
+        table: 'Brand',
+        column: 'Brand ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Category.Category]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Category',
+        table: 'Category',
+        column: 'Category',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Category.Category ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Category ID',
+        table: 'Category',
+        column: 'Category ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Age Range]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Age Range',
+        table: 'Commerce',
+        column: 'Age Range',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Brand ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Brand ID',
+        table: 'Commerce',
+        column: 'Brand ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Category ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Category ID',
+        table: 'Commerce',
+        column: 'Category ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Condition]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Condition',
+        table: 'Commerce',
+        column: 'Condition',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Cost]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Cost',
+        table: 'Commerce',
+        column: 'Cost',
+        merged: false,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Country ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Country ID',
+        table: 'Commerce',
+        column: 'Country ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Date (Calendar)]',
+        type: 'dimension',
+        dimtype: 'datetime',
+        title: 'Date',
+        table: 'Commerce',
+        column: 'Date',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Gender]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Gender',
+        table: 'Commerce',
+        column: 'Gender',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Quantity]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Quantity',
+        table: 'Commerce',
+        column: 'Quantity',
+        merged: false,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Revenue]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Revenue',
+        table: 'Commerce',
+        column: 'Revenue',
+        merged: false,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Commerce.Visit ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Visit ID',
+        table: 'Commerce',
+        column: 'Visit ID',
+        merged: false,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Country.Country]',
+        type: 'dimension',
+        dimtype: 'text',
+        title: 'Country',
+        table: 'Country',
+        column: 'Country',
+        merged: false,
+        indexed: true,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+    {
+        id: '[Country.Country ID]',
+        type: 'dimension',
+        dimtype: 'numeric',
+        title: 'Country ID',
+        table: 'Country',
+        column: 'Country ID',
+        merged: true,
+        indexed: false,
+        tableDescription: null,
+        columnDescription: null,
+        tableTitle: null,
+        semanticIndex: false,
+    },
+];

package/dist/dimensional-model/{dimensions.d.ts → dimensions/dimensions.d.ts}

@@ -1,6 +1,6 @@
-import { Attribute, LevelAttribute, Dimension, DateDimension } from './interfaces.js';
-import { Sort, JaqlDataSource } from './types.js';
-import { DimensionalElement } from './base.js';
+import { Attribute, LevelAttribute, Dimension, DateDimension } from '../interfaces.js';
+import { Sort, JaqlDataSource } from '../types.js';
+import { DimensionalElement } from '../base.js';
 /**
  * Represents a Dimension in a Dimensional Model
  *

package/dist/dimensional-model/{dimensions.js → dimensions/dimensions.js}

@@ -1,6 +1,6 @@
-import { Sort, DateLevels, MetadataTypes } from './types.js';
-import { DimensionalAttribute, DimensionalLevelAttribute, jaqlSimpleColumnType, } from './attributes.js';
-import { DimensionalElement, normalizeName } from './base.js';
+import { Sort, DateLevels, MetadataTypes } from '../types.js';
+import { DimensionalAttribute, DimensionalLevelAttribute, jaqlSimpleColumnType, } from '../attributes.js';
+import { DimensionalElement, normalizeName } from '../base.js';
 /**
  * Represents a Dimension in a Dimensional Model
  *

package/dist/dimensional-model/dimensions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './dimensions.js';
+export * from './utils.js';

package/dist/dimensional-model/dimensions/index.js

@@ -0,0 +1,2 @@
+export * from './dimensions.js';
+export * from './utils.js';

package/dist/dimensional-model/dimensions/utils.d.ts

@@ -0,0 +1,11 @@
+import { DataSource } from '../../interfaces.js';
+import { Dimension } from '../interfaces.js';
+import { DataSourceField } from '../types.js';
+/**
+ * Function to convert data source fields to dimensions.
+ * @param fields - The data source fields to convert.
+ * @param dataSource - The data source title.
+ * @returns - The dimensions created from the data source fields.
+ * @internal
+ */
+export declare function getDimensionsFromDataSourceFields(fields: DataSourceField[], dataSource: DataSource): Dimension[];

package/dist/dimensional-model/dimensions/utils.js

@@ -0,0 +1,59 @@
+import { createAttribute } from '../attributes.js';
+import { createDimension, createDateDimension } from './dimensions.js';
+import { isDataSourceInfo } from '../../utils.js';
+/**
+ * Function to convert data source fields to dimensions.
+ * @param fields - The data source fields to convert.
+ * @param dataSource - The data source title.
+ * @returns - The dimensions created from the data source fields.
+ * @internal
+ */
+export function getDimensionsFromDataSourceFields(fields, dataSource) {
+    const attributeEntries = fields.map((field) => createAttributeEntry(field, dataSource));
+    const groupedConfigs = groupAttributesByDimension(attributeEntries);
+    return Object.values(groupedConfigs).map((config) => createDimension(config));
+}
+/**
+ * Given a DataSourceField and the data source title, creates an attribute entry
+ * that includes the dimension name, attribute name, and the attribute itself.
+ */
+const createAttributeEntry = (field, dataSource) => {
+    const dimensionId = field.table;
+    const dimensionName = field.tableTitle || dimensionId;
+    const attributeId = field.id;
+    const attributeName = field.title || attributeId;
+    const dataSourceConfig = isDataSourceInfo(dataSource)
+        ? dataSource
+        : { title: dataSource, live: false };
+    const attribute = field.dimtype === 'datetime'
+        ? createDateDimension({
+            name: attributeName,
+            expression: attributeId,
+            dataSource: dataSourceConfig,
+        })
+        : createAttribute({
+            name: attributeName,
+            type: field.dimtype === 'text' ? 'text-attribute' : 'numeric-attribute',
+            expression: attributeId,
+            dataSource: dataSourceConfig,
+        });
+    return {
+        dimension: {
+            id: dimensionId,
+            name: dimensionName,
+        },
+        attribute,
+    };
+};
+/**
+ * Groups an array of attribute entries by their dimension name.
+ * Returns an object whose keys are dimension names and values are configuration objects
+ * that can be passed to createDimension.
+ */
+const groupAttributesByDimension = (entries) => entries.reduce((acc, { dimension, attribute }) => {
+    const dimensionConfig = acc[dimension.name] || {
+        name: dimension.name,
+        expression: dimension.id,
+    };
+    return Object.assign(Object.assign({}, acc), { [dimension.name]: Object.assign(Object.assign({}, dimensionConfig), { [attribute.name]: attribute }) });
+}, {});

package/dist/dimensional-model/factory.js

@@ -2,7 +2,7 @@
 import { MetadataTypes } from './types.js';
 import { createMeasure } from './measures/measures.js';
 import { createFilter } from './filters/filters.js';
-import { createDimension } from './dimensions.js';
+import { createDimension } from './dimensions/index.js';
 import { createAttribute } from './attributes.js';
 import { TranslatableError } from '../translation/translatable-error.js';
 /**

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

@@ -153,6 +153,7 @@ export declare class MembersFilter extends AbstractFilter {
      * gets the element's ID
      */
     get id(): string;
+    get name(): string;
     /**
      * Gets a serializable representation of the element
      */

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

@@ -6,6 +6,7 @@ import { DimensionalBaseMeasure } from '../measures/measures.js';
 import { TranslatableError } from '../../translation/translatable-error.js';
 import { getDefaultBaseFilterConfig, getDefaultMembersFilterConfig, } from './filter-config-utils.js';
 import merge from 'lodash-es/merge.js';
+import omit from 'lodash-es/omit.js';
 /**
  * Different text operators that can be used with text filters
  *
@@ -210,6 +211,10 @@ export class MembersFilter extends AbstractFilter {
     get id() {
         return `${this.attribute.id}_${this.members.map((m) => m.toString()).join()}`;
     }
+    get name() {
+        // to hexadecimal string
+        return hash([this.jaql(), omit(this.config, ['guid', 'originalFilterJaql'])]).toString(16);
+    }
     /**
      * Gets a serializable representation of the element
      */

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

@@ -197,6 +197,7 @@ export declare type BaseJaql = {
         };
     };
     merged?: boolean;
+    panel?: 'rows' | 'columns';
 };
 /** @internal */
 export declare type FormulaID = string;
@@ -403,6 +404,7 @@ export declare type DataSourceField = {
     indexed: boolean;
     merged: boolean;
     table: string;
+    tableTitle?: null | string;
     title: string;
     type: string;
 };

package/dist/index.d.ts

@@ -12,7 +12,7 @@ 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/dimensions/index.js';
 export * from './dimensional-model/factory.js';
 export * from './dimensional-model/jaql-element.js';
 export * from './dimensional-model/filters/filters.js';

package/dist/index.js

@@ -12,7 +12,7 @@ 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/dimensions/index.js';
 export * from './dimensional-model/factory.js';
 export * from './dimensional-model/jaql-element.js';
 export * from './dimensional-model/filters/filters.js';