@ai-sdk/topaz 2.0.0 → 3.0.1

package/src/topaz-image-model.ts

@@ -2,9 +2,10 @@ import {
   AISDKError,
   InvalidArgumentError,
   InvalidResponseDataError,
-  type ImageModelV3,
-  type ImageModelV3CallOptions,
-  type SharedV3Warning,
+  type ImageModelV4,
+  type ImageModelV4CallOptions,
+  type ImageModelV4Result,
+  type SharedV4Warning,
 } from '@ai-sdk/provider';
 import {
   combineHeaders,
@@ -12,16 +13,19 @@ import {
   createBinaryResponseHandler,
   createJsonResponseHandler,
   delay,
+  getFromApi,
   mediaTypeToExtension,
   parseProviderOptions,
   postFormDataToApi,
   removeUndefinedEntries,
   resolve,
+  serializeModelOptions,
+  WORKFLOW_DESERIALIZE,
+  WORKFLOW_SERIALIZE,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import type { TopazConfig } from './topaz-config';
 import { topazFailedResponseHandler } from './topaz-error';
-import { topazGetFromApi } from './topaz-get-from-api';
 import {
   topazImageModelOptionsSchema,
   type TopazImageModelOptions,
@@ -38,8 +42,8 @@ const DEFAULT_POLL_TIMEOUT_MILLIS = 600_000;
  * Topaz enhances an image that the caller supplies, so `files` is required and
  * exactly one image is processed per call.
  */
-export class TopazImageModel implements ImageModelV3 {
-  readonly specificationVersion = 'v3';
+export class TopazImageModel implements ImageModelV4 {
+  readonly specificationVersion = 'v4';
   readonly maxImagesPerCall = 1;
   readonly supportsFileInputs = true;
   readonly supportsMaskInputs = false;
@@ -48,16 +52,30 @@ export class TopazImageModel implements ImageModelV3 {
     return this.config.provider;
   }
 
+  static [WORKFLOW_SERIALIZE](model: TopazImageModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: TopazImageModelId;
+    config: TopazConfig;
+  }) {
+    return new TopazImageModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: TopazImageModelId,
     private readonly config: TopazConfig,
   ) {}
 
   async doGenerate(
-    options: ImageModelV3CallOptions,
-  ): Promise<Awaited<ReturnType<ImageModelV3['doGenerate']>>> {
+    options: ImageModelV4CallOptions,
+  ): Promise<ImageModelV4Result> {
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
-    const warnings: SharedV3Warning[] = [];
+    const warnings: SharedV4Warning[] = [];
 
     const topazOptions = await parseProviderOptions({
       provider: 'topaz',
@@ -151,8 +169,8 @@ export class TopazImageModel implements ImageModelV3 {
   }
 
   private addUnsupportedWarnings(
-    options: ImageModelV3CallOptions,
-    warnings: SharedV3Warning[],
+    options: ImageModelV4CallOptions,
+    warnings: SharedV4Warning[],
   ): void {
     if (options.prompt != null) {
       warnings.push({
@@ -202,9 +220,9 @@ export class TopazImageModel implements ImageModelV3 {
   }
 
   private async buildFormData(
-    options: ImageModelV3CallOptions,
+    options: ImageModelV4CallOptions,
     topazOptions: TopazImageModelOptions | undefined,
-    warnings: SharedV3Warning[],
+    warnings: SharedV4Warning[],
   ): Promise<FormData> {
     const file = options.files?.[0];
 
@@ -298,7 +316,7 @@ export class TopazImageModel implements ImageModelV3 {
     const deadline = Date.now() + pollTimeoutMillis;
 
     while (true) {
-      const { value: status } = await topazGetFromApi({
+      const { value: status } = await getFromApi({
         url: `${this.config.baseURL}/image/v1/status/${processId}`,
         // Built from the configured baseURL, not from response data.
         validateUrl: false,
@@ -367,7 +385,7 @@ export class TopazImageModel implements ImageModelV3 {
     image: Uint8Array;
     responseHeaders: Record<string, string> | undefined;
   }> {
-    const { value: downloadResponse } = await topazGetFromApi({
+    const { value: downloadResponse } = await getFromApi({
       url: `${this.config.baseURL}/image/v1/download/${processId}`,
       // Built from the configured baseURL, not from response data.
       validateUrl: false,
@@ -388,7 +406,7 @@ export class TopazImageModel implements ImageModelV3 {
       });
     }
 
-    const { value: image, responseHeaders } = await topazGetFromApi({
+    const { value: image, responseHeaders } = await getFromApi({
       url: downloadUrl,
       // Comes from the Topaz response body and normally points at object
       // storage, so it is validated and the API key is withheld off-origin.

package/src/topaz-provider.ts

@@ -1,8 +1,8 @@
 import {
   NoSuchModelError,
-  type Experimental_VideoModelV3 as VideoModelV3,
-  type ImageModelV3,
-  type ProviderV3,
+  type Experimental_VideoModelV4 as VideoModelV4,
+  type ImageModelV4,
+  type ProviderV4,
 } from '@ai-sdk/provider';
 import {
   loadApiKey,
@@ -42,26 +42,26 @@ export interface TopazProviderSettings {
   fetch?: FetchFunction;
 }
 
-export interface TopazProvider extends ProviderV3 {
+export interface TopazProvider extends ProviderV4 {
   /**
    * Creates a model for image enhancement.
    */
-  image(modelId: TopazImageModelId): ImageModelV3;
+  image(modelId: TopazImageModelId): ImageModelV4;
 
   /**
    * Creates a model for image enhancement.
    */
-  imageModel(modelId: TopazImageModelId): ImageModelV3;
+  imageModel(modelId: TopazImageModelId): ImageModelV4;
 
   /**
    * Creates a model for video enhancement.
    */
-  video(modelId: TopazVideoModelId): VideoModelV3;
+  video(modelId: TopazVideoModelId): VideoModelV4;
 
   /**
    * Creates a model for video enhancement.
    */
-  videoModel(modelId: TopazVideoModelId): VideoModelV3;
+  videoModel(modelId: TopazVideoModelId): VideoModelV4;
 }
 
 const defaultBaseURL = 'https://api.topazlabs.com';
@@ -89,7 +89,7 @@ export function createTopaz(
       `ai-sdk-topaz/${VERSION}`,
     );
 
-  const createImageModel = (modelId: TopazImageModelId): ImageModelV3 =>
+  const createImageModel = (modelId: TopazImageModelId): ImageModelV4 =>
     new TopazImageModel(modelId, {
       provider: 'topaz.image',
       baseURL,
@@ -97,7 +97,7 @@ export function createTopaz(
       fetch: options.fetch,
     });
 
-  const createVideoModel = (modelId: TopazVideoModelId): VideoModelV3 =>
+  const createVideoModel = (modelId: TopazVideoModelId): VideoModelV4 =>
     new TopazVideoModel(modelId, {
       provider: 'topaz.video',
       baseURL,
@@ -118,7 +118,7 @@ export function createTopaz(
   };
 
   const provider: TopazProvider = {
-    specificationVersion: 'v3' as const,
+    specificationVersion: 'v4' as const,
     image: createImageModel,
     imageModel: createImageModel,
     video: createVideoModel,

package/src/topaz-video-model-options.ts

@@ -175,10 +175,6 @@ export type TopazVideoOutput = z.infer<typeof topazVideoOutputSchema>;
 export const topazVideoModelOptionsSchema = lazySchema(() =>
   zodSchema(
     z.object({
-      /** Interval between status polls, in milliseconds. Defaults to 2000. */
-      pollIntervalMillis: z.number().positive().optional(),
-      /** Maximum time to poll, in milliseconds. Defaults to 3600000 (1 hour). */
-      pollTimeoutMillis: z.number().positive().optional(),
       source: topazVideoSourceSchema.optional(),
       output: topazVideoOutputSchema.optional(),
 
@@ -280,8 +276,6 @@ export type TopazVideoModelOptions = InferSchema<
  * forwarded into the `filters[]` entry.
  */
 export const TOPAZ_NON_FILTER_OPTION_KEYS = [
-  'pollIntervalMillis',
-  'pollTimeoutMillis',
   'source',
   'output',
   'additionalFilters',

package/src/topaz-video-model.ts

@@ -1,29 +1,32 @@
 import {
-  AISDKError,
   APICallError,
   InvalidArgumentError,
   InvalidResponseDataError,
-  type Experimental_VideoModelV3 as VideoModelV3,
-  type Experimental_VideoModelV3File as VideoModelV3File,
-  type SharedV3Warning,
+  type Experimental_VideoModelV4 as VideoModelV4,
+  type Experimental_VideoModelV4File as VideoModelV4File,
+  type Experimental_VideoModelV4OperationStartResult as VideoModelV4OperationStartResult,
+  type Experimental_VideoModelV4OperationStatusResult as VideoModelV4OperationStatusResult,
+  type SharedV4Warning,
 } from '@ai-sdk/provider';
 import {
   combineHeaders,
   convertBase64ToUint8Array,
   createJsonResponseHandler,
-  delay,
+  getFromApi,
   isSameOrigin,
   parseProviderOptions,
   postJsonToApi,
   removeUndefinedEntries,
   resolve,
+  serializeModelOptions,
   validateDownloadUrl,
   withUserAgentSuffix,
+  WORKFLOW_DESERIALIZE,
+  WORKFLOW_SERIALIZE,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import type { TopazConfig } from './topaz-config';
 import { topazFailedResponseHandler } from './topaz-error';
-import { topazGetFromApi } from './topaz-get-from-api';
 import {
   TOPAZ_NON_FILTER_OPTION_KEYS,
   type topazOutputContainers,
@@ -37,12 +40,6 @@ import {
 } from './topaz-video-settings';
 import { VERSION } from './version';
 
-type VideoModelResult = Awaited<ReturnType<VideoModelV3['doGenerate']>>;
-type TopazVideoOperation = { requestId: string; outputContainer: string };
-
-const DEFAULT_POLL_INTERVAL_MILLIS = 2000;
-const DEFAULT_POLL_TIMEOUT_MILLIS = 3_600_000;
-
 type TopazSourceContainer = (typeof topazSourceContainers)[number];
 type TopazOutputContainer = (typeof topazOutputContainers)[number];
 
@@ -87,91 +84,42 @@ const containerMediaTypes: Record<string, string> = {
 
 /**
  * Topaz video models enhance a video the caller supplies, passed through
- * `inputReferences`. `doGenerate` creates an express request: Topaz fetches URL
+ * `inputReferences`. `doStart` creates an express request: Topaz fetches URL
  * inputs itself, and file inputs are uploaded to the returned URL. Processing
- * starts once Topaz has the video, and the provider polls until it completes.
+ * starts once Topaz has the video, and `doStatus` polls.
  */
-export class TopazVideoModel implements VideoModelV3 {
-  readonly specificationVersion = 'v3';
+export class TopazVideoModel implements VideoModelV4 {
+  readonly specificationVersion = 'v4';
   readonly maxVideosPerCall = 1;
 
   get provider(): string {
     return this.config.provider;
   }
 
+  static [WORKFLOW_SERIALIZE](model: TopazVideoModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: TopazVideoModelId;
+    config: TopazConfig;
+  }) {
+    return new TopazVideoModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: TopazVideoModelId,
     private readonly config: TopazConfig,
   ) {}
 
-  async doGenerate(
-    options: Parameters<VideoModelV3['doGenerate']>[0],
-  ): Promise<VideoModelResult> {
-    const topazOptions = await parseProviderOptions({
-      provider: 'topaz',
-      providerOptions: options.providerOptions,
-      schema: topazVideoModelOptionsSchema,
-    });
-    const started = await this.start(options);
-    const pollIntervalMillis =
-      topazOptions?.pollIntervalMillis ?? DEFAULT_POLL_INTERVAL_MILLIS;
-    const pollTimeoutMillis =
-      topazOptions?.pollTimeoutMillis ?? DEFAULT_POLL_TIMEOUT_MILLIS;
-    const deadline = Date.now() + pollTimeoutMillis;
-
-    try {
-      while (true) {
-        const result = await this.getStatus({
-          operation: started.operation,
-          headers: options.headers,
-          abortSignal: options.abortSignal,
-        });
-        if (result != null) {
-          return {
-            ...result,
-            warnings: [...started.warnings, ...result.warnings],
-            response: {
-              ...result.response,
-              timestamp: started.response.timestamp,
-            },
-          };
-        }
-
-        if (Date.now() + pollIntervalMillis > deadline) {
-          const headers = combineHeaders(
-            await resolve(this.config.headers),
-            options.headers,
-          );
-          await this.cancelQuietly(started.operation.requestId, headers);
-          throw new AISDKError({
-            name: 'TOPAZ_VIDEO_ENHANCEMENT_TIMEOUT',
-            message:
-              `Topaz video enhancement did not finish within ${pollTimeoutMillis}ms ` +
-              `(request ${started.operation.requestId}). ` +
-              'Increase the `pollTimeoutMillis` provider option if the job needs longer.',
-          });
-        }
-        await delay(pollIntervalMillis, { abortSignal: options.abortSignal });
-      }
-    } catch (error) {
-      if (options.abortSignal?.aborted) {
-        const headers = combineHeaders(
-          await resolve(this.config.headers),
-          options.headers,
-        );
-        await this.cancelQuietly(started.operation.requestId, headers);
-      }
-      throw error;
-    }
-  }
-
-  private async start(
-    options: Parameters<VideoModelV3['doGenerate']>[0],
-  ): Promise<
-    Omit<VideoModelResult, 'videos'> & { operation: TopazVideoOperation }
-  > {
+  async doStart(
+    options: Parameters<NonNullable<VideoModelV4['doStart']>>[0],
+  ): Promise<VideoModelV4OperationStartResult> {
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
-    const warnings: SharedV3Warning[] = [];
+    const warnings: SharedV4Warning[] = [];
 
     const topazOptions = await parseProviderOptions({
       provider: 'topaz',
@@ -248,7 +196,7 @@ export class TopazVideoModel implements VideoModelV3 {
       }
 
       return {
-        // The output container travels with the operation so the polling code can
+        // The output container travels with the operation so `doStatus` can
         // report the right media type without re-deriving it.
         operation: { requestId, outputContainer: output.container },
         warnings,
@@ -277,18 +225,16 @@ export class TopazVideoModel implements VideoModelV3 {
     }
   }
 
-  private async getStatus(options: {
-    operation: TopazVideoOperation;
-    headers?: Record<string, string | undefined>;
-    abortSignal?: AbortSignal;
-  }): Promise<VideoModelResult | undefined> {
+  async doStatus(
+    options: Parameters<NonNullable<VideoModelV4['doStatus']>>[0],
+  ): Promise<VideoModelV4OperationStatusResult> {
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
     const { requestId, outputContainer } = options.operation as {
       requestId: string;
       outputContainer?: string;
     };
 
-    const { value: status, responseHeaders } = await topazGetFromApi({
+    const { value: status, responseHeaders } = await getFromApi({
       url: `${this.config.baseURL}/video/${requestId}/status`,
       // Built from the configured baseURL, not from response data.
       validateUrl: false,
@@ -324,6 +270,7 @@ export class TopazVideoModel implements VideoModelV3 {
       }
 
       return {
+        status: 'completed',
         videos: [
           {
             type: 'url',
@@ -355,24 +302,33 @@ export class TopazVideoModel implements VideoModelV3 {
     }
 
     if (status.status === 'failed' || status.status === 'canceled') {
-      throw new AISDKError({
-        name: 'TOPAZ_VIDEO_ENHANCEMENT_FAILED',
-        message:
+      return {
+        status: 'error',
+        error:
           `Topaz video request ${requestId} ${status.status}` +
           (status.errorCode != null ? ` (${status.errorCode})` : '') +
           (status.message != null ? `: ${status.message}` : '.'),
-      });
+        providerMetadata: {
+          topaz: {
+            requestId,
+            ...(status.errorCode != null
+              ? { errorCode: status.errorCode }
+              : {}),
+          },
+        },
+        response,
+      };
     }
 
     // Documented in-progress values are requested, accepted, initializing,
     // preprocessing, processing, postprocessing and canceling. Anything else
     // keeps polling too, so a newly added state cannot break running jobs.
-    return undefined;
+    return { status: 'pending', response };
   }
 
   private addUnsupportedWarnings(
-    options: Parameters<VideoModelV3['doGenerate']>[0],
-    warnings: SharedV3Warning[],
+    options: Parameters<NonNullable<VideoModelV4['doStart']>>[0],
+    warnings: SharedV4Warning[],
   ): void {
     // `generateVideo` requires a prompt, so an empty one is the expected way
     // to call an enhancement model and does not warrant a warning.
@@ -445,9 +401,9 @@ export class TopazVideoModel implements VideoModelV3 {
   }
 
   private selectInputVideo(
-    options: Parameters<VideoModelV3['doGenerate']>[0],
-    warnings: SharedV3Warning[],
-  ): VideoModelV3File {
+    options: Parameters<NonNullable<VideoModelV4['doStart']>>[0],
+    warnings: SharedV4Warning[],
+  ): VideoModelV4File {
     const references = options.inputReferences ?? [];
     const videos = references.filter(isVideoReference);
 
@@ -560,7 +516,7 @@ function lowerBoundCredits(
 }
 
 function fileBytes(
-  input: Extract<VideoModelV3File, { type: 'file' }>,
+  input: Extract<VideoModelV4File, { type: 'file' }>,
 ): Uint8Array {
   return typeof input.data === 'string'
     ? convertBase64ToUint8Array(input.data)
@@ -568,7 +524,7 @@ function fileBytes(
 }
 
 function resolveContainer(
-  input: VideoModelV3File,
+  input: VideoModelV4File,
   declaredContainer: TopazSourceContainer | undefined,
 ): TopazSourceContainer {
   if (declaredContainer != null) {
@@ -607,7 +563,7 @@ function resolveContainer(
   return container;
 }
 
-function isVideoReference(reference: VideoModelV3File): boolean {
+function isVideoReference(reference: VideoModelV4File): boolean {
   if (reference.type === 'file') {
     return reference.mediaType.toLowerCase().startsWith('video/');
   }
@@ -709,7 +665,7 @@ function buildOutput({
   topazOptions,
   source,
 }: {
-  options: Parameters<VideoModelV3['doGenerate']>[0];
+  options: Parameters<NonNullable<VideoModelV4['doStart']>>[0];
   topazOptions: TopazVideoModelOptions | undefined;
   source: ResolvedSource;
 }): Record<string, unknown> & { container: TopazOutputContainer } {
@@ -762,7 +718,7 @@ function buildOutput({
 }
 
 /**
- * Mirrors Topaz's container rules so the polling code can report the media type of
+ * Mirrors Topaz's container rules so `doStatus` can report the media type of
  * the file Topaz will actually produce.
  */
 function resolveOutputContainer(

package/src/topaz-get-from-api.ts

@@ -1,53 +0,0 @@
-import {
-  fetchWithValidatedEndpoint,
-  fetchWithValidatedRedirects,
-  getFromApi,
-  isSameOrigin,
-  type FetchFunction,
-} from '@ai-sdk/provider-utils';
-
-/**
- * Adapts URL validation to v6's getFromApi, which does not yet expose the
- * validateUrl and credentialedOrigin options.
- */
-export async function topazGetFromApi<T>({
-  validateUrl,
-  credentialedOrigin,
-  trustedOrigin,
-  ...options
-}: Parameters<typeof getFromApi<T>>[0] & {
-  validateUrl: boolean;
-  credentialedOrigin?: string;
-  trustedOrigin?: string;
-}) {
-  const validatedFetch: FetchFunction = (url, init) =>
-    fetchWithValidatedRedirects({
-      url: url.toString(),
-      headers: init?.headers,
-      abortSignal: init?.signal ?? undefined,
-      trustedOrigin,
-      fetch: (hopUrl, hopInit) =>
-        fetchWithValidatedEndpoint({
-          url: hopUrl.toString(),
-          init: {
-            ...hopInit,
-            headers:
-              credentialedOrigin != null &&
-              isSameOrigin(hopUrl.toString(), credentialedOrigin)
-                ? hopInit?.headers
-                : undefined,
-          },
-          trustedOrigin,
-          redirect: 'manual',
-          fetch: options.fetch,
-        }),
-    });
-
-  // v6 ignores this flag; validation is handled by the injected fetch above.
-  const requestOptions = {
-    ...options,
-    validateUrl: false,
-    fetch: validateUrl ? validatedFetch : options.fetch,
-  };
-  return getFromApi(requestOptions);
-}