@sisense/sdk-ui 2.29.0 → 2.30.0

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/types.d.ts

@@ -1,7 +1,7 @@
 import { AreamapChartDesignOptions } from '../../../../../domains/visualizations/components/chart/restructured-charts/areamap-chart/types';
 import { StreamgraphChartDesignOptions } from '../../../../../domains/visualizations/components/chart/restructured-charts/highchart-based-charts/cartesians/stackable/streamgraph-chart/types';
 import { ChartType } from '../../../../../types';
-import { AreaChartDesignOptions, AreaRangeChartDesignOptions, BarChartDesignOptions, BaseDesignOptionsType, BoxplotChartDesignOptions, CalendarHeatmapChartDesignOptions, ColumnChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, ScattermapChartDesignOptions, SunburstChartDesignOptions, TreemapChartDesignOptions } from './design-options';
+import { AreaChartDesignOptions, AreaRangeChartDesignOptions, BarChartDesignOptions, BaseDesignOptionsType, BoxplotChartDesignOptions, CalendarHeatmapChartDesignOptions, ColumnChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, PolarChartDesignOptions, SankeyChartDesignOptions, ScatterChartDesignOptions, ScattermapChartDesignOptions, SunburstChartDesignOptions, TreemapChartDesignOptions } from './design-options';
 /**
  * Style configuration for text elements in charts and UI components.
  * Defines the visual appearance and behavior of text rendering.
@@ -91,11 +91,19 @@ export type CalendarHeatmapChartType = (typeof CALENDAR_HEATMAP_CHART_TYPES)[num
 export declare const RANGE_CHART_TYPES: readonly ["arearange"];
 /** AreaRange chart types  @expandType */
 export type RangeChartType = (typeof RANGE_CHART_TYPES)[number];
+export declare const SANKEY_CHART_TYPES: readonly ["sankey"];
+/**
+ * Sankey chart types
+ *
+ * @expandType
+ * @beta
+ */
+export type SankeyChartType = (typeof SANKEY_CHART_TYPES)[number];
 export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator' | 'areamap' | 'arearange';
 /**
  * Design options for a specific chart type
  */
-export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'streamgraph' ? StreamgraphChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'sunburst' ? SunburstChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'calendar-heatmap' ? CalendarHeatmapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : never;
+export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'streamgraph' ? StreamgraphChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'sunburst' ? SunburstChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'calendar-heatmap' ? CalendarHeatmapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : SpecificChartType extends 'sankey' ? SankeyChartDesignOptions : never;
 /** A unique identifier for a series to be found in {@link ChartDataOptionsInternal} */
 type SeriesId = string;
 /**
@@ -123,6 +131,7 @@ export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot"
 export declare const isAreamap: (chartType: ChartType) => chartType is "areamap";
 export declare const isRange: (chartType: ChartType) => chartType is "arearange";
 export declare const isCalendarHeatmap: (chartType: ChartType) => chartType is "calendar-heatmap";
-export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "streamgraph", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "calendar-heatmap", "arearange"];
+export declare const isSankey: (chartType: ChartType) => chartType is "sankey";
+export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "streamgraph", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "calendar-heatmap", "arearange", "sankey"];
 export type DynamicChartType = (typeof ALL_CHART_TYPES)[number];
 export {};

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

@@ -2,7 +2,7 @@ import { ReactNode } from 'react';
 import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import type { ChartWidgetChangeEvent, ChartWidgetDrilldownSelectionsChangedEvent } from '../../../../domains/widgets/change-events';
 import type { ChartEventProps } from '../../../../props';
-import { ChartDataOptions, ChartType, ChartWidgetStyleOptions, DrilldownOptions } from '../../../../types';
+import { ChartDataOptions, ChartType, ChartWidgetStyleOptions, DrilldownOptions, WidgetAiOptions } from '../../../../types';
 import { WidgetConfig } from '../widget/types';
 export type { ChartWidgetChangeEvent, ChartWidgetDrilldownSelectionsChangedEvent };
 /**
@@ -48,6 +48,13 @@ export interface ChartWidgetProps extends ChartEventProps {
      * @category Widget
      */
     styleOptions?: ChartWidgetStyleOptions;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     *
