@sisense/sdk-ui 2.26.0 → 2.28.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
@@ -41,6 +41,7 @@ export interface GetDashboardModelOptions {
  * @param appSettings - Optional application settings
  * @returns The dashboard model
  *
- * @internal @sisenseInternal
+ * @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,4 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { AppSettings } from '../../../infra/app/settings/settings';
+import { CompleteThemeSettingsInternal } from '../../../types';
 export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
@@ -12,4 +14,4 @@ export interface GetDashboardModelsOptions {
     includeWidgets?: boolean;
 }
 /** @internal */
-export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): 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,14 +1,15 @@
 import { Dimension, Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode, Measure } from '@sisense/sdk-data';
-import { JtdTarget, TriggerMethod } from '../../../domains/dashboarding/hooks/jtd/jtd-types';
+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';
 import { RestApi } from '../../../infra/api/rest-api';
 import { type CascadingFilterDto, DashboardDto, type FilterDto, type LayoutDto } from '../../../infra/api/types/dashboard-dto';
 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 const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
-export declare const convertDimensionsToDimIndexes: (widget: WidgetDto, dimensionIds: string[]) => string[];
+export declare const getJtdNavigateType: (widget: WidgetJtdDtoSlice) => TriggerMethod;
+export declare const convertDimensionsToDimIndexes: (widget: WidgetJtdDtoSlice, dimensionIds: string[]) => string[];
 /**
  * Extract pivot targets configuration from widget DTO and build Map-based targets
  *
@@ -16,10 +17,20 @@ export declare const convertDimensionsToDimIndexes: (widget: WidgetDto, dimensio
  * @returns Map of dimensions/measures to their targets or undefined if no targets found
  * @internal
  */
-export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetDto): Map<Dimension | {
+export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetJtdDtoSlice): Map<Dimension | {
     dimension: Dimension;
     location: 'row' | 'column' | 'value';
 } | Measure, JtdTarget[]> | undefined;
+/**
+ * Converts a Fusion {@link WidgetDto}'s `drillToDashboardConfig` into Compose SDK JumpToDashboardConfig | JumpToDashboardConfigForPivot
+ * {@link JumpToDashboardConfig} {@link JumpToDashboardConfigForPivot} for use with {@link useJtdWidget}
+ *
+ * @param widget - Fusion widget DTO (or the subset of fields used for JTD translation)
+ * @returns JTD config, or `undefined` when there is no versioned JTD DTO or the widget type does not support JTD
+ *
+ * @group Dashboards
+ */
+export declare function jumpToDashboardConfigFromWidgetDto(widget: WidgetJtdDtoSlice): JumpToDashboardConfig | JumpToDashboardConfigForPivot | undefined;
 export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
 /**
  * Applies {@link SpecificWidgetOptions} to a {@link WidgetDto}.
@@ -50,3 +61,4 @@ export declare function findDimensionByInstanceId(panels: Panel[], pivotDimensio
     dimension: Dimension;
     location: 'row' | 'column' | 'value';
 } | undefined;
+export {};

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

@@ -1,5 +1,6 @@
 import { CommonFiltersOptions } from '../../../domains/dashboarding/common-filters/types';
 import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../../domains/dashboarding/hooks/jtd/jtd-types';
+import type { UnsupportedStyleOptions } from '../../../domains/widgets/components/widget-by-id/translate-widget-style-options/extract-unsupported-style-options.js';
 import type { WidgetDto } from '../../../domains/widgets/components/widget-by-id/types';
 import { ColorPaletteTheme } from '../../../types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../../domains/dashboarding/common-filters/types';
@@ -95,9 +96,16 @@ export type SpecificWidgetOptions = {
      * Required to include all existing options/style when PATCHing a single field (e.g. previousScrollerLocation),
      * because the server replaces the entire object rather than merging.
      *
+     * `style` carries only the unsupported style fields not yet first-class translated by the
+     * CSDK widget model (extracted via `extractUnsupportedStyleOptions`); they are re-attached
+     * to the DTO during serialization with lower priority than rebuilt translation output.
+     *
      * @internal
      */
