@sisense/sdk-ui 1.3.0 → 1.4.0

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

@@ -0,0 +1,32 @@
+import { ReactNode } from 'react';
+import { ChatConfig } from './chat-config';
+export type AiContextProviderProps = {
+    children: ReactNode;
+    /** @internal */
+    config?: Partial<ChatConfig>;
+};
+/**
+ * React component that wraps all generative AI components and hooks.
+ *
+ * ::: warning Note
+ * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ * import { AiContextProvider, Chatbot } from '@sisense/sdk-ui/ai';
+ *
+ * function App() {
+ *   return (
+ *     <SisenseContextProvider {...sisenseContextProps}>
+ *       <AiContextProvider>
+ *         <Chatbot />
+ *       </AiContextProvider>
+ *     </SisenseContextProvider>
+ *   );
+ * }
+ * ```
+ * @beta
+ */
+export default function AiContextProvider({ children, config }: AiContextProviderProps): JSX.Element;

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

@@ -0,0 +1,17 @@
+import { ReactNode } from 'react';
+import { ChatRestApi } from './chat-rest-api';
+/**
+ * Exported for testing purposes only.
+ *
+ * @internal
+ */
+export declare const ChatApiContext: import("react").Context<ChatRestApi | undefined>;
+export declare const useChatApi: () => ChatRestApi | undefined;
+/**
+ * React component
+ *
+ * @internal
+ */
+export declare const ChatApiProvider: ({ children }: {
+    children: ReactNode;
+}) => JSX.Element;

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