+     * @category Widget
+     * @alpha
+     */
+    aiOptions?: WidgetAiOptions;
     /**
      * List of categories to allow drilldowns on
      *

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

@@ -1,6 +1,6 @@
 import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
 import type { ChartWidgetProps } from './types.js';
-export type UseChartWidgetExcelDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'config' | 'dataSource' | 'id'> & {
+export type UseChartWidgetExcelDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'config' | 'dataSource' | 'filters' | 'id'> & {
     baseHeaderConfig: WidgetHeaderConfig;
 };
 export type UseChartWidgetExcelDownloadResult = {

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

@@ -0,0 +1,28 @@
+import { type ReactNode } from 'react';
+import type { RefObject } from 'react';
+import type { ChartWidgetStyleOptions } from '../../../../types';
+import type { ChartWidgetProps } from './types';
+type UseChartWidgetNarrativeParams = {
+    propsWithDrilldown: ChartWidgetProps;
+    styleOptions: ChartWidgetStyleOptions | undefined;
+};
+type UseChartWidgetNarrativeReturn = {
+    /** Ref to pass to WidgetContainer — measures the content area for height constraints. */
+    contentAreaRef: RefObject<HTMLDivElement | null>;
+    /** styleOptions extended with the narrative trigger button injected into the header toolbar when applicable. */
+    styleOptionsWithNarrative: ChartWidgetStyleOptions | undefined;
+    /** Narrative element for the top slot; non-null only when displayLocation is `above` and narrative is visible. */
+    narrativeTopSlot: ReactNode;
+    /** Narrative element for the bottom slot; non-null only when displayLocation is `below` and narrative is visible. */
+    narrativeBottomSlot: ReactNode;
+    /** Narrative element used as widget content; non-null only when displayLocation is `alone` and narrative is visible. */
+    narrativeAloneContent: ReactNode;
+};
+/**
+ * Encapsulates all narrative-related logic for ChartWidget:
+ * options resolution, visibility state, trigger-button toolbar injection, and height constraints.
+ *
+ * @internal
+ */
+export declare function useChartWidgetNarrative({ propsWithDrilldown, styleOptions, }: UseChartWidgetNarrativeParams): UseChartWidgetNarrativeReturn;
+export {};

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

@@ -1,6 +1,6 @@
 import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
 import type { CustomWidgetProps } from './types.js';
