chore (ai): remove toJSON method from AI SDK errors (#3495)

.changeset/poor-needles-double.md

@@ -0,0 +1,6 @@
+---
+'@ai-sdk/provider': major
+'ai': major
+---
+
+chore (ai): remove toJSON method from AI SDK errors

content/docs/08-troubleshooting/01-migration-guide/04-migration-guide-4-0.mdx

@@ -63,6 +63,10 @@ Please use the `headers` and `body` parameters instead.
 
 The `name` property from the `Message` type has been removed.
 
+### Removed `toJSON` method from errors
+
+The `toJSON` method has been removed from AI SDK errors.
+
 ### Removed `streamMode` from `useChat` and `useCompletion`
 
 The `streamMode` parameter has been removed from the `useChat` and `useCompletion` hooks.

packages/ai/core/generate-object/no-object-generated-error.ts

@@ -26,16 +26,4 @@ export class NoObjectGeneratedError extends AISDKError {
   ): error is NoObjectGeneratedError {
     return error instanceof Error && error.name === name;
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      cause: this.cause,
-      message: this.message,
-      stack: this.stack,
-    };
-  }
 }

packages/ai/core/prompt/invalid-data-content-error.ts

@@ -39,17 +39,4 @@ export class InvalidDataContentError extends AISDKError {
       (error as InvalidDataContentError).content != null
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-      cause: this.cause,
-      content: this.content,
-    };
-  }
 }

packages/ai/core/prompt/invalid-message-role-error.ts

@@ -37,17 +37,4 @@ export class InvalidMessageRoleError extends AISDKError {
       typeof (error as InvalidMessageRoleError).role === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      role: this.role,
-    };
-  }
 }

packages/ai/core/registry/no-such-provider-error.ts

@@ -44,21 +44,4 @@ export class NoSuchProviderError extends NoSuchModelError {
       Array.isArray((error as NoSuchProviderError).availableProviders)
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      modelId: this.modelId,
-      modelType: this.modelType,
-
-      providerId: this.providerId,
-      availableProviders: this.availableProviders,
-    };
-  }
 }

packages/ai/errors/invalid-argument-error.ts

@@ -43,15 +43,4 @@ export class InvalidArgumentError extends AISDKError {
       typeof (error as InvalidArgumentError).value === 'string'
     );
   }
-
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      parameter: this.parameter,
-      value: this.value,
-    };
-  }
 }

packages/ai/errors/invalid-tool-arguments-error.ts

@@ -46,19 +46,4 @@ export class InvalidToolArgumentsError extends AISDKError {
       typeof (error as InvalidToolArgumentsError).toolArgs === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      cause: this.cause,
-      stack: this.stack,
-
-      toolName: this.toolName,
-      toolArgs: this.toolArgs,
-    };
-  }
 }

packages/ai/errors/no-such-tool-error.ts

@@ -45,18 +45,4 @@ export class NoSuchToolError extends AISDKError {
       typeof error.name === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      toolName: this.toolName,
-      availableTools: this.availableTools,
-    };
-  }
 }

packages/ai/util/download-error.ts

@@ -51,18 +51,4 @@ export class DownloadError extends AISDKError {
         typeof (error as DownloadError).statusText === 'string')
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      url: this.url,
-      statusCode: this.statusCode,
-      statusText: this.statusText,
-      cause: this.cause,
-    };
-  }
 }

packages/ai/util/retry-error.ts

@@ -50,17 +50,4 @@ export class RetryError extends AISDKError {
       Array.isArray((error as RetryError).errors)
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      reason: this.reason,
-      lastError: this.lastError,
-      errors: this.errors,
-    };
-  }
 }

packages/provider/src/errors/ai-sdk-error.ts

@@ -59,17 +59,4 @@ export class AISDKError extends Error {
       error[markerSymbol] === true
     );
   }
-
-  /**
-   * Returns a JSON representation of the error.
-   * @returns {Object} An object containing the error's name, message, and cause.
-   *
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-    };
-  }
 }

packages/provider/src/errors/api-call-error.ts

@@ -79,22 +79,4 @@ export class APICallError extends AISDKError {
         typeof (error as APICallError).data === 'object')
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      url: this.url,
-      requestBodyValues: this.requestBodyValues,
-      statusCode: this.statusCode,
-      responseHeaders: this.responseHeaders,
-      responseBody: this.responseBody,
-      cause: this.cause,
-      isRetryable: this.isRetryable,
-      data: this.data,
-    };
-  }
 }

packages/provider/src/errors/invalid-prompt-error.ts

@@ -37,17 +37,4 @@ export class InvalidPromptError extends AISDKError {
   static isInvalidPromptError(error: unknown): error is InvalidPromptError {
     return error instanceof Error && error.name === name && prompt != null;
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      prompt: this.prompt,
-    };
-  }
 }

packages/provider/src/errors/invalid-response-data-error.ts

@@ -41,17 +41,4 @@ export class InvalidResponseDataError extends AISDKError {
       (error as InvalidResponseDataError).data != null
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      data: this.data,
-    };
-  }
 }

packages/provider/src/errors/json-parse-error.ts

@@ -38,18 +38,4 @@ export class JSONParseError extends AISDKError {
       typeof error.text === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      cause: this.cause,
-      stack: this.stack,
-
-      valueText: this.text,
-    };
-  }
 }

packages/provider/src/errors/no-content-generated-error.ts

@@ -28,16 +28,4 @@ export class NoContentGeneratedError extends AISDKError {
   ): error is NoContentGeneratedError {
     return error instanceof Error && error.name === name;
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      cause: this.cause,
-      message: this.message,
-      stack: this.stack,
-    };
-  }
 }

packages/provider/src/errors/no-such-model-error.ts

@@ -42,18 +42,4 @@ export class NoSuchModelError extends AISDKError {
       typeof (error as NoSuchModelError).modelType === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      modelId: this.modelId,
-      modelType: this.modelType,
-    };
-  }
 }

packages/provider/src/errors/too-many-embedding-values-for-call-error.ts

@@ -57,20 +57,4 @@ export class TooManyEmbeddingValuesForCallError extends AISDKError {
       Array.isArray(error.values)
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      provider: this.provider,
-      modelId: this.modelId,
-      maxEmbeddingsPerCall: this.maxEmbeddingsPerCall,
-      values: this.values,
-    };
-  }
 }

packages/provider/src/errors/type-validation-error.ts

@@ -55,18 +55,4 @@ export class TypeValidationError extends AISDKError {
   static isTypeValidationError(error: unknown): error is TypeValidationError {
     return error instanceof Error && error.name === name;
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      cause: this.cause,
-      stack: this.stack,
-
-      value: this.value,
-    };
-  }
 }

packages/provider/src/errors/unsupported-functionality-error.ts

@@ -34,17 +34,4 @@ export class UnsupportedFunctionalityError extends AISDKError {
       typeof (error as UnsupportedFunctionalityError).functionality === 'string'
     );
   }
-
-  /**
-   * @deprecated Do not use this method. It will be removed in the next major version.
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      stack: this.stack,
-
-      functionality: this.functionality,
-    };
-  }
 }