@copilotkit/runtime 1.57.3 → 1.58.0-canary.thread-id-propagation

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from "./lib";
-export * from "./utils";
-export * from "./service-adapters";

package/src/langgraph.ts

@@ -1 +0,0 @@
-export * from "./lib/runtime/agent-integrations/langgraph";

package/src/lib/__tests__/telemetry-disclosure.test.ts

@@ -1,55 +0,0 @@
-import {
-  afterEach,
-  beforeEach,
-  describe,
-  expect,
-  it,
-  vi,
-  type MockInstance,
-} from "vitest";
-
-import {
-  _resetRuntimeTelemetryDisclosureForTesting,
-  logRuntimeTelemetryDisclosure,
-} from "../telemetry-disclosure";
-
-let consoleInfoSpy: MockInstance<typeof console.info>;
-const originalEnv = { ...process.env };
-
-beforeEach(() => {
-  _resetRuntimeTelemetryDisclosureForTesting();
-  consoleInfoSpy = vi.spyOn(console, "info").mockImplementation(() => {});
-  // Clear opt-out env vars so the disclosure can fire by default.
-  delete process.env.COPILOTKIT_TELEMETRY_DISABLED;
-  delete process.env.DO_NOT_TRACK;
-});
-
-afterEach(() => {
-  vi.restoreAllMocks();
-  process.env = { ...originalEnv };
-});
-
-describe("logRuntimeTelemetryDisclosure", () => {
-  it("logs once per process", () => {
-    logRuntimeTelemetryDisclosure();
-    logRuntimeTelemetryDisclosure();
-    logRuntimeTelemetryDisclosure();
-
-    expect(consoleInfoSpy).toHaveBeenCalledTimes(1);
-    const [message] = consoleInfoSpy.mock.calls[0]!;
-    expect(message).toMatch(/anonymous telemetry/i);
-    expect(message).toMatch(/COPILOTKIT_TELEMETRY_DISABLED/);
-  });
-
-  it("does not log when COPILOTKIT_TELEMETRY_DISABLED is set", () => {
-    process.env.COPILOTKIT_TELEMETRY_DISABLED = "true";
-    logRuntimeTelemetryDisclosure();
-    expect(consoleInfoSpy).not.toHaveBeenCalled();
-  });
-
-  it("does not log when DO_NOT_TRACK is set", () => {
-    process.env.DO_NOT_TRACK = "1";
-    logRuntimeTelemetryDisclosure();
-    expect(consoleInfoSpy).not.toHaveBeenCalled();
-  });
-});

package/src/lib/cloud/index.ts

@@ -1,4 +0,0 @@
-export interface CopilotCloudOptions {
-  baseUrl?: string;
-  publicApiKey?: string;
-}

package/src/lib/error-messages.ts

