@sisense/sdk-ui 2.9.0 → 2.11.0

package/dist/packages/sdk-ui/src/chart-options-processor/translations/legend-section.d.ts

@@ -1,28 +1,42 @@
-import { TextStyle } from './types';
+import type { LegendOptions } from '../../types';
+import type { TextStyle } from './types';
 export type LegendPosition = 'top' | 'left' | 'right' | 'bottom' | null;
 export type LegendSettings = {
     enabled: boolean;
     align?: 'center' | 'left' | 'right';
     verticalAlign?: 'top' | 'middle' | 'bottom';
-    layout?: 'horizontal' | 'vertical';
-    itemStyle?: TextStyle & {
-        cursor?: string;
-    };
-    symbolRadius?: number;
-    symbolHeight?: number;
-    symbolWidth?: number;
     borderWidth?: number;
     borderColor?: string;
+    borderRadius?: number;
     backgroundColor?: string;
+    margin?: number;
+    padding?: number;
+    maxHeight?: number;
+    shadow?: boolean;
+    reversed?: boolean;
+    rtl?: boolean;
+    floating?: boolean;
+    width?: number | string;
+    x?: number;
+    y?: number;
+    layout?: 'horizontal' | 'vertical' | 'proximate';
+    itemDistance?: number;
+    itemWidth?: number;
+    itemStyle?: TextStyle;
+    itemHoverStyle?: TextStyle;
+    itemHiddenStyle?: TextStyle;
     itemMarginBottom?: number;
     itemMarginTop?: number;
-    margin?: number;
+    symbolRadius?: number;
+    symbolHeight?: number;
+    symbolWidth?: number;
+    symbolPadding?: number;
+    squareSymbol?: boolean;
     title?: {
-        style?: {
-            [key: string]: string | number;
-        };
+        text?: string;
+        style?: TextStyle;
     };
-    maxHeight?: number;
 };
 export declare const legendItemStyleDefault: LegendSettings['itemStyle'];
-export declare const getLegendSettings: (position: LegendPosition) => LegendSettings;
+export declare const getLegendSettings: (legend?: LegendOptions) => LegendSettings;
+export declare const isLegendOnRight: (legend?: LegendOptions) => boolean;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-plot-options.d.ts

@@ -1,5 +1,5 @@
 import { PlotOptions } from '../chart-options-service';
-import { ValueLabelSettings } from './value-label-section';
+import { DataLabelsSettings } from './value-label-section';
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { CompleteThemeSettings } from '../../types';
 export declare const DefaultPieLabels: PieLabels;
