@sisense/sdk-ui 1.18.0 → 1.19.0

package/dist/models/widget/widget-model.d.ts

@@ -1,14 +1,15 @@
 import { Filter } from '@sisense/sdk-data';
 import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
 import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
-import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
+import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
 import { ChartType, DrilldownOptions, CompleteThemeSettings, RenderToolbarHandler, WidgetStyleOptions } from '../../types';
 import { AppSettings } from '../../app/settings/settings';
+import { EmptyObject } from '../../utils/utility-types';
 /**
  * Widget data options.
  */
-export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions;
+export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions | EmptyObject;
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
  *
@@ -188,6 +189,21 @@ export declare class WidgetModel {
      * @internal
      */
     getPivotTableWidgetProps(): PivotTableWidgetProps;
+    /**
+     * Returns the props to be used for rendering a text widget.
+     *
+     * @example
+     * ```tsx
+     * <TextWidget {...widget.getTextWidgetProps()} />
+     * ```
+     *
+     * Note: this method is not supported for chart, table, or pivot widgets.
+     * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
+     * Use {@link getTableWidgetProps} instead for getting props for the <TableWidget> component.
+     * Use {@link getPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
+     *
+     */
+    getTextWidgetProps(): TextWidgetProps;
     /**
      * Registers new "onDataPointClick" handler for the constructed component
      *

package/dist/plugins-provider/custom-plugins-provider.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+import { WidgetPlugin } from './types';
+/** @internal */
+export type CustomPluginsProviderProps = {
+    context: CustomPluginsContext;
+    error?: Error;
+};
+/** @internal */
+export type CustomPluginsContext = {
+    pluginMap: Map<string, WidgetPlugin>;
+    registerPlugin: (pluginType: string, plugin: WidgetPlugin) => void;
+    getPlugin: (pluginType: string) => WidgetPlugin | undefined;
+};
+/**
+ * Custom Plugin Provider component that allows passing external plugins context.
+ *
+ * Note: it is designed to serve as a bridge for passing pre-initialized plugin data between an external wrapper and child React components.
+ *
+ * @internal
+ */
+export declare const CustomPluginsProvider: React.FC<{
+    context: CustomPluginsContext;
+    children: ReactNode;
+}>;

package/dist/plugins-provider/index.d.ts

@@ -0,0 +1,2 @@
+export * from './plugins-provider';
+export * from './plugins-context';

package/dist/plugins-provider/plugins-context.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { WidgetPlugin } from './types';
+type PluginsContextType = {
+    plugins: Map<string, WidgetPlugin>;
+    registerPlugin: (pluginType: string, plugin: WidgetPlugin) => void;
+    getPlugin: (pluginType: string) => WidgetPlugin | undefined;
+};
+export declare const PluginsContext: import("react").Context<PluginsContextType>;
+export {};

package/dist/plugins-provider/plugins-provider.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { WidgetPlugin } from './types';
+/**
+ * Plugin Provider component that allows registering and accessing plugins.
+ *
+ * @internal
+ */
+export declare const PluginsProvider: React.FC<{
+    children: ReactNode;
+}>;
+export declare const usePlugins: () => {
+    plugins: Map<string, WidgetPlugin>;
+    registerPlugin: (pluginType: string, plugin: WidgetPlugin) => void;
+    getPlugin: (pluginType: string) => WidgetPlugin | undefined;
+};

package/dist/plugins-provider/types.d.ts

@@ -0,0 +1,8 @@
+import { WidgetModel } from '../models';
+import { CompleteThemeSettings } from '../types';
+/** @internal */
+export type WidgetPlugin<P = {}> = {
+    name: string;
+    component: (props: any) => any;
+    createChartProps(w: WidgetModel, themeSettings: CompleteThemeSettings): P;
+};

package/dist/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, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection } 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, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions } 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';
@@ -1361,3 +1361,12 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
      */
     dataSource?: DataSource;
 }
+/**
+ * Props for the TextWidget component.
+ */
+export type TextWidgetProps = {
+    /**
+     * Style options for the text widget.
+     */
+    styleOptions: TextWidgetStyleOptions;
+};

package/dist/sisense-chart/types.d.ts

