@sisense/sdk-ui 0.13.0 → 0.15.0

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

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+import { ChatRestApi } from './chat-rest-api';
+export declare const useChatApi: () => ChatRestApi | undefined;
+/**
+ * React component that allows wrapped components to access the AI Chat API on a
+ * Sisense instance. Depends on {@link SisenseContextProvider}.
+ *
+ * @internal
+ */
+export declare const ChatApiContextProvider: ({ children }: {
+    children: ReactNode;
+}) => JSX.Element;

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

@@ -0,0 +1,28 @@
+import { HttpClient } from '@sisense/sdk-rest-client';
+import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, DataModel, GetNlgQueryResultRequest, GetNlgQueryResultResponse, LlmConfig, Perspective, QueryRecommendationResponse } from './types';
+export declare class ChatRestApi {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    getDataModels: () => Promise<DataModel[]>;
+    getPerspectives: () => Promise<Perspective[]>;
+    private getNlgQueryResult;
+    private getQueryRecommendations;
+    private setLlmConfig;
+    private getAllChats;
+    private getChatById;
+    private createChat;
+    private postChat;
+    private deleteChatHistory;
+    ai: {
+        getNlgQueryResult: (request: GetNlgQueryResultRequest) => Promise<GetNlgQueryResultResponse>;
+        getQueryRecommendations: (contextId: string) => Promise<QueryRecommendationResponse>;
+        setLlmConfig: (config: LlmConfig) => Promise<unknown>;
+        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>;
+        };
+    };
+}

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

