@sisense/sdk-ui 2.29.0 → 2.30.0

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

@@ -4,14 +4,14 @@ import { Hierarchy } from './domains/drilldown/hierarchy-model';
 import { ExecuteQueryParams, QueryByWidgetIdState } from './domains/query-execution';
 import { ExecuteQueryResult } from './domains/query-execution/types';
 import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from './domains/visualizations/components/pivot-table/formatters/types';
-import { AreamapChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, RangeChartDataOptions, RegularChartDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptions, TabularChartDataOptions } from './domains/visualizations/core/chart-data-options/types';
+import { AreamapChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, RangeChartDataOptions, RegularChartDataOptions, SankeyChartDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptions, TabularChartDataOptions } from './domains/visualizations/core/chart-data-options/types';
 import { HighchartsOptions } from './domains/visualizations/core/chart-options-processor/chart-options-service';
 import type { ChartWidgetProps } from './domains/widgets/components/chart-widget/types';
 import { FiltersMergeStrategy } from './domains/widgets/components/widget-by-id/types';
 import { type AppConfig } from './infra/app/types';
 import type { Module } from './infra/modules';
 import type { Plugin } from './infra/plugins/types';
-import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, CustomDrilldownResult, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableDrilldownOptions, PivotTableStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TableStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, ThemeConfig, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
+import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, CustomDrilldownResult, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableDrilldownOptions, PivotTableStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, SankeyStyleOptions, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TableStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, ThemeConfig, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
 export type { TabberButtonsWidgetProps } from './domains/widgets/components/tabber-buttons-widget/types';
 export type { WidgetProps, WidgetType, WithCommonWidgetProps, } from './domains/widgets/components/widget/types';
 export type { MenuItemSection, HighchartsOptions };
@@ -202,6 +202,12 @@ export interface ExecuteQueryProps {
     offset?: number;
     /** {@inheritDoc ExecuteQueryParams.ungroup} */
     ungroup?: boolean;
+    /**
+     * {@inheritDoc ExecuteQueryParams.includeRowCount}
+     *
+     * @beta
+     */
+    includeRowCount?: boolean;
     /** Function as child component that is called to render the query results */
     children?: (queryResult: ExecuteQueryResult) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
@@ -847,6 +853,38 @@ export interface FunnelChartProps extends BaseChartProps, HighchartsBasedChartEv
      */
     styleOptions?: FunnelStyleOptions;
 }
+/**
+ * Props of the {@link SankeyChart} component.
+ *
+ * @group Charts
+ * @beta
+ *
+ * @example
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Category.Category],
+ *     value: measureFactory.sum(DM.Commerce.Revenue),
+ *   }}
+ *   styleOptions={{ orientation: 'horizontal' }}
+ * />
+ * ```
+ */
+export interface SankeyChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart.
+     *
+     * @category Chart
+     */
+    dataOptions: SankeyChartDataOptions;
+    /**
+     * Configurations for how to style and present a chart's data.
+     *
+     * @category Chart
+     */
+    styleOptions?: SankeyStyleOptions;
+}
 /**
  * Props of the {@link LineChart} component.
  */
