@sisense/sdk-ui 1.18.1 → 1.20.0

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

@@ -0,0 +1,97 @@
+import { HookEnableParam } from '../../common/hooks/types.js';
+import { HierarchyModel } from '../../models/hierarchy/hierarchy-model';
+import { GetHierarchiesOptions } from './types.js';
+/**
+ * Parameters for {@link useGetHierarchyModels} hook.
+ */
+export interface GetHierarchiesParams extends GetHierarchiesOptions, HookEnableParam {
+}
+/**
+ * States of hierarchy models load.
+ */
+export type HierarchyModelsState = HierarchyModelsLoadingState | HierarchyModelsErrorState | HierarchyModelsSuccessState;
+/**
+ * State of hierarchy models that is loading.
+ */
+export type HierarchyModelsLoadingState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: true;
+    /** Whether the hierarchy models load has failed */
+    isError: false;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: false;
+    /** Error, if one occurred */
+    error: undefined;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: HierarchyModel[] | undefined;
+    /** Loading status */
+    status: 'loading';
+};
+/**
+ * State of a hierarchy models load that has failed.
+ */
+export type HierarchyModelsErrorState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: false;
+    /** Whether the hierarchy models load has failed */
+    isError: true;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: false;
+    /** Error, if one occurred */
+    error: Error;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: undefined;
+    /** Loading status */
+    status: 'error';
+};
+/**
+ * State of a hierarchy models load that has succeeded.
+ */
+export type HierarchyModelsSuccessState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: false;
+    /** Whether the hierarchy models load has failed */
+    isError: false;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: true;
+    /** Error, if one occurred */
+    error: undefined;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: HierarchyModel[];
+    /** Loading status */
+    status: 'success';
+};
+/**
+ * React hook that retrieves existing hierarchy models from a Fusion Embed instance.
+ *
+ * @example
+ * Retrieve the hierarchy models and render their counts.
+ ```tsx
+  const { hierarchies, isLoading, isError } = useGetHierarchyModels({
+    dataSource: DM.DataSource,
+    dimension: DM.Commerce.AgeRange,
+  });
+
+  if (isLoading) {
+    return <div>Loading...</div>;
+  }
+  if (isError) {
+    return <div>Error</div>;
+  }
+  if (hierarchies) {
+    return <div>{`Total Hierarchies: ${hierarchies.length}`}</div>;
+  }
+  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
+ * @fusionEmbed
+ */
+export declare const useGetHierarchyModels: (params: GetHierarchiesParams) => HierarchyModelsState;
+/**
+ * {@link useGetHierarchyModels} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useGetHierarchyModelsInternal(params: GetHierarchiesParams): HierarchyModelsState;

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

@@ -1,2 +1,3 @@
 export * from './dashboard';
 export * from './widget';
+export * from './hierarchy';

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

@@ -1,4 +1,4 @@
-export * from './translate-widget';
 export * from './widget-model';
 export * from './get-widget-model';
 export * from './use-get-widget-model';
+export * as widgetModelTranslator from './widget-model-translator';

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

@@ -6,4 +6,4 @@ import { ChartType } from '../../index';
  *
  * @internal
  */
-export type WidgetTypeInternal = ChartType | 'pivot' | 'plugin';
+export type WidgetTypeInternal = ChartType | 'pivot' | 'plugin' | 'text';

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,25 +1,25 @@
-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 { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
+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 { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';
+import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
 /**
  * Widget data options.
  */
-export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions;
+export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions | EmptyObject;
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
  *
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare class WidgetModel {
+export interface WidgetModel {
     /**
      * Unique identifier of the widget.
      */
-    oid: string;
+    readonly oid: string;
     /**
      * Widget title.
      */
@@ -31,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.
      */
@@ -66,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.
      *
@@ -97,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;
     /**
@@ -109,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;
     /**
@@ -119,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;
     /**
@@ -135,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;
     /**
@@ -148,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;
     /**
@@ -159,6 +144,7 @@ export declare class WidgetModel {
      * ```
      *
      * Note: this method is not supported for pivot widgets.
+     * @deprecated Use {@link widgetModelTranslator.toChartWidgetProps} instead
      */
     getChartWidgetProps(): ChartWidgetProps;
     /**
@@ -171,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;
@@ -185,25 +172,23 @@ 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;
     /**
-     * Registers new "onDataPointClick" handler for the constructed component
+     * Returns the props to be used for rendering a text widget.
      *
-     * @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
+     * @example
+     * ```tsx
+     * <TextWidget {...widget.getTextWidgetProps()} />
+     * ```
      *
-     * @internal
+     * 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
      */
-    registerComponentRenderToolbarHandler?(handler: RenderToolbarHandler): void;
+    getTextWidgetProps(): TextWidgetProps;
 }
+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/packages/sdk-ui/src/plugins-provider/custom-plugins-provider.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+import { PluginComponent } from './types';
+/** @internal */
+export type CustomPluginsProviderProps = {
+    context: CustomPluginsContext;
+    error?: Error;
+};
+/** @internal */
+export type CustomPluginsContext = {
+    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.
+ *
+ * Note: it is designed to serve as a bridge for passing pre-initialized plugin data between an external wrapper and child React components.
+ *
+ * @internal
+ */
+export declare const CustomPluginsProvider: React.FC<{
+    context: CustomPluginsContext;
+    children: ReactNode;
+}>;

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

@@ -0,0 +1,2 @@
+export * from './plugins-provider';
+export * from './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/packages/sdk-ui/src/plugins-provider/plugins-provider.d.ts

@@ -0,0 +1,18 @@
+import { ReactNode } from 'react';
+import { PluginComponent } from './types';
+/**
+ * Plugin Provider component that allows registering and accessing plugins.
+ *
+ * @internal
+ */
+export declare const PluginsProvider: React.FC<{
+    children: ReactNode;
+}>;
+/**
+ * @internal
+ */
+export declare const usePlugins: () => {
+    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;
+};