@@ -0,0 +1,74 @@
+import type { ChatContext } from './types';
+/**
+ * @internal
+ */
+export declare const useDataTopics: () => {
+    data: ChatContext[] | undefined;
+    isLoading: boolean;
+};
+/**
+ * @internal
+ */
+export declare const useChats: () => {
+    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 or perspective ID */
+    contextId: string;
+}
+/**
+ * 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[];
+    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;
+    isLoading: boolean;
+    refetch: () => void;
+};

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

@@ -0,0 +1,139 @@
+import { MetadataItem } from '@sisense/sdk-query-client';
+export interface ChatContext {
+    id: string;
+    name: string;
+    type: ChatContextType;
+    description: string;
+}
+export type ChatContextType = 'dashboard' | 'datamodel' | 'global' | 'perspective';
+interface TextMessage {
+    role: 'assistant';
+    content: string;
+    type: 'Text';
+}
+export interface NlqMessage {
+    role: 'assistant';
+    content: string;
+    type: 'nlq';
+}
+interface RegularMessage {
+    role: 'user' | 'assistant';
+    content: string;
+}
+type SystemMessage = NlqMessage | TextMessage;
+export type ChatMessage = RegularMessage | SystemMessage;
+export interface Chat {
+    chatId: string;
+    contextId: string;
+    contextType: ChatContextType;
+    contextTitle: string;
+    lastUpdate: string;
+    tenantId: string;
+    userId: string;
+    chatHistory: ChatMessage[];
+}
+export type ChatWithoutHistory = Omit<Chat, 'chatHistory'>;
+export interface LlmConfig {
+    provider: string;
+    apiKey: string;
+    baseUrl: string;
+    model: string;
+    version?: string;
+}
+export interface ChatRequest {
+    text?: string;
+    timezone?: string;
+    options?: {
+        enableFollowup?: boolean;
+    };
+}
+interface TextResponse {
+    chatHistory: ChatMessage[];
+    data: {
+        answer: string;
+    };
+    chatId: string;
+    responseType: 'Text';
+}
+export interface AxesMapping {
+    category?: {
+        name: string;
+        type: string;
+    }[];
+    value?: {
+        name: string;
+        type: string;
+    }[];
+    breakBy?: {
+        name: string;
+        type: string;
+    }[];
+}
+export interface ChartRecommendations {
+    chartFamily: string;
+    chartType: string;
+    axesMapping: AxesMapping;
+}
+export interface NlqResponseData {
+    detailedDescription: string;
+    followupQuestions: string[];
+    nlqPrompt: string;
+    chartRecommendations: ChartRecommendations;
+    jaql: {
+        datasource?: {
+            title: string;
+        };
+        metadata: MetadataItem[];
+    };
+    queryTitle: string;
+}
+export interface NlqResponse {
+    data: NlqResponseData;
+    timestamp: string;
+    responseType: 'nlq';
+}
+export type ChatResponse = NlqResponse | TextResponse;
+export interface QueryRecommendation {
+    query: string;
+    jaql: object;
+}
+export interface QueryRecommendationResponse {
+    data: {
+        answer: QueryRecommendation[];
+    };
+    responseType: 'Array';
+}
+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;
+    isDefault: boolean;
+    tenantId: string;
+}
+export interface GetNlgQueryResultRequest {
+    style: 'Small' | 'Medium' | 'Large';
+    jaql: {
+        datasource: {
+            title: string;
+        };
+        metadata: unknown[];
+    };
+}
+export interface GetNlgQueryResultResponse {
+    data?: {
+        answer: string;
+    };
+    responseType: 'Text';
+}
+export {};

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

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

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

@@ -0,0 +1,8 @@
+import { CSSProperties, ReactNode } from 'react';
+type ChatFrameProps = {
+    width?: CSSProperties['width'];
+    height?: CSSProperties['height'];
+    children: ReactNode;
+};
+export default function ChatFrame({ width, height, children, }: ChatFrameProps): JSX.Element;
+export {};

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

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

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export type ChatInputProps = {
+    onSendMessage: (message: string) => void;
+    onClearHistoryClick?: () => void;
+    disabled?: boolean;
+};
+export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, }: ChatInputProps): JSX.Element;

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

@@ -0,0 +1,11 @@
+import { ReactNode } from 'react';
+import { ChatContext } from './api/types';
+type ChatbotContextProviderProps = {
+    children: ReactNode;
+};
+export declare const useChatbotContext: () => {
+    selectedContext?: ChatContext | undefined;
+    setSelectedContext: (context: ChatContext | undefined) => void;
+};
+export declare function ChatbotContextProvider({ children }: ChatbotContextProviderProps): JSX.Element;
+export {};

package/dist/ai/chatbot.d.ts

@@ -0,0 +1,27 @@
+import { CSSProperties } from 'react';
+/**
+ * Props for {@link Chatbot} component.
+ *
+ * @internal
+ */
+export type ChatbotProps = {
+    /**
+     * Total width of the chatbot
+     *
+     * If not specified, a default width of 500px will be used
+     */
+    width?: CSSProperties['width'];
+    /**
+     * Total height of the chatbot
+     *
+     * If not specified, a default height of 500px will be used
+     */
+    height?: CSSProperties['height'];
+};
+/**
+ * React component that renders a chatbot with data topic selection.
+ *
+ * @param props - {@link ChatbotProps}
+ * @internal
+ */
+export declare const Chatbot: import("react").FunctionComponent<ChatbotProps>;

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+type Props = {
+    title: string;
+    description?: string;
+    onClick?: () => void;
+};
+export default function DataTopicItem(props: Props): JSX.Element;
+export {};

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

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+export interface DataTopic {
+    title: string;
+    description: string;
+    onClick?: () => void;
+}
+export interface Props {
+    dataTopics: DataTopic[];
+}
+export default function DataTopicList(props: Props): JSX.Element;

package/dist/ai/data-topics/index.d.ts

@@ -0,0 +1,2 @@
+export { default as DataTopicItem } from './data-topic-item';
+export { default as DataTopicList } from './data-topic-list';

package/dist/ai/icons/arrow-left-icon.d.ts

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

package/dist/ai/icons/clear-chat-icon.d.ts

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

