@ai-sdk/provider 0.0.14 → 0.0.15

package/dist/index.d.ts

@@ -82,13 +82,57 @@ type EmbeddingModelV1<VALUE> = {
     }>;
 };
 
-declare class APICallError extends Error {
+declare const symbol$b: unique symbol;
+/**
+ * Custom error class for AI SDK related errors.
+ * @extends Error
+ */
+declare class AISDKError extends Error {
+    private readonly [symbol$b];
+    /**
+     * The underlying cause of the error, if any.
+     */
+    readonly cause?: unknown;
+    /**
+     * Creates an AI SDK Error.
+     *
+     * @param {Object} params - The parameters for creating the error.
+     * @param {string} params.name - The name of the error.
+     * @param {string} params.message - The error message.
+     * @param {unknown} [params.cause] - The underlying cause of the error.
+     */
+    constructor({ name, message, cause, }: {
+        name: string;
+        message: string;
+        cause?: unknown;
+    });
+    /**
+     * Checks if the given error is an AI SDK Error.
+     * @param {unknown} error - The error to check.
+     * @returns {boolean} True if the error is an AI SDK Error, false otherwise.
+     */
+    static isInstance(error: unknown): error is AISDKError;
+    protected static hasMarker(error: unknown, marker: string): boolean;
+    /**
+     * 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(): {
+        name: string;
+        message: string;
+    };
+}
+
+declare const symbol$a: unique symbol;
+declare class APICallError extends AISDKError {
+    private readonly [symbol$a];
     readonly url: string;
     readonly requestBodyValues: unknown;
     readonly statusCode?: number;
     readonly responseHeaders?: Record<string, string>;
     readonly responseBody?: string;
-    readonly cause?: unknown;
     readonly isRetryable: boolean;
     readonly data?: unknown;
     constructor({ message, url, requestBodyValues, statusCode, responseHeaders, responseBody, cause, isRetryable, // server error
@@ -103,7 +147,14 @@ declare class APICallError extends Error {
         isRetryable?: boolean;
         data?: unknown;
     });
+    static isInstance(error: unknown): error is APICallError;
+    /**
+     * @deprecated Use isInstance instead.
+     */
     static isAPICallError(error: unknown): error is APICallError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -118,84 +169,41 @@ declare class APICallError extends Error {
     };
 }
 
-declare class DownloadError extends Error {
-    readonly url: string;
-    readonly statusCode?: number;
-    readonly statusText?: string;
-    readonly cause?: unknown;
-    constructor({ url, statusCode, statusText, cause, message, }: {
-        url: string;
-        statusCode?: number;
-        statusText?: string;
-        message?: string;
-        cause?: unknown;
-    });
-    static isDownloadError(error: unknown): error is DownloadError;
-    toJSON(): {
-        name: string;
-        message: string;
-        url: string;
-        statusCode: number | undefined;
-        statusText: string | undefined;
-        cause: unknown;
-    };
-}
-
-declare class EmptyResponseBodyError extends Error {
+declare const symbol$9: unique symbol;
+declare class EmptyResponseBodyError extends AISDKError {
+    private readonly [symbol$9];
     constructor({ message }?: {
         message?: string;
     });
+    static isInstance(error: unknown): error is EmptyResponseBodyError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
     static isEmptyResponseBodyError(error: unknown): error is EmptyResponseBodyError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-    };
 }
 
-declare class InvalidArgumentError extends Error {
-    readonly parameter: string;
-    readonly value: unknown;
-    constructor({ parameter, value, message, }: {
-        parameter: string;
-        value: unknown;
-        message: string;
-    });
-    static isInvalidArgumentError(error: unknown): error is InvalidArgumentError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        parameter: string;
-        value: unknown;
-    };
-}
-
-declare class InvalidDataContentError extends Error {
-    readonly content: unknown;
-    readonly cause?: unknown;
-    constructor({ content, cause, message, }: {
-        content: unknown;
-        cause?: unknown;
-        message?: string;
-    });
-    static isInvalidDataContentError(error: unknown): error is InvalidDataContentError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        cause: unknown;
-        content: unknown;
-    };
-}
+declare function getErrorMessage(error: unknown | undefined): string;
 
