@sisense/sdk-ui 2.27.0 → 2.29.0

package/dist/packages/sdk-ui/src/domains/dashboarding/components/editable-layout/const.d.ts

@@ -4,7 +4,7 @@ export declare const MIN_ROW_HEIGHT = 60;
 export declare const MAX_ROW_HEIGHT = 1500;
 export declare const WIDGET_HEADER_HEIGHT = 32;
 export declare const MIN_COLUMN_WIDTH = 128;
-export declare const MAX_COLUMN_WIDTH = 2048;
+export declare const MAX_COLUMN_WIDTH: number;
 export declare const Z_INDEX_RESIZE_OVERLAY = 100;
 export declare const Z_INDEX_RESIZE_LINE = 101;
 export declare const Z_INDEX_CELL_DROPZONE = 102;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/dashboard-model-translator.d.ts

@@ -1,7 +1,7 @@
 import { DashboardProps } from '../../../domains/dashboarding/index.js';
 import { DashboardDto } from '../../../infra/api/types/dashboard-dto.js';
 import { AppSettings } from '../../../infra/app/settings/settings.js';
-import { CompleteThemeSettings } from '../../../types.js';
+import { CompleteThemeSettingsInternal } from '../../../types.js';
 import { DashboardModel } from './dashboard-model.js';
 /**
  * Translates {@link DashboardModel} to {@link DashboardProps}.
@@ -20,4 +20,4 @@ export declare function toDashboardProps(dashboardModel: DashboardModel): Dashbo
  * @param appSettings - Optional application settings
  * @internal
  */
-export declare function fromDashboardDto(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): DashboardModel;
+export declare function fromDashboardDto(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettingsInternal, appSettings?: AppSettings): DashboardModel;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/get-dashboard-model.d.ts

@@ -1,7 +1,7 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { DashboardModel } from '../../../domains/dashboarding/dashboard-model';
 import { AppSettings } from '../../../infra/app/settings/settings';
-import { CompleteThemeSettings } from '../../../types';
+import { CompleteThemeSettingsInternal } from '../../../types';
 export interface GetDashboardModelOptions {
     /**
      * Boolean flag whether to include widgets in the dashboard model
@@ -30,6 +30,13 @@ export interface GetDashboardModelOptions {
      * @internal
      */
     useLegacyApiVersion?: boolean;
+    /**
+     * Whether to fetch the dashboard with admin-level access.
+     *
+     * @default false
+     * @sisenseInternal
+     */
+    adminAccess?: boolean;
 }
 /**
  * Retrieves a dashboard model by its OID.
@@ -44,4 +51,4 @@ export interface GetDashboardModelOptions {
  * @internal
  * @sisenseInternal
  */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<DashboardModel>;
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettingsInternal, appSettings?: AppSettings): Promise<DashboardModel>;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/get-dashboard-models.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { AppSettings } from '../../../infra/app/settings/settings';
-import { CompleteThemeSettings } from '../../../types';
+import { CompleteThemeSettingsInternal } from '../../../types';
 export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
@@ -14,4 +14,4 @@ export interface GetDashboardModelsOptions {
     includeWidgets?: boolean;
 }
 /** @internal */
-export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<import('../../../domains/dashboarding/dashboard-model').DashboardModel[]>;
+export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions, themeSettings?: CompleteThemeSettingsInternal, appSettings?: AppSettings): Promise<import('../../../domains/dashboarding/dashboard-model').DashboardModel[]>;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/translate-dashboard-utils.d.ts

