@sisense/sdk-ui 2.1.1 → 2.3.0

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

@@ -1,11 +1,9 @@
 /// <reference types="react" />
-import type { PivotBuilder } from '@sisense/sdk-pivot-client';
+import { type PivotBuilder } from '@sisense/sdk-pivot-client';
 import type { CompleteThemeSettings, PivotTableStyleOptions } from '../../types';
 import type { PivotTableDataOptions } from '../../chart-data-options/types';
 import type { ContainerSize } from '../../dynamic-size-container/dynamic-size-container';
 type PivotRenderOptions = {
-    /** Reference to the pivot table container. */
-    nodeRef: React.RefObject<HTMLDivElement>;
     /** The pivot builder instance. */
     pivotBuilder: PivotBuilder;
     /** The pivot table data options. */
@@ -22,5 +20,7 @@ type PivotRenderOptions = {
 /**
  * A hook that renders the pivot table.
  */
-export declare function useRenderPivot({ nodeRef, pivotBuilder, dataOptions, styleOptions, themeSettings, size, onTotalHeightChange, }: PivotRenderOptions): void;
+export declare function useRenderPivot({ pivotBuilder, dataOptions, styleOptions, themeSettings, size, onTotalHeightChange, }: PivotRenderOptions): {
+    pivotElement: JSX.Element | null;
+};
 export {};

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

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { DataSource, Filter } from '@sisense/sdk-data';
+import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import { GenericDataOptions } from '../types';
 /**
  * Props passed to a user-defined widget component.
@@ -10,7 +10,7 @@ export interface PluginComponentProps<DataOptions = GenericDataOptions, StyleOpt
     dataSource?: DataSource;
     dataOptions: DataOptions;
     styleOptions: StyleOptions;
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     highlights?: Filter[];
     description?: string;
 }

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

@@ -1,5 +1,5 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps, PluginWidgetStyleOptions } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
@@ -86,6 +86,9 @@ export interface SisenseContextProviderProps {
     /**
      * Callback function that is triggered when an error occurs within the Sisense context.
      *
+     * Return React node to render a custom error UI.
+     * Return `undefined` to use the default error UI.
+     *
      * This callback is useful for handling errors that happen during the initialization or runtime of the Sisense context,
      * such as incorrect configuration, invalid authentication, or network-related issues.
      *
@@ -100,7 +103,7 @@ export interface SisenseContextProviderProps {
         componentName: string;
         /** The props of the component that caused the error. */
         componentProps: unknown;
-    }) => void;
+    }) => void | ReactNode;
     /**
      * Boolean flag to enable sending silent pre-authentication requests to the Sisense instance.
      * Used to check if user is already authenticated, check is performed in an ivisible iframe.
@@ -1179,7 +1182,7 @@ export interface PluginWidgetProps {
      *
      * @category Data
      */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelations;
     /**
      * Filters that will highlight query results
      *
@@ -1197,7 +1200,7 @@ export interface PluginWidgetProps {
      *
      * @category Widget
      */
