@ai-sdk/black-forest-labs 1.0.10 → 1.0.11

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/black-forest-labs
 
+## 1.0.11
+
+### Patch Changes
+
+- 4de5a1d: chore: excluded tests from src folder in npm package
+- Updated dependencies [4de5a1d]
+  - @ai-sdk/provider@3.0.5
+  - @ai-sdk/provider-utils@4.0.9
+
 ## 1.0.10
 
 ### Patch Changes

package/dist/index.js

@@ -392,7 +392,7 @@ function bflErrorToMessage(error) {
 }
 
 // src/version.ts
-var VERSION = true ? "1.0.10" : "0.0.0-test";
+var VERSION = true ? "1.0.11" : "0.0.0-test";
 
 // src/black-forest-labs-provider.ts
 var defaultBaseURL = "https://api.bfl.ai/v1";

package/dist/index.mjs

@@ -381,7 +381,7 @@ function bflErrorToMessage(error) {
 }
 
 // src/version.ts
-var VERSION = true ? "1.0.10" : "0.0.0-test";
+var VERSION = true ? "1.0.11" : "0.0.0-test";
 
 // src/black-forest-labs-provider.ts
 var defaultBaseURL = "https://api.bfl.ai/v1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/black-forest-labs",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -10,6 +10,10 @@
     "dist/**/*",
     "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md"
   ],
   "directories": {
@@ -24,15 +28,15 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.9"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.2",
+    "@ai-sdk/test-server": "1.0.3",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {

package/src/black-forest-labs-image-model.test.ts

@@ -1,576 +0,0 @@
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import { createTestServer } from '@ai-sdk/test-server/with-vitest';
-import { describe, expect, it } from 'vitest';
-import { BlackForestLabsImageModel } from './black-forest-labs-image-model';
-
-const prompt = 'A cute baby sea otter';
-
-function createBasicModel({
-  headers,
-  fetch,
-  currentDate,
-  pollIntervalMillis,
-  pollTimeoutMillis,
-}: {
-  headers?: () => Record<string, string | undefined>;
-  fetch?: FetchFunction;
-  currentDate?: () => Date;
-  pollIntervalMillis?: number;
-  pollTimeoutMillis?: number;
-} = {}) {
-  return new BlackForestLabsImageModel('test-model', {
-    provider: 'black-forest-labs.image',
-    baseURL: 'https://api.example.com/v1',
-    headers: headers ?? (() => ({ 'x-key': 'test-key' })),
-    fetch,
-    pollIntervalMillis,
-    pollTimeoutMillis,
-    _internal: {
-      currentDate,
-    },
-  });
-}
-
-describe('BlackForestLabsImageModel', () => {
-  const server = createTestServer({
-    'https://api.example.com/v1/test-model': {
-      response: {
-        type: 'json-value',
-        body: {
-          id: 'req-123',
-          polling_url: 'https://api.example.com/poll',
-        },
-      },
-    },
-    'https://api.example.com/poll': {
-      response: {
-        type: 'json-value',
-        body: {
-          status: 'Ready',
-          result: {
-            sample: 'https://api.example.com/image.png',
-          },
-        },
-      },
-    },
-    'https://api.example.com/image.png': {
-      response: {
-        type: 'binary',
-        body: Buffer.from('test-binary-content'),
-      },
-    },
-  });
-
-  describe('doGenerate', () => {
-    it('passes the correct parameters including aspect ratio and providerOptions', async () => {
-      const model = createBasicModel();
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: '16:9',
-        seed: undefined,
-        providerOptions: {
-          blackForestLabs: {
-            promptUpsampling: true,
-            unsupportedProperty: 'value',
-          },
-        },
-      });
-
-      expect(await server.calls[0].requestBodyJson).toStrictEqual({
-        prompt,
-        aspect_ratio: '16:9',
-        prompt_upsampling: true,
-      });
-    });
-
-    it('includes seed in providerMetadata images when provided by API', async () => {
-      server.urls['https://api.example.com/poll'].response = {
-        type: 'json-value',
-        body: {
-          status: 'Ready',
-          result: {
-            sample: 'https://api.example.com/image.png',
-            seed: 12345,
-          },
-        },
-      };
-
-      const model = createBasicModel();
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      expect(result.providerMetadata?.blackForestLabs.images[0]).toMatchObject({
-        seed: 12345,
-      });
-    });
-
-    it('includes all cost and megapixel fields when provided by submit API', async () => {
-      server.urls['https://api.example.com/v1/test-model'].response = {
-        type: 'json-value',
-        body: {
-          id: 'req-123',
-          polling_url: 'https://api.example.com/poll',
-          cost: 0.08,
-          input_mp: 1.5,
-          output_mp: 2.0,
-        },
-      };
-
-      const model = createBasicModel();
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      expect(result.providerMetadata?.blackForestLabs.images[0]).toMatchObject({
-        cost: 0.08,
-        inputMegapixels: 1.5,
-        outputMegapixels: 2.0,
-      });
-    });
-
-    it('omits cost and megapixel fields from providerMetadata when not provided by submit API', async () => {
-      server.urls['https://api.example.com/v1/test-model'].response = {
-        type: 'json-value',
-        body: {
-          id: 'req-123',
-          polling_url: 'https://api.example.com/poll',
-        },
-      };
-
-      const model = createBasicModel();
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      const metadata = result.providerMetadata?.blackForestLabs.images[0];
-      expect(metadata).toBeDefined();
-      expect(metadata).not.toHaveProperty('cost');
-      expect(metadata).not.toHaveProperty('inputMegapixels');
-      expect(metadata).not.toHaveProperty('outputMegapixels');
-    });
-
-    it('handles null cost and megapixel fields from submit API', async () => {
-      server.urls['https://api.example.com/v1/test-model'].response = {
-        type: 'json-value',
-        body: {
-          id: 'req-123',
-          polling_url: 'https://api.example.com/poll',
-          cost: null,
-          input_mp: null,
-          output_mp: null,
-        },
-      };
-
-      const model = createBasicModel();
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      const metadata = result.providerMetadata?.blackForestLabs.images[0];
-      expect(metadata).toBeDefined();
-      expect(metadata).not.toHaveProperty('cost');
-      expect(metadata).not.toHaveProperty('inputMegapixels');
-      expect(metadata).not.toHaveProperty('outputMegapixels');
-    });
-
-    it('calls the expected URLs in sequence', async () => {
-      const model = createBasicModel();
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        aspectRatio: '16:9',
-        providerOptions: {},
-        size: undefined,
-        seed: undefined,
-      });
-
-      expect(server.calls[0].requestMethod).toBe('POST');
-      expect(server.calls[0].requestUrl).toBe(
-        'https://api.example.com/v1/test-model',
-      );
-      expect(server.calls[1].requestMethod).toBe('GET');
-      expect(server.calls[1].requestUrl).toBe(
-        'https://api.example.com/poll?id=req-123',
-      );
-      expect(server.calls[2].requestMethod).toBe('GET');
-      expect(server.calls[2].requestUrl).toBe(
-        'https://api.example.com/image.png',
-      );
-    });
-
-    it('merges provider and request headers for submit call', async () => {
-      const modelWithHeaders = createBasicModel({
-        headers: () => ({
-          'Custom-Provider-Header': 'provider-header-value',
-          'x-key': 'test-key',
-        }),
-      });
-
-      await modelWithHeaders.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        providerOptions: {},
-        headers: {
-          'Custom-Request-Header': 'request-header-value',
-        },
-        size: undefined,
-        seed: undefined,
-        aspectRatio: undefined,
-      });
-
-      expect(server.calls[0].requestHeaders).toStrictEqual({
-        'content-type': 'application/json',
-        'custom-provider-header': 'provider-header-value',
-        'custom-request-header': 'request-header-value',
-        'x-key': 'test-key',
-      });
-    });
-
-    it('passes merged headers to polling requests', async () => {
-      const modelWithHeaders = createBasicModel({
-        headers: () => ({
-          'Custom-Provider-Header': 'provider-header-value',
-          'x-key': 'test-key',
-        }),
-      });
-
-      await modelWithHeaders.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        providerOptions: {},
-        headers: {
-          'Custom-Request-Header': 'request-header-value',
-        },
-        size: undefined,
-        seed: undefined,
-        aspectRatio: undefined,
-      });
-
-      expect(server.calls[1].requestHeaders).toStrictEqual({
-        'custom-provider-header': 'provider-header-value',
-        'custom-request-header': 'request-header-value',
-        'x-key': 'test-key',
-      });
-    });
-
-    it('warns and derives aspect_ratio when size is provided', async () => {
-      const model = createBasicModel();
-
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: '1024x1024',
-        providerOptions: {},
-        seed: undefined,
-        aspectRatio: undefined,
-      });
-
-      expect(result.warnings).toMatchInlineSnapshot(`
-        [
-          {
-            "details": "Deriving aspect_ratio from size. Use the width and height provider options to specify dimensions for models that support them.",
-            "feature": "size",
-            "type": "unsupported",
-          },
-        ]
-      `);
-    });
-
-    it('warns and ignores size when both size and aspectRatio are provided', async () => {
-      const model = createBasicModel();
-
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: '1920x1080',
-        providerOptions: {},
-        seed: undefined,
-        aspectRatio: '16:9',
-      });
-
-      expect(result.warnings).toMatchInlineSnapshot(`
-        [
-          {
-            "details": "Black Forest Labs ignores size when aspectRatio is provided. Use the width and height provider options to specify dimensions for models that support them",
-            "feature": "size",
-            "type": "unsupported",
-          },
-        ]
-      `);
-    });
-
-    it('handles API errors with message and detail', async () => {
-      server.urls['https://api.example.com/v1/test-model'].response = {
-        type: 'error',
-        status: 400,
-        body: JSON.stringify({
-          message: 'Top-level message',
-          detail: { error: 'Invalid prompt' },
-        }),
-      };
-
-      const model = createBasicModel();
-
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          providerOptions: {},
-          size: undefined,
-          seed: undefined,
-          aspectRatio: undefined,
-        }),
-      ).rejects.toMatchObject({
-        message: '{"error":"Invalid prompt"}',
-        statusCode: 400,
-        url: 'https://api.example.com/v1/test-model',
-      });
-    });
-
-    it('handles poll responses with state instead of status', async () => {
-      server.urls['https://api.example.com/poll'].response = {
-        type: 'json-value',
-        body: {
-          state: 'Ready',
-          result: {
-            sample: 'https://api.example.com/image.png',
-          },
-        },
-      };
-
-      const model = createBasicModel();
-
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      expect(result.images).toHaveLength(1);
-      expect(result.images[0]).toBeInstanceOf(Uint8Array);
-    });
-
-    it('polls multiple times using configured interval until Ready', async () => {
-      let pollHitCount = 0;
-      server.urls['https://api.example.com/poll'].response = () => {
-        pollHitCount += 1;
-        if (pollHitCount < 3) {
-          return {
-            type: 'json-value',
-            body: { status: 'Pending' },
-          };
-        }
-        return {
-          type: 'json-value',
-          body: {
-            status: 'Ready',
-            result: { sample: 'https://api.example.com/image.png' },
-          },
-        };
-      };
-
-      const model = createBasicModel({
-        pollIntervalMillis: 10,
-        pollTimeoutMillis: 1000,
-      });
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      });
-
-      const pollCalls = server.calls.filter(
-        c =>
-          c.requestMethod === 'GET' &&
-          c.requestUrl.startsWith('https://api.example.com/poll'),
-      );
-      expect(pollCalls.length).toBe(3);
-    });
-
-    it('uses configured pollTimeoutMillis and pollIntervalMillis to time out', async () => {
-      server.urls['https://api.example.com/poll'].response = ({
-        callNumber,
-      }) => ({
-        type: 'json-value',
-        body: { status: 'Pending', callNumber },
-      });
-
-      const pollIntervalMillis = 10;
-      const pollTimeoutMillis = 25;
-      const model = createBasicModel({
-        pollIntervalMillis,
-        pollTimeoutMillis,
-      });
-
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          seed: undefined,
-          aspectRatio: '1:1',
-          providerOptions: {},
-        }),
-      ).rejects.toThrow('Black Forest Labs generation timed out.');
-
-      const pollCalls = server.calls.filter(
-        c =>
-          c.requestMethod === 'GET' &&
-          c.requestUrl.startsWith('https://api.example.com/poll'),
-      );
-      expect(pollCalls.length).toBe(
-        Math.ceil(pollTimeoutMillis / pollIntervalMillis),
-      );
-      const imageFetchCalls = server.calls.filter(c =>
-        c.requestUrl.startsWith('https://api.example.com/image.png'),
-      );
-      expect(imageFetchCalls.length).toBe(0);
-    });
-
-    it('throws when poll is Ready but sample is missing', async () => {
-      server.urls['https://api.example.com/poll'].response = {
-        type: 'json-value',
-        body: {
-          status: 'Ready',
-          result: null,
-        },
-      };
-
-      const model = createBasicModel();
-
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          seed: undefined,
-          aspectRatio: '1:1',
-          providerOptions: {},
-        }),
-      ).rejects.toThrow(
-        'Black Forest Labs poll response is Ready but missing result.sample',
-      );
-    });
-
-    it('throws when poll returns Error or Failed', async () => {
-      server.urls['https://api.example.com/poll'].response = {
-        type: 'json-value',
-        body: {
-          status: 'Error',
-        },
-      };
-
-      const model = createBasicModel();
-
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          seed: undefined,
-          aspectRatio: '1:1',
-          providerOptions: {},
-        }),
-      ).rejects.toThrow('Black Forest Labs generation failed.');
-    });
-
-    it('includes timestamp, headers, and modelId in response metadata', async () => {
-      const testDate = new Date('2025-01-01T00:00:00Z');
-      const model = createBasicModel({
-        currentDate: () => testDate,
-      });
-
-      const result = await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        providerOptions: {},
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-      });
-
-      expect(result.response).toStrictEqual({
-        timestamp: testDate,
-        modelId: 'test-model',
-        headers: expect.any(Object),
-      });
-    });
-  });
-
-  describe('constructor', () => {
-    it('exposes correct provider and model information', () => {
-      const model = createBasicModel();
-
-      expect(model.provider).toBe('black-forest-labs.image');
-      expect(model.modelId).toBe('test-model');
-      expect(model.specificationVersion).toBe('v3');
-      expect(model.maxImagesPerCall).toBe(1);
-    });
-  });
-});

