@ai-sdk/provider-utils 5.0.0-beta.19 → 5.0.0-beta.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider-utils",
-  "version": "5.0.0-beta.19",
+  "version": "5.0.0-beta.20",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -33,8 +33,9 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
+    "@workflow/serde": "4.1.0",
     "eventsource-parser": "^3.0.6",
-    "@ai-sdk/provider": "4.0.0-beta.11"
+    "@ai-sdk/provider": "4.0.0-beta.12"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/index.ts

@@ -1,20 +1,16 @@
 export * from './combine-headers';
 export { convertAsyncIteratorToReadableStream } from './convert-async-iterator-to-readable-stream';
+export { convertImageModelFileToDataUri } from './convert-image-model-file-to-data-uri';
+export { convertToFormData } from './convert-to-form-data';
 export {
   createToolNameMapping,
   type ToolNameMapping,
 } from './create-tool-name-mapping';
 export * from './delay';
 export { DelayedPromise } from './delayed-promise';
-export * from './extract-response-headers';
-export { convertImageModelFileToDataUri } from './convert-image-model-file-to-data-uri';
-export { convertToFormData } from './convert-to-form-data';
 export { downloadBlob } from './download-blob';
 export { DownloadError } from './download-error';
-export {
-  readResponseWithSizeLimit,
-  DEFAULT_MAX_DOWNLOAD_SIZE,
-} from './read-response-with-size-limit';
+export * from './extract-response-headers';
 export * from './fetch-function';
 export { createIdGenerator, generateId, type IdGenerator } from './generate-id';
 export * from './get-error-message';
@@ -27,13 +23,13 @@ export { isNonNullable } from './is-non-nullable';
 export { isProviderReference } from './is-provider-reference';
 export { isUrlSupported } from './is-url-supported';
 export * from './load-api-key';
+export { loadOptionalSetting } from './load-optional-setting';
+export { loadSetting } from './load-setting';
 export {
   isCustomReasoning,
   mapReasoningToProviderBudget,
   mapReasoningToProviderEffort,
 } from './map-reasoning-to-provider';
-export { loadOptionalSetting } from './load-optional-setting';
-export { loadSetting } from './load-setting';
 export { type MaybePromiseLike } from './maybe-promise-like';
 export { mediaTypeToExtension } from './media-type-to-extension';
 export { normalizeHeaders } from './normalize-headers';
@@ -47,9 +43,13 @@ export {
   type ProviderToolFactory,
   type ProviderToolFactoryWithOutputSchema,
 } from './provider-tool-factory';
+export {
+  DEFAULT_MAX_DOWNLOAD_SIZE,
+  readResponseWithSizeLimit,
+} from './read-response-with-size-limit';
 export * from './remove-undefined-entries';
-export { resolveProviderReference } from './resolve-provider-reference';
 export * from './resolve';
