@sisense/sdk-ui 1.20.0 → 1.22.0

package/dist/packages/sdk-ui/src/formulas/use-get-shared-formula.d.ts

@@ -67,7 +67,7 @@ export type SharedFormulaSuccessState = {
     status: 'success';
 };
 /**
- * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the a Fusion Embed instance.
+ * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the a Fusion instance.
  *
  * The formula can be identified either by `oid` or by name and data source pair.
  *
@@ -83,16 +83,15 @@ export type SharedFormulaSuccessState = {
     ```tsx
     const { formula, isLoading, isError } = useGetSharedFormula({ name: 'My Shared Formula', datasource: DM.DataSource })
     ```
- * @param params - {@link UseGetSharedFormulaParams}
- * @param dataSource - Data source in Sisense instance
  * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
 /**
  * {@link useGetSharedFormula} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - {@link UseGetSharedFormulaParams}
  * @internal
  */
 export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;

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

@@ -1,4 +1,4 @@
-export { ClientApplication, createClientApplication } from './app/client-application';
+export { type ClientApplication, createClientApplication } from './app/client-application';
 export * from './chart-data-options/types';
 export { Chart } from './chart';
 export { ThemeProvider } from './theme-provider';
@@ -10,11 +10,12 @@ export * from './query-execution';
 export { executeQuery } from './query/execute-query';
 export { SisenseContextProvider } from './sisense-context/sisense-context-provider';
 export { DrilldownWidget } from './widgets/drilldown-widget';
-export { processDrilldownSelections } from './widgets/common/use-drilldown';
+export { processDrilldownSelections } from './widgets/common/use-drilldown-core';
 export { ChartWidget } from './widgets/chart-widget';
 export { TableWidget } from './widgets/table-widget';
 export { PivotTableWidget } from './widgets/pivot-table-widget';
 export { TextWidget } from './widgets/text-widget';
+export { Widget } from './widgets/widget';
 export { ContextMenu } from './common/components/menu/context-menu/context-menu';
 export { DrilldownBreadcrumbs } from './widgets/common/drilldown-breadcrumbs';
 export * from './line-chart';
@@ -44,19 +45,28 @@ export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
 export { useGetDashboardModel, useGetDashboardModels, 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 as WidgetsPanelColumnLayout, type WidgetsPanelLayout as WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchiesParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, } from './models';
 /**
- * Utility functions to translate between widget abstractions of models and UI props.
+ * Utility functions to translate a Fusion widget model from and to other widget data structures
  *
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion widget model from and to other widget data structures
  */
 export * as widgetModelTranslator from './models/widget/widget-model-translator';
 /**
- * Utility functions to translate between dashboard abstractions of models and UI props.
+ * Utility functions to translate a Fusion dashboard model from and to other dashboard data structures
  *
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion dashboard model from and to other dashboard data structures
  */
 export * as dashboardModelTranslator from './models/dashboard/dashboard-model-translator';
+/**
+ * Utility functions to manipulate `DashboardProps`
+ *
+ * @group Dashboards
+ * @shortDescription Utility functions to manipulate dashboard elements
+ */
+export * as dashboardHelpers from './dashboard/dashboard-helpers';
 export type { AutoZoomNavigatorScrollerLocation } from './dashboard-widget/types';
 export { boxWhiskerProcessResult } from './boxplot-utils';
 export { queryStateReducer } from './query-execution/query-state-reducer';

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

@@ -10,10 +10,10 @@ import { AppSettings } from '../../app/settings/settings.js';
  * ```tsx
  * <Dashboard {...dashboardModelTranslator.toDashboardProps(dashboardModel)} />
  * ```
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
-export declare function toDashboardProps(dashboardModel: DashboardModel): Required<DashboardProps>;
+export declare function toDashboardProps(dashboardModel: DashboardModel): DashboardProps;
 /**
  * Creates a new dashboard model from a dashboard DTO.
  *

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

@@ -5,7 +5,7 @@ import { DashboardLayoutOptions } from '../../dashboard';
 /**
  * Model of Sisense Fusion dashboard defined in the abstractions of Compose SDK.
  *
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export interface DashboardModel {

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

@@ -12,8 +12,6 @@ export interface GetDashboardModelOptions {
      * Boolean flag whether to include filters in the dashboard model
      *
      * If not specified, the default value is `false`
-     *
-     * @internal
      */
     includeFilters?: boolean;
 }

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

@@ -5,3 +5,5 @@ export * from './use-get-dashboard-model';
 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';

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

