@sisense/sdk-ui 2.28.0 → 2.29.0

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

@@ -0,0 +1,79 @@
+/**
+ * Producer-side declaration of a single API field on a module.
+ */
+export interface ApiField<TValue, TRegistry> {
+    /** Creates the per-registration registry holding contributions for this field. */
+    createRegistry: () => TRegistry;
+    /** Writes a contribution into the registry. Invoked once per contributor. */
+    register: (value: TValue, registry: TRegistry, fromModule: Module) => void;
+}
+/**
+ * The shape of a producer module's `api` property — a record of `ApiField` declarations.
+ * Each module declares its own concrete schema (e.g. `CoreModuleApiDefinition`);
+ */
+export type ApiSchema = Record<string, ApiField<any, any>>;
+/**
+ * Module definition
+ *
+ * @alpha
+ */
+export interface Module<TSchema = any> {
+    /** Unique module identifier, e.g. `'dashboard'`. */
+    name: string;
+    /** Module version */
+    version: string;
+    /**
+     * Modules this module integrates with.
+     * - `'name'` → hard requirement.
+     * - `{ name }` → hard requirement.
+     * - `{ name, optional: true }` → soft; contributions to it are dropped if absent.
+     * - `{ ..., requiredVersion: '^2.0.0' }` → optional semver range constraint.
+     */
+    requires?: ReadonlyArray<ModuleRequirement>;
+    /** Modules this one ships as part of its own feature */
+    includes?: ReadonlyArray<Module>;
+    /**
+     * Declarative contributions to other modules, keyed by target module name.
+     */
+    integrations?: Record<string, unknown>;
+    /** Producer-side API declaration; defines registries other modules contribute to. */
+    api?: TSchema;
+}
+/**
+ * Hard or soft requirement on another module, optionally version-constrained.
+ *
+ * @alpha
+ */
+export type ModuleRequirement = string | {
+    name: string;
+    /** If true, the requirement may be missing and contributions to it are dropped. */
+    optional?: boolean;
+    /**
+     * Semver range the registered target's `version` must satisfy
+     * (e.g. `'^2.0.0'`). Mismatches throw at boot unless `optional`.
+     */
+    requiredVersion?: string;
+};
+/**
+ * Resolves the registry type owned by a producer module's API field — the
+ * value `useModuleApiRegistry(module, field)` returns.
+ */
+export type RegistryOf<TSchema, K extends keyof TSchema> = TSchema[K] extends ApiField<any, infer R> ? R : never;
+/**
+ * Resolves the contribution value type a consumer must supply for a producer's API field.
+ */
+export type ValueOf<TSchema, K extends keyof TSchema> = TSchema[K] extends ApiField<infer V, any> ? V : never;
+/**
+ * Derives the consumer-facing `*ModuleApi` contract from a producer schema.
+ * Each field becomes optional and typed as its contribution value.
+ *
+ * @example
+ * ```ts
+ * export type CoreModuleApi = ApiContract<CoreModuleApiDefinition>;
+ * // → { providers?: ComponentType<{ children: ReactNode }>[] }
+ * ```
+ * @alpha
+ */
+export type ApiContract<TSchema> = {
+    [K in keyof TSchema]?: ValueOf<TSchema, K>;
+};

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

