@sisense/sdk-ui 1.19.0 → 1.20.0

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

@@ -0,0 +1,146 @@
+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 { CompleteThemeSettings } from '../../types.js';
+import { WidgetDto } from '../../dashboard-widget/types.js';
+import { AppSettings } from '../../app/settings/settings.js';
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
+ *
+ * @example
+ * ```tsx
+ * const {data, isLoading, isError} = useExecuteQuery(widgetModelTranslator.toExecuteQueryParams(widgetModel));
+ * ```
+ *
+ * Note: this method is not supported for getting pivot query.
+ * Use {@link toExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
+ */
+export declare function toExecuteQueryParams(widgetModel: WidgetModel): ExecuteQueryParams;
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the pivot widget.
+ *
+ * @example
+ * ```tsx
+ * const {data, isLoading, isError} = useExecutePivotQuery(widgetModelTranslator.toExecutePivotQueryParams(widgetModel));
+ * ```
+ *
+ * Note: this method is supported only for getting pivot query.
+ * Use {@link toExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
+ */
+export declare function toExecutePivotQueryParams(widgetModel: WidgetModel): ExecutePivotQueryParams;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart.
+ *
+ * @example
+ * ```tsx
+ * <Chart {...widgetModelTranslator.toChartProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ * Use {@link toPivotTableProps} instead for getting props for the <PivotTable> component.
+ */
+export declare function toChartProps(widgetModel: WidgetModel): ChartProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a table.
+ *
+ * @example
+ * ```tsx
+ * <Table {...widgetModelTranslator.toTableProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for chart and pivot widgets.
+ * Use {@link toChartProps} instead for getting props for the <Chart> component.
+ * Use {@link toPivotTableProps} instead for getting props for the <PivotTable> component.
+ */
+export declare function toTableProps(widgetModel: WidgetModel): TableProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table.
+ *
+ * @example
+ * ```tsx
+ * <PivotTable {...widgetModelTranslator.toPivotTableProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for chart or table widgets.
+ * Use {@link toChartProps} instead for getting props for the <Chart> component.
+ * Use {@link toTableProps} instead for getting props for the <Table> component.
+ */
+export declare function toPivotTableProps(widgetModel: WidgetModel): PivotTableProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart widget.
+ *
+ * @example
+ * ```tsx
+ * <ChartWidget {...widgetModelTranslator.toChartWidgetProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ */
+export declare function toChartWidgetProps(widgetModel: WidgetModel): ChartWidgetProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a table widget.
+ *
+ * @example
+ * ```tsx
+ * <TableWidget {...widgetModelTranslator.toTableWidgetProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for chart widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
+ * @internal
+ */
+export declare function toTableWidgetProps(widgetModel: WidgetModel): TableWidgetProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table widget.
+ *
+ * @example
+ * ```tsx
+ * <PivotTableWidget {...widgetModelTranslator.toPivotTableWidgetProps(widgetModel)} />
+ * ```
+
+ * 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;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a text widget.
+ *
+ * @example
+ * ```tsx
+ * <TextWidget {...widgetModelTranslator.toTextWidgetProps(widgetModel)} />
+ * ```
+ *
+ * Note: this method is not supported for chart or pivot widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
+ * Use {@link toPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
+ */
+export declare function toTextWidgetProps(widgetModel: WidgetModel): TextWidgetProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a plugin widget.
+ *
+ * @internal
+ */
+export declare function toPluginWidgetProps(widgetModel: WidgetModel): PluginWidgetProps;
+/**
+ * Translates {@link WidgetModel} to {@link CommonWidgetProps}.
+ *
+ * @internal
+ */
+export declare function toCommonWidgetProps(widgetModel: WidgetModel): CommonWidgetProps;
+/**
+ * Translates {@link WidgetModel} to {@link WidgetProps}.
+ *
+ * @internal
+ */
+export declare function toWidgetProps(widgetModel: WidgetModel): WidgetProps;
+/**
+ * Creates a {@link WidgetModel} from a widget DTO.
+ *
+ * @param widgetDto - The widget DTO to be converted to a widget model
+ * @param themeSettings - The theme settings to be used for the widget model
+ * @param appSettings - The application settings to be used for the widget model
+ * @returns The widget model
+ * @internal
+ */
+export declare function fromWidgetDto(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): WidgetModel;

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

@@ -1,11 +1,10 @@
-import { Filter } from '@sisense/sdk-data';
+import { DataSource, Filter } from '@sisense/sdk-data';
 import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
-import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
+import { WidgetType } from '../../dashboard-widget/types';
 import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
-import { ChartType, DrilldownOptions, CompleteThemeSettings, RenderToolbarHandler, WidgetStyleOptions } from '../../types';
-import { AppSettings } from '../../app/settings/settings';
-import { EmptyObject } from '../../utils/utility-types';
+import { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';
+import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
 /**
  * Widget data options.
  */
@@ -16,11 +15,11 @@ export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions | Empty
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare class WidgetModel {
+export interface WidgetModel {
     /**
      * Unique identifier of the widget.
      */
-    oid: string;
+    readonly oid: string;
     /**
      * Widget title.
      */
@@ -32,17 +31,19 @@ export declare class WidgetModel {
     /**
      * Full name of the widget data source.
      */
-    dataSource: string;
+    dataSource: DataSource;
     /**
      * Widget type.
+     *
+     * @deprecated Use {@link widgetModelTranslator} methods instead
      */
     widgetType: WidgetType;
-    /** @internal */
+    /**
+     * Plugin type. Only present for plugin widgets.
+     *
+     * If this is a plugin widget, this is typically the name/ID of the plugin.
+     */
     pluginType: string;
-    /** @internal */
-    pluginPanels: Panel[];
-    /** @internal */
-    pluginStyles: any;
     /**
      * Widget data options.
      */
@@ -67,27 +68,6 @@ export declare class WidgetModel {
      * Widget drilldown options.
      */
     drilldownOptions: DrilldownOptions;
-    /**
-     * "onDataPointClick" handler for the constructed component
-     *
-     * @internal
-     */
-    componentDataPointClickHandler?: ChartProps['onDataPointClick'];
-    /**
-     * "onDataPointsSelected" handler for the constructed component
-     *
-     * @internal
-     */
-    componentDataPointsSelectedHandler?: ChartProps['onDataPointsSelected'];
-    /**
-     * Creates a new widget model.
-     *
-     * @param widgetDto - The widget DTO to be converted to a widget model
-     * @param themeSettings - The theme settings to be used for the widget model
-     * @param appSettings - The application settings to be used for the widget model
-     * @internal
-     */
-    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings);
     /**
      * Returns the parameters to be used for executing a query for the widget.
      *
@@ -98,6 +78,7 @@ export declare class WidgetModel {
      *
      * 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;
     /**
@@ -110,6 +91,7 @@ export declare class WidgetModel {
      *
      * 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;
     /**
@@ -120,9 +102,9 @@ export declare class WidgetModel {
      * <Chart {...widget.getChartProps()} />
      * ```
      *
-     * Note: this method is not supported for tabular widgets.
-     * Use {@link getTableProps} instead for getting props for the <Table> component.
+     * 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;
     /**
@@ -136,6 +118,7 @@ export declare class WidgetModel {
      * 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;
     /**
@@ -149,6 +132,7 @@ export declare class WidgetModel {
      * 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;
     /**
@@ -160,6 +144,7 @@ export declare class WidgetModel {
      * ```
      *
      * Note: this method is not supported for pivot widgets.
+     * @deprecated Use {@link widgetModelTranslator.toChartWidgetProps} instead
      */
     getChartWidgetProps(): ChartWidgetProps;
     /**
@@ -172,6 +157,7 @@ export declare class WidgetModel {
      *
      * 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;
@@ -186,6 +172,7 @@ export declare class 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;
@@ -197,29 +184,11 @@ export declare class WidgetModel {
      * <TextWidget {...widget.getTextWidgetProps()} />
      * ```
      *
-     * Note: this method is not supported for chart, table, or pivot widgets.
+     * Note: this method is not supported for chart or pivot widgets.
      * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * Use {@link getTableWidgetProps} instead for getting props for the <TableWidget> component.
      * Use {@link getPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
-     *
+     * @deprecated Use {@link widgetModelTranslator.toTextWidgetProps} instead
      */
     getTextWidgetProps(): TextWidgetProps;
-    /**
-     * Registers new "onDataPointClick" handler for the constructed component
-     *
-     * @internal
-     */
-    registerComponentDataPointClickHandler?(handler: NonNullable<ChartProps['onDataPointClick']>): void;
-    /**
-     * Registers new "onDataPointsSelected" handler for the constructed component
-     *
-     * @internal
-     */
-    registerComponentDataPointsSelectedHandler?(handler: NonNullable<ChartProps['onDataPointsSelected']>): void;
-    /**
-     * Registers new "renderToolbar" handler for the constructed component
-     *
-     * @internal
-     */
-    registerComponentRenderToolbarHandler?(handler: RenderToolbarHandler): void;
 }
+export declare const isWidgetModel: (widget: any) => widget is WidgetModel;

package/dist/{pivot-table → packages/sdk-ui/src/pivot-table}/formatters/header-cell-formatters/header-cell-value-formatter.d.ts

@@ -1,3 +1,8 @@
 import type { PivotTableDataOptions } from '../../../chart-data-options/types.js';
 import type { DateFormatter, HeaderCellFormatter } from '../types.js';
 export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter) => HeaderCellFormatter;
+/**
+ * Formats the date time string.
+ * If the date is invalid, it returns the original value.
+ */
+export declare function formatDateTimeString(value: string, dateFormatter: DateFormatter, dateFormat?: string): string;

package/dist/{plugins-provider → packages/sdk-ui/src/plugins-provider}/custom-plugins-provider.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { WidgetPlugin } from './types';
+import { PluginComponent } from './types';
 /** @internal */
 export type CustomPluginsProviderProps = {
     context: CustomPluginsContext;
@@ -7,9 +7,9 @@ export type CustomPluginsProviderProps = {
 };
 /** @internal */
 export type CustomPluginsContext = {
-    pluginMap: Map<string, WidgetPlugin>;
-    registerPlugin: (pluginType: string, plugin: WidgetPlugin) => void;
-    getPlugin: (pluginType: string) => WidgetPlugin | undefined;
+    pluginMap: Map<string, PluginComponent>;
+    registerPlugin: (pluginType: string, plugin: PluginComponent) => void;
+    getPlugin: (pluginType: string) => PluginComponent | undefined;
 };
 /**
  * Custom Plugin Provider component that allows passing external plugins context.

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { PluginComponent } from './types';
+type PluginsContextType = {
+    plugins: Map<string, PluginComponent>;
+    registerPlugin: (pluginType: string, plugin: PluginComponent) => void;
+    getPlugin: (pluginType: string) => PluginComponent | undefined;
+};
+export declare const PluginsContext: import("react").Context<PluginsContextType>;
+export {};

package/dist/{plugins-provider → packages/sdk-ui/src/plugins-provider}/plugins-provider.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { WidgetPlugin } from './types';
+import { PluginComponent } from './types';
 /**
  * Plugin Provider component that allows registering and accessing plugins.
  *
@@ -8,8 +8,11 @@ import { WidgetPlugin } from './types';
 export declare const PluginsProvider: React.FC<{
     children: ReactNode;
 }>;
+/**
+ * @internal
+ */
 export declare const usePlugins: () => {
-    plugins: Map<string, WidgetPlugin>;
-    registerPlugin: (pluginType: string, plugin: WidgetPlugin) => void;
-    getPlugin: (pluginType: string) => WidgetPlugin | undefined;
+    plugins: Map<string, PluginComponent>;
+    registerPlugin: (pluginType: string, plugin: PluginComponent) => void;
+    getPlugin: (pluginType: string) => PluginComponent | undefined;
 };

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

@@ -0,0 +1,22 @@
+import { ReactNode } from 'react';
+import { DataSource, Filter } from '@sisense/sdk-data';
+import { GenericDataOptions } from '../types';
+/**
+ * Props passed to a user-defined widget component.
+ *
+ * @alpha
+ */
+export interface PluginComponentProps {
+    dataSource?: DataSource;
+    dataOptions: GenericDataOptions;
+    styleOptions: any;
+    filters?: Filter[];
+    highlights?: Filter[];
+}
+/**
+ * A user-defined widget component. This is can be specified when registering a
+ * plugin with `registerPlugin` from the `usePlugins` hook.
+ *
+ * @alpha
+ */
+export type PluginComponent = (props: PluginComponentProps) => ReactNode;

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

@@ -0,0 +1,24 @@
+import { Attribute, Measure, QueryResultData } from '@sisense/sdk-data';
+import { GenericDataOptions } from '../types';
+import { PluginComponentProps } from './types';
+/**
+ * Utility function for converting data options to parameters for executing a query.
+ *
+ * @group Dashboarding
+ * @alpha
+ */
+export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOptions): {
+    dimensions: Attribute[];
+    measures: Measure[];
+};
+/**
+ * React hook that takes a plugin component's props and executes a data query.
+ *
+ * @group Dashboarding
+ * @alpha
+ */
+export declare function useExecutePluginQuery({ dataSource, dataOptions, filters, highlights, }: PluginComponentProps): {
+    data: QueryResultData | undefined;
+    isLoading: boolean;
+    isError: boolean;
+};

package/dist/{props.d.ts → 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 } 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 } 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';
@@ -8,6 +8,7 @@ import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
 import { HookEnableParam } from './common/hooks/types';
 import { ExecuteQueryResult } from './query-execution/types';
+import { Hierarchy } from './models';
 export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations and authentication for Sisense Context.
@@ -966,6 +967,8 @@ export interface ChartWidgetProps extends ChartEventProps {
      * @category Widget
      */
     highlightSelectionDisabled?: boolean;
+    /** @internal */
+    onChange?: (props: Partial<ChartWidgetProps>) => void;
 }
 /**
  * Props for the {@link TableWidget} component
@@ -1026,8 +1029,6 @@ export interface TableWidgetProps {
 }
 /**
  * Props for the {@link PivotTableWidget} component
- *
- * @internal
  */
 export interface PivotTableWidgetProps {
     /**
@@ -1089,6 +1090,94 @@ export interface PivotTableWidgetProps {
      */
     description?: string;
 }
+/**
+ * Props for the `TextWidget` component.
+ */
+export interface TextWidgetProps {
+    /**
+     * Style options for the text widget.
+     *
+     * @category Widget
+     */
+    styleOptions: TextWidgetStyleOptions;
+}
+/**
+ * Props for the Plugin Widget component
+ */
+export interface PluginWidgetProps {
+    /**
+     * Plugin type. This is typically the name/ID of the plugin.
+     *
+     * @category Widget
+     */
+    pluginType: string;
+    /**
+     * Data source the query is run against - e.g. `Sample ECommerce`
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     *
+     * @category Data
+     */
+    dataSource?: DataSource;
+    /**
+     * Filters that will slice query results
+     *
+     * @category Data
+     */
+    filters?: Filter[];
+    /**
+     * Filters that will highlight query results
+     *
+     * @category Data
+     */
+    highlights?: Filter[];
+    /**
+     * Configurations for how to interpret and present the data passed to the table
+     *
+     * @category Chart
+     */
+    dataOptions: GenericDataOptions;
+    /**
+     * Style options for the plugin widget.
+     *
+     * @category Widget
+     */
+    styleOptions?: unknown;
+    /**
+     * Title of the widget
+     *
+     * @category Widget
+     */
+    title: string;
+    /**
+     *  Description of the widget
+     *
+     * @category Widget
+     */
+    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.
+ */
+export type WithWidgetType<W extends ChartWidgetProps | PivotTableWidgetProps | TextWidgetProps | PluginWidgetProps, T extends 'chart' | 'pivot' | 'text' | 'plugin'> = W & {
+    widgetType: T;
+};
+/**
+ * Props for the facade widget component.
+ */
+export type CommonWidgetProps = WithWidgetType<ChartWidgetProps, 'chart'> | WithWidgetType<PivotTableWidgetProps, 'pivot'> | WithWidgetType<TextWidgetProps, 'text'> | WithWidgetType<PluginWidgetProps, '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;
+};
 /**
  * Props for {@link ExecuteQueryByWidgetId} component.
  *
@@ -1313,8 +1402,15 @@ 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.
+     *
+     * @category Widget
      */
-    drilldownDimensions: Attribute[];
+    drilldownPaths?: (Attribute | Hierarchy)[];
     /**
      * Initial dimension to apply first set of filters to
      *
@@ -1333,6 +1429,8 @@ export interface DrilldownWidgetProps {
      * @category Widget
      */
     config?: DrilldownWidgetConfig;
+    /** @internal */
+    onChange?: (props: Partial<DrilldownWidgetProps>) => void;
     /**
      * React component to be rendered as context menu
      *
@@ -1361,12 +1459,3 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
      */
     dataSource?: DataSource;
 }
