@sisense/sdk-ui 2.1.0 → 2.2.0

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

@@ -8,11 +8,14 @@ interface ErrorBoundaryProps {
     error?: AbstractTranslatableError | Error | string;
     children: ReactNode;
     resetKeys?: any[];
-    onError?: (error: Error) => void;
+    onError?: (error: Error) => void | ReactNode;
     isContainerComponent?: boolean;
+    /** If set to true, children will be rendered when an error is provided via props, but not when caught during rendering */
+    shouldRenderChildrenWithProvidedError?: boolean;
 }
 type ErrorBoundaryState = {
     error: AbstractTranslatableError | Error | string | null;
+    customErrorUI: ReactNode | null;
 };
 /**
  * This component is used to catch errors thrown by the UI component and display an error message
@@ -24,11 +27,12 @@ type ErrorBoundaryState = {
  */
 export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
     showErrorBox: boolean;
-    onError?: (error: Error) => void;
+    onError?: (error: Error) => void | ReactNode;
     isContainerComponent: boolean;
     constructor(props: ErrorBoundaryProps);
     static getDerivedStateFromError(error: Error): {
         error: Error;
+        customErrorUI: null;
     };
     componentDidCatch(error: Error): void;
     componentDidUpdate(prevProps: ErrorBoundaryProps, prevState: ErrorBoundaryState): void;

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

@@ -44,7 +44,7 @@ export { usePlugins } from './plugins-provider/plugins-provider';
 export { extractDimensionsAndMeasures, useExecutePluginQuery, } from './plugins-provider/use-execute-plugin-query';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
-export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, translateFiltersAndRelationsToDto, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, translateFiltersAndRelationsToDto, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
 /**
  * Utility functions to translate a Fusion widget model from and to other widget data structures
  *

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

@@ -2,6 +2,7 @@ import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import { DashboardStyleOptions, TabbersOptions, WidgetModel } from '../../models';
 import { type WidgetsOptions } from './types';
 import { DashboardLayoutOptions } from '../../dashboard';
+import { DashboardSettings } from '../../api/types/dashboard-dto';
 /**
  * Model of Sisense Fusion dashboard defined in the abstractions of Compose SDK.
  *
@@ -55,4 +56,10 @@ export interface DashboardModel {
      * @internal
      */
     tabbersOptions?: TabbersOptions;
+    /**
+     * Dashboard settings.
+     *
+     * @internal
+     */
+    settings?: DashboardSettings;
 }

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-dto-utils.d.ts

@@ -1,5 +1,6 @@
 import { Filter } from '@sisense/sdk-data';
-import { CascadingFilterDto, FilterDto } from '../../api/types/dashboard-dto';
+import { CascadingFilterDto, FilterDto, LayoutDto } from '../../api/types/dashboard-dto';
+import { WidgetsPanelLayout } from '../../dashboard/types';
 /**
  * Translates a {@link Filter} to a {@link FilterDto}.
  *
@@ -8,3 +9,4 @@ import { CascadingFilterDto, FilterDto } from '../../api/types/dashboard-dto';
  * @internal
  */
 export declare function filterToFilterDto(filter: Filter): FilterDto | CascadingFilterDto;
+export declare function layoutToLayoutDto(layout: WidgetsPanelLayout): LayoutDto;

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

@@ -2,25 +2,37 @@ import { CommonFiltersOptions } from '../../common-filters/types';
 import { ColorPaletteTheme, TabberConfig } from '../../types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
 /**
- * Column layout of dashboard widgets
+ * Part of Dashboard layout, which describes how widgets are arranged in a cell
+ */
+export interface WidgetsPanelCell {
+    widthPercentage: number;
+    /**
+     * @privateRemarks
+     * This value appears to be overwritten by the widget's height property.
+     * Marking as optional and internal for now.
+     * @internal
+     */
+    height?: number | string;
+    widgetId: string;
+}
+/**
+ * Part of Dashboard layout, which describes how widgets are arranged in a row
+ */
+export interface WidgetsPanelRow {
+    cells: WidgetsPanelCell[];
+}
+/**
+ * Part of Dashboard layout, which describes how widgets are arranged in a column
+ */
+export interface WidgetsPanelColumn {
+    widthPercentage: number;
+    rows: WidgetsPanelRow[];
+}
+/**
+ * Dashboard layout, which describes how widgets are arranged in the dashboard
  */
 export interface WidgetsPanelColumnLayout {
-    columns: {
-        widthPercentage: number;
-        rows: {
-            cells: {
-                widthPercentage: number;
-                /**
-                 * @privateRemarks
-                 * This value appears to be overwritten by the widget's height property.
-                 * Marking as optional and internal for now.
-                 * @internal
-                 */
-                height?: number | string;
-                widgetId: string;
-            }[];
-        }[];
-    }[];
+    columns: WidgetsPanelColumn[];
 }
 /**
  * Layout of dashboard widgets panel, which is a union of different layout algorithms
@@ -39,7 +51,7 @@ export type WidgetsOptions = Record<WidgetId, {
     filtersOptions?: CommonFiltersOptions;
 }>;
 /**
- * Options for TabberWidetss in a dashboard
+ * Options for TabberWidets in a dashboard
  *
  * This property actually moves responsibility on the layout management from the tabber widgets to the dashboard,
  * storing all the tabbers configs in the single place

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

@@ -1,4 +1,4 @@
-import { DashboardModel, WidgetModel } from '../../../models';
+import { DashboardModel, WidgetModel, WidgetsPanelLayout } from '../../../models';
 import { Filter, FilterRelations } from '@sisense/sdk-data';
 import { RestApi } from '../../../api/rest-api';
 export type UseDashboardModelState = DashboardModel | null;
@@ -8,8 +8,7 @@ export type UseDashboardModelState = DashboardModel | null;
  * @internal
  */
 export declare enum UseDashboardModelActionTypeInternal {
-    DASHBOARD_INIT = "DASHBOARD.INIT",
-    DASHBOARD_UPDATE_LAYOUT = "DASHBOARD.UPDATE_LAYOUT"
+    DASHBOARD_INIT = "DASHBOARD.INIT"
 }
 /**
  * Action types for the dashboard model state used in {@link useDashboardModel}.
@@ -18,7 +17,8 @@ export declare enum UseDashboardModelActionTypeInternal {
  */
 export declare enum UseDashboardModelActionType {
     FILTERS_UPDATE = "FILTERS.UPDATE",
-    ADD_WIDGET = "WIDGETS.ADD"
+    ADD_WIDGET = "WIDGETS.ADD",
+    WIDGETS_PANEL_LAYOUT_UPDATE = "WIDGETS_PANEL_LAYOUT.UPDATE"
 }
 /**
  * Internal actions for the dashboard model state used in {@link useDashboardModel}.
@@ -34,7 +34,7 @@ export type UseDashboardModelInternalAction = UseDashboardModelAction | {
  *
  * @internal
  */