@@ -1,4 +1,4 @@
-import { Dimension, Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode, Measure } from '@sisense/sdk-data';
+import { Dimension, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
 import { JtdTarget, JumpToDashboardConfig, JumpToDashboardConfigForPivot, TriggerMethod } from '../../../domains/dashboarding/hooks/jtd/jtd-types';
 import { TabbersConfig } from '../../../domains/dashboarding/hooks/use-tabber';
 import { Panel, WidgetDto } from '../../../domains/widgets/components/widget-by-id/types';
@@ -7,7 +7,7 @@ import { type CascadingFilterDto, DashboardDto, type FilterDto, type LayoutDto }
 import type { SpecificWidgetOptions, WidgetsOptions, WidgetsPanelColumnLayout } from './types';
 type WidgetJtdDtoSlice = Pick<WidgetDto, 'oid' | 'type' | 'metadata' | 'drillToDashboardConfig'>;
 export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
-export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
+export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsDtoOptions?: DashboardDto['filterRelations']): Filter[] | FilterRelations;
 export declare const getJtdNavigateType: (widget: WidgetJtdDtoSlice) => TriggerMethod;
 export declare const convertDimensionsToDimIndexes: (widget: WidgetJtdDtoSlice, dimensionIds: string[]) => string[];
 /**

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/persist-dashboard-model-middleware.d.ts

@@ -1,7 +1,8 @@
 import { DataSource } from '@sisense/sdk-data';
+import { DashboardModel } from '../../../../../domains/dashboarding/dashboard-model';
 import { RestApi } from '../../../../../infra/api/rest-api';
 import { AppSettings } from '../../../../../infra/app/settings/settings';
-import { CompleteThemeSettings } from '../../../../../types';
+import { CompleteThemeSettingsInternal } from '../../../../../types';
 import { UseDashboardModelInternalAction } from './types.js';
 export type PersistDashboardModelMiddlewareParams = {
     /** Dashboard OID, or undefined if not initialized */
@@ -15,13 +16,21 @@ export type PersistDashboardModelMiddlewareParams = {
     /** Application settings forwarded to {@link toWidgetDto} (controls widget design feature flag) */
     appSettings: AppSettings;
     /** Theme settings forwarded to {@link toWidgetDto} (used as defaults for widget design) */
-    themeSettings: CompleteThemeSettings;
+    themeSettings: CompleteThemeSettingsInternal;
     /**
      * Dashboard-level data source. Used as a fallback data source for widgets
      * whose model does not carry one (e.g. text widgets), so the produced DTO
      * still satisfies the server's datasource schema.
      */
     dashboardDataSource?: DataSource;
+    /**
+     * Pre-reducer dashboard model snapshot. Used by UPDATE_WIDGET to read
+     * `widgetsOptions[oid].partialDtoOptions.options` so the Fusion PATCH carries
+     * the full options object (Fusion replaces, not merges).
+     *
+     * @internal
+     */
+    model?: DashboardModel;
 };
 /**
  * Middleware that persists the dashboard model changes to the Sisense server.
@@ -29,4 +38,4 @@ export type PersistDashboardModelMiddlewareParams = {
  * @returns Promise resolving to the action (possibly transformed, e.g. for ADD_WIDGET)
  * @internal
  */
-export declare function persistDashboardModelMiddleware({ dashboardOid, action, restApi, sharedMode, appSettings, themeSettings, dashboardDataSource, }: PersistDashboardModelMiddlewareParams): Promise<UseDashboardModelInternalAction>;
+export declare function persistDashboardModelMiddleware({ dashboardOid, action, restApi, sharedMode, appSettings, themeSettings, dashboardDataSource, model, }: PersistDashboardModelMiddlewareParams): Promise<UseDashboardModelInternalAction>;

package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/types.d.ts

@@ -1,5 +1,6 @@
 import { Filter, FilterRelations } from '@sisense/sdk-data';
 import { DashboardModel, SpecificWidgetOptions, WidgetsPanelLayout } from '../../../../../domains/dashboarding/dashboard-model';
+import type { WidgetPropsUpdate } from '../../../../../domains/dashboarding/persistence/update-types.js';
 import type { WidgetDto } from '../../../../../domains/widgets/components/widget-by-id/types';
 import { WidgetModel } from '../../../../../domains/widgets/widget-model';
 export type UseDashboardModelState = DashboardModel | null;
