@sisense/sdk-data 1.23.0 → 1.25.0

package/dist/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/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/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/index.js

@@ -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/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';
 };