+export { resolveProviderReference } from './resolve-provider-reference';
 export * from './response-handler';
 export {
   asSchema,
@@ -62,6 +62,7 @@ export {
   type Schema,
   type ValidationResult,
 } from './schema';
+export { serializeModelOptions } from './serialize-model-options';
 export { stripFileExtension } from './strip-file-extension';
 export * from './uint8-utils';
 export { validateDownloadUrl } from './validate-download-url';
@@ -75,6 +76,7 @@ export * from './types';
 
 // external re-exports
 export type * from '@standard-schema/spec';
+export { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
 export {
   EventSourceParserStream,
   type EventSourceMessage,

package/src/is-json-serializable.ts

@@ -0,0 +1,29 @@
+import { JSONValue } from '@ai-sdk/provider';
+
+/**
+ * Checks whether a value can cross a workflow serialization boundary.
+ *
+ * The check accepts JSON-like primitives, arrays, and plain objects whose
+ * nested values are also serializable. It rejects functions, symbols,
+ * bigints, and non-plain objects such as class instances, dates, and regexes.
+ */
+export function isJSONSerializable(value: unknown): value is JSONValue {
+  if (value === null || value === undefined) return true;
+
+  const type = typeof value;
+  if (type === 'string' || type === 'number' || type === 'boolean') return true;
+  if (type === 'function' || type === 'symbol' || type === 'bigint')
+    return false;
+
+  if (Array.isArray(value)) {
+    return value.every(isJSONSerializable);
+  }
+
+  if (Object.getPrototypeOf(value) === Object.prototype) {
+    return Object.values(value as Record<string, unknown>).every(
+      isJSONSerializable,
+    );
+  }
+
+  return false;
+}

package/src/resolve.ts

@@ -1,5 +1,20 @@
 import { MaybePromiseLike } from './maybe-promise-like';
 
+/**
+ * A value or a lazy provider of a value, each of which may be synchronous or asynchronous.
+ *
+ * @template T The resolved type after {@link resolve} runs.
+ *
+ * One of:
+ * - A plain value of type {@link T}
+ * - A {@link PromiseLike} of {@link T} (e.g. a `Promise<T>`)
+ * - A zero-argument function that returns a plain {@link T}
+ * - A zero-argument function that returns a {@link PromiseLike} of {@link T}
+ *
+ * The function form is only invoked when passed to {@link resolve}; it is not distinguished from
+ * a {@link T} that happens to be a function—callers should wrap function values if disambiguation
+ * is required.
+ */
 export type Resolvable<T> = MaybePromiseLike<T> | (() => MaybePromiseLike<T>);
 
 /**

package/src/serialize-model-options.ts

@@ -0,0 +1,63 @@
+import { JSONObject } from '@ai-sdk/provider';
+import { isJSONSerializable } from './is-json-serializable';
+import { Resolvable } from './resolve';
+
+/**
+ * Serializes a model instance for workflow step boundaries.
+ * Returns the `modelId` plus the JSON-serializable config properties.
+ *
+ * Non-serializable values are omitted. As a special case, a
+ * function-valued `headers` property is resolved during serialization
+ * and included if the returned value is JSON-serializable.
+ *
+ * Used as the body of `static [WORKFLOW_SERIALIZE]` in provider models.
+ *
+ * @example
+ * ```ts
+ * static [WORKFLOW_SERIALIZE](model: MyLanguageModel) {
+ *   return serializeModelOptions({
+ *     modelId: model.modelId,
+ *     config: model.config,
+ *   });
+ * }
+ * ```
+ */
+export function serializeModelOptions<
+  CONFIG extends {
+    headers?: Resolvable<Record<string, string | undefined>>;
+  },
+>(options: {
+  modelId: string;
+  config: CONFIG;
+}): {
+  modelId: string;
+  config: JSONObject;
+} {
+  const serializableConfig: JSONObject = {};
+  for (const [key, value] of Object.entries(options.config)) {
+    if (key === 'headers') {
+      const resolvedHeaders = resolveSync(value);
+      if (isJSONSerializable(resolvedHeaders)) {
+        serializableConfig[key] = resolvedHeaders;
+      }
+    } else if (isJSONSerializable(value)) {
+      serializableConfig[key] = value;
+    }
+  }
+  return { modelId: options.modelId, config: serializableConfig };
+}
+
+function resolveSync<T>(value: Resolvable<T>): T {
+  let next: unknown = value;
+  if (typeof value === 'function') {
+    next = (value as () => unknown)();
+  }
+
+  // the serialization for workflows currently only supports synchronous values
+  // TODO introduce SerializationError
+  if (next instanceof Promise) {
+    throw new Error('Promise returned from resolveSync');
+  }
+
+  return next as T;
+}

package/src/types/content-part.ts

@@ -325,6 +325,12 @@ export type ToolResultOutput =
              */
             url: string;
 
+            /**
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
+            mediaType?: string; // Temporarily optional. TODO: make required in v8, after migration period.
+
             /**
              * Provider-specific options.
              */
@@ -367,7 +373,7 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using base64 encoded data.
+             * @deprecated Use file-data instead.
              */
             type: 'image-data';
 
@@ -389,7 +395,7 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using a URL.
+             * @deprecated Use file-url instead.
              */
             type: 'image-url';
 
@@ -405,7 +411,7 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * @deprecated Use image-file-reference instead.
+             * @deprecated Use file-reference instead.
              */
             type: 'image-file-id';
 
@@ -426,7 +432,7 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using a provider reference.
+             * @deprecated Use file-reference instead.
              */
             type: 'image-file-reference';