@sisense/sdk-ui 2.23.0 → 2.24.0

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-csv-download.d.ts

@@ -0,0 +1,24 @@
+import type { WidgetProps } from '../../../domains/widgets/components/widget/types.js';
+export type UseWidgetCsvDownloadParams = {
+    widgets: WidgetProps[];
+    /**
+     * CSV download enabled value from `config.widgetsPanel.actions.downloadCsv.enabled`.
+     * Per-widget `config.actions.downloadCsv.enabled` overrides when explicitly set.
+     */
+    enabled: boolean;
+};
+/**
+ * Applies dashboard-level CSV download settings to each widget's `config`.
+ *
+ * Reads `config.widgetsPanel.actions.downloadCsv.enabled` and merges it into
+ * `widget.config.actions.downloadCsv` for every widget.
+ * Widget-level `config.actions.downloadCsv.enabled` takes precedence when defined, so the dashboard-level config acts as a
+ * default rather than replacing explicit widget configuration.
+ *
+ * @param params - Widgets and panel-level CSV toggle
+ * @returns Widgets with resolved `config.actions.downloadCsv.enabled`
+ * @internal
+ */
+export declare function useWidgetCsvDownload({ widgets, enabled }: UseWidgetCsvDownloadParams): {
+    widgets: WidgetProps[];
+};

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

