@ai-sdk/black-forest-labs 0.0.0-1c33ba03-20260114162300

package/CHANGELOG.md

@@ -0,0 +1,332 @@
+# @ai-sdk/black-forest-labs
+
+## 0.0.0-1c33ba03-20260114162300
+
+### Patch Changes
+
+- Updated dependencies [261c011]
+  - @ai-sdk/provider-utils@0.0.0-1c33ba03-20260114162300
+
+## 1.0.6
+
+### Patch Changes
+
+- Updated dependencies [1b11dcb]
+  - @ai-sdk/provider-utils@4.0.6
+  - @ai-sdk/provider@3.0.3
+
+## 1.0.5
+
+### Patch Changes
+
+- Updated dependencies [34d1c8a]
+  - @ai-sdk/provider-utils@4.0.5
+
+## 1.0.4
+
+### Patch Changes
+
+- Updated dependencies [d937c8f]
+  - @ai-sdk/provider@3.0.2
+  - @ai-sdk/provider-utils@4.0.4
+
+## 1.0.3
+
+### Patch Changes
+
+- Updated dependencies [0b429d4]
+  - @ai-sdk/provider-utils@4.0.3
+
+## 1.0.2
+
+### Patch Changes
+
+- 863d34f: fix: trigger release to update `@latest`
+- Updated dependencies [863d34f]
+  - @ai-sdk/provider@3.0.1
+  - @ai-sdk/provider-utils@4.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [29264a3]
+  - @ai-sdk/provider-utils@4.0.1
+
+## 1.0.0
+
+### Major Changes
+
+- 8a9f0d4: feat(black-forest-labs): initial version
+
+### Patch Changes
+
+- 3922a5f: feat(provider/black-forest-labs): make polling timeout configurable
+- 8d9e8ad: chore(provider): remove generics from EmbeddingModelV3
+
+  Before
+
+  ```ts
+  model.textEmbeddingModel('my-model-id');
+  ```
+
+  After
+
+  ```ts
+  model.embeddingModel('my-model-id');
+  ```
+
+- cd3b71c: feat (provider/black-forest-labs): include cost and megapixels in metadata
+- 457318b: chore(provider,ai): switch to SharedV3Warning and unified warnings
+- 9061dc0: feat: image editing
+- 366f50b: chore(provider): add deprecated textEmbeddingModel and textEmbedding aliases
+- b8e77ef: feat(provider/black-forest-labs): Add new provider options
+- 666bd16: fix (provider/black-forest-labs): allow null for cost and megapixel in provider response
+- Updated dependencies
+  - @ai-sdk/provider@3.0.0
+  - @ai-sdk/provider-utils@4.0.0
+
+## 1.0.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [475189e]
+  - @ai-sdk/provider@3.0.0-beta.32
+  - @ai-sdk/provider-utils@4.0.0-beta.59
+
+## 1.0.0-beta.29
+
+### Patch Changes
+
+- Updated dependencies [2625a04]
+  - @ai-sdk/provider@3.0.0-beta.31
+  - @ai-sdk/provider-utils@4.0.0-beta.58
+
+## 1.0.0-beta.28
+
+### Patch Changes
+
+- Updated dependencies [cbf52cd]
+  - @ai-sdk/provider@3.0.0-beta.30
+  - @ai-sdk/provider-utils@4.0.0-beta.57
+
+## 1.0.0-beta.27
+
+### Patch Changes
+
+- Updated dependencies [9549c9e]
+  - @ai-sdk/provider@3.0.0-beta.29
+  - @ai-sdk/provider-utils@4.0.0-beta.56
+
+## 1.0.0-beta.26
+
+### Patch Changes
+
+- Updated dependencies [50b70d6]
+  - @ai-sdk/provider-utils@4.0.0-beta.55
+
+## 1.0.0-beta.25
+
+### Patch Changes
+
+- 9061dc0: feat: image editing
+- Updated dependencies [9061dc0]
+  - @ai-sdk/provider-utils@4.0.0-beta.54
+  - @ai-sdk/provider@3.0.0-beta.28
+
+## 1.0.0-beta.24
+
+### Patch Changes
+
+- 366f50b: chore(provider): add deprecated textEmbeddingModel and textEmbedding aliases
+- Updated dependencies [366f50b]
+  - @ai-sdk/provider@3.0.0-beta.27
+  - @ai-sdk/provider-utils@4.0.0-beta.53
+
+## 1.0.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [763d04a]
+  - @ai-sdk/provider-utils@4.0.0-beta.52
+
+## 1.0.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [c1efac4]
+  - @ai-sdk/provider-utils@4.0.0-beta.51
+
+## 1.0.0-beta.21
+
+### Patch Changes
+
+- Updated dependencies [32223c8]
+  - @ai-sdk/provider-utils@4.0.0-beta.50
+
+## 1.0.0-beta.20
+
+### Patch Changes
+
+- Updated dependencies [83e5744]
+  - @ai-sdk/provider-utils@4.0.0-beta.49
+
+## 1.0.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [960ec8f]
+  - @ai-sdk/provider-utils@4.0.0-beta.48
+
+## 1.0.0-beta.18
+
+### Patch Changes
+
+- Updated dependencies [e9e157f]
+  - @ai-sdk/provider-utils@4.0.0-beta.47
+
+## 1.0.0-beta.17
+
+### Patch Changes
+
+- Updated dependencies [81e29ab]
+  - @ai-sdk/provider-utils@4.0.0-beta.46
+
+## 1.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [3bd2689]
+  - @ai-sdk/provider@3.0.0-beta.26
+  - @ai-sdk/provider-utils@4.0.0-beta.45
+
+## 1.0.0-beta.15
+
+### Patch Changes
+
+- Updated dependencies [53f3368]
+  - @ai-sdk/provider@3.0.0-beta.25
+  - @ai-sdk/provider-utils@4.0.0-beta.44
+
+## 1.0.0-beta.14
+
+### Patch Changes
+
+- Updated dependencies [dce03c4]
+  - @ai-sdk/provider-utils@4.0.0-beta.43
+  - @ai-sdk/provider@3.0.0-beta.24
+
+## 1.0.0-beta.13
+
+### Patch Changes
+
+- Updated dependencies [3ed5519]
+  - @ai-sdk/provider-utils@4.0.0-beta.42
+
+## 1.0.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [1bd7d32]
+  - @ai-sdk/provider-utils@4.0.0-beta.41
+  - @ai-sdk/provider@3.0.0-beta.23
+
+## 1.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [544d4e8]
+  - @ai-sdk/provider-utils@4.0.0-beta.40
+  - @ai-sdk/provider@3.0.0-beta.22
+
+## 1.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [954c356]
+  - @ai-sdk/provider-utils@4.0.0-beta.39
+  - @ai-sdk/provider@3.0.0-beta.21
+
+## 1.0.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [03849b0]
+  - @ai-sdk/provider-utils@4.0.0-beta.38
+
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- 457318b: chore(provider,ai): switch to SharedV3Warning and unified warnings
+- Updated dependencies [457318b]
+  - @ai-sdk/provider@3.0.0-beta.20
+  - @ai-sdk/provider-utils@4.0.0-beta.37
+
+## 1.0.0-beta.7
+
+### Patch Changes
+
+- 8d9e8ad: chore(provider): remove generics from EmbeddingModelV3
+
+  Before
+
+  ```ts
+  model.textEmbeddingModel('my-model-id');
+  ```
+
+  After
+
+  ```ts
+  model.embeddingModel('my-model-id');
+  ```
+
+- Updated dependencies [8d9e8ad]
+  - @ai-sdk/provider@3.0.0-beta.19
+  - @ai-sdk/provider-utils@4.0.0-beta.36
+
+## 1.0.0-beta.6
+
+### Patch Changes
+
+- Updated dependencies [10d819b]
+  - @ai-sdk/provider@3.0.0-beta.18
+  - @ai-sdk/provider-utils@4.0.0-beta.35
+
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- b8e77ef: feat(provider/black-forest-labs): Add new provider options
+
+## 1.0.0-beta.4
+
+### Patch Changes
+
+- 666bd16: fix (provider/black-forest-labs): allow null for cost and megapixel in provider response
+
+## 1.0.0-beta.3
+
+### Patch Changes
+
+- cd3b71c: feat (provider/black-forest-labs): include cost and megapixels in metadata
+
+## 1.0.0-beta.2
+
+### Patch Changes
+
+- Updated dependencies [db913bd]
+  - @ai-sdk/provider@3.0.0-beta.17
+  - @ai-sdk/provider-utils@4.0.0-beta.34
+
+## 1.0.0-beta.1
+
+### Patch Changes
+
+- 3922a5f: feat(provider/black-forest-labs): make polling timeout configurable
+
+## 1.0.0-beta.0
+
+### Major Changes
+
+- 8a9f0d4: feat(black-forest-labs): initial version

