@ai-sdk/provider-utils 3.0.0-canary.16 → 3.0.0-canary.18

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider-utils
 
+## 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

package/dist/index.d.mts

@@ -129,6 +129,7 @@ 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`.
@@ -241,6 +242,14 @@ 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;
@@ -304,45 +313,6 @@ type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
  */
 declare function resolve<T>(value: Resolvable<T>): Promise<T>;
 
-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<T>({ value, schema: inputSchema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): Promise<T>;
-/**
- * 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.
- */
-declare function safeValidateTypes<T>({ value, schema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): Promise<{
-    success: true;
-    value: T;
-} | {
-    success: false;
-    error: TypeValidationError;
-}>;
-
-declare function withoutTrailingSlash(url: string | undefined): string | undefined;
-
 /**
  * Used to mark schemas so we can support both Zod and custom schemas.
  */
@@ -378,16 +348,6 @@ declare function jsonSchema<OBJECT = unknown>(jsonSchema: JSONSchema7, { validat
 }): Schema<OBJECT>;
 declare function asSchema<OBJECT>(schema: z.Schema<OBJECT, z.ZodTypeDef, any> | Schema<OBJECT> | undefined): Schema<OBJECT>;
 
-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>;
-
 /**
 Typed tool call that is returned by generateText and streamText.
 It contains the tool call ID, the tool name, and the tool arguments.
@@ -442,4 +402,55 @@ type ToolResultContent = Array<{
     mimeType?: string;
 }>;
 
-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, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema, zodValidator };
+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<T>({ value, schema: inputSchema, }: {
+    value: unknown;
+    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
+}): Promise<T>;
+/**
+ * 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.
+ */
+declare function safeValidateTypes<T>({ value, schema, }: {
+    value: unknown;
+    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
+}): Promise<{
+    success: true;
+    value: T;
+    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 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, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema, zodValidator };

package/dist/index.d.ts

@@ -129,6 +129,7 @@ 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`.
@@ -241,6 +242,14 @@ 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;
@@ -304,45 +313,6 @@ type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
  */
 declare function resolve<T>(value: Resolvable<T>): Promise<T>;
 
