@sisense/sdk-ui 1.32.0 → 1.33.0

package/dist/packages/sdk-ui/src/ai/ai-context-provider.d.ts

@@ -1,8 +1,9 @@
 import { ReactNode } from 'react';
-export type AiContextProviderProps = {
+export interface AiContextProviderProps {
     children: ReactNode;
+    /** AI context volatile mode */
     volatile?: boolean;
-};
+}
 /**
  * React component that wraps all generative AI components and hooks.
  *

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

@@ -65,13 +65,19 @@ interface ErrorResponse {
     responseType: 'error';
 }
 /**
- * Response data to NLQ request
+ * Response data for NLQ request
  */
 export interface NlqResponseData extends ExpandedQueryModel {
+    /** Detailed description of the response */
     detailedDescription: string;
-    followupQuestions: string[];
+    /** An array of suggested followup questions  */
+    followupQuestions?: string[];
+    /** NLQ prompt used in the request  */
     nlqPrompt: string;
+    /** Suggested widget props*/
     widgetProps?: WidgetProps | undefined;
+    /** The response message for the chat  */
+    userMsg: string;
 }
 export interface NlqResponse {
     data: NlqResponseData;
@@ -83,7 +89,9 @@ export interface QueryRecommendationConfig {
     numOfRecommendations: number;
 }
 export type NlqResult = Omit<NlqResponseData, 'followupQuestions'>;
-export type QueryRecommendation = Omit<NlqResponseData, 'followupQuestions'>;
+/** AI-generated recommended query you can run on your data model */
+export interface QueryRecommendation extends Omit<NlqResponseData, 'followupQuestions'> {
+}
 export type QueryRecommendationResponse = QueryRecommendation[];
 export interface GetNlgInsightsRequest {
     jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;

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

@@ -1,4 +1,4 @@
-import { Filter, Data } from '@sisense/sdk-data';
+import { Filter, Data, FilterRelations } from '@sisense/sdk-data';
 import type { NlqResponseData } from '../../ai';
 import { NlqChartWidgetStyleOptions } from '../../types';
 /**
@@ -15,7 +15,7 @@ export interface NlqChartWidgetProps {
     /**
      * The dashboard filters to be applied to the chart
      */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     /**
      * A callback that allows to modify data immediately after it has been retrieved.
      * Can be used to inject modification of queried data.

package/dist/packages/sdk-ui/src/ai/custom-ai-context-provider.d.ts

@@ -2,7 +2,7 @@ import { ReactNode } from 'react';
 import { type ChatRestApi } from './api/chat-rest-api';
 /** @internal */
 export type CustomAiContext = {
-    api: ChatRestApi;
+    api?: ChatRestApi;
 };
 /** @internal */
 export type CustomAiContextProviderProps = {

package/dist/packages/sdk-ui/src/ai/use-last-nlq-response-from-history.d.ts

@@ -0,0 +1,8 @@
+import type { NlqResponseData, ChatMessage } from './api/types';
+/**
+ * React hook that returns the last NLQ response from chat history
+ *
+ * @chatHistory [ChatMessage[]] - Parameters for the hook
+ * @internal
+ */
+export declare const useLastNlqResponseFromHistory: (chatHistory?: ChatMessage[]) => NlqResponseData | null;

package/dist/packages/sdk-ui/src/ai/use-last-nlq-response.d.ts

@@ -4,7 +4,7 @@ import type { NlqResponseData, ChatContextDetails } from './api/types';
  *
  * @internal
  */
-interface UseLastNlqResponseParams {
+export interface UseLastNlqResponseParams {
     /** The title of the data model or perspective */
     contextTitle: string;
     /** optional chat context details */
@@ -18,4 +18,3 @@ interface UseLastNlqResponseParams {
  * @internal
  */
 export declare const useLastNlqResponse: ({ contextTitle, contextDetails, }: UseLastNlqResponseParams) => NlqResponseData | null;
-export {};

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

@@ -89,8 +89,9 @@ export declare class RestApi {
      * @returns A list of datasource fields
      */
     getDataSourceFields: (dataSource: string, options?: {
-        offset: number;
-        count: number;
+        offset?: number;
+        count?: number;
+        searchValue?: string;
     }) => Promise<DataSourceField[] | undefined>;
 }
 export declare const useRestApi: () => {

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

@@ -17,8 +17,8 @@ import { AreaChartProps } from './props';
  *
  * Additional Area Chart examples:
  *
- * - [Stacked Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked)
- * - [Stacked Percentage Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked100)
+ * - [Stacked Area Chart](https://www.sisense.com/developers/playground/?example=charts%2Farea-chart-stacked)
+ * - [Stacked Percentage Area Chart](https://www.sisense.com/developers/playground/?example=charts%2Farea-chart-stacked100)
  *
  * @param props - Area chart properties
  * @returns Area Chart component

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

@@ -17,8 +17,8 @@ import { BarChartProps } from './props';
  *
  * Additional Bar Chart examples:
  *
- * - [Stacked Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked)
- * - [Stacked Percentage Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked100)
+ * - [Stacked Bar Chart](https://www.sisense.com/developers/playground/?example=charts%2Fbar-chart-stacked)
+ * - [Stacked Percentage Bar Chart](https://www.sisense.com/developers/playground/?example=charts%2Fbar-chart-stacked100)
  *
  * @param props - Bar chart properties
  * @returns Bar Chart component

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

@@ -20,8 +20,8 @@ import { ColumnChartProps } from './props';
  *
  * Additional Column Chart examples:
  *
- * - [Stacked Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked)
- * - [Stacked Percentage Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked100)
+ * - [Stacked Column Chart](https://www.sisense.com/developers/playground/?example=charts%2Fcolumn-chart-stacked)
+ * - [Stacked Percentage Column Chart](https://www.sisense.com/developers/playground/?example=charts%2Fcolumn-chart-stacked100)
  *
  * @param props - Column chart properties
  * @returns Column Chart component

package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/group-header.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { ItemsGroup, GroupSecondaryActionConfig } from './types';
+type GroupHeaderProps = {
+    isOpen: boolean;
+    group: ItemsGroup;
+    secondaryAction?: GroupSecondaryActionConfig;
+    onOpenStateChange?: (open: boolean) => void;
+};
+export declare const GroupHeader: React.FC<GroupHeaderProps>;
+export {};

package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/group.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { ItemsGroup, GroupSecondaryActionConfig, ItemActionConfig, ItemSecondaryActionConfig } from './types';
+type GroupProps = {
+    group: ItemsGroup;
+    groupSecondaryActionConfig?: GroupSecondaryActionConfig;
+    itemActionConfig?: ItemActionConfig;
+    itemSecondaryActionConfig?: ItemSecondaryActionConfig;
+};
+export declare const Group: React.FC<GroupProps>;
+export {};

package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/grouped-items-browser.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { GroupedItemsBrowserProps } from './types';
+/**
+ * A generic component that displays a list of grouped items.
+ */
+export declare const GroupedItemsBrowser: React.FC<GroupedItemsBrowserProps>;

package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/item-row.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { Item, ItemActionConfig, ItemSecondaryActionConfig } from './types';
+/**
+ * Props for the item row component.
+ */
+type ItemRowProps = {
+    /** The item to display. */
+    item: Item;
+    /** The action to perform when the item is clicked. */
+    itemActionConfig?: ItemActionConfig;
+    /** The secondary action of the item. */
+    itemSecondaryActionConfig?: ItemSecondaryActionConfig;
+};
+export declare const ItemRow: React.FC<ItemRowProps>;
+export {};

package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/types.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="react" />
+export type GroupedItemsBrowserProps = {
+    groupedItems: ItemsGroup[];
+    groupSecondaryActionConfig?: GroupSecondaryActionConfig;
+    itemActionConfig?: ItemActionConfig;
+    itemSecondaryActionConfig?: ItemSecondaryActionConfig;
+    onScrolledToBottom?: () => void;
+};
+/**
+ * A group of items.
+ */
+export type ItemsGroup = {
+    title: string;
+    id: string;
+    items: Item[];
+    Icon?: React.ComponentType;
+};
+/**
+ * An item in the list of grouped items.
+ */
+export type Item = {
+    id: string;
+    title: string;
+    Icon?: React.ComponentType;
+};
+export type GroupSecondaryActionConfig = {
+    SecondaryActionButtonIcon: React.ComponentType<{
+        group: ItemsGroup;
+    }>;
+    onClick(this: void, group: ItemsGroup): void;
+};
+export type ItemActionConfig = {
+    onClick(this: void, item: Item): void;
+};
+export type ItemSecondaryActionConfig = {
+    SecondaryActionButtonIcon: React.ComponentType<{
+        item: Item;
+    }>;
+    onClick(this: void, item: Item): void;
+};

package/dist/packages/sdk-ui/src/common/components/loading-dots.d.ts

@@ -1,3 +1,3 @@
 export declare const LoadingDots: ({ color }: {
-    color: string | undefined;
+    color?: string | undefined;
 }) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/components/popover.d.ts

@@ -15,6 +15,7 @@ type PopoverPosition = PopoverAnchorPosition;
 type PopoverProps = {
     children: ReactNode;
     open: boolean;
+    id?: string;
     position?: PopoverPosition;
     onClose?: () => void;
 };

package/dist/packages/sdk-ui/src/common/components/radio.d.ts

@@ -2,6 +2,7 @@ type ButtonProps = {
     checked?: boolean;
     value?: string;
     onChange?: (checked: boolean) => void;
+    disabled?: boolean;
 };
 /** @internal */
 export declare const Radio: (props: ButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './use-data-accumulation';
+export * from './use-get-load-more-function';
+export * from './use-load-data-from-internal-hook';
+export * from './use-manage-slice-to-load';

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-data-accumulation.d.ts

@@ -0,0 +1,7 @@
+import { DataChunk } from '../../types';
+export declare function useDataAccumulation({ shouldBeReset }: {
+    shouldBeReset: boolean;
+}): {
+    accumulatedData: DataChunk[];
+    addData: (dataChunk: DataChunk | null) => void;
+};

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-get-load-more-function.d.ts

@@ -0,0 +1,4 @@
+export declare function useGetLoadMoreFunction({ increaseSliceToLoad, isLoadMoreRequestsForbidden, }: {
+    increaseSliceToLoad: () => void;
+    isLoadMoreRequestsForbidden: boolean;
+}): () => void;

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-load-data-from-internal-hook.d.ts

@@ -0,0 +1,16 @@
+import { AnyArray, RestApiHookState } from '../../../../../../utils/utility-types';
+import { RestApiHookParams, SliceableRestApiHook, UnsliceableParams, Slice, DataChunk, HookExecutionStatus } from '../../types';
+type UseLoadDataFromInternalHookOptions<HookParams extends RestApiHookParams, DataKey extends string, SuccessDataType extends AnyArray, Hook extends SliceableRestApiHook<HookParams, DataKey, SuccessDataType>> = {
+    hook: Hook;
+    params: UnsliceableParams<HookParams>;
+    sliceToLoad: Slice;
+    dataKey: DataKey;
+};
+type UseLoadDataFromInternalHookResult<DataKey extends string, SuccessDataType extends AnyArray> = {
+    dataChunk: DataChunk | null;
+    hookExecutionStatus: HookExecutionStatus;
+    dataLoadingError: Error | undefined;
+    hookResultState: RestApiHookState<DataKey, SuccessDataType>;
+};
+export declare function useLoadDataFromInternalHook<HookParams extends RestApiHookParams, DataKey extends string, SuccessDataType extends AnyArray, Hook extends SliceableRestApiHook<HookParams, DataKey, SuccessDataType>>(options: UseLoadDataFromInternalHookOptions<HookParams, DataKey, SuccessDataType, Hook>): UseLoadDataFromInternalHookResult<DataKey, SuccessDataType>;
+export {};

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-manage-slice-to-load.d.ts

@@ -0,0 +1,10 @@
+import { DataChunk, Slice } from '../../types';
+export declare function useManageSliceToLoad({ initialCount, chunkSize, accumulatedData, shouldBeReset, }: {
+    initialCount: number;
+    chunkSize: number;
+    accumulatedData: DataChunk[];
+    shouldBeReset: boolean;
+}): {
+    sliceToLoad: Slice;
+    increaseSliceToLoad: () => void;
+};

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/utils/calculate-if-all-items-loaded.d.ts

@@ -0,0 +1,2 @@
+import { DataChunk } from '../../types';
+export declare const calculateIfAllItemsLoaded: (dataChunk: DataChunk | null) => boolean;

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/utils/get-hook-state-result.d.ts

@@ -0,0 +1,9 @@
+import { AnyArray, RestApiHookState } from '../../../../../../utils/utility-types';
+import { HookExecutionStatus, WithLoadMore } from '../../types';
+export declare function getHookStateResult<DataKey extends string, SuccessDataType extends AnyArray>(options: {
+    status: HookExecutionStatus;
+    dataKey: DataKey;
+    data: SuccessDataType;
+    loadMore: () => void;
+    error?: Error;
+}): WithLoadMore<RestApiHookState<DataKey, SuccessDataType>>;

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './calculate-if-all-items-loaded';
+export * from './get-hook-state-result';

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/index.d.ts

@@ -0,0 +1 @@
+export { withLazyLoading } from './with-lazy-loading';

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/types.d.ts

@@ -0,0 +1,27 @@
+import { AnyArray, AnyObject, RestApiHookState } from '../../../../utils/utility-types';
+export type Slice = {
+    count: number;
+    offset: number;
+};
+type Sliceable = Partial<Slice>;
+type Enableable = {
+    enabled?: boolean;
+};
+export type RestApiHookParams = Sliceable & Enableable & AnyObject;
+export type UnsliceableParams<Params extends RestApiHookParams> = Omit<Params, keyof Slice>;
+export type LazyLoadingConfig = {
+    initialCount: number;
+    chunkSize: number;
+    dataKey: string;
+};
+export type SliceableRestApiHook<Params extends RestApiHookParams, DataKey extends string, SuccessDataType extends AnyArray> = (params: Params) => RestApiHookState<DataKey, SuccessDataType>;
+export type WithLoadMore<ReturnObject> = ReturnObject & {
+    loadMore: () => void;
+};
+export type HookWithLazyLoading<HookParams extends RestApiHookParams, DataKey extends string, SuccessDataType extends AnyArray, Hook extends SliceableRestApiHook<HookParams, DataKey, SuccessDataType>> = (params: UnsliceableParams<HookParams>) => WithLoadMore<ReturnType<Hook>>;
+export type DataChunk = {
+    slice: Slice;
+    data: AnyArray;
+};
+export type HookExecutionStatus = 'success' | 'error' | 'loading';
+export {};

package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/with-lazy-loading.d.ts

@@ -0,0 +1,7 @@
+import { AnyArray } from '../../../../utils/utility-types';
+import { LazyLoadingConfig, SliceableRestApiHook, HookWithLazyLoading, RestApiHookParams } from './types';
+/**
+ * A decorator that adds lazy loading functionality to a hook.
+ *
+ */
+export declare const withLazyLoading: (config: LazyLoadingConfig) => <HookParams extends RestApiHookParams, DataKey extends string, SuccessDataType extends AnyArray>(hook: SliceableRestApiHook<HookParams, DataKey, SuccessDataType>) => HookWithLazyLoading<HookParams, DataKey, SuccessDataType, SliceableRestApiHook<HookParams, DataKey, SuccessDataType>>;

package/dist/packages/sdk-ui/src/common/hooks/fusion-endpoints/use-get-data-source-fields.d.ts

@@ -9,6 +9,9 @@ import { DataSource, DataSourceField } from '@sisense/sdk-data';
 export declare const useGetDataSourceFields: (params: {
     dataSource: DataSource | undefined;
     enabled?: boolean;
+    count?: number;
+    offset?: number;
+    searchValue?: string;
 }) => DataSourceFieldsState;
 type DataSourceFieldsState = RestApiHookState<'dataSourceFields', DataSourceField[]>;
 export {};

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

@@ -0,0 +1,9 @@
+import type { DeepRequired } from 'ts-essentials';
+import { AnyObject } from '../../utils/utility-types';
+/**
+ * Merges the provided configuration with the default configuration.
+ * @param config - The configuration to merge with the default configuration.
+ * @param defaults - The default configuration.
+ * @returns The merged configuration.
+ */
+export declare const useDefaults: <Config extends AnyObject>(config: Config | undefined, defaults: DeepRequired<Config>) => DeepRequired<Config>;

package/dist/packages/sdk-ui/src/common/hooks/use-last-defined.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Hook that returns the last defined value.
+ *
+ * @param value - last defined value to return.
+ */
+export declare function useLastDefined<T>(value: T | null | undefined): T;

package/dist/packages/sdk-ui/src/common/icons/approval-icon.d.ts

@@ -0,0 +1 @@
+export declare const ApprovalIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/arrow-icon.d.ts

@@ -0,0 +1,3 @@
+export declare const ArrowIcon: (props: {
+    direction: 'left' | 'right' | 'up' | 'down';
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/breadcrumbs-arrows-arrow-icon.d.ts

@@ -0,0 +1,3 @@
+export declare const BreadcrumbsArrowsIcon: ({ direction, }: {
+    direction?: "left" | "right" | undefined;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/close-icon.d.ts

@@ -0,0 +1 @@
+export declare const CloseIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/date-attribute-icon.d.ts

@@ -0,0 +1 @@
+export declare const DateAttributeIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/elasticube-icon.d.ts

@@ -0,0 +1 @@
+export declare const ElasticubeIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/numeric-attribute-icon.d.ts

@@ -0,0 +1 @@
+export declare const NumericAttributeIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/plus-icon.d.ts

@@ -0,0 +1 @@
+export declare const PlusIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/table-icon.d.ts

@@ -0,0 +1 @@
+export declare const TableIcon: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/common/icons/text-attribute-icon.d.ts

@@ -0,0 +1 @@
+export declare const TextAttributeIcon: () => import("react/jsx-runtime").JSX.Element;

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

@@ -10,6 +10,13 @@ export interface ContentPanelProps {
      * An object defining how the widgets should be laid out.
      */
     layout?: WidgetsPanelLayout;
+    /**
+     * If true adjust layout based on available width of content panel.
+     *
+     * If not specified, the default value is `false`.
+     * @internal
+     */
+    responsive?: boolean;
     /**
      * A list of widget props to render.
      */
@@ -21,4 +28,4 @@ export interface ContentPanelProps {
  * @param props - {@link ContentPanelProps}
  * @internal
  */
-export declare const ContentPanel: ({ layout, widgets }: ContentPanelProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ContentPanel: ({ layout, responsive, widgets }: ContentPanelProps) => import("react/jsx-runtime").JSX.Element;

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, onChange, enableFilterEditor, }: 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/constants.d.ts

@@ -1,2 +1,6 @@
+import type { DeepRequired } from 'ts-essentials';
+import { DashboardByIdConfig, DashboardConfig } from './types';
 export declare const DASHBOARD_DIVIDER_COLOR = "#d5d5d5";
 export declare const DASHBOARD_DIVIDER_WIDTH = 1;
+export declare const DEFAULT_DASHBOARD_CONFIG: DeepRequired<DashboardConfig>;
+export declare const DEFAULT_DASHBOARD_BY_ID_CONFIG: DeepRequired<DashboardByIdConfig>;

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

@@ -10,7 +10,7 @@ import { Filter, FilterRelations } from '@sisense/sdk-data';
  * ```ts
  * const existingDashboard: DashboardProps = {...}
  * const newFilters: Filter[] = [{...}, {...}, ...];
- * const updatedDashboard = replaceFilters(existingDashboard, newFilters);
+ * const updatedDashboard = dashboardHelpers.replaceFilters(existingDashboard, newFilters);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) whose filters are to be replaced.
  * @param newFilters - An array of new filters or filter relations to set on the dashboard.
@@ -27,7 +27,7 @@ export declare const replaceFilters: (dashboard: DashboardProps, newFilters: Fil
  * ```ts
  * const existingDashboard: DashboardProps = {...};
  * const newFilter: Filter = {...};
- * const updatedDashboard = addFilter(existingDashboard, newFilter);
+ * const updatedDashboard = dashboardHelpers.addFilter(existingDashboard, newFilter);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) to which the filter will be added.
  * @param newFilter - The filter to add to the dashboard.
@@ -44,7 +44,7 @@ export declare const addFilter: (dashboard: DashboardProps, newFilter: Filter) =
  * ```ts
  * const existingDashboard: DashboardProps = {...};
  * const newFilters: Filter[] = [{...}, {...}, ...];
- * const updatedDashboard = addFilters(existingDashboard, newFilters);
+ * const updatedDashboard = dashboardHelpers.addFilters(existingDashboard, newFilters);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) to which the filters will be added.
  * @param newFilters - An array of filters to add to the dashboard.
@@ -63,7 +63,7 @@ export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[
  * const existingDashboard: DashboardProps = {...};
  * const filterToReplace: Filter = {...};
  * const newFilter: Filter = {...};
- * const updatedDashboard = replaceFilter(existingDashboard, filterToReplace, newFilter);
+ * const updatedDashboard = dashboardHelpers.replaceFilter(existingDashboard, filterToReplace, newFilter);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to be replaced.
  * @param filterToReplace - The existing filter to be replaced.
@@ -94,7 +94,7 @@ export declare const modifyFilter: (dashboard: DashboardProps, filterToModify: F
  * ```ts
  * const existingDashboard: DashboardProps = {...};
  * const filterToRemove: Filter = {...};
- * const updatedDashboard = removeFilter(existingDashboard, filterToRemove);
+ * const updatedDashboard = dashboardHelpers.removeFilter(existingDashboard, filterToRemove);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) from which to remove the filter.
  * @param filterToRemove - The filter to be removed.
@@ -112,7 +112,7 @@ export declare const removeFilter: (dashboard: DashboardProps, filterToRemove: F
  * ```ts
  * const existingDashboard: DashboardProps = {...};
  * const filtersToRemove: Filter[] = [{...}, {...}, ...];
- * const updatedDashboard = removeFilters(existingDashboard, filtersToRemove);
+ * const updatedDashboard = dashboardHelpers.removeFilters(existingDashboard, filtersToRemove);
  * ```
  * @param dashboard - The original dashboard (`DashboardProps`) from which the specified filters are removed.
  * @param filtersToRemove - An array of filters to remove.

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

@@ -2,4 +2,4 @@ export { DashboardById } from './dashboard-by-id';
 export { Dashboard } from './dashboard';
 export { useComposedDashboard, type ComposableDashboardProps, type UseComposedDashboardOptions, } from './use-composed-dashboard';
 export { useDashboardTheme, type DashboardThemeParams } from './use-dashboard-theme';
-export type { DashboardByIdProps, DashboardProps, DashboardLayoutOptions, DashboardStyleOptions, DashboardConfig, } from './types';
+export type { DashboardByIdProps, DashboardProps, DashboardLayoutOptions, DashboardStyleOptions, DashboardConfig, DashboardByIdConfig, DashboardFiltersPanelConfig, } from './types';