@@ -0,0 +1,11 @@
+import { Filter } from '@sisense/sdk-data';
+import { FilterDto } from '../../api/types/dashboard-dto';
+/**
+ * Translates a {@link Filter} to a {@link FilterDto}.
+ * @param filter
+ *
+ * @returns FilterDto
+ *
+ * @internal
+ */
+export declare function filterToFilterDto(filter: Filter): FilterDto;

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

@@ -0,0 +1,22 @@
+import { UseDashboardModelAction } from '../../../models';
+import { DashboardChangeAction } from '../../../dashboard/dashboard';
+import { Authenticator } from '@sisense/sdk-rest-client';
+/**
+ * Convert a dashboard change action to a use dashboard model action.
+ * @param action - The dashboard change action to convert
+ *
+ * @returns The useDashboardModel action or null if the action is not supported
+ *
+ * @internal
+ */
+export declare function dashboardChangeActionToUseDashboardModelAction(action: DashboardChangeAction): UseDashboardModelAction | null;
+/**
+ * Check if the persistence is supported and log a warning if it is not.
+ * @param authType - The authentication type
+ * @param shouldWarn - Whether to log a warning
+ *
+ * @returns True if the persistence is supported, false otherwise
+ *
+ * @internal
+ */
+export declare function checkPersistenceSupport(authType: Authenticator['type'], shouldWarn: boolean): boolean;

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

@@ -0,0 +1,63 @@
+import { DashboardModel } from '../../../models';
+import { Filter } from '@sisense/sdk-data';
+import { RestApi } from '../../../api/rest-api';
+export type UseDashboardModelState = DashboardModel | null;
+/**
+ * Internal action types for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+export declare enum UseDashboardModelActionTypeInternal {
+    DASHBOARD_INIT = "DASHBOARD.INIT"
+}
+/**
+ * Action types for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+export declare enum UseDashboardModelActionType {
+    FILTERS_UPDATE = "FILTERS.UPDATE"
+}
+/**
+ * Internal actions for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+type UseDashboardModelInternalAction = UseDashboardModelAction | {
+    type: UseDashboardModelActionTypeInternal.DASHBOARD_INIT;
+    payload: DashboardModel;
+};
+/**
+ * Actions for the dashboard model state used in {@link useDashboardModel}.
+ *
+ * @internal
+ */
+export type UseDashboardModelAction = {
+    type: UseDashboardModelActionType.FILTERS_UPDATE;
+    payload: Filter[];
+};
+/**
+ * Reducer for the dashboard model state used in {@link useDashboardModel}.
+ * @param state
+ * @param action
+ *
+ * @internal
+ */
+export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
+/**
+ * Middleware connector for {@link persistDashboardModelMiddleware}.
+ * @param restApi - The Sisense REST API instance
+ * @param reducer - The dashboard model reducer
+ *
+ * @internal
+ */
+export declare function withPersistDashboardModelMiddleware(restApi: RestApi, reducer: (state: UseDashboardModelState, action: UseDashboardModelInternalAction) => UseDashboardModelState): (state: UseDashboardModelState, action: UseDashboardModelInternalAction) => UseDashboardModelState;
+/**
+ * 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(state: DashboardModel, action: UseDashboardModelAction, restApi: RestApi): Promise<import("../../..").DashboardDto | undefined> | Promise<null>;
+export {};

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

@@ -0,0 +1,38 @@
+import { GetDashboardModelParams } from '../../../models';
+import { Dispatch } from 'react';
+import { UseDashboardModelAction } from './use-dashboard-model-reducer';
+export interface UseDashboardModelParams extends GetDashboardModelParams {
+    /**
+     * Boolean flag indicating whether changes to the dashboard state should be saved to the dashboard in Fusion
+     * @default true
+     * @internal
+     */
+    persist?: boolean;
+}
+/**
+ *  This hook allows you to retrieve and manage a dashboard model from a Sisense instance.
+ *  It handles fetching the existing dashboard, managing its local state, and saving any changes back to the Sisense server.
+ * (only filters persist supported for now)
+ *
+ * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any, function to dispatch changes to the dashboard model.
+ * @group Fusion Embed
+ * @fusionEmbed
+ * @internal
+ */
+export declare const useDashboardModel: (args_0: UseDashboardModelParams) => {
+    dashboard: import('../../../models').UseDashboardModelState;
+    isLoading: boolean;
+    isError: boolean;
+    dispatchChanges: Dispatch<UseDashboardModelAction>;
+};
+/**
+ * {@link useDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useDashboardModelInternal({ dashboardOid, includeWidgets, includeFilters, persist, }: UseDashboardModelParams): {
+    dashboard: import('../../../models').UseDashboardModelState;
+    isLoading: boolean;
+    isError: boolean;
+    dispatchChanges: Dispatch<UseDashboardModelAction>;
+};

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

@@ -96,15 +96,15 @@ export type DashboardModelSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the dashboard to be retrieved
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;
 /**
  * {@link useGetDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the dashboard to be retrieved
  * @internal
  */
 export declare function useGetDashboardModelInternal(params: GetDashboardModelParams): DashboardModelState;

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

