@sisense/sdk-ui 2.28.0 → 2.30.0

package/dist/packages/sdk-ui/src/shared/hooks/use-element-height.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Observes an HTML element's height via `ResizeObserver` and reports the latest
+ * measured height in CSS pixels.
+ *
+ * Returns a callback ref to attach to the target element and the current height.
+ * Height is `0` while no element is attached. The observer is re-bound when the
+ * attached node changes and disconnected on unmount.
+ *
+ * @example
+ * ```tsx
+ * const { ref, height } = useElementHeight<HTMLDivElement>();
+ * return <div ref={ref}>{height}px</div>;
+ * ```
+ * @internal
+ */
+export declare function useElementHeight<T extends HTMLElement = HTMLElement>(): {
+    ref: (node: T | null) => void;
+    height: number;
+};

package/dist/packages/sdk-ui/src/shared/hooks/use-synced-state.d.ts

@@ -1,5 +1,10 @@
 import { Dispatch, SetStateAction } from 'react';
-type UseSyncedStateOptions<T> = {
+/**
+ * Options for {@link useSyncedState}.
+ *
+ * @alpha
+ */
+export type UseSyncedStateOptions<T> = {
     /**
      * A callback function that is triggered when the state is updated via the local setter,
      * but not through synchronization with `syncValue`.
@@ -14,6 +19,22 @@ type UseSyncedStateOptions<T> = {
 /**
  * A custom React hook that behaves like the regular `useState`, but also synchronizes the state
  * with an external `syncValue`.
+ *
+ * @param syncValue - The external value to synchronize with. When this value changes (as
+ *   determined by `syncCompareFn`), the local state is updated to match it.
+ * @param options - Optional configuration object.
+ * @param options.onLocalStateChange - Callback invoked whenever the local state is updated via
+ *   the returned setter (not triggered by external `syncValue` synchronization).
+ * @param options.syncCompareFn - Custom equality function used to detect changes in `syncValue`.
+ *   Defaults to a deep equality check via `isEqual` from lodash-es. See {@link UseSyncedStateOptions}.
+ * @returns A tuple of `[localState, setState]` — the current local state and a setter that
+ *   both updates state and fires `onLocalStateChange`.
+ * @example
+ * ```tsx
+ * const [localState, setLocalState] = useSyncedState(externalValue, {
+ *   onLocalStateChange: (s) => console.log('local update', s),
+ * });
+ * ```
+ * @alpha
  */
 export declare function useSyncedState<T>(syncValue: T, { onLocalStateChange, syncCompareFn }?: UseSyncedStateOptions<T>): [T, Dispatch<SetStateAction<T>>];
-export {};

package/dist/packages/sdk-ui/src/shared/utils/filter-relations.d.ts

@@ -9,6 +9,14 @@ export declare enum FiltersMergeStrategyEnum {
     CODE_ONLY = "codeOnly"
 }
 export type FiltersMergeStrategy = `${FiltersMergeStrategyEnum}`;
+/**
+ * Returns true if any node in the filter-relations tree uses an OR operator.
+ * Used to decide whether to show the AND/OR Formula tile — AND-only trees are the default
+ * behavior and don't warrant a visible indicator.
+ *
+ * @internal
+ */
+export declare function hasOrOperator(relations: FilterRelationsRules): boolean;
 /**
  * Textual representation of filter relations for debugging purposes.
  * Returns string like "(([Gender] AND [Country]) OR [Condition])".

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

@@ -178,6 +178,7 @@ export type GradientColor = LinearGradientColor | RadialGradientColor;
  *
  * @param value - The value to check
  * @returns True if the value is a linear gradient
+ * @group Styling
  */
 export declare const isLinearGradient: (value: any) => value is LinearGradientColor;
 /**
@@ -185,6 +186,7 @@ export declare const isLinearGradient: (value: any) => value is LinearGradientCo
  *
  * @param value - The value to check
  * @returns True if the value is a radial gradient
+ * @group Styling
  */
 export declare const isRadialGradient: (value: any) => value is RadialGradientColor;
 /**
@@ -192,6 +194,7 @@ export declare const isRadialGradient: (value: any) => value is RadialGradientCo
  *
  * @param value - The value to check
  * @returns True if the value is a gradient
+ * @group Styling
  */
 export declare const isGradient: (value: any) => value is GradientColor;
 /**
@@ -315,6 +318,7 @@ export declare const RadialGradientPresets: {
  *   ]
  * );
  * ```
+ * @group Styling
  */
 export declare const createLinearGradient: (direction: LinearGradientDirection, stops: readonly GradientStop[]) => LinearGradientColor;
 /**
@@ -334,6 +338,7 @@ export declare const createLinearGradient: (direction: LinearGradientDirection,
  *   ]
  * );
  * ```
+ * @group Styling
  */
 export declare const createRadialGradient: (center: RadialGradientConfig, stops: readonly GradientStop[]) => RadialGradientColor;
 /**

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

@@ -4,6 +4,8 @@ import { DeepRequired } from 'ts-essentials';
 import { AbstractDataPointWithEntries } from './domains/dashboarding/common-filters/types';
 import { Coordinates } from './domains/visualizations/components/chart/components/scattermap/types';
 import { Hierarchy, HierarchyId, StyledColumn, StyledMeasureColumn } from '.';
+import type { CompleteWidgetNarrativeOptions, WidgetNarrativeDisplayLocation, WidgetNarrativeOptions } from './domains/narrative/core/widget-narrative-options.js';
+import { getCompleteWidgetNarrativeOptions } from './domains/narrative/core/widget-narrative-options.js';
 import { GeoDataElement } from './domains/visualizations/components/chart/restructured-charts/areamap-chart/types';
 import { CalendarDayOfWeek } from './domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
 import { HighchartsOptionsInternal } from './domains/visualizations/core/chart-options-processor/chart-options-service';
@@ -12,7 +14,7 @@ import { IndicatorComponents, TableColorOptions } from './domains/visualizations
 import { FunnelDirection, FunnelSize, FunnelType } from './domains/visualizations/core/chart-options-processor/translations/funnel-plot-options';
 import { LegendPosition } from './domains/visualizations/core/chart-options-processor/translations/legend-section';
 import { ScatterMarkerSize } from './domains/visualizations/core/chart-options-processor/translations/scatter-plot-options';
-import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, CartesianChartType, CategoricalChartType, IndicatorChartType, RangeChartType, ScatterChartType, ScattermapChartType, TableChartType, TextStyle } from './domains/visualizations/core/chart-options-processor/translations/types';
+import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, CartesianChartType, CategoricalChartType, IndicatorChartType, RangeChartType, SankeyChartType, ScatterChartType, ScattermapChartType, TableChartType, TextStyle } from './domains/visualizations/core/chart-options-processor/translations/types';
 import { DataPointsEventHandler } from './props';
 import { GradientColor } from './shared/utils/gradient';
 import { SoftUnion } from './shared/utils/utility-types';
@@ -20,9 +22,9 @@ export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './infra/app/types';
 export type { DateConfig } from './domains/query-execution/core/date-formats';
 export type { CalendarDayOfWeek } from './domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
-export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, StyledColumn, StyledMeasureColumn, } from './domains/visualizations/core/chart-data-options/types';
+export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, SankeyChartDataOptions, StyledColumn, StyledMeasureColumn, } from './domains/visualizations/core/chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './domains/visualizations/core/chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, TextStyle, } from './domains/visualizations/core/chart-options-processor/translations/types';
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, SankeyChartType, TextStyle, } from './domains/visualizations/core/chart-options-processor/translations/types';
 export type { IndicatorComponents } from './domains/visualizations/core/chart-options-processor/translations/design-options';
 export type { ScatterMarkerSize } from './domains/visualizations/core/chart-options-processor/translations/scatter-plot-options';
 export type { LegendPosition } from './domains/visualizations/core/chart-options-processor/translations/legend-section';
@@ -33,6 +35,22 @@ export type { AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubty
 export type { MonthOfYear, DayOfWeek, DateLevel, } from './domains/query-execution/core/date-formats/apply-date-format';
 export type { IndicatorRenderOptions } from './domains/visualizations/components/chart/components/indicator/indicator-render-options';
 export type { TabberButtonsWidgetStyleOptions, TabberButtonsWidgetCustomOptions, } from './domains/widgets/components/tabber-buttons-widget/types';
+/**
+ * Configuration for AI-powered widget features such as automated narrative generation
+ *
+ * Exposed on {@link ChartWidgetProps} and {@link PivotTableWidgetProps} as `aiOptions`.
+ *
+ * @alpha
+ */
+export type WidgetAiOptions = {
+    /**
+     * Natural-language narrative settings
+     * @alpha
+     */
+    narrative?: WidgetNarrativeOptions;
+};
+export type { WidgetNarrativeDisplayLocation, WidgetNarrativeOptions, CompleteWidgetNarrativeOptions, };
+export { getCompleteWidgetNarrativeOptions };
 /**
  * @internal
  */
@@ -1345,12 +1363,67 @@ export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'wid
  * View type determines how many months to display: 'month' (1), 'quarter' (3), 'half-year' (6), 'year' (12)
  */
 export type CalendarHeatmapViewType = 'month' | 'quarter' | 'half-year' | 'year';
+/**
+ * Configuration options that define functional style of the various elements of a SankeyChart.
+ *
+ * @group Charts
+ * @beta
+ *
+ * @example
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={dataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Category.Category],
+ *     value: [DM.Measures.SumRevenue],
+ *   }}
+ *   styleOptions={{
+ *     orientation: 'vertical',
+ *     nodePadding: 12,
+ *   }}
+ * />
+ * ```
+ */
+export interface SankeyStyleOptions extends BaseStyleOptions {
+    /**
+     * Whether the diagram flows horizontally (left-to-right) or vertically (top-to-bottom).
+     * Highcharts renders vertical flow by inverting the chart.
+     *
+     * @default 'horizontal'
+     */
+    orientation?: 'horizontal' | 'vertical';
+    /**
+     * Curve factor of links between Sankey nodes. 0 makes the lines straight.
+     * @default 0.33
+     */
+    curveFactor?: number;
+    /**
+     * Opacity of the links between Sankey nodes.
+     * @default 0.5
+     */
+    linkOpacity?: number;
+    /**
+     * Width of Sankey nodes in pixels (or height in vertical mode).
+     * @default 20
+     */
+    nodeWidth?: number;
+    /**
+     * Vertical padding between Sankey nodes in pixels (horizontal padding in vertical mode).
+     * @default 10
+     */
+    nodePadding?: number;
+    /**
+     * Determines which side of the chart the nodes are aligned to.
+     * In vertical mode `'top'` aligns to the left and `'bottom'` to the right.
+     */
+    nodeAlignment?: 'top' | 'center' | 'bottom';
+}
 /**
  * Configuration options that define functional style of the various elements of chart.
  */
 export type ChartStyleOptions = RegularChartStyleOptions | TabularChartStyleOptions;
 /** Style options for regular chart types */
-export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions | CalendarHeatmapStyleOptions | StreamgraphStyleOptions;
+export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions | CalendarHeatmapStyleOptions | StreamgraphStyleOptions | SankeyStyleOptions;
 /** Mapping of each of the chart value series to colors. */
 export type ValueToColorMap = {
     [value: string]: string;
@@ -1362,7 +1435,7 @@ export type MultiColumnValueToColorMap = {
 /**
  * Chart type of one of the supported chart families
  */
-export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | CalendarHeatmapChartType | RangeChartType | TableChartType;
+export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | CalendarHeatmapChartType | RangeChartType | SankeyChartType | TableChartType;
 /** Chart type of the regular charts */
 export type RegularChartType = Exclude<ChartType, TableChartType>;
 /**
@@ -2287,7 +2360,6 @@ export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of PivotTableWidget
- *
  */
 export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetContainerStyleOptions;
 /**