@sisense/sdk-ui 1.34.0 → 2.0.0

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

@@ -3,10 +3,9 @@ export * from './chart-data-options/types';
 export { Chart } from './chart';
 export { ThemeProvider } from './theme-provider';
 export * from './dashboard';
-export { DashboardWidget } from './widget-by-id/dashboard-widget';
 export { WidgetById } from './widget-by-id/widget-by-id';
 export { isChartWidgetProps, isPivotTableWidgetProps, isTextWidgetProps, isPluginWidgetProps, } from './widget-by-id/utils';
-export { type WidgetType, type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, type TextWidgetType, } from './widget-by-id/types';
+export { type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, type TextWidgetType, } from './widget-by-id/types';
 export { getChartType } from './widget-by-id/utils';
 export * from './query-execution';
 export { executeQuery, executePivotQuery } from './query/execute-query';
@@ -45,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, 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 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
  *
@@ -74,6 +73,8 @@ export { boxWhiskerProcessResult } from './boxplot-utils';
 export { queryStateReducer } from './query-execution/query-state-reducer';
 export * from './props';
 export * from './types';
+export type { SoftUnion } from './utils/utility-types';
+export type { BeforeMenuOpenHandler } from './common/components/menu/types';
 export * from './filters';
 export * from './formulas';
 export { trackHook } from './decorators/hook-decorators';

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

@@ -61,6 +61,20 @@ export type UseDashboardModelAddWidgetAction = {
  * @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("../../../api/types/dashboard-dto").FilterDto | import("../../../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.
  *
@@ -68,4 +82,4 @@ export declare function dashboardReducer(state: UseDashboardModelState, action:
  * @param reducer - The dashboard model reducer
  * @internal
  */
-export declare function persistDashboardModelMiddleware(dashbordOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi): Promise<UseDashboardModelInternalAction>;
+export declare function persistDashboardModelMiddleware(dashboardOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi): Promise<UseDashboardModelInternalAction>;

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

@@ -2,7 +2,7 @@ import { ChartType } from '../../index';
 /**
  * Widget type
  *
- * todo: as a future refactoring need to replace existing `WidgetType` by current one
+ * todo: as a future refactoring need to replace this type by combination of WidgetType and ChartType
  *
  * @internal
  */

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

@@ -1,7 +1,7 @@
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
 import { WidgetModel } from './widget-model.js';
 import { ChartProps, ChartWidgetProps, WidgetProps, PivotTableProps, PivotTableWidgetProps, PluginWidgetProps, TableProps, TableWidgetProps, TextWidgetProps, CommonWidgetProps } from '../../props';
-import { JaqlDataSource } from '@sisense/sdk-data';
+import { JaqlDataSourceForDto } from '@sisense/sdk-data';
 import { CompleteThemeSettings } from '../../types.js';
 import { WidgetDto } from '../../widget-by-id/types.js';
 import { AppSettings } from '../../app/settings/settings.js';
@@ -160,16 +160,6 @@ export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps)
  * @internal
  */
 export declare function fromWidgetProps(widgetProps: WidgetProps): WidgetModel;
-/**
- * Data source as specified in the jaql
- * but with required filelds
- *
- * @internal
- */
-export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
-    id: string;
-    address?: string;
-};
 /**
  * Translates a {@link WidgetModel} to {@link WidgetDto}.
  *
@@ -178,4 +168,4 @@ export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
  * @returns WidgetDto
  * @internal
  */
-export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?: JaqlDataSourceForWidgetDto): WidgetDto;
+export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?: JaqlDataSourceForDto): WidgetDto;

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

@@ -1,8 +1,6 @@
 import { DataSource, Filter } from '@sisense/sdk-data';
 import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