@@ -21,6 +22,7 @@ export declare enum UseDashboardModelActionType {
     FILTERS_UPDATE = "FILTERS.UPDATE",
     ADD_WIDGET = "WIDGETS.ADD",
     PATCH_WIDGET = "WIDGETS.PATCH",
+    UPDATE_WIDGET = "WIDGETS.UPDATE",
     WIDGETS_PANEL_LAYOUT_UPDATE = "WIDGETS_PANEL_LAYOUT.UPDATE",
     WIDGETS_DELETE = "WIDGETS.DELETE"
 }
@@ -46,6 +48,18 @@ export type WidgetPatch = {
             max: number;
         };
     };
+    /**
+     * Full opaque widget style to send in the PATCH request. Used for custom
+     * (plugin) widgets whose `styleOptions` round-trip through `WidgetDto.style`.
+     * Must reconstruct the entire style object (the server replaces it on PATCH).
+     */
+    style?: WidgetDto['style'];
+    /**
+     * Full custom-widget options bag to send in the PATCH request.
+     * Must include all existing keys alongside the changed ones, because the
+     * server replaces the entire object rather than merging.
+     */
+    customOptions?: Record<string, unknown>;
 };
 /**
  * Internal actions for the dashboard model state used in {@link useDashboardModel}.
@@ -62,12 +76,26 @@ export type UseDashboardModelInternalAction = UseDashboardModelAction | {
         widgets: string[];
     };
 };
+/**
+ * Props-shaped widget update action. Carries a partial `WidgetPropsUpdate` that
+ * the reducer applies to the in-memory `WidgetModel` and the persist middleware
+ * translates to a targeted DTO patch via its per-field mapping table.
+ *
+ * @internal
+ */
+export type UseDashboardModelUpdateWidgetAction = {
+    type: UseDashboardModelActionType.UPDATE_WIDGET;
+    payload: {
+        widgetOid: string;
+        update: WidgetPropsUpdate;
+    };
+};
 /**
  * Actions for the dashboard model state used in {@link useDashboardModel}.
  *
  * @internal
  */
-export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseDashboardModelAddWidgetAction | UseDashboardModelPatchWidgetAction | UseDashboardModelLayoutUpdateAction | UseDashboardWidgetsDeleteAction;
+export type UseDashboardModelAction = UseDashboardModelFilterUpdateAction | UseDashboardModelAddWidgetAction | UseDashboardModelPatchWidgetAction | UseDashboardModelUpdateWidgetAction | UseDashboardModelLayoutUpdateAction | UseDashboardWidgetsDeleteAction;
 /**
  * Filter update actions for the dashboard model state used in {@link useDashboardModel}.
  *

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-excel-download.d.ts

@@ -0,0 +1,23 @@
+import type { WidgetProps } from '../../../domains/widgets/components/widget/types.js';
+export type UseWidgetExcelDownloadParams = {
+    widgets: WidgetProps[];
+    /**
+     * Excel download enabled value from `config.widgetsPanel.actions.downloadExcel.enabled`.
+     * Per-widget `config.actions.downloadExcel.enabled` overrides when explicitly set.
+     */
+    enabled: boolean;
+};
+/**
+ * Applies dashboard-level Excel download settings to each widget's `config`.
+ *
+ * Reads `config.widgetsPanel.actions.downloadExcel.enabled` and merges it into
+ * `widget.config.actions.downloadExcel` for every widget.
+ * Widget-level `config.actions.downloadExcel.enabled` takes precedence when defined, so the dashboard-level config acts as a
+ * default rather than replacing explicit widget configuration.
+ *
+ * @param params - Widgets and panel-level Excel toggle
+ * @returns Widgets with resolved `config.actions.downloadExcel.enabled`
+ */
+export declare function useWidgetExcelDownload({ widgets, enabled }: UseWidgetExcelDownloadParams): {
+    widgets: WidgetProps[];
+};

package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-updates-persistence.d.ts

@@ -0,0 +1,27 @@
+import type { DashboardPersistenceManager } from '../../../domains/dashboarding/persistence/types';
+import type { WidgetProps } from '../../../domains/widgets/components/widget/types';
+type Persistence = Pick<DashboardPersistenceManager, 'updateWidget'> | undefined;
+/**
+ * Composition middleware that adds persistable widget-update plumbing to a
+ * widget list. For each widget that exposes a known runtime-state callback
+ * (currently only `styleOptions.navigator.onScrollerChange` for charts with
+ * a navigator), the hook injects a handler that:
+ *
+ * 1. Applies the update optimistically to local widget state (the parent
+ *    `useComposedDashboardInternal` re-renders with the new value).
+ * 2. Schedules a debounced (500 ms) call to `persistence.updateWidget` with
+ *    a {@link WidgetPropsUpdate}-shaped payload.
+ *
+ * When `persistence` is `undefined`, the optimistic apply still runs (so
+ * visualizations behave correctly in read-only mode) and the persist call
+ * is skipped.
+ *
+ * Errors during persistence are logged via `console.error`; the hook does
+ * not roll back local state.
+ *
+ * @sisenseInternal
+ */
+export declare function useWidgetUpdatesPersistence(widgets: WidgetProps[], setWidgets: (updater: (prev: WidgetProps[]) => WidgetProps[]) => void, persistence?: Persistence): {
+    widgets: WidgetProps[];
+};
+export {};

package/dist/packages/sdk-ui/src/domains/dashboarding/persistence/deep-merge.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Deep-merges a partial `update` into `base` for widget-update persistence.
+ *
+ * Merge semantics (shared by every merge point of the unified widget-update
+ * channel — pending-update accumulator, optimistic apply, model reducer and
+ * DTO patch):
+ * - nested plain objects are merged recursively at any depth;
+ * - arrays, primitives and non-plain objects (e.g. `Date`) are replaced
+ *   wholesale (last-write-wins);
+ * - keys cannot be deleted via merge — overwrite with an explicit value
+ *   (e.g. `null`) instead.
+ *
+ * Pure: returns a new object, never mutates the inputs.
+ *
+ * @internal
+ */
+export declare function deepMerge<T extends object>(base: T, update: object): T;

package/dist/packages/sdk-ui/src/domains/dashboarding/persistence/types.d.ts

@@ -1,5 +1,7 @@
 import type { SpecificWidgetOptions, WidgetPatch, WidgetsPanelLayout } from '../../../domains/dashboarding/dashboard-model';
 import type { WidgetProps } from '../../../domains/widgets/components/widget/types';
+import type { WidgetPropsUpdate } from './update-types.js';
+export type { WidgetPropsUpdate, OnWidgetUpdate } from './update-types.js';
 /**
  * Interface for persisting dashboard changes from the composition layer (e.g. add widget).
  *
@@ -49,4 +51,17 @@ export type DashboardPersistenceManager = {
      * The patch to apply to the widget.
      */
     patch: WidgetPatch) => Promise<void>;
+    /**
+     * Apply a props-shaped partial update to an existing widget. The composition
+     * layer's preferred write channel for visualization-originated state
+     * (scroll, customOptions, future title/description). Internally routed
+     * through the per-field DTO patch table in `persist-dashboard-model-middleware`.
+     *
+     * Fire-and-forget; errors are logged at the call site. The reducer applies
+     * the update to the canonical `WidgetModel` synchronously before the REST
+     * call fires.
+     *
+     * @sisenseInternal
+     */
+    updateWidget: (widgetOid: string, update: WidgetPropsUpdate) => Promise<void>;
 };

package/dist/packages/sdk-ui/src/domains/dashboarding/persistence/update-types.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Narrow, props-shaped slice of widget state that can be persisted through the
+ * unified `DashboardPersistenceManager.updateWidget` channel. Intentionally
+ * narrow on first landing — extended only when a new field is paired with a
+ * row in the persist middleware's per-field DTO patch table AND an
+ * update→DTO-patch→re-read roundtrip test.
+ *
+ * For the persistable-vs-transient distinction, see
+ * [unified-widget-updates-persistence.md §6.4](./__dev-docs__/unified-widget-updates-persistence.md).
+ * Transient/interactive events (drilldown selections, in-progress title edits)
+ * stay on the {@link WidgetChangeEvent} channel.
+ *
+ * @sisenseInternal
+ */
+export type WidgetPropsUpdate = {
+    readonly styleOptions?: {
+        readonly navigator?: {
+            readonly scrollerLocation?: {
+                readonly min: number;
+                readonly max: number;
+            };
+        };
+        /**
+         * For custom (plugin) widgets, `styleOptions` is an opaque deeply-partial
+         * bag — arbitrary keys are deep-merged into the widget's opaque DTO
+         * `style` (see `deepMerge` for the semantics). Chart widgets only use the
+         * typed `navigator` subtree above.
+         */
+        readonly [key: string]: unknown;
+    };
+    /**
+     * Custom-widget-specific runtime options to persist. Only meaningful for
+     * custom (plugin) widgets. The middleware deep-merges this into the widget
+     * DTO's `customOptions` bag, preserving any existing keys (at any depth) not
+     * present in the update.
+     *
+     * Only serializable values should be passed — non-serializable values cannot
+     * survive the DTO round-trip.
+     */
+    readonly customOptions?: Readonly<Record<string, unknown>>;
+};
+/**
+ * Callback signature used internally by `useWidgetUpdatesPersistence` to emit
+ * a persistable update for a specific widget. Not part of the public
+ * `WidgetProps` surface — composition layer injects handlers into the
+ * visualization's existing callback APIs (e.g.
+ * `styleOptions.navigator.onScrollerChange`).
+ *
+ * @internal
+ */
+export type OnWidgetUpdate = (update: WidgetPropsUpdate) => void;

package/dist/packages/sdk-ui/src/domains/dashboarding/types.d.ts

@@ -181,6 +181,19 @@ export interface WidgetsPanelConfig {
              */
             enabled?: boolean;
         };
+        /**
+         * Configuration for downloading widget data as Excel.
+         *
+         * @sisenseInternal
+         */
+        downloadExcel?: {
+            /**
+             * Determines whether the widgets possibility to download Excel is enabled.
+             *
+             * If not specified, the default value is `false`.
+             */
+            enabled?: boolean;
+        };
     };
 }
 /**

package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-export/build-jaql-excel-export.d.ts

@@ -0,0 +1,48 @@
+import { type Attribute, type DataSource, type Measure } from '@sisense/sdk-data';
+/** `by` field for JAQL export requests. */
+export declare const EXCEL_EXPORT_JAQL_BY = "export";
+/**
+ * Optional pivot row/column hint on {@link Attribute} for XLSX metadata `panel`
+ * (set by pivot Excel download; chart dimensions omit it and default to `rows`).
+ */
+export type ExcelExportDimensionPanel = 'rows' | 'columns';
+type ExcelExportJaqlWidgetContext = {
+    widgetOid: string;
+    widgetTitle: string;
+    dataSource: DataSource;
+    /** Repeat rows (`false`) vs merge rows (`true`) for the export JAQL. */
+    mergeRows: boolean;
+};
+type XlsxExportQueryParams = {
+    dimensions?: readonly Attribute[];
+    measures?: readonly Measure[];
+};
+/**
+ * Resolves XLSX metadata `panel` for a dimension.
+ * When `mergeRows` is `false` (repeat rows), always returns `rows` so column dimensions are flattened into rows.
+ * When `mergeRows` is `true`, uses {@link Attribute} `panel` when set (pivot column axes → `columns`), else `rows`.
+ */
+export declare function resolveExcelDimensionMetadataPanel(dimension: Attribute, mergeRows: boolean): ExcelExportDimensionPanel;
+/**
+ * Returns export metadata items describing XLSX table panels (rows/measures).
+ * `field.index` on each metadata item is sequential across dimensions then measures (0…n−1).
+ *
+ * @param mergeRows - When `false`, every dimension metadata item uses panel `rows` (see {@link resolveExcelDimensionMetadataPanel}).
+ * @returns Metadata entries for JAQL `metadata` used by the XLSX export endpoint.
+ */
+export declare function createPanelsMetadataForXlsx(dimensions: XlsxExportQueryParams['dimensions'], measures: XlsxExportQueryParams['measures'], mergeRows: boolean): {
+    jaql: {
+        column: any;
+        title: any;
+        dim: any;
+        merged: boolean;
+    };
+    field: {
+        id: string;
+        index: number;
+    };
+    format: Record<string, any>;
+    panel: "measures" | ExcelExportDimensionPanel;
+}[];
+export declare function buildJaqlForExcelExport(params: XlsxExportQueryParams, context: ExcelExportJaqlWidgetContext): Record<string, unknown>;
+export {};

package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-export/build-xlsx-export-payload.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Widget chrome sent with the XLSX JAQL export API (chart, pivot, custom widgets).
+ *
+ * - `widgetId` ← `ChartWidgetProps.id` when set (opaque string; Fusion `oid` when rendered via `Widget` / `toWidgetProps`)
+ * - `widgetType` (request body) ← Compose `chartType` (e.g. `bar`, `line`)
+ * - `language` ← resolved in {@link useExecuteExcelQueryInternal} from app settings
+ */
+export type XlsxExportWidgetContext = {
+    widgetId: string;
+    /** Compose chart `chartType` or other widget discriminator sent to export API. */
+    widgetType: string;
+    /** BCP 47 tag (e.g. `en-US`); use `app.settings.translationConfig.language` from {@link useSisenseContext}. */
+    language: string;
+};
+/**
+ * Request JSON body for `POST api/v1/export/jaql/xlsx`.
+ */
+export type XlsxExportRequestPayload = {
+    widgetId: string;
+    widgetType: string;
+    jaql: Record<string, unknown>;
+    mergeRows: boolean;
+    language: string;
+};
+/**
+ * Builds the XLSX JAQL export request body shared by chart, pivot, and custom widgets.
+ *
+ * @param widget - Widget id, type, and locale for the export body
+ * @param jaql - JAQL root for the export body (typically from `buildJaqlForExcelExport`)
+ * @param mergeRows - Repeat rows vs merge rows
+ * @returns Payload for {@link HttpClient.post}
+ */
+export declare function buildXlsxExportPayload(widget: XlsxExportWidgetContext, jaql: Record<string, unknown>, mergeRows: boolean): XlsxExportRequestPayload;

package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-query-state-reducer.d.ts

@@ -0,0 +1,2 @@
+import type { ExcelQueryAction, ExcelQueryState } from '../../types.js';
+export declare function downloadExcelQueryStateReducer(state: ExcelQueryState, action: ExcelQueryAction): ExcelQueryState;

package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/use-excel-query-params-changed.d.ts

@@ -0,0 +1,8 @@
+import type { ExecuteExcelQueryParams } from '../../types.js';
+/**
+ * Detects changes relevant to Excel export (query fields and `mergeRows`).
+ *
+ * @param params - Excel export parameters
+ * @returns Whether parameters differ from the previous render
+ */
+export declare function useExcelQueryParamsChanged(params: ExecuteExcelQueryParams): boolean;

package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/use-execute-excel-query.d.ts

@@ -0,0 +1,8 @@
+import type { ExcelQueryState, ExecuteExcelQueryParams } from '../../types.js';
+/**
+ * Runs JAQL XLSX export without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @param params - Parameters of the export query
+ * @internal
+ */
+export declare function useExecuteExcelQueryInternal(params: ExecuteExcelQueryParams): ExcelQueryState;

package/dist/packages/sdk-ui/src/domains/query-execution/index.d.ts

@@ -1,8 +1,9 @@
 export { ExecuteQuery } from './components/execute-query.js';
 export { useExecuteQuery } from './hooks/use-execute-query/index.js';
 export { useExecuteCsvQuery, useExecuteCsvQueryInternal, } from './hooks/use-execute-csv-query/use-execute-csv-query.js';
+export { useExecuteExcelQueryInternal } from './hooks/use-execute-excel-query/use-execute-excel-query.js';
 export { ExecuteQueryByWidgetId } from './components/execute-query-by-widget-id.js';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './hooks/use-execute-query-by-widget-id/use-execute-query-by-widget-id.js';
 export { useExecutePivotQuery, useExecutePivotQueryInternal, } from './hooks/use-execute-pivot-query/use-execute-pivot-query.js';
 export { useQueryCache } from './hooks/use-query-cache/use-query-cache.js';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, BaseQueryParams, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types.js';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, ExcelQueryState, ExcelQueryLoadingState, ExcelQuerySuccessState, ExcelQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, BaseQueryParams, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteExcelQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types.js';

package/dist/packages/sdk-ui/src/domains/query-execution/types.d.ts

@@ -57,6 +57,62 @@ export type CsvQuerySuccessState = {
     status: 'success';
 };
 export type CsvQueryAction = DataLoadAction<Blob | string>;
+/**
+ * State of an on-demand Excel (JAQL) export request.
+ */
+export type ExcelQueryState = ExcelQueryLoadingState | ExcelQueryErrorState | ExcelQuerySuccessState;
+/**
+ * State of an Excel export that is loading.
+ */
+export type ExcelQueryLoadingState = {
+    /** Whether the export is loading */
+    isLoading: true;
+    /** Whether the export has failed */
+    isError: false;
+    /** Whether the export has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** XLSX blob when the export has succeeded */
+    data: Blob | undefined;
+    /** Status of the export */
+    status: 'loading';
+};
+/**
+ * State of an Excel export that has failed.
+ */
+export type ExcelQueryErrorState = {
+    /** Whether the export is loading */
+    isLoading: false;
+    /** Whether the export has failed */
+    isError: true;
+    /** Whether the export has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** Result data when the export has succeeded */
+    data: undefined;
+    /** Status of the export */
+    status: 'error';
+};
+/**
+ * State of an Excel export that has succeeded.
+ */
+export type ExcelQuerySuccessState = {
+    /** Whether the export is loading */
+    isLoading: false;
+    /** Whether the export has failed */
+    isError: false;
+    /** Whether the export has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** XLSX blob */
+    data: Blob;
+    /** Status of the export */
+    status: 'success';
+};
+export type ExcelQueryAction = DataLoadAction<Blob>;
 /**
  * State of a query execution.
  */
