@uptiqai/widgets-sdk 1.89.0 → 1.91.0

package/dist/index.d.ts

@@ -1,8 +1,12 @@
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { MemoExoticComponent } from 'react';
+import { ReactNode } from 'react';
 
-export declare type AgentInterruptEvent = EvaluationResultElement | DoneElement | StatusUpdateElement | PlanUpdateElement | ErrorElement | ToolResultElement | ToolCallElement | AgentMessage | ContextualKnowledgeElement | PausedElement;
+export declare type AgentInterruptEvent = EvaluationResultElement | DoneElement | StatusUpdateElement | PlanUpdateElement | ErrorElement | ToolResultElement | ToolCallElement | AgentMessage_2 | ContextualKnowledgeElement | PausedElement;
 
-declare type AgentMessage = ConversationElement & {
+export declare const AgentMessage: MemoExoticComponent<({ message, isSelected, onClick, annotationOverlay, selectionIndicator, className, hideMetadata, hideActions, showBorder, onOpenToolsPanel, onOpenPlanPanel, onOpenCustomWidget, selectedCustomWidget }: AgentMessageProps) => JSX_2.Element>;
+
+declare type AgentMessage_2 = ConversationElement & {
     type: ConversationElementType.AGENT_MESSAGE;
     content: string;
     subtype: 'thinking_started' | 'thinking_completed' | 'guardrail_started' | 'guardrail_ended' | 'strategy_updated' | 'thinking_failed' | 'intermediate' | 'final' | 'question' | 'workflow_task' | 'final_stream' | 'attach_files' | 'output_files' | 'ask_permission';
@@ -20,11 +24,34 @@ declare type AgentMessage = ConversationElement & {
     parentMessageId?: string;
 };
 
+export declare type AgentMessageAnnotationProps = {
+    isSelected?: boolean;
+    onClick?: () => void;
+    annotationOverlay?: ReactNode;
+    selectionIndicator?: ReactNode;
+    className?: string;
+    hideMetadata?: boolean;
+    hideActions?: boolean;
+    showBorder?: boolean;
+    message: SdkAgentMessage;
+};
+
+export declare type AgentMessageContextProps = {
+    onOpenToolsPanel?: (message: SdkAgentMessage) => void;
+    onOpenPlanPanel?: (message: SdkAgentMessage) => void;
+    onOpenCustomWidget?: (widget: SdkCustomWidget) => void;
+    selectedCustomWidget?: SdkCustomWidget;
+};
+
+declare type AgentMessageProps = AgentMessageAnnotationProps & AgentMessageContextProps;
+
 declare enum AgentResponseFormat {
     Json = "Json",
     Markdown = "Markdown"
 }
 
+declare type AiMessage = EvaluationResultElement | DoneElement | StatusUpdateElement | PlanUpdateElement | ErrorElement | ToolResultElement | ToolCallElement | AgentMessage_2 | ContextualKnowledgeElement | PausedElement;
+
 declare type AttachedDocument = {
     id: string;
     fileName?: string;
@@ -34,6 +61,26 @@ declare type AttachedDocument = {
     state?: DocumentProcessingState;
 };
 
+export declare type ChatMessage = UserMessage_2 | AiMessage;
+
+export declare const ChatRightPanel: ({ isOpen: externalIsOpen, onClose: externalOnClose, selectedTab: externalSelectedTab, onTabChange: externalOnTabChange, selectedMessage: externalSelectedMessage, container: externalContainer, useThinkingState }?: ChatRightPanelProps) => JSX_2.Element;
+
+export declare type ChatRightPanelProps = {
+    isOpen?: boolean;
+    onClose?: () => void;
+    selectedTab?: ChatRightPanelTab;
+    onTabChange?: (tab: ChatRightPanelTab) => void;
+    selectedMessage?: SdkAgentMessage;
+    container?: HTMLElement | null;
+    useThinkingState?: boolean;
+};
+
+export declare enum ChatRightPanelTab {
+    Plan = "Plan",
+    Tools = "Tools",
+    ContextualKnowledge = "ContextualKnowledge"
+}
+
 export declare const ChatWidget: ({ onClose, embedded, ...props }: ChatWidgetProps) => JSX_2.Element;
 
 declare type ChatWidgetContainerProps = (ChatWidgetPopupContainerProps & {
@@ -76,7 +123,7 @@ declare type CommonWidgetProps = {
     enableViewOnObservability?: boolean;
 };
 
-declare type ContextualKnowledge = {
+export declare type ContextualKnowledge = {
     knowledge: string;
     userRequest: string;
 };
@@ -161,6 +208,23 @@ declare type FullChatWidgetContainerProps = {
     widgetRef?: React.Ref<FullScreenChatWidgetRef>;
 };
 
+export declare const FullScreenAnnotationChatWidget: ({ defaultOpen, widgetRef, onClose, hideTrigger, ...props }: FullScreenAnnotationChatWidgetProps) => JSX_2.Element;
+
+declare type FullScreenAnnotationChatWidgetContainerProps = {
+    children: React.ReactNode;
+    defaultOpen?: boolean;
+    hideTrigger?: boolean;
+    onClose?: () => void;
+    widgetRef?: React.Ref<FullScreenAnnotationChatWidgetRef>;
+};
+
+export declare type FullScreenAnnotationChatWidgetProps = CommonWidgetProps & Omit<FullScreenAnnotationChatWidgetContainerProps, 'children'>;
+
+export declare type FullScreenAnnotationChatWidgetRef = {
+    open: () => void;
+    close: () => void;
+};
+
 export declare const FullScreenChatWidget: ({ defaultOpen, widgetRef, onClose, hideTrigger, ...props }: FullScreenChatWidgetProps) => JSX_2.Element;
 
 export declare type FullScreenChatWidgetProps = CommonWidgetProps & Omit<FullChatWidgetContainerProps, 'children'>;
@@ -180,6 +244,8 @@ declare type HeadlessEventHandler<T extends HeadlessEventType> = T extends 'agen
 
 declare type HeadlessEventType = 'agent-interrupt';
 
+export declare type IntermediateAgentMessage = Omit<SdkAgentMessage, 'intermediateMessages'>;
+
 declare type PausedElement = ConversationElement & {
     type: ConversationElementType.PAUSED;
     resumeInfo: any;
@@ -191,13 +257,13 @@ declare type PermissionRequest = {
     description: string;
 };
 
-declare type Plan = {
+export declare type Plan = {
     id: string;
     status: 'running' | 'completed' | 'failed';
     steps: PlanStep[];
 };
 
-declare type PlanStep = {
+export declare type PlanStep = {
     id: string;
     description: string;
     status: 'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'waiting_for_input';
@@ -215,6 +281,81 @@ export declare type QueryPayload = {
     files?: File[];
 };
 
+declare type SdkAgentGuardrailMessage = {
+    id: string;
+    intent: string;
+    result?: string;
+    startTime: Date;
+    endTime?: Date;
+    metadata?: Record<string, any>;
+    type: SdkAgentStepType.GUARDRAIL;
+};
+
+export declare type SdkAgentMessage = Pick<AgentMessage_2, 'content' | 'id' | 'timestamp' | 'metadata'> & {
+    type: 'agent';
+    subtype?: AgentMessage_2['subtype'];
+    plan?: Plan;
+    thinking?: {
+        startTime: Date;
+        endTime: Date;
+    };
+    contextualKnowledge?: ContextualKnowledge;
+    usedMemories?: UsedMemories;
+    isStreaming?: boolean;
+    intermediateMessages?: IntermediateAgentMessage[];
+    agentSteps?: SdkAgentStep[];
+    selectedStrategy?: string;
+};
+
+declare type SdkAgentStep = SdkTool | SdkAgentThinkingMessage | SdkAgentGuardrailMessage;
+
+declare enum SdkAgentStepType {
+    TOOL_CALL = "TOOL_CALL",
+    THINKING = "THINKING",
+    GUARDRAIL = "GUARDRAIL"
+}
+
+declare type SdkAgentThinkingMessage = {
+    id: string;
+    intent: string;
+    thoughtProcess?: string;
+    startTime: Date;
+    endTime?: Date;
+    metadata?: Record<string, any>;
+    type: SdkAgentStepType.THINKING;
+};
+
+export declare type SdkChatMessage = SdkUserMessage | SdkAgentMessage;
+
+export declare type SdkCustomWidget = {
+    widgetId: string;
+    toolResult?: any;
+    uri: string;
+    title: string;
+    timestamp: Date;
+    toolId: string;
+    metadata?: Record<string, any>;
+};
+
+export declare type SdkTool = {
+    id: string;
+    inputs: Record<string, any>;
+    intent?: string;
+    name: string;
+    startTime: Date;
+    endTime?: Date;
+    result?: any;
+    widget?: ToolWidgetMetaData;
+    metadata?: Record<string, any>;
+    type: SdkAgentStepType.TOOL_CALL;
+    error?: string;
+};
+
+export declare type SdkUserMessage = Pick<UserMessage_2, 'metadata' | 'id' | 'content' | 'timestamp'> & {
+    type: 'user';
+    status?: 'pending' | 'acknowledged' | 'error' | 'failed';
+};
+
 declare interface StatusUpdateElement extends ConversationElement {
     type: ConversationElementType.STATUS_UPDATE;
     status: string;
@@ -249,6 +390,18 @@ declare type ToolWidgetMetaData = {
     toolId: string;
 };
 
+export declare const transformMessagesToSdkMessages: (_messages: ChatMessage[]) => {
+    messages: SdkChatMessage[];
+    thinking: {
+        startTime: Date;
+        content: string;
+    } | undefined;
+    plan: Plan | undefined;
+    currentIntermediateMessage: IntermediateAgentMessage | undefined;
+    intermediateMessages: IntermediateAgentMessage[];
+    agentSteps: SdkAgentStep[];
+};
+
 /** FAQs and user persona memories that were used during agent execution */
 declare interface UsedMemories {
     faqs?: Array<{
@@ -265,6 +418,38 @@ declare interface UsedMemories {
     };
 }
 
+export declare const UserMessage: ({ message, isSelected, onClick, annotationOverlay, selectionIndicator, className }: UserMessageProps) => JSX_2.Element;
+
+declare type UserMessage_2 = ConversationElement & {
+    type: ConversationElementType.USER_MESSAGE;
+    content: string;
+    subtype: 'text' | 'file';
+    source: 'direct' | 'slack' | 'discord' | 'teams' | 'api';
+    status?: 'pending' | 'acknowledged' | 'error' | 'failed';
+    metadata?: {
+        channel?: string;
+        thread?: string[];
+        user?: string;
+        platform?: string;
+        questionId?: string;
+        fileName?: string;
+        documents?: AttachedDocument[];
+        payload?: any;
+    };
+};
+
+export declare type UserMessageAnnotationProps = {
+    isSelected?: boolean;
+    onClick?: () => void;
+    annotationOverlay?: ReactNode;
+    selectionIndicator?: ReactNode;
+    className?: string;
+};
+
+declare type UserMessageProps = {
+    message: SdkUserMessage;
+} & UserMessageAnnotationProps;
+
 declare type WidgetConfig = {
     serverUrl: string;
     agentId: string;