@sisense/sdk-ui 1.24.0 → 1.26.0

package/dist/packages/sdk-ui/src/filters/helpers.d.ts

@@ -0,0 +1,122 @@
+import { Filter, FilterRelations } from '@sisense/sdk-data';
+/**
+ * Returns a function that adds a filter to existing filters or filter relations.
+ *
+ * @param filter - The filter to add.
+ * @returns A function that takes existing filters or filter relations and returns updated filters or filter relations with the new filter added.
+ * @group Filter Utilities
+ * @example
+ * ```ts
+ * // Using with an array of filters
+ * const originalFilters = [filterByAgeRange];
+ * const updatedFilters = withAddedFilter(filterByCost)(originalFilters);
+ * // [filterByAgeRange, filterByCost]
+ *
+ * // Using with filter relations
+ * const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
+ * const updatedFilterRelations = withAddedFilter(filterByCost)(originalFilterRelations);
+ * // (filterByAgeRange OR filterByRevenue) AND filterByCost
+ * ```
+ * @internal
+ */
+export declare function withAddedFilter(filter: Filter): (filters: Filter[] | FilterRelations | undefined) => Filter[] | FilterRelations;
+/**
+ * Returns a function that adds multiple filters to existing filters or filter relations.
+ *
+ * @param filtersToAdd - An array of filters to add.
+ * @returns A function that takes existing filters or filter relations and returns updated filters or filter relations with the new filters added.
+ * @group Filter Utilities
+ * @example
+ * ```ts
+ * // Using with an array of filters
+ * const originalFilters = [filterByAgeRange];
+ * const updatedFilters = withAddedFilters([filterByCost, filterByRevenue])(originalFilters);
+ * // [filterByAgeRange, filterByCost, filterByRevenue]
+ *
+ * // Using with filter relations
+ * const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
+ * const updatedFilterRelations = withAddedFilters([filterByCost, filterByRevenue])(originalFilterRelations);
+ * // (filterByAgeRange OR filterByRevenue) AND filterByCost AND filterByRevenue
+ * ```
+ *
+ * @internal
+ */
+export declare function withAddedFilters(filtersToAdd: Filter[]): (filters: Filter[] | FilterRelations | undefined) => Filter[] | FilterRelations;
+/**
+ * Returns a function that removes a filter from existing filters or filter relations.
+ *
+ * @param filterToRemove - The filter to remove.
+ * @returns A function that takes existing filters or filter relations and returns updated filters or filter relations without the specified filter.
+ * @group Filter Utilities
+ * @example
+ * ```ts
+ * // Using with an array of filters
+ * const originalFilters = [filterByAgeRange, filterByRevenue, filterByCost];
+ * const updatedFilters = withoutFilter(filterByCost)(originalFilters);
+ * // [filterByAgeRange, filterByRevenue]
+ *
+ * // Using with filter relations
+ * const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
+ * const updatedFiltersRelations = withoutFilter(filterByRevenue)(originalFilterRelations);
+ * // filterByAgeRange
+ * ```
+ *
+ * @internal
+ */
+export declare function withoutFilter(filterToRemove: Filter): (filters: Filter[] | FilterRelations | undefined) => Filter[] | FilterRelations;
+/**
+ * Returns a function that removes multiple filters from existing filters or filter relations.
+ *
+ * @param filtersToRemove - An array of filters to remove.
+ * @returns A function that takes existing filters or filter relations and returns updated filters or filter relations without the specified filters.
+ * @group Filter Utilities
+ * @example
+ * ```ts
+ * // Using with an array of filters
+ * const originalFilters = [filterByAgeRange, filterByRevenue, filterByCost];
+ * const updatedFilters = withRemovedFilters([filterByRevenue, filterByCost])(originalFilters);
+ * // [filterByAgeRange]
+ *
+ * // Using with filter relations
+ * const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
+ * const updatedFiltersRelations = withRemovedFilters([filterByRevenue])(originalFilterRelations);
+ * // filterByAgeRange
+ * ```
+ *
+ * @internal
+ */
+export declare function withoutFilters(filtersToRemove: Filter[]): (filters: Filter[] | FilterRelations | undefined) => Filter[] | FilterRelations;
+/**
+ * Returns a function that replaces a filter with a new filter in existing filters or filter relations.
+ *
+ * @param filterToReplace - The filter to replace.
+ * @param newFilter - The new filter to use as a replacement.
+ * @returns A function that takes existing filters or filter relations and returns updated filters or filter relations with the filter replaced.
+ * @group Filter Utilities
+ * @example
+ * ```ts
+ * // Using with an array of filters
+ * const originalFilters = [filterByAgeRange, filterByRevenue];
+ * const updatedFilters = withReplacedFilter(filterByRevenue, filterByCost)(originalFilters);
+ * // [filterByAgeRange, filterByCost]
+ *
+ * // Using with filter relations
+ * const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
+ * const updatedFilterRelations = withReplacedFilter(filterByRevenue, filterByCost)(originalFilterRelations);
+ * // (filterByAgeRange OR filterByCost)
+ * ```
+ *
+ * @internal
+ */
+export declare function withReplacedFilter(filterToReplace: Filter, newFilter: Filter): (filters: Filter[] | FilterRelations | undefined) => Filter[] | FilterRelations;
+/**
+ * Finds a filter in an array of filters or filter relations.
+ * Returns the first filter that satisfies the provided search function.
+ * @group Filter Utilities
+ * @param filters - An array of filters or filter relations to search.
+ * @param searchFn - A function that takes a filter and returns a boolean indicating whether the filter satisfies the search criteria.
+ * @returns The first filter that satisfies the search function, or `undefined` if no filter is found.
+ *
+ * @internal
+ */
+export declare function findFilter(filters: Filter[] | FilterRelations | undefined, searchFn: (filter: Filter) => boolean): Filter | undefined;

