@xpert-ai/chatkit-types 0.0.3 → 0.0.4

package/dist/index.d.ts

@@ -1,34 +1,36 @@
+import { ToolCall } from '@langchain/core/messages/tool';
+
 export declare interface ChatkitMessage {
-    status?: string
-    content: TMessageItems
-    reasoning?: TMessageContentReasoning[]
-    type: 'user' | 'assistant' | 'system' | 'tool' | 'event'
-    id: string
+    status?: string;
+    content: TMessageItems;
+    reasoning?: TMessageContentReasoning[];
+    type: 'user' | 'assistant' | 'system' | 'tool' | 'event';
+    id: string;
 }
 
 /**
  * https://js.langchain.com/docs/how_to/streaming/#event-reference
  */
 export declare enum ChatMessageEventTypeEnum {
-    ON_CONVERSATION_START = 'on_conversation_start',
-    ON_CONVERSATION_END = 'on_conversation_end',
-    ON_MESSAGE_START = 'on_message_start',
-    ON_MESSAGE_END = 'on_message_end',
-    ON_TOOL_START = 'on_tool_start',
-    ON_TOOL_END = 'on_tool_end',
-    ON_TOOL_ERROR = 'on_tool_error',
+    ON_CONVERSATION_START = "on_conversation_start",
+    ON_CONVERSATION_END = "on_conversation_end",
+    ON_MESSAGE_START = "on_message_start",
+    ON_MESSAGE_END = "on_message_end",
+    ON_TOOL_START = "on_tool_start",
+    ON_TOOL_END = "on_tool_end",
+    ON_TOOL_ERROR = "on_tool_error",
     /**
      * Step message in tool call
      */
-    ON_TOOL_MESSAGE = 'on_tool_message',
-    ON_AGENT_START = 'on_agent_start',
-    ON_AGENT_END = 'on_agent_end',
-    ON_RETRIEVER_START = 'on_retriever_start',
-    ON_RETRIEVER_END = 'on_retriever_end',
-    ON_RETRIEVER_ERROR = 'on_retriever_error',
-    ON_INTERRUPT = 'on_interrupt',
-    ON_ERROR = 'on_error',
-    ON_CHAT_EVENT = 'on_chat_event',
+    ON_TOOL_MESSAGE = "on_tool_message",
+    ON_AGENT_START = "on_agent_start",
+    ON_AGENT_END = "on_agent_end",
+    ON_RETRIEVER_START = "on_retriever_start",
+    ON_RETRIEVER_END = "on_retriever_end",
+    ON_RETRIEVER_ERROR = "on_retriever_error",
+    ON_INTERRUPT = "on_interrupt",
+    ON_ERROR = "on_error",
+    ON_CHAT_EVENT = "on_chat_event"
 }
 
 /**
@@ -38,46 +40,107 @@ export declare enum ChatMessageStepCategory {
     /**
      * List of items: urls, files, etc.
      */
-    List = 'list',
+    List = "list",
     /**
      * Websearch results
      */
-    WebSearch = 'web_search',
+    WebSearch = "web_search",
     /**
      * Files list
      */
-    Files = 'files',
+    Files = "files",
     /**
      * View a file
      */
-    File = 'file',
+    File = "file",
     /**
      * Program Execution
      */
-    Program = 'program',
+    Program = "program",
     /**
      * Iframe
      */
-    Iframe = 'iframe',
-
-    Memory = 'memory',
-
-    Tasks = 'tasks',
-
+    Iframe = "iframe",
+    Memory = "memory",
+    Tasks = "tasks",
     /**
      * Knowledges (knowledge base retriever results)
      */
-    Knowledges = 'knowledges'
+    Knowledges = "knowledges"
 }
 
 export declare enum ChatMessageTypeEnum {
-    // LOG = 'log',
-    MESSAGE = 'message',
-    EVENT = 'event'
+    MESSAGE = "message",
+    EVENT = "event"
+}
+
+export declare interface ClientToolMessageInput {
+    content: unknown;
+    name?: string;
+    tool_call_id?: string;
+    status?: 'success' | 'error';
+    artifact?: unknown;
+}
+
+export declare interface ClientToolRequest {
+    clientToolCalls: ToolCall[];
+}
+
+export declare interface ClientToolResponse {
+    toolMessages: ClientToolMessageInput[];
 }
 
 export declare type ImageDetail = "auto" | "low" | "high";
 
