@copilotkit/sdk-js 1.51.5-next.0 → 1.51.5-next.1

package/dist/langgraph/utils.cjs

@@ -0,0 +1,281 @@
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+let _langchain_langgraph = require("@langchain/langgraph");
+let _langchain_core_callbacks_dispatch = require("@langchain/core/callbacks/dispatch");
+let _copilotkit_shared = require("@copilotkit/shared");
+let _langchain_core_tools = require("@langchain/core/tools");
+let _langchain_core_messages = require("@langchain/core/messages");
+
+//#region src/langgraph/utils.ts
+/**
+* Customize the LangGraph configuration for use in CopilotKit.
+*
+* To the CopilotKit SDK, run:
+*
+* ```bash
+* npm install @copilotkit/sdk-js
+* ```
+*
+* ### Examples
+*
+* Disable emitting messages and tool calls:
+*
+* ```typescript
+* import { copilotkitCustomizeConfig } from "@copilotkit/sdk-js";
+*
+* config = copilotkitCustomizeConfig(
+*   config,
+*   emitMessages=false,
+*   emitToolCalls=false
+* )
+* ```
+*
+* To emit a tool call as streaming LangGraph state, pass the destination key in state,
+* the tool name and optionally the tool argument. (If you don't pass the argument name,
+* all arguments are emitted under the state key.)
+*
+* ```typescript
+* import { copilotkitCustomizeConfig } from "@copilotkit/sdk-js";
+*
+* config = copilotkitCustomizeConfig(
+*   config,
+*   emitIntermediateState=[
+*     {
+*       "stateKey": "steps",
+*       "tool": "SearchTool",
+*       "toolArgument": "steps",
+*     },
+*   ],
+* )
+* ```
+*/
+function copilotkitCustomizeConfig(baseConfig, options) {
+	if (baseConfig && typeof baseConfig !== "object") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "baseConfig must be an object or null/undefined" });
+	if (options && typeof options !== "object") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "options must be an object when provided" });
+	if (options?.emitIntermediateState) {
+		if (!Array.isArray(options.emitIntermediateState)) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "emitIntermediateState must be an array when provided" });
+		options.emitIntermediateState.forEach((state, index) => {
+			if (!state || typeof state !== "object") throw new _copilotkit_shared.CopilotKitMisuseError({ message: `emitIntermediateState[${index}] must be an object` });
+			if (!state.stateKey || typeof state.stateKey !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: `emitIntermediateState[${index}] must have a valid 'stateKey' string property` });
+			if (!state.tool || typeof state.tool !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: `emitIntermediateState[${index}] must have a valid 'tool' string property` });
+			if (state.toolArgument && typeof state.toolArgument !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: `emitIntermediateState[${index}].toolArgument must be a string when provided` });
+		});
+	}
+	try {
+		const metadata = baseConfig?.metadata || {};
+		if (options?.emitAll) {
+			metadata["copilotkit:emit-tool-calls"] = true;
+			metadata["copilotkit:emit-messages"] = true;
+		} else {
+			if (options?.emitToolCalls !== void 0) metadata["copilotkit:emit-tool-calls"] = options.emitToolCalls;
+			if (options?.emitMessages !== void 0) metadata["copilotkit:emit-messages"] = options.emitMessages;
+		}
+		if (options?.emitIntermediateState) metadata["copilotkit:emit-intermediate-state"] = options.emitIntermediateState.map((state) => ({
+			tool: state.tool,
+			tool_argument: state.toolArgument,
+			state_key: state.stateKey
+		}));
+		baseConfig = baseConfig || {};
+		return {
+			...baseConfig,
+			metadata
+		};
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to customize config: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+/**
+* Exits the current agent after the run completes. Calling copilotkit_exit() will
+* not immediately stop the agent. Instead, it signals to CopilotKit to stop the agent after
+* the run completes.
+*
+* ### Examples
+*
+* ```typescript
+* import { copilotkitExit } from "@copilotkit/sdk-js";
+*
+* async function myNode(state: Any):
+*   await copilotkitExit(config)
+*   return state
+* ```
+*/
+async function copilotkitExit(config) {
+	if (!config) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "LangGraph configuration is required for copilotkitExit" });
+	try {
+		await (0, _langchain_core_callbacks_dispatch.dispatchCustomEvent)("copilotkit_exit", {}, config);
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to dispatch exit event: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+/**
+* Emits intermediate state to CopilotKit. Useful if you have a longer running node and you want to
+* update the user with the current state of the node.
+*
+* ### Examples
+*
+* ```typescript
+* import { copilotkitEmitState } from "@copilotkit/sdk-js";
+*
+* for (let i = 0; i < 10; i++) {
+*   await someLongRunningOperation(i);
+*   await copilotkitEmitState(config, { progress: i });
+* }
+* ```
+*/
+async function copilotkitEmitState(config, state) {
+	if (!config) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "LangGraph configuration is required for copilotkitEmitState" });
+	if (state === void 0) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "State is required for copilotkitEmitState" });
+	try {
+		await (0, _langchain_core_callbacks_dispatch.dispatchCustomEvent)("copilotkit_manually_emit_intermediate_state", state, config);
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to emit state: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+/**
+* Manually emits a message to CopilotKit. Useful in longer running nodes to update the user.
+* Important: You still need to return the messages from the node.
+*
+* ### Examples
+*
+* ```typescript
+* import { copilotkitEmitMessage } from "@copilotkit/sdk-js";
+*
+* const message = "Step 1 of 10 complete";
+* await copilotkitEmitMessage(config, message);
+*
+* // Return the message from the node
+* return {
+*   "messages": [AIMessage(content=message)]
+* }
+* ```
+*/
+async function copilotkitEmitMessage(config, message) {
+	if (!config) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "LangGraph configuration is required for copilotkitEmitMessage" });
+	if (!message || typeof message !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Message must be a non-empty string for copilotkitEmitMessage" });
+	try {
+		await (0, _langchain_core_callbacks_dispatch.dispatchCustomEvent)("copilotkit_manually_emit_message", {
+			message,
+			message_id: (0, _copilotkit_shared.randomId)(),
+			role: "assistant"
+		}, config);
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to emit message: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+/**
+* Manually emits a tool call to CopilotKit.
+*
+* ### Examples
+*
+* ```typescript
+* import { copilotkitEmitToolCall } from "@copilotkit/sdk-js";
+*
+* await copilotkitEmitToolCall(config, name="SearchTool", args={"steps": 10})
+* ```
+*/
+async function copilotkitEmitToolCall(config, name, args) {
+	if (!config) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "LangGraph configuration is required for copilotkitEmitToolCall" });
+	if (!name || typeof name !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Tool name must be a non-empty string for copilotkitEmitToolCall" });
+	if (args === void 0) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Tool arguments are required for copilotkitEmitToolCall" });
+	try {
+		await (0, _langchain_core_callbacks_dispatch.dispatchCustomEvent)("copilotkit_manually_emit_tool_call", {
+			name,
+			args,
+			id: (0, _copilotkit_shared.randomId)()
+		}, config);
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to emit tool call '${name}': ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+function convertActionToDynamicStructuredTool(actionInput) {
+	if (!actionInput) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Action input is required but was not provided" });
+	if (!actionInput.name || typeof actionInput.name !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Action must have a valid 'name' property of type string" });
+	if (actionInput.description == void 0 || actionInput.description == null || typeof actionInput.description !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Action '${actionInput.name}' must have a valid 'description' property of type string` });
+	if (!actionInput.parameters) throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Action '${actionInput.name}' must have a 'parameters' property` });
+	try {
+		return new _langchain_core_tools.DynamicStructuredTool({
+			name: actionInput.name,
+			description: actionInput.description,
+			schema: (0, _copilotkit_shared.convertJsonSchemaToZodSchema)(actionInput.parameters, true),
+			func: async () => {
+				return "";
+			}
+		});
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to convert action '${actionInput.name}' to DynamicStructuredTool: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+/**
+* Use this function to convert a list of actions you get from state
+* to a list of dynamic structured tools.
+*
+* ### Examples
+*
+* ```typescript
+* import { convertActionsToDynamicStructuredTools } from "@copilotkit/sdk-js";
+*
+* const tools = convertActionsToDynamicStructuredTools(state.copilotkit.actions);
+* ```
+*/
+function convertActionsToDynamicStructuredTools(actions) {
+	if (!Array.isArray(actions)) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Actions must be an array" });
+	return actions.map((action, index) => {
+		try {
+			return convertActionToDynamicStructuredTool(action.type === "function" ? action.function : action);
+		} catch (error) {
+			throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to convert action at index ${index}: ${error instanceof Error ? error.message : String(error)}` });
+		}
+	});
+}
+function copilotKitInterrupt({ message, action, args }) {
+	if (!message && !action) throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Either message or action (and optional arguments) must be provided for copilotKitInterrupt" });
+	if (action && typeof action !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Action must be a string when provided to copilotKitInterrupt" });
+	if (message && typeof message !== "string") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Message must be a string when provided to copilotKitInterrupt" });
+	if (args && typeof args !== "object") throw new _copilotkit_shared.CopilotKitMisuseError({ message: "Args must be an object when provided to copilotKitInterrupt" });
+	let interruptValues = null;
+	let interruptMessage = null;
+	let answer = null;
+	try {
+		if (message) {
+			interruptValues = message;
+			interruptMessage = new _langchain_core_messages.AIMessage({
+				content: message,
+				id: (0, _copilotkit_shared.randomId)()
+			});
+		} else {
+			interruptMessage = new _langchain_core_messages.AIMessage({
+				content: "",
+				tool_calls: [{
+					id: (0, _copilotkit_shared.randomId)(),
+					name: action,
+					args: args ?? {}
+				}]
+			});
+			interruptValues = {
+				action,
+				args: args ?? {}
+			};
+		}
+		const response = (0, _langchain_langgraph.interrupt)({
+			__copilotkit_interrupt_value__: interruptValues,
+			__copilotkit_messages__: [interruptMessage]
+		});
+		answer = response[response.length - 1].content;
+		return {
+			answer,
+			messages: response
+		};
+	} catch (error) {
+		throw new _copilotkit_shared.CopilotKitMisuseError({ message: `Failed to create interrupt: ${error instanceof Error ? error.message : String(error)}` });
+	}
+}
+
+//#endregion
+exports.convertActionToDynamicStructuredTool = convertActionToDynamicStructuredTool;
+exports.convertActionsToDynamicStructuredTools = convertActionsToDynamicStructuredTools;
+exports.copilotKitInterrupt = copilotKitInterrupt;
+exports.copilotkitCustomizeConfig = copilotkitCustomizeConfig;
+exports.copilotkitEmitMessage = copilotkitEmitMessage;
+exports.copilotkitEmitState = copilotkitEmitState;
+exports.copilotkitEmitToolCall = copilotkitEmitToolCall;
+exports.copilotkitExit = copilotkitExit;
+//# sourceMappingURL=utils.cjs.map

package/dist/langgraph/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","names":["CopilotKitMisuseError","DynamicStructuredTool","AIMessage"],"sources":["../../src/langgraph/utils.ts"],"sourcesContent":["import { RunnableConfig } from \"@langchain/core/runnables\";\nimport { dispatchCustomEvent } from \"@langchain/core/callbacks/dispatch\";\nimport {\n  convertJsonSchemaToZodSchema,\n  randomId,\n  CopilotKitMisuseError,\n} from \"@copilotkit/shared\";\nimport { interrupt } from \"@langchain/langgraph\";\nimport { DynamicStructuredTool } from \"@langchain/core/tools\";\nimport { AIMessage } from \"@langchain/core/messages\";\nimport { OptionsConfig } from \"./types\";\n\n/**\n * Customize the LangGraph configuration for use in CopilotKit.\n *\n * To the CopilotKit SDK, run:\n *\n * ```bash\n * npm install @copilotkit/sdk-js\n * ```\n *\n * ### Examples\n *\n * Disable emitting messages and tool calls:\n *\n * ```typescript\n * import { copilotkitCustomizeConfig } from \"@copilotkit/sdk-js\";\n *\n * config = copilotkitCustomizeConfig(\n *   config,\n *   emitMessages=false,\n *   emitToolCalls=false\n * )\n * ```\n *\n * To emit a tool call as streaming LangGraph state, pass the destination key in state,\n * the tool name and optionally the tool argument. (If you don't pass the argument name,\n * all arguments are emitted under the state key.)\n *\n * ```typescript\n * import { copilotkitCustomizeConfig } from \"@copilotkit/sdk-js\";\n *\n * config = copilotkitCustomizeConfig(\n *   config,\n *   emitIntermediateState=[\n *     {\n *       \"stateKey\": \"steps\",\n *       \"tool\": \"SearchTool\",\n *       \"toolArgument\": \"steps\",\n *     },\n *   ],\n * )\n * ```\n */\nexport function copilotkitCustomizeConfig(\n  /**\n   * The LangChain/LangGraph configuration to customize.\n   */\n  baseConfig: RunnableConfig,\n  /**\n   * Configuration options:\n   * - `emitMessages: boolean?`\n   *   Configure how messages are emitted. By default, all messages are emitted. Pass false to\n   *   disable emitting messages.\n   * - `emitToolCalls: boolean | string | string[]?`\n   *   Configure how tool calls are emitted. By default, all tool calls are emitted. Pass false to\n   *   disable emitting tool calls. Pass a string or list of strings to emit only specific tool calls.\n   * - `emitIntermediateState: IntermediateStateConfig[]?`\n   *   Lets you emit tool calls as streaming LangGraph state.\n   */\n  options?: OptionsConfig,\n): RunnableConfig {\n  if (baseConfig && typeof baseConfig !== \"object\") {\n    throw new CopilotKitMisuseError({\n      message: \"baseConfig must be an object or null/undefined\",\n    });\n  }\n\n  if (options && typeof options !== \"object\") {\n    throw new CopilotKitMisuseError({\n      message: \"options must be an object when provided\",\n    });\n  }\n\n  // Validate emitIntermediateState structure\n  if (options?.emitIntermediateState) {\n    if (!Array.isArray(options.emitIntermediateState)) {\n      throw new CopilotKitMisuseError({\n        message: \"emitIntermediateState must be an array when provided\",\n      });\n    }\n\n    options.emitIntermediateState.forEach((state, index) => {\n      if (!state || typeof state !== \"object\") {\n        throw new CopilotKitMisuseError({\n          message: `emitIntermediateState[${index}] must be an object`,\n        });\n      }\n\n      if (!state.stateKey || typeof state.stateKey !== \"string\") {\n        throw new CopilotKitMisuseError({\n          message: `emitIntermediateState[${index}] must have a valid 'stateKey' string property`,\n        });\n      }\n\n      if (!state.tool || typeof state.tool !== \"string\") {\n        throw new CopilotKitMisuseError({\n          message: `emitIntermediateState[${index}] must have a valid 'tool' string property`,\n        });\n      }\n\n      if (state.toolArgument && typeof state.toolArgument !== \"string\") {\n        throw new CopilotKitMisuseError({\n          message: `emitIntermediateState[${index}].toolArgument must be a string when provided`,\n        });\n      }\n    });\n  }\n\n  try {\n    const metadata = baseConfig?.metadata || {};\n\n    if (options?.emitAll) {\n      metadata[\"copilotkit:emit-tool-calls\"] = true;\n      metadata[\"copilotkit:emit-messages\"] = true;\n    } else {\n      if (options?.emitToolCalls !== undefined) {\n        metadata[\"copilotkit:emit-tool-calls\"] = options.emitToolCalls;\n      }\n      if (options?.emitMessages !== undefined) {\n        metadata[\"copilotkit:emit-messages\"] = options.emitMessages;\n      }\n    }\n\n    if (options?.emitIntermediateState) {\n      const snakeCaseIntermediateState = options.emitIntermediateState.map(\n        (state) => ({\n          tool: state.tool,\n          tool_argument: state.toolArgument,\n          state_key: state.stateKey,\n        }),\n      );\n\n      metadata[\"copilotkit:emit-intermediate-state\"] =\n        snakeCaseIntermediateState;\n    }\n\n    baseConfig = baseConfig || {};\n\n    return {\n      ...baseConfig,\n      metadata: metadata,\n    };\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to customize config: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n/**\n * Exits the current agent after the run completes. Calling copilotkit_exit() will\n * not immediately stop the agent. Instead, it signals to CopilotKit to stop the agent after\n * the run completes.\n *\n * ### Examples\n *\n * ```typescript\n * import { copilotkitExit } from \"@copilotkit/sdk-js\";\n *\n * async function myNode(state: Any):\n *   await copilotkitExit(config)\n *   return state\n * ```\n */\nexport async function copilotkitExit(\n  /**\n   * The LangChain/LangGraph configuration.\n   */\n  config: RunnableConfig,\n) {\n  if (!config) {\n    throw new CopilotKitMisuseError({\n      message: \"LangGraph configuration is required for copilotkitExit\",\n    });\n  }\n\n  try {\n    await dispatchCustomEvent(\"copilotkit_exit\", {}, config);\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to dispatch exit event: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n/**\n * Emits intermediate state to CopilotKit. Useful if you have a longer running node and you want to\n * update the user with the current state of the node.\n *\n * ### Examples\n *\n * ```typescript\n * import { copilotkitEmitState } from \"@copilotkit/sdk-js\";\n *\n * for (let i = 0; i < 10; i++) {\n *   await someLongRunningOperation(i);\n *   await copilotkitEmitState(config, { progress: i });\n * }\n * ```\n */\nexport async function copilotkitEmitState(\n  /**\n   * The LangChain/LangGraph configuration.\n   */\n  config: RunnableConfig,\n  /**\n   * The state to emit.\n   */\n  state: any,\n) {\n  if (!config) {\n    throw new CopilotKitMisuseError({\n      message: \"LangGraph configuration is required for copilotkitEmitState\",\n    });\n  }\n\n  if (state === undefined) {\n    throw new CopilotKitMisuseError({\n      message: \"State is required for copilotkitEmitState\",\n    });\n  }\n\n  try {\n    await dispatchCustomEvent(\n      \"copilotkit_manually_emit_intermediate_state\",\n      state,\n      config,\n    );\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to emit state: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n/**\n * Manually emits a message to CopilotKit. Useful in longer running nodes to update the user.\n * Important: You still need to return the messages from the node.\n *\n * ### Examples\n *\n * ```typescript\n * import { copilotkitEmitMessage } from \"@copilotkit/sdk-js\";\n *\n * const message = \"Step 1 of 10 complete\";\n * await copilotkitEmitMessage(config, message);\n *\n * // Return the message from the node\n * return {\n *   \"messages\": [AIMessage(content=message)]\n * }\n * ```\n */\nexport async function copilotkitEmitMessage(\n  /**\n   * The LangChain/LangGraph configuration.\n   */\n  config: RunnableConfig,\n  /**\n   * The message to emit.\n   */\n  message: string,\n) {\n  if (!config) {\n    throw new CopilotKitMisuseError({\n      message: \"LangGraph configuration is required for copilotkitEmitMessage\",\n    });\n  }\n\n  if (!message || typeof message !== \"string\") {\n    throw new CopilotKitMisuseError({\n      message: \"Message must be a non-empty string for copilotkitEmitMessage\",\n    });\n  }\n\n  try {\n    await dispatchCustomEvent(\n      \"copilotkit_manually_emit_message\",\n      { message, message_id: randomId(), role: \"assistant\" },\n      config,\n    );\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to emit message: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n/**\n * Manually emits a tool call to CopilotKit.\n *\n * ### Examples\n *\n * ```typescript\n * import { copilotkitEmitToolCall } from \"@copilotkit/sdk-js\";\n *\n * await copilotkitEmitToolCall(config, name=\"SearchTool\", args={\"steps\": 10})\n * ```\n */\nexport async function copilotkitEmitToolCall(\n  /**\n   * The LangChain/LangGraph configuration.\n   */\n  config: RunnableConfig,\n  /**\n   * The name of the tool to emit.\n   */\n  name: string,\n  /**\n   * The arguments to emit.\n   */\n  args: any,\n) {\n  if (!config) {\n    throw new CopilotKitMisuseError({\n      message: \"LangGraph configuration is required for copilotkitEmitToolCall\",\n    });\n  }\n\n  if (!name || typeof name !== \"string\") {\n    throw new CopilotKitMisuseError({\n      message:\n        \"Tool name must be a non-empty string for copilotkitEmitToolCall\",\n    });\n  }\n\n  if (args === undefined) {\n    throw new CopilotKitMisuseError({\n      message: \"Tool arguments are required for copilotkitEmitToolCall\",\n    });\n  }\n\n  try {\n    await dispatchCustomEvent(\n      \"copilotkit_manually_emit_tool_call\",\n      { name, args, id: randomId() },\n      config,\n    );\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to emit tool call '${name}': ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n\nexport function convertActionToDynamicStructuredTool(\n  actionInput: any,\n): DynamicStructuredTool<any> {\n  if (!actionInput) {\n    throw new CopilotKitMisuseError({\n      message: \"Action input is required but was not provided\",\n    });\n  }\n\n  if (!actionInput.name || typeof actionInput.name !== \"string\") {\n    throw new CopilotKitMisuseError({\n      message: \"Action must have a valid 'name' property of type string\",\n    });\n  }\n\n  if (\n    actionInput.description == undefined ||\n    actionInput.description == null ||\n    typeof actionInput.description !== \"string\"\n  ) {\n    throw new CopilotKitMisuseError({\n      message: `Action '${actionInput.name}' must have a valid 'description' property of type string`,\n    });\n  }\n\n  if (!actionInput.parameters) {\n    throw new CopilotKitMisuseError({\n      message: `Action '${actionInput.name}' must have a 'parameters' property`,\n    });\n  }\n\n  try {\n    return new DynamicStructuredTool({\n      name: actionInput.name,\n      description: actionInput.description,\n      schema: convertJsonSchemaToZodSchema(actionInput.parameters, true),\n      func: async () => {\n        return \"\";\n      },\n    });\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to convert action '${actionInput.name}' to DynamicStructuredTool: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n/**\n * Use this function to convert a list of actions you get from state\n * to a list of dynamic structured tools.\n *\n * ### Examples\n *\n * ```typescript\n * import { convertActionsToDynamicStructuredTools } from \"@copilotkit/sdk-js\";\n *\n * const tools = convertActionsToDynamicStructuredTools(state.copilotkit.actions);\n * ```\n */\nexport function convertActionsToDynamicStructuredTools(\n  /**\n   * The list of actions to convert.\n   */\n  actions: any[],\n): DynamicStructuredTool<any>[] {\n  if (!Array.isArray(actions)) {\n    throw new CopilotKitMisuseError({\n      message: \"Actions must be an array\",\n    });\n  }\n\n  return actions.map((action, index) => {\n    try {\n      return convertActionToDynamicStructuredTool(\n        action.type === \"function\" ? action.function : action,\n      );\n    } catch (error) {\n      throw new CopilotKitMisuseError({\n        message: `Failed to convert action at index ${index}: ${error instanceof Error ? error.message : String(error)}`,\n      });\n    }\n  });\n}\n\nexport function copilotKitInterrupt({\n  message,\n  action,\n  args,\n}: {\n  message?: string;\n  action?: string;\n  args?: Record<string, any>;\n}) {\n  if (!message && !action) {\n    throw new CopilotKitMisuseError({\n      message:\n        \"Either message or action (and optional arguments) must be provided for copilotKitInterrupt\",\n    });\n  }\n\n  if (action && typeof action !== \"string\") {\n    throw new CopilotKitMisuseError({\n      message: \"Action must be a string when provided to copilotKitInterrupt\",\n    });\n  }\n\n  if (message && typeof message !== \"string\") {\n    throw new CopilotKitMisuseError({\n      message: \"Message must be a string when provided to copilotKitInterrupt\",\n    });\n  }\n\n  if (args && typeof args !== \"object\") {\n    throw new CopilotKitMisuseError({\n      message: \"Args must be an object when provided to copilotKitInterrupt\",\n    });\n  }\n\n  let interruptValues = null;\n  let interruptMessage = null;\n  let answer = null;\n\n  try {\n    if (message) {\n      interruptValues = message;\n      interruptMessage = new AIMessage({ content: message, id: randomId() });\n    } else {\n      const toolId = randomId();\n      interruptMessage = new AIMessage({\n        content: \"\",\n        tool_calls: [{ id: toolId, name: action, args: args ?? {} }],\n      });\n      interruptValues = {\n        action,\n        args: args ?? {},\n      };\n    }\n\n    const response = interrupt({\n      __copilotkit_interrupt_value__: interruptValues,\n      __copilotkit_messages__: [interruptMessage],\n    });\n    answer = response[response.length - 1].content;\n\n    return {\n      answer,\n      messages: response,\n    };\n  } catch (error) {\n    throw new CopilotKitMisuseError({\n      message: `Failed to create interrupt: ${error instanceof Error ? error.message : String(error)}`,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDA,SAAgB,0BAId,YAYA,SACgB;AAChB,KAAI,cAAc,OAAO,eAAe,SACtC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,kDACV,CAAC;AAGJ,KAAI,WAAW,OAAO,YAAY,SAChC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,2CACV,CAAC;AAIJ,KAAI,SAAS,uBAAuB;AAClC,MAAI,CAAC,MAAM,QAAQ,QAAQ,sBAAsB,CAC/C,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,wDACV,CAAC;AAGJ,UAAQ,sBAAsB,SAAS,OAAO,UAAU;AACtD,OAAI,CAAC,SAAS,OAAO,UAAU,SAC7B,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,yBAAyB,MAAM,sBACzC,CAAC;AAGJ,OAAI,CAAC,MAAM,YAAY,OAAO,MAAM,aAAa,SAC/C,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,yBAAyB,MAAM,iDACzC,CAAC;AAGJ,OAAI,CAAC,MAAM,QAAQ,OAAO,MAAM,SAAS,SACvC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,yBAAyB,MAAM,6CACzC,CAAC;AAGJ,OAAI,MAAM,gBAAgB,OAAO,MAAM,iBAAiB,SACtD,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,yBAAyB,MAAM,gDACzC,CAAC;IAEJ;;AAGJ,KAAI;EACF,MAAM,WAAW,YAAY,YAAY,EAAE;AAE3C,MAAI,SAAS,SAAS;AACpB,YAAS,gCAAgC;AACzC,YAAS,8BAA8B;SAClC;AACL,OAAI,SAAS,kBAAkB,OAC7B,UAAS,gCAAgC,QAAQ;AAEnD,OAAI,SAAS,iBAAiB,OAC5B,UAAS,8BAA8B,QAAQ;;AAInD,MAAI,SAAS,sBASX,UAAS,wCAR0B,QAAQ,sBAAsB,KAC9D,WAAW;GACV,MAAM,MAAM;GACZ,eAAe,MAAM;GACrB,WAAW,MAAM;GAClB,EACF;AAMH,eAAa,cAAc,EAAE;AAE7B,SAAO;GACL,GAAG;GACO;GACX;UACM,OAAO;AACd,QAAM,IAAIA,yCAAsB,EAC9B,SAAS,+BAA+B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAC/F,CAAC;;;;;;;;;;;;;;;;;;AAkBN,eAAsB,eAIpB,QACA;AACA,KAAI,CAAC,OACH,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,0DACV,CAAC;AAGJ,KAAI;AACF,oEAA0B,mBAAmB,EAAE,EAAE,OAAO;UACjD,OAAO;AACd,QAAM,IAAIA,yCAAsB,EAC9B,SAAS,kCAAkC,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAClG,CAAC;;;;;;;;;;;;;;;;;;AAkBN,eAAsB,oBAIpB,QAIA,OACA;AACA,KAAI,CAAC,OACH,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,+DACV,CAAC;AAGJ,KAAI,UAAU,OACZ,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,6CACV,CAAC;AAGJ,KAAI;AACF,oEACE,+CACA,OACA,OACD;UACM,OAAO;AACd,QAAM,IAAIA,yCAAsB,EAC9B,SAAS,yBAAyB,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACzF,CAAC;;;;;;;;;;;;;;;;;;;;;AAqBN,eAAsB,sBAIpB,QAIA,SACA;AACA,KAAI,CAAC,OACH,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,iEACV,CAAC;AAGJ,KAAI,CAAC,WAAW,OAAO,YAAY,SACjC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,gEACV,CAAC;AAGJ,KAAI;AACF,oEACE,oCACA;GAAE;GAAS,8CAAsB;GAAE,MAAM;GAAa,EACtD,OACD;UACM,OAAO;AACd,QAAM,IAAIA,yCAAsB,EAC9B,SAAS,2BAA2B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAC3F,CAAC;;;;;;;;;;;;;;AAcN,eAAsB,uBAIpB,QAIA,MAIA,MACA;AACA,KAAI,CAAC,OACH,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,kEACV,CAAC;AAGJ,KAAI,CAAC,QAAQ,OAAO,SAAS,SAC3B,OAAM,IAAIA,yCAAsB,EAC9B,SACE,mEACH,CAAC;AAGJ,KAAI,SAAS,OACX,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,0DACV,CAAC;AAGJ,KAAI;AACF,oEACE,sCACA;GAAE;GAAM;GAAM,sCAAc;GAAE,EAC9B,OACD;UACM,OAAO;AACd,QAAM,IAAIA,yCAAsB,EAC9B,SAAS,6BAA6B,KAAK,KAAK,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACvG,CAAC;;;AAIN,SAAgB,qCACd,aAC4B;AAC5B,KAAI,CAAC,YACH,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,iDACV,CAAC;AAGJ,KAAI,CAAC,YAAY,QAAQ,OAAO,YAAY,SAAS,SACnD,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,2DACV,CAAC;AAGJ,KACE,YAAY,eAAe,UAC3B,YAAY,eAAe,QAC3B,OAAO,YAAY,gBAAgB,SAEnC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,WAAW,YAAY,KAAK,4DACtC,CAAC;AAGJ,KAAI,CAAC,YAAY,WACf,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,WAAW,YAAY,KAAK,sCACtC,CAAC;AAGJ,KAAI;AACF,SAAO,IAAIC,4CAAsB;GAC/B,MAAM,YAAY;GAClB,aAAa,YAAY;GACzB,6DAAqC,YAAY,YAAY,KAAK;GAClE,MAAM,YAAY;AAChB,WAAO;;GAEV,CAAC;UACK,OAAO;AACd,QAAM,IAAID,yCAAsB,EAC9B,SAAS,6BAA6B,YAAY,KAAK,8BAA8B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAC5I,CAAC;;;;;;;;;;;;;;;AAeN,SAAgB,uCAId,SAC8B;AAC9B,KAAI,CAAC,MAAM,QAAQ,QAAQ,CACzB,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,4BACV,CAAC;AAGJ,QAAO,QAAQ,KAAK,QAAQ,UAAU;AACpC,MAAI;AACF,UAAO,qCACL,OAAO,SAAS,aAAa,OAAO,WAAW,OAChD;WACM,OAAO;AACd,SAAM,IAAIA,yCAAsB,EAC9B,SAAS,qCAAqC,MAAM,IAAI,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAC/G,CAAC;;GAEJ;;AAGJ,SAAgB,oBAAoB,EAClC,SACA,QACA,QAKC;AACD,KAAI,CAAC,WAAW,CAAC,OACf,OAAM,IAAIA,yCAAsB,EAC9B,SACE,8FACH,CAAC;AAGJ,KAAI,UAAU,OAAO,WAAW,SAC9B,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,gEACV,CAAC;AAGJ,KAAI,WAAW,OAAO,YAAY,SAChC,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,iEACV,CAAC;AAGJ,KAAI,QAAQ,OAAO,SAAS,SAC1B,OAAM,IAAIA,yCAAsB,EAC9B,SAAS,+DACV,CAAC;CAGJ,IAAI,kBAAkB;CACtB,IAAI,mBAAmB;CACvB,IAAI,SAAS;AAEb,KAAI;AACF,MAAI,SAAS;AACX,qBAAkB;AAClB,sBAAmB,IAAIE,mCAAU;IAAE,SAAS;IAAS,sCAAc;IAAE,CAAC;SACjE;AAEL,sBAAmB,IAAIA,mCAAU;IAC/B,SAAS;IACT,YAAY,CAAC;KAAE,sCAHQ;KAGI,MAAM;KAAQ,MAAM,QAAQ,EAAE;KAAE,CAAC;IAC7D,CAAC;AACF,qBAAkB;IAChB;IACA,MAAM,QAAQ,EAAE;IACjB;;EAGH,MAAM,+CAAqB;GACzB,gCAAgC;GAChC,yBAAyB,CAAC,iBAAiB;GAC5C,CAAC;AACF,WAAS,SAAS,SAAS,SAAS,GAAG;AAEvC,SAAO;GACL;GACA,UAAU;GACX;UACM,OAAO;AACd,QAAM,IAAIF,yCAAsB,EAC9B,SAAS,+BAA+B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IAC/F,CAAC"}

package/dist/langgraph/utils.d.cts

@@ -0,0 +1,192 @@
+import { OptionsConfig } from "./types.cjs";
+import { RunnableConfig } from "@langchain/core/runnables";
+import { DynamicStructuredTool } from "@langchain/core/tools";
+
+//#region src/langgraph/utils.d.ts
+/**
+ * Customize the LangGraph configuration for use in CopilotKit.
+ *
+ * To the CopilotKit SDK, run:
+ *
+ * ```bash
+ * npm install @copilotkit/sdk-js
+ * ```
+ *
+ * ### Examples
+ *
+ * Disable emitting messages and tool calls:
+ *
+ * ```typescript
+ * import { copilotkitCustomizeConfig } from "@copilotkit/sdk-js";
+ *
+ * config = copilotkitCustomizeConfig(
+ *   config,
+ *   emitMessages=false,
+ *   emitToolCalls=false
+ * )
+ * ```
+ *
+ * To emit a tool call as streaming LangGraph state, pass the destination key in state,
+ * the tool name and optionally the tool argument. (If you don't pass the argument name,
+ * all arguments are emitted under the state key.)
+ *
+ * ```typescript
+ * import { copilotkitCustomizeConfig } from "@copilotkit/sdk-js";
+ *
+ * config = copilotkitCustomizeConfig(
+ *   config,
+ *   emitIntermediateState=[
+ *     {
+ *       "stateKey": "steps",
+ *       "tool": "SearchTool",
+ *       "toolArgument": "steps",
+ *     },
+ *   ],
+ * )
+ * ```
+ */
+declare function copilotkitCustomizeConfig(
+/**
+ * The LangChain/LangGraph configuration to customize.
+ */
+baseConfig: RunnableConfig,
+/**
+ * Configuration options:
+ * - `emitMessages: boolean?`
+ *   Configure how messages are emitted. By default, all messages are emitted. Pass false to
+ *   disable emitting messages.
+ * - `emitToolCalls: boolean | string | string[]?`
+ *   Configure how tool calls are emitted. By default, all tool calls are emitted. Pass false to
+ *   disable emitting tool calls. Pass a string or list of strings to emit only specific tool calls.
+ * - `emitIntermediateState: IntermediateStateConfig[]?`
+ *   Lets you emit tool calls as streaming LangGraph state.
+ */
+options?: OptionsConfig): RunnableConfig;
+/**
+ * Exits the current agent after the run completes. Calling copilotkit_exit() will
+ * not immediately stop the agent. Instead, it signals to CopilotKit to stop the agent after
+ * the run completes.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { copilotkitExit } from "@copilotkit/sdk-js";
+ *
+ * async function myNode(state: Any):
+ *   await copilotkitExit(config)
+ *   return state
+ * ```
+ */
+declare function copilotkitExit(
+/**
+ * The LangChain/LangGraph configuration.
+ */
+config: RunnableConfig): Promise<void>;
+/**
+ * Emits intermediate state to CopilotKit. Useful if you have a longer running node and you want to
+ * update the user with the current state of the node.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { copilotkitEmitState } from "@copilotkit/sdk-js";
+ *
+ * for (let i = 0; i < 10; i++) {
+ *   await someLongRunningOperation(i);
+ *   await copilotkitEmitState(config, { progress: i });
+ * }
+ * ```
+ */
+declare function copilotkitEmitState(
+/**
+ * The LangChain/LangGraph configuration.
+ */
+config: RunnableConfig,
+/**
+ * The state to emit.
+ */
+state: any): Promise<void>;
+/**
+ * Manually emits a message to CopilotKit. Useful in longer running nodes to update the user.
+ * Important: You still need to return the messages from the node.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { copilotkitEmitMessage } from "@copilotkit/sdk-js";
+ *
+ * const message = "Step 1 of 10 complete";
+ * await copilotkitEmitMessage(config, message);
+ *
+ * // Return the message from the node
+ * return {
+ *   "messages": [AIMessage(content=message)]
+ * }
+ * ```
+ */
+declare function copilotkitEmitMessage(
+/**
+ * The LangChain/LangGraph configuration.
+ */
+config: RunnableConfig,
+/**
+ * The message to emit.
+ */
+message: string): Promise<void>;
+/**
+ * Manually emits a tool call to CopilotKit.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { copilotkitEmitToolCall } from "@copilotkit/sdk-js";
+ *
+ * await copilotkitEmitToolCall(config, name="SearchTool", args={"steps": 10})
+ * ```
+ */
+declare function copilotkitEmitToolCall(
+/**
+ * The LangChain/LangGraph configuration.
+ */
+config: RunnableConfig,
+/**
+ * The name of the tool to emit.
+ */
+name: string,
+/**
+ * The arguments to emit.
+ */
+args: any): Promise<void>;
+declare function convertActionToDynamicStructuredTool(actionInput: any): DynamicStructuredTool<any>;
+/**
+ * Use this function to convert a list of actions you get from state
+ * to a list of dynamic structured tools.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { convertActionsToDynamicStructuredTools } from "@copilotkit/sdk-js";
+ *
+ * const tools = convertActionsToDynamicStructuredTools(state.copilotkit.actions);
+ * ```
+ */
+declare function convertActionsToDynamicStructuredTools(
+/**
+ * The list of actions to convert.
+ */
+actions: any[]): DynamicStructuredTool<any>[];
+declare function copilotKitInterrupt({
+  message,
+  action,
+  args
+}: {
+  message?: string;
+  action?: string;
+  args?: Record<string, any>;
+}): {
+  answer: any;
+  messages: any;
+};
+//#endregion
+export { convertActionToDynamicStructuredTool, convertActionsToDynamicStructuredTools, copilotKitInterrupt, copilotkitCustomizeConfig, copilotkitEmitMessage, copilotkitEmitState, copilotkitEmitToolCall, copilotkitExit };
+//# sourceMappingURL=utils.d.cts.map

package/dist/langgraph/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","names":[],"sources":["../../src/langgraph/utils.ts"],"mappings":";;;;;;;AAsDA;;;;;;;;;;;;;;;AAwHA;;;;;;;;;AAmCA;;;;;;;;;;AAoDA;;;;;;iBA/MgB,yBAAA;;;;AAId,UAAA,EAAY,cAAA;;;;;;;;;;;AAsSd;AA1RE,OAAA,GAAU,aAAA,GACT,cAAA;;;;AAmVH;;;;;AAyBA;;;;;;;iBArQsB,cAAA;;;;AAIpB,MAAA,EAAQ,cAAA,GAAc,OAAA;;;;;;;;;;;;;;;;iBA+BF,mBAAA;;;;AAIpB,MAAA,EAAQ,cAAA;;;;AAIR,KAAA,QAAU,OAAA;;;;;;;;;;;;;;;;;;;iBA4CU,qBAAA;;;;AAIpB,MAAA,EAAQ,cAAA;;;;AAIR,OAAA,WAAe,OAAA;;;;;;;;;;;;iBAqCK,sBAAA;;;;AAIpB,MAAA,EAAQ,cAAA;;;;AAIR,IAAA;;;;AAIA,IAAA,QAAS,OAAA;AAAA,iBAkCK,oCAAA,CACd,WAAA,QACC,qBAAA;;;;;;;;;;;;;iBAwDa,sCAAA;;;;AAId,OAAA,UACC,qBAAA;AAAA,iBAoBa,mBAAA,CAAA;EACd,OAAA;EACA,MAAA;EACA;AAAA;EAEA,OAAA;EACA,MAAA;EACA,IAAA,GAAO,MAAA;AAAA"}