@ai-sdk/topaz 0.0.0 → 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @ai-sdk/topaz
+
+## 3.0.0
+
+### Major Changes
+
+- 09aa6c2: feat (provider/topaz): add Topaz Labs provider
+
+### Patch Changes
+
+- Updated dependencies [8c65988]
+- Updated dependencies [527a163]
+  - @ai-sdk/provider@4.0.21
+  - @ai-sdk/provider-utils@5.0.53

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,4 +1,68 @@
-# @ai-sdk/topaz
+# AI SDK - Topaz Labs Provider
 
-Seed package provisioned by the internal npm provisioning control plane.
-Releases are published from [`vercel/ai`](https://github.com/vercel/ai) via `release.yml` using npm Trusted Publishing.
+The **Topaz Labs provider** for the [AI SDK](https://ai-sdk.dev/docs) contains image and video model support for the [Topaz Labs API](https://developer.topazlabs.com).
+
+Topaz models **enhance media you supply**. They upscale, denoise, sharpen and restore an existing image or video, and do not generate media from a text prompt.
+
+> **Deploying to Vercel?** With Vercel's AI Gateway you can access Topaz Labs (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
+
+## Setup
+
+The Topaz Labs provider is available in the `@ai-sdk/topaz` module. You can install it with:
+
+```bash
+npm i @ai-sdk/topaz
+```
+
+## Skill for Coding Agents
+
+If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:
+
+```shell
+npx skills add vercel/ai
+```
+
+## Provider Instance
+
+You can import the default provider instance `topaz` from `@ai-sdk/topaz`:
+
+```ts
+import { topaz } from '@ai-sdk/topaz';
+```
+
+The default instance reads the API key from the `TOPAZ_API_KEY` environment variable. Use `createTopaz({ apiKey })` to pass it explicitly. See [API Key Setup](https://developer.topazlabs.com/getting-started/api-key-setup) to create a key.
+
+## Image Enhancement Example
+
+```ts
+import { topaz } from '@ai-sdk/topaz';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: topaz.image('wonder-3.5'),
+  prompt: {
+    images: ['https://example.com/photo.jpg'],
+  },
+  size: '4096x4096',
+});
+```
+
+## Video Enhancement Example
+
+`generateVideo` requires a prompt, so pass an empty one. `resolution` sets the output resolution. Starlight models also need the input video's properties in the `source` provider option:
+
+```ts
+import { topaz } from '@ai-sdk/topaz';
+import { experimental_generateVideo as generateVideo } from 'ai';
+
+const { videos } = await generateVideo({
+  model: topaz.video('proteus'),
+  prompt: '',
+  inputReferences: ['https://example.com/clip.mp4'],
+  resolution: '3840x2160',
+});
+```
+
+## Documentation
+
+Please check out the **[Topaz Labs provider](https://ai-sdk.dev/providers/ai-sdk-providers/topaz)** for more information.

package/dist/index.d.ts

@@ -0,0 +1,247 @@
+import { Experimental_VideoModelV4, ImageModelV4, ProviderV4 } from "@ai-sdk/provider";
+import { FetchFunction, InferSchema } from "@ai-sdk/provider-utils";
+import { z } from "zod/v4";
+//#region src/topaz-image-settings.d.ts
+/**
+ * Topaz image model ids.
+ *
+ * The AI SDK exposes a readable id that is mapped onto the name the Topaz API
+ * expects in the `model` form field (see `topazImageApiModelIds`). Passing a
+ * raw Topaz name such as `Wonder 3.5` also works - unknown ids are forwarded
+ * to the API unchanged.
+ */
+type TopazImageModelId = 'wonder-3.5' | (string & {});
+//#endregion
+//#region src/topaz-video-settings.d.ts
+/**
+ * Topaz video model ids.
+ *
+ * The AI SDK exposes readable ids that are mapped onto the short names the
+ * Topaz API expects in the `filters[].model` field (see
+ * `topazVideoApiModelIds`). Passing a raw Topaz name such as `slp-2.6` also
+ * works - unknown ids are forwarded to the API unchanged.
+ */
+type TopazVideoModelId = 'proteus' | 'starlight-precise-2.6' | (string & {});
+//#endregion
+//#region src/topaz-provider.d.ts
+interface TopazProviderSettings {
+  /**
+   * Topaz Labs API key. Default value is taken from the `TOPAZ_API_KEY`
+   * environment variable.
+   *
+   * @see https://developer.topazlabs.com/getting-started/api-key-setup
+   */
+  apiKey?: string;
+  /**
+   * Base URL for the API calls.
+   */
+  baseURL?: string;
+  /**
+   * Custom headers to include in the requests.
+   */
+  headers?: Record<string, string>;
+  /**
+   * Custom fetch implementation. You can use it as a middleware to intercept
+   * requests, or to provide a custom fetch implementation for e.g. testing.
+   */
+  fetch?: FetchFunction;
+}
+interface TopazProvider extends ProviderV4 {
+  /**
+   * Creates a model for image enhancement.
+   */
+  image(modelId: TopazImageModelId): ImageModelV4;
+  /**
+   * Creates a model for image enhancement.
+   */
+  imageModel(modelId: TopazImageModelId): ImageModelV4;
+  /**
+   * Creates a model for video enhancement.
+   */
+  video(modelId: TopazVideoModelId): Experimental_VideoModelV4;
+  /**
+   * Creates a model for video enhancement.
+   */
+  videoModel(modelId: TopazVideoModelId): Experimental_VideoModelV4;
+}
+/**
+ * Create a Topaz Labs provider instance.
+ */
+export declare function createTopaz(options?: TopazProviderSettings): TopazProvider;
+/**
+ * Default Topaz Labs provider instance.
+ */
+export declare const topaz: TopazProvider;
+//#endregion
+//#region src/topaz-image-model-options.d.ts
+/**
+ * Provider options for Topaz generative image models (Wonder 3.5).
+ *
+ * The documented request schema fields are sent in snake_case
+ * (`output_width`, `output_format`, ...); model-specific settings are sent in
+ * camelCase, matching the Topaz model reference.
+ *
+ * @see https://developer.topazlabs.com/image-models/wonder/wonder-3.5-new
+ */
+declare const topazImageModelOptionsSchema: import("@ai-sdk/provider-utils").LazySchema<{
+  enhancementStrength?: "low" | "medium" | "high" | undefined;
+  grain?: boolean | undefined;
+  grainDensity?: number | undefined;
+  grainModel?: "silver" | "gaussian" | "grey" | undefined;
+  grainSize?: number | undefined;
+  grainStrength?: number | undefined;
+  inputWidth?: number | undefined;
+  inputHeight?: number | undefined;
+  outputWidth?: number | undefined;
+  outputHeight?: number | undefined;
+  outputFormat?: "jpeg" | "jpg" | "png" | "tiff" | "tif" | undefined;
+  cropToFill?: boolean | undefined;
+  webhookUrl?: string | undefined;
+  pollIntervalMillis?: number | undefined;
+  pollTimeoutMillis?: number | undefined;
+}>;
+type TopazImageModelOptions = InferSchema<typeof topazImageModelOptionsSchema>;
+//#endregion
+//#region src/topaz-video-model-options.d.ts
+/**
+ * Metadata about the input video.
+ *
+ * Starlight models require `width`, `height`, `duration` and `frameRate`
+ * (Topaz prices them from these values), and for other models they let Topaz
+ * estimate the cost before it has the video. The AI SDK does not inspect
+ * media files, so the values come from the caller. Setting any of them
+ * requires all four.
+ */
+declare const topazVideoSourceSchema: z.ZodObject<{
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+  duration: z.ZodOptional<z.ZodNumber>;
+  frameRate: z.ZodOptional<z.ZodNumber>;
+  frameCount: z.ZodOptional<z.ZodNumber>;
+  container: z.ZodOptional<z.ZodEnum<{
+    "3gp": "3gp";
+    avi: "avi";
+    dv: "dv";
+    flv: "flv";
+    m1v: "m1v";
+    m2t: "m2t";
+    m2ts: "m2ts";
+    m2v: "m2v";
+    m4v: "m4v";
+    mkv: "mkv";
+    mov: "mov";
+    mp4: "mp4";
+    mpeg: "mpeg";
+    mpg: "mpg";
+    mts: "mts";
+    mxf: "mxf";
+    ser: "ser";
+    ts: "ts";
+    vob: "vob";
+    webm: "webm";
+    wmv: "wmv";
+  }>>;
+}, z.core.$strip>;
+type TopazVideoSource = z.infer<typeof topazVideoSourceSchema>;
+/**
+ * Output settings for the enhanced video.
+ */
+declare const topazVideoOutputSchema: z.ZodObject<{
+  width: z.ZodOptional<z.ZodNumber>;
+  height: z.ZodOptional<z.ZodNumber>;
+  frameRate: z.ZodOptional<z.ZodNumber>;
+  audioCodec: z.ZodOptional<z.ZodEnum<{
+    AAC: "AAC";
+    AC3: "AC3";
+    PCM: "PCM";
+  }>>;
+  audioBitrate: z.ZodOptional<z.ZodString>;
+  audioTransfer: z.ZodOptional<z.ZodEnum<{
+    Copy: "Copy";
+    Convert: "Convert";
+    None: "None";
+  }>>;
+  videoEncoder: z.ZodOptional<z.ZodEnum<{
+    AV1: "AV1";
+    H264: "H264";
+    H265: "H265";
+    ProRes: "ProRes";
+    VP9: "VP9";
+  }>>;
+  videoProfile: z.ZodOptional<z.ZodString>;
+  videoBitrate: z.ZodOptional<z.ZodString>;
+  dynamicCompressionLevel: z.ZodOptional<z.ZodEnum<{
+    Low: "Low";
+    Mid: "Mid";
+    High: "High";
+  }>>;
+  cropToFit: z.ZodOptional<z.ZodBoolean>;
+  container: z.ZodOptional<z.ZodEnum<{
+    avi: "avi";
+    mkv: "mkv";
+    mov: "mov";
+    mp4: "mp4";
+    webm: "webm";
+  }>>;
+}, z.core.$strip>;
+type TopazVideoOutput = z.infer<typeof topazVideoOutputSchema>;
+/**
+ * Provider options for Topaz video models.
+ *
+ * @see https://developer.topazlabs.com/video-models/proteus/proteus-1
+ * @see https://developer.topazlabs.com/video-models/starlight/starlight-precise-2.6
+ */
+declare const topazVideoModelOptionsSchema: import("@ai-sdk/provider-utils").LazySchema<{
+  source?: {
+    width?: number | undefined;
+    height?: number | undefined;
+    duration?: number | undefined;
+    frameRate?: number | undefined;
+    frameCount?: number | undefined;
+    container?: "3gp" | "avi" | "dv" | "flv" | "m1v" | "m2t" | "m2ts" | "m2v" | "m4v" | "mkv" | "mov" | "mp4" | "mpeg" | "mpg" | "mts" | "mxf" | "ser" | "ts" | "vob" | "webm" | "wmv" | undefined;
+  } | undefined;
+  output?: {
+    width?: number | undefined;
+    height?: number | undefined;
+    frameRate?: number | undefined;
+    audioCodec?: "AAC" | "AC3" | "PCM" | undefined;
+    audioBitrate?: string | undefined;
+    audioTransfer?: "Copy" | "Convert" | "None" | undefined;
+    videoEncoder?: "AV1" | "H264" | "H265" | "ProRes" | "VP9" | undefined;
+    videoProfile?: string | undefined;
+    videoBitrate?: string | undefined;
+    dynamicCompressionLevel?: "Low" | "Mid" | "High" | undefined;
+    cropToFit?: boolean | undefined;
+    container?: "avi" | "mkv" | "mov" | "mp4" | "webm" | undefined;
+  } | undefined;
+  additionalFilters?: Record<string, unknown>[] | undefined;
+  filter?: Record<string, unknown> | undefined;
+  videoType?: "Progressive" | "Interlaced" | "ProgressiveInterlaced" | undefined;
+  auto?: "Auto" | "Manual" | "Relative" | undefined;
+  fieldOrder?: "Auto" | "TopFirst" | "BottomFirst" | undefined;
+  focusFixLevel?: "None" | "Normal" | "Strong" | undefined;
+  compression?: number | undefined;
+  details?: number | undefined;
+  prenoise?: number | undefined;
+  noise?: number | undefined;
+  halo?: number | undefined;
+  preblur?: number | undefined;
+  blur?: number | undefined;
+  grain?: number | undefined;
+  grainSigma?: number | undefined;
+  grainSize?: number | undefined;
+  grainType?: "gaussian" | "grey" | "silver_rich" | undefined;
+  recoverOriginalDetailValue?: number | undefined;
+  sharpness?: number | undefined;
+  videoBitDepth?: number | undefined;
+  videoCodec?: "ffv1" | "prores" | "vp9" | undefined;
+  videoProfile?: "420" | "422" | "444" | undefined;
+  watermark?: boolean | undefined;
+}>;
+type TopazVideoModelOptions = InferSchema<typeof topazVideoModelOptionsSchema>;
+//#endregion
+//#region src/version.d.ts
+export declare const VERSION: string;
+//#endregion
+export type { TopazImageModelId, TopazImageModelOptions, TopazProvider, TopazProviderSettings, TopazVideoModelId, TopazVideoModelOptions, TopazVideoOutput, TopazVideoSource };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["VideoModelV4"],"sources":["../src/topaz-image-settings.ts","../src/topaz-video-settings.ts","../src/topaz-provider.ts","../src/topaz-image-model-options.ts","../src/topaz-video-model-options.ts","../src/version.ts"],"mappings":";;;;;;;;;;;;KAQY;;;;;;;;;;;KCAA;;;UCUK;;;;;;;EAOf;;;;EAKA;;;;EAKA,UAAU;;;;;EAMV,QAAQ;;UAGO,sBAAsB;;;;EAIrC,MAAM,SAAS,oBAAoB;;;;EAKnC,WAAW,SAAS,oBAAoB;;;;EAKxC,MAAM,SAAS,oBAAoBA;;;;EAKnC,WAAW,SAAS,oBAAoBA;;;;;wBAQ1B,YACd,UAAS,wBACR;;;;qBA8DU,OAAK;;;;;;;;;;;;cCvHL,+DAA4B;;;;;;;;;;;;;;;;;KAwF7B,yBAAyB,mBAC5B;;;;;;;;;;;;cCnDI,wBAAsB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCjC,EAAA,KAAA;KAEU,mBAAmB,EAAE,aAAa;;;;cAKjC,wBAAsB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEjC,EAAA,KAAA;KAEU,mBAAmB,EAAE,aAAa;;;;;;;cAQjC,+DAA4B;;;;;;;;;;;;;;;;;;;;;;;sBAA5B;WAAA;;;;;;;;;;;;;;;;;;;;;;;KA+FD,yBAAyB,mBAC5B;;;qBC5QI"}