fal-endpoint-types 1.1.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fal-endpoint-types",
-    "version": "1.1.0",
+    "version": "1.2.1",
     "description": "",
     "homepage": "https://github.com/rawpixel-vincent/fal-endpoint-types#readme",
     "bugs": {

package/readme.md

@@ -1,4 +1,8 @@
-input and output shapes exported from the openapi.json of fal.ai endpoints to typescript types.
+Fal.ai model endpoints Input and Output ts shapes.
+Built from the Open API schemas provided by fal.ai.
+
+- https://fal.ai/api/models
+- https://fal.ai/api/openapi/queue/openapi.json?endpoint_id={endpointId}
 
 Usage:
 
@@ -11,46 +15,39 @@ const output: fal.EndpointOutput<'fal-ai/hyper3d/rodin'> = {
 };
 ```
 
-```ts
-const getMyMappedEndpointInput = (endpointId: Endpoint, userInputs: any): EndpointInput<typeof endpointId> => {
-  // ...
-  // Narrow down the endpoint id
-  // to infer the type of the returned value
-  switch (endpointId) {
-    case 'fal-ai/minimax/hailuo-02/standard/text-to-video':
-      return {
-        prompt: userInputs.prompt, // type safe, will be infered by the narrowed endpoint id
-      };
-    default:
-      throw new Error(`Unsupported endpoint: ${endpointId}`);
-  }
-}
-
-const endpointId = req.endpointId; // 'fal-ai/minimax/hailuo-02/standard/text-to-video'
-const input = getMyMappedEndpointInput(endpointId, req.userInputs);
+Usage example:
 
-// --------------------------
-
-const res = await fetch('https://fal.ai/api/v1/endpoints/{endpointId}', {
-    method: 'POST',
-    body: JSON.stringify({
-     input: {
-        ...input,
+```ts
+// ...
+// Narrow down the endpoint id,
+// to infer the type of the returned value,
+// this example uses an index signature.
+// The input type is infered in the function.
+const FalInputs: {
+    [x: number | string | symbol]: any;
+} & {
+    [K in fal.Endpoint]?: (userInputs: Record<string, any>) => fal.EndpointInput<K>;
+} = {
+    'fal-ai/flux-kontext/dev': (userInputs) => ({
+        // typed FluxKontextDevInput
+        prompt: typeof userInputs['prompt'] === 'string' ? userInputs['prompt'] : '',
+        image_url: typeof userInputs['image_url'] === 'string' ? userInputs['image_url'] : '',
     }),
-}).then(res => res.json());
-// check the api urls in the docs, this is just an example.
-const result = await fetch('https://fal.ai/api/v1/endpoints/{endpointId}/requests/{res.requestId}', {
-    method: 'GET',
-}).then(res => res.json())
-const output = data.data as unknown as EndpointOutput<typeof endpointId>;
-
-// --------------------------
-// OR
-
-const res = await fal.queue.submit(endpointId, {input});
-
-// import('@fal/client').Result<EndpointOutput<typeof endpointId>>
-const result = await fal.queue.result(res.requestId);
+    // '...etc...': (userInputs) => ({}), // more endpoints you want to support
+};
 
-const output = result.data as unknown as EndpointOutput<typeof endpointId>;
+const endpointIdString = String('fal-ai/flux-kontext/dev');
+// any | undefined (best instead of all possible inputs)
+const falInputAny = FalInputs[endpointIdString]?.({ prompt: 'Hello, world!' });
+// FluxKreaTrainerInput | BriaVideoBackgroundRemovalInput
+// | ... 100 more ... | undefined (expensive option, no benefits, not safe)
+const falInputAll =
+    isFalEndpoint(endpointIdString) ?
+        FalInputs[endpointIdString]?.({ prompt: 'Hello, world!' })
+    :   undefined;
+
+//... Normal inference when the endpoint id is known.
+const endpointId = 'fal-ai/flux-kontext/dev';
+// FluxKontextDevInput | undefined
+const falInput = FalInputs[endpointId]?.({ prompt: 'Hello, world!' });
 ```

package/types/fal/endpoints/schema.d.ts

@@ -139822,3 +139822,5 @@ export interface AnimatediffSparsectrlLcmOutput {
         url: string;
     };
 }
+
+export {};

package/types/fal/index.d.ts

@@ -1,59 +1,11 @@
+/// <reference types="./endpoints/index.d.ts" />
+
 declare global {
     export namespace fal {
-        export type Endpoint = keyof fal.endpoints.Endpoints;
-        /**
-         * Usage:
-         * @example
-         * ```ts
-         *
-         * const getMyMappedEndpointInput = (endpointId: Endpoint, userInputs: any): EndpointInput<typeof endpointId> => {
-         *   // ...
-         *   // Narrow down the endpoint id
-         *   // to infer the type of the returned value
-         *   switch (endpointId) {
-         *     case 'fal-ai/minimax/hailuo-02/standard/text-to-video':
-         *       return {
-         *         prompt: userInputs.prompt, // type safe, will be infered by the narrowed endpoint id
-         *       };
-         *     default:
-         *       throw new Error(`Unsupported endpoint: ${endpointId}`);
-         *   }
-         * }
-         *
-         * const endpointId = req.endpointId; // 'fal-ai/minimax/hailuo-02/standard/text-to-video'
-         * const input = getMyMappedEndpointInput(endpointId, req.userInputs);
-         *
-         * // --------------------------
-         *
-         * const res = await fetch('https://fal.ai/api/v1/endpoints/{endpointId}', {
-         *     method: 'POST',
-         *     body: JSON.stringify({
-         *      input: {
-         *         ...input,
-         *     }),
-         * }).then(res => res.json());
-         * // check the api urls in the docs, this is just an example.
-         * const result = await fetch('https://fal.ai/api/v1/endpoints/{endpointId}/requests/{res.requestId}', {
-         *     method: 'GET',
-         * }).then(res => res.json())
-         * const output = data.data as unknown as EndpointOutput<typeof endpointId>;
-         *
-         * // --------------------------
-         * // OR
-         *
-         * const res = await fal.queue.submit(endpointId, {input});
-         *
-         * // import('@fal/client').Result<EndpointOutput<typeof endpointId>>
-         * const result = await fal.queue.result(res.requestId);
-         *
-         * const output = result.data as unknown as EndpointOutput<typeof endpointId>;
-         * ```
-         *
-         */
-        export type EndpointInput<T extends Endpoint> = fal.endpoints.Endpoints[T]['input'];
-        export type EndpointOutput<T extends Endpoint> = fal.endpoints.Endpoints[T]['output'];
+        export type Endpoint = keyof fal.endpoints.Endpoints & string;
+        export type EndpointInput<T extends fal.Endpoint> = fal.endpoints.Endpoints[T]['input'];
+        export type EndpointOutput<T extends fal.Endpoint> = fal.endpoints.Endpoints[T]['output'];
     }
-    export namespace fal.endpoints {}
 }
 
 export {};

package/types/fal/endpoints/index.next.d.ts

@@ -1,20 +0,0 @@
-import type * as falEndpoints from './schema.js';
-
-declare global {
-  export namespace fal {}
-  export namespace fal.endpoints {
-    export interface Endpoints {
-
-
-    
-      'fal-ai/hyper3d/rodin': {
-        input: falEndpoints.Hyper3dRodinInput;
-        output: falEndpoints.Hyper3dRodinOutput;
-      };
-  
-
-    }
-  }
-}
-
-export {};

package/types/fal/endpoints/schema.next.d.ts

@@ -1,177 +0,0 @@
-export interface Hyper3dRodinInput {
-    /**
-     * Prompt
-     * @description A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode.
-     * @default
-     * @example A futuristic robot with sleek metallic design.
-     */
-    prompt?: string;
-    /**
-     * Condition Mode
-     * @description For fuse mode, One or more images are required.It will generate a model by extracting and fusing features of objects from multiple images.For concat mode, need to upload multiple multi-view images of the same object and generate the model. (You can upload multi-view images in any order, regardless of the order of view.)
-     * @default concat
-     * @enum {string}
-     */
-    condition_mode?: 'fuse' | 'concat';
-    /**
-     * Bbox Condition
-     * @description An array that specifies the dimensions and scaling factor of the bounding box. Typically, this array contains 3 elements, Length(X-axis), Width(Y-axis) and Height(Z-axis).
-     * @example [
-     *       100,
-     *       50,
-     *       150
-     *     ]
-     */
-    bbox_condition?: number[];
-    /**
-     * Tier
-     * @description Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular.
-     * @default Regular
-     * @enum {string}
-     */
-    tier?: 'Regular' | 'Sketch';
-    /**
-     * Quality
-     * @description Generation quality. Possible values: high, medium, low, extra-low. Default is medium.
-     * @default medium
-     * @enum {string}
-     */
-    quality?: 'high' | 'medium' | 'low' | 'extra-low';
-    /**
-     * T/A Pose
-     * @description When generating the human-like model, this parameter control the generation result to T/A Pose.
-     * @default false
-     */
-    TAPose?: boolean;
-    /**
-     * Input Image Urls
-     * @description URL of images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode.
-     * @example https://storage.googleapis.com/falserverless/model_tests/video_models/robot.png
-     */
-    input_image_urls?: string[];
-    /**
-     * Geometry File Format
-     * @description Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb.
-     * @default glb
-     * @enum {string}
-     */
-    geometry_file_format?: 'glb' | 'usdz' | 'fbx' | 'obj' | 'stl';
-    /**
-     * Use Hyper
-     * @description Whether to export the model using hyper mode. Default is false.
-     * @default false
-     */
-    use_hyper?: boolean;
-    /**
-     * Addons
-     * @description Generation add-on features. Default is []. Possible values are HighPack. The HighPack option will provide 4K resolution textures instead of the default 1K, as well as models with high-poly. It will cost triple the billable units.
-     * @enum {string}
-     */
-    addons?: 'HighPack';
-    /**
-     * Seed
-     * @description Seed value for randomization, ranging from 0 to 65535. Optional.
-     */
-    seed?: number;
-    /**
-     * Material
-     * @description Material type. Possible values: PBR, Shaded. Default is PBR.
-     * @default PBR
-     * @example Shaded
-     * @enum {string}
-     */
-    material?: 'PBR' | 'Shaded';
-}
-
-export interface Hyper3dRodinOutput {
-    /**
-     * Model Mesh
-     * @description Generated 3D object file.
-     * @example {
-     *       "url": "https://v3.fal.media/files/koala/VlX4JqNI8F9HO2ETp_B7t_base_basic_pbr.glb"
-     *     }
-     */
-    model_mesh: {
-        /**
-         * File Size
-         * @description The size of the file in bytes.
-         * @example 4404019
-         */
-        file_size?: number;
-        /**
-         * File Name
-         * @description The name of the file. It will be auto-generated if not provided.
-         * @example z9RV14K95DvU.png
-         */
-        file_name?: string;
-        /**
-         * Content Type
-         * @description The mime type of the file.
-         * @example image/png
-         */
-        content_type?: string;
-        /**
-         * Url
-         * @description The URL where the file can be downloaded from.
-         */
-        url: string;
-        /**
-         * File Data
-         * Format: binary
-         * @description File data
-         */
-        file_data?: string;
-    };
-    /**
-     * Seed
-     * @description Seed value used for generation.
-     */
-    seed: number;
-    /**
-     * Textures
-     * @description Generated textures for the 3D object.
-     */
-    textures: {
-        /**
-         * Height
-         * @description The height of the image in pixels.
-         * @example 1024
-         */
-        height?: number;
-        /**
-         * File Size
-         * @description The size of the file in bytes.
-         * @example 4404019
-         */
-        file_size?: number;
-        /**
-         * Url
-         * @description The URL where the file can be downloaded from.
-         */
-        url: string;
-        /**
-         * Width
-         * @description The width of the image in pixels.
-         * @example 1024
-         */
-        width?: number;
-        /**
-         * File Name
-         * @description The name of the file. It will be auto-generated if not provided.
-         * @example z9RV14K95DvU.png
-         */
-        file_name?: string;
-        /**
-         * Content Type
-         * @description The mime type of the file.
-         * @example image/png
-         */
-        content_type?: string;
-        /**
-         * File Data
-         * Format: binary
-         * @description File data
-         */
-        file_data?: string;
-    }[];
-}