@sisense/sdk-ui 1.12.0 → 1.14.0

package/dist/ai/ai-context-provider.d.ts

@@ -6,7 +6,7 @@ export type AiContextProviderProps = {
  * React component that wraps all generative AI components and hooks.
  *
  * ::: warning Note
- * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
  * :::
  *
  * @example

package/dist/ai/api/chat-rest-api.d.ts

@@ -1,11 +1,10 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
-import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, DataModel, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, Perspective, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
+import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, ChatContext, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
 import { DataSourceField } from '@sisense/sdk-query-client';
 export declare class ChatRestApi {
     private httpClient;
     constructor(httpClient: HttpClient);
-    getDataModels: () => Promise<DataModel[]>;
-    getPerspectives: () => Promise<Perspective[]>;
+    getChatContexts: () => Promise<ChatContext[]>;
     private getNlgQueryResult;
     private getQueryRecommendations;
     private setLlmConfig;
@@ -17,17 +16,17 @@ export declare class ChatRestApi {
     private sendFeedback;
     private getDataSourceFields;
     ai: {
-        getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse>;
-        getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse>;
+        getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse | undefined>;
+        getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse | undefined>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;
         sendFeedback: (request: SendFeedbackRequest) => Promise<unknown>;
-        getDataSourceFields: (dataSource: string) => Promise<DataSourceField[]>;
+        getDataSourceFields: (dataSource: string) => Promise<DataSourceField[] | undefined>;
         chat: {
-            getAll: () => Promise<ChatWithoutHistory[]>;
-            getById: (chatId: string) => Promise<Chat>;
-            create: (contextId: string) => Promise<Chat>;
-            post: (chatId: string, request: ChatRequest) => Promise<ChatResponse>;
-            clearHistory: (chatId: string) => Promise<void>;
+            getAll: () => Promise<ChatWithoutHistory[] | undefined>;
+            getById: (chatId: string) => Promise<Chat | undefined>;
+            create: (sourceId: string) => Promise<Chat | undefined>;
+            post: (chatId: string, request: ChatRequest) => Promise<ChatResponse | undefined>;
+            clearHistory: (chatId: string) => Promise<void | undefined>;
         };
     };
 }

package/dist/ai/api/hooks.d.ts

@@ -1,9 +1,9 @@
-import type { ChatContext, ChatResponse } from './types';
+import type { ChatResponse } from './types';
 /**
  * @internal
  */
 export declare const useGetDataTopics: () => {
-    data: ChatContext[] | undefined;
+    data: import("./types").ChatContext[] | undefined;
     isLoading: boolean;
     fetchStatus: import("@tanstack/react-query").FetchStatus;
 };

package/dist/ai/api/types.d.ts

@@ -1,12 +1,9 @@
 import { JaqlQueryPayload, MetadataItem } from '@sisense/sdk-query-client';
 import { ChartDataOptions } from '../../types';
 export interface ChatContext {
-    id: string;
-    name: string;
-    type: ChatContextType;
-    description: string;
+    title: string;
+    live: boolean;
 }
-export type ChatContextType = 'datamodel' | 'perspective';
 export interface NlqMessage {
     role: 'assistant';
     content: string;
@@ -20,7 +17,6 @@ export type ChatMessage = RegularMessage | NlqMessage;
 export interface Chat {
     chatId: string;
     contextId: string;
-    contextType: ChatContextType;
     contextTitle: string;
     lastUpdate: string;
     tenantId: string;
@@ -94,16 +90,6 @@ export interface QueryRecommendationConfig {
 }
 export type QueryRecommendation = Omit<NlqResponseData, 'followupQuestions'>;
 export type QueryRecommendationResponse = QueryRecommendation[];
-export interface DataModel {
-    oid: string;
-    title: string;
-}
-export interface Perspective {
-    oid: string;
-    name: string;
-    description: string;
-    isDefault: boolean;
-}
 export interface GetNlgQueryResultRequest {
     jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;
 }

package/dist/ai/buttons/scroll-to-bottom-button.d.ts

@@ -0,0 +1,3 @@
+export declare const ScrollToBottomButton: ({ onClick }: {
+    onClick: () => void;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/ai/chat-config.d.ts

@@ -20,11 +20,12 @@ export interface ChatConfig {
      */
     numOfRecentPrompts: number;
     /**
-     * The default context (data model or perspective) title to use for a chat session
+     * List of titles representing allowed contexts (data models or perspectives) for a chat session.
      *
-     * If specified, the data topic selector screen will not be shown.
+     * Each context will be validated and checked for availability.
+     * If only one context is specified, the data topic selector screen will not be shown.
      */
-    defaultContextTitle?: string;
+    dataTopicsList?: string[];
     /**
      * The chat mode to use for a chat session.
      *
@@ -63,6 +64,14 @@ export interface ChatConfig {
      * @internal
      */
     enableInsights?: boolean;
+    /**
+     * Boolean flag to start a clean chat on every load.
+     *
+     * Note: When the flag is `true`, chat history will be preserved and stored for the session but will not be fetched or displayed. Changing this setting back to `false` will make the entire history visible again, even if it was previously hidden. Use the "Clear History" button to completely erase the history.
+     *
+     * @default false
+     */
+    hideHistory?: boolean;
 }
 export declare const DEFAULTS: Readonly<ChatConfig>;
 export type ChatConfigProviderProps = {

package/dist/ai/chat-home.d.ts

@@ -1,5 +1,6 @@
 type ChatHomeProps = {
+    dataTopicsList: string[];
     onDataTopicClick: (title: string) => void;
 };
-export default function ChatHome({ onDataTopicClick }: ChatHomeProps): import("react/jsx-runtime").JSX.Element;
+export default function ChatHome({ dataTopicsList, onDataTopicClick }: ChatHomeProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/ai/chatbot.d.ts

@@ -25,7 +25,7 @@ export type ChatbotProps = {
  * React component that renders a chatbot with data topic selection. You can optionally provide `width` and/or `height`.
  *
  * ::: warning Note
- * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
  * :::
  *
  * @example

package/dist/ai/common/constants.d.ts

@@ -0,0 +1 @@
+export declare const CHAT_INPUT_MAX_LENGTH = 500;

package/dist/ai/common/tooltip.d.ts

@@ -1,4 +1,4 @@
 import { type TooltipProps as MuiTooltipProps } from '@mui/material/Tooltip';
-type TooltipProps = Pick<MuiTooltipProps, 'title' | 'children'>;
-export default function Tooltip({ title, children }: TooltipProps): import("react/jsx-runtime").JSX.Element;
+type TooltipProps = Pick<MuiTooltipProps, 'title' | 'placement' | 'children'>;
+export default function Tooltip({ title, placement, children }: TooltipProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/ai/data-topics/data-topic-list.d.ts

@@ -1,6 +1,5 @@
 export interface DataTopic {
     title: string;
-    description: string;
     onClick?: () => void;
 }
 export interface Props {

package/dist/ai/get-nlg-query-result.d.ts

@@ -10,7 +10,7 @@ export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams,
  * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
  *
  * ::: warning Note
- * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
  * :::
  *
  * @example

package/dist/ai/icons/scroll-to-bottom-icon.d.ts

@@ -0,0 +1 @@
+export default function ScrollToBottomIcon(): import("react/jsx-runtime").JSX.Element;

package/dist/ai/scroll-to-bottom.d.ts

@@ -0,0 +1,7 @@
+type ScrollToBottomProps = {
+    isVisible: boolean;
+    anchorElement: HTMLDivElement | null;
+    onClick: () => void;
+};
+export declare const ScrollToBottom: ({ isVisible, onClick, anchorElement }: ScrollToBottomProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/ai/use-get-nlg-query-result.d.ts

@@ -46,7 +46,7 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
  *
  * ::: warning Note
- * This hook is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
+ * This hook is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
  * :::
  *
  * @example

package/dist/ai/use-get-query-recommendations.d.ts

@@ -36,7 +36,7 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
  * This hook includes the same code that fetches the initial suggested questions in the chatbot.
  *
  * ::: warning Note
- * This hook is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
+ * This hook is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
  * :::
  *
  * @example