-/**
- * Props for the TextWidget component.
- */
-export type TextWidgetProps = {
-    /**
-     * Style options for the text widget.
-     */
-    styleOptions: TextWidgetStyleOptions;
-};

package/dist/packages/sdk-ui/src/query/date-formats/angular-text-date-format-replacers.d.ts

@@ -0,0 +1,2 @@
+import type { DateFormat } from './apply-date-format';
+export declare function newDateFormatWithExpandedAngularTextFormats(oldFormat: DateFormat, locale: Locale): DateFormat;

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

@@ -33,15 +33,19 @@ export declare const translation: {
             onlyTableWidgetSupported: string;
             onlyPivotWidgetSupported: string;
             onlyTextWidgetSupported: string;
+            onlyPluginWidgetSupported: string;
         };
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;
         invalidFilterType: string;
         secondsDateTimeLevelSupportedOnlyForLive: string;
+        missingMenuRoot: string;
+        missingDataSource: string;
     };
     errorBoxText: string;
     chartNoData: string;
     criteriaFilter: {
+        displayModePrefix: string;
         equals: string;
         notEquals: string;
         lessThan: string;
@@ -119,7 +123,13 @@ export declare const translation: {
     };
     commonFilter: {
         clearSelectionButton: string;
+        selectMenuItem: string;
+        unselectMenuItem: string;
     };
     customFilterTileMessage: string;
+    drilldown: {
+        drillMenuItem: string;
+        breadcrumbsAllSuffix: string;
+    };
 };
 export type TranslationDictionary = typeof translation;