feat(openapi)!: replace shouldHoistDef with customComponentName option in generator

[dinwwwh]

Root-level $defs are now always hoisted into components.schemas. The shouldHoistDef option is gone, replaced by customComponentName for renaming the resulting components.

const spec = await generator.generate(router, {
  customComponentName: defName => `Api${defName}`,
})

• Returning undefined keeps the original def name.
• Conflicting names still fall back to the existing postfix rules (Planet, PlanetInput, Planet2, ...).
• Error components no longer put the default message in their message schema. Procedures that declare the same error code with different messages now share one component, and the message still shows up in the response description.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
orpc	Ready	Preview, Comment	Jul 26, 2026 5:34am

[pkg-pr-new]

More templates

• @orpc/bun-playground
• @orpc/cloudflare-playground
• @orpc/nest-playground
• @orpc/next-playground

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@1728

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@1728

@orpc/bun

npm i https://pkg.pr.new/@orpc/bun@1728

@orpc/client

npm i https://pkg.pr.new/@orpc/client@1728

@orpc/cloudflare

npm i https://pkg.pr.new/@orpc/cloudflare@1728

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@1728

@orpc/experimental-effect

npm i https://pkg.pr.new/@orpc/experimental-effect@1728

@orpc/evlog

npm i https://pkg.pr.new/@orpc/evlog@1728

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@1728

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@1728

@orpc/next

npm i https://pkg.pr.new/@orpc/next@1728

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@1728

@orpc/opentelemetry

npm i https://pkg.pr.new/@orpc/opentelemetry@1728

@orpc/pinia-colada

npm i https://pkg.pr.new/@orpc/pinia-colada@1728

@orpc/pino

npm i https://pkg.pr.new/@orpc/pino@1728

@orpc/publisher

npm i https://pkg.pr.new/@orpc/publisher@1728

@orpc/ratelimit

npm i https://pkg.pr.new/@orpc/ratelimit@1728

@orpc/server

npm i https://pkg.pr.new/@orpc/server@1728

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@1728

@orpc/swr

npm i https://pkg.pr.new/@orpc/swr@1728

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@1728

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@1728

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@1728

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@1728

commit: ff4d3db

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[pullfrog]

✅ No new issues found.

Reviewed changes — this PR removes shouldHoistDef and replaces it with customComponentName. All root-level $defs are now always hoisted into components.schemas; customComponentName controls how they're renamed. Error components also shed their baked-in default message for better reuse.

• customComponentName replaces shouldHoistDef — the OpenAPIComponentRegistry constructor and OpenAPIGeneratorGenerateOptions now accept a (defName, defSchema) => string | undefined callback instead of a Value<boolean> predicate. All defs are always hoisted.
• ~90 lines of dead code removed — visitLocalDefRefs, hoistReferencedLocalDefs, withReferencedLocalDefs, and collectReferencedLocalDefNames are gone, along with unused imports of visitJsonSchemaRefs and Value.
• Error message default removed — error components no longer carry the per-procedure defaultMessage in their message schema. Procedures sharing the same error code but with different messages now reuse the same component.
• Docs updated — the specification docs reflect the new customComponentName API.

  ^{｜ View workflow run ｜ Using DeepSeek Pro (free via Pullfrog for OSS) ｜ 𝕏}

[codspeed-hq]

Merging this PR will not alter performance

✅ 18 untouched benchmarks

---

_{Comparing dinwwwh:claude/openapi-hoisting-options-3be20a (ff4d3db) with main (8bbe5f0)}