improve header protection ergonomics (breaking change) #128
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.
Changed the header protection data types for better ergonomics (#125). Previously,
()
was used for serialisations that only support protected headers (thus, a single constructor). This release introduces the new single-constructor data typeProtectedOnly
to replace the use of()
for this purpose. This is a breaking change and some library users will need to update their code.The
Protection
type has been renamed toProtectionOptional
, with the old name retained as a (deprecated) type synonym.The
ProtectionIndicator
class has been renamed toProtectionOptionality
, with the old name retained as a (deprecated) type synonym.Added some convenience header and header parameter constructors:
newJWSHeaderProtected
,newHeaderParamProtected
andnewHeaderParamUnprotected
.Fixes: #125