@ai-sdk/fireworks 2.0.17 → 2.0.19

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/fireworks
 
+## 2.0.19
+
+### Patch Changes
+
+- 4de5a1d: chore: excluded tests from src folder in npm package
+- Updated dependencies [4de5a1d]
+  - @ai-sdk/openai-compatible@2.0.18
+  - @ai-sdk/provider@3.0.5
+  - @ai-sdk/provider-utils@4.0.9
+
+## 2.0.18
+
+### Patch Changes
+
+- 2b8369d: chore: add docs to package dist
+
 ## 2.0.17
 
 ### Patch Changes

package/dist/index.js

@@ -174,7 +174,7 @@ var import_provider_utils2 = require("@ai-sdk/provider-utils");
 var import_v4 = require("zod/v4");
 
 // src/version.ts
-var VERSION = true ? "2.0.17" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/fireworks-provider.ts
 var fireworksErrorSchema = import_v4.z.object({

package/dist/index.mjs

@@ -159,7 +159,7 @@ import {
 import { z } from "zod/v4";
 
 // src/version.ts
-var VERSION = true ? "2.0.17" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/fireworks-provider.ts
 var fireworksErrorSchema = z.object({

package/docs/26-fireworks.mdx

@@ -0,0 +1,289 @@
+---
+title: Fireworks
+description: Learn how to use Fireworks models with the AI SDK.
+---
+
+# Fireworks Provider
+
+[Fireworks](https://fireworks.ai/) is a platform for running and testing LLMs through their [API](https://readme.fireworks.ai/).
+
+## Setup
+
+The Fireworks provider is available via the `@ai-sdk/fireworks` module. You can install it with
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/fireworks" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/fireworks" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/fireworks" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/fireworks" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `fireworks` from `@ai-sdk/fireworks`:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+```
+
+If you need a customized setup, you can import `createFireworks` from `@ai-sdk/fireworks`
+and create a provider instance with your settings:
+
+```ts
+import { createFireworks } from '@ai-sdk/fireworks';
+
+const fireworks = createFireworks({
+  apiKey: process.env.FIREWORKS_API_KEY ?? '',
+});
+```
+
+You can use the following optional settings to customize the Fireworks provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://api.fireworks.ai/inference/v1`.
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header. It defaults to
+  the `FIREWORKS_API_KEY` environment variable.
+
+- **headers** _Record&lt;string,string&gt;_
+
+  Custom headers to include in the requests.
+
+- **fetch** _(input: RequestInfo, init?: RequestInit) => Promise&lt;Response&gt;_
+
+  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
+
+## Language Models
+
+You can create [Fireworks models](https://fireworks.ai/models) using a provider instance.
+The first argument is the model id, e.g. `accounts/fireworks/models/firefunction-v1`:
+
+```ts
+const model = fireworks('accounts/fireworks/models/firefunction-v1');
+```
+
+### Reasoning Models
+
+Fireworks exposes the thinking of `deepseek-r1` in the generated text using the `<think>` tag.
+You can use the `extractReasoningMiddleware` to extract this reasoning and expose it as a `reasoning` property on the result:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { wrapLanguageModel, extractReasoningMiddleware } from 'ai';
+
+const enhancedModel = wrapLanguageModel({
+  model: fireworks('accounts/fireworks/models/deepseek-r1'),
+  middleware: extractReasoningMiddleware({ tagName: 'think' }),
+});
+```
+
+You can then use that enhanced model in functions like `generateText` and `streamText`.
+
+### Example
+
+You can use Fireworks language models to generate text with the `generateText` function:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: fireworks('accounts/fireworks/models/firefunction-v1'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+```
+
+Fireworks language models can also be used in the `streamText` function
+(see [AI SDK Core](/docs/ai-sdk-core)).
+
+### Completion Models
+
+You can create models that call the Fireworks completions API using the `.completion()` factory method:
+
+```ts
+const model = fireworks.completion('accounts/fireworks/models/firefunction-v1');
+```
+
+### Model Capabilities
+
+| Model                                                      | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      |
+| ---------------------------------------------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
+| `accounts/fireworks/models/firefunction-v1`                | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `accounts/fireworks/models/deepseek-r1`                    | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/deepseek-v3`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p1-405b-instruct`       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `accounts/fireworks/models/llama-v3p1-8b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p2-3b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p3-70b-instruct`        | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x7b-instruct`          | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x7b-instruct-hf`       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/mixtral-8x22b-instruct`         | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2p5-coder-32b-instruct`     | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2p5-72b-instruct`           | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen-qwq-32b-preview`           | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwen2-vl-72b-instruct`          | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/llama-v3p2-11b-vision-instruct` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/qwq-32b`                        | <Cross size={18} /> | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/yi-large`                       | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| `accounts/fireworks/models/kimi-k2-instruct`               | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+
+<Note>
+  The table above lists popular models. Please see the [Fireworks models
+  page](https://fireworks.ai/models) for a full list of available models.
+</Note>
+
+## Embedding Models
+
+You can create models that call the Fireworks embeddings API using the `.embedding()` factory method:
+
+```ts
+const model = fireworks.embedding('nomic-ai/nomic-embed-text-v1.5');
+```
+
+You can use Fireworks embedding models to generate embeddings with the `embed` function:
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { embed } from 'ai';
+
+const { embedding } = await embed({
+  model: fireworks.embedding('nomic-ai/nomic-embed-text-v1.5'),
+  value: 'sunny day at the beach',
+});
+```
+
+### Model Capabilities
+
+| Model                            | Dimensions | Max Tokens |
+| -------------------------------- | ---------- | ---------- |
+| `nomic-ai/nomic-embed-text-v1.5` | 768        | 8192       |
+
+<Note>
+  For more embedding models, see the [Fireworks models
+  page](https://fireworks.ai/models) for a full list of available models.
+</Note>
+
+## Image Models
+
+You can create Fireworks image models using the `.image()` factory method.
+For more on image generation with the AI SDK see [generateImage()](/docs/reference/ai-sdk-core/generate-image).
+
+```ts
+import { fireworks } from '@ai-sdk/fireworks';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-1-dev-fp8'),
+  prompt: 'A futuristic cityscape at sunset',
+  aspectRatio: '16:9',
+});
+```
+
+<Note>
+  Model support for `size` and `aspectRatio` parameters varies. See the [Model
+  Capabilities](#model-capabilities-1) section below for supported dimensions,
+  or check the model's documentation on [Fireworks models
+  page](https://fireworks.ai/models) for more details.
+</Note>
+
+### Image Editing
+
+Fireworks supports image editing through FLUX Kontext models (`flux-kontext-pro` and `flux-kontext-max`). Pass input images via `prompt.images` to transform or edit existing images.
+
+<Note>
+  Fireworks Kontext models do not support explicit masks. Editing is
+  prompt-driven — describe what you want to change in the text prompt.
+</Note>
+
+#### Basic Image Editing
+
+Transform an existing image using text prompts:
+
+```ts
+const imageBuffer = readFileSync('./input-image.png');
+
+const { images } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-kontext-pro'),
+  prompt: {
+    text: 'Turn the cat into a golden retriever dog',
+    images: [imageBuffer],
+  },
+  providerOptions: {
+    fireworks: {
+      output_format: 'jpeg',
+    },
+  },
+});
+```
+
+#### Style Transfer
+
+Apply artistic styles to an image:
+
+```ts
+const imageBuffer = readFileSync('./input-image.png');
+
+const { images } = await generateImage({
+  model: fireworks.image('accounts/fireworks/models/flux-kontext-pro'),
+  prompt: {
+    text: 'Transform this into a watercolor painting style',
+    images: [imageBuffer],
+  },
+  aspectRatio: '1:1',
+});
+```
+
+<Note>
+  Input images can be provided as `Buffer`, `ArrayBuffer`, `Uint8Array`, or
+  base64-encoded strings. Fireworks only supports a single input image per
+  request.
+</Note>
+
+### Model Capabilities
+
+For all models supporting aspect ratios, the following aspect ratios are supported:
+
+`1:1 (default), 2:3, 3:2, 4:5, 5:4, 16:9, 9:16, 9:21, 21:9`
+
+For all models supporting size, the following sizes are supported:
+
+`640 x 1536, 768 x 1344, 832 x 1216, 896 x 1152, 1024x1024 (default), 1152 x 896, 1216 x 832, 1344 x 768, 1536 x 640`
+
+| Model                                                        | Dimensions Specification | Image Editing       |
+| ------------------------------------------------------------ | ------------------------ | ------------------- |
+| `accounts/fireworks/models/flux-kontext-pro`                 | Aspect Ratio             | <Check size={18} /> |
+| `accounts/fireworks/models/flux-kontext-max`                 | Aspect Ratio             | <Check size={18} /> |
+| `accounts/fireworks/models/flux-1-dev-fp8`                   | Aspect Ratio             | <Cross size={18} /> |
+| `accounts/fireworks/models/flux-1-schnell-fp8`               | Aspect Ratio             | <Cross size={18} /> |
+| `accounts/fireworks/models/playground-v2-5-1024px-aesthetic` | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/japanese-stable-diffusion-xl`     | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/playground-v2-1024px-aesthetic`   | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/SSD-1B`                           | Size                     | <Cross size={18} /> |
+| `accounts/fireworks/models/stable-diffusion-xl-1024-v1-0`    | Size                     | <Cross size={18} /> |
+
+For more details, see the [Fireworks models page](https://fireworks.ai/models).
+
+#### Stability AI Models
+
+Fireworks also presents several Stability AI models backed by Stability AI API
+keys and endpoint. The AI SDK Fireworks provider does not currently include
+support for these models:
+
+| Model ID                               |
+| -------------------------------------- |
+| `accounts/stability/models/sd3-turbo`  |
+| `accounts/stability/models/sd3-medium` |
+| `accounts/stability/models/sd3`        |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/fireworks",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,10 +8,18 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md"
   ],
+  "directories": {
+    "doc": "./docs"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -21,16 +29,16 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "2.0.17",
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/openai-compatible": "2.0.18",
+    "@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": {
@@ -56,7 +64,7 @@
   "scripts": {
     "build": "pnpm clean && tsup --tsconfig tsconfig.build.json",
     "build:watch": "pnpm clean && tsup --watch",
-    "clean": "del-cli dist *.tsbuildinfo",
+    "clean": "del-cli dist docs *.tsbuildinfo",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --build",
     "prettier-check": "prettier --check \"./**/*.ts*\"",

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

@@ -1,629 +0,0 @@
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import { createTestServer } from '@ai-sdk/test-server/with-vitest';
-import { describe, expect, it, vi } from 'vitest';
-import { FireworksImageModel } from './fireworks-image-model';
-
-const prompt = 'A cute baby sea otter';
-
-function createBasicModel({
-  headers,
-  fetch,
-  currentDate,
-}: {
-  headers?: () => Record<string, string>;
-  fetch?: FetchFunction;
-  currentDate?: () => Date;
-} = {}) {
-  return new FireworksImageModel('accounts/fireworks/models/flux-1-dev-fp8', {
-    provider: 'fireworks',
-    baseURL: 'https://api.example.com',
-    headers: headers ?? (() => ({ 'api-key': 'test-key' })),
-    fetch,
-    _internal: {
-      currentDate,
-    },
-  });
-}
-
-function createSizeModel() {
-  return new FireworksImageModel(
-    'accounts/fireworks/models/playground-v2-5-1024px-aesthetic',
-    {
-      provider: 'fireworks',
-      baseURL: 'https://api.size-example.com',
-      headers: () => ({ 'api-key': 'test-key' }),
-    },
-  );
-}
-
-describe('FireworksImageModel', () => {
-  const server = createTestServer({
-    'https://api.example.com/*': {
-      response: {
-        type: 'binary',
-        body: Buffer.from('test-binary-content'),
-      },
-    },
-    'https://api.size-example.com/*': {
-      response: {
-        type: 'binary',
-        body: Buffer.from('test-binary-content'),
-      },
-    },
-  });
-
-  describe('doGenerate', () => {
-    it('should pass the correct parameters including aspect ratio and seed', async () => {
-      const model = createBasicModel();
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: '16:9',
-        seed: 42,
-        providerOptions: { fireworks: { additional_param: 'value' } },
-      });
-
-      expect(await server.calls[0].requestBodyJson).toStrictEqual({
-        prompt,
-        aspect_ratio: '16:9',
-        seed: 42,
-        samples: 1,
-        additional_param: 'value',
-      });
-    });
-
-    it('should call the correct url', async () => {
-      const model = createBasicModel();
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: '16:9',
-        seed: 42,
-        providerOptions: { fireworks: { additional_param: 'value' } },
-      });
-
-      expect(server.calls[0].requestMethod).toStrictEqual('POST');
-      expect(server.calls[0].requestUrl).toStrictEqual(
-        'https://api.example.com/workflows/accounts/fireworks/models/flux-1-dev-fp8/text_to_image',
-      );
-    });
-
-    it('should pass headers', async () => {
-      const modelWithHeaders = createBasicModel({
-        headers: () => ({
-          'Custom-Provider-Header': 'provider-header-value',
-        }),
-      });
-
-      await modelWithHeaders.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-        headers: {
-          'Custom-Request-Header': 'request-header-value',
-        },
-      });
-
-      expect(server.calls[0].requestHeaders).toStrictEqual({
-        'content-type': 'application/json',
-        'custom-provider-header': 'provider-header-value',
-        'custom-request-header': 'request-header-value',
-      });
-    });
-
-    it('should handle empty response body', async () => {
-      server.urls['https://api.example.com/*'].response = {
-        type: 'empty',
-      };
-
-      const model = createBasicModel();
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          aspectRatio: undefined,
-          seed: undefined,
-          providerOptions: {},
-        }),
-      ).rejects.toMatchObject({
-        message: 'Response body is empty',
-        statusCode: 200,
-        url: 'https://api.example.com/workflows/accounts/fireworks/models/flux-1-dev-fp8/text_to_image',
-        requestBodyValues: {
-          prompt: 'A cute baby sea otter',
-        },
-      });
-    });
-
-    it('should handle API errors', async () => {
-      server.urls['https://api.example.com/*'].response = {
-        type: 'error',
-        status: 400,
-        body: 'Bad Request',
-      };
-
-      const model = createBasicModel();
-      await expect(
-        model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          aspectRatio: undefined,
-          seed: undefined,
-          providerOptions: {},
-        }),
-      ).rejects.toMatchObject({
-        message: 'Bad Request',
-        statusCode: 400,
-        url: 'https://api.example.com/workflows/accounts/fireworks/models/flux-1-dev-fp8/text_to_image',
-        requestBodyValues: {
-          prompt: 'A cute baby sea otter',
-        },
-        responseBody: 'Bad Request',
-      });
-    });
-
-    it('should handle size parameter for supported models', async () => {
-      const sizeModel = createSizeModel();
-
-      await sizeModel.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: '1024x768',
-        aspectRatio: undefined,
-        seed: 42,
-        providerOptions: {},
-      });
-
-      expect(await server.calls[0].requestBodyJson).toStrictEqual({
-        prompt,
-        width: '1024',
-        height: '768',
-        seed: 42,
-        samples: 1,
-      });
-    });
-
-    describe('warnings', () => {
-      it('should return size warning on workflow model', async () => {
-        const model = createBasicModel();
-
-        const result1 = await model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: '1024x1024',
-          aspectRatio: '1:1',
-          seed: 123,
-          providerOptions: {},
-        });
-
-        expect(result1.warnings).toMatchInlineSnapshot(`
-          [
-            {
-              "details": "This model does not support the \`size\` option. Use \`aspectRatio\` instead.",
-              "feature": "size",
-              "type": "unsupported",
-            },
-          ]
-        `);
-      });
-
-      it('should return aspectRatio warning on size-supporting model', async () => {
-        const sizeModel = createSizeModel();
-
-        const result2 = await sizeModel.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: '1024x1024',
-          aspectRatio: '1:1',
-          seed: 123,
-          providerOptions: {},
-        });
-
-        expect(result2.warnings).toMatchInlineSnapshot(`
-          [
-            {
-              "details": "This model does not support the \`aspectRatio\` option.",
-              "feature": "aspectRatio",
-              "type": "unsupported",
-            },
-          ]
-        `);
-      });
-    });
-
-    it('should respect the abort signal', async () => {
-      const model = createBasicModel();
-      const controller = new AbortController();
-
-      const generatePromise = model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-        abortSignal: controller.signal,
-      });
-
-      controller.abort();
-
-      await expect(generatePromise).rejects.toThrow(
-        'This operation was aborted',
-      );
-    });
-
-    it('should use custom fetch function when provided', async () => {
-      const mockFetch = vi.fn().mockResolvedValue(
-        new Response(Buffer.from('mock-image-data'), {
-          status: 200,
-        }),
-      );
-
-      const model = createBasicModel({
-        fetch: mockFetch,
-      });
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      expect(mockFetch).toHaveBeenCalled();
-    });
-
-    it('should pass samples parameter to API', async () => {
-      const model = createBasicModel();
-
-      await model.doGenerate({
-        prompt,
-        files: undefined,
-        mask: undefined,
-        n: 42,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      expect(await server.calls[0].requestBodyJson).toHaveProperty(
-        'samples',
-        42,
-      );
-    });
-
-    describe('response metadata', () => {
-      it('should include timestamp, headers and modelId in response', async () => {
-        const testDate = new Date('2024-01-01T00:00:00Z');
-        const model = createBasicModel({
-          currentDate: () => testDate,
-        });
-
-        const result = await model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          aspectRatio: undefined,
-          seed: undefined,
-          providerOptions: {},
-        });
-
-        expect(result.response).toStrictEqual({
-          timestamp: testDate,
-          modelId: 'accounts/fireworks/models/flux-1-dev-fp8',
-          headers: expect.any(Object),
-        });
-      });
-
-      it('should include response headers from API call', async () => {
-        server.urls['https://api.example.com/*'].response = {
-          type: 'binary',
-          body: Buffer.from('test-binary-content'),
-          headers: {
-            'x-request-id': 'test-request-id',
-            'content-type': 'image/png',
-          },
-        };
-
-        const model = createBasicModel();
-        const result = await model.doGenerate({
-          prompt,
-          files: undefined,
-          mask: undefined,
-          n: 1,
-          size: undefined,
-          aspectRatio: undefined,
-          seed: undefined,
-          providerOptions: {},
-        });
-
-        expect(result.response.headers).toStrictEqual({
-          'content-length': '19',
-          'x-request-id': 'test-request-id',
-          'content-type': 'image/png',
-        });
-      });
-    });
-  });
-
-  describe('constructor', () => {
-    it('should expose correct provider and model information', () => {
-      const model = createBasicModel();
-
-      expect(model.provider).toBe('fireworks');
-      expect(model.modelId).toBe('accounts/fireworks/models/flux-1-dev-fp8');
-      expect(model.specificationVersion).toBe('v3');
-      expect(model.maxImagesPerCall).toBe(1);
-    });
-  });
-
-  describe('Image Editing', () => {
-    const editServer = createTestServer({
-      'https://api.edit.example.com/*': {
-        response: {
-          type: 'binary',
-          body: Buffer.from('edited-image-data'),
-        },
-      },
-    });
-
-    function createKontextModel() {
-      return new FireworksImageModel(
-        'accounts/fireworks/models/flux-kontext-pro',
-        {
-          provider: 'fireworks',
-          baseURL: 'https://api.edit.example.com',
-          headers: () => ({ 'api-key': 'test-key' }),
-        },
-      );
-    }
-
-    it('should send edit request with files as data URI', async () => {
-      const imageData = new Uint8Array([137, 80, 78, 71]); // PNG magic bytes
-
-      await createKontextModel().doGenerate({
-        prompt: 'Turn the cat into a dog',
-        files: [
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      const requestBody = await editServer.calls[0].requestBodyJson;
-      expect(requestBody).toMatchInlineSnapshot(`
-        {
-          "input_image": "data:image/png;base64,iVBORw==",
-          "prompt": "Turn the cat into a dog",
-          "samples": 1,
-        }
-      `);
-    });
-
-    it('should use correct URL for Kontext model (no text_to_image suffix)', async () => {
-      const imageData = new Uint8Array([137, 80, 78, 71]);
-
-      await createKontextModel().doGenerate({
-        prompt: 'Edit this image',
-        files: [
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      expect(editServer.calls[0].requestUrl).toBe(
-        'https://api.edit.example.com/workflows/accounts/fireworks/models/flux-kontext-pro',
-      );
-    });
-
-    it('should send edit request with URL-based file', async () => {
-      await createKontextModel().doGenerate({
-        prompt: 'Edit this image',
-        files: [
-          {
-            type: 'url',
-            url: 'https://example.com/input.png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      const requestBody = await editServer.calls[0].requestBodyJson;
-      expect(requestBody).toMatchInlineSnapshot(`
-        {
-          "input_image": "https://example.com/input.png",
-          "prompt": "Edit this image",
-          "samples": 1,
-        }
-      `);
-    });
-
-    it('should send edit request with base64 string data', async () => {
-      await createKontextModel().doGenerate({
-        prompt: 'Edit this image',
-        files: [
-          {
-            type: 'file',
-            data: 'iVBORw0KGgoAAAANSUhEUgAAAAE=',
-            mediaType: 'image/png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      const requestBody = await editServer.calls[0].requestBodyJson;
-      expect(requestBody).toMatchInlineSnapshot(`
-        {
-          "input_image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAE=",
-          "prompt": "Edit this image",
-          "samples": 1,
-        }
-      `);
-    });
-
-    it('should warn when multiple files are provided', async () => {
-      const imageData = new Uint8Array([137, 80, 78, 71]);
-
-      const result = await createKontextModel().doGenerate({
-        prompt: 'Edit images',
-        files: [
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      expect(result.warnings).toContainEqual({
-        type: 'other',
-        message:
-          'Fireworks only supports a single input image. Additional images are ignored.',
-      });
-    });
-
-    it('should warn when mask is provided', async () => {
-      const imageData = new Uint8Array([137, 80, 78, 71]);
-      const maskData = new Uint8Array([255, 255, 255, 0]);
-
-      const result = await createKontextModel().doGenerate({
-        prompt: 'Edit with mask',
-        files: [
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-        ],
-        mask: {
-          type: 'file',
-          data: maskData,
-          mediaType: 'image/png',
-        },
-        n: 1,
-        size: undefined,
-        aspectRatio: undefined,
-        seed: undefined,
-        providerOptions: {},
-      });
-
-      expect(result.warnings).toContainEqual({
-        type: 'unsupported',
-        feature: 'mask',
-        details:
-          'Fireworks Kontext models do not support explicit masks. Use the prompt to describe the areas to edit.',
-      });
-    });
-
-    it('should pass provider options with edit request', async () => {
-      const imageData = new Uint8Array([137, 80, 78, 71]);
-
-      await createKontextModel().doGenerate({
-        prompt: 'Edit with options',
-        files: [
-          {
-            type: 'file',
-            data: imageData,
-            mediaType: 'image/png',
-          },
-        ],
-        mask: undefined,
-        n: 1,
-        size: undefined,
-        aspectRatio: '16:9',
-        seed: 42,
-        providerOptions: {
-          fireworks: {
-            output_format: 'jpeg',
-            safety_tolerance: 2,
-          },
-        },
-      });
-
-      const requestBody = await editServer.calls[0].requestBodyJson;
-      expect(requestBody).toMatchInlineSnapshot(`
-        {
-          "aspect_ratio": "16:9",
-          "input_image": "data:image/png;base64,iVBORw==",
-          "output_format": "jpeg",
-          "prompt": "Edit with options",
-          "safety_tolerance": 2,
-          "samples": 1,
-          "seed": 42,
-        }
-      `);
-    });
-  });
-});

package/src/fireworks-provider.test.ts

@@ -1,198 +0,0 @@
-import { describe, it, expect, vi, beforeEach, Mock } from 'vitest';
-import { createFireworks } from './fireworks-provider';
-import { LanguageModelV3, EmbeddingModelV3 } from '@ai-sdk/provider';
-import { loadApiKey } from '@ai-sdk/provider-utils';
-import {
-  OpenAICompatibleChatLanguageModel,
-  OpenAICompatibleCompletionLanguageModel,
-  OpenAICompatibleEmbeddingModel,
-} from '@ai-sdk/openai-compatible';
-import { FireworksImageModel } from './fireworks-image-model';
-
-// Add type assertion for the mocked class
-const OpenAICompatibleChatLanguageModelMock =
-  OpenAICompatibleChatLanguageModel as unknown as Mock;
-
-vi.mock('@ai-sdk/openai-compatible', () => {
-  // Create mock constructor functions that behave like classes
-  const createMockConstructor = (providerName: string) => {
-    const mockConstructor = vi.fn().mockImplementation(function (
-      this: any,
-      modelId: string,
-      settings: any,
-    ) {
-      this.provider = providerName;
-      this.modelId = modelId;
-      this.settings = settings;
-    });
-    return mockConstructor;
-  };
-
-  return {
-    OpenAICompatibleChatLanguageModel: createMockConstructor('fireworks.chat'),
-    OpenAICompatibleCompletionLanguageModel: createMockConstructor(
-      'fireworks.completion',
-    ),
-    OpenAICompatibleEmbeddingModel: createMockConstructor(
-      'fireworks.embedding',
-    ),
-  };
-});
-
-vi.mock('@ai-sdk/provider-utils', async () => {
-  const actual = await vi.importActual('@ai-sdk/provider-utils');
-  return {
-    ...actual,
-    loadApiKey: vi.fn().mockReturnValue('mock-api-key'),
-    withoutTrailingSlash: vi.fn(url => url),
-  };
-});
-
-vi.mock('./fireworks-image-model', () => ({
-  FireworksImageModel: vi.fn(),
-}));
-
-describe('FireworksProvider', () => {
-  let mockLanguageModel: LanguageModelV3;
-  let mockEmbeddingModel: EmbeddingModelV3;
-
-  beforeEach(() => {
-    // Mock implementations of models
-    mockLanguageModel = {
-      // Add any required methods for LanguageModelV3
-    } as LanguageModelV3;
-    mockEmbeddingModel = {
-      // Add any required methods for EmbeddingModelV3
-    } as EmbeddingModelV3;
-
-    // Reset mocks
-    vi.clearAllMocks();
-  });
-
-  describe('createFireworks', () => {
-    it('should create a FireworksProvider instance with default options', () => {
-      const provider = createFireworks();
-      const model = provider('model-id');
-
-      // Use the mocked version
-      const constructorCall =
-        OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[1];
-      config.headers();
-
-      expect(loadApiKey).toHaveBeenCalledWith({
-        apiKey: undefined,
-        environmentVariableName: 'FIREWORKS_API_KEY',
-        description: 'Fireworks API key',
-      });
-    });
-
-    it('should create a FireworksProvider instance with custom options', () => {
-      const options = {
-        apiKey: 'custom-key',
-        baseURL: 'https://custom.url',
-        headers: { 'Custom-Header': 'value' },
-      };
-      const provider = createFireworks(options);
-      const model = provider('model-id');
-
-      const constructorCall =
-        OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[1];
-      config.headers();
-
-      expect(loadApiKey).toHaveBeenCalledWith({
-        apiKey: 'custom-key',
-        environmentVariableName: 'FIREWORKS_API_KEY',
-        description: 'Fireworks API key',
-      });
-    });
-
-    it('should return a chat model when called as a function', () => {
-      const provider = createFireworks();
-      const modelId = 'foo-model-id';
-
-      const model = provider(modelId);
-      expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
-    });
-  });
-
-  describe('chatModel', () => {
-    it('should construct a chat model with correct configuration', () => {
-      const provider = createFireworks();
-      const modelId = 'fireworks-chat-model';
-
-      const model = provider.chatModel(modelId);
-
-      expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
-    });
-  });
-
-  describe('completionModel', () => {
-    it('should construct a completion model with correct configuration', () => {
-      const provider = createFireworks();
-      const modelId = 'fireworks-completion-model';
-
-      const model = provider.completionModel(modelId);
-
-      expect(model).toBeInstanceOf(OpenAICompatibleCompletionLanguageModel);
-    });
-  });
-
-  describe('embeddingModel', () => {
-    it('should construct a text embedding model with correct configuration', () => {
-      const provider = createFireworks();
-      const modelId = 'fireworks-embedding-model';
-
-      const model = provider.embeddingModel(modelId);
-
-      expect(model).toBeInstanceOf(OpenAICompatibleEmbeddingModel);
-    });
-  });
-
-  describe('image', () => {
-    it('should construct an image model with correct configuration', () => {
-      const provider = createFireworks();
-      const modelId = 'accounts/fireworks/models/flux-1-dev-fp8';
-
-      const model = provider.image(modelId);
-
-      expect(model).toBeInstanceOf(FireworksImageModel);
-      expect(FireworksImageModel).toHaveBeenCalledWith(
-        modelId,
-        expect.objectContaining({
-          provider: 'fireworks.image',
-          baseURL: 'https://api.fireworks.ai/inference/v1',
-        }),
-      );
-    });
-
-    it('should use default settings when none provided', () => {
-      const provider = createFireworks();
-      const modelId = 'accounts/fireworks/models/flux-1-dev-fp8';
-
-      const model = provider.image(modelId);
-
-      expect(model).toBeInstanceOf(FireworksImageModel);
-      expect(FireworksImageModel).toHaveBeenCalledWith(
-        modelId,
-        expect.any(Object),
-      );
-    });
-
-    it('should respect custom baseURL', () => {
-      const customBaseURL = 'https://custom.api.fireworks.ai';
-      const provider = createFireworks({ baseURL: customBaseURL });
-      const modelId = 'accounts/fireworks/models/flux-1-dev-fp8';
-
-      provider.image(modelId);
-
-      expect(FireworksImageModel).toHaveBeenCalledWith(
-        modelId,
-        expect.objectContaining({
-          baseURL: customBaseURL,
-        }),
-      );
-    });
-  });
-});