package/dist/ai/icons/close-dialog-icon.d.ts

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

package/dist/ai/icons/expand-icon.d.ts

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

package/dist/ai/icons/info-icon.d.ts

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

package/dist/ai/icons/light-bulb-icon.d.ts

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

package/dist/ai/icons/loading-dots-icon.d.ts

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

package/dist/ai/icons/magic-wand-icon.d.ts

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

package/dist/ai/icons/message-icon.d.ts

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

package/dist/ai/icons/refresh-icon.d.ts

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

package/dist/ai/icons/sisense-logo.d.ts

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

package/dist/ai/icons/three-dots-icon.d.ts

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

package/dist/ai/index.d.ts

@@ -0,0 +1,4 @@
+export { ChatApiContextProvider } from './api/chat-api-context';
+export { useGetNlgQueryResult, useGetQueryRecommendations, type UseGetNlgQueryResultParams, type UseGetQueryRecommendationsParams, } from './api/hooks';
+export { Chatbot, type ChatbotProps } from './chatbot';
+export { default as NlgQueryResult, type NlgQueryResultProps } from './nlg-query-result';

package/dist/ai/magic-wand-dropdown.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export default function MagicWandDropdown({ questions, onSelection, isLoading, anchorEl, }: {
+    questions: string[];
+    onSelection: (question: string) => void;
+    isLoading: boolean;
+    anchorEl: Element | null;
+}): JSX.Element;

package/dist/ai/messages/chart-message-toolbar.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+type ChartMessageToolbarProps = {
+    infoTooltipText?: string;
+    onRefresh: () => void;
+    onExpand: () => void;
+};
+export default function ChartMessageToolbar({ infoTooltipText, onRefresh, onExpand, }: ChartMessageToolbarProps): JSX.Element;
+export {};

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { NlqResponseData } from '../api/types';
+type ChartMessageProps = {
+    content: NlqResponseData;
+    dataSource: string;
+};
+export default function ChartMessage({ content, dataSource }: ChartMessageProps): JSX.Element;
+export {};

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export type ClearHistoryMessageProps = {
+    onConfirm: () => void;
+    onCancel: () => void;
+};
+export default function ClearHistoryMessage({ onCancel, onConfirm }: ClearHistoryMessageProps): JSX.Element;

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

@@ -0,0 +1,13 @@
+import { MetadataItem } from '@sisense/sdk-query-client';
+import { CartesianChartDataOptions, CategoricalChartDataOptions, StyleOptions } from '../../types';
+import { ChartRecommendations } from '../api/types';
+export declare const getTableOptions: (jaql: MetadataItem[]) => {
+    dataOptions: {
+        columns: import("./jaql-element").JaqlElement[];
+    };
+};
+export declare const getChartOptions: (jaql: MetadataItem[], chartRecs: ChartRecommendations) => {
+    dataOptions: CartesianChartDataOptions | CategoricalChartDataOptions;
+    styleOptions: StyleOptions;
+    expandedStyleOptions: StyleOptions;
+};

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

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+export declare function InsightsSummary({ summary }: {
+    summary: string;
+}): JSX.Element;
+type InsightsMessageProps = {
+    dataSource: string;
+    metadata: unknown[];
+};
+export default function InsightsMessage({ dataSource, metadata }: InsightsMessageProps): JSX.Element;
+export {};

package/dist/ai/messages/jaql-element.d.ts

