feat: automatically generate OSCAL types from JSON Schema #765
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
This adds a new package `@easydynamics/oscal-types` that will convert the underlying OSCAL JSON schema to TypeScipt type definitions. It also replaces two existing instances of type information in `oscal-react-library` with these new types: Properties and BackMater within `oscal-utils`. The types are represented _literally_. This includes things like `media-type` rather than making it the friendlier `mediaType`. Additionally, to encourage good hygiene, all types are represented as `readonly`.
|
To do:
|
tuckerzp
reviewed
Apr 10, 2023
… into kyle/autogenerate-types-package
kylelaker
commented
Apr 10, 2023
kylelaker
commented
Apr 10, 2023
kylelaker
commented
Apr 10, 2023
Co-authored-by: Kyle Laker <klaker@easydynamics.com>
tuckerzp
reviewed
Apr 10, 2023
tuckerzp
approved these changes
Apr 11, 2023
tuckerzp
approved these changes
Apr 11, 2023
Bronstrom
approved these changes
Apr 12, 2023
Bronstrom
force-pushed
the
kyle/autogenerate-types-package
branch
from
af425e3
to
d42b209
Compare
… into kyle/autogenerate-types-package
kylelaker
force-pushed
the
kyle/autogenerate-types-package
branch
from
d42b209
to
21626b8
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.
This adds a new package
@easydynamics/oscal-typesthat will convertthe underlying OSCAL JSON schema to TypeScipt type definitions. It also
replaces two existing instances of type information in
oscal-react-librarywith these new types: Properties and BackMater within
oscal-utils.The types are represented literally. This includes things like
media-typerather than making it the friendliermediaType.Additionally, to encourage good hygiene, all types are represented as
readonly.Closes: #763