@ai-sdk/provider-utils 2.2.8 → 3.0.0-alpha.1

package/CHANGELOG.md

@@ -1,38 +1,195 @@
 # @ai-sdk/provider-utils
 
-## 2.2.8
+## 3.0.0-alpha.1
 
 ### Patch Changes
 
-- d87b9d1: fix(provider-utils): fix SSE parser bug (CRLF)
+- Updated dependencies [3f2f00c]
+  - @ai-sdk/provider@2.0.0-alpha.1
 
-## 2.2.7
+## 3.0.0-canary.19
 
 ### Patch Changes
 
-- Updated dependencies [beef951]
-  - @ai-sdk/provider@1.1.3
+- faf8446: chore (provider-utils): switch to standard-schema
 
-## 2.2.6
+## 3.0.0-canary.18
+
+### Major Changes
+
+- 40acf9b: feat (ui): introduce ChatStore and ChatTransport
+
+## 3.0.0-canary.17
+
+### Major Changes
+
+- ea7a7c9: feat (ui): UI message metadata
+
+## 3.0.0-canary.16
+
+### Patch Changes
+
+- 87b828f: fix(provider-utils): fix SSE parser bug (CRLF)
+
+## 3.0.0-canary.15
+
+### Major Changes
+
+- 41fa418: chore (provider-utils): return IdGenerator interface
+
+### Patch Changes
+
+- a571d6e: chore(provider-utils): move ToolResultContent to provider-utils
+- Updated dependencies [a8c8bd5]
+- Updated dependencies [7979f7f]
+  - @ai-sdk/provider@2.0.0-canary.14
+
+## 3.0.0-canary.14
+
+### Major Changes
+
+- 957b739: chore (provider-utils): rename TestServerCall.requestBody to requestBodyJson
+
+### Patch Changes
+
+- Updated dependencies [9bd5ab5]
+  - @ai-sdk/provider@2.0.0-canary.13
+
+## 3.0.0-canary.13
+
+### Patch Changes
+
+- 0ff02bb: chore(provider-utils): move over jsonSchema
+- Updated dependencies [7b3ae3f]
+  - @ai-sdk/provider@2.0.0-canary.12
+
+## 3.0.0-canary.12
+
+### Patch Changes
+
+- Updated dependencies [9bf7291]
+- Updated dependencies [4617fab]
+- Updated dependencies [e030615]
+  - @ai-sdk/provider@2.0.0-canary.11
+
+## 3.0.0-canary.11
+
+### Patch Changes
+
+- 66962ed: fix(packages): export node10 compatible types
+- Updated dependencies [9301f86]
+- Updated dependencies [a3f768e]
+  - @ai-sdk/provider@2.0.0-canary.10
+
+## 3.0.0-canary.10
 
 ### Patch Changes
 
-- Updated dependencies [013faa8]
-  - @ai-sdk/provider@1.1.2
+- Updated dependencies [e86be6f]
+  - @ai-sdk/provider@2.0.0-canary.9
 
-## 2.2.5
+## 3.0.0-canary.9
 
 ### Patch Changes
 
