@sisense/sdk-ui 2.5.0 → 2.6.0

package/dist/packages/sdk-ui/src/app/client-application.d.ts

@@ -181,7 +181,7 @@ export interface ClientApplication {
         clear: () => void;
     };
 }
-type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth'>;
+type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth' | 'alternativeSsoHost'>;
 /** @internal */
-export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, }: ClientApplicationParams) => Promise<ClientApplication>;
+export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, alternativeSsoHost, }: ClientApplicationParams) => Promise<ClientApplication>;
 export {};

package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts

@@ -12,6 +12,10 @@ export type HighchartsBasedChartRendererProps<CT extends HighchartBasedChartType
     onDataPointContextMenu?: SisenseChartDataPointEventHandler;
     onDataPointsSelected?: SisenseChartDataPointsEventHandler;
     onBeforeRender?: BeforeRenderHandler;
+    size?: {
+        width?: number;
+        height?: number;
+    };
 };
 /**
  * Creates a specific highcharts based chart renderer component

package/dist/packages/sdk-ui/src/dashboard/components/jtd-dashboard.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { type Filter } from '@sisense/sdk-data';
 interface JtdDashboardProps {
     dashboardOid: string;
@@ -11,5 +12,5 @@ interface JtdDashboardProps {
  * This component reuses DashboardById logic but is specifically designed for JTD use cases
  * @internal
  */
-export declare const JtdDashboard: ({ dashboardOid, filters: runtimeFilters, mergeTargetDashboardFilters, displayToolbarRow, displayFilterPane, }: JtdDashboardProps) => import("react/jsx-runtime").JSX.Element;
+export declare const JtdDashboard: import("react").FunctionComponent<JtdDashboardProps>;
 export {};

package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-filters.d.ts

@@ -1,6 +1,6 @@
 import { type Filter } from '@sisense/sdk-data';
 import { WidgetProps } from '../../../props.js';
-import { DataPoint } from '../../../types';
+import { DataPoint, ScatterDataPoint } from '../../../types';
 import { JtdConfig } from '../../../widget-by-id/types';
 /**
  * Jump to Dashboard (JTD) Filter Merging Logic:
@@ -69,18 +69,51 @@ export declare const getFormulaContextFilters: (clickedWidget: WidgetProps, jtdC
  */
 export declare const handleFormulaDuplicateFilters: (filters: Filter[], sendFormulaFiltersDuplicate?: number | 'none') => Filter[];
 /**
- * Generate filters from data point based on its category entries
+ * Type guard to check if a data point is a ScatterDataPoint.
+ * Checks for actual scatter chart structure (x/y coordinates) and scatter-only properties.
  *
- * @param point - The data point
+ * @param point - The data point to check
+ * @returns True if the point is a ScatterDataPoint, false otherwise
+ * @internal
+ */
+export declare const isScatterDataPoint: (point: DataPoint | ScatterDataPoint) => point is ScatterDataPoint;
+/**
+ * Extracts filters from scatter chart data point (breakByColor and breakByPoint).
+ *
+ * @param point - The scatter data point
+ * @returns Array of filters generated from scatter chart breakBy properties
+ * @internal
+ */
+export declare const getFiltersFromScatterDataPoint: (point: ScatterDataPoint) => Filter[];
+/**
+ * Extracts filters from regular chart data point (category and breakBy array).
+ * Also processes any scatter properties (breakByColor/breakByPoint) if present.
+ *
+ * @param point - The regular data point (may have mixed properties)
+ * @returns Array of filters generated from all available entries
+ * @internal
+ */
+export declare const getFiltersFromRegularDataPoint: (point: DataPoint) => Filter[];
+/**
+ * Extracts filters from a data point for Jump To Dashboard functionality.
+ *
+ * This function handles both regular DataPoint and ScatterDataPoint types:
+ * - If data point has scatter properties (breakByColor/breakByPoint), process as scatter chart
+ * - Otherwise, process as regular chart (category/breakBy entries)
+ * - Scatter properties take priority over regular properties when both exist
+ *
+ * @param point - The data point from chart interaction
  * @returns Array of filters generated from the data point
+ * @internal
  */
