@sisense/sdk-data 1.33.0 → 1.34.0

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

@@ -1,4 +1,4 @@
-import { JaqlDataSource, type ConditionFilterJaql } from './filters/utils/types.js';
+import { type ConditionFilterJaql, JaqlDataSource } from './filters/utils/types.js';
 import { Attribute } from './interfaces.js';
 /**
  * @internal
@@ -141,24 +141,26 @@ export declare const MetadataTypes: {
  * Levels for {@link DateDimension}
  */
 export declare const DateLevels: {
-    Years: string;
-    Quarters: string;
-    Months: string;
-    Weeks: string;
-    Days: string;
-    Hours: string;
-    MinutesRoundTo30: string;
-    MinutesRoundTo15: string;
-    Minutes: string;
-    Seconds: string;
-    AggHours: string;
-    AggMinutesRoundTo30: string;
-    AggMinutesRoundTo15: string;
-    AggMinutesRoundTo1: string;
+    readonly Years: "Years";
+    readonly Quarters: "Quarters";
+    readonly Months: "Months";
+    readonly Weeks: "Weeks";
+    readonly Days: "Days";
+    readonly Hours: "Hours";
+    readonly MinutesRoundTo30: "MinutesRoundTo30";
+    readonly MinutesRoundTo15: "MinutesRoundTo15";
+    readonly Minutes: "Minutes";
+    readonly Seconds: "Seconds";
+    readonly AggHours: "AggHours";
+    readonly AggMinutesRoundTo30: "AggMinutesRoundTo30";
+    readonly AggMinutesRoundTo15: "AggMinutesRoundTo15";
+    readonly AggMinutesRoundTo1: "AggMinutesRoundTo1";
     /** @internal */
     readonly all: string[];
 };
 /** @internal */
