feat: add Ingest API codegen with Zod schema generation (#9932)

## Summary

- Add `packages/ingest-types/` package that auto-generates TypeScript
types and Zod schemas from the Ingest service OpenAPI spec
- Uses `@hey-api/openapi-ts` with built-in Zod plugin (Zod v3
compatible)
- Filters out overlapping endpoints shared with the local ComfyUI Python
backend
- Generates **493 TypeScript types** and **256 Zod schemas** covering
cloud-only endpoints
- Configure knip to ignore generated files

## CI automation

The cloud repo pushes generated types to this repo (push model, no
private repo cloning).
See: Comfy-Org/cloud#2858

## How endpoint filtering works

Codegen targets are controlled by the **exclude list** in
`packages/ingest-types/openapi-ts.config.ts`. Everything in the Ingest
`openapi.yaml` is included **except** overlapping endpoints that also
exist in the local ComfyUI Python backend:

**Excluded (overlapping with ComfyUI Python):**
`/prompt`, `/queue`, `/history`, `/object_info`, `/features`,
`/settings`, `/system_stats`, `/interrupt`, `/upload/*`, `/view`,
`/jobs`, `/userdata`, `/webhooks/*`, `/internal/*`

**Included (cloud-only, codegen targets):**
`/workspaces/*`, `/billing/*`, `/secrets/*`, `/assets/*`, `/tasks/*`,
`/auth/*`, `/workflows/*`, `/workspace/*`, `/user`, `/settings/{key}`,
`/tags`, `/feedback`, `/invite_code/*`, `/experiment/models/*`,
`/global_subgraphs/*`

## Follow-up: replace manual types with generated ones

This PR only sets up the codegen infrastructure. A follow-up PR should
replace manually maintained types with imports from
`@comfyorg/ingest-types`:

| File | Lines | Current | Replace with |
|------|-------|---------|-------------|
| `src/platform/workspace/api/workspaceApi.ts` | ~270 | TS interfaces |
`import type { ... } from '@comfyorg/ingest-types'` |
| `src/platform/secrets/types.ts` | ~32 | TS interfaces | `import type {
... } from '@comfyorg/ingest-types'` |
| `src/platform/assets/schemas/assetSchema.ts` | ~125 | Zod schemas |
`import { ... } from '@comfyorg/ingest-types/zod'` |
| `src/platform/assets/schemas/mediaAssetSchema.ts` | ~50 | Zod schemas
| `import { ... } from '@comfyorg/ingest-types/zod'` |
| `src/platform/tasks/services/taskService.ts` | ~70 | Zod schemas |
`import { ... } from '@comfyorg/ingest-types/zod'` |
| `src/platform/workspace/workspaceTypes.ts` | ~6 | TS interface |
`export type { ... } from '@comfyorg/ingest-types'` |

## Test plan

- [x] `pnpm generate` in `packages/ingest-types/` produces
`types.gen.ts` and `zod.gen.ts`
- [x] `pnpm typecheck` passes
- [x] Pre-commit hooks pass (lint, typecheck, format)
- [x] Generated Zod schemas validate correct data and reject invalid
data
- [x] No import conflicts with existing code (generated types are
isolated in separate package)

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: GitHub Action <action@github.com>

Author: 3 people

.gitattributes

@@ -3,4 +3,6 @@
 
 # Generated files
 packages/registry-types/src/comfyRegistryTypes.ts linguist-generated=true
+packages/ingest-types/src/types.gen.ts linguist-generated=true
+packages/ingest-types/src/zod.gen.ts linguist-generated=true
 src/workbench/extensions/manager/types/generatedManagerTypes.ts linguist-generated=true

knip.config.ts

@@ -26,9 +26,13 @@ const config: KnipConfig = {
     },
     'packages/registry-types': {
       project: ['src/**/*.{js,ts}']
+    },
+    'packages/ingest-types': {
+      project: ['src/**/*.{js,ts}'],
+      entry: ['src/index.ts']
     }
   },
-  ignoreBinaries: ['python3', 'gh'],
+  ignoreBinaries: ['python3', 'gh', 'generate'],
   ignoreDependencies: [
     // Weird importmap things
     '@iconify-json/lucide',
@@ -41,9 +45,12 @@ const config: KnipConfig = {
     '@iconify/utils'
   ],
   ignore: [
-    // Auto generated manager types
+    // Auto generated API types
     'src/workbench/extensions/manager/types/generatedManagerTypes.ts',
     'packages/registry-types/src/comfyRegistryTypes.ts',
+    'packages/ingest-types/src/types.gen.ts',
+    'packages/ingest-types/src/zod.gen.ts',
+    'packages/ingest-types/openapi-ts.config.ts',
     // Used by a custom node (that should move off of this)
     'src/scripts/ui/components/splitButton.ts',
     // Used by stacked PR (feat/glsl-live-preview)

packages/ingest-types/.gitignore

@@ -0,0 +1,4 @@
+# OpenAPI spec is fetched from cloud repo during CI
+openapi.yaml
+# Crash logs
+openapi-ts-error-*.log

packages/ingest-types/openapi-ts.config.ts

@@ -0,0 +1,51 @@
+import { defineConfig } from '@hey-api/openapi-ts'
+
+export default defineConfig({
+  input: './openapi.yaml',
+  output: {
+    path: './src',
+    clean: true
+  },
+  parser: {
+    filters: {
+      operations: {
+        // Exclude endpoints that overlap with ComfyUI Python backend.
+        // These are shared between local and cloud, with separate Zod
+        // schemas already maintained in src/schemas/apiSchema.ts.
+        exclude: [
+          '/^GET \\/api\\/prompt$/',
+          '/^POST \\/api\\/prompt$/',
+          '/^GET \\/api\\/queue$/',
+          '/^POST \\/api\\/queue$/',
+          '/^GET \\/api\\/history$/',
+          '/^POST \\/api\\/history$/',
+          '/^GET \\/api\\/history_v2/',
+          '/^GET \\/api\\/object_info$/',
+          '/^GET \\/api\\/features$/',
+          '/^GET \\/api\\/settings$/',
+          '/^POST \\/api\\/settings$/',
+          '/^GET \\/api\\/system_stats$/',
+          '/^(GET|POST) \\/api\\/interrupt$/',
+          '/^POST \\/api\\/upload\\//',
+          '/^GET \\/api\\/view$/',
+          '/^GET \\/api\\/jobs/',
+          '/\\/api\\/userdata/',
+          // Webhooks are server-to-server, not called by frontend
+          '/\\/api\\/webhooks\\//',
+          // Internal analytics endpoint
+          '/\\/api\\/internal\\//'
+        ]
+      }
+    }
+  },
+  plugins: [
+    '@hey-api/typescript',
+    {
+      name: 'zod',
+      compatibilityVersion: 3,
+      definitions: true,
+      requests: true,
+      responses: true
+    }
+  ]
+})

packages/ingest-types/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@comfyorg/ingest-types",
+  "version": "1.0.0",
+  "description": "Comfy Cloud Ingest API TypeScript types and Zod schemas",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./zod": "./src/zod.gen.ts"
+  },
+  "scripts": {
+    "generate": "openapi-ts && node -e \"const fs=require('fs'); ['src/zod.gen.ts'].forEach(f => fs.writeFileSync(f, fs.readFileSync(f,'utf8').replaceAll(\\\"from 'zod/v3'\\\", \\\"from 'zod'\\\")));\""
+  },
+  "dependencies": {
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "0.93.0"
+  },
+  "packageManager": "pnpm@10.17.1",
+  "nx": {
+    "tags": [
+      "scope:shared",
+      "type:types"
+    ]
+  }
+}