-- c21fa6d: feat: add transcription with experimental_transcribe
-- Updated dependencies [c21fa6d]
-  - @ai-sdk/provider@1.1.1
+- Updated dependencies [95857aa]
+- Updated dependencies [7ea4132]
+  - @ai-sdk/provider@2.0.0-canary.8
+
+## 3.0.0-canary.8
+
+### Major Changes
+
+- 5d142ab: remove deprecated `CoreToolCall` and `CoreToolResult` types
+
+### Patch Changes
+
+- Updated dependencies [b6b43c7]
+- Updated dependencies [8aa9e20]
+- Updated dependencies [3795467]
+  - @ai-sdk/provider@2.0.0-canary.7
+
+## 3.0.0-canary.7
+
+### Patch Changes
+
+- Updated dependencies [26735b5]
+- Updated dependencies [443d8ec]
+- Updated dependencies [14c9410]
+- Updated dependencies [d9c98f4]
+- Updated dependencies [c4a2fec]
+- Updated dependencies [0054544]
+- Updated dependencies [9e9c809]
+- Updated dependencies [32831c6]
+- Updated dependencies [d0f9495]
+- Updated dependencies [fd65bc6]
+- Updated dependencies [393138b]
+- Updated dependencies [7182d14]
+  - @ai-sdk/provider@2.0.0-canary.6
+
+## 3.0.0-canary.6
+
+### Patch Changes
+
+- Updated dependencies [411e483]
+- Updated dependencies [79457bd]
+- Updated dependencies [ad80501]
+- Updated dependencies [1766ede]
+- Updated dependencies [f10304b]
+  - @ai-sdk/provider@2.0.0-canary.5
+
+## 3.0.0-canary.5
+
+### Patch Changes
+
+- Updated dependencies [6f6bb89]
+  - @ai-sdk/provider@2.0.0-canary.4
+
+## 3.0.0-canary.4
+
+### Patch Changes
+
+- Updated dependencies [d1a1aa1]
+  - @ai-sdk/provider@2.0.0-canary.3
+
+## 3.0.0-canary.3
+
+### Patch Changes
+
+- a166433: feat: add transcription with experimental_transcribe
+- 9f95b35: refactor (provider-utils): copy relevant code from `secure-json-parse` into codebase
+- Updated dependencies [a166433]
+- Updated dependencies [abf9a79]
+- Updated dependencies [0a87932]
+- Updated dependencies [6dc848c]
+  - @ai-sdk/provider@2.0.0-canary.2
+
+## 3.0.0-canary.2
+
+### Patch Changes
+
+- Updated dependencies [c57e248]
+- Updated dependencies [33f4a6a]
+  - @ai-sdk/provider@2.0.0-canary.1
+
+## 3.0.0-canary.1
+
+### Patch Changes
+
+- 060370c: feat(provider-utils): add TestServerCall#requestCredentials
+- 0c0c0b3: refactor (provider-utils): move `customAlphabet()` method from `nanoid` into codebase
+- 63d791d: chore (utils): remove unused test helpers
+
+## 3.0.0-canary.0
+
+### Major Changes
 
-## 2.2.4
+- d5f588f: AI SDK 5
 
 ### Patch Changes
 
-- 2c19b9a: feat(provider-utils): add TestServerCall#requestCredentials
+- Updated dependencies [d5f588f]
+  - @ai-sdk/provider@2.0.0-canary.0
 
 ## 2.2.3
 

package/dist/index.d.mts

@@ -1,5 +1,7 @@
-import { JSONValue, JSONParseError, TypeValidationError, APICallError } from '@ai-sdk/provider';
-import { z, ZodSchema } from 'zod';
+import { JSONValue, JSONParseError, TypeValidationError, APICallError, JSONSchema7 } from '@ai-sdk/provider';
+import { ZodSchema, z } from 'zod';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+export * from '@standard-schema/spec';
 
 declare function combineHeaders(...headers: Array<Record<string, string | undefined> | undefined>): Record<string, string | undefined>;
 
@@ -43,29 +45,28 @@ type FetchFunction = typeof globalThis.fetch;
 /**
 Creates an ID generator.
 The total length of the ID is the sum of the prefix, separator, and random part length.
-Non-secure.
+Not cryptographically secure.
 
 @param alphabet - The alphabet to use for the ID. Default: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.
-@param prefix - The prefix of the ID to generate. Default: ''.
+@param prefix - The prefix of the ID to generate. Optional.
 @param separator - The separator between the prefix and the random part of the ID. Default: '-'.
 @param size - The size of the random part of the ID to generate. Default: 16.
  */
-declare const createIdGenerator: ({ prefix, size: defaultSize, alphabet, separator, }?: {
+declare const createIdGenerator: ({ prefix, size, alphabet, separator, }?: {
     prefix?: string;
     separator?: string;
     size?: number;
     alphabet?: string;
-}) => ((size?: number) => string);
+}) => IdGenerator;
 /**
 A function that generates an ID.
  */
