@sisense/sdk-ui 1.11.0 → 1.12.0

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

@@ -0,0 +1,62 @@
+import { DataSource, Filter } from '@sisense/sdk-data';
+import { Layout, WidgetModel } from '../../models';
+import type { DashboardDto } from '../../api/types/dashboard-dto';
+/**
+ * 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[];
+    /**
+     * Creates a new dashboard model.
+     *
+     * @param dashboardDto - The widget DTO to be converted to a widget model
+     * @internal
+     */
+    constructor(dashboardDto: DashboardDto);
+    /**
+     * Returns the props to be used for rendering a dashboard.
+     *
+     * @example
+     * ```tsx
+     * <Dashboard {...dashboard.getDashboardProps()} />
+     * ```
+     * @internal
+     */
+    getDashboardProps(): {
+        title: string;
+        dataSource: DataSource;
+        widgets: WidgetModel[];
+        layout: Layout;
+        filters: Filter[];
+    };
+}

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

@@ -1,4 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { DashboardModel } from '../../models/dashboard/dashboard-model';
 export interface GetDashboardModelOptions {
     /**
      * Boolean flag whether to include widgets in the dashboard model
@@ -16,4 +17,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): 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,5 @@
+import { type Layout as SisenseLayout, type FilterDto, type CascadingFilterDto } from '../../api/types/dashboard-dto';
+import type { Layout } from './types';
+import { Filter } from '@sisense/sdk-data';
+export declare const translateLayout: (layout: SisenseLayout) => Layout;
+export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>): Filter[];

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

@@ -1,11 +1,9 @@
-import { type DataSource, Filter } from '@sisense/sdk-data';
-import { WidgetModel } from '../widget/widget-model';
 /** @internal */
 export interface Layout {
     columns: {
         widthPercentage: number;
-        cells: {
-            subcells: {
+        rows: {
+            cells: {
                 widthPercentage: number;
                 height: number | string;
                 widgetId: string;
@@ -13,13 +11,3 @@ export interface Layout {
         }[];
     }[];
 }
-export type DashboardModel = {
-    oid: string;
-    title: string;
-    dataSource: DataSource;
-    widgets?: WidgetModel[];
-    /** @internal */
-    layout?: Layout;
-    /** @internal */
-    filters?: Filter[];
-};

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/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;

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

package/dist/types.d.ts

@@ -656,8 +656,6 @@ export interface ThemeSettings {
     };
     /**
      * Theme settings specific to the AI Chatbot component
-     *
-     * @internal
      */
     aiChat?: {
         /** Background color of the chatbot */
@@ -766,10 +764,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 +776,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 +792,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;
+        };
     };
 }
 /**