@@ -81,15 +81,15 @@ export type DashboardModelsSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the dashboards to be retrieved
  * @returns Load state that contains the status of the execution, the result dashboards, or the error if any
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const useGetDashboardModels: (params?: GetDashboardModelsParams | undefined) => DashboardModelsState;
 /**
  * {@link useGetDashboardModels} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the dashboards to be retrieved
  * @internal
  */
 export declare function useGetDashboardModelsInternal(params?: GetDashboardModelsParams): DashboardModelsState;

package/dist/packages/sdk-ui/src/models/hierarchy/use-get-hierarchy-models.d.ts

@@ -62,7 +62,7 @@ export type HierarchyModelsSuccessState = {
     status: 'success';
 };
 /**
- * React hook that retrieves existing hierarchy models from a Fusion Embed instance.
+ * React hook that retrieves existing hierarchy models from a Fusion instance.
  *
  * @example
  * Retrieve the hierarchy models and render their counts.
@@ -83,15 +83,15 @@ export type HierarchyModelsSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the hierarchies to be retrieved
  * @returns Load state that contains the status of the execution, the result hierarchy models, or the error if one has occurred
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const useGetHierarchyModels: (params: GetHierarchiesParams) => HierarchyModelsState;
 /**
  * {@link useGetHierarchyModels} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the hierarchies to be retrieved
  * @internal
  */
 export declare function useGetHierarchyModelsInternal(params: GetHierarchiesParams): HierarchyModelsState;

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

@@ -69,7 +69,7 @@ export type WidgetModelSuccessState = {
     status: 'success';
 };
 /**
- * React hook that retrieves an existing widget model from a Fusion Embed instance.
+ * React hook that retrieves an existing widget model from a Fusion instance.
  *
  * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
  *
@@ -88,15 +88,15 @@ export type WidgetModelSuccessState = {
  *
  * - [Modify Chart Type](https://www.sisense.com/platform/compose-sdk/playground/?example=fusion-assets%2Fuse-get-widget-model-change-chart-type)
  *
- * @param params - Parameters of the widget to be retrieved
  * @returns Widget load state that contains the status of the execution, the result widget model, or the error if one has occurred
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const useGetWidgetModel: (params: GetWidgetModelParams) => WidgetModelState;
 /**
  * {@link useGetWidgetModel} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the widget to be retrieved
  * @internal
  */
 export declare function useGetWidgetModelInternal(params: GetWidgetModelParams): WidgetModelState;

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

@@ -1,6 +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 { CompleteThemeSettings } from '../../types.js';
 import { WidgetDto } from '../../dashboard-widget/types.js';
 import { AppSettings } from '../../app/settings/settings.js';
@@ -100,7 +101,6 @@ export declare function toTableWidgetProps(widgetModel: WidgetModel): TableWidge
 
  * Note: this method is not supported for chart or table widgets.
  * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
- * Use {@link toTableWidgetProps} instead for getting props for the <TableWidget> component.
  */
 export declare function toPivotTableWidgetProps(widgetModel: WidgetModel): PivotTableWidgetProps;
 /**
@@ -144,3 +144,20 @@ export declare function toWidgetProps(widgetModel: WidgetModel): WidgetProps;
  * @internal
  */
 export declare function fromWidgetDto(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): WidgetModel;
+/**
+ * Creates a {@link WidgetModel} from a {@link ChartWidgetProps}.
+ *
+ * @param chartWidgetProps - The ChartWidgetProps to be converted to a widget model
+ * @returns WidgetModel
+ * @internal
+ */
+export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps): WidgetModel;
+/**
+ * Translates a {@link WidgetModel} to {@link WidgetDto}.
+ *
+ * @param widgetModel - The WidgetModel to be converted to a widgetDto
+ * @param dataSource - The full datasource details
+ * @returns WidgetDto
+ * @internal
+ */
+export declare function toWidgetDto(widgetModel: WidgetModel, dataSource: JaqlDataSource): WidgetDto;

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