-type IDGenerator = () => string;
+type IdGenerator = () => string;
 /**
-Generates a 16-character random string to use for IDs. Not secure.
-
-@param size - The size of the ID to generate. Default: 16.
+Generates a 16-character random string to use for IDs.
+Not cryptographically secure.
  */
-declare const generateId: (size?: number) => string;
+declare const generateId: IdGenerator;
 
 declare function getErrorMessage(error: unknown | undefined): string;
 
@@ -89,17 +90,17 @@ type Validator<OBJECT = unknown> = {
      * Optional. Validates that the structure of a value matches this schema,
      * and returns a typed version of the value if it does.
      */
-    readonly validate?: (value: unknown) => ValidationResult<OBJECT>;
+    readonly validate?: (value: unknown) => ValidationResult<OBJECT> | PromiseLike<ValidationResult<OBJECT>>;
 };
 /**
  * Create a validator.
  *
  * @param validate A validation function for the schema.
  */
-declare function validator<OBJECT>(validate?: undefined | ((value: unknown) => ValidationResult<OBJECT>)): Validator<OBJECT>;
+declare function validator<OBJECT>(validate?: undefined | ((value: unknown) => ValidationResult<OBJECT> | PromiseLike<ValidationResult<OBJECT>>)): Validator<OBJECT>;
 declare function isValidator(value: unknown): value is Validator;
-declare function asValidator<OBJECT>(value: Validator<OBJECT> | z.Schema<OBJECT, z.ZodTypeDef, any>): Validator<OBJECT>;
-declare function zodValidator<OBJECT>(zodSchema: z.Schema<OBJECT, z.ZodTypeDef, any>): Validator<OBJECT>;
+declare function asValidator<OBJECT>(value: Validator<OBJECT> | StandardSchemaV1<OBJECT>): Validator<OBJECT>;
+declare function standardSchemaValidator<OBJECT>(standardSchema: StandardSchemaV1<OBJECT>): Validator<OBJECT>;
 
 /**
  * Parses a JSON string into an unknown object.
@@ -110,19 +111,19 @@ declare function zodValidator<OBJECT>(zodSchema: z.Schema<OBJECT, z.ZodTypeDef,
 declare function parseJSON(options: {
     text: string;
     schema?: undefined;
-}): JSONValue;
+}): Promise<JSONValue>;
 /**
  * Parses a JSON string into a strongly-typed object using the provided schema.
  *
  * @template T - The type of the object to parse the JSON into.
  * @param {string} text - The JSON string to parse.
  * @param {Validator<T>} schema - The schema to use for parsing the JSON.
- * @returns {T} - The parsed object.
+ * @returns {Promise<T>} - The parsed object.
  */
 declare function parseJSON<T>(options: {
     text: string;
     schema: ZodSchema<T> | Validator<T>;
-}): T;
+}): Promise<T>;
 type ParseResult<T> = {
     success: true;
     value: T;
@@ -130,17 +131,18 @@ type ParseResult<T> = {
 } | {
     success: false;
     error: JSONParseError | TypeValidationError;
+    rawValue: unknown;
 };
 /**
  * Safely parses a JSON string and returns the result as an object of type `unknown`.
  *
  * @param text - The JSON string to parse.
- * @returns {object} Either an object with `success: true` and the parsed data, or an object with `success: false` and the error that occurred.
+ * @returns {Promise<object>} Either an object with `success: true` and the parsed data, or an object with `success: false` and the error that occurred.
  */
 declare function safeParseJSON(options: {
     text: string;
     schema?: undefined;
-}): ParseResult<JSONValue>;
+}): Promise<ParseResult<JSONValue>>;
 /**
  * Safely parses a JSON string into a strongly-typed object, using a provided schema to validate the object.
  *
@@ -152,7 +154,7 @@ declare function safeParseJSON(options: {
 declare function safeParseJSON<T>(options: {
     text: string;
     schema: ZodSchema<T> | Validator<T>;
-}): ParseResult<T>;
+}): Promise<ParseResult<T>>;
 declare function isParsableJson(input: string): boolean;
 
 type ResponseHandler<RETURN_TYPE> = (options: {
@@ -190,6 +192,23 @@ declare const getFromApi: <T>({ url, headers, successfulResponseHandler, failedR
 
 declare function isAbortError(error: unknown): error is Error;
 
+/**
+ * Checks if the given URL is supported natively by the model.
+ *
+ * @param mediaType - The media type of the URL. Case-sensitive.
+ * @param url - The URL to check.
+ * @param supportedUrls - A record where keys are case-sensitive media types (or '*')
+ *                        and values are arrays of RegExp patterns for URLs.
+ *
+ * @returns `true` if the URL matches a pattern under the specific media type
+ *          or the wildcard '*', `false` otherwise.
+ */
+declare function isUrlSupported({ mediaType, url, supportedUrls, }: {
+    mediaType: string;
+    url: string;
+    supportedUrls: Record<string, RegExp[]>;
+}): boolean;
+
 declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
     apiKey: string | undefined;
     environmentVariableName: string;