@@ -1,5 +1,6 @@
 import { FunctionComponent, ReactNode } from 'react';
 import type { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import type { DeepPartial } from 'ts-essentials';
 import { AnyObject } from '../../../shared/utils/utility-types';
 import type { AbstractDataPointWithEntries, GenericDataOptions } from '../../../types';
 import type { BasePluginInfo } from '../types';
@@ -8,7 +9,7 @@ import type { BasePluginInfo } from '../types';
  *
  * @sisenseInternal
  */
-export interface WidgetPlugin<Props extends CustomVisualizationProps = CustomVisualizationProps> extends BasePluginInfo {
+export interface WidgetPlugin<Props extends CustomVisualizationProps<any, any, any, any> = CustomVisualizationProps> extends BasePluginInfo {
     /**
      * The type of plugin
      */
@@ -179,7 +180,7 @@ export type AnyWidgetPlugin = WidgetPlugin<any>;
  *
  * @sisenseInternal
  */
-export interface CustomVisualizationProps<DataOptions = GenericDataOptions, StyleOptions = CustomVisualizationStyleOptions, DataPoint extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> extends CustomVisualizationEventProps<DataPoint> {
+export interface CustomVisualizationProps<DataOptions = GenericDataOptions, StyleOptions = CustomVisualizationStyleOptions, DataPoint extends AbstractDataPointWithEntries = AbstractDataPointWithEntries, CustomOptions = Record<string, unknown>> extends CustomVisualizationEventProps<DataPoint> {
     /** Data source for the custom visualization */
     dataSource?: DataSource;
     /** Data options defining what data to display */
@@ -190,7 +191,46 @@ export interface CustomVisualizationProps<DataOptions = GenericDataOptions, Styl
     filters?: Filter[] | FilterRelations;
     /** Highlight filters for interactive highlighting */
     highlights?: Filter[];
+    /**
+     * Arbitrary plugin-specific options that is not data- or style-related.
+     *
+     * @sisenseInternal
+     */
+    customOptions?: CustomOptions;
+    /**
+     * Emit a partial state update to be persisted through the dashboard
+     * persistence layer. Injected by the dashboard when the widget lives inside a
+     * Dashboard component; `undefined` in standalone use or read-only mode — always
+     * call it with optional chaining.
+     *
+     * @example
+     * ```tsx
+     * onChange?.({ customOptions: { lastPage: 3 } });
+     * ```
+     *
+     * @sisenseInternal
+     */
+    onChange?: (update: VisualizationStateUpdate<StyleOptions, CustomOptions>) => void;
 }
+/**
+ * Partial persistable state a custom visualization can push back to the
+ * persistence layer. Carries the same props vocabulary the plugin already reads
+ * from.
+ *
+ * Both fields are deeply partial and are deep-merged into the current widget
+ * state: nested plain objects merge recursively at any depth, so a plugin
+ * passes only the leaf values that changed — e.g.
+ * `{ styleOptions: { pagination: { currentPage: 3 } } }` updates `currentPage`
+ * while preserving the sibling `pagination` keys. Arrays and primitives are
+ * replaced wholesale (last-write-wins). Keys cannot be deleted via merge —
+ * overwrite with an explicit value (e.g. `null`) instead.
+ *
+ * @sisenseInternal
+ */
+export type VisualizationStateUpdate<StyleOptions = CustomVisualizationStyleOptions, CustomOptions = Record<string, unknown>> = {
+    styleOptions?: DeepPartial<StyleOptions>;
+    customOptions?: DeepPartial<CustomOptions>;
+};
 /**
  * Style options for a custom visualization.
  *
@@ -206,6 +246,16 @@ export interface CustomVisualizationStyleOptions extends AnyObject {
  * @sisenseInternal
  */
 export type CustomVisualization<Props = CustomVisualizationProps> = (props: Props) => ReactNode;
+/**
+ * A custom visualization with erased prop types, used for heterogeneous storage
+ * at registry/context boundaries. Each concrete visualization specializes
+ * {@link CustomVisualizationProps} differently (and may require extra props such
+ * as a widget `id`), so the registry cannot know each exact shape — the prop
+ * type is intentionally erased here. Do not consume prop types from this alias.
+ *
+ * @sisenseInternal
+ */
+export type AnyCustomVisualization = CustomVisualization<any>;
 /**
  * Event props for custom visualizations with generic data point type.
  *

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

@@ -1,4 +1,4 @@
-import type { CustomVisualization } from './types.js';
+import type { AnyCustomVisualization } from './types.js';
 /**
  * Central widget registration and lookup.
  * Plugin-sourced entries take priority over legacy-sourced entries.
@@ -12,7 +12,7 @@ export declare class WidgetPluginRegistry {
      * Plugin-sourced entries take priority over legacy-sourced entries.
      * Within the same source, first-write-wins (no silent overwrites).
      */
-    register(widgetTypeName: string, component: CustomVisualization, source?: 'plugin' | 'legacy'): void;
+    register(widgetTypeName: string, component: AnyCustomVisualization, source?: 'plugin' | 'legacy'): void;
     /**
      * Unregister a widget by type name and source.
      * Only removes the entry if it matches the given source.
@@ -23,7 +23,7 @@ export declare class WidgetPluginRegistry {
      * When `source` is provided, returns the component only if the entry matches that source.
      * When omitted, returns the component for any source (plugin takes priority over legacy).
      */
-    getComponent(widgetTypeName: string, source?: 'plugin' | 'legacy'): CustomVisualization | undefined;
+    getComponent(widgetTypeName: string, source?: 'plugin' | 'legacy'): AnyCustomVisualization | undefined;
     /**
      * Check if a widget is registered.
      * When `source` is provided, returns true only if an entry exists for that source.

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/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

@@ -9,6 +9,7 @@ import { HighchartsOptions } from './domains/visualizations/core/chart-options-p
 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';
 export type { TabberButtonsWidgetProps } from './domains/widgets/components/tabber-buttons-widget/types';
@@ -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.

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

@@ -9,4 +9,7 @@ export type { ThemeConfig } from '../types';
 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';