@sisense/sdk-ui 2.24.0 → 2.26.0

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

@@ -0,0 +1,26 @@
+import type { HttpClient } from '@sisense/sdk-rest-client';
+import type { NarrativeRequest, NarrativeResponse } from './narrative-api-types.js';
+/** Unified narrative endpoint. Try first; fall back to legacy on 404. */
+export declare const UNIFIED_NARRATIVE_ENDPOINT = "api/v2/ai/narrative";
+/** Legacy endpoint (used when unified narrative returns 404). */
+export declare const LEGACY_NARRATIVE_ENDPOINT = "api/v2/ai/nlg/queryResult";
+/**
+ * Options for getNarrative. All endpoint choice logic lives in this module.
+ *
+ * @internal
+ */
+export type GetNarrativeOptions = {
+    isUnified?: boolean;
+    isSisenseAiEnabled?: boolean;
+};
+/**
+ * Fetches Narrative. Single place for endpoint logic: `isUnified === false` → legacy only;
+ * otherwise try unified endpoint first, fall back to legacy on 404.
+ *
+ * @param httpClient - HttpClient instance
+ * @param request - Narration request payload
+ * @param options - Optional; `isUnified` / `isSisenseAiEnabled` (e.g. from `app.settings.narrative`)
+ * @returns Promise with narration response
+ * @internal
+ */
+export declare function getNarrative(httpClient: HttpClient, request: NarrativeRequest, options?: GetNarrativeOptions): Promise<NarrativeResponse>;

package/dist/packages/sdk-ui/src/infra/api/narrative/send-ai-feedback.d.ts

@@ -0,0 +1,8 @@
+import type { HttpClient } from '@sisense/sdk-rest-client';
+import type { SendAiFeedbackRequest } from './narrative-api-types.js';
+/**
+ * Posts AI / chart insight feedback (thumbs).
+ *
+ * @internal
+ */
+export declare function sendAiFeedback(httpClient: HttpClient, request: SendAiFeedbackRequest): Promise<unknown>;

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

@@ -6,6 +6,17 @@ import { PaletteDto } from '../../infra/api/types/palette-dto';
 import { HierarchyDto, SharedFormulaDto, WidgetDto } from '../../domains/widgets/components/widget-by-id/types';
 import { TranslatableError } from '../translation/translatable-error';
 import type { DashboardDto } from './types/dashboard-dto';
