@uptiqai/widgets-sdk 1.34.0 → 1.35.0

package/dist/index.d.ts

@@ -1,5 +1,32 @@
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 
+export declare type AgentInterruptEvent = EvaluationResultElement | DoneElement | StatusUpdateElement | PlanUpdateElement | ErrorElement | ToolResultElement | ToolCallElement | AgentMessage | ContextualKnowledgeElement | PausedElement;
+
+declare type AgentMessage = ConversationElement & {
+    type: ConversationElementType.AGENT_MESSAGE;
+    content: string;
+    subtype: 'intermediate' | 'final' | 'question' | 'final_stream' | 'output_files' | 'ask_permission';
+    isStreaming?: boolean;
+    relatedStepId?: string;
+    expectedResponseType?: 'text' | 'boolean' | 'selection' | 'json';
+    options?: string[];
+    taskData?: Record<string, any>;
+    metadata?: {
+        [key: string]: any;
+        documents?: AttachedDocument[];
+        requestedSchema?: any;
+        permissionRequest?: PermissionRequest;
+    };
+};
+
+declare type AttachedDocument = {
+    id: string;
+    fileName?: string;
+    summary?: string;
+    mimeType?: string;
+    source?: string;
+};
+
 export declare const ChatWidget: ({ onClose, embedded, ...props }: ChatWidgetProps) => JSX_2.Element;
 
 declare type ChatWidgetContainerProps = (ChatWidgetPopupContainerProps & {
@@ -40,6 +67,74 @@ declare type CommonWidgetProps = {
     filterConversationsByUser?: boolean;
 };
 
+declare type ContextualKnowledge = {
+    knowledge: string;
+    userRequest: string;
+};
+
+declare type ContextualKnowledgeElement = ConversationElement & ContextualKnowledge & {
+    type: ConversationElementType.CONTEXTUAL_KNOWLEDGE;
+};
+
+declare type ConversationElement = {
+    id: string;
+    type: ConversationElementType;
+    timestamp: Date;
+    conversationId?: string;
+    metadata?: Record<string, any>;
+};
+
+declare enum ConversationElementType {
+    USER_MESSAGE = "user_message",
+    AGENT_MESSAGE = "agent_message",
+    TOOL_CALL = "tool_call",
+    TOOL_RESULT = "tool_result",
+    PLAN_UPDATE = "plan_update",
+    STATUS_UPDATE = "status_update",
+    CONTEXTUAL_KNOWLEDGE = "contextual_knowledge",
+    EVALUATION_RESULT = "evaluation_result",
+    PAUSED = "paused",
+    DONE = "done",
+    ERROR = "error"
+}
+
+export declare const createHeadlessAgentInstance: (params: CreateHeadlessAgentInstanceParams) => HeadlessAgentInstance;
+
+export declare type CreateHeadlessAgentInstanceParams = Pick<CreateWidgetInstanceParams, 'config' | 'user' | 'instanceId'>;
+
+declare type CreateWidgetInstanceParams = Omit<CommonWidgetProps, 'theme'> & {
+    instanceId: string;
+};
+
+declare interface DoneElement extends ConversationElement {
+    type: ConversationElementType.DONE;
+    plan?: Plan;
+    content?: string;
+    error?: string;
+}
+
+declare type ErrorElement = ConversationElement & {
+    type: ConversationElementType.ERROR;
+    error: string;
+    source: 'agent' | 'tool' | 'system' | 'external';
+    context?: {
+        toolName?: string;
+        stepId?: string;
+        originalRequest?: string;
+    };
+};
+
+declare type EvaluationResponse = {
+    score: number;
+    reasoning: string;
+    is_correct: boolean;
+};
+
+declare interface EvaluationResultElement extends ConversationElement {
+    type: ConversationElementType.EVALUATION_RESULT;
+    result: EvaluationResponse;
+}
+
 declare type FullChatWidgetContainerProps = {
     children: React.ReactNode;
     defaultOpen?: boolean;
@@ -57,6 +152,86 @@ export declare type FullScreenChatWidgetRef = {
     close: () => void;
 };
 
+export declare type HeadlessAgentInstance = {
+    emit: (event: 'query', payload: QueryPayload) => void;
+    on: <T extends HeadlessEventType>(event: T, handler: HeadlessEventHandler<T>) => () => void;
+    cleanup: () => void;
+};
+
+declare type HeadlessEventHandler<T extends HeadlessEventType> = T extends 'agent-interrupt' ? (message: AgentInterruptEvent) => void : never;
+
+declare type HeadlessEventType = 'agent-interrupt';
+
+declare type PausedElement = ConversationElement & {
+    type: ConversationElementType.PAUSED;
+    resumeInfo: any;
+};
+
+declare type PermissionRequest = {
+    id: string;
+    title: string;
+    description: string;
+};
+
+declare type Plan = {
+    id: string;
+    status: 'running' | 'completed' | 'failed';
+    steps: PlanStep[];
+};
+
+declare type PlanStep = {
+    id: string;
+    description: string;
+    status: 'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'waiting_for_input';
+};
+
+declare type PlanUpdateElement = ConversationElement & {
+    type: ConversationElementType.PLAN_UPDATE;
+    plan?: Plan;
+    changeType: 'created' | 'updated' | 'step_added' | 'step_updated' | 'completed';
+};
+
+export declare type QueryPayload = {
+    content: string;
+    executionId?: string;
+    files?: File[];
+};
+
+declare interface StatusUpdateElement extends ConversationElement {
+    type: ConversationElementType.STATUS_UPDATE;
+    status: string;
+    context?: string;
+    relatedStepId?: string;
+}
+
+declare type ToolCallElement = ConversationElement & {
+    type: ConversationElementType.TOOL_CALL;
+    skillId: string;
+    toolName: string;
+    intent?: string;
+    inputs: Record<string, any>;
+    status: 'pending' | 'executing' | 'completed' | 'failed';
+    relatedStepId?: string;
+};
+
+declare type ToolResultElement = ConversationElement & {
+    type: ConversationElementType.TOOL_RESULT;
+    toolCallId: string;
+    result: any;
+    success: boolean;
+    error?: string;
+    duration?: number;
+    widget?: ToolWidgetMetaData;
+};
+
+declare type ToolWidgetMetaData = {
+    uri: string;
+    widgetId: string;
+    content: string;
+    title: string;
+    toolId: string;
+};
+
 declare type WidgetConfig = {
     serverUrl: string;
     agentId: string;