package/dist/packages/sdk-ui/src/filters/index.d.ts

@@ -4,4 +4,5 @@ export * from './components/criteria-filter-tile';
 export * from './components/cascading-filter-tile';
 export * from './components/filters-panel';
 export * from './components/custom-filter-tile';
+export * from './helpers';
 export { type FilterVariant } from './components/common/filter-utils';

package/dist/packages/sdk-ui/src/models/dashboard/dashboard-model.d.ts

@@ -1,4 +1,4 @@
-import { DataSource, Filter } from '@sisense/sdk-data';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import { DashboardStyleOptions, WidgetModel } from '../../models';
 import { type WidgetsOptions } from './types';
 import { DashboardLayoutOptions } from '../../dashboard';
@@ -42,7 +42,7 @@ export interface DashboardModel {
      *
      * @internal
      */
-    filters: Filter[];
+    filters: Filter[] | FilterRelations;
     /**
      * Dashboard options for each of the widgets.
      *

package/dist/packages/sdk-ui/src/models/dashboard/get-dashboard-model.d.ts

@@ -1,4 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { DashboardModel } from '../../models/dashboard';
 import { CompleteThemeSettings } from '../../types';
 import { AppSettings } from '../../app/settings/settings';
 export interface GetDashboardModelOptions {
@@ -26,4 +27,4 @@ export interface GetDashboardModelOptions {
  * @returns The dashboard model
  * @internal
  */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<import('../../models/dashboard').DashboardModel>;
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<DashboardModel>;

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-dto-utils.d.ts

@@ -2,8 +2,8 @@ import { Filter } from '@sisense/sdk-data';
 import { CascadingFilterDto, FilterDto } from '../../api/types/dashboard-dto';
 /**
  * Translates a {@link Filter} to a {@link FilterDto}.
- * @param filter
  *
+ * @param filter - The filter to translate.
  * @returns FilterDto
  *
  * @internal

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts

@@ -1,7 +1,15 @@
-import { type LayoutDto, type FilterDto, type CascadingFilterDto } from '../../api/types/dashboard-dto';
+import { type LayoutDto, type FilterDto, type CascadingFilterDto, DashboardDto } from '../../api/types/dashboard-dto';
 import type { WidgetsPanelColumnLayout, WidgetsOptions } from './types';
-import { Filter } from '@sisense/sdk-data';
+import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode } from '@sisense/sdk-data';
 import { WidgetDto } from '../../widget-by-id/types';
+import { RestApi } from '../../api/rest-api';
 export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
-export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>): Filter[];
+export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
 export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
+/**
+ * Replace all shared formulas, which defined by id references, in the dashboard with their actual values.
+ * @param dashboard - The dashboard DTO to replace shared formulas in
+ * @param api - The REST API instance
+ * @returns The dashboard DTO with shared formulas, defined by id references, replaced
+ */
+export declare function withSharedFormulas(dashboard: DashboardDto, api: RestApi): Promise<DashboardDto>;

package/dist/packages/sdk-ui/src/models/dashboard/types.d.ts

@@ -26,6 +26,9 @@ export interface WidgetsPanelColumnLayout {
  * Layout of dashboard widgets panel, which is a union of different layout algorithms
  */
 export type WidgetsPanelLayout = WidgetsPanelColumnLayout;
+/**
+ * Widget ID
+ */
 export type WidgetId = string;
 /**
  * Options for widgets in a dashboard

package/dist/packages/sdk-ui/src/models/dashboard/use-dashboard-model/use-dashboard-model-reducer.d.ts

@@ -1,5 +1,5 @@
 import { DashboardModel, WidgetModel } from '../../../models';
-import { Filter } from '@sisense/sdk-data';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
 import { RestApi } from '../../../api/rest-api';
 export type UseDashboardModelState = DashboardModel | null;
 /**
@@ -42,7 +42,7 @@ export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseD
  */
 export type UseDashboardModelFilterUpdateAction = {
     type: UseDashboardModelActionType.FILTERS_UPDATE;
-    payload: Filter[];
+    payload: Filter[] | FilterRelations;
 };
 /**
  * Add widget action for the dashboard model state used in {@link useDashboardModel}.

package/dist/packages/sdk-ui/src/models/dashboard/use-dashboard-model/use-dashboard-model.d.ts

@@ -24,6 +24,7 @@ export declare const useDashboardModel: (args_0: UseDashboardModelParams) => {
     dashboard: import('../../../models').UseDashboardModelState;
     isLoading: boolean;
     isError: boolean;
+    error: Error | undefined;
     dispatchChanges: Dispatch<UseDashboardModelAction>;
 };
 /**
@@ -35,5 +36,6 @@ export declare function useDashboardModelInternal({ dashboardOid, includeWidgets
     dashboard: import('../../../models').UseDashboardModelState;
     isLoading: boolean;
     isError: boolean;
+    error: Error | undefined;
     dispatchChanges: Dispatch<UseDashboardModelAction>;
 };

package/dist/packages/sdk-ui/src/query/date-formats/apply-date-format.d.ts

@@ -61,4 +61,5 @@ export declare const defaultDateConfig: DateConfig;
  * @param cfg -
  */
 export declare function applyDateFormat(date: Date, format: DateFormat, locale?: Locale, cfg?: DateConfig): string;
+export declare function getDefaultDateMask(granularity?: string): "HH:mm:ss" | "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "shortDate" | "fullDate" | "Q yyyy";
 export {};

package/dist/packages/sdk-ui/src/query-execution/utils.d.ts

@@ -0,0 +1,3 @@
+import { PivotQueryDescription, QueryDescription } from '../query/execute-query';
+import { ExecutePivotQueryParams, ExecuteQueryParams } from './types';
+export declare function convertToQueryDescription<T extends ExecuteQueryParams | ExecutePivotQueryParams>(params: T): T extends ExecutePivotQueryParams ? PivotQueryDescription : QueryDescription;

package/dist/packages/sdk-ui/src/utils/extract-widget-ids.d.ts

@@ -0,0 +1,2 @@
+import type { DashboardDto } from '../api/types/dashboard-dto';
+export declare const getWidgetIdsFromDashboard: (dashboard: DashboardDto) => string[];

package/dist/packages/sdk-ui/src/utils/filter-relations.d.ts

@@ -0,0 +1,64 @@
+import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode } from '@sisense/sdk-data';
+/**
+ * Rules of filter relations - logical operators of how filters are related to each other.
+ */
+export type FilterRelationsRules = FilterRelationsRule | FilterRelationsRuleNode | null;
+type FilterRelationsRule = {
+    left: FilterRelationsRuleNode;
+    right: FilterRelationsRuleNode;
+    operator: 'AND' | 'OR';
+};
+type FilterRelationsRuleIdNode = {
+    instanceid: string;
+};
+type FilterRelationsRuleNode = FilterRelationsRule | FilterRelationsRuleIdNode;
+/**
+ * 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.
+ */
+export declare function mergeFiltersOrFilterRelations(sourceFilters: Filter[] | FilterRelations | undefined, targetFilters: Filter[] | FilterRelations | undefined): Filter[] | FilterRelations;
+/**
+ * Splits filters or filter relations into filters and relations rules.
+ */
+export declare function splitFiltersAndRelations(filtersOrFilterRelations: Filter[] | FilterRelations | undefined): {
+    filters: Filter[];
+    relations: FilterRelationsRules;
+};
+/**
+ * Returns pure filters array from the given filters or filter relations.
+ */
+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.
+ */
+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). */
+export declare function isTrivialSingleNodeRelations(relations: FilterRelationsRules): relations is FilterRelationsRuleIdNode;
+/**
+ * Calculates new relations based on the changes in filters.
+ */
+export declare function calculateNewRelations(prevFilters: Filter[], prevRelations: FilterRelationsRules, newFilters: Filter[]): FilterRelationsRules;
+/**
+ * Replaces a filter in the relations tree with a new filter.
+ */
+export declare function getRelationsWithReplacedFilter(relations: FilterRelationsRules, filterToReplace: Filter, newFilter: Filter): FilterRelationsRules;
+/**
+ * Converts filter relations model from Fusion to internal CSDK filter relations rules.
+ */
+export declare function convertFilterRelationsModelToRelationRules(filterRelationsModel: FilterRelationsModel | FilterRelationsModelNode | undefined, filters: Filter[]): FilterRelationsRules;
+/**
+ * Converts internal CSDK filter relations rules to filter relations model for Fusion.
+ */
+export declare function filterRelationRulesToFilterRelationsModel(filterRelationRules: FilterRelationsRules, filters: Filter[]): FilterRelationsModel | FilterRelationsModelNode | undefined;
+/**
+ * Textual representation of filter relations for debugging purposes.
+ * Returns string like "(([Gender] AND [Country]) OR [Condition])".
+ *
+ * @internal
+ */
+export declare function getRelationsAsText(relations: FilterRelationsRules, filters: Filter[]): string | null;
+export {};

package/dist/packages/sdk-ui/src/utils/filters-comparator.d.ts

@@ -9,6 +9,11 @@ import { Filter, FilterRelations, FilterRelationsJaql } from '@sisense/sdk-data'
  * The function ignores randomly generated names of the filters.
  */
 export declare function isFiltersChanged(prevFilters: Filter[] | undefined, newFilters: Filter[] | undefined): boolean;
+export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
+/**
+ * Compare filters with ignoring randomly generated names
+ */
+export declare function areFiltersEqual(filterA: Filter, filterB: Filter): boolean;
 /**
  * Checks if filter relations have changed by deep comparison.
  *

package/dist/packages/sdk-ui/src/utils/filters.d.ts

@@ -8,6 +8,5 @@ export declare const cloneFilterAndToggleDisabled: <TFilter extends Filter>(filt
 export declare const cloneFilter: <TFilter extends Filter>(filter: TFilter) => TFilter;
 export declare function clearMembersFilter(filter: Filter): Filter;
 export declare function isIncludeAllFilter(filter: Filter): boolean;
-export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
 /** @internal */
 export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;