@@ -1,5 +1,5 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
-import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, DataModel, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, Perspective, QueryRecommendationConfig, QueryRecommendationResponse } from './types';
+import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, DataModel, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, Perspective, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest } from './types';
 export declare class ChatRestApi {
     private httpClient;
     constructor(httpClient: HttpClient);
@@ -13,10 +13,12 @@ export declare class ChatRestApi {
     private createChat;
     private postChat;
     private deleteChatHistory;
+    private sendFeedback;
     ai: {
         getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse>;
         getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;
+        sendFeedback: (request: SendFeedbackRequest) => Promise<unknown>;
         chat: {
             getAll: () => Promise<ChatWithoutHistory[]>;
             getById: (chatId: string) => Promise<Chat>;

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

@@ -0,0 +1 @@
+export declare const UNKNOWN_ERROR = "Oh snap, something went wrong. Please try again later or try asking a different question.";

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

@@ -1,74 +1,35 @@
-import type { ChatContext } from './types';
+import type { ChatContext, ChatMessage, ChatResponse } from './types';
 /**
  * @internal
  */
-export declare const useDataTopics: () => {
+export declare const useGetDataTopics: () => {
     data: ChatContext[] | undefined;
     isLoading: boolean;
+    fetchStatus: import("@tanstack/react-query").FetchStatus;
 };
 /**
  * @internal
  */
-export declare const useChats: () => {
+export declare const useGetAllChats: () => {
     data: import("./types").ChatWithoutHistory[];
     isLoading: boolean;
-    refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<import("./types").ChatWithoutHistory[] | undefined, unknown>>;
 };
 /**
  * @internal
  */
-export declare const useChat: (id: string | undefined) => {
-    data: import("./types").Chat | undefined;
-    isLoading: boolean;
-    refetch: () => void;
-};
-/**
- * Parameters for {@link useQueryRecommendations} hook.
- *
- * @internal
- */
-export interface UseGetQueryRecommendationsParams {
-    /** Data model title or perspective title */
-    contextTitle: string;
-}
+export declare const useMaybeCreateChat: (contextId: string | undefined, shouldCreate: boolean) => void;
 /**
- * Fetch recommended questions for a data model or perspective.
- *
- * @param params - {@link UseQueryRecommendationsParams}
- * @returns An array of questions
  * @internal
  */
-export declare function useGetQueryRecommendations(params: UseGetQueryRecommendationsParams): {
-    data: string[];
+export declare const useGetChatHistory: (id: string | undefined) => {
+    data: ChatMessage[] | undefined;
     isLoading: boolean;
 };
 /**
- * Parameters for {@link useNlgQueryResult} hook.
- *
- * @internal
- */
-export interface UseGetNlgQueryResultParams {
-    /** The data source that the JAQL metadata targets - e.g. `Sample ECommerce` */
-    dataSource: string;
-    /** The metadata that composes the JAQL to be analyzed */
-    metadata: unknown[];
-    /**
-     * Boolean flag to enable/disable API call by default
-     *
-     * If not specified, the default value is `true`
-     */
-    enabled?: boolean;
-}
-/**
- * Fetch an analysis of the provided JAQL.
- *
- * @param params - {@link UseNlgQueryResultParams}
- * @returns A response object containing a text summary
  * @internal
  */
-export declare const useGetNlgQueryResult: (params: UseGetNlgQueryResultParams) => {
-    data: string | undefined;
-    isError: boolean;
+export declare const useClearChatHistory: (chatId: string | undefined) => import("@tanstack/react-query").UseMutationResult<void, unknown, void, unknown>;
+export declare const useSendChatMessage: (chatId: string | undefined) => {
+    mutate: import("@tanstack/react-query").UseMutateFunction<ChatResponse | undefined, unknown, string, void>;
     isLoading: boolean;
-    refetch: () => void;
 };

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

@@ -6,7 +6,7 @@ export interface ChatContext {
     type: ChatContextType;
     description: string;
 }
-export type ChatContextType = 'dashboard' | 'datamodel' | 'global' | 'perspective';
+export type ChatContextType = 'datamodel' | 'perspective';
 interface TextMessage {
     role: 'assistant';
     content: string;
@@ -56,9 +56,9 @@ interface TextResponse {
     chatId: string;
     responseType: 'Text';
 }
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
-type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
+export type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type AllPossibleChartOptionKeys = KeysOfUnion<ChartDataOptions>;
+export type AxesMappingKey = Exclude<AllPossibleChartOptionKeys, 'seriesToColorMap'>;
 export type AxesMapping = Partial<Record<AxesMappingKey, Array<{
     name: string;
     type: string;
@@ -72,9 +72,9 @@ export interface NlqResponseData {
     detailedDescription: string;
     followupQuestions: string[];
     nlqPrompt: string;
-    chartRecommendations: ChartRecommendations;
+    chartRecommendations: ChartRecommendations | {};
     jaql: {
-        datasource?: {
+        datasource: {
             title: string;
         };
         metadata: MetadataItem[];
@@ -90,43 +90,26 @@ export type ChatResponse = NlqResponse | TextResponse;
 export interface QueryRecommendationConfig {
     numOfRecommendations: number;
 }
-export interface QueryRecommendation {
-    nlqPrompt: string;
-    chartRecommendations: ChartRecommendations;
-    jaql: {
-        datasource?: {
-            title: string;
-        };
-        metadata: MetadataItem[];
-    };
-    queryTitle: string;
-    detailedDescription: string;
-}
+export type QueryRecommendation = Omit<NlqResponseData, 'followupQuestions'>;
 export type QueryRecommendationResponse = QueryRecommendation[];
 export interface DataModel {
     oid: string;
     title: string;
 }
 export interface Perspective {
-    _id: string;
     oid: string;
-    datamodelOid: string;
-    description: string;
-    tables: any[];
-    lastUpdated: string;
-    createdTime: string;
-    parentOid: string | null;
     name: string;
-    creator: string;
+    description: string;
     isDefault: boolean;
-    tenantId: string;
 }
 export interface GetNlgQueryResultRequest {
     style: 'Small' | 'Medium' | 'Large';
     jaql: {
+        /** The data source that the JAQL metadata targets - e.g. `Sample ECommerce` */
         datasource: {
             title: string;
         };
+        /** The metadata that composes the JAQL to be analyzed */
         metadata: unknown[];
     };
 }
@@ -136,4 +119,10 @@ export interface GetNlgQueryResultResponse {
     };
     responseType: 'Text';
 }
+export interface SendFeedbackRequest {
+    type: string;
+    data: object;
+    sourceId: string;
+    rating: -1 | 1;
+}
 export {};

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+type ThumbsDownButtonProps = {
+    onClick?: () => void;
+};
+export default function ThumbsDownButton({ onClick }: ThumbsDownButtonProps): JSX.Element;
+export {};

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+type ThumbsUpButtonProps = {
+    onClick?: () => void;
+};
+export default function ThumbsUpButton({ onClick }: ThumbsUpButtonProps): JSX.Element;
+export {};

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-import { ChatContext } from './api/types';
 export type ChatBoxProps = {
-    selectedContext: ChatContext;
+    contextTitle: string;
+    onGoBack?: () => void;
 };
-export default function ChatBox({ selectedContext }: ChatBoxProps): JSX.Element;
+export default function ChatBox({ contextTitle, onGoBack }: ChatBoxProps): JSX.Element;

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

@@ -0,0 +1,28 @@
+import { ReactNode } from 'react';
+export interface ChatConfig {
+    /**
+     * Boolean flag to show or hide suggested questions following a chat response
+     *
+     * If not specified, the default value is `false`
+     */
+    enableFollowupQuestions: boolean;
+    /**
+     * Number of recommended queries that should be shown in a chat session
+     *
+     * If not specified, the default value is `4`
+     */
+    numOfRecommendations: number;
+    /**
+     * The default context (data model or perspective) title to use for a chat session
+     *
+     * If specified, the data topic selector screen will not be shown.
+     */
+    defaultContextTitle?: string;
+}
+export declare const DEFAULTS: Readonly<ChatConfig>;
+export type ChatConfigProviderProps = {
+    children: ReactNode;
+    value: Partial<ChatConfig>;
+};
+export declare const useChatConfig: () => ChatConfig;
+export declare const ChatConfigProvider: ({ children, value }: ChatConfigProviderProps) => JSX.Element;

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

@@ -1,2 +1,6 @@
 /// <reference types="react" />
-export default function ChatHome(): JSX.Element;
+type ChatHomeProps = {
+    onDataTopicClick: (title: string) => void;
+};
+export default function ChatHome({ onDataTopicClick }: ChatHomeProps): JSX.Element;
+export {};

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

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ChatRouter(): JSX.Element;

package/dist/ai/chatbot.d.ts

@@ -1,8 +1,7 @@
 import { CSSProperties } from 'react';
+import { ChatConfig } from './chat-config';
 /**
  * Props for {@link Chatbot} component.
- *
- * @internal
  */
 export type ChatbotProps = {
     /**
@@ -17,11 +16,34 @@ export type ChatbotProps = {
      * If not specified, a default height of 500px will be used
      */
     height?: CSSProperties['height'];
+    /**
+     * Various configuration options for the chatbot
+     */
+    config?: Partial<ChatConfig>;
 };
 /**
- * React component that renders a chatbot with data topic selection.
+ * 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 private beta for selected customers and is subject to change as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ * import { AiContextProvider, Chatbot } from '@sisense/sdk-ui/ai';
  *
+ * function App() {
+ *   return (
+ *     <SisenseContextProvider {...sisenseContextProps}>
+ *       <AiContextProvider>
+ *         <Chatbot width={1000} height={800} />
+ *       </AiContextProvider>
+ *     </SisenseContextProvider>
+ *   );
+ * }
+ * ```
  * @param props - {@link ChatbotProps}
- * @internal
+ * @beta
  */
 export declare const Chatbot: import("react").FunctionComponent<ChatbotProps>;

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

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

package/dist/ai/error-page.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+type ErrorPageProps = {
+    text: string;
+    action?: {
+        text: string;
+        onClick: () => void;
+    };
+};
+export default function ErrorPage({ text, action }: ErrorPageProps): JSX.Element;
+export {};

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

@@ -0,0 +1,78 @@
+/// <reference types="react" />
+import { GetNlgQueryResultRequest } from './api/types';
+/**
+ * Props for {@link GetNlgQueryResult} component.
+ */
+export type GetNlgQueryResultProps = GetNlgQueryResultRequest;
+/**
+ * React component that fetches and displays a collapsible analysis of the provided JAQL using natural language generation (NLG).
+ *
+ * This takes the same props as {@link useGetNlgQueryResult} and makes the same API call but presents the result in a collapsible container.
+ *
+ * ::: warning Note
+ * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
+ * :::
+ *
+ * @example
+ * ```tsx
+ * import { SisenseContextProvider } from '@sisense/sdk-ui';
+ * import { AiContextProvider, GetNlgQueryResult } from '@sisense/sdk-ui/ai';
+ *
+ * function Page() {
+ *   return (
+ *     <GetNlgQueryResult
+ *       dataSource="Sample ECommerce"
+ *       metadata={[
+ *         {
+ *           jaql: {
+ *             column: 'Date',
+ *             datatype: 'datetime',
+ *             dim: '[Commerce.Date]',
+ *             firstday: 'mon',
+ *             level: 'years',
+ *             table: 'Commerce',
+ *             title: 'Date',
+ *           },
+ *           format: {
+ *             mask: {
+ *               days: 'shortDate',
+ *               isdefault: true,
+ *               minutes: 'HH:mm',
+ *               months: 'MM/yyyy',
+ *               quarters: 'yyyy Q',
+ *               weeks: 'ww yyyy',
+ *               years: 'yyyy',
+ *             },
+ *           },
+ *         },
+ *         {
+ *           jaql: {
+ *             agg: 'sum',
+ *             column: 'Revenue',
+ *             datatype: 'numeric',
+ *             dim: '[Commerce.Revenue]',
+ *             table: 'Commerce',
+ *             title: 'total of Revenue',
+ *           },
+ *         },
+ *       ]}
+ *     />
+ *   );
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <SisenseContextProvider {...sisenseContextProps}>
+ *       <AiContextProvider>
+ *         <Page />
+ *       </AiContextProvider>
+ *     </SisenseContextProvider>
+ *   );
+ * }
+ * ```
+ * @param props - {@link GetNlgQueryResultProps}
+ * @returns Collapsible container wrapping a text summary
+ * @beta
+ */
+declare const _default: import("react").FunctionComponent<GetNlgQueryResultRequest>;
+export default _default;

package/dist/ai/icons/thumbs-down-hovered-icon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ThumbsDownHoveredIcon(): JSX.Element;

package/dist/ai/icons/thumbs-down-icon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ThumbsDownIcon(): JSX.Element;

package/dist/ai/icons/thumbs-up-hovered-icon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ThumbsUpHoveredIcon(): JSX.Element;

package/dist/ai/icons/thumbs-up-icon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ThumbsUpIcon(): JSX.Element;

package/dist/ai/index.d.ts

@@ -1,4 +1,7 @@
-export { ChatApiContextProvider } from './api/chat-api-context';
-export { useGetNlgQueryResult, useGetQueryRecommendations, type UseGetNlgQueryResultParams, type UseGetQueryRecommendationsParams, } from './api/hooks';
+export { default as AiContextProvider, type AiContextProviderProps } from './ai-context-provider';
+export { type ChatConfig } from './chat-config';
+export { useGetNlgQueryResult, type UseGetNlgQueryResultParams } from './use-get-nlg-query-result';
+export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, } from './use-get-query-recommendations';
+export type { GetNlgQueryResultRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, ChartRecommendations, AxesMapping, AxesMappingKey, AllPossibleChartOptionKeys, KeysOfUnion, } from './api/types';
 export { Chatbot, type ChatbotProps } from './chatbot';
-export { default as NlgQueryResult, type NlgQueryResultProps } from './nlg-query-result';
+export { default as GetNlgQueryResult, type GetNlgQueryResultProps } from './get-nlg-query-result';

package/dist/ai/loading-page.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function LoadingPage(): JSX.Element;

package/dist/ai/messages/clear-history-success-message.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function ClearHistorySuccessMessage(): JSX.Element;

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

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+type FeedbackWrapperProps = {
+    sourceId: string;
+    data: object;
+    type: string;
+    children: ReactNode;
+};
+export default function FeedbackWrapper({ sourceId, data, type, children }: FeedbackWrapperProps): JSX.Element;
+export {};

package/dist/ai/messages/get-widget-options.d.ts

@@ -1,6 +1,7 @@
 import { MetadataItem } from '@sisense/sdk-query-client';
 import { ChartDataOptions, ChartStyleOptions } from '../../types';
-import { ChartRecommendations } from '../api/types';
+import { ChartRecommendations, NlqResponseData } from '../api/types';
+export declare const getChartRecommendationsOrDefault: (response: NlqResponseData) => ChartRecommendations;
 export declare const getTableOptions: (jaql: MetadataItem[]) => {
     dataOptions: {
         columns: import("./jaql-element").JaqlElement[];

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

@@ -2,10 +2,9 @@
 import { ChatMessage } from '../api/types';
 type MessageResolverProps = {
     message: ChatMessage;
-    dataSource: string;
     sendMessage?: (message: string) => void;
     allowFollowupQuestions?: boolean;
 };
-declare function MessageResolver({ message, dataSource, allowFollowupQuestions, sendMessage, }: MessageResolverProps): JSX.Element;
+declare function MessageResolver({ message, allowFollowupQuestions, sendMessage, }: MessageResolverProps): JSX.Element;
 declare const _default: import("react").MemoExoticComponent<typeof MessageResolver>;
 export default _default;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 type Props = {
     children: string | JSX.Element;
-    align: 'left' | 'right';
+    align: 'left' | 'right' | 'full';
     onClick?: () => void;
 };
 export default function TextMessage({ children, align, onClick }: Props): JSX.Element;

package/dist/ai/toolbar.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import { ReactNode } from 'react';
 export interface Props {
     title: string;
-    leftNav: JSX.Element;
+    leftNav: ReactNode;
     rightNav?: JSX.Element;
 }
 declare const _default: import("react").ForwardRefExoticComponent<Props & import("react").RefAttributes<HTMLDivElement>>;

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

@@ -1,7 +1,7 @@
 import type { ChatMessage } from './api/types';
 interface UseChatSessionResult {
+    chatId: string | undefined;
     history: ChatMessage[];
-    clearHistory: () => void;
     sendMessage: (message: string) => void;
     isAwaitingResponse: boolean;
     isLoading: boolean;