@@ -1,211 +0,0 @@
-/**
- * Error message configuration - Single source of truth for all error messages
- *
- * This centralized configuration system provides:
- *
- * 🎯 **Benefits:**
- * - Single source of truth for all error messages
- * - Easy content management without touching code
- * - Consistent error messaging across the application
- * - Ready for internationalization (i18n)
- * - Type-safe configuration with TypeScript
- * - Categorized errors for better handling
- *
- * 📝 **How to use:**
- * 1. Add new error patterns to `errorPatterns` object
- * 2. Use {context} placeholder for dynamic context injection
- * 3. Specify category, severity, and actionable flags
- * 4. Add fallback messages for error categories
- *
- * 🔧 **How to maintain:**
- * - Content teams can update messages here without touching logic
- * - Developers add new error patterns as needed
- * - Use categories to group similar errors
- * - Mark errors as actionable if users can fix them
- *
- * 🌍 **Future i18n support:**
- * - Replace `message` string with `messages: { en: "...", es: "..." }`
- * - Add locale parameter to helper functions
- *
- * @example
- * ```typescript
- * // Adding a new error pattern:
- * "CUSTOM_ERROR": {
- *   message: "Custom error occurred in {context}. Please try again.",
- *   category: "unknown",
- *   severity: "error",
- *   actionable: true
- * }
- * ```
- */
-
-export interface ErrorPatternConfig {
-  message: string;
-  category:
-    | "network"
-    | "connection"
-    | "authentication"
-    | "validation"
-    | "unknown";
-  severity: "error" | "warning" | "info";
-  actionable: boolean;
-}
-
-export interface ErrorConfig {
-  errorPatterns: Record<string, ErrorPatternConfig>;
-  fallbacks: Record<string, string>;
-  contextTemplates: Record<string, string>;
-}
-
-export const errorConfig: ErrorConfig = {
-  errorPatterns: {
-    ECONNREFUSED: {
-      message:
-        "Connection refused - the agent service is not running or not accessible at the specified address. Please check that your agent is started and listening on the correct port.",
-      category: "network",
-      severity: "error",
-      actionable: true,
-    },
-    ENOTFOUND: {
-      message:
-        "Host not found - the agent service URL appears to be incorrect or the service is not accessible. Please verify the agent endpoint URL.",
-      category: "network",
-      severity: "error",
-      actionable: true,
-    },
-    ETIMEDOUT: {
-      message:
-        "Connection timeout - the agent service is taking too long to respond. This could indicate network issues or an overloaded agent service.",
-      category: "network",
-      severity: "warning",
-      actionable: true,
-    },
-    terminated: {
-      message:
-        "Agent {context} was unexpectedly terminated. This often indicates an error in the agent service (e.g., authentication failures, missing environment variables, or agent crashes). Check the agent logs for the root cause.",
-      category: "connection",
-      severity: "error",
-      actionable: true,
-    },
-    UND_ERR_SOCKET: {
-      message:
-        "Socket connection was closed unexpectedly. This typically indicates the agent service encountered an error and shut down the connection. Check the agent logs for the underlying cause.",
-      category: "connection",
-      severity: "error",
-      actionable: true,
-    },
-    other_side_closed: {
-      message:
-        "The agent service closed the connection unexpectedly. This usually indicates an error in the agent service. Check the agent logs for more details.",
-      category: "connection",
-      severity: "error",
-      actionable: true,
-    },
-    fetch_failed: {
-      message:
-        "Failed to connect to the agent service. Please verify the agent is running and the endpoint URL is correct.",
-      category: "network",
-      severity: "error",
-      actionable: true,
-    },
-    // Authentication patterns
-    "401": {
-      message:
-        "Authentication failed. Please check your API keys and ensure they are correctly configured.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    "api key": {
-      message:
-        "API key error detected. Please verify your API key is correct and has the necessary permissions.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    unauthorized: {
-      message:
-        "Unauthorized access. Please check your authentication credentials.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    // Python-specific error patterns
-    AuthenticationError: {
-      message:
-        "OpenAI authentication failed. Please check your OPENAI_API_KEY environment variable or API key configuration.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    "Incorrect API key provided": {
-      message:
-        "OpenAI API key is invalid. Please verify your OPENAI_API_KEY is correct and active.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    RateLimitError: {
-      message:
-        "OpenAI rate limit exceeded. Please wait a moment and try again, or check your OpenAI usage limits.",
-      category: "network",
-      severity: "warning",
-      actionable: true,
-    },
-    InvalidRequestError: {
-      message:
-        "Invalid request to OpenAI API. Please check your request parameters and model configuration.",
-      category: "validation",
-      severity: "error",
-      actionable: true,
-    },
-    PermissionDeniedError: {
-      message:
-        "Permission denied for OpenAI API. Please check your API key permissions and billing status.",
-      category: "authentication",
-      severity: "error",
-      actionable: true,
-    },
-    NotFoundError: {
-      message:
-        "OpenAI resource not found. Please check your model name and availability.",
-      category: "validation",
-      severity: "error",
-      actionable: true,
-    },
-  },
-  fallbacks: {
-    network:
-      "A network error occurred while connecting to the agent service. Please check your connection and ensure the agent service is running.",
-    connection:
-      "The connection to the agent service was lost unexpectedly. This may indicate an issue with the agent service.",
-    authentication:
-      "Authentication failed. Please check your API keys and credentials.",
-    validation:
-      "Invalid input or configuration. Please check your parameters and try again.",
-    unknown:
-      "An unexpected error occurred. Please check the logs for more details.",
-    default:
-      "An unexpected error occurred. Please check the logs for more details.",
-  },
-  contextTemplates: {
-    connection: "connection",
-    event_streaming_connection: "event streaming connection",
-    agent_streaming_connection: "agent streaming connection",
-    langgraph_agent_connection: "LangGraph agent connection",
-  },
-};
-
-/**
- * Helper function to get error pattern configuration by key
- */
-export function getErrorPattern(key: string): ErrorPatternConfig | undefined {
-  return errorConfig.errorPatterns[key];
-}
-
-/**
- * Helper function to get fallback message by category
- */
-export function getFallbackMessage(category: string): string {
-  return errorConfig.fallbacks[category] || errorConfig.fallbacks.default;
-}

package/src/lib/index.ts

@@ -1,52 +0,0 @@
-export * from "../service-adapters/openai/openai-adapter";
-export * from "../service-adapters/langchain/langchain-adapter";
-export * from "../service-adapters/google/google-genai-adapter";
-export * from "../service-adapters/openai/openai-assistant-adapter";
-export * from "../service-adapters/unify/unify-adapter";
-export * from "../service-adapters/groq/groq-adapter";
-export * from "./integrations";
-export * from "./logger";
-export * from "./runtime/copilot-runtime";
-export * from "./runtime/mcp-tools-utils";
-export * from "./runtime/telemetry-agent-runner";
-
-// The below re-exports "dummy" classes and types, to get a deprecation warning redirecting the users to import these from the correct, new route
-
-/**
- * @deprecated LangGraphAgent import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export class LangGraphAgent {
-  constructor() {
-    throw new Error(
-      "LangGraphAgent import from @copilotkit/runtime is deprecated. Please import it from @copilotkit/runtime/langgraph instead",
-    );
-  }
-}
-
-/**
- * @deprecated LangGraphHttpAgent import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export class LangGraphHttpAgent {
-  constructor() {
-    throw new Error(
-      "LangGraphHttpAgent import from @copilotkit/runtime is deprecated. Please import it from @copilotkit/runtime/langgraph instead",
-    );
-  }
-}
-
-/**
- * @deprecated TextMessageEvents import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export type TextMessageEvents = any;
-/**
- * @deprecated ToolCallEvents import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export type ToolCallEvents = any;
-/**
- * @deprecated CustomEventNames import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export type CustomEventNames = any;
-/**
- * @deprecated PredictStateTool import from `@copilotkit/runtime` is deprecated. Please import it from `@copilotkit/runtime/langgraph` instead
- */
-export type PredictStateTool = any;

package/src/lib/integrations/index.ts

@@ -1,6 +0,0 @@
-export * from "./shared";
-export * from "./nextjs/app-router";
-export * from "./nextjs/pages-router";
-export * from "./node-http";
-export * from "./node-express";
-export * from "./nest";

package/src/lib/integrations/nest/index.ts

@@ -1,21 +0,0 @@
-import { CreateCopilotRuntimeServerOptions } from "../shared";
-import { copilotRuntimeNodeHttpEndpoint } from "../node-http";
-import telemetry, {
-  getRuntimeInstanceTelemetryInfo,
-} from "../../telemetry-client";
-
-export function copilotRuntimeNestEndpoint(
-  options: CreateCopilotRuntimeServerOptions,
-) {
-  telemetry.setGlobalProperties({
-    runtime: {
-      framework: "nest",
-    },
-  });
-
-  telemetry.capture(
-    "oss.runtime.instance_created",
-    getRuntimeInstanceTelemetryInfo(options),
-  );
-  return copilotRuntimeNodeHttpEndpoint(options);
-}

package/src/lib/integrations/nextjs/app-router.ts

@@ -1,47 +0,0 @@
-import { createCopilotEndpointSingleRoute } from "../../../v2/runtime";
-import { CreateCopilotRuntimeServerOptions, getCommonConfig } from "../shared";
-import telemetry, {
-  getRuntimeInstanceTelemetryInfo,
-} from "../../telemetry-client";
-import { handle } from "hono/vercel";
-
-export function copilotRuntimeNextJSAppRouterEndpoint(
-  options: CreateCopilotRuntimeServerOptions,
-) {
-  const commonConfig = getCommonConfig(options);
-
-  telemetry.setGlobalProperties({
-    runtime: {
-      framework: "nextjs-app-router",
-    },
-  });
-
-  if (options.properties?._copilotkit) {
-    telemetry.setGlobalProperties({
-      _copilotkit: options.properties._copilotkit,
-    });
-  }
-
-  telemetry.capture(
-    "oss.runtime.instance_created",
-    getRuntimeInstanceTelemetryInfo(options),
-  );
-
-  const logger = commonConfig.logging;
-  logger.debug("Creating NextJS App Router endpoint");
-
-  const serviceAdapter = options.serviceAdapter;
-  if (serviceAdapter) {
-    options.runtime.handleServiceAdapter(serviceAdapter);
-  }
-
-  // Note: cors option requires @copilotkit/runtime with credentials support
-  const copilotRoute = createCopilotEndpointSingleRoute({
-    runtime: options.runtime.instance,
-    basePath: options.baseUrl ?? options.endpoint,
-    ...(options.cors && { cors: options.cors }),
-  } as any);
-
-  const handleRequest = handle(copilotRoute as any);
-  return { handleRequest };
-}

package/src/lib/integrations/nextjs/pages-router.ts

@@ -1,45 +0,0 @@
-import { CreateCopilotRuntimeServerOptions, getCommonConfig } from "../shared";
-import telemetry, {
-  getRuntimeInstanceTelemetryInfo,
-} from "../../telemetry-client";
-import { copilotRuntimeNodeHttpEndpoint } from "../node-http";
-
-export const config = {
-  api: {
-    bodyParser: false,
-  },
-};
-
-// This import is needed to fix the type error
-// Fix is currently in TypeScript 5.5 beta, waiting for stable version
-// https://github.com/microsoft/TypeScript/issues/42873#issuecomment-2066874644
-// oxlint-disable-next-line unicorn/require-module-specifiers, typescript/no-useless-empty-export
-export type {} from "@whatwg-node/server";
-
-export function copilotRuntimeNextJSPagesRouterEndpoint(
-  options: CreateCopilotRuntimeServerOptions,
-) {
-  const commonConfig = getCommonConfig(options);
-
-  telemetry.setGlobalProperties({
-    runtime: {
-      framework: "nextjs-pages-router",
-    },
-  });
-
-  if (options.properties?._copilotkit) {
-    telemetry.setGlobalProperties({
-      _copilotkit: options.properties._copilotkit,
-    });
-  }
-
-  telemetry.capture(
-    "oss.runtime.instance_created",
-    getRuntimeInstanceTelemetryInfo(options),
-  );
-
-  const logger = commonConfig.logging;
-  logger.debug("Creating NextJS Pages Router endpoint");
-
-  return copilotRuntimeNodeHttpEndpoint(options);
-}

package/src/lib/integrations/node-express/index.ts

@@ -1,21 +0,0 @@
-import { CreateCopilotRuntimeServerOptions } from "../shared";
-import { copilotRuntimeNodeHttpEndpoint } from "../node-http";
-import telemetry, {
-  getRuntimeInstanceTelemetryInfo,
-} from "../../telemetry-client";
-
-export function copilotRuntimeNodeExpressEndpoint(
-  options: CreateCopilotRuntimeServerOptions,
-) {
-  telemetry.setGlobalProperties({
-    runtime: {
-      framework: "node-express",
-    },
-  });
-
-  telemetry.capture(
-    "oss.runtime.instance_created",
-    getRuntimeInstanceTelemetryInfo(options),
-  );
-  return copilotRuntimeNodeHttpEndpoint(options);
-}

package/src/lib/integrations/node-http/__tests__/request-duck-type.test.ts

@@ -1,66 +0,0 @@
-import { describe, it, expect } from "vitest";
-
-/**
- * Test for #2986: instanceof Request fails with @hono/node-server polyfill
- *
- * When Hono polyfills the Request class, `instanceof Request` fails because
- * the polyfilled Request has a different prototype. We need duck-type checking.
- */
-
-// Simulates a polyfilled Request object that does NOT pass instanceof Request
-function createPolyfillRequest(url: string, method: string = "GET"): object {
-  return {
-    url,
-    method,
-    headers: new Headers({ "content-type": "application/json" }),
-    body: null,
-    clone: () => createPolyfillRequest(url, method),
-  };
-}
-
-// This is the duck-type check that should replace instanceof
-function isRequestLike(obj: unknown): obj is Request {
-  return (
-    typeof obj === "object" &&
-    obj !== null &&
-    "url" in obj &&
-    "method" in obj &&
-    "headers" in obj &&
-    typeof (obj as any).url === "string" &&
-    typeof (obj as any).method === "string"
-  );
-}
-
-describe("Request duck-type detection (#2986)", () => {
-  it("should detect a native Request object", () => {
-    const req = new Request("http://localhost:3000/api/copilotkit", {
-      method: "POST",
-    });
-    expect(isRequestLike(req)).toBe(true);
-    expect(req instanceof Request).toBe(true);
-  });
-
-  it("should detect a polyfilled Request object that fails instanceof", () => {
-    const polyfilled = createPolyfillRequest(
-      "http://localhost:3000/api/copilotkit",
-      "POST",
-    );
-
-    // instanceof fails for polyfilled objects
-    expect(polyfilled instanceof Request).toBe(false);
-
-    // But duck-type check succeeds
-    expect(isRequestLike(polyfilled)).toBe(true);
-  });
-
-  it("should NOT match null or undefined", () => {
-    expect(isRequestLike(null)).toBe(false);
-    expect(isRequestLike(undefined)).toBe(false);
-  });
-
-  it("should NOT match an object missing required properties", () => {
-    expect(isRequestLike({ url: "http://test.com" })).toBe(false);
-    expect(isRequestLike({ method: "GET" })).toBe(false);
-    expect(isRequestLike({})).toBe(false);
-  });
-});