@@ -16,7 +16,7 @@ export type PieType = (typeof pieTypes)[number];
 export type PieOptions = {
     allowPointSelect: boolean;
     cursor?: string;
-    dataLabels: ValueLabelSettings & {
+    dataLabels: DataLabelsSettings & {
         showPercentLabels: boolean;
         showDecimals: boolean;
         pieMinimumFontSizeToTextLabel: number;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-series.d.ts

@@ -1,18 +1,46 @@
-import { SeriesWithAlerts, CompleteThemeSettings } from '../../types';
+import { Convolution, SeriesWithAlerts, CompleteThemeSettings } from '../../types';
 import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
 import { SeriesType } from '../chart-options-service';
 import { PieChartDesignOptions } from './design-options';
 import { CategoricalChartData } from '../../chart-data/types';
+import { SeriesPieOptions } from '@sisense/sisense-charts';
 type FormattedPieChartData = SeriesWithAlerts<SeriesType[]> & {
-    convolutionSeries: SeriesType[];
+    convolutionSeries: SeriesPieOptions[];
 };
+/**
+ * Pure function that generates alerts for data limit warnings based on series capacity.
+ */
+export declare const getPieAlerts: (chartData: CategoricalChartData, seriesCapacity: number) => SeriesWithAlerts<SeriesType[]>['alerts'];
+/**
+ * Creates pie chart series with convolution applied.
+ * Returns the complete series ready for chart rendering.
+ */
+export declare const getPieSeries: ({ chartData, dataOptions, seriesCapacity, convolution, themeSettings, }: {
+    chartData: CategoricalChartData;
+    dataOptions: CategoricalChartDataOptionsInternal;
+    seriesCapacity: number;
+    convolution?: Convolution | undefined;
+    themeSettings?: CompleteThemeSettings | undefined;
+}) => SeriesType[];
+/**
+ * Returns only the convolution series (breakdown of "Others" slice).
+ * This is separate data for drill-down functionality.
+ */
+export declare const getPieConvolutionSeries: ({ chartData, dataOptions, seriesCapacity, convolution, themeSettings, }: {
+    chartData: CategoricalChartData;
+    dataOptions: CategoricalChartDataOptionsInternal;
+    seriesCapacity: number;
+    convolution?: Convolution | undefined;
+    themeSettings?: CompleteThemeSettings | undefined;
+}) => SeriesPieOptions[];
 /**
  * Convert categorical chart data into renderable highcharts pie series.
  *
- * @param chartData
- * @param dataOptions
- * @param designOptions
- * @param themeSettings
+ * @param chartData - The source categorical chart data
+ * @param dataOptions - Chart data configuration options
+ * @param designOptions - Design and styling options including convolution settings
+ * @param themeSettings - Theme configuration for colors and styling
+ * @returns Formatted pie chart data with series, alerts, and convolution series
  */
 export declare const formatCategoricalChartData: (chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: PieChartDesignOptions, themeSettings?: CompleteThemeSettings) => FormattedPieChartData;
 export {};

package/dist/packages/sdk-ui/src/chart-options-processor/translations/scatter-series.d.ts

@@ -3,6 +3,7 @@ import { SeriesType } from '../chart-options-service';
 import { ScatterAxisCategoriesMap, ScatterDataTable } from '../../chart-data/types';
 import { ComparableData } from '../../chart-data-processor/table-processor';
 import { SeriesWithAlerts, CompleteThemeSettings } from '../../types';
+import { ChartDesignOptions } from './types';
 export type ScatterSeriesColor = {
     index: number;
     color: string;
@@ -21,4 +22,4 @@ export interface AxisComputedProperties {
     selected?: boolean;
 }
 export declare const handleNumberValue: (cell: ComparableData) => number | null;
-export declare const buildScatterSeries: (data: ScatterDataTable, categoriesMap: ScatterAxisCategoriesMap, dataOptions?: ScatterChartDataOptionsInternal, themeSettings?: CompleteThemeSettings, seriesCapacity?: number) => SeriesWithAlerts<SeriesType[]>;
+export declare const buildScatterSeries: (data: ScatterDataTable, categoriesMap: ScatterAxisCategoriesMap, dataOptions?: ScatterChartDataOptionsInternal, designOptions?: ChartDesignOptions, themeSettings?: CompleteThemeSettings, seriesCapacity?: number) => SeriesWithAlerts<SeriesType[]>;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/sunburst/sunburst-options.d.ts

@@ -4,4 +4,82 @@ import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options
 import { CompleteThemeSettings } from '../../../types';
 import { SunburstChartDesignOptions } from '../design-options';
 import { TFunction } from '@sisense/sdk-common';
+/**
+ * Prepares the series configuration for sunburst chart
+ */
+export declare function prepareSunburstSeries(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettings): ({
+    name: string;
+    showInLegend: boolean;
+    color: string;
+    data: never[];
+    states: {
+        hover: {
+            enabled: boolean;
+        };
+    };
+} | {
+    name: string;
+    data: ({
+        id: string;
+        name: string;
+        custom: {
+            level: number;
+            levelsCount: number;
+        };
+    } | {
+        color: any;
+        name?: string | undefined;
+        y?: number | null | undefined;
+        x?: number | null | undefined;
+        z?: number | null | undefined;
+        marker?: {
+            enabled?: boolean | undefined;
+            isIsolatedPoint?: boolean | undefined;
+            lineColor?: string | undefined;
+            lineWidth?: number | undefined;
+        } | undefined;
+        selected?: boolean | undefined;
+        sliced?: boolean | undefined;
+        custom?: {
+            [k: string]: unknown;
+            number1?: number | undefined;
+            string1?: string | undefined;
+            level?: number | undefined;
+            maskedBreakByPoint?: string | undefined;
+            maskedBreakByColor?: string | undefined;
+        } | undefined;
+        value?: number | null | undefined;
+        id?: string | undefined;
+        drilldown?: string | undefined;
+        parent?: string | undefined;
+        low?: number | null | undefined;
+        high?: number | null | undefined;
+        trend?: {
+            min: number;
+            max: number;
+            median: number;
+            average: number;
+        } | undefined;
+    })[];
+    levels: {
+        level: number;
+        dataLabels: {
+            enabled: boolean;
+            formatter(this: import("highcharts").PointLabelObject): string;
+        };
+    }[];
+    showInLegend: boolean;
+    turboThreshold: number;
+    type: string;
+    borderWidth: number;
+    dataLabels: {
+        style: {
+            textOutline: string;
+        };
+    };
+})[];
+/**
+ * Prepares the tooltip configuration for sunburst chart
+ */
+export declare function prepareSunburstTooltip(dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction): import("../tooltip-utils").TooltipSettings;
 export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/tooltip-utils.d.ts

@@ -1,5 +1,5 @@
 import { StyledMeasureColumn, StyledColumn } from '../../chart-data-options/types.js';
-import { TooltipFormatterContextObject } from '@sisense/sisense-charts';
+import { TooltipFormatterContextObject, CSSObject } from '@sisense/sisense-charts';
 export declare const isValueNumeric: (value: StyledMeasureColumn | StyledColumn | undefined) => boolean | "";
 export declare const formatTooltipValue: (dataOption: StyledMeasureColumn | StyledColumn | undefined, value: number | string | undefined, displayValue: string) => string;
 export declare function isTooltipPercentValueSupported(options: StyledMeasureColumn | undefined): boolean;
@@ -14,11 +14,13 @@ export type TooltipSettings = {
     crosshairs?: boolean;
     shared?: boolean;
     formatter?: (this: HighchartsDataPointContext) => string | false;
-    style?: {
-        fontFamily?: string;
-    };
+    style?: CSSObject;
     padding?: number;
     outside?: boolean;
+    position?: {
+        relativeTo?: 'chart';
+    };
+    followPointer?: boolean;
 };
 export type HighchartsDataPointContextNode = {
     val: number;
@@ -54,6 +56,8 @@ export type HighchartsDataPointContext = {
             string1?: string;
             xDisplayValue?: string;
             xValue?: (number | string)[];
+            monthDay?: number;
+            hasData?: boolean;
         };
         upperPointName?: string;
         lowerPointName?: string;
@@ -65,6 +69,8 @@ export type HighchartsDataPointContext = {
         };
         options?: TooltipFormatterContextObject['point']['options'];
         node?: HighchartsDataPointContextNode;
+        date?: string | number | Date;
+        value?: number;
     };
     percentage?: number;
     color?: string;

package/dist/packages/sdk-ui/src/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -7,7 +7,7 @@ import { Stacking } from '../chart-options-service';
 import { DesignOptions } from './types';
 export type LineType = 'straight' | 'smooth';
 export type StackType = 'classic' | 'stacked' | 'stack100';
-export type HighchartsType = ChartType | 'spline' | 'areaspline' | 'bubble';
+export type HighchartsType = ChartType | 'spline' | 'areaspline' | 'bubble' | 'heatmap';
 export type HighchartsSeriesValues = {
     name: string;
     data: SeriesPointStructure[];

package/dist/packages/sdk-ui/src/chart-options-processor/translations/types.d.ts

@@ -1,18 +1,54 @@
 import { AreamapChartDesignOptions } from '../../chart/restructured-charts/areamap-chart/types';
 import { ChartType } from '../../types';
-import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, ScattermapChartDesignOptions, AreaRangeChartDesignOptions, BaseDesignOptionsType } from './design-options';
+import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, CalendarHeatmapChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, ScattermapChartDesignOptions, AreaRangeChartDesignOptions, BaseDesignOptionsType } from './design-options';
 /**
- * Style configuration for text elements
+ * Style configuration for text elements in charts and UI components.
+ * Defines the visual appearance and behavior of text rendering.
  */
 export type TextStyle = {
+    /**
+     * Font family name for the text.
+     * Examples: 'Arial', 'Helvetica', 'Times New Roman', 'sans-serif'
+     */
     fontFamily?: string;
+    /**
+     * Font size in CSS units (px, em, rem, pt, etc.).
+     * Examples: '12px', '1.2em', '16pt'
+     */
     fontSize?: string;
+    /**
+     * Font weight for text rendering.
+     * Examples: 'normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'
+     */
     fontWeight?: string;
+    /**
+     * Font style for text rendering.
+     * Examples: 'normal', 'italic', 'oblique'
+     */
+    fontStyle?: string;
+    /**
+     * Text color in any valid CSS color format.
+     * Examples: '#FF0000', 'rgb(255, 0, 0)', 'red', 'rgba(255, 0, 0, 0.5)'
+     */
     color?: string;
+    /**
+     * Text outline/stroke configuration.
+     * Defines the outline color and width for text rendering.
+     * Examples: '1px solid black', '2px #333'
+     */
     textOutline?: string;
+    /**
+     * CSS pointer-events property for text interaction.
+     * Controls how the text responds to mouse events.
+     * Examples: 'auto', 'none', 'visible', 'visibleFill', 'visibleStroke'
+     */
     pointerEvents?: string;
+    /**
+     * Text overflow handling behavior.
+     * Controls how text is displayed when it exceeds its container.
+     * Examples: 'clip', 'ellipsis', 'visible', 'hidden'
+     */
     textOverflow?: string;
-    width?: string;
 };
 export declare const POLAR_CHART_TYPES: readonly ["polar"];
 export type PolarChartType = (typeof POLAR_CHART_TYPES)[number];
@@ -44,6 +80,13 @@ export type ImageChartType = (typeof IMAGE_CHART_TYPES)[number];
 export declare const SCATTERMAP_CHART_TYPES: readonly ["scattermap"];
 /** Scattermap chart types  @expandType */
 export type ScattermapChartType = (typeof SCATTERMAP_CHART_TYPES)[number];
+export declare const CALENDAR_HEATMAP_CHART_TYPES: readonly ["calendar-heatmap"];
+/**
+ * Calendar heatmap chart types
+ *
+ * @expandType
+ */
+export type CalendarHeatmapChartType = (typeof CALENDAR_HEATMAP_CHART_TYPES)[number];
 export declare const RANGE_CHART_TYPES: readonly ["arearange"];
 /** AreaRange chart types  @expandType */
 export type RangeChartType = (typeof RANGE_CHART_TYPES)[number];
@@ -51,7 +94,7 @@ export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' |
 /**
  * Design options for a specific chart type
  */
-export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : never;
+export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'sunburst' ? TreemapChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'calendar-heatmap' ? CalendarHeatmapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : never;
 /** A unique identifier for a series to be found in {@link ChartDataOptionsInternal} */
 type SeriesId = string;
 /**
@@ -64,7 +107,7 @@ export type ChartDesignOptions<SpecificChartType extends ChartType = ChartType>
  *
  * @internal
  */
-export type SeriesDesignOptions = Pick<BaseDesignOptionsType, 'lineWidth' | 'marker'>;
+export type SeriesDesignOptions = Pick<BaseDesignOptionsType, 'marker'> & Pick<LineChartDesignOptions, 'line'>;
 export type DesignPerSeries = {
     designPerSeries: Record<SeriesId, SeriesDesignOptions>;
 };
@@ -78,6 +121,7 @@ export declare const isTable: (chartType: ChartType | TableType) => chartType is
 export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot";
 export declare const isAreamap: (chartType: ChartType) => chartType is "areamap";
 export declare const isRange: (chartType: ChartType) => chartType is "arearange";
-export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "arearange"];
+export declare const isCalendarHeatmap: (chartType: ChartType) => chartType is "calendar-heatmap";
+export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "calendar-heatmap", "arearange"];
 export type DynamicChartType = (typeof ALL_CHART_TYPES)[number];
 export {};

package/dist/packages/sdk-ui/src/chart-options-processor/translations/value-label-section.d.ts

@@ -3,17 +3,12 @@ import { TextStyle } from './types';
 import { AxisOrientation } from './axis-section';
 import { HighchartsDataPointContext } from './tooltip-utils';
 import { PolarType } from './design-options';
-import { NumberFormatConfig } from '../../types';
-export type ValueLabelOptions = {
-    enabled?: boolean;
-    rotation?: number;
-    showValue?: boolean;
-    showPercentage?: boolean;
-};
+import { NumberFormatConfig, SeriesLabels } from '../../types';
 export type RotationType = 'horizontal' | 'diagonal' | 'vertical';
-export type ValueLabelSettings = {
+export type DataLabelsSettings = {
     enabled?: boolean;
     align?: string;
+    inside?: boolean;
     crop?: boolean;
     rotation?: number;
     y?: number;
@@ -23,6 +18,14 @@ export type ValueLabelSettings = {
     allowOverlap?: boolean;
     verticalAlign?: 'bottom' | 'middle' | 'top';
     padding?: number;
+    color?: 'contrast' | string;
+    backgroundColor?: string;
+    borderColor?: string;
+    borderRadius?: number;
+    borderWidth?: number;
+    animation?: {
+        defer?: boolean | number;
+    };
     types?: {
         count: boolean;
         relative: boolean;
@@ -30,7 +33,7 @@ export type ValueLabelSettings = {
     };
     formatter?: (this: HighchartsDataPointContext, options?: DataLabelsOptions, valuePropName?: string) => string;
 };
-export declare const createValueLabelFormatter: (numberFormatConfig?: NumberFormatConfig, options?: ValueLabelOptions) => (this: HighchartsDataPointContext) => string;
+export declare const createDataLabelsFormatter: (numberFormatConfig?: NumberFormatConfig, options?: SeriesLabels) => (this: HighchartsDataPointContext) => string;
 export declare const getRotationType: (rotation: number) => RotationType;
-export declare const getValueLabelSettings: (xAxisOrientation: AxisOrientation, valueLabel: ValueLabelOptions, inside?: boolean) => ValueLabelSettings;
-export declare const getPolarValueLabelSettings: (valueLabel: ValueLabelOptions, polarType: PolarType) => ValueLabelSettings;
+export declare const getDataLabelsSettings: (xAxisOrientation: AxisOrientation, seriesLabels?: SeriesLabels, inside?: boolean) => DataLabelsSettings;
+export declare const getPolarDataLabelsSettings: (seriesLabels: SeriesLabels | undefined, polarType: PolarType) => DataLabelsSettings;

package/dist/packages/sdk-ui/src/common/components/modal/modal-context.d.ts

@@ -1,11 +1,10 @@
 /// <reference types="react" />
-import { SizeMeasurement } from '../../../types';
 export interface ModalOptions {
     title?: string;
     content: React.ReactNode;
     width?: number;
     height?: number;
-    measurement?: SizeMeasurement;
+    measurement?: '%' | 'px';
 }
 export type ModalInstance = {
     id: string;

package/dist/packages/sdk-ui/src/common/formatters/create-date-formatter.d.ts

@@ -0,0 +1,10 @@
+import { DateConfig } from '../../query/date-formats';
+export type DateFormatter = (date: Date, format: string) => string;
+/**
+ * Creates a date formatter function
+ *
+ * @param locale - The locale to use for formatting
+ * @param cfg - The date configuration to use for formatting
+ * @returns A function that formats dates
+ */
+export declare function createDateFormatter(locale?: Locale, cfg?: DateConfig): DateFormatter;

package/dist/packages/sdk-ui/src/common/hooks/useDateFormatter.d.ts

@@ -0,0 +1,7 @@
+import { DateFormatter } from '../formatters/create-date-formatter';
+/**
+ * A hook that returns a date formatter function
+ *
+ * @returns A function that formats dates
+ */
+export declare function useDateFormatter(): DateFormatter;

package/dist/packages/sdk-ui/src/common/icons/double-arrow-end-icon.d.ts

@@ -0,0 +1,6 @@
+import { Themable } from '../../theme-provider/types';
+import type { SVGProps } from 'react';
+export declare const DoubleArrowEndIcon: (props: Pick<SVGProps<SVGElement>, 'className' | 'width' | 'height' | 'fill' | 'onClick'> & {
+    direction: 'left' | 'right';
+    disabled?: boolean;
+} & Themable) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/utils.d.ts

@@ -1,24 +1,5 @@
 import { EditableLayoutDragData, EditableLayoutDropData } from '../../../dashboard/components/editable-layout/types';
 import { DragStartEvent } from '@dnd-kit/core';
-import { RenderTitleHandler, RenderToolbarHandler, TextWidgetRenderToolbarHandler } from '../../../types';
 export declare const isEditableLayoutDragData: (data: any | undefined) => data is EditableLayoutDragData;
 export declare const isEditableLayoutDropData: (data: any) => data is EditableLayoutDropData;
 export declare const getDraggingWidgetId: (event: DragStartEvent) => string | null;
-/**
- * Compose multiple RenderToolbarHandler functions into one.
- * Each handler gets a chance to modify the toolbar.
- * If it returns `null`, the previous toolbar is passed to the next handler.
- */
-export declare function composeToolbarHandlers(...handlers: (RenderToolbarHandler | undefined)[]): RenderToolbarHandler;
-/**
- * Compose multiple TextWidgetRenderToolbarHandler functions into one.
- * Each handler gets a chance to modify the toolbar.
- * If it returns `null`, the previous toolbar is passed to the next handler.
- */
-export declare function composeTextWidgetToolbarHandlers(...handlers: (TextWidgetRenderToolbarHandler | undefined)[]): TextWidgetRenderToolbarHandler;
-/**
- * Compose multiple RenderTitleHandler functions into one.
- * Each handler gets a chance to modify the title.
- * If it returns `null`, the previous tile is passed to the next handler.
- */
-export declare function composeTitleHandlers(...handlers: (RenderTitleHandler | undefined)[]): RenderTitleHandler;

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

@@ -1,15 +1,16 @@
 /// <reference types="react" />
 import { type Filter } from '@sisense/sdk-data';
+import { DashboardConfig, DashboardProps } from '../../dashboard/types';
+import { DashboardId } from '../../models/dashboard/types';
 interface JtdDashboardProps {
-    dashboardOid: string;
+    dashboard: DashboardId | DashboardProps;
     filters: Filter[];
     mergeTargetDashboardFilters: boolean;
-    displayToolbarRow: boolean;
-    displayFilterPane: boolean;
+    dashboardConfig?: DashboardConfig;
 }
 /**
  * JTD-specific Dashboard component that handles runtime filters
- * This component reuses DashboardById logic but is specifically designed for JTD use cases
+ * This component can render either by dashboard ID or with provided dashboard props
  * @internal
  */
 export declare const JtdDashboard: import("react").FunctionComponent<JtdDashboardProps>;

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

@@ -1,5 +1,6 @@
 import { DashboardProps } from './types';
 import { Filter, FilterRelations } from '@sisense/sdk-data';
+import type { JumpToDashboardConfig } from './hooks/jtd/jtd-types';
 /**
  * Creates a new dashboard instance with its filters replaced by a new set of filters.
  *
@@ -107,3 +108,111 @@ export declare const removeFilter: (dashboard: DashboardProps, filterToRemove: F
  * @returns A new dashboard instance with the specified filters removed.
  */
 export declare const removeFilters: (dashboard: DashboardProps, filtersToRemove: Filter[]) => DashboardProps;
+/**
+ * Creates a new `DashboardProps` instance with JTD (Jump To Dashboard) configuration applied to a single widget.
+ *
+ * Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets,
+ * such as clicking on chart data points or using context menus. This function applies JTD configuration to a specific
+ * widget in a dashboard, enabling jump-to-dashboard functionality.
+ *
+ * This function does not modify the original dashboard; instead, it returns a new `DashboardProps` instance with the JTD
+ * configuration applied. If the specified widget does not exist in the dashboard, the function returns the original
+ * `DashboardProps` unchanged and logs a warning to the console.
+ *
+ * @example
+ * Apply JTD configuration to a dashboard widget.
+ * ```ts
+ * const jtdConfig: JumpToDashboardConfig = {
+ *   targets: [{ id: 'dashboardId1', caption: 'Analytics Dashboard' }],
+ *   interaction: {
+ *     triggerMethod: 'rightclick',
+ *     contextMenuCaption: 'Jump to Analytics'
+ *   }
+ * };
+ *
+ * const updatedDashboard = dashboardHelpers.applyJtdConfig(dashboard, 'widgetId3', jtdConfig);
+ * ```
+ *
+ * @param dashboard - The original dashboard to modify. Must be a valid `DashboardProps` object containing the target widget.
+ * @param widgetOid - The unique identifier (OID) of the widget to apply JTD configuration to. Must match an existing widget ID in the dashboard.
+ * @param config - The JTD configuration to apply.
+ *
+ * @returns A new `DashboardProps` instance with the JTD configuration applied to the specified widget. If the widget doesn't exist, returns the original dashboard unchanged.
+ *
+ * @group Dashboard Utilities
+ */
+export declare const applyJtdConfig: (dashboard: DashboardProps, widgetOid: string, config: JumpToDashboardConfig) => DashboardProps;
+/**
+ * Creates a new `DashboardProps` instance with JTD (Jump To Dashboard) configurations applied to multiple widgets in a single operation.
+ *
+ * Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets.
+ * This function efficiently applies JTD configurations to multiple widgets in a single operation.
+ *
+ * This function does not modify the original dashboard; instead, it returns a new `DashboardProps` instance with all valid
+ * JTD configurations applied. Configurations for non-existent widgets are automatically filtered out, and warnings
+ * are logged to the console for invalid widget OIDs.
+ *
+ * @example
+ * Apply a variety of Jump To Dashboard configuration options to multiple widgets in a single operation.
+ * ```ts
+ * import { dashboardHelpers } from '@sisense/sdk-ui';
+ *
+ * const dashboard: DashboardProps = {
+ *   title: 'Executive Dashboard',
+ *   widgets: [
+ *     { id: 'widgetId1', widgetType: 'chart', chartType: 'column', dataOptions: {...} },
+ *     { id: 'widgetId2', widgetType: 'chart', chartType: 'pie', dataOptions: {...} },
+ *     { id: 'widgetId3', widgetType: 'table', dataOptions: {...} }
+ *   ]
+ * };
+ *
+ * const jtdConfigs = {
+ *   'widgetId1': {
+ *     enabled: true,
+ *     targets: [{ id: 'dashboardId1', caption: 'Sales Breakdown' }],
+ *     interaction: {
+ *       triggerMethod: 'rightclick'
+ *     }
+ *   },
+ *   'widgetId2': {
+ *     targets: [{ id: 'dashboardId2', caption: 'Revenue Analysis' }],
+ *     interaction: {
+ *       triggerMethod: 'click',
+ *       contextMenuCaption: 'Analyze Revenue'
+ *     }
+ *   },
+ *   'widgetId3': {
+ *     enabled: true,
+ *     targets: [
+ *       { id: 'dashboardId3', caption: 'Customer Details' },
+ *       { id: 'dashboardId4', caption: 'Product Analytics' }
+ *     ],
+ *     interaction: {
+ *       triggerMethod: 'rightclick'
+ *     }
+ *   }
+ * };
+ *
+ * const updatedDashboard = dashboardHelpers.applyJtdConfigs(dashboard, jtdConfigs);
+ * ```
+ *
+ * @example Error handling
+ * Batch apply JTD configurations with error handling.
+ * ```ts
+ * const configsWithInvalidWidget = {
+ *   'widgetId1': { targets: [{ id: 'dashboardId1', caption: 'Target' }] },
+ *   'invalidWidgetId': { targets: [{ id: 'dashboardId2', caption: 'Other' }] } // Will be filtered out
+ * };
+ *
+ * const result = dashboardHelpers.applyJtdConfigs(dashboard, configsWithInvalidWidget);
+ * // Console warning: "Widgets with OIDs [invalidWidgetId] not found in dashboard..."
+ * // Only 'widgetId1' gets the JTD configuration applied
+ * ```
+ *
+ * @param dashboard - The original dashboard to modify. Must be a valid `DashboardProps` object with widgets to configure.
+ * @param jtdConfigs - An object mapping widget OIDs (keys) to their respective JTD configurations (values).
+ * @returns A new `DashboardProps` instance with all valid JTD configurations applied to their respective widgets. Invalid widget configurations are skipped and warnings are logged.
+ *
+ * @group Dashboard Utilities
+ */
+export declare const applyJtdConfigs: (dashboard: DashboardProps, jtdConfigs: Record<string, JumpToDashboardConfig>) => DashboardProps;

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

@@ -0,0 +1,7 @@
+export { type JumpToDashboardConfig, type JumpToDashboardConfigForPivot, type JtdTarget, type TriggerMethod, } from './jtd';
+/**
+ * Internal JTD hook for dashboard composition
+ * @internal
+ */
+export { useJtdInternal } from './use-jtd';
+export { useJtdWidget } from './use-jtd-widget';