-declare class InvalidPromptError extends Error {
+declare const symbol$8: unique symbol;
+/**
+ * A prompt is invalid. This error should be thrown by providers when they cannot
+ * process a prompt.
+ */
+declare class InvalidPromptError extends AISDKError {
+    private readonly [symbol$8];
     readonly prompt: unknown;
     constructor({ prompt, message }: {
         prompt: unknown;
         message: string;
     });
+    static isInstance(error: unknown): error is InvalidPromptError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
     static isInvalidPromptError(error: unknown): error is InvalidPromptError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -204,17 +212,26 @@ declare class InvalidPromptError extends Error {
     };
 }
 
+declare const symbol$7: unique symbol;
 /**
-Server returned a response with invalid data content. This should be thrown by providers when they
-cannot parse the response from the API.
+ * Server returned a response with invalid data content.
+ * This should be thrown by providers when they cannot parse the response from the API.
  */
-declare class InvalidResponseDataError extends Error {
+declare class InvalidResponseDataError extends AISDKError {
+    private readonly [symbol$7];
     readonly data: unknown;
     constructor({ data, message, }: {
         data: unknown;
         message?: string;
     });
+    static isInstance(error: unknown): error is InvalidResponseDataError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
     static isInvalidResponseDataError(error: unknown): error is InvalidResponseDataError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -223,35 +240,22 @@ declare class InvalidResponseDataError extends Error {
     };
 }
 
-declare class InvalidToolArgumentsError extends Error {
-    readonly toolName: string;
-    readonly toolArgs: string;
-    readonly cause: unknown;
-    constructor({ toolArgs, toolName, cause, message, }: {
-        message?: string;
-        toolArgs: string;
-        toolName: string;
-        cause: unknown;
-    });
-    static isInvalidToolArgumentsError(error: unknown): error is InvalidToolArgumentsError;
-    toJSON(): {
-        name: string;
-        message: string;
-        cause: unknown;
-        stack: string | undefined;
-        toolName: string;
-        toolArgs: string;
-    };
-}
-
-declare class JSONParseError extends Error {
+declare const symbol$6: unique symbol;
+declare class JSONParseError extends AISDKError {
+    private readonly [symbol$6];
     readonly text: string;
-    readonly cause: unknown;
     constructor({ text, cause }: {
         text: string;
         cause: unknown;
     });
+    static isInstance(error: unknown): error is JSONParseError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
     static isJSONParseError(error: unknown): error is JSONParseError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -261,37 +265,49 @@ declare class JSONParseError extends Error {
     };
 }
 
-declare class LoadAPIKeyError extends Error {
+declare const symbol$5: unique symbol;
+declare class LoadAPIKeyError extends AISDKError {
+    private readonly [symbol$5];
     constructor({ message }: {
         message: string;
     });
+    static isInstance(error: unknown): error is LoadAPIKeyError;
+    /**
+     * @deprecated Use isInstance instead.
+     */
     static isLoadAPIKeyError(error: unknown): error is LoadAPIKeyError;
-    toJSON(): {
-        name: string;
-        message: string;
-    };
 }
 
-declare class LoadSettingError extends Error {
+declare const symbol$4: unique symbol;
+declare class LoadSettingError extends AISDKError {
+    private readonly [symbol$4];
     constructor({ message }: {
         message: string;
     });
+    static isInstance(error: unknown): error is LoadSettingError;
+    /**
+     * @deprecated Use isInstance instead.
+     */
     static isLoadSettingError(error: unknown): error is LoadSettingError;
-    toJSON(): {
-        name: string;
-        message: string;
-    };
 }
 
+declare const symbol$3: unique symbol;
 /**
 Thrown when the AI provider fails to generate any content.
  */
-declare class NoContentGeneratedError extends Error {
-    readonly cause: unknown;
+declare class NoContentGeneratedError extends AISDKError {
+    private readonly [symbol$3];
     constructor({ message, }?: {
         message?: string;
     });
+    static isInstance(error: unknown): error is NoContentGeneratedError;
+    /**
+     * @deprecated Use isInstance instead.
+     */
     static isNoContentGeneratedError(error: unknown): error is NoContentGeneratedError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         cause: unknown;
@@ -300,62 +316,9 @@ declare class NoContentGeneratedError extends Error {
     };
 }
 
-/**
-Thrown when the AI provider fails to generate a parsable object.
- */
-declare class NoObjectGeneratedError extends Error {
-    readonly cause: unknown;
-    constructor({ message }?: {
-        message?: string;
-    });
-    static isNoObjectGeneratedError(error: unknown): error is NoObjectGeneratedError;
-    toJSON(): {
-        name: string;
-        cause: unknown;
-        message: string;
-        stack: string | undefined;
-    };
-}
-
-declare class NoSuchToolError extends Error {
-    readonly toolName: string;
-    readonly availableTools: string[] | undefined;
-    constructor({ toolName, availableTools, message, }: {
-        toolName: string;
-        availableTools?: string[] | undefined;
-        message?: string;
-    });
-    static isNoSuchToolError(error: unknown): error is NoSuchToolError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        toolName: string;
-        availableTools: string[] | undefined;
-    };
-}
-
-type RetryErrorReason = 'maxRetriesExceeded' | 'errorNotRetryable' | 'abort';
-declare class RetryError extends Error {
-    readonly reason: RetryErrorReason;
-    readonly lastError: unknown;
-    readonly errors: Array<unknown>;
-    constructor({ message, reason, errors, }: {
-        message: string;
-        reason: RetryErrorReason;
-        errors: Array<unknown>;
-    });
-    static isRetryError(error: unknown): error is RetryError;
-    toJSON(): {
-        name: string;
-        message: string;
-        reason: RetryErrorReason;
-        lastError: unknown;
-        errors: unknown[];
-    };
-}
-
-declare class TooManyEmbeddingValuesForCallError extends Error {
+declare const symbol$2: unique symbol;
+declare class TooManyEmbeddingValuesForCallError extends AISDKError {
+    private readonly [symbol$2];
     readonly provider: string;
     readonly modelId: string;
     readonly maxEmbeddingsPerCall: number;
@@ -366,75 +329,41 @@ declare class TooManyEmbeddingValuesForCallError extends Error {
         maxEmbeddingsPerCall: number;
         values: Array<unknown>;
     });
-    static isInvalidPromptError(error: unknown): error is TooManyEmbeddingValuesForCallError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        provider: string;
-        modelId: string;
-        maxEmbeddingsPerCall: number;
-        values: unknown[];
-    };
-}
-
-/**
-A tool has a name, a description, and a set of parameters.
-
-Note: this is **not** the user-facing tool definition. The AI SDK methods will
-map the user-facing tool definitions to this format.
- */
-type LanguageModelV1FunctionTool = {
+    static isInstance(error: unknown): error is TooManyEmbeddingValuesForCallError;
     /**
-  The type of the tool. Only functions for now, but this gives us room to
-  add more specific tool types in the future and use a discriminated union.
-     */
-    type: 'function';
-    /**
-  The name of the tool. Unique within this model call.
-     */
-    name: string;
-    /**
-  A description of the tool. The language model uses this to understand the
-  tool's purpose and to provide better completion suggestions.
+     * @deprecated use `isInstance` instead
      */
-    description?: string;
+    static isTooManyEmbeddingValuesForCallError(error: unknown): error is TooManyEmbeddingValuesForCallError;
     /**
-  The parameters that the tool expects. The language model uses this to
-  understand the tool's input requirements and to provide matching suggestions.
+     * @deprecated Do not use this method. It will be removed in the next major version.
      */
-    parameters: JSONSchema7;
-};
-
-declare class ToolCallParseError extends Error {
-    readonly cause: unknown;
-    readonly text: string;
-    readonly tools: LanguageModelV1FunctionTool[];
-    constructor({ cause, text, tools, message, }: {
-        cause: unknown;
-        text: string;
-        tools: LanguageModelV1FunctionTool[];
-        message?: string;
-    });
-    static isToolCallParseError(error: unknown): error is ToolCallParseError;
     toJSON(): {
         name: string;
         message: string;
         stack: string | undefined;
-        cause: unknown;
-        text: string;
-        tools: LanguageModelV1FunctionTool[];
+        provider: string;
+        modelId: string;
+        maxEmbeddingsPerCall: number;
+        values: unknown[];
     };
 }
 
-declare class TypeValidationError extends Error {
+declare const symbol$1: unique symbol;
+declare class TypeValidationError extends AISDKError {
+    private readonly [symbol$1];
     readonly value: unknown;
-    readonly cause: unknown;
     constructor({ value, cause }: {
         value: unknown;
         cause: unknown;
     });
+    static isInstance(error: unknown): error is TypeValidationError;
+    /**
+     * @deprecated use `isInstance` instead
+     */
     static isTypeValidationError(error: unknown): error is TypeValidationError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -444,12 +373,21 @@ declare class TypeValidationError extends Error {
     };
 }
 
-declare class UnsupportedFunctionalityError extends Error {
+declare const symbol: unique symbol;
+declare class UnsupportedFunctionalityError extends AISDKError {
+    private readonly [symbol];
     readonly functionality: string;
     constructor({ functionality }: {
         functionality: string;
     });
+    static isInstance(error: unknown): error is UnsupportedFunctionalityError;
+    /**
+     * @deprecated Use isInstance instead.
+     */
     static isUnsupportedFunctionalityError(error: unknown): error is UnsupportedFunctionalityError;
+    /**
+     * @deprecated Do not use this method. It will be removed in the next major version.
+     */
     toJSON(): {
         name: string;
         message: string;
@@ -458,24 +396,6 @@ declare class UnsupportedFunctionalityError extends Error {
     };
 }
 
-declare class UnsupportedJSONSchemaError extends Error {
-    readonly reason: string;
-    readonly schema: unknown;
-    constructor({ schema, reason, message, }: {
-        schema: unknown;
-        reason: string;
-        message?: string;
-    });
-    static isUnsupportedJSONSchemaError(error: unknown): error is UnsupportedJSONSchemaError;
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        reason: string;
-        schema: unknown;
-    };
-}
-
 type LanguageModelV1CallSettings = {
     /**
   Maximum number of tokens to generate.
@@ -543,6 +463,34 @@ type LanguageModelV1CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+/**
+A tool has a name, a description, and a set of parameters.
+
+Note: this is **not** the user-facing tool definition. The AI SDK methods will
+map the user-facing tool definitions to this format.
+ */
+type LanguageModelV1FunctionTool = {
+    /**
+  The type of the tool. Only functions for now, but this gives us room to
+  add more specific tool types in the future and use a discriminated union.
+     */
+    type: 'function';
+    /**
+  The name of the tool. Unique within this model call.
+     */
+    name: string;
+    /**
+  A description of the tool. The language model uses this to understand the
+  tool's purpose and to provide better completion suggestions.
+     */
+    description?: string;
+    /**
+  The parameters that the tool expects. The language model uses this to
+  understand the tool's input requirements and to provide matching suggestions.
+     */
+    parameters: JSONSchema7;
+};
+
 /**
 A prompt is a list of messages.
 
@@ -895,4 +843,4 @@ type LanguageModelV1StreamPart = {
 };
 type LanguageModelV1ResponseMetadata = {};
 
-export { APICallError, DownloadError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidArgumentError, InvalidDataContentError, InvalidPromptError, InvalidResponseDataError, InvalidToolArgumentsError, JSONParseError, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ResponseMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoObjectGeneratedError, NoSuchToolError, RetryError, type RetryErrorReason, TooManyEmbeddingValuesForCallError, ToolCallParseError, TypeValidationError, UnsupportedFunctionalityError, UnsupportedJSONSchemaError };
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1Prompt, type LanguageModelV1ResponseMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage };