fix: Go back to generating enums out of unions containing enums #2149
Conversation
This file contains 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
|
Happy to address feedback @domoritz :) |
arthurfiorette
requested changes
Jan 6, 2025
|
Good points, should be addressed now @arthurfiorette! |
arthurfiorette
requested changes
Jan 7, 2025
domoritz
approved these changes
Jan 7, 2025
|
I fixed some linting issues and added a test case that also ensures some of my use cases. When enums are exported we cannot allow any merging of their actual types. |
domoritz
reviewed
Jan 7, 2025
| @@ -43,8 +48,8 @@ export class LiteralUnionTypeFormatter implements SubTypeFormatter { | |||
| }; | |||
| } | |||
|
|
|||
| const values = uniqueArray(types.map(getLiteralValue)); | |||
| const typeNames = uniqueArray(types.map(getLiteralType)); | |||
| const values = uniqueArray(types.flatMap(getLiteralValues)); | |||
There was a problem hiding this comment.
this can probably become map again if we fix the thing below
There was a problem hiding this comment.
Did it for us since i also need this PR :)
arthurfiorette
approved these changes
Jan 7, 2025
domoritz
reviewed
Jan 7, 2025
|
🚀 PR was released in |
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.
Problem
feat: improve literal union type handling #1927 improved some cases of handling union types, but it broke one we rely heavily on at PostHog:
Before #1927 types such as
type X = Enum.A | Enum.Bwere output"enum": ["a", "b"], since #1927 they are instead series ofanyOf– whereastype X = "a" | "b"continued to beenum. This doesn't seem to have been covered by any test case.The
anyOfoutput breaks our downstream processing of the schema, and just seems less practical thanenum.Changes
This PR updates LiteralUnionTypeFormatter to support enums too – their underlying values are literal after all, and
ts-json-schema-generatordid make use of this before the regression.I committed so that it's easily immediately what the difference in union output is before (on
next)vs. after (this branch).See here: a734160#diff-ba53f2224477f939f2a9762fe35a747aede17fd1e8caab8e4054b135857f2de9
Version
Published prerelease version:
v2.4.0-next.6Changelog
🎉 This release contains work from new contributors! 🎉
Thanks for all your work!
❤️ Michael Matloka (@Twixes)
❤️ null@dcharbonnier
❤️ Werner Robitza (@slhck)
❤️ Bence Balogh (@baloghbence0915)
🚀 Enhancement
--expose allwith generic types #2009 (@arthurfiorette)🐛 Bug Fix
next🔩 Dependency Updates
Authors: 7