[FCL-361] Add new types to utils to express NCNs and related concepts #191
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
Utils will need to play host to multiple new types which explicitly describe concepts relating to courts; the existing autogenerated types from the schema should logically live in the same place, which is a new submobule. This should not affect downstream consumers of the package, as these court types are only used internally.
These new types explicitly allow us to state "this string represents a Neutral Citation" and "this string represents a URI we have derived from a Neutral Citation". They will replace types serving a similar function in API Client, giving us full end-to-end type integrity for NCNs and derived-URIs for the first time. BREAKING CHANGE: Existing calls to `neutral_url()` will need to be made type-aware in all downstream projects where typechecking is used.
dragon-dxw
approved these changes
Oct 2, 2024
jacksonj04
changed the title
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.
Utils sets up the basis for our understanding of what a Neutral Citation is, how they relate to courts, and what valid NCN-based URIs look like. It is logical that the underlying types for these things emerge from Utils and are then used downstream to enforce consistency.