You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using enumValues: true with OpenAPI schemas containing oneOf/anyOf unions, the generated TypeScript type paths would fail because properties might only exist on some union variants.
Before (invalid TypeScript):
exportconstresourceItemsNestedCodeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["Resource"]["items"]["nested"]["code"]>=["a","b"];// Error: Property 'nested' does not exist on type '{ type: "simple"; } | { type: "complex"; nested: { code: "a" | "b"; }; }'
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Note: two tests will fail due to network errors (probably the original gist has been deleted). Nothing I can do on that front (they were already failing on main).
Note: two tests will fail due to network errors (probably the original gist has been deleted). Nothing I can do on that front (they were already failing on main).
Indeed, I've address this in a separate PR a few weeks back which is awaiting review: #2522
@sacha-c thanks, I've rebased so that tests can pass in CI now
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
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.
Changes
When using
enumValues: truewith OpenAPI schemas containingoneOf/anyOfunions, the generated TypeScript type paths would fail because properties might only exist on some union variants.Before (invalid TypeScript):
After (valid TypeScript):
The fix wraps property accesses after
oneOf/anyOfindices withExtract<>to narrow the union type before accessing variant-specific properties.This PR has been tested in a production environment with a custom build of openapi-typescript.
How to Review
I've added three tests:
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)