@sisense/sdk-ui 1.11.0 → 1.13.0

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;
@@ -25,7 +24,7 @@ export declare class ChatRestApi {
         chat: {
             getAll: () => Promise<ChatWithoutHistory[]>;
             getById: (chatId: string) => Promise<Chat>;
-            create: (contextId: string) => Promise<Chat>;
+            create: (sourceId: string) => Promise<Chat>;
             post: (chatId: string, request: ChatRequest) => Promise<ChatResponse>;
             clearHistory: (chatId: string) => Promise<void>;
         };

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/buttons/thumbs-down-button.d.ts

@@ -1,5 +1,6 @@
 type ThumbsDownButtonProps = {
     onClick?: () => void;
+    disabled?: boolean;
 };
-export default function ThumbsDownButton({ onClick }: ThumbsDownButtonProps): import("react/jsx-runtime").JSX.Element;
+export default function ThumbsDownButton({ onClick, disabled }: ThumbsDownButtonProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/ai/buttons/thumbs-up-button.d.ts

@@ -1,5 +1,6 @@
 type ThumbsUpButtonProps = {
     onClick?: () => void;
+    disabled?: boolean;
 };
-export default function ThumbsUpButton({ onClick }: ThumbsUpButtonProps): import("react/jsx-runtime").JSX.Element;
+export default function ThumbsUpButton({ onClick, disabled }: ThumbsUpButtonProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -37,8 +37,18 @@ export interface ChatConfig {
      * The welcome text to show at the top of a chat session.
      *
      * A value of `false` will hide the welcome text.
+     *
+     * If not specified, a default message will be displayed.
      */
     welcomeText?: string | false;
+    /**
+     * The message text to show above the initial suggested questions in a chat session.
+     *
+     * A value of `false` will hide the text.
+     *
+     * If not specified, a default message will be displayed.
+     */
+    suggestionsWelcomeText?: string | false;
     /**
      * Boolean flag to show or hide the header in a chat session.
      *
@@ -53,6 +63,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-dropup.d.ts

@@ -6,6 +6,7 @@ interface ChatDropupProps {
     onSelection: (q: string) => void;
     anchorEl: HTMLElement | null;
     text: string;
+    recommendationsError: boolean;
 }
-export default function ChatDropup({ recentPrompts, suggestions, isLoading, onSelection, anchorEl, text, }: ChatDropupProps): import("react/jsx-runtime").JSX.Element;
+export default function ChatDropup({ recentPrompts, suggestions, isLoading, onSelection, anchorEl, text, recommendationsError, }: ChatDropupProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -5,5 +5,7 @@ export type ChatInputProps = {
     recentPrompts: string[];
     suggestions: string[];
     isLoading: boolean;
+    recommendationsError: boolean;
+    onChange?: (text: string) => void;
 };
-export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, recentPrompts, suggestions, isLoading, }: ChatInputProps): import("react/jsx-runtime").JSX.Element;
+export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, recentPrompts, suggestions, isLoading, recommendationsError, onChange, }: ChatInputProps): import("react/jsx-runtime").JSX.Element;

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

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

package/dist/ai/common/icon-button.d.ts

@@ -1,12 +1,11 @@
 /// <reference types="react" />
 import { type IconButtonProps as MuiIconButtonProps } from '@mui/material/IconButton';
-import { CompleteThemeSettings } from '../../types';
 interface IconButtonProps extends MuiIconButtonProps {
-    $themeSettings?: CompleteThemeSettings;
+    $hoverColor?: string;
 }
 declare const IconButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "sx" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+}, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
     theme?: import("@emotion/react").Theme | undefined;
 } & IconButtonProps, {}, {}>;
 export default IconButton;

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/icons/light-bulb-icon.d.ts

@@ -1,3 +1 @@
-export default function LightBulbIcon({ hover }: {
-    hover?: boolean;
-}): import("react/jsx-runtime").JSX.Element;
+export default function LightBulbIcon(): import("react/jsx-runtime").JSX.Element;

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/index.d.ts

@@ -3,6 +3,7 @@ export { type ChatConfig } from './chat-config';
 export { useGetNlgQueryResult, type UseGetNlgQueryResultParams, type UseGetNlgQueryResultState, } from './use-get-nlg-query-result';
 export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type UseGetQueryRecommendationsState, } from './use-get-query-recommendations';
 export { useChatSession, type UseChatSessionResult } from './use-chat-session';
+export { useLastNlqResponse } from './use-last-nlq-response';
 export { useGetDataSourceFields } from './use-get-data-source-fields';
 export type { GetNlgQueryResultRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, ChartRecommendations, AxesMapping, AxesMappingKey, AllPossibleChartOptionKeys, KeysOfUnion, } from './api/types';
 export { Chatbot, type ChatbotProps } from './chatbot';

package/dist/ai/messages/clickable-message.d.ts

@@ -6,6 +6,7 @@ type Props = {
     disabled?: boolean;
     onMouseEnter?: () => void;
     onMouseLeave?: () => void;
+    accessibleName?: string;
 };
-export default function ClickableMessage({ children, align, onClick, onMouseEnter, onMouseLeave, }: Props): import("react/jsx-runtime").JSX.Element;
+export default function ClickableMessage({ children, align, onClick, onMouseEnter, onMouseLeave, accessibleName, }: Props): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/ai/messages/feedback-wrapper.d.ts

@@ -4,7 +4,7 @@ type FeedbackWrapperProps = {
     data: object;
     type: string;
     buttonVisibility?: 'onHover' | 'always' | 'never';
-    children: ReactNode;
+    renderContent: (buttonRow: JSX.Element) => ReactNode;
 };
-export default function FeedbackWrapper({ sourceId, data, type, buttonVisibility, children, }: FeedbackWrapperProps): import("react/jsx-runtime").JSX.Element;
+export default function FeedbackWrapper({ sourceId, data, type, buttonVisibility, renderContent, }: FeedbackWrapperProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/ai/messages/text-message.d.ts

@@ -1,6 +1,11 @@
+import { Themable } from '../../theme-provider/types';
 import { FC, PropsWithChildren } from 'react';
 type Alignable = {
     align: 'left' | 'right' | 'full';
 };
+export declare const MessageContainer: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
+} & Themable & Alignable, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
 declare const TextMessage: FC<PropsWithChildren<Alignable>>;
 export default TextMessage;

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-last-nlq-response.d.ts

@@ -0,0 +1,19 @@
+import type { NlqResponseData } from './api/types';
+/**
+ * Parameters for the useLastNlqResponse hook.
+ *
+ * @internal
+ */
+interface UseLastNlqResponseParams {
+    /** The title of the data model or perspective */
+    contextTitle: string;
+}
+/**
+ * React hook that returns the last NLQ response for the chat that corresponds
+ * to the given data model or perspective.
+ *
+ * @param params - Parameters for the hook
+ * @internal
+ */
+export declare const useLastNlqResponse: ({ contextTitle, }: UseLastNlqResponseParams) => NlqResponseData | null;
+export {};