@copilotkit/shared 0.0.0-feat-dynamic-copilotcloud-qa-20250117190454 → 0.0.0-feat-enable-setting-recursion-limit-20250424165940

package/CHANGELOG.md

@@ -1,6 +1,290 @@
 # @copilotkit/shared
 
-## 0.0.0-feat-dynamic-copilotcloud-qa-20250117190454
+## 0.0.0-feat-enable-setting-recursion-limit-20250424165940
+
+## 1.8.7
+
+## 1.8.7-next.0
+
+## 1.8.6
+
+## 1.8.6-next.0
+
+## 1.8.5
+
+## 1.8.5-next.5
+
+## 1.8.5-next.4
+
+## 1.8.5-next.3
+
+## 1.8.5-next.2
+
+## 1.8.5-next.1
+
+## 1.8.5-next.0
+
+## 1.8.4
+
+### Patch Changes
+
+- f363760: - fix: when unable to find specified agent, show what's available
+
+## 1.8.4-next.4
+
+## 1.8.4-next.3
+
+## 1.8.4-next.2
+
+## 1.8.4-next.1
+
+### Patch Changes
+
+- f363760: - fix: when unable to find specified agent, show what's available
+
+## 1.8.4-next.0
+
+## 1.8.3
+
+## 1.8.3-next.0
+
+## 1.8.2-next.3
+
+## 1.8.2-next.2
+
+## 1.8.2-next.1
+
+## 1.8.2-next.0
+
+## 1.8.1
+
+## 1.8.1-next.1
+
+## 1.8.1-next.0
+
+## 1.8.0
+
+## 1.8.0-next.8
+
+## 1.8.0-next.7
+
+## 1.8.0-next.6
+
+## 1.8.0-next.5
+
+## 1.8.0-next.4
+
+## 1.8.0-next.3
+
+## 1.7.2-next.2
+
+## 1.7.2-next.1
+
+## 1.7.2-next.0
+
+## 1.7.1
+
+## 1.7.1-next.0
+
+## 1.7.0
+
+## 1.7.0-next.1
+
+## 1.7.0-next.0
+
+## 1.6.0
+
+### Patch Changes
+
+- 090203d: - fix: use tryMap method to filter out possibly invalid items
+
+## 1.6.0-next.12
+
+## 1.6.0-next.11
+
+## 1.6.0-next.10
+
+## 1.6.0-next.9
+
+## 1.6.0-next.8
+
+## 1.6.0-next.7
+
+## 1.6.0-next.6
+
+## 1.6.0-next.5
+
+### Patch Changes
+
+- 090203d: - fix: use tryMap method to filter out possibly invalid items
+
+## 1.6.0-next.4
+
+## 1.6.0-next.3
+
+## 1.6.0-next.2
+
+## 1.6.0-next.1
+
+## 1.6.0-next.0
+
+## 1.5.20
+
+### Patch Changes
+
+- 51f0d66: - fix(errors): fix internal usage of error resolver
+
+## 1.5.20-next.0
+
+### Patch Changes
+
+- 51f0d66: - fix(errors): fix internal usage of error resolver
+
+## 1.5.19
+
+### Patch Changes
+
+- 0dd1ab9: - fix(errors): allow non copilotkit errors to pass to consumer app error boundary
+
+## 1.5.19-next.1
+
+### Patch Changes
+
+- 0dd1ab9: - fix(errors): allow non copilotkit errors to pass to consumer app error boundary
+
+## 1.5.19-next.0
+
+## 1.5.18
+
+### Patch Changes
+
+- d47cd26: - fix: detect and alert on version mismatch
+- f77a7b9: - fix: use warning when version mismatch is not expected to error out
+- 38d3ac2: - fix: add additional info the our error messages
+
+## 1.5.18-next.3
+
+### Patch Changes
+
+- f77a7b9: - fix: use warning when version mismatch is not expected to error out
+
+## 1.5.18-next.2
+
+### Patch Changes
+
+- 38d3ac2: - fix: add additional info the our error messages
+
+## 1.5.18-next.1
+
+## 1.5.18-next.0
+
+### Patch Changes
+
+- d47cd26: - fix: detect and alert on version mismatch
+
+## 1.5.17
+
+### Patch Changes
+
+- 1fc3902: - Revert "fix: detect and alert on version mismatch (#1333)"
+
+  This reverts commit 48b7c7b1bd48ced82ffb9a00d6eddc1f7581e0c1.
+
+## 1.5.17-next.0
+
+### Patch Changes
+
+- 1fc3902: - Revert "fix: detect and alert on version mismatch (#1333)"
+
+  This reverts commit 48b7c7b1bd48ced82ffb9a00d6eddc1f7581e0c1.
+
+## 1.5.16
+
+### Patch Changes
+
+- 48b7c7b: - fix: detect and alert on version mismatch
+
+## 1.5.16-next.2
+
+## 1.5.16-next.1
+
+### Patch Changes
+
+- 48b7c7b: - fix: detect and alert on version mismatch
+
+## 1.5.16-next.0
+
+## 1.5.15
+
+### Patch Changes
+
+- 7b3141d: - feat(interrupt): support LG interrupt with useLangGraphInterrupt hook
+  - chore(interrupt): add e2e test to interrupt functionality
+  - feat(interrupt): add support for multiple interrupts and conditions
+
+## 1.5.15-next.8
+
+## 1.5.15-next.7
+
+## 1.5.15-next.6
+
+## 1.5.15-next.5
+
+## 1.5.15-next.4
+
+### Patch Changes
+
+- 7b3141d: - feat(interrupt): support LG interrupt with useLangGraphInterrupt hook
+  - chore(interrupt): add e2e test to interrupt functionality
+  - feat(interrupt): add support for multiple interrupts and conditions
+
+## 1.5.15-next.3
+
+## 1.5.15-next.2
+
+## 1.5.15-next.1
+
+## 1.5.15-next.0
+
+## 1.5.14
+
+### Patch Changes
+
+- 0061f65: - feat: allows dev mode for cloud onboarding flow
+
+## 1.5.14-next.0
+
+### Patch Changes
+
+- 0061f65: - feat: allows dev mode for cloud onboarding flow
+
+## 1.5.13
+
+## 1.5.13-next.0
+
+## 1.5.12
+
+### Patch Changes
+
+- 6136a57: - fix(errors): add custom error classes to better describe library errors
+  - fix(errors): use new errors in error handling
+  - chore: add documentation and links to respective errors
+
+## 1.5.12-next.7
+
+## 1.5.12-next.6
+
+### Patch Changes
+
+- 6136a57: - fix(errors): add custom error classes to better describe library errors
+  - fix(errors): use new errors in error handling
+  - chore: add documentation and links to respective errors
+
+## 1.5.12-next.5
+
+## 1.5.12-next.4
+
+## 1.5.12-next.3
 
 ## 1.5.12-next.2
 