+/**
+ * When an interrupt occurs during task execution, the system generates an InterruptPayload.
+ ```json
+ {
+ "type": "event",
+ "event": "on_interrupt",
+ "data": {
+ "tasks": [
+ {
+ "id": "9c4d2ac5-8808-5b6f-855c-4d48aa3d77a7",
+ "name": "Middleware_wPzR2bIXqE_after_model",
+ "path": ["__pregel_pull", "Middleware_wPzR2bIXqE_after_model"],
+ "interrupts": [
+ {
+ "id": "b42f7887d65e57ed11cf08b8927763db",
+ "value": {
+ "toolCalls": [
+ {
+ "name": "getUserStation",
+ "args": {
+ "input": "Query the site selected by the user"
+ },
+ "id": "call_00_swcaUjIaACXOHHaZyNmQB3Vm",
+ "type": "tool_call"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ```
+ */
+export declare interface InterruptPayload {
+    tasks: Array<{
+        id: string;
+        name: string;
+        path: string[];
+        interrupts: Array<{
+            id: string;
+            value: ClientToolRequest;
+        }>;
+    }>;
+}
+
+export declare function isClientToolRequest(value: any): value is ClientToolRequest;
+
 export declare type MessageContentImageUrl = {
     type: "image_url";
     image_url: string | {
@@ -95,59 +158,59 @@ export declare type MessageContentText = {
  * Data type for chat event message
  */
 export declare type TChatEventMessage = {
-    type?: string
-    title?: string
-    message?: string
-    status?: 'success' | 'fail' | 'running'
-    created_date?: Date | string
-    end_date?: Date | string
-    error?: string
-}
+    type?: string;
+    title?: string;
+    message?: string;
+    status?: 'success' | 'fail' | 'running';
+    created_date?: Date | string;
+    end_date?: Date | string;
+    error?: string;
+};
 
 /**
  * Step message type, in canvas and ai message.
  */
-export declare type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>
+export declare type TChatMessageStep<T = any> = TMessageComponent<TMessageComponentStep<T>>;
 
 /**
  * Defines the data type of the sub-message of `component` type in the message `content` {@link MessageContentComplex}
  */
 export declare type TMessageComponent<T extends object = object> = T & {
-    id?: string
-    category: 'Dashboard' | 'Computer' | 'Tool'
-    type?: string
-    created_date?: Date | string
-}
+    id?: string;
+    category: 'Dashboard' | 'Computer' | 'Tool';
+    type?: string;
+    created_date?: Date | string;
+};
 
 export declare type TMessageComponentIframe = {
-    type: 'iframe'
-    title: string
-    url?: string
+    type: 'iframe';
+    title: string;
+    url?: string;
     data?: {
-        url?: string
-    }
-}
+        url?: string;
+    };
+};
 
 export declare type TMessageComponentStep<T = unknown> = {
-    type: ChatMessageStepCategory
-    toolset: string
-    toolset_id: string
-    tool?: string
-    title: string
-    message: string
-    status: 'success' | 'fail' | 'running'
-    created_date: Date | string
-    end_date: Date | string
-    error?: string
-    data?: T
-    input?: any
-    output?: string
-    artifact?: any
-}
+    type: ChatMessageStepCategory;
+    toolset: string;
+    toolset_id: string;
+    tool?: string;
+    title: string;
+    message: string;
+    status: 'success' | 'fail' | 'running';
+    created_date: Date | string;
+    end_date: Date | string;
+    error?: string;
+    data?: T;
+    input?: any;
+    output?: string;
+    artifact?: any;
+};
 
 /**
  * Enhance {@link MessageContent} in Langchain.js
- * 
+ *
  * @deprecated use {@link TMessageItems} instead
  */
 export declare type TMessageContent = string | TMessageContentComplex[];
@@ -160,42 +223,42 @@ export declare type TMessageContentComplex = (TMessageContentText | TMessageCont
 }) | (Record<string, any> & {
     type?: never;
 })) & {
-    id?: string
-    xpertName?: string
+    id?: string;
+    xpertName?: string;
     agentKey?: string;
-    created_date?: Date | string
-}
+    created_date?: Date | string;
+};
 
 /**
  * Similar to {@link MessageContentText} | {@link MessageContentImageUrl}, which together form {@link MessageContentComplex}
  */
 export declare type TMessageContentComponent<T extends object = object> = {
-    id: string
-    type: 'component'
-    data: TMessageComponent<T>
-    xpertName?: string
+    id: string;
+    type: 'component';
+    data: TMessageComponent<T>;
+    xpertName?: string;
     agentKey?: string;
-}
+};
 
 export declare type TMessageContentMemory = {
-    id?: string
-    agentKey?: string
+    id?: string;
+    agentKey?: string;
     type: "memory";
     data: any[];
 };
 
 export declare type TMessageContentReasoning = {
-    id?: string
-    xpertName?: string
-    agentKey?: string
+    id?: string;
+    xpertName?: string;
+    agentKey?: string;
     type: "reasoning";
     text: string;
 };
 
 export declare type TMessageContentText = {
-    id?: string
-    xpertName?: string
-    agentKey?: string
+    id?: string;
+    xpertName?: string;
+    agentKey?: string;
     type: "text";
     text: string;
 };