@sisense/sdk-ui 1.11.0 → 1.13.0

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

@@ -0,0 +1,66 @@
+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.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export declare class DashboardModel {
+    /**
+     * Unique identifier of the dashboard.
+     */
+    oid: string;
+    /**
+     * Dashboard title.
+     */
+    title: string;
+    /**
+     * Dashboard data source details.
+     */
+    dataSource: DataSource;
+    /**
+     * Dashboard widgets.
+     */
+    widgets: WidgetModel[];
+    /**
+     * Dashboard layout.
+     *
+     * @internal
+     */
+    layout: Layout;
+    /**
+     * Dashboard filters.
+     *
+     * @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, themeSettings?: CompleteThemeSettings);
+    /**
+     * Returns the props to be used for rendering a dashboard.
+     *
+     * @example
+     * ```tsx
+     * <Dashboard {...dashboard.getDashboardProps()} />
+     * ```
+     * @internal
+     */
+    getDashboardProps(): DashboardProps;
+}

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

@@ -1,4 +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
@@ -16,4 +18,4 @@ export interface GetDashboardModelOptions {
     includeFilters?: boolean;
 }
 /** @internal */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions): Promise<import("./types").DashboardModel>;
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings): Promise<DashboardModel>;

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

@@ -1,4 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { DashboardModel } from '../../models/dashboard/dashboard-model';
 export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
@@ -12,4 +13,4 @@ export interface GetDashboardModelsOptions {
     includeWidgets?: boolean;
 }
 /** @internal */
-export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): Promise<import("./types.js").DashboardModel[]>;
+export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): Promise<DashboardModel[]>;

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

@@ -1,6 +1,6 @@
 export * from './types';
 export * from './get-dashboard-model';
 export * from './get-dashboard-models';
-export * from './translate-dashboard';
 export * from './use-get-dashboard-model';
 export * from './use-get-dashboard-models';
+export * from './dashboard-model';

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