@@ -12,7 +12,7 @@ export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions | Empty
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
  *
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export interface WidgetModel {
@@ -171,9 +171,7 @@ export interface WidgetModel {
   
      * Note: this method is not supported for chart or table widgets.
      * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * Use {@link getTableWidgetProps} instead for getting props for the <TableWidget> component.
      * @deprecated Use {@link widgetModelTranslator.toPivotTableWidgetProps} instead
-     * @internal
      */
     getPivotTableWidgetProps(): PivotTableWidgetProps;
     /**

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

@@ -6,10 +6,10 @@ import { GenericDataOptions } from '../types';
  *
  * @alpha
  */
-export interface PluginComponentProps {
+export interface PluginComponentProps<DataOptions = GenericDataOptions, StyleOptions = any> {
     dataSource?: DataSource;
-    dataOptions: GenericDataOptions;
-    styleOptions: any;
+    dataOptions: DataOptions;
+    styleOptions: StyleOptions;
     filters?: Filter[];
     highlights?: Filter[];
 }
@@ -19,4 +19,4 @@ export interface PluginComponentProps {
  *
  * @alpha
  */
-export type PluginComponent = (props: PluginComponentProps) => ReactNode;
+export type PluginComponent<DataOptions = GenericDataOptions, StyleOptions = any> = (props: PluginComponentProps<DataOptions, StyleOptions>) => ReactNode;

package/dist/packages/sdk-ui/src/plugins-provider/use-execute-plugin-query.d.ts

@@ -4,7 +4,7 @@ import { PluginComponentProps } from './types';
 /**
  * Utility function for converting data options to parameters for executing a query.
  *
- * @group Dashboarding
+ * @group Dashboards
  * @alpha
  */
 export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOptions): {
@@ -14,7 +14,7 @@ export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOpt
 /**
  * React hook that takes a plugin component's props and executes a data query.
  *
- * @group Dashboarding
+ * @group Dashboards
  * @alpha
  */
 export declare function useExecutePluginQuery({ dataSource, dataOptions, filters, highlights, }: PluginComponentProps): {

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, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions } 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, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, CustomTranslationObject } 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';
@@ -9,6 +9,7 @@ import { FiltersMergeStrategy } from './dashboard-widget/types';
 import { HookEnableParam } from './common/hooks/types';
 import { ExecuteQueryResult } from './query-execution/types';
 import { Hierarchy } from './models';
+import { BeforeMenuOpenHandler } from './common/components/menu/types';
 export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations and authentication for Sisense Context.
@@ -91,17 +92,6 @@ export interface SisenseContextProviderProps {
      * @category Sisense App Error Handling
      */
     onError?: (error: Error) => void;
-    /**
-     * Boolean flag to enable sending tracking events to the Sisense instance.
-     *
-     * If not specified, the default value is `true`.
-     *
-     * Deprecated: Use {@link AppConfig.trackingConfig | trackingConfig.enabled }
-     *
-     * @deprecated Use {@link AppConfig.trackingConfig | trackingConfig.enabled }
-     * @internal
-     */
-    enableTracking?: boolean;
     /**
      * 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.
@@ -157,7 +147,7 @@ export interface ExecuteQueryProps {
  *
  * OR
  *
- * (2) `ThemeOid` -- Theme identifier as defined in a Fusion Embed instance (**Admin > App Configuration > Look and Feel**).
+ * (2) `ThemeOid` -- Theme identifier as defined in a Fusion instance (**Admin > App Configuration > Look and Feel**).
  * See [Customizing the Sisense User Interface](https://docs.sisense.com/main/SisenseLinux/customizing-the-sisense-user-interface.htm) for more details.
  */
 export type ThemeProviderProps = PropsWithChildren<{
@@ -259,7 +249,7 @@ interface HighchartsBasedChartEventProps {
      * [options values](https://api.highcharts.com/highcharts/) and then return the modified options
      * object. The returned options are then used when rendering the chart.
      *
-     * This callback is not supported for Indicator Chart, Areamap Chart, and Scattermap Chart.
+     * This callback is not supported for Indicator Chart, Areamap Chart, Scattermap Chart, and Table.
      *
      * For an example of how the `onBeforeRender` callback can be used, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
@@ -268,11 +258,21 @@ interface HighchartsBasedChartEventProps {
      */
     onBeforeRender?: BeforeRenderHandler;
 }
+interface BaseChartEventProps {
+    /**
+     * A callback that allows to modify data immediately after it has been retrieved.
+     * Can be used to inject modification of queried data.
+     *
+     * @category Callbacks
+     * @internal
+     */
+    onDataReady?: (data: Data) => Data;
+}
 /**
  * Event props for regular (non-specific) charts which uses DataPoint type
  * to describe data points for events.
  */
-interface RegularChartEventProps extends HighchartsBasedChartEventProps {
+interface RegularChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
     /**
      * A callback that allows you to customize what happens when a data point is clicked.
      *
@@ -302,7 +302,7 @@ interface RegularChartEventProps extends HighchartsBasedChartEventProps {
  * Event props for Scatter chart which uses ScatterDataPoint type
  * to describe data points for events.
  */
-interface ScatterChartEventProps extends HighchartsBasedChartEventProps {
+interface ScatterChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -350,7 +350,7 @@ interface ScattermapChartEventProps {
  * Event props for Boxplot chart which uses BoxplotDataPoint type
  * to describe data points for events.
  */
-interface BoxplotChartEventProps extends HighchartsBasedChartEventProps {
+interface BoxplotChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -375,10 +375,10 @@ interface BoxplotChartEventProps extends HighchartsBasedChartEventProps {
  *
  * @internal
  */
-export interface BaseChartProps {
+export interface BaseChartProps extends BaseChartEventProps {
     /**
      * Data set for a chart using one of the following options. If neither option is specified, the chart
-     * will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider}
+     * will use the `defaultDataSource` specified in the parent `SisenseContextProvider`
      * component.
      *
      *
@@ -386,7 +386,7 @@ export interface BaseChartProps {
      * retrieve the data source name from a data model you create using the `get-data-model`
      * {@link https://sisense.dev/guides/sdk/guides/cli.html | command} of the Compose SDK CLI. Under the hood, the chart
      * connects to the data source, executes a query, and loads the data as specified in
-     * {@link dataOptions}, {@link filters}, and {@link highlights}.
+     * `dataOptions`, `filters`, and `highlights`.
      *
      * To learn more about using data from a Sisense data source, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#sisense-data).
@@ -446,7 +446,7 @@ export interface BaseChartProps {
      * Highlights based on filter criteria to apply to a chart using one of the following options.
      *
      * NOTE that the filter dimensions used in highlights must match those defined in the
-     * {@link dataOptions} of the chart. Otherwise, the filters will be applied as regular slice filters.
+     * `dataOptions` of the chart. Otherwise, the filters will be applied as regular slice filters.
      *
      * (1) Array of {@link Filter} returned from filter factory functions, such as
      * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
@@ -471,7 +471,7 @@ export interface BaseChartProps {
 /**
  * Chart props to be able to react on chart events.
  */
-interface ChartEventProps extends HighchartsBasedChartEventProps {
+interface ChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -1162,12 +1162,22 @@ export interface PluginWidgetProps {
  * This is used to extend the props of a widget with its respective widget type.
  */
 export type WithWidgetType<W extends ChartWidgetProps | PivotTableWidgetProps | TextWidgetProps | PluginWidgetProps, T extends 'chart' | 'pivot' | 'text' | 'plugin'> = W & {
+    /**
+     * 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'>;
+export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | WithWidgetType<PivotTableWidgetProps, 'pivot'> | WithWidgetType<TextWidgetProps, 'text'> | WithWidgetType<PluginWidgetProps, 'plugin'>) & {
+    /**
+     * Optional handler function to process menu options before opening the context menu.
+     *
+     * @internal
+     */
+    onBeforeMenuOpen?: BeforeMenuOpenHandler;
+};
 /**
  * Props for the widget component within a container component like dashboard.
  */
@@ -1459,3 +1469,12 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
      */
     dataSource?: DataSource;
 }
+/**
+ * Params of the {@link CustomTranslationsLoader} component
+ *
+ * @internal
+ */
+export interface CustomTranslationsLoaderProps {
+    customTranslations?: CustomTranslationObject[];
+    children?: React.ReactNode;
+}

package/dist/packages/sdk-ui/src/query-execution/execute-query-by-widget-id.d.ts

@@ -35,7 +35,7 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  * ```
  * @param props - ExecuteQueryByWidgetId properties
  * @returns ExecuteQueryByWidgetId component
- * @group Fusion Embed
+ * @group Fusion Assets
  * @fusionEmbed
  */
 export declare const ExecuteQueryByWidgetId: FunctionComponent<ExecuteQueryByWidgetIdProps>;

package/dist/packages/sdk-ui/src/query-execution/use-execute-csv-query.d.ts

@@ -68,7 +68,6 @@ import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
  }
  return null;
  ```
- * @param params - Parameters of the query
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  * @group Queries
  */
@@ -76,6 +75,7 @@ export declare const useExecuteCsvQuery: (params: ExecuteCsvQueryParams) => CsvQ
 /**
  * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the query
  * @internal
  */
 export declare function useExecuteCsvQueryInternal(params: ExecuteCsvQueryParams): CsvQueryState;