@@ -1180,6 +1218,12 @@ export interface ExecuteQueryByWidgetIdProps {
     count?: number;
     /** {@inheritDoc ExecuteQueryParams.offset} */
     offset?: number;
+    /**
+     * {@inheritDoc ExecuteQueryByWidgetIdParams.includeRowCount}
+     *
+     * @beta
+     */
+    includeRowCount?: boolean;
     /** {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy} */
     filtersMergeStrategy?: FiltersMergeStrategy;
     /** {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters} */

package/dist/packages/sdk-ui/src/public-api/alpha.d.ts

@@ -5,7 +5,9 @@
  * Not recommended for production use.
  */
 export { useDashboardTheme } from '../domains/dashboarding/use-dashboard-theme.js';
-export type { ThemeConfig } from '../types';
+export type { ThemeConfig, WidgetNarrativeDisplayLocation, WidgetNarrativeOptions, CompleteWidgetNarrativeOptions, WidgetAiOptions, } from '../types';
+export { DashboardHeaderTargets, type DashboardHeaderTarget, } from '../domains/dashboarding/components/dashboard-header-targets.js';
+export type { DashboardHeaderConfig, DashboardHeaderItem, DashboardHeaderItemComponent, DashboardHeaderItemComponentProps, DashboardHeaderItemPosition, DashboardHeaderItemSize, DashboardHeaderItemsTransform, DashboardResolvedHeaderItem, } from '../domains/dashboarding/components/dashboard-header-config.js';
 export { type TranslationDictionary, PACKAGE_NAMESPACE as translationNamespace, } from '../infra/translation/resources';
 export { CascadingFilterTile, type CascadingFilterTileProps, } from '../domains/filters/components/cascading-filter-tile';
 export { CustomFilterTile, type CustomFilterTileProps, } from '../domains/filters/components/custom-filter-tile';

package/dist/packages/sdk-ui/src/public-api/beta.d.ts

@@ -5,3 +5,9 @@
  * Not recommended for production use.
  */
 export { useQueryCache } from '../domains/query-execution/hooks/use-query-cache/use-query-cache';
+export type { Plugin, BasePluginInfo } from '../infra/plugins/types.js';
+export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
+export { SankeyChart } from '../domains/visualizations/components/sankey-chart';
+export type { SankeyChartProps } from '../props';
+export type { SankeyChartDataOptions } from '../domains/visualizations/core/chart-data-options/types';
+export type { SankeyStyleOptions, SankeyChartType } from '../types';

package/dist/packages/sdk-ui/src/public-api/internal.d.ts

@@ -8,7 +8,7 @@ export { type ClientApplication } from '../infra/app/types';
 export { createClientApplication } from '../infra/app/client-application';
 export { queryStateReducer } from '../domains/query-execution/hooks/shared/query-state-reducer';
 export { useExecuteCsvQueryInternal, useExecutePivotQueryInternal, executeQueryByWidgetId, } from '../domains/query-execution';
-export { executeCsvQuery, executePivotQuery, executeQuery, } from '../domains/query-execution/core/execute-query';
+export { executeCsvQuery, executePivotQuery, executeQuery, executeQueryWithRowCount, } from '../domains/query-execution/core/execute-query';
 export { useDashboardModel, getDashboardModel, getDashboardModels, translateToDashboardResponse, translateToDashboardsResponse, } from '../domains/dashboarding/dashboard-model';
 export { getWidgetModel } from '../domains/widgets/widget-model';
 export { getHierarchyModels } from '../domains/drilldown/hierarchy-model';

package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts

@@ -19,17 +19,19 @@ export { QuotaNotification } from '../shared/components/quota-notification/quota
 export type { QuotaNotificationProps } from '../shared/components/quota-notification/quota-notification.js';
 export { useQuotaNotification } from '../shared/hooks/use-quota-notification.js';
 export type { QuotaNotificationOptions, QuotaApiResponse, QuotaState, } from '../shared/hooks/use-quota-notification.js';
-export type { Plugin } from '../infra/plugins/types.js';
-export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, VisualizationStateUpdate, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
+export type { VisualizationStateUpdate } from '../infra/plugins/widget-plugins/types.js';
 export { LoadingIndicator } from '../shared/components/loading-indicator.js';
 export { DataSchemaBrowser } from '../domains/data-browser/data-schema-browser/data-schema-browser.js';
 export { type NarrativeQueryParams } from '../domains/narrative/core/build-narrative-request.js';
-export { useGetWidgetNarrative, type UseGetWidgetNarrativeOptions, type UseGetWidgetNarrativeParams, type UseGetWidgetNarrativeResult, } from '../domains/narrative/hooks/use-get-widget-narrative.js';
+export { useGetWidgetNarrative, type UseGetWidgetNarrativeParams, type UseGetWidgetNarrativeResult, } from '../domains/narrative/hooks/use-get-widget-narrative.js';
 export { WidgetNarrative, type WidgetNarrativeProps, } from '../domains/narrative/components/widget-narrative.js';
 export type { NlqChartWidgetStyleOptions } from '../types';
 export type { RenderToolbarHandler, RenderTitleHandler } from '../types';
 export { isChartWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
 export { isPivotTableWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
+export { DashboardModule, type DashboardModuleApi, } from '../domains/dashboarding/dashboard-module/dashboard-module.js';
+export type { DashboardCustomization, DashboardStateApi, } from '../domains/dashboarding/dashboard-module/types.js';
+export { withHeaderItem } from '../domains/dashboarding/dashboard-helpers.js';
 export { useDashboardPersistence } from '../domains/dashboarding/dashboard-model';
 export { createDashboardPersistenceManager } from '../domains/dashboarding/persistence/persistence-manager.js';
 export type { DashboardPersistenceManager } from '../domains/dashboarding/persistence/types.js';

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