@@ -0,0 +1,25 @@
+import { DimensionalElement } from '@sisense/sdk-data';
+import { MetadataItem } from '@sisense/sdk-query-client';
+/**
+ * This implementation wraps metadata for a JAQL query. The metadata could be
+ * for a dimension, measure, or filter. We do little to no interpretation of
+ * the JAQL as it is designed to be "passed through" to the query execution
+ * step.
+ *
+ * This will typically be used for JAQL metadata that is coming from a Sisense
+ * instance and is assumed to be correct (e.g. dashboard widget, NLQ
+ * suggestion).
+ *
+ * @param item - the metadata item in a JAQL query
+ * @param type - the data type of the dimension
+ * @internal
+ */
+export declare class JaqlElement extends DimensionalElement {
+    private metadataItem;
+    expression: string;
+    skipValidation: boolean;
+    constructor(item: MetadataItem, type: string);
+    get id(): string;
+    jaql(): MetadataItem;
+}
+export declare function createJaqlElement(item: MetadataItem): JaqlElement;

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { ChatMessage } from '../api/types';
+export type MessageListResolverProps = {
+    messages: ChatMessage[];
+    sendMessage?: (message: string) => void;
+};
+export default function MessageListResolver({ messages, sendMessage, }: MessageListResolverProps): JSX.Element;

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

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+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 const _default: import("react").MemoExoticComponent<typeof MessageResolver>;
+export default _default;

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

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

package/dist/ai/nav-back-button.d.ts

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

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

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+/**
+ * Props for {@link NlgQueryResult} component.
+ *
+ * @internal
+ */
+export type NlgQueryResultProps = {
+    /** 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[];
+};
+/**
+ * Fetch and display a collapsible analysis of the provided JAQL.
+ *
+ * @param props - {@link NlgQueryResultProps}
+ * @returns A response object containing a text summary
+ * @internal
+ */
+export default function NlgQueryResult(props: NlgQueryResultProps): JSX.Element;

package/dist/ai/suggestions/index.d.ts

@@ -0,0 +1,4 @@
+export { default as SuggestionItem } from './suggestion-item';
+export { default as SuggestionList } from './suggestion-list';
+export { default as SuggestionListWithIntro } from './suggestions-with-intro';
+export { default as SuggestionListSkeleton } from './suggestion-list-skeleton';

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+type SuggestionDropdownItemProps = {
+    onClick: () => void;
+    text: string;
+};
+export default function SuggestionDropdownItem(props: SuggestionDropdownItemProps): JSX.Element;
+export {};

package/dist/ai/suggestions/suggestion-dropdown-list.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface SuggestionDropdownListProps {
+    onSelect: (selection: string) => void;
+    suggestions: string[];
+    isLoading: boolean;
+}
+export default function SuggestionDropdownList(props: SuggestionDropdownListProps): JSX.Element;

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface SuggestedItemProps {
+    question: string;
+    onClick: () => void;
+}
+declare const SuggestionItem: React.FC<SuggestedItemProps>;
+export default SuggestionItem;

package/dist/ai/suggestions/suggestion-list-skeleton.d.ts

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

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+type Props = {
+    questions: string[];
+    onSelection: (question: string) => void;
+};
+export default function SuggestionList(props: Props): JSX.Element;
+export {};

package/dist/ai/suggestions/suggestions-with-intro.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+type Props = {
+    questions: string[];
+    title: string;
+    onSelection: (question: string) => void;
+};
+export default function SuggestionsWithIntro(props: Props): JSX.Element;
+export {};

package/dist/ai/toolbar.d.ts

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

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

@@ -0,0 +1,22 @@
+import type { ChatMessage } from './api/types';
+interface UseChatSessionResult {
+    history: ChatMessage[];
+    clearHistory: () => void;
+    sendMessage: (message: string) => void;
+    isAwaitingResponse: boolean;
+    isLoading: boolean;
+}
+/**
+ * React hook that returns a chat session object for the given data model or
+ * perspective.
+ *
+ * Maintains chat history and updates when a message is sent/received or when
+ * history is cleared.
+ *
+ * If a chat session does not already exist, then one is created.
+ *
+ * @param contextTitle - the title of the data model or perspective
+ * @internal
+ */
+export declare const useChatSession: (contextTitle: string) => UseChatSessionResult;
+export {};

package/dist/ai.d.ts

@@ -0,0 +1 @@
+export * from './ai/index'