Add tests for current TS output of DTOs with "optional" and required fields. #68
Conversation
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
ejball
approved these changes
Aug 3, 2024
4 tasks
heymb
added a commit
that referenced
this pull request
Aug 5, 2024
…n TS. (#69) BREAKING CHANGE: Generate DTO required fields as NOT optional properties on interface in TS. Previously, all DTO fields (including required ones) were optional properties on an interface in TS. - Implement minimum support for #34. Does not add other validation. - Update test added in #68 since made change. - Run codegen since FSD file has required fields. - Update version and release notes. Learn more: - FSD docs on "Required Fields": https://facilityapi.github.io/define/fsd#fields - FSD docs on DTOs: https://facilityapi.github.io/define/fsd#data-transfer-objects - TS docs on optional properties: https://www.typescriptlang.org/docs/handbook/2/objects.html#optional-properties --------- Co-authored-by: Michael Baldwin <michael.baldwin@faithlife.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add tests for current TS output of DTOs with "optional" or required fields (see "Required Fields" section, can't hyperlink).
Context: This issue mentions wanting support for required fields as a minimum. Recently, others mentioned wanting this behavior.
Follow up - Implementation: A follow up PR implements minimum support for required fields. It seemed better to break out adding tests for existing behavior into this PR that can be merged first and adding support can be merged after as a follow up PR.