@sisense/sdk-data 1.30.0 → 1.32.0

package/dist/cjs/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/cjs/dimensional-model/attributes.js

@@ -13,10 +13,14 @@ exports.jaqlSimpleColumnType = jaqlSimpleColumnType;
  * @internal
  */
 class DimensionalAttribute extends base_js_1.DimensionalElement {
-    constructor(name, expression, type, desc, sort, dataSource, composeCode) {
+    constructor(name, expression, type, desc, sort, dataSource, composeCode, panel) {
         super(name, type || types_js_1.MetadataTypes.Attribute, desc, dataSource, composeCode);
         this._sort = types_js_1.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 || types_js_1.Sort.None;
     }
     /**
@@ -40,7 +44,7 @@ class DimensionalAttribute extends base_js_1.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
@@ -55,6 +59,9 @@ class DimensionalAttribute extends base_js_1.DimensionalElement {
                 datatype: (0, exports.jaqlSimpleColumnType)(this.type),
             },
         };
+        if (this.panel) {
+            result.panel = this.panel;
+        }
         if (this._sort != types_js_1.Sort.None) {
             result.jaql.sort = this._sort == types_js_1.Sort.Ascending ? 'asc' : 'desc';
         }
@@ -77,10 +84,14 @@ exports.DimensionalAttribute = DimensionalAttribute;
  * @internal
  */
 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, types_js_1.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
@@ -148,6 +159,9 @@ class DimensionalLevelAttribute extends DimensionalAttribute {
         const r = {
             jaql: Object.assign({ title: this.name, dim: this.expression, datatype: (0, exports.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/cjs/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/cjs/dimensional-model/dimensions/__mocks__/sample-ecommerce-fields.js

@@ -0,0 +1,246 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleEcommerceFields = void 0;
+/**
+ * Actual fields from the Sample ECommerce datasource returned by server.
+ */
+exports.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/cjs/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/cjs/dimensional-model/{dimensions.js → dimensions/dimensions.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDateDimension = exports.createDimension = exports.DimensionalDateDimension = exports.DimensionalDimension = void 0;
-const types_js_1 = require("./types.js");
-const attributes_js_1 = require("./attributes.js");
-const base_js_1 = require("./base.js");
+const types_js_1 = require("../types.js");
+const attributes_js_1 = require("../attributes.js");
+const base_js_1 = require("../base.js");
 /**
  * Represents a Dimension in a Dimensional Model
  *

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

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

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

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dimensions.js"), exports);
+__exportStar(require("./utils.js"), exports);

package/dist/cjs/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/cjs/dimensional-model/dimensions/utils.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDimensionsFromDataSourceFields = void 0;
+const attributes_js_1 = require("../attributes.js");
+const dimensions_js_1 = require("./dimensions.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
+ */
+function getDimensionsFromDataSourceFields(fields, dataSource) {
+    const attributeEntries = fields.map((field) => createAttributeEntry(field, dataSource));
+    const groupedConfigs = groupAttributesByDimension(attributeEntries);
+    return Object.values(groupedConfigs).map((config) => (0, dimensions_js_1.createDimension)(config));
+}
+exports.getDimensionsFromDataSourceFields = getDimensionsFromDataSourceFields;
+/**
+ * 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 = { title: dataSource, live: false };
+    const attribute = field.dimtype === 'datetime'
+        ? (0, dimensions_js_1.createDateDimension)({
+            name: attributeName,
+            expression: attributeId,
+            dataSource: dataSourceConfig,
+        })
+        : (0, attributes_js_1.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/cjs/dimensional-model/factory.js

@@ -5,7 +5,7 @@ exports.create = exports.createAll = void 0;
 const types_js_1 = require("./types.js");
 const measures_js_1 = require("./measures/measures.js");
 const filters_js_1 = require("./filters/filters.js");
-const dimensions_js_1 = require("./dimensions.js");
+const index_js_1 = require("./dimensions/index.js");
 const attributes_js_1 = require("./attributes.js");
 const translatable_error_js_1 = require("../translation/translatable-error.js");
 /**
@@ -47,7 +47,7 @@ function create(item) {
         item.type === 'dimension' ||
         item.attributes ||
         item.dimtype) {
-        return (0, dimensions_js_1.createDimension)(item);
+        return (0, index_js_1.createDimension)(item);
     }
     throw new translatable_error_js_1.TranslatableError('errors.unsupportedDimensionalElement');
 }

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

@@ -7,26 +7,26 @@ import { AnyObject } from '../types.js';
  * @internal
  */
 export declare const TextOperators: {
-    Contains: string;
-    StartsWith: string;
-    EndsWith: string;
-    Equals: string;
-    DoesntEqual: string;
-    DoesntStartWith: string;
-    DoesntContain: string;
-    DoesntEndWith: string;
-    Like: string;
+    readonly Contains: "contains";
+    readonly StartsWith: "startsWith";
+    readonly EndsWith: "endsWith";
+    readonly Equals: "equals";
+    readonly DoesntEqual: "doesntEqual";
+    readonly DoesntStartWith: "doesntStartWith";
+    readonly DoesntContain: "doesntContain";
+    readonly DoesntEndWith: "doesntEndWith";
+    readonly Like: "like";
 };
 /**
  * Different numeric operators that can be used with numeric filters
  */
 export declare const NumericOperators: {
-    Equals: string;
-    DoesntEqual: string;
-    From: string;
-    FromNotEqual: string;
-    To: string;
-    ToNotEqual: string;
+    readonly Equals: "equals";
+    readonly DoesntEqual: "doesntEqual";
+    readonly From: "from";
+    readonly FromNotEqual: "fromNotEqual";
+    readonly To: "to";
+    readonly ToNotEqual: "toNotEqual";
 };
 /**
  * Different date operators that can be used with date filters
@@ -56,8 +56,8 @@ export declare const LogicalOperators: {
  * @internal
  */
 export declare const RankingOperators: {
-    Top: string;
-    Bottom: string;
+    readonly Top: "top";
+    readonly Bottom: "bottom";
 };
 /**
  * Different filter types
@@ -65,17 +65,17 @@ export declare const RankingOperators: {
  * @internal
  */
 export declare const FilterTypes: {
-    logicalAttribute: string;
-    members: string;
-    exclude: string;
-    measure: string;
-    ranking: string;
-    text: string;
-    numeric: string;
-    dateRange: string;
-    relativeDate: string;
-    cascading: string;
-    advanced: string;
+    readonly logicalAttribute: "logicalAttribute";
+    readonly members: "members";
+    readonly exclude: "exclude";
+    readonly measure: "measure";
+    readonly ranking: "ranking";
+    readonly text: "text";
+    readonly numeric: "numeric";
+    readonly dateRange: "dateRange";
+    readonly relativeDate: "relativeDate";
+    readonly cascading: "cascading";
+    readonly advanced: "advanced";
 };
 /**
  * base implementation for filter classes
@@ -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/cjs/dimensional-model/filters/filters.js

@@ -12,6 +12,7 @@ const measures_js_1 = require("../measures/measures.js");
 const translatable_error_js_1 = require("../../translation/translatable-error.js");
 const filter_config_utils_js_1 = require("./filter-config-utils.js");
 const merge_js_1 = __importDefault(require("lodash-es/merge.js"));
+const omit_js_1 = __importDefault(require("lodash-es/omit.js"));
 /**
  * Different text operators that can be used with text filters
  *
@@ -217,6 +218,10 @@ class MembersFilter extends AbstractFilter {
     get id() {
         return `${this.attribute.id}_${this.members.map((m) => m.toString()).join()}`;
     }
+    get name() {
+        // to hexadecimal string
+        return (0, hash_it_1.default)([this.jaql(), (0, omit_js_1.default)(this.config, ['guid', 'originalFilterJaql'])]).toString(16);
+    }
     /**
      * Gets a serializable representation of the element
      */

package/dist/cjs/dimensional-model/jaql-element.d.ts

@@ -1,6 +1,6 @@
 import { DimensionalElement } from './base.js';
 import { SortDirection } from './interfaces.js';
-import { MetadataItem } from './types.js';
+import { MetadataItem, MetadataItemJaql } from './types.js';
 /**
  * This implementation wraps metadata for a JAQL query. The metadata could be
  * for a dimension, measure, or filter. We do little to no interpretation of
@@ -24,7 +24,8 @@ export declare class JaqlElement extends DimensionalElement {
     sortType?: SortDirection;
     constructor(item: MetadataItem, type: string);
     get id(): string;
-    jaql(): MetadataItem;
+    jaql(nested?: true): MetadataItemJaql;
+    jaql(nested?: false | undefined): MetadataItem;
 }
 /**
  * Create a JaqlElement from a MetadataItem

package/dist/cjs/dimensional-model/jaql-element.js

@@ -47,8 +47,8 @@ class JaqlElement extends base_js_1.DimensionalElement {
     get id() {
         return this.expression;
     }
-    jaql() {
-        return this.metadataItem;
+    jaql(nested) {
+        return nested === true ? this.metadataItem.jaql : this.metadataItem;
     }
 }
 exports.JaqlElement = JaqlElement;

package/dist/cjs/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/cjs/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/cjs/index.js

@@ -41,7 +41,7 @@ __exportStar(require("./dimensional-model/interfaces.js"), exports);
 __exportStar(require("./dimensional-model/base.js"), exports);
 __exportStar(require("./dimensional-model/data-model.js"), exports);
 __exportStar(require("./dimensional-model/attributes.js"), exports);
-__exportStar(require("./dimensional-model/dimensions.js"), exports);
+__exportStar(require("./dimensional-model/dimensions/index.js"), exports);
 __exportStar(require("./dimensional-model/factory.js"), exports);
 __exportStar(require("./dimensional-model/jaql-element.js"), exports);
 __exportStar(require("./dimensional-model/filters/filters.js"), exports);