+/** PATCH body for persisting Highcharts navigator scroller bounds on a dashboard widget. */
+export type WidgetDashboardScrollerLocationPatch = {
+    options: Partial<NonNullable<WidgetDto['options']>> & {
+        previousScrollerLocation: {
+            min: number;
+            max: number;
+        };
+    };
+};
+/** Supported PATCH bodies for `RestApi.patchWidgetInDashboard`. */
+export type PatchWidgetInDashboardBody = Partial<Pick<WidgetDto, 'title'>> | WidgetDashboardScrollerLocationPatch;
 type GetDashboardsOptions = {
     searchByTitle?: string;
     fields?: string[];
@@ -84,7 +95,7 @@ export declare class RestApi {
     /**
      * Partially update a widget in a dashboard.
      */
-    patchWidgetInDashboard: (dashboardOid: string, widgetOid: string, patch: Partial<Pick<WidgetDto, 'title'>>, sharedMode?: boolean) => Promise<WidgetDto | undefined>;
+    patchWidgetInDashboard: (dashboardOid: string, widgetOid: string, patch: PatchWidgetInDashboardBody, sharedMode?: boolean) => Promise<WidgetDto | undefined>;
     /**
      * Get shared formulas by ids
      *

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

@@ -13,6 +13,7 @@ export type AppSettings = Required<ConfigurableAppSettings> & ServerSettings;
 type ConfigurableAppSettings = AppConfig;
 /**
  * User role permissions
+ *
  * @internal
  */
 type RoleManifest = {
@@ -63,14 +64,21 @@ type ServerSettings = {
     serverLanguage: string;
     serverVersion: string;
     serverFeatures: FeatureMap;
-    isUnifiedNarrationEnabled?: boolean;
-    isSisenseAiEnabled?: boolean;
+    narrative: {
+        /** From `api/v2/settings/ai` narration.enabled */
+        isEnabled: boolean;
+        /** From globals.props.narrationUnified */
+        isUnified: boolean;
+        /** Computed: unlimited (API sisenseAIEnabled or props) or credit-based narratives */
+        isSisenseAiEnabled: boolean;
+    };
     user: {
         tenant: {
             name: string;
         };
         /**
          * User role permissions
+         *
          * @internal
          */
         permissions: RoleManifest;

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

@@ -5,17 +5,22 @@ import { CustomWidgetComponent, CustomWidgetComponentProps } from './types';
  * @example
  * Example of registering a custom widget in a dashboard:
  * ```tsx
+ * import { useEffect } from 'react';
  * import { useCustomWidgets, DashboardById } from '@sisense/sdk-ui';
  * import CustomHistogramWidget from './custom-histogram-widget';
  *
  * const Example = () => {
- *   const { registerCustomWidget } = useCustomWidgets();
- *   registerCustomWidget('histogramwidget', CustomHistogramWidget);
+ *   const { registerCustomWidget, unregisterCustomWidget } = useCustomWidgets();
+ *
+ *   useEffect(() => {
+ *     registerCustomWidget('histogramwidget', CustomHistogramWidget);
+ *     // Optionally unregister on unmount (e.g. if the widget should only be available within this component)
+ *     return () => unregisterCustomWidget('histogramwidget');
+ *   }, [registerCustomWidget, unregisterCustomWidget]);
  *
  *   return <DashboardById dashboardOid="your-dashboard-oid" />;
  * }
  * ```
- *
  * @group Dashboards
  */
 export declare const useCustomWidgets: () => UseCustomWidgetsResult;
@@ -25,6 +30,8 @@ export declare const useCustomWidgets: () => UseCustomWidgetsResult;
 export type UseCustomWidgetsResult = {
     /** Registers a custom widget. */
     registerCustomWidget: <T = CustomWidgetComponentProps>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+    /** Unregisters a legacy custom widget for the given type name. */
+    unregisterCustomWidget: (customWidgetType: string) => void;
     /** Checks if a custom widget is registered. */
     hasCustomWidget: (customWidgetType: string) => boolean;
     /** Gets a custom widget. */

package/dist/packages/sdk-ui/src/infra/contexts/emotion-cache-provider/emotion-cache-provider.d.ts

@@ -1,10 +1,38 @@
 import React, { ReactNode } from 'react';
 export interface EmotionCacheProviderProps {
     children: ReactNode;
+    /**
+     * An ancestor CSS selector (e.g. `'#sdk-scope'`) to prepend to every Emotion
+     * CSS rule to increase specificity.
+     *
+     * When omitted (`undefined`), no prefix logic is applied.
+     */
+    cssSelectorPrefix?: string;
 }
 /**
- * A provider component that uses the Emotion cache, but only creates one if a nonce is found in the DOM.
- * This ensures that styles are injected in a way that is compliant with CSP if necessary.
- * If no nonce is found, it simply renders the children without the CacheProvider.
+ * Provides an Emotion cache to the component tree.  Handles two concerns:
+ *
+ * 1. **CSP nonce** — when a `<meta property="csp-nonce">` tag is present, a
+ *    cache carrying that nonce is created so Emotion's `<style>` tags comply
+ *    with Content Security Policy.
+ *
+ * 2. **CSS selector prefix** — when `cssSelectorPrefix` is provided, a Stylis
+ *    plugin is installed that prepends the selector to every compiled CSS rule,
+ *    increasing specificity so CSDK styles win over host-app overrides.
+ *
+ * The component is designed to be used at two levels:
+ *
+ * - **Top-level** (in `SisenseContextProvider`, no `cssSelectorPrefix` prop) —
+ *   creates a nonce-only cache if needed and establishes the internal context
+ *   so nested instances can detect they are not the first provider.
+ *
+ * - **Nested** (in `ThemeProvider`, with `cssSelectorPrefix` prop) — compares
+ *   the requested prefix against the ancestor's value via `EmotionCacheContext`.
+ *   A new cache is created only when the prefix has actually changed; otherwise
+ *   children are rendered as-is, reusing the ancestor's cache.
+ *
+ * When a nested provider creates a cache (nonce is always included when present),
+ * it also updates `EmotionCacheContext` so that further nested providers can
+ * detect the new prefix value and avoid creating duplicate caches.
  */
 export declare const EmotionCacheProvider: React.FC<EmotionCacheProviderProps>;

package/dist/packages/sdk-ui/src/infra/contexts/emotion-cache-provider/stylis-plugins/css-selector-prefix-plugin.d.ts

@@ -0,0 +1,18 @@
+import type { Middleware } from 'stylis';
+/**
+ * Creates a Stylis plugin that prepends a CSS selector prefix to every rule.
+ *
+ * Given configured prefix, for example "#sdk-root", a compiled rule like ".css-abc { color: red }"
+ * becomes "#sdk-root .css-abc { color: red }", increasing its specificity so
+ * that library styles win over same-specificity rules from the host application.
+ *
+ * Operating at the Stylis (CSS compilation) layer means all CSS is covered —
+ * template strings, interpolation functions, object styles, and keyframe
+ * declarations — without any changes to the styled-component call sites.
+ *
+ * @param prefix - An ancestor CSS selector, e.g. `'#sdk-scope'` or `'.my-app'`.
+ *   Must match an element that wraps all library components in the DOM.
+ * @returns A Stylis v4 middleware function compatible with `@emotion/cache`'s
+ *   `stylisPlugins` option.
+ */
+export declare function createCssSelectorPrefixPlugin(prefix: string): Middleware;

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

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { WidgetPlugin } from './widget-plugins/types.js';
+import type { AnyWidgetPlugin } from './widget-plugins/types.js';
 import type { WidgetPluginRegistry } from './widget-plugins/widget-plugin-registry.js';
 /**
  * Context for accessing registered plugins
@@ -10,7 +10,7 @@ export interface PluginContextValue {
     /**
      * Validated widget plugin declarations (metadata)
      */
-    widgetPlugins: readonly WidgetPlugin[];
+    widgetPlugins: readonly AnyWidgetPlugin[];
     /**
      * Central widget component registry (used for lookup and legacy bridge)
      */

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

@@ -1,4 +1,4 @@
-import type { WidgetPlugin } from './widget-plugins/types.js';
+import type { AnyWidgetPlugin } from './widget-plugins/types.js';
 /**
  * Base plugin information
  *
@@ -55,4 +55,4 @@ export interface PluginValidationResult {
  *
  * @sisenseInternal
  */
-export type Plugin = WidgetPlugin;
+export type Plugin = AnyWidgetPlugin;

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

@@ -131,6 +131,15 @@ export interface WidgetPlugin<Props = CustomVisualizationProps, StyleOptions = C
         };
     };
 }
+/**
+ * Any Widget plugin declaration
+ * Represents heterogeneous widget plugin declarations at registry/context boundaries.
+ * Generic params are intentionally erased because each plugin can define distinct props/style types.
+ * Do not consume component prop types from this alias directly.
+ *
+ * @sisenseInternal
+ */
+export type AnyWidgetPlugin = WidgetPlugin<any, any>;
 /**
  * Props passed to a user-defined custom visualization component.
  *

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/de-de.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/en-us.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-ar.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-es.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/fr-fr.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/it-it.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ja-jp.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ko-kr.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/nl-nl.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/pt-br.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ru-ru.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/tr-tr.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/zh-cn.d.ts

@@ -428,6 +428,15 @@ declare const _default: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/en.d.ts

@@ -425,6 +425,15 @@ export declare const translation: {
     loadingOverlay: {
         label: string;
     };
+    queryDefinition: {
+        showMorePills: string;
+        showLess: string;
+        connectorBy: string;
+        connectorWhere: string;
+        tooltipType: string;
+        tooltipColumn: string;
+        tooltipFormula: string;
+    };
     measures: {
         countShort: string;
         countDistinct: string;

package/dist/packages/sdk-ui/src/infra/translation/resources/index.d.ts

@@ -435,6 +435,15 @@ export declare const resources: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;
@@ -875,6 +884,15 @@ export declare const resources: {
         loadingOverlay: {
             label: string;
         };
+        queryDefinition: {
+            showMorePills: string;
+            showLess: string;
+            connectorBy: string;
+            connectorWhere: string;
+            tooltipType: string;
+            tooltipColumn: string;
+            tooltipFormula: string;
+        };
         measures: {
             countShort: string;
             countDistinct: string;

package/dist/packages/sdk-ui/src/modules/ai/api/chat-rest-api.d.ts

@@ -1,13 +1,12 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { type GetNarrativeOptions } from '../../../infra/api/narrative/narrative-endpoints.js';
 import { ChatContextDetails } from '../../../modules/ai/api/types';
 import type { Chat, ChatContext, ChatRequest, ChatResponse, ChatWithoutHistory, GetNlgInsightsRequest, GetNlqResultRequest, LlmConfig, NlqResult, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
 /** @internal */
 export declare class ChatRestApi {
     private readonly volatile;
     private httpClient;
-    private readonly isUnifiedNarrationEnabled;
-    private readonly isSisenseAiEnabled;
-    constructor(httpClient: HttpClient, volatile?: boolean, isUnifiedNarrationEnabled?: boolean, isSisenseAiEnabled?: boolean);
+    constructor(httpClient: HttpClient, volatile?: boolean);
     getChatContexts: () => Promise<ChatContext[]>;
     private getNlgInsights;
     private getQueryRecommendations;
@@ -20,7 +19,7 @@ export declare class ChatRestApi {
     private deleteChatHistory;
     private sendFeedback;
     ai: {
-        getNlgInsights: (request: GetNlgInsightsRequest) => Promise<import('../../../modules/ai/api/types').GetNlgInsightsResponse>;
+        getNlgInsights: (request: GetNlgInsightsRequest, options?: GetNarrativeOptions) => Promise<import("../../../infra/api/narrative/narrative-api-types").NarrativeResponse>;
         getNlqResult: (contextTitle: string, request: GetNlqResultRequest) => Promise<NlqResult | undefined>;
         getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse | undefined>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;

package/dist/packages/sdk-ui/src/modules/ai/api/types.d.ts

@@ -1,5 +1,5 @@
-import { JaqlQueryPayload } from '@sisense/sdk-query-client';
 import { WidgetProps } from '../../../domains/widgets/components/widget/types';
+import type { GetNlgInsightsResponse as GetNlgInsightsResponseInfra, SendAiFeedbackRequest } from '../../../infra/api/narrative/narrative-api-types.js';
 import { ExpandedQueryModel } from '../../../modules/analytics-composer';
 export interface ChatContext {
     title: string;
@@ -102,17 +102,9 @@ export type NlqResult = Omit<NlqResponseData, 'followupQuestions'>;
 export interface QueryRecommendation extends Omit<NlqResponseData, 'followupQuestions'> {
 }
 export type QueryRecommendationResponse = QueryRecommendation[];
-export interface GetNlgInsightsRequest {
-    jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;
-    verbosity?: 'Low' | 'High';
-}
+export type { GetNlgInsightsRequest } from '../../../infra/api/narrative/narrative-api-types.js';
 /** @internal */
-export interface GetNlgInsightsResponse {
-    data?: {
-        answer: string;
-    };
-    responseType: 'Text';
-}
+export type GetNlgInsightsResponse = GetNlgInsightsResponseInfra;
 /** @internal */
 export declare const NLQ_RESULT_CHART_TYPES: readonly ["indicator", "column", "line", "table", "pie", "bar"];
 /** NLQ result chart types @expandType */
@@ -122,12 +114,8 @@ export interface GetNlqResultRequest {
     timezone?: string;
     chartTypes: NlqResultChartType[];
 }
-export interface SendFeedbackRequest {
-    type: string;
-    data: object;
-    sourceId: string;
-    rating: -1 | 1;
-}
+/** @internal */
+export type SendFeedbackRequest = SendAiFeedbackRequest;
 /**
  * The chat mode to use for a chat session
  *
@@ -135,4 +123,3 @@ export interface SendFeedbackRequest {
  * develop: Enable developers to build queries and charts for embedded analytics
  */
 export type ChatMode = 'analyze' | 'develop';
-export {};

package/dist/packages/sdk-ui/src/modules/ai/chart/nlq-chart-widget.d.ts

@@ -40,6 +40,8 @@ export interface NlqChartWidgetProps {
 /**
  * React component that renders a chart widget based on NLQ response data.
  *
+ * @deprecated Prefer composing `ChartWidget` with `WidgetNarrative` when using `WidgetProps` for new embeds.
+ *
  * @example
  * ```tsx
  * import { NlqChartWidget, NlqResponseData } from '@sisense/sdk-ui/ai';

package/dist/packages/sdk-ui/src/modules/ai/common/collapsible.d.ts

@@ -4,6 +4,9 @@ type CollapsibleProps = {
 /**
  * Text container with an expand/collapse button for text over the character limit.
  *
+ * Uses `max-height` + `overflow: hidden` when collapsed (not `line-clamp`), because
+ * `white-space: pre-wrap` is incompatible with `-webkit-line-clamp` in browsers.
+ *
  * @internal
  */
 export default function Collapsible({ text }: CollapsibleProps): import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/modules/ai/get-nlg-insights-from-widget.d.ts

@@ -1,31 +1,23 @@
-import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
+import type { WidgetNarrativeNlgOptions } from '../../domains/narrative/core/widget-narrative-options.js';
 import { WidgetProps } from '../../domains/widgets/components/widget/types';
 /**
  * Options for {@link getNlgInsightsFromWidget} function.
+ *
  * @internal
  */
-export interface GetNlgInsightsFromWidgetOptions {
-    /** Optional default data source to use if WidgetProps.dataSource is undefined */
-    defaultDataSource?: DataSource;
-    /** The verbosity of the NLG summarization */
-    verbosity?: 'Low' | 'High';
-    /** When false, legacy narration endpoint only; when true or undefined, try unified then fallback. From props.isUnifiedNarrationEnabled. */
-    isUnifiedNarrationEnabled?: boolean;
-    isSisenseAiEnabled?: boolean;
-}
+export type GetNlgInsightsFromWidgetOptions = WidgetNarrativeNlgOptions;
 /**
  * Pure function that fetches NLG insights from WidgetProps.
  *
  * This function converts WidgetProps to the required API format and makes an HTTP request
- * to get natural language insights about the chart data.
+ * to get natural language insights about the chart or pivot data.
  *
- * @param props - WidgetProps containing chart configuration
+ * @param props - WidgetProps containing chart or pivot configuration
  * @param httpClient - HttpClient instance for making API requests
  * @param options - Optional configuration including defaultDataSource and verbosity
  * @returns Promise that resolves to the NLG insights answer string
  * @throws Error if dataSource cannot be resolved or if API response is invalid
- *
  * @example
  * ```typescript
  * import { getNlgInsightsFromWidget } from '@sisense/sdk-ui/ai';

package/dist/packages/sdk-ui/src/modules/ai/index.d.ts

@@ -12,7 +12,8 @@ export { Chatbot, type ChatbotProps } from './chatbot.js';
 export { default as GetNlgInsights, type GetNlgInsightsProps } from './get-nlg-insights.js';
 export { NlqChartWidget, type NlqChartWidgetProps } from './chart/nlq-chart-widget.js';
 export { ChatRestApi } from './api/chat-rest-api.js';
+export type { GetNarrativeOptions } from '../../infra/api/narrative/narrative-endpoints.js';
 export { CustomAiContextProvider, type CustomAiContext, type CustomAiContextProviderProps, } from './custom-ai-context-provider.js';
-export { prepareGetNlgInsightsPayload } from './use-get-nlg-insights.js';
+export { prepareGetNlgInsightsPayload } from '../../domains/narrative/core/build-narrative-request.js';
 export { getNlgInsightsFromWidget, type GetNlgInsightsFromWidgetOptions, } from './get-nlg-insights-from-widget.js';
 export { widgetComposer } from '../../modules/analytics-composer';