@langgraph-js/sdk 1.6.3 → 1.7.0

package/src/SpendTime.ts

@@ -1,60 +1,60 @@
-/**
- * @zh SpendTime 类用于计算和记录操作的耗时。
- * @en The SpendTime class is used to calculate and record the time spent on operations.
- */
-export class SpendTime {
-    private timeCounter = new Map<string, [Date, Date] | [Date]>();
-
-    /**
-     * @zh 开始计时。
-     * @en Starts timing.
-     */
-    start(key: string) {
-        this.timeCounter.set(key, [new Date()]);
-    }
-
-    /**
-     * @zh 结束计时。
-     * @en Ends timing.
-     */
-    end(key: string) {
-        this.timeCounter.set(key, [this.timeCounter.get(key)?.[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: string) {
-        if (this.timeCounter.has(key)) {
-            this.end(key);
-        } else {
-            this.start(key);
-        }
-    }
-
-    /**
-     * @zh 获取指定键的开始时间。
-     * @en Gets the start time for the specified key.
-     */
-    getStartTime(key: string) {
-        return this.timeCounter.get(key)?.[0] || new Date();
-    }
-
-    /**
-     * @zh 获取指定键的结束时间。
-     * @en Gets the end time for the specified key.
-     */
-    getEndTime(key: string) {
-        return this.timeCounter.get(key)?.[1] || new Date();
-    }
-
-    /**
-     * @zh 获取指定键的耗时（毫秒）。
-     * @en Gets the time spent (in milliseconds) for the specified key.
-     */
-    getSpendTime(key: string) {
-        const [start, end = new Date()] = this.timeCounter.get(key) || [new Date(), new Date()];
-        return end.getTime() - start.getTime();
-    }
-}
+/**
+ * @zh SpendTime 类用于计算和记录操作的耗时。
+ * @en The SpendTime class is used to calculate and record the time spent on operations.
+ */
+export class SpendTime {
+    private timeCounter = new Map<string, [Date, Date] | [Date]>();
+
+    /**
+     * @zh 开始计时。
+     * @en Starts timing.
+     */
+    start(key: string) {
+        this.timeCounter.set(key, [new Date()]);
+    }
+
+    /**
+     * @zh 结束计时。
+     * @en Ends timing.
+     */
+    end(key: string) {
+        this.timeCounter.set(key, [this.timeCounter.get(key)?.[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: string) {
+        if (this.timeCounter.has(key)) {
+            this.end(key);
+        } else {
+            this.start(key);
+        }
+    }
+
+    /**
+     * @zh 获取指定键的开始时间。
+     * @en Gets the start time for the specified key.
+     */
+    getStartTime(key: string) {
+        return this.timeCounter.get(key)?.[0] || new Date();
+    }
+
+    /**
+     * @zh 获取指定键的结束时间。
+     * @en Gets the end time for the specified key.
+     */
+    getEndTime(key: string) {
+        return this.timeCounter.get(key)?.[1] || new Date();
+    }
+
+    /**
+     * @zh 获取指定键的耗时（毫秒）。
+     * @en Gets the time spent (in milliseconds) for the specified key.
+     */
+    getSpendTime(key: string) {
+        const [start, end = new Date()] = this.timeCounter.get(key) || [new Date(), new Date()];
+        return end.getTime() - start.getTime();
+    }
+}

package/src/ToolManager.ts

@@ -1,131 +1,131 @@
-import { ToolMessage } from "@langchain/langgraph-sdk";
-import { LangGraphClient } from "./LangGraphClient.js";
-import { CallToolResult, createJSONDefineTool, UnionTool } from "./tool/createTool.js";
-
-/**
- * @zh ToolManager 类用于管理和执行工具。
- * @en The ToolManager class is used to manage and execute tools.
- */
-export class ToolManager {
-    private tools: Map<string, UnionTool<any>> = new Map();
-    // === 专门为前端设计的异步触发结构
-    private waitingMap: Map<string, (value: CallToolResult) => void> = new Map();
-
-    /**
-     * @zh 注册一个工具。
-     * @en Registers a tool.
-     */
-    bindTool(tool: UnionTool<any>) {
-        if (this.tools.has(tool.name)) {
-            throw new Error(`Tool with name ${tool.name} already exists`);
-        }
-        this.tools.set(tool.name, tool);
-    }
-
-    /**
-     * @zh 注册多个工具。
-     * @en Registers multiple tools.
-     */
-    bindTools(tools: UnionTool<any>[]) {
-        tools.forEach((tool) => this.bindTool(tool));
-    }
-
-    /**
-     * @zh 获取所有已注册的工具。
-     * @en Gets all registered tools.
-     */
-    getAllTools(): UnionTool<any>[] {
-        return Array.from(this.tools.values());
-    }
-
-    /**
-     * @zh 获取指定名称的工具。
-     * @en Gets the tool with the specified name.
-     */
-    getTool(name: string): UnionTool<any> | undefined {
-        return this.tools.get(name);
-    }
-
-    /**
-     * @zh 移除指定名称的工具。
-     * @en Removes the tool with the specified name.
-     */
-    removeTool(name: string): boolean {
-        return this.tools.delete(name);
-    }
-
-    /**
-     * @zh 清空所有工具。
-     * @en Clears all tools.
-     */
-    clearTools() {
-        this.tools.clear();
-    }
-    reset() {
-        this.clearTools();
-        this.clearWaiting();
-    }
-    clearWaiting() {
-        this.waitingMap.clear();
-    }
-
-    /**
-     * @zh 调用指定名称的工具。
-     * @en Calls the tool with the specified name.
-     */
-    async callTool(name: string, args: any, context: { client: LangGraphClient; message: ToolMessage }) {
-        const tool = this.getTool(name);
-        if (!tool) {
-            throw new Error(`Tool with name ${name} not found`);
-        }
-        return await tool.execute(args, context);
-    }
-
-    /**
-     * @zh 将所有工具转换为 JSON 定义格式。
-     * @en Converts all tools to JSON definition format.
-     */
-    toJSON(remote = true) {
-        return Array.from(this.tools.values())
-            .filter((i) => (remote ? !i.onlyRender : true))
-            .map((i) => createJSONDefineTool(i));
-    }
-
-    /**
-     * @zh 标记指定 ID 的工具等待已完成，并传递结果。
-     * @en Marks the tool waiting with the specified ID as completed and passes the result.
-     */
-    doneWaiting(id: string, value: CallToolResult) {
-        if (this.waitingMap.has(id)) {
-            this.waitingMap.get(id)!(value);
-            this.waitingMap.delete(id);
-            return true;
-        } else {
-            console.warn(`Waiting for tool ${id} not found`);
-            return false;
-        }
-    }
-
-    /**
-     * @zh 等待指定 ID 的工具完成。
-     * @en Waits for the tool with the specified ID to complete.
-     */
-    waitForDone(id: string) {
-        if (this.waitingMap.has(id)) {
-            return this.waitingMap.get(id);
-        }
-        const promise = new Promise((resolve, reject) => {
-            this.waitingMap.set(id, resolve);
-        });
-        return promise;
-    }
-
-    /**
-     * @zh 一个静态方法，用于在前端等待用户界面操作完成。
-     * @en A static method used in the frontend to wait for user interface operations to complete.
-     */
-    static waitForUIDone<T>(_: T, context: { client: LangGraphClient; message: ToolMessage }) {
-        // console.log(context.message);
-        return context.client.tools.waitForDone(context.message.id!);
-    }
-}
+import { ToolMessage } from "@langchain/langgraph-sdk";
+import { LangGraphClient } from "./LangGraphClient.js";
+import { CallToolResult, createJSONDefineTool, UnionTool } from "./tool/createTool.js";
+
+/**
+ * @zh ToolManager 类用于管理和执行工具。
+ * @en The ToolManager class is used to manage and execute tools.
+ */
+export class ToolManager {
+    private tools: Map<string, UnionTool<any>> = new Map();
+    // === 专门为前端设计的异步触发结构
+    private waitingMap: Map<string, (value: CallToolResult) => void> = new Map();
+
+    /**
+     * @zh 注册一个工具。
+     * @en Registers a tool.
+     */
+    bindTool(tool: UnionTool<any>) {
+        if (this.tools.has(tool.name)) {
+            throw new Error(`Tool with name ${tool.name} already exists`);
+        }
+        this.tools.set(tool.name, tool);
+    }
+
+    /**
+     * @zh 注册多个工具。
+     * @en Registers multiple tools.
+     */
+    bindTools(tools: UnionTool<any>[]) {
+        tools.forEach((tool) => this.bindTool(tool));
+    }
+
+    /**
+     * @zh 获取所有已注册的工具。
+     * @en Gets all registered tools.
+     */
+    getAllTools(): UnionTool<any>[] {
+        return Array.from(this.tools.values());
+    }
+
+    /**
+     * @zh 获取指定名称的工具。
+     * @en Gets the tool with the specified name.
+     */
+    getTool(name: string): UnionTool<any> | undefined {
+        return this.tools.get(name);
+    }
+
+    /**
+     * @zh 移除指定名称的工具。
+     * @en Removes the tool with the specified name.
+     */
+    removeTool(name: string): boolean {
+        return this.tools.delete(name);
+    }
+
+    /**
+     * @zh 清空所有工具。
+     * @en Clears all tools.
+     */
+    clearTools() {
+        this.tools.clear();
+    }
+    reset() {
+        this.clearTools();
+        this.clearWaiting();
+    }
+    clearWaiting() {
+        this.waitingMap.clear();
+    }
+
+    /**
+     * @zh 调用指定名称的工具。
+     * @en Calls the tool with the specified name.
+     */
+    async callTool(name: string, args: any, context: { client: LangGraphClient; message: ToolMessage }) {
+        const tool = this.getTool(name);
+        if (!tool) {
+            throw new Error(`Tool with name ${name} not found`);
+        }
+        return await tool.execute(args, context);
+    }
+
+    /**
+     * @zh 将所有工具转换为 JSON 定义格式。
+     * @en Converts all tools to JSON definition format.
+     */
+    toJSON(remote = true) {
+        return Array.from(this.tools.values())
+            .filter((i) => (remote ? !i.onlyRender : true))
+            .map((i) => createJSONDefineTool(i));
+    }
+
+    /**
+     * @zh 标记指定 ID 的工具等待已完成，并传递结果。
+     * @en Marks the tool waiting with the specified ID as completed and passes the result.
+     */
+    doneWaiting(id: string, value: CallToolResult) {
+        if (this.waitingMap.has(id)) {
+            this.waitingMap.get(id)!(value);
+            this.waitingMap.delete(id);
+            return true;
+        } else {
+            console.warn(`Waiting for tool ${id} not found`);
+            return false;
+        }
+    }
+
+    /**
+     * @zh 等待指定 ID 的工具完成。
+     * @en Waits for the tool with the specified ID to complete.
+     */
+    waitForDone(id: string) {
+        if (this.waitingMap.has(id)) {
+            return this.waitingMap.get(id);
+        }
+        const promise = new Promise((resolve, reject) => {
+            this.waitingMap.set(id, resolve);
+        });
+        return promise;
+    }
+
+    /**
+     * @zh 一个静态方法，用于在前端等待用户界面操作完成。
+     * @en A static method used in the frontend to wait for user interface operations to complete.
+     */
+    static waitForUIDone<T>(_: T, context: { client: LangGraphClient; message: ToolMessage }) {
+        // console.log(context.message);
+        return context.client.tools.waitForDone(context.message.id!);
+    }
+}

package/src/index.ts

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

package/src/tool/ToolUI.ts

@@ -1,41 +1,41 @@
-import { RenderMessage } from "../LangGraphClient.js";
-
-import { LangGraphClient } from "../LangGraphClient.js";
-import { getMessageContent } from "../ui-store/createChatStore.js";
-
-export class ToolRenderData<D> {
-    constructor(
-        public message: RenderMessage,
-        public client: LangGraphClient
-    ) {}
-    get state() {
-        if (this.message.type === "tool" && this.message?.additional_kwargs?.done) {
-            return "done";
-        }
-        return "idle";
-    }
-    get input() {
-        try {
-            return JSON.parse(this.message.tool_input!);
-        } catch (e) {
-            return null;
-        }
-    }
-    get output() {
-        return getMessageContent(this.message.content);
-    }
-    getJSONOutput() {
-        return JSON.parse(this.output);
-    }
-    /** 如果解析失败，则返回 null */
-    getJSONOutputSafe() {
-        try {
-            return JSON.parse(this.output);
-        } catch (e) {
-            return null;
-        }
-    }
-    response(data: D) {
-        this.client.doneFEToolWaiting(this.message.id!, JSON.stringify(data));
-    }
-}
+import { RenderMessage } from "../LangGraphClient.js";
+
+import { LangGraphClient } from "../LangGraphClient.js";
+import { getMessageContent } from "../ui-store/createChatStore.js";
+
+export class ToolRenderData<D> {
+    constructor(
+        public message: RenderMessage,
+        public client: LangGraphClient
+    ) {}
+    get state() {
+        if (this.message.type === "tool" && this.message?.additional_kwargs?.done) {
+            return "done";
+        }
+        return "idle";
+    }
+    get input() {
+        try {
+            return JSON.parse(this.message.tool_input!);
+        } catch (e) {
+            return null;
+        }
+    }
+    get output() {
+        return getMessageContent(this.message.content);
+    }
+    getJSONOutput() {
+        return JSON.parse(this.output);
+    }
+    /** 如果解析失败，则返回 null */
+    getJSONOutputSafe() {
+        try {
+            return JSON.parse(this.output);
+        } catch (e) {
+            return null;
+        }
+    }
+    response(data: D) {
+        this.client.doneFEToolWaiting(this.message.id!, JSON.stringify(data));
+    }
+}

package/src/tool/copilotkit-actions.ts

@@ -1,72 +1,72 @@
-import { Message } from "@langchain/langgraph-sdk";
-/**
- * copy and modify from copilotkit
- * https://github.com/copilotkit/copilotkit
- *
- * MIT License
- */
-type TypeMap = {
-    string: string;
-    number: number;
-    boolean: boolean;
-    object: object;
-    "string[]": string[];
-    "number[]": number[];
-    "boolean[]": boolean[];
-    "object[]": object[];
-};
-
-type AbstractParameter = {
-    name: string;
-    type?: keyof TypeMap;
-    description?: string;
-    required?: boolean;
-};
-
-interface StringParameter extends AbstractParameter {
-    type: "string";
-    enum?: string[];
-}
-
-interface ObjectParameter extends AbstractParameter {
-    type: "object";
-    attributes?: Parameter[];
-}
-
-interface ObjectArrayParameter extends AbstractParameter {
-    type: "object[]";
-    attributes?: Parameter[];
-}
-
-type SpecialParameters = StringParameter | ObjectParameter | ObjectArrayParameter;
-interface BaseParameter extends AbstractParameter {
-    type?: Exclude<AbstractParameter["type"], SpecialParameters["type"]>;
-}
-
-export type Parameter = BaseParameter | SpecialParameters;
-
-type OptionalParameterType<P extends AbstractParameter> = P["required"] extends false ? undefined : never;
-
-type StringParameterType<P> = P extends StringParameter ? (P extends { enum?: Array<infer E> } ? E : string) : never;
-
-type ObjectParameterType<P> = P extends ObjectParameter ? (P extends { attributes?: infer Attributes extends Parameter[] } ? MappedParameterTypes<Attributes> : object) : never;
-
-type ObjectArrayParameterType<P> = P extends ObjectArrayParameter ? (P extends { attributes?: infer Attributes extends Parameter[] } ? MappedParameterTypes<Attributes>[] : any[]) : never;
-
-type MappedTypeOrString<T> = T extends keyof TypeMap ? TypeMap[T] : string;
-type BaseParameterType<P extends AbstractParameter> = P extends { type: infer T } ? (T extends BaseParameter["type"] ? MappedTypeOrString<T> : never) : string;
-
-export type MappedParameterTypes<T extends Parameter[] | [] = []> = T extends []
-    ? Record<string, any>
-    : {
-          [P in T[number] as P["name"]]: OptionalParameterType<P> | StringParameterType<P> | ObjectParameterType<P> | ObjectArrayParameterType<P> | BaseParameterType<P>;
-      };
-
-export type Action<T extends Parameter[] | [] = []> = {
-    name: string;
-    description?: string;
-    parameters?: T;
-    handler?: T extends [] ? () => any | Promise<any> : (args: MappedParameterTypes<T>, context?: any) => any | Promise<any>;
-    returnDirect?: boolean;
-    callbackMessage?: () => Message[];
-};
+import { Message } from "@langchain/langgraph-sdk";
+/**
+ * copy and modify from copilotkit
+ * https://github.com/copilotkit/copilotkit
+ *
+ * MIT License
+ */
+type TypeMap = {
+    string: string;
+    number: number;
+    boolean: boolean;
+    object: object;
+    "string[]": string[];
+    "number[]": number[];
+    "boolean[]": boolean[];
+    "object[]": object[];
+};
+
+type AbstractParameter = {
+    name: string;
+    type?: keyof TypeMap;
+    description?: string;
+    required?: boolean;
+};
+
+interface StringParameter extends AbstractParameter {
+    type: "string";
+    enum?: string[];
+}
+
+interface ObjectParameter extends AbstractParameter {
+    type: "object";
+    attributes?: Parameter[];
+}
+
+interface ObjectArrayParameter extends AbstractParameter {
+    type: "object[]";
+    attributes?: Parameter[];
+}
+
+type SpecialParameters = StringParameter | ObjectParameter | ObjectArrayParameter;
+interface BaseParameter extends AbstractParameter {
+    type?: Exclude<AbstractParameter["type"], SpecialParameters["type"]>;
+}
+
+export type Parameter = BaseParameter | SpecialParameters;
+
+type OptionalParameterType<P extends AbstractParameter> = P["required"] extends false ? undefined : never;
+
+type StringParameterType<P> = P extends StringParameter ? (P extends { enum?: Array<infer E> } ? E : string) : never;
+
+type ObjectParameterType<P> = P extends ObjectParameter ? (P extends { attributes?: infer Attributes extends Parameter[] } ? MappedParameterTypes<Attributes> : object) : never;
+
+type ObjectArrayParameterType<P> = P extends ObjectArrayParameter ? (P extends { attributes?: infer Attributes extends Parameter[] } ? MappedParameterTypes<Attributes>[] : any[]) : never;
+
+type MappedTypeOrString<T> = T extends keyof TypeMap ? TypeMap[T] : string;
+type BaseParameterType<P extends AbstractParameter> = P extends { type: infer T } ? (T extends BaseParameter["type"] ? MappedTypeOrString<T> : never) : string;
+
+export type MappedParameterTypes<T extends Parameter[] | [] = []> = T extends []
+    ? Record<string, any>
+    : {
+          [P in T[number] as P["name"]]: OptionalParameterType<P> | StringParameterType<P> | ObjectParameterType<P> | ObjectArrayParameterType<P> | BaseParameterType<P>;
+      };
+
+export type Action<T extends Parameter[] | [] = []> = {
+    name: string;
+    description?: string;
+    parameters?: T;
+    handler?: T extends [] ? () => any | Promise<any> : (args: MappedParameterTypes<T>, context?: any) => any | Promise<any>;
+    returnDirect?: boolean;
+    callbackMessage?: () => Message[];
+};