@@ -161,6 +161,26 @@ export interface WidgetsPanelConfig {
      * Edit mode configuration.
      */
     editMode?: EditModeConfig;
+    /**
+     * Actions available for all widgets in the panel.
+     *
+     * @sisenseInternal
+     */
+    actions?: {
+        /**
+         * Configuration for downloading a widget CSV.
+         *
+         * @sisenseInternal
+         */
+        downloadCsv?: {
+            /**
+             * Determines whether the widgets possibility to download a CSV is enabled.
+             *
+             * If not specified, the default value is `false`.
+             */
+            enabled?: boolean;
+        };
+    };
 }
 /**
  * Edit mode configuration

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-translated-data-options.d.ts

@@ -1,5 +1,16 @@
 import { ChartDataOptions, ChartType } from '../../../../../types';
-export declare const useTranslatedDataOptions: (chartDataOptions: ChartDataOptions, chartType: ChartType, isForecastOrTrendChart: boolean) => {
+export declare const useTranslatedDataOptions: (chartDataOptions: ChartDataOptions, chartType: ChartType, isForecastOrTrendChart?: boolean) => {
+    dataOptions: import("../../../core/chart-data-options/types.js").ChartDataOptionsInternal;
+    attributes: import("@sisense/sdk-data").Attribute[];
+    measures: import("@sisense/sdk-data").Measure[];
+    dataColumnNamesMapping: import('../../../../../domains/visualizations/core/chart-data-options/validate-data-options/index.js').DataColumnNamesMapping;
+};
+export declare function getTranslatedDataOptions(chartDataOptions: ChartDataOptions, chartType: ChartType, options?: {
+    /** Indicates if the chart is a forecast or trend chart for temporal routing between legacy and restructured charts processing */
+    isForecastOrTrendChart?: boolean;
+    /** Indicates if the data column names should be generated uniquely */
+    shouldHaveUniqueDataColumnNames?: boolean;
+}): {
     dataOptions: import("../../../core/chart-data-options/types.js").ChartDataOptionsInternal;
     attributes: import("@sisense/sdk-data").Attribute[];
     measures: import("@sisense/sdk-data").Measure[];

package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-csv-download.d.ts

@@ -0,0 +1,18 @@
+import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
+import type { ChartWidgetProps } from './types.js';
+export type UseChartWidgetCsvDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'filters' | 'highlights' | 'config' | 'dataSource'> & {
+    /** Base header config */
+    baseHeaderConfig: WidgetHeaderConfig;
+};
+export type UseChartWidgetCsvDownloadResult = {
+    headerConfig: WidgetHeaderConfig;
+};
+/**
+ * Enhances a chart widget's header with CSV download capabilities:
+ * - Adds the "Download > CSV File" header menu item.
+ * - Executes the CSV query and downloads the result as a CSV file.
+ *
+ * @param props - Chart widget props and base header config
+ * @returns Header config for {@link WidgetContainer}
+ */
+export declare function useChartWidgetCsvDownload(props: UseChartWidgetCsvDownloadParams): UseChartWidgetCsvDownloadResult;

package/dist/packages/sdk-ui/src/domains/widgets/components/custom-widget/use-custom-widget-csv-download.d.ts

@@ -0,0 +1,15 @@
+import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
+import type { CustomWidgetProps } from './types.js';
+export type UseCustomWidgetCsvDownloadParams = Pick<CustomWidgetProps, 'title' | 'dataOptions' | 'filters' | 'highlights' | 'config' | 'dataSource'>;
+export type UseCustomWidgetCsvDownloadResult = {
+    headerConfig: WidgetHeaderConfig;
+};
+/**
+ * Enhances a custom widget's header with CSV download capabilities:
+ * - Adds the "Download > CSV File" header menu item.
+ * - Executes the CSV query and downloads the result as a CSV file.
+ *
+ * @param widgetProps - Custom widget props needed for CSV
+ * @returns Header config for {@link WidgetContainer}
+ */
+export declare function useCustomWidgetCsvDownload(widgetProps: UseCustomWidgetCsvDownloadParams): UseCustomWidgetCsvDownloadResult;

package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/use-pivot-widget-csv-download.d.ts

@@ -0,0 +1,18 @@
+import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
+import type { PivotTableWidgetProps } from './types.js';
+export type UsePivotWidgetCsvDownloadParams = Pick<PivotTableWidgetProps, 'title' | 'dataOptions' | 'filters' | 'highlights' | 'config' | 'dataSource'> & {
+    /** Header config from {@link useWidgetHeaderManagement} (rename menu, etc.). */
+    baseHeaderConfig: WidgetHeaderConfig;
+};
+export type UsePivotWidgetCsvDownloadResult = {
+    headerConfig: WidgetHeaderConfig;
+};
+/**
+ * Enhances a pivot table widget's header with CSV download capabilities:
+ * - Adds the "Download > CSV File" header menu item.
+ * - Executes the CSV query and downloads the result as a CSV file.
+ *
+ * @param props - Pivot widget props and base header config
+ * @returns Header config for {@link WidgetContainer}
+ */
+export declare function usePivotWidgetCsvDownload(props: UsePivotWidgetCsvDownloadParams): UsePivotWidgetCsvDownloadResult;

package/dist/packages/sdk-ui/src/domains/widgets/components/tabber-buttons-widget/types.d.ts

@@ -4,10 +4,6 @@ import { CustomWidgetProps } from '../../../../domains/widgets/components/custom
  *
  */
 export type TabberButtonsWidgetStyleOptions = {
-    /**
-     * Color of the widget description text
-     */
-    descriptionColor?: string;
     /**
      * Background color of the selected tab
      */
@@ -22,6 +18,14 @@ export type TabberButtonsWidgetStyleOptions = {
      * @defaultValue true
      */
     showDescription?: boolean;
+    /**
+     * Description text displayed in the tabber widget (when showDescription is true)
+     */
+    description?: string;
+    /**
+     * Color of the widget description text
+     */
+    descriptionColor?: string;
     /**
      * Whether to show visual separators between tabs
      *
@@ -120,8 +124,4 @@ export interface TabberButtonsWidgetProps extends CustomWidgetProps {
      * Configuration for tabs including names and active tab index
      */
     customOptions: TabberButtonsWidgetCustomOptions;
-    /**
-     * Description text displayed in the widget
-     */
-    description?: string;
 }

package/dist/packages/sdk-ui/src/domains/widgets/components/widget/types.d.ts

@@ -5,7 +5,7 @@ import type { CustomWidgetProps } from '../custom-widget/types';
 import type { PivotTableWidgetProps } from '../pivot-table-widget/types';
 import type { TextWidgetProps } from '../text-widget/types';
 /**
- * Generic widget configuration (e.g. header menu, toolbar).
+ * Generic widget configuration (e.g. header menu, toolbar, actions).
  * Shared across chart, pivot, text, and custom widgets.
  */
 export type WidgetConfig = {
@@ -13,6 +13,26 @@ export type WidgetConfig = {
      * Configurations for the widget header (e.g. toolbar menu items)
      */
     header?: WidgetHeaderConfig;
+    /**
+     * Configuration for widget actions.
+     *
+     * @sisenseInternal
+     */
+    actions?: {
+        /**
+         * Configuration for downloading a CSV file.
+         *
+         * @sisenseInternal
+         */
+        downloadCsv?: {
+            /**
+             * Determines whether the possibility to download a CSV is enabled.
+             *
+             * If not specified, the default value is `false`.
+             */
+            enabled?: boolean;
+        };
+    };
 };
 /**
  * Type of the widget component.

package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/to-widget-dto-style.d.ts

@@ -1,5 +1,5 @@
-import type { AxisLabel, DataLimits, LegendOptions, LineStyleOptions, LineWidth, Markers, Navigator, SeriesLabels } from '../../../../../types.js';
-import type { AxisStyle, CartesianWidgetStyle } from '../types.js';
+import type { AreaStyleOptions, AxisLabel, DataLimits, LegendOptions, LineStyleOptions, LineWidth, Markers, Navigator, SeriesLabels } from '../../../../../types.js';
+import type { AxisStyle, CartesianWidgetStyle, WidgetSubtype } from '../types.js';
 /**
  * Maps SDK legend options to Fusion DTO legend style.
  *
@@ -60,4 +60,13 @@ export declare function toDataLimitsStyle(dataLimits?: DataLimits): CartesianWid
  * @internal
  */
 export declare function toLineWidgetStyle(styleOptions: LineStyleOptions): CartesianWidgetStyle;
+/**
+ * Converts area chart style options to Fusion CartesianWidgetStyle DTO.
+ * Used when serializing an area chart widget back to WidgetDto.
+ *
+ * @param styleOptions - Area style options from WidgetModel.styleOptions
+ * @param widgetSubtype - Resolved Fusion widget subtype (e.g. after `area/basic` default)
+ * @returns Fusion CartesianWidgetStyle for the widget DTO
+ */
+export declare function toAreaWidgetStyle(styleOptions: AreaStyleOptions, widgetSubtype: WidgetSubtype): CartesianWidgetStyle;
 export {};

package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-csv-query-file-loader.d.ts

@@ -0,0 +1,16 @@
+import type { ExecuteCsvQueryParams } from '../../../domains/query-execution/types.js';
+export type CsvExecuteParams = Omit<ExecuteCsvQueryParams, 'enabled'> & {
+    /** Filename for the downloaded CSV file. Defaults to `data.csv`. */
+    filename?: string;
+};
+export type UseCsvQueryLoaderResult = {
+    /** Triggers CSV query execution and browser file download with the given params. */
+    execute: (params: CsvExecuteParams) => void;
+};
+/**
+ * Hook that executes a CSV query on demand and triggers a browser file download.
+ * Call `execute` with query params to start the download; no params are needed at hook initialisation.
+ *
+ * @returns `execute` callback
+ */
+export declare function useCsvQueryFileLoader(): UseCsvQueryLoaderResult;

package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-with-csv-download-menu-item.d.ts

@@ -0,0 +1,22 @@
+import type { WidgetHeaderConfig } from '../../../domains/widgets/shared/widget-header/types.js';
+export type UseWithCsvDownloadMenuParams = {
+    /** Base header config. */
+    baseHeaderConfig: WidgetHeaderConfig;
+    /** Whether the "Download CSV" menu item is enabled. */
+    enabled: boolean;
+    /** Triggers CSV query execution and browser download. */
+    onClick: () => void;
+};
+/**
+ * Appends a "Download > CSV File" item to the widget header menu when enabled.
+ *
+ * If a "Download" group already exists in the menu, the "CSV File" item is added to its `items`.
+ * Otherwise a new "Download" group containing "CSV File" is appended.
+ *
+ * @param params.baseHeaderConfig - Base header config.
+ * @param params.enabled - Whether the "Download CSV" menu item is enabled.
+ * @param params.onClick - Click handler for the "CSV File" leaf item.
+ * @returns Header config to pass to {@link WidgetContainer}
+ * @internal
+ */
+export declare function useWithCsvDownloadMenuItem({ baseHeaderConfig, enabled, onClick, }: UseWithCsvDownloadMenuParams): WidgetHeaderConfig;

package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-header/widget-menu-button.d.ts

@@ -1,4 +1,4 @@
-import { MenuItem } from '../../../../shared/types/menu-item';
+import type { MenuItem } from '../../../../shared/types/menu-item';
 export interface WidgetMenuButtonProps {
     menuItems: MenuItem[];
 }

package/dist/packages/sdk-ui/src/infra/app/client-application.d.ts

@@ -1,11 +1,11 @@
 import { SisenseContextProviderProps } from '../../index';
 import { type ClientApplication } from './types';
-type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth' | 'alternativeSsoHost' | 'disableFusionPalette'> & {
+type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth' | 'alternativeSsoHost' | 'ssoMaxAuthRedirectAttempts' | 'ssoRedirectAttemptsTtlMs' | 'disableFusionPalette'> & {
     /**
      * @internal
      */
     packageName?: string;
 };
 /** @internal */
-export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, alternativeSsoHost, disableFusionPalette, packageName, }: ClientApplicationParams) => Promise<ClientApplication>;
+export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, alternativeSsoHost, ssoMaxAuthRedirectAttempts, ssoRedirectAttemptsTtlMs, disableFusionPalette, packageName, }: ClientApplicationParams) => Promise<ClientApplication>;
 export {};

