@sisense/sdk-ui 1.23.0 → 1.25.0

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

@@ -1,7 +1,7 @@
 import { DashboardStyleOptions, WidgetsOptions, WidgetsPanelLayout } from '../models';
 import { WidgetProps } from '../props';
-import { DataSource, Filter } from '@sisense/sdk-data';
 import { DashboardChangeAction } from '../dashboard/dashboard';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 export type { DashboardStyleOptions, WidgetsPanelColumnLayout } from '../models';
 /**
  * Props for the DashboardById component
@@ -19,7 +19,7 @@ export interface DashboardByIdProps {
      * Limitations:
      * - WAT authentication does not support persistence.
      * - As an alpha feature, currently only changes to dashboard filters are persisted.
-     * @internal
+     * @alpha
      */
     persist?: boolean;
 }
@@ -31,9 +31,15 @@ export interface DashboardContainerProps {
     layoutOptions?: DashboardLayoutOptions;
     config?: DashboardConfig;
     widgets: WidgetProps[];
-    filters: Filter[];
-    onFiltersChange: (filters: Filter[]) => void;
+    filters: Filter[] | FilterRelations;
+    onFiltersChange: (filters: Filter[] | FilterRelations) => void;
     defaultDataSource?: DataSource;
+    /**
+     * Callback to receive changes
+     *
+     * @internal
+     */
+    onChange?: (action: DashboardChangeAction) => void;
 }
 /**
  * Dashboard configuration
@@ -42,7 +48,19 @@ export interface DashboardContainerProps {
  */
 export interface DashboardConfig {
     filtersPanel?: {
-        isVisible: boolean;
+        isVisible?: boolean;
+        /**
+         * Boolean flag that controls the initial "collapsed" state of the filters panel.
+         *
+         * If not specified, the default value is `false`.
+         */
+        isCollapsedInitially?: boolean;
+        /**
+         * Setting this to true will use the isCollapsed state from local storage, if available, and store any changes to local storage.
+         * This state is shared across all dashboards.
+         * This state has a higher priority than "initialIsCollapsed" when enabled.
+         */
+        persistCollapsedStateToLocalStorage?: boolean;
     };
     toolbar?: {
         isVisible: boolean;
@@ -77,7 +95,7 @@ export interface DashboardProps {
     /** The widgets to render in the dashboard */
     widgets: WidgetProps[];
     /** The dashboard filters to be applied to each of the widgets based on the widget filter options */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     /** The default data source to use for the dashboard */
     defaultDataSource?: DataSource;
     /** The options for each of the widgets */

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

@@ -1,11 +1,11 @@
 import { DashboardProps } from './types.js';
-import { Filter } from '@sisense/sdk-data';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
 export type ComposableDashboardProps = Pick<DashboardProps, 'filters' | 'widgets' | 'widgetsOptions'>;
 export type UseComposedDashboardOptions = {
     /**
      * @internal
      */
-    onFiltersChange?: (filters: Filter[]) => void;
+    onFiltersChange?: (filters: Filter[] | FilterRelations) => void;
 };
 /**
  * {@link useComposedDashboard} without tracking to be used inside other hooks or components in Compose SDK.
@@ -15,7 +15,7 @@ export type UseComposedDashboardOptions = {
  */
 export declare function useComposedDashboardInternal<D extends ComposableDashboardProps | DashboardProps>(initialDashboard: D, { onFiltersChange }?: UseComposedDashboardOptions): {
     dashboard: D;
-    setFilters: (filters: Filter[]) => void;
+    setFilters: (filters: Filter[] | FilterRelations) => void;
 };
 /**
  * React hook that takes in separate dashboard elements and
@@ -26,5 +26,5 @@ export declare function useComposedDashboardInternal<D extends ComposableDashboa
  */
 export declare const useComposedDashboard: <D extends DashboardProps | ComposableDashboardProps>(args_0: D, args_1?: UseComposedDashboardOptions | undefined) => {
     dashboard: D;
-    setFilters: (filters: Filter[]) => void;
+    setFilters: (filters: Filter[] | FilterRelations) => void;
 };

package/dist/packages/sdk-ui/src/decorators/component-decorators/with-error-boundary.d.ts

@@ -2,4 +2,6 @@ import { ComponentDecorator } from './as-sisense-component';
 /**
  * Adds error boundary to the component
  */
-export declare const withErrorBoundary: ComponentDecorator<void>;
+export declare const withErrorBoundary: ComponentDecorator<{
+    componentName: string;
+}>;

package/dist/packages/sdk-ui/src/error-boundary/error-boundary.d.ts

@@ -1,5 +1,4 @@
 import { Component, ReactNode } from 'react';
-import { SisenseContextPayload } from '../sisense-context/sisense-context';
 import { AbstractTranslatableError } from '@sisense/sdk-common';
 /**
  * @internal
@@ -9,6 +8,8 @@ interface ErrorBoundaryProps {
     error?: AbstractTranslatableError | Error | string;
     children: ReactNode;
     resetKeys?: any[];
+    onError?: (error: Error) => void;
+    isContainerComponent?: boolean;
 }
 type ErrorBoundaryState = {
     error: AbstractTranslatableError | Error | string | null;
@@ -23,7 +24,8 @@ type ErrorBoundaryState = {
  */
 export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
     showErrorBox: boolean;
-    context: SisenseContextPayload;
+    onError?: (error: Error) => void;
+    isContainerComponent: boolean;
     constructor(props: ErrorBoundaryProps);
     static getDerivedStateFromError(error: Error): {
         error: Error;

package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts

@@ -19,6 +19,8 @@ export interface CascadingFilterTileProps {
     arrangement?: FilterVariant;
     /** Callback returning filter object, or null for failure */
     onChange: (filter: Filter) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
 }
 /**
  * UI component representing group of cascading (dependent) filters.

package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -14,6 +14,8 @@ export interface CriteriaFilterTileProps {
     arrangement?: FilterVariant;
     /** Callback returning filter object, or null for failure */
     onUpdate: (filter: Filter | null) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /** List of available measures to rank by. Required only for ranking filters. */
     measures?: Measure[];
     /**

package/dist/packages/sdk-ui/src/filters/components/custom-filter-tile.d.ts

@@ -15,6 +15,8 @@ export interface CustomFilterTileProps {
      * @param filter - Custom filter
      */
     onUpdate: (filter: Filter | null) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /** Design options for the tile @internal */
     tileDesignOptions?: FilterTileDesignOptions;
 }

package/dist/packages/sdk-ui/src/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts

@@ -38,6 +38,8 @@ export interface DateRangeFilterTileProps {
      * @param filter - Date range filter
      */
     onChange: (filter: Filter) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /**
      * List of filters this filter is dependent on.
      */

package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/helpers.d.ts

@@ -0,0 +1,6 @@
+import { RelativeDateFilter as RelativeDateFilterType } from '@sisense/sdk-data';
+import dayjs from 'dayjs';
+/**
+ * @internal
+ */
+export declare function createAnchorDateFromRelativeDateFilter(filter: RelativeDateFilterType): dayjs.Dayjs;

package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts

@@ -18,6 +18,8 @@ export interface RelativeDateFilterTileProps {
      * @param filter - Relative date filter
      */
     onUpdate: (filter: Filter) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /**
      * Limit of the date range that can be selected.
      */

package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/relative-date-filter.d.ts

@@ -19,7 +19,8 @@ export interface RelativeDateFilterProps {
  */
 export declare const RelativeDateFilter: FunctionComponent<RelativeDateFilterProps>;
 export declare const DATE_OPS_MAP: {
-    readonly [x: string]: "dateFilter.last" | "dateFilter.next";
+    readonly last: "dateFilter.last";
+    readonly next: "dateFilter.next";
 };
 export declare const DATE_LEVELS_MAP: {
     readonly [x: string]: "dateFilter.days" | "dateFilter.weeks" | "dateFilter.months" | "dateFilter.quarters" | "dateFilter.years";

package/dist/packages/sdk-ui/src/filters/components/filter-tile.d.ts

@@ -29,6 +29,7 @@ interface Props {
     isDependent?: boolean;
     design?: FilterTileDesignOptions;
     onToggleDisabled?: () => void;
+    onDelete?: () => void;
     locked?: boolean;
 }
 /**

package/dist/packages/sdk-ui/src/filters/components/filters-panel/filters-panel-tile.d.ts

@@ -9,6 +9,8 @@ export type FiltersPanelTileProps = {
     filter: Filter;
     /** Callback to handle filter change */
     onChange: (filter: Filter | null) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /** Default data source used for filter tiles */
     defaultDataSource?: DataSource;
 };
@@ -17,4 +19,4 @@ export type FiltersPanelTileProps = {
  *
  * @internal
  */
-export declare const FiltersPanelTile: ({ filter, onChange, defaultDataSource, }: FiltersPanelTileProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FiltersPanelTile: ({ filter, onChange, onDelete, defaultDataSource, }: FiltersPanelTileProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,14 +1,14 @@
 /// <reference types="react" />
-import { DataSource, Filter } from '@sisense/sdk-data';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 /**
  * Props of the {@link FiltersPanel} component
  *
  */
 export type FiltersPanelProps = {
     /** Array of filters to display */
-    filters: Filter[];
+    filters: Filter[] | FilterRelations;
     /** Callback to handle changes in filters */
-    onFiltersChange: (filters: Filter[]) => void;
+    onFiltersChange: (filters: Filter[] | FilterRelations) => void;
     /** Default data source used for filter tiles */
     defaultDataSource?: DataSource;
 };

package/dist/packages/sdk-ui/src/filters/components/icons/trash-icon.d.ts

@@ -1,2 +1,2 @@
 import type { SVGProps } from 'react';
-export declare const TrashIcon: (props: Pick<SVGProps<SVGElement>, 'className' | 'width' | 'height'>) => import("react/jsx-runtime").JSX.Element;
+export declare const TrashIcon: (props: Pick<SVGProps<SVGElement>, 'className' | 'width' | 'height' | 'fill'>) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/filters/components/member-filter-tile/member-filter-tile.d.ts

@@ -19,6 +19,8 @@ export interface MemberFilterTileProps {
     filter: Filter | null;
     /** Callback indicating when the source member filter object should be updated */
     onChange: (filter: Filter | null) => void;
+    /** Filter delete callback */
+    onDelete?: () => void;
     /** List of filters this filter is dependent on */
     parentFilters?: Filter[];
     /** Design options for the tile @internal */

package/dist/packages/sdk-ui/src/filters/components/member-filter-tile/member-list.d.ts

@@ -7,7 +7,7 @@ export interface MemberListProps {
     checkAllMembers: () => void;
     uncheckAllMembers: () => void;
     excludeMembers: boolean;
-    multiSelection: boolean;
+    enableMultiSelection: boolean;
     disabled: boolean;
 }
 export declare const MemberList: FunctionComponent<MemberListProps>;

package/dist/packages/sdk-ui/src/filters/components/unsupported-filter-tile.d.ts

@@ -3,10 +3,12 @@ import { Filter } from '@sisense/sdk-data';
 export type UnsupportedFilterTileProps = {
     filter: Filter;
     design?: FilterTileDesignOptions;
+    /** Filter delete callback */
+    onDelete?: () => void;
 };
 /**
  * Filter tile component that renders an unsupported filter (which is not recognized by the JAQL to Filter translation)
  *
  * @internal
  */
-export declare const UnsupportedFilterTile: ({ filter, design }: UnsupportedFilterTileProps) => import("react/jsx-runtime").JSX.Element;
+export declare const UnsupportedFilterTile: ({ filter, design, onDelete }: UnsupportedFilterTileProps) => import("react/jsx-runtime").JSX.Element;

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/index.d.ts

@@ -5,7 +5,9 @@ export { ThemeProvider } from './theme-provider';
 export * from './dashboard';
 export { DashboardWidget } from './widget-by-id/dashboard-widget';
 export { WidgetById } from './widget-by-id/widget-by-id';
+export { isChartWidgetProps, isPivotTableWidgetProps, isTextWidgetProps, isPluginWidgetProps, } from './widget-by-id/utils';
 export { type WidgetType, type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, type TextWidgetType, } from './widget-by-id/types';
+export { getChartType } from './widget-by-id/utils';
 export * from './query-execution';
 export { executeQuery } from './query/execute-query';
 export { SisenseContextProvider } from './sisense-context/sisense-context-provider';
@@ -43,7 +45,7 @@ export { usePlugins } from './plugins-provider/plugins-provider';
 export { extractDimensionsAndMeasures, useExecutePluginQuery, } from './plugins-provider/use-execute-plugin-query';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
-export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout as WidgetsPanelColumnLayout, type WidgetsPanelLayout as WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchiesParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout as WidgetsPanelColumnLayout, type WidgetsPanelLayout as WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
 /**
  * Utility functions to translate a Fusion widget model from and to other widget data structures
  *

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,7 @@
 import { type LayoutDto, type FilterDto, type CascadingFilterDto } 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';
 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;

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-dasboard-model-utils.d.ts

@@ -3,20 +3,18 @@ import { DashboardChangeAction } from '../../../dashboard/dashboard';
 import { Authenticator } from '@sisense/sdk-rest-client';
 /**
  * Convert a dashboard change action to a use dashboard model action.
- * @param action - The dashboard change action to convert
  *
+ * @param action - The dashboard change action to convert
  * @returns The useDashboardModel action or null if the action is not supported
- *
  * @internal
  */
 export declare function dashboardChangeActionToUseDashboardModelAction(action: DashboardChangeAction): UseDashboardModelAction | null;
 /**
  * Check if the persistence is supported and log a warning if it is not.
+ *
  * @param authType - The authentication type
  * @param shouldWarn - Whether to log a warning
- *
  * @returns True if the persistence is supported, false otherwise
- *
  * @internal
  */
 export declare function checkPersistenceSupport(authType: Authenticator['type'], shouldWarn: boolean): boolean;

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

@@ -1,5 +1,5 @@
-import { DashboardModel } from '../../../models';
-import { Filter } from '@sisense/sdk-data';
+import { DashboardModel, WidgetModel } from '../../../models';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
 import { RestApi } from '../../../api/rest-api';
 export type UseDashboardModelState = DashboardModel | null;
 /**
@@ -8,7 +8,8 @@ export type UseDashboardModelState = DashboardModel | null;
  * @internal
  */
 export declare enum UseDashboardModelActionTypeInternal {
-    DASHBOARD_INIT = "DASHBOARD.INIT"
+    DASHBOARD_INIT = "DASHBOARD.INIT",
+    DASHBOARD_UPDATE_LAYOUT = "DASHBOARD.UPDATE_LAYOUT"
 }
 /**
  * Action types for the dashboard model state used in {@link useDashboardModel}.
@@ -16,14 +17,15 @@ export declare enum UseDashboardModelActionTypeInternal {
  * @internal
  */
 export declare enum UseDashboardModelActionType {
-    FILTERS_UPDATE = "FILTERS.UPDATE"
+    FILTERS_UPDATE = "FILTERS.UPDATE",
+    ADD_WIDGET = "WIDGETS.ADD"
 }
 /**
  * Internal actions for the dashboard model state used in {@link useDashboardModel}.
  *
  * @internal
  */
-type UseDashboardModelInternalAction = UseDashboardModelAction | {
+export type UseDashboardModelInternalAction = UseDashboardModelAction | {
     type: UseDashboardModelActionTypeInternal.DASHBOARD_INIT;
     payload: DashboardModel;
 };
@@ -32,32 +34,38 @@ type UseDashboardModelInternalAction = UseDashboardModelAction | {
  *
  * @internal
  */
-export type UseDashboardModelAction = {
+export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseDashboardModelAddWidgetAction;
+/**
+ * Filter update actions for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+export type UseDashboardModelFilterUpdateAction = {
     type: UseDashboardModelActionType.FILTERS_UPDATE;
-    payload: Filter[];
+    payload: Filter[] | FilterRelations;
 };
 /**
- * Reducer for the dashboard model state used in {@link useDashboardModel}.
- * @param state
- * @param action
+ * Add widget action for the dashboard model state used in {@link useDashboardModel}.
  *
  * @internal
  */
-export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
+export type UseDashboardModelAddWidgetAction = {
+    type: UseDashboardModelActionType.ADD_WIDGET;
+    payload: WidgetModel;
+};
 /**
- * Middleware connector for {@link persistDashboardModelMiddleware}.
- * @param restApi - The Sisense REST API instance
- * @param reducer - The dashboard model reducer
+ * Reducer for the dashboard model state used in {@link useDashboardModel}.
  *
+ * @param state
+ * @param action
  * @internal
  */
-export declare function withPersistDashboardModelMiddleware(restApi: RestApi, reducer: (state: UseDashboardModelState, action: UseDashboardModelInternalAction) => UseDashboardModelState): (state: UseDashboardModelState, action: UseDashboardModelInternalAction) => UseDashboardModelState;
+export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
 /**
  * Middleware that persists the dashboard model changes to the Sisense server.
+ *
  * @param restApi - The Sisense REST API instance
  * @param reducer - The dashboard model reducer
- *
  * @internal
  */
-export declare function persistDashboardModelMiddleware(state: DashboardModel, action: UseDashboardModelAction, restApi: RestApi): Promise<import("../../..").DashboardDto | undefined> | Promise<null>;
-export {};
+export declare function persistDashboardModelMiddleware(dashbordOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi): Promise<UseDashboardModelInternalAction>;

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

@@ -4,6 +4,7 @@ import { UseDashboardModelAction } from './use-dashboard-model-reducer';
 export interface UseDashboardModelParams extends GetDashboardModelParams {
     /**
      * Boolean flag indicating whether changes to the dashboard state should be saved to the dashboard in Fusion
+     *
      * @default true
      * @internal
      */
@@ -23,6 +24,7 @@ export declare const useDashboardModel: (args_0: UseDashboardModelParams) => {
     dashboard: import('../../../models').UseDashboardModelState;
     isLoading: boolean;
     isError: boolean;
+    error: Error | undefined;
     dispatchChanges: Dispatch<UseDashboardModelAction>;
 };
 /**
@@ -34,5 +36,6 @@ export declare function useDashboardModelInternal({ dashboardOid, includeWidgets
     dashboard: import('../../../models').UseDashboardModelState;
     isLoading: boolean;
     isError: boolean;
+    error: Error | undefined;
     dispatchChanges: Dispatch<UseDashboardModelAction>;
 };