-import { WidgetType } from '../../widget-by-id/types';
-import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
-import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
+import type { WidgetType } from '../../props';
 import { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';
 import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
 /**
@@ -34,8 +32,6 @@ export interface WidgetModel {
     dataSource: DataSource;
     /**
      * Widget type.
-     *
-     * @deprecated Use {@link widgetModelTranslator} methods instead
      */
     widgetType: WidgetType;
     /**
@@ -68,125 +64,5 @@ export interface WidgetModel {
      * Widget drilldown options.
      */
     drilldownOptions: DrilldownOptions;
-    /**
-     * Returns the parameters to be used for executing a query for the widget.
-     *
-     * @example
-     * ```tsx
-     * const {data, isLoading, isError} = useExecuteQuery(widget.getExecuteQueryParams());
-     * ```
-     *
-     * Note: this method is not supported for getting pivot query.
-     * Use {@link getExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
-     * @deprecated Use {@link widgetModelTranslator.toExecuteQueryParams} instead
-     */
-    getExecuteQueryParams(): ExecuteQueryParams;
-    /**
-     * Returns the parameters to be used for executing a query for the pivot widget.
-     *
-     * @example
-     * ```tsx
-     * const {data, isLoading, isError} = useExecutePivotQuery(widget.getExecutePivotQueryParams());
-     * ```
-     *
-     * Note: this method is supported only for getting pivot query.
-     * Use {@link getExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
-     * @deprecated Use {@link widgetModelTranslator.toExecutePivotQueryParams} instead
-     */
-    getExecutePivotQueryParams(): ExecutePivotQueryParams;
-    /**
-     * Returns the props to be used for rendering a chart.
-     *
-     * @example
-     * ```tsx
-     * <Chart {...widget.getChartProps()} />
-     * ```
-     *
-     * Note: this method is not supported for pivot table widgets.
-     * Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
-     * @deprecated Use {@link widgetModelTranslator.toChartProps} instead
-     */
-    getChartProps(): ChartProps;
-    /**
-     * Returns the props to be used for rendering a table.
-     *
-     * @example
-     * ```tsx
-     * <Table {...widget.getTableProps()} />
-     * ```
-     *
-     * Note: this method is not supported for chart and pivot widgets.
-     * Use {@link getChartProps} instead for getting props for the <Chart> component.
-     * Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
-     * @deprecated Use {@link widgetModelTranslator.toTableProps} instead
-     */
-    getTableProps(): TableProps;
-    /**
-     * Returns the props to be used for rendering a pivot table.
-     *
-     * @example
-     * ```tsx
-     * <PivotTable {...widget.getPivotTableProps()} />
-     * ```
-     *
-     * Note: this method is not supported for chart or table widgets.
-     * Use {@link getChartProps} instead for getting props for the <Chart> component.
-     * Use {@link getTableProps} instead for getting props for the <Table> component.
-     * @deprecated Use {@link widgetModelTranslator.toPivotTableProps} instead
-     */
-    getPivotTableProps(): PivotTableProps;
-    /**
-     * Returns the props to be used for rendering a chart widget.
-     *
-     * @example
-     * ```tsx
-     * <ChartWidget {...widget.getChartWidgetProps()} />
-     * ```
-     *
-     * Note: this method is not supported for pivot widgets.
-     * @deprecated Use {@link widgetModelTranslator.toChartWidgetProps} instead
-     */
-    getChartWidgetProps(): ChartWidgetProps;
-    /**
-     * Returns the props to be used for rendering a table widget.
-     *
-     * @example
-     * ```tsx
-     * <TableWidget {...widget.getTableWidgetProps()} />
-     * ```
-     *
-     * Note: this method is not supported for chart widgets.
-     * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * @deprecated Use {@link widgetModelTranslator.toTableWidgetProps} instead
-     * @internal
-     */
-    getTableWidgetProps(): TableWidgetProps;
-    /**
-     * Returns the props to be used for rendering a pivot table widget.
-     *
-     * @example
-     * ```tsx
-     * <PivotTableWidget {...widget.getPivotTableWidgetProps()} />
-     * ```
-  
-     * Note: this method is not supported for chart or table widgets.
-     * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * @deprecated Use {@link widgetModelTranslator.toPivotTableWidgetProps} instead
-     */
-    getPivotTableWidgetProps(): PivotTableWidgetProps;
-    /**
-     * Returns the props to be used for rendering a text widget.
-     *
-     * @example
-     * ```tsx
-     * <TextWidget {...widget.getTextWidgetProps()} />
-     * ```
-     *
-     * Note: this method is not supported for chart or pivot widgets.
-     * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * Use {@link getPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
-     * @deprecated Use {@link widgetModelTranslator.toTextWidgetProps} instead
-     */
-    getTextWidgetProps(): TextWidgetProps;
 }
 export declare const isWidgetModel: (widget: any) => widget is WidgetModel;

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

@@ -1,5 +1,5 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, DashboardWidgetStyleOptions, IndicatorRenderOptions, TabberStyleProps } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
@@ -10,6 +10,7 @@ import { HookEnableParam } from './common/hooks/types';
 import { ExecuteQueryResult } from './query-execution/types';
 import { Hierarchy } from './models';
 import { BeforeMenuOpenHandler } from './common/components/menu/types';
