@sisense/sdk-ui 1.15.0 → 1.16.0

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

@@ -1,9 +1,10 @@
 import { DataSource, Filter } from '@sisense/sdk-data';
-import { Layout, WidgetModel } from '../../models';
+import { DashboardStyleOptions, 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';
+import { AppSettings } from '../../app/settings/settings';
 /**
  * Model of Sisense dashboard defined in the abstractions of Compose SDK.
  *
@@ -33,6 +34,12 @@ export declare class DashboardModel {
      * @internal
      */
     layout: Layout;
+    /**
+     * Dashboard style options.
+     *
+     * @internal
+     */
+    styleOptions: DashboardStyleOptions;
     /**
      * Dashboard filters.
      *
@@ -50,9 +57,10 @@ export declare class DashboardModel {
      *
      * @param dashboardDto - The widget DTO to be converted to a widget model
      * @param themeSettings - Optional theme settings
+     * @param appSettings - Optional application settings
      * @internal
      */
-    constructor(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings);
+    constructor(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings);
     /**
      * Returns the props to be used for rendering a dashboard.
      *

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

@@ -1,6 +1,7 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { DashboardModel } from '../../models/dashboard/dashboard-model';
 import { CompleteThemeSettings } from '../../types';
+import { AppSettings } from '../../app/settings/settings';
 export interface GetDashboardModelOptions {
     /**
      * Boolean flag whether to include widgets in the dashboard model
@@ -17,5 +18,15 @@ export interface GetDashboardModelOptions {
      */
     includeFilters?: boolean;
 }
-/** @internal */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings): Promise<DashboardModel>;
+/**
+ * Retrieves a dashboard model by its OID.
+ * @param http - The HTTP client
+ * @param dashboardOid - The OID of the dashboard
+ * @param options - The options to include widgets and filters in the dashboard model
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The dashboard model
+ *
+ * @internal
+ */
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<DashboardModel>;

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