-export type UseCustomWidgetExcelDownloadParams = Pick<CustomWidgetProps, 'title' | 'dataOptions' | 'filters' | 'highlights' | 'config' | 'dataSource' | 'customWidgetType' | 'id'> & {
+export type UseCustomWidgetExcelDownloadParams = Pick<CustomWidgetProps, 'title' | 'dataOptions' | 'filters' | 'config' | 'dataSource' | 'customWidgetType' | 'id'> & {
     baseHeaderConfig: WidgetHeaderConfig;
 };
 export type UseCustomWidgetExcelDownloadResult = {

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

@@ -4,10 +4,10 @@ import { PivotTableWidgetProps } from './types';
  * Computes the outer widget height in auto-height mode.
  *
  * The inner pivot reports only its own table height. The widget reserves additional vertical
- * space above the pivot — the container chrome (header + `spaceAround` padding, SNS-127785) and
- * the optional top slot (e.g. drilldown breadcrumbs, SNS-128141). Callers must sum all such
- * non-pivot reserved space into `reservedHeight` so that pagination at the bottom of the pivot
- * remains reachable.
+ * space above the pivot — the container chrome (header + `spaceAround` padding) and
+ * the optional top slot (e.g. drilldown breadcrumbs, narrative-above). Callers must
+ * sum all such non-pivot reserved space into `reservedHeight` so that pagination at the bottom of
+ * the pivot remains reachable.
  *
  * @param pivotTableHeight - The measured content height of the pivot table.
  * @param reservedHeight - The total non-pivot vertical space the widget reserves (chrome + topSlot).

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

@@ -4,7 +4,7 @@ import type { CustomDataCellFormatter, CustomHeaderCellFormatter } from '../../.
 import { PivotTableDataOptions } from '../../../../domains/visualizations/core/chart-data-options/types';
 import type { PivotTableWidgetChangeEvent, PivotTableWidgetDrilldownSelectionsChangedEvent } from '../../../../domains/widgets/change-events';
 import type { PivotTableDataPointEventHandler } from '../../../../props';
-import { PivotTableDrilldownOptions, PivotTableWidgetStyleOptions } from '../../../../types';
+import { PivotTableDrilldownOptions, PivotTableWidgetStyleOptions, WidgetAiOptions } from '../../../../types';
 import { WidgetConfig } from '../widget/types';
 export type { PivotTableWidgetChangeEvent, PivotTableWidgetDrilldownSelectionsChangedEvent };
 /**
@@ -43,6 +43,12 @@ export interface PivotTableWidgetProps {
      * @category Widget
      */
     styleOptions?: PivotTableWidgetStyleOptions;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     * @category Widget
+     */
+    aiOptions?: WidgetAiOptions;
     /**
      * Widget configuration (e.g. header toolbar menu)
      *

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

@@ -1,6 +1,6 @@
 import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
 import type { PivotTableWidgetProps } from './types.js';
-export type UsePivotWidgetExcelDownloadParams = Pick<PivotTableWidgetProps, 'title' | 'dataOptions' | 'config' | 'dataSource' | 'filters' | 'highlights' | 'id'> & {
+export type UsePivotWidgetExcelDownloadParams = Pick<PivotTableWidgetProps, 'title' | 'dataOptions' | 'config' | 'dataSource' | 'filters' | 'id'> & {
     baseHeaderConfig: WidgetHeaderConfig;
 };
 export type UsePivotWidgetExcelDownloadResult = {

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

@@ -2,3 +2,4 @@ export * from './apply-partial-dto-style.js';
 export * from './extract-unsupported-style-options.js';
 export * from './translate-widget-style-options.js';
 export * from './to-widget-dto-style.js';
+export * from './widget-narrative-style.js';

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

@@ -1,4 +1,4 @@
-import { TabberButtonsWidgetStyleOptions } from '../../../../../types.js';
+import { TabberButtonsWidgetCustomOptions, TabberButtonsWidgetStyleOptions } from '../../../../../types.js';
 import { TabberWidgetDto, TabberWidgetDtoStyle } from '../types.js';
 /**
  * Extracts style options from TabberWidgetDtoStyle.
@@ -21,3 +21,19 @@ export declare function extractTabberButtonsWidgetCustomOptions(tabberDto: Tabbe
     tabNames: string[];
     activeTab: number;
 };
+/**
+ * Builds the tabber DTO style from CSDK tabber style and custom options.
+ * Inverse of {@link extractTabberButtonsWidgetStyleOptions} and
+ * {@link extractTabberButtonsWidgetCustomOptions}: re-encodes the lowercase enum
+ * values back to uppercase, reconstructs the `useSelectedBkg`/`useUnselectedBkg`
+ * flags from the presence of the corresponding background colors, and
+ * re-materializes `tabs`/`activeTab` from the custom options.
+ *
+ * Note: `displayWidgetIds`/`hideWidgetIds` are not represented in the CSDK
+ * widget model, so the re-materialized tabs carry empty id lists.
+ *
+ * @param styleOptions - The tabber style options from WidgetModel.styleOptions
+ * @param customOptions - The tabber custom options from WidgetModel.customOptions
+ * @returns The tabber widget style for the DTO
+ */
+export declare function toTabberWidgetStyle(styleOptions: TabberButtonsWidgetStyleOptions, customOptions: TabberButtonsWidgetCustomOptions): TabberWidgetDtoStyle;

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

@@ -0,0 +1,31 @@
+import type { WidgetDtoNarration, WidgetStyle } from '../../../../../domains/widgets/components/widget-by-id/types.js';
+import type { WidgetNarrativeOptions } from '../../../../../types.js';
+/**
+ * Maps Fusion `style.narration` into SDK {@link WidgetNarrativeOptions},
+ * including `feedback` when present on the DTO.
+ *
+ * Reads boolean `autoShow`; legacy string `displayMode` (`onLoad` / `onClick`) is still accepted for
+ * older payloads when `autoShow` is absent.
+ *
+ * @param dto - Fusion narration payload, if any
+ * @returns Partial narrative options, or `undefined` when absent or empty
+ * @internal
+ */
+export declare function extractWidgetNarrativeOptionsFromDto(dto: WidgetDtoNarration | undefined): WidgetNarrativeOptions | undefined;
+/**
+ * Builds Fusion `style.narration` from SDK {@link WidgetNarrativeOptions} only (typed fields).
+ *
+ * @param narrative - SDK narrative slice from {@link WidgetAiOptions.narrative}
+ * @returns Narration DTO, or `undefined` when nothing should be written
+ * @internal
+ */
+export declare function narrativeOptionsToWidgetDtoNarration(narrative: WidgetNarrativeOptions | undefined): WidgetDtoNarration | undefined;
+/**
+ * Merges narrative options onto a Fusion widget `style` object for {@link toWidgetDto}.
+ *
+ * @param baseStyle - Chart or pivot style object without narration
+ * @param narrative - SDK narrative from {@link WidgetModel.aiOptions}
+ * @returns `WidgetStyle` with narration merged, or base style unchanged when narrative is absent
+ * @internal
+ */
+export declare function mergeWidgetStyleWithNarrativeForDto(baseStyle: WidgetStyle, narrative: WidgetNarrativeOptions | undefined): WidgetStyle;

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

@@ -568,9 +568,38 @@ export type CalendarHeatmapWidgetStyle = {
         month: number;
     };
 };
+/**
+ * Fusion `style.narration` payload (chart widgets and others that support narration).
+ *
+ * @internal
+ */
+export type WidgetDtoNarration = {
+    enabled?: boolean;
+    /** Placement string from Fusion; maps to SDK `displayLocation`. */
+    display?: string;
+    format?: string;
+    verbosity?: string;
+    up_sentiment?: string;
+    aggregation?: string;
+    labels?: readonly {
+        id: string;
+        title: string;
+        singular: string;
+        plural: string;
+    }[];
+    includeTrendAndForecast?: boolean;
+    /** When `true`, narrative is shown as soon as the widget loads */
+    autoShow?: boolean;
+    /** Narrative feedback actions */
+    feedback?: {
+        enabled?: boolean;
+    };
+    /** Fraction (0–1) of the content area height reserved for the narrative; maps to SDK `height`. */
+    size?: number;
+};
 export type WidgetStyle = {
     widgetDesign?: WidgetDesign;
-    narration?: any;
+    narration?: WidgetDtoNarration;
 } & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | PieWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle | CalendarHeatmapWidgetStyle | TextWidgetDtoStyle | TabberWidgetDtoStyle);
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",