-export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseDashboardModelAddWidgetAction;
+export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseDashboardModelAddWidgetAction | UseDashboardModelLayoutUpdateAction;
 /**
  * Filter update actions for the dashboard model state used in {@link useDashboardModel}.
  *
@@ -53,6 +53,15 @@ export type UseDashboardModelAddWidgetAction = {
     type: UseDashboardModelActionType.ADD_WIDGET;
     payload: WidgetModel;
 };
+/**
+ * Layout update action for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+export type UseDashboardModelLayoutUpdateAction = {
+    type: UseDashboardModelActionType.WIDGETS_PANEL_LAYOUT_UPDATE;
+    payload: WidgetsPanelLayout;
+};
 /**
  * Reducer for the dashboard model state used in {@link useDashboardModel}.
  *

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

@@ -86,6 +86,9 @@ export interface SisenseContextProviderProps {
     /**
      * Callback function that is triggered when an error occurs within the Sisense context.
      *
+     * Return React node to render a custom error UI.
+     * Return `undefined` to use the default error UI.
+     *
      * This callback is useful for handling errors that happen during the initialization or runtime of the Sisense context,
      * such as incorrect configuration, invalid authentication, or network-related issues.
      *
@@ -100,7 +103,7 @@ export interface SisenseContextProviderProps {
         componentName: string;
         /** The props of the component that caused the error. */
         componentProps: unknown;
-    }) => void;
+    }) => void | ReactNode;
     /**
      * Boolean flag to enable sending silent pre-authentication requests to the Sisense instance.
      * Used to check if user is already authenticated, check is performed in an ivisible iframe.

package/dist/packages/sdk-ui/src/theme-provider/default-theme-settings.d.ts

@@ -1,6 +1,9 @@
 import { CompleteThemeSettings } from '../types';
 export declare const DEFAULT_DIVIDER_COLOR = "#F2F2F2";
 export declare const DEFAULT_DIVIDER_WIDTH = 4;
+export declare const DEFAULT_DASHBOARD_BORDER_COLOR = "#D5D5D5";
+export declare const DEFAULT_DASHBOARD_BORDER_WIDTH = 1;
+export declare const DEFAULT_FILTER_PANEL_BORDER_COLOR = "#DADADA";
 export declare const DEFAULT_TITLE_FONT_SIZE = 15;
 /**
  * Returns default theme settings, which can be used as base for custom theme options.

package/dist/packages/sdk-ui/src/translation/resources/en.d.ts

@@ -352,6 +352,15 @@ export declare const translation: {
         grandTotal: string;
         subTotal: string;
     };
+    dashboard: {
+        toolbar: {
+            undo: string;
+            redo: string;
+            cancel: string;
+            apply: string;
+            editLayout: string;
+        };
+    };
 };
 /**
  * A reference type containing all currently used translation keys.

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

@@ -362,6 +362,15 @@ export declare const resources: {
             grandTotal: string;
             subTotal: string;
         };
+        dashboard: {
+            toolbar: {
+                undo: string;
+                redo: string;
+                cancel: string;
+                apply: string;
+                editLayout: string;
+            };
+        };
     };
     uk: {
         errors: {
@@ -717,5 +726,14 @@ export declare const resources: {
             grandTotal: string;
             subTotal: string;
         };
+        dashboard: {
+            toolbar: {
+                undo: string;
+                redo: string;
+                cancel: string;
+                apply: string;
+                editLayout: string;
+            };
+        };
     };
 };

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

@@ -944,6 +944,8 @@ export type DashboardThemeSettings = {
     backgroundColor?: string;
     dividerLineWidth?: number;
     dividerLineColor?: string;
+    borderWidth?: number;
+    borderColor?: string;
 };
 /**
  * Filter theme settings
@@ -954,6 +956,18 @@ export type FilterThemeSettings = {
         titleColor?: string;
         /** Background color */
         backgroundColor?: string;
+        /**
+         * Border color
+         *
+         * @internal
+         * */
+        borderColor?: string;
+        /**
+         * Border width
+         *
+         * @internal
+         * */
+        borderWidth?: number;
     };
 };
 /**