-export declare const getFiltersFromDataPoint: (point: DataPoint) => Filter[];
+export declare const getFiltersFromDataPoint: (point: DataPoint | ScatterDataPoint) => Filter[];
 /**
  * Filter filters based on allowed dimension names, supporting cascading filters
  *
  * @param filters - The filters to filter
  * @param allowedDims - The allowed dimensions
  * @returns The filtered filters
+ * @internal
  */
 export declare const filterByAllowedDimensions: (filters: Filter[], allowedDims?: string[]) => Filter[];
 /**
@@ -91,5 +124,6 @@ export declare const filterByAllowedDimensions: (filters: Filter[], allowedDims?
  * @param widgetFilters - Widget-specific filters
  * @param formulaContextFilters - Formula context filters
  * @returns Merged filters array
+ * @internal
  */
 export declare const mergeJtdFilters: (generatedFilters: Filter[], dashboardFilters: Filter[], widgetFilters: Filter[], formulaContextFilters: Filter[]) => Filter[];

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

@@ -64,23 +64,13 @@ export interface DashboardFiltersPanelConfig extends FiltersPanelConfig {
  */
 export interface WidgetsPanelConfig {
     /**
-     * If true adjust layout based on available width of widgets panel.
+     * If `true`, adjust layout based on available width of widgets panel.
      *
      * If not specified, the default value is `false`.
      */
     responsive?: boolean;
     /**
      * Edit mode configuration.
-     * If enabled, an 'Edit Layout' action is visible to users on the dashboard toolbar.
-     * Clicking 'Edit Layout' opens the dashboard in editing mode, where the user can resize or reposition widgets using drag and drop.
-     * If history enabled, layout changes are temporarily stored during editing, with undo/redo buttons available on the toolbar.
-     * Finally, changes are confirmed or discarded with 'Apply' or 'Cancel' buttons.
-     *
-     * If persistence is enabled for the dashboard, changes to the layout will be saved to Fusion on clicking the 'Apply' button.
-     *
-     * This feature is in alpha.
-     *
-     * @alpha
      */
     editMode?: EditModeConfig;
 }
@@ -88,36 +78,53 @@ export interface WidgetsPanelConfig {
  * Edit mode configuration
  */
 export interface EditModeConfig {
-    /** Flag indicating whether the edit layout feature is enabled
+    /**
+     * If `true` the editable layout feature is enabled for the end user.
+     *
+     * If `false` the end user is unable to edit the layout of widgets in the dashboard.
+     *
+     * When persistence is enabled combined with `editMode` for a Fusion dashboard, changes to the layout will saved to Fusion.
      *
      * @default false
      */
     enabled: boolean;
     /**
-     * Flag indicating whether the dashboard is currently in edit mode.
-     * If specified, will override inner mode state.
+     * Indicates whether the dashboard is currently in edit mode.
+     *
+     * If set, this controls whether editing is currently in progress,
+     * which by default is automatically managed from UI interactions with the dashboard toolbar menu/buttons.
+     *
      * */
     isEditing?: boolean;
-    /** Configuration for the edit mode history */
+    /**
+     * Configuration for the edit mode user experience
+     */
     applyChangesAsBatch?: {
         /**
-         * If true, changes are applied when the user clicks 'Apply'
+         * If `true`, a history of changes will be accumulated during editing,
+         * and users may undo/redo through the history of changes made during the current edit.
+         *
+         * The current layout state will be applied to the dashboard when the user clicks 'Apply',
          * or discarded when the user clicks 'Cancel'.
          *
-         * If false, changes will be applied immediately as the user makes each change
+         * If `false`, the layout changes will be applied immediately after the user makes each change,
          * without confirmation or the ability to cancel/undo.
          *
          * @default: true
          * */
         enabled: boolean;
         /**
-         * The maximum number of history items to keep.
+         * The maximum number of history items to keep while applying changes in batch mode.
+         *
+         * History will be temporarily stored in the browser during editing.
          *
          * @default 20
          */
         historyLimit?: number;
     };
-    /** Flag indicating whether the drag handle icon is visible
+    /**
+     * Determines whether the drag handle icon should be displayed on the
+     * header of each widget when layout editing is possible.
      *
      * @default true
      */

package/dist/packages/sdk-ui/src/dynamic-size-container/dynamic-size-container.d.ts

@@ -13,6 +13,7 @@ export type DynamicSizeContainerProps = {
         height?: boolean;
     };
     onSizeChange?: (size: ContainerSize) => void;
+    debounceMs?: number;
 };
 /**
  * A container component that adjusts its content size according to provided sizes
@@ -37,4 +38,4 @@ export type DynamicSizeContainerProps = {
  * @param {DynamicSizeContainerProps} props - DynamicSizeContainer properties.
  * @returns {JSX.Element} The DynamicSizeContainer component.
  */
-export declare const DynamicSizeContainer: ({ children, defaultSize, size, rerenderOnResize, useContentSize, onSizeChange, }: DynamicSizeContainerProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DynamicSizeContainer: ({ children, defaultSize, size, rerenderOnResize, useContentSize, onSizeChange, debounceMs, }: DynamicSizeContainerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts

@@ -13,5 +13,6 @@ export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersO
  * @param dashboard - The dashboard DTO to replace shared formulas in
  * @param api - The REST API instance
  * @returns The dashboard DTO with shared formulas, defined by id references, replaced
+ * @internal
  */
 export declare function withSharedFormulas(dashboard: DashboardDto, api: RestApi): Promise<DashboardDto>;

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

@@ -114,6 +114,16 @@ export interface SisenseContextProviderProps {
      *
      */
     enableSilentPreAuth?: boolean;
+    /**
+     * Alternative host to use for SSO authentication.
+     * Used **only** when the SSO Login URL is configured as a *relative* url.
+     * If not specified, the default value is `''`.
+     *
+     * @category Sisense Authentication
+     *
+     * @internal
+     */
+    alternativeSsoHost?: string;
 }
 /**
  * Props for {@link ExecuteQuery} component.

package/dist/packages/sdk-ui/src/sisense-chart/sisense-chart.d.ts

@@ -4,6 +4,6 @@ import { SisenseChartProps, SisenseChartType } from './types';
 /**
  * @internal
  */
-export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, size, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
 export declare const isSisenseChartType: (chartType: ChartType) => chartType is SisenseChartType;
 export declare const isSisenseChartProps: (props: ChartRendererProps) => props is SisenseChartProps;

package/dist/packages/sdk-ui/src/sisense-chart/types.d.ts

@@ -15,5 +15,9 @@ export interface SisenseChartProps {
     onDataPointContextMenu?: SisenseChartDataPointEventHandler;
     onDataPointsSelected?: SisenseChartDataPointsEventHandler;
     onBeforeRender?: BeforeRenderHandler;
+    size?: {
+        width?: number;
+        height?: number;
+    };
 }
 export type SisenseChartType = CartesianChartType | CategoricalChartType | ScatterChartType | BoxplotChartType;

package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts

@@ -16,6 +16,29 @@ export declare function getFusionWidgetType(widgetType: WidgetType, chartType?:
 export declare function getWidgetType(fusionWidgetType: FusionWidgetType): WidgetType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 export declare function isSupportedWidgetType(fusionWidgetType: FusionWidgetType): fusionWidgetType is FusionWidgetType;
+/**
+ * Widget types that support Jump To Dashboard (JTD) functionality
+ *
+ * Supported types:
+ * - Pie chart with no categories, Pie chart
+ * - Indicator
+ * - Text widget
+ * - Column chart, Bar chart, Line chart, Area chart
+ * - Pivot
+ * - Scatter chart, Polar chart
+ * - Blox
+ *
+ * @internal
+ */
+export declare const JTD_SUPPORTED_WIDGET_TYPES: FusionWidgetType[];
+/**
+ * Check if the widget type supports Jump To Dashboard (JTD)
+ *
+ * @param fusionWidgetType - The fusion widget type
+ * @returns True if the widget type supports JTD, false otherwise
+ * @internal
+ */
+export declare function widgetTypeSupportsJtd(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isTableWidgetModel(widgetModel: WidgetModel): boolean;
 export declare function isPivotTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
@@ -26,6 +49,9 @@ export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetSt
 export declare function isCustomWidgetFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isCustomWidget(widgetType: WidgetType): boolean;
 export declare function isChartFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isChartTypeFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isPieChartFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isIndicatorFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isChartWidget(widgetType: WidgetType): boolean;
 /**
  * Type guard for checking if the widget props is for a text widget.