@ai-sdk/fireworks 0.0.0-8777c42a-20250115032312 → 0.0.0-98261322-20260122142521

package/src/fireworks-image-model.ts

@@ -0,0 +1,196 @@
+import { ImageModelV3, SharedV3Warning } from '@ai-sdk/provider';
+import {
+  combineHeaders,
+  convertImageModelFileToDataUri,
+  createBinaryResponseHandler,
+  createStatusCodeErrorResponseHandler,
+  FetchFunction,
+  postJsonToApi,
+} from '@ai-sdk/provider-utils';
+import { FireworksImageModelId } from './fireworks-image-options';
+
+interface FireworksImageModelBackendConfig {
+  urlFormat: 'workflows' | 'workflows_edit' | 'image_generation';
+  supportsSize?: boolean;
+  supportsEditing?: boolean;
+}
+
+const modelToBackendConfig: Partial<
+  Record<FireworksImageModelId, FireworksImageModelBackendConfig>
+> = {
+  'accounts/fireworks/models/flux-1-dev-fp8': {
+    urlFormat: 'workflows',
+  },
+  'accounts/fireworks/models/flux-1-schnell-fp8': {
+    urlFormat: 'workflows',
+  },
+  'accounts/fireworks/models/flux-kontext-pro': {
+    urlFormat: 'workflows_edit',
+    supportsEditing: true,
+  },
+  'accounts/fireworks/models/flux-kontext-max': {
+    urlFormat: 'workflows_edit',
+    supportsEditing: true,
+  },
+  'accounts/fireworks/models/playground-v2-5-1024px-aesthetic': {
+    urlFormat: 'image_generation',
+    supportsSize: true,
+  },
+  'accounts/fireworks/models/japanese-stable-diffusion-xl': {
+    urlFormat: 'image_generation',
+    supportsSize: true,
+  },
+  'accounts/fireworks/models/playground-v2-1024px-aesthetic': {
+    urlFormat: 'image_generation',
+    supportsSize: true,
+  },
+  'accounts/fireworks/models/stable-diffusion-xl-1024-v1-0': {
+    urlFormat: 'image_generation',
+    supportsSize: true,
+  },
+  'accounts/fireworks/models/SSD-1B': {
+    urlFormat: 'image_generation',
+    supportsSize: true,
+  },
+};
+
+function getUrlForModel(
+  baseUrl: string,
+  modelId: FireworksImageModelId,
+  hasInputImage: boolean,
+): string {
+  const config = modelToBackendConfig[modelId];
+
+  switch (config?.urlFormat) {
+    case 'image_generation':
+      return `${baseUrl}/image_generation/${modelId}`;
+    case 'workflows_edit':
+      // Kontext models: use base URL for editing (no suffix)
+      return `${baseUrl}/workflows/${modelId}`;
+    case 'workflows':
+    default:
+      // Standard FLUX models: use text_to_image for generation,
+      // but if input_image provided, some models may support editing
+      if (hasInputImage && config?.supportsEditing) {
+        return `${baseUrl}/workflows/${modelId}`;
+      }
+      return `${baseUrl}/workflows/${modelId}/text_to_image`;
+  }
+}
+
+interface FireworksImageModelConfig {
+  provider: string;
+  baseURL: string;
+  headers: () => Record<string, string>;
+  fetch?: FetchFunction;
+  _internal?: {
+    currentDate?: () => Date;
+  };
+}
+
+export class FireworksImageModel implements ImageModelV3 {
+  readonly specificationVersion = 'v3';
+  readonly maxImagesPerCall = 1;
+
+  get provider(): string {
+    return this.config.provider;
+  }
+
+  constructor(
+    readonly modelId: FireworksImageModelId,
+    private config: FireworksImageModelConfig,
+  ) {}
+
+  async doGenerate({
+    prompt,
+    n,
+    size,
+    aspectRatio,
+    seed,
+    providerOptions,
+    headers,
+    abortSignal,
+    files,
+    mask,
+  }: Parameters<ImageModelV3['doGenerate']>[0]): Promise<
+    Awaited<ReturnType<ImageModelV3['doGenerate']>>
+  > {
+    const warnings: Array<SharedV3Warning> = [];
+
+    const backendConfig = modelToBackendConfig[this.modelId];
+    if (!backendConfig?.supportsSize && size != null) {
+      warnings.push({
+        type: 'unsupported',
+        feature: 'size',
+        details:
+          'This model does not support the `size` option. Use `aspectRatio` instead.',
+      });
+    }
+
+    // Use supportsSize as a proxy for whether the model does not support
+    // aspectRatio. This invariant holds for the current set of models.
+    if (backendConfig?.supportsSize && aspectRatio != null) {
+      warnings.push({
+        type: 'unsupported',
+        feature: 'aspectRatio',
+        details: 'This model does not support the `aspectRatio` option.',
+      });
+    }
+
+    // Handle files for image editing
+    const hasInputImage = files != null && files.length > 0;
+    let inputImage: string | undefined;
+
+    if (hasInputImage) {
+      inputImage = convertImageModelFileToDataUri(files[0]);
+
+      if (files.length > 1) {
+        warnings.push({
+          type: 'other',
+          message:
+            'Fireworks only supports a single input image. Additional images are ignored.',
+        });
+      }
+    }
+
+    // Warn about mask - Fireworks Kontext models don't support explicit masks
+    if (mask != null) {
+      warnings.push({
+        type: 'unsupported',
+        feature: 'mask',
+        details:
+          'Fireworks Kontext models do not support explicit masks. Use the prompt to describe the areas to edit.',
+      });
+    }
+
+    const splitSize = size?.split('x');
+    const currentDate = this.config._internal?.currentDate?.() ?? new Date();
+    const { value: response, responseHeaders } = await postJsonToApi({
+      url: getUrlForModel(this.config.baseURL, this.modelId, hasInputImage),
+      headers: combineHeaders(this.config.headers(), headers),
+      body: {
+        prompt,
+        aspect_ratio: aspectRatio,
+        seed,
+        samples: n,
+        ...(inputImage && { input_image: inputImage }),
+        ...(splitSize && { width: splitSize[0], height: splitSize[1] }),
+        ...(providerOptions.fireworks ?? {}),
+      },
+      failedResponseHandler: createStatusCodeErrorResponseHandler(),
+      successfulResponseHandler: createBinaryResponseHandler(),
+      abortSignal,
+      fetch: this.config.fetch,
+    });
+
+    return {
+      images: [response],
+      warnings,
+      response: {
+        timestamp: currentDate,
+        modelId: this.modelId,
+        headers: responseHeaders,
+      },
+    };
+  }
+}