package/dist/packages/sdk-ui/src/domains/widgets/helpers/excel-export-map-dimensions-measures.d.ts

@@ -1,4 +1,10 @@
-import { type Attribute, type Measure } from '@sisense/sdk-data';
+import { type Attribute, type CalculatedMeasureColumn, type Measure, type MeasureColumn } from '@sisense/sdk-data';
+import type { StyledMeasureColumn } from '../../../domains/visualizations/core/chart-data-options/types.js';
+import type { NumberFormatConfig } from '../../../types';
+export type MeasureWithExcelExportFormat = Measure & {
+    readonly excelNumberFormatConfig?: NumberFormatConfig;
+};
+type MeasureColumnInput = MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 /**
  * Returns attributes prepared for Excel JAQL export: dimensional level attributes without an
  * explicit display format receive a level-appropriate default so the backend renders human-readable
@@ -15,4 +21,13 @@ export declare function mapAttributesForExcelExport(attributes: readonly Attribu
  * @param measures - Raw measures from chart or pivot translation
  * @returns New array of measures safe to pass as export measures
  */
-export declare function mapMeasuresForExcelExport(measures: readonly Measure[]): Measure[];
+export declare function mapMeasuresForExcelExport(measures: readonly Measure[]): MeasureWithExcelExportFormat[];
+/**
+ * Maps a styled measure column to a measure for Excel export, preserving `numberFormatConfig`.
+ */
+export declare function mapMeasureColumnForExcelExport(column: MeasureColumnInput): MeasureWithExcelExportFormat;
+/**
+ * Maps measure columns to measures for Excel export, preserving per-column `numberFormatConfig`.
+ */
+export declare function mapMeasureColumnsForExcelExport(columns: readonly MeasureColumnInput[]): MeasureWithExcelExportFormat[];
+export {};

package/dist/packages/sdk-ui/src/domains/widgets/helpers/number-format-config-to-numeric-mask.d.ts

@@ -0,0 +1,5 @@
+import type { NumberFormatConfig } from '../../../types';
+/**
+ * Converts Compose {@link NumberFormatConfig} to a Fusion numeric mask for XLSX export metadata.
+ */
+export declare function numberFormatConfigToNumericMask(config: NumberFormatConfig): Record<string, unknown>;

package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-container/widget-container.d.ts

