-
Notifications
You must be signed in to change notification settings - Fork 628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve codegen typings #2999
Merged
Merged
Improve codegen typings #2999
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
2abd90e
to
ef8af3f
Compare
bebca0e
to
0bea135
Compare
0bea135
to
02ddb9a
Compare
02ddb9a
to
1a337a2
Compare
rafaelbsky
approved these changes
Nov 18, 2024
devinivy
reviewed
Dec 2, 2024
devinivy
reviewed
Dec 2, 2024
2714235
to
617d86c
Compare
6e398be
to
17b3081
Compare
devinivy
approved these changes
Dec 19, 2024
49690ba
to
819eeac
Compare
2 tasks
5e0b6ff
to
a101316
Compare
0133f4a
to
7fa74c3
Compare
cfa432c
to
78c8561
Compare
9c7ee84
to
8e04164
Compare
6067ace
to
4715c89
Compare
Merged
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.
This PR is the first of a 2 steps changes aimed at improving typing in the atproto repo:
$type
property to records and user object types. Improves the typing of isX and validateX helpers.Breaking changes
This PR changes the interfaces of the generated code in the following ways:
[x: string]: unknown
index signature in objects & records. Because of this, access to un-speccified fields must be explicit.$type
property explicit (though optional, except in open unions). This allows to properly discriminate entity types, especially when used in open unions.$type
property mandatory in record types.isMyType(value)
utilities no longer type cast thevalue
being checked. They only type the presence of the$type
property.validateMyType(value)
utilities.validateMyType
utilities now require that the$type
, if present, is valid.asPredicate
" helper function allows to convert avalidateMyType
utility into a type predicate like so:const isValidMyType = asPredicate(validateMyType)
Note
When reviewing, "codegen" commits can be ignored as they only contain generated code changes.
Fixes #2952