@@ -0,0 +1,7 @@
+import { type Layout as SisenseLayout, type FilterDto, type CascadingFilterDto } from '../../api/types/dashboard-dto';
+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,11 +1,10 @@
-import { type DataSource, Filter } from '@sisense/sdk-data';
-import { WidgetModel } from '../widget/widget-model';
+import { CommonFiltersOptions } from '../../common-filters/types';
 /** @internal */
 export interface Layout {
     columns: {
         widthPercentage: number;
-        cells: {
-            subcells: {
+        rows: {
+            cells: {
                 widthPercentage: number;
                 height: number | string;
                 widgetId: string;
@@ -13,13 +12,5 @@ export interface Layout {
         }[];
     }[];
 }
-export type DashboardModel = {
-    oid: string;
-    title: string;
-    dataSource: DataSource;
-    widgets?: WidgetModel[];
-    /** @internal */
-    layout?: Layout;
-    /** @internal */
-    filters?: Filter[];
-};
+/** @internal */
+export type WidgetFilterOptions = Record<string, CommonFiltersOptions>;

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

@@ -1,5 +1,5 @@
 import { DataState } from '../../common/hooks/data-load-state-reducer';
-import { type DashboardModel } from './types';
+import { DashboardModel } from './dashboard-model';
 import { GetDashboardModelOptions } from './get-dashboard-model';
 import { HookEnableParam } from '../../common/hooks/types';
 /**

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

@@ -1,7 +1,7 @@
 import { DataState } from '../../common/hooks/data-load-state-reducer.js';
-import { type DashboardModel } from './types.js';
 import { HookEnableParam } from '../../common/hooks/types.js';
 import { GetDashboardModelsOptions } from './get-dashboard-models.js';
+import { DashboardModel } from '../../models';
 /**
  * Parameters for {@link useGetDashboardModels} hook.
  */

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/query-execution/query-params-comparator.d.ts

@@ -1,8 +1,2 @@
 import { ExecuteQueryParams } from '../index.js';
-/**
- * Checks if the query parameters have changed by deep comparison.
- *
- * @param prevParams - Previous query parameters
- * @param newParams - New query parameters
- */
-export declare function isQueryParamsChanged(prevParams: ExecuteQueryParams | undefined, newParams: ExecuteQueryParams): boolean;
+export declare function useQueryParamsChanged(params: ExecuteQueryParams): boolean;

package/dist/query-execution/use-execute-pivot-query.d.ts

@@ -29,9 +29,6 @@ export declare function useExecutePivotQueryInternal(params: ExecutePivotQueryPa
 /**
  * Checks if the query parameters have changed by deep comparison.
  *
- * TODO refactor to reuse isQueryParamsChanged
- *
- * @param prevParams - Previous query parameters
- * @param newParams - New query parameters
+ * @param params - New query parameters
  */
-export declare function isPivotQueryParamsChanged(prevParams: ExecutePivotQueryParams | undefined, newParams: ExecutePivotQueryParams): boolean;
+export declare function usePivotQueryParamsChanged(params: ExecutePivotQueryParams): boolean;

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -39,12 +39,11 @@ export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdP
  */
 export declare function useExecuteQueryByWidgetIdInternal(params: ExecuteQueryByWidgetIdParams): QueryByWidgetIdState;
 /**
- * Checks if the parameters have changed by deep comparison.
+ * Checks if the query parameters have changed by deep comparison.
  *
- * @param prevParams - Previous query parameters
- * @param newParams - New query parameters
+ * @param params - New query parameters
  */
-export declare function isParamsChanged(prevParams: ExecuteQueryByWidgetIdParams | undefined, newParams: ExecuteQueryByWidgetIdParams): boolean;
+export declare function useParamsChanged(params: ExecuteQueryByWidgetIdParams): boolean;
 /** @internal */
 export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;

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

@@ -35,6 +35,7 @@ export declare const translation: {
         };
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;
+        invalidFilterType: string;
     };
     errorBoxText: string;
     chartNoData: string;
@@ -95,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

@@ -39,6 +39,7 @@ export declare const resources: {
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
+            invalidFilterType: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -99,6 +100,10 @@ export declare const resources: {
             title: string;
             message: string;
         };
+        commonFilter: {
+            clearSelectionButton: string;
+        };
+        customFilterTileMessage: string;
     };
     uk: {
         errors: {
@@ -137,6 +142,7 @@ export declare const resources: {
             };
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
+            invalidFilterType: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -197,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 {
@@ -656,8 +659,6 @@ export interface ThemeSettings {
     };
     /**
      * Theme settings specific to the AI Chatbot component
-     *
-     * @internal
      */
     aiChat?: {
         /** Background color of the chatbot */
@@ -766,10 +767,10 @@ export interface ThemeSettings {
             borderRadius?: string;
             /** Setting to be applied on hover */
             hover?: {
-                /** Background color of the chatbot suggestions on hover */
-                backgroundColor?: string;
                 /** Text color of the chatbot suggestions on hover */
                 textColor?: string;
+                /** Background color of the chatbot suggestions on hover */
+                backgroundColor?: string;
             };
             /** 2-color gradient to be applied on suggestions loading animation */
             loadingGradient?: [string, string];
@@ -778,12 +779,14 @@ export interface ThemeSettings {
         };
         /** Settings for the chatbot clickable messages */
         clickableMessages?: {
-            /** Background color of the chatbot clickable messages */
-            backgroundColor?: string;
             /** Text color of the chatbot clickable messages */
             textColor?: string;
+            /** Background color of the chatbot clickable messages */
+            backgroundColor?: string;
             /** Border of the chatbot clickable messages */
             border?: false | string;
+            /** 2-color gradient to be applied on the border */
+            borderGradient?: [string, string] | null;
             /** Setting to be applied on hover */
             hover?: {
                 /** Text color of the chatbot clickable messages on hover */
@@ -792,16 +795,37 @@ export interface ThemeSettings {
                 backgroundColor?: string;
             };
         };
+        /** Settings for the data topics screen */
+        dataTopics?: {
+            /** Background color of the data topics screen */
+            backgroundColor?: string;
+            /** Settings for the individual data topic items */
+            items?: {
+                /** Text color of the data topic items */
+                textColor?: string;
+                /** Background color of the data topic items */
+                backgroundColor?: string;
+            };
+        };
         /** Settings for the chatbot icons */
         icons?: {
             /** Color of the chatbot icons */
             color?: string;
-            /** Setting to be applied on hover */
-            hover?: {
-                /** Color of the chatbot icons on hover */
-                color?: string;
+            /** Settings for feedback icons */
+            feedbackIcons?: {
+                /** Background color of the feedback icons on hover */
+                hoverColor?: string;
             };
         };
+        /** Settings for the chatbot tooltips */
+        tooltips?: {
+            /** Background color of the tooltips */
+            backgroundColor?: string;
+            /** Text color of the tooltips */
+            textColor?: string;
+            /** Box shadow of the tooltips */
+            boxShadow?: string;
+        };
     };
 }
 /**
@@ -851,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 {
     /**
@@ -1031,6 +1057,7 @@ export type Series = {
 export type HighchartsPoint = {
     category: string;
     name?: string;
+    state?: string;
     options: {
         name: string;
         custom: {