package/src/black-forest-labs-provider.test.ts

@@ -1,139 +0,0 @@
-import { createTestServer } from '@ai-sdk/test-server/with-vitest';
-import { describe, expect, it } from 'vitest';
-import { createBlackForestLabs } from './black-forest-labs-provider';
-
-const server = createTestServer({
-  'https://api.example.com/v1/flux-pro-1.1': {
-    response: {
-      type: 'json-value',
-      body: {
-        id: 'req-123',
-        polling_url: 'https://api.example.com/poll',
-      },
-    },
-  },
-  'https://api.example.com/poll': {
-    response: {
-      type: 'json-value',
-      body: {
-        status: 'Ready',
-        result: {
-          sample: 'https://api.example.com/image.png',
-        },
-      },
-    },
-  },
-  'https://api.example.com/image.png': {
-    response: {
-      type: 'binary',
-      body: Buffer.from([1, 2, 3]),
-    },
-  },
-});
-
-describe('BlackForestLabs provider', () => {
-  it('creates image models via .image and .imageModel', () => {
-    const provider = createBlackForestLabs();
-
-    const imageModel = provider.image('flux-pro-1.1');
-    const imageModel2 = provider.imageModel('flux-pro-1.1-ultra');
-
-    expect(imageModel.provider).toBe('black-forest-labs.image');
-    expect(imageModel.modelId).toBe('flux-pro-1.1');
-    expect(imageModel2.modelId).toBe('flux-pro-1.1-ultra');
-    expect(imageModel.specificationVersion).toBe('v3');
-  });
-
-  it('configures baseURL and headers correctly', async () => {
-    const provider = createBlackForestLabs({
-      apiKey: 'test-api-key',
-      baseURL: 'https://api.example.com/v1',
-      headers: {
-        'x-extra-header': 'extra',
-      },
-    });
-
-    const model = provider.image('flux-pro-1.1');
-
-    await model.doGenerate({
-      prompt: 'A serene mountain landscape at sunset',
-      files: undefined,
-      mask: undefined,
-      n: 1,
-      size: undefined,
-      seed: undefined,
-      aspectRatio: '1:1',
-      providerOptions: {},
-    });
-
-    expect(server.calls[0].requestUrl).toBe(
-      'https://api.example.com/v1/flux-pro-1.1',
-    );
-    expect(server.calls[0].requestMethod).toBe('POST');
-    expect(server.calls[0].requestHeaders['x-key']).toBe('test-api-key');
-    expect(server.calls[0].requestHeaders['x-extra-header']).toBe('extra');
-    expect(await server.calls[0].requestBodyJson).toMatchObject({
-      prompt: 'A serene mountain landscape at sunset',
-      aspect_ratio: '1:1',
-    });
-
-    expect(server.calls[0].requestUserAgent).toContain(
-      'ai-sdk/black-forest-labs/',
-    );
-    expect(server.calls[1].requestUserAgent).toContain(
-      'ai-sdk/black-forest-labs/',
-    );
-    expect(server.calls[2].requestUserAgent).toContain(
-      'ai-sdk/black-forest-labs/',
-    );
-  });
-
-  it('uses provider polling options for timeout behavior', async () => {
-    server.urls['https://api.example.com/poll'].response = ({
-      callNumber,
-    }) => ({
-      type: 'json-value',
-      body: { status: 'Pending', callNumber },
-    });
-
-    const provider = createBlackForestLabs({
-      apiKey: 'test-api-key',
-      baseURL: 'https://api.example.com/v1',
-      pollIntervalMillis: 10,
-      pollTimeoutMillis: 25,
-    });
-
-    const model = provider.image('flux-pro-1.1');
-
-    await expect(
-      model.doGenerate({
-        prompt: 'Timeout test',
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        seed: undefined,
-        aspectRatio: '1:1',
-        providerOptions: {},
-      }),
-    ).rejects.toThrow('Black Forest Labs generation timed out.');
-
-    const pollCalls = server.calls.filter(
-      c =>
-        c.requestMethod === 'GET' &&
-        c.requestUrl.startsWith('https://api.example.com/poll'),
-    );
-    expect(pollCalls.length).toBe(3);
-  });
-
-  it('throws NoSuchModelError for unsupported model types', () => {
-    const provider = createBlackForestLabs();
-
-    expect(() => provider.languageModel('some-id')).toThrowError(
-      'No such languageModel',
-    );
-    expect(() => provider.embeddingModel('some-id')).toThrowError(
-      'No such embeddingModel',
-    );
-  });
-});