@langgraph-js/sdk 1.11.0 → 2.0.0

package/dist/LangGraphClient.d.ts

@@ -1,25 +1,8 @@
-import { Client, Thread, Message, Assistant, HumanMessage, AIMessage, ToolMessage, Command } from "@langchain/langgraph-sdk";
+import type { Thread, Message, Assistant, Command } from "@langchain/langgraph-sdk";
+import { EventEmitter } from "eventemitter3";
 import { ToolManager } from "./ToolManager.js";
 import { CallToolResult } from "./tool/createTool.js";
-interface AsyncCallerParams {
-    /**
-     * The maximum number of concurrent calls that can be made.
-     * Defaults to `Infinity`, which means no limit.
-     */
-    maxConcurrency?: number;
-    /**
-     * The maximum number of retries that can be made for a single call,
-     * with an exponential backoff between each attempt. Defaults to 6.
-     */
-    maxRetries?: number;
-    onFailedResponseHook?: any;
-    /**
-     * Specify a custom fetch implementation.
-     *
-     * By default we expect the `fetch` is available in the global scope.
-     */
-    fetch?: typeof fetch | ((...args: any[]) => any);
-}
+import { ILangGraphClient } from "./types.js";
 export type RenderMessage = Message & {
     /** 对于 AIMessage 来说是节点名称，对于工具节点来说是工具名称 */
     name?: string;
@@ -35,6 +18,7 @@ export type RenderMessage = Message & {
             };
         }[];
     };
