@sisense/sdk-data 2.5.0 → 2.6.0

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

@@ -1,6 +1,6 @@
 import { DimensionalElement } from './base.js';
 import { Attribute, LevelAttribute } from './interfaces.js';
-import { DateLevel, JaqlDataSource, JSONObject, Sort } from './types.js';
+import { AnyObject, DateLevel, JaqlDataSource, JSONObject, Sort } from './types.js';
 /**
  * @internal
  */
@@ -9,6 +9,10 @@ export declare const jaqlSimpleColumnType: (datatype: string) => string;
  * @internal
  */
 export declare class DimensionalAttribute extends DimensionalElement implements Attribute {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly expression: string;
     readonly panel: string;
     protected _sort: Sort;
@@ -41,10 +45,18 @@ export declare class DimensionalAttribute extends DimensionalElement implements
      */
     serialize(): JSONObject;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalAttribute: (v: AnyObject) => v is DimensionalAttribute;
 /**
  * @internal
  */
 export declare class DimensionalLevelAttribute extends DimensionalAttribute implements LevelAttribute {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     private _format;
     readonly granularity: string;
     readonly panel: string;
@@ -115,6 +127,10 @@ export declare class DimensionalLevelAttribute extends DimensionalAttribute impl
     static translateJaqlToGranularity(json: any): string;
     static getDefaultFormatForGranularity(granularity: string): string;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalLevelAttribute: (v: AnyObject) => v is DimensionalLevelAttribute;
 /**
  * Creates an Attribute instance from the given JSON object.
  * If the JSON object contains a granularity property, a {@link LevelAttribute} instance is created.

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeAttributeName = exports.createLevel = exports.createAttribute = exports.DimensionalLevelAttribute = exports.DimensionalAttribute = exports.jaqlSimpleColumnType = void 0;
+exports.normalizeAttributeName = exports.createLevel = exports.createAttribute = exports.isDimensionalLevelAttribute = exports.DimensionalLevelAttribute = exports.isDimensionalAttribute = exports.DimensionalAttribute = exports.jaqlSimpleColumnType = void 0;
 /* eslint-disable max-params */
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
@@ -23,6 +23,10 @@ exports.jaqlSimpleColumnType = jaqlSimpleColumnType;
 class DimensionalAttribute extends base_js_1.DimensionalElement {
     constructor(name, expression, type, desc, sort, dataSource, composeCode, panel) {
         super(name, type || types_js_1.MetadataTypes.Attribute, desc, dataSource, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DimensionalAttribute';
         this._sort = types_js_1.Sort.None;
         this.expression = expression;
         // if composeCode is not explicitly set by the caller, extract it from expression
@@ -85,7 +89,6 @@ class DimensionalAttribute extends base_js_1.DimensionalElement {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'DimensionalAttribute';
         result.expression = this.expression;
         if (this.getSort() !== types_js_1.Sort.None) {
             result.sort = this.getSort();
@@ -94,12 +97,23 @@ class DimensionalAttribute extends base_js_1.DimensionalElement {
     }
 }
 exports.DimensionalAttribute = DimensionalAttribute;
+/**
+ * @internal
+ */
+const isDimensionalAttribute = (v) => {
+    return Boolean(v && v.__serializable === 'DimensionalAttribute');
+};
+exports.isDimensionalAttribute = isDimensionalAttribute;
 /**
  * @internal
  */
 class DimensionalLevelAttribute extends DimensionalAttribute {
     constructor(name, expression, granularity, format, desc, sort, dataSource, composeCode, panel) {
         super(name, expression, types_js_1.MetadataTypes.DateLevel, desc, sort, dataSource, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DimensionalLevelAttribute';
         this._format = format;
         this.granularity = granularity;
         // if composeCode is not explicitly set by the caller, extract it from expression and granularity
@@ -172,7 +186,6 @@ class DimensionalLevelAttribute extends DimensionalAttribute {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'DimensionalLevelAttribute';
         result.granularity = this.granularity;
         if (this.getFormat() !== undefined) {
             result.format = this.getFormat();
@@ -353,6 +366,13 @@ class DimensionalLevelAttribute extends DimensionalAttribute {
     }
 }
 exports.DimensionalLevelAttribute = DimensionalLevelAttribute;
+/**
+ * @internal
+ */
+const isDimensionalLevelAttribute = (v) => {
+    return Boolean(v && v.__serializable === 'DimensionalLevelAttribute');
+};
+exports.isDimensionalLevelAttribute = isDimensionalLevelAttribute;
 /**
  * Creates an Attribute instance from the given JSON object.
  * If the JSON object contains a granularity property, a {@link LevelAttribute} instance is created.

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

@@ -4,6 +4,10 @@ import { JaqlDataSource, JSONObject } from './types.js';
  * @internal
  */
 export declare abstract class DimensionalElement implements Element {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     /**
      * @internal
      */
@@ -52,7 +56,7 @@ export declare abstract class DimensionalElement implements Element {
     toString(): string;
 }
 /**
- * @param name
+ * @param name - The name to normalize
  * @internal
  */
 export declare function normalizeName(name: string): string;

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

@@ -6,6 +6,10 @@ exports.normalizeName = exports.DimensionalElement = void 0;
  */
 class DimensionalElement {
     constructor(name, type, desc, dataSource, composeCode) {
+        /**
+         * @internal
+         */
+        this.__serializable = 'DimensionalElement';
         this._name = name;
         this.type = type;
         this.description = desc || '';
@@ -41,7 +45,7 @@ class DimensionalElement {
             description: this.description,
             dataSource: this.dataSource,
             composeCode: this.composeCode,
-            __serializable: 'DimensionalElement',
+            __serializable: this.__serializable,
         };
     }
     toJSON() {
@@ -56,7 +60,7 @@ class DimensionalElement {
 }
 exports.DimensionalElement = DimensionalElement;
 /**
- * @param name
+ * @param name - The name to normalize
  * @internal
  */
 function normalizeName(name) {

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

@@ -1,12 +1,16 @@
 import { DimensionalElement } from '../base.js';
 import { Attribute, DateDimension, Dimension, LevelAttribute } from '../interfaces.js';
-import { JaqlDataSource, JSONObject, Sort } from '../types.js';
+import { AnyObject, JaqlDataSource, JSONObject, Sort } from '../types.js';
 /**
  * Represents a Dimension in a Dimensional Model
  *
  * @internal
  */
 export declare class DimensionalDimension extends DimensionalElement implements Dimension, Attribute {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     static parseType(type: string): string;
     [propName: string]: any;
     defaultAttribute: Attribute | undefined;
@@ -55,12 +59,20 @@ export declare class DimensionalDimension extends DimensionalElement implements
      */
     jaql(nested?: boolean): any;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalDimension: (v: AnyObject) => v is DimensionalDimension;
 /**
  * Represents a Date Dimension in a Dimensional Model
  *
  * @internal
  */
 export declare class DimensionalDateDimension extends DimensionalDimension implements DateDimension {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(name: string, expression: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * Years level
@@ -149,6 +161,10 @@ export declare class DimensionalDateDimension extends DimensionalDimension imple
      */
     jaql(nested?: boolean): any;
 }
+/**
+ * @internal
+ */
+export declare const isDimensionalDateDimension: (v: AnyObject) => v is DimensionalDateDimension;
 /**
  * Creates a new Dimension instance from the given JSON object.
  *

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

@@ -1,14 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDateDimension = exports.createDimension = exports.DimensionalDateDimension = exports.DimensionalDimension = void 0;
-/* eslint-disable max-params */
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
+exports.createDateDimension = exports.createDimension = exports.isDimensionalDateDimension = exports.DimensionalDateDimension = exports.isDimensionalDimension = exports.DimensionalDimension = void 0;
 /* eslint-disable sonarjs/no-duplicate-string */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-argument */
 const utils_js_1 = require("../../utils.js");
 const attributes_js_1 = require("../attributes.js");
 const base_js_1 = require("../base.js");
@@ -22,6 +15,10 @@ const types_js_1 = require("../types.js");
 class DimensionalDimension extends base_js_1.DimensionalElement {
     constructor(name, expression, attributes, dimensions, type, desc, sort, dataSource, composeCode, defaultAttribute) {
         super(name, type || types_js_1.MetadataTypes.Dimension, desc, dataSource, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DimensionalDimension';
         this._dimensions = [];
         this._attributes = [];
         this._sort = types_js_1.Sort.None;
@@ -129,7 +126,6 @@ class DimensionalDimension extends base_js_1.DimensionalElement {
      */
     serialize() {
         const result = super.serialize();
-        result.__serializable = 'DimensionalDimension';
         result.expression = this.expression;
         if (this.getSort() !== undefined) {
             result.sort = this.getSort();
@@ -167,6 +163,13 @@ class DimensionalDimension extends base_js_1.DimensionalElement {
     }
 }
 exports.DimensionalDimension = DimensionalDimension;
+/**
+ * @internal
+ */
+const isDimensionalDimension = (v) => {
+    return v && v.__serializable === 'DimensionalDimension';
+};
+exports.isDimensionalDimension = isDimensionalDimension;
 /**
  * Represents a Date Dimension in a Dimensional Model
  *
@@ -175,6 +178,10 @@ exports.DimensionalDimension = DimensionalDimension;
 class DimensionalDateDimension extends DimensionalDimension {
     constructor(name, expression, desc, sort, dataSource, composeCode) {
         super(name, expression, [], [], types_js_1.MetadataTypes.DateDimension, desc, sort, dataSource, composeCode);
+        /**
+         * @internal
+         */
+        this.__serializable = 'DimensionalDateDimension';
         this.defaultLevel = types_js_1.DateLevels.Years;
         this.Years = new attributes_js_1.DimensionalLevelAttribute(types_js_1.DateLevels.Years, expression, types_js_1.DateLevels.Years, 'yyyy', desc, sort, dataSource);
         this.Quarters = new attributes_js_1.DimensionalLevelAttribute(types_js_1.DateLevels.Quarters, expression, types_js_1.DateLevels.Quarters, 'Q yyyy', desc, sort, dataSource);
@@ -240,9 +247,7 @@ class DimensionalDateDimension extends DimensionalDimension {
      * Gets a serializable representation of the element
      */
     serialize() {
-        const result = super.serialize();
-        result.__serializable = 'DimensionalDateDimension';
-        return result;
+        return super.serialize();
     }
     /**
      * Gets the JAQL representation of this instance
@@ -256,6 +261,13 @@ class DimensionalDateDimension extends DimensionalDimension {
     }
 }
 exports.DimensionalDateDimension = DimensionalDateDimension;
+/**
+ * @internal
+ */
+const isDimensionalDateDimension = (v) => {
+    return v && v.__serializable === 'DimensionalDateDimension';
+};
+exports.isDimensionalDateDimension = isDimensionalDateDimension;
 /**
  * Creates a new Dimension instance from the given JSON object.
  *

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

@@ -83,6 +83,10 @@ export declare const FilterTypes: {
  * @internal
  */
 declare abstract class AbstractFilter extends DimensionalElement implements Filter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     /**
      * Attribute this filter instance is filtering
      */
@@ -126,6 +130,10 @@ declare abstract class AbstractFilter extends DimensionalElement implements Filt
  * @internal
  */
 export declare class LogicalAttributeFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly filters: Filter[];
     readonly operator: string;
     constructor(filters: Filter[], operator: string, config?: BaseFilterConfig, composeCode?: string);
@@ -146,6 +154,10 @@ export declare class LogicalAttributeFilter extends AbstractFilter {
  * @internal
  */
 export declare class MembersFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly members: string[];
     config: CompleteMembersFilterConfig;
     constructor(attribute: Attribute, members?: string[], config?: MembersFilterConfig, composeCode?: string);
@@ -167,6 +179,10 @@ export declare class MembersFilter extends AbstractFilter {
  * @internal
  */
 export declare class CascadingFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly _filters: Filter[];
     constructor(filters: Filter[], config?: BaseFilterConfig, composeCode?: string);
     /**
@@ -191,6 +207,10 @@ export declare class CascadingFilter extends AbstractFilter {
  * @internal
  */
 export declare class ExcludeFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly filter: Filter;
     readonly input?: Filter;
     constructor(filter: Filter, input?: Filter, config?: BaseFilterConfig, composeCode?: string);
@@ -211,6 +231,10 @@ export declare class ExcludeFilter extends AbstractFilter {
  * @internal
  */
 export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     operatorA?: string;
     operatorB?: string;
     valueA?: Type;
@@ -233,6 +257,10 @@ export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
  * @internal
  */
 export declare class MeasureFilter extends DoubleOperatorFilter<number> {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     measure: Measure;
     constructor(att: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig, composeCode?: string);
     /**
@@ -249,6 +277,10 @@ export declare class MeasureFilter extends DoubleOperatorFilter<number> {
  * @internal
  */
 export declare class RankingFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     count: number;
     operator: string;
     measure: Measure;
@@ -270,6 +302,10 @@ export declare class RankingFilter extends AbstractFilter {
  * @internal
  */
 export declare class NumericFilter extends DoubleOperatorFilter<number> {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(att: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig, composeCode?: string);
     /**
      * Gets a serializable representation of the element
@@ -280,6 +316,10 @@ export declare class NumericFilter extends DoubleOperatorFilter<number> {
  * @internal
  */
 export declare class TextFilter extends DoubleOperatorFilter<string> {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(att: Attribute, operator: string, value: string, config?: BaseFilterConfig, composeCode?: string);
     /**
      * Gets a serializable representation of the element
@@ -290,6 +330,10 @@ export declare class TextFilter extends DoubleOperatorFilter<string> {
  * @internal
  */
 export declare class DateRangeFilter extends DoubleOperatorFilter<Date | string> {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     constructor(levelAttribute: LevelAttribute, valueFrom?: Date | string, valueTo?: Date | string, config?: BaseFilterConfig, composeCode?: string);
     get level(): LevelAttribute;
     get from(): string;
@@ -307,6 +351,10 @@ export declare class DateRangeFilter extends DoubleOperatorFilter<Date | string>
  * @internal
  */
 export declare class RelativeDateFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly offset: number;
     readonly count: number;
     readonly operator: typeof DateOperators.Last | typeof DateOperators.Next;
@@ -331,6 +379,10 @@ export declare class RelativeDateFilter extends AbstractFilter {
  * @internal
  */
 export declare class CustomFilter extends AbstractFilter {
+    /**
+     * @internal
+     */
+    readonly __serializable: string;
     readonly jaqlExpression: any;
     constructor(att: Attribute, jaql: any, config?: BaseFilterConfig, composeCode?: string);
     /**