@sisense/sdk-ui 1.12.0 → 1.14.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/pivot-table/formatters/utils.d.ts

@@ -2,4 +2,4 @@ import { type Column } from '@sisense/sdk-data';
 import { type PivotTableDataOptions, type StyledColumn, type AnyColumn } from '../../chart-data-options/types';
 export declare const getPivotDataOptionByJaqlIndex: (dataOptions: PivotTableDataOptions, dataOptionIndex?: number) => AnyColumn | undefined;
 export declare const getNumberFormatConfig: (dataOption?: AnyColumn) => Required<import("../..").NumberFormatConfig>;
-export declare const getDateFormatConfig: (dataOption: Column | StyledColumn) => string;
+export declare const getDateFormatConfig: (dataOption: Column | StyledColumn) => string | undefined;

package/dist/props.d.ts

@@ -388,21 +388,21 @@ export interface BaseChartProps {
      */
     dataSet?: DataSource | Data;
     /**
-     * Filters to apply to a chart’s data using one of the following options.
+     * Filters to limit (or slice) a chart’s data using one of the following options.
      *
-     * (1) Array of filters returned from filter factory functions, such as
+     * (1) Array of {@link Filter} or {@link FilterRelations} returned from filter factory functions, such as
      * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
      *
      * Use this option for filters that do not require a UI to set them
-     * or for filters where you will supply your own UI using non-Sisense components.
+     * or for filters where you will supply your own UI components or use pre-built UI components. This is the most common option.
      *
      * To learn more about using filter factory functions to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions).
      *
-     * (2) Array of filters controlled by Sisense filter components.
+     * (2) Array of {@link Filter} controlled by filter UI components – for example {@link MemberFilterTile}.
      *
-     * Use this option for filters that you want your users to set using Sisense UI components.
+     * Use this option for filters that you want your users to set using pre-built UI components.
      *
-     * To learn more about using filter components to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components).
+     * To learn more about using filter UI components to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components).
      *
      * @category Data
      */
@@ -410,21 +410,21 @@ export interface BaseChartProps {
     /**
      * Highlights based on filter criteria to apply to a chart using one of the following options.
      *
-     * Note that the filter dimensions used in highlights must match those defined in the
-     * {@link dataOptions} of the chart.
+     * NOTE that the filter dimensions used in highlights must match those defined in the
+     * {@link dataOptions} of the chart. Otherwise, the filters will be applied as regular slice filters.
      *
-     * (1) Array of filters returned from filter factory functions, such as
+     * (1) Array of {@link Filter} returned from filter factory functions, such as
      * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
      *
      * Use this option for highlights that do not require a UI to set them
-     * or for highlights where you will supply your own UI using non-Sisense components.
+     * or for highlights where you will supply your own UI components or use pre-built UI components. This is the most common option.
      *
      * To learn more about using filter factory functions to create highlights, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions-for-highlighting).
      *
-     * (2) Array of filters controlled by Sisense filter components.
+     * (2) Array of {@link Filter} controlled by filter UI components – for example {@link MemberFilterTile}.
      *
-     * Use this option for highlights that you want your users to set using Sisense UI components.
+     * Use this option for highlights that you want your users to set using pre-built UI components.
      *
      * To learn more about using filter components to create highlights, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components-for-highlighting).

package/dist/table/hooks/use-table-data.d.ts

@@ -12,5 +12,5 @@ export declare const getTableAttributesAndMeasures: (dataOptions: TableDataOptio
     attributes: Attribute[];
     measures: Measure[];
 };
-export declare const useTableData: ({ dataSet, dataOptions, filters, filterRelations, count, offset, }: UseDataProps) => Data | null;
+export declare const useTableData: ({ dataSet, dataOptions: originalDataOptions, filters, filterRelations, count, offset, }: UseDataProps) => [Data | null, TableDataOptionsInternal | null];
 export {};

package/dist/table/table-component.d.ts

@@ -1,8 +1,8 @@
 import { TableProps } from '../props';
+export declare const DEFAULT_TABLE_ROWS_PER_PAGE = 25;
+/** How many pages of data will be loaded in one query */
+export declare const PAGES_BATCH_SIZE = 10;
 /**
  * Component that renders a table with aggregation and pagination.
  */
-export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, refreshCounter, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;
-export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;
-/** How many pages of data will be loaded in one query */
-export declare const PAGES_BATCH_SIZE = 10;
+export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;

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

@@ -3,6 +3,8 @@ import { ThemeProviderProps } from '../props';
 /**
  * Theme provider, which allows you to adjust the look and feel of child components.
  *
+ * Components not wrapped in a theme provider use the current theme from the connected Fusion instance by default.
+ *
  * @example
  * Example of a theme provider, which changes the colors and font of the nested indicator chart:
  * ```tsx

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

@@ -36,6 +36,7 @@ export declare const translation: {
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;
         invalidFilterType: string;
+        secondsDateTimeLevelSupportedOnlyForLive: string;
     };
     errorBoxText: string;
     chartNoData: string;
@@ -96,5 +97,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

@@ -40,6 +40,7 @@ export declare const resources: {
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
             invalidFilterType: string;
+            secondsDateTimeLevelSupportedOnlyForLive: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -100,6 +101,10 @@ export declare const resources: {
             title: string;
             message: string;
         };
+        commonFilter: {
+            clearSelectionButton: string;
+        };
+        customFilterTileMessage: string;
     };
     uk: {
         errors: {
@@ -139,6 +144,7 @@ export declare const resources: {
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
             invalidFilterType: string;
+            secondsDateTimeLevelSupportedOnlyForLive: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -199,5 +205,9 @@ export declare const resources: {
             title: string;
             message: string;
         };
+        commonFilter: {
+            clearSelectionButton: string;
+        };
+        customFilterTileMessage: string;
     };
 };