package/dist/chunk-FDMXZMSN.mjs

@@ -0,0 +1,361 @@
+// src/utils/errors.ts
+import { GraphQLError } from "graphql";
+
+// src/utils/index.ts
+function parseJson(json, fallback = "unset") {
+  try {
+    return JSON.parse(json);
+  } catch (e) {
+    return fallback === "unset" ? null : fallback;
+  }
+}
+function tryMap(items, callback) {
+  return items.reduce((acc, item, index, array) => {
+    try {
+      acc.push(callback(item, index, array));
+    } catch (error) {
+      console.error(error);
+    }
+    return acc;
+  }, []);
+}
+
+// package.json
+var version = "1.8.7";
+
+// src/index.ts
+var COPILOTKIT_VERSION = version;
+
+// src/utils/errors.ts
+var Severity = /* @__PURE__ */ ((Severity2) => {
+  Severity2["Error"] = "error";
+  return Severity2;
+})(Severity || {});
+var ERROR_NAMES = {
+  COPILOT_ERROR: "CopilotError",
+  COPILOT_API_DISCOVERY_ERROR: "CopilotApiDiscoveryError",
+  COPILOT_REMOTE_ENDPOINT_DISCOVERY_ERROR: "CopilotKitRemoteEndpointDiscoveryError",
+  COPILOT_KIT_AGENT_DISCOVERY_ERROR: "CopilotKitAgentDiscoveryError",
+  COPILOT_KIT_LOW_LEVEL_ERROR: "CopilotKitLowLevelError",
+  COPILOT_KIT_VERSION_MISMATCH_ERROR: "CopilotKitVersionMismatchError",
+  RESOLVED_COPILOT_KIT_ERROR: "ResolvedCopilotKitError",
+  CONFIGURATION_ERROR: "ConfigurationError",
+  MISSING_PUBLIC_API_KEY_ERROR: "MissingPublicApiKeyError",
+  UPGRADE_REQUIRED_ERROR: "UpgradeRequiredError"
+};
+var COPILOT_CLOUD_ERROR_NAMES = [
+  ERROR_NAMES.CONFIGURATION_ERROR,
+  ERROR_NAMES.MISSING_PUBLIC_API_KEY_ERROR,
+  ERROR_NAMES.UPGRADE_REQUIRED_ERROR
+];
+var CopilotKitErrorCode = /* @__PURE__ */ ((CopilotKitErrorCode2) => {
+  CopilotKitErrorCode2["NETWORK_ERROR"] = "NETWORK_ERROR";
+  CopilotKitErrorCode2["NOT_FOUND"] = "NOT_FOUND";
+  CopilotKitErrorCode2["AGENT_NOT_FOUND"] = "AGENT_NOT_FOUND";
+  CopilotKitErrorCode2["API_NOT_FOUND"] = "API_NOT_FOUND";
+  CopilotKitErrorCode2["REMOTE_ENDPOINT_NOT_FOUND"] = "REMOTE_ENDPOINT_NOT_FOUND";
+  CopilotKitErrorCode2["MISUSE"] = "MISUSE";
+  CopilotKitErrorCode2["UNKNOWN"] = "UNKNOWN";
+  CopilotKitErrorCode2["VERSION_MISMATCH"] = "VERSION_MISMATCH";
+  CopilotKitErrorCode2["CONFIGURATION_ERROR"] = "CONFIGURATION_ERROR";
+  CopilotKitErrorCode2["MISSING_PUBLIC_API_KEY_ERROR"] = "MISSING_PUBLIC_API_KEY_ERROR";
+  CopilotKitErrorCode2["UPGRADE_REQUIRED_ERROR"] = "UPGRADE_REQUIRED_ERROR";
+  return CopilotKitErrorCode2;
+})(CopilotKitErrorCode || {});
+var BASE_URL = "https://docs.copilotkit.ai";
+var getSeeMoreMarkdown = (link) => `See more: [${link}](${link})`;
+var ERROR_CONFIG = {
+  ["NETWORK_ERROR" /* NETWORK_ERROR */]: {
+    statusCode: 503,
+    troubleshootingUrl: `${BASE_URL}/troubleshooting/common-issues#i-am-getting-a-network-errors--api-not-found`
+  },
+  ["NOT_FOUND" /* NOT_FOUND */]: {
+    statusCode: 404,
+    troubleshootingUrl: `${BASE_URL}/troubleshooting/common-issues#i-am-getting-a-network-errors--api-not-found`
+  },
+  ["AGENT_NOT_FOUND" /* AGENT_NOT_FOUND */]: {
+    statusCode: 500,
+    troubleshootingUrl: `${BASE_URL}/coagents/troubleshooting/common-issues#i-am-getting-agent-not-found-error`
+  },
+  ["API_NOT_FOUND" /* API_NOT_FOUND */]: {
+    statusCode: 404,
+    troubleshootingUrl: `${BASE_URL}/troubleshooting/common-issues#i-am-getting-a-network-errors--api-not-found`
+  },
+  ["REMOTE_ENDPOINT_NOT_FOUND" /* REMOTE_ENDPOINT_NOT_FOUND */]: {
+    statusCode: 404,
+    troubleshootingUrl: `${BASE_URL}/troubleshooting/common-issues#i-am-getting-copilotkits-remote-endpoint-not-found-error`
+  },
+  ["MISUSE" /* MISUSE */]: {
+    statusCode: 400,
+    troubleshootingUrl: null
+  },
+  ["UNKNOWN" /* UNKNOWN */]: {
+    statusCode: 500
+  },
+  ["CONFIGURATION_ERROR" /* CONFIGURATION_ERROR */]: {
+    statusCode: 400,
+    troubleshootingUrl: null,
+    severity: "error" /* Error */
+  },
+  ["MISSING_PUBLIC_API_KEY_ERROR" /* MISSING_PUBLIC_API_KEY_ERROR */]: {
+    statusCode: 400,
+    troubleshootingUrl: null,
+    severity: "error" /* Error */
+  },
+  ["UPGRADE_REQUIRED_ERROR" /* UPGRADE_REQUIRED_ERROR */]: {
+    statusCode: 402,
+    troubleshootingUrl: null,
+    severity: "error" /* Error */
+  },
+  ["VERSION_MISMATCH" /* VERSION_MISMATCH */]: {
+    statusCode: 400,
+    troubleshootingUrl: null
+  }
+};
+var CopilotKitError = class extends GraphQLError {
+  constructor({
+    message = "Unknown error occurred",
+    code,
+    severity
+  }) {
+    const name = ERROR_NAMES.COPILOT_ERROR;
+    const { statusCode } = ERROR_CONFIG[code];
+    super(message, {
+      extensions: {
+        name,
+        statusCode
+      }
+    });
+    this.code = code;
+    this.name = name;
+    this.statusCode = statusCode;
+    this.severity = severity;
+  }
+};
+var CopilotKitMisuseError = class extends CopilotKitError {
+  constructor({
+    message,
+    code = "MISUSE" /* MISUSE */
+  }) {
+    const docsLink = "troubleshootingUrl" in ERROR_CONFIG[code] && ERROR_CONFIG[code].troubleshootingUrl ? getSeeMoreMarkdown(ERROR_CONFIG[code].troubleshootingUrl) : null;
+    const finalMessage = docsLink ? `${message}.
+
+${docsLink}` : message;
+    super({ message: finalMessage, code });
+    this.name = ERROR_NAMES.COPILOT_API_DISCOVERY_ERROR;
+  }
+};
+var getVersionMismatchErrorMessage = ({
+  reactCoreVersion,
+  runtimeVersion,
+  runtimeClientGqlVersion
+}) => `Version mismatch detected: @copilotkit/runtime@${runtimeVersion ?? ""} is not compatible with @copilotkit/react-core@${reactCoreVersion} and @copilotkit/runtime-client-gql@${runtimeClientGqlVersion}. Please ensure all installed copilotkit packages are on the same version.`;
+var CopilotKitVersionMismatchError = class extends CopilotKitError {
+  constructor({
+    reactCoreVersion,
+    runtimeVersion,
+    runtimeClientGqlVersion
+  }) {
+    const code = "VERSION_MISMATCH" /* VERSION_MISMATCH */;
+    super({
+      message: getVersionMismatchErrorMessage({
+        reactCoreVersion,
+        runtimeVersion,
+        runtimeClientGqlVersion
+      }),
+      code
+    });
+    this.name = ERROR_NAMES.COPILOT_KIT_VERSION_MISMATCH_ERROR;
+  }
+};
+var CopilotKitApiDiscoveryError = class extends CopilotKitError {
+  constructor(params = {}) {
+    const url = params.url ?? "";
+    let operationSuffix = "";
+    if (url == null ? void 0 : url.includes("/info"))
+      operationSuffix = `when fetching CopilotKit info`;
+    else if (url.includes("/actions/execute"))
+      operationSuffix = `when attempting to execute actions.`;
+    else if (url.includes("/agents/state"))
+      operationSuffix = `when attempting to get agent state.`;
+    else if (url.includes("/agents/execute"))
+      operationSuffix = `when attempting to execute agent(s).`;
+    const message = params.message ?? (params.url ? `Failed to find CopilotKit API endpoint at url ${params.url} ${operationSuffix}` : `Failed to find CopilotKit API endpoint.`);
+    const code = params.code ?? "API_NOT_FOUND" /* API_NOT_FOUND */;
+    const errorMessage = `${message}.
+
+${getSeeMoreMarkdown(ERROR_CONFIG[code].troubleshootingUrl)}`;
+    super({ message: errorMessage, code });
+    this.name = ERROR_NAMES.COPILOT_API_DISCOVERY_ERROR;
+  }
+};
+var CopilotKitRemoteEndpointDiscoveryError = class extends CopilotKitApiDiscoveryError {
+  constructor(params) {
+    const message = (params == null ? void 0 : params.message) ?? ((params == null ? void 0 : params.url) ? `Failed to find or contact remote endpoint at url ${params.url}` : "Failed to find or contact remote endpoint");
+    const code = "REMOTE_ENDPOINT_NOT_FOUND" /* REMOTE_ENDPOINT_NOT_FOUND */;
+    super({ message, code });
+    this.name = ERROR_NAMES.COPILOT_REMOTE_ENDPOINT_DISCOVERY_ERROR;
+  }
+};
+var CopilotKitAgentDiscoveryError = class extends CopilotKitError {
+  constructor(params) {
+    const { agentName, availableAgents } = params;
+    const code = "AGENT_NOT_FOUND" /* AGENT_NOT_FOUND */;
+    let message = "Failed to find any agents.";
+    const configMessage = "Please verify the agent name exists and is properly configured.";
+    const seeMore = getSeeMoreMarkdown(ERROR_CONFIG[code].troubleshootingUrl);
+    if (availableAgents.length) {
+      message = agentName ? `Failed to find agent '${agentName}'. ${configMessage}` : `Failed to find agent. ${configMessage}`;
+      const bulletList = availableAgents.map((agent) => `\u2022 ${agent.name} (ID: \`${agent.id}\`)`).join("\n");
+      message += `
+
+The available agents are:
+
+${bulletList}
+
+${seeMore}`;
+    } else {
+      message += `
+
+${seeMore}`;
+    }
+    super({ message, code });
+    this.name = ERROR_NAMES.COPILOT_KIT_AGENT_DISCOVERY_ERROR;
+  }
+};
+var CopilotKitLowLevelError = class extends CopilotKitError {
+  constructor({ error, url, message }) {
+    let code = "NETWORK_ERROR" /* NETWORK_ERROR */;
+    const errorCode = error.code;
+    const errorMessage = message ?? resolveLowLevelErrorMessage({ errorCode, url });
+    super({ message: errorMessage, code });
+    this.name = ERROR_NAMES.COPILOT_KIT_LOW_LEVEL_ERROR;
+  }
+};
+var ResolvedCopilotKitError = class extends CopilotKitError {
+  constructor({
+    status,
+    message,
+    code,
+    isRemoteEndpoint,
+    url
+  }) {
+    let resolvedCode = code;
+    if (!resolvedCode) {
+      switch (status) {
+        case 400:
+          throw new CopilotKitApiDiscoveryError({ message, url });
+        case 404:
+          throw isRemoteEndpoint ? new CopilotKitRemoteEndpointDiscoveryError({ message, url }) : new CopilotKitApiDiscoveryError({ message, url });
+        default:
+          resolvedCode = "UNKNOWN" /* UNKNOWN */;
+          super({ message, code: resolvedCode });
+      }
+    } else {
+      super({ message, code: resolvedCode });
+    }
+    this.name = ERROR_NAMES.RESOLVED_COPILOT_KIT_ERROR;
+  }
+};
+var ConfigurationError = class extends CopilotKitError {
+  constructor(message) {
+    super({ message, code: "CONFIGURATION_ERROR" /* CONFIGURATION_ERROR */ });
+    this.name = ERROR_NAMES.CONFIGURATION_ERROR;
+    this.severity = "error" /* Error */;
+  }
+};
+var MissingPublicApiKeyError = class extends ConfigurationError {
+  constructor(message) {
+    super(message);
+    this.name = ERROR_NAMES.MISSING_PUBLIC_API_KEY_ERROR;
+    this.severity = "error" /* Error */;
+  }
+};
+var UpgradeRequiredError = class extends ConfigurationError {
+  constructor(message) {
+    super(message);
+    this.name = ERROR_NAMES.UPGRADE_REQUIRED_ERROR;
+    this.severity = "error" /* Error */;
+  }
+};
+async function getPossibleVersionMismatch({
+  runtimeVersion,
+  runtimeClientGqlVersion
+}) {
+  if (!runtimeVersion || runtimeVersion === "" || !runtimeClientGqlVersion)
+    return;
+  if (COPILOTKIT_VERSION !== runtimeVersion || COPILOTKIT_VERSION !== runtimeClientGqlVersion || runtimeVersion !== runtimeClientGqlVersion) {
+    return {
+      runtimeVersion,
+      runtimeClientGqlVersion,
+      reactCoreVersion: COPILOTKIT_VERSION,
+      message: getVersionMismatchErrorMessage({
+        runtimeVersion,
+        runtimeClientGqlVersion,
+        reactCoreVersion: COPILOTKIT_VERSION
+      })
+    };
+  }
+  return;
+}
+var resolveLowLevelErrorMessage = ({ errorCode, url }) => {
+  const troubleshootingLink = ERROR_CONFIG["NETWORK_ERROR" /* NETWORK_ERROR */].troubleshootingUrl;
+  const genericMessage = (description = `Failed to fetch from url ${url}.`) => `${description}.
+
+Possible reasons:
+- -The server may have an error preventing it from returning a response (Check the server logs for more info).
+- -The server might be down or unreachable
+- -There might be a network issue (e.g., DNS failure, connection timeout) 
+- -The URL might be incorrect
+- -The server is not running on the specified port
+
+${getSeeMoreMarkdown(troubleshootingLink)}`;
+  if (url.includes("/info"))
+    return genericMessage(`Failed to fetch CopilotKit agents/action information from url ${url}.`);
+  if (url.includes("/actions/execute"))
+    return genericMessage(`Fetch call to ${url} to execute actions failed.`);
+  if (url.includes("/agents/state"))
+    return genericMessage(`Fetch call to ${url} to get agent state failed.`);
+  if (url.includes("/agents/execute"))
+    return genericMessage(`Fetch call to ${url} to execute agent(s) failed.`);
+  switch (errorCode) {
+    case "ECONNREFUSED":
+      return `Connection to ${url} was refused. Ensure the server is running and accessible.
+
+${getSeeMoreMarkdown(troubleshootingLink)}`;
+    case "ENOTFOUND":
+      return `The server on ${url} could not be found. Check the URL or your network configuration.
+
+${getSeeMoreMarkdown(ERROR_CONFIG["NOT_FOUND" /* NOT_FOUND */].troubleshootingUrl)}`;
+    case "ETIMEDOUT":
+      return `The connection to ${url} timed out. The server might be overloaded or taking too long to respond.
+
+${getSeeMoreMarkdown(troubleshootingLink)}`;
+    default:
+      return;
+  }
+};
+
+export {
+  Severity,
+  ERROR_NAMES,
+  COPILOT_CLOUD_ERROR_NAMES,
+  CopilotKitErrorCode,
+  ERROR_CONFIG,
+  CopilotKitError,
+  CopilotKitMisuseError,
+  CopilotKitVersionMismatchError,
+  CopilotKitApiDiscoveryError,
+  CopilotKitRemoteEndpointDiscoveryError,
+  CopilotKitAgentDiscoveryError,
+  CopilotKitLowLevelError,
+  ResolvedCopilotKitError,
+  ConfigurationError,
+  MissingPublicApiKeyError,
+  UpgradeRequiredError,
+  getPossibleVersionMismatch,
+  parseJson,
+  tryMap,
+  COPILOTKIT_VERSION
+};
+//# sourceMappingURL=chunk-FDMXZMSN.mjs.map