feat: add Ingest API codegen with Zod schema generation

.github/workflows/api-update-ingest-api-types.yaml

@@ -0,0 +1,100 @@
+# Description: When upstream cloud/ingest OpenAPI spec is updated, regenerate TypeScript types and Zod schemas
+name: 'Api: Update Ingest API Types'
+
+on:
+  workflow_dispatch:
+
+  repository_dispatch:
+    types: [ingest-api-updated]
+
+jobs:
+  update-ingest-types:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
+        with:
+          version: 10
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Checkout cloud repository
+        uses: actions/checkout@v6
+        with:
+          repository: Comfy-Org/cloud
+          path: cloud
+          token: ${{ secrets.COMFY_API_PAT }}
+          sparse-checkout: services/ingest/openapi.yaml
+          clean: true
+
+      - name: Get API commit information
+        id: api-info
+        run: |
+          cd cloud
+          API_COMMIT=$(git rev-parse --short HEAD)
+          echo "commit=${API_COMMIT}" >> $GITHUB_OUTPUT
+          cd ..
+
+      - name: Copy OpenAPI spec and generate types
+        run: |
+          echo "Generating Ingest API types from cloud@${{ steps.api-info.outputs.commit }}..."
+          cp cloud/services/ingest/openapi.yaml packages/ingest-types/openapi.yaml
+          cd packages/ingest-types
+          pnpm generate
+
+      - name: Validate generated files
+        run: |
+          for file in packages/ingest-types/src/types.gen.ts packages/ingest-types/src/zod.gen.ts; do
+            if [ ! -s "$file" ]; then
+              echo "Error: $file is missing or empty."
+              exit 1
+            fi
+          done
+          echo "Generated files validated successfully."
+
+      - name: Check for changes
+        id: check-changes
+        run: |
+          if [[ -z $(git status --porcelain packages/ingest-types/src/) ]]; then
+            echo "No changes to Ingest API types detected."
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "Changes detected in Ingest API types."
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create Pull Request
+        if: steps.check-changes.outputs.changed == 'true'
+        uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
+        with:
+          token: ${{ secrets.PR_GH_TOKEN }}
+          commit-message: '[chore] Update Ingest API types from cloud@${{ steps.api-info.outputs.commit }}'
+          title: '[chore] Update Ingest API types from cloud@${{ steps.api-info.outputs.commit }}'
+          body: |
+            ## Automated Ingest API Type Update
+
+            This PR updates the Ingest API TypeScript types and Zod schemas from the latest cloud OpenAPI specification.
+
+            - Cloud commit: ${{ steps.api-info.outputs.commit }}
+            - Generated using @hey-api/openapi-ts with Zod plugin
+
+            These types cover cloud-only endpoints (workspaces, billing, secrets, assets, tasks, etc.).
+            Overlapping endpoints shared with the local ComfyUI Python backend are excluded.
+          branch: update-ingest-types-${{ steps.api-info.outputs.commit }}
+          base: main
+          delete-branch: true
+          add-paths: |
+            packages/ingest-types/src/

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').replace(\\\"from 'zod/v3'\\\", \\\"from 'zod'\\\")));\""
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "0.93.0"
+  },
+  "dependencies": {
+    "zod": "catalog:"
+  },
+  "packageManager": "pnpm@10.17.1",
+  "nx": {
+    "tags": [
+      "scope:shared",
+      "type:types"
+    ]
+  }
+}