@sisense/sdk-ui 2.3.0 → 2.4.0

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

@@ -79,7 +79,7 @@ export interface NlqResponseData extends ExpandedQueryModel {
     /** The response message for the chat  */
     userMsg: string;
     /** @internal */
-    clarification: string;
+    clarification?: string;
 }
 export interface NlqResponse {
     data: NlqResponseData;

package/dist/packages/sdk-ui/src/ai/common/icon-button.d.ts

@@ -5,7 +5,7 @@ interface IconButtonProps extends MuiIconButtonProps {
 }
 declare const IconButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "loading" | "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
+}, "loading" | "children" | "disabled" | "size" | "className" | "style" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
     theme?: import("@emotion/react").Theme | undefined;
 } & IconButtonProps, {}, {}>;
 export default IconButton;

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

@@ -12,7 +12,7 @@ type ExtraWidgetCodeProps = {
     componentString: string;
     extraImportsString: string;
     idString?: string;
-    widgetTypeString?: 'chart' | 'pivot' | 'text' | 'plugin';
+    widgetTypeString?: 'chart' | 'pivot' | 'text' | 'custom';
 };
 /** @internal */
 export type KeysOfUnion<T> = T extends T ? keyof T : never;
@@ -240,7 +240,7 @@ export type TemplateKeyMapByWidgetType = {
     chart: CodeTemplateKey;
     pivot: CodeTemplateKey;
     text?: CodeTemplateKey;
-    plugin?: CodeTemplateKey;
+    custom?: CodeTemplateKey;
 };
 /** TYPE FOR DASHBOARD CODE */
 /**

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

@@ -13,6 +13,7 @@ type GetDashboardsOptions = {
 };
 type GetDashboardOptions = {
     fields?: string[];
+    sharedMode?: boolean;
 };
 export declare class RestApi {
     private httpClient;
@@ -42,11 +43,11 @@ export declare class RestApi {
     /**
      * Get all widgets of a specific dashboard
      */
-    getDashboardWidgets: (dashboardOid: string) => Promise<WidgetDto[] | undefined>;
+    getDashboardWidgets: (dashboardOid: string, sharedMode?: boolean) => Promise<WidgetDto[] | undefined>;
     /**
      * Get a specific widget from a dashboard
      */
-    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto | undefined>;
+    getWidget: (widgetOid: string, dashboardOid: string, sharedMode?: boolean) => Promise<WidgetDto | undefined>;
     /**
      * Get a GeoJSON data for all countries
      */
@@ -66,11 +67,15 @@ export declare class RestApi {
     /**
      * Partially update a dashboard
      */
-    patchDashboard: (dashboardOid: string, dashboard: Partial<DashboardDto>) => Promise<DashboardDto | undefined>;
+    patchDashboard: (dashboardOid: string, dashboard: Partial<DashboardDto>, sharedMode?: boolean) => Promise<DashboardDto | undefined>;
     /**
      * Add widget to a dashboard
      */
-    addWidgetToDashboard: (dashboardOid: string, widgetDto: WidgetDto) => Promise<WidgetDto | undefined>;
+    addWidgetToDashboard: (dashboardOid: string, widgetDto: WidgetDto, sharedMode?: boolean) => Promise<WidgetDto | undefined>;
+    /**
+     * Delete widget from a dashboard
+     */
+    deleteWidgetFromDashboard: (dashboardOid: string, widgetOid: string, sharedMode?: boolean) => Promise<void | undefined>;
     /**
      * Get shared formulas by ids
      *

package/dist/packages/sdk-ui/src/app/client-application.d.ts

@@ -68,7 +68,7 @@ export type AppConfig = {
     /**
      * Configuration of the tabber widget
      *
-     * Set the `tabberConfig.enabled` property to `true` to enable the tabber widget support. Otherwise, the tabber widget will be treated as 'unknown plugin type'.
+     * Set the `tabberConfig.enabled` property to `true` to enable the tabber widget support. Otherwise, the tabber widget will be treated as 'unknown custom widget type'.
      * Only tabber widgets that are configured using the Fusion UI as documented [here](https://docs.sisense.com/main/SisenseLinux/tabber.htm#Creating) are supported.
      */
     tabberConfig?: {

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

@@ -4,6 +4,7 @@ type ButtonProps = {
     type?: 'primary' | 'secondary';
     disabled?: boolean;
     onClick?: () => void;
+    title?: string;
 };
 /** @internal */
 export declare const Button: (props: ButtonProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -4,4 +4,4 @@ import { ContextMenuProps } from '../../../../props';
  *
  * @group Drilldown
  */
-export declare const ContextMenu: ({ position, itemSections, children, closeContextMenu, }: ContextMenuProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ContextMenu: ({ position, itemSections, children, closeContextMenu, alignment, }: ContextMenuProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,10 +1,12 @@
 import { ReactNode } from 'react';
-import { MenuPosition } from '../../../../index';
+import { MenuPosition, MenuAlignment } from '../../../../index';
 type MenuProps = {
     children: ReactNode;
     open: boolean;
     position: MenuPosition | null;
     onClose: () => void;
+    /** @internal */
+    alignment?: MenuAlignment;
 };
-export declare const Menu: ({ children, open, position, onClose }: MenuProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Menu: ({ children, open, position, onClose, alignment }: MenuProps) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -0,0 +1,8 @@
+import { MouseEventHandler } from 'react';
+type MenuButtonProps = {
+    color?: string;
+    onClick?: MouseEventHandler<HTMLButtonElement>;
+    ariaLabel?: string;
+};
+export declare const MenuButton: ({ color, onClick, ariaLabel, ...restProps }: MenuButtonProps) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -1,10 +1,12 @@
-import { MenuPosition, MenuItemSection } from '../../../types';
+import { MenuPosition, MenuItemSection, MenuAlignment } from '../../../types';
 export type MenuOptions = {
     /** @internal */
     readonly id?: string;
     position: MenuPosition;
     itemSections: MenuItemSection[];
     onClose?: () => void;
+    /** @internal */
+    alignment?: MenuAlignment;
 };
 /** @internal */
 export type BeforeMenuOpenHandler = (options: MenuOptions) => MenuOptions | null;

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

@@ -4,6 +4,11 @@ type PopperProps = {
     open: boolean;
     anchorEl: HTMLElement | null;
     style?: React.CSSProperties;
+    /**
+     * If true, the click event will not be propagated to the parent elements outside of the popper.
+     * Useful for React to Preact compatibility issues related to different event handling mechanisms - virtual DOM vs real DOM.
+     */
+    preventClickPropagation?: boolean;
 };
-export declare const Popper: ({ children, open, anchorEl, style }: PopperProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Popper: ({ children, open, anchorEl, style, preventClickPropagation, }: PopperProps) => import("react/jsx-runtime").JSX.Element;
 export {};

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

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

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

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

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { CustomWidgetComponent } from './types';
+/**
+ * Context for custom widgets.
+ *
+ * @internal
+ */
+export declare const CustomWidgetsContext: import("react").Context<Map<string, CustomWidgetComponent<any>> | null>;

package/dist/packages/sdk-ui/src/custom-widgets-provider/custom-widgets-provider-adapter.d.ts

@@ -0,0 +1,17 @@
+import { PropsWithChildren } from 'react';
+import { CustomWidgetComponent, CustomWidgetComponentProps } from './types.js';
+import { CustomContextProviderProps } from '../types.js';
+/** @internal */
+export type CustomWidgetsProviderAdapterProps = CustomContextProviderProps<CustomWidgetsContextAdapter<CustomWidgetComponentProps>>;
+/** @internal */
+export type CustomWidgetsContextAdapter<T = CustomWidgetComponentProps> = {
+    customWidgetsMap: Map<string, CustomWidgetComponent<T>>;
+};
+/**
+ * Custom Widget Provider Adapter component that allows passing external custom widgets context.
+ *
+ * Note: it is designed to serve as a bridge for passing pre-initialized custom widget data between an external wrapper and child React components.
+ *
+ * @internal
+ */
+export declare const CustomWidgetsProviderAdapter: React.FC<PropsWithChildren<CustomWidgetsProviderAdapterProps>>;

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

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+/**
+ * Custom Widget Provider component that allows registering and accessing custom widgets.
+ *
+ * @internal
+ */
+export declare const CustomWidgetsProvider: React.FC<{
+    children: ReactNode;
+}>;

package/dist/packages/sdk-ui/src/custom-widgets-provider/index.d.ts

@@ -0,0 +1,6 @@
+export * from './custom-widgets-provider';
+export * from './custom-widgets-provider-adapter';
+export * from './custom-widgets-context';
+export * from './types';
+export * from './use-execute-custom-widget-query';
+export * from './use-custom-widgets';

package/dist/packages/sdk-ui/src/custom-widgets-provider/types.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import { GenericDataOptions } from '../types';
+/**
+ * Props passed to a user-defined custom widget component.
+ */
+export interface CustomWidgetComponentProps<DataOptions = GenericDataOptions, StyleOptions = any> {
+    dataSource?: DataSource;
+    dataOptions: DataOptions;
+    styleOptions: StyleOptions;
+    filters?: Filter[] | FilterRelations;
+    highlights?: Filter[];
+    description?: string;
+}
+/**
+ * A user-defined custom widget component. This is can be specified when registering a
+ * custom widget with `registerCustomWidget` from the `useCustomWidgets` hook.
+ */
+export type CustomWidgetComponent<Props = CustomWidgetComponentProps> = (props: Props) => ReactNode;

package/dist/packages/sdk-ui/src/custom-widgets-provider/use-custom-widgets.d.ts

@@ -0,0 +1,25 @@
+import { CustomWidgetComponent } from './types';
+/**
+ * Hook that provides API for configuring custom widgets.
+ *
+ * @example
+ * Example of registering a custom widget in a dashboard:
+ * ```tsx
+ * import { useCustomWidgets, DashboardById } from '@sisense/sdk-ui';
+ * import CustomHistogramWidget from './custom-histogram-widget';
+ *
+ * const Example = () => {
+ *   const { registerCustomWidget } = useCustomWidgets();
+ *   registerCustomWidget('histogramwidget', CustomHistogramWidget);
+ *
+ *   return <DashboardById dashboardOid="your-dashboard-oid" />;
+ * }
+ * ```
+ *
+ * @group Dashboards
+ */
+export declare const useCustomWidgets: () => {
+    registerCustomWidget: <T = any>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+    hasCustomWidget: (customWidgetType: string) => boolean;
+    getCustomWidget: (customWidgetType: string) => CustomWidgetComponent<any> | undefined;
+};

package/dist/packages/sdk-ui/src/custom-widgets-provider/use-execute-custom-widget-query.d.ts

@@ -0,0 +1,35 @@
+import { Attribute, Measure } from '@sisense/sdk-data';
+import { GenericDataOptions } from '../types';
+import { CustomWidgetComponentProps } from './types';
+import { ExecuteQueryParams, QueryState } from '../query-execution/types';
+import { HookEnableParam } from '../common/hooks/types';
+/**
+ * State of a query execution retrieving data of a custom widget.
+ */
+export type CustomWidgetQueryState = QueryState;
+/**
+ * Parameters for executing a query for a custom widget.
+ */
+export interface ExecuteCustomWidgetQueryParams extends CustomWidgetComponentProps, HookEnableParam, Pick<ExecuteQueryParams, 'onBeforeQuery' | 'count' | 'offset' | 'ungroup'> {
+}
+/**
+ * Utility function for converting data options to parameters for executing a query.
+ *
+ * @group Dashboards
+ */
+export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOptions): {
+    dimensions: Attribute[];
+    measures: Measure[];
+};
+/**
+ * {@link useExecuteCustomWidgetQuery} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useExecuteCustomWidgetQueryInternal({ dataSource, dataOptions, filters, highlights, count, offset, ungroup, onBeforeQuery, }: ExecuteCustomWidgetQueryParams): CustomWidgetQueryState;
+/**
+ * React hook that takes a custom widget component's props and executes a data query.
+ *
+ * @group Queries
+ */
+export declare const useExecuteCustomWidgetQuery: (args_0: ExecuteCustomWidgetQueryParams) => QueryState;

package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/components/draggable-widget-wrapper.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
 import { EditableLayoutDragData } from '../../../../dashboard/components/editable-layout/types';
+import { ReactNode } from 'react';
 /**
  * Props for the DraggableWidgetWrapper component
  *
@@ -17,12 +17,21 @@ type DraggableWidgetWrapperProps = {
     /**
      * The child elements to render inside the wrapper
      */
-    children: React.ReactNode;
+    children: (withDragHandle: (element: ReactNode) => ReactNode) => ReactNode;
+    /**
+     * Options for drag handle
+     */
+    dragHandleOptions?: {
+        icon?: {
+            visible?: boolean;
+            color?: string;
+        };
+    };
 };
 /**
  * Renders a draggable widget wrapper component that allows for drag and drop operations.
  *
  * @internal
  */
-export declare const DraggableWidgetWrapper: ({ id, data, children }: DraggableWidgetWrapperProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DraggableWidgetWrapper: ({ id, data, children, dragHandleOptions, }: DraggableWidgetWrapperProps) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -18,6 +18,17 @@ export interface EditableLayoutProps {
      * A callback function that is called when the layout changes.
      */
     onLayoutChange?: (layout: WidgetsPanelLayout) => void;
+    /**
+     * The configuration for the editable layout.
+     */
+    config?: {
+        /**
+         * Flag indicating whether the drag handle icon is visible.
+         *
+         * @default true
+         */
+        showDragHandleIcon?: boolean;
+    };
 }
 /**
  * A React used to render a layout of widgets that can resize and rearrange their positions using drag-and-drop.
@@ -25,4 +36,4 @@ export interface EditableLayoutProps {
  * @param props - {@link EditableLayoutProps}
  * @internal
  */
-export declare const EditableLayout: ({ layout, widgets, onLayoutChange }: EditableLayoutProps) => import("react/jsx-runtime").JSX.Element;
+export declare const EditableLayout: ({ layout, widgets, onLayoutChange, config, }: EditableLayoutProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,4 @@
-import { WidgetsPanelColumn, WidgetsPanelColumnLayout, WidgetsPanelLayout } from '../../../models';
+import { WidgetsPanelColumn, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetsPanelRow } from '../../../models';
 import { EditableLayoutDropData, EditableLayoutDragData } from './types';
 /**
  * Updates the height of all cells in a specific row within a column layout.
@@ -28,6 +28,62 @@ export declare function updateRowHeight(layout: WidgetsPanelColumnLayout, height
  * @internal
  */
 export declare function updateLayoutWidths(layout: WidgetsPanelLayout, widths: number[], parentColumnIndex?: number, parentRowIndex?: number): WidgetsPanelColumnLayout;
+/**
+ * Deletes a widget from a layout.
+ *
+ * @param layout - The current layout to modify
+ * @param columnIndex - Index of the column containing the widget
+ * @param rowIndex - Index of the row containing the widget
+ * @param widgetId - ID of the widget to delete
+ *
+ * @returns A new layout with the widget removed
+ *
+ * @internal
+ */
+export declare function deleteWidgetFromLayout(layout: WidgetsPanelLayout, columnIndex: number, rowIndex: number, widgetId: string): {
+    columns: WidgetsPanelColumn[];
+};
+/**
+ * Deletes widgets from a layout.
+ *
+ * @param layout - The current layout to modify
+ * @param widgetIds - IDs of the widgets to delete
+ *
+ * @returns A new layout with the widgets removed
+ *
+ * @internal
+ */
+export declare function deleteWidgetsFromLayout(layout: WidgetsPanelLayout, widgetIds: string[]): {
+    columns: {
+        rows: WidgetsPanelRow[];
+        widthPercentage: number;
+    }[];
+};
+/**
+ * Finds widgets that were deleted from a layout.
+ *
+ * @param previousLayout - The previous layout
+ * @param newLayout - The new layout
+ *
+ * @returns An array of widget IDs that were deleted
+ *
+ * @internal
+ */
+export declare function findDeletedWidgetsFromLayout(previousLayout: WidgetsPanelLayout, newLayout: WidgetsPanelLayout): string[];
+/**
+ * Distributes equal width to all cells in a row.
+ *
+ * @param layout - The current layout to modify
+ * @param columnIndex - Index of the column containing the row
+ * @param rowIndex - Index of the row to distribute the width to
+ *
+ * @returns A new layout with the width distributed
+ *
+ * @internal
+ */
+export declare const distributeEqualWidthInRow: (layout: WidgetsPanelLayout, columnIndex: number, rowIndex: number) => {
+    columns: WidgetsPanelColumn[];
+};
 /**
  * Updates the layout based on drag and drop operations.
  *

package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/utils.d.ts

@@ -1,5 +1,18 @@
 import { EditableLayoutDragData, EditableLayoutDropData } from '../../../dashboard/components/editable-layout/types';
 import { DragStartEvent } from '@dnd-kit/core';
+import { RenderTitleHandler, RenderToolbarHandler } from '../../../types';
 export declare const isEditableLayoutDragData: (data: any | undefined) => data is EditableLayoutDragData;
 export declare const isEditableLayoutDropData: (data: any) => data is EditableLayoutDropData;
 export declare const getDraggingWidgetId: (event: DragStartEvent) => string | null;
+/**
+ * Compose multiple RenderToolbarHandler functions into one.
+ * Each handler gets a chance to modify the toolbar.
+ * If it returns `null`, the previous toolbar is passed to the next handler.
+ */
+export declare function composeToolbarHandlers(...handlers: (RenderToolbarHandler | undefined)[]): RenderToolbarHandler;
+/**
+ * Compose multiple RenderTitleHandler functions into one.
+ * Each handler gets a chance to modify the title.
+ * If it returns `null`, the previous tile is passed to the next handler.
+ */
+export declare function composeTitleHandlers(...handlers: (RenderTitleHandler | undefined)[]): RenderTitleHandler;

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

@@ -1,4 +1,12 @@
 import type { DeepRequired } from 'ts-essentials';
-import { DashboardByIdConfig, DashboardConfig } from './types';
-export declare const DEFAULT_DASHBOARD_CONFIG: DeepRequired<DashboardConfig>;
-export declare const DEFAULT_DASHBOARD_BY_ID_CONFIG: DeepRequired<DashboardByIdConfig>;
+import { DashboardByIdConfig, DashboardConfig, EditModeConfig, WidgetsPanelConfig } from './types';
+export declare const DEFAULT_DASHBOARD_CONFIG: DeepRequired<Omit<DashboardConfig, 'widgetsPanel'> & {
+    widgetsPanel: Omit<WidgetsPanelConfig, 'editMode'> & {
+        editMode: Omit<EditModeConfig, 'isEditing'>;
+    };
+}>;
+export declare const DEFAULT_DASHBOARD_BY_ID_CONFIG: DeepRequired<Omit<DashboardByIdConfig, 'widgetsPanel'> & {
+    widgetsPanel: Omit<WidgetsPanelConfig, 'editMode'> & {
+        editMode: Omit<EditModeConfig, 'isEditing'>;
+    };
+}>;

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

@@ -8,7 +8,11 @@ export declare enum DashboardChangeType {
     /** Filters panel collapsed state changed */
     UI_FILTERS_PANEL_COLLAPSE = "UI.FILTERS.PANEL.COLLAPSE",
     /** Widgets panel layout updated */
-    WIDGETS_PANEL_LAYOUT_UPDATE = "WIDGETS_PANEL_LAYOUT.UPDATE"
+    WIDGETS_PANEL_LAYOUT_UPDATE = "WIDGETS_PANEL_LAYOUT.UPDATE",
+    /** Edit mode isEditing changed */
+    WIDGETS_PANEL_LAYOUT_IS_EDITING_CHANGE = "WIDGETS_PANEL.EDIT_MODE.IS_EDITING.CHANGE",
+    /** Widgets deleted from the dashboard */
+    WIDGETS_DELETE = "WIDGETS.DELETE"
 }
 export type DashboardChangeAction = {
     type: DashboardChangeType.FILTERS_UPDATE;
@@ -19,6 +23,12 @@ export type DashboardChangeAction = {
 } | {
     type: DashboardChangeType.WIDGETS_PANEL_LAYOUT_UPDATE;
     payload: WidgetsPanelLayout;
+} | {
+    type: DashboardChangeType.WIDGETS_PANEL_LAYOUT_IS_EDITING_CHANGE;
+    payload: boolean;
+} | {
+    type: DashboardChangeType.WIDGETS_DELETE;
+    payload: string[];
 };
 /**
  * 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/index.d.ts

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

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

@@ -59,6 +59,70 @@ export interface DashboardFiltersPanelConfig extends FiltersPanelConfig {
      */
     persistCollapsedStateToLocalStorage?: boolean;
 }
+/**
+ * Widgets panel configuration
+ */
+export interface WidgetsPanelConfig {
+    /**
+     * If true adjust layout based on available width of widgets panel.
+     *
+     * If not specified, the default value is `false`.
+     */
+    responsive?: boolean;
+    /**
+     * Edit mode configuration.
+     * If enabled, an 'Edit Layout' action is visible to users on the dashboard toolbar.
+     * Clicking 'Edit Layout' opens the dashboard in editing mode, where the user can resize or reposition widgets using drag and drop.
+     * If history enabled, layout changes are temporarily stored during editing, with undo/redo buttons available on the toolbar.
+     * Finally, changes are confirmed or discarded with 'Apply' or 'Cancel' buttons.
+     *
+     * If persistence is enabled for the dashboard, changes to the layout will be saved to Fusion on clicking the 'Apply' button.
+     *
+     * This feature is in alpha.
+     *
+     * @alpha
+     */
+    editMode?: EditModeConfig;
+}
+/**
+ * Edit mode configuration
+ */
+export interface EditModeConfig {
+    /** Flag indicating whether the edit layout feature is enabled
+     *
+     * @default false
+     */
+    enabled: boolean;
+    /**
+     * Flag indicating whether the dashboard is currently in edit mode.
+     * If specified, will override inner mode state.
+     * */
+    isEditing?: boolean;
+    /** Configuration for the edit mode history */
+    applyChangesAsBatch?: {
+        /**
+         * If true, changes are applied when the user clicks 'Apply'
+         * or discarded when the user clicks 'Cancel'.
+         *
+         * If false, changes will be applied immediately as the user makes each change
+         * without confirmation or the ability to cancel/undo.
+         *
+         * @default: true
+         * */
+        enabled: boolean;
+        /**
+         * The maximum number of history items to keep.
+         *
+         * @default 20
+         */
+        historyLimit?: number;
+    };
+    /** Flag indicating whether the drag handle icon is visible
+     *
+     * @default true
+     */
+    showDragHandleIcon?: boolean;
+}
 /**
  * Dashboard configuration
  */
@@ -81,27 +145,7 @@ export interface DashboardConfig {
     /**
      * Configuration for the widgets panel
      */
-    widgetsPanel?: {
-        /**
-         * If true adjust layout based on available width of widgets panel.
-         *
-         * If not specified, the default value is `false`.
-         */
-        responsive?: boolean;
-        /**
-         * If true, an 'Edit Layout' action is visible to users on the dashboard toolbar.
-         * Clicking 'Edit Layout' opens the dashboard in editing mode, where the user can resize or reposition widgets using drag and drop.
-         * Layout changes are temporarily stored during editing, with undo/redo buttons available on the toolbar.
-         * Finally, changes are confirmed or discarded with 'Apply' or 'Cancel' buttons.
-         *
-         * If persistence is enabled for the dashboard, changes to the layout will be saved to Fusion on clicking the 'Apply' button.
-         *
-         * This feature is in alpha.
-         *
-         * @alpha
-         */
-        editMode?: boolean;
-    };
+    widgetsPanel?: WidgetsPanelConfig;
 }
 /**
  * Dashboard configuration
@@ -117,6 +161,13 @@ export interface DashboardByIdConfig extends DashboardConfig {
      * - Currently only changes to dashboard filters are persisted.
      */
     persist?: boolean;
+    /**
+     * Whether to load the dashboard in shared mode (co-authoring feature).
+     *
+     * @default false
+     * @internal
+     */
+    sharedMode?: boolean;
 }
 /**
  * Dashboard layout options

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

@@ -19,6 +19,11 @@ export declare const useDashboardThemeInternal: ({ styleOptions }: DashboardThem
             dividerLineColor: string;
             borderWidth: number;
             borderColor: string;
+            toolbar: {
+                primaryTextColor: string;
+                secondaryTextColor: string;
+                backgroundColor: string;
+            };
         };
         palette?: import("..").ColorPaletteTheme | undefined;
     };
@@ -38,6 +43,11 @@ export declare const useDashboardTheme: (args_0: DashboardThemeParams) => {
             dividerLineColor: string;
             borderWidth: number;
             borderColor: string;
+            toolbar: {
+                primaryTextColor: string;
+                secondaryTextColor: string;
+                backgroundColor: string;
+            };
         };
         palette?: import("..").ColorPaletteTheme | undefined;
     };