@@ -1,4 +1,4 @@
-import { type ReactNode } from 'react';
+import { type ReactNode, type RefObject } from 'react';
 import { WidgetContainerStyleOptions } from '../../../../types';
 import { TitleEditorConfig, WidgetHeaderConfig } from '../widget-header/types.js';
 export interface WidgetContainerProps {
@@ -16,6 +16,12 @@ export interface WidgetContainerProps {
     bottomSlot?: ReactNode;
     children: ReactNode;
     onRefresh?: () => void;
+    /**
+     * Ref attached to the content area below the header (topSlot + chart + bottomSlot).
+     * Use to measure the available height for narrative-to-chart ratio calculations.
+     * @internal
+     */
+    contentAreaRef?: RefObject<HTMLDivElement | null>;
 }
 /** @internal */
 export declare const WidgetContainer: React.FC<WidgetContainerProps>;

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

@@ -2,7 +2,7 @@ import { DataSource, Filter } from '@sisense/sdk-data';
 import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
 import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../../domains/dashboarding/hooks/jtd/jtd-types';
 import { ChartDataOptions, PivotTableDataOptions } from '../../../domains/visualizations/core/chart-data-options/types';
-import { ChartType, DrilldownOptions, PivotTableDrilldownOptions, WidgetStyleOptions } from '../../../types';
+import { ChartType, DrilldownOptions, PivotTableDrilldownOptions, WidgetAiOptions, WidgetStyleOptions } from '../../../types';
 import type { WidgetType } from '../components/widget/types';
 /**
  * Widget data options.
@@ -49,6 +49,11 @@ export interface WidgetModel {
      * Widget style options.
      */
     styleOptions: WidgetStyleOptions;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     */
+    aiOptions?: WidgetAiOptions;
     /**
      * Custom widget options. Only present for custom widgets.
      *

package/dist/packages/sdk-ui/src/infra/api/narrative/narrative-endpoints.d.ts

@@ -24,9 +24,9 @@ export type GetNarrativeOptions = {
  * retried once with the fallback payload.
  *
  * @param httpClient - HttpClient instance
- * @param request - Narration request payload
+ * @param request - Narrative request payload
  * @param options - Optional; `canGenerateNarrativeViaAI` (typically from `app.settings.narrative`)
- * @returns Promise that resolves with narration JSON or `undefined` (same semantics as `HttpClient.post`)
+ * @returns Promise that resolves with narrative JSON or `undefined` (same semantics as `HttpClient.post`)
  * @internal
  */
 export declare function getNarrative(httpClient: HttpClient, request: NarrativeRequest, options?: GetNarrativeOptions): Promise<NarrativeResponse | undefined>;

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

@@ -160,6 +160,24 @@ export type AppConfig = {
          */
         enabled?: boolean;
     };
+    /**
+     * Configuration of the Narrative feature for widgets
+     * Temporary feature flag to explicitly enable narrative on widgets
+     * (avoid narratives appearing in fusion dashboards/widgets before this feature is released)
+     * @sisenseInternal
+     */
+    narrativeConfig?: {
+        /**
+         * Whether to enable or disable the Widget Narrative feature
+         *
+         * When `true`, the Widget Narrative feature is enabled if the Fusion server supports it.
+         *
+         * When `false`, the Widget Narrative feature is disabled.
+         *
+         * @default false
+         */
+        widgetNarrativeEnabled?: boolean;
+    };
     /**
      * Global configuration for some specific aspects of data visualizations.
      */

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

@@ -1,8 +1,17 @@
-import type { AnyWidgetPlugin } from './widget-plugins/types.js';
+import type { WidgetPlugin } from './widget-plugins/types.js';
 /**
- * Base plugin information
+ * Defines base information shared by all plugin types.
  *
- * @sisenseInternal
+ * @group Plugin System
+ * @example
+ * ```ts
+ * const info: BasePluginInfo = {
+ *   name: 'my-widget-plugin',
+ *   version: '1.0.0',
+ *   requiredApiVersion: '^2.9.0',
+ * };
+ * ```
+ * @beta
  */
 export interface BasePluginInfo {
     /**
@@ -50,9 +59,28 @@ export interface PluginValidationResult {
     reason?: string;
 }
 /**
- * Plugin declaration.
+ * Declares a plugin for registration with the Compose SDK.
  * Currently only widget plugins are supported.
  *
- * @sisenseInternal
+ * @group Plugin System
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ *
+ * const myPlugin: Plugin = {
+ *   name: 'my-widget-plugin',
+ *   version: '1.0.0',
+ *   requiredApiVersion: '^2.9.0',
+ *   pluginType: 'widget',
+ *   customWidget: {
+ *     name: 'my-widget',
+ *     displayName: 'My Widget',
+ *     visualization: { Component: MyVisualization },
+ *   },
+ * };
+ *
+ * <SisenseContextProvider plugins={[myPlugin]} {...props} />
+ * ```
+ * @beta
  */
-export type Plugin = AnyWidgetPlugin;
+export type Plugin = WidgetPlugin<any>;