@sisense/sdk-ui 2.21.0 → 2.22.0

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

@@ -6,5 +6,5 @@ export * from './use-get-dashboard-models';
 export * from './dashboard-model';
 export * as dashboardModelTranslator from './dashboard-model-translator';
 export * from './use-dashboard-model/use-dashboard-model';
-export * from './use-dashboard-model/use-dashboard-model-reducer';
+export * from './use-dashboard-model/dashboard-model-reducer';
 export * from './use-dashboard-model/use-dashboard-persistence';

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/translate-dashboard-utils.d.ts

@@ -4,7 +4,7 @@ import { TabbersConfig } from '../../../domains/dashboarding/hooks/use-tabber';
 import { Panel, WidgetDto } from '../../../domains/widgets/components/widget-by-id/types';
 import { RestApi } from '../../../infra/api/rest-api';
 import { type CascadingFilterDto, DashboardDto, type FilterDto, type LayoutDto } from '../../../infra/api/types/dashboard-dto';
-import type { WidgetsOptions, WidgetsPanelColumnLayout } from './types';
+import type { SpecificWidgetOptions, WidgetsOptions, WidgetsPanelColumnLayout } from './types';
 export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
 export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
 export declare const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
@@ -20,6 +20,13 @@ export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetDto
     location: 'row' | 'column' | 'value';
 } | Measure, JtdTarget[]> | undefined;
 export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
+/**
+ * Applies {@link SpecificWidgetOptions} to a {@link WidgetDto}.
+ * Merges filtersOptions and jtdConfig into the DTO for persistence.
+ *
+ * @internal
+ */
+export declare function withSpecificWidgetOptions(widgetOptions?: SpecificWidgetOptions): (widgetDto: WidgetDto) => WidgetDto;
 export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersConfig;
 /**
  * Replace all shared formulas, which defined by id references, in the dashboard with their actual values.

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

@@ -74,13 +74,20 @@ export type DashboardId = string;
  *
  * For example, how common filters defined at the dashboard level should be applied to widgets.
  */
-export type WidgetsOptions = Record<WidgetId, {
+export type WidgetsOptions = Record<WidgetId, SpecificWidgetOptions>;
+/**
+ * Options for a specific widget
+ */
+export type SpecificWidgetOptions = {
+    /**
+     * Options for common filters defined at the dashboard level to be applied to certain widgets.
+     */
     filtersOptions?: CommonFiltersOptions;
     /**
      * Jump To Dashboard config for widgets.
      */
     jtdConfig?: JumpToDashboardConfig | JumpToDashboardConfigForPivot;
-}>;
+};
 /**
  * Style options for the dashboard.
  */

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/index.d.ts

@@ -0,0 +1,4 @@
+export * from './use-dashboard-model-reducer.js';
+export * from './persist-dashboard-model-middleware.js';
+export * from './types.js';
+export * from './utils.js';

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/persist-dashboard-model-middleware.d.ts

@@ -0,0 +1,13 @@
+import { RestApi } from '../../../../../infra/api/rest-api';
+import { UseDashboardModelInternalAction } from './types.js';
+/**
+ * Middleware that persists the dashboard model changes to the Sisense server.
+ *
+ * @param dashboardOid - Dashboard OID, or undefined if not initialized
+ * @param action - Internal dashboard model action to persist
+ * @param restApi - Sisense REST API instance
+ * @param sharedMode - Whether the dashboard is in shared mode
+ * @returns Promise resolving to the action (possibly transformed, e.g. for ADD_WIDGET)
+ * @internal
+ */
+export declare function persistDashboardModelMiddleware(dashboardOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi, sharedMode: boolean): Promise<UseDashboardModelInternalAction>;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/{use-dashboard-model-reducer.d.ts → dashboard-model-reducer/types.d.ts}

@@ -1,7 +1,6 @@
 import { Filter, FilterRelations } from '@sisense/sdk-data';
