- fal-serverless diffusion -
-Enter a prompt to generate the image
- - -
-
-
-
+ {
- const result = await fal.run('a51c0ca0-9011-4ff0-8dc1-2ac0b42a9fd0', {
- path: '/generate',
- input,
- });
- const data = result['raw_data'];
- return `data:image/jpg;base64,${data}`;
-}
diff --git a/apps/demo-app/services/getJoke.ts b/apps/demo-app/services/getJoke.ts
deleted file mode 100644
index e4afad2..0000000
--- a/apps/demo-app/services/getJoke.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import * as fal from '@fal-ai/serverless-client';
-
-fal.config({
- host: 'gateway.alpha.fal.ai',
- credentials: {
- userId: process.env.FAL_USER_ID || '',
- keyId: process.env.FAL_KEY_ID || '',
- keySecret: process.env.FAL_KEY_SECRET || '',
- },
-});
-
-export type GetJokeInput = {
- language?: string;
-};
-
-export function getJoke(input?: GetJokeInput): Promise<{ joke: string }> {
- return fal.run('fastapi_get_joke', { input });
-}
diff --git a/apps/demo-app/specs/index.spec.tsx b/apps/demo-app/specs/index.spec.tsx
index 80e1079..5d65455 100644
--- a/apps/demo-app/specs/index.spec.tsx
+++ b/apps/demo-app/specs/index.spec.tsx
@@ -1,4 +1,3 @@
-import React from 'react';
import { render } from '@testing-library/react';
import Index from '../pages/index';
diff --git a/libs/client/package.json b/libs/client/package.json
index b823b85..4de3d04 100644
--- a/libs/client/package.json
+++ b/libs/client/package.json
@@ -1,7 +1,7 @@
{
"name": "@fal-ai/serverless-client",
"description": "The fal serverless JS/TS client",
- "version": "0.1.0",
+ "version": "0.2.0",
"license": "MIT",
"repository": {
"type": "git",
diff --git a/libs/client/src/config.spec.ts b/libs/client/src/config.spec.ts
index ef7458d..06d2255 100644
--- a/libs/client/src/config.spec.ts
+++ b/libs/client/src/config.spec.ts
@@ -7,11 +7,11 @@ describe('The config test suite', () => {
credentials: {
keyId: 'key-id',
keySecret: 'key-secret',
- userId: 'user-id',
},
};
config(newConfig);
const currentConfig = getConfig();
- expect(currentConfig).toEqual(newConfig);
+ expect(currentConfig.host).toBe(newConfig.host);
+ expect(currentConfig.credentials).toEqual(newConfig.credentials);
});
});
diff --git a/libs/client/src/config.ts b/libs/client/src/config.ts
index 403ae69..73d0955 100644
--- a/libs/client/src/config.ts
+++ b/libs/client/src/config.ts
@@ -1,21 +1,80 @@
+import type { RequestMiddleware } from './middleware';
+import type { ResponseHandler } from './response';
+import { defaultResponseHandler } from './response';
+
export type Credentials = {
keyId: string;
keySecret: string;
- userId: string;
};
+export type CredentialsResolver = () => Credentials;
+
export type Config = {
- credentials: Credentials;
+ credentials?: Credentials | CredentialsResolver;
host?: string;
+ requestMiddleware?: RequestMiddleware;
+ responseHandler?: ResponseHandler;
};
export type RequiredConfig = Required;
+/**
+ * Checks if the required FAL environment variables are set.
+ *
+ * @returns `true` if the required environment variables are set,
+ * `false` otherwise.
+ */
+function hasEnvVariables(): boolean {
+ return (
+ process &&
+ process.env &&
+ typeof process.env.FAL_KEY_ID !== 'undefined' &&
+ typeof process.env.FAL_KEY_SECRET !== 'undefined'
+ );
+}
+
+export const credentialsFromEnv: CredentialsResolver = () => {
+ if (!hasEnvVariables()) {
+ return {
+ keyId: '',
+ keySecret: '',
+ };
+ }
+ if (typeof window !== 'undefined') {
+ console.warn(
+ "The fal credentials are exposed in the browser's environment. " +
+ "That's not recommended for production use cases."
+ );
+ }
+
+ return {
+ keyId: process.env.FAL_KEY_ID || '',
+ keySecret: process.env.FAL_KEY_SECRET || '',
+ };
+};
+
+/**
+ * Get the default host for the fal-serverless gateway endpoint.
+ * @private
+ * @returns the default host. Depending on the platform it can default to
+ * the environment variable `FAL_HOST`.
+ */
+function getDefaultHost(): string {
+ const host = 'gateway.alpha.fal.ai';
+ if (process && process.env) {
+ return process.env.FAL_HOST || host;
+ }
+ return host;
+}
+
const DEFAULT_CONFIG: Partial = {
- host: 'gateway.shark.fal.ai',
+ host: getDefaultHost(),
+ credentials: credentialsFromEnv,
+ requestMiddleware: (request) => Promise.resolve(request),
+ responseHandler: defaultResponseHandler,
};
-let configuration: RequiredConfig | undefined = undefined;
+let configuration: RequiredConfig;
/**
* Configures the fal serverless client.
@@ -32,8 +91,8 @@ export function config(config: Config) {
* @returns the current client configuration.
*/
export function getConfig(): RequiredConfig {
- if (typeof configuration === 'undefined') {
- throw new Error('You must configure fal-serverless first.');
+ if (!configuration) {
+ console.info('Using default configuration for the fal client');
}
return configuration;
}
diff --git a/libs/client/src/function.spec.ts b/libs/client/src/function.spec.ts
index 2cbd87e..5735c8d 100644
--- a/libs/client/src/function.spec.ts
+++ b/libs/client/src/function.spec.ts
@@ -5,7 +5,6 @@ import { buildUrl } from './function';
config({
host: 'gateway.alpha.fal.ai',
credentials: {
- userId: 'github|123456',
keyId: 'a91ff3ca-71bc-4c8c-b400-859f6cbe804d',
keySecret: '0123456789abcdfeghijklmnopqrstuv',
},
@@ -13,15 +12,14 @@ config({
describe('The function test suite', () => {
it('should build the URL with a function UUIDv4', () => {
- const { credentials } = getConfig();
const id = randomUUID();
- const url = buildUrl(id);
- expect(url).toMatch(`trigger/${credentials.userId}/${id}`);
+ const url = buildUrl(`12345/${id}`);
+ expect(url).toMatch(`trigger/12345/${id}`);
});
it('should build the URL with a function alias', () => {
const { host } = getConfig();
- const alias = 'some-alias';
+ const alias = '12345-some-alias';
const url = buildUrl(alias);
expect(url).toMatch(`${alias}.${host}`);
});
diff --git a/libs/client/src/function.ts b/libs/client/src/function.ts
index d0a5721..93fc3b2 100644
--- a/libs/client/src/function.ts
+++ b/libs/client/src/function.ts
@@ -1,7 +1,7 @@
-import fetch from 'cross-fetch';
import { getConfig } from './config';
import { getUserAgent, isBrowser } from './runtime';
-import { isUUIDv4 } from './utils';
+import { EnqueueResult, QueueStatus } from './types';
+import { isUUIDv4, isValidUrl } from './utils';
/**
* The function input and other configuration when running
@@ -22,7 +22,7 @@ type RunOptions = {
/**
* The HTTP method, defaults to `post`;
*/
- readonly method?: 'get' | 'post' | 'put' | 'delete';
+ readonly method?: 'get' | 'post' | 'put' | 'delete' | string;
};
/**
@@ -38,150 +38,143 @@ export function buildUrl(
id: string,
options: RunOptions = {}
): string {
- const { credentials, host } = getConfig();
+ const { host } = getConfig();
const method = (options.method ?? 'post').toLowerCase();
- const path = options.path ?? '';
+ const path = (options.path ?? '').replace(/^\//, '').replace(/\/{2,}/, '/');
const params =
method === 'get' ? new URLSearchParams(options.input ?? {}) : undefined;
- let queryParams = '';
- if (params) {
- queryParams = `?${params.toString()}`;
+ // TODO: change to params.size once it's officially supported
+ const queryParams = params && params['size'] ? `?${params.toString()}` : '';
+ const parts = id.split('/');
+
+ // if a fal.ai url is passed, just use it
+ if (isValidUrl(id)) {
+ const url = id.endsWith('/') ? id : `${id}/`;
+ return `${url}${path}${queryParams}`;
}
- if (isUUIDv4(id)) {
- return `https://${host}/trigger/${credentials.userId}/${id}/${path}${queryParams}`;
+
+ if (parts.length === 2 && isUUIDv4(parts[1])) {
+ return `https://${host}/trigger/${id}/${path}${queryParams}`;
}
- const userId = credentials.userId.replace(/github\|/g, '');
- return `https://${userId}-${id}.${host}/${path}${queryParams}`;
+ return `https://${id}.${host}/${path}${queryParams}`;
}
/**
* Runs a fal serverless function identified by its `id`.
* TODO: expand documentation and provide examples
*
- * @param id the registered function id
+ * @param id the registered function revision id or alias.
* @returns the remote function output
*/
export async function run(
id: string,
options: RunOptions = {}
): Promise
+
- Hello
-
);
diff --git a/apps/demo-app/services/generateImage.ts b/apps/demo-app/services/generateImage.ts
deleted file mode 100644
index 2ed4e27..0000000
--- a/apps/demo-app/services/generateImage.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-import * as fal from '@fal-ai/serverless-client';
-
-export type GenerateImageInput = {
- prompt: string;
-};
-
-type ImageType = 'gif' | 'png' | 'jpg' | 'jpeg';
-type ImageDataUri = `data:image/${ImageType};base64,${string}`;
-
-fal.config({
- credentials: {
- userId: '',
- keyId: '',
- keySecret: '',
- },
-});
-
-export async function generateImage(
- input: GenerateImageInput
-): Promise
- Hello fal-serverless
+ Hello fal
- - This page can access fal-serverless functions when - it's rendering. -
-
+
+ setPrompt(e.target.value)}
+ onBlur={(e) => setPrompt(e.target.value.trim())}
+ />
+
- - Here's a joke: {props.joke} -
+
+
+ {image && (
+ // eslint-disable-next-line @next/next/no-img-element
+ 
+ )}
+
+
+
+
+ JSON Result
++ {`Elapsed Time (seconds): ${(elapsedTime / 1000).toFixed(2)}`} +
+
+ {result
+ ? JSON.stringify(result, null, 2)
+ : '// result pending...'}
+
+
+
+ Logs
+
+ {logs.filter(Boolean).join('\n')}
+
+