@ai-sdk/replicate 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/replicate
 
+## 0.0.2
+
+### Patch Changes
+
+- 33b28df: feat (provider/replicate): Fix api key name typo, add package metadata/files config.
+
 ## 0.0.1
 
 ### Patch Changes

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@ai-sdk/replicate",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "CHANGELOG.md"
+  ],
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -34,6 +38,17 @@
   "publishConfig": {
     "access": "public"
   },
+  "homepage": "https://sdk.vercel.ai/docs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vercel/ai.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vercel/ai/issues"
+  },
+  "keywords": [
+    "ai"
+  ],
   "scripts": {
     "build": "tsup",
     "build:watch": "tsup --watch",

package/.turbo/turbo-build.log

@@ -1,21 +0,0 @@
-
-> @ai-sdk/replicate@0.0.1 build /home/runner/work/ai/ai/packages/replicate
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.3.0
-CLI Using tsup config: /home/runner/work/ai/ai/packages/replicate/tsup.config.ts
-CLI Target: es2018
-CJS Build start
-ESM Build start
-ESM dist/index.mjs     3.13 KB
-ESM dist/index.mjs.map 7.22 KB
-ESM ⚡️ Build success in 74ms
-CJS dist/index.js     4.37 KB
-CJS dist/index.js.map 7.46 KB
-CJS ⚡️ Build success in 88ms
-DTS Build start
-DTS ⚡️ Build success in 18826ms
-DTS dist/index.d.ts  3.08 KB
-DTS dist/index.d.mts 3.08 KB

package/.turbo/turbo-clean.log

@@ -1,4 +0,0 @@
-
-> @ai-sdk/replicate@0.0.1 clean /home/runner/work/ai/ai/packages/replicate
-> rm -rf dist
-

package/src/index.ts

@@ -1,5 +0,0 @@
-export { createReplicate, replicate } from './replicate-provider';
-export type {
-  ReplicateProvider,
-  ReplicateProviderSettings,
-} from './replicate-provider';

package/src/replicate-error.ts

@@ -1,13 +0,0 @@
-import { createJsonErrorResponseHandler } from '@ai-sdk/provider-utils';
-import { z } from 'zod';
-
-const replicateErrorSchema = z.object({
-  detail: z.string().optional(),
-  error: z.string().optional(),
-});
-
-export const replicateFailedResponseHandler = createJsonErrorResponseHandler({
-  errorSchema: replicateErrorSchema,
-  errorToMessage: error =>
-    error.detail ?? error.error ?? 'Unknown Replicate error',
-});

package/src/replicate-image-model.test.ts

@@ -1,177 +0,0 @@
-import { createTestServer } from '@ai-sdk/provider-utils/test';
-import { createReplicate } from './replicate-provider';
-
-const prompt = 'The Loch Ness monster getting a manicure';
-
-const provider = createReplicate({ apiToken: 'test-api-token' });
-const model = provider.image('black-forest-labs/flux-schnell');
-
-describe('doGenerate', () => {
-  const server = createTestServer({
-    'https://api.replicate.com/*': {},
-    'https://replicate.delivery/*': {
-      response: {
-        type: 'binary',
-        body: Buffer.from('test-binary-content'),
-      },
-    },
-  });
-
-  function prepareResponse({
-    output = ['https://replicate.delivery/xezq/abc/out-0.webp'],
-  }: { output?: string | Array<string> } = {}) {
-    server.urls['https://api.replicate.com/*'].response = {
-      type: 'json-value',
-      body: {
-        id: 's7x1e3dcmhrmc0cm8rbatcneec',
-        model: 'black-forest-labs/flux-schnell',
-        version: 'dp-4d0bcc010b3049749a251855f12800be',
-        input: {
-          num_outputs: 1,
-          prompt: 'The Loch Ness Monster getting a manicure',
-        },
-        logs: '',
-        output,
-        data_removed: false,
-        error: null,
-        status: 'processing',
-        created_at: '2025-01-08T13:24:38.692Z',
-        urls: {
-          cancel:
-            'https://api.replicate.com/v1/predictions/s7x1e3dcmhrmc0cm8rbatcneec/cancel',
-          get: 'https://api.replicate.com/v1/predictions/s7x1e3dcmhrmc0cm8rbatcneec',
-          stream:
-            'https://stream.replicate.com/v1/files/bcwr-3okdfv3o2wehstv5f2okyftwxy57hhypqsi6osiim5iaq5k7u24a',
-        },
-      },
-    };
-  }
-
-  it('should pass the model and the settings', async () => {
-    prepareResponse();
-
-    await model.doGenerate({
-      prompt,
-      n: 1,
-      size: '1024x768',
-      aspectRatio: '3:4',
-      seed: 123,
-      providerOptions: {
-        replicate: {
-          style: 'realistic_image',
-        },
-        other: {
-          something: 'else',
-        },
-      },
-    });
-
-    expect(await server.calls[0].requestBody).toStrictEqual({
-      input: {
-        prompt,
-        num_outputs: 1,
-        aspect_ratio: '3:4',
-        size: '1024x768',
-        seed: 123,
-        style: 'realistic_image',
-      },
-    });
-  });
-
-  it('should call the correct url', async () => {
-    prepareResponse();
-
-    await model.doGenerate({
-      prompt,
-      n: 1,
-      size: undefined,
-      aspectRatio: undefined,
-      seed: undefined,
-      providerOptions: {},
-    });
-
-    expect(server.calls[0].requestMethod).toStrictEqual('POST');
-    expect(server.calls[0].requestUrl).toStrictEqual(
-      'https://api.replicate.com/v1/models/black-forest-labs/flux-schnell/predictions',
-    );
-  });
-
-  it('should pass headers and set the prefer header', async () => {
-    prepareResponse();
-
-    const provider = createReplicate({
-      apiToken: 'test-api-token',
-      headers: {
-        'Custom-Provider-Header': 'provider-header-value',
-      },
-    });
-
-    await provider.image('black-forest-labs/flux-schnell').doGenerate({
-      prompt,
-      n: 1,
-      size: undefined,
-      aspectRatio: undefined,
-      seed: undefined,
-      providerOptions: {},
-      headers: {
-        'Custom-Request-Header': 'request-header-value',
-      },
-    });
-
-    expect(server.calls[0].requestHeaders).toStrictEqual({
-      authorization: 'Bearer test-api-token',
-      'content-type': 'application/json',
-      'custom-provider-header': 'provider-header-value',
-      'custom-request-header': 'request-header-value',
-      prefer: 'wait',
-    });
-  });
-
-  it('should extract the generated image from array response', async () => {
-    prepareResponse({
-      output: ['https://replicate.delivery/xezq/abc/out-0.webp'],
-    });
-
-    const result = await model.doGenerate({
-      prompt,
-      n: 1,
-      size: undefined,
-      aspectRatio: undefined,
-      seed: undefined,
-      providerOptions: {},
-    });
-
-    expect(result.images).toStrictEqual([
-      new Uint8Array(Buffer.from('test-binary-content')),
-    ]);
-
-    expect(server.calls[1].requestMethod).toStrictEqual('GET');
-    expect(server.calls[1].requestUrl).toStrictEqual(
-      'https://replicate.delivery/xezq/abc/out-0.webp',
-    );
-  });
-
-  it('should extract the generated image from string response', async () => {
-    prepareResponse({
-      output: 'https://replicate.delivery/xezq/abc/out-0.webp',
-    });
-
-    const result = await model.doGenerate({
-      prompt,
-      n: 1,
-      size: undefined,
-      aspectRatio: undefined,
-      seed: undefined,
-      providerOptions: {},
-    });
-
-    expect(result.images).toStrictEqual([
-      new Uint8Array(Buffer.from('test-binary-content')),
-    ]);
-
-    expect(server.calls[1].requestMethod).toStrictEqual('GET');
-    expect(server.calls[1].requestUrl).toStrictEqual(
-      'https://replicate.delivery/xezq/abc/out-0.webp',
-    );
-  });
-});

package/src/replicate-image-model.ts

@@ -1,104 +0,0 @@
-import type { ImageModelV1, ImageModelV1CallWarning } from '@ai-sdk/provider';
-import type { Resolvable } from '@ai-sdk/provider-utils';
-import {
-  FetchFunction,
-  combineHeaders,
-  createJsonResponseHandler,
-  postJsonToApi,
-  resolve,
-} from '@ai-sdk/provider-utils';
-import { z } from 'zod';
-import { replicateFailedResponseHandler } from './replicate-error';
-import {
-  ReplicateImageModelId,
-  ReplicateImageSettings,
-} from './replicate-image-settings';
-
-interface ReplicateImageModelConfig {
-  provider: string;
-  baseURL: string;
-  headers?: Resolvable<Record<string, string | undefined>>;
-  fetch?: FetchFunction;
-}
-
-export class ReplicateImageModel implements ImageModelV1 {
-  readonly specificationVersion = 'v1';
-
-  readonly modelId: ReplicateImageModelId;
-  readonly settings: ReplicateImageSettings;
-
-  private readonly config: ReplicateImageModelConfig;
-
-  get provider(): string {
-    return this.config.provider;
-  }
-
-  get maxImagesPerCall(): number {
-    return this.settings.maxImagesPerCall ?? 1;
-  }
-
-  constructor(
-    modelId: ReplicateImageModelId,
-    settings: ReplicateImageSettings,
-    config: ReplicateImageModelConfig,
-  ) {
-    this.modelId = modelId;
-    this.settings = settings;
-    this.config = config;
-  }
-
-  async doGenerate({
-    prompt,
-    n,
-    aspectRatio,
-    size,
-    seed,
-    providerOptions,
-    headers,
-    abortSignal,
-  }: Parameters<ImageModelV1['doGenerate']>[0]): Promise<
-    Awaited<ReturnType<ImageModelV1['doGenerate']>>
-  > {
-    const warnings: Array<ImageModelV1CallWarning> = [];
-
-    const {
-      value: { output },
-    } = await postJsonToApi({
-      url: `${this.config.baseURL}/models/${this.modelId}/predictions`,
-      headers: combineHeaders(await resolve(this.config.headers), headers, {
-        prefer: 'wait',
-      }),
-      body: {
-        input: {
-          prompt,
-          aspect_ratio: aspectRatio,
-          size,
-          seed,
-          num_outputs: n,
-          ...(providerOptions.replicate ?? {}),
-        },
-      },
-      failedResponseHandler: replicateFailedResponseHandler,
-      successfulResponseHandler: createJsonResponseHandler(
-        replicateImageResponseSchema,
-      ),
-      abortSignal,
-      fetch: this.config.fetch,
-    });
-
-    // download the images:
-    const outputArray = Array.isArray(output) ? output : [output];
-    const images = await Promise.all(
-      outputArray.map(async url => {
-        const response = await fetch(url);
-        return new Uint8Array(await response.arrayBuffer());
-      }),
-    );
-
-    return { images, warnings };
-  }
-}
-
-const replicateImageResponseSchema = z.object({
-  output: z.union([z.array(z.string()), z.string()]),
-});

package/src/replicate-image-settings.ts

@@ -1,36 +0,0 @@
-export type ReplicateImageModelId =
-  | 'black-forest-labs/flux-1.1-pro'
-  | 'black-forest-labs/flux-1.1-pro-ultra'
-  | 'black-forest-labs/flux-dev'
-  | 'black-forest-labs/flux-pro'
-  | 'black-forest-labs/flux-schnell'
-  | 'bytedance/sdxl-lightning-4step'
-  | 'fofr/aura-flow'
-  | 'fofr/latent-consistency-model'
-  | 'fofr/realvisxl-v3-multi-controlnet-lora'
-  | 'fofr/sdxl-emoji'
-  | 'fofr/sdxl-multi-controlnet-lora'
-  | 'ideogram-ai/ideogram-v2'
-  | 'ideogram-ai/ideogram-v2-turbo'
-  | 'lucataco/dreamshaper-xl-turbo'
-  | 'lucataco/open-dalle-v1.1'
-  | 'lucataco/realvisxl-v2.0'
-  | 'lucataco/realvisxl2-lcm'
-  | 'luma/photon'
-  | 'luma/photon-flash'
-  | 'nvidia/sana'
-  | 'playgroundai/playground-v2.5-1024px-aesthetic'
-  | 'recraft-ai/recraft-v3'
-  | 'recraft-ai/recraft-v3-svg'
-  | 'stability-ai/stable-diffusion-3.5-large'
-  | 'stability-ai/stable-diffusion-3.5-large-turbo'
-  | 'stability-ai/stable-diffusion-3.5-medium'
-  | 'tstramer/material-diffusion'
-  | (string & {});
-
-export interface ReplicateImageSettings {
-  /**
-Override the maximum number of images per call (default 1)
-   */
-  maxImagesPerCall?: number;
-}

package/src/replicate-provider.test.ts

@@ -1,24 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { createReplicate } from './replicate-provider';
-import { ReplicateImageModel } from './replicate-image-model';
-
-describe('createReplicate', () => {
-  it('creates a provider with required settings', () => {
-    const provider = createReplicate({ apiToken: 'test-token' });
-    expect(provider.image).toBeDefined();
-  });
-
-  it('creates a provider with custom settings', () => {
-    const provider = createReplicate({
-      apiToken: 'test-token',
-      baseURL: 'https://custom.replicate.com',
-    });
-    expect(provider.image).toBeDefined();
-  });
-
-  it('creates an image model instance', () => {
-    const provider = createReplicate({ apiToken: 'test-token' });
-    const model = provider.image('black-forest-labs/flux-schnell');
-    expect(model).toBeInstanceOf(ReplicateImageModel);
-  });
-});

package/src/replicate-provider.ts

@@ -1,74 +0,0 @@
-import type { FetchFunction } from '@ai-sdk/provider-utils';
-import { loadApiKey } from '@ai-sdk/provider-utils';
-import { ReplicateImageModel } from './replicate-image-model';
-import {
-  ReplicateImageModelId,
-  ReplicateImageSettings,
-} from './replicate-image-settings';
-
-export interface ReplicateProviderSettings {
-  /**
-API token that is being send using the `Authorization` header.
-It defaults to the `REPLICATE_API_TOKEN` environment variable.
-   */
-  apiToken?: string;
-
-  /**
-Use a different URL prefix for API calls, e.g. to use proxy servers.
-The default prefix is `https://api.replicate.com/v1`.
-   */
-  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;
-}
-
-export interface ReplicateProvider {
-  /**
-   * Creates a Replicate image generation model.
-   */
-  image(
-    modelId: ReplicateImageModelId,
-    settings?: ReplicateImageSettings,
-  ): ReplicateImageModel;
-}
-
-/**
- * Create a Replicate provider instance.
- */
-export function createReplicate(
-  options: ReplicateProviderSettings = {},
-): ReplicateProvider {
-  return {
-    image: (
-      modelId: ReplicateImageModelId,
-      settings?: ReplicateImageSettings,
-    ) =>
-      new ReplicateImageModel(modelId, settings ?? {}, {
-        provider: 'replicate',
-        baseURL: options.baseURL ?? 'https://api.replicate.com/v1',
-        headers: {
-          Authorization: `Bearer ${loadApiKey({
-            apiKey: options.apiToken,
-            environmentVariableName: 'REPLICATE_API_TOKEN',
-            description: 'Replicate',
-          })}`,
-          ...options.headers,
-        },
-        fetch: options.fetch,
-      }),
-  };
-}
-
-/**
- * Default Replicate provider instance.
- */
-export const replicate = createReplicate();

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./node_modules/@vercel/ai-tsconfig/ts-library.json",
-  "include": ["."],
-  "exclude": ["*/dist", "dist", "build", "node_modules"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig([
-  {
-    entry: ['src/index.ts'],
-    format: ['cjs', 'esm'],
-    dts: true,
-    sourcemap: true,
-  },
-]);

package/turbo.json

@@ -1,12 +0,0 @@
-{
-  "extends": [
-    "//"
-  ],
-  "tasks": {
-    "build": {
-      "outputs": [
-        "**/dist/**"
-      ]
-    }
-  }
-}

package/vitest.edge.config.js

@@ -1,10 +0,0 @@
-import { defineConfig } from 'vite';
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  test: {
-    environment: 'edge-runtime',
-    globals: true,
-    include: ['**/*.test.ts', '**/*.test.tsx'],
-  },
-});

package/vitest.node.config.js

@@ -1,10 +0,0 @@
-import { defineConfig } from 'vite';
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  test: {
-    environment: 'node',
-    globals: true,
-    include: ['**/*.test.ts', '**/*.test.tsx'],
-  },
-});