@sisense/sdk-data 2.4.1 → 2.6.0

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

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFilter = exports.isDateRangeFilter = exports.isTextFilter = exports.isRelativeDateFilter = exports.isCascadingFilter = exports.isLogicalAttributeFilter = exports.isExcludeFilter = exports.isMeasureFilter = exports.isRankingFilter = exports.isNumericFilter = exports.isMembersFilter = exports.isCustomFilter = exports.CustomFilter = exports.RelativeDateFilter = exports.DateRangeFilter = exports.TextFilter = exports.NumericFilter = exports.RankingFilter = exports.MeasureFilter = exports.DoubleOperatorFilter = exports.ExcludeFilter = exports.CascadingFilter = exports.MembersFilter = exports.LogicalAttributeFilter = exports.FilterTypes = exports.RankingOperators = exports.LogicalOperators = exports.DateOperators = exports.NumericOperators = exports.TextOperators = void 0;
+/* eslint-disable max-lines */
 const hash_it_1 = __importDefault(require("hash-it"));
 const merge_js_1 = __importDefault(require("lodash-es/merge.js"));
 const omit_js_1 = __importDefault(require("lodash-es/omit.js"));
@@ -98,6 +99,10 @@ exports.FilterTypes = {
 class AbstractFilter extends base_js_1.DimensionalElement {
     constructor(att, filterType, config, composeCode) {
         super('filter', types_js_1.MetadataTypes.Filter, undefined, undefined, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'AbstractFilter';
         this.filterType = filterType;
         // need to set isScope
         // to make filter complete for comparison
@@ -115,7 +120,6 @@ class AbstractFilter extends base_js_1.DimensionalElement {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'AbstractFilter';
         result.filterType = this.filterType;
         result.attribute = this.attribute.serialize();
         if (this.config) {
@@ -173,6 +177,10 @@ class AbstractFilter extends base_js_1.DimensionalElement {
 class LogicalAttributeFilter extends AbstractFilter {
     constructor(filters, operator, config, composeCode) {
         super(filters[0].attribute, exports.FilterTypes.logicalAttribute, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'LogicalAttributeFilter';
         this.operator = operator;
         this.filters = filters;
     }
@@ -187,7 +195,6 @@ class LogicalAttributeFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'LogicalAttributeFilter';
         result.operator = this.operator;
         result.filters = this.filters.map((f) => f.serialize());
         return result;
@@ -208,6 +215,10 @@ exports.LogicalAttributeFilter = LogicalAttributeFilter;
 class MembersFilter extends AbstractFilter {
     constructor(attribute, members, config, composeCode) {
         super(attribute, exports.FilterTypes.members, undefined, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'MembersFilter';
         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', {
@@ -233,7 +244,6 @@ class MembersFilter extends AbstractFilter {
      */
     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);
@@ -266,6 +276,10 @@ exports.MembersFilter = MembersFilter;
 class CascadingFilter extends AbstractFilter {
     constructor(filters, config, composeCode) {
         super(filters[0].attribute, exports.FilterTypes.cascading, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'CascadingFilter';
         this._filters = filters;
     }
     /**
@@ -289,7 +303,6 @@ class CascadingFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'CascadingFilter';
         result._filters = this.filters.map((f) => f.serialize());
         return result;
     }
@@ -318,6 +331,10 @@ exports.CascadingFilter = CascadingFilter;
 class ExcludeFilter extends AbstractFilter {
     constructor(filter, input, config, composeCode) {
         super(filter.attribute, exports.FilterTypes.exclude, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'ExcludeFilter';
         this.input = input;
         this.filter = filter;
     }
@@ -336,7 +353,6 @@ class ExcludeFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'ExcludeFilter';
         result.filter = this.filter.serialize();
         if (this.input) {
             result.input = this.input.serialize();
@@ -366,6 +382,10 @@ exports.ExcludeFilter = ExcludeFilter;
 class DoubleOperatorFilter extends AbstractFilter {
     constructor(att, filterType, operatorA, valueA, operatorB, valueB, config, composeCode) {
         super(att, filterType, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DoubleOperatorFilter';
         if (operatorA && valueA !== undefined) {
             this.valueA = valueA;
             this.operatorA = operatorA;
@@ -393,7 +413,6 @@ class DoubleOperatorFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'DoubleOperatorFilter';
         if (this.operatorA) {
             result.operatorA = this.operatorA;
         }
@@ -429,6 +448,10 @@ exports.DoubleOperatorFilter = DoubleOperatorFilter;
 class MeasureFilter extends DoubleOperatorFilter {
     constructor(att, measure, operatorA, valueA, operatorB, valueB, config, composeCode) {
         super(att, exports.FilterTypes.measure, operatorA, valueA, operatorB, valueB, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'MeasureFilter';
         this.measure = measure;
     }
     /**
@@ -449,7 +472,6 @@ class MeasureFilter extends DoubleOperatorFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'MeasureFilter';
         result.measure = this.measure.serialize();
         return result;
     }
@@ -458,7 +480,7 @@ class MeasureFilter extends DoubleOperatorFilter {
             return AbstractFilter.disabledJaql(nested);
         }
         const result = super.jaql(nested);
-        if (this.measure instanceof measures_js_1.DimensionalBaseMeasure) {
+        if ((0, measures_js_1.isDimensionalBaseMeasure)(this.measure)) {
             Object.entries(this.measure.jaql().jaql).forEach(([key, value]) => {
                 result.jaql[key] = value;
             });
@@ -473,6 +495,10 @@ exports.MeasureFilter = MeasureFilter;
 class RankingFilter extends AbstractFilter {
     constructor(att, measure, operator, count, config, composeCode) {
         super(att, exports.FilterTypes.ranking, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'RankingFilter';
         this.count = count;
         this.operator = operator;
         this.measure = measure;
@@ -488,7 +514,6 @@ class RankingFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'RankingFilter';
         result.count = this.count;
         result.operator = this.operator;
         result.measure = this.measure.serialize();
@@ -511,14 +536,16 @@ exports.RankingFilter = RankingFilter;
 class NumericFilter extends DoubleOperatorFilter {
     constructor(att, operatorA, valueA, operatorB, valueB, config, composeCode) {
         super(att, exports.FilterTypes.numeric, operatorA, valueA, operatorB, valueB, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'NumericFilter';
     }
     /**
      * Gets a serializable representation of the element
      */
     serialize() {
-        const result = super.serialize();
-        result.__serializable = 'NumericFilter';
-        return result;
+        return super.serialize();
     }
 }
 exports.NumericFilter = NumericFilter;
@@ -528,14 +555,16 @@ exports.NumericFilter = NumericFilter;
 class TextFilter extends DoubleOperatorFilter {
     constructor(att, operator, value, config, composeCode) {
         super(att, exports.FilterTypes.text, operator, value, undefined, undefined, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'TextFilter';
     }
     /**
      * Gets a serializable representation of the element
      */
     serialize() {
-        const result = super.serialize();
-        result.__serializable = 'TextFilter';
-        return result;
+        return super.serialize();
     }
 }
 exports.TextFilter = TextFilter;
@@ -545,6 +574,10 @@ exports.TextFilter = TextFilter;
 class DateRangeFilter extends DoubleOperatorFilter {
     constructor(levelAttribute, valueFrom, valueTo, config, composeCode) {
         super(levelAttribute, exports.FilterTypes.dateRange, exports.DateOperators.From, valueFrom, exports.DateOperators.To, valueTo, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DateRangeFilter';
         if (typeof valueFrom === 'object') {
             this.valueA = valueFrom.toISOString();
         }
@@ -571,9 +604,7 @@ class DateRangeFilter extends DoubleOperatorFilter {
      * Gets a serializable representation of the element
      */
     serialize() {
-        const result = super.serialize();
-        result.__serializable = 'DateRangeFilter';
-        return result;
+        return super.serialize();
     }
 }
 exports.DateRangeFilter = DateRangeFilter;
@@ -583,6 +614,10 @@ exports.DateRangeFilter = DateRangeFilter;
 class RelativeDateFilter extends AbstractFilter {
     constructor(levelAttribute, offset, count, operator, anchor, config, composeCode) {
         super(levelAttribute, exports.FilterTypes.relativeDate, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'RelativeDateFilter';
         if (!operator) {
             operator = exports.DateOperators.Next;
         }
@@ -614,7 +649,6 @@ class RelativeDateFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'RelativeDateFilter';
         result.offset = this.offset;
         result.count = this.count;
         result.operator = this.operator;
@@ -651,6 +685,10 @@ exports.RelativeDateFilter = RelativeDateFilter;
 class CustomFilter extends AbstractFilter {
     constructor(att, jaql, config, composeCode) {
         super(att, exports.FilterTypes.advanced, config, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'CustomFilter';
         // remove filterType from jaql as it is not needed
         delete jaql.filterType;
         this.jaqlExpression = jaql;
@@ -673,7 +711,6 @@ class CustomFilter extends AbstractFilter {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'CustomFilter';
         result.jaqlExpression = this.jaqlExpression;
         return result;
     }
@@ -686,7 +723,7 @@ exports.CustomFilter = CustomFilter;
  * @internal
  */
 function isCustomFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.advanced;
+    return filter && filter.__serializable === 'CustomFilter';
 }
 exports.isCustomFilter = isCustomFilter;
 /**
@@ -696,7 +733,7 @@ exports.isCustomFilter = isCustomFilter;
  * @internal
  */
 function isMembersFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.members;
+    return filter && filter.__serializable === 'MembersFilter';
 }
 exports.isMembersFilter = isMembersFilter;
 /**
@@ -706,7 +743,7 @@ exports.isMembersFilter = isMembersFilter;
  * @internal
  */
 function isNumericFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.numeric;
+    return filter && filter.__serializable === 'NumericFilter';
 }
 exports.isNumericFilter = isNumericFilter;
 /**
@@ -716,7 +753,7 @@ exports.isNumericFilter = isNumericFilter;
  * @internal
  */
 function isRankingFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.ranking;
+    return filter && filter.__serializable === 'RankingFilter';
 }
 exports.isRankingFilter = isRankingFilter;
 /**
@@ -726,7 +763,7 @@ exports.isRankingFilter = isRankingFilter;
  * @internal
  */
 function isMeasureFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.measure;
+    return filter && filter.__serializable === 'MeasureFilter';
 }
 exports.isMeasureFilter = isMeasureFilter;
 /**
@@ -736,7 +773,7 @@ exports.isMeasureFilter = isMeasureFilter;
  * @internal
  */
 function isExcludeFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.exclude;
+    return filter && filter.__serializable === 'ExcludeFilter';
 }
 exports.isExcludeFilter = isExcludeFilter;
 /**
@@ -746,7 +783,7 @@ exports.isExcludeFilter = isExcludeFilter;
  * @internal
  */
 function isLogicalAttributeFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.logicalAttribute;
+    return filter && filter.__serializable === 'LogicalAttributeFilter';
 }
 exports.isLogicalAttributeFilter = isLogicalAttributeFilter;
 /**
@@ -756,7 +793,7 @@ exports.isLogicalAttributeFilter = isLogicalAttributeFilter;
  * @internal
  */
 function isCascadingFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.cascading;
+    return filter && filter.__serializable === 'CascadingFilter';
 }
 exports.isCascadingFilter = isCascadingFilter;
 /**
@@ -766,7 +803,7 @@ exports.isCascadingFilter = isCascadingFilter;
  * @internal
  */
 function isRelativeDateFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.relativeDate;
+    return filter && filter.__serializable === 'RelativeDateFilter';
 }
 exports.isRelativeDateFilter = isRelativeDateFilter;
 /**
@@ -776,7 +813,7 @@ exports.isRelativeDateFilter = isRelativeDateFilter;
  * @internal
  */
 function isTextFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.text;
+    return filter && filter.__serializable === 'TextFilter';
 }
 exports.isTextFilter = isTextFilter;
 /**
@@ -786,7 +823,7 @@ exports.isTextFilter = isTextFilter;
  * @internal
  */
 function isDateRangeFilter(filter) {
-    return 'filterType' in filter && filter.filterType === exports.FilterTypes.dateRange;
+    return filter && filter.__serializable === 'DateRangeFilter';
 }
 exports.isDateRangeFilter = isDateRangeFilter;
 /**

package/dist/cjs/dimensional-model/filters/utils/filter-from-jaql-util.js

@@ -66,13 +66,8 @@ exports.createGenericFilter = createGenericFilter;
  * @returns The created Filter object.
  */
 const createFilterIncludeAll = (attribute, guid) => {
-    // including all members is equivalent to excluding none
-    // so we can simply create a filter with no members and excludeMembers set to true
-    const config = {
-        guid,
-        excludeMembers: true,
-    };
-    return filterFactory.members(attribute, [], config);
+    // empty members array is interpreted by server as all members are included
+    return filterFactory.members(attribute, [], { guid });
 };
 exports.createFilterIncludeAll = createFilterIncludeAll;
 /**

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

@@ -41,6 +41,10 @@ export interface Element {
      * @internal
      */
     readonly dataSource?: JaqlDataSource;
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     /**
      * 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 { JSONObject, MetadataItem, MetadataItemJaql } from './types.js';
+import { AnyObject, JSONObject, 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
@@ -16,6 +16,10 @@ import { JSONObject, MetadataItem, MetadataItemJaql } from './types.js';
  * @internal
  */
 export declare class JaqlElement extends DimensionalElement {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     private readonly metadataItem;
     expression: string;
     skipValidation: boolean;
@@ -31,6 +35,10 @@ export declare class JaqlElement extends DimensionalElement {
      */
     serialize(): JSONObject;
 }
+/**
+ * @internal
+ */
+export declare const isJaqlElement: (v: AnyObject) => v is JaqlElement;
 /**
  * Create a JaqlElement from a MetadataItem
  *

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDimensionalElementFromMetadataItem = exports.createJaqlElement = exports.JaqlElement = void 0;
+exports.createDimensionalElementFromMetadataItem = exports.createJaqlElement = exports.isJaqlElement = exports.JaqlElement = void 0;
 const utils_js_1 = require("../utils.js");
 const attributes_js_1 = require("./attributes.js");
 const base_js_1 = require("./base.js");
@@ -23,6 +23,10 @@ class JaqlElement extends base_js_1.DimensionalElement {
     constructor(item, type) {
         var _a;
         super((_a = item.jaql.title) !== null && _a !== void 0 ? _a : '', type);
+        /**
+         * @internal
+         */
+        this.__serializable = 'JaqlElement';
         this.expression = (item.jaql.dim || item.jaql.formula);
         this.metadataItem = item;
         if (item.jaql.agg) {
@@ -56,7 +60,6 @@ class JaqlElement extends base_js_1.DimensionalElement {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'JaqlElement';
         result.metadataItem = this.metadataItem;
         result.type = this.type;
         return result;
@@ -68,6 +71,13 @@ const toMetadataType = {
     numeric: types_js_1.MetadataTypes.NumericAttribute,
     datetime: types_js_1.MetadataTypes.DateLevel,
 };
+/**
+ * @internal
+ */
+const isJaqlElement = (v) => {
+    return v && v.__serializable === 'JaqlElement';
+};
+exports.isJaqlElement = isJaqlElement;
 /**
  * Create a JaqlElement from a MetadataItem
  *

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

@@ -1,10 +1,14 @@
 import { DimensionalElement } from '../base.js';
 import { Attribute, BaseMeasure, CalculatedMeasure, Measure, MeasureContext, MeasureTemplate } from '../interfaces.js';
-import { JaqlDataSource, JSONObject, Sort } from '../types.js';
+import { AnyObject, JaqlDataSource, JSONObject, Sort } from '../types.js';
 /**
  * @internal
  */
 export declare abstract class AbstractMeasure extends DimensionalElement {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     protected _sort: Sort;
     protected _format: string | undefined;
     constructor(name: string, type: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
@@ -49,6 +53,10 @@ export declare abstract class AbstractMeasure extends DimensionalElement {
  * @internal
  */
 export declare class DimensionalBaseMeasure extends AbstractMeasure implements BaseMeasure {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     static aggregationFromJAQL(agg: string): string;
     static aggregationToJAQL(agg: string): string;
     constructor(name: string, attribute: Attribute, agg: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
@@ -86,6 +94,10 @@ export declare class DimensionalBaseMeasure extends AbstractMeasure implements B
     serialize(): JSONObject;
     jaql(nested?: boolean): any;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalBaseMeasure: (v: AnyObject) => v is DimensionalBaseMeasure;
 /**
  * Stands for a Calculated Measure
  *
@@ -93,6 +105,10 @@ export declare class DimensionalBaseMeasure extends AbstractMeasure implements B
  * @internal
  */
 export declare class DimensionalCalculatedMeasure extends AbstractMeasure implements CalculatedMeasure {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(name: string, expression: string, context: MeasureContext, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Defines the Calculated measure's expression
@@ -128,12 +144,20 @@ export declare class DimensionalCalculatedMeasure extends AbstractMeasure implem
     serialize(): JSONObject;
     jaql(nested?: boolean): any;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalCalculatedMeasure: (v: AnyObject) => v is DimensionalCalculatedMeasure;
 /**
  * Stands for a Measure template - generator for different aggregation over Attribute
  *
  * @internal
  */
 export declare class DimensionalMeasureTemplate extends AbstractMeasure implements MeasureTemplate {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(name: string, attribute: Attribute, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Aggregating attribute
@@ -211,7 +235,11 @@ export declare class DimensionalMeasureTemplate extends AbstractMeasure implemen
     countDistinct(format?: string): Measure;
 }
 /**
- * @param json
+ * @internal
+ */
+export declare const isDimensionalMeasureTemplate: (v: AnyObject) => v is DimensionalMeasureTemplate;
+/**
+ * @param json - The JSON object to create a measure from
  * @internal
  */
 export declare function createMeasure(json: any): Measure | BaseMeasure;