@ai-sdk/fal 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/LICENSE +13 -0
- package/README.md +56 -0
- package/dist/index.d.mts +48 -0
- package/dist/index.d.ts +48 -0
- package/dist/index.js +205 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +186 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +63 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Copyright 2023 Vercel, Inc.
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# AI SDK - fal Provider
|
|
2
|
+
|
|
3
|
+
The **[fal provider](https://sdk.vercel.ai/providers/ai-sdk-providers/fal)** for the [AI SDK](https://sdk.vercel.ai/docs) contains image model support for the [fal.ai API](https://fal.ai/).
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
The fal provider is available in the `@ai-sdk/fal` module. You can install it with
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i @ai-sdk/fal
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Provider Instance
|
|
14
|
+
|
|
15
|
+
You can import the default provider instance `fal` from `@ai-sdk/fal`:
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { fal } from '@ai-sdk/fal';
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Image Generation Example
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import { fal } from '@ai-sdk/fal';
|
|
25
|
+
import { experimental_generateImage as generateImage } from 'ai';
|
|
26
|
+
import fs from 'fs';
|
|
27
|
+
const { image } = await generateImage({
|
|
28
|
+
model: fal.image('fal-ai/flux/schnell'),
|
|
29
|
+
prompt: 'A cat wearing a intricate robe',
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
const filename = `image-${Date.now()}.png`;
|
|
33
|
+
fs.writeFileSync(filename, image.uint8Array);
|
|
34
|
+
console.log(`Image saved to ${filename}`);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Additional Options
|
|
38
|
+
|
|
39
|
+
If you want to pass additional inputs to the model besides the prompt, use the `providerOptions.fal` property:
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
const { image } = await generateImage({
|
|
43
|
+
model: fal.image('fal-ai/recraft-v3'),
|
|
44
|
+
prompt: 'A cat wearing a intricate robe',
|
|
45
|
+
size: '1920x1080',
|
|
46
|
+
providerOptions: {
|
|
47
|
+
fal: {
|
|
48
|
+
style: 'digital_illustration',
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Documentation
|
|
55
|
+
|
|
56
|
+
Please check out the **[fal provider](https://sdk.vercel.ai/providers/ai-sdk-providers/fal)** for more information.
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { ImageModelV1 } from '@ai-sdk/provider';
|
|
2
|
+
import { FetchFunction } from '@ai-sdk/provider-utils';
|
|
3
|
+
|
|
4
|
+
type FalImageModelId = 'fal-ai/aura-flow' | 'fal-ai/aura-sr' | 'fal-ai/bria/eraser' | 'fal-ai/bria/product-shot' | 'fal-ai/bria/text-to-image/base' | 'fal-ai/bria/text-to-image/fast' | 'fal-ai/bria/text-to-image/hd' | 'fal-ai/bria/text-to-image/turbo' | 'fal-ai/ccsr' | 'fal-ai/clarity-upscaler' | 'fal-ai/creative-upscaler' | 'fal-ai/esrgan' | 'fal-ai/fast-sdxl' | 'fal-ai/flux-general' | 'fal-ai/flux-general/differential-diffusion' | 'fal-ai/flux-general/image-to-image' | 'fal-ai/flux-general/inpainting' | 'fal-ai/flux-general/rf-inversion' | 'fal-ai/flux-lora' | 'fal-ai/flux-lora/image-to-image' | 'fal-ai/flux-lora/inpainting' | 'fal-ai/flux-pro/v1.1' | 'fal-ai/flux-pro/v1.1-ultra' | 'fal-ai/flux-pro/v1.1-ultra-finetuned' | 'fal-ai/flux-pro/v1.1-ultra/redux' | 'fal-ai/flux-pro/v1.1/redux' | 'fal-ai/flux/dev' | 'fal-ai/flux/dev/image-to-image' | 'fal-ai/flux/dev/redux' | 'fal-ai/flux/schnell' | 'fal-ai/flux/schnell/redux' | 'fal-ai/hyper-sdxl' | 'fal-ai/ideogram/v2' | 'fal-ai/ideogram/v2/remix' | 'fal-ai/ideogram/v2/turbo' | 'fal-ai/ideogram/v2/turbo/edit' | 'fal-ai/ideogram/v2/turbo/remix' | 'fal-ai/janus' | 'fal-ai/luma-photon' | 'fal-ai/luma-photon/flash' | 'fal-ai/omnigen-v1' | 'fal-ai/playground-v25' | 'fal-ai/recraft-20b' | 'fal-ai/recraft-v3' | 'fal-ai/sana' | 'fal-ai/stable-cascade' | 'fal-ai/stable-diffusion-3.5-large' | 'fal-ai/stable-diffusion-3.5-medium' | 'fashn/tryon' | (string & {});
|
|
5
|
+
interface FalImageSettings {
|
|
6
|
+
/**
|
|
7
|
+
Override the maximum number of images per call (default 1).
|
|
8
|
+
*/
|
|
9
|
+
maxImagesPerCall?: number;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
interface FalProviderSettings {
|
|
13
|
+
/**
|
|
14
|
+
fal.ai API key. Default value is taken from the `FAL_API_KEY` environment
|
|
15
|
+
variable.
|
|
16
|
+
*/
|
|
17
|
+
apiKey?: string;
|
|
18
|
+
/**
|
|
19
|
+
Base URL for the API calls.
|
|
20
|
+
The default prefix is `https://fal.run`.
|
|
21
|
+
*/
|
|
22
|
+
baseURL?: string;
|
|
23
|
+
/**
|
|
24
|
+
Custom headers to include in the requests.
|
|
25
|
+
*/
|
|
26
|
+
headers?: Record<string, string>;
|
|
27
|
+
/**
|
|
28
|
+
Custom fetch implementation. You can use it as a middleware to intercept
|
|
29
|
+
requests, or to provide a custom fetch implementation for e.g. testing.
|
|
30
|
+
*/
|
|
31
|
+
fetch?: FetchFunction;
|
|
32
|
+
}
|
|
33
|
+
interface FalProvider {
|
|
34
|
+
/**
|
|
35
|
+
Creates a model for image generation.
|
|
36
|
+
*/
|
|
37
|
+
image(modelId: FalImageModelId, settings?: FalImageSettings): ImageModelV1;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
Create a fal.ai provider instance.
|
|
41
|
+
*/
|
|
42
|
+
declare function createFal(options?: FalProviderSettings): FalProvider;
|
|
43
|
+
/**
|
|
44
|
+
Default fal.ai provider instance.
|
|
45
|
+
*/
|
|
46
|
+
declare const fal: FalProvider;
|
|
47
|
+
|
|
48
|
+
export { type FalProvider, type FalProviderSettings, createFal, fal };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { ImageModelV1 } from '@ai-sdk/provider';
|
|
2
|
+
import { FetchFunction } from '@ai-sdk/provider-utils';
|
|
3
|
+
|
|
4
|
+
type FalImageModelId = 'fal-ai/aura-flow' | 'fal-ai/aura-sr' | 'fal-ai/bria/eraser' | 'fal-ai/bria/product-shot' | 'fal-ai/bria/text-to-image/base' | 'fal-ai/bria/text-to-image/fast' | 'fal-ai/bria/text-to-image/hd' | 'fal-ai/bria/text-to-image/turbo' | 'fal-ai/ccsr' | 'fal-ai/clarity-upscaler' | 'fal-ai/creative-upscaler' | 'fal-ai/esrgan' | 'fal-ai/fast-sdxl' | 'fal-ai/flux-general' | 'fal-ai/flux-general/differential-diffusion' | 'fal-ai/flux-general/image-to-image' | 'fal-ai/flux-general/inpainting' | 'fal-ai/flux-general/rf-inversion' | 'fal-ai/flux-lora' | 'fal-ai/flux-lora/image-to-image' | 'fal-ai/flux-lora/inpainting' | 'fal-ai/flux-pro/v1.1' | 'fal-ai/flux-pro/v1.1-ultra' | 'fal-ai/flux-pro/v1.1-ultra-finetuned' | 'fal-ai/flux-pro/v1.1-ultra/redux' | 'fal-ai/flux-pro/v1.1/redux' | 'fal-ai/flux/dev' | 'fal-ai/flux/dev/image-to-image' | 'fal-ai/flux/dev/redux' | 'fal-ai/flux/schnell' | 'fal-ai/flux/schnell/redux' | 'fal-ai/hyper-sdxl' | 'fal-ai/ideogram/v2' | 'fal-ai/ideogram/v2/remix' | 'fal-ai/ideogram/v2/turbo' | 'fal-ai/ideogram/v2/turbo/edit' | 'fal-ai/ideogram/v2/turbo/remix' | 'fal-ai/janus' | 'fal-ai/luma-photon' | 'fal-ai/luma-photon/flash' | 'fal-ai/omnigen-v1' | 'fal-ai/playground-v25' | 'fal-ai/recraft-20b' | 'fal-ai/recraft-v3' | 'fal-ai/sana' | 'fal-ai/stable-cascade' | 'fal-ai/stable-diffusion-3.5-large' | 'fal-ai/stable-diffusion-3.5-medium' | 'fashn/tryon' | (string & {});
|
|
5
|
+
interface FalImageSettings {
|
|
6
|
+
/**
|
|
7
|
+
Override the maximum number of images per call (default 1).
|
|
8
|
+
*/
|
|
9
|
+
maxImagesPerCall?: number;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
interface FalProviderSettings {
|
|
13
|
+
/**
|
|
14
|
+
fal.ai API key. Default value is taken from the `FAL_API_KEY` environment
|
|
15
|
+
variable.
|
|
16
|
+
*/
|
|
17
|
+
apiKey?: string;
|
|
18
|
+
/**
|
|
19
|
+
Base URL for the API calls.
|
|
20
|
+
The default prefix is `https://fal.run`.
|
|
21
|
+
*/
|
|
22
|
+
baseURL?: string;
|
|
23
|
+
/**
|
|
24
|
+
Custom headers to include in the requests.
|
|
25
|
+
*/
|
|
26
|
+
headers?: Record<string, string>;
|
|
27
|
+
/**
|
|
28
|
+
Custom fetch implementation. You can use it as a middleware to intercept
|
|
29
|
+
requests, or to provide a custom fetch implementation for e.g. testing.
|
|
30
|
+
*/
|
|
31
|
+
fetch?: FetchFunction;
|
|
32
|
+
}
|
|
33
|
+
interface FalProvider {
|
|
34
|
+
/**
|
|
35
|
+
Creates a model for image generation.
|
|
36
|
+
*/
|
|
37
|
+
image(modelId: FalImageModelId, settings?: FalImageSettings): ImageModelV1;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
Create a fal.ai provider instance.
|
|
41
|
+
*/
|
|
42
|
+
declare function createFal(options?: FalProviderSettings): FalProvider;
|
|
43
|
+
/**
|
|
44
|
+
Default fal.ai provider instance.
|
|
45
|
+
*/
|
|
46
|
+
declare const fal: FalProvider;
|
|
47
|
+
|
|
48
|
+
export { type FalProvider, type FalProviderSettings, createFal, fal };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var src_exports = {};
|
|
22
|
+
__export(src_exports, {
|
|
23
|
+
createFal: () => createFal,
|
|
24
|
+
fal: () => fal
|
|
25
|
+
});
|
|
26
|
+
module.exports = __toCommonJS(src_exports);
|
|
27
|
+
|
|
28
|
+
// src/fal-provider.ts
|
|
29
|
+
var import_provider_utils2 = require("@ai-sdk/provider-utils");
|
|
30
|
+
|
|
31
|
+
// src/fal-image-model.ts
|
|
32
|
+
var import_provider_utils = require("@ai-sdk/provider-utils");
|
|
33
|
+
var import_zod = require("zod");
|
|
34
|
+
var FalImageModel = class {
|
|
35
|
+
constructor(modelId, settings, config) {
|
|
36
|
+
this.modelId = modelId;
|
|
37
|
+
this.settings = settings;
|
|
38
|
+
this.config = config;
|
|
39
|
+
this.specificationVersion = "v1";
|
|
40
|
+
}
|
|
41
|
+
get provider() {
|
|
42
|
+
return this.config.provider;
|
|
43
|
+
}
|
|
44
|
+
get maxImagesPerCall() {
|
|
45
|
+
var _a;
|
|
46
|
+
return (_a = this.settings.maxImagesPerCall) != null ? _a : 1;
|
|
47
|
+
}
|
|
48
|
+
async doGenerate({
|
|
49
|
+
prompt,
|
|
50
|
+
n,
|
|
51
|
+
size,
|
|
52
|
+
aspectRatio,
|
|
53
|
+
seed,
|
|
54
|
+
providerOptions,
|
|
55
|
+
headers,
|
|
56
|
+
abortSignal
|
|
57
|
+
}) {
|
|
58
|
+
var _a, _b, _c, _d;
|
|
59
|
+
const warnings = [];
|
|
60
|
+
let imageSize;
|
|
61
|
+
if (size) {
|
|
62
|
+
const [width, height] = size.split("x").map(Number);
|
|
63
|
+
imageSize = { width, height };
|
|
64
|
+
} else if (aspectRatio) {
|
|
65
|
+
imageSize = convertAspectRatioToSize(aspectRatio);
|
|
66
|
+
}
|
|
67
|
+
const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
|
|
68
|
+
const { value, responseHeaders } = await (0, import_provider_utils.postJsonToApi)({
|
|
69
|
+
url: `${this.config.baseURL}/${this.modelId}`,
|
|
70
|
+
headers: (0, import_provider_utils.combineHeaders)(await (0, import_provider_utils.resolve)(this.config.headers), headers),
|
|
71
|
+
body: {
|
|
72
|
+
prompt,
|
|
73
|
+
seed,
|
|
74
|
+
image_size: imageSize,
|
|
75
|
+
num_images: n,
|
|
76
|
+
...(_d = providerOptions.fal) != null ? _d : {}
|
|
77
|
+
},
|
|
78
|
+
failedResponseHandler: falFailedResponseHandler,
|
|
79
|
+
successfulResponseHandler: (0, import_provider_utils.createJsonResponseHandler)(
|
|
80
|
+
falImageResponseSchema
|
|
81
|
+
),
|
|
82
|
+
abortSignal,
|
|
83
|
+
fetch: this.config.fetch
|
|
84
|
+
});
|
|
85
|
+
const targetImages = "images" in value ? value.images : [value.image];
|
|
86
|
+
const downloadedImages = await Promise.all(
|
|
87
|
+
targetImages.map((image) => this.downloadImage(image.url, abortSignal))
|
|
88
|
+
);
|
|
89
|
+
return {
|
|
90
|
+
images: downloadedImages,
|
|
91
|
+
warnings,
|
|
92
|
+
response: {
|
|
93
|
+
modelId: this.modelId,
|
|
94
|
+
timestamp: currentDate,
|
|
95
|
+
headers: responseHeaders
|
|
96
|
+
}
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
async downloadImage(url, abortSignal) {
|
|
100
|
+
const { value: response } = await (0, import_provider_utils.getFromApi)({
|
|
101
|
+
url,
|
|
102
|
+
// No specific headers should be needed for this request as it's a
|
|
103
|
+
// generated image provided by fal.ai.
|
|
104
|
+
abortSignal,
|
|
105
|
+
failedResponseHandler: (0, import_provider_utils.createStatusCodeErrorResponseHandler)(),
|
|
106
|
+
successfulResponseHandler: (0, import_provider_utils.createBinaryResponseHandler)(),
|
|
107
|
+
fetch: this.config.fetch
|
|
108
|
+
});
|
|
109
|
+
return response;
|
|
110
|
+
}
|
|
111
|
+
};
|
|
112
|
+
function convertAspectRatioToSize(aspectRatio) {
|
|
113
|
+
switch (aspectRatio) {
|
|
114
|
+
case "1:1":
|
|
115
|
+
return "square_hd";
|
|
116
|
+
case "16:9":
|
|
117
|
+
return "landscape_16_9";
|
|
118
|
+
case "9:16":
|
|
119
|
+
return "portrait_16_9";
|
|
120
|
+
case "4:3":
|
|
121
|
+
return "landscape_4_3";
|
|
122
|
+
case "3:4":
|
|
123
|
+
return "portrait_4_3";
|
|
124
|
+
case "16:10":
|
|
125
|
+
return { width: 1280, height: 800 };
|
|
126
|
+
case "10:16":
|
|
127
|
+
return { width: 800, height: 1280 };
|
|
128
|
+
case "21:9":
|
|
129
|
+
return { width: 2560, height: 1080 };
|
|
130
|
+
case "9:21":
|
|
131
|
+
return { width: 1080, height: 2560 };
|
|
132
|
+
}
|
|
133
|
+
return void 0;
|
|
134
|
+
}
|
|
135
|
+
var falValidationErrorSchema = import_zod.z.object({
|
|
136
|
+
detail: import_zod.z.array(
|
|
137
|
+
import_zod.z.object({
|
|
138
|
+
loc: import_zod.z.array(import_zod.z.string()),
|
|
139
|
+
msg: import_zod.z.string(),
|
|
140
|
+
type: import_zod.z.string()
|
|
141
|
+
})
|
|
142
|
+
)
|
|
143
|
+
});
|
|
144
|
+
var falHttpErrorSchema = import_zod.z.object({
|
|
145
|
+
message: import_zod.z.string()
|
|
146
|
+
});
|
|
147
|
+
var falErrorSchema = import_zod.z.union([falValidationErrorSchema, falHttpErrorSchema]);
|
|
148
|
+
var falImageSchema = import_zod.z.object({
|
|
149
|
+
url: import_zod.z.string(),
|
|
150
|
+
width: import_zod.z.number(),
|
|
151
|
+
height: import_zod.z.number(),
|
|
152
|
+
content_type: import_zod.z.string()
|
|
153
|
+
});
|
|
154
|
+
var falImageResponseSchema = import_zod.z.union([
|
|
155
|
+
import_zod.z.object({
|
|
156
|
+
images: import_zod.z.array(falImageSchema)
|
|
157
|
+
}),
|
|
158
|
+
import_zod.z.object({
|
|
159
|
+
image: falImageSchema
|
|
160
|
+
})
|
|
161
|
+
]);
|
|
162
|
+
function isValidationError(error) {
|
|
163
|
+
return falValidationErrorSchema.safeParse(error).success;
|
|
164
|
+
}
|
|
165
|
+
var falFailedResponseHandler = (0, import_provider_utils.createJsonErrorResponseHandler)({
|
|
166
|
+
errorSchema: falErrorSchema,
|
|
167
|
+
errorToMessage: (error) => {
|
|
168
|
+
var _a;
|
|
169
|
+
if (isValidationError(error)) {
|
|
170
|
+
return error.detail.map((detail) => `${detail.loc.join(".")}: ${detail.msg}`).join("\n");
|
|
171
|
+
}
|
|
172
|
+
return (_a = error.message) != null ? _a : "Unknown fal error";
|
|
173
|
+
}
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
// src/fal-provider.ts
|
|
177
|
+
var defaultBaseURL = "https://fal.run";
|
|
178
|
+
function createFal(options = {}) {
|
|
179
|
+
var _a;
|
|
180
|
+
const baseURL = (0, import_provider_utils2.withoutTrailingSlash)((_a = options.baseURL) != null ? _a : defaultBaseURL);
|
|
181
|
+
const getHeaders = () => ({
|
|
182
|
+
Authorization: `Key ${(0, import_provider_utils2.loadApiKey)({
|
|
183
|
+
apiKey: options.apiKey,
|
|
184
|
+
environmentVariableName: "FAL_API_KEY",
|
|
185
|
+
description: "fal.ai"
|
|
186
|
+
})}`,
|
|
187
|
+
...options.headers
|
|
188
|
+
});
|
|
189
|
+
const createImageModel = (modelId, settings = {}) => new FalImageModel(modelId, settings, {
|
|
190
|
+
provider: "fal.image",
|
|
191
|
+
baseURL: baseURL != null ? baseURL : defaultBaseURL,
|
|
192
|
+
headers: getHeaders,
|
|
193
|
+
fetch: options.fetch
|
|
194
|
+
});
|
|
195
|
+
const provider = (modelId, settings) => createImageModel(modelId, settings);
|
|
196
|
+
provider.image = createImageModel;
|
|
197
|
+
return provider;
|
|
198
|
+
}
|
|
199
|
+
var fal = createFal();
|
|
200
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
201
|
+
0 && (module.exports = {
|
|
202
|
+
createFal,
|
|
203
|
+
fal
|
|
204
|
+
});
|
|
205
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/fal-provider.ts","../src/fal-image-model.ts"],"sourcesContent":["export { createFal, fal } from './fal-provider';\nexport type { FalProvider, FalProviderSettings } from './fal-provider';\n","import { ImageModelV1 } from '@ai-sdk/provider';\nimport type { FetchFunction } from '@ai-sdk/provider-utils';\nimport { loadApiKey, withoutTrailingSlash } from '@ai-sdk/provider-utils';\nimport { FalImageModel } from './fal-image-model';\nimport { FalImageModelId, FalImageSettings } from './fal-image-settings';\n\nexport interface FalProviderSettings {\n /**\nfal.ai API key. Default value is taken from the `FAL_API_KEY` environment\nvariable.\n */\n apiKey?: string;\n\n /**\nBase URL for the API calls.\nThe default prefix is `https://fal.run`.\n */\n baseURL?: string;\n\n /**\nCustom headers to include in the requests.\n */\n headers?: Record<string, string>;\n\n /**\nCustom fetch implementation. You can use it as a middleware to intercept\nrequests, or to provide a custom fetch implementation for e.g. testing.\n */\n fetch?: FetchFunction;\n}\n\nexport interface FalProvider {\n /**\nCreates a model for image generation.\n */\n image(modelId: FalImageModelId, settings?: FalImageSettings): ImageModelV1;\n}\n\nconst defaultBaseURL = 'https://fal.run';\n\n/**\nCreate a fal.ai provider instance.\n */\nexport function createFal(options: FalProviderSettings = {}): FalProvider {\n const baseURL = withoutTrailingSlash(options.baseURL ?? defaultBaseURL);\n const getHeaders = () => ({\n Authorization: `Key ${loadApiKey({\n apiKey: options.apiKey,\n environmentVariableName: 'FAL_API_KEY',\n description: 'fal.ai',\n })}`,\n ...options.headers,\n });\n\n const createImageModel = (\n modelId: FalImageModelId,\n settings: FalImageSettings = {},\n ) =>\n new FalImageModel(modelId, settings, {\n provider: 'fal.image',\n baseURL: baseURL ?? defaultBaseURL,\n headers: getHeaders,\n fetch: options.fetch,\n });\n\n const provider = (modelId: FalImageModelId, settings?: FalImageSettings) =>\n createImageModel(modelId, settings);\n\n provider.image = createImageModel;\n\n return provider as FalProvider;\n}\n\n/**\nDefault fal.ai provider instance.\n */\nexport const fal = createFal();\n","import type { ImageModelV1, ImageModelV1CallWarning } from '@ai-sdk/provider';\nimport type { Resolvable } from '@ai-sdk/provider-utils';\nimport {\n FetchFunction,\n combineHeaders,\n createBinaryResponseHandler,\n createJsonResponseHandler,\n createJsonErrorResponseHandler,\n createStatusCodeErrorResponseHandler,\n getFromApi,\n postJsonToApi,\n resolve,\n} from '@ai-sdk/provider-utils';\nimport { z } from 'zod';\nimport {\n FalImageModelId,\n FalImageSettings,\n FalImageSize,\n} from './fal-image-settings';\n\ninterface FalImageModelConfig {\n provider: string;\n baseURL: string;\n headers?: Resolvable<Record<string, string | undefined>>;\n fetch?: FetchFunction;\n _internal?: {\n currentDate?: () => Date;\n };\n}\n\nexport class FalImageModel implements ImageModelV1 {\n readonly specificationVersion = 'v1';\n\n get provider(): string {\n return this.config.provider;\n }\n\n get maxImagesPerCall(): number {\n return this.settings.maxImagesPerCall ?? 1;\n }\n\n constructor(\n readonly modelId: FalImageModelId,\n private readonly settings: FalImageSettings,\n private readonly config: FalImageModelConfig,\n ) {}\n\n async doGenerate({\n prompt,\n n,\n size,\n aspectRatio,\n seed,\n providerOptions,\n headers,\n abortSignal,\n }: Parameters<ImageModelV1['doGenerate']>[0]): Promise<\n Awaited<ReturnType<ImageModelV1['doGenerate']>>\n > {\n const warnings: Array<ImageModelV1CallWarning> = [];\n\n let imageSize: FalImageSize | undefined;\n if (size) {\n const [width, height] = size.split('x').map(Number);\n imageSize = { width, height };\n } else if (aspectRatio) {\n imageSize = convertAspectRatioToSize(aspectRatio);\n }\n\n const currentDate = this.config._internal?.currentDate?.() ?? new Date();\n const { value, responseHeaders } = await postJsonToApi({\n url: `${this.config.baseURL}/${this.modelId}`,\n headers: combineHeaders(await resolve(this.config.headers), headers),\n body: {\n prompt,\n seed,\n image_size: imageSize,\n num_images: n,\n ...(providerOptions.fal ?? {}),\n },\n failedResponseHandler: falFailedResponseHandler,\n successfulResponseHandler: createJsonResponseHandler(\n falImageResponseSchema,\n ),\n abortSignal,\n fetch: this.config.fetch,\n });\n\n // download the images:\n const targetImages = 'images' in value ? value.images : [value.image];\n const downloadedImages = await Promise.all(\n targetImages.map(image => this.downloadImage(image.url, abortSignal)),\n );\n\n return {\n images: downloadedImages,\n warnings,\n response: {\n modelId: this.modelId,\n timestamp: currentDate,\n headers: responseHeaders,\n },\n };\n }\n\n private async downloadImage(\n url: string,\n abortSignal: AbortSignal | undefined,\n ): Promise<Uint8Array> {\n const { value: response } = await getFromApi({\n url,\n // No specific headers should be needed for this request as it's a\n // generated image provided by fal.ai.\n abortSignal,\n failedResponseHandler: createStatusCodeErrorResponseHandler(),\n successfulResponseHandler: createBinaryResponseHandler(),\n fetch: this.config.fetch,\n });\n return response;\n }\n}\n\n/**\nConverts an aspect ratio to an image size compatible with fal.ai APIs.\n@param aspectRatio - The aspect ratio to convert.\n@returns The image size.\n */\nfunction convertAspectRatioToSize(\n aspectRatio: `${number}:${number}`,\n): FalImageSize | undefined {\n switch (aspectRatio) {\n case '1:1':\n return 'square_hd';\n case '16:9':\n return 'landscape_16_9';\n case '9:16':\n return 'portrait_16_9';\n case '4:3':\n return 'landscape_4_3';\n case '3:4':\n return 'portrait_4_3';\n case '16:10':\n return { width: 1280, height: 800 };\n case '10:16':\n return { width: 800, height: 1280 };\n case '21:9':\n return { width: 2560, height: 1080 };\n case '9:21':\n return { width: 1080, height: 2560 };\n }\n return undefined;\n}\n\n// Validation error has a particular payload to inform the exact property that is invalid\nconst falValidationErrorSchema = z.object({\n detail: z.array(\n z.object({\n loc: z.array(z.string()),\n msg: z.string(),\n type: z.string(),\n }),\n ),\n});\n\ntype ValidationError = z.infer<typeof falValidationErrorSchema>;\n\n// Other errors have a message property\nconst falHttpErrorSchema = z.object({\n message: z.string(),\n});\n\nconst falErrorSchema = z.union([falValidationErrorSchema, falHttpErrorSchema]);\n\nconst falImageSchema = z.object({\n url: z.string(),\n width: z.number(),\n height: z.number(),\n content_type: z.string(),\n});\n\nconst falImageResponseSchema = z.union([\n z.object({\n images: z.array(falImageSchema),\n }),\n z.object({\n image: falImageSchema,\n }),\n]);\n\nfunction isValidationError(error: unknown): error is ValidationError {\n return falValidationErrorSchema.safeParse(error).success;\n}\n\nconst falFailedResponseHandler = createJsonErrorResponseHandler({\n errorSchema: falErrorSchema,\n errorToMessage: error => {\n if (isValidationError(error)) {\n return error.detail\n .map(detail => `${detail.loc.join('.')}: ${detail.msg}`)\n .join('\\n');\n }\n return error.message ?? 'Unknown fal error';\n },\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEA,IAAAA,yBAAiD;;;ACAjD,4BAUO;AACP,iBAAkB;AAiBX,IAAM,gBAAN,MAA4C;AAAA,EAWjD,YACW,SACQ,UACA,QACjB;AAHS;AACQ;AACA;AAbnB,SAAS,uBAAuB;AAAA,EAc7B;AAAA,EAZH,IAAI,WAAmB;AACrB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,mBAA2B;AArCjC;AAsCI,YAAO,UAAK,SAAS,qBAAd,YAAkC;AAAA,EAC3C;AAAA,EAQA,MAAM,WAAW;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAEE;AA1DJ;AA2DI,UAAM,WAA2C,CAAC;AAElD,QAAI;AACJ,QAAI,MAAM;AACR,YAAM,CAAC,OAAO,MAAM,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI,MAAM;AAClD,kBAAY,EAAE,OAAO,OAAO;AAAA,IAC9B,WAAW,aAAa;AACtB,kBAAY,yBAAyB,WAAW;AAAA,IAClD;AAEA,UAAM,eAAc,sBAAK,OAAO,cAAZ,mBAAuB,gBAAvB,4CAA0C,oBAAI,KAAK;AACvE,UAAM,EAAE,OAAO,gBAAgB,IAAI,UAAM,qCAAc;AAAA,MACrD,KAAK,GAAG,KAAK,OAAO,OAAO,IAAI,KAAK,OAAO;AAAA,MAC3C,aAAS,sCAAe,UAAM,+BAAQ,KAAK,OAAO,OAAO,GAAG,OAAO;AAAA,MACnE,MAAM;AAAA,QACJ;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ,YAAY;AAAA,QACZ,IAAI,qBAAgB,QAAhB,YAAuB,CAAC;AAAA,MAC9B;AAAA,MACA,uBAAuB;AAAA,MACvB,+BAA2B;AAAA,QACzB;AAAA,MACF;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AAGD,UAAM,eAAe,YAAY,QAAQ,MAAM,SAAS,CAAC,MAAM,KAAK;AACpE,UAAM,mBAAmB,MAAM,QAAQ;AAAA,MACrC,aAAa,IAAI,WAAS,KAAK,cAAc,MAAM,KAAK,WAAW,CAAC;AAAA,IACtE;AAEA,WAAO;AAAA,MACL,QAAQ;AAAA,MACR;AAAA,MACA,UAAU;AAAA,QACR,SAAS,KAAK;AAAA,QACd,WAAW;AAAA,QACX,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,cACZ,KACA,aACqB;AACrB,UAAM,EAAE,OAAO,SAAS,IAAI,UAAM,kCAAW;AAAA,MAC3C;AAAA;AAAA;AAAA,MAGA;AAAA,MACA,2BAAuB,4DAAqC;AAAA,MAC5D,+BAA2B,mDAA4B;AAAA,MACvD,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAOA,SAAS,yBACP,aAC0B;AAC1B,UAAQ,aAAa;AAAA,IACnB,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,IAAI;AAAA,IACpC,KAAK;AACH,aAAO,EAAE,OAAO,KAAK,QAAQ,KAAK;AAAA,IACpC,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,KAAK;AAAA,IACrC,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,KAAK;AAAA,EACvC;AACA,SAAO;AACT;AAGA,IAAM,2BAA2B,aAAE,OAAO;AAAA,EACxC,QAAQ,aAAE;AAAA,IACR,aAAE,OAAO;AAAA,MACP,KAAK,aAAE,MAAM,aAAE,OAAO,CAAC;AAAA,MACvB,KAAK,aAAE,OAAO;AAAA,MACd,MAAM,aAAE,OAAO;AAAA,IACjB,CAAC;AAAA,EACH;AACF,CAAC;AAKD,IAAM,qBAAqB,aAAE,OAAO;AAAA,EAClC,SAAS,aAAE,OAAO;AACpB,CAAC;AAED,IAAM,iBAAiB,aAAE,MAAM,CAAC,0BAA0B,kBAAkB,CAAC;AAE7E,IAAM,iBAAiB,aAAE,OAAO;AAAA,EAC9B,KAAK,aAAE,OAAO;AAAA,EACd,OAAO,aAAE,OAAO;AAAA,EAChB,QAAQ,aAAE,OAAO;AAAA,EACjB,cAAc,aAAE,OAAO;AACzB,CAAC;AAED,IAAM,yBAAyB,aAAE,MAAM;AAAA,EACrC,aAAE,OAAO;AAAA,IACP,QAAQ,aAAE,MAAM,cAAc;AAAA,EAChC,CAAC;AAAA,EACD,aAAE,OAAO;AAAA,IACP,OAAO;AAAA,EACT,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,OAA0C;AACnE,SAAO,yBAAyB,UAAU,KAAK,EAAE;AACnD;AAEA,IAAM,+BAA2B,sDAA+B;AAAA,EAC9D,aAAa;AAAA,EACb,gBAAgB,WAAS;AAnM3B;AAoMI,QAAI,kBAAkB,KAAK,GAAG;AAC5B,aAAO,MAAM,OACV,IAAI,YAAU,GAAG,OAAO,IAAI,KAAK,GAAG,CAAC,KAAK,OAAO,GAAG,EAAE,EACtD,KAAK,IAAI;AAAA,IACd;AACA,YAAO,WAAM,YAAN,YAAiB;AAAA,EAC1B;AACF,CAAC;;;ADrKD,IAAM,iBAAiB;AAKhB,SAAS,UAAU,UAA+B,CAAC,GAAgB;AA3C1E;AA4CE,QAAM,cAAU,8CAAqB,aAAQ,YAAR,YAAmB,cAAc;AACtE,QAAM,aAAa,OAAO;AAAA,IACxB,eAAe,WAAO,mCAAW;AAAA,MAC/B,QAAQ,QAAQ;AAAA,MAChB,yBAAyB;AAAA,MACzB,aAAa;AAAA,IACf,CAAC,CAAC;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,QAAM,mBAAmB,CACvB,SACA,WAA6B,CAAC,MAE9B,IAAI,cAAc,SAAS,UAAU;AAAA,IACnC,UAAU;AAAA,IACV,SAAS,4BAAW;AAAA,IACpB,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,WAAW,CAAC,SAA0B,aAC1C,iBAAiB,SAAS,QAAQ;AAEpC,WAAS,QAAQ;AAEjB,SAAO;AACT;AAKO,IAAM,MAAM,UAAU;","names":["import_provider_utils"]}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
// src/fal-provider.ts
|
|
2
|
+
import { loadApiKey, withoutTrailingSlash } from "@ai-sdk/provider-utils";
|
|
3
|
+
|
|
4
|
+
// src/fal-image-model.ts
|
|
5
|
+
import {
|
|
6
|
+
combineHeaders,
|
|
7
|
+
createBinaryResponseHandler,
|
|
8
|
+
createJsonResponseHandler,
|
|
9
|
+
createJsonErrorResponseHandler,
|
|
10
|
+
createStatusCodeErrorResponseHandler,
|
|
11
|
+
getFromApi,
|
|
12
|
+
postJsonToApi,
|
|
13
|
+
resolve
|
|
14
|
+
} from "@ai-sdk/provider-utils";
|
|
15
|
+
import { z } from "zod";
|
|
16
|
+
var FalImageModel = class {
|
|
17
|
+
constructor(modelId, settings, config) {
|
|
18
|
+
this.modelId = modelId;
|
|
19
|
+
this.settings = settings;
|
|
20
|
+
this.config = config;
|
|
21
|
+
this.specificationVersion = "v1";
|
|
22
|
+
}
|
|
23
|
+
get provider() {
|
|
24
|
+
return this.config.provider;
|
|
25
|
+
}
|
|
26
|
+
get maxImagesPerCall() {
|
|
27
|
+
var _a;
|
|
28
|
+
return (_a = this.settings.maxImagesPerCall) != null ? _a : 1;
|
|
29
|
+
}
|
|
30
|
+
async doGenerate({
|
|
31
|
+
prompt,
|
|
32
|
+
n,
|
|
33
|
+
size,
|
|
34
|
+
aspectRatio,
|
|
35
|
+
seed,
|
|
36
|
+
providerOptions,
|
|
37
|
+
headers,
|
|
38
|
+
abortSignal
|
|
39
|
+
}) {
|
|
40
|
+
var _a, _b, _c, _d;
|
|
41
|
+
const warnings = [];
|
|
42
|
+
let imageSize;
|
|
43
|
+
if (size) {
|
|
44
|
+
const [width, height] = size.split("x").map(Number);
|
|
45
|
+
imageSize = { width, height };
|
|
46
|
+
} else if (aspectRatio) {
|
|
47
|
+
imageSize = convertAspectRatioToSize(aspectRatio);
|
|
48
|
+
}
|
|
49
|
+
const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
|
|
50
|
+
const { value, responseHeaders } = await postJsonToApi({
|
|
51
|
+
url: `${this.config.baseURL}/${this.modelId}`,
|
|
52
|
+
headers: combineHeaders(await resolve(this.config.headers), headers),
|
|
53
|
+
body: {
|
|
54
|
+
prompt,
|
|
55
|
+
seed,
|
|
56
|
+
image_size: imageSize,
|
|
57
|
+
num_images: n,
|
|
58
|
+
...(_d = providerOptions.fal) != null ? _d : {}
|
|
59
|
+
},
|
|
60
|
+
failedResponseHandler: falFailedResponseHandler,
|
|
61
|
+
successfulResponseHandler: createJsonResponseHandler(
|
|
62
|
+
falImageResponseSchema
|
|
63
|
+
),
|
|
64
|
+
abortSignal,
|
|
65
|
+
fetch: this.config.fetch
|
|
66
|
+
});
|
|
67
|
+
const targetImages = "images" in value ? value.images : [value.image];
|
|
68
|
+
const downloadedImages = await Promise.all(
|
|
69
|
+
targetImages.map((image) => this.downloadImage(image.url, abortSignal))
|
|
70
|
+
);
|
|
71
|
+
return {
|
|
72
|
+
images: downloadedImages,
|
|
73
|
+
warnings,
|
|
74
|
+
response: {
|
|
75
|
+
modelId: this.modelId,
|
|
76
|
+
timestamp: currentDate,
|
|
77
|
+
headers: responseHeaders
|
|
78
|
+
}
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
async downloadImage(url, abortSignal) {
|
|
82
|
+
const { value: response } = await getFromApi({
|
|
83
|
+
url,
|
|
84
|
+
// No specific headers should be needed for this request as it's a
|
|
85
|
+
// generated image provided by fal.ai.
|
|
86
|
+
abortSignal,
|
|
87
|
+
failedResponseHandler: createStatusCodeErrorResponseHandler(),
|
|
88
|
+
successfulResponseHandler: createBinaryResponseHandler(),
|
|
89
|
+
fetch: this.config.fetch
|
|
90
|
+
});
|
|
91
|
+
return response;
|
|
92
|
+
}
|
|
93
|
+
};
|
|
94
|
+
function convertAspectRatioToSize(aspectRatio) {
|
|
95
|
+
switch (aspectRatio) {
|
|
96
|
+
case "1:1":
|
|
97
|
+
return "square_hd";
|
|
98
|
+
case "16:9":
|
|
99
|
+
return "landscape_16_9";
|
|
100
|
+
case "9:16":
|
|
101
|
+
return "portrait_16_9";
|
|
102
|
+
case "4:3":
|
|
103
|
+
return "landscape_4_3";
|
|
104
|
+
case "3:4":
|
|
105
|
+
return "portrait_4_3";
|
|
106
|
+
case "16:10":
|
|
107
|
+
return { width: 1280, height: 800 };
|
|
108
|
+
case "10:16":
|
|
109
|
+
return { width: 800, height: 1280 };
|
|
110
|
+
case "21:9":
|
|
111
|
+
return { width: 2560, height: 1080 };
|
|
112
|
+
case "9:21":
|
|
113
|
+
return { width: 1080, height: 2560 };
|
|
114
|
+
}
|
|
115
|
+
return void 0;
|
|
116
|
+
}
|
|
117
|
+
var falValidationErrorSchema = z.object({
|
|
118
|
+
detail: z.array(
|
|
119
|
+
z.object({
|
|
120
|
+
loc: z.array(z.string()),
|
|
121
|
+
msg: z.string(),
|
|
122
|
+
type: z.string()
|
|
123
|
+
})
|
|
124
|
+
)
|
|
125
|
+
});
|
|
126
|
+
var falHttpErrorSchema = z.object({
|
|
127
|
+
message: z.string()
|
|
128
|
+
});
|
|
129
|
+
var falErrorSchema = z.union([falValidationErrorSchema, falHttpErrorSchema]);
|
|
130
|
+
var falImageSchema = z.object({
|
|
131
|
+
url: z.string(),
|
|
132
|
+
width: z.number(),
|
|
133
|
+
height: z.number(),
|
|
134
|
+
content_type: z.string()
|
|
135
|
+
});
|
|
136
|
+
var falImageResponseSchema = z.union([
|
|
137
|
+
z.object({
|
|
138
|
+
images: z.array(falImageSchema)
|
|
139
|
+
}),
|
|
140
|
+
z.object({
|
|
141
|
+
image: falImageSchema
|
|
142
|
+
})
|
|
143
|
+
]);
|
|
144
|
+
function isValidationError(error) {
|
|
145
|
+
return falValidationErrorSchema.safeParse(error).success;
|
|
146
|
+
}
|
|
147
|
+
var falFailedResponseHandler = createJsonErrorResponseHandler({
|
|
148
|
+
errorSchema: falErrorSchema,
|
|
149
|
+
errorToMessage: (error) => {
|
|
150
|
+
var _a;
|
|
151
|
+
if (isValidationError(error)) {
|
|
152
|
+
return error.detail.map((detail) => `${detail.loc.join(".")}: ${detail.msg}`).join("\n");
|
|
153
|
+
}
|
|
154
|
+
return (_a = error.message) != null ? _a : "Unknown fal error";
|
|
155
|
+
}
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
// src/fal-provider.ts
|
|
159
|
+
var defaultBaseURL = "https://fal.run";
|
|
160
|
+
function createFal(options = {}) {
|
|
161
|
+
var _a;
|
|
162
|
+
const baseURL = withoutTrailingSlash((_a = options.baseURL) != null ? _a : defaultBaseURL);
|
|
163
|
+
const getHeaders = () => ({
|
|
164
|
+
Authorization: `Key ${loadApiKey({
|
|
165
|
+
apiKey: options.apiKey,
|
|
166
|
+
environmentVariableName: "FAL_API_KEY",
|
|
167
|
+
description: "fal.ai"
|
|
168
|
+
})}`,
|
|
169
|
+
...options.headers
|
|
170
|
+
});
|
|
171
|
+
const createImageModel = (modelId, settings = {}) => new FalImageModel(modelId, settings, {
|
|
172
|
+
provider: "fal.image",
|
|
173
|
+
baseURL: baseURL != null ? baseURL : defaultBaseURL,
|
|
174
|
+
headers: getHeaders,
|
|
175
|
+
fetch: options.fetch
|
|
176
|
+
});
|
|
177
|
+
const provider = (modelId, settings) => createImageModel(modelId, settings);
|
|
178
|
+
provider.image = createImageModel;
|
|
179
|
+
return provider;
|
|
180
|
+
}
|
|
181
|
+
var fal = createFal();
|
|
182
|
+
export {
|
|
183
|
+
createFal,
|
|
184
|
+
fal
|
|
185
|
+
};
|
|
186
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/fal-provider.ts","../src/fal-image-model.ts"],"sourcesContent":["import { ImageModelV1 } from '@ai-sdk/provider';\nimport type { FetchFunction } from '@ai-sdk/provider-utils';\nimport { loadApiKey, withoutTrailingSlash } from '@ai-sdk/provider-utils';\nimport { FalImageModel } from './fal-image-model';\nimport { FalImageModelId, FalImageSettings } from './fal-image-settings';\n\nexport interface FalProviderSettings {\n /**\nfal.ai API key. Default value is taken from the `FAL_API_KEY` environment\nvariable.\n */\n apiKey?: string;\n\n /**\nBase URL for the API calls.\nThe default prefix is `https://fal.run`.\n */\n baseURL?: string;\n\n /**\nCustom headers to include in the requests.\n */\n headers?: Record<string, string>;\n\n /**\nCustom fetch implementation. You can use it as a middleware to intercept\nrequests, or to provide a custom fetch implementation for e.g. testing.\n */\n fetch?: FetchFunction;\n}\n\nexport interface FalProvider {\n /**\nCreates a model for image generation.\n */\n image(modelId: FalImageModelId, settings?: FalImageSettings): ImageModelV1;\n}\n\nconst defaultBaseURL = 'https://fal.run';\n\n/**\nCreate a fal.ai provider instance.\n */\nexport function createFal(options: FalProviderSettings = {}): FalProvider {\n const baseURL = withoutTrailingSlash(options.baseURL ?? defaultBaseURL);\n const getHeaders = () => ({\n Authorization: `Key ${loadApiKey({\n apiKey: options.apiKey,\n environmentVariableName: 'FAL_API_KEY',\n description: 'fal.ai',\n })}`,\n ...options.headers,\n });\n\n const createImageModel = (\n modelId: FalImageModelId,\n settings: FalImageSettings = {},\n ) =>\n new FalImageModel(modelId, settings, {\n provider: 'fal.image',\n baseURL: baseURL ?? defaultBaseURL,\n headers: getHeaders,\n fetch: options.fetch,\n });\n\n const provider = (modelId: FalImageModelId, settings?: FalImageSettings) =>\n createImageModel(modelId, settings);\n\n provider.image = createImageModel;\n\n return provider as FalProvider;\n}\n\n/**\nDefault fal.ai provider instance.\n */\nexport const fal = createFal();\n","import type { ImageModelV1, ImageModelV1CallWarning } from '@ai-sdk/provider';\nimport type { Resolvable } from '@ai-sdk/provider-utils';\nimport {\n FetchFunction,\n combineHeaders,\n createBinaryResponseHandler,\n createJsonResponseHandler,\n createJsonErrorResponseHandler,\n createStatusCodeErrorResponseHandler,\n getFromApi,\n postJsonToApi,\n resolve,\n} from '@ai-sdk/provider-utils';\nimport { z } from 'zod';\nimport {\n FalImageModelId,\n FalImageSettings,\n FalImageSize,\n} from './fal-image-settings';\n\ninterface FalImageModelConfig {\n provider: string;\n baseURL: string;\n headers?: Resolvable<Record<string, string | undefined>>;\n fetch?: FetchFunction;\n _internal?: {\n currentDate?: () => Date;\n };\n}\n\nexport class FalImageModel implements ImageModelV1 {\n readonly specificationVersion = 'v1';\n\n get provider(): string {\n return this.config.provider;\n }\n\n get maxImagesPerCall(): number {\n return this.settings.maxImagesPerCall ?? 1;\n }\n\n constructor(\n readonly modelId: FalImageModelId,\n private readonly settings: FalImageSettings,\n private readonly config: FalImageModelConfig,\n ) {}\n\n async doGenerate({\n prompt,\n n,\n size,\n aspectRatio,\n seed,\n providerOptions,\n headers,\n abortSignal,\n }: Parameters<ImageModelV1['doGenerate']>[0]): Promise<\n Awaited<ReturnType<ImageModelV1['doGenerate']>>\n > {\n const warnings: Array<ImageModelV1CallWarning> = [];\n\n let imageSize: FalImageSize | undefined;\n if (size) {\n const [width, height] = size.split('x').map(Number);\n imageSize = { width, height };\n } else if (aspectRatio) {\n imageSize = convertAspectRatioToSize(aspectRatio);\n }\n\n const currentDate = this.config._internal?.currentDate?.() ?? new Date();\n const { value, responseHeaders } = await postJsonToApi({\n url: `${this.config.baseURL}/${this.modelId}`,\n headers: combineHeaders(await resolve(this.config.headers), headers),\n body: {\n prompt,\n seed,\n image_size: imageSize,\n num_images: n,\n ...(providerOptions.fal ?? {}),\n },\n failedResponseHandler: falFailedResponseHandler,\n successfulResponseHandler: createJsonResponseHandler(\n falImageResponseSchema,\n ),\n abortSignal,\n fetch: this.config.fetch,\n });\n\n // download the images:\n const targetImages = 'images' in value ? value.images : [value.image];\n const downloadedImages = await Promise.all(\n targetImages.map(image => this.downloadImage(image.url, abortSignal)),\n );\n\n return {\n images: downloadedImages,\n warnings,\n response: {\n modelId: this.modelId,\n timestamp: currentDate,\n headers: responseHeaders,\n },\n };\n }\n\n private async downloadImage(\n url: string,\n abortSignal: AbortSignal | undefined,\n ): Promise<Uint8Array> {\n const { value: response } = await getFromApi({\n url,\n // No specific headers should be needed for this request as it's a\n // generated image provided by fal.ai.\n abortSignal,\n failedResponseHandler: createStatusCodeErrorResponseHandler(),\n successfulResponseHandler: createBinaryResponseHandler(),\n fetch: this.config.fetch,\n });\n return response;\n }\n}\n\n/**\nConverts an aspect ratio to an image size compatible with fal.ai APIs.\n@param aspectRatio - The aspect ratio to convert.\n@returns The image size.\n */\nfunction convertAspectRatioToSize(\n aspectRatio: `${number}:${number}`,\n): FalImageSize | undefined {\n switch (aspectRatio) {\n case '1:1':\n return 'square_hd';\n case '16:9':\n return 'landscape_16_9';\n case '9:16':\n return 'portrait_16_9';\n case '4:3':\n return 'landscape_4_3';\n case '3:4':\n return 'portrait_4_3';\n case '16:10':\n return { width: 1280, height: 800 };\n case '10:16':\n return { width: 800, height: 1280 };\n case '21:9':\n return { width: 2560, height: 1080 };\n case '9:21':\n return { width: 1080, height: 2560 };\n }\n return undefined;\n}\n\n// Validation error has a particular payload to inform the exact property that is invalid\nconst falValidationErrorSchema = z.object({\n detail: z.array(\n z.object({\n loc: z.array(z.string()),\n msg: z.string(),\n type: z.string(),\n }),\n ),\n});\n\ntype ValidationError = z.infer<typeof falValidationErrorSchema>;\n\n// Other errors have a message property\nconst falHttpErrorSchema = z.object({\n message: z.string(),\n});\n\nconst falErrorSchema = z.union([falValidationErrorSchema, falHttpErrorSchema]);\n\nconst falImageSchema = z.object({\n url: z.string(),\n width: z.number(),\n height: z.number(),\n content_type: z.string(),\n});\n\nconst falImageResponseSchema = z.union([\n z.object({\n images: z.array(falImageSchema),\n }),\n z.object({\n image: falImageSchema,\n }),\n]);\n\nfunction isValidationError(error: unknown): error is ValidationError {\n return falValidationErrorSchema.safeParse(error).success;\n}\n\nconst falFailedResponseHandler = createJsonErrorResponseHandler({\n errorSchema: falErrorSchema,\n errorToMessage: error => {\n if (isValidationError(error)) {\n return error.detail\n .map(detail => `${detail.loc.join('.')}: ${detail.msg}`)\n .join('\\n');\n }\n return error.message ?? 'Unknown fal error';\n },\n});\n"],"mappings":";AAEA,SAAS,YAAY,4BAA4B;;;ACAjD;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS;AAiBX,IAAM,gBAAN,MAA4C;AAAA,EAWjD,YACW,SACQ,UACA,QACjB;AAHS;AACQ;AACA;AAbnB,SAAS,uBAAuB;AAAA,EAc7B;AAAA,EAZH,IAAI,WAAmB;AACrB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,mBAA2B;AArCjC;AAsCI,YAAO,UAAK,SAAS,qBAAd,YAAkC;AAAA,EAC3C;AAAA,EAQA,MAAM,WAAW;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAEE;AA1DJ;AA2DI,UAAM,WAA2C,CAAC;AAElD,QAAI;AACJ,QAAI,MAAM;AACR,YAAM,CAAC,OAAO,MAAM,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI,MAAM;AAClD,kBAAY,EAAE,OAAO,OAAO;AAAA,IAC9B,WAAW,aAAa;AACtB,kBAAY,yBAAyB,WAAW;AAAA,IAClD;AAEA,UAAM,eAAc,sBAAK,OAAO,cAAZ,mBAAuB,gBAAvB,4CAA0C,oBAAI,KAAK;AACvE,UAAM,EAAE,OAAO,gBAAgB,IAAI,MAAM,cAAc;AAAA,MACrD,KAAK,GAAG,KAAK,OAAO,OAAO,IAAI,KAAK,OAAO;AAAA,MAC3C,SAAS,eAAe,MAAM,QAAQ,KAAK,OAAO,OAAO,GAAG,OAAO;AAAA,MACnE,MAAM;AAAA,QACJ;AAAA,QACA;AAAA,QACA,YAAY;AAAA,QACZ,YAAY;AAAA,QACZ,IAAI,qBAAgB,QAAhB,YAAuB,CAAC;AAAA,MAC9B;AAAA,MACA,uBAAuB;AAAA,MACvB,2BAA2B;AAAA,QACzB;AAAA,MACF;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AAGD,UAAM,eAAe,YAAY,QAAQ,MAAM,SAAS,CAAC,MAAM,KAAK;AACpE,UAAM,mBAAmB,MAAM,QAAQ;AAAA,MACrC,aAAa,IAAI,WAAS,KAAK,cAAc,MAAM,KAAK,WAAW,CAAC;AAAA,IACtE;AAEA,WAAO;AAAA,MACL,QAAQ;AAAA,MACR;AAAA,MACA,UAAU;AAAA,QACR,SAAS,KAAK;AAAA,QACd,WAAW;AAAA,QACX,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,cACZ,KACA,aACqB;AACrB,UAAM,EAAE,OAAO,SAAS,IAAI,MAAM,WAAW;AAAA,MAC3C;AAAA;AAAA;AAAA,MAGA;AAAA,MACA,uBAAuB,qCAAqC;AAAA,MAC5D,2BAA2B,4BAA4B;AAAA,MACvD,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAOA,SAAS,yBACP,aAC0B;AAC1B,UAAQ,aAAa;AAAA,IACnB,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,IAAI;AAAA,IACpC,KAAK;AACH,aAAO,EAAE,OAAO,KAAK,QAAQ,KAAK;AAAA,IACpC,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,KAAK;AAAA,IACrC,KAAK;AACH,aAAO,EAAE,OAAO,MAAM,QAAQ,KAAK;AAAA,EACvC;AACA,SAAO;AACT;AAGA,IAAM,2BAA2B,EAAE,OAAO;AAAA,EACxC,QAAQ,EAAE;AAAA,IACR,EAAE,OAAO;AAAA,MACP,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,MACvB,KAAK,EAAE,OAAO;AAAA,MACd,MAAM,EAAE,OAAO;AAAA,IACjB,CAAC;AAAA,EACH;AACF,CAAC;AAKD,IAAM,qBAAqB,EAAE,OAAO;AAAA,EAClC,SAAS,EAAE,OAAO;AACpB,CAAC;AAED,IAAM,iBAAiB,EAAE,MAAM,CAAC,0BAA0B,kBAAkB,CAAC;AAE7E,IAAM,iBAAiB,EAAE,OAAO;AAAA,EAC9B,KAAK,EAAE,OAAO;AAAA,EACd,OAAO,EAAE,OAAO;AAAA,EAChB,QAAQ,EAAE,OAAO;AAAA,EACjB,cAAc,EAAE,OAAO;AACzB,CAAC;AAED,IAAM,yBAAyB,EAAE,MAAM;AAAA,EACrC,EAAE,OAAO;AAAA,IACP,QAAQ,EAAE,MAAM,cAAc;AAAA,EAChC,CAAC;AAAA,EACD,EAAE,OAAO;AAAA,IACP,OAAO;AAAA,EACT,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,OAA0C;AACnE,SAAO,yBAAyB,UAAU,KAAK,EAAE;AACnD;AAEA,IAAM,2BAA2B,+BAA+B;AAAA,EAC9D,aAAa;AAAA,EACb,gBAAgB,WAAS;AAnM3B;AAoMI,QAAI,kBAAkB,KAAK,GAAG;AAC5B,aAAO,MAAM,OACV,IAAI,YAAU,GAAG,OAAO,IAAI,KAAK,GAAG,CAAC,KAAK,OAAO,GAAG,EAAE,EACtD,KAAK,IAAI;AAAA,IACd;AACA,YAAO,WAAM,YAAN,YAAiB;AAAA,EAC1B;AACF,CAAC;;;ADrKD,IAAM,iBAAiB;AAKhB,SAAS,UAAU,UAA+B,CAAC,GAAgB;AA3C1E;AA4CE,QAAM,UAAU,sBAAqB,aAAQ,YAAR,YAAmB,cAAc;AACtE,QAAM,aAAa,OAAO;AAAA,IACxB,eAAe,OAAO,WAAW;AAAA,MAC/B,QAAQ,QAAQ;AAAA,MAChB,yBAAyB;AAAA,MACzB,aAAa;AAAA,IACf,CAAC,CAAC;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,QAAM,mBAAmB,CACvB,SACA,WAA6B,CAAC,MAE9B,IAAI,cAAc,SAAS,UAAU;AAAA,IACnC,UAAU;AAAA,IACV,SAAS,4BAAW;AAAA,IACpB,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,WAAW,CAAC,SAA0B,aAC1C,iBAAiB,SAAS,QAAQ;AAEpC,WAAS,QAAQ;AAEjB,SAAO;AACT;AAKO,IAAM,MAAM,UAAU;","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ai-sdk/fal",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"sideEffects": false,
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"module": "./dist/index.mjs",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"files": [
|
|
10
|
+
"dist/**/*",
|
|
11
|
+
"CHANGELOG.md"
|
|
12
|
+
],
|
|
13
|
+
"exports": {
|
|
14
|
+
"./package.json": "./package.json",
|
|
15
|
+
".": {
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"import": "./dist/index.mjs",
|
|
18
|
+
"require": "./dist/index.js"
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"@ai-sdk/provider": "1.0.6",
|
|
23
|
+
"@ai-sdk/provider-utils": "2.1.5"
|
|
24
|
+
},
|
|
25
|
+
"devDependencies": {
|
|
26
|
+
"@types/node": "^18",
|
|
27
|
+
"tsup": "^8",
|
|
28
|
+
"typescript": "5.6.3",
|
|
29
|
+
"zod": "3.23.8",
|
|
30
|
+
"@vercel/ai-tsconfig": "0.0.0"
|
|
31
|
+
},
|
|
32
|
+
"peerDependencies": {
|
|
33
|
+
"zod": "^3.0.0"
|
|
34
|
+
},
|
|
35
|
+
"engines": {
|
|
36
|
+
"node": ">=18"
|
|
37
|
+
},
|
|
38
|
+
"publishConfig": {
|
|
39
|
+
"access": "public"
|
|
40
|
+
},
|
|
41
|
+
"homepage": "https://sdk.vercel.ai/docs",
|
|
42
|
+
"repository": {
|
|
43
|
+
"type": "git",
|
|
44
|
+
"url": "git+https://github.com/vercel/ai.git"
|
|
45
|
+
},
|
|
46
|
+
"bugs": {
|
|
47
|
+
"url": "https://github.com/vercel/ai/issues"
|
|
48
|
+
},
|
|
49
|
+
"keywords": [
|
|
50
|
+
"ai"
|
|
51
|
+
],
|
|
52
|
+
"scripts": {
|
|
53
|
+
"build": "tsup",
|
|
54
|
+
"build:watch": "tsup --watch",
|
|
55
|
+
"clean": "rm -rf dist",
|
|
56
|
+
"lint": "eslint \"./**/*.ts*\"",
|
|
57
|
+
"type-check": "tsc --noEmit",
|
|
58
|
+
"prettier-check": "prettier --check \"./**/*.ts*\"",
|
|
59
|
+
"test": "pnpm test:node && pnpm test:edge",
|
|
60
|
+
"test:edge": "vitest --config vitest.edge.config.js --run",
|
|
61
|
+
"test:node": "vitest --config vitest.node.config.js --run"
|
|
62
|
+
}
|
|
63
|
+
}
|