package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/custom-widgets-provider-adapter.d.ts

@@ -10,7 +10,8 @@ export type CustomWidgetsContextAdapter<T = CustomWidgetComponentProps> = {
 /**
  * Custom Widget Provider Adapter component that allows passing external custom widgets context.
  *
- * Note: it is designed to serve as a bridge for passing pre-initialized custom widget data between an external wrapper and child React components.
+ * Bridges pre-initialized custom widget data from an external wrapper to child React components.
+ * Syncs the widget registry with customWidgetsMap on updates and cleans up on unmount.
  *
  * @internal
  */

package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/use-custom-widgets.d.ts

@@ -1,4 +1,4 @@
-import { CustomWidgetComponent } from './types';
+import { CustomWidgetComponent, CustomWidgetComponentProps } from './types';
 /**
  * Hook that provides API for configuring custom widgets.
  *
@@ -18,8 +18,15 @@ import { CustomWidgetComponent } from './types';
  *
  * @group Dashboards
  */
-export declare const useCustomWidgets: () => {
-    registerCustomWidget: <T = any>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+export declare const useCustomWidgets: () => UseCustomWidgetsResult;
+/**
+ * Result of the `useCustomWidgets` hook.
+ */
+export type UseCustomWidgetsResult = {
+    /** Registers a custom widget. */
+    registerCustomWidget: <T = CustomWidgetComponentProps>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+    /** Checks if a custom widget is registered. */
     hasCustomWidget: (customWidgetType: string) => boolean;
-    getCustomWidget: (customWidgetType: string) => CustomWidgetComponent<any> | undefined;
+    /** Gets a custom widget. */
+    getCustomWidget: (customWidgetType: string) => CustomWidgetComponent | undefined;
 };

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

@@ -0,0 +1,18 @@
+import { type PropsWithChildren } from 'react';
+import { CustomContextProviderProps } from '../../types';
+import type { Plugin } from './types.js';
+/** @internal */
+export type CustomPluginContextProviderContext = {
+    plugins: Plugin[];
+};
+/** @internal */
+export type CustomPluginContextProviderProps = CustomContextProviderProps<CustomPluginContextProviderContext>;
+/**
+ * Custom Plugin Context Provider component that allows passing external plugin context.
+ *
+ * Specifically designed to serve as a bridge for passing plugin context between an
+ * external framework wrapper and child React components.
+ *
+ * @internal
+ */
+export declare const CustomPluginContextProvider: React.FC<PropsWithChildren<CustomPluginContextProviderProps>>;

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

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { WidgetPlugin } from './widget-plugins/types.js';
+import type { WidgetPluginRegistry } from './widget-plugins/widget-plugin-registry.js';
+/**
+ * Context for accessing registered plugins
+ *
+ * @internal
+ */
+export interface PluginContextValue {
+    /**
+     * Validated widget plugin declarations (metadata)
+     */
+    widgetPlugins: readonly WidgetPlugin[];
+    /**
+     * Central widget component registry (used for lookup and legacy bridge)
+     */
+    widgetRegistry: WidgetPluginRegistry;
+}
+/**
+ * Error message when a plugin hook/component is used outside PluginProvider.
+ * @internal
+ */
+export declare const PLUGIN_CONTEXT_MISSING_MESSAGE = "PluginContext is missing. Ensure PluginProvider (or a compatible provider) is an ancestor.";
+/**
+ * React context for plugin management.
+ * Default is null to avoid a shared WidgetPluginRegistry at module load (cross-test/consumer pollution).
+ * PluginProvider supplies a real value; consumers must check for null and throw if missing.
+ */
+export declare const PluginContext: import("react").Context<PluginContextValue | null>;

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

@@ -1,9 +1,9 @@
 import { type ReactNode } from 'react';
-import { Plugin } from './types';
+import { Plugin } from './types.js';
 /**
  * Props for PluginProvider component
  *
- * @internal
+ * @sisenseInternal
  */
 export interface PluginProviderProps {
     /**
@@ -17,5 +17,7 @@ export interface PluginProviderProps {
 }
 /**
  * Plugin Provider component that validates and provides access to plugins
+ *
+ * @sisenseInternal
  */
 export declare const PluginProvider: React.FC<PluginProviderProps>;

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

@@ -1,9 +1,10 @@
+import type { WidgetPlugin } from './widget-plugins/types.js';
 /**
- * Plugin with metadata information
+ * Base plugin information
  *
- * @internal
+ * @sisenseInternal
  */
-export interface Plugin {
+export interface BasePluginInfo {
     /**
      * Unique name identifier for the plugin
      */
@@ -32,7 +33,7 @@ export interface Plugin {
 /**
  * Result of plugin validation
  *
- * @internal
+ * @sisenseInternal
  */
 export interface PluginValidationResult {
     /**
@@ -48,3 +49,10 @@ export interface PluginValidationResult {
      */
     reason?: string;
 }
+/**
+ * Plugin declaration.
+ * Currently only widget plugins are supported.
+ *
+ * @sisenseInternal
+ */
+export type Plugin = WidgetPlugin;

package/dist/packages/sdk-ui/src/infra/plugins/use-widget-plugin-registry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Hook for accessing the widget plugin registry.
+ * Used internally by the CustomWidget renderer to look up components.
+ *
+ * @internal
+ */
+export declare const useWidgetPluginRegistry: () => import("./widget-plugins/widget-plugin-registry.js").WidgetPluginRegistry;

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

@@ -1,4 +1,4 @@
-import { Plugin } from './types';
+import { Plugin } from './types.js';
 /**
  * Validates and returns only valid plugins.
  *