@sisense/sdk-ui 2.28.0 → 2.30.0

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

@@ -15,5 +15,5 @@ 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 '../../domains/narrative/core/build-narrative-request.js';
-export { getNlgInsightsFromWidget, type GetNlgInsightsFromWidgetOptions, } from './get-nlg-insights-from-widget.js';
+export { getNlgInsightsFromWidget } from './get-nlg-insights-from-widget.js';
 export { widgetComposer } from '../../modules/analytics-composer';

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/dimensions/get-dimension-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns the dimensional attribute path with the `DM.` module prefix removed.
+ *
+ * @param dimensionString - NLQ dimension reference (e.g. `DM.Commerce.Date.Years`)
+ * @returns Path without `DM.` (e.g. `Commerce.Date.Years`)
+ *
+ * @internal
+ */
+export declare function getDimensionName(dimensionString: string): string;

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

@@ -1,6 +1,7 @@
-import { Attribute, JSONArray } from '@sisense/sdk-data';
+import { Attribute } from '@sisense/sdk-data';
 import type { SortDirection } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../../../types.js';
+import { type DimensionItemJSON } from '../../types.js';
 /** Runtime StyledColumn: wrapper with column and optional CategoryStyle (from chart dataOptions) */
 type StyledColumn = {
     column: Attribute;
@@ -15,8 +16,8 @@ type StyledColumn = {
  * properties; otherwise outputs composeCode string.
  *
  * @param dimensions - Array of CSDK Attribute or StyledColumn objects
- * @returns NlqTranslationResult<JSONArray> - JSON array output for NLQ dimensions
+ * @returns NlqTranslationResult with dimension items in NLQ JSON format
  * @internal
  */
-export declare function translateDimensionsToJSON(dimensions: (Attribute | StyledColumn)[]): NlqTranslationResult<JSONArray>;
+export declare function translateDimensionsToJSON(dimensions: (Attribute | StyledColumn)[]): NlqTranslationResult<DimensionItemJSON[]>;
 export {};

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/filters/get-filter-name.d.ts

@@ -0,0 +1,10 @@
+import type { FunctionCall } from '../../types.js';
+/**
+ * Extracts a human-readable label from a filter FunctionCall.
+ *
+ * @param call - Filter factory function call
+ * @returns Attribute name, measure name, or function suffix for logical combinators
+ *
+ * @internal
+ */
+export declare function getFilterName(call: FunctionCall): string;

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

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

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/get-query-element-summary.d.ts

@@ -0,0 +1,23 @@
+import { type ElementSummary, type QueryElementItemJSON } from '../types.js';
+/**
+ * Options for {@link getQueryElementSummary}.
+ *
+ * @internal
+ */
+export type GetQueryElementSummaryOptions = {
+    /**
+     * Distinguishes filter vs highlight when `item` is a `filterFactory.*` call.
+     * Ignored for dimensions and measures. Defaults to `'filter'`.
+     */
+    readonly role?: 'filter' | 'highlight';
+};
+/**
+ * Derives a human-readable name and element kind from a query JSON item.
+ *
+ * @param item - Dimension, measure, filter, or highlight JSON entry
+ * @param options - When `item` is a filter/highlight `FunctionCall`, `role` selects the returned kind
+ * @returns Summary with display name and type, or `null` when `item` is not a recognized shape
+ *
+ * @internal
+ */
+export declare function getQueryElementSummary(item: QueryElementItemJSON, options?: GetQueryElementSummaryOptions): ElementSummary | null;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/measures/get-measure-name.d.ts

@@ -0,0 +1,10 @@
+import type { FunctionCall } from '../../types.js';
+/**
+ * Extracts a human-readable name from a measure FunctionCall.
+ *
+ * @param call - Measure factory function call
+ * @returns Display name for LLM / UI labels
+ *
+ * @internal
+ */
+export declare function getMeasureName(call: FunctionCall): string;

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

@@ -1,6 +1,7 @@
-import { JSONArray, Measure } from '@sisense/sdk-data';
+import { Measure } from '@sisense/sdk-data';
 import type { SortDirection } from '@sisense/sdk-data';
 import { NlqTranslationResult } from '../../../types.js';
+import type { MeasureItemJSON } from '../../types.js';
 /** Runtime StyledMeasureColumn: wrapper with column and optional style (from chart dataOptions) */
 type StyledMeasureColumn = {
     column: Measure;
@@ -15,8 +16,8 @@ type StyledMeasureColumn = {
  * otherwise outputs the parsed FunctionCall.
  *
  * @param measures - Array of CSDK Measure or StyledMeasureColumn objects
- * @returns NlqTranslationResult<JSONArray> - JSON array output for NLQ measures
+ * @returns NlqTranslationResult with measure items in NLQ JSON format
  * @internal
  */
-export declare function translateMeasuresToJSON(measures: (Measure | StyledMeasureColumn)[]): NlqTranslationResult<JSONArray>;
+export declare function translateMeasuresToJSON(measures: (Measure | StyledMeasureColumn)[]): NlqTranslationResult<MeasureItemJSON[]>;
 export {};

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

@@ -9,4 +9,6 @@ export * from './widget/translate-widget-to-json.js';
 export * from './dashboard/translate-dashboard-from-json.js';
 export * from './dashboard/translate-dashboard-to-json.js';
 export * from './query/translate-query-to-jaql.js';
-export type { ChartJSON, DataOptionsJSON, ChartInput, DataSourceJSON, PivotTableJSON, PivotTableDataOptionsJSON, PivotTableInput, ChartWidgetJSON, PivotTableWidgetJSON, TextWidgetJSON, CustomWidgetJSON, WidgetJSON, WidgetInput, SpecificWidgetOptionsJSON, WidgetsOptionsJSON, DashboardJSON, DashboardInput, } from './types.js';
+export { getQueryElementSummary } from './constructs/get-query-element-summary.js';
+export type { GetQueryElementSummaryOptions } from './constructs/get-query-element-summary.js';
+export type { ChartJSON, DataOptionsJSON, ChartInput, DataSourceJSON, PivotTableJSON, PivotTableDataOptionsJSON, PivotTableInput, ChartWidgetJSON, PivotTableWidgetJSON, TextWidgetJSON, CustomWidgetJSON, WidgetJSON, WidgetInput, WidgetConfigJSON, QueryJSON, QueryInput, DimensionItemJSON, MeasureItemJSON, FunctionCall, QueryElementKind, QueryElementItemJSON, ElementSummary, SpecificWidgetOptionsJSON, WidgetsOptionsJSON, DashboardJSON, DashboardInput, } from './types.js';

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

@@ -1,6 +1,6 @@
 import type { ExecuteQueryParams } from '../../../../domains/query-execution/index.js';
 import { NlqTranslationResult } from '../../types.js';
-import { QueryInput } from '../../types.js';
+import { QueryInput } from '../types.js';
 /**
  * Translates NLQ JSON format to CSDK ExecuteQueryParams object.
  * Direction: JSON → CSDK

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

@@ -1,5 +1,6 @@
 import type { ExecuteQueryParams } from '../../../../domains/query-execution/index.js';
-import { NlqResponseJSON, NlqTranslationResult } from '../../types.js';
+import { NlqTranslationResult } from '../../types.js';
+import type { QueryJSON } from '../types.js';
 /**
  * Translates CSDK ExecuteQueryParams to NLQ JSON format.
  * Direction: CSDK → JSON
@@ -50,7 +51,7 @@ import { NlqResponseJSON, NlqTranslationResult } from '../../types.js';
  * ```
  *
  * @param query - ExecuteQueryParams object with CSDK objects
- * @returns NlqTranslationResult<NlqResponseJSON> with FunctionCall format or structured errors
+ * @returns NlqTranslationResult<QueryJSON> with FunctionCall format or structured errors
  * @internal
  */
-export declare function translateQueryToJSON(query: ExecuteQueryParams): NlqTranslationResult<NlqResponseJSON>;
+export declare function translateQueryToJSON(query: ExecuteQueryParams): NlqTranslationResult<QueryJSON>;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/adapters.d.ts

@@ -1,5 +1,4 @@
 import type { Attribute, Measure } from '@sisense/sdk-data';
-import type { JSONArray } from '@sisense/sdk-data';
 import type { StyledColumn, StyledMeasureColumn } from '../../../../../domains/visualizations/core/chart-data-options/types.js';
 import type { NlqTranslationError } from '../../../types.js';
 import type { DimensionItemJSON, DimensionTranslationItem, MeasureItemJSON, MeasureTranslationItem } from '../../types.js';
@@ -12,5 +11,7 @@ import type { DimensionItemJSON, DimensionTranslationItem, MeasureItemJSON, Meas
 export type AxisType = 'dimension' | 'measure';
 export declare function adaptDimensionsToStyledColumn(items: DimensionTranslationItem[]): (Attribute | StyledColumn)[];
 export declare function adaptMeasuresToStyledMeasureColumn(items: MeasureTranslationItem[]): (Measure | StyledMeasureColumn)[];
-export declare function toJSONArray(value: DimensionItemJSON | DimensionItemJSON[] | MeasureItemJSON | MeasureItemJSON[]): JSONArray;
+export declare function toDimensionItemsJSON(value: DimensionItemJSON | DimensionItemJSON[]): DimensionItemJSON[];
+export declare function toMeasureItemsJSON(value: MeasureItemJSON | MeasureItemJSON[]): MeasureItemJSON[];
+export declare function toDataOptionItemsJSON(value: DimensionItemJSON | DimensionItemJSON[] | MeasureItemJSON | MeasureItemJSON[]): (DimensionItemJSON | MeasureItemJSON)[];
 export declare function withAxisContext(axisKey: string): (e: NlqTranslationError) => NlqTranslationError;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/index.d.ts

@@ -4,6 +4,6 @@
  *
  * @internal
  */
-export { adaptDimensionsToStyledColumn, adaptMeasuresToStyledMeasureColumn, toJSONArray, withAxisContext, } from './adapters.js';
+export { adaptDimensionsToStyledColumn, adaptMeasuresToStyledMeasureColumn, toDataOptionItemsJSON, toDimensionItemsJSON, toMeasureItemsJSON, withAxisContext, } from './adapters.js';
 export { translateSingleAxisFromJSON, type AxisType, type TranslatedAxis, } from './translate-axis-from-json.js';
 export { translateSingleAxisToJSON } from './translate-axis-to-json.js';

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/process-measured-value.d.ts

@@ -0,0 +1,14 @@
+import { FunctionContext, ProcessedArg } from '../../types.js';
+/**
+ * Validates measuredValue filters: only plain Filter instances are allowed.
+ * FilterRelations (logic.or / logic.and) are rejected because the JAQL engine
+ * does not support them inside measured-value formulas.
+ *
+ * @param processedArgs - [measure, filters, name?, format?]
+ * @param context - Processing context with error prefix
+ * @returns Same `processedArgs` when validation succeeds
+ * @throws Error when any filter entry is a FilterRelations object
+ *
+ * @internal
+ */
+export declare function processMeasuredValue(processedArgs: ProcessedArg[], context: FunctionContext): ProcessedArg[];

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

@@ -3,6 +3,7 @@ import type { CommonFiltersOptions } from '../../../domains/dashboarding/common-
 import type { DashboardConfig, DashboardLayoutOptions, DashboardStyleOptions } from '../../../domains/dashboarding/types.js';
 import { CategoryStyle, SeriesStyle, ValueStyle } from '../../../domains/visualizations/core/chart-data-options/types.js';
 import type { WidgetConfig, WidgetType } from '../../../domains/widgets/components/widget/types.js';
+import type { ToolbarMenuConfig, WidgetHeaderTitleConfig } from '../../../domains/widgets/shared/widget-header/types.js';
 import type { CustomWidgetStyleOptions, PivotTableStyleOptions, TextWidgetStyleOptions } from '../../../types.js';
 import { DataSchemaContext, NlqTranslationInput } from '../types.js';
 import type { SchemaIndex } from './shared/utils/schema-index.js';
@@ -25,6 +26,8 @@ export type ArgType = 'string' | 'string[]' | 'number' | 'number[]' | 'boolean'
 export interface ArgSchema {
     type: ArgType;
     required: boolean;
+    /** Marks this positional arg as the human-readable display name. */
+    isName?: true;
 }
 export type ProcessedArg = unknown;
 export type QueryElement = Filter | FilterRelations | Measure;
@@ -41,10 +44,6 @@ export interface FunctionContext extends InternalDataSchemaContext {
 export interface ArgContext extends FunctionContext {
     argSchema: ArgSchema;
 }
-export type DimensionsInput = NlqTranslationInput<JSONArray, InternalDataSchemaContext>;
-export type MeasuresInput = NlqTranslationInput<JSONArray, InternalDataSchemaContext>;
-export type FiltersInput = NlqTranslationInput<JSONArray, InternalDataSchemaContext>;
-export type HighlightsInput = NlqTranslationInput<JSONArray, InternalDataSchemaContext>;
 export type MeasuresFunctionCallInput = NlqTranslationInput<FunctionCall[], InternalDataSchemaContext>;
 export type FiltersFunctionCallInput = NlqTranslationInput<FunctionCall[], InternalDataSchemaContext>;
 export type HighlightsFunctionCallInput = NlqTranslationInput<FunctionCall[], InternalDataSchemaContext>;
@@ -64,7 +63,7 @@ export type CustomFunctionProcessor = (processedArgs: ProcessedArg[], context: F
  */
 export declare function isRecordStringUnknown(value: unknown): value is Record<string, unknown>;
 export declare function isFunctionCall(value: unknown): value is FunctionCall;
-export declare function isFunctionCallArray(value: JSONArray): value is FunctionCall[];
+export declare function isFunctionCallArray(value: readonly unknown[]): value is FunctionCall[];
 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;
@@ -119,6 +118,54 @@ export type DimensionItemJSON = string | StyledColumnJSON;
  * @internal
  */
 export type MeasureItemJSON = FunctionCall | StyledMeasureColumnJSON;
+/**
+ * Translation input types for query constructs (precise JSON arrays).
+ *
+ * @internal
+ */
+export type DimensionsInput = NlqTranslationInput<DimensionItemJSON[], InternalDataSchemaContext>;
+export type MeasuresInput = NlqTranslationInput<MeasureItemJSON[], InternalDataSchemaContext>;
+export type FiltersInput = NlqTranslationInput<FunctionCall[], InternalDataSchemaContext>;
+export type HighlightsInput = NlqTranslationInput<FunctionCall[], InternalDataSchemaContext>;
+/**
+ * JSON representation of a query from the NLQ API.
+ * Precise serializable schema for dimensions, measures, filters, and highlights.
+ *
+ * @internal
+ */
+export interface QueryJSON {
+    dimensions: DimensionItemJSON[];
+    measures: MeasureItemJSON[];
+    filters: FunctionCall[];
+    highlights?: FunctionCall[];
+}
+/**
+ * Input type for query translation (JSON → CSDK).
+ *
+ * @internal
+ */
+export type QueryInput = NlqTranslationInput<QueryJSON, DataSchemaContext>;
+/**
+ * Element kind for a single {@link QueryJSON} array entry.
+ *
+ * @internal
+ */
+export type QueryElementKind = 'dimension' | 'measure' | 'filter' | 'highlight';
+/**
+ * Display name and kind for a query JSON element.
+ *
+ * @internal
+ */
+export interface ElementSummary {
+    readonly name: string;
+    readonly type: QueryElementKind;
+}
+/**
+ * A single item from {@link QueryJSON} dimensions, measures, filters, or highlights arrays.
+ *
+ * @internal
+ */
+export type QueryElementItemJSON = DimensionItemJSON | MeasureItemJSON | FunctionCall;
 /**
  * Type guard: value is StyledColumnJSON (object with column, not a FunctionCall).
  *
@@ -223,6 +270,20 @@ type WithCommonWidgetJSON<Base, Type extends WidgetType> = Base & {
     widgetType: Type;
     readonly id: string;
 };
+/**
+ * JSON-safe subset of {@link WidgetConfig} (drops function-bearing menu items).
+ * Structurally assignable to {@link WidgetConfig} because `items` is optional on the runtime type.
+ *
+ * @internal
+ */
+export type WidgetConfigJSON = Pick<WidgetConfig, 'actions'> & {
+    header?: {
+        title?: WidgetHeaderTitleConfig;
+        toolbar?: {
+            menu?: Pick<ToolbarMenuConfig, 'enabled'>;
+        };
+    };
+};
 /**
  * Data source in NLQ JSON — title only. Full JAQL details live in {@link DataSchemaContext}.
  *
@@ -238,7 +299,7 @@ export type ChartWidgetJSON = ChartJSON & {
     title?: string;
     description?: string;
     dataSource?: DataSourceJSON;
-    config?: WidgetConfig;
+    config?: WidgetConfigJSON;
     highlightSelectionDisabled?: boolean;
 };
 /**
@@ -250,7 +311,7 @@ export type PivotTableWidgetJSON = PivotTableJSON & {
     title?: string;
     description?: string;
     dataSource?: DataSourceJSON;
-    config?: WidgetConfig;
+    config?: WidgetConfigJSON;
 };
 /**
  * JSON representation of a text widget
@@ -259,7 +320,7 @@ export type PivotTableWidgetJSON = PivotTableJSON & {
  */
 export type TextWidgetJSON = {
     styleOptions: TextWidgetStyleOptions;
-    config?: WidgetConfig;
+    config?: WidgetConfigJSON;
 };
 /**
  * JSON representation of a custom/plugin widget payload.
@@ -275,7 +336,7 @@ export type CustomWidgetJSON = {
     title?: string;
     description?: string;
     dataSource?: DataSourceJSON;
-    config?: WidgetConfig;
+    config?: WidgetConfigJSON;
     filters?: FunctionCall[];
     highlights?: FunctionCall[];
     /** Opaque pass-through — GenericDataOptions serialized as plain JSON */

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

@@ -1,12 +1,12 @@
-import type { WidgetConfig, WidgetProps } from '../../../../../domains/widgets/components/widget/types.js';
+import type { WidgetProps } from '../../../../../domains/widgets/components/widget/types.js';
 import type { ChartProps, PivotTableProps } from '../../../../../props.js';
-import type { DataSourceJSON } from '../../types.js';
+import type { DataSourceJSON, WidgetConfigJSON } from '../../types.js';
 export type WidgetMeta = {
     readonly id: string;
     readonly title?: string;
     readonly description?: string;
     readonly dataSource?: DataSourceJSON;
-    readonly config?: WidgetConfig;
+    readonly config?: WidgetConfigJSON;
     readonly highlightSelectionDisabled?: boolean;
 };
 /**

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

@@ -1,13 +1,12 @@
-import type { WidgetConfig } from '../../../../../domains/widgets/components/widget/types.js';
 import type { DataSchemaContext, NlqTranslationInput, NlqTranslationResult } from '../../../types.js';
-import type { DataSourceJSON } from '../../types.js';
+import type { DataSourceJSON, WidgetConfigJSON } from '../../types.js';
 import type { WidgetMeta } from './to-widget-props.js';
 type WidgetEnvelopeJSON = {
     readonly id: string;
     readonly title?: string;
     readonly description?: string;
     readonly dataSource?: DataSourceJSON;
-    readonly config?: WidgetConfig;
+    readonly config?: WidgetConfigJSON;
     readonly highlightSelectionDisabled?: boolean;
 };
 /**

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

@@ -1,4 +1,4 @@
-import { JaqlDataSourceForDto, JSONArray, MetadataItem } from '@sisense/sdk-data';
+import { JaqlDataSourceForDto, MetadataItem } from '@sisense/sdk-data';
 import type { DashboardByIdConfig } from '../../domains/dashboarding';
 import { DashboardProps } from '../../domains/dashboarding/types.js';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../domains/query-execution/index.js';
@@ -319,17 +319,6 @@ export type NlqTranslationInput<DataType, ContextType> = {
     data: DataType;
     context: ContextType;
 };
-/**
- * Response JSON generated by the new NLQ API.
- *
- * @internal
- */
-export type NlqResponseJSON = {
-    dimensions: JSONArray;
-    measures: JSONArray;
-    filters: JSONArray;
-    highlights?: JSONArray;
-};
 /**
  * Data schema context for translation
  *
@@ -341,12 +330,6 @@ export interface DataSchemaContext {
     /** Available tables for attribute resolution */
     tables: NormalizedTable[];
 }
-/**
- * Query input for translation
- *
- * @internal
- */
-export type QueryInput = NlqTranslationInput<NlqResponseJSON, DataSchemaContext>;
 /**
  * Context used when building translation errors (before message is attached).
  *

package/dist/packages/sdk-ui/src/props.d.ts

@@ -4,13 +4,14 @@ import { Hierarchy } from './domains/drilldown/hierarchy-model';
 import { ExecuteQueryParams, QueryByWidgetIdState } from './domains/query-execution';
 import { ExecuteQueryResult } from './domains/query-execution/types';
 import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from './domains/visualizations/components/pivot-table/formatters/types';
-import { AreamapChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, RangeChartDataOptions, RegularChartDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptions, TabularChartDataOptions } from './domains/visualizations/core/chart-data-options/types';
+import { AreamapChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, RangeChartDataOptions, RegularChartDataOptions, SankeyChartDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptions, TabularChartDataOptions } from './domains/visualizations/core/chart-data-options/types';
 import { HighchartsOptions } from './domains/visualizations/core/chart-options-processor/chart-options-service';
 import type { ChartWidgetProps } from './domains/widgets/components/chart-widget/types';
 import { FiltersMergeStrategy } from './domains/widgets/components/widget-by-id/types';
 import { type AppConfig } from './infra/app/types';
+import type { Module } from './infra/modules';
 import type { Plugin } from './infra/plugins/types';
-import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, CustomDrilldownResult, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableDrilldownOptions, PivotTableStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TableStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, ThemeConfig, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
+import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, CustomDrilldownResult, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableDrilldownOptions, PivotTableStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, SankeyStyleOptions, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TableStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, ThemeConfig, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
 export type { TabberButtonsWidgetProps } from './domains/widgets/components/tabber-buttons-widget/types';
 export type { WidgetProps, WidgetType, WithCommonWidgetProps, } from './domains/widgets/components/widget/types';
 export type { MenuItemSection, HighchartsOptions };
@@ -167,6 +168,14 @@ export interface SisenseContextProviderProps {
      * @internal
      */
     plugins?: Plugin[];
+    /**
+     * Array of modules to register.
+     *
+     * @category Sisense App
+     *
+     * @alpha
+     */
+    modules?: Module[];
 }
 /**
  * Props for {@link ExecuteQuery} component.
@@ -193,6 +202,12 @@ export interface ExecuteQueryProps {
     offset?: number;
     /** {@inheritDoc ExecuteQueryParams.ungroup} */
     ungroup?: boolean;
+    /**
+     * {@inheritDoc ExecuteQueryParams.includeRowCount}
+     *
+     * @beta
+     */
+    includeRowCount?: boolean;
     /** Function as child component that is called to render the query results */
     children?: (queryResult: ExecuteQueryResult) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
@@ -838,6 +853,38 @@ export interface FunnelChartProps extends BaseChartProps, HighchartsBasedChartEv
      */
     styleOptions?: FunnelStyleOptions;
 }
+/**
+ * Props of the {@link SankeyChart} component.
+ *
+ * @group Charts
+ * @beta
+ *
+ * @example
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Category.Category],
+ *     value: measureFactory.sum(DM.Commerce.Revenue),
+ *   }}
+ *   styleOptions={{ orientation: 'horizontal' }}
+ * />
+ * ```
+ */
+export interface SankeyChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart.
+     *
+     * @category Chart
+     */
+    dataOptions: SankeyChartDataOptions;
+    /**
+     * Configurations for how to style and present a chart's data.
+     *
+     * @category Chart
+     */
+    styleOptions?: SankeyStyleOptions;
+}
 /**
  * Props of the {@link LineChart} component.
  */
@@ -1171,6 +1218,12 @@ export interface ExecuteQueryByWidgetIdProps {
     count?: number;
     /** {@inheritDoc ExecuteQueryParams.offset} */
     offset?: number;
+    /**
+     * {@inheritDoc ExecuteQueryByWidgetIdParams.includeRowCount}
+     *
+     * @beta
+     */
+    includeRowCount?: boolean;
     /** {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy} */
     filtersMergeStrategy?: FiltersMergeStrategy;
     /** {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters} */

package/dist/packages/sdk-ui/src/public-api/alpha.d.ts

@@ -5,8 +5,13 @@
  * Not recommended for production use.
  */
 export { useDashboardTheme } from '../domains/dashboarding/use-dashboard-theme.js';
-export type { ThemeConfig } from '../types';
+export type { ThemeConfig, WidgetNarrativeDisplayLocation, WidgetNarrativeOptions, CompleteWidgetNarrativeOptions, WidgetAiOptions, } from '../types';
+export { DashboardHeaderTargets, type DashboardHeaderTarget, } from '../domains/dashboarding/components/dashboard-header-targets.js';
+export type { DashboardHeaderConfig, DashboardHeaderItem, DashboardHeaderItemComponent, DashboardHeaderItemComponentProps, DashboardHeaderItemPosition, DashboardHeaderItemSize, DashboardHeaderItemsTransform, DashboardResolvedHeaderItem, } from '../domains/dashboarding/components/dashboard-header-config.js';
 export { type TranslationDictionary, PACKAGE_NAMESPACE as translationNamespace, } from '../infra/translation/resources';
 export { CascadingFilterTile, type CascadingFilterTileProps, } from '../domains/filters/components/cascading-filter-tile';
 export { CustomFilterTile, type CustomFilterTileProps, } from '../domains/filters/components/custom-filter-tile';
+export { useSyncedState, type UseSyncedStateOptions } from '../shared/hooks/use-synced-state';
 export { isIndicatorRenderOptions, isHighchartsOptions, type HighchartsOptions, type CalendarHeatmapChartEventProps, } from '../props';
+export type { Module, ModuleRequirement } from '../infra/modules/types.js';
+export { useModuleApiRegistry } from '../infra/modules/modules-context.js';

package/dist/packages/sdk-ui/src/public-api/beta.d.ts

@@ -5,3 +5,9 @@
  * Not recommended for production use.
  */
 export { useQueryCache } from '../domains/query-execution/hooks/use-query-cache/use-query-cache';
+export type { Plugin, BasePluginInfo } from '../infra/plugins/types.js';
+export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
+export { SankeyChart } from '../domains/visualizations/components/sankey-chart';
+export type { SankeyChartProps } from '../props';
+export type { SankeyChartDataOptions } from '../domains/visualizations/core/chart-data-options/types';
+export type { SankeyStyleOptions, SankeyChartType } from '../types';

package/dist/packages/sdk-ui/src/public-api/internal.d.ts

@@ -8,7 +8,7 @@ export { type ClientApplication } from '../infra/app/types';
 export { createClientApplication } from '../infra/app/client-application';
 export { queryStateReducer } from '../domains/query-execution/hooks/shared/query-state-reducer';
 export { useExecuteCsvQueryInternal, useExecutePivotQueryInternal, executeQueryByWidgetId, } from '../domains/query-execution';
-export { executeCsvQuery, executePivotQuery, executeQuery, } from '../domains/query-execution/core/execute-query';
+export { executeCsvQuery, executePivotQuery, executeQuery, executeQueryWithRowCount, } from '../domains/query-execution/core/execute-query';
 export { useDashboardModel, getDashboardModel, getDashboardModels, translateToDashboardResponse, translateToDashboardsResponse, } from '../domains/dashboarding/dashboard-model';
 export { getWidgetModel } from '../domains/widgets/widget-model';
 export { getHierarchyModels } from '../domains/drilldown/hierarchy-model';

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

@@ -94,7 +94,9 @@ export * as dashboardModelTranslator from '../domains/dashboarding/dashboard-mod
 export * as dashboardHelpers from '../domains/dashboarding/dashboard-helpers';
 export type { EmptyObject } from '../shared/utils/utility-types';
 export { useFetch, type RequestConfig, type UseQueryResult } from '../shared/hooks/use-fetch';
-export type { StyledColumn, SeriesStyleOptions, StyledMeasureColumn, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, ScatterChartDataOptions, AreamapChartDataOptions, CalendarHeatmapChartDataOptions, TableDataOptions, TabularChartDataOptions, PivotTableDataOptions, ScattermapLocationLevel, ScattermapChartDataOptions, BoxWhiskerType, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, AreaRangeMeasureColumn, RangeChartDataOptions, ChartDataOptions, RegularChartDataOptions, } from '../domains/visualizations/core/chart-data-options/types';
+export type { StyledColumn, SeriesStyleOptions, StyledMeasureColumn, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, ScatterChartDataOptions, AreamapChartDataOptions, CalendarHeatmapChartDataOptions, TableDataOptions, TabularChartDataOptions, PivotTableDataOptions, ScattermapLocationLevel, ScattermapChartDataOptions, BoxWhiskerType, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, AreaRangeMeasureColumn, RangeChartDataOptions, ChartDataOptions, RegularChartDataOptions, CommonDataOptions, } from '../domains/visualizations/core/chart-data-options/types';
+export { formatNumber, formatDate, getDefaultDateFormat, formatDataSet } from '../infra/formatting';
+export type { FormatDateOptions, FormatDataSetOptions } from '../infra/formatting';
 export type { TabberButtonsWidgetProps, SisenseContextProviderProps, ExecuteQueryProps, ThemeProviderProps, BeforeRenderHandler, IndicatorBeforeRenderHandler, ChartDataPointsEventHandler, DataPointsEventHandler, DataPointEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler, AreamapDataPointEventHandler, ScattermapDataPointEventHandler, BoxplotDataPointEventHandler, IndicatorDataPointEventHandler, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEventHandler, PivotTableDataPointEventHandler, ChartEventProps, ChartProps, AreaChartProps, StreamgraphChartProps, BarChartProps, ColumnChartProps, FunnelChartProps, LineChartProps, PieChartProps, PolarChartProps, IndicatorChartProps, TableProps, PivotTableProps, ScatterChartProps, WidgetByIdProps, ExecuteQueryByWidgetIdProps, TreemapChartProps, SunburstChartProps, BoxplotChartProps, ScattermapChartProps, AreamapChartProps, AreaRangeChartProps, ContextMenuProps, DrilldownBreadcrumbsProps, DrilldownWidgetConfig, DrilldownWidgetProps, CalendarHeatmapChartProps, } from '../props';
 export type { AutoZoomNavigatorScrollerLocation } from '../domains/widgets/components/widget-by-id/types';
 export type { SortDirection, PivotRowsSort, AppConfig, DateConfig, CalendarDayOfWeek, IndicatorComponents, ScatterMarkerSize, LegendPosition, Coordinates, TableColorOptions, IndicatorRenderOptions, GeoDataElement, RawGeoDataElement, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, TextStyle, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, MonthOfYear, DayOfWeek, DateLevel, TabberButtonsWidgetStyleOptions, TabberButtonsWidgetCustomOptions, Color, ColorPaletteTheme, Navigator, LineWidth, DashStyle, EndCapType, LineOptions, Markers, X2Title, SeriesLabelsTextStyle, SeriesLabelsBase, SeriesLabelsAligning, SeriesLabels, TotalLabelsTextStyle, TotalLabels, LegendTitleOptions, LegendItemsOptions, LegendSymbolsOptions, LegendOptions, Legend, Labels, AxisLabel, Convolution, DataLimits, LineStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, StreamgraphStyleOptions, StackableStyleOptions, PiePercentageLabels, PieSeriesLabels, PieStyleOptions, FunnelSeriesLabels, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, TableStyleOptions, TabularChartStyleOptions, PivotTableStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterSeriesLabels, ScatterStyleOptions, TreemapSeriesLabels, TreemapStyleOptions, SunburstSeriesLabelsBase, SunburstSeriesLabels, SunburstStyleOptions, BoxplotStyleOptions, AreamapType, AreamapStyleOptions, ScattermapMarkers, ScattermapStyleOptions, CalendarHeatmapCellLabels, CalendarHeatmapSubtype, CalendarHeatmapStyleOptions, CalendarHeatmapViewType, ChartStyleOptions, RegularChartStyleOptions, ValueToColorMap, MultiColumnValueToColorMap, ChartType, RegularChartType, SeriesChartType, DecimalScale, NumberFormatConfig, ThemeOid, ChartThemeSettings, AiChatThemeSettings, ThemeSettingsFontSource, ThemeSettingsFont, FontsLoaderSettings, TypographyThemeSettings, GeneralThemeSettings, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetThemeSettings, FilterThemeSettings, ThemeSettings, WidgetStyleOptions, WidgetContainerStyleOptions, WidgetByIdStyleOptions, ChartWidgetStyleOptions, PivotTableWidgetStyleOptions, TextWidgetStyleOptions, CustomWidgetStyleOptions, DrilldownOptions, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, DrilldownSelection, DataOptionLocation, ChartDataPoints, ChartDataPoint, DataPoint, DataPointEntry, BasicDataPointEntry, AttributeDataPointEntry, MeasureDataPointEntry, ScatterDataPoint, BoxplotDataPoint, IndicatorDataPoint, CalendarHeatmapDataPoint, PivotTableDataPoint, AreamapDataPoint, ScattermapDataPoint, CustomWidgetDataPoint, CustomWidgetDataPointEventHandler, CustomWidgetDataPointContextMenuHandler, CustomWidgetDataPointsEventHandler, CustomWidgetEventProps, AbstractDataPointWithEntries, MenuPosition, MenuItemSection, CustomDrilldownResult, LoadingIndicatorConfig, GenericDataOptions, NestedTranslationResources, CustomTranslationObject, TranslationConfig, } from '../types';

package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts

@@ -19,17 +19,19 @@ export { QuotaNotification } from '../shared/components/quota-notification/quota
 export type { QuotaNotificationProps } from '../shared/components/quota-notification/quota-notification.js';
 export { useQuotaNotification } from '../shared/hooks/use-quota-notification.js';
 export type { QuotaNotificationOptions, QuotaApiResponse, QuotaState, } from '../shared/hooks/use-quota-notification.js';
-export type { Plugin } from '../infra/plugins/types.js';
-export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
+export type { VisualizationStateUpdate } from '../infra/plugins/widget-plugins/types.js';
 export { LoadingIndicator } from '../shared/components/loading-indicator.js';
 export { DataSchemaBrowser } from '../domains/data-browser/data-schema-browser/data-schema-browser.js';
 export { type NarrativeQueryParams } from '../domains/narrative/core/build-narrative-request.js';
-export { useGetWidgetNarrative, type UseGetWidgetNarrativeOptions, type UseGetWidgetNarrativeParams, type UseGetWidgetNarrativeResult, } from '../domains/narrative/hooks/use-get-widget-narrative.js';
+export { useGetWidgetNarrative, type UseGetWidgetNarrativeParams, type UseGetWidgetNarrativeResult, } from '../domains/narrative/hooks/use-get-widget-narrative.js';
 export { WidgetNarrative, type WidgetNarrativeProps, } from '../domains/narrative/components/widget-narrative.js';
 export type { NlqChartWidgetStyleOptions } from '../types';
 export type { RenderToolbarHandler, RenderTitleHandler } from '../types';
 export { isChartWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
 export { isPivotTableWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
+export { DashboardModule, type DashboardModuleApi, } from '../domains/dashboarding/dashboard-module/dashboard-module.js';
+export type { DashboardCustomization, DashboardStateApi, } from '../domains/dashboarding/dashboard-module/types.js';
+export { withHeaderItem } from '../domains/dashboarding/dashboard-helpers.js';
 export { useDashboardPersistence } from '../domains/dashboarding/dashboard-model';
 export { createDashboardPersistenceManager } from '../domains/dashboarding/persistence/persistence-manager.js';
 export type { DashboardPersistenceManager } from '../domains/dashboarding/persistence/types.js';

package/dist/packages/sdk-ui/src/shared/components/loading-overlay.d.ts

@@ -25,5 +25,6 @@ export type LoadingOverlayProps = {
  *   <Chart {...chartOptions} />
  * </LoadingOverlay>
  * ```
+ * @group Primitives
  */
 export declare const LoadingOverlay: ({ isVisible, children }: LoadingOverlayProps) => import("react/jsx-runtime").JSX.Element;