@xpert-ai/chatkit-types 0.0.2 → 0.0.4

package/dist/index.d.ts

@@ -0,0 +1,268 @@
+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;
+}
+
+/**
+ * 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",
+    /**
+     * 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"
+}
+
+/**
+ * Category of step message: determines the display components of computer use
+ */
+export declare enum ChatMessageStepCategory {
+    /**
+     * List of items: urls, files, etc.
+     */
+    List = "list",
+    /**
+     * Websearch results
+     */
+    WebSearch = "web_search",
+    /**
+     * Files list
+     */
+    Files = "files",
+    /**
+     * View a file
+     */
+    File = "file",
+    /**
+     * Program Execution
+     */
+    Program = "program",
+    /**
+     * Iframe
+     */
+    Iframe = "iframe",
+    Memory = "memory",
+    Tasks = "tasks",
+    /**
+     * Knowledges (knowledge base retriever results)
+     */
+    Knowledges = "knowledges"
+}
+
+export declare enum ChatMessageTypeEnum {
+    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 | {
+        url: string;
+        detail?: ImageDetail;
+    };
+};
+
+export declare type MessageContentText = {
+    type: "text";
+    text: string;
+};
+
+/**
+ * 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;
+};
+
+/**
+ * Step message type, in canvas and ai message.
+ */
+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;
+};
+
+export declare type TMessageComponentIframe = {
+    type: 'iframe';
+    title: string;
+    url?: string;
+    data?: {
+        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;
+};
+
+/**
+ * Enhance {@link MessageContent} in Langchain.js
+ *
+ * @deprecated use {@link TMessageItems} instead
+ */
+export declare type TMessageContent = string | TMessageContentComplex[];
+
+/**
+ * Enhance {@link MessageContentComplex} in Langchain.js
+ */
+export declare type TMessageContentComplex = (TMessageContentText | TMessageContentReasoning | MessageContentImageUrl | TMessageContentComponent | TMessageContentMemory | (Record<string, any> & {
+    type?: "text" | "image_url" | string;
+}) | (Record<string, any> & {
+    type?: never;
+})) & {
+    id?: string;
+    xpertName?: string;
+    agentKey?: 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;
+    agentKey?: string;
+};
+
+export declare type TMessageContentMemory = {
+    id?: string;
+    agentKey?: string;
+    type: "memory";
+    data: any[];
+};
+
+export declare type TMessageContentReasoning = {
+    id?: string;
+    xpertName?: string;
+    agentKey?: string;
+    type: "reasoning";
+    text: string;
+};
+
+export declare type TMessageContentText = {
+    id?: string;
+    xpertName?: string;
+    agentKey?: string;
+    type: "text";
+    text: string;
+};
+
+export declare type TMessageItems = TMessageContentComplex[];
+
+export { }