Replace JSONObject type with JsonDocumentObject #258
Merged
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 replaces the type
JSONObject
with a new typeJsonDocumentObject
for all the data that can be serialized and parsed as valid JSON, such as queries or credentialSubjects.The issue with typing serializable documents as
JSONObject
is that this type includesobject
as a valid value:object
in TypeScript is very broad (basically any value that is not a primitive is an object). This includes functions for example.This broadness makes it very hard for the clients of this library to parse data that adheres to types using
JSONObject
, such as theAuthorizationRequestMessage
'sdid_doc
.