@sisense/sdk-ui 1.34.0 → 2.1.0

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

@@ -13,6 +13,7 @@ import { HighchartsOptionsInternal } from './chart-options-processor/chart-optio
 import { CSSProperties } from 'react';
 import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
 import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
+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';
@@ -320,24 +321,6 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
 };
 /** Configuration options that define functional style of the various elements of the Table Component */
 export interface TableStyleOptions {
-    /**
-     * Boolean flag whether to fill header cells with background color
-     *
-     * @deprecated Use {@link TableStyleOptions#header | TableStyleOptions.header.color} instead.
-     */
-    headersColor?: boolean;
-    /**
-     * Boolean flag whether to apply background color to alternate rows.
-     *
-     * @deprecated Use {@link TableStyleOptions#rows | TableStyleOptions.rows.alternatingColor} instead.
-     */
-    alternatingRowsColor?: boolean;
-    /**
-     * Boolean flag whether to apply background color to alternate columns
-     *
-     * @deprecated Use {@link TableStyleOptions#columns | TableStyleOptions.columns.alternatingColor} instead.
-     */
-    alternatingColumnsColor?: boolean;
     /**
      * Vertical padding around whole table
      * Default value is 20px
@@ -668,12 +651,6 @@ export interface ChartThemeSettings {
     secondaryTextColor?: string;
     /** Background color */
     backgroundColor?: string;
-    /**
-     * Toolbar Background color, can be used as a secondary background color
-     *
-     * @deprecated
-     */
-    panelBackgroundColor?: string;
     /** Animation options */
     animation?: {
         /** Chart initialization animation options */
@@ -948,6 +925,8 @@ export type WidgetThemeSettings = {
         titleTextColor?: string;
         /** Header title alignment */
         titleAlignment?: AlignmentTypes;
+        /** Header title font size */
+        titleFontSize?: number;
         /** Toggle of the divider line between widget header and chart */
         dividerLine?: boolean;
         /** Divider line color */
@@ -1229,13 +1208,6 @@ export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
      */
     height?: number;
 }
-/**
- * Style settings defining the look and feel of DashboardWidget
- *
- * @deprecated Use {@link WidgetByIdStyleOptions} instead
- */
-export interface DashboardWidgetStyleOptions extends WidgetByIdStyleOptions {
-}
 /** Style settings defining the look and feel of ChartWidget */
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
@@ -1272,12 +1244,6 @@ export declare type ColorPaletteTheme = {
 };
 /** Configuration for the drilldown */
 export type DrilldownOptions = {
-    /**
-     * Dimensions that can be used for drilldown
-     *
-     * @deprecated Use {@link DrilldownOptions.drilldownPaths} instead
-     */
-    drilldownDimensions?: Attribute[];
     /**
      * Dimensions and hierarchies available for drilldown on.
      */
@@ -1653,6 +1619,51 @@ export type CustomTranslationObject = {
      */
     namespace?: string;
 };
+/**
+ * Translation Configuration
+ */
+export type TranslationConfig = {
+    /**
+     * Language code to be used for translations.
+     */
+    language?: string;
+    /**
+     * Additional translation resources to be loaded.
+     *
+     * You can find the list of available translation keys in the translation folder of every package.
+     *
+     * Translation keys that are not provided will default to the English translation.
+     * If translation is provided for a package other than sdk-ui, please specify the namespace property.
+     *
+     * Important: Do not translate parts in {{}} - these are placeholders for dynamic values and will be matched using provided variable names.
+     *
+     * @example
+     * ```ts
+     * customTranslations: [
+     *   {
+     *     language: 'fr',
+     *     resources: {
+     *       errors: {
+     *        invalidFilterType: 'Type de filtre invalide',
+     *       },
+     *     },
+     *   },
+     *   {
+     *     language: 'es',
+     *     namespace: 'sdkData'
+     *     resources: {
+     *       errors: {
+     *         measure: {
+     *           unsupportedType: 'Tipo de medida no compatible',
+     *         },
+     *       },
+     *     },
+     *   },
+     * ]
+     * ```
+     */
+    customTranslations?: CustomTranslationObject[];
+};
 /**
  * Single Tabber Widget tab object without styling
  *
@@ -1707,10 +1718,8 @@ export type TabberConfig = {
     activeTab: number;
 };
 /** @internal */
-export type CustomContextProviderProps<P> = {
+export type CustomContextProviderProps<P> = SoftUnion<{
     context: P;
-    error?: undefined;
 } | {
-    context?: undefined;
     error: Error;
-};
+}>;

package/dist/packages/sdk-ui/src/utils/get-scrollbar-width.d.ts

@@ -0,0 +1 @@
+export declare const getScrollbarWidth: () => number;

package/dist/packages/sdk-ui/src/utils/{utility-types.d.ts → utility-types/basic-utility-types.d.ts}

@@ -61,38 +61,4 @@ export type AnyArray = any[];
  * type TRequiredB = WithRequiredProp<T, 'b'>; // { a: string; b: number; c?: boolean; }
  */
 export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-/**
- * Universal generic state for hooks that fetch data from the REST API.
- */
-export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
-/** Success state of the REST API hook */
-export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
-    isLoading: false;
-    isError: false;
-    isSuccess: true;
-    error: undefined;
-    status: 'success';
-} & {
-    [key in DataKey]: SuccessDataType;
-};
-/** Error state of the REST API hook */
-export type RestApiHookErrorState<DataKey extends string> = {
-    isLoading: false;
-    isError: true;
-    isSuccess: false;
-    error: Error;
-    status: 'error';
-} & {
-    [key in DataKey]: undefined;
-};
-/** Loading state of the REST API hook */
-export type RestApiHookLoadingState<DataKey extends string> = {
-    isLoading: true;
-    isError: false;
-    isSuccess: false;
-    error: undefined;
-    status: 'loading';
-} & {
-    [key in DataKey]: undefined;
-};
 export {};

package/dist/packages/sdk-ui/src/utils/utility-types/distributive-omit.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Utility type that applies `Omit` distributively over a union of types.
+ *
+ * In TypeScript, applying `Omit` directly to a union type causes the keys to be removed
+ * from the union "as a whole", resulting in unintended behavior. This type fixes that by
+ * distributing `Omit` to each member of the union individually.
+ *
+ * @template T The union of types to apply the omit to.
+ * @template K The keys to omit from each type in the union.
+ *
+ * @example
+ * type A = { type: 'a'; foo: string };
+ * type B = { type: 'b'; bar: number };
+ * type U = A | B;
+ *
+ * // Without distributive omit:
+ * type Broken = Omit<U, 'type'>;
+ * // Result: { foo?: string; bar?: number } - not a union anymore
+ *
+ * // With distributive omit:
+ * type Fixed = DistributiveOmit<U, 'type'>;
+ * // Result: { foo: string } | { bar: number } - still a union
+ */
+export type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : never;

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

@@ -0,0 +1,4 @@
+export * from './basic-utility-types';
+export * from './rest-api-hook-state';
+export * from './soft-union';
+export * from './distributive-omit';

package/dist/packages/sdk-ui/src/utils/utility-types/rest-api-hook-state.d.ts

@@ -0,0 +1,35 @@
+import { AnyArray, AnyObject } from './basic-utility-types';
+/**
+ * Universal generic state for hooks that fetch data from the REST API.
+ */
+export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
+/** Success state of the REST API hook */
+export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
+    isLoading: false;
+    isError: false;
+    isSuccess: true;
+    error: undefined;
+    status: 'success';
+} & {
+    [key in DataKey]: SuccessDataType;
+};
+/** Error state of the REST API hook */
+export type RestApiHookErrorState<DataKey extends string> = {
+    isLoading: false;
+    isError: true;
+    isSuccess: false;
+    error: Error;
+    status: 'error';
+} & {
+    [key in DataKey]: undefined;
+};
+/** Loading state of the REST API hook */
+export type RestApiHookLoadingState<DataKey extends string> = {
+    isLoading: true;
+    isError: false;
+    isSuccess: false;
+    error: undefined;
+    status: 'loading';
+} & {
+    [key in DataKey]: undefined;
+};

package/dist/packages/sdk-ui/src/utils/utility-types/soft-union.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Gets all unique keys from a union of object types.
+ *
+ * @template T - The union of object types.
+ * @returns A union of all keys present in the types in `T`.
+ *
+ * @example
+ * type Type1 = { a: number; b: string };
+ * type Type2 = { b: string; c?: boolean };
+ * type AllKeys = KeysOfUnion<Type1 | Type2>; // Evaluates to "a" | "b" | "c"
+ */
+type KeysOfUnion<T> = T extends unknown ? keyof T : never;
+/**
+ * Creates a "soft union" type from a union of object types. A soft union
+ * combines the properties of all types in the union, making properties
+ * optional with `undefined` if they are not present in a specific type
+ * within the union.
+ *
+ * @template T - The union of object types.
+ * @returns A type that represents the soft union of the types in `T`.
+ * Each constituent type in the union `T` is augmented with the missing
+ * properties from other types in `T`, typed as optional `undefined`.
+ *
+ * @example
+ * type Type1 = { bar: string };
+ * type Type2 = { agg: number };
+ * type SoftUnionType = SoftUnion<Type1 | Type2>;
+ * // Evaluates to:
+ * // | { bar: string; agg?: undefined }
+ * // | { bar?: undefined; agg: number; }
+ *
+ * @internal
+ */
+export type SoftUnion<T, K extends PropertyKey = KeysOfUnion<T>> = T extends unknown ? T & Partial<Record<Exclude<K, keyof T>, undefined>> : never;
+export {};

package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts

@@ -4785,13 +4785,6 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
         sort?: "desc" | "asc" | undefined;
         in?: {
             selected?: {
-                /**
-                 * Checks if a highlight filter is applicable to a widget.
-                 *
-                 * @param {FilterDto} filter - The filter to be checked.
-                 * @param {WidgetDto} widget - The widget that filters are applied to.
-                 * @returns {boolean} `true` if the filter is applicable; otherwise, `false`.
-                 */
                 jaql: import("@sisense/sdk-data").FilterJaql;
             } | undefined;
         } | undefined;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts

@@ -1,6 +1,6 @@
 import { JaqlDataSource } from '@sisense/sdk-data';
 import { StyledMeasureColumn, StyledColumn, Color } from '../types.js';
-import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
+import { Panel, PanelItem, FusionWidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
 import { WidgetDataOptions } from '../models/index.js';
 /** @internal */
 export declare function applyStatisticalModels(dataOption: StyledMeasureColumn, statisticalModels?: {
@@ -38,4 +38,4 @@ export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr"
  * This is to support multi-source dashboards.
  */
 export declare function attachDataSourceToPanels(panels: Panel[], dataSource: JaqlDataSource): Panel[];
-export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;
+export declare function extractDataOptions(fusionWidgetType: FusionWidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-drilldown-options.d.ts

@@ -1,3 +1,3 @@
-import { Panel, PanelItem, WidgetType } from './types.js';
+import { Panel, PanelItem, FusionWidgetType } from './types.js';
 import { DrilldownOptions } from '../types.js';
-export declare const extractDrilldownOptions: (widgetType: WidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;
+export declare const extractDrilldownOptions: (widgetType: FusionWidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts

@@ -1,9 +1,9 @@
 import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetStyleOptions, TextWidgetStyleOptions } from '../types';
-import { WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
+import { WidgetSubtype, FusionWidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
-export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
+export declare function extractStyleOptions<WType extends FusionWidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
 export declare const getFlattenWidgetDesign: (widgetDesign: WidgetDesign) => {
     backgroundColor: string;
     spaceAround: SpaceSizes;

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

@@ -21,7 +21,7 @@ export type TextWidgetType = 'richtexteditor';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
+export type FusionWidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa' | 'richtexteditor';
 export declare enum WidgetDashboardFilterMode {
     FILTER = "filter",
@@ -37,7 +37,7 @@ export declare enum WidgetDashboardFilterMode {
  */
 export interface WidgetDto {
     oid: string;
-    type: WidgetType | string;
+    type: FusionWidgetType;
     subtype: WidgetSubtype | string;
     datasource: JaqlDataSource;
     metadata: {

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

@@ -1,25 +1,32 @@
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options.js';
-import { ChartType } from '../types.js';
-import { Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types.js';
-import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '../index.js';
+import { ChartType, RenderToolbarHandler } from '../types.js';
+import { Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, FusionWidgetType } from './types.js';
+import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, TextWidgetProps, CommonWidgetProps, WithCommonWidgetProps, WidgetProps, WidgetType } from '../props';
 import { WidgetTypeInternal } from '../models/widget/types';
+import { WidgetModel } from '../models';
 export { mergeFilters, getFilterRelationsFromJaql, convertFilterRelationsModelToJaql, getFilterCompareId, } from '@sisense/sdk-data';
 /**
  * Returns the corresponding chart type for a given widget type
  *
  * @internal
  */
-export declare function getChartType(widgetType: WidgetType): ChartType;
-export declare function getWidgetTypeFromChartType(chartType: ChartType): WidgetType;
+export declare function getChartType(fusionWidgetType: FusionWidgetType): ChartType;
+export declare function getFusionWidgetTypeFromChartType(chartType: ChartType): FusionWidgetType;
+export declare function getFusionWidgetType(widgetType: WidgetType, chartType?: ChartType): FusionWidgetType;
+export declare function getWidgetType(fusionWidgetType: FusionWidgetType): WidgetType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
-type WidgetTypeOrString = string | WidgetType;
-export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
-export declare function isTableWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isPivotTableWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isTextWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isSupportedWidgetType(fusionWidgetType: FusionWidgetType): fusionWidgetType is FusionWidgetType;
+export declare function isTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isTableWidgetModel(widgetModel: WidgetModel): boolean;
+export declare function isPivotTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isPivotWidget(widgetType: WidgetType): boolean;
+export declare function isTextFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isTextWidget(widgetType: WidgetType): boolean;
 export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetStyle is TextWidgetDtoStyle;
-export declare function isPluginWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isPluginFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isPluginWidget(widgetType: WidgetType): boolean;
+export declare function isChartFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isChartWidget(widgetType: WidgetType): boolean;
 /**
  * Type guard for checking if the widget props is for a text widget.
  *
@@ -27,7 +34,7 @@ export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
  * @returns whether the widget props is for a text widget
  * @internal
  */
-export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<TextWidgetProps, 'text'>;
+export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<TextWidgetProps, 'text'>;
 /**
  * Type guard for checking if the widget props is for a pivot table widget.
  *
@@ -35,7 +42,7 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
  * @returns whether the widget props is for a pivot table widget
  * @internal
  */
-export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PivotTableWidgetProps, 'pivot'>;
+export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'>;
 /**
  * Type guard for checking if the widget props is for a plugin widget
  *
@@ -43,7 +50,7 @@ export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps):
  * @returns whether the widget props is for a plugin widget
  * @internal
  */
-export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PluginWidgetProps, 'plugin'>;
+export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
 /**
  * Type guard for checking if the widget props is for a chart widget
  *
@@ -51,7 +58,7 @@ export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): wid
  * @returns whether the widget props is for a chart widget
  * @internal
  */
-export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<ChartWidgetProps, 'chart'>;
+export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<ChartWidgetProps, 'chart'>;
 export declare function getInternalWidgetType(widgetProps: CommonWidgetProps): WidgetTypeInternal;
 /**
  * Registers new "onDataPointClick" handler for the Widget component

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

@@ -0,0 +1 @@
+export declare const DEFAULT_WIDGET_HEADER_HEIGHT = 32;

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

@@ -4,6 +4,5 @@ import { WidgetProps } from '..';
  * Facade component that renders a widget within a dashboard based on the widget type.
  *
  * @group Dashboards
- * @alpha
  */
 export declare const Widget: React.FC<WidgetProps>;