-import { DashboardModel, WidgetsPanelLayout } from '../../../../domains/dashboarding/dashboard-model';
-import { WidgetModel } from '../../../../domains/widgets/widget-model';
-import { RestApi } from '../../../../infra/api/rest-api';
+import { DashboardModel, SpecificWidgetOptions, WidgetsPanelLayout } from '../../../../../domains/dashboarding/dashboard-model';
+import { WidgetModel } from '../../../../../domains/widgets/widget-model';
 export type UseDashboardModelState = DashboardModel | null;
 /**
  * Internal action types for the dashboard model state used in {@link useDashboardModel}.
@@ -55,12 +54,23 @@ export type UseDashboardModelFilterUpdateAction = {
 };
 /**
  * Add widget action for the dashboard model state used in {@link useDashboardModel}.
+ * If widgetsPanelLayout is not provided, the widget will be appended to the first cell of the first column.
  *
- * @internal
+ * WidgetModel plain payload will be deprecated in the future.
+ * Instead, use the following payload:
+ * {
+ *   widget: WidgetModel;
+ *   widgetsPanelLayout?: WidgetsPanelLayout;
+ *   widgetOptions?: SpecificWidgetOptions;
+ * }
  */
 export type UseDashboardModelAddWidgetAction = {
     type: UseDashboardModelActionType.ADD_WIDGET;
-    payload: WidgetModel;
+    payload: WidgetModel | {
+        widget: WidgetModel;
+        widgetsPanelLayout?: WidgetsPanelLayout;
+        widgetOptions?: SpecificWidgetOptions;
+    };
 };
 /**
  * Layout update action for the dashboard model state used in {@link useDashboardModel}.
@@ -72,7 +82,9 @@ export type UseDashboardModelLayoutUpdateAction = {
     payload: WidgetsPanelLayout;
 };
 /**
- * Layout update action for the dashboard model state used in {@link useDashboardModel}.
+ * Widgets delete action for the dashboard model state used in {@link useDashboardModel}.
+ * {@link UseDashboardWidgetsDeleteAction} is dispatched with
+ * {@link UseDashboardModelActionType.WIDGETS_DELETE}.
  *
  * @internal
  */
@@ -80,33 +92,4 @@ export type UseDashboardWidgetsDeleteAction = {
     type: UseDashboardModelActionType.WIDGETS_DELETE;
     payload: string[];
 };
-/**
- * Reducer for the dashboard model state used in {@link useDashboardModel}.
- *
- * @param state
- * @param action
- * @internal
- */
-export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
-/**
- * Translates filters and relations to DTOs.
- *
- * @param filtersOrFilterRelations - The filters or filter relations to translate
- * @returns The translated filters and relations DTOs for Fusion
- * @internal
- */
-export declare function translateFiltersAndRelationsToDto(filtersOrFilterRelations: Filter[] | FilterRelations): {
-    filters: (import("../../../../infra/api/types/dashboard-dto").FilterDto | import("../../../../infra/api/types/dashboard-dto").CascadingFilterDto)[];
-    filterRelations: {
-        datasource: string;
-        filterRelations: import("@sisense/sdk-data").FilterRelationsModelNode;
-    }[] | undefined;
-};
-/**
- * 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(dashboardOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi, sharedMode: boolean): Promise<UseDashboardModelInternalAction>;
+export type AddWidgetPayload = UseDashboardModelAddWidgetAction['payload'];

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

@@ -0,0 +1,9 @@
+import { UseDashboardModelInternalAction, UseDashboardModelState } from './types.js';
+/**
+ * Reducer for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @param state
+ * @param action
+ * @internal
+ */
+export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/utils.d.ts