+    sub_agent_messages?: RenderMessage[];
     usage_metadata?: {
         total_tokens: number;
         input_tokens: number;
@@ -62,36 +46,188 @@ export type SendMessageOptions = {
 export interface LangGraphClientConfig {
     apiUrl?: string;
     apiKey?: string;
-    callerOptions?: AsyncCallerParams;
+    callerOptions?: {
+        /**
+         * The maximum number of concurrent calls that can be made.
+         * Defaults to `Infinity`, which means no limit.
+         */
+        maxConcurrency?: number;
+        /**
+         * The maximum number of retries that can be made for a single call,
+         * with an exponential backoff between each attempt. Defaults to 6.
+         */
+        maxRetries?: number;
+        onFailedResponseHook?: any;
+        /**
+         * Specify a custom fetch implementation.
+         *
+         * By default we expect the `fetch` is available in the global scope.
+         */
+        fetch?: typeof fetch | ((...args: any[]) => any);
+    };
     timeoutMs?: number;
     defaultHeaders?: Record<string, string | null | undefined>;
+    /** 自定义客户端实现，如果不提供则使用官方 Client */
+    client: ILangGraphClient;
 }
-/**
- * @zh StreamingMessageType 类用于判断消息的类型。
- * @en The StreamingMessageType class is used to determine the type of a message.
- */
-export declare class StreamingMessageType {
-    static isUser(m: Message): m is HumanMessage;
-    static isTool(m: Message): m is ToolMessage;
-    static isAssistant(m: Message): m is AIMessage;
-    static isToolAssistant(m: Message): m is AIMessage;
+export interface LangGraphEvents {
+    /** 流开始事件 */
+    start: {
+        event: "start";
+    };
+    /** 消息部分更新事件 */
+    message: {
+        event: "messages/partial";
+        data: Message[];
+    };
+    /** 值更新事件 */
+    value: {
+        event: "messages/partial" | "values";
+        data: {
+            messages?: Message[];
+        };
+    };
+    /** 错误事件 */
+    error: {
+        event: "error";
+        data: any;
+    };
+    /** Thread 创建事件 */
+    thread: {
+        event: "thread/create";
+        data: {
+            thread: Thread;
+        };
+    };
+    /** 流完成事件 */
+    done: {
+        event: "done";
+    };
 }
-type StreamingUpdateEvent = {
-    type: "message" | "value" | "update" | "error" | "thread" | "done" | "start";
-    data: any;
-};
-type StreamingUpdateCallback = (event: StreamingUpdateEvent) => void;
 /**
  * @zh LangGraphClient 类是与 LangGraph 后端交互的主要客户端。
  * @en The LangGraphClient class is the main client for interacting with the LangGraph backend.
  */
-export declare class LangGraphClient extends Client {
+export declare class LangGraphClient<TStateType = unknown, TUpdateType = TStateType> extends EventEmitter<LangGraphEvents> {
+    private client;
     private currentAssistant;
     private currentThread;
-    private streamingCallbacks;
     tools: ToolManager;
     stopController: AbortController | null;
+    /** 用于存储 subAgent 状态数据的键 */
+    subAgentsKey: string;
+    /** Message 处理器 */
+    private messageProcessor;
     constructor(config: LangGraphClientConfig);
+    /** 代理 assistants 属性到内部 client */
+    get assistants(): {
+        search(query?: {
+            graphId?: string;
+            metadata?: import("@langchain/langgraph-sdk").Metadata;
+            limit?: number;
+            offset?: number;
+            sortBy?: import("./types.js").AssistantSortBy;
+            sortOrder?: import("./types.js").SortOrder;
+        }): Promise<Assistant[]>;
+        getGraph(assistantId: string, options?: {
+            xray?: boolean | number;
+        }): Promise<import("@langchain/langgraph-sdk").AssistantGraph>;
+    };
+    /** 代理 threads 属性到内部 client */
+    get threads(): {
+        create<ValuesType = TStateType>(payload?: {
+            metadata?: import("@langchain/langgraph-sdk").Metadata;
+            threadId?: string;
+            ifExists?: import("@langchain/langgraph-sdk").OnConflictBehavior;
+            graphId?: string;
+            supersteps?: Array<{
+                updates: Array<{
+                    values: unknown;
+                    command?: Command;
+                    asNode: string;
+                }>;
+            }>;
+        }): Promise<Thread<ValuesType>>;
+        search<ValuesType = TStateType>(query?: {
+            metadata?: import("@langchain/langgraph-sdk").Metadata;
+            limit?: number;
+            offset?: number;
+            status?: import("@langchain/langgraph-sdk").ThreadStatus;
+            sortBy?: import("./types.js").ThreadSortBy;
+            sortOrder?: import("./types.js").SortOrder;
+        }): Promise<Thread<ValuesType>[]>;
+        get<ValuesType = TStateType>(threadId: string): Promise<Thread<ValuesType>>;
+        delete(threadId: string): Promise<void>;
+    };
+    /** 代理 runs 属性到内部 client */
+    get runs(): {
+        list(threadId: string, options?: {
+            limit?: number;
+            offset?: number;
+            status?: import("./types.js").RunStatus;
+        }): Promise<import("@langchain/langgraph-sdk").Run[]>;
+        stream<TStreamMode extends import("@langchain/langgraph-sdk").StreamMode | import("@langchain/langgraph-sdk").StreamMode[] = import("@langchain/langgraph-sdk").StreamMode, TSubgraphs extends boolean = false>(threadId: null, assistantId: string, payload?: {
+            input?: Record<string, unknown> | null;
+            metadata?: import("@langchain/langgraph-sdk").Metadata;
+            config?: import("@langchain/langgraph-sdk").Config;
+            checkpointId?: string;
+            checkpoint?: Omit<import("@langchain/langgraph-sdk").Checkpoint, "thread_id">;
+            checkpointDuring?: boolean;
+            interruptBefore?: "*" | string[];
+            interruptAfter?: "*" | string[];
+            signal?: AbortController["signal"];
+            webhook?: string;
+            onDisconnect?: import("./types.js").DisconnectMode;
+            afterSeconds?: number;
+            ifNotExists?: "create" | "reject";
+            command?: Command;
+            onRunCreated?: (params: {
+                run_id: string;
+                thread_id?: string;
+            }) => void;
+            streamMode?: TStreamMode | undefined;
+            streamSubgraphs?: TSubgraphs | undefined;
+            streamResumable?: boolean;
+            feedbackKeys?: string[];
+        } | undefined): import("./types.js").TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, unknown>;
+        stream<TStreamMode extends import("@langchain/langgraph-sdk").StreamMode | import("@langchain/langgraph-sdk").StreamMode[] = import("@langchain/langgraph-sdk").StreamMode, TSubgraphs extends boolean = false>(threadId: string, assistantId: string, payload?: {
+            input?: Record<string, unknown> | null;
+            metadata?: import("@langchain/langgraph-sdk").Metadata;
+            config?: import("@langchain/langgraph-sdk").Config;
+            checkpointId?: string;
+            checkpoint?: Omit<import("@langchain/langgraph-sdk").Checkpoint, "thread_id">;
+            checkpointDuring?: boolean;
+            interruptBefore?: "*" | string[];
+            interruptAfter?: "*" | string[];
+            multitaskStrategy?: import("./types.js").MultitaskStrategy;
+            onCompletion?: import("./types.js").OnCompletionBehavior;
+            signal?: AbortController["signal"];
+            webhook?: string;
+            onDisconnect?: import("./types.js").DisconnectMode;
+            afterSeconds?: number;
+            ifNotExists?: "create" | "reject";
+            command?: Command;
+            onRunCreated?: (params: {
+                run_id: string;
+                thread_id?: string;
+            }) => void;
+            streamMode?: TStreamMode | undefined;
+            streamSubgraphs?: TSubgraphs | undefined;
+            streamResumable?: boolean;
+            feedbackKeys?: string[];
+        } | undefined): import("./types.js").TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, unknown>;
+        joinStream(threadId: string | undefined | null, runId: string, options?: {
+            signal?: AbortSignal;
+            cancelOnDisconnect?: boolean;
+            lastEventId?: string;
+            streamMode?: import("@langchain/langgraph-sdk").StreamMode | import("@langchain/langgraph-sdk").StreamMode[];
+        } | AbortSignal): AsyncGenerator<{
+            id?: string;
+            event: import("@langchain/core/tracers/log_stream").StreamEvent;
+            data: any;
+        }>;
+        cancel(threadId: string, runId: string, wait?: boolean, action?: import("./types.js").CancelAction): Promise<void>;
+    };
     availableAssistants: Assistant[];
     private listAssistants;
     /**
@@ -105,41 +241,26 @@ export declare class LangGraphClient extends Client {
      */
     createThread({ threadId, }?: {
         threadId?: string;
-    }): Promise<Thread<import("@langchain/langgraph-sdk").DefaultValues>>;
+    }): Promise<Thread<TStateType>>;
     graphVisualize(): Promise<import("@langchain/langgraph-sdk").AssistantGraph>;
     /**
      * @zh 列出所有的 Thread。
      * @en Lists all Threads.
      */
-    listThreads<T>(): Promise<Thread<T>[]>;
+    listThreads(): Promise<Thread<TStateType>[]>;
+    deleteThread(threadId: string): Promise<void>;
     /**
      * @zh 从历史中恢复 Thread 数据。
      * @en Resets the Thread data from history.
      */
-    resetThread(agent: string, threadId: string): Promise<Thread<import("@langchain/langgraph-sdk").DefaultValues>>;
+    resetThread(agent: string, threadId: string): Promise<Thread<TStateType>>;
     resetStream(): Promise<void>;
-    streamingMessage: RenderMessage[];
-    /** 图发过来的更新信息 */
-    graphMessages: RenderMessage[];
     cloneMessage(message: Message): Message;
-    private updateStreamingMessage;
-    /** 将 graphMessages 和 streamingMessage 合并，并返回新的消息数组 */
-    private combineGraphMessagesWithStreamingMessages;
     /**
      * @zh 用于 UI 中的流式渲染中的消息。
      * @en Messages used for streaming rendering in the UI.
      */
     get renderMessage(): RenderMessage[];
-    /**
-     * @zh 为消息附加额外的信息，如耗时、唯一 ID 等。
-     * @en Attaches additional information to messages, such as spend time, unique ID, etc.
-     */
-    private attachInfoForMessage;
-    /**
-     * @zh 组合工具消息，将 AI 的工具调用和工具的执行结果关联起来。
-     * @en Composes tool messages, associating AI tool calls with tool execution results.
-     */
-    private composeToolMessages;
     /**
      * @zh 获取 Token 计数器信息。
      * @en Gets the Token counter information.
@@ -149,12 +270,6 @@ export declare class LangGraphClient extends Client {
         input_tokens: number;
         output_tokens: number;
     };
-    /**
-     * @zh 注册流式更新的回调函数。
-     * @en Registers a callback function for streaming updates.
-     */
-    onStreamingUpdate(callback: StreamingUpdateCallback): () => void;
-    private emitStreamingUpdate;
     /** 前端工具人机交互时，锁住面板 */
     isFELocking(messages: RenderMessage[]): boolean | undefined;
     graphState: any;
@@ -181,8 +296,6 @@ export declare class LangGraphClient extends Client {
         id: string;
         name: string;
     };
-    /** 子图的数据需要通过 merge 的方式重新进行合并更新 */
-    private mergeSubGraphMessagesToStreamingMessages;
     private runFETool;
     private callFETool;
     extraParams: Record<string, any>;
@@ -200,7 +313,7 @@ export declare class LangGraphClient extends Client {
      * @zh 获取当前的 Thread。
      * @en Gets the current Thread.
      */
-    getCurrentThread(): Thread<import("@langchain/langgraph-sdk").DefaultValues> | null;
+    getCurrentThread(): Thread<TStateType> | null;
     /**
      * @zh 获取当前的 Assistant。
      * @en Gets the current Assistant.
@@ -212,4 +325,3 @@ export declare class LangGraphClient extends Client {
      */
     reset(): Promise<void>;
 }
-export {};