@sisense/sdk-ui 2.20.0 → 2.22.0

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

@@ -270,6 +270,12 @@ declare const _default: {
                 unknownResponse: string;
                 invalidInput: string;
                 noAvailableDataTopics: string;
+                failedToFetchCreditBalance: string;
+            };
+            quota: {
+                exceededErrorTitle: string;
+                exceededErrorDescription: string;
+                warningDescription: string;
             };
         };
         attribute: {
@@ -389,6 +395,14 @@ declare const _default: {
                 nextGroup: string;
             };
         };
+        filterTile: {
+            menu: {
+                lock: string;
+                unlock: string;
+                lockGroup: string;
+                unlockGroup: string;
+            };
+        };
     };
 }[];
 export default _default;

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

@@ -270,6 +270,12 @@ declare const _default: {
                 unknownResponse: string;
                 invalidInput: string;
                 noAvailableDataTopics: string;
+                failedToFetchCreditBalance: string;
+            };
+            quota: {
+                exceededErrorTitle: string;
+                exceededErrorDescription: string;
+                warningDescription: string;
             };
         };
         attribute: {
@@ -389,6 +395,14 @@ declare const _default: {
                 nextGroup: string;
             };
         };
+        filterTile: {
+            menu: {
+                lock: string;
+                unlock: string;
+                lockGroup: string;
+                unlockGroup: string;
+            };
+        };
     };
 }[];
 export default _default;

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

@@ -267,6 +267,12 @@ export declare const translation: {
             unknownResponse: string;
             invalidInput: string;
             noAvailableDataTopics: string;
+            failedToFetchCreditBalance: string;
+        };
+        quota: {
+            exceededErrorTitle: string;
+            exceededErrorDescription: string;
+            warningDescription: string;
         };
     };
     attribute: {
@@ -386,6 +392,14 @@ export declare const translation: {
             nextGroup: string;
         };
     };
+    filterTile: {
+        menu: {
+            lock: string;
+            unlock: string;
+            lockGroup: string;
+            unlockGroup: string;
+        };
+    };
 };
 /**
  * A reference type containing all currently used translation keys.

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

@@ -277,6 +277,12 @@ export declare const resources: {
                 unknownResponse: string;
                 invalidInput: string;
                 noAvailableDataTopics: string;
+                failedToFetchCreditBalance: string;
+            };
+            quota: {
+                exceededErrorTitle: string;
+                exceededErrorDescription: string;
+                warningDescription: string;
             };
         };
         attribute: {
@@ -396,6 +402,14 @@ export declare const resources: {
                 nextGroup: string;
             };
         };
+        filterTile: {
+            menu: {
+                lock: string;
+                unlock: string;
+                lockGroup: string;
+                unlockGroup: string;
+            };
+        };
     };
     'en-US': {
         errors: {
@@ -666,6 +680,12 @@ export declare const resources: {
                 unknownResponse: string;
                 invalidInput: string;
                 noAvailableDataTopics: string;
+                failedToFetchCreditBalance: string;
+            };
+            quota: {
+                exceededErrorTitle: string;
+                exceededErrorDescription: string;
+                warningDescription: string;
             };
         };
         attribute: {
@@ -785,5 +805,13 @@ export declare const resources: {
                 nextGroup: string;
             };
         };
+        filterTile: {
+            menu: {
+                lock: string;
+                unlock: string;
+                lockGroup: string;
+                unlockGroup: string;
+            };
+        };
     };
 };

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

@@ -1,11 +1,13 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { ChatContextDetails } from '../../../modules/ai/api/types';
-import type { Chat, ChatContext, ChatRequest, ChatResponse, ChatWithoutHistory, GetNlgInsightsRequest, GetNlgInsightsResponse, GetNlqResultRequest, LlmConfig, NlqResult, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './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;
-    constructor(httpClient: HttpClient, volatile?: boolean);
+    private readonly isUnifiedNarrationEnabled;
+    private readonly isSisenseAiEnabled;
+    constructor(httpClient: HttpClient, volatile?: boolean, isUnifiedNarrationEnabled?: boolean, isSisenseAiEnabled?: boolean);
     getChatContexts: () => Promise<ChatContext[]>;
     private getNlgInsights;
     private getQueryRecommendations;
@@ -18,7 +20,7 @@ export declare class ChatRestApi {
     private deleteChatHistory;
     private sendFeedback;
     ai: {
-        getNlgInsights: (request: GetNlgInsightsRequest) => Promise<GetNlgInsightsResponse | undefined>;
+        getNlgInsights: (request: GetNlgInsightsRequest) => Promise<import('../../../modules/ai/api/types').GetNlgInsightsResponse>;
         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/narration-endpoints.d.ts

@@ -0,0 +1,25 @@
+import type { HttpClient } from '@sisense/sdk-rest-client';
+import type { GetNlgInsightsRequest, GetNlgInsightsResponse } from './types.js';
+/** Unified narrative endpoint. Try first; fall back to legacy on 404. */
+export declare const UNIFIED_NARRATION_ENDPOINT = "api/v2/ai/narrative";
+/** Legacy endpoint (used when unified narrative returns 404). */
+export declare const LEGACY_NARRATION_ENDPOINT = "api/v2/ai/nlg/queryResult";
+/**
+ * Options for getNarrations. All endpoint choice logic lives in this module.
+ * @internal
+ */
+export type GetNarrationsOptions = {
+    isUnifiedNarrationEnabled?: boolean;
+    isSisenseAiEnabled?: boolean;
+};
+/**
+ * Fetches narrations. Single place for endpoint logic: isUnifiedNarrationEnabled === 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; isUnifiedNarrationEnabled (from props.isUnifiedNarrationEnabled)
+ * @returns Promise with narration response
+ * @internal
+ */
+export declare function getNarrations(httpClient: HttpClient, request: GetNlgInsightsRequest, options?: GetNarrationsOptions): Promise<GetNlgInsightsResponse>;

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