@@ -0,0 +1,28 @@
+import { Filter, FilterRelations } from '@sisense/sdk-data';
+import { SpecificWidgetOptions, WidgetsPanelLayout } from '../../../../../domains/dashboarding/dashboard-model';
+import { WidgetModel } from '../../../../../domains/widgets/widget-model';
+import { AddWidgetPayload } from './types.js';
+/**
+ * Translates filters and relations to DTOs.
+ *
+ * @param filtersOrFilterRelations - The filters or filter relations to translate
+ * @returns The translated filters and relations DTOs for Fusion
+ * @internal
+ */
+export declare function translateFiltersAndRelationsToDto(filtersOrFilterRelations: Filter[] | FilterRelations): {
+    filters: (import("../../../../../infra/api/types/dashboard-dto.js").FilterDto | import("../../../../../infra/api/types/dashboard-dto.js").CascadingFilterDto)[];
+    filterRelations: {
+        datasource: string;
+        filterRelations: import("@sisense/sdk-data").FilterRelationsModelNode;
+    }[] | undefined;
+};
+export declare function parseAddWidgetPayload(payload: AddWidgetPayload): {
+    widget: WidgetModel;
+    widgetsPanelLayout?: WidgetsPanelLayout;
+    widgetOptions?: SpecificWidgetOptions;
+};
+/**
+ * Appends a widget cell to the first column's first row. Creates row/cells if missing.
+ * Returns a new layout (immutable) or the original when no columns exist.
+ */
+export declare function appendWidgetToFirstCell(layout: WidgetsPanelLayout | undefined, widgetId: string): WidgetsPanelLayout | undefined;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/use-dashboard-persistence.d.ts

@@ -1,5 +1,5 @@
 import { DashboardModel } from '../../../../domains/dashboarding/dashboard-model';
-import { UseDashboardModelAction } from './use-dashboard-model-reducer';
+import { UseDashboardModelAction, UseDashboardModelInternalAction } from './dashboard-model-reducer';
 export interface UseDashboardPersistenceParams {
     /**
      * The dashboard model to manage persistence for
@@ -25,10 +25,10 @@ export interface UseDashboardPersistenceResult {
      */
     dashboard: DashboardModel | null;
     /**
-     * Function to dispatch changes to the dashboard model with optional persistence
-     * Returns a promise when persistence is enabled to allow error handling
+     * Function to dispatch changes to the dashboard model with optional persistence.
+     * Returns a promise that resolves to the processed (or transformed) action.
      */
-    dispatchChanges: (action: UseDashboardModelAction) => Promise<void> | void;
+    dispatchChanges: (action: UseDashboardModelAction) => Promise<UseDashboardModelInternalAction>;
 }
 /**
  * Hook that provides persistence capabilities for an already loaded dashboard model.

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/duplicate-widget/duplicate-widget-utils.d.ts

@@ -0,0 +1,34 @@
+import type { WidgetsPanelLayout } from '../../../../domains/dashboarding/dashboard-model/types.js';
+/**
+ * Location of a widget cell within the layout structure.
+ */
+export type WidgetCellLocation = {
+    columnIndex: number;
+    rowIndex: number;
+    cellIndex: number;
+};
+/**
+ * Finds the location of a widget cell in the layout.
+ *
+ * @param layout - The widgets panel layout.
+ * @param widgetId - The ID of the widget to find.
+ * @returns The cell location, or undefined if not found.
+ */
+export declare const getWidgetCellLocation: (layout: Readonly<WidgetsPanelLayout>, widgetId: string) => WidgetCellLocation | undefined;
+/**
+ * Transformer: Inserts a new cell into the same row as the original cell.
+ * Splits the original cell's widthPercentage in half: original and new cell each get 50%.
+ *
+ * @param originalCellLocation - The location of the original cell.
+ * @param newWidgetId - The ID of the new widget.
+ * @returns A pure transformer that produces the updated layout.
+ */
+export declare const withNewCellInsertedToTheSameRow: (originalCellLocation: WidgetCellLocation, newWidgetId: string) => (layout: Readonly<WidgetsPanelLayout>) => WidgetsPanelLayout;
+/**
+ * Transformer: Replaces a widget ID with another in all cells of the layout.
+ *
+ * @param oldWidgetId - The widget ID to replace.
+ * @param newWidgetId - The new widget ID.
+ * @returns A pure transformer that produces the updated layout (immutable).
+ */
+export declare const withReplacedWidgetId: (oldWidgetId: string, newWidgetId: string) => (layout: Readonly<WidgetsPanelLayout>) => WidgetsPanelLayout;

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/duplicate-widget/index.d.ts

