@sisense/sdk-ui 2.12.0 → 2.14.0

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

@@ -1,8 +1,20 @@
 import { AnyObject, DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import { DashboardSettings } from '../../api/types/dashboard-dto';
 import { DashboardLayoutOptions } from '../../dashboard';
-import { DashboardStyleOptions, TabbersOptions, WidgetModel } from '../../models';
+import { TabbersConfig } from '../../dashboard/hooks/use-tabber';
+import { DashboardStyleOptions, WidgetModel } from '../../models';
 import { type WidgetsOptions } from './types';
+/**
+ * Configuration data for a dashboard model.
+ *
+ * @internal
+ */
+export interface DashboardModelConfig {
+    /**
+     * Configuration for tabber widgets in the dashboard.
+     */
+    tabbers?: TabbersConfig;
+}
 /**
  * Model of Sisense Fusion dashboard defined in the abstractions of Compose SDK.
  *
@@ -51,11 +63,11 @@ export interface DashboardModel {
      */
     widgetsOptions: WidgetsOptions;
     /**
-     * Tabber configurations for the dashboard.
+     * Dashboard configuration.
      *
      * @internal
      */
-    tabbersOptions?: TabbersOptions;
+    config: DashboardModelConfig;
     /**
      * Dashboard settings.
      *

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

@@ -1,9 +1,10 @@
 import { Dimension, Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode, Measure } from '@sisense/sdk-data';
 import { RestApi } from '../../api/rest-api';
 import { JtdTarget, TriggerMethod } from '../../dashboard/hooks/jtd/jtd-types';
+import { TabbersConfig } from '../../dashboard/hooks/use-tabber';
 import { Panel, WidgetDto } from '../../widget-by-id/types';
 import { type CascadingFilterDto, DashboardDto, type FilterDto, type LayoutDto } from '../../api/types/dashboard-dto';
-import type { TabbersOptions, WidgetsOptions, WidgetsPanelColumnLayout } from './types';
+import type { WidgetsOptions, WidgetsPanelColumnLayout } from './types';
 export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
 export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
 export declare const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
@@ -19,7 +20,7 @@ export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetDto
     location: 'row' | 'column' | 'value';
 } | Measure, JtdTarget[]> | undefined;
 export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
-export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersOptions;
+export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersConfig;
 /**
  * Replace all shared formulas, which defined by id references, in the dashboard with their actual values.
  *

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

@@ -1,6 +1,6 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
 import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../dashboard/hooks/jtd/jtd-types';
-import { ColorPaletteTheme, TabberConfig } from '../../types';
+import { ColorPaletteTheme } from '../../types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
 /**
  * Part of Dashboard layout, which describes how widgets are arranged in a cell
@@ -81,15 +81,6 @@ export type WidgetsOptions = Record<WidgetId, {
      */
     jtdConfig?: JumpToDashboardConfig | JumpToDashboardConfigForPivot;
 }>;
-/**
- * Options for TabberWidets in a dashboard
- *
- * This property actually moves responsibility on the layout management from the tabber widgets to the dashboard,
- * storing all the tabbers configs in the single place
- *
- * @internal
- */
-export type TabbersOptions = Record<WidgetId, TabberConfig>;
 /**
  * Style options for the dashboard.
  */

package/dist/packages/sdk-ui/src/models/dashboard/use-dashboard-model/use-dasboard-model-utils.d.ts

@@ -1,14 +1,14 @@
 import { Authenticator } from '@sisense/sdk-rest-client';
-import { DashboardChangeAction } from '../../../dashboard/dashboard';
+import { DashboardChangeEvent } from '../../../dashboard/types';
 import { UseDashboardModelAction } from '../../../models';
 /**
- * Convert a dashboard change action to a use dashboard model action.
+ * Convert a dashboard change event to a use dashboard model action.
  *
- * @param action - The dashboard change action to convert
- * @returns The useDashboardModel action or null if the action is not supported
+ * @param event - The dashboard change event to convert
+ * @returns The useDashboardModel action or null if the event is not supported
  * @internal
  */
