@sisense/sdk-ui 2.27.0 → 2.29.0

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

@@ -0,0 +1,26 @@
+import type { ComponentType, ReactNode } from 'react';
+import type { ApiContract, ApiField, Module } from './types.js';
+type ProviderComponent = ComponentType<{
+    children: ReactNode;
+}>;
+/**
+ * API declaration for the `core` module.
+ */
+export interface CoreModuleApiDefinition {
+    /** Root-level React providers mounted by `SisenseContextProvider`. */
+    providers: ApiField<ProviderComponent[], ProviderComponent[]>;
+}
+/**
+ * API contract for contributing to the `core` module.
+ */
+export type CoreModuleApi = ApiContract<CoreModuleApiDefinition>;
+export declare const CORE_MODULE_NAME = "core";
+/**
+ * The `core` module.
+ * Always registered automatically by `ModuleProvider`; consumers do not need to list it in the `modules` prop.
+ *
+ * Owns the `providers` registry — other modules contribute root-level React
+ * providers there, which `CoreModuleProvidersTree` mounts inside `SisenseContextProvider`.
+ */
+export declare const CoreModule: Module<CoreModuleApiDefinition>;
+export {};

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

@@ -0,0 +1,3 @@
+export type { Module, ModuleRequirement } from './types.js';
+export { useModuleApiRegistry } from './modules-context.js';
+export { ModuleProvider, type ModuleProviderProps } from './module-provider.js';

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

@@ -0,0 +1,17 @@
+import { type FunctionComponent, type PropsWithChildren } from 'react';
+import type { Module } from './types.js';
+/**
+ * Props for `ModuleProvider`.
+ */
+export interface ModuleProviderProps {
+    /**
+     * Modules to register.
+     *
+     * `CoreModule` is registered automatically; consumers do not need to list it.
+     */
+    modules?: ReadonlyArray<Module>;
+}
+/**
+ * Registers the given modules and makes the API registry available to the children.
+ */
+export declare const ModuleProvider: FunctionComponent<PropsWithChildren<ModuleProviderProps>>;

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

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import type { ModulesApiRegistry } from './build-module-registry.js';
+import type { Module, RegistryOf } from './types.js';
+/**
+ * Modules API registry context.
+ */
+export declare const ModulesContext: import("react").Context<ModulesApiRegistry | null>;
+/**
+ * Gives access to the API registry for a given module and field.
+ *
+ * @example
+ * ```ts
+ * const chartBuilders = useModuleApiRegistry(VisualizationsModule, 'chartBuilders');
+ * ```
+ * @throws if used outside a `ModuleProvider`.
+ * @throws if `module` was not registered in the enclosing provider.
+ *
+ * @alpha
+ */
+export declare const useModuleApiRegistry: <TSchema, K extends keyof TSchema & string>(module: Module<TSchema>, field: K) => RegistryOf<TSchema, K>;

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/infra/themes/legacy-design-settings.d.ts