+import { DistributiveOmit } from './utils/utility-types/distributive-omit';
 export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations and authentication for Sisense Context.
@@ -106,7 +107,8 @@ export interface SisenseContextProviderProps {
      * Used only with SSO authentication.
      * If not specified, the default value is `false`.
      *
-     * @internal
+     * @category Sisense Authentication
+     *
      */
     enableSilentPreAuth?: boolean;
 }
@@ -133,11 +135,7 @@ export interface ExecuteQueryProps {
     count?: number;
     /** {@inheritDoc ExecuteQueryParams.offset} */
     offset?: number;
-    /**
-     * {@inheritDoc ExecuteQueryParams.ungroup}
-     *
-     * @internal
-     */
+    /** {@inheritDoc ExecuteQueryParams.ungroup} */
     ungroup?: boolean;
     /** Function as child component that is called to render the query results */
     children?: (queryResult: ExecuteQueryResult) => ReactNode;
@@ -299,7 +297,6 @@ interface BaseChartEventProps {
      * Can be used to inject modification of queried data.
      *
      * @category Callbacks
-     * @internal
      */
     onDataReady?: (data: Data) => Data;
 }
@@ -920,19 +917,6 @@ export interface WidgetByIdProps extends Omit<ChartWidgetProps, 'dataSource' | '
      */
     drilldownOptions?: DrilldownOptions;
 }
-/**
- * Props for the {@link DashboardWidget} component
- *
- * @deprecated Use {@link WidgetById} and {@link WidgetByIdProps} instead
- */
-export interface DashboardWidgetProps extends WidgetByIdProps {
-    /**
-     * Style options for the widget including the widget container and the chart or table inside.
-     *
-     * @category Widget
-     */
-    styleOptions?: DashboardWidgetStyleOptions;
-}
 /**
  * Props for the {@link ChartWidget} component
  *
@@ -1222,20 +1206,19 @@ export interface PluginWidgetProps {
     description?: string;
 }
 /**
- * A utility type that combines widget-specific properties (`W`) with a corresponding widget type (`T`).
- *
- * This is used to extend the props of a widget with its respective widget type.
+ * A utility type that combines widget-specific properties (`BaseWidget`)
+ * with a common widget props including corresponding widget type (`Type`).
  */
-export type WithWidgetType<W extends ChartWidgetProps | PivotTableWidgetProps | TextWidgetProps | PluginWidgetProps, T extends 'chart' | 'pivot' | 'text' | 'plugin'> = W & {
+export type WithCommonWidgetProps<BaseWidget, Type extends WidgetType> = BaseWidget & {
+    /**
+     * Unique identifier of the widget within the container component (dashboard)
+     *
+     */
+    readonly id: string;
     /**
      * Widget type
      */
-    widgetType: T;
-};
-/**
- * Props for the facade widget component.
- */
-export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | WithWidgetType<PivotTableWidgetProps, 'pivot'> | WithWidgetType<TextWidgetProps, 'text'> | WithWidgetType<PluginWidgetProps, 'plugin'>) & {
+    widgetType: Type;
     /**
      * Optional handler function to process menu options before opening the context menu.
      *
@@ -1243,16 +1226,20 @@ export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | Wit
      */
     onBeforeMenuOpen?: BeforeMenuOpenHandler;
 };
+/**
+ * Type of the widget component.
+ */
+export type WidgetType = 'chart' | 'pivot' | 'text' | 'plugin';
 /**
  * Props for the widget component within a container component like dashboard.
  */
