@langgraph-js/sdk 1.1.5 → 1.1.8

package/dist/LangGraphClient.d.ts

@@ -1,7 +1,25 @@
 import { Client, Thread, Message, Assistant, HumanMessage, ToolMessage, Command } from "@langchain/langgraph-sdk";
-import { ToolManager } from "./ToolManager";
-import { CallToolResult } from "./tool";
-import { AsyncCallerParams } from "@langchain/langgraph-sdk/dist/utils/async_caller";
+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);
+}
 export type RenderMessage = Message & {
     /** 工具入参 ，聚合而来*/
     tool_input?: string;
@@ -40,6 +58,10 @@ export interface LangGraphClientConfig {
     timeoutMs?: number;
     defaultHeaders?: Record<string, string | null | undefined>;
 }
+/**
+ * @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;
@@ -51,6 +73,10 @@ type StreamingUpdateEvent = {
     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 {
     private currentAssistant;
     private currentThread;
@@ -60,43 +86,103 @@ export declare class LangGraphClient extends Client {
     constructor(config: LangGraphClientConfig);
     availableAssistants: Assistant[];
     private listAssistants;
+    /**
+     * @zh 初始化 Assistant。
+     * @en Initializes the Assistant.
+     */
     initAssistant(agentName: string): Promise<void>;
+    /**
+     * @zh 创建一个新的 Thread。
+     * @en Creates a new Thread.
+     */
     createThread({ threadId, }?: {
         threadId?: string;
     }): Promise<Thread<import("@langchain/langgraph-sdk").DefaultValues>>;
+    /**
+     * @zh 列出所有的 Thread。
+     * @en Lists all Threads.
+     */
     listThreads<T>(): Promise<Thread<T>[]>;
-    /** 从历史中恢复数据 */
+    /**
+     * @zh 从历史中恢复 Thread 数据。
+     * @en Resets the Thread data from history.
+     */
     resetThread(agent: string, threadId: string): Promise<void>;
     streamingMessage: RenderMessage[];
     /** 图发过来的更新信息 */
     graphMessages: RenderMessage[];
     cloneMessage(message: Message): Message;
     private replaceMessageWithValuesMessage;
-    /** 用于 UI 中的流式渲染中的消息 */
+    /**
+     * @zh 用于 UI 中的流式渲染中的消息。
+     * @en Messages used for streaming rendering in the UI.
+     */
     get renderMessage(): RenderMessage[];
-    attachInfoForMessage(result: RenderMessage[]): RenderMessage[];
-    composeToolMessages(messages: 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.
+     */
     get tokenCounter(): {
         total_tokens: number;
         input_tokens: number;
         output_tokens: number;
     };
+    /**
+     * @zh 注册流式更新的回调函数。
+     * @en Registers a callback function for streaming updates.
+     */
     onStreamingUpdate(callback: StreamingUpdateCallback): () => void;
     private emitStreamingUpdate;
     graphState: any;
     currentRun?: {
         run_id: string;
     };
+    /**
+     * @zh 取消当前的 Run。
+     * @en Cancels the current Run.
+     */
     cancelRun(): void;
+    /**
+     * @zh 发送消息到 LangGraph 后端。
+     * @en Sends a message to the LangGraph backend.
+     */
     sendMessage(input: string | Message[], { extraParams, _debug, command }?: SendMessageOptions): Promise<any[]>;
     private runFETool;
     private callFETool;
-    /** 恢复消息，当中断流时使用 */
+    /**
+     * @zh 继续被前端工具中断的流程。
+     * @en Resumes a process interrupted by a frontend tool.
+     */
     resume(result: CallToolResult): Promise<any[]>;
-    /** 完成工具等待 */
+    /**
+     * @zh 标记前端工具等待已完成。
+     * @en Marks the frontend tool waiting as completed.
+     */
     doneFEToolWaiting(id: string, result: CallToolResult): void;
+    /**
+     * @zh 获取当前的 Thread。
+     * @en Gets the current Thread.
+     */
     getCurrentThread(): Thread<import("@langchain/langgraph-sdk").DefaultValues> | null;
+    /**
+     * @zh 获取当前的 Assistant。
+     * @en Gets the current Assistant.
+     */
     getCurrentAssistant(): Assistant | null;
+    /**
+     * @zh 重置客户端状态。
+     * @en Resets the client state.
+     */
     reset(): Promise<void>;
 }
 export {};

package/dist/LangGraphClient.js

@@ -1,5 +1,9 @@
 import { Client } from "@langchain/langgraph-sdk";
-import { ToolManager } from "./ToolManager";
+import { ToolManager } from "./ToolManager.js";
+/**
+ * @zh StreamingMessageType 类用于判断消息的类型。
+ * @en The StreamingMessageType class is used to determine the type of a message.
+ */
 export class StreamingMessageType {
     static isUser(m) {
         return m.type === "human";
@@ -16,6 +20,10 @@ export class StreamingMessageType {
         return m.type === "ai" && (((_a = m.tool_calls) === null || _a === void 0 ? void 0 : _a.length) || ((_b = m.tool_call_chunks) === null || _b === void 0 ? void 0 : _b.length));
     }
 }
+/**
+ * @zh LangGraphClient 类是与 LangGraph 后端交互的主要客户端。
+ * @en The LangGraphClient class is the main client for interacting with the LangGraph backend.
+ */
 export class LangGraphClient extends Client {
     constructor(config) {
         super(config);
@@ -37,6 +45,10 @@ export class LangGraphClient extends Client {
             limit: 100,
         });
     }
+    /**
+     * @zh 初始化 Assistant。
+     * @en Initializes the Assistant.
+     */
     async initAssistant(agentName) {
         try {
             const assistants = await this.listAssistants();
@@ -56,6 +68,10 @@ export class LangGraphClient extends Client {
             throw error;
         }
     }
+    /**
+     * @zh 创建一个新的 Thread。
+     * @en Creates a new Thread.
+     */
     async createThread({ threadId, } = {}) {
         try {
             this.currentThread = await this.threads.create({
@@ -68,12 +84,19 @@ export class LangGraphClient extends Client {
             throw error;
         }
     }
+    /**
+     * @zh 列出所有的 Thread。
+     * @en Lists all Threads.
+     */
     async listThreads() {
         return this.threads.search({
             sortOrder: "desc",
         });
     }
-    /** 从历史中恢复数据 */
+    /**
+     * @zh 从历史中恢复 Thread 数据。
+     * @en Resets the Thread data from history.
+     */
     async resetThread(agent, threadId) {
         await this.initAssistant(agent);
         this.currentThread = await this.threads.get(threadId);
@@ -104,7 +127,10 @@ export class LangGraphClient extends Client {
         }
         return message;
     }
-    /** 用于 UI 中的流式渲染中的消息 */
+    /**
+     * @zh 用于 UI 中的流式渲染中的消息。
+     * @en Messages used for streaming rendering in the UI.
+     */
     get renderMessage() {
         var _a;
         const previousMessage = new Map();
@@ -128,12 +154,12 @@ export class LangGraphClient extends Client {
                 /** @ts-ignore */
                 const tool_calls = ((_a = m.tool_calls) === null || _a === void 0 ? void 0 : _a.length) ? m.tool_calls : m.tool_call_chunks;
                 const new_tool_calls = tool_calls.map((tool, index) => {
-                    var _a;
+                    var _a, _b, _c, _d;
                     return this.replaceMessageWithValuesMessage({
                         type: "tool",
                         additional_kwargs: {},
                         /** @ts-ignore */
-                        tool_input: (_a = m.additional_kwargs) === null || _a === void 0 ? void 0 : _a.tool_calls[index].function.arguments,
+                        tool_input: (_d = (_c = (_b = (_a = m.additional_kwargs) === null || _a === void 0 ? void 0 : _a.tool_calls) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.function) === null || _d === void 0 ? void 0 : _d.arguments,
                         id: tool.id,
                         name: tool.name,
                         response_metadata: {},
@@ -157,6 +183,10 @@ export class LangGraphClient extends Client {
         }
         return this.attachInfoForMessage(this.composeToolMessages(result));
     }
+    /**
+     * @zh 为消息附加额外的信息，如耗时、唯一 ID 等。
+     * @en Attaches additional information to messages, such as spend time, unique ID, etc.
+     */
     attachInfoForMessage(result) {
         var _a, _b, _c;
         let lastMessage = null;
@@ -182,6 +212,10 @@ export class LangGraphClient extends Client {
         }
         return result;
     }
+    /**
+     * @zh 组合工具消息，将 AI 的工具调用和工具的执行结果关联起来。
+     * @en Composes tool messages, associating AI tool calls with tool execution results.
+     */
     composeToolMessages(messages) {
         var _a;
         const result = [];
@@ -219,6 +253,10 @@ export class LangGraphClient extends Client {
         }
         return result;
     }
+    /**
+     * @zh 获取 Token 计数器信息。
+     * @en Gets the Token counter information.
+     */
     get tokenCounter() {
         return this.graphMessages.reduce((acc, message) => {
             var _a, _b, _c, _d, _e;
@@ -240,6 +278,10 @@ export class LangGraphClient extends Client {
             output_tokens: 0,
         });
     }
+    /**
+     * @zh 注册流式更新的回调函数。
+     * @en Registers a callback function for streaming updates.
+     */
     onStreamingUpdate(callback) {
         this.streamingCallbacks.add(callback);
         return () => {
@@ -249,12 +291,20 @@ export class LangGraphClient extends Client {
     emitStreamingUpdate(event) {
         this.streamingCallbacks.forEach((callback) => callback(event));
     }
+    /**
+     * @zh 取消当前的 Run。
+     * @en Cancels the current Run.
+     */
     cancelRun() {
         var _a, _b;
         if (((_a = this.currentThread) === null || _a === void 0 ? void 0 : _a.thread_id) && ((_b = this.currentRun) === null || _b === void 0 ? void 0 : _b.run_id)) {
             this.runs.cancel(this.currentThread.thread_id, this.currentRun.run_id);
         }
     }
+    /**
+     * @zh 发送消息到 LangGraph 后端。
+     * @en Sends a message to the LangGraph backend.
+     */
     async sendMessage(input, { extraParams, _debug, command } = {}) {
         if (!this.currentAssistant) {
             throw new Error("Thread or Assistant not initialized");
@@ -366,7 +416,10 @@ export class LangGraphClient extends Client {
         const result = await this.tools.callTool(message.name, args, { client: that, message });
         return this.resume(result);
     }
-    /** 恢复消息，当中断流时使用 */
+    /**
+     * @zh 继续被前端工具中断的流程。
+     * @en Resumes a process interrupted by a frontend tool.
+     */
     resume(result) {
         return this.sendMessage([], {
             command: {
@@ -374,7 +427,10 @@ export class LangGraphClient extends Client {
             },
         });
     }
-    /** 完成工具等待 */
+    /**
+     * @zh 标记前端工具等待已完成。
+     * @en Marks the frontend tool waiting as completed.
+     */
     doneFEToolWaiting(id, result) {
         var _a;
         const done = this.tools.doneWaiting(id, result);
@@ -382,12 +438,24 @@ export class LangGraphClient extends Client {
             this.resume(result);
         }
     }
+    /**
+     * @zh 获取当前的 Thread。
+     * @en Gets the current Thread.
+     */
     getCurrentThread() {
         return this.currentThread;
     }
+    /**
+     * @zh 获取当前的 Assistant。
+     * @en Gets the current Assistant.
+     */
     getCurrentAssistant() {
         return this.currentAssistant;
     }
+    /**
+     * @zh 重置客户端状态。
+     * @en Resets the client state.
+     */
     async reset() {
         var _a;
         await this.initAssistant((_a = this.currentAssistant) === null || _a === void 0 ? void 0 : _a.name);

package/dist/SpendTime.d.ts

@@ -1,9 +1,37 @@
+/**
+ * @zh SpendTime 类用于计算和记录操作的耗时。
+ * @en The SpendTime class is used to calculate and record the time spent on operations.
+ */
 export declare class SpendTime {
     private timeCounter;
+    /**
+     * @zh 开始计时。
+     * @en Starts timing.
+     */
     start(key: string): void;
+    /**
+     * @zh 结束计时。
+     * @en Ends timing.
+     */
     end(key: string): void;
+    /**
+     * @zh 设置或更新指定键的耗时记录。如果键已存在，则更新结束时间；否则，开始新的计时。
+     * @en Sets or updates the time spent record for the specified key. If the key already exists, updates the end time; otherwise, starts a new timing.
+     */
     setSpendTime(key: string): void;
+    /**
+     * @zh 获取指定键的开始时间。
+     * @en Gets the start time for the specified key.
+     */
     getStartTime(key: string): Date;
+    /**
+     * @zh 获取指定键的结束时间。
+     * @en Gets the end time for the specified key.
+     */
     getEndTime(key: string): Date;
+    /**
+     * @zh 获取指定键的耗时（毫秒）。
+     * @en Gets the time spent (in milliseconds) for the specified key.
+     */
     getSpendTime(key: string): number;
 }

package/dist/SpendTime.js

@@ -1,14 +1,30 @@
+/**
+ * @zh SpendTime 类用于计算和记录操作的耗时。
+ * @en The SpendTime class is used to calculate and record the time spent on operations.
+ */
 export class SpendTime {
     constructor() {
         this.timeCounter = new Map();
     }
+    /**
+     * @zh 开始计时。
+     * @en Starts timing.
+     */
     start(key) {
         this.timeCounter.set(key, [new Date()]);
     }
+    /**
+     * @zh 结束计时。
+     * @en Ends timing.
+     */
     end(key) {
         var _a;
         this.timeCounter.set(key, [((_a = this.timeCounter.get(key)) === null || _a === void 0 ? void 0 : _a[0]) || new Date(), new Date()]);
     }
+    /**
+     * @zh 设置或更新指定键的耗时记录。如果键已存在，则更新结束时间；否则，开始新的计时。
+     * @en Sets or updates the time spent record for the specified key. If the key already exists, updates the end time; otherwise, starts a new timing.
+     */
     setSpendTime(key) {
         if (this.timeCounter.has(key)) {
             this.end(key);
@@ -17,14 +33,26 @@ export class SpendTime {
             this.start(key);
         }
     }
+    /**
+     * @zh 获取指定键的开始时间。
+     * @en Gets the start time for the specified key.
+     */
     getStartTime(key) {
         var _a;
         return ((_a = this.timeCounter.get(key)) === null || _a === void 0 ? void 0 : _a[0]) || new Date();
     }
+    /**
+     * @zh 获取指定键的结束时间。
+     * @en Gets the end time for the specified key.
+     */
     getEndTime(key) {
         var _a;
         return ((_a = this.timeCounter.get(key)) === null || _a === void 0 ? void 0 : _a[1]) || new Date();
     }
+    /**
+     * @zh 获取指定键的耗时（毫秒）。
+     * @en Gets the time spent (in milliseconds) for the specified key.
+     */
     getSpendTime(key) {
         const [start, end = new Date()] = this.timeCounter.get(key) || [new Date(), new Date()];
         return end.getTime() - start.getTime();

package/dist/ToolManager.d.ts

@@ -1,43 +1,54 @@
 import { ToolMessage } from "@langchain/langgraph-sdk";
-import { LangGraphClient } from "./LangGraphClient";
-import { CallToolResult, UnionTool } from "./tool/createTool";
+import { LangGraphClient } from "./LangGraphClient.js";
+import { CallToolResult, UnionTool } from "./tool/createTool.js";
+/**
+ * @zh ToolManager 类用于管理和执行工具。
+ * @en The ToolManager class is used to manage and execute tools.
+ */
 export declare class ToolManager {
     private tools;
     /**
-     * 注册一个工具
-     * @param tool 要注册的工具
+     * @zh 注册一个工具。
+     * @en Registers a tool.
      */
     bindTool(tool: UnionTool<any>): void;
     /**
-     * 注册多个工具
-     * @param tools 要注册的工具数组
+     * @zh 注册多个工具。
+     * @en Registers multiple tools.
      */
     bindTools(tools: UnionTool<any>[]): void;
     /**
-     * 获取所有已注册的工具
-     * @returns 工具数组
+     * @zh 获取所有已注册的工具。
+     * @en Gets all registered tools.
      */
     getAllTools(): UnionTool<any>[];
     /**
-     * 获取指定名称的工具
-     * @param name 工具名称
-     * @returns 工具实例或 undefined
+     * @zh 获取指定名称的工具。
+     * @en Gets the tool with the specified name.
      */
     getTool(name: string): UnionTool<any> | undefined;
     /**
-     * 移除指定名称的工具
-     * @param name 工具名称
-     * @returns 是否成功移除
+     * @zh 移除指定名称的工具。
+     * @en Removes the tool with the specified name.
      */
     removeTool(name: string): boolean;
     /**
-     * 清空所有工具
+     * @zh 清空所有工具。
+     * @en Clears all tools.
      */
     clearTools(): void;
+    /**
+     * @zh 调用指定名称的工具。
+     * @en Calls the tool with the specified name.
+     */
     callTool(name: string, args: any, context: {
         client: LangGraphClient;
         message: ToolMessage;
     }): Promise<CallToolResult>;
+    /**
+     * @zh 将所有工具转换为 JSON 定义格式。
+     * @en Converts all tools to JSON definition format.
+     */
     toJSON(): {
         name: string;
         description: string;
@@ -49,12 +60,19 @@ export declare class ToolManager {
         };
     }[];
     private waitingMap;
+    /**
+     * @zh 标记指定 ID 的工具等待已完成，并传递结果。
+     * @en Marks the tool waiting with the specified ID as completed and passes the result.
+     */
     doneWaiting(id: string, value: CallToolResult): boolean;
+    /**
+     * @zh 等待指定 ID 的工具完成。
+     * @en Waits for the tool with the specified ID to complete.
+     */
     waitForDone(id: string): Promise<unknown> | ((value: CallToolResult) => void) | undefined;
-    /** 等待用户输入
-     * @example
-     * // 继续 chat 流
-     * client.tools.doneWaiting(message.id!, (e.target as any).value);
+    /**
+     * @zh 一个静态方法，用于在前端等待用户界面操作完成。
+     * @en A static method used in the frontend to wait for user interface operations to complete.
      */
     static waitForUIDone<T>(_: T, context: {
         client: LangGraphClient;

package/dist/ToolManager.js

@@ -1,4 +1,8 @@
-import { createJSONDefineTool } from "./tool/createTool";
+import { createJSONDefineTool } from "./tool/createTool.js";
+/**
+ * @zh ToolManager 类用于管理和执行工具。
+ * @en The ToolManager class is used to manage and execute tools.
+ */
 export class ToolManager {
     constructor() {
         this.tools = new Map();
@@ -6,8 +10,8 @@ export class ToolManager {
         this.waitingMap = new Map();
     }
     /**
-     * 注册一个工具
-     * @param tool 要注册的工具
+     * @zh 注册一个工具。
+     * @en Registers a tool.
      */
     bindTool(tool) {
         if (this.tools.has(tool.name)) {
@@ -16,41 +20,44 @@ export class ToolManager {
         this.tools.set(tool.name, tool);
     }
     /**
-     * 注册多个工具
-     * @param tools 要注册的工具数组
+     * @zh 注册多个工具。
+     * @en Registers multiple tools.
      */
     bindTools(tools) {
         tools.forEach((tool) => this.bindTool(tool));
     }
     /**
-     * 获取所有已注册的工具
-     * @returns 工具数组
+     * @zh 获取所有已注册的工具。
+     * @en Gets all registered tools.
      */
     getAllTools() {
         return Array.from(this.tools.values());
     }
     /**
-     * 获取指定名称的工具
-     * @param name 工具名称
-     * @returns 工具实例或 undefined
+     * @zh 获取指定名称的工具。
+     * @en Gets the tool with the specified name.
      */
     getTool(name) {
         return this.tools.get(name);
     }
     /**
-     * 移除指定名称的工具
-     * @param name 工具名称
-     * @returns 是否成功移除
+     * @zh 移除指定名称的工具。
+     * @en Removes the tool with the specified name.
      */
     removeTool(name) {
         return this.tools.delete(name);
     }
     /**
-     * 清空所有工具
+     * @zh 清空所有工具。
+     * @en Clears all tools.
      */
     clearTools() {
         this.tools.clear();
     }
+    /**
+     * @zh 调用指定名称的工具。
+     * @en Calls the tool with the specified name.
+     */
     async callTool(name, args, context) {
         const tool = this.getTool(name);
         if (!tool) {
@@ -58,9 +65,17 @@ export class ToolManager {
         }
         return await tool.execute(args, context);
     }
+    /**
+     * @zh 将所有工具转换为 JSON 定义格式。
+     * @en Converts all tools to JSON definition format.
+     */
     toJSON() {
         return Array.from(this.tools.values()).map((i) => createJSONDefineTool(i));
     }
+    /**
+     * @zh 标记指定 ID 的工具等待已完成，并传递结果。
+     * @en Marks the tool waiting with the specified ID as completed and passes the result.
+     */
     doneWaiting(id, value) {
         if (this.waitingMap.has(id)) {
             this.waitingMap.get(id)(value);
@@ -72,6 +87,10 @@ export class ToolManager {
             return false;
         }
     }
+    /**
+     * @zh 等待指定 ID 的工具完成。
+     * @en Waits for the tool with the specified ID to complete.
+     */
     waitForDone(id) {
         if (this.waitingMap.has(id)) {
             return this.waitingMap.get(id);
@@ -81,10 +100,9 @@ export class ToolManager {
         });
         return promise;
     }
-    /** 等待用户输入
-     * @example
-     * // 继续 chat 流
-     * client.tools.doneWaiting(message.id!, (e.target as any).value);
+    /**
+     * @zh 一个静态方法，用于在前端等待用户界面操作完成。
+     * @en A static method used in the frontend to wait for user interface operations to complete.
      */
     static waitForUIDone(_, context) {
         // console.log(context.message);

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./LangGraphClient";
-export * from "./tool";
+export * from "./LangGraphClient.js";
+export * from "./tool/index.js";
 export * from "@langchain/langgraph-sdk";
-export * from "./ui-store";
-export * from "./ToolManager";
+export * from "./ui-store/index.js";
+export * from "./ToolManager.js";

package/dist/index.js

@@ -1,5 +1,5 @@
-export * from "./LangGraphClient";
-export * from "./tool";
+export * from "./LangGraphClient.js";
+export * from "./tool/index.js";
 export * from "@langchain/langgraph-sdk";
-export * from "./ui-store";
-export * from "./ToolManager";
+export * from "./ui-store/index.js";
+export * from "./ToolManager.js";