-    styleOptions?: unknown;
+    styleOptions?: PluginWidgetStyleOptions;
     /**
      * Title of the widget
      *

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

@@ -49,6 +49,7 @@ export declare const translation: {
         invalidFilterType: string;
         secondsDateTimeLevelSupportedOnlyForLive: string;
         missingMenuRoot: string;
+        missingModalRoot: string;
         missingDataSource: string;
         incorrectOnDataReadyHandler: string;
         undefinedDataSource: string;
@@ -68,9 +69,11 @@ export declare const translation: {
         mapLoadingFailed: string;
         cascadingFilterOriginalNotFound: string;
         dashboardLoadFailed: string;
+        widgetLoadFailed: string;
         dashboardWithOidNotFound: string;
         failedToAddWidget: string;
         widgetWithOidNotFound: string;
+        widgetWithOidNotFoundInDashboard: string;
         widgetEmptyResponse: string;
         dateFilterIncorrectOperator: string;
         synchronizedFilterInvalidProps: string;
@@ -87,6 +90,7 @@ export declare const translation: {
         addFilterPopover: {
             noDataSources: string;
         };
+        tabberInvalidConfiguration: string;
     };
     errorBoxText: string;
     chartNoData: string;
@@ -352,6 +356,18 @@ export declare const translation: {
         grandTotal: string;
         subTotal: string;
     };
+    dashboard: {
+        toolbar: {
+            undo: string;
+            redo: string;
+            cancel: string;
+            apply: string;
+            editLayout: string;
+        };
+    };
+    jumpToDashboard: {
+        defaultCaption: string;
+    };
 };
 /**
  * A reference type containing all currently used translation keys.

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

@@ -59,6 +59,7 @@ export declare const resources: {
             invalidFilterType: string;
             secondsDateTimeLevelSupportedOnlyForLive: string;
             missingMenuRoot: string;
+            missingModalRoot: string;
             missingDataSource: string;
             incorrectOnDataReadyHandler: string;
             undefinedDataSource: string;
@@ -78,9 +79,11 @@ export declare const resources: {
             mapLoadingFailed: string;
             cascadingFilterOriginalNotFound: string;
             dashboardLoadFailed: string;
+            widgetLoadFailed: string;
             dashboardWithOidNotFound: string;
             failedToAddWidget: string;
             widgetWithOidNotFound: string;
+            widgetWithOidNotFoundInDashboard: string;
             widgetEmptyResponse: string;
             dateFilterIncorrectOperator: string;
             synchronizedFilterInvalidProps: string;
@@ -97,6 +100,7 @@ export declare const resources: {
             addFilterPopover: {
                 noDataSources: string;
             };
+            tabberInvalidConfiguration: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -362,6 +366,18 @@ export declare const resources: {
             grandTotal: string;
             subTotal: string;
         };
+        dashboard: {
+            toolbar: {
+                undo: string;
+                redo: string;
+                cancel: string;
+                apply: string;
+                editLayout: string;
+            };
+        };
+        jumpToDashboard: {
+            defaultCaption: string;
+        };
     };
     uk: {
         errors: {
@@ -414,6 +430,7 @@ export declare const resources: {
             invalidFilterType: string;
             secondsDateTimeLevelSupportedOnlyForLive: string;
             missingMenuRoot: string;
+            missingModalRoot: string;
             missingDataSource: string;
             incorrectOnDataReadyHandler: string;
             undefinedDataSource: string;
@@ -433,9 +450,11 @@ export declare const resources: {
             mapLoadingFailed: string;
             cascadingFilterOriginalNotFound: string;
             dashboardLoadFailed: string;
+            widgetLoadFailed: string;
             dashboardWithOidNotFound: string;
             failedToAddWidget: string;
             widgetWithOidNotFound: string;
+            widgetWithOidNotFoundInDashboard: string;
             widgetEmptyResponse: string;
             dateFilterIncorrectOperator: string;
             synchronizedFilterInvalidProps: string;
@@ -452,6 +471,7 @@ export declare const resources: {
             addFilterPopover: {
                 noDataSources: string;
             };
+            tabberInvalidConfiguration: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -717,5 +737,17 @@ export declare const resources: {
             grandTotal: string;
             subTotal: string;
         };
+        dashboard: {
+            toolbar: {
+                undo: string;
+                redo: string;
+                cancel: string;
+                apply: string;
+                editLayout: string;
+            };
+        };
+        jumpToDashboard: {
+            defaultCaption: string;
+        };
     };
 };

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

@@ -17,6 +17,14 @@ import { SoftUnion } from './utils/utility-types';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
+/**
+ * @internal
+ * Enum for size measurement units
+ */
+export declare enum SizeMeasurement {
+    PERCENT = "%",
+    PIXEL = "px"
+}
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
 export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, TableChartType, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, };