package/src/fireworks-image-options.ts

@@ -0,0 +1,12 @@
+// https://fireworks.ai/models?type=image
+export type FireworksImageModelId =
+  | 'accounts/fireworks/models/flux-1-dev-fp8'
+  | 'accounts/fireworks/models/flux-1-schnell-fp8'
+  | 'accounts/fireworks/models/flux-kontext-pro'
+  | 'accounts/fireworks/models/flux-kontext-max'
+  | 'accounts/fireworks/models/playground-v2-5-1024px-aesthetic'
+  | 'accounts/fireworks/models/japanese-stable-diffusion-xl'
+  | 'accounts/fireworks/models/playground-v2-1024px-aesthetic'
+  | 'accounts/fireworks/models/SSD-1B'
+  | 'accounts/fireworks/models/stable-diffusion-xl-1024-v1-0'
+  | (string & {});

package/src/fireworks-provider.test.ts

@@ -0,0 +1,198 @@
+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,
+        }),
+      );
+    });
+  });
+});

package/src/fireworks-provider.ts

@@ -0,0 +1,172 @@
+import {
+  OpenAICompatibleChatLanguageModel,
+  OpenAICompatibleCompletionLanguageModel,
+  OpenAICompatibleEmbeddingModel,
+  ProviderErrorStructure,
+} from '@ai-sdk/openai-compatible';
+import {
+  EmbeddingModelV3,
+  ImageModelV3,
+  LanguageModelV3,
+  ProviderV3,
+} from '@ai-sdk/provider';
+import {
+  FetchFunction,
+  loadApiKey,
+  withoutTrailingSlash,
+  withUserAgentSuffix,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+import { FireworksChatModelId } from './fireworks-chat-options';
+import { FireworksCompletionModelId } from './fireworks-completion-options';
+import { FireworksEmbeddingModelId } from './fireworks-embedding-options';
+import { FireworksImageModel } from './fireworks-image-model';
+import { FireworksImageModelId } from './fireworks-image-options';
+import { VERSION } from './version';
+
+export type FireworksErrorData = z.infer<typeof fireworksErrorSchema>;
+
+const fireworksErrorSchema = z.object({
+  error: z.string(),
+});
+
+const fireworksErrorStructure: ProviderErrorStructure<FireworksErrorData> = {
+  errorSchema: fireworksErrorSchema,
+  errorToMessage: data => data.error,
+};
+
+export interface FireworksProviderSettings {
+  /**
+Fireworks API key. Default value is taken from the `FIREWORKS_API_KEY`
+environment variable.
+*/
+  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;
+}
+
+export interface FireworksProvider extends ProviderV3 {
+  /**
+Creates a model for text generation.
+*/
+  (modelId: FireworksChatModelId): LanguageModelV3;
+
+  /**
+Creates a chat model for text generation.
+*/
+  chatModel(modelId: FireworksChatModelId): LanguageModelV3;
+
+  /**
+Creates a completion model for text generation.
+*/
+  completionModel(modelId: FireworksCompletionModelId): LanguageModelV3;
+
+  /**
+Creates a chat model for text generation.
+*/
+  languageModel(modelId: FireworksChatModelId): LanguageModelV3;
+
+  /**
+Creates a text embedding model for text generation.
+*/
+  embeddingModel(modelId: FireworksEmbeddingModelId): EmbeddingModelV3;
+
+  /**
+   * @deprecated Use `embeddingModel` instead.
+   */
+  textEmbeddingModel(modelId: FireworksEmbeddingModelId): EmbeddingModelV3;
+
+  /**
+Creates a model for image generation.
+*/
+  image(modelId: FireworksImageModelId): ImageModelV3;
+
+  /**
+Creates a model for image generation.
+*/
+  imageModel(modelId: FireworksImageModelId): ImageModelV3;
+}
+
+const defaultBaseURL = 'https://api.fireworks.ai/inference/v1';
+
+export function createFireworks(
+  options: FireworksProviderSettings = {},
+): FireworksProvider {
+  const baseURL = withoutTrailingSlash(options.baseURL ?? defaultBaseURL);
+  const getHeaders = () =>
+    withUserAgentSuffix(
+      {
+        Authorization: `Bearer ${loadApiKey({
+          apiKey: options.apiKey,
+          environmentVariableName: 'FIREWORKS_API_KEY',
+          description: 'Fireworks API key',
+        })}`,
+        ...options.headers,
+      },
+      `ai-sdk/fireworks/${VERSION}`,
+    );
+
+  interface CommonModelConfig {
+    provider: string;
+    url: ({ path }: { path: string }) => string;
+    headers: () => Record<string, string>;
+    fetch?: FetchFunction;
+  }
+
+  const getCommonModelConfig = (modelType: string): CommonModelConfig => ({
+    provider: `fireworks.${modelType}`,
+    url: ({ path }) => `${baseURL}${path}`,
+    headers: getHeaders,
+    fetch: options.fetch,
+  });
+
+  const createChatModel = (modelId: FireworksChatModelId) => {
+    return new OpenAICompatibleChatLanguageModel(modelId, {
+      ...getCommonModelConfig('chat'),
+      errorStructure: fireworksErrorStructure,
+    });
+  };
+
+  const createCompletionModel = (modelId: FireworksCompletionModelId) =>
+    new OpenAICompatibleCompletionLanguageModel(modelId, {
+      ...getCommonModelConfig('completion'),
+      errorStructure: fireworksErrorStructure,
+    });
+
+  const createEmbeddingModel = (modelId: FireworksEmbeddingModelId) =>
+    new OpenAICompatibleEmbeddingModel(modelId, {
+      ...getCommonModelConfig('embedding'),
+      errorStructure: fireworksErrorStructure,
+    });
+
+  const createImageModel = (modelId: FireworksImageModelId) =>
+    new FireworksImageModel(modelId, {
+      ...getCommonModelConfig('image'),
+      baseURL: baseURL ?? defaultBaseURL,
+    });
+
+  const provider = (modelId: FireworksChatModelId) => createChatModel(modelId);
+
+  provider.specificationVersion = 'v3' as const;
+  provider.completionModel = createCompletionModel;
+  provider.chatModel = createChatModel;
+  provider.languageModel = createChatModel;
+  provider.embeddingModel = createEmbeddingModel;
+  provider.textEmbeddingModel = createEmbeddingModel;
+  provider.image = createImageModel;
+  provider.imageModel = createImageModel;
+  return provider;
+}
+
+export const fireworks = createFireworks();

package/src/index.ts

@@ -0,0 +1,13 @@
+export type {
+  FireworksEmbeddingModelId,
+  FireworksEmbeddingProviderOptions,
+} from './fireworks-embedding-options';
+export { FireworksImageModel } from './fireworks-image-model';
+export type { FireworksImageModelId } from './fireworks-image-options';
+export { fireworks, createFireworks } from './fireworks-provider';
+export type {
+  FireworksProvider,
+  FireworksProviderSettings,
+  FireworksErrorData,
+} from './fireworks-provider';
+export { VERSION } from './version';

package/src/version.ts

@@ -0,0 +1,6 @@
+// Version string of this package injected at build time.
+declare const __PACKAGE_VERSION__: string | undefined;
+export const VERSION: string =
+  typeof __PACKAGE_VERSION__ !== 'undefined'
+    ? __PACKAGE_VERSION__
+    : '0.0.0-test';