-export declare function dashboardChangeActionToUseDashboardModelAction(action: DashboardChangeAction): UseDashboardModelAction | null;
+export declare function dashboardChangeEventToUseDashboardModelAction(event: DashboardChangeEvent): UseDashboardModelAction | null;
 /**
  * Check if the persistence is supported and log a warning if it is not.
  *

package/dist/packages/sdk-ui/src/models/widget/widget-model-translator/index.d.ts

@@ -0,0 +1 @@
+export * from './widget-model-translator';

package/dist/packages/sdk-ui/src/models/widget/widget-model-translator/tabber.d.ts

@@ -0,0 +1,21 @@
+import { GenericDataOptions, TabberButtonsWidgetStyleOptions } from '../../../types.js';
+import { Panel, WidgetDto } from '../../../widget-by-id/types.js';
+/**
+ * Processes officially supported tabber custom widgets (WidgetsTabber).
+ * Pure function that creates data and style options for the TabberButtonsWidget.
+ * Maps from DTO widget type ('WidgetsTabber') to CSDK widget type ('tabber-buttons').
+ *
+ * @param params - Parameters for processing tabber widget
+ * @returns Object containing fusion type, custom type, data options, style options, and custom options
+ */
+export declare const processTabberWidget: (params: {
+    panels: Panel[];
+    widgetDto: WidgetDto;
+    variantColors: string[];
+}) => {
+    fusionWidgetType: 'custom';
+    customWidgetType: 'tabber-buttons';
+    dataOptions: GenericDataOptions;
+    styleOptions: TabberButtonsWidgetStyleOptions;
+    customOptions: Record<string, any>;
+};

package/dist/packages/sdk-ui/src/models/widget/{widget-model-translator.d.ts → widget-model-translator/widget-model-translator.d.ts}

@@ -1,10 +1,10 @@
 import { JaqlDataSourceForDto } from '@sisense/sdk-data';
-import { AppSettings } from '../../app/settings/settings.js';
-import { ChartProps, ChartWidgetProps, CommonWidgetProps, CustomWidgetProps, PivotTableProps, PivotTableWidgetProps, TableProps, TableWidgetProps, TextWidgetProps, WidgetProps } from '../../props';
-import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
-import { CompleteThemeSettings } from '../../types.js';
-import { WidgetDto } from '../../widget-by-id/types.js';
-import { WidgetModel } from './widget-model.js';
+import { AppSettings } from '../../../app/settings/settings.js';
+import { ChartProps, ChartWidgetProps, CommonWidgetProps, CustomWidgetProps, PivotTableProps, PivotTableWidgetProps, TableProps, TableWidgetProps, TextWidgetProps, WidgetProps } from '../../../props';
+import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../../query-execution';
+import { CompleteThemeSettings } from '../../../types.js';
+import { WidgetDto } from '../../../widget-by-id/types.js';
+import { WidgetModel } from '../widget-model.js';
 /**
  * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
  *
@@ -92,16 +92,16 @@ export declare function toChartWidgetProps(widgetModel: WidgetModel): ChartWidge
  */
 export declare function toTableWidgetProps(widgetModel: WidgetModel): TableWidgetProps;
 /**
- * Translates a {@link WidgetModel} to the props for rendering a pivot table widget.
- *
- * @example
- * ```tsx
- * <PivotTableWidget {...widgetModelTranslator.toPivotTableWidgetProps(widgetModel)} />
- * ```
+   * Translates a {@link WidgetModel} to the props for rendering a pivot table widget.
+   *
+   * @example
+   * ```tsx
+   * <PivotTableWidget {...widgetModelTranslator.toPivotTableWidgetProps(widgetModel)} />
+   * ```
 
- * Note: this method is not supported for chart or table widgets.
- * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
- */
+   * Note: this method is not supported for chart or table widgets.
+   * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
+   */
 export declare function toPivotTableWidgetProps(widgetModel: WidgetModel): PivotTableWidgetProps;
 /**
  * Translates a {@link WidgetModel} to the props for rendering a text widget.

package/dist/packages/sdk-ui/src/models/widget/widget-model.d.ts

@@ -48,6 +48,12 @@ export interface WidgetModel {
      * Widget style options.
      */
     styleOptions: WidgetStyleOptions;
+    /**
+     * Custom widget options. Only present for custom widgets.
+     *
+     * Contains widget-specific configuration that doesn't fit into standard style or data options.
+     */
+    customOptions?: Record<string, any>;
     /**
      * Widget filters.
      */