@@ -1,5 +1,4 @@
-import { DataPointsEventHandler, ScatterDataPointsEventHandler } from '../props.js';
 import { BoxplotDataPoint, DataPoint, ScatterDataPoint } from '../types.js';
-export type SisenseChartDataPointsEventHandler = DataPointsEventHandler | ScatterDataPointsEventHandler;
+export type SisenseChartDataPointsEventHandler = (points: SisenseChartDataPoint[], nativeEvent: MouseEvent) => void;
 export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
 export type SisenseChartDataPointEventHandler = (point: SisenseChartDataPoint, nativeEvent: PointerEvent) => void;

package/dist/theme-provider/fonts-loader/fonts-loader.d.ts

@@ -0,0 +1,5 @@
+import { ThemeSettingsFont } from '../../types';
+export declare const FontsLoader: ({ fonts, children, }: {
+    fonts?: ThemeSettingsFont[] | undefined;
+    children?: any;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/theme-provider/fonts-loader/use-fonts-loader.d.ts

@@ -0,0 +1,2 @@
+import { ThemeSettingsFont } from '../../types';
+export declare const useFontsLoader: (fonts: ThemeSettingsFont[], prevLoadedFonts: string[]) => string[];

package/dist/themes/legacy-design-settings.d.ts

@@ -94,5 +94,5 @@ export declare const LEGACY_DESIGN_TYPES: {
  * @param legacyPalette - legacy palette object.
  * @returns
  */
-export declare function convertToThemeSettings(legacyDesignSettings: LegacyDesignSettings, legacyPalette: LegacyPalette): CompleteThemeSettings;
+export declare function convertToThemeSettings(legacyDesignSettings: LegacyDesignSettings, legacyPalette: LegacyPalette, domainUrl: string): CompleteThemeSettings;
 export declare function getPaletteName(legacyDesignSettings: LegacyDesignSettings): string;

package/dist/themes/theme-loader.d.ts

@@ -9,5 +9,5 @@ import { type LegacyPalette } from './legacy-design-settings';
  * @returns CompleteThemeSettings from server.
  * @internal
  */
-export declare function getThemeSettingsByOid(themeOid: ThemeOid, httpClient: Pick<HttpClient, 'get'>): Promise<CompleteThemeSettings>;
+export declare function getThemeSettingsByOid(themeOid: ThemeOid, httpClient: Pick<HttpClient, 'get' | 'url'>): Promise<CompleteThemeSettings>;
 export declare function getLegacyPalette(paletteName: string, httpClient: Pick<HttpClient, 'get'>): Promise<LegacyPalette>;

package/dist/translation/resources/en.d.ts

@@ -10,7 +10,6 @@ export declare const translation: {
         executeQueryNoSisenseContext: string;
         executeQueryNoDataSource: string;
         dataOptions: {
-            emptyValueArray: string;
             noDimensionsAndMeasures: string;
             attributeNotFound: string;
             measureNotFound: string;
@@ -30,8 +29,10 @@ export declare const translation: {
         };
         widgetModel: {
             pivotWidgetNotSupported: string;
+            textWidgetNotSupported: string;
             onlyTableWidgetSupported: string;
             onlyPivotWidgetSupported: string;
+            onlyTextWidgetSupported: string;
         };
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;

package/dist/translation/resources/index.d.ts

@@ -14,7 +14,6 @@ export declare const resources: {
             executeQueryNoSisenseContext: string;
             executeQueryNoDataSource: string;
             dataOptions: {
-                emptyValueArray: string;
                 noDimensionsAndMeasures: string;
                 attributeNotFound: string;
                 measureNotFound: string;
@@ -34,8 +33,10 @@ export declare const resources: {
             };
             widgetModel: {
                 pivotWidgetNotSupported: string;
+                textWidgetNotSupported: string;
                 onlyTableWidgetSupported: string;
                 onlyPivotWidgetSupported: string;
+                onlyTextWidgetSupported: string;
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
@@ -137,7 +138,6 @@ export declare const resources: {
             executeQueryNoSisenseContext: string;
             executeQueryNoDataSource: string;
             dataOptions: {
-                emptyValueArray: string;
                 noDimensionsAndMeasures: string;
                 attributeNotFound: string;
                 measureNotFound: string;
@@ -157,8 +157,10 @@ export declare const resources: {
             };
             widgetModel: {
                 pivotWidgetNotSupported: string;
+                textWidgetNotSupported: string;
                 onlyTableWidgetSupported: string;
                 onlyPivotWidgetSupported: string;
+                onlyTextWidgetSupported: string;
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;

package/dist/types.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="react" />
-import { AutoZoomNavigatorScrollerLocation } from './dashboard-widget/types';
-import type { Attribute, MembersFilter } from '@sisense/sdk-data';
+import type { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
 import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, AreaRangeSubtype } from './chart-options-processor/subtype-to-design-options';
 import { IndicatorComponents, TableColorOptions } from './chart-options-processor/translations/design-options';
@@ -11,6 +10,8 @@ import { DataPointsEventHandler } from './props';
 import { LegendPosition } from './chart-options-processor/translations/legend-section';
 import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
 import { Coordinates } from './charts/map-charts/scattermap/types';
+import { StyledColumn, StyledMeasureColumn } from '.';
+import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
@@ -30,7 +31,11 @@ export type Components = {
 export type Navigator = {
     /** Boolean flag that defines if navigator should be shown on the chart */
     enabled: boolean;
-    scrollerLocation?: AutoZoomNavigatorScrollerLocation;
+    /** The scroll location of the navigator scroller / auto zoom feature */
+    scrollerLocation?: {
+        min: number;
+        max: number;
+    };
 };
 /** Configuration that defines line width */
 export type LineWidth = {
@@ -830,6 +835,26 @@ export interface AiChatThemeSettings {
         boxShadow?: string;
     };
 }
+export type ThemeSettingsFontSource = {
+    local: string;
+} | {
+    url: string;
+} | {
+    format: string;
+    url: string;
+};
+/** Loading font details */
+export interface ThemeSettingsFont {
+    fontFamily: string;
+    fontWeight: string | number;
+    fontStyle: string;
+    src: ThemeSettingsFontSource[];
+}
+/** Settings for fonts loading */
+export interface FontsLoaderSettings {
+    /** List of fonts */
+    fonts: ThemeSettingsFont[];
+}
 /** Text theme settings */
 export interface TypographyThemeSettings {
     /** Font family name to style component text */
@@ -838,6 +863,8 @@ export interface TypographyThemeSettings {
     primaryTextColor?: string;
     /** Secondary text color */
     secondaryTextColor?: string;
+    /** Settings for font loading */
+    fontsLoader?: FontsLoaderSettings;
 }
 /** General theme settings */
 export interface GeneralThemeSettings {
@@ -942,9 +969,13 @@ export interface ThemeSettings {
  *
  * @internal
  */
-export type CompleteThemeSettings = DeepRequired<ThemeSettings>;
+export type CompleteThemeSettings = DeepRequired<Omit<ThemeSettings, 'typography'>> & {
+    typography: DeepRequired<Omit<TypographyThemeSettings, 'fontsLoader'>> & {
+        fontsLoader?: FontsLoaderSettings;
+    };
+};
 /** 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) & WidgetContainerStyleOptions;
+export type WidgetStyleOptions = (ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions) & 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 */
@@ -1025,6 +1056,14 @@ export type TableWidgetStyleOptions = TableStyleOptions & WidgetContainerStyleOp
  * @internal
  */
 export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetContainerStyleOptions;
+/**
+ * Style settings defining the look and feel of TextWidget
+ */
+export type TextWidgetStyleOptions = {
+    html: string;
+    vAlign: `valign-${'middle' | 'top' | 'bottom'}`;
+    bgColor: string;
+};
 /**
  * Runs type guard check for ThemeOid.
  *
@@ -1055,11 +1094,11 @@ export type DrilldownSelection = {
 /**
  * Data points in a chart. Array of data points of the same data point type.
  */
-export type ChartDataPoints = DataPoint[] | ScatterDataPoint[] | BoxplotDataPoint[] | AreamapDataPoint[];
+export type ChartDataPoints = DataPoint[] | ScatterDataPoint[] | BoxplotDataPoint[] | AreamapDataPoint[] | ScattermapDataPoint[];
 /**
  * Abstract data point in a chart - union of all types of data points.
  */
-export type ChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | AreamapDataPoint;
+export type ChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | AreamapDataPoint | ScattermapDataPoint;
 /**
  * Abstract data point in a chart that based on Highcharts.
  *
@@ -1082,6 +1121,38 @@ export type DataPoint = {
     categoryDisplayValue?: string;
     /** Series associated with the data point */
     seriesValue?: string | number;
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        category: DataPointEntry[];
+        value: DataPointEntry[];
+        breakBy?: DataPointEntry[];
+    };
+};
+/**
+ * A data point entry that represents a single dimension within a multi-dimensional data point.
+ *
+ * @internal
+ */
+export type DataPointEntry = {
+    /**
+     * The unique identifier of the data point entry.
+     * It represents the path within the `dataOptions` object that identifies the related option.
+     */
+    readonly id: string;
+    /** The data option associated with this entry */
+    dataOption: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    /** The attribute associated with this data point entry */
+    attribute?: Attribute;
+    /** The measure associated with this data point entry */
+    measure?: Measure;
+    /** The raw value of the data point */
+    value: string | number;
+    /** The formated value of the data point */
+    displayValue?: string;
 };
 /** Data point in a Scatter chart. */
 export type ScatterDataPoint = {
@@ -1090,28 +1161,62 @@ export type ScatterDataPoint = {
     size?: number;
     breakByPoint?: string;
     breakByColor?: string;
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        x?: DataPointEntry;
+        y?: DataPointEntry;
+        size?: DataPointEntry;
+        breakByPoint?: DataPointEntry;
+        breakByColor?: DataPointEntry;
+    };
 };
 /** Data point in a Boxplot chart. */
 export type BoxplotDataPoint = {
     /** Value of the box minimum */
-    boxMin: number;
+    boxMin?: number;
     /** Value of the box median */
-    boxMedian: number;
+    boxMedian?: number;
     /** Value of the box maximum */
-    boxMax: number;
+    boxMax?: number;
     /** Value of the box minimal whisker */
-    whiskerMin: number;
+    whiskerMin?: number;
     /** Value of the box maximal whisker */
-    whiskerMax: number;
+    whiskerMax?: number;
     /** Value of the category for the data point */
     categoryValue?: string | number;
     /** Display value of category of the data point */
     categoryDisplayValue?: string;
+    /** Value of the outlier */
+    outlier?: number;
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        category: DataPointEntry[];
+        value: DataPointEntry[];
+        outliers: DataPointEntry[];
+    };
 };
 /**
  * Data point in an Areamap chart.
  */
-export type AreamapDataPoint = GeoDataElement;
+export type AreamapDataPoint = GeoDataElement & {
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        geo: DataPointEntry[];
+        color: DataPointEntry[];
+    };
+};
 /**
  * Data point in an Scattermap chart.
  */
@@ -1124,6 +1229,17 @@ export type ScattermapDataPoint = {
     value: number;
     /** Location coordinates */
     coordinates: Coordinates;
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        geo: DataPointEntry[];
+        size?: DataPointEntry;
+        colorBy?: DataPointEntry;
+        details?: DataPointEntry;
+    };
 };
 /**
  * This is the minimum definition of Highcharts
@@ -1173,18 +1289,27 @@ export type HighchartsPoint = {
         name: string;
         custom: {
             number1?: number;
+            level?: number;
+            levelsCount?: number;
         };
         q1?: number;
         median?: number;
         q3?: number;
         low?: number;
         high?: number;
+        y?: number;
     };
     custom: {
+        maskedX?: string;
+        maskedY?: string;
         maskedBreakByPoint?: string;
         maskedBreakByColor?: string;
+        maskedSize?: string;
         rawValue?: string | number;
         xValue?: (string | number)[];
+        xDisplayValue?: string[];
+        rawValues?: (string | number)[];
+        xValues?: string[];
     };
     series: {
         initialType: string;
@@ -1194,6 +1319,11 @@ export type HighchartsPoint = {
                 rawValue?: string | number[];
             };
         };
+        index: number;
+        chart: {
+            options: HighchartsOptionsInternal;
+        };
+        name: string;
     };
     graphic?: {
         on: (eventType: string, callback: (event: PointerEvent) => void) => HighchartsPoint['graphic'];
@@ -1201,6 +1331,8 @@ export type HighchartsPoint = {
     x: number;
     y: number;
     z: number;
+    index: number;
+    value?: number;
 };
 /**
  * @internal