@@ -0,0 +1,2 @@
+export { getWidgetCellLocation, withNewCellInsertedToTheSameRow, withReplacedWidgetId, type WidgetCellLocation, } from './duplicate-widget-utils.js';
+export { useDuplicateWidgetMenuItem, type UseDuplicateWidgetMenuItemParams, type DuplicateWidgetMiddlewareOutput, } from './use-duplicate-widget-menu-item.js';

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/duplicate-widget/use-duplicate-widget-menu-item.d.ts

@@ -0,0 +1,57 @@
+/// <reference types="react" />
+import type { WidgetsOptions, WidgetsPanelLayout } from '../../../../domains/dashboarding/dashboard-model/types.js';
+import { type WidgetProps } from '../../../../domains/widgets/components/widget/types.js';
+import type { DashboardPersistenceManager } from '../../types.js';
+/** Setter for widgets array (e.g. React setState or updater function). */
+export type SetWidgets = React.Dispatch<React.SetStateAction<WidgetProps[]>>;
+/** Setter for widgets options array (e.g. React setState or updater function). */
+export type SetWidgetsOptions = React.Dispatch<React.SetStateAction<WidgetsOptions>>;
+/** Setter for widgets panel layout. */
+export type SetWidgetsLayout = (newLayout: WidgetsPanelLayout) => void;
+/** Options for the duplicate widget middleware hook. */
+export type UseDuplicateWidgetMenuItemParams = {
+    /** Current widgets. */
+    widgets: WidgetProps[];
+    /** Setter to update widgets (e.g. from parent state). */
+    setWidgets: SetWidgets;
+    /** Current widgets panel layout. */
+    widgetsLayout: WidgetsPanelLayout;
+    /** Setter to update widgets layout (e.g. from parent state). */
+    setWidgetsLayout: SetWidgetsLayout;
+    /** When false, returns widgets unchanged (no menu item added). */
+    enabled?: boolean;
+    /** Dashboard-level widget options (applied to cloned widget when persisting). */
+    widgetsOptions?: WidgetsOptions;
+    /** Setter to update widgets options (e.g. from parent state). */
+    setWidgetsOptions: SetWidgetsOptions;
+    persistence?: Pick<DashboardPersistenceManager, 'addWidget'>;
+};
+/** Output of the duplicate widget middleware. */
+export type DuplicateWidgetMiddlewareOutput = {
+    widgets: WidgetProps[];
+};
+/**
+ * Middleware hook that adds a "Duplicate widget" header menu item to each widget.
+ * On click, clones the widget and updates the layout (inserts new cell in the same row).
+ *
+ * @param options - Options containing widgets, layout, setters, and enabled flag.
+ * @returns Updated props with widgets augmented with the duplicate menu item (or unchanged when disabled).
+ *
+ * @example
+ * ```ts
+ * const [widgets, setWidgets] = useSyncedState(initialWidgets);
+ * const [widgetsLayout, setWidgetsLayout] = useSyncedState(initialLayout);
+ * const { widgets: widgetsWithDuplicate, widgetsLayout: widgetsLayoutWithDuplicate } = useDuplicateWidgetMenuItem({
+ *   widgets,
+ *   setWidgets,
+ *   widgetsLayout,
+ *   setWidgetsLayout,
+ *   enabled: true,
+ * });
+ * const { layout: widgetsLayout, setLayout: setWidgetsLayout } = useWidgetsLayoutManagement({
+ *   layout: widgetsLayoutWithDuplicate,
+ *   layoutManagers: [tabberLayoutManager],
+ * });
+ * ```
+ */
+export declare function useDuplicateWidgetMenuItem(params: UseDuplicateWidgetMenuItemParams): DuplicateWidgetMiddlewareOutput;

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

@@ -1,10 +1,10 @@
 import { ReactNode } from 'react';
 import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
