fal-endpoint-types 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vincent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "fal-endpoint-types",
+    "version": "1.0.0",
+    "description": "",
+    "homepage": "https://github.com/rawpixel-vincent/fal-endpoint-types#readme",
+    "bugs": {
+        "url": "https://github.com/rawpixel-vincent/fal-endpoint-types/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/rawpixel-vincent/fal-endpoint-types.git"
+    },
+    "license": "ISC",
+    "author": "rawpixel-vincent",
+    "type": "module",
+    "main": "./types/fal/index.d.ts",
+    "types": "./types/fal/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./types/fal/index.d.ts"
+        },
+        "./endpoints": {
+            "types": "./types/fal/endpoints/index.d.ts"
+        }
+    },
+    "files": [
+        "types/**/*.d.ts",
+        "README.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "generate": "node scripts/generate-fal-types.mjs",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "devDependencies": {
+        "prettier": "^3.8.0",
+        "typescript": ">=5.9.3",
+        "@types/node": ">=24.1.1"
+    }
+}

package/readme.md

@@ -0,0 +1,56 @@
+input and output shapes exported from the openapi.json of fal.ai endpoints to typescript types.
+
+Usage:
+
+```ts
+const input: fal.EndpointInput<'fal-ai/hyper3d/rodin'> = {
+    //  ...
+};
+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);
+
+// --------------------------
+
+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>;
+```