feat: add TypeScript schema #15
Draft
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
moretti
force-pushed
the
typescript-schema
branch
from
5480d31 to
416b20c
Compare
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.
I've started the process of extracting a TypeScript schema for prototype events, utilising the JSON Schema as the source of truth.
Currently, prototype events are typed as
anywithin themkiiimono repo, making it challenging to work with them in functions. Moreover, the JSON Schema is quite verbose and complex to understand (~180 lines are equivalent to the other 25 JSON files in the repository).Ideally we should consider transitioning to TypeScript as the primary source of truth, similar to how we validate user test data within the mono repo. However, given that we have a Python package in the repository, we could also consider keeping TypeScript as our source of truth and create a script to generate the JSON schema when needed.