@@ -225,11 +244,19 @@ declare function loadSetting({ settingValue, environmentVariableName, settingNam
     description: string;
 }): string;
 
+/**
+ * Parses a JSON event stream into a stream of parsed JSON objects.
+ */
+declare function parseJsonEventStream<T>({ stream, schema, }: {
+    stream: ReadableStream<Uint8Array>;
+    schema: ZodSchema<T>;
+}): ReadableStream<ParseResult<T>>;
+
 declare function parseProviderOptions<T>({ provider, providerOptions, schema, }: {
     provider: string;
     providerOptions: Record<string, unknown> | undefined;
     schema: z.ZodSchema<T>;
-}): T | undefined;
+}): Promise<T | undefined>;
 
 declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, successfulResponseHandler, abortSignal, fetch, }: {
     url: string;
@@ -288,43 +315,40 @@ type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
  */
 declare function resolve<T>(value: Resolvable<T>): Promise<T>;
 
-declare function convertBase64ToUint8Array(base64String: string): Uint8Array;
-declare function convertUint8ArrayToBase64(array: Uint8Array): string;
-
 /**
- * Validates the types of an unknown object using a schema and
- * return a strongly-typed object.
- *
- * @template T - The type of the object to validate.
- * @param {string} options.value - The object to validate.
- * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
- * @returns {T} - The typed object.
+ * Used to mark schemas so we can support both Zod and custom schemas.
  */
-declare function validateTypes<T>({ value, schema: inputSchema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): T;
+declare const schemaSymbol: unique symbol;
+type Schema<OBJECT = unknown> = Validator<OBJECT> & {
+    /**
+     * Used to mark schemas so we can support both Zod and custom schemas.
+     */
+    [schemaSymbol]: true;
+    /**
+     * Schema type for inference.
+     */
+    _type: OBJECT;
+    /**
+     * The JSON Schema for the schema. It is passed to the providers.
+     */
+    readonly jsonSchema: JSONSchema7;
+};
 /**
- * Safely validates the types of an unknown object using a schema and
- * return a strongly-typed object.
+ * Create a schema using a JSON Schema.
  *
- * @template T - The type of the object to validate.
- * @param {string} options.value - The JSON object to validate.
- * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
- * @returns An object with either a `success` flag and the parsed and typed data, or a `success` flag and an error object.
+ * @param jsonSchema The JSON Schema for the schema.
+ * @param options.validate Optional. A validation function for the schema.
  */
-declare function safeValidateTypes<T>({ value, schema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): {
-    success: true;
-    value: T;
-} | {
-    success: false;
-    error: TypeValidationError;
-};
-
-declare function withoutTrailingSlash(url: string | undefined): string | undefined;
+declare function jsonSchema<OBJECT = unknown>(jsonSchema: JSONSchema7, { validate, }?: {
+    validate?: (value: unknown) => {
+        success: true;
+        value: OBJECT;
+    } | {
+        success: false;
+        error: Error;
+    };
+}): Schema<OBJECT>;
+declare function asSchema<OBJECT>(schema: z.Schema<OBJECT, z.ZodTypeDef, any> | Schema<OBJECT> | undefined): Schema<OBJECT>;
 
 /**
 Typed tool call that is returned by generateText and streamText.
@@ -344,10 +368,6 @@ interface ToolCall<NAME extends string, ARGS> {
      */
     args: ARGS;
 }
-/**
- * @deprecated Use `ToolCall` instead.
- */
-type CoreToolCall<NAME extends string, ARGS> = ToolCall<NAME, ARGS>;
 
 /**
 Typed tool result that is returned by `generateText` and `streamText`.
@@ -371,9 +391,68 @@ interface ToolResult<NAME extends string, ARGS, RESULT> {
        */
     result: RESULT;
 }
+type ToolResultContent = Array<{
+    type: 'text';
+    text: string;
+} | {
+    type: 'image';
+    data: string;
+    mediaType?: string;
+    /**
+     * @deprecated Use `mediaType` instead.
+     */
+    mimeType?: string;
+}>;
+
+declare function convertBase64ToUint8Array(base64String: string): Uint8Array<ArrayBuffer>;
+declare function convertUint8ArrayToBase64(array: Uint8Array): string;
+declare function convertToBase64(value: string | Uint8Array): string;
+
+/**
+ * Validates the types of an unknown object using a schema and
+ * return a strongly-typed object.
+ *
+ * @template T - The type of the object to validate.
+ * @param {string} options.value - The object to validate.
+ * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
+ * @returns {Promise<T>} - The typed object.
+ */
+declare function validateTypes<OBJECT>({ value, schema, }: {
+    value: unknown;
+    schema: StandardSchemaV1<OBJECT> | Validator<OBJECT>;
+}): Promise<OBJECT>;
 /**
- * @deprecated Use `ToolResult` instead.
+ * Safely validates the types of an unknown object using a schema and
+ * return a strongly-typed object.
+ *
+ * @template T - The type of the object to validate.
+ * @param {string} options.value - The JSON object to validate.
+ * @param {Validator<T>} options.schema - The schema to use for validating the JSON.
+ * @returns An object with either a `success` flag and the parsed and typed data, or a `success` flag and an error object.
  */
-type CoreToolResult<NAME extends string, ARGS, RESULT> = ToolResult<NAME, ARGS, RESULT>;
+declare function safeValidateTypes<OBJECT>({ value, schema, }: {
+    value: unknown;
+    schema: StandardSchemaV1<OBJECT> | Validator<OBJECT>;
+}): Promise<{
+    success: true;
+    value: OBJECT;
+    rawValue: unknown;
+} | {
+    success: false;
+    error: TypeValidationError;
+    rawValue: unknown;
+}>;
+
+declare function withoutTrailingSlash(url: string | undefined): string | undefined;
+
+declare function zodSchema<OBJECT>(zodSchema: z.Schema<OBJECT, z.ZodTypeDef, any>, options?: {
+    /**
+     * Enables support for references in the schema.
+     * This is required for recursive schemas, e.g. with `z.lazy`.
+     * However, not all language models and providers support such references.
+     * Defaults to `false`.
+     */
+    useReferences?: boolean;
+}): Schema<OBJECT>;
 
-export { type CoreToolCall, type CoreToolResult, type EventSourceChunk, type FetchFunction, type IDGenerator, type ParseResult, type Resolvable, type ResponseHandler, type ToolCall, type ToolResult, type ValidationResult, type Validator, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceParserStream, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createStatusCodeErrorResponseHandler, delay, extractResponseHeaders, generateId, getErrorMessage, getFromApi, isAbortError, isParsableJson, isValidator, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodValidator };
+export { type EventSourceChunk, type FetchFunction, type IdGenerator, type ParseResult, type Resolvable, type ResponseHandler, type Schema, type ToolCall, type ToolResult, type ToolResultContent, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceParserStream, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createStatusCodeErrorResponseHandler, delay, extractResponseHeaders, generateId, getErrorMessage, getFromApi, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema };