@copilotkit/sdk-js 0.0.0-mme-load-agent-state-20250117154700

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@copilotkit/sdk-js",
+  "private": false,
+  "homepage": "https://github.com/CopilotKit/CopilotKit",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CopilotKit/CopilotKit.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.0.0-mme-load-agent-state-20250117154700",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./langchain": {
+      "require": "./dist/langchain.js",
+      "import": "./dist/langchain.mjs"
+    },
+    "./langgraph": {
+      "require": "./dist/langgraph.js",
+      "import": "./dist/langgraph.mjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "langchain": [
+        "dist/langchain.d.ts"
+      ],
+      "langgraph": [
+        "dist/langgraph.d.ts"
+      ],
+      "*": [
+        "dist/*"
+      ]
+    }
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@swc/core": "1.5.28",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.4",
+    "@types/node": "^18.11.17",
+    "@whatwg-node/server": "^0.9.34",
+    "eslint": "^8.56.0",
+    "jest": "^29.6.4",
+    "nodemon": "^3.1.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "tsup": "^6.7.0",
+    "typescript": "^5.2.3",
+    "zod-to-json-schema": "^3.23.5",
+    "tsconfig": "1.4.6",
+    "eslint-config-custom": "1.4.6"
+  },
+  "dependencies": {
+    "@langchain/community": "^0.0.53",
+    "@langchain/core": "^0.3.13",
+    "@langchain/langgraph": "^0.2.22",
+    "@langchain/langgraph-sdk": "^0.0.16",
+    "langchain": "^0.3.3",
+    "zod": "^3.23.3",
+    "@copilotkit/shared": "0.0.0-mme-load-agent-state-20250117154700"
+  },
+  "keywords": [
+    "copilotkit",
+    "copilot",
+    "react",
+    "nextjs",
+    "nodejs",
+    "ai",
+    "assistant",
+    "javascript",
+    "automation",
+    "textarea"
+  ],
+  "scripts": {
+    "build": "tsup --clean",
+    "dev": "tsup --watch --no-splitting",
+    "test": "jest --passWithNoTests",
+    "check-types": "tsc --noEmit",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist && rm -rf .next",
+    "link:global": "pnpm link --global",
+    "unlink:global": "pnpm unlink --global"
+  }
+}

package/src/langchain.ts

@@ -0,0 +1,17 @@
+console.warn(
+  "Warning: '@copilotkit/sdk-js/langchain' is deprecated and will be removed in a future release. Please use '@copilotkit/sdk-js/langgraph' instead.",
+);
+
+export {
+  CopilotKitPropertiesAnnotation,
+  CopilotKitStateAnnotation,
+  type CopilotKitState,
+  type CopilotKitProperties,
+  copilotkitCustomizeConfig as copilotKitCustomizeConfig,
+  copilotkitExit as copilotKitExit,
+  copilotkitEmitState as copilotKitEmitState,
+  copilotkitEmitMessage as copilotKitEmitMessage,
+  copilotkitEmitToolCall as copilotKitEmitToolCall,
+  convertActionToDynamicStructuredTool,
+  convertActionsToDynamicStructuredTools,
+} from "./langgraph";

package/src/langgraph.ts