package/LICENSE

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

package/README.md

@@ -0,0 +1,109 @@
+# AI SDK - Black Forest Labs Provider
+
+The **[Black Forest Labs provider](https://ai-sdk.dev/providers/ai-sdk-providers/black-forest-labs)** for the [AI SDK](https://ai-sdk.dev/docs) adds image model support for the [Black Forest Labs API](https://docs.bfl.ai/).
+
+## Setup
+
+The Black Forest Labs provider is available in the `@ai-sdk/black-forest-labs` module. You can install it with
+
+```bash
+pnpm add @ai-sdk/black-forest-labs
+```
+
+## Provider Instance
+
+You can import the default provider instance `blackForestLabs` from `@ai-sdk/black-forest-labs`:
+
+```ts
+import { blackForestLabs } from '@ai-sdk/black-forest-labs';
+```
+
+## Image Generation Example
+
+```ts
+import fs from 'node:fs';
+import { blackForestLabs } from '@ai-sdk/black-forest-labs';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: blackForestLabs.image('flux-pro-1.1'),
+  prompt: 'A cat wearing a intricate robe',
+});
+
+const filename = `image-${Date.now()}.png`;
+fs.writeFileSync(filename, image.uint8Array);
+console.log(`Image saved to ${filename}`);
+```
+
+## Additional Options
+
+If you want to pass additional inputs to the model besides the prompt, use the `providerOptions.blackForestLabs` property:
+
+```ts
+import {
+  blackForestLabs,
+  type BlackForestLabsImageProviderOptions,
+} from '@ai-sdk/black-forest-labs';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: blackForestLabs.image('flux-pro-1.1'),
+  prompt: 'A cat wearing an intricate robe',
+  aspectRatio: '16:9',
+  providerOptions: {
+    blackForestLabs: {
+      outputFormat: 'png',
+    } satisfies BlackForestLabsImageProviderOptions,
+  },
+});
+```
+
+## Configuring Base URL
+
+By default, the provider uses `https://api.bfl.ai/v1`. You can override this to use regional or legacy endpoints:
+
+```ts
+import { createBlackForestLabs } from '@ai-sdk/black-forest-labs';
+
+const blackForestLabs = createBlackForestLabs({
+  baseURL: 'https://api.eu.bfl.ai/v1',
+  apiKey: process.env.BFL_API_KEY,
+});
+```
+
+## Configuring Polling
+
+You can customize how often the client polls for image completion and how long it waits before timing out:
+
+```ts
+import { createBlackForestLabs } from '@ai-sdk/black-forest-labs';
+
+const blackForestLabs = createBlackForestLabs({
+  apiKey: process.env.BFL_API_KEY,
+  // Poll every 500ms, timeout after 5 minutes
+  pollIntervalMillis: 500,
+  pollTimeoutMillis: 5 * 60_000,
+});
+```
+
+You can also override these polling settings per request via `providerOptions.blackForestLabs`:
+
+```ts
+import { blackForestLabs } from '@ai-sdk/black-forest-labs';
+import { generateImage } from 'ai';
+
+const { image } = await generateImage({
+  model: blackForestLabs.image('flux-pro-1.1'),
+  prompt: 'A cat wearing an intricate robe',
+  providerOptions: {
+    blackForestLabs: {
+      pollIntervalMillis: 250,
+      pollTimeoutMillis: 30_000,
+    },
+  },
+});
+```
+
+## Documentation
+
+See the [Black Forest Labs provider](https://ai-sdk.dev/providers/ai-sdk-providers/black-forest-labs) for more information.

package/dist/index.d.mts

@@ -0,0 +1,82 @@
+import { ProviderV3, ImageModelV3 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
+import { FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
+
+type BlackForestLabsImageModelId = 'flux-kontext-pro' | 'flux-kontext-max' | 'flux-pro-1.1-ultra' | 'flux-pro-1.1' | 'flux-pro-1.0-fill' | (string & {});
+type BlackForestLabsAspectRatio = `${number}:${number}`;
+
+interface BlackForestLabsProviderSettings {
+    /**
+  Black Forest Labs API key. Default value is taken from the `BFL_API_KEY` environment variable.
+     */
+    apiKey?: string;
+    /**
+  Base URL for the API calls. Defaults to `https://api.bfl.ai/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;
+    /**
+   Poll interval in milliseconds between status checks. Defaults to 500ms.
+     */
+    pollIntervalMillis?: number;
+    /**
+   Overall timeout in milliseconds for polling before giving up. Defaults to 60s.
+     */
+    pollTimeoutMillis?: number;
+}
+interface BlackForestLabsProvider extends ProviderV3 {
+    /**
+  Creates a model for image generation.
+     */
+    image(modelId: BlackForestLabsImageModelId): ImageModelV3;
+    /**
+  Creates a model for image generation.
+     */
+    imageModel(modelId: BlackForestLabsImageModelId): ImageModelV3;
+    /**
+     * @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel(modelId: string): never;
+}
+declare function createBlackForestLabs(options?: BlackForestLabsProviderSettings): BlackForestLabsProvider;
+declare const blackForestLabs: BlackForestLabsProvider;
+
+declare const blackForestLabsImageProviderOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    imagePrompt?: string | undefined;
+    imagePromptStrength?: number | undefined;
+    inputImage?: string | undefined;
+    inputImage2?: string | undefined;
+    inputImage3?: string | undefined;
+    inputImage4?: string | undefined;
+    inputImage5?: string | undefined;
+    inputImage6?: string | undefined;
+    inputImage7?: string | undefined;
+    inputImage8?: string | undefined;
+    inputImage9?: string | undefined;
+    inputImage10?: string | undefined;
+    steps?: number | undefined;
+    guidance?: number | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    outputFormat?: "jpeg" | "png" | undefined;
+    promptUpsampling?: boolean | undefined;
+    raw?: boolean | undefined;
+    safetyTolerance?: number | undefined;
+    webhookSecret?: string | undefined;
+    webhookUrl?: string | undefined;
+    pollIntervalMillis?: number | undefined;
+    pollTimeoutMillis?: number | undefined;
+}>;
+type BlackForestLabsImageProviderOptions = InferSchema<typeof blackForestLabsImageProviderOptionsSchema>;
+
+declare const VERSION: string;
+
+export { type BlackForestLabsAspectRatio, type BlackForestLabsImageModelId, type BlackForestLabsImageProviderOptions, type BlackForestLabsProvider, type BlackForestLabsProviderSettings, VERSION, blackForestLabs, createBlackForestLabs };

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+import { ProviderV3, ImageModelV3 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
+import { FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
+
+type BlackForestLabsImageModelId = 'flux-kontext-pro' | 'flux-kontext-max' | 'flux-pro-1.1-ultra' | 'flux-pro-1.1' | 'flux-pro-1.0-fill' | (string & {});
+type BlackForestLabsAspectRatio = `${number}:${number}`;
+
+interface BlackForestLabsProviderSettings {
+    /**
+  Black Forest Labs API key. Default value is taken from the `BFL_API_KEY` environment variable.
+     */
+    apiKey?: string;
+    /**
+  Base URL for the API calls. Defaults to `https://api.bfl.ai/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;
+    /**
+   Poll interval in milliseconds between status checks. Defaults to 500ms.
+     */
+    pollIntervalMillis?: number;
+    /**
+   Overall timeout in milliseconds for polling before giving up. Defaults to 60s.
+     */
+    pollTimeoutMillis?: number;
+}
+interface BlackForestLabsProvider extends ProviderV3 {
+    /**
+  Creates a model for image generation.
+     */
+    image(modelId: BlackForestLabsImageModelId): ImageModelV3;
+    /**
+  Creates a model for image generation.
+     */
+    imageModel(modelId: BlackForestLabsImageModelId): ImageModelV3;
+    /**
+     * @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel(modelId: string): never;
+}
+declare function createBlackForestLabs(options?: BlackForestLabsProviderSettings): BlackForestLabsProvider;
+declare const blackForestLabs: BlackForestLabsProvider;
+
+declare const blackForestLabsImageProviderOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    imagePrompt?: string | undefined;
+    imagePromptStrength?: number | undefined;
+    inputImage?: string | undefined;
+    inputImage2?: string | undefined;
+    inputImage3?: string | undefined;
+    inputImage4?: string | undefined;
+    inputImage5?: string | undefined;
+    inputImage6?: string | undefined;
+    inputImage7?: string | undefined;
+    inputImage8?: string | undefined;
+    inputImage9?: string | undefined;
+    inputImage10?: string | undefined;
+    steps?: number | undefined;
+    guidance?: number | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    outputFormat?: "jpeg" | "png" | undefined;
+    promptUpsampling?: boolean | undefined;
+    raw?: boolean | undefined;
+    safetyTolerance?: number | undefined;
+    webhookSecret?: string | undefined;
+    webhookUrl?: string | undefined;
+    pollIntervalMillis?: number | undefined;
+    pollTimeoutMillis?: number | undefined;
+}>;
+type BlackForestLabsImageProviderOptions = InferSchema<typeof blackForestLabsImageProviderOptionsSchema>;
+
+declare const VERSION: string;
+
+export { type BlackForestLabsAspectRatio, type BlackForestLabsImageModelId, type BlackForestLabsImageProviderOptions, type BlackForestLabsProvider, type BlackForestLabsProviderSettings, VERSION, blackForestLabs, createBlackForestLabs };