@@ -249,6 +257,17 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
     lineWidth?: LineWidth;
     /** Subtype of LineChart */
     subtype?: LineSubtype;
+    /**
+     * For step charts: defines where the step occurs (before, between, or after points)
+     * Only used when subtype is 'line/step'
+     *
+     * **Values**
+     *
+     * - `left` - step occurs before the point (default)
+     * - `center` - step occurs between points
+     * - `right` - step occurs after the point
+     */
+    stepPosition?: 'left' | 'center' | 'right';
 }
 /** Configuration options that define functional style of the various elements of AreaRangeChart */
 export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
@@ -1145,7 +1164,7 @@ export type CompleteThemeSettings = DeepRequired<Omit<ThemeSettings, 'typography
     };
 };
 /** Complete set of configuration options that define functional style of the various elements of the charts as well as the look and feel of widget itself and widget header. */
-export type WidgetStyleOptions = (ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions) & WidgetContainerStyleOptions;
+export type WidgetStyleOptions = (ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions | PluginWidgetStyleOptions) & WidgetContainerStyleOptions;
 /** Style settings defining the look and feel of widget itself and widget header */
 export interface WidgetContainerStyleOptions {
     /** Space between widget container edge and the chart */
@@ -1243,6 +1262,10 @@ export type TextWidgetStyleOptions = {
     vAlign: `valign-${'middle' | 'top' | 'bottom'}`;
     bgColor: string;
 };
+/**
+ * Style settings defining the look and feel of PluginWidget
+ */
+export type PluginWidgetStyleOptions = Record<string, unknown> & WidgetContainerStyleOptions;
 /**
  * Runs type guard check for ThemeOid.
  *
@@ -1692,8 +1715,8 @@ export type TabberTab = {
  *
  * @internal
  */
-export type TabberDtoStyle = TabberStyleProps & {
-    activeTab: string;
+export type TabberDtoStyle = Partial<TabberStyleProps> & {
+    activeTab?: string;
 };
 /**
  * Configuration options that define style of the various elements of the Tabber component.

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

@@ -23,10 +23,10 @@ export declare function getFilterRelationsDescription(relations: FilterRelations
 /**
  * Merge two arrays of filters using the specified merge strategy.
  *
- * @param {Filter[]} widgetFilters - The filters from the widget.
- * @param {Filter[]} codeFilters - The filters from the code.
- * @param {FiltersMergeStrategy} [mergeStrategy] - The strategy to use for merging filters.
- * @returns {Filter[]} The merged filters based on the selected strategy.
+ * @param widgetFilters - The filters from the widget.
+ * @param codeFilters - The filters from the code.
+ * @param mergeStrategy - The strategy to use for merging filters.
+ * @returns The merged filters based on the selected strategy.
  * @internal
  */
 export declare function mergeFiltersByStrategy(widgetFilters?: Filter[] | FilterRelations, codeFilters?: Filter[] | FilterRelations, mergeStrategy?: FiltersMergeStrategy): Filter[] | FilterRelations;

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

@@ -2,6 +2,7 @@ import { WidgetContainerStyleOptions } from '../types';
 import { LEGACY_DESIGN_TYPES } from '../themes/legacy-design-settings';
 import { BaseJaql, FormulaContext, FormulaJaql, Jaql, JaqlDataSource, JaqlSortDirection } from '@sisense/sdk-data';
 import { HierarchyId } from '../models/hierarchy';
+import { SizeMeasurement } from '../types';
 /**
  * The type of a widget on a dashboard that is a variant of Cartesian widget.
  */
@@ -46,6 +47,7 @@ export interface WidgetDto {
         drillHistory?: PanelItem[];
         usedFormulasMapping?: any;
     };
+    drillToDashboardConfig?: JTDConfigDto;
     style: WidgetStyle;
     title: string;
     desc: string | null;
@@ -512,4 +514,74 @@ export type TextWidgetDtoStyle = {
         textAlign: 'center';
     };
 };
+export type JTDDrillTarget = {
+    caption: string;
+    id: string;
+};
+export type JTDConfigDto = {
+    drilledDashboardPrefix: string;
+    drilledDashboardsFolderPrefix: string;
+    displayFilterPane: boolean;
+    displayDashboardsPane: boolean;
+    displayToolbarRow: boolean;
+    displayHeaderRow: boolean;
+    volatile: boolean;
+    hideDrilledDashboards: boolean;
+    hideSharedDashboardsForNonOwner: boolean;
+    drillToDashboardRightMenuCaption: string;
+    drillToDashboardNavigateType: number;
+    drillToDashboardNavigateTypePivot: number;
+    drillToDashboardNavigateTypeCharts: number;
+    drillToDashboardNavigateTypeOthers: number;
+    drilledDashboardDisplayType: number;
+    dashboardIds: Array<{
+        oid: string;
+        caption: string;
+        id: string;
+        dashboardTitle: string;
+    }>;
+    modalWindowResize: boolean;
+    modalWindowMeasurement?: SizeMeasurement;
+    modalWindowWidth?: number;
+    modalWindowHeight?: number;
+    showFolderNameOnMenuSelection: boolean;
+    resetDashFiltersAfterJTD: boolean;
+    sameCubeRestriction: boolean;
+    showJTDIcon: boolean;
+    sendPieChartMeasureFiltersOnClick: boolean;
+    forceZeroInsteadNull: boolean;
+    mergeTargetDashboardFilters: boolean;
+    drillToDashboardByName: boolean;
+    sendBreakByValueFilter: boolean;
+    ignoreFiltersSource: boolean;
+    sendFormulaFiltersDuplicate?: number | 'none' | undefined;
+    enabled?: boolean;
+    version?: string;
+    includeDashFilterDims?: string[];
+    includeWidgetFilterDims?: string[];
+};
+export declare enum JTDNavigateType {
+    CLICK = "click",
+    RIGHT_CLICK = "rightclick",
+    PIVOT_LINK = "pivotlink",
+    BLOX = "blox"
+}
+export type JTDConfig = {
+    drilledDashboardPrefix?: string;
+    displayFilterPane?: boolean;
+    displayToolbarRow?: boolean;
+    drillToDashboardRightMenuCaption?: string;
+    navigateType?: JTDNavigateType;
+    includeDashFilterDims?: string[];
+    includeWidgetFilterDims?: string[];
+    drillTargets: JTDDrillTarget[];
+    modalWindowResize?: boolean;
+    modalWindowMeasurement?: SizeMeasurement;
+    modalWindowWidth?: number;
+    modalWindowHeight?: number;
+    showJTDIcon?: boolean;
+    mergeTargetDashboardFilters?: boolean;
+    sendFormulaFiltersDuplicate?: number | 'none' | undefined;
+    enabled?: boolean;
+};
 export {};

package/dist/packages/sdk-ui/src/widgets/common/drilldown-breadcrumbs/styled-buttons.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="react" />
 export declare const StyledPrevButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+}, "loading" | "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;
 export declare const StyledNextButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+}, "loading" | "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;

package/dist/packages/sdk-ui/src/widgets/tabber-widget.d.ts

@@ -1,3 +1,4 @@
+import React from 'react';
 import { TabberWidgetProps } from '../props';
 /**
  * Tabber widget tab size
@@ -37,4 +38,4 @@ export type TabCornerRadius = 'SMALL' | 'MEDIUM' | 'LARGE' | 'NONE';
  * @group TabberWidget
  * @internal
  */
-export declare const TabberWidget: ({ styleOptions, description, ...props }: TabberWidgetProps) => import("react/jsx-runtime").JSX.Element;
+export declare const TabberWidget: React.FunctionComponent<TabberWidgetProps>;