@sisense/sdk-ui 1.23.0 → 1.25.0

package/dist/packages/sdk-ui/src/ai/chart/chart-insights.d.ts

@@ -1,5 +1,6 @@
 import { GetNlgQueryResultRequest } from '../../ai';
 export interface ChartInsightsProps {
+    summary: string;
     nlgRequest: GetNlgQueryResultRequest;
 }
-export declare const ChartInsights: ({ nlgRequest }: ChartInsightsProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ChartInsights: ({ summary, nlgRequest }: ChartInsightsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/ai/chart/nlq-chart-widget.d.ts

@@ -1,4 +1,4 @@
-import { Filter } from '@sisense/sdk-data';
+import { Filter, Data } from '@sisense/sdk-data';
 import type { NlqResponseData } from '../../ai';
 /**
  * Props for {@link NlqChartWidget} component.
@@ -15,6 +15,11 @@ export interface NlqChartWidgetProps {
      * The dashboard filters to be applied to the chart
      */
     filters?: Filter[];
+    /**
+     * A callback that allows to modify data immediately after it has been retrieved.
+     * Can be used to inject modification of queried data.
+     */
+    onDataReady?: (data: Data) => Data;
 }
 /**
  * React component that renders a chart widget based on NLQ response data.
@@ -38,4 +43,4 @@ export interface NlqChartWidgetProps {
  * @group Generative AI
  * @internal
  */
-export declare const NlqChartWidget: ({ nlqResponse, filters }: NlqChartWidgetProps) => import("react/jsx-runtime").JSX.Element;
+export declare const NlqChartWidget: ({ nlqResponse, onDataReady, filters }: NlqChartWidgetProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/ai/chat-config.d.ts

@@ -8,9 +8,11 @@ export interface ChatConfig {
      */
     enableFollowupQuestions: boolean;
     /**
-     * Number of recommended queries that should be shown in a chat session
+     * Number of recommended queries that should initially be shown in a chat session
      *
-     * If not specified, the default value is `4`
+     * If not specified, the default value is `4`.
+     *
+     * Set to `0` to disable initial recommendations.
      */
     numOfRecommendations: number;
     /**

package/dist/packages/sdk-ui/src/ai/icons/exclamation-mark-brand-icon.d.ts

@@ -0,0 +1,3 @@
+export default function ExclamationMarkBrandIcon({ fill, }: {
+    fill?: string | '#fa5656' | '#1de4eb';
+}): import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/analytics-composer/common/stringify-props.d.ts

@@ -0,0 +1,5 @@
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import { ChartDataOptions } from '../../types';
+export declare function stringifyDataOptions(dataOptions: ChartDataOptions): string;
+export declare function stringifyDataSource(dataSource: DataSource | undefined): string;
+export declare function stringifyExtraImports(filters: Filter[] | FilterRelations): string;

package/dist/packages/sdk-ui/src/analytics-composer/common/utils.d.ts

@@ -1,4 +1,5 @@
 import { ExpandedQueryModel, SimpleQueryModel } from '../types.js';
+import { DynamicChartType } from '../../chart-options-processor/translations/types.js';
 export declare function toKebabCase(str: string): string;
 export declare function capitalizeFirstLetter(str: string): string;
 /**
@@ -11,3 +12,4 @@ export declare function sanitizeDimensionId(str: string): string;
 export declare function validateQueryModel(model: any): SimpleQueryModel;
 export declare function isEmptyQueryModel(queryModel: ExpandedQueryModel | undefined | null): boolean;
 export declare function escapeSingleQuotes(str?: string): string | undefined;
+export declare function validateChartType(chartType: DynamicChartType): void;

package/dist/packages/sdk-ui/src/analytics-composer/execute-query/execute-query-composer.d.ts

@@ -0,0 +1,8 @@
+import { ExecuteQueryCodeParams } from '../types.js';
+/**
+ * Converts query params to CSDK code.
+ *
+ * @param queryParams - queryParams params
+ * @returns CSDK code string
+ */
+export declare const toExecuteQueryCode: (executeQueryCodeParams: ExecuteQueryCodeParams) => string;

package/dist/packages/sdk-ui/src/analytics-composer/execute-query/to-execute-query-code.d.ts

@@ -0,0 +1,2 @@
+import { ExecuteQueryCodeParams } from '../types.js';
+export declare const toExecuteQueryCode: ({ queryParams, uiFramework, }: ExecuteQueryCodeParams) => string;

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

@@ -10,3 +10,8 @@ export * as widgetComposer from './widget/widget-composer';
  * @internal
  */
 export * as dashboardComposer from './dashboard/dashboard-composer';
+/**
+ * Utility functions to compose props and code for executing queries.
+ * @internal
+ */
+export * as executeQueryComposer from './execute-query/execute-query-composer';

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

@@ -1,6 +1,8 @@
 import { WidgetProps } from '../props';
 import { ChartDataOptions } from '../types';
+import { ExecuteQueryParams } from '../query-execution';
 import { MetadataItem } from '@sisense/sdk-data';
+import { DynamicChartType } from '../chart-options-processor/translations/types.js';
 export type KeysOfUnion<T> = T extends T ? keyof T : never;
 export type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
 export type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
@@ -22,6 +24,8 @@ export interface ExpandedQueryModel {
     chartRecommendations: ChartRecommendations | {};
     jaql: {
         datasource: {
+            id?: string;
+            type?: 'elasticube' | 'live';
             title: string;
         };
         metadata: MetadataItem[];
@@ -82,7 +86,7 @@ export type UiFramework = 'react' | 'vue' | 'angular';
  * Code Template Key
  * @internal
  */
-export type CodeTemplateKey = 'baseChartTmpl' | 'chartTmpl' | 'chartWidgetTmpl' | 'widgetByIdTmpl';
+export type CodeTemplateKey = 'baseChartTmpl' | 'chartTmpl' | 'chartWidgetTmpl' | 'widgetByIdTmpl' | 'executeQueryByWidgetIdTmpl' | 'executeQueryTmpl';
 /**
  * Code Templates
  * @internal
@@ -115,7 +119,7 @@ export type WidgetCodeConfig = BaseCodeConfig & {
  * Client-side Widget Code Params
  * @internal
  */
-export type ClientSideWidgetCodeParams = WidgetCodeConfig & {
+export type ClientSideWidgetCodeParams = BaseCodeConfig & {
     widgetProps: WidgetProps;
 };
 /**
@@ -125,6 +129,7 @@ export type ClientSideWidgetCodeParams = WidgetCodeConfig & {
 export type ByIdWidgetCodeParams = WidgetCodeConfig & {
     dashboardOid: string;
     widgetOid: string;
+    chartType: DynamicChartType;
 };
 /**
  * Widget Code Params
@@ -147,3 +152,9 @@ export declare const isByIdWidgetCodeParams: (params: WidgetCodeParams) => param
 export type WidgetPropsConfig = {
     useCustomizedStyleOptions?: boolean;
 };
+/**
+ * @internal
+ */
+export type ExecuteQueryCodeParams = BaseCodeConfig & {
+    queryParams: ExecuteQueryParams;
+};

package/dist/packages/sdk-ui/src/analytics-composer/widget/to-widget-code.d.ts

@@ -1,3 +1,3 @@
 import { ByIdWidgetCodeParams, ClientSideWidgetCodeParams } from '../types.js';
-export declare const toWidgetCodeById: ({ dashboardOid, widgetOid, uiFramework, }: ByIdWidgetCodeParams) => string;
+export declare const toWidgetCodeById: ({ dashboardOid, widgetOid, uiFramework, chartType, includeChart, }: ByIdWidgetCodeParams) => string;
 export declare const toWidgetCodeClientSide: ({ widgetProps, uiFramework, }: ClientSideWidgetCodeParams) => string;

package/dist/packages/sdk-ui/src/analytics-composer/widget/widget-composer.d.ts

@@ -2,6 +2,7 @@ import { WidgetProps } from '../../props.js';
 import { ExpandedQueryModel, WidgetCodeParams, WidgetPropsConfig } from '../types.js';
 /**
  * Converts query model to widget props.
+ *
  * @param queryModel - Expanded query model
  * @returns Widget props
  */

package/dist/packages/sdk-ui/src/api/rest-api.d.ts

@@ -3,6 +3,7 @@ import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
 import { type DataSource } from '@sisense/sdk-data';
 import { HierarchyDto, WidgetDto } from '../widget-by-id/types';
 import type { DashboardDto } from './types/dashboard-dto';
+import { TranslatableError } from '../translation/translatable-error';
 import { PaletteDto } from '../api/types/palette-dto';
 import { GetHierarchiesOptions } from '../models/hierarchy/types';
 type GetDashboardsOptions = {
@@ -20,7 +21,19 @@ export declare class RestApi {
     /**
      * Get all dashboards
      */
-    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[] | undefined>;
+    getDashboards: (options?: GetDashboardsOptions) => Promise<({
+        oid: string;
+        title: string;
+        datasource: import("@sisense/sdk-data").JaqlDataSource;
+        widgets?: WidgetDto[] | undefined;
+        filters?: (import("./types/dashboard-dto").FilterDto | import("./types/dashboard-dto").CascadingFilterDto)[] | undefined;
+        filterRelations?: {
+            datasource: string;
+            filterRelations: import("@sisense/sdk-data").FilterRelationsModelNode;
+        }[] | undefined;
+        layout?: import("./types/dashboard-dto").LayoutDto | undefined;
+        style?: import("./types/dashboard-dto").DashboardStyleDto | undefined;
+    } & import("../utils/utility-types").AnyObject)[]>;
     /**
      * Get a specific dashboard
      */
@@ -53,6 +66,16 @@ export declare class RestApi {
      * Partially update a dashboard
      */
     patchDashboard: (dashboardOid: string, dashboard: Partial<DashboardDto>) => Promise<DashboardDto | undefined>;
+    /**
+     * Add widget to a dashboard
+     */
+    addWidgetToDashboard: (dashboardOid: string, widgetDto: WidgetDto) => Promise<WidgetDto | undefined>;
+}
+export declare const useRestApi: () => {
+    restApi: RestApi | undefined;
+    isReady: boolean;
+};
+export declare class RestApiNotReadyError extends TranslatableError {
+    constructor();
 }
-export declare const useGetApi: () => RestApi;
 export {};

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

@@ -1,9 +1,9 @@
 import { WidgetDto } from '../../widget-by-id/types';
-import { FilterJaql, FilterRelationsModel, JaqlDataSource } from '@sisense/sdk-data';
+import { FilterJaql, FilterRelationsModel, FilterRelationsModelNode, JaqlDataSource } from '@sisense/sdk-data';
 import { AnyObject } from '../../utils/utility-types';
 /** @internal */
 export type LayoutDto = {
-    columns: {
+    columns?: {
         width: number;
         cells?: {
             subcells: {
@@ -23,9 +23,12 @@ export type FilterDto = {
     disabled?: boolean;
     locked?: boolean;
 };
+type CascadeLevel = FilterJaql & {
+    instanceid?: string;
+};
 export type CascadingFilterDto = {
     isCascading: true;
-    levels: FilterJaql[];
+    levels: CascadeLevel[];
     instanceid?: string;
     disabled?: boolean;
     locked?: boolean;
@@ -48,8 +51,10 @@ export type DashboardDto = {
     widgets?: WidgetDto[];
     filters?: Array<FilterDto | CascadingFilterDto>;
     filterRelations?: {
-        filterRelations: FilterRelationsModel;
+        datasource: string;
+        filterRelations: FilterRelationsModel | FilterRelationsModelNode;
     }[];
     layout?: LayoutDto;
     style?: DashboardStyleDto;
 } & AnyObject;
+export {};

package/dist/packages/sdk-ui/src/chart/advanced-chart.d.ts

@@ -4,4 +4,4 @@ import { RegularChartProps } from '../props.js';
  * @param props
  * @returns
  */
-export declare const AdvancedChart: (props: RegularChartProps) => import("react/jsx-runtime").JSX.Element;
+export declare const AdvancedChart: (props: RegularChartProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/packages/sdk-ui/src/chart/regular-chart.d.ts

@@ -1,3 +1,4 @@
+import { Data } from '@sisense/sdk-data';
 import { RegularChartProps } from '../props';
 /**
  *
@@ -5,3 +6,5 @@ import { RegularChartProps } from '../props';
  * @returns
  */
 export declare const RegularChart: (props: RegularChartProps) => import("react/jsx-runtime").JSX.Element | null;
+/** Type guard for Data */
+export declare function isData(data: any): data is Data;

package/dist/packages/sdk-ui/src/chart-data-processor/data-table-date-period.d.ts

@@ -1,7 +1,4 @@
-export type SystemSettings = {
-    language: string;
-};
-export declare const getBaseDateFnsLocale: (systemSettings?: SystemSettings) => Locale;
+export declare const getBaseDateFnsLocale: (language?: string) => Locale;
 export declare enum DatePeriod {
     YEAR = "years",
     QUARTER = "quarters",

package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options.d.ts

@@ -3,6 +3,7 @@ import { ChartType, OptionsWithAlerts, CompleteThemeSettings } from '../types';
 import { CategoricalChartData } from '../chart-data/types';
 import { HighchartsOptionsInternal } from './chart-options-service';
 import { ChartDataOptionsInternal } from '../chart-data-options/types';
+import { TFunction } from '@sisense/sdk-common';
 /**
  * Convert intermediate chart data, data options, and design options
  * into pure highcharts config data.
@@ -13,4 +14,4 @@ import { ChartDataOptionsInternal } from '../chart-data-options/types';
  * @param dataOptions -
  * @param themeSettings -
  */
-export declare const getCategoricalChartOptions: (chartData: CategoricalChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings) => OptionsWithAlerts<HighchartsOptionsInternal>;
+export declare const getCategoricalChartOptions: (chartData: CategoricalChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, translate: TFunction, themeSettings?: CompleteThemeSettings) => OptionsWithAlerts<HighchartsOptionsInternal>;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/sunburst/sunburst-options.d.ts

@@ -3,4 +3,5 @@ import { HighchartsOptionsInternal } from '../../chart-options-service';
 import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
 import { CompleteThemeSettings } from '../../../types';
 import { SunburstChartDesignOptions } from '../design-options';
-export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;
+import { TFunction } from '@sisense/sdk-common';
+export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/treemap/treemap-options.d.ts

@@ -3,4 +3,5 @@ import { HighchartsOptionsInternal } from '../../chart-options-service';
 import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
 import { CompleteThemeSettings } from '../../../types';
 import { TreemapChartDesignOptions } from '../design-options';
-export declare function prepareTreemapOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;
+import { TFunction } from '@sisense/sdk-common';
+export declare function prepareTreemapOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/treemap/treemap-tooltip.d.ts

@@ -2,11 +2,12 @@ import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options
 import { TreemapChartDesignOptions } from '../design-options';
 import { TooltipSettings } from '../../tooltip';
 import { TooltipFormatterContextObject } from '@sisense/sisense-charts';
+import { TFunction } from '@sisense/sdk-common';
 type TooltipFormatterOptions = {
     displayTotalContribution: boolean;
     displayColorCircles: boolean;
     shouldSkip: (context: TooltipFormatterContextObject) => boolean;
 };
-export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, formatterOptions?: TooltipFormatterOptions) => TooltipSettings;
-export declare function treemapTooltipFormatter(context: TooltipFormatterContextObject, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, formatterOptions?: TooltipFormatterOptions): string | false;
+export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions) => TooltipSettings;
+export declare function treemapTooltipFormatter(context: TooltipFormatterContextObject, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions): string | false;
 export {};

package/dist/packages/sdk-ui/src/chart-options-processor/translations/types.d.ts

@@ -64,4 +64,6 @@ export declare const isTable: (chartType: ChartType | TableType) => chartType is
 export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot";
 export declare const isAreamap: (chartType: ChartType) => chartType is "areamap";
 export declare const isRange: (chartType: ChartType) => chartType is "arearange";
+export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "arearange"];
+export type DynamicChartType = (typeof ALL_CHART_TYPES)[number];
 export {};

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

@@ -14,7 +14,9 @@ export declare function flattenCascadingFilters(filters: Filter[]): {
  * @param originalFilters - Original filters with maybe cascading filters.
  * @returns reassembled filters.
  */
-export declare function reassembleCascadingFilters(updatedFilters: PureFilter[], originalFilters: (PureFilter | CascadingFilter)[]): (PureFilter | CascadingFilter)[];
+export declare function reassembleCascadingFilters(updatedFilters: PureFilter[], originalFilters: (PureFilter | CascadingFilter)[], config?: {
+    shouldResetFiltersDeeperThanModified?: boolean;
+}): (PureFilter | CascadingFilter)[];
 /**
  * Converts cascading filters to pure filters and vice versa.
  *

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

@@ -4,14 +4,15 @@ import { CommonFiltersOptions } from './types.js';
 import { WidgetTypeInternal } from '../models/widget/types';
 import { OpenMenuFn } from '../common/components/menu/types';
 import { TFunction } from '@sisense/sdk-common';
-type CommonFiltersToWidgetConnectProps = Pick<ChartWidgetProps, 'filters' | 'highlights' | 'onDataPointClick' | 'onDataPointsSelected' | 'onDataPointContextMenu'> & {
+type CommonFiltersConnectionProps = Pick<ChartWidgetProps, 'highlights' | 'onDataPointClick' | 'onDataPointsSelected' | 'onDataPointContextMenu'> & {
+    filters: Filter[];
     renderToolbar: RenderToolbarHandler;
 };
 /**
- * Prepares common filters to be used in widget connect props
+ * Prepares common filters for connection to widget props
  *
  * @param filters - Pure filters (non-cascading)
  * @param setFilters - Function to set updated pure filters (non-cascading)
  */
-export declare function prepareCommonFiltersToWidgetConnectProps(commonFilters: Filter[], updateCommonFilters: (filters: Filter[]) => void, widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, options: CommonFiltersOptions, translate: TFunction, openMenu?: OpenMenuFn): CommonFiltersToWidgetConnectProps;
+export declare function prepareCommonFiltersConnectionProps(commonFilters: Filter[], updateCommonFilters: (filters: Filter[]) => void, widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, options: CommonFiltersOptions, translate: TFunction, openMenu?: OpenMenuFn): CommonFiltersConnectionProps;
 export {};

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

@@ -11,16 +11,41 @@ export declare enum CommonFiltersApplyMode {
  * Options for common filters defined at the dashboard level to be applied to certain widgets.
  */
 export type CommonFiltersOptions = {
+    /**
+     * Apply mode for common filters: 'highlight' or 'filter'.
+     */
     applyMode?: `${CommonFiltersApplyMode}`;
+    /**
+     * Boolean flag whether widget interactions – for example, selection of bars on a bar chart –
+     * should affect common filters.
+     *
+     * If not specified, the default value is `true`.
+     */
     shouldAffectFilters?: boolean;
+    /**
+     * Filters to ignore when applying common filters.
+     */
     ignoreFilters?: FiltersIgnoringRules;
+    /**
+     * Boolean flag whether to apply all background filters as slice filters ignoring "disabled" state and "ignoreFilters" rules
+     *
+     * If not specified, the default value is `true`.
+     */
     forceApplyBackgroundFilters?: boolean;
 };
 /**
  * Filters ignoring rules.
  */
 export type FiltersIgnoringRules = {
+    /**
+     * Boolean flag whether to ignore all filters.
+     *
+     * If not specified, the default value is `false`.
+     */
     all?: boolean;
+    /**
+     * Filter GUIDs to ignore.
+     */
     ids?: string[];
 };
 /** @internal */

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

@@ -1,17 +1,16 @@
-/// <reference types="react" />
-import { type Filter } from '@sisense/sdk-data';
+import { FilterRelations, type Filter } from '@sisense/sdk-data';
 import { CommonFiltersOptions } from './types.js';
 import { WidgetProps } from '../props.js';
 import { BeforeMenuOpenHandler, OpenMenuFn } from '../common/components/menu/types.js';
 /** @internal */
-export declare const useCommonFilters: ({ initialFilters, openMenu, onBeforeMenuOpen, onFiltersChange, }?: {
-    initialFilters?: Filter[] | undefined;
+export declare const useCommonFilters: ({ initialFilters: initialCommonFiltersOrFilterRelations, openMenu, onBeforeMenuOpen, onFiltersChange, }?: {
+    initialFilters?: Filter[] | FilterRelations | undefined;
     openMenu?: OpenMenuFn | undefined;
     onBeforeMenuOpen?: BeforeMenuOpenHandler | undefined;
-    onFiltersChange?: ((filters: Filter[]) => void) | undefined;
+    onFiltersChange?: ((filters: Filter[] | FilterRelations) => void) | undefined;
 }) => {
-    filters: Filter[];
-    setFilters: import("react").Dispatch<import("react").SetStateAction<Filter[]>>;
-    addFilter: (newFilter: Filter) => void;
-    connectToWidgetProps: (widget: WidgetProps, options?: CommonFiltersOptions) => WidgetProps;
+    filters: Filter[] | FilterRelations;
+    setFilters: (filtersOrFilterRelations: Filter[] | FilterRelations) => void;
+    addFilter: (filter: Filter) => void;
+    connectToWidgetProps: (widgetProps: WidgetProps, options?: CommonFiltersOptions) => WidgetProps;
 };

package/dist/packages/sdk-ui/src/common-filters/use-convert-filter-relations.d.ts

@@ -0,0 +1,26 @@
+import { Filter, FilterRelations } from '@sisense/sdk-data';
+/**
+ * Result of the FilterRelations conversion.
+ */
+type UseFilterRelationsConversionResult = {
+    /** The current filters or filter relations. */
+    filtersOrFilterRelations: Filter[] | FilterRelations;
+    /** The current regular filters without relations. */
+    regularFilters: Filter[];
+    /** Adds a new filter to the current filters (recalculates relations if needed). */
+    addFilter: (filter: Filter) => void;
+    /** Completely replaces the current filters and relations with new ones. */
+    setFiltersOrFilterRelations: (filtersOrFilterRelations: Filter[] | FilterRelations) => void;
+    /** Completely replaces the current filters with new ones (recalculates relations if needed). */
+    setFilters: (filters: Filter[]) => void;
+    /** Calculates relations for some other filters based on current relations and applies them */
+    applyRelationsToOtherFilters: (otherFilters: Filter[]) => Filter[] | FilterRelations;
+};
+/**
+ * Hook for handling conversion between regular filters and filter relations.
+ *
+ * @param initialFiltersOrFilterRelations - Initial filters or filter relations.
+ * @returns The result of the conversion. See {@link UseFilterRelationsConversionResult}.
+ */
+export declare function useConvertFilterRelations(initialFiltersOrFilterRelations: Filter[] | FilterRelations, onFiltersChange?: (filters: Filter[] | FilterRelations) => void): UseFilterRelationsConversionResult;
+export {};

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

@@ -1,2 +1,2 @@
 import { DashboardContainerProps } from '../../dashboard/types';
-export declare const DashboardContainer: ({ title, layoutOptions, config, widgets, filters, onFiltersChange, defaultDataSource, }: DashboardContainerProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DashboardContainer: ({ title, layoutOptions, config, widgets, filters, onFiltersChange, defaultDataSource, onChange, }: DashboardContainerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/dashboard/components/horizontal-collapse.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+export declare const HorizontalCollapse: ({ collapsed, onCollapsedChange, children, }: {
+    collapsed?: boolean | undefined;
+    onCollapsedChange?: ((collapsed: boolean) => void) | undefined;
+    children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,5 +1,5 @@
-import { Filter } from '@sisense/sdk-data';
 import { DashboardProps } from './types';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
 /**
  * Creates a new dashboard instance with its filters replaced by a new set of filters.
  *
@@ -13,10 +13,10 @@ import { DashboardProps } from './types';
  * const updatedDashboard = replaceFilters(existingDashboard, newFilters);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) whose filters are to be replaced.
- * @param newFilters - An array of new filters to set on the dashboard.
+ * @param newFilters - An array of new filters or filter relations to set on the dashboard.
  * @returns A new dashboard instance with the updated filters.
  */
-export declare const replaceFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
+export declare const replaceFilters: (dashboard: DashboardProps, newFilters: Filter[] | FilterRelations) => DashboardProps;
 /**
  * Creates a new dashboard instance with an additional filter added to its existing filters.
  *
@@ -52,19 +52,31 @@ export declare const addFilter: (dashboard: DashboardProps, newFilter: Filter) =
  */
 export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
 /**
- * Creates a new dashboard instance with a specific filter modified.
+ * Creates a new dashboard instance with a specific filter replaced.
  *
- * This function searches for a filter with the same GUID as the provided `filterToModify` and replaces it with `newFilter`.
+ * This function searches for a filter with the same GUID as the provided `filterToReplace` and replaces it with `newFilter`.
  * This function does not modify the original dashboard; instead, it returns a new dashboard with the updated filters.
  *
  * @example
- * Modify a filter in a dashboard.
+ * Replace a filter in a dashboard.
  * ```ts
  * const existingDashboard: DashboardProps = {...};
- * const filterToModify: Filter = {...};
+ * const filterToReplace: Filter = {...};
  * const newFilter: Filter = {...};
- * const updatedDashboard = modifyFilter(existingDashboard, filterToModify, newFilter);
+ * const updatedDashboard = replaceFilter(existingDashboard, filterToReplace, newFilter);
  * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to be replaced.
+ * @param filterToReplace - The existing filter to be replaced.
+ * @param newFilter - The new filter to replace the existing one.
+ * @returns A new dashboard instance with the specified filter replaced.
+ */
+export declare const replaceFilter: (dashboard: DashboardProps, filterToReplace: Filter, newFilter: Filter) => DashboardProps;
+/**
+ * Creates a new dashboard instance with a specific filter modified.
+ * Alias for `replaceFilter`.
+ *
+ * @deprecated Use {@link replaceFilter} instead
+ *
  * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to modify.
  * @param filterToModify - The existing filter to be modified.
  * @param newFilter - The new filter to replace the existing one.
@@ -85,7 +97,25 @@ export declare const modifyFilter: (dashboard: DashboardProps, filterToModify: F
  * const updatedDashboard = removeFilter(existingDashboard, filterToRemove);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) from which to remove the filter.
- * @param filter - The filter to be removed.
+ * @param filterToRemove - The filter to be removed.
  * @returns A new dashboard instance with the specified filter removed.
  */
-export declare const removeFilter: (dashboard: DashboardProps, filter: Filter) => DashboardProps;
+export declare const removeFilter: (dashboard: DashboardProps, filterToRemove: Filter) => DashboardProps;
+/**
+ * Creates a new dashboard instance with multiple filters removed.
+ *
+ * This function removes all filters with the same GUID as the provided filters from the dashboard's filters.
+ * This function does not modify the original dashboard; instead, it returns a new dashboard with the updated filters.
+ *
+ * @example
+ * Remove multiple filters from a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filtersToRemove: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = removeFilters(existingDashboard, filtersToRemove);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) from which the specified filters are removed.
+ * @param filtersToRemove - An array of filters to remove.
+ * @returns A new dashboard instance with the specified filters removed.
+ */
+export declare const removeFilters: (dashboard: DashboardProps, filtersToRemove: Filter[]) => DashboardProps;

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

@@ -1,13 +1,18 @@
 /// <reference types="react" />
 import { DashboardProps } from '../dashboard/types';
-import { Filter } from '@sisense/sdk-data';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
 export declare enum DashboardChangeType {
     /** Dashboard filters have been updated */
-    FILTERS_UPDATE = "FILTERS.UPDATE"
+    FILTERS_UPDATE = "FILTERS.UPDATE",
+    /** Filters panel collapsed state changed */
+    UI_FILTERS_PANEL_COLLAPSE = "UI.FILTERS.PANEL.COLLAPSE"
 }
 export type DashboardChangeAction = {
     type: DashboardChangeType.FILTERS_UPDATE;
-    payload: Filter[];
+    payload: Filter[] | FilterRelations;
+} | {
+    type: DashboardChangeType.UI_FILTERS_PANEL_COLLAPSE;
+    payload: boolean;
 };
 /**
  * React component that renders a dashboard whose elements are customizable. It includes internal logic of applying common filters to widgets.

package/dist/packages/sdk-ui/src/dashboard/hooks/use-filters-panel-collapsed-state.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare const LS_KEY_FILTERS_PANEL_COLLAPSED = "csdk_dashboard_filters_panel_collapsed";
+/**
+ * @internal
+ */
+export declare const useFiltersPanelCollapsedState: (initialState?: boolean, shouldUseLocalStorage?: boolean) => [boolean, (state: boolean) => void];