Handle required-only allOf constraints - #2850
Open
darkbasic wants to merge 1 commit into
Open
Conversation
Translate exact required-only allOf members through the existing required-property flow while preserving unsafe, annotated, polymorphic, and transformed schemas. Fixes openapi-ts#1474 Related to openapi-ts#1520 and openapi-ts#2570
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
🦋 Changeset detectedLatest commit: f032c8e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Summary
Handle
allOfmembers that only make existing object properties required.Fixes #1474
Related to #1520 and #2570
Problem
Given a schema such as:
openapi-typescriptgeneratedBase & Record<string, never>. The second member is a presence constraint, but it was transformed as an empty object, making the resulting type effectively unusable.Solution
Exact
{ required: [...] }and{ type: object, required: [...] }members are translated through the existing parentrequiredflow. For referenced schemas this producesWithRequired<Base, "name">instead of an empty-object intersection.The implementation is intentionally conservative:
allOfreferences are followed with cycle protection.The main logic is in
transform/schema-object.ts. The composition tests include generated TypeScript compilation checks, and the DigitalOcean fixture was regenerated because it contains several real examples of this schema pattern.Validation
Notes
While the original implementation has been written by me, after several rounds of validation by GPT-5.6 Sol it found so many corner cases that it basically rewrote it from scratch.