@sisense/sdk-ui 1.12.0 → 1.13.0

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

@@ -1,6 +1,9 @@
 import { DataSource, Filter } from '@sisense/sdk-data';
 import { Layout, WidgetModel } from '../../models';
 import type { DashboardDto } from '../../api/types/dashboard-dto';
+import { DashboardProps } from '../../dashboard/types';
+import { type WidgetFilterOptions } from './types';
+import { CompleteThemeSettings } from '../../types';
 /**
  * Model of Sisense dashboard defined in the abstractions of Compose SDK.
  *
@@ -36,13 +39,20 @@ export declare class DashboardModel {
      * @internal
      */
     filters: Filter[];
+    /**
+     * Dashboard filters options per each widget.
+     *
+     * @internal
+     */
+    widgetFilterOptions: WidgetFilterOptions;
     /**
      * Creates a new dashboard model.
      *
      * @param dashboardDto - The widget DTO to be converted to a widget model
+     * @param themeSettings - Optional theme settings
      * @internal
      */
-    constructor(dashboardDto: DashboardDto);
+    constructor(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings);
     /**
      * Returns the props to be used for rendering a dashboard.
      *
@@ -52,11 +62,5 @@ export declare class DashboardModel {
      * ```
      * @internal
      */
-    getDashboardProps(): {
-        title: string;
-        dataSource: DataSource;
-        widgets: WidgetModel[];
-        layout: Layout;
-        filters: Filter[];
-    };
+    getDashboardProps(): DashboardProps;
 }

package/dist/models/dashboard/get-dashboard-model.d.ts

@@ -1,5 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { DashboardModel } from '../../models/dashboard/dashboard-model';
+import { CompleteThemeSettings } from '../../types';
 export interface GetDashboardModelOptions {
     /**
      * Boolean flag whether to include widgets in the dashboard model
@@ -17,4 +18,4 @@ export interface GetDashboardModelOptions {
     includeFilters?: boolean;
 }
 /** @internal */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions): Promise<DashboardModel>;
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings): Promise<DashboardModel>;

package/dist/models/dashboard/translate-dashboard-utils.d.ts

@@ -1,5 +1,7 @@
 import { type Layout as SisenseLayout, type FilterDto, type CascadingFilterDto } from '../../api/types/dashboard-dto';
-import type { Layout } from './types';
+import type { Layout, WidgetFilterOptions } from './types';
 import { Filter } from '@sisense/sdk-data';
+import { WidgetDto } from '../../dashboard-widget/types';
 export declare const translateLayout: (layout: SisenseLayout) => Layout;
 export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>): Filter[];
+export declare function translateWidgetFilterOptions(widgets?: WidgetDto[]): WidgetFilterOptions;

package/dist/models/dashboard/types.d.ts

@@ -1,3 +1,4 @@
+import { CommonFiltersOptions } from '../../common-filters/types';
 /** @internal */
 export interface Layout {
     columns: {
@@ -11,3 +12,5 @@ export interface Layout {
         }[];
     }[];
 }
+/** @internal */
+export type WidgetFilterOptions = Record<string, CommonFiltersOptions>;

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

@@ -1,4 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { WidgetModel } from './widget-model';
+import { CompleteThemeSettings } from '../../types';
 /** @internal */
-export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string): Promise<WidgetModel>;
+export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?: CompleteThemeSettings): Promise<WidgetModel>;

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

@@ -1,3 +1,6 @@
-import { WidgetDto } from '../../dashboard-widget/types';
+import { CompleteThemeSettings } from '../../types';
+import { WidgetDto, WidgetType } from '../../dashboard-widget/types';
+import { WidgetTypeInternal } from './types';
 import { WidgetModel } from './widget-model';
-export declare function translateWidget(widget: WidgetDto): WidgetModel;
+export declare function translateWidget(widget: WidgetDto, themeSettings?: CompleteThemeSettings): WidgetModel;
+export declare function translateWidgetType(widgetType: WidgetType): WidgetTypeInternal;

package/dist/models/widget/types.d.ts

@@ -0,0 +1,9 @@
+import { ChartType } from '../../index';
+/**
+ * Widget type
+ *
+ * todo: as a future refactoring need to replace existing `WidgetType` by current one
+ *
+ * @internal
+ */
+export type WidgetTypeInternal = ChartType | 'pivot' | 'plugin';

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