@@ -1,4 +1,5 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
+import { ColorPaletteTheme } from '../../types';
 /** @internal */
 export interface Layout {
     columns: {
@@ -14,3 +15,7 @@ export interface Layout {
 }
 /** @internal */
 export type WidgetFilterOptions = Record<string, CommonFiltersOptions>;
+/** @internal */
+export type DashboardStyleOptions = {
+    palette?: ColorPaletteTheme;
+};

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

@@ -69,6 +69,8 @@ export type DashboardModelSuccessState = {
 /**
  * React hook that retrieves an existing dashboard model from the Sisense instance.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  * An example of retrieving an existing dashboard model from the Sisense instance and render its widgets with component `DashboardWidget`:
  ```tsx

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

@@ -65,6 +65,8 @@ export type DashboardModelsSuccessState = {
 /**
  * React hook that retrieves existing dashboards that the user can access to from the Sisense instance.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  ```tsx
   const { dashboards, isLoading, isError } = useGetDashboardModels();

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

@@ -1,5 +1,16 @@
 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, themeSettings?: CompleteThemeSettings): Promise<WidgetModel>;
+import { AppSettings } from '../../app/settings/settings';
+/**
+ * Retrieves a widget model by its OID.
+ * @param httpClient - The HTTP client
+ * @param dashboardOid - The OID of the dashboard
+ * @param widgetOid - The OID of the widget
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The widget model
+ *
+ * @internal
+ */
+export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<WidgetModel>;

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

@@ -2,5 +2,13 @@ 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, themeSettings?: CompleteThemeSettings): WidgetModel;
+import { AppSettings } from '../../app/settings/settings';
+/**
+ * Translates a widget DTO to a widget model.
+ * @param widget - The widget DTO to be converted to a widget model
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The widget model
+ */
+export declare function translateWidget(widget: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): WidgetModel;
 export declare function translateWidgetType(widgetType: WidgetType): WidgetTypeInternal;

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

@@ -71,6 +71,8 @@ export type WidgetModelSuccessState = {
 /**
  * React hook that retrieves an existing widget model from a Fusion Embed instance.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * ## Example
  *
  * Retrieve a widget model and use it to populate a `Chart` component

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

@@ -3,7 +3,8 @@ 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, RenderToolbarHandler } from '../../types';
+import { ChartType, DrilldownOptions, CompleteThemeSettings, RenderToolbarHandler, WidgetStyleOptions } from '../../types';
+import { AppSettings } from '../../app/settings/settings';
 /**
  * Widget data options.
  */
@@ -48,7 +49,7 @@ export declare class WidgetModel {
     /**
      * Widget style options.
      */
-    styleOptions: ChartStyleOptions | TableStyleOptions;
+    styleOptions: WidgetStyleOptions;
     /**
      * Widget filters.
      */
@@ -82,9 +83,10 @@ export declare class WidgetModel {
      *
      * @param widgetDto - The widget DTO to be converted to a widget model
      * @param themeSettings - The theme settings to be used for the widget model
+     * @param appSettings - The application settings to be used for the widget model
      * @internal
      */
-    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings);
+    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings);
     /**
      * Returns the parameters to be used for executing a query for the widget.
      *

package/dist/pivot-table/use-get-pivot-table-query.d.ts

@@ -8,16 +8,12 @@ export declare const getPivotQueryOptions: (dataOptions: PivotTableDataOptionsIn
  *
  * @internal
  */
-export declare const useGetPivotTableQuery: ({ dataSet, dataOptionsInternal, filters, highlights, refreshCounter, }: {
+export declare const usePivotTableQuery: ({ dataSet, dataOptionsInternal, filters, highlights, }: {
     dataSet?: DataSource | undefined;
     dataOptionsInternal: PivotTableDataOptionsInternal;
     filters?: Filter[] | FilterRelations | undefined;
     highlights?: Filter[] | undefined;
-    refreshCounter?: number | undefined;
 }) => {
-    isLoading: boolean;
-    isSuccess: boolean;
-    isError: boolean;
+    jaql: JaqlRequest | undefined;
     error: Error | undefined;
-    jaql: JaqlRequest | null;
 };

package/dist/props.d.ts

@@ -21,32 +21,40 @@ export type { MenuItemSection, HighchartsOptions };
 export interface SisenseContextProviderProps {
     /**
      * Default data source explicitly set to be used by child components that are not defined with a data source.
+     *
+     * @category Sisense App
      */
     defaultDataSource?: DataSource;
-    /** URL of the Sisense environment the app connects to */
+    /**
+     * URL of the Sisense environment the app connects to
+     *
+     * @category Sisense App
+     */
     url: string;
     /**
      * [Single Sign-On](https://docs.sisense.com/main/SisenseLinux/using-single-sign-on-to-access-sisense.htm) toggle.
      *
      * Set to `true` to use SSO authentication. When `true`, this overrides any other authentication methods. Defaults to `false`.
      *
-     * @category Authentication
+     * @category Sisense Authentication
      */
     ssoEnabled?: boolean;
     /**
      * Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).
      *
-     * @category Authentication
+     * @category Sisense Authentication
      */
     token?: string;
     /**
      * [Web Access Token](https://docs.sisense.com/main/SisenseLinux/using-web-access-token.htm).
      *
-     * @category Authentication
+     * @category Sisense Authentication
      */
     wat?: string;
     /**
      * Application specific configurations such as locale and date formats.
+     *
+     * @category Sisense App
      */
     appConfig?: AppConfig;
     /**
@@ -1286,7 +1294,7 @@ export interface DrilldownWidgetProps {
      */
     initialDimension: Attribute;
     /**
-     * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
+     * An object that allows users to pass advanced configuration options as a prop for the `DrilldownWidget` component
      *
      * @category Widget
      */

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

@@ -7,6 +7,8 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  * This component takes the Children Prop Pattern and
  * offers an alternative approach to the {@link useExecuteQueryByWidgetId} hook.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  * The example below executes a query over the existing dashboard widget with the specified widget and dashboard OIDs.
  * ```tsx

package/dist/query-execution/index.d.ts

@@ -5,4 +5,4 @@ export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
 export { useExecutePivotQuery } from './use-execute-pivot-query';
 export { useQueryCache } from './use-query-cache';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, ExecutePivotQueryParams, } from './types';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types';

package/dist/query-execution/types.d.ts

@@ -154,10 +154,19 @@ export interface ExecuteQueryByWidgetIdParams {
     /** {@inheritDoc ExecuteQueryParams.enabled} */
     enabled?: boolean;
 }
-export type QueryByWidgetIdState = QueryState & {
-    /** Query parameters constructed over the widget */
+/**
+ * Query parameters constructed over either a chart widget or pivot table widget. This is returned as part of the query state {@link QueryByWidgetIdState}.
+ */
+export type QueryByWidgetIdQueryParams = {
+    /** Query parameters constructed over the chart widget */
     query: ExecuteQueryParams | undefined;
+    /** Query parameters constructed over the pivot table widget */
+    pivotQuery: ExecutePivotQueryParams | undefined;
 };
+/**
+ * State of a query execution retrieving data of Fusion widget.
+ */
+export type QueryByWidgetIdState = QueryState & QueryByWidgetIdQueryParams;
 /**
  * Parameters for {@link useExecuteQuery} hook.
  */

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

@@ -1,11 +1,12 @@
-import { QueryDescription } from '../query/execute-query';
 import { ClientApplication } from '../app/client-application';
-import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
+import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams } from './types';
+import { QueryResultData } from '@sisense/sdk-data';
 /**
  * React hook that executes a data query extracted from an existing widget in the Sisense instance.
  *
  * This approach, which offers an alternative to {@link ExecuteQueryByWidgetId} component, is similar to React Query's `useQuery` hook.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
  *
  * @example
  * The example below executes a query over the existing dashboard widget with the specified widget and dashboard OIDs.
@@ -48,6 +49,5 @@ export declare function useParamsChanged(params: ExecuteQueryByWidgetIdParams):
 export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
-    data: import("@sisense/sdk-data").QueryResultData;
-    query: QueryDescription;
-}>;
+    data: QueryResultData;
+} & QueryByWidgetIdQueryParams>;

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

@@ -73,6 +73,20 @@ export type LegacyPaletteError = {
     message: string;
     status: 'error';
 };
+/**
+ * Mapping of legacy design properties types to theme setting types
+ */
+export declare const LEGACY_DESIGN_TYPES: {
+    none: string;
+    small: string;
+    medium: string;
+    large: string;
+    left: string;
+    center: string;
+    right: string;
+    light: string;
+    dark: string;
+};
 /**
  * Converts legacy (used in Sisense UI) design settings and it's palette object to CompleteThemeSettings.
  *

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

@@ -87,6 +87,15 @@ export declare const translation: {
             max: string;
         };
     };
+    advanced: {
+        tooltip: {
+            min: string;
+            max: string;
+            forecastValue: string;
+            forecast: string;
+            trend: string;
+        };
+    };
     arearange: {
         tooltip: {
             min: string;

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

@@ -91,6 +91,15 @@ export declare const resources: {
                 max: string;
             };
         };
+        advanced: {
+            tooltip: {
+                min: string;
+                max: string;
+                forecastValue: string;
+                forecast: string;
+                trend: string;
+            };
+        };
         arearange: {
             tooltip: {
                 min: string;
@@ -195,6 +204,15 @@ export declare const resources: {
                 max: string;
             };
         };
+        advanced: {
+            tooltip: {
+                min: string;
+                max: string;
+                forecastValue: string;
+                forecast: string;
+                trend: string;
+            };
+        };
         arearange: {
             tooltip: {
                 min: string;

package/dist/types.d.ts

@@ -825,6 +825,44 @@ export interface GeneralThemeSettings {
     /** Hover color for primary buttons */
     primaryButtonHoverColor?: string;
 }
+/** Possible sizes for spacing. */
+export type SpaceSizes = 'None' | 'Large' | 'Medium' | 'Small';
+/** Possible sizes for border radius. */
+export type RadiusSizes = 'None' | 'Large' | 'Medium' | 'Small';
+/** Possible types of shadows. */
+export type ShadowsTypes = 'None' | 'Light' | 'Medium' | 'Dark';
+/** Possible types of text alignment. */
+export type AlignmentTypes = 'Left' | 'Center' | 'Right';
+/** Widget theme settings */
+export type WidgetThemeSettings = {
+    /** Space between widget container edge and the chart */
+    spaceAround?: SpaceSizes;
+    /** Corner radius of the widget container */
+    cornerRadius?: RadiusSizes;
+    /**
+     * Shadow level of the widget container
+     *
+     * Effective only when spaceAround is defined
+     */
+    shadow?: ShadowsTypes;
+    /** Widget container border toggle */
+    border?: boolean;
+    /** Widget container border color */
+    borderColor?: string;
+    /** Widget header styles */
+    header?: {
+        /** Header title text color */
+        titleTextColor?: string;
+        /** Header title alignment */
+        titleAlignment?: AlignmentTypes;
+        /** Toggle of the divider line between widget header and chart */
+        dividerLine?: boolean;
+        /** Divider line color */
+        dividerLineColor?: string;
+        /** Header background color */
+        backgroundColor?: string;
+    };
+};
 /** Theme settings defining the look and feel of components. */
 export interface ThemeSettings {
     /** Chart theme settings */
@@ -835,6 +873,8 @@ export interface ThemeSettings {
     typography?: TypographyThemeSettings;
     /** General theme settings */
     general?: GeneralThemeSettings;
+    /** Widget theme settings */
+    widget?: WidgetThemeSettings;
     /**
      * Theme settings specific to the AI Chatbot component
      */
@@ -846,18 +886,20 @@ export interface ThemeSettings {
  * @internal
  */
 export type CompleteThemeSettings = DeepRequired<ThemeSettings>;
+/** 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;
 /** Style settings defining the look and feel of widget itself and widget header */
-export interface WidgetStyleOptions {
+export interface WidgetContainerStyleOptions {
     /** Space between widget container edge and the chart */
-    spaceAround?: 'Large' | 'Medium' | 'Small';
+    spaceAround?: SpaceSizes;
     /** Corner radius of the widget container */
-    cornerRadius?: 'Large' | 'Medium' | 'Small';
+    cornerRadius?: RadiusSizes;
     /**
      * Shadow level of the widget container
      *
      * Effective only when spaceAround is defined
      */
-    shadow?: 'Light' | 'Medium' | 'Dark';
+    shadow?: ShadowsTypes;
     /** Widget container border toggle */
     border?: boolean;
     /** Widget container border color */
@@ -875,7 +917,7 @@ export interface WidgetStyleOptions {
         /** Header title text color */
         titleTextColor?: string;
         /** Header title alignment */
-        titleAlignment?: 'Left' | 'Center' | undefined;
+        titleAlignment?: AlignmentTypes;
         /** Toggle of the divider line between widget header and chart */
         dividerLine?: boolean;
         /** Divider line color */
@@ -893,7 +935,7 @@ export interface WidgetStyleOptions {
 /** @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 {
+export interface DashboardWidgetStyleOptions extends WidgetContainerStyleOptions {
     /**
      * Total width of the component, which is considered in the following order of priority:
      *
@@ -913,19 +955,19 @@ export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
     height?: number;
 }
 /** Style settings defining the look and feel of ChartWidget */
-export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetStyleOptions;
+export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget
  *
  * @internal
  */
-export type TableWidgetStyleOptions = TableStyleOptions & WidgetStyleOptions;
+export type TableWidgetStyleOptions = TableStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget
  *
  * @internal
  */
-export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetStyleOptions;
+export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetContainerStyleOptions;
 /**
  * Runs type guard check for ThemeOid.
  *