@@ -1,6 +1,6 @@
-import { CompleteThemeSettings, ThemeOid } from '../../types.js';
+import { CompleteThemeSettingsInternal, ThemeOid } from '../../types.js';
 /**
- * Legacy analog of CompleteThemeSettings used in Sisense UI.
+ * Legacy analog of CompleteThemeSettingsInternal used in Sisense UI.
  */
 export type LegacyDesignSettings = {
     oid: ThemeOid;
@@ -88,11 +88,11 @@ export declare const LEGACY_DESIGN_TYPES: {
     dark: string;
 };
 /**
- * Converts legacy (used in Sisense UI) design settings and it's palette object to CompleteThemeSettings.
+ * Converts legacy (used in Sisense UI) design settings and its palette object to CompleteThemeSettingsInternal.
  *
  * @param legacyDesignSettings - legacy design settings.
  * @param legacyPalette - legacy palette object.
  * @returns
  */
-export declare function convertToThemeSettings(legacyDesignSettings: LegacyDesignSettings, legacyPalette: LegacyPalette, domainUrl: string): CompleteThemeSettings;
+export declare function convertToThemeSettings(legacyDesignSettings: LegacyDesignSettings, legacyPalette: LegacyPalette, domainUrl: string): CompleteThemeSettingsInternal;
 export declare function getPaletteName(legacyDesignSettings: LegacyDesignSettings): string;

package/dist/packages/sdk-ui/src/infra/themes/theme-loader.d.ts

@@ -1,13 +1,13 @@
 import type { HttpClient } from '@sisense/sdk-rest-client';
-import type { CompleteThemeSettings, ThemeOid } from '../../types';
+import type { CompleteThemeSettingsInternal, ThemeOid } from '../../types';
 import { type LegacyPalette } from './legacy-design-settings';
 /**
- * Fetches theme settings from the Sisense instance and converts them to CompleteThemeSettings.
+ * Fetches theme settings from the Sisense instance and converts them to CompleteThemeSettingsInternal.
  *
  * @param themeOid - Theme oid.
  * @param httpClient - Sisense REST API client.
- * @returns CompleteThemeSettings from server.
+ * @returns CompleteThemeSettingsInternal from server.
  * @internal
  */
-export declare function getThemeSettingsByOid(themeOid: ThemeOid, httpClient: Pick<HttpClient, 'get' | 'url'>): Promise<CompleteThemeSettings>;
+export declare function getThemeSettingsByOid(themeOid: ThemeOid, httpClient: Pick<HttpClient, 'get' | 'url'>): Promise<CompleteThemeSettingsInternal>;
 export declare function getLegacyPalette(paletteName: string, httpClient: Pick<HttpClient, 'get'>): Promise<LegacyPalette>;

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -225,6 +225,9 @@ declare const _default: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -222,6 +222,9 @@ export declare const translation: {
             distributeEqualWidth: string;
             download: string;
             csvFile: string;
+            excelFile: string;
+            repeatRowsRecommended: string;
+            mergeRows: string;
         };
     };
     customWidgets: {

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

@@ -232,6 +232,9 @@ export declare const resources: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {
@@ -681,6 +684,9 @@ export declare const resources: {
                 distributeEqualWidth: string;
                 download: string;
                 csvFile: string;
+                excelFile: string;
+                repeatRowsRecommended: string;
+                mergeRows: string;
             };
         };
         customWidgets: {

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

@@ -1,4 +1,4 @@
-import { CompleteThemeSettings } from '../..';
+import { CompleteThemeSettingsInternal } from '../..';
 export default function AiDisclaimer({ theme }: {
-    theme: CompleteThemeSettings;
+    theme: CompleteThemeSettingsInternal;
 }): import("react/jsx-runtime").JSX.Element;

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/dashboard/translate-dashboard-from-json.d.ts

@@ -0,0 +1,17 @@
+import { DashboardProps } from '../../../../domains/dashboarding/types.js';
+import type { NlqTranslationResult } from '../../types.js';
+import type { DashboardInput } from '../types.js';
+/**
+ * Translates NLQ DashboardJSON format to CSDK DashboardProps.
+ * Direction: JSON → CSDK
+ *
+ * Translates each widget using `translateWidgetFromJSON` (which requires each widget JSON to
+ * have an `id`). Dashboard-level filters are translated using the shared filter translator.
+ *
+ * Translation fails if any widget or filter translation fails.
+ *
+ * @param input - DashboardInput containing dashboardJSON and data schema context
+ * @returns NlqTranslationResult with DashboardProps or errors
+ * @internal
+ */
+export declare const translateDashboardFromJSON: (input: DashboardInput) => NlqTranslationResult<DashboardProps>;

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

@@ -0,0 +1,15 @@
+import { DashboardProps } from '../../../../domains/dashboarding/types.js';
+import type { NlqTranslationResult } from '../../types.js';
+import type { DashboardJSON } from '../types.js';
+/**
+ * Translates CSDK DashboardProps to NLQ DashboardJSON format.
+ * Direction: CSDK → JSON
+ *
+ * Translates each widget using `translateWidgetToJSON` and dashboard-level filters using
+ * the shared filter translator. Translation fails if any widget or filter translation fails.
+ *
+ * @param dashboardProps - Dashboard props to serialize
+ * @returns NlqTranslationResult with DashboardJSON or errors
+ * @internal
+ */
+export declare const translateDashboardToJSON: (dashboardProps: DashboardProps) => NlqTranslationResult<DashboardJSON>;