-import { DashboardStyleOptions, WidgetsOptions, WidgetsPanelLayout } from '../../domains/dashboarding/dashboard-model';
+import { DashboardStyleOptions, SpecificWidgetOptions, WidgetsOptions, WidgetsPanelLayout } from '../../domains/dashboarding/dashboard-model';
 import { TabbersConfig } from '../../domains/dashboarding/hooks/use-tabber';
 import { FiltersPanelConfig } from '../../domains/filters/components/filters-panel/types';
 import { WidgetProps } from '../../domains/widgets/components/widget/types';
-export type { DashboardStyleOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetsPanelCell, WidgetsPanelRow, WidgetsPanelColumn, } from '../../domains/dashboarding/dashboard-model';
+export type { DashboardStyleOptions, SpecificWidgetOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetsPanelCell, WidgetsPanelRow, WidgetsPanelColumn, } from '../../domains/dashboarding/dashboard-model';
 export type { TabbersConfig, TabberConfig, TabberTabConfig, } from '../../domains/dashboarding/hooks/use-tabber';
 /**
  * Event triggered when dashboard filters are updated.
@@ -217,6 +217,23 @@ export interface EditModeConfig {
      * @default true
      */
     showDragHandleIcon?: boolean;
+    /**
+     * Configuration for the widget duplication feature.
+     *
+     * @internal
+     */
+    duplicateWidget?: {
+        /**
+         * When `true`, adds a "Duplicate widget" menu item to each widget header.
+         * On click, clones the widget and updates the layout.
+         * Only has effect when edit mode is also enabled (`editMode.enabled`) and batch mode is disabled (`editMode.applyChangesAsBatch.enabled`).
+         * If batch mode is enabled, "Duplicate widget" menu item won't be applied because it would not be possible to undo/redo the duplication.
+         *
+         * If not specified, the default value is `false`.
+         * @internal
+         */
+        enabled: boolean;
+    };
 }
 /**
  * Dashboard configuration
@@ -278,6 +295,26 @@ export interface DashboardLayoutOptions {
      */
     widgetsPanel?: WidgetsPanelLayout;
 }
+/**
+ * Interface for persisting dashboard changes from the composition layer (e.g. add widget).
+ *
+ * @internal
+ */
+export type DashboardPersistenceManager = {
+    /**
+     * Adds a widget to the dashboard.
+     *
+     * @param widget - The widget to add.
+     * @param widgetsPanelLayout - The layout to add the widget to.
+     * @param widgetOptions - The options for the widget.
+     * @returns The persisted widget (possibly modified by the server, e.g. new id), the new widgets panel layout and the widget options.
+     */
+    addWidget: (widget: WidgetProps, widgetsPanelLayout: WidgetsPanelLayout, widgetOptions?: SpecificWidgetOptions) => Promise<{
+        widget: WidgetProps;
+        widgetsPanelLayout: WidgetsPanelLayout;
+        widgetOptions?: SpecificWidgetOptions;
+    }>;
+};
 /**
  * Props for the Dashboard component
  */
@@ -317,6 +354,10 @@ export interface DashboardProps {
      * @param event The event that occurred
      */
     onChange?: (event: DashboardChangeEvent) => void;
+    /**
+     * @internal
+     */
+    persistence?: DashboardPersistenceManager;
 }
 /**
  * Props for the Dashboard Header component

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

@@ -1,12 +1,24 @@
 import { Filter, FilterRelations } from '@sisense/sdk-data';
-import { WidgetsPanelLayout } from '../../domains/dashboarding/dashboard-model';
-import { DashboardProps } from './types.js';
+import type { WidgetsPanelLayout } from '../../domains/dashboarding/dashboard-model';
+import { DashboardPersistenceManager, DashboardProps } from './types.js';
 export type ComposableDashboardProps = Pick<DashboardProps, 'filters' | 'widgets' | 'widgetsOptions' | 'layoutOptions' | 'config'>;
 export type UseComposedDashboardOptions = {
     /**
      * @internal
      */
     onFiltersChange?: (filters: Filter[] | FilterRelations) => void;