package/dist/packages/sdk-ui/src/pivot-table/hooks/use-render-pivot.d.ts

@@ -14,17 +14,23 @@ type PivotRenderOptions = {
     themeSettings: CompleteThemeSettings;
     /** The size of the pivot table container. */
     size: ContainerSize | null;
+    /** Allow html in pivot table cells */
+    allowHtml?: boolean;
     /** Callback to handle total height change. */
     onTotalHeightChange?: (totalHeight: number) => void;
     /** Callback to handle data point click. */
     onDataPointClick?: PivotTableDataPointEventHandler;
     /** Callback to handle data point context menu. */
     onDataPointContextMenu?: PivotTableDataPointEventHandler;
+    /** The page size */
+    pageSize: number;
+    /** Callback to handle page size. */
+    onPageSizeChange: (newPageSize: number) => void;
 };
 /**
  * A hook that renders the pivot table.
  */
-export declare function useRenderPivot({ pivotBuilder, dataOptions, styleOptions, themeSettings, size, onTotalHeightChange, onDataPointClick, onDataPointContextMenu, }: PivotRenderOptions): {
+export declare function useRenderPivot({ pivotBuilder, dataOptions, styleOptions, themeSettings, size, allowHtml, onTotalHeightChange, onDataPointClick, onDataPointContextMenu, pageSize, onPageSizeChange, }: PivotRenderOptions): {
     pivotElement: JSX.Element | null;
 };
 export {};

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

@@ -9,9 +9,10 @@ import { Hierarchy } from './models';
 import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from './pivot-table/formatters/types';
 import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
 import { ExecuteQueryResult } from './query-execution/types';
-import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, CustomDrilldownResult, CustomWidgetStyleOptions, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, GenericDataOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, SunburstStyleOptions, TabberStyleProps, TableStyleOptions, TableWidgetStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, TextWidgetStyleOptions, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
+import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, CustomDrilldownResult, CustomWidgetStyleOptions, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, GenericDataOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, SunburstStyleOptions, TableStyleOptions, TableWidgetStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, TextWidgetStyleOptions, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
 import { DistributiveOmit } from './utils/utility-types/distributive-omit';
 import { FiltersMergeStrategy } from './widget-by-id/types';
+export type { TabberButtonsWidgetProps } from './widgets/tabber/types';
 export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations and authentication for Sisense Context.
@@ -1419,6 +1420,12 @@ export interface CustomWidgetProps {
      * @category Widget
      */
     description?: string;
+    /**
+     * Specific options for the custom widget.
+     *
+     * @category Widget
+     */
+    customOptions?: Record<string, any>;
 }
 /**
  * A utility type that combines widget-specific properties (`BaseWidget`)
@@ -1721,25 +1728,6 @@ export interface DrilldownWidgetProps {
      */
     children: (customDrilldownResult: CustomDrilldownResult) => ReactNode;
 }
-/**
- * Tabber widget props designed to be a current state and is provided by use-tabber hook
- *
- * @internal
- */
-export type TabberWidgetExtraProps = {
-    onTabSelected: (tab: number) => void;
-    selectedTab: number;
-};
-/**
- * Tabber widget props
- *
- * @internal
- */
-export type TabberWidgetProps = {
-    styleOptions?: TabberStyleProps;
-    description?: string;
-    width?: string;
-} & TabberWidgetExtraProps;
 /**
  * Params of the {@link useGetSharedFormula} hook
  *

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

@@ -370,6 +370,8 @@ export declare const translation: {
             viewMode: string;
             showFilters: string;
             hideFilters: string;
+            columns: string;
+            column: string;
         };
     };
     jumpToDashboard: {

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

@@ -380,6 +380,8 @@ export declare const resources: {
                 viewMode: string;
                 showFilters: string;
                 hideFilters: string;
+                columns: string;
+                column: string;
             };
         };
         jumpToDashboard: {
@@ -770,6 +772,8 @@ export declare const resources: {
                 viewMode: string;
                 showFilters: string;
                 hideFilters: string;
+                columns: string;
+                column: string;
             };
         };
         jumpToDashboard: {