@@ -3,7 +3,7 @@ import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-option
 import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
 import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
-import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings } from '../../types';
+import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings, RenderToolbarHandler } from '../../types';
 /**
  * Widget data options.
  */
@@ -65,6 +65,18 @@ export declare class WidgetModel {
      * Widget drilldown options.
      */
     drilldownOptions: DrilldownOptions;
+    /**
+     * "onDataPointClick" handler for the constructed component
+     *
+     * @internal
+     */
+    componentDataPointClickHandler?: ChartProps['onDataPointClick'];
+    /**
+     * "onDataPointsSelected" handler for the constructed component
+     *
+     * @internal
+     */
+    componentDataPointsSelectedHandler?: ChartProps['onDataPointsSelected'];
     /**
      * Creates a new widget model.
      *
@@ -174,4 +186,22 @@ export declare class WidgetModel {
      * @internal
      */
     getPivotTableWidgetProps(): PivotTableWidgetProps;
+    /**
+     * Registers new "onDataPointClick" handler for the constructed component
+     *
+     * @internal
+     */
+    registerComponentDataPointClickHandler?(handler: NonNullable<ChartProps['onDataPointClick']>): void;
+    /**
+     * Registers new "onDataPointsSelected" handler for the constructed component
+     *
+     * @internal
+     */
+    registerComponentDataPointsSelectedHandler?(handler: NonNullable<ChartProps['onDataPointsSelected']>): void;
+    /**
+     * Registers new "renderToolbar" handler for the constructed component
+     *
+     * @internal
+     */
+    registerComponentRenderToolbarHandler?(handler: RenderToolbarHandler): void;
 }

package/dist/query/query-result-date-formatting.d.ts

@@ -1,4 +1,5 @@
 import { Data } from '@sisense/sdk-data';
 import type { DateConfig } from './date-formats';
 import type { QueryResultData } from '@sisense/sdk-data';
+export declare function parseISOWithDefaultUTCOffset(dateString: string): Date;
 export declare function applyDateFormats(data: QueryResultData | Data, chartDataOptions: any, locale?: Locale, dateConfig?: DateConfig): QueryResultData | Data;

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

@@ -96,5 +96,9 @@ export declare const translation: {
         title: string;
         message: string;
     };
+    commonFilter: {
+        clearSelectionButton: string;
+    };
+    customFilterTileMessage: string;
 };
 export type TranslationDictionary = typeof translation;

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

@@ -100,6 +100,10 @@ export declare const resources: {
             title: string;
             message: string;
         };
+        commonFilter: {
+            clearSelectionButton: string;
+        };
+        customFilterTileMessage: string;
     };
     uk: {
         errors: {
@@ -199,5 +203,9 @@ export declare const resources: {
             title: string;
             message: string;
         };
+        commonFilter: {
+            clearSelectionButton: string;
+        };
+        customFilterTileMessage: string;
     };
 };

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { Attribute, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
-import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype } from './chart-options-processor/subtype-to-design-options';
+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';
 import { FunnelDirection, FunnelSize, FunnelType } from './chart-options-processor/translations/funnel-plot-options';
 import { ScatterMarkerSize } from './chart-options-processor/translations/scatter-plot-options';
@@ -15,7 +15,7 @@ export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
 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, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, };
+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, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 /**
  * @internal
@@ -215,7 +215,10 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
 }
 /** Configuration options that define functional style of the various elements of AreaRangeChart */
 export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
+    /** Configuration that defines line width */
     lineWidth?: LineWidth;
+    /** Subtype of AreaRangeChart */
+    subtype?: AreaRangeSubtype;
 }
 /** Configuration options that define functional style of the various elements of AreaChart */
 export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
@@ -872,9 +875,11 @@ export interface WidgetStyleOptions {
          *
          * @internal
          */
-        renderToolbar?: (onRefresh: () => void) => JSX.Element | null;
+        renderToolbar?: RenderToolbarHandler;
     };
 }
+/** @internal */
+export type RenderToolbarHandler = (onRefresh: () => void, defaultToolbar: JSX.Element) => JSX.Element | null;
 /** Style settings defining the look and feel of DashboardWidget */
 export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
     /**
@@ -1052,6 +1057,7 @@ export type Series = {
 export type HighchartsPoint = {
     category: string;
     name?: string;
+    state?: string;
     options: {
         name: string;
         custom: {