+    /**
+     * @internal
+     */
+    persistence?: DashboardPersistenceManager;
+    /**
+     * Runtime edit mode state. When provided (e.g. by Dashboard), used for duplicate-widget visibility
+     * instead of only config.widgetsPanel.editMode.isEditing.
+     * @internal
+     *
+     * @deprecated Temporal workaround. Edit mode (with history management) should be managed by the `useComposedDashboard` hook instead of the Dashboard component.
+     */
+    isEditing?: boolean;
 };
 /**
  * Result of the {@link useComposedDashboard} hook.
@@ -24,7 +36,7 @@ export type ComposedDashboardResult<D extends ComposableDashboardProps | Dashboa
  *
  * @internal
  */
-export declare function useComposedDashboardInternal<D extends ComposableDashboardProps | DashboardProps>(initialDashboard: D, { onFiltersChange }?: UseComposedDashboardOptions): ComposedDashboardResult<D>;
+export declare function useComposedDashboardInternal<D extends ComposableDashboardProps | DashboardProps>(initialDashboard: D, { onFiltersChange, persistence, isEditing: isEditingRuntime }?: UseComposedDashboardOptions): ComposedDashboardResult<D>;
 /**
  * React hook that takes in separate dashboard elements and
  * composes them into a coordinated dashboard with change detection, cross filtering, and drill down.

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

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { DataSource, Filter } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
+import type { FilterTileConfig } from '../filter-tile/types.js';
 /**
  * Props for {@link CascadingFilterTile}
  *
@@ -23,6 +24,12 @@ export interface CascadingFilterTileProps {
     onDelete?: () => void;
     /** Filter edit callback */
     onEdit?: (levelIndex: number) => void;
+    /**
+     * Config for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title (first cascading level filter only)
      *

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

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { DataSource, Filter } from '@sisense/sdk-data';
+import { MenuItem } from '../../../../shared/types/menu-item.js';
 /**
  * Props of the {@link CascadingLevelFilterTile} component
  *
@@ -21,6 +22,8 @@ export type CascadingLevelFilterTileProps = {
     onEdit?: () => void;
     /** Whether the filter is the last in the list */
     isLast?: boolean;
+    /** Menu items to be displayed in the cascading level filter header */
+    menuItems: MenuItem[];
     /**
      * Render header title
      *
@@ -33,4 +36,4 @@ export type CascadingLevelFilterTileProps = {
  *
  * @internal
  */
