@sisense/sdk-data 1.34.0 → 2.0.0

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

@@ -1,6 +1,6 @@
 import { DimensionalElement } from '../base.js';
 import { Attribute, BaseFilterConfig, CompleteBaseFilterConfig, CompleteMembersFilterConfig, Filter, LevelAttribute, Measure, MembersFilterConfig } from '../interfaces.js';
-import { AnyObject } from '../types.js';
+import { AnyObject, JSONObject } from '../types.js';
 /**
  * Different text operators that can be used with text filters
  *
@@ -95,7 +95,7 @@ declare abstract class AbstractFilter extends DimensionalElement implements Filt
      * Filter configuration
      */
     config: CompleteBaseFilterConfig;
-    constructor(att: Attribute, filterType: string, config?: BaseFilterConfig);
+    constructor(att: Attribute, filterType: string, config?: BaseFilterConfig, composeCode?: string);
     get name(): string;
     /**
      * Gets JAQL representing this Filter instance
@@ -112,7 +112,7 @@ declare abstract class AbstractFilter extends DimensionalElement implements Filt
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets the JAQL representation of this instance
      *
@@ -128,7 +128,7 @@ declare abstract class AbstractFilter extends DimensionalElement implements Filt
 export declare class LogicalAttributeFilter extends AbstractFilter {
     readonly filters: Filter[];
     readonly operator: string;
-    constructor(filters: Filter[], operator: string, config?: BaseFilterConfig);
+    constructor(filters: Filter[], operator: string, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -136,7 +136,7 @@ export declare class LogicalAttributeFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -148,7 +148,7 @@ export declare class LogicalAttributeFilter extends AbstractFilter {
 export declare class MembersFilter extends AbstractFilter {
     readonly members: string[];
     config: CompleteMembersFilterConfig;
-    constructor(attribute: Attribute, members?: string[], config?: MembersFilterConfig);
+    constructor(attribute: Attribute, members?: string[], config?: MembersFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -157,7 +157,7 @@ export declare class MembersFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -168,7 +168,7 @@ export declare class MembersFilter extends AbstractFilter {
  */
 export declare class CascadingFilter extends AbstractFilter {
     readonly _filters: Filter[];
-    constructor(filters: Filter[], config?: BaseFilterConfig);
+    constructor(filters: Filter[], config?: BaseFilterConfig, composeCode?: string);
     /**
      * Returns the level filters with the root config applied.
      */
@@ -180,7 +180,7 @@ export declare class CascadingFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -193,7 +193,7 @@ export declare class CascadingFilter extends AbstractFilter {
 export declare class ExcludeFilter extends AbstractFilter {
     readonly filter: Filter;
     readonly input?: Filter;
-    constructor(filter: Filter, input?: Filter, config?: BaseFilterConfig);
+    constructor(filter: Filter, input?: Filter, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -201,7 +201,7 @@ export declare class ExcludeFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -215,7 +215,7 @@ export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
     operatorB?: string;
     valueA?: Type;
     valueB?: Type;
-    constructor(att: Attribute, filterType: string, operatorA?: string, valueA?: Type, operatorB?: string, valueB?: Type, config?: BaseFilterConfig);
+    constructor(att: Attribute, filterType: string, operatorA?: string, valueA?: Type, operatorB?: string, valueB?: Type, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -223,7 +223,7 @@ export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -234,7 +234,7 @@ export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
  */
 export declare class MeasureFilter extends DoubleOperatorFilter<number> {
     measure: Measure;
-    constructor(att: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig);
+    constructor(att: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -242,7 +242,7 @@ export declare class MeasureFilter extends DoubleOperatorFilter<number> {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     jaql(nested?: boolean | undefined): any;
 }
 /**
@@ -252,7 +252,7 @@ export declare class RankingFilter extends AbstractFilter {
     count: number;
     operator: string;
     measure: Measure;
-    constructor(att: Attribute, measure: Measure, operator: string, count: number, config?: BaseFilterConfig);
+    constructor(att: Attribute, measure: Measure, operator: string, count: number, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -260,7 +260,7 @@ export declare class RankingFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      */
@@ -270,19 +270,27 @@ export declare class RankingFilter extends AbstractFilter {
  * @internal
  */
 export declare class NumericFilter extends DoubleOperatorFilter<number> {
-    constructor(att: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig);
+    constructor(att: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig, composeCode?: string);
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize(): JSONObject;
 }
 /**
  * @internal
  */
 export declare class TextFilter extends DoubleOperatorFilter<string> {
-    constructor(att: Attribute, operator: string, value: string, config?: BaseFilterConfig);
+    constructor(att: Attribute, operator: string, value: string, config?: BaseFilterConfig, composeCode?: string);
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize(): JSONObject;
 }
 /**
  * @internal
  */
 export declare class DateRangeFilter extends DoubleOperatorFilter<Date | string> {
-    constructor(l: LevelAttribute, valueFrom?: Date | string, valueTo?: Date | string, config?: BaseFilterConfig);
+    constructor(levelAttribute: LevelAttribute, valueFrom?: Date | string, valueTo?: Date | string, config?: BaseFilterConfig, composeCode?: string);
     get level(): LevelAttribute;
     get from(): string;
     get to(): string;
@@ -290,6 +298,10 @@ export declare class DateRangeFilter extends DoubleOperatorFilter<Date | string>
      * Gets JAQL representing this Filter instance
      */
     filterJaql(): any;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize(): JSONObject;
 }
 /**
  * @internal
@@ -299,7 +311,7 @@ export declare class RelativeDateFilter extends AbstractFilter {
     readonly count: number;
     readonly operator: typeof DateOperators.Last | typeof DateOperators.Next;
     readonly anchor?: Date | string;
-    constructor(l: LevelAttribute, offset: number, count: number, operator?: typeof DateOperators.Last | typeof DateOperators.Next, anchor?: Date | string, config?: BaseFilterConfig);
+    constructor(levelAttribute: LevelAttribute, offset: number, count: number, operator?: typeof DateOperators.Last | typeof DateOperators.Next, anchor?: Date | string, config?: BaseFilterConfig, composeCode?: string);
     get level(): LevelAttribute;
     /**
      * gets the element's ID
@@ -308,7 +320,7 @@ export declare class RelativeDateFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable(): any;
+    serialize(): JSONObject;
     /**
      * Gets JAQL representing this Filter instance
      *
@@ -320,7 +332,7 @@ export declare class RelativeDateFilter extends AbstractFilter {
  */
 export declare class CustomFilter extends AbstractFilter {
     readonly jaqlExpression: any;
-    constructor(att: Attribute, jaql: any, config?: BaseFilterConfig);
+    constructor(att: Attribute, jaql: any, config?: BaseFilterConfig, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -330,6 +342,10 @@ export declare class CustomFilter extends AbstractFilter {
      *
      */
     filterJaql(): any;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize(): JSONObject;
 }
 /**
  * Checks if a filter is a CustomFilter.

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

@@ -96,8 +96,8 @@ exports.FilterTypes = {
  * @internal
  */
 class AbstractFilter extends base_js_1.DimensionalElement {
-    constructor(att, filterType, config) {
-        super('filter', types_js_1.MetadataTypes.Filter);
+    constructor(att, filterType, config, composeCode) {
+        super('filter', types_js_1.MetadataTypes.Filter, undefined, undefined, composeCode);
         this.filterType = filterType;
         // need to set isScope
         // to make filter complete for comparison
@@ -113,10 +113,15 @@ class AbstractFilter extends base_js_1.DimensionalElement {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'AbstractFilter';
         result.filterType = this.filterType;
-        result.attribute = this.attribute.serializable();
+        result.attribute = this.attribute.serialize();
+        if (this.config) {
+            result.config = this.config;
+        }
+        result.composeCode = this.composeCode;
         return result;
     }
     /**
@@ -166,8 +171,8 @@ class AbstractFilter extends base_js_1.DimensionalElement {
  * @internal
  */
 class LogicalAttributeFilter extends AbstractFilter {
-    constructor(filters, operator, config) {
-        super(filters[0].attribute, exports.FilterTypes.logicalAttribute, config);
+    constructor(filters, operator, config, composeCode) {
+        super(filters[0].attribute, exports.FilterTypes.logicalAttribute, config, composeCode);
         this.operator = operator;
         this.filters = filters;
     }
@@ -180,10 +185,11 @@ class LogicalAttributeFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'LogicalAttributeFilter';
         result.operator = this.operator;
-        result.filters = this.filters.map((f) => f.serializable());
+        result.filters = this.filters.map((f) => f.serialize());
         return result;
     }
     /**
@@ -200,8 +206,8 @@ exports.LogicalAttributeFilter = LogicalAttributeFilter;
  * @internal
  */
 class MembersFilter extends AbstractFilter {
-    constructor(attribute, members, config) {
-        super(attribute, exports.FilterTypes.members);
+    constructor(attribute, members, config, composeCode) {
+        super(attribute, exports.FilterTypes.members, undefined, composeCode);
         this.members = members !== null && members !== void 0 ? members : [];
         if (this.members.filter((m) => m === null || m === undefined).length > 0) {
             throw new translatable_error_js_1.TranslatableError('errors.filter.membersFilterNullMember', {
@@ -225,8 +231,13 @@ class MembersFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'MembersFilter';
+        if (this.config) {
+            result.config = (this.config.backgroundFilter
+                ? Object.assign(Object.assign({}, this.config), { backgroundFilter: this.config.backgroundFilter.serialize() }) : this.config);
+        }
         result.members = this.members;
         return result;
     }
@@ -253,8 +264,8 @@ exports.MembersFilter = MembersFilter;
  * @internal
  */
 class CascadingFilter extends AbstractFilter {
-    constructor(filters, config) {
-        super(filters[0].attribute, exports.FilterTypes.cascading, config);
+    constructor(filters, config, composeCode) {
+        super(filters[0].attribute, exports.FilterTypes.cascading, config, composeCode);
         this._filters = filters;
     }
     /**
@@ -276,9 +287,10 @@ class CascadingFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
-        result.filters = this.filters.map((f) => f.serializable());
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'CascadingFilter';
+        result._filters = this.filters.map((f) => f.serialize());
         return result;
     }
     /**
@@ -304,8 +316,8 @@ exports.CascadingFilter = CascadingFilter;
  * @internal
  */
 class ExcludeFilter extends AbstractFilter {
-    constructor(filter, input, config) {
-        super(filter.attribute, exports.FilterTypes.exclude, config);
+    constructor(filter, input, config, composeCode) {
+        super(filter.attribute, exports.FilterTypes.exclude, config, composeCode);
         this.input = input;
         this.filter = filter;
     }
@@ -322,11 +334,12 @@ class ExcludeFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
-        result.filter = this.filter.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'ExcludeFilter';
+        result.filter = this.filter.serialize();
         if (this.input) {
-            result.input = this.input.serializable();
+            result.input = this.input.serialize();
         }
         return result;
     }
@@ -351,8 +364,8 @@ exports.ExcludeFilter = ExcludeFilter;
  * @internal
  */
 class DoubleOperatorFilter extends AbstractFilter {
-    constructor(att, filterType, operatorA, valueA, operatorB, valueB, config) {
-        super(att, filterType, config);
+    constructor(att, filterType, operatorA, valueA, operatorB, valueB, config, composeCode) {
+        super(att, filterType, config, composeCode);
         if (operatorA && valueA !== undefined) {
             this.valueA = valueA;
             this.operatorA = operatorA;
@@ -378,8 +391,9 @@ class DoubleOperatorFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'DoubleOperatorFilter';
         if (this.operatorA) {
             result.operatorA = this.operatorA;
         }
@@ -413,8 +427,8 @@ exports.DoubleOperatorFilter = DoubleOperatorFilter;
  * @internal
  */
 class MeasureFilter extends DoubleOperatorFilter {
-    constructor(att, measure, operatorA, valueA, operatorB, valueB, config) {
-        super(att, exports.FilterTypes.measure, operatorA, valueA, operatorB, valueB, config);
+    constructor(att, measure, operatorA, valueA, operatorB, valueB, config, composeCode) {
+        super(att, exports.FilterTypes.measure, operatorA, valueA, operatorB, valueB, config, composeCode);
         this.measure = measure;
     }
     /**
@@ -433,9 +447,10 @@ class MeasureFilter extends DoubleOperatorFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
-        result.measure = this.measure.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'MeasureFilter';
+        result.measure = this.measure.serialize();
         return result;
     }
     jaql(nested) {
@@ -456,8 +471,8 @@ exports.MeasureFilter = MeasureFilter;
  * @internal
  */
 class RankingFilter extends AbstractFilter {
-    constructor(att, measure, operator, count, config) {
-        super(att, exports.FilterTypes.ranking, config);
+    constructor(att, measure, operator, count, config, composeCode) {
+        super(att, exports.FilterTypes.ranking, config, composeCode);
         this.count = count;
         this.operator = operator;
         this.measure = measure;
@@ -471,11 +486,12 @@ class RankingFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'RankingFilter';
         result.count = this.count;
         result.operator = this.operator;
-        result.measure = this.measure.serializable();
+        result.measure = this.measure.serialize();
         return result;
     }
     /**
@@ -493,8 +509,16 @@ exports.RankingFilter = RankingFilter;
  * @internal
  */
 class NumericFilter extends DoubleOperatorFilter {
-    constructor(att, operatorA, valueA, operatorB, valueB, config) {
-        super(att, exports.FilterTypes.numeric, operatorA, valueA, operatorB, valueB, config);
+    constructor(att, operatorA, valueA, operatorB, valueB, config, composeCode) {
+        super(att, exports.FilterTypes.numeric, operatorA, valueA, operatorB, valueB, config, composeCode);
+    }
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'NumericFilter';
+        return result;
     }
 }
 exports.NumericFilter = NumericFilter;
@@ -502,8 +526,16 @@ exports.NumericFilter = NumericFilter;
  * @internal
  */
 class TextFilter extends DoubleOperatorFilter {
-    constructor(att, operator, value, config) {
-        super(att, exports.FilterTypes.text, operator, value, undefined, undefined, config);
+    constructor(att, operator, value, config, composeCode) {
+        super(att, exports.FilterTypes.text, operator, value, undefined, undefined, config, composeCode);
+    }
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'TextFilter';
+        return result;
     }
 }
 exports.TextFilter = TextFilter;
@@ -511,8 +543,8 @@ exports.TextFilter = TextFilter;
  * @internal
  */
 class DateRangeFilter extends DoubleOperatorFilter {
-    constructor(l, valueFrom, valueTo, config) {
-        super(l, exports.FilterTypes.dateRange, exports.DateOperators.From, valueFrom, exports.DateOperators.To, valueTo, config);
+    constructor(levelAttribute, valueFrom, valueTo, config, composeCode) {
+        super(levelAttribute, exports.FilterTypes.dateRange, exports.DateOperators.From, valueFrom, exports.DateOperators.To, valueTo, config, composeCode);
         if (typeof valueFrom === 'object') {
             this.valueA = valueFrom.toISOString();
         }
@@ -535,14 +567,22 @@ class DateRangeFilter extends DoubleOperatorFilter {
     filterJaql() {
         return super.filterJaql();
     }
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'DateRangeFilter';
+        return result;
+    }
 }
 exports.DateRangeFilter = DateRangeFilter;
 /**
  * @internal
  */
 class RelativeDateFilter extends AbstractFilter {
-    constructor(l, offset, count, operator, anchor, config) {
-        super(l, exports.FilterTypes.relativeDate, config);
+    constructor(levelAttribute, offset, count, operator, anchor, config, composeCode) {
+        super(levelAttribute, exports.FilterTypes.relativeDate, config, composeCode);
         if (!operator) {
             operator = exports.DateOperators.Next;
         }
@@ -572,13 +612,14 @@ class RelativeDateFilter extends AbstractFilter {
     /**
      * Gets a serializable representation of the element
      */
-    serializable() {
-        const result = super.serializable();
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'RelativeDateFilter';
         result.offset = this.offset;
         result.count = this.count;
         result.operator = this.operator;
         if (this.anchor) {
-            result.anchor = this.anchor;
+            result.anchor = typeof this.anchor === 'string' ? this.anchor : this.anchor.toISOString();
         }
         return result;
     }
@@ -608,8 +649,8 @@ exports.RelativeDateFilter = RelativeDateFilter;
  * @internal
  */
 class CustomFilter extends AbstractFilter {
-    constructor(att, jaql, config) {
-        super(att, exports.FilterTypes.advanced, config);
+    constructor(att, jaql, config, composeCode) {
+        super(att, exports.FilterTypes.advanced, config, composeCode);
         // remove filterType from jaql as it is not needed
         delete jaql.filterType;
         this.jaqlExpression = jaql;
@@ -627,6 +668,15 @@ class CustomFilter extends AbstractFilter {
     filterJaql() {
         return this.jaqlExpression;
     }
+    /**
+     * Gets a serializable representation of the element
+     */
+    serialize() {
+        const result = super.serialize();
+        result.__serializable = 'CustomFilter';
+        result.jaqlExpression = this.jaqlExpression;
+        return result;
+    }
 }
 exports.CustomFilter = CustomFilter;
 /**

package/dist/cjs/dimensional-model/filters/utils/attribute-measure-util.js

@@ -9,15 +9,11 @@ const utils_js_1 = require("../../../utils.js");
  * @returns attribute or level attribute
  */
 const createAttributeFromFilterJaql = (jaql) => {
-    const { dim, table, column, datatype, title, datasource: dataSource } = jaql;
+    const { dim, datatype, title, datasource: dataSource } = jaql;
     return (0, utils_js_1.createAttributeHelper)({
-        dim,
-        table,
-        column,
+        expression: dim,
         dataType: datatype,
         granularity: (0, utils_js_1.getGranularityFromJaql)(jaql),
-        format: undefined,
-        sort: undefined,
         title,
         dataSource,
     });
@@ -30,13 +26,11 @@ exports.createAttributeFromFilterJaql = createAttributeFromFilterJaql;
  * @returns Measure
  */
 const createMeasureFromFilterJaql = (jaql) => {
-    const { dim, table, column, title, datatype: dataType, agg, datasource: dataSource } = jaql;
+    const { dim, title, datatype: dataType, agg, datasource: dataSource } = jaql;
     if (!agg)
         return undefined;
     return (0, utils_js_1.createMeasureHelper)({
-        dim,
-        table,
-        column,
+        expression: dim,
         dataType,
         agg,
         granularity: (0, utils_js_1.getGranularityFromJaql)(jaql),
@@ -56,11 +50,9 @@ exports.createMeasureFromFilterJaql = createMeasureFromFilterJaql;
 const createMeasureFromRankingFilterJaql = (jaql, rankingMessage) => {
     if ('formula' in jaql)
         return (0, utils_js_1.createCalculatedMeasureHelper)(jaql);
-    const { dim, table, column, datatype: dataType, agg } = jaql;
+    const { dim, datatype: dataType, agg } = jaql;
     return (0, utils_js_1.createMeasureHelper)({
-        dim,
-        table,
-        column,
+        expression: dim,
         granularity: (0, utils_js_1.getGranularityFromJaql)(jaql),
         dataType,
         agg,