@@ -0,0 +1,268 @@
+import { RunnableConfig } from "@langchain/core/runnables";
+import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
+import { convertJsonSchemaToZodSchema, randomId } from "@copilotkit/shared";
+import { Annotation, MessagesAnnotation } from "@langchain/langgraph";
+import { DynamicStructuredTool } from "@langchain/core/tools";
+
+interface IntermediateStateConfig {
+  stateKey: string;
+  tool: string;
+  toolArgument?: string;
+}
+
+interface OptionsConfig {
+  emitToolCalls?: boolean | string | string[];
+  emitMessages?: boolean;
+  emitAll?: boolean;
+  emitIntermediateState?: IntermediateStateConfig[];
+}
+
+export const CopilotKitPropertiesAnnotation = Annotation.Root({
+  actions: Annotation<any[]>,
+});
+
+export const CopilotKitStateAnnotation = Annotation.Root({
+  copilotkit: Annotation<typeof CopilotKitPropertiesAnnotation.State>,
+  ...MessagesAnnotation.spec,
+});
+
+export type CopilotKitState = typeof CopilotKitStateAnnotation.State;
+export type CopilotKitProperties = typeof CopilotKitPropertiesAnnotation.State;
+
+/**
+ * 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",
+ *     },
+ *   ],
+ * )
+ * ```
+ */
+export 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 {
+  const metadata = baseConfig?.metadata || {};
+
+  if (options?.emitAll) {
+    metadata["copilotkit:emit-tool-calls"] = true;
+    metadata["copilotkit:emit-messages"] = true;
+  } else {
+    if (options?.emitToolCalls !== undefined) {
+      metadata["copilotkit:emit-tool-calls"] = options.emitToolCalls;
+    }
+    if (options?.emitMessages !== undefined) {
+      metadata["copilotkit:emit-messages"] = options.emitMessages;
+    }
+  }
+
+  if (options?.emitIntermediateState) {
+    const snakeCaseIntermediateState = options.emitIntermediateState.map((state) => ({
+      tool: state.tool,
+      tool_argument: state.toolArgument,
+      state_key: state.stateKey,
+    }));
+
+    metadata["copilotkit:emit-intermediate-state"] = snakeCaseIntermediateState;
+  }
+
+  baseConfig = baseConfig || {};
+
+  return {
+    ...baseConfig,
+    metadata: metadata,
+  };
+}
+/**
+ * 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
+ * ```
+ */
+export async function copilotkitExit(
+  /**
+   * The LangChain/LangGraph configuration.
+   */
+  config: RunnableConfig,
+) {
+  await dispatchCustomEvent("copilotkit_exit", {}, config);
+}
+/**
+ * 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 });
+ * }
+ * ```
+ */
+export async function copilotkitEmitState(
+  /**
+   * The LangChain/LangGraph configuration.
+   */
+  config: RunnableConfig,
+  /**
+   * The state to emit.
+   */
+  state: any,
+) {
+  await dispatchCustomEvent("copilotkit_manually_emit_intermediate_state", state, config);
+}
+/**
+ * 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)]
+ * }
+ * ```
+ */
+export async function copilotkitEmitMessage(
+  /**
+   * The LangChain/LangGraph configuration.
+   */
+  config: RunnableConfig,
+  /**
+   * The message to emit.
+   */
+  message: string,
+) {
+  await dispatchCustomEvent(
+    "copilotkit_manually_emit_message",
+    { message, message_id: randomId(), role: "assistant" },
+    config,
+  );
+}
+/**
+ * Manually emits a tool call to CopilotKit.
+ *
+ * ### Examples
+ *
+ * ```typescript
+ * import { copilotkitEmitToolCall } from "@copilotkit/sdk-js";
+ *
+ * await copilotkitEmitToolCall(config, name="SearchTool", args={"steps": 10})
+ * ```
+ */
+export async function copilotkitEmitToolCall(
+  /**
+   * The LangChain/LangGraph configuration.
+   */
+  config: RunnableConfig,
+  /**
+   * The name of the tool to emit.
+   */
+  name: string,
+  /**
+   * The arguments to emit.
+   */
+  args: any,
+) {
+  await dispatchCustomEvent(
+    "copilotkit_manually_emit_tool_call",
+    { name, args, id: randomId() },
+    config,
+  );
+}
+
+export function convertActionToDynamicStructuredTool(actionInput: any) {
+  return new DynamicStructuredTool({
+    name: actionInput.name,
+    description: actionInput.description,
+    schema: convertJsonSchemaToZodSchema(actionInput.parameters, true),
+    func: async () => {
+      return "";
+    },
+  });
+}
+/**
+ * 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);
+ * ```
+ */
+export function convertActionsToDynamicStructuredTools(
+  /**
+   * The list of actions to convert.
+   */
+  actions: any[],
+) {
+  return actions.map((action) => convertActionToDynamicStructuredTool(action));
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../utilities/tsconfig/base.json",
+  "compilerOptions": {
+    "lib": ["es2017", "dom"],
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "strict": false
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["dist", "build", "node_modules", "**/*.test.ts", "**/*.test.tsx", "**/__tests__/*"]
+}

package/tsup.config.ts

@@ -0,0 +1,23 @@
+import { defineConfig, Options } from "tsup";
+
+export default defineConfig((options: Options) => ({
+  ...options,
+  entry: {
+    index: "src/index.ts",
+    langchain: "src/langchain.ts",
+    langgraph: "src/langgraph.ts",
+  },
+  format: ["esm", "cjs"],
+  dts: {
+    entry: ["src/index.ts", "src/langchain.ts", "src/langgraph.ts"],
+  },
+  minify: false,
+  external: [],
+  sourcemap: true,
+  entryNames: "[name]",
+  exclude: [
+    "**/*.test.ts", // Exclude TypeScript test files
+    "**/*.test.tsx", // Exclude TypeScript React test files
+    "**/__tests__/*", // Exclude any files inside a __tests__ directory
+  ],
+}));

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}