-export declare const CascadingLevelFilterTile: ({ filter, dataSource, parentFilters, onChange, isLast, onEdit, renderHeaderTitle, }: CascadingLevelFilterTileProps) => import("react/jsx-runtime").JSX.Element;
+export declare const CascadingLevelFilterTile: ({ filter, dataSource, parentFilters, onChange, isLast, onEdit, menuItems, renderHeaderTitle, }: CascadingLevelFilterTileProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/domains/filters/components/cascading-filter-tile/use-cascadding-filter-tile-menu-items/use-cascadding-filter-tile-lock-menu-item.d.ts

@@ -0,0 +1,13 @@
+import type { MenuItem } from '../../../../../shared/types/menu-item';
+/**
+ * Builds the lock menu item for the cascading filter tile.
+ *
+ * @param locked - Current lock state
+ * @param onLockToggle - Handler for lock toggle
+ * @returns Filter tile lock menu item
+ * @internal
+ */
+export declare function useCascadingFilterTileLockMenuItem({ locked, onLockToggle, }: {
+    locked: boolean;
+    onLockToggle: () => void;
+}): MenuItem;

package/dist/packages/sdk-ui/src/domains/filters/components/cascading-filter-tile/use-cascadding-filter-tile-menu-items/use-cascadding-filter-tile-menu-items.d.ts

@@ -0,0 +1,14 @@
+import { type CascadingFilter } from '@sisense/sdk-data';
+import type { MenuItem } from '../../../../../shared/types/menu-item';
+import type { FilterTileConfig } from '../../../components/filter-tile/types';
+/**
+ * Builds the menu items list for a cascading filter tile,
+ * conditionally prepending them based on config.
+ *
+ * @param filter - The current filter
+ * @param config - Filter tile configuration
+ * @param onChange - Callback invoked when the filter changes (e.g., lock toggle)
+ * @returns Filter tile menu items
+ * @internal
+ */
+export declare function useCascadingFilterTileMenuItems(filter: CascadingFilter, config: FilterTileConfig | undefined, onChange: ((filter: CascadingFilter) => void) | undefined): MenuItem[];

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

@@ -2,6 +2,7 @@
 import { Filter, Measure } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
 import { FilterTileDesignOptions } from '../filter-tile-container.js';
+import type { FilterTileConfig } from '../filter-tile/types.js';
 /**
  * Props of the {@link CriteriaFilterTile} component.
  */
@@ -26,6 +27,12 @@ export interface CriteriaFilterTileProps {
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;
+    /**
+     * Config for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title
      *

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

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { Filter } from '@sisense/sdk-data';
+import type { FilterTileConfig } from '../../../domains/filters/components/filter-tile/types';
 import { FilterTileDesignOptions } from './filter-tile-container';
 /**
  * Props for {@link CustomFilterTile}
@@ -21,6 +22,12 @@ export interface CustomFilterTileProps {
     onEdit?: () => void;
     /** Design options for the tile @internal */
     tileDesignOptions?: FilterTileDesignOptions;
+    /**
+     * Config for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title
      *

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

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { DataSource, Filter, LevelAttribute } from '@sisense/sdk-data';
 import { FilterTileDesignOptions } from '../../filter-tile-container';
+import type { FilterTileConfig } from '../../filter-tile/types';
 /**
  * Props of the {@link DateRangeFilterTile} component.
  */
@@ -62,6 +63,12 @@ export interface DateRangeFilterTileProps {
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;
+    /**
+     * Config for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title
      *

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

@@ -2,6 +2,7 @@
 import { Filter } from '@sisense/sdk-data';
 import { FilterVariant } from '../../common/index.js';
 import { FilterTileDesignOptions } from '../../filter-tile-container.js';
+import type { FilterTileConfig } from '../../filter-tile/types.js';
 /**
  * Props of the {@link RelativeDateFilterTile} component.
  */
@@ -35,6 +36,12 @@ export interface RelativeDateFilterTileProps {
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;
+    /**
+     * Config for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title
      *

package/dist/packages/sdk-ui/src/domains/filters/components/{filter-tile.d.ts → filter-tile/filter-tile.d.ts}

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { DataSource, Filter } from '@sisense/sdk-data';
+import { FilterTileConfig } from './types.js';
 /**
  * Props of the {@link FilterTile} component
  *
@@ -17,6 +18,12 @@ export interface FilterTileProps {
     levelIndex?: number) => void;
     /** Default data source used for filter tiles */
     defaultDataSource?: DataSource;
+    /**
+     * Configurations for the filter tile
+     *
+     * @internal
+     */
+    config?: FilterTileConfig;
     /**
      * Render header title
      *

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

@@ -0,0 +1 @@
+export { FilterTile, type FilterTileProps } from './filter-tile.js';

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

@@ -0,0 +1,36 @@
+import { MenuItem } from '../../../../shared/types/menu-item';
+/**
+ * Configuration for the filter tile.
+ */
+export type FilterTileConfig = {
+    /**
+     * Configurations for the filter tile header.
+     */
+    header?: {
+        /**
+         * Configurations for the filter tile header menu.
+         */
+        menu?: {
+            /**
+             * List of menu items to be injected into the filter tile header.
+             */
+            items?: MenuItem[];
+        };
+    };
+    /**
+     * Configures the available actions within the filter tile.
+     */
+    actions?: {
+        /**
+         * Configuration for locking a filter.
+         */
+        lockFilter?: {
+            /**
+             * Determines whether the possibility to lock a filter is enabled.
+             *
+             * If not specified, the default value is `false`.
+             */
+            enabled?: boolean;
+        };
+    };
+};