@sisense/sdk-data 1.28.0 → 1.29.0

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

@@ -11,7 +11,7 @@ export declare const jaqlSimpleColumnType: (datatype: string) => string;
 export declare class DimensionalAttribute extends DimensionalElement implements Attribute {
     readonly expression: string;
     protected _sort: Sort;
-    constructor(name: string, expression: string, type?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource);
+    constructor(name: string, expression: string, type?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * gets the element's ID
      */
@@ -46,7 +46,7 @@ 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);
+    constructor(l: string, expression: string, granularity: string, format?: string, desc?: string, sort?: Sort, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * gets the element's ID
      */

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

@@ -13,8 +13,8 @@ exports.jaqlSimpleColumnType = jaqlSimpleColumnType;
  * @internal
  */
 class DimensionalAttribute extends base_js_1.DimensionalElement {
-    constructor(name, expression, type, desc, sort, dataSource) {
-        super(name, type || types_js_1.MetadataTypes.Attribute, desc, dataSource);
+    constructor(name, expression, type, desc, sort, dataSource, composeCode) {
+        super(name, type || types_js_1.MetadataTypes.Attribute, desc, dataSource, composeCode);
         this._sort = types_js_1.Sort.None;
         this.expression = expression;
         this._sort = sort || types_js_1.Sort.None;
@@ -40,7 +40,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);
+        return new DimensionalAttribute(this.name, this.expression, this.type, this.description, sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets the JAQL representation of this instance
@@ -77,8 +77,8 @@ exports.DimensionalAttribute = DimensionalAttribute;
  * @internal
  */
 class DimensionalLevelAttribute extends DimensionalAttribute {
-    constructor(l, expression, granularity, format, desc, sort, dataSource) {
-        super(l, expression, types_js_1.MetadataTypes.DateLevel, desc, sort, dataSource);
+    constructor(l, expression, granularity, format, desc, sort, dataSource, composeCode) {
+        super(l, expression, types_js_1.MetadataTypes.DateLevel, desc, sort, dataSource, composeCode);
         this._format = format;
         this.granularity = granularity;
     }
@@ -109,7 +109,7 @@ class DimensionalLevelAttribute extends DimensionalAttribute {
      * @returns An instance representing the sorted {@link LevelAttribute} of this instance
      */
     sort(sort) {
-        return new DimensionalLevelAttribute(this.name, this.expression, this.granularity, this._format, this.description, sort, this.dataSource);
+        return new DimensionalLevelAttribute(this.name, this.expression, this.granularity, this._format, this.description, sort, this.dataSource, this.composeCode);
     }
     /**
      * The string formatting of this instance
@@ -126,7 +126,7 @@ class DimensionalLevelAttribute extends DimensionalAttribute {
      * @returns An instance representing the formatted {@link LevelAttribute} of this instance
      */
     format(format) {
-        return new DimensionalLevelAttribute(this.name, this.expression, this.granularity, format, this.description, this._sort, this.dataSource);
+        return new DimensionalLevelAttribute(this.name, this.expression, this.granularity, format, this.description, this._sort, this.dataSource, this.composeCode);
     }
     /**
      * Gets a serializable representation of the element

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

@@ -21,7 +21,7 @@ export declare abstract class DimensionalElement implements Element {
      * Defines the element's data source
      */
     get dataSource(): JaqlDataSource;
-    constructor(name: string, type: string, desc?: string, dataSource?: JaqlDataSource);
+    constructor(name: string, type: string, desc?: string, dataSource?: JaqlDataSource, composeCode?: string);
     /**
      * gets the element's description
      */
@@ -34,6 +34,12 @@ export declare abstract class DimensionalElement implements Element {
      * gets the element's ID
      */
     abstract get id(): string;
+    /**
+     * Optional CSDK code to initialize this element
+     *
+     * @internal
+     */
+    composeCode?: string;
     /**
      * Gets a serializable representation of the element
      */

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

@@ -5,13 +5,14 @@ exports.normalizeName = exports.DimensionalElement = void 0;
  * @internal
  */
 class DimensionalElement {
-    constructor(name, type, desc, dataSource) {
+    constructor(name, type, desc, dataSource, composeCode) {
         this._name = name;
         this.type = type;
         this.description = desc || '';
         if (dataSource) {
             this._dataSource = dataSource;
         }
+        this.composeCode = composeCode;
     }
     /**
      * Defines the element's name

package/dist/cjs/dimensional-model/filters/filter-config-utils.d.ts

@@ -1,16 +1,19 @@
 import { BaseFilterConfig, CompleteBaseFilterConfig, CompleteMembersFilterConfig, MembersFilterConfig } from '../interfaces.js';
 /**
  * Returns a default configuration for a base filter.
+ *
  * @internal
  */
 export declare const getDefaultBaseFilterConfig: () => CompleteBaseFilterConfig;
 /**
  * Returns a default configuration for a members filter.
+ *
  * @internal
  */
 export declare const getDefaultMembersFilterConfig: () => CompleteMembersFilterConfig;
 /**
  * Checks whether the given configuration is a members filter configuration.
+ *
  * @param config - The filter configuration.
  * @returns Whether the configuration is a members filter configuration.
  * @internal
@@ -18,6 +21,7 @@ export declare const getDefaultMembersFilterConfig: () => CompleteMembersFilterC
 export declare function isMembersFilterConfig(config: BaseFilterConfig | MembersFilterConfig): config is MembersFilterConfig;
 /**
  * Simplifies the filter configuration by removing default values.
+ *
  * @param config - The filter configuration.
  * @returns The simplified filter configuration.
  * @internal

package/dist/cjs/dimensional-model/filters/filter-config-utils.js

@@ -8,6 +8,7 @@ const isEqual_js_1 = __importDefault(require("lodash-es/isEqual.js"));
 const utils_js_1 = require("../../utils.js");
 /**
  * Returns a default configuration for a base filter.
+ *
  * @internal
  */
 const getDefaultBaseFilterConfig = () => ({
@@ -18,12 +19,14 @@ const getDefaultBaseFilterConfig = () => ({
 exports.getDefaultBaseFilterConfig = getDefaultBaseFilterConfig;
 /**
  * Returns a default configuration for a members filter.
+ *
  * @internal
  */
 const getDefaultMembersFilterConfig = () => (Object.assign(Object.assign({}, (0, exports.getDefaultBaseFilterConfig)()), { excludeMembers: false, enableMultiSelection: true, deactivatedMembers: [] }));
 exports.getDefaultMembersFilterConfig = getDefaultMembersFilterConfig;
 /**
  * Checks whether the given configuration is a members filter configuration.
+ *
  * @param config - The filter configuration.
  * @returns Whether the configuration is a members filter configuration.
  * @internal
@@ -34,6 +37,7 @@ function isMembersFilterConfig(config) {
 exports.isMembersFilterConfig = isMembersFilterConfig;
 /**
  * Simplifies the filter configuration by removing default values.
+ *
  * @param config - The filter configuration.
  * @returns The simplified filter configuration.
  * @internal
@@ -43,7 +47,6 @@ const simplifyFilterConfig = (config) => {
         ? (0, exports.getDefaultMembersFilterConfig)()
         : (0, exports.getDefaultBaseFilterConfig)();
     // Filter out properties that match their default values
-    const simplifiedConfig = Object.fromEntries(Object.entries(config).filter(([key, value]) => !(0, isEqual_js_1.default)(value, defaultConfig[key])));
-    return simplifiedConfig;
+    return Object.fromEntries(Object.entries(config).filter(([key, value]) => !(0, isEqual_js_1.default)(value, defaultConfig[key])));
 };
 exports.simplifyFilterConfig = simplifyFilterConfig;

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

@@ -0,0 +1,187 @@
+import { Filter, FilterRelations, FilterRelationsJaql, FilterRelationsModel, FilterRelationsModelNode } from '../../index.js';
+/**
+ * Type guard for checking if the provided filters are FilterRelations.
+ *
+ * @param filters - The filters to check.
+ * @returns `true` if the filters are FilterRelations, `false` otherwise.
+ * @group Filter Utilities
+ */
+export declare function isFilterRelations(filters: Filter[] | FilterRelations | undefined): filters is FilterRelations;
+/**
+ * Rules of filter relations - logical operators of how filters are related to each other.
+ *
+ * @internal
+ *
+ */
+export declare type FilterRelationsRules = FilterRelationsRule | FilterRelationsRuleNode | null;
+/** @internal */
+export declare type FilterRelationsRule = {
+    left: FilterRelationsRuleNode;
+    right: FilterRelationsRuleNode;
+    operator: 'AND' | 'OR';
+};
+/** @internal */
+export declare type FilterRelationsRuleIdNode = {
+    instanceid: string;
+};
+/** @internal */
+export declare type FilterRelationsRuleNode = FilterRelationsRule | FilterRelationsRuleIdNode;
+/**
+ * Filter action types
+ *
+ * @internal
+ */
+export declare type FilterAction = {
+    type: 'add';
+    payload: Filter;
+} | {
+    type: 'remove';
+    payload: Filter;
+};
+/**
+ * Merges source filters with target filters and recalculates relations.
+ *
+ * @param sourceFilters - The source filters or filter relations to merge.
+ * @param targetFilters - The target filters or filter relations to merge with.
+ * @returns Updated source filters merged with target filters. If the source filters are FilterRelations, the relations are recalculated.
+ * @internal
+ */
+export declare function mergeFiltersOrFilterRelations(sourceFilters?: Filter[] | FilterRelations, targetFilters?: Filter[] | FilterRelations): Filter[] | FilterRelations;
+/**
+ * Splits filters or filter relations into filters and relations rules.
+ * @internal
+ */
+export declare function splitFiltersAndRelations(filtersOrFilterRelations: Filter[] | FilterRelations | undefined): {
+    filters: Filter[];
+    relations: FilterRelationsRules;
+};
+/**
+ * Returns pure filters array from the given filters or filter relations.
+ * @internal
+ */
+export declare function getFiltersArray(filtersOrFilterRelations: Filter[] | FilterRelations | undefined): Filter[];
+/**
+ * Combines filters and relations into a single FilterRelations object.
+ * If the relations are empty or relations are trivial (single node), the filters are returned as is.
+ * @internal
+ */
+export declare function combineFiltersAndRelations(filters: Filter[], relations: FilterRelationsRules): Filter[] | FilterRelations;
+/** Type guard for checking if a node is a single relations node (trivial case when relations are needless).
+ * @internal
+ */
+export declare function isTrivialSingleNodeRelations(relations: FilterRelationsRules): relations is FilterRelationsRuleIdNode;
+/**
+ * Calculates new relations based on the changes in filters.
+ * @internal
+ */
+export declare function calculateNewRelations(prevFilters: Filter[], prevRelations: FilterRelationsRules, newFilters: Filter[]): FilterRelationsRules;
+/**
+ * Replaces a filter in the relations tree with a new filter.
+ * @internal
+ */
+export declare function getRelationsWithReplacedFilter(relations: FilterRelationsRules, filterToReplace: Filter, newFilter: Filter): FilterRelationsRules;
+/**
+ * Converts filter relations model from Fusion to internal CSDK filter relations rules.
+ * @internal
+ */
+export declare function convertFilterRelationsModelToRelationRules(filterRelationsModel: FilterRelationsModel | FilterRelationsModelNode | undefined, filters: Filter[]): FilterRelationsRules;
+/**
+ * @internal
+ */
+export declare function isRelationsRuleIdNode(node: FilterRelationsRuleNode): node is FilterRelationsRuleIdNode;
+/**
+ * @internal
+ */
+export declare function isRelationsRule(node: FilterRelationsRuleNode): node is FilterRelationsRule;
+/**
+ * Converts internal CSDK filter relations rules to filter relations model for Fusion.
+ * @internal
+ */
+export declare function filterRelationRulesToFilterRelationsModel(filterRelationRules: FilterRelationsRules, filters: Filter[]): FilterRelationsModel | FilterRelationsModelNode | undefined;
+/**
+ * @internal
+ */
+export declare function findFilterByGuid(filters: Filter[], guid: string): Filter | undefined;
+/**
+ * Error thrown when an unknown node type is encountered in filter relations.
+ * @internal
+ */
+export declare class UnknownRelationsNodeError extends Error {
+    constructor();
+}
+/** @internal */
+export declare type FilterRelationsDescription = FilterRelationsDescriptionNode[];
+/** @internal */
+export declare type FilterRelationsDescriptionNode = OpenBracketDescriptionNode | CloseBracketDescriptionNode | AttributeDescriptionNode | OperatorDescriptionNode;
+/** @internal */
+export declare type OpenBracketDescriptionNode = {
+    nodeType: 'openBracket';
+};
+/**
+ * @internal
+ */
+export declare function isOpenBracketDescriptionNode(node: FilterRelationsDescriptionNode): node is OpenBracketDescriptionNode;
+/** @internal */
+export declare type CloseBracketDescriptionNode = {
+    nodeType: 'closeBracket';
+};
+/**
+ * @internal
+ */
+export declare function isCloseBracketDescriptionNode(node: FilterRelationsDescriptionNode): node is CloseBracketDescriptionNode;
+/** @internal */
+export declare type AttributeDescriptionNode = {
+    nodeType: 'attribute';
+    attribute: string;
+};
+/**
+ * @internal
+ */
+export declare function isAttributeDescriptionNode(node: FilterRelationsDescriptionNode): node is AttributeDescriptionNode;
+/** @internal */
+export declare type OperatorDescriptionNode = {
+    nodeType: 'operator';
+    operator: 'AND' | 'OR';
+};
+/**
+ * @internal
+ */
+export declare function isOperatorDescriptionNode(node: FilterRelationsDescriptionNode): node is OperatorDescriptionNode;
+/**
+ * Gets a unique identifier for a filter, combining its attribute expression and granularity if available.
+ *
+ * @param {Filter} filter - The filter object to generate the unique identifier for.
+ * @returns {string} - The unique identifier for the filter.
+ * @internal
+ */
+export declare function getFilterCompareId(filter: Filter): string;
+/**
+ * Merges two arrays of filter objects, prioritizing 'targetFilters' over 'sourceFilters',
+ * and removes duplicates based on filter compare id.
+ *
+ * Saves the 'sourceFilters' filters order, while adds new filters to the end of the array.
+ *
+ * @param {Filter[]} [sourceFilters=[]] - The source array of filter objects.
+ * @param {Filter[]} [targetFilters=[]] - The target array of filter objects.
+ * @returns {Filter[]} - The merged array of filter objects.
+ * @internal
+ */
+export declare function mergeFilters(sourceFilters?: Filter[], targetFilters?: Filter[]): Filter[];
+/**
+ * Replaces nodes of filter reations tree with fetched filters by instance id.
+ *
+ * @param filters - The filters.
+ * @param highlights - The highlights
+ * @param filterRelations - Fetched filter relations.
+ * @returns Filter relations with filters in nodes.
+ * @internal
+ */
+export declare function getFilterRelationsFromJaql(filters: Filter[], highlights: Filter[], filterRelations: FilterRelationsJaql | undefined): FilterRelations | Filter[];
+/**
+ * Converts filter relations model to filter relations jaql.
+ *
+ * @param filterRelations - Filter relations model.
+ * @returns Filter relations jaql.
+ * @internal
+ */
+export declare function convertFilterRelationsModelToJaql(filterRelations: FilterRelationsModel | FilterRelationsModelNode | undefined): FilterRelationsJaql | undefined;