-export type WidgetProps = CommonWidgetProps & {
-    /**
-     * Unique identifier of the widget within the container component (dashboard)
-     *
-     */
-    readonly id: string;
-};
+export type WidgetProps = WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
+/**
+ * Props for the facade widget component.
+ *
+ * @internal
+ */
+export type CommonWidgetProps = DistributiveOmit<WidgetProps, 'id'>;
 /**
  * Props for {@link ExecuteQueryByWidgetId} component.
  *
@@ -1476,13 +1463,6 @@ export type DrilldownWidgetConfig = {
  * Props for the {@link DrilldownWidget} component
  */
 export interface DrilldownWidgetProps {
-    /**
-     * List of dimensions to allow drilldowns on
-     *
-     * @category Widget
-     * @deprecated Use {@link DrilldownWidgetProps.drilldownPaths} instead
-     */
-    drilldownDimensions?: Attribute[];
     /**
      * Dimensions and hierarchies available for drilldown on.
      *

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

@@ -209,11 +209,9 @@ export interface ExecuteQueryParams {
     /**
      * Boolean flag whether to include `ungroup: true` in non-aggregated JAQL queries.
      *
-     * This improves computation and performance of querying huge tables when no aggregation is needed
+     * This improves computation and performance of querying tables when no aggregation is needed
      *
      * If not specified, the default value is `false`
-     *
-     * @internal
      */
     ungroup?: boolean;
     /**

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

@@ -41,6 +41,8 @@ export declare const translation: {
             onlyPivotWidgetSupported: string;
             onlyTextWidgetSupported: string;
             onlyPluginWidgetSupported: string;
+            unsupportedWidgetType: string;
+            unsupportedFusionWidgetType: string;
         };
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;
@@ -226,7 +228,6 @@ export declare const translation: {
         dataTopics: string;
         chatbotDescription: string;
         topicSelectPrompt: string;
-        betaLabel: string;
         preview: string;
         clearHistoryPrompt: string;
         config: {

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

@@ -51,6 +51,8 @@ export declare const resources: {
                 onlyPivotWidgetSupported: string;
                 onlyTextWidgetSupported: string;
                 onlyPluginWidgetSupported: string;
+                unsupportedWidgetType: string;
+                unsupportedFusionWidgetType: string;
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
@@ -236,7 +238,6 @@ export declare const resources: {
             dataTopics: string;
             chatbotDescription: string;
             topicSelectPrompt: string;
-            betaLabel: string;
             preview: string;
             clearHistoryPrompt: string;
             config: {
@@ -405,6 +406,8 @@ export declare const resources: {
                 onlyPivotWidgetSupported: string;
                 onlyTextWidgetSupported: string;
                 onlyPluginWidgetSupported: string;
+                unsupportedWidgetType: string;
+                unsupportedFusionWidgetType: string;
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
@@ -590,7 +593,6 @@ export declare const resources: {
             dataTopics: string;
             chatbotDescription: string;
             topicSelectPrompt: string;
-            betaLabel: string;
             preview: string;
             clearHistoryPrompt: string;
             config: {

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

@@ -13,6 +13,7 @@ import { HighchartsOptionsInternal } from './chart-options-processor/chart-optio
 import { CSSProperties } from 'react';
 import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
 import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
+import { SoftUnion } from './utils/utility-types';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
@@ -320,24 +321,6 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
 };
 /** Configuration options that define functional style of the various elements of the Table Component */
 export interface TableStyleOptions {
-    /**
-     * Boolean flag whether to fill header cells with background color
-     *
-     * @deprecated Use {@link TableStyleOptions#header | TableStyleOptions.header.color} instead.
-     */
-    headersColor?: boolean;
-    /**
-     * Boolean flag whether to apply background color to alternate rows.
-     *
-     * @deprecated Use {@link TableStyleOptions#rows | TableStyleOptions.rows.alternatingColor} instead.
-     */
-    alternatingRowsColor?: boolean;
-    /**
-     * Boolean flag whether to apply background color to alternate columns
-     *
-     * @deprecated Use {@link TableStyleOptions#columns | TableStyleOptions.columns.alternatingColor} instead.
-     */
-    alternatingColumnsColor?: boolean;
     /**
      * Vertical padding around whole table
      * Default value is 20px
@@ -668,12 +651,6 @@ export interface ChartThemeSettings {
     secondaryTextColor?: string;
     /** Background color */
     backgroundColor?: string;
-    /**
-     * Toolbar Background color, can be used as a secondary background color
-     *
-     * @deprecated
-     */
-    panelBackgroundColor?: string;
     /** Animation options */
     animation?: {
         /** Chart initialization animation options */
@@ -1229,13 +1206,6 @@ export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
      */
     height?: number;
 }
-/**
- * Style settings defining the look and feel of DashboardWidget
- *
- * @deprecated Use {@link WidgetByIdStyleOptions} instead
- */
-export interface DashboardWidgetStyleOptions extends WidgetByIdStyleOptions {
-}
 /** Style settings defining the look and feel of ChartWidget */
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
@@ -1272,12 +1242,6 @@ export declare type ColorPaletteTheme = {
 };
 /** Configuration for the drilldown */
 export type DrilldownOptions = {
-    /**
-     * Dimensions that can be used for drilldown
-     *
-     * @deprecated Use {@link DrilldownOptions.drilldownPaths} instead
-     */
-    drilldownDimensions?: Attribute[];
     /**
      * Dimensions and hierarchies available for drilldown on.
      */
@@ -1653,6 +1617,51 @@ export type CustomTranslationObject = {
      */
     namespace?: string;
 };
+/**
+ * Translation Configuration
+ */
+export type TranslationConfig = {
+    /**
+     * Language code to be used for translations.
+     */
+    language?: string;
+    /**
+     * Additional translation resources to be loaded.
+     *
+     * You can find the list of available translation keys in the translation folder of every package.
+     *
+     * Translation keys that are not provided will default to the English translation.
+     * If translation is provided for a package other than sdk-ui, please specify the namespace property.
+     *
+     * Important: Do not translate parts in {{}} - these are placeholders for dynamic values and will be matched using provided variable names.
+     *
+     * @example
+     * ```ts
+     * customTranslations: [
+     *   {
+     *     language: 'fr',
+     *     resources: {
+     *       errors: {
+     *        invalidFilterType: 'Type de filtre invalide',
+     *       },
+     *     },
+     *   },
+     *   {
+     *     language: 'es',
+     *     namespace: 'sdkData'
+     *     resources: {
+     *       errors: {
+     *         measure: {
+     *           unsupportedType: 'Tipo de medida no compatible',
+     *         },
+     *       },
+     *     },
+     *   },
+     * ]
+     * ```
+     */
+    customTranslations?: CustomTranslationObject[];
+};
 /**
  * Single Tabber Widget tab object without styling
  *
@@ -1707,10 +1716,8 @@ export type TabberConfig = {
     activeTab: number;
 };
 /** @internal */
-export type CustomContextProviderProps<P> = {
+export type CustomContextProviderProps<P> = SoftUnion<{
     context: P;
-    error?: undefined;
 } | {
-    context?: undefined;
     error: Error;
-};
+}>;

package/dist/packages/sdk-ui/src/utils/{utility-types.d.ts → utility-types/basic-utility-types.d.ts}

@@ -61,38 +61,4 @@ export type AnyArray = any[];
  * type TRequiredB = WithRequiredProp<T, 'b'>; // { a: string; b: number; c?: boolean; }
  */
 export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-/**
- * Universal generic state for hooks that fetch data from the REST API.
- */
-export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
-/** Success state of the REST API hook */
-export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
-    isLoading: false;
-    isError: false;
-    isSuccess: true;
-    error: undefined;
-    status: 'success';
-} & {
-    [key in DataKey]: SuccessDataType;
-};
-/** Error state of the REST API hook */
-export type RestApiHookErrorState<DataKey extends string> = {
-    isLoading: false;
-    isError: true;
-    isSuccess: false;
-    error: Error;
-    status: 'error';
-} & {
-    [key in DataKey]: undefined;
-};
-/** Loading state of the REST API hook */
-export type RestApiHookLoadingState<DataKey extends string> = {
-    isLoading: true;
-    isError: false;
-    isSuccess: false;
-    error: undefined;
-    status: 'loading';
-} & {
-    [key in DataKey]: undefined;
-};
 export {};

package/dist/packages/sdk-ui/src/utils/utility-types/distributive-omit.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Utility type that applies `Omit` distributively over a union of types.
+ *
+ * In TypeScript, applying `Omit` directly to a union type causes the keys to be removed
+ * from the union "as a whole", resulting in unintended behavior. This type fixes that by
+ * distributing `Omit` to each member of the union individually.
+ *
+ * @template T The union of types to apply the omit to.
+ * @template K The keys to omit from each type in the union.
+ *
+ * @example
+ * type A = { type: 'a'; foo: string };
+ * type B = { type: 'b'; bar: number };
+ * type U = A | B;
+ *
+ * // Without distributive omit:
+ * type Broken = Omit<U, 'type'>;
+ * // Result: { foo?: string; bar?: number } - not a union anymore
+ *
+ * // With distributive omit:
+ * type Fixed = DistributiveOmit<U, 'type'>;
+ * // Result: { foo: string } | { bar: number } - still a union
+ */
+export type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : never;

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

@@ -0,0 +1,4 @@
+export * from './basic-utility-types';
+export * from './rest-api-hook-state';
+export * from './soft-union';
+export * from './distributive-omit';