@sisense/sdk-ui 2.29.0 → 2.31.0

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

@@ -1,8 +1,9 @@
-import { ReactNode } from 'react';
 import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import { DashboardHeaderConfig } from '../../domains/dashboarding/components/dashboard-header/dashboard-header-config';
 import { DashboardStyleOptions, WidgetsOptions, WidgetsPanelLayout } from '../../domains/dashboarding/dashboard-model';
 import { TabbersConfig } from '../../domains/dashboarding/hooks/use-tabber';
 import { FiltersPanelConfig } from '../../domains/filters/components/filters-panel/types';
+import { HeaderItem } from '../../domains/shared/header';
 import { WidgetProps } from '../../domains/widgets/components/widget/types';
 import type { DashboardPersistenceManager } from './persistence/types.js';
 export type { DashboardStyleOptions, SpecificWidgetOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetsPanelCell, WidgetsPanelRow, WidgetsPanelColumn, } from '../../domains/dashboarding/dashboard-model';
@@ -111,11 +112,13 @@ export interface DashboardContainerProps {
      */
     onLayoutChange: (layout: WidgetsPanelLayout) => void;
     /**
-     * Render the toolbar
-     *
-     * @internal
+     * Built-in action items rendered in the dashboard header.
+     */
+    headerItems?: HeaderItem[];
+    /**
+     * User configuration for the dashboard header items.
      */
-    renderToolbar?: () => ReactNode;
+    headerConfig?: DashboardHeaderConfig;
 }
 /**
  * Dashboard filters panel configuration
@@ -163,21 +166,34 @@ export interface WidgetsPanelConfig {
      */
     editMode?: EditModeConfig;
     /**
-     * Actions available for all widgets in the panel.
-     *
-     * @sisenseInternal
+     * Configuration for actions available on all widgets in the panel, such as
+     * downloading each widget's data.
      */
     actions?: {
         /**
-         * Configuration for downloading a widget CSV.
+         * Configuration for the "Download as CSV" action on all widgets in the panel,
+         * which adds an item to each widget's header menu that exports the widget's
+         * underlying data as a CSV file.
          *
-         * @sisenseInternal
+         * @example
+         * Enable CSV download for every widget in a dashboard:
+         * ```ts
+         * const dashboardConfig: DashboardConfig = {
+         *   widgetsPanel: {
+         *     actions: {
+         *       downloadCsv: {
+         *         enabled: true,
+         *       },
+         *     },
+         *   },
+         * };
+         * ```
          */
         downloadCsv?: {
             /**
-             * Determines whether the widgets possibility to download a CSV is enabled.
+             * Whether the "Download as CSV" action is enabled for all widgets in the panel.
              *
-             * If not specified, the default value is `false`.
+             * @default false
              */
             enabled?: boolean;
         };
@@ -294,13 +310,21 @@ export interface DashboardConfig {
      */
     filtersPanel?: DashboardFiltersPanelConfig;
     /**
-     * Configuration for the toolbar
+     * Configuration for the dashboard header.
+     */
+    header?: DashboardHeaderConfig;
+    /**
+     * Configuration for the toolbar.
+     *
+     * @deprecated Use the `header` configuration section instead (`header.visible`).
      */
     toolbar?: {
         /**
          * Determines whether the toolbar is visible.
          *
          * If not specified, the default value is `true`.
+         *
+         * @deprecated Use `header.visible` instead.
          */
         visible: boolean;
     };
@@ -351,7 +375,9 @@ export type { DashboardPersistenceManager };
  */
 export interface DashboardProps {
     /**
-     * Optional identifer of the dashboard
+     * Optional unique identifier of the dashboard.
+     *
+     * For dashboards loaded from Fusion (for example, via `DashboardById`), this is populated with the dashboard OID
      *
      * @internal
      */
@@ -397,6 +423,8 @@ export interface DashboardProps {
  * @internal
  */
 export interface DashboardHeaderProps {
-    title: string;
-    toolbar?: () => ReactNode;
+    /** Built-in header items (title, spacer, edit-mode toolbar, toggles, menu) before user config is merged. */
+    items?: HeaderItem[];
+    /** User configuration for the header items. */
+    config?: DashboardHeaderConfig;
 }

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

@@ -1,6 +1,19 @@
+import { DataSource } from '@sisense/sdk-data';
 import { WidgetProps } from '../../domains/widgets/components/widget/types';
-import { WidgetsPanelColumnLayout } from './types.js';
+import { ContextfulTransformer } from '../../shared/utils/utility-types/transformer';
+import { DashboardConfig, WidgetsPanelColumnLayout } from './types.js';
 export declare const getDividerStyle: (color: string, width: number) => string;
+/**
+ * Resolves whether the dashboard header is visible from a dashboard config.
+ *
+ * The header is visible unless explicitly disabled. `header.visible` takes precedence; the
+ * deprecated `toolbar.visible` is honored as a fallback for backward compatibility (and emits a
+ * one-time deprecation warning when it is the value in effect).
+ *
+ * @param config - The dashboard config to resolve header visibility from.
+ * @returns Whether the dashboard header should be rendered.
+ */
+export declare const isDashboardHeaderVisible: (config?: DashboardConfig) => boolean;
 /**
  * Gets the default layout for a set of widgets.
  *
@@ -10,6 +23,25 @@ export declare const getDividerStyle: (color: string, width: number) => string;
  * @returns The default layout for the widgets.
  */
 export declare const getDefaultWidgetsPanelLayout: (widgets: WidgetProps[]) => WidgetsPanelColumnLayout;
+/**
+ * Contextful transformer that returns a copy of the layout with a new full-width row holding
+ * `widgetId` appended to the end of the first column (a column is created if the layout has none).
+ *
+ * @param widgetId - The id of the widget to append.
+ * @returns A transformer over a widgets-panel layout.
+ */
+export declare const withWidgetAppendedToPanelLayout: ContextfulTransformer<WidgetsPanelColumnLayout, string>;
+/**
+ * Contextful transformer that resolves the data source for a widget being added to a dashboard.
+ *
+ * Keeps the widget's own `dataSource` when present; otherwise fills it from the first defined
+ * fallback (e.g. the dashboard default, then the app default). Text widgets, which have no data
+ * source, are returned unchanged.
+ *
+ * @param fallbackDataSources - Ordered fallback data sources; the first defined one is used.
+ * @returns A transformer over a widget that resolves its `dataSource`.
+ */
+export declare const withResolvedWidgetDataSource: ContextfulTransformer<WidgetProps, Array<DataSource | undefined>>;
 /**
  * With optionally disabled auto height.
  *

package/dist/packages/sdk-ui/src/domains/data-browser/add-measure-popover/add-measure-data-browser.d.ts

@@ -0,0 +1,11 @@
+import { BaseMeasure, DataSource } from '@sisense/sdk-data';
+type AddMeasureDataBrowserProps = {
+    dataSources: DataSource[];
+    initialDataSource: DataSource;
+    onMeasureCreated: (measure: BaseMeasure) => void;
+};
+/**
+ * A component that allows users to select a data source and an attribute to create a measure.
+ */
+export declare const AddMeasureDataBrowser: ({ initialDataSource, dataSources, onMeasureCreated, }: AddMeasureDataBrowserProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/packages/sdk-ui/src/domains/data-browser/add-measure-popover/add-measure-popover.d.ts

@@ -0,0 +1,14 @@
+import { BaseMeasure, DataSource } from '@sisense/sdk-data';
+type AddMeasurePopoverProps = {
+    anchorEl: HTMLElement;
+    isOpen: boolean;
+    onClose?: () => void;
+    dataSources: DataSource[];
+    initialDataSource: DataSource;
+    onMeasureCreated: (measure: BaseMeasure) => void;
+};
+/**
+ * A popover with "data browser" that allows users to select a data source and an attribute to create a measure.
+ */
+export declare const AddMeasurePopover: ({ anchorEl, isOpen, onClose, dataSources, initialDataSource, onMeasureCreated, }: AddMeasurePopoverProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/packages/sdk-ui/src/domains/data-browser/add-measure-popover/measure-ranking-title.d.ts

@@ -0,0 +1,21 @@
+import { AggregationType, Measure } from '@sisense/sdk-data';
+import type { TFunction } from 'i18next';
+/**
+ * Builds a human-readable measure title from an aggregation type and attribute name.
+ *
+ * @param aggregation - Measure aggregation type.
+ * @param attributeName - Attribute name appended to the aggregation label.
+ * @param t - Translation function for aggregation labels.
+ * @returns Human-readable measure title.
+ * @internal
+ */
+export declare function buildMeasureRankingTitle(aggregation: AggregationType, attributeName: string, t: TFunction): string;
+/**
+ * Returns the ranked-by display label for a measure.
+ *
+ * @param measure - Measure to display, or null when unset.
+ * @param t - Translation function for aggregation labels.
+ * @returns Display label for the ranked-by field.
+ * @internal
+ */
+export declare function getRankingMeasureDisplayName(measure: Measure | null, t: TFunction): string;

package/dist/packages/sdk-ui/src/domains/data-browser/add-measure-popover/measures.d.ts

@@ -0,0 +1,13 @@
+import { AggregationType, DimensionalAttribute, LevelAttribute } from '@sisense/sdk-data';
+type MeasureConfig = {
+    titleKey: string;
+    name: AggregationType;
+    merged?: boolean;
+    class: string;
+    group: string;
+};
+/**
+ * @internal
+ */
+export declare function getMeasuresListForAttribute(attribute: DimensionalAttribute | LevelAttribute): MeasureConfig[];
+export {};

package/dist/packages/sdk-ui/src/domains/filters/components/criteria-filter-tile/criteria-filter-menu.d.ts

@@ -1,5 +1,5 @@
 import { FunctionComponent } from 'react';
-import { Measure } from '@sisense/sdk-data';
+import { Attribute, Measure } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
 import { CriteriaFilterValueType, FilterOptionType } from './criteria-filter-operations.js';
 /**
@@ -14,6 +14,7 @@ export interface CriteriaFilterMenuProps {
     onUpdate?: (values: CriteriaFilterValueType[]) => void;
     disabled?: boolean;
     measures?: Measure[];
+    attribute?: Attribute;
 }
 /**
  * UI component that provides field(s) for the user to enter values for a numeric filter.

package/dist/packages/sdk-ui/src/domains/filters/components/criteria-filter-tile/criteria-filter-operations.d.ts

@@ -63,5 +63,6 @@ export declare const filterToOption: (filter: Filter) => FilterOptionType;
 export type CriteriaFilterValueType = string | number | Measure;
 export declare const filterToDefaultValues: (filter: Filter) => CriteriaFilterValueType[];
 export declare const valuesToDisplayValues: (values: CriteriaFilterValueType[]) => (string | number)[];
+export declare const getRankingTypeLabel: (filterType: FilterOptionType, t: TFunction) => string;
 export declare const translatedMsgNoVal: (message: string, t: TFunction) => string;
 export declare const filterTypeToInputType: (filterType: string) => string;

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/filter-editor-context.d.ts

@@ -2,6 +2,7 @@ import { ReactNode } from 'react';
 import { DataSource, Filter } from '@sisense/sdk-data';
 type FilterEditorContextValue = {
     defaultDataSource: DataSource | null;
+    dataSources: DataSource[];
     parentFilters: Filter[];
     membersOnlyMode: boolean;
 };

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/filter-editor-popover.d.ts

@@ -10,8 +10,9 @@ type FilterEditorPopoverProps = {
     onClose?: () => void;
     /** Default data source used for filter attribute */
     defaultDataSource?: DataSource;
+    dataSources?: DataSource[];
     config?: FilterEditorConfig;
 };
 /** @internal */
-export declare const FilterEditorPopover: ({ filter, parentFilters, position, onChange, onClose, defaultDataSource, config, }: FilterEditorPopoverProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const FilterEditorPopover: ({ filter, parentFilters, position, onChange, onClose, defaultDataSource, dataSources, config, }: FilterEditorPopoverProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/filter-editor.d.ts

@@ -6,8 +6,9 @@ type FilterEditorProps = {
     onChange?: (filter: Filter | null) => void;
     /** Default data source used for filter attribute */
     defaultDataSource?: DataSource;
+    dataSources?: DataSource[];
     config?: FilterEditorConfig;
 };
 /** @internal */
-export declare const FilterEditor: ({ filter, parentFilters, config, onChange, defaultDataSource, }: FilterEditorProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FilterEditor: ({ filter, parentFilters, config, onChange, defaultDataSource, dataSources, }: FilterEditorProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/sections/numeric-condition-section/types.d.ts

@@ -1,3 +1,4 @@
+import { Measure } from '@sisense/sdk-data';
 export declare const NumericCondition: {
     readonly EXCLUDE: "exclude";
     readonly EQUALS: "numericequals";
@@ -6,6 +7,8 @@ export declare const NumericCondition: {
     readonly LESS_THAN_OR_EQUAL: "numericto";
     readonly GREATER_THAN: "numericfromNotEqual";
     readonly GREATER_THAN_OR_EQUAL: "numericfrom";
+    readonly TOP: "rankingtop";
+    readonly BOTTOM: "rankingbottom";
 };
 export type NumericConditionType = (typeof NumericCondition)[keyof typeof NumericCondition];
 export type NumericConditionFilterData = {
@@ -13,4 +16,6 @@ export type NumericConditionFilterData = {
     value: string;
     selectedMembers: string[];
     multiSelectEnabled: boolean;
+    rankingCount?: number;
+    rankingMeasure?: Measure | null;
 };

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/sections/ranking-condition/index.d.ts

@@ -0,0 +1,3 @@
+export { RankingConditionControls } from './ranking-condition-controls.js';
+export { createRankingFilter, DEFAULT_DATETIME_RANKING_COUNT, DEFAULT_RANKING_COUNT, getRankingCountFromFilter, getRankingMeasureFromFilter, getRankingStateFromFilter, isRankingCondition, } from './ranking-condition-utils.js';
+export type { RankingConditionType } from './ranking-condition-utils.js';

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/sections/ranking-condition/ranking-condition-controls.d.ts

@@ -0,0 +1,33 @@
+import { Measure } from '@sisense/sdk-data';
+/**
+ * Props for the ranking count, date level, and ranked-by measure controls.
+ *
+ * @property count - Current ranking count (minimum 1).
+ * @property measure - Selected measure used to rank members, or null when unset.
+ * @property onCountChange - Called when the user changes the ranking count.
+ * @property onMeasureChange - Called when the user selects a measure from the popover.
+ * @property showRankedBy - Whether to render the ranked-by measure selector (default true).
+ * @property showDateLevel - Whether to render the date level selector (default false).
+ * @property dateLevel - Current date granularity when `showDateLevel` is true.
+ * @property onDateLevelChange - Called when the user changes the date level.
+ * @property disabled - Disables count input and ranked-by selector when true.
+ */
+export type RankingConditionControlsProps = {
+    count: number;
+    measure: Measure | null;
+    onCountChange: (count: number) => void;
+    onMeasureChange: (measure: Measure) => void;
+    showRankedBy?: boolean;
+    showDateLevel?: boolean;
+    dateLevel?: string;
+    onDateLevelChange?: (granularity: string) => void;
+    disabled?: boolean;
+};
+/**
+ * Renders shared Top/Bottom ranking controls: count input, optional date level, and ranked-by measure.
+ *
+ * @param props - Ranking control state and change handlers.
+ * @returns Fragment containing ranking UI controls.
+ * @internal
+ */
+export declare const RankingConditionControls: ({ count, measure, onCountChange, onMeasureChange, showRankedBy, showDateLevel, dateLevel, onDateLevelChange, disabled, }: RankingConditionControlsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/domains/filters/components/filter-editor-popover/sections/ranking-condition/ranking-condition-utils.d.ts

@@ -0,0 +1,13 @@
+import { Attribute, Filter, Measure } from '@sisense/sdk-data';
+import { FilterOption } from '../../../criteria-filter-tile/criteria-filter-operations.js';
+export declare const DEFAULT_RANKING_COUNT = 10;
+export declare const DEFAULT_DATETIME_RANKING_COUNT = 1;
+export type RankingConditionType = typeof FilterOption.TOP | typeof FilterOption.BOTTOM;
+export declare function isRankingCondition(condition: string): condition is RankingConditionType;
+export declare function getRankingCountFromFilter(filter: Filter): number;
+export declare function getRankingMeasureFromFilter(filter: Filter): Measure | null;
+export declare function getRankingStateFromFilter(filter: Filter): {
+    count: number;
+    measure: Measure | null;
+};
+export declare function createRankingFilter(baseFilter: Filter, condition: RankingConditionType, count: number, measure: Measure | null, attributeOverride?: Attribute): Filter | null;

package/dist/packages/sdk-ui/src/domains/filters/components/filters-panel/filters-panel.d.ts

@@ -51,7 +51,6 @@ export interface FiltersPanelProps {
  *   );
  * }
  * ```
- *
  * @group Filter Tiles
  */
 export declare const FiltersPanel: import("react").FunctionComponent<FiltersPanelProps>;

package/dist/packages/sdk-ui/src/domains/filters/components/filters-panel/hooks/use-existing-filter-editing.d.ts

@@ -3,6 +3,7 @@ import type { UseExistingFilterEditingConfig } from '../types';
 type UseExistingFilterEditingParams = {
     onFilterChanged: (filter: Filter) => void;
     defaultDataSource?: DataSource;
+    dataSources?: DataSource[];
     config?: UseExistingFilterEditingConfig;
 };
 type UseExistingFilterEditingReturn = {
@@ -13,6 +14,6 @@ type UseExistingFilterEditingReturn = {
  * Hook that keeps editing process of existing filters.
  * Returns a function to start editing a filter and a component that renders the filter editing popover.
  */
-export declare const useExistingFilterEditing: ({ config, defaultDataSource, onFilterChanged, }: UseExistingFilterEditingParams) => UseExistingFilterEditingReturn;
+export declare const useExistingFilterEditing: ({ config, defaultDataSource, dataSources, onFilterChanged, }: UseExistingFilterEditingParams) => UseExistingFilterEditingReturn;
 export declare function isFilterSupportEditing(filter: Filter): boolean;
 export {};

package/dist/packages/sdk-ui/src/domains/narrative/components/narrative-collapsible.d.ts

@@ -1,13 +1,31 @@
 type NarrativeCollapsibleProps = {
     text: string;
+    noCollapse?: boolean;
+    /** When true, shows the loading overlay over the text area at its settled height. */
+    isLoading?: boolean;
+    isError?: boolean;
+    /** Fired when the collapsed state toggles. */
+    onCollapsedChange?: (isCollapsed: boolean) => void;
+    /**
+     * Reserved height in pixels for the collapsed state (line-aligned internally).
+     * The container always occupies this much vertical space; "show more" only appears when
+     * the text overflows it. Defaults to 5 text rows when `undefined`.
+     */
+    constrainedHeightPx?: number;
+    /**
+     * Absolute pixel cap applied when the narrative is expanded.
+     * Text scrolls rather than exceeding this limit.
+     */
+    maxConstrainedHeightPx?: number;
 };
 /**
- * Text container with an expand/collapse control for long narrative text.
+ * Narrative-specific collapsible: always reserves the collapsed height to prevent widget
+ * layout shifts during data loads.
  *
- * Uses `max-height` + `overflow: hidden` when collapsed (not `line-clamp`), because
- * `white-space: pre-wrap` is incompatible with `-webkit-line-clamp` in browsers.
+ * Thin wrapper around {@link Collapsible} that maps legacy prop names and sets
+ * narrative-appropriate defaults.
  *
  * @internal
  */
-export declare function NarrativeCollapsible({ text }: NarrativeCollapsibleProps): import("react/jsx-runtime").JSX.Element;
+export declare function NarrativeCollapsible({ constrainedHeightPx, maxConstrainedHeightPx, ...rest }: NarrativeCollapsibleProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/packages/sdk-ui/src/domains/narrative/components/narrative-top-slot-shell.d.ts

@@ -4,6 +4,7 @@ import { Themable } from '../../../infra/contexts/theme-provider/types.js';
 export declare const NARRATIVE_TOP_SLOT_LEADING_GUTTER_PX = 18;
 /** Space after feedback controls (interactive) and plain narrative right inset. */
 export declare const NARRATIVE_TOP_SLOT_TRAILING_GUTTER_PX = 12;
+export declare const NARRATIVE_TOP_SLOT_PADDING_TOP = 8;
 /**
  * Full-bleed chart panel styling for narrative content in a widget top slot,
  * so it visually continues into the chart content area (same colors, no gray gutters).
@@ -15,6 +16,7 @@ export declare const NARRATIVE_TOP_SLOT_TRAILING_GUTTER_PX = 12;
  */
 export declare const NarrativeTopSlotShell: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme | undefined;
+    /** `gap` between icon and collapsible text in the narrative row. */
     as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
 } & Themable & {
     $horizontalInset?: boolean | undefined;

package/dist/packages/sdk-ui/src/domains/narrative/components/narrative-trigger-button.d.ts

@@ -0,0 +1,17 @@
+type NarrativeTriggerButtonProps = {
+    onClick: () => void;
+    isVisible: boolean;
+};
+/**
+ * Toolbar icon button that triggers on-demand narrative generation when autoShow=false.
+ * Shows a "generate" icon when the narrative is hidden and a "hide" icon when visible.
+ * Rendered inside the widget header toolbar via an injected renderToolbar wrapper.
+ *
+ * @param props - Component props.
+ * @param props.onClick - Callback fired when the button is clicked.
+ * @param props.isVisible - Whether the narrative is currently visible; controls which icon is shown.
+ * @returns A tooltip-wrapped icon button.
+ * @internal
+ */
+export declare function NarrativeTriggerButton({ onClick, isVisible }: NarrativeTriggerButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/packages/sdk-ui/src/domains/narrative/components/widget-narrative-interactive.d.ts

@@ -1,11 +1,29 @@
+/// <reference types="react" />
 import type { NarrativeRequest } from '../../../infra/api/narrative/narrative-api-types.js';
+import { Themable } from '../../../infra/contexts/theme-provider/types';
 export type WidgetNarrativeInteractiveProps = {
-    summary: string;
+    text: string;
+    isError?: boolean;
+    isLoading?: boolean;
     narrativeRequest: NarrativeRequest;
+    onCollapsedChange?: (isCollapsed: boolean) => void;
+    constrainedHeightPx?: number;
+    maxConstrainedHeightPx?: number;
+    noCollapse?: boolean;
 };
+export declare const NarrativeTopSlotRow: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+export declare const IconDiv: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
+} & Themable, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+/** Sparkle AI icon rendered next to every narrative. */
+export declare function NarrativeAiIcon({ theme }: Themable): import("react/jsx-runtime").JSX.Element;
 /**
  * Chart-area narrative text with optional thumbs feedback; mirrors legacy ChartInsights without `modules/ai`.
  *
  * @internal
  */
-export declare function WidgetNarrativeInteractive({ summary, narrativeRequest, }: WidgetNarrativeInteractiveProps): import("react/jsx-runtime").JSX.Element;
+export declare function WidgetNarrativeInteractive({ text, isError, isLoading, narrativeRequest, onCollapsedChange, constrainedHeightPx, maxConstrainedHeightPx, noCollapse, }: WidgetNarrativeInteractiveProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,22 +1,24 @@
 /// <reference types="react" />
 import { WidgetProps } from '../../../domains/widgets/components/widget/types';
-import type { WidgetNarrativeOptions } from '../core/widget-narrative-options.js';
+import type { HookEnableParam } from '../../../shared/hooks/types';
 /**
  * Props for {@link WidgetNarrative}.
  *
+ * @remarks
+ * Narrative options are read from `widgetProps.config.narrative` for chart and pivot widgets.
+ * Accepts {@link HookEnableParam}; `enabled` is forwarded to {@link useWidgetNarrativeState}.
  * @sisenseInternal
  */
 export type WidgetNarrativeProps = {
     /** Widget whose query drives the narrative (chart or pivot). */
     widgetProps: WidgetProps;
-    /**
-     * `default` — collapsible narrative with AI feedback actions (same pattern as NLQ chart insights).
-     * `plain` — collapsible text only (similar to the `GetNlgInsights` component).
-     */
-    variant?: 'default' | 'plain';
-    /** When false, the narrative query does not run (see {@link useWidgetNarrativeState}). */
-    enabled?: boolean;
-} & WidgetNarrativeOptions;
+    /** Fired when the collapsed state of the narrative text changes (expand/collapse mode only). */
+    onCollapsedChange?: (isCollapsed: boolean) => void;
+    /** Forwarded to {@link NarrativeCollapsible} — external height constraint in pixels. */
+    constrainedHeightPx?: number;
+    /** Forwarded to {@link NarrativeCollapsible} — max height constraint in pixels. (Limit after 'show more' is expanded) */
+    maxConstrainedHeightPx?: number;
+} & HookEnableParam;
 /**
  * Renders a natural-language narrative for chart or pivot `WidgetProps`. The request uses the same
  * JAQL as the widget query (chart or pivot)—compose it next to or above a `ChartWidget` or

package/dist/packages/sdk-ui/src/domains/narrative/core/build-narrative-request.d.ts

@@ -22,7 +22,7 @@ export interface UseGetNlgInsightsParams {
     verbosity?: 'Low' | 'High';
 }
 /**
- * Parameters for building a narration request (before JAQL payload expansion).
+ * Parameters for building a narrative request (before JAQL payload expansion).
  *
  * @sisenseInternal
  */

package/dist/packages/sdk-ui/src/domains/narrative/core/get-narrative-dimensions-and-measures.d.ts

@@ -3,7 +3,7 @@ import { type AdaptMeasuresForQueryOptions } from '../../../domains/visualizatio
 import type { TableDataOptions } from '../../../domains/visualizations/core/chart-data-options/types.js';
 import { ChartDataOptions, ChartType } from '../../../types';
 /**
- * Dimensions and measures for narration / JAQL, including styled sort, trend, and forecast.
+ * Dimensions and measures for narrative / JAQL, including styled sort, trend, and forecast.
  *
  * @internal
  */
@@ -12,7 +12,7 @@ export declare function getNarrativeDimensionsAndMeasures(chartDataOptions: Char
     measures: Measure[];
 };
 /**
- * Table dimensions and measures for narration / JAQL, including styled sort, trend, and forecast.
+ * Table dimensions and measures for narrative / JAQL, including styled sort, trend, and forecast.
  *
  * @internal
  */

package/dist/packages/sdk-ui/src/domains/narrative/core/get-widget-narrative-from-widget-props.d.ts

@@ -0,0 +1,18 @@
+import type { WidgetNarrativeConfig } from '../../../domains/narrative/core/widget-narrative-config';
+import type { ChartWidgetProps } from '../../../domains/widgets/components/chart-widget/types.js';
+import type { PivotTableWidgetProps } from '../../../domains/widgets/components/pivot-table-widget/types.js';
+import type { WidgetProps } from '../../../domains/widgets/components/widget/types.js';
+type WidgetPropsWithNarrativeSupport = ChartWidgetProps | PivotTableWidgetProps | Extract<WidgetProps, {
+    widgetType: 'chart';
+} | {
+    widgetType: 'pivot';
+}>;
+/**
+ * Returns narrative config from chart or pivot widget props (`config.narrative`).
+ *
+ * @param props - Chart or pivot widget props (standalone or {@link WidgetProps} chart/pivot branches)
+ * @returns `WidgetNarrativeConfig` when present
+ * @internal
+ */
+export declare function getWidgetNarrativeConfigFromWidgetProps(props: WidgetPropsWithNarrativeSupport): WidgetNarrativeConfig | undefined;
+export {};

package/dist/packages/sdk-ui/src/domains/narrative/core/to-nlg-api-verbosity.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Maps SDK narrative verbosity (`low` / `high`) to NLG API values (`Low` / `High`).
+ * @param verbosity - SDK verbosity level (`low` / `high`) or undefined
+ * @returns NLG API verbosity value (`Low` / `High`) or undefined when verbosity is undefined
+ * @internal
+ */
+export declare function toNlgApiVerbosity(verbosity?: 'low' | 'high'): 'Low' | 'High' | undefined;