@sisense/sdk-ui 1.6.0 → 1.7.0

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

@@ -8,7 +8,7 @@ import { ChatRestApi } from './chat-rest-api';
 export declare const ChatApiContext: import("react").Context<ChatRestApi | undefined>;
 export declare const useChatApi: () => ChatRestApi | undefined;
 /**
- * React component
+ * React component that initializes the necessary wrappers to enable API calls and caching.
  *
  * @internal
  */

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

@@ -0,0 +1,18 @@
+import type { ChatMessage } from './types';
+export declare const CHAT_HISTORY_QUERY_KEY = "chatHistory";
+/**
+ * Hook that calls the clear history API and updates the cache.
+ *
+ * @internal
+ */
+export declare const useClearChatHistory: (chatId: string | undefined) => import("@tanstack/react-query").UseMutationResult<void, unknown, void, unknown>;
+/**
+ * Hook that calls the get chat API and handles errors by clearing the history.
+ *
+ * @internal
+ */
+export declare const useChatHistory: (chatId: string | undefined) => {
+    history: ChatMessage[] | undefined;
+    isLoading: boolean;
+    isError: boolean;
+};

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

@@ -1,2 +1,4 @@
 export declare const UNEXPECTED_ERROR = "Oh snap, something went wrong. Please try again later.";
 export declare const UNEXPECTED_CHAT_RESPONSE_ERROR = "Oh snap, something went wrong. Please try again later or try asking a different question.";
+export declare const FETCH_HISTORY_ERROR = "Something went wrong and we were unable to retrieve the chat thread. Let's start over!";
+export declare const CHAT_UNAVAILABLE_ERROR = "Chat unavailable. Please try again later.";

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

@@ -1,4 +1,4 @@
-import type { ChatContext, ChatMessage, ChatResponse } from './types';
+import type { ChatContext, ChatResponse } from './types';
 /**
  * @internal
  */
@@ -17,18 +17,7 @@ export declare const useGetAllChats: () => {
 /**
  * @internal
  */
-export declare const useMaybeCreateChat: (contextId: string | undefined, shouldCreate: boolean) => void;
-/**
- * @internal
- */
-export declare const useGetChatHistory: (id: string | undefined) => {
-    data: ChatMessage[] | undefined;
-    isLoading: boolean;
-};
-/**
- * @internal
- */
-export declare const useClearChatHistory: (chatId: string | undefined) => import("@tanstack/react-query").UseMutationResult<void, unknown, void, unknown>;
+export declare const useMaybeCreateChat: (contextId: string | undefined, shouldCreate: boolean) => import("@tanstack/react-query").UseMutationResult<import("./types").Chat | undefined, unknown, void, unknown>;
 export declare const useSendChatMessage: (chatId: string | undefined) => {
     mutate: import("@tanstack/react-query").UseMutateFunction<ChatResponse | undefined, unknown, string, void>;
     isLoading: boolean;

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

@@ -7,11 +7,6 @@ export interface ChatContext {
     description: string;
 }
 export type ChatContextType = 'datamodel' | 'perspective';
-interface TextMessage {
-    role: 'assistant';
-    content: string;
-    type: 'Text';
-}
 export interface NlqMessage {
     role: 'assistant';
     content: string;
@@ -21,8 +16,7 @@ interface RegularMessage {
     role: 'user' | 'assistant';
     content: string;
 }
-type SystemMessage = NlqMessage | TextMessage;
-export type ChatMessage = RegularMessage | SystemMessage;
+export type ChatMessage = RegularMessage | NlqMessage;
 export interface Chat {
     chatId: string;
     contextId: string;
@@ -54,7 +48,15 @@ interface TextResponse {
         answer: string;
     };
     chatId: string;
-    responseType: 'Text';
+    responseType: 'text';
+}
+interface ErrorResponse {
+    data: {
+        message: string;
+        code: string;
+        answer: string;
+    };
+    responseType: 'error';
 }
 export type KeysOfUnion<T> = T extends T ? keyof T : never;
 export type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
@@ -86,7 +88,7 @@ export interface NlqResponse {
     timestamp: string;
     responseType: 'nlq';
 }
-export type ChatResponse = NlqResponse | TextResponse;
+export type ChatResponse = NlqResponse | TextResponse | ErrorResponse;
 export interface QueryRecommendationConfig {
     numOfRecommendations: number;
 }

package/dist/ai/chat-style-provider.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+export interface ChatStyle {
+    backgroundColor?: string;
+    primaryTextColor?: string;
+    secondaryTextColor?: string;
+    messageBackgroundColor?: string;
+    inputBackgroundColor?: string;
+    border?: false | string;
+}
+export type ChatStyleProviderProps = {
+    children: ReactNode;
+    value: ChatStyle;
+};
+export declare const useChatStyle: () => ChatStyle;
+export declare const ChatStyleProvider: ({ children, value }: ChatStyleProviderProps) => JSX.Element;

package/dist/ai/chatbot.d.ts

@@ -1,5 +1,6 @@
 import { CSSProperties } from 'react';
 import { ChatConfig } from './chat-config';
+import { ChatStyle } from './chat-style-provider';
 /**
  * Props for {@link Chatbot} component.
  */
@@ -16,6 +17,12 @@ export type ChatbotProps = {
      * If not specified, a default height of `900px` will be used.
      */
     height?: CSSProperties['height'];
+    /**
+     * Style settings for the chatbot
+     *
+     * @internal
+     */
+    style?: ChatStyle;
     /**
      * Various configuration options for the chatbot
      */

package/dist/ai/{error-page.d.ts → common/error-container.d.ts}

@@ -6,5 +6,5 @@ type ErrorPageProps = {
         onClick: () => void;
     };
 };
-export default function ErrorPage({ text, action }: ErrorPageProps): JSX.Element;
+export default function ErrorContainer({ text, action }: ErrorPageProps): JSX.Element;
 export {};

package/dist/ai/suggestions/suggestion-item.d.ts

@@ -3,5 +3,4 @@ export interface SuggestedItemProps {
     question: string;
     onClick: () => void;
 }
-declare const SuggestionItem: React.FC<SuggestedItemProps>;
-export default SuggestionItem;
+export default function SuggestionItem({ question, onClick }: SuggestedItemProps): JSX.Element;

package/dist/ai/use-chat-session.d.ts

@@ -11,6 +11,7 @@ export interface UseChatSessionResult {
     sendMessage: (message: string) => void;
     isAwaitingResponse: boolean;
     isLoading: boolean;
+    lastError: Error | null;
 }
 export declare const isNlqMessage: (message: ChatMessage | null | undefined) => message is NlqMessage;
 /**