-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<T>({ value, schema: inputSchema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): Promise<T>;
-/**
- * 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.
- */
-declare function safeValidateTypes<T>({ value, schema, }: {
-    value: unknown;
-    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
-}): Promise<{
-    success: true;
-    value: T;
-} | {
-    success: false;
-    error: TypeValidationError;
-}>;
-
-declare function withoutTrailingSlash(url: string | undefined): string | undefined;
-
 /**
  * Used to mark schemas so we can support both Zod and custom schemas.
  */
@@ -378,16 +348,6 @@ declare function jsonSchema<OBJECT = unknown>(jsonSchema: JSONSchema7, { validat
 }): Schema<OBJECT>;
 declare function asSchema<OBJECT>(schema: z.Schema<OBJECT, z.ZodTypeDef, any> | Schema<OBJECT> | undefined): Schema<OBJECT>;
 
-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>;
-
 /**
 Typed tool call that is returned by generateText and streamText.
 It contains the tool call ID, the tool name, and the tool arguments.
@@ -442,4 +402,55 @@ type ToolResultContent = Array<{
     mimeType?: string;
 }>;
 
-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, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema, zodValidator };
+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<T>({ value, schema: inputSchema, }: {
+    value: unknown;
+    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
+}): Promise<T>;
+/**
+ * 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.
+ */
+declare function safeValidateTypes<T>({ value, schema, }: {
+    value: unknown;
+    schema: z.Schema<T, z.ZodTypeDef, any> | Validator<T>;
+}): Promise<{
+    success: true;
+    value: T;
+    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 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, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema, zodValidator };

package/dist/index.js

@@ -59,6 +59,7 @@ __export(src_exports, {
   loadOptionalSetting: () => loadOptionalSetting,
   loadSetting: () => loadSetting,
   parseJSON: () => parseJSON,
+  parseJsonEventStream: () => parseJsonEventStream,
   parseProviderOptions: () => parseProviderOptions,
   postFormDataToApi: () => postFormDataToApi,
   postJsonToApi: () => postJsonToApi,
@@ -550,20 +551,22 @@ async function safeValidateTypes({
   const validator2 = asValidator(schema);
   try {
     if (validator2.validate == null) {
-      return { success: true, value };
+      return { success: true, value, rawValue: value };
     }
     const result = validator2.validate(value);
     if (result.success) {
-      return result;
+      return { success: true, value: result.value, rawValue: value };
     }
     return {
       success: false,
-      error: import_provider5.TypeValidationError.wrap({ value, cause: result.error })
+      error: import_provider5.TypeValidationError.wrap({ value, cause: result.error }),
+      rawValue: value
     };
   } catch (error) {
     return {
       success: false,
-      error: import_provider5.TypeValidationError.wrap({ value, cause: error })
+      error: import_provider5.TypeValidationError.wrap({ value, cause: error }),
+      rawValue: value
     };
   }
 }
@@ -595,12 +598,12 @@ async function safeParseJSON({
     if (schema == null) {
       return { success: true, value, rawValue: value };
     }
-    const validationResult = await safeValidateTypes({ value, schema });
-    return validationResult.success ? { ...validationResult, rawValue: value } : validationResult;
+    return await safeValidateTypes({ value, schema });
   } catch (error) {
     return {
       success: false,
-      error: import_provider6.JSONParseError.isInstance(error) ? error : new import_provider6.JSONParseError({ text, cause: error })
+      error: import_provider6.JSONParseError.isInstance(error) ? error : new import_provider6.JSONParseError({ text, cause: error }),
+      rawValue: void 0
     };
   }
 }
@@ -613,6 +616,23 @@ function isParsableJson(input) {
   }
 }
 
+// src/parse-json-event-stream.ts
+function parseJsonEventStream({
+  stream,
+  schema
+}) {
+  return stream.pipeThrough(new TextDecoderStream()).pipeThrough(createEventSourceParserStream()).pipeThrough(
+    new TransformStream({
+      async transform({ data }, controller) {
+        if (data === "[DONE]") {
+          return;
+        }
+        controller.enqueue(await safeParseJSON({ text: data, schema }));
+      }
+    })
+  );
+}
+
 // src/parse-provider-options.ts
 var import_provider7 = require("@ai-sdk/provider");
 async function parseProviderOptions({
@@ -836,21 +856,10 @@ var createEventSourceResponseHandler = (chunkSchema) => async ({ response }) =>
   }
   return {
     responseHeaders,
-    value: response.body.pipeThrough(new TextDecoderStream()).pipeThrough(createEventSourceParserStream()).pipeThrough(
-      new TransformStream({
-        async transform({ data }, controller) {
-          if (data === "[DONE]") {
-            return;
-          }
-          controller.enqueue(
-            await safeParseJSON({
-              text: data,
-              schema: chunkSchema
-            })
-          );
-        }
-      })
-    )
+    value: parseJsonEventStream({
+      stream: response.body,
+      schema: chunkSchema
+    })
   };
 };
 var createJsonStreamResponseHandler = (chunkSchema) => async ({ response }) => {
@@ -950,29 +959,6 @@ var createStatusCodeErrorResponseHandler = () => async ({ response, url, request
   };
 };
 
-// src/uint8-utils.ts
-var { btoa, atob } = globalThis;
-function convertBase64ToUint8Array(base64String) {
-  const base64Url = base64String.replace(/-/g, "+").replace(/_/g, "/");
-  const latin1string = atob(base64Url);
-  return Uint8Array.from(latin1string, (byte) => byte.codePointAt(0));
-}
-function convertUint8ArrayToBase64(array) {
-  let latin1string = "";
-  for (let i = 0; i < array.length; i++) {
-    latin1string += String.fromCodePoint(array[i]);
-  }
-  return btoa(latin1string);
-}
-function convertToBase64(value) {
-  return value instanceof Uint8Array ? convertUint8ArrayToBase64(value) : value;
-}
-
-// src/without-trailing-slash.ts
-function withoutTrailingSlash(url) {
-  return url == null ? void 0 : url.replace(/\/$/, "");
-}
-
 // src/zod-schema.ts
 var import_zod_to_json_schema = __toESM(require("zod-to-json-schema"));
 function zodSchema(zodSchema2, options) {
@@ -1016,6 +1002,29 @@ function asSchema(schema) {
     additionalProperties: false
   }) : isSchema(schema) ? schema : zodSchema(schema);
 }
+
+// src/uint8-utils.ts
+var { btoa, atob } = globalThis;
+function convertBase64ToUint8Array(base64String) {
+  const base64Url = base64String.replace(/-/g, "+").replace(/_/g, "/");
+  const latin1string = atob(base64Url);
+  return Uint8Array.from(latin1string, (byte) => byte.codePointAt(0));
+}
+function convertUint8ArrayToBase64(array) {
+  let latin1string = "";
+  for (let i = 0; i < array.length; i++) {
+    latin1string += String.fromCodePoint(array[i]);
+  }
+  return btoa(latin1string);
+}
+function convertToBase64(value) {
+  return value instanceof Uint8Array ? convertUint8ArrayToBase64(value) : value;
+}
+
+// src/without-trailing-slash.ts
+function withoutTrailingSlash(url) {
+  return url == null ? void 0 : url.replace(/\/$/, "");
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   asSchema,
@@ -1047,6 +1056,7 @@ function asSchema(schema) {
   loadOptionalSetting,
   loadSetting,
   parseJSON,
+  parseJsonEventStream,
   parseProviderOptions,
   postFormDataToApi,
   postJsonToApi,