@@ -130,7 +186,12 @@ export interface ExecuteQueryByWidgetIdParams {
      * The provided filters will be merged with the existing widget filters based on `filtersMergeStrategy`
      */
     filters?: Filter[];
-    /** Highlight filters that will highlight results that pass filter criteria */
+    /**
+     * Highlight filters that will highlight results that pass filter criteria.
+     *
+     * NOTE that highlight filters in the "Include all" state are silently omitted from the
+     * query. To clear a highlight, remove it from the array.
+     */
     highlights?: Filter[];
     /** {@inheritDoc ExecuteQueryParams.count} */
     count?: number;
@@ -188,7 +249,12 @@ export interface BaseQueryParams {
     measures?: Measure[];
     /** Filters that will slice query results */
     filters?: Filter[] | FilterRelations;
-    /** Highlight filters that will highlight results that pass filter criteria */
+    /**
+     * Highlight filters that will highlight results that pass filter criteria.
+     *
+     * NOTE that highlight filters in the "Include all" state are silently omitted from the
+     * query. To clear a highlight, remove it from the array.
+     */
     highlights?: Filter[];
 }
 /**
@@ -266,6 +332,35 @@ export type ExecuteCSVQueryConfig = {
 export interface ExecuteCsvQueryParams extends ExecuteQueryParams {
     config?: ExecuteCSVQueryConfig;
 }
+/**
+ * Parameters for {@link useExecuteExcelQueryInternal} (JAQL XLSX export).
+ */
+export interface ExecuteExcelQueryParams extends ExecuteQueryParams {
+    /** `false` = repeat rows (Angular default); `true` = merge rows. */
+    mergeRows: boolean;
+    /** Suggested download file name (e.g. from widget title). */
+    filename?: string;
+    /**
+     * Widget id for export (`ChartWidget` / `Widget` `id`). Required when `enabled` runs an export;
+     * optional on the type so idle/default param objects can omit it.
+     */
+    widgetId?: string;
+    /**
+     * Widget presentation type for export (e.g. Compose `ChartType` from `ChartWidget` `chartType`).
+     */
+    widgetType?: string;
+    /**
+     * Widget title for Fusion JAQL `widget` segment (`oid;title`). Optional; defaults to empty string.
+     */
+    widgetTitle?: string;
+    /**
+     * Monotonic id assigned by {@link useExcelQueryFileLoader} on each `execute` so each click starts
+     * a distinct export even when query fields and `mergeRows` match the previous run.
+     *
+     * @internal
+     */
+    exportRunId?: number;
+}
 /**
  * State of a pivot query execution.
  */

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/scattermap/utils/map.d.ts

@@ -1,6 +1,6 @@
 import leaflet, { type FitBoundsOptions } from 'leaflet';
-import { CompleteThemeSettings } from '../../../../../../../types.js';
+import { CompleteThemeSettingsInternal } from '../../../../../../../types.js';
 type FitBoundsAnimationOptions = Pick<FitBoundsOptions, 'animate' | 'duration'>;
-export declare function prepareFitBoundsAnimationOptions(themeSettings: CompleteThemeSettings): FitBoundsAnimationOptions;
+export declare function prepareFitBoundsAnimationOptions(themeSettings: CompleteThemeSettingsInternal): FitBoundsAnimationOptions;
 export declare function fitMapToBounds(map: leaflet.Map, markers: leaflet.CircleMarker[], options?: FitBoundsOptions): void;
 export {};

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data.d.ts

@@ -20,7 +20,6 @@ export type CalendarHeatmapChartData = {
  * @param chartDataOptions - Internal data options specifying which columns to use
  * @param dataTable - Raw data table containing the source data
  * @returns Formatted calendar heatmap chart data
-
  */
 export declare function getCalendarHeatmapChartData(chartDataOptions: CalendarHeatmapChartDataOptionsInternal, dataTable: DataTable): CalendarHeatmapChartData;
 /**

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/with-calendar-heatmap-data-coloring.d.ts

@@ -1,4 +1,4 @@
-import { CompleteThemeSettings, DataColorOptions, RangeDataColorOptions } from '../../../../../../../../types';
+import { CompleteThemeSettingsInternal, DataColorOptions, RangeDataColorOptions } from '../../../../../../../../types';
 import { CalendarHeatmapChartData } from '../data.js';
 /**
  * Returns the default color options for calendar heatmap chart
@@ -6,7 +6,7 @@ import { CalendarHeatmapChartData } from '../data.js';
  * @param themeSettings - Theme settings
  * @returns Default color options
  */
-export declare function getCalendarHeatmapDefaultColorOptions(themeSettings: CompleteThemeSettings): RangeDataColorOptions;
+export declare function getCalendarHeatmapDefaultColorOptions(themeSettings: CompleteThemeSettingsInternal): RangeDataColorOptions;
 /**
  * Creates a decorator function that applies data-driven coloring to calendar heatmap data values.
  * Uses a decorator pattern where the function accepts color options and returns a data transformer.

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/build-highchart-options.d.ts

@@ -17,7 +17,7 @@ export declare const buildHighchartsOptions: <CT extends HighchartBasedChartType
     };
     extraConfig: {
         translate: import("i18next").TFunction<"translation", undefined>;
-        themeSettings: import("../../../../../../../types.js").CompleteThemeSettings;
+        themeSettings: import("../../../../../../../types.js").CompleteThemeSettingsInternal;
         dateFormatter: (date: Date, format: string) => string;
         accessibilityEnabled: boolean;
     };