@sisense/sdk-data 1.23.0 → 1.25.0

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

@@ -1,5 +1,5 @@
 import { DataSource } from '../interfaces.js';
-import { JaqlDataSource, Sort } from './types.js';
+import { FilterJaql, JaqlDataSource, Sort } from './types.js';
 /**
  * @internal
  */
@@ -339,15 +339,106 @@ export interface LevelAttribute extends Attribute {
     };
 }
 /**
- * Base interface for filter. See {@link filterFactory} for how to create filters.
+ * Base filter configuration
  */
-export interface Filter extends Element {
+export interface BaseFilterConfig {
+    /**
+     * Optional filter identifier
+     *
+     * If not provided, a unique identifier will be generated.
+     *
+     * @category Base Configurations
+     */
+    readonly guid?: string;
+    /**
+     * Original filter JAQL
+     *
+     * @category Base Configurations
+     * @internal
+     */
+    originalFilterJaql?: FilterJaql;
+    /**
+     * Boolean flag whether the filter is disabled
+     *
+     * If not specified, the default value is `false`.
+     *
+     * @category Base Configurations
+     */
+    disabled?: boolean;
+    /**
+     * Boolean flag whether the filter is locked
+     *
+     * If not specified, the default value is `false`.
+     *
+     * @category Base Configurations
+     */
+    locked?: boolean;
+}
+/**
+ * Complete configuration for base filter
+ *
+ * All properties are required except for originalFilterJaql
+ *
+ * @internal
+ */
+export declare type CompleteBaseFilterConfig = Required<Omit<BaseFilterConfig, 'originalFilterJaql'>> & {
+    originalFilterJaql?: FilterJaql;
+};
+/**
+ * Configurations for members filter
+ */
+export interface MembersFilterConfig extends BaseFilterConfig {
+    /**
+     * Boolean flag whether selected members are excluded or included in the filter
+     *
+     * If not specified, the default value is false.
+     *
+     * @category Extended Configurations
+     */
+    excludeMembers?: boolean;
+    /**
+     * Boolean flag whether selection of multiple members is enabled
+     *
+     * If not specified, the default value is `true`.
+     *
+     * @category Extended Configurations
+     */
+    enableMultiSelection?: boolean;
     /**
-     * Global filter identifier
+     * Optional list of members to be shown as deactivated in the `MemberFilterTile` component.
+     *
+     * This list should not contain members that are already included in the filter.
+     *
+     * @category Extended Configurations
      */
-    readonly guid: string;
+    deactivatedMembers?: string[];
+    /**
+     * Optional filter to be applied in the background
+     */
+    backgroundFilter?: Filter;
+}
+/**
+ * Complete configuration for members filter
+ *
+ * All properties are required except for originalFilterJaql and backgroundFilter
+ *
+ * @internal
+ */
+export declare type CompleteMembersFilterConfig = Required<Omit<MembersFilterConfig, 'originalFilterJaql' | 'backgroundFilter'>> & {
+    originalFilterJaql?: FilterJaql;
+    backgroundFilter?: Filter;
+};
+/**
+ * @internal
+ */
+export declare type FilterConfig = CompleteBaseFilterConfig | CompleteMembersFilterConfig;
+/**
+ * Base interface for filter. See {@link filterFactory} for how to create filters.
+ */
+export interface Filter extends Element {
     /**
      * Attribute this filter instance is filtering
+     * @internal
      */
     readonly attribute: Attribute;
     /**
@@ -356,20 +447,15 @@ export interface Filter extends Element {
     readonly filterType: string;
     /**
      * Boolean flag whether the filter is a scope filter
-     */
-    isScope: boolean;
-    /**
-     * Boolean flag whether the filter is disabled
-     *
      * @internal
      */
-    disabled: boolean;
+    isScope: boolean;
     /**
-     * Boolean flag whether the filter is locked
+     * Filter config
      *
      * @internal
      */
-    locked: boolean;
+    config: FilterConfig;
     /**
      * Gets JAQL representing this Filter instance
      *
@@ -436,7 +522,7 @@ export declare type FilterRelationsNode = Filter | Filter[] | FilterRelations;
  *
  * @internal
  */
-export declare type FilterRelationsModelNode = FilterRelationsModelIdNode | FilterRelationsModelBracketNode | FilterRelationsModel;
+export declare type FilterRelationsModelNode = FilterRelationsModelIdNode | FilterRelationsModelCascadeNode | FilterRelationsModelBracketNode | FilterRelationsModel;
 /**
  * A node or a subtree of a {@link FilterRelationsJaql} tree
  *
@@ -456,11 +542,12 @@ export interface FilterRelations {
     operator: 'AND' | 'OR';
 }
 /**
- * Incoming filter logical relations (AND/OR) when fetched from the instance
+ * Model of filter logical relations (AND/OR) from Fusion dashboard
  *
  * @internal
  */
 export interface FilterRelationsModel {
+    type: 'LogicalExpression';
     left: FilterRelationsModelNode;
     right: FilterRelationsModelNode;
     operator: 'AND' | 'OR';
@@ -489,6 +576,7 @@ export declare type FilterRelationsJaqlIdNode = {
  * @internal
  */
 export declare type FilterRelationsModelIdNode = {
+    type: 'Identifier';
     instanceId: string;
 };
 /**
@@ -497,8 +585,18 @@ export declare type FilterRelationsModelIdNode = {
  * @internal
  */
 export declare type FilterRelationsModelBracketNode = {
+    type: 'ParenthesizedLogicalExpression';
     value: FilterRelationsModelNode;
 };
+/**
+ * A node of a {@link FilterRelationsModel} tree that represents a cascading filter
+ *
+ * @internal
+ */
+export declare type FilterRelationsModelCascadeNode = {
+    type: 'CascadingIdentifier';
+    levels: FilterRelationsModelIdNode[];
+};
 /** Sorting direction, either in Ascending order, Descending order, or None */
 export declare type SortDirection = 'sortAsc' | 'sortDesc' | 'sortNone';
 /**

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

@@ -211,40 +211,40 @@ export declare type FormulaJaql = {
     context?: Record<FormulaID, FormulaContext>;
 };
 /** @internal */
-export declare type BaseFilter = IncludeAllFilter | IncludeMembersFilter | ExcludeMembersFilter | JaqlNumericFilter | ConditionFilterJaql | AndFilter<JaqlNumericFilter | ConditionFilterJaql> | OrFilter<JaqlNumericFilter | ConditionFilterJaql>;
+export declare type BaseFilterJaql = IncludeAllFilterJaql | IncludeMembersFilterJaql | ExcludeMembersFilterJaql | NumericFilterJaql | ConditionFilterJaql | AndFilterJaql<NumericFilterJaql | ConditionFilterJaql> | OrFilterJaql<NumericFilterJaql | ConditionFilterJaql>;
 /** @internal */
-export declare type BackgroundFilter = BaseFilter & {
+export declare type BackgroundFilterJaql = BaseFilterJaql & {
     level?: 'string';
 };
 /** @internal */
-export declare type IncludeAllFilter = {
+export declare type IncludeAllFilterJaql = {
     all: true;
 };
 /** @internal */
-export declare type IncludeMembersFilter = {
+export declare type IncludeMembersFilterJaql = {
     members: string[];
     multiSelection?: boolean;
 };
 /** @internal */
-export declare type ExcludeMembersFilter = {
+export declare type ExcludeMembersFilterJaql = {
     exclude: {
         members: string[];
     };
     multiSelection?: boolean;
 };
 /** @internal */
-export declare type TurnOffMembersFilter = ExcludeMembersFilter & {
+export declare type TurnOffMembersFilterJaql = ExcludeMembersFilterJaql & {
     turnedOff: boolean;
 };
 /** @internal */
 export declare type FilterJaql = BaseJaql & {
-    filter: BaseFilter & {
-        filter?: BackgroundFilter | TurnOffMembersFilter;
+    filter: BaseFilterJaql & {
+        filter?: BackgroundFilterJaql | TurnOffMembersFilterJaql;
     };
 };
 declare type NumericFilterValue = number | FormulaJaql;
 /** @internal */
-export declare type JaqlNumericFilter = {
+export declare type NumericFilterJaql = {
     equals?: NumericFilterValue;
     doesntEqual?: NumericFilterValue;
     toNotEqual?: NumericFilterValue;
@@ -257,11 +257,11 @@ export declare type JaqlNumericFilter = {
     '>='?: NumericFilterValue;
     '<='?: NumericFilterValue;
 };
-declare type AndFilter<FilterItem> = {
+declare type AndFilterJaql<FilterItem> = {
     and: FilterItem[];
 };
 /** @internal */
-export declare type OrFilter<FilterItem> = {
+export declare type OrFilterJaql<FilterItem> = {
     or: FilterItem[];
 };
 /**
@@ -325,6 +325,7 @@ export declare type MetadataItem = {
     jaql: MetadataItemJaql;
     panel?: string;
     isScope?: boolean;
+    members?: string[];
     format?: {
         mask?: Partial<DatetimeMask> | Partial<NumericMask>;
         number?: string;
@@ -353,6 +354,12 @@ export declare type MetadataItem = {
     from?: string;
     to?: string;
 };
+/**
+ * @internal
+ */
+export declare type VagueMetadataItem = Omit<MetadataItem, 'json'> & {
+    json?: MetadataItem;
+};
 /**
  * @internal
  */

package/dist/cjs/index.d.ts

@@ -16,6 +16,7 @@ export * from './dimensional-model/dimensions.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 { createFilterMatcher } from './dimensional-model/filters/utils/filter-matcher-utils.js';
 /**
  * Functions to create date, text, or numeric filters on specified data.
@@ -85,6 +86,7 @@ export * from './dimensional-model/measures/measures.js';
  */
 export * as measureFactory from './dimensional-model/measures/factory.js';
 export * from './dimensional-model/simple-column-types.js';
+export * from './dimensional-model/filter-relations.js';
 /**
  * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
  *

package/dist/cjs/index.js

@@ -45,6 +45,7 @@ __exportStar(require("./dimensional-model/dimensions.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);
 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; } });
 /**
@@ -115,6 +116,7 @@ __exportStar(require("./dimensional-model/measures/measures.js"), exports);
  */
 exports.measureFactory = __importStar(require("./dimensional-model/measures/factory.js"));
 __exportStar(require("./dimensional-model/simple-column-types.js"), exports);
+__exportStar(require("./dimensional-model/filter-relations.js"), exports);
 /**
  * Functions to create elements for advanced analytics – for example, attributes and measures for constructing a custom Boxplot chart
  *

package/dist/cjs/interfaces.d.ts

@@ -132,6 +132,14 @@ export interface CalculatedMeasureColumn {
  * Info of data source
  */
 export declare type DataSourceInfo = {
+    /**
+     * @internal
+     **/
+    id?: string;
+    /**
+     * @internal
+     **/
+    address?: string;
     title: string;
     type: 'live' | 'elasticube';
 };

package/dist/cjs/utils.d.ts

@@ -13,7 +13,7 @@ export declare const guidFast: (len?: number) => string;
  *
  * @internal
  */
-export declare const getFilterListAndRelations: (filterRelations: FilterRelations | Filter[] | undefined) => {
+export declare const getFilterListAndRelationsJaql: (filterRelations: FilterRelations | Filter[] | undefined) => {
     filters: Filter[] | undefined;
     relations: FilterRelationsJaql | undefined;
 };
@@ -53,11 +53,13 @@ export declare function convertSort(sort?: string): Sort;
  * Creates a filter from a JAQL object.
  *
  * @param jaql - The filter JAQL object.
- * @param instanceid - The instance ID.
+ * @param instanceid - Optional instance ID.
+ * @param disabled - Optional disabled flag.
+ * @param locked - Optional locked flag.
  * @returns - The created Filter object.
  * @internal
  */
-export declare const createFilterFromJaql: (jaql: FilterJaql, instanceid?: string) => Filter;
+export declare const createFilterFromJaql: (jaql: FilterJaql, instanceid?: string, disabled?: boolean, locked?: boolean) => Filter;
 /**
  * Retrieves the table value from the attribute.
  *

package/dist/cjs/utils.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSortType = exports.getColumnNameFromAttribute = exports.getTableNameFromAttribute = exports.createFilterFromJaql = exports.convertSort = exports.convertJaqlDataSource = exports.convertDataSource = exports.isDataSourceInfo = exports.getDataSourceName = exports.getFilterListAndRelations = exports.guidFast = void 0;
+exports.getSortType = exports.getColumnNameFromAttribute = exports.getTableNameFromAttribute = exports.createFilterFromJaql = exports.convertSort = exports.convertJaqlDataSource = exports.convertDataSource = exports.isDataSourceInfo = exports.getDataSourceName = exports.getFilterListAndRelationsJaql = exports.guidFast = void 0;
 const cloneDeep_js_1 = __importDefault(require("lodash-es/cloneDeep.js"));
+const index_js_1 = require("./index.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");
 /**
@@ -40,7 +41,7 @@ exports.guidFast = guidFast;
  *
  * @internal
  */
-const getFilterListAndRelations = (filterRelations) => {
+const getFilterListAndRelationsJaql = (filterRelations) => {
     if (!filterRelations) {
         return { filters: undefined, relations: undefined };
     }
@@ -48,12 +49,25 @@ const getFilterListAndRelations = (filterRelations) => {
         return { filters: filterRelations, relations: undefined };
     }
     const filters = new Set();
+    function traverseCascade(cascade) {
+        const [firstFilter, ...restFilters] = cascade;
+        filters.add(firstFilter);
+        if (!restFilters.length) {
+            return traverse({ instanceid: firstFilter.config.guid });
+        }
+        const left = traverse(firstFilter);
+        const right = traverseCascade(restFilters);
+        return { left, right, operator: 'AND' };
+    }
     function traverse(node) {
         if (!node)
             return node;
-        if ('guid' in node) {
+        if (isFilter(node)) {
+            if ((0, index_js_1.isCascadingFilter)(node)) {
+                return traverseCascade(node.filters);
+            }
             filters.add(node);
-            return { instanceid: node.guid };
+            return { instanceid: node.config.guid };
         }
         else {
             if ('left' in node) {
@@ -70,7 +84,10 @@ const getFilterListAndRelations = (filterRelations) => {
     const relations = traverse(copiedFilterRelations);
     return { filters: Array.from(filters), relations };
 };
-exports.getFilterListAndRelations = getFilterListAndRelations;
+exports.getFilterListAndRelationsJaql = getFilterListAndRelationsJaql;
+function isFilter(node) {
+    return 'config' in node && 'guid' in node.config;
+}
 /**
  * Gets the name of the data source
  *
@@ -96,6 +113,8 @@ exports.isDataSourceInfo = isDataSourceInfo;
  */
 function convertDataSource(jaqlDataSource) {
     return {
+        id: jaqlDataSource.id,
+        address: jaqlDataSource.address,
         title: jaqlDataSource.title,
         type: jaqlDataSource.live ? 'live' : 'elasticube',
     };
@@ -138,18 +157,25 @@ exports.convertSort = convertSort;
  * Creates a filter from a JAQL object.
  *
  * @param jaql - The filter JAQL object.
- * @param instanceid - The instance ID.
+ * @param instanceid - Optional instance ID.
+ * @param disabled - Optional disabled flag.
+ * @param locked - Optional locked flag.
  * @returns - The created Filter object.
  * @internal
  */
-const createFilterFromJaql = (jaql, instanceid) => {
+const createFilterFromJaql = (jaql, instanceid, disabled = false, locked = false) => {
     // translation logic is based on FilterJaqlInternal type (from internal modern-analytics-filters)
     // TODO reconcile FilterJaql and FilterJaqlInternal
     const hasBackgroundFilter = jaql.filter.filter && !('turnedOff' in jaql.filter.filter);
-    const filter = (0, filter_from_jaql_util_js_1.createFilterFromJaqlInternal)(jaql, instanceid);
+    const guid = instanceid || (0, exports.guidFast)();
+    const filter = (0, filter_from_jaql_util_js_1.createFilterFromJaqlInternal)(jaql, guid);
     if (hasBackgroundFilter) {
-        filter.backgroundFilter = (0, filter_from_jaql_util_js_1.createFilterFromJaqlInternal)(Object.assign(Object.assign({}, jaql), { filter: jaql.filter.filter }), `${instanceid}-bg`);
+        const backgroundFilter = (0, filter_from_jaql_util_js_1.createFilterFromJaqlInternal)(Object.assign(Object.assign({}, jaql), { filter: jaql.filter.filter }), `${instanceid}-bg`);
+        const config = filter.config;
+        filter.config = Object.assign(Object.assign({}, config), { backgroundFilter });
+        return filter;
     }
+    filter.config = Object.assign(Object.assign({}, filter.config), { originalFilterJaql: jaql, disabled, locked });
     return filter;
 };
 exports.createFilterFromJaql = createFilterFromJaql;

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

@@ -0,0 +1,9 @@
+import { Filter, FilterRelations } from './interfaces.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;

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

@@ -0,0 +1,14 @@
+/**
+ * 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 function isFilterRelations(filters) {
+    return (!!filters &&
+        'operator' in filters &&
+        (filters.operator === 'AND' || filters.operator === 'OR') &&
+        !!filters.right &&
+        !!filters.left);
+}