-    partialDtoOptions?: Partial<Pick<WidgetDto, 'options' | 'style'>>;
+    partialDtoOptions?: {
+        options?: WidgetDto['options'];
+        style?: UnsupportedStyleOptions;
+    };
 };
 /**
  * Style options for the dashboard.

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

@@ -1,6 +1,7 @@
+import { DataSource } from '@sisense/sdk-data';
 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 */
@@ -14,7 +15,13 @@ 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;
 };
 /**
  * Middleware that persists the dashboard model changes to the Sisense server.
@@ -22,4 +29,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, }: PersistDashboardModelMiddlewareParams): Promise<UseDashboardModelInternalAction>;
+export declare function persistDashboardModelMiddleware({ dashboardOid, action, restApi, sharedMode, appSettings, themeSettings, dashboardDataSource, }: PersistDashboardModelMiddlewareParams): Promise<UseDashboardModelInternalAction>;

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/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/drilldown/hooks/use-drilldown.d.ts

@@ -23,5 +23,5 @@ export declare const useDrilldown: ({ initialDimension, initialDrilldownSelectio
 /** @internal */
 export declare function getSelectionTitleMenuItem(points: DataPoint[], drilldownDimension: Attribute): MenuItemSection;
 /** @internal */
-export declare function getDrilldownMenuItems(availableDrilldownPaths: (Attribute | Hierarchy)[], drilldownDimension: Attribute, selectFn: (nextDimension: Attribute, hierarchy?: Hierarchy) => void, translate: TFunction): MenuItemSection;
+export declare function getDrilldownMenuItems(availableDrilldownPaths: (Attribute | Hierarchy)[], drilldownDimension: Attribute, selectFn: (nextDimension: Attribute, hierarchy?: Hierarchy) => void, translate: TFunction): MenuItemSection | null;
 export {};

package/dist/packages/sdk-ui/src/domains/drilldown/hooks/use-hierarchies-loader.d.ts

@@ -0,0 +1,17 @@
+import { Attribute, DataSource } from '@sisense/sdk-data';
+import { Hierarchy, HierarchyId } from '../hierarchy-model';
+export interface GetHierarchiesParams {
+    /** The attribute/dimension for which to load hierarchies */
+    attribute: Attribute;
+    /** The data source from which to retrieve hierarchies */
+    dataSource?: DataSource;
+    /** The hierarchy IDs to load */
+    ids: HierarchyId[];
+}
+/**
+ * Provides a `getHierarchies` function that loads hierarchy models from a Fusion instance by ID,
+ * including any hierarchies marked as `alwaysIncluded`.
+ */
+export declare function useHierarchiesLoader(): {
+    getHierarchies: (params: GetHierarchiesParams) => Promise<Hierarchy[]>;
+};

package/dist/packages/sdk-ui/src/domains/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts

@@ -5,7 +5,7 @@ import type { FilterTileConfig } from '../filter-tile/types.js';
 /**
  * Props for {@link CascadingFilterTile}
  *
- * @internal
+ * @alpha
  */
 export interface CascadingFilterTileProps {
     /** Cascading filter object to initialize filter type and default values */
@@ -43,6 +43,6 @@ export interface CascadingFilterTileProps {
  * @param props - Cascading filter tile props
  * @returns Cascading filter tile component
  * @group Filter Tiles
- * @internal
+ * @alpha
  */
 export declare const CascadingFilterTile: import("react").FunctionComponent<CascadingFilterTileProps>;

package/dist/packages/sdk-ui/src/domains/filters/components/custom-filter-tile.d.ts

@@ -5,7 +5,7 @@ import { FilterTileDesignOptions } from './filter-tile-container';
 /**
  * Props for {@link CustomFilterTile}
  *
- * @internal
+ * @alpha
  */
 export interface CustomFilterTileProps {
     /** Custom filter. */
@@ -38,7 +38,6 @@ export interface CustomFilterTileProps {
 /**
  * UI component for a custom filter defined with JAQL.
  *
- * @internal
  * @example
  * ```tsx
  * const filterJaql = { from: 10, to: 20000 };
@@ -59,5 +58,6 @@ export interface CustomFilterTileProps {
  * @param props - Custom filter tile props
  * @returns Custom filter tile component
  * @group Filter Tiles
+ * @alpha
  */
 export declare const CustomFilterTile: import("react").FunctionComponent<CustomFilterTileProps>;

package/dist/packages/sdk-ui/src/domains/narrative/core/widget-narrative-options.d.ts

@@ -10,10 +10,17 @@ export interface WidgetNarrativeOptions {
     defaultDataSource?: DataSource;
     /** The verbosity of the NLG summarization */
     verbosity?: 'Low' | 'High';
-    /** When false, legacy narration endpoint only; when true or undefined, try unified then fallback. */
-    isUnified?: boolean;
-    /** Computed SDK flag from server settings (`app.settings.narrative.isSisenseAiEnabled`), not raw AI API. */
-    isSisenseAiEnabled?: boolean;
+    /**
+     * When `true`, attempts the unified AI narrative endpoint and falls back to the legacy endpoint
+     * on 404. When `false` or omitted, only the legacy endpoint is used.
+     *
+     * **Hook-based flows** (e.g. {@link useGetWidgetNarrative}): when omitted, the value is read
+     * from `app.settings.narrative.canGenerateNarrativeViaAI` via {@link useSisenseContext}.
+     *
+     * **Imperative helpers** (e.g. {@link getNlgInsightsFromWidget}): no context fallback is
+     * performed — omitting this option is equivalent to `false` (legacy endpoint only).
+     */
+    canGenerateNarrativeViaAI?: boolean;
     /**
      * When `true`, trend and forecast companion measures are omitted from the narrative JAQL so
      * requests stay compatible with backends that do not yet support them.

package/dist/packages/sdk-ui/src/domains/narrative/core/widget-props-to-narrative-params.d.ts

@@ -1,7 +1,7 @@
 import { DataSource } from '@sisense/sdk-data';
 import { ChartWidgetProps } from '../../../domains/widgets/components/chart-widget/types';
 import type { PivotTableWidgetProps } from '../../../domains/widgets/components/pivot-table-widget/types';
-import type { WithCommonWidgetProps } from '../../../domains/widgets/components/widget/types';
+import type { WidgetProps, WithCommonWidgetProps } from '../../../domains/widgets/components/widget/types';
 import type { NarrativeRequest } from '../../../infra/api/narrative/narrative-api-types.js';
 import type { NarrativeQueryParams } from './build-narrative-request.js';
 /**
@@ -34,3 +34,53 @@ export declare function convertPivotWidgetPropsToNarrativeRequest(props: WithCom
  * @deprecated Use {@link convertChartWidgetPropsToNarrativeParams}. Same function; kept for legacy `getNlgInsightsFromWidget`.
  */
 export declare const convertChartWidgetPropsToUseGetNlgInsightsParams: typeof convertChartWidgetPropsToNarrativeParams;
+/**
+ * Error message for imperative callers (e.g. {@link getNlgInsightsFromWidget}) when chart or pivot
+ * props omit `dataSource` and no `defaultDataSource` is passed.
+ *
+ * @internal
+ */
+export declare const MISSING_DATASOURCE_NLG_ERROR = "dataSource is required. Provide it on the widget props or as defaultDataSource parameter.";
+export type WidgetNarrativeRequestPair = {
+    supported: boolean;
+    narrativeRequest: NarrativeRequest | undefined;
+    /**
+     * Same request with trend/forecast stripped. `undefined` when `ignoreTrendAndForecast` is
+     * already `true` (primary already stripped), when the widget type is unsupported, or when
+     * the fallback conversion itself fails.
+     */
+    narrativeFallbackRequest: NarrativeRequest | undefined;
+    /**
+     * When `supported` is `false`, `true` means chart/pivot had no resolved data source (props and
+     * `defaultDataSource` were both unset); conversion was skipped.
+     */
+    missingDataSource?: boolean;
+};
+/**
+ * Builds a primary narrative request and, when useful, a fallback request with trend/forecast
+ * stripped — both from the same widget props in a single call.
+ *
+ * @param props - Chart or pivot widget props
+ * @param defaultDataSource - Used when `props.dataSource` is undefined
+ * @param verbosity - Optional verbosity for narrative text
+ * @param ignoreTrendAndForecast - When `true`, the primary request already omits trend/forecast
+ *   and no fallback is needed
+ * @returns `{ supported, narrativeRequest, narrativeFallbackRequest }`. `supported` is `false`
+ *   when the widget type is unsupported, when no data source can be resolved for chart/pivot, or
+ *   when the primary conversion fails.
+ * @example Chart or pivot widget props
+ * ```ts
+ * const { supported, narrativeRequest, narrativeFallbackRequest } =
+ *   buildWidgetNarrativeRequests(
+ *     widgetProps, // `WithCommonWidgetProps<ChartWidgetProps, 'chart'>` or pivot equivalent
+ *     defaultDataSource,
+ *     'High',
+ *     false,
+ *   );
+ * ```
+ * On success, `supported` is `true` and `narrativeRequest` / `narrativeFallbackRequest` hold the
+ * primary and trend-stripped NLG payloads; otherwise `supported` is `false` and requests are
+ * `undefined` (and `missingDataSource` may be set when no source could be resolved).
+ * @internal
+ */
+export declare function buildWidgetNarrativeRequests(props: WidgetProps, defaultDataSource?: DataSource, verbosity?: 'Low' | 'High', ignoreTrendAndForecast?: boolean): WidgetNarrativeRequestPair;

package/dist/packages/sdk-ui/src/domains/narrative/hooks/use-get-widget-narrative.d.ts

@@ -5,9 +5,9 @@ import { type WidgetNarrativeQueryState } from './use-widget-narrative-state.js'
  * Options for {@link useGetWidgetNarrative}.
  *
  * @remarks
- * Narration endpoints and flags default from `app.settings.narrative` on {@link useSisenseContext} when
- * `isUnified` / `isSisenseAiEnabled` are omitted. Optional overrides match the
- * imperative `getNlgInsightsFromWidget` helper for per-call behavior.
+ * Narration endpoint selection defaults from `app.settings.narrative.canGenerateNarrativeViaAI`
+ * on {@link useSisenseContext} when `canGenerateNarrativeViaAI` is omitted. Optional overrides
+ * match the imperative `getNlgInsightsFromWidget` helper for per-call behavior.
  * @sisenseInternal
  */
 export type UseGetWidgetNarrativeOptions = WidgetNarrativeOptions & {

package/dist/packages/sdk-ui/src/domains/narrative/hooks/use-widget-narrative-state.d.ts

@@ -23,7 +23,7 @@ export type UseWidgetNarrativeStateResult = WidgetNarrativeQueryState & {
     /**
      * Mirrors the `enabled` param. When `false`, the narrative is opted out: `data` is cleared (no
      * cached fallback), `narrativeRequest` is undefined, and loading/error flags reflect a disabled
-     * query rather than “no insights.”
+     * query rather than "no insights."
      */
     enabled: boolean;
     /** Present when `supported` and `enabled`; used by {@link WidgetNarrative} for feedback payload only. */
@@ -36,4 +36,4 @@ export type UseWidgetNarrativeStateResult = WidgetNarrativeQueryState & {
  *
  * @internal
  */
-export declare function useWidgetNarrativeState({ widgetProps, defaultDataSource, verbosity, enabled, ignoreTrendAndForecast, isUnified: optionsUnified, isSisenseAiEnabled: optionsSisenseAi, }: UseWidgetNarrativeStateParams): UseWidgetNarrativeStateResult;
+export declare function useWidgetNarrativeState({ widgetProps, defaultDataSource, verbosity, enabled, ignoreTrendAndForecast, canGenerateNarrativeViaAI: optionsCanGenerateNarrativeViaAI, }: UseWidgetNarrativeStateParams): UseWidgetNarrativeStateResult;

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