@@ -1,6 +1,6 @@
 import { JaqlQueryPayload } from '@sisense/sdk-query-client';
+import { WidgetProps } from '../../../domains/widgets/components/widget/types';
 import { ExpandedQueryModel } from '../../../modules/analytics-composer';
-import { WidgetProps } from '../../../props';
 export interface ChatContext {
     title: string;
     live: boolean;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { Data, Filter, FilterRelations } from '@sisense/sdk-data';
+import { ChartWidgetProps } from '../../../domains/widgets/components/chart-widget/types';
 import type { NlqResponseData } from '../../../modules/ai';
-import { ChartWidgetProps } from '../../../props';
 import { NlqChartWidgetStyleOptions } from '../../../types';
 /**
  * Props for {@link NlqChartWidget} component.
@@ -20,7 +20,7 @@ export interface NlqChartWidgetProps {
     filters?: Filter[] | FilterRelations;
     /**
      * A callback that allows to modify data immediately after it has been retrieved.
-     * Can be used to inject modification of queried data.
+     * It can be used to inject modification of queried data.
      */
     onDataReady?: (data: Data) => Data;
     /**

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

@@ -1,6 +1,6 @@
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
-import { WidgetProps } from '../../props';
+import { WidgetProps } from '../../domains/widgets/components/widget/types';
 /**
  * Options for {@link getNlgInsightsFromWidget} function.
  * @internal
@@ -10,6 +10,9 @@ export interface GetNlgInsightsFromWidgetOptions {
     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;
 }
 /**
  * Pure function that fetches NLG insights from WidgetProps.

package/dist/packages/sdk-ui/src/modules/ai/use-get-nlq-result.d.ts

@@ -1,5 +1,5 @@
 import { DataSource } from '@sisense/sdk-data';
-import { WidgetProps } from '../../props';
+import { WidgetProps } from '../../domains/widgets/components/widget/types';
 import { HookEnableParam } from '../../shared/hooks/types';
 import { ChatRestApi } from './api/chat-rest-api.js';
 import { GetNlqResultRequest, NlqResult, NlqResultChartType } from './api/types.js';

package/dist/packages/sdk-ui/src/modules/analytics-composer/common/utils.d.ts

@@ -1,6 +1,7 @@
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../../domains/query-execution/index.js';
 import { DynamicChartType } from '../../../domains/visualizations/core/chart-options-processor/translations/types.js';
-import { ChartWidgetProps, PivotTableWidgetProps } from '../../../props';
+import { ChartWidgetProps } from '../../../domains/widgets/components/chart-widget/types';
+import { PivotTableWidgetProps } from '../../../domains/widgets/components/pivot-table-widget/types';
 import { ExpandedQueryModel, SimpleQueryModel } from '../types.js';
 export declare function toKebabCase(str: string): string;
 export declare function capitalizeFirstLetter(str: string): string;

package/dist/packages/sdk-ui/src/modules/analytics-composer/dashboard/stringify-widgets.d.ts

@@ -1,3 +1,3 @@
-import { WidgetProps } from '../../../props.js';
+import { WidgetProps } from '../../../domains/widgets/components/widget/types';
 import { UiFramework } from '../types.js';
 export declare const stringifyWidgets: (widgets: WidgetProps[], uiFramework: UiFramework) => string;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-dimensions-from-json.d.ts

@@ -2,10 +2,11 @@ import { Attribute } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../types.js';
 import { DimensionsInput } from './types.js';
 /**
- * Translate an array of JSON objects to attributes.
+ * Translates an array of JSON dimension items (strings or StyledColumnJSON) to attributes.
+ *
  * Direction: JSON → CSDK
  *
- * @param input - DimensionsInput object`
+ * @param input - DimensionsInput object
  * @returns NlqTranslationResult<Attribute[]>
  */
 export declare const translateDimensionsFromJSON: (input: DimensionsInput) => NlqTranslationResult<Attribute[]>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-dimensions-to-json.d.ts

@@ -1,13 +1,13 @@
-import { Attribute } from '@sisense/sdk-data';
+import { Attribute, JSONArray } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../types.js';
 /**
- * Translates CSDK Attribute array to NLQ JSON format (string array).
+ * Translates CSDK Attribute array to NLQ JSON format (string or StyledColumnJSON array).
  *
- * Returns composeCode from each attribute directly. The composeCode contains [[delimiters]]
- * around names that need normalization, which are stripped at the final step in translateQueryToJSON.
+ * When an attribute has sort applied, outputs StyledColumnJSON with column and sortType;
+ * otherwise outputs composeCode string. Delimiters are stripped at the final step in translateQueryToJSON.
  *
  * @param dimensions - Array of CSDK Attribute objects
- * @returns NlqTranslationResult<string[]> with array of composeCode strings or structured errors
+ * @returns NlqTranslationResult<JSONArray> - JSON array output for NLQ dimensions
  * @internal
  */
-export declare function translateDimensionsToJSON(dimensions: Attribute[]): NlqTranslationResult<string[]>;
+export declare function translateDimensionsToJSON(dimensions: Attribute[]): NlqTranslationResult<JSONArray>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-filters-to-json.d.ts

@@ -1,6 +1,5 @@
-import { Filter, FilterRelations } from '@sisense/sdk-data';
+import { Filter, FilterRelations, JSONArray } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../types.js';
-import { FunctionCall } from './types.js';
 /**
  * Translates CSDK Filter array or FilterRelations to NLQ JSON format (FunctionCall array).
  *
@@ -11,7 +10,7 @@ import { FunctionCall } from './types.js';
  * @returns NlqTranslationResult<FunctionCall[]> with array of FunctionCall objects or structured errors
  * @internal
  */
-export declare function translateFiltersToJSON(filters: Filter[] | FilterRelations | undefined): NlqTranslationResult<FunctionCall[]>;
+export declare function translateFiltersToJSON(filters: Filter[] | FilterRelations | undefined): NlqTranslationResult<JSONArray>;
 /**
  * Translates CSDK Filter array to NLQ JSON format (FunctionCall array).
  *
@@ -23,4 +22,4 @@ export declare function translateFiltersToJSON(filters: Filter[] | FilterRelatio
  * @returns NlqTranslationResult<FunctionCall[]> with array of FunctionCall objects or structured errors
  * @internal
  */
-export declare function translateHighlightsToJSON(highlights: Filter[] | undefined): NlqTranslationResult<FunctionCall[]>;
+export declare function translateHighlightsToJSON(highlights: Filter[] | undefined): NlqTranslationResult<JSONArray>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-measures-from-json.d.ts

@@ -1,37 +1,22 @@
 import { Measure } from '@sisense/sdk-data';
-import { NlqTranslationResult } from '../types.js';
-import { MeasuresFunctionCallInput, MeasuresInput } from './types.js';
+import { NlqTranslationErrorContext, NlqTranslationResult } from '../types.js';
+import { FunctionCall, InternalDataSchemaContext, MeasuresInput } from './types.js';
 /**
- * Translate an array of JSON objects to measures
+ * Translate a single function call to a measure.
  *
- * @example
- * [
- *   {
- *     "function": "measureFactory.sum",
- *     "args": ["DM.Commerce.Revenue", "Total Revenue"]
- *   },
- *   {
- *     "function": "measureFactory.sum",
- *     "args": ["DM.Commerce.Cost", "Total Cost"]
- *   }
- * ]
- *
- * is translated to the following Measure[] object:
- * {success: true, data: [
- *   measureFactory.sum("DM.Commerce.Revenue", "Total Revenue"),
- *   measureFactory.sum("DM.Commerce.Cost", "Total Cost")
- * ]}
- * @param measuresJSON - A JSON array representing the measures
- * @param dataSource - The data source to use for the measures
- * @param tables - The tables to use for the measures
- * @returns A Measure[] object
+ * @internal
  */
-export declare const translateMeasuresFromJSONFunctionCall: (input: MeasuresFunctionCallInput) => NlqTranslationResult<Measure[]>;
+export declare const translateMeasureFromJSONFunctionCall: (functionCall: FunctionCall, context: InternalDataSchemaContext, errorContext: NlqTranslationErrorContext) => NlqTranslationResult<Measure>;
 /**
- * Translate an array of JSON objects to measures.
+ * Translates an array of JSON measure items (FunctionCall or StyledMeasureColumnJSON) to measures.
+ *
  * Direction: JSON → CSDK
  *
- * @param input - MeasuresInput object
- * @returns NlqTranslationResult<Measure[]>
+ * @example
+ * [
+ *   { "function": "measureFactory.sum", "args": ["DM.Commerce.Revenue", "Total Revenue"] },
+ *   { "column": { "function": "measureFactory.sum", "args": ["DM.Commerce.Cost", "Total Cost"] }, "sortType": "sortDesc" }
+ * ]
+ * @internal
  */
 export declare const translateMeasuresFromJSON: (input: MeasuresInput) => NlqTranslationResult<Measure[]>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-measures-to-json.d.ts

@@ -1,14 +1,13 @@
-import { Measure } from '@sisense/sdk-data';
+import { JSONArray, Measure } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../types.js';
-import { FunctionCall } from './types.js';
 /**
- * Translates CSDK Measure array to NLQ JSON format (FunctionCall array).
+ * Translates CSDK Measure array to NLQ JSON format (FunctionCall or StyledMeasureColumnJSON array).
  *
- * Parses composeCode directly to FunctionCall format. The composeCode contains [[delimiters]]
- * around names that need normalization, which are stripped at the final step in translateQueryToJSON.
+ * When a measure has sort applied, outputs StyledMeasureColumnJSON with column and sortType;
+ * otherwise outputs the parsed FunctionCall. Delimiters are stripped at the final step in translateQueryToJSON.
  *
  * @param measures - Array of CSDK Measure objects
- * @returns NlqTranslationResult<FunctionCall[]> with array of FunctionCall objects or structured errors
+ * @returns NlqTranslationResult<JSONArray> - JSON array output for NLQ measures
  * @internal
  */
-export declare function translateMeasuresToJSON(measures: Measure[]): NlqTranslationResult<FunctionCall[]>;
+export declare function translateMeasuresToJSON(measures: Measure[]): NlqTranslationResult<JSONArray>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/types.d.ts

@@ -1,4 +1,5 @@
 import { Filter, FilterRelations, JaqlDataSourceForDto, JSONArray, JSONValue, Measure } from '@sisense/sdk-data';
+import { CategoryStyle, SeriesStyle, ValueStyle } from '../../../public-api/index.js';
 import { NlqTranslationInput } from '../types.js';
 import type { SchemaIndex } from './common.js';
 /**
@@ -57,3 +58,47 @@ export declare function isFilterElement(arg: QueryElement): arg is Filter;
 export declare function isFilterRelationsElement(arg: QueryElement): arg is FilterRelations;
 export declare function isMeasureElement(arg: QueryElement): arg is Measure;
 export declare function isStringArray(value: JSONArray): value is string[];
+/**
+ * JSON-facing type for a styled dimension/attribute.
+ * Reusable for query JSON and future chart JSON (translateChartFromJSON).
+ *
+ * @internal
+ */
+export interface StyledColumnJSON extends CategoryStyle {
+    /** Attribute reference (composeCode), e.g. "DM.Commerce.Gender" */
+    column: string;
+}
+/**
+ * JSON-facing type for a styled measure.
+ * Reusable for query JSON and future chart JSON (translateChartFromJSON).
+ *
+ * @internal
+ */
+export interface StyledMeasureColumnJSON extends ValueStyle, SeriesStyle {
+    /** Measure definition (function/args), e.g. { function: "measureFactory.sum", args: [...] } */
+    column: FunctionCall;
+}
+/**
+ * Dimension item in query JSON: plain composeCode string or styled column.
+ *
+ * @internal
+ */
+export type DimensionItemJSON = string | StyledColumnJSON;
+/**
+ * Measure item in query JSON: plain function call or styled measure.
+ *
+ * @internal
+ */
+export type MeasureItemJSON = FunctionCall | StyledMeasureColumnJSON;
+/**
+ * Type guard: value is StyledColumnJSON (object with column, not a FunctionCall).
+ *
+ * @internal
+ */
+export declare function isStyledColumnJSON(value: unknown): value is StyledColumnJSON;
+/**
+ * Type guard: value is StyledMeasureColumnJSON (object with column containing a measure definition).
+ *
+ * @internal
+ */
+export declare function isStyledMeasureColumnJSON(value: unknown): value is StyledMeasureColumnJSON;

package/dist/packages/sdk-ui/src/modules/analytics-composer/types.d.ts

@@ -4,7 +4,9 @@ import { DashboardProps } from '../../domains/dashboarding/types.js';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../domains/query-execution/index.js';
 import { AnyColumn } from '../../domains/visualizations/core/chart-data-options/types.js';
 import { DynamicChartType } from '../../domains/visualizations/core/chart-options-processor/translations/types.js';
-import { ChartWidgetProps, PivotTableWidgetProps, WidgetProps } from '../../props';
+import { ChartWidgetProps } from '../../domains/widgets/components/chart-widget/types';
+import { PivotTableWidgetProps } from '../../domains/widgets/components/pivot-table-widget/types';
+import { WidgetProps } from '../../domains/widgets/components/widget/types';
 import { ChartDataOptions, ChartStyleOptions } from '../../types';
 type Stringify<T> = {
     [K in keyof T as `${K & string}String`]: string;

package/dist/packages/sdk-ui/src/modules/analytics-composer/widget/to-widget-code.d.ts

@@ -1,4 +1,4 @@
-import { WidgetProps } from '../../../props';
+import { WidgetProps } from '../../../domains/widgets/components/widget/types';
 import { ByIdWidgetCodeParams, ClientSideWidgetCodeParams, TemplateKeyMapByWidgetType, UiFramework } from '../types.js';
 export declare const toWidgetCodeById: ({ dashboardOid, widgetOid, uiFramework, chartType, includeChart, }: ByIdWidgetCodeParams) => string;
 export declare const getWidgetCode: (widgetProps: WidgetProps, uiFramework: UiFramework, templateKeyMap: TemplateKeyMapByWidgetType, removeDefaultProps?: boolean) => string;

package/dist/packages/sdk-ui/src/modules/analytics-composer/widget/to-widget-props.d.ts

@@ -1,3 +1,3 @@
-import { WidgetProps } from '../../../props';
+import { WidgetProps } from '../../../domains/widgets/components/widget/types';
 import { ExpandedQueryModel, WidgetPropsConfig } from '../types.js';
 export declare const toWidgetPropsFromQuery: (queryModel: ExpandedQueryModel, config?: WidgetPropsConfig) => WidgetProps | undefined;

package/dist/packages/sdk-ui/src/modules/analytics-composer/widget/widget-composer.d.ts

@@ -1,4 +1,4 @@
-import { WidgetProps } from '../../../props.js';
+import { WidgetProps } from '../../../domains/widgets/components/widget/types';
 import { ExpandedQueryModel, WidgetCodeParams, WidgetPropsConfig } from '../types.js';
 /**
  * Converts query model to widget props.