@sisense/sdk-ui 2.4.1 → 2.6.0

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

@@ -1,100 +1,8 @@
 import { type Filter } from '@sisense/sdk-data';
 import { WidgetProps } from '../../props.js';
 import { OpenMenuFn } from '../../common/components/menu/types.js';
-import { DataPoint } from '../../types';
 import { WidgetsOptions } from '../../index-typedoc';
-import { JTDConfig, JTDDrillTarget } from '../../widget-by-id/types';
-import React from 'react';
-import { SizeMeasurement } from '../../types';
 /**
- * Jump to Dashboard (JTD) Filter Merging Logic:
- *
- * When a user clicks on a datapoint to open a JTD modal, multiple types of filters are merged:
- *
- * 1. **Generated Filters**: Created from the clicked datapoint's category and breakBy entries
- * 2. **Dashboard Filters**: Current dashboard filters (filtered by includeDashFilterDims)
- * 3. **Widget Filters**: Original widget-specific filters (filtered by includeWidgetFilterDims)
- * 4. **Formula Context Filters**: NEW - Embedded filters from the clicked widget's datapoint calculations
- *
- * ## Formula Context Filters (New Feature)
- *
- * Formula context filters are embedded within datapoint calculations and represent intrinsic
- * filters that are part of the measure/column computation itself. They are extracted only from
- * the specific widget that was clicked, not from all widgets. For example:
- *
- * ```
- * clickedWidget.dataOptions.value[0].column.context = {
- *   "13FC1-655": {
- *     "type": "filter",
- *     "filterType": "numeric",
- *     "attribute": { ... },
- *     "valueA": 10,
- *     "valueB": 27249.89453125
- *   }
- * }
- * ```
- *
- * These filters:
- * - Represent calculation constraints that are intrinsic to the clicked widget's datapoint
- * - Are extracted from all dataOption fields of the clicked widget (value, category, breakBy, x, y, etc.)
- * - Support both object format and string reference format
- *
- * ## Duplicate Filter Handling
- *
- * Complex formulas like `AVG(cost) - AVG(PREVMONTH(cost))` can contain multiple filters on the same dimension.
- * The `sendFormulaFiltersDuplicate` parameter controls how duplicates are handled:
- *
- * - **"none"**: Exclude all duplicate filters (only include filters that appear once)
- * - **Number (1+)**: Include only the filter at that position (1-indexed). Invalid numbers treated as "none"
- * - **Other values**: Include only the first duplicate filter
- *
- * Examples:
- * - Formula has 2 filters on Commerce.Cost dimension
- * - `sendFormulaFiltersDuplicate = "none"` → No Cost filters included
- * - `sendFormulaFiltersDuplicate = 1` → Include first Cost filter
- * - `sendFormulaFiltersDuplicate = 2` → Include second Cost filter
- * - `sendFormulaFiltersDuplicate = 3` → Invalid (out of range), treat as "none"
- */
-export declare const getFormulaContextFilters: (point: DataPoint, clickedWidget: WidgetProps, jtdConfig: JTDConfig) => Filter[];
-/**
- * @internal
- * Handle duplicate formula filters based on sendFormulaFiltersDuplicate parameter
- * @param filters - The filters to handle
- * @param sendFormulaFiltersDuplicate - The send formula filters duplicate parameter
- * @returns The filtered filters
- */
-export declare const handleFormulaDuplicateFilters: (filters: Filter[], sendFormulaFiltersDuplicate?: number | 'none') => Filter[];
-export declare const getFiltersFromDataPoint: (point: DataPoint) => 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
- */
-export declare const filterByAllowedDimensions: (filters: Filter[], allowedDims?: string[]) => Filter[];
-/**
- * @internal
- * Get the JTD click handler for a specific data point of the specific widget
- * @param jtdConfig - The JTD config
- * @param drillTarget - The drill target
- * @param widgetProps - The widget props
- * @param point - The data point
- * @param dashboardFilters - The dashboard filters
- * @param originalWidgetFilters - The original widget filters
- * @param openModal - The open modal function
- * @returns The JTD click handler
- */
-export declare const getJtdClickHandler: (jtdConfig: JTDConfig, drillTarget: JTDDrillTarget, widgetProps: WidgetProps, point: DataPoint, dashboardFilters: Filter[], originalWidgetFilters: Filter[], openModal: (options: {
-    title: string;
-    width?: number;
-    height?: number;
-    measurement?: SizeMeasurement;
-    allowResize?: boolean;
-    content: React.ReactNode;
-}) => Promise<string>) => () => Promise<void>;
-/**
- * @internal
  * Jump to Dashboard (JTD) hook.
  * Implements the JTD functionality for each widget with JTD config.
  * @param widgetOptions - The widget options of the dashboard
@@ -111,3 +19,4 @@ export declare const useJtd: ({ widgetOptions, dashboardFilters, widgetFilters,
 }) => {
     connectToWidgetProps: (widgetProps: WidgetProps) => WidgetProps;
 };
+export * from './jtd';

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/filters/components/filter-editor-popover/sections/utils.d.ts

@@ -5,3 +5,11 @@ export declare function createExcludeMembersFilter(attribute: Attribute, members
 export declare function getMembersWithoutDeactivated(filter: Filter, selectedMembers: string[]): string[];
 export declare function getMembersWithDeactivated(filter: Filter): string[];
 export declare function getConfigWithUpdatedDeactivated(filter: Filter, selectedMembers: string[]): import("@sisense/sdk-data").FilterConfig;
+/**
+ * Returns the granularities that are restricted by the parent filters (previous cascading levels)
+ *
+ * @param datetimeAttribute - The datetime attribute
+ * @param parentFilters - The parent filters
+ * @returns The restricted granularities
+ */
+export declare function getRestrictedGranularities(datetimeAttribute: Attribute, parentFilters?: Filter[]): string[];

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/models/dashboard/types.d.ts

@@ -1,6 +1,6 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
 import { ColorPaletteTheme, TabberConfig } from '../../types';
-import { JTDConfig } from '../../widget-by-id/types';
+import { JtdConfig } from '../../widget-by-id/types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
 /**
  * Part of Dashboard layout, which describes how widgets are arranged in a cell
@@ -14,6 +14,22 @@ export interface WidgetsPanelCell {
      * @internal
      */
     height?: number | string;
+    /**
+     * @internal
+     */
+    minHeight?: number;
+    /**
+     * @internal
+     */
+    maxHeight?: number;
+    /**
+     * @internal
+     */
+    minWidth?: number;
+    /**
+     * @internal
+     */
+    maxWidth?: number;
     widgetId: string;
 }
 /**
@@ -54,7 +70,7 @@ export type WidgetsOptions = Record<WidgetId, {
      * Jump to dashboard config for widgets
       @internal
      */
-    jtdConfig?: JTDConfig;
+    jtdConfig?: JtdConfig;
 }>;
 /**
  * Options for TabberWidets in a dashboard

package/dist/packages/sdk-ui/src/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts

@@ -2,7 +2,7 @@ import type { PivotTableDataOptions } from '../../../chart-data-options/types.js
 import type { DateFormatter, HeaderCellFormatter } from '../types.js';
 export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter) => HeaderCellFormatter;
 /**
- * Formats the date time string.
+ * Formats the date time string or Date object.
  * If the date is invalid, it returns the original value.
  */
-export declare function formatDatetimeString(value: string, dateFormatter: DateFormatter, dateFormat?: string): string;
+export declare function formatDatetimeString(value: string | Date, dateFormatter: DateFormatter, dateFormat?: string): string;

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/translation/resources/en.d.ts

@@ -372,6 +372,7 @@ export declare const translation: {
     };
     jumpToDashboard: {
         defaultCaption: string;
+        jumpableTooltip: string;
     };
 };
 /**

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

@@ -382,6 +382,7 @@ export declare const resources: {
         };
         jumpToDashboard: {
             defaultCaption: string;
+            jumpableTooltip: string;
         };
     };
     uk: {
@@ -758,6 +759,7 @@ export declare const resources: {
         };
         jumpToDashboard: {
             defaultCaption: string;
+            jumpableTooltip: string;
         };
     };
 };

package/dist/packages/sdk-ui/src/utils/parseISOWithTimezoneCheck.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses an ISO date string with timezone handling.
+ * If the date string doesn't have a timezone offset, it appends 'Z' (UTC) to ensure consistent parsing.
+ * This prevents parseISO from adding timezone based on daylight saving time.
+ *
+ * @param dateString - The ISO date string to parse
+ * @returns A Date object parsed from the string
+ */
+export declare function parseISOWithTimezoneCheck(dateString: string): Date;

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

@@ -47,7 +47,7 @@ export interface WidgetDto {
         drillHistory?: PanelItem[];
         usedFormulasMapping?: any;
     };
-    drillToDashboardConfig?: JTDConfigDto;
+    drillToDashboardConfig?: JtdConfigDto;
     style: WidgetStyle;
     title: string;
     desc: string | null;
@@ -514,11 +514,11 @@ export type TextWidgetDtoStyle = {
         textAlign: 'center';
     };
 };
-export type JTDDrillTarget = {
+export type JtdDrillTarget = {
     caption: string;
     id: string;
 };
-export type JTDConfigDto = {
+export type JtdConfigDto = {
     drilledDashboardPrefix: string;
     drilledDashboardsFolderPrefix: string;
     displayFilterPane: boolean;
@@ -547,7 +547,7 @@ export type JTDConfigDto = {
     showFolderNameOnMenuSelection: boolean;
     resetDashFiltersAfterJTD: boolean;
     sameCubeRestriction: boolean;
-    showJTDIcon: boolean;
+    showJTDIcon?: boolean;
     sendPieChartMeasureFiltersOnClick: boolean;
     forceZeroInsteadNull: boolean;
     mergeTargetDashboardFilters: boolean;
@@ -560,26 +560,26 @@ export type JTDConfigDto = {
     includeDashFilterDims?: string[];
     includeWidgetFilterDims?: string[];
 };
-export declare enum JTDNavigateType {
+export declare enum JtdNavigateType {
     CLICK = "click",
     RIGHT_CLICK = "rightclick",
     PIVOT_LINK = "pivotlink",
     BLOX = "blox"
 }
-export type JTDConfig = {
+export type JtdConfig = {
     drilledDashboardPrefix?: string;
     displayFilterPane?: boolean;
     displayToolbarRow?: boolean;
     drillToDashboardRightMenuCaption?: string;
-    navigateType?: JTDNavigateType;
+    navigateType?: JtdNavigateType;
     includeDashFilterDims?: string[];
     includeWidgetFilterDims?: string[];
-    drillTargets: JTDDrillTarget[];
+    drillTargets: JtdDrillTarget[];
     modalWindowResize?: boolean;
     modalWindowMeasurement?: SizeMeasurement;
     modalWindowWidth?: number;
     modalWindowHeight?: number;
-    showJTDIcon?: boolean;
+    showJtdIcon?: boolean;
     mergeTargetDashboardFilters?: boolean;
     sendFormulaFiltersDuplicate?: number | 'none' | undefined;
     enabled?: boolean;

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.