feat(type-helpers): add reusable union schema factory - #4025
Open
dogemad wants to merge 1 commit into
Open
Conversation
Add createUnionApiSchema() to emit named oneOf components while preserving the corresponding TypeScript union through InferUnionApiSchema. Register referenced DTOs automatically and support built-in schema constructors, discriminators, custom component names, and nested union tokens. Update schema exploration and generateSchema() so generated tokens resolve through their declared component names.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Reusable OpenAPI union schemas require users to manually define
oneOfreferences, register every referenced DTO with
ApiExtraModels, and maintain aseparate TypeScript union type.
The OpenAPI schema and application type can therefore drift apart. In addition,
generateSchema()looks up its result using the runtime class name, which doesnot work correctly for schemas with a custom component name.
Issue Number: Fixes #3886
What is the new behavior?
This PR introduces
createUnionApiSchema(), which creates a reusable namedOpenAPI
oneOfcomponent and preserves the represented TypeScript union.The new helper:
FunctionmembersgenerateSchema()now uses the component name returned by schema exploration,so it also resolves schemas decorated with a custom
ApiSchemaname correctly.Does this PR introduce a breaking change?
Other information
The generated value is a Swagger metadata host rather than a constructor for a
union member.
InferUnionApiSchema<typeof Schema>exposes the correspondingapplication type without claiming that
new Schema()creates one of its DTOs.Validation performed:
npm run buildnpm run lintnpm test— 415 tests passednpm run test:e2e— 127 tests passed