+export declare type DateLevel = Exclude<(typeof DateLevels)[keyof typeof DateLevels], typeof DateLevels.all>;
+/** @internal */
 export declare enum DataType {
     TEXT = "text",
     NUMERIC = "numeric",

package/dist/cjs/index.d.ts

@@ -6,18 +6,18 @@ import './translation/initialize-i18n.js';
  * @group Data Model Utilities
  * Utility functions for creating attributes and dimensions in code.
  */
-export * from './interfaces.js';
-export * from './dimensional-model/types.js';
-export * from './dimensional-model/interfaces.js';
+export * from './dimensional-model/attributes.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/index.js';
 export * from './dimensional-model/factory.js';
-export * from './dimensional-model/jaql-element.js';
-export * from './dimensional-model/filters/filters.js';
 export * from './dimensional-model/filters/filter-config-utils.js';
+export * from './dimensional-model/filters/filters.js';
 export { createFilterMatcher } from './dimensional-model/filters/utils/filter-matcher-utils.js';
+export * from './dimensional-model/interfaces.js';
+export * from './dimensional-model/jaql-element.js';
+export * from './dimensional-model/types.js';
+export * from './interfaces.js';
 /**
  * Functions to create date, text, or numeric filters on specified data.
  *
@@ -92,6 +92,6 @@ export * from './dimensional-model/simple-column-types.js';
  * @group Factories
  */
 export * as analyticsFactory from './dimensional-model/analytics/factory.js';
-export * from './utils.js';
 export * from './dimensional-model/filters/index.js';
 export { type TranslationDictionary, PACKAGE_NAMESPACE as translationNamespace, } from './translation/resources/index.js';
+export * from './utils.js';

package/dist/cjs/index.js

@@ -35,19 +35,19 @@ require("./translation/initialize-i18n.js");
  * @group Data Model Utilities
  * Utility functions for creating attributes and dimensions in code.
  */
-__exportStar(require("./interfaces.js"), exports);
-__exportStar(require("./dimensional-model/types.js"), exports);
-__exportStar(require("./dimensional-model/interfaces.js"), exports);
+__exportStar(require("./dimensional-model/attributes.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/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);
 __exportStar(require("./dimensional-model/filters/filter-config-utils.js"), exports);
+__exportStar(require("./dimensional-model/filters/filters.js"), exports);
 var filter_matcher_utils_js_1 = require("./dimensional-model/filters/utils/filter-matcher-utils.js");
 Object.defineProperty(exports, "createFilterMatcher", { enumerable: true, get: function () { return filter_matcher_utils_js_1.createFilterMatcher; } });
+__exportStar(require("./dimensional-model/interfaces.js"), exports);
+__exportStar(require("./dimensional-model/jaql-element.js"), exports);
+__exportStar(require("./dimensional-model/types.js"), exports);
+__exportStar(require("./interfaces.js"), exports);
 /**
  * Functions to create date, text, or numeric filters on specified data.
  *
@@ -122,7 +122,7 @@ __exportStar(require("./dimensional-model/simple-column-types.js"), exports);
  * @group Factories
  */
 exports.analyticsFactory = __importStar(require("./dimensional-model/analytics/factory.js"));
-__exportStar(require("./utils.js"), exports);
 __exportStar(require("./dimensional-model/filters/index.js"), exports);
 var index_js_1 = require("./translation/resources/index.js");
 Object.defineProperty(exports, "translationNamespace", { enumerable: true, get: function () { return index_js_1.PACKAGE_NAMESPACE; } });
+__exportStar(require("./utils.js"), exports);

package/dist/cjs/utils.d.ts

@@ -1,7 +1,7 @@
-import { JaqlDataSource } from './dimensional-model/filters/utils/types.js';
+import { FilterJaqlInternal, JaqlDataSource, RankingFilterJaql } from './dimensional-model/filters/utils/types.js';
 import { Attribute, BaseMeasure, CalculatedMeasure, Filter, FilterRelations, FilterRelationsJaql, LevelAttribute, SortDirection } from './dimensional-model/interfaces.js';
+import { BaseJaql, FilterJaql, FormulaJaql, Jaql, JaqlSortDirection, Sort } from './dimensional-model/types.js';
 import { DataSource, DataSourceInfo } from './interfaces.js';
-import { FilterJaql, FormulaJaql, Jaql, JaqlSortDirection, Sort } from './dimensional-model/types.js';
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -49,6 +49,14 @@ export declare function convertJaqlDataSource(dataSource: DataSource): JaqlDataS
  * @internal
  */
 export declare function convertSort(sort?: string): Sort;
+/**
+ * Converts a SortDirection to a Sort enum
+ *
+ * @param sortDirection - The SortDirection to convert
+ * @returns The converted Sort enum
+ * @internal
+ */
+export declare function convertSortDirectionToSort(sortDirection: SortDirection): Sort;
 /**
  * Creates a filter from a JAQL object.
  *
@@ -86,7 +94,7 @@ export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined
  * @returns attribute or level attribute
  * @internal
  */
-export declare const createAttributeHelper: ({ dim, table, column, dataType, level, format, sort, title, panel, dataSource, }: {
+export declare const createAttributeHelper: ({ dim, table, column, dataType, granularity, format, sort, title, panel, dataSource, }: {
     /** Dimension expression */
     dim: string;
     /** Table name */
@@ -95,8 +103,8 @@ export declare const createAttributeHelper: ({ dim, table, column, dataType, lev
     column: string | undefined;
     /** Data type */
     dataType: string;
-    /** Date level */
-    level: string | undefined;
+    /** Date granularity */
+    granularity: string | undefined;
     /** Format */
     format: string | undefined;
     /** Sort */
@@ -114,7 +122,7 @@ export declare const createAttributeHelper: ({ dim, table, column, dataType, lev
  * @returns measure
  * @internal
  */
-export declare const createMeasureHelper: ({ dim, table, column, dataType, agg, level, format, sort, title, dataSource, }: {
+export declare const createMeasureHelper: ({ dim, table, column, dataType, agg, granularity, format, sort, title, dataSource, }: {
     /** Dimension expression */
     dim: string;
     /** Table name */
@@ -125,8 +133,8 @@ export declare const createMeasureHelper: ({ dim, table, column, dataType, agg,
     dataType: string;
     /** Aggregation function */
     agg: string;
-    /** Date level */
-    level: string | undefined;
+    /** Date granularity */
+    granularity: string | undefined;
     /** Format */
     format: string | undefined;
     /** Sort */
@@ -152,3 +160,11 @@ export declare const createCalculatedMeasureHelper: (jaql: FormulaJaql) => Calcu
  * @internal
  */
 export declare function createDimensionalElementFromJaql(jaql: Jaql, datetimeFormat?: string, panel?: string): Attribute | BaseMeasure | CalculatedMeasure | Filter;
+/**
+ * Returns the granularity from the provided JAQL object.
+ *
+ * @param jaql - The JAQL object.
+ * @returns string.
+ * @internal
+ */
+export declare function getGranularityFromJaql(jaql: BaseJaql | FilterJaql | FilterJaqlInternal | RankingFilterJaql): string | undefined;

package/dist/cjs/utils.js

@@ -3,16 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDimensionalElementFromJaql = exports.createCalculatedMeasureHelper = exports.createMeasureHelper = exports.createAttributeHelper = exports.getSortType = exports.getColumnNameFromAttribute = exports.getTableNameFromAttribute = exports.createFilterFromJaql = exports.convertSort = exports.convertJaqlDataSource = exports.convertDataSource = exports.isDataSourceInfo = exports.getDataSourceName = exports.getFilterListAndRelationsJaql = exports.guidFast = void 0;
+exports.getGranularityFromJaql = exports.createDimensionalElementFromJaql = exports.createCalculatedMeasureHelper = exports.createMeasureHelper = exports.createAttributeHelper = exports.getSortType = exports.getColumnNameFromAttribute = exports.getTableNameFromAttribute = exports.createFilterFromJaql = exports.convertSortDirectionToSort = exports.convertSort = exports.convertJaqlDataSource = exports.convertDataSource = exports.isDataSourceInfo = exports.getDataSourceName = exports.getFilterListAndRelationsJaql = exports.guidFast = void 0;
+const sdk_common_1 = require("@sisense/sdk-common");
 const cloneDeep_js_1 = __importDefault(require("lodash-es/cloneDeep.js"));
 const mapValues_js_1 = __importDefault(require("lodash-es/mapValues.js"));
+const attributes_js_1 = require("./dimensional-model/attributes.js");
+const filters_js_1 = require("./dimensional-model/filters/filters.js");
 const filter_from_jaql_util_js_1 = require("./dimensional-model/filters/utils/filter-from-jaql-util.js");
-const types_js_1 = require("./dimensional-model/types.js");
-const sdk_common_1 = require("@sisense/sdk-common");
 const measures_js_1 = require("./dimensional-model/measures/measures.js");
-const filters_js_1 = require("./dimensional-model/filters/filters.js");
-const attributes_js_1 = require("./dimensional-model/attributes.js");
 const simple_column_types_js_1 = require("./dimensional-model/simple-column-types.js");
+const types_js_1 = require("./dimensional-model/types.js");
 /**
  * A more performant, but slightly bulkier, RFC4122v4 implementation. Performance is improved by minimizing calls to random()
  *
@@ -158,6 +158,24 @@ function convertSort(sort) {
     }
 }
 exports.convertSort = convertSort;
+/**
+ * Converts a SortDirection to a Sort enum
+ *
+ * @param sortDirection - The SortDirection to convert
+ * @returns The converted Sort enum
+ * @internal
+ */
+function convertSortDirectionToSort(sortDirection) {
+    switch (sortDirection) {
+        case 'sortAsc':
+            return types_js_1.Sort.Ascending;
+        case 'sortDesc':
+            return types_js_1.Sort.Descending;
+        default:
+            return types_js_1.Sort.None;
+    }
+}
+exports.convertSortDirectionToSort = convertSortDirectionToSort;
 /**
  * Creates a filter from a JAQL object.
  *
@@ -244,7 +262,7 @@ const DATA_MODEL_MODULE_NAME = 'DM';
  * @returns attribute or level attribute
  * @internal
  */
-const createAttributeHelper = ({ dim, table, column, dataType, level, format, sort, title, panel, dataSource, }) => {
+const createAttributeHelper = ({ dim, table, column, dataType, granularity, format, sort, title, panel, dataSource, }) => {
     // if table is undefined, extract it from dim
     const dimTable = table !== null && table !== void 0 ? table : parseExpression(dim).table;
     // if column is undefined, extract it from dim
@@ -252,9 +270,9 @@ const createAttributeHelper = ({ dim, table, column, dataType, level, format, so
     const sortEnum = convertSort(sort);
     const isDataTypeDatetime = dataType === types_js_1.DataType.DATETIME;
     if (isDataTypeDatetime) {
-        const dateLevel = attributes_js_1.DimensionalLevelAttribute.translateJaqlToGranularity({ level });
-        const composeCode = (0, attributes_js_1.normalizeAttributeName)(dimTable, dimColumn, level, DATA_MODEL_MODULE_NAME);
-        const levelAttribute = new attributes_js_1.DimensionalLevelAttribute(title !== null && title !== void 0 ? title : dimColumn, dim, dateLevel, format || attributes_js_1.DimensionalLevelAttribute.getDefaultFormatForGranularity(dateLevel), undefined, sortEnum, dataSource, composeCode, panel);
+        const composeCode = (0, attributes_js_1.normalizeAttributeName)(dimTable, dimColumn, granularity, DATA_MODEL_MODULE_NAME);
+        const levelAttribute = new attributes_js_1.DimensionalLevelAttribute(title !== null && title !== void 0 ? title : dimColumn, dim, granularity || types_js_1.DateLevels.Years, format ||
+            attributes_js_1.DimensionalLevelAttribute.getDefaultFormatForGranularity(granularity || types_js_1.DateLevels.Years), undefined, sortEnum, dataSource, composeCode, panel);
         return levelAttribute;
     }
     const attributeType = !dataType || (0, simple_column_types_js_1.isNumber)(dataType) ? types_js_1.MetadataTypes.NumericAttribute : types_js_1.MetadataTypes.TextAttribute;
@@ -269,14 +287,14 @@ exports.createAttributeHelper = createAttributeHelper;
  * @returns measure
  * @internal
  */
-const createMeasureHelper = ({ dim, table, column, dataType, agg, level, format, sort, title, dataSource, }) => {
+const createMeasureHelper = ({ dim, table, column, dataType, agg, granularity, format, sort, title, dataSource, }) => {
     const sortEnum = convertSort(sort);
     const attribute = (0, exports.createAttributeHelper)({
         dim,
         table,
         column,
         dataType,
-        level,
+        granularity,
         format,
         sort,
         title,
@@ -345,7 +363,7 @@ function createDimensionalElementFromJaql(jaql, datetimeFormat, panel) {
             column: jaql.column,
             dataType: jaql.datatype,
             agg: jaql.agg || '',
-            level: jaql.level,
+            granularity: getGranularityFromJaql(jaql),
             format: datetimeFormat,
             sort: jaql.sort,
             title: jaql.title,
@@ -357,7 +375,7 @@ function createDimensionalElementFromJaql(jaql, datetimeFormat, panel) {
         table: jaql.table,
         column: jaql.column,
         dataType: jaql.datatype,
-        level: jaql.level,
+        granularity: getGranularityFromJaql(jaql),
         format: datetimeFormat,
         sort: jaql.sort,
         title: jaql.title,
@@ -366,3 +384,16 @@ function createDimensionalElementFromJaql(jaql, datetimeFormat, panel) {
     });
 }
 exports.createDimensionalElementFromJaql = createDimensionalElementFromJaql;
+/**
+ * Returns the granularity from the provided JAQL object.
+ *
+ * @param jaql - The JAQL object.
+ * @returns string.
+ * @internal
+ */
+function getGranularityFromJaql(jaql) {
+    return (jaql === null || jaql === void 0 ? void 0 : jaql.datatype) && (0, simple_column_types_js_1.isDatetime)(jaql.datatype)
+        ? attributes_js_1.DimensionalLevelAttribute.translateJaqlToGranularity(jaql)
+        : undefined;
+}
+exports.getGranularityFromJaql = getGranularityFromJaql;

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

@@ -1,6 +1,6 @@
-import { Attribute, LevelAttribute } from './interfaces.js';
-import { Sort, JaqlDataSource } from './types.js';
 import { DimensionalElement } from './base.js';
+import { Attribute, LevelAttribute } from './interfaces.js';
+import { DateLevel, JaqlDataSource, Sort } from './types.js';
 /**
  * @internal
  */
@@ -79,6 +79,13 @@ export declare class DimensionalLevelAttribute extends DimensionalAttribute impl
      * @returns An instance representing the formatted {@link LevelAttribute} of this instance
      */
     format(format: string): LevelAttribute;
+    /**
+     * Gets a {@link LevelAttribute} with the given granularity
+     *
+     * @param granularity - Date granularity
+     * @returns New instance representing {@link LevelAttribute} with provided granularity
+     */
+    setGranularity(granularity: DateLevel): LevelAttribute;
     /**
      * Gets a serializable representation of the element
      */
@@ -138,4 +145,4 @@ export declare function createLevel(json: any): LevelAttribute;
  * @return full normalized attribute name (e.g., DM.CommerceSales.OrderDate.Years)
  * @internal
  */
-export declare function normalizeAttributeName(tableName: string, columnName: string, dateLevel?: string, modelName?: string): string;
+export declare function normalizeAttributeName(tableName: string, columnName: string, granularity?: string, modelName?: string): string;

package/dist/dimensional-model/attributes.js

@@ -1,6 +1,12 @@
-import { Sort, MetadataTypes, DateLevels } from './types.js';
+/* 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-argument */
+/* eslint-disable sonarjs/no-nested-switch */
 import { DimensionalElement, normalizeName } from './base.js';
 import { simpleColumnType } from './simple-column-types.js';
+import { DateLevels, MetadataTypes, Sort } from './types.js';
 /**
  * @internal
  */
@@ -134,6 +140,15 @@ export class DimensionalLevelAttribute extends DimensionalAttribute {
     format(format) {
         return new DimensionalLevelAttribute(this.name, this.expression, this.granularity, format, this.description, this._sort, this.dataSource, this.composeCode);
     }
+    /**
+     * Gets a {@link LevelAttribute} with the given granularity
+     *
+     * @param granularity - Date granularity
+     * @returns New instance representing {@link LevelAttribute} with provided granularity
+     */
+    setGranularity(granularity) {
+        return new DimensionalLevelAttribute(this.name, this.expression, granularity, this._format, this.description, this._sort, this.dataSource, this.composeCode);
+    }
     /**
      * Gets a serializable representation of the element
      */
@@ -355,12 +370,10 @@ export function createLevel(json) {
  * @return full normalized attribute name (e.g., DM.CommerceSales.OrderDate.Years)
  * @internal
  */
-export function normalizeAttributeName(tableName, columnName, dateLevel, modelName) {
+export function normalizeAttributeName(tableName, columnName, granularity, modelName) {
     return ((modelName && modelName.length > 0 ? modelName + '.' : '') +
         normalizeName(tableName) +
         '.' +
         normalizeName(columnName) +
-        (dateLevel && dateLevel.length > 0
-            ? '.' + DimensionalLevelAttribute.translateJaqlToGranularity({ level: dateLevel })
-            : ''));
+        (granularity && granularity.length > 0 ? '.' + granularity : ''));
 }

package/dist/dimensional-model/data-model.d.ts

@@ -1,5 +1,5 @@
-import { DataModel, Element } from './interfaces.js';
 import { DataSource, DataSourceInfo } from '../interfaces.js';
+import { DataModel, Element } from './interfaces.js';
 /**
  * @internal
  */

package/dist/dimensional-model/data-model.js

@@ -1,5 +1,5 @@
-import { create } from './factory.js';
 import { TranslatableError } from '../translation/translatable-error.js';
+import { create } from './factory.js';
 /**
  * @internal
  */

package/dist/dimensional-model/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, DateDimension, Dimension, LevelAttribute } from '../interfaces.js';
+import { JaqlDataSource, Sort } from '../types.js';
 /**
  * Represents a Dimension in a Dimensional Model
  *

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

@@ -1,6 +1,14 @@
-import { Sort, DateLevels, MetadataTypes } from '../types.js';
+/* 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 */
+/* eslint-disable sonarjs/no-duplicate-string */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 import { DimensionalAttribute, DimensionalLevelAttribute, jaqlSimpleColumnType, } from '../attributes.js';
 import { DimensionalElement, normalizeName } from '../base.js';
+import { DateLevels, MetadataTypes, Sort } from '../types.js';
 /**
  * Represents a Dimension in a Dimensional Model
  *

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

@@ -3,6 +3,7 @@ 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.

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

@@ -1,8 +1,9 @@
-import { createAttribute } from '../attributes.js';
-import { createDimension, createDateDimension } from './dimensions.js';
 import { isDataSourceInfo } from '../../utils.js';
+import { createAttribute } from '../attributes.js';
+import { createDateDimension, createDimension } from './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.

package/dist/dimensional-model/factory.js

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import { MetadataTypes } from './types.js';
-import { createMeasure } from './measures/measures.js';
-import { createFilter } from './filters/filters.js';
-import { createDimension } from './dimensions/index.js';
-import { createAttribute } from './attributes.js';
 import { TranslatableError } from '../translation/translatable-error.js';
+import { createAttribute } from './attributes.js';
+import { createDimension } from './dimensions/index.js';
+import { createFilter } from './filters/filters.js';
+import { createMeasure } from './measures/measures.js';
+import { MetadataTypes } from './types.js';
 /**
  * Generate an array of dimension model instances out of the given JSON array
  *

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

@@ -1,4 +1,4 @@
-import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationsNode, FilterRelations, MembersFilterConfig, BaseFilterConfig } from '../interfaces.js';
+import { Attribute, BaseFilterConfig, BaseMeasure, DateDimension, Filter, FilterRelations, FilterRelationsNode, LevelAttribute, Measure, MembersFilterConfig } from '../interfaces.js';
 /**
  * Creates a filter representing the union of multiple filters on the same attribute. The resulting
  * union filter filters on items that match any of the given filters.

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

@@ -1,4 +1,4 @@
-import { TextOperators, NumericOperators, DateOperators, LogicalOperators, RankingOperators, LogicalAttributeFilter, MembersFilter, ExcludeFilter, NumericFilter, MeasureFilter, RankingFilter, TextFilter, DateRangeFilter, RelativeDateFilter, CustomFilter, CascadingFilter, } from './filters.js';
+import { CascadingFilter, CustomFilter, DateOperators, DateRangeFilter, ExcludeFilter, LogicalAttributeFilter, LogicalOperators, MeasureFilter, MembersFilter, NumericFilter, NumericOperators, RankingFilter, RankingOperators, RelativeDateFilter, TextFilter, TextOperators, } from './filters.js';
 // LOGICAL FILTERS
 /**
  * Creates a filter representing the union of multiple filters on the same attribute. The resulting

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

@@ -11,7 +11,6 @@ export declare function isFilterRelations(filters: Filter[] | FilterRelations |
  * Rules of filter relations - logical operators of how filters are related to each other.
  *
  * @internal
- *
  */
 export declare type FilterRelationsRules = FilterRelationsRule | FilterRelationsRuleNode | null;
 /** @internal */
@@ -49,6 +48,7 @@ export declare type FilterAction = {
 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): {
@@ -57,31 +57,38 @@ export declare function splitFiltersAndRelations(filtersOrFilterRelations: Filte
 };
 /**
  * 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).
+/**
+ * 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;
@@ -95,6 +102,7 @@ export declare function isRelationsRuleIdNode(node: FilterRelationsRuleNode): no
 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;
@@ -104,6 +112,7 @@ export declare function filterRelationRulesToFilterRelationsModel(filterRelation
 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 {

package/dist/dimensional-model/filters/filter-relations.js

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/default-param-last */
-import { DimensionalLevelAttribute, isCascadingFilter, } from '../../index.js';
 import cloneDeep from 'lodash-es/cloneDeep.js';
 import isArray from 'lodash-es/isArray.js';
+import { DimensionalLevelAttribute, isCascadingFilter, } from '../../index.js';
 import { TranslatableError } from '../../translation/translatable-error.js';
 /**
  * Type guard for checking if the provided filters are FilterRelations.
@@ -37,6 +37,7 @@ export function mergeFiltersOrFilterRelations(sourceFilters = [], targetFilters
 }
 /**
  * Splits filters or filter relations into filters and relations rules.
+ *
  * @internal
  */
 export function splitFiltersAndRelations(filtersOrFilterRelations) {
@@ -67,6 +68,7 @@ export function splitFiltersAndRelations(filtersOrFilterRelations) {
 }
 /**
  * Returns pure filters array from the given filters or filter relations.
+ *
  * @internal
  */
 export function getFiltersArray(filtersOrFilterRelations) {
@@ -78,6 +80,7 @@ export function getFiltersArray(filtersOrFilterRelations) {
 /**
  * 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 function combineFiltersAndRelations(filters, relations) {
@@ -100,7 +103,9 @@ export function combineFiltersAndRelations(filters, relations) {
         throw new UnknownRelationsNodeError();
     }
 }
-/** Type guard for checking if a node is a single relations node (trivial case when relations are needless).
+/**
+ * Type guard for checking if a node is a single relations node (trivial case when relations are needless).
+ *
  * @internal
  */
 export function isTrivialSingleNodeRelations(relations) {
@@ -108,6 +113,7 @@ export function isTrivialSingleNodeRelations(relations) {
 }
 /**
  * Calculates new relations based on the changes in filters.
+ *
  * @internal
  */
 export function calculateNewRelations(prevFilters, prevRelations, newFilters) {
@@ -136,6 +142,7 @@ function areFiltersEqualForRelations(filter1, filter2) {
 }
 /**
  * Replaces a filter in the relations tree with a new filter.
+ *
  * @internal
  */
 export function getRelationsWithReplacedFilter(relations, filterToReplace, newFilter) {
@@ -234,6 +241,7 @@ function removeFilterFromRelations(filter, relations) {
 }
 /**
  * Converts filter relations model from Fusion to internal CSDK filter relations rules.
+ *
  * @internal
  */
 export function convertFilterRelationsModelToRelationRules(filterRelationsModel, filters) {
@@ -302,6 +310,7 @@ function isFilterNode(node) {
 }
 /**
  * Converts internal CSDK filter relations rules to filter relations model for Fusion.
+ *
  * @internal
  */
 export function filterRelationRulesToFilterRelationsModel(filterRelationRules, filters) {
@@ -354,6 +363,7 @@ export function findFilterByGuid(filters, guid) {
 }
 /**
  * Error thrown when an unknown node type is encountered in filter relations.
+ *
  * @internal
  */
 export class UnknownRelationsNodeError extends Error {

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

@@ -1,5 +1,5 @@
-import { LevelAttribute, Attribute, Measure, Filter, MembersFilterConfig, CompleteMembersFilterConfig, CompleteBaseFilterConfig, BaseFilterConfig } from '../interfaces.js';
 import { DimensionalElement } from '../base.js';
+import { Attribute, BaseFilterConfig, CompleteBaseFilterConfig, CompleteMembersFilterConfig, Filter, LevelAttribute, Measure, MembersFilterConfig } from '../interfaces.js';
 import { AnyObject } from '../types.js';
 /**
  * Different text operators that can be used with text filters