Skip to content

Latest commit

 

History

History
521 lines (368 loc) · 19.2 KB

CHANGELOG.md

File metadata and controls

521 lines (368 loc) · 19.2 KB
Raw

Release Notes

v4.1.0 - 2024-08-27

  • Feat:
    • Add mso_mdoc and intent_to_retain types. No interpretation is done yet, as the kmp-mdl-mdoc handles PE itself. We will add support soon in PEX as well.

v4.0.1 - 2024-07-24

  • Fixed:
    • nested_path updates sometimes ended up with wrong replacements
    • const filter allows booleans now

v4.0.0 - 2024-07-23

  • Added:
    • Allow to work without input descriptors. EBSI is using this (not spec compliant!)
  • Updated:
    • use sd_hash instead of _sd_hash, reflecting the change in the SD-JWT spec

v3.3.3 - 2024-04-25

  • Fixed:
    • const boolean value was missing in schema file

v3.3.2 - 2024-04-24

  • Updated:
    • Allow to use const boolean in filters.
    • Allow to use 'optional' boolean in V2 Fields object. Please be aware we do not take that value into account yet. We just added the field, so it doesn't fail validation
    • Update to PEX models 2.2.4

v3.3.1 - 2024-03-19

  • Updated:
    • Update sd-jwt packages to 0.6.1 from 0.3.0
    • Update to latest @sphereon/ssi-types
    • Move to pnpm from yarn, given our other libraries also use pnpm

v3.3.0 - 2024-02-29

  • Added:
    • Significant performance improvement: Add cache for AJV field validation as the operation is expensive and can be called multiple times. The improvement is in the order of 10 times or higher especially when larger definitions are encountered
    • Expose jwt_vp_json format
  • Updated:
    • Update to PEX models 2.2.2

v3.2.0 - 2024-02-05

  • Added:
    • Support for Data Integrity Proofs, using Anoncreds 2023 format.

v3.1.0 - 2024-02-02

  • Updated:
    • Update to PEX models 2.2.0 which adds support for Verifiable Credential Data Integrity 1.0
  • Fixed:
    • Do not use path nested for sd-jwt
    • In the wild a presentation submission sometimes comes in as a double stringified JSON and thus string format. We detect and fix that, also providing a warning

v3.0.1 - 2024-01-19

  • Updated:
    • SD-JWT dependency updated to 0.2.0
    • SSS types updated to 0.18.1

v3.0.0 - 2024-01-14

  • Added:
    • Initial support for Selective Disclosure JWTs (SD-JWT). API is mostly the same, but to be sure we released it as a new major version
  • Updated:
    • Update to latest pex-models, containing some definition updates
  • Fixed:
    • Fix evaluation rule All when there are no marked input descriptors

v2.2.2 - 2023-11-28

  • Updated:
    • Updated pex-model deps
    • Added more logic to deduce holder(s) for a VP
  • Fixed:
    • Logic when to generate a presentation submission was incorrect

v2.2.1 - 2023-10-23

  • Updated:
    • Updated logic to return holder DID when constructing presentation
  • Fixed:
    • Issue with determining whether to generate submission data or not.

v2.2.0 - 2023-10-12

  • Updated:

    • Updated to latest PEX models package

  • Fixed:

    • Use decoded VC values to match paths against, instead of internal stable VC representation. We didn't map the "vc" property in a JWT VP correctly.
    • Fix issue with verifiableCredential path dereferencing

  • Added:

    • Support for external presentation submission paths for VPs and VCs as used by OID4VP (path_nested)
    • Support for jwt_vc_json format
    • Support for the format property at tje input descriptor level next to the global level

v2.1.2 and v2.1.1 - 2023-09-28

No changes except from some updated dependencies

v2.1.0 - 2023-07-10

IMPORTANT: This release moves to @astronautlabs/jsonpathplus in favor of jsonpathplus, bringing a security improvement. As such you may need to update your dependencies in case you have a more strict dependency manager like pnpm.

  • Changed:

    • Move to @astronautlabs/jsonpathplus for improved Jsonpath security, whilst working on a permanent fix. (#110)

  • Fixed:

    • Move to build-time compilation of schema's using AJV, instead of runtime. Fixes an issue with the Hermes engine in React-Native, next to bringing execution optimizations. (#118)
    • Add name property to field objects included in @sphereon/pex-models 2.0.3. (#123)
    • Invalid name used in matches from selection results. (#117)
    • Fixed pick and count behaviour matching against all credentials instead of per input descriptor (#115)
    • Fixed matching logic because of wrong assumptions. Previously all credentials were matched against all input descriptors, now a match per input descriptor suffices, as long as all input descriptors have matches. (#114 and #113)

v2.0.1 - 2023-05-01

  • Fixed:
    • some wrong import paths were used from @sphereon/pex-models

v2.0.0 - 2023-04-30

WARNING: This release has several breaking changes.

Although we envision a V3 release, with some major refactoring and full support for V2 of the PE spec, this version should be more usable in OpenID4VP scenario's and incorporates many fixes. As such we urge people to upgrade from V1 to V2 of the library.

Refactored external methods. They now all have optional objects as argument. Fixing future extensibility and ordering of arguments. Added support for PEX models v2, fixing model/interface names for typescript reserved words. Added options which are handy in OpenID4VP scenario's, like having separate presentation submissions, filtering on DIDs and Formats not denoted in the specification etc.

  • Added:

    • Allow to have an external presentation submission not part of the VP, especially handy in OpenID4VP use cases
    • Allow to filter against Verifiable Credential Formats, defined outside of a definition. This is handy for instance when OpenID4VP Relying Parties signal support for certain formats in their OpenID4VP metadata, but do not necessarily incorporate these in their definition(s).
    • Allow to filter against DID methods, defined outside of a definition. This is handy for instance when OpenID4VP Relying Parties signal support for certain DID methods in their OpenID4VP metadata, but do not necessarily incorporate these in their definition(s).
    • Matching of schema strings against the type property in a VC for V1, as this is being used in the wild
    • Allow issuance object to be present in a definition as it is being used in the wild

  • Removed:

    • definitions of ssi-types (lib/types/SSI.types.ts)

  • Changed:

    • Changed optional arguments to use objects, see the upgrade section of the README
    • presentationFrom and verifiablePresentationFrom methods now return an object instead of the presentation directly. see the upgrade section of the README
    • Certain non-state related methods have moved to static methods in the PEX class
    • method signatures are using common types from @sphereon/ssi-types
    • Credential Mapper from @sphereon/ssi-types is now used to create internal uniform VPs/VCs
    • Relax AJV errors

  • Fixed:

    • No more need for _const and _enum models/properties in presentation definitions. They are now const and enum ( fixed in OpenAPI model generation)
    • Set the format based on detection of the format instead of hard-coding it in the descriptor
    • Match subject is issuer against all subjects of a VC if present (not common)

v1.1.6 - 2023-02-17

Add async callback for signing

  • Updates:
    • The sign callback now supports both a synchronous and asynchronous callback, thanks to @TimoGlastra from our friends at @animo
    • Update dependencies

v1.1.5 - 2023-01-10

Relax V1 schema URI handling

  • Updates:
    • Relax V1 schema URI handling. Previously we required the URI to be an actual URI, but in the wild the URI is also used as a regular string. We now support that as well. In case we detect a http based URI we will perform some additional checks.

v1.1.4 - 2022-10-26

Update dependencies

  • Updates:
    • Update dependencies

v1.1.3 - 2022-08-15

Bugfix release

  • Fixed:
    • Json-path fix for when an array needs to be searched in a field filter. See README for how to search in an array, as not all JSON schema methods are supported in current verion.

v1.1.2 - 2022-06-30

Bugfix release

  • Added:
    • Add status object to evaluationResult which informs whether VCs would satisfy the Definition or not
  • Fixed:
    • Some errors would be filtered out by mistake

v1.1.1

Internal release because of forgotten merges

v1.1.0 - 2022-05-30

Added support for jwt vc/vp, added support for async callbacks, fixed some issues with generating PresentationSubmission

  • Added:
    • support for jwt vc
    • support for jwt vp
    • support for async callback when creating verifiable presentation (verifiablePresentationFromAsync)
  • Changed:
    • verifiablePresentationFrom is deprecated
  • Fixed:
    • handling of submission_requirement object
    • creation of presentation_submission
    • handling of unwrapped jwt verifiable credentials

v1.0.2 - 2022-01-14

Added String.matchAll shim for React-Native compatibility. Will be removed later and updated with another solution, to keep the deps to a minumum

  • Fixed:
    • React-Native not working with matchAll regexes

v1.0.1 - 2022-01-13

Some JWT VC related fixes in the deserialization and VC claim comparisons

  • Fixed:
    • JWT exp and nbf values can be numbers
    • JWT issuer can be an object with id. Ensure we also check this value against the VC claim
    • Always ensure JWT timestamps are serialized as ISO date strings in the resulting VC

v1.0.0 - 2022-01-13

This is the first stable PEX library that has complete support for V1 and V2 of the Presentation Exchange spec.

  • Added:
    • Check for hashlinks in schemas for a V1 specification. If we encounter them we generate a warning we did not verify the hashlink, as unfortunately there are no current typescript libraries that support hashlink decoding.
  • Changed:
    • limitDisclosure and holderDids arguments made optional everywhere. Do note that definitions that use some holder binding and/or selective disclosure require these arguments to be present, so we advise to always populate them
  • Fixed
    • React-native has no support for look-behind in regexes. We used this in escaping JSONLD terms in JSON-paths. Replaced by some typescript logic.

v0.7.0 - 2022-01-11

Escape JsonLD terms in json-paths. This allows path constructs like $..@context to be used in definitions. Improved JWT VC handling.

  • Added:
    • JSonLD terms like @context need to be escaped for the json-path library. As long as the @ is followed by one or more word-characters we internally escape it, so that the json-path library functions as one would expect.
  • Changed:
    • We now have better JWT claim handling. We are using VC values from the JWT if present. Otherwise we use JWT claim values. If both are present we check them to be equal.
    • Documentation updates
  • Fixed:
    • Format minimum was not properly handled the schema check
    • We translate _const and _enum from the OpenAPI models internally to their actual protected typescript keys ( const and enum)
    • Different submission requirements and definition combinations where not counted properly

v0.6.2 - 2021-12-31

No exports of internal structures anymore. Split internal and external interfaces and types

  • Changed:
    • Moved internal types to separate file
    • Only export external interfaces and types

v0.6.1 - 2021-12-31

Small improvements in the Credential interfaces, removal of exposure of internal structures in the PEX class. Small bugfixes

  • Changed:

    • Next to @context evaluation for V1 schema values, we now look at the credentialSchema
    • Seperated Credentials and VerifiableCredential public interfaces into JSON-LD and JWT versions

  • Fixed:

    • We were exposing some internal structures in the PEX class
    • Group validation assumed an array being present, which could be a string

v0.6.0 - 2021-12-29

Breaking change: class and package renamed as of v0.6.0!

As part of introducing Presentation Exchange v1 and v2 feature based detection support to our Presentation Exchange library and not reaching version 1.X yet, we decided to change the name of both the package and the main entry class:

  • The package was changed from @sphereon/pe-js to @sphereon/pex
  • The main class was changed from PEJS to PEX. The latter class has internal feature detection support on the provided definition, delegating the actual implementation to the new PEXv1 or PEXv2 class internally. If you don't want the automatic feature detection you can also choose to use the PEXv1 and PEXv2 classes directly.

Add Presentation Exchange v2 support, separating JWT Verifiable Credentials and JSON-LD VerifiableCredentials

Breaking change: class and package renamed in v0.6.0! As part of introducing Presentation Exchange v1 and v2 feature based detection support to our Presentation Exchange library and not reaching version 1.X yet, we decided to change the name of both the package and the main entry class:

  • The package was changed from @sphereon/pe-js to @sphereon/pex

  • The main class was changed from PEJS to PEX. The latter class has internal feature detection support on the provided definition, delegating the actual implementation to the new PEXv1 or PEXv2 class internally. If you don't want the automatic feature detection you can also choose to use the PEXv1 and PEXv2 classes directly.

  • Added:

    • presentation exchange v2 support
      • supporting method for all the previous methods in v2
      • presentation definition version discovery
      • presentation definition validator for v2
      • frame validation
    • Updated:
      • Json-LD and JWT verifiable credentials are separated internally
      • All the messaged now come from an enum instead of literal strings
      • Dependency versions

v0.5.1 - 2021-12-03

Fixed json path issue in library responses. Added a verifiableCredential array to almost all responses that corresponds to the json paths in the same response

  • Fixed:

    • json path of the verifiableCredentials, now start at presentation object root in a VP

  • Updated:

    • added verifiableCredential (list) to return params of evaluatePresentation
    • added verifiableCredential (list) to return params of evaluateCredentials
    • selectFrom response changed to have "verifiableCredential" instead of "selectableVerifiableCredential"
    • renamed matches in submissionRequirementMatches to vc_path

v0.5.0 - 2021-11-29

Refactor verifiable presentation support using callbacks

  • Added:

    • verifiablePresentationFrom method that accepts a callback function and signature proof options
    • Documentation on the above as well as general improvements

  • Fixed:

    • Credential and Presentation interfaces were not fully conforming
    • Explicit imports and exports added
    • Selective disclosure errors fixed
    • Releases contained too many files

v0.4.1 - 2021-11-26

Improve selective disclosure, add sign callback, several fixes

  • Added:

    • Add status object to SelectResults informing the user whether to continue submission to the verifier or not
    • Allow user to pass in ZKP based signature suite types, so that PE can determine whether limited/selective disclosure can be applied. Note you still need to create the proofs yourself
    • Create a Verifiable Presentation with PresentationSubmission object that accepts a signature callback

  • Fixed:

    • Ensure supplied params are final and not mutated
    • Limited/selective disclosure fixes

v0.4.0 - 2021-11-26

This release has been pulled, because of issues in the release process.

v0.3.0 - 2021-11-10

Bugfix release (refactoring)

  • Fixed:

    • Remove Presentation Definition from VP as these are separate types
    • Fix creation of VP from submissionFrom
    • Fix sameSubject and issuerIsOwner handling
    • Fix JSON paths in matches
    • Fix several tests to be more strict

  • Updated:

    • Remove usage of unknown/any types in favor of having interfaces and types
    • Enable strict mode
    • Refactoring of several classes
    • Updated readme/flows

v0.2.4 - 2021-10-06

Bugfix release

  • Fixed:
    • We returned duplicate submission requirements in some cases
    • Remove URL package import, fixes react-native support
    • Fixed 2 code-paths that could have undefined values

v0.2.3 - 2021-09-23

Updated dependency and fixed schema handling

v0.2.2 - 2021-09-15

Make project compatible with browsers / react

  • Fixed:
    • Make compatible with browsers/react

v0.2.1 - 2021-09-15

Updated dependencies and some forgotten expression changes

  • Changed:
    • Updated all dependencies
  • Fixed:
    • Remove usage of &&= in all expressions

v0.2.0 - 2021-09-15

Some fixes regarding usage in React. Better error handling

  • Fixed:

    • Remove usage of &&= in expressions
    • Restrict usage of fs to tests only, so not used at runtime
    • Move errors from strings to an object

  • Added:

    • Return stacktraces

v0.1.1 - 2021-09-09

This is the second Beta release of the Presentation Exchange typescript library. Please note that the interfaces might still slightly change as the software still is in active development.

  • Fixed:
    • strict flag in projects gave errors on PEX

v0.1.0 - 2021-09-03

This is the first Beta release of the Presentation Exchange typescript library. Please note that the interfaces might still slightly change as the software still is in active development.

  • Added:

    • pejs.selectFrom() method

  • Fixed:

    • submissionFrom should use results from evaluate
    • validateSubmission should be successfully called

  • Known issues:

    1. Implementation of actual hashlink validation, according to DIF documentation is missing

      4.3.1- If the Input Descriptor schema object uri is a hashlink or similar value that points to immutable content, then the content of the retrieved schema must also match

    2. Some entries in DIF documentation are addressing nested credentials and nested paths, which are currently only partially supported.

v0.0.1 - 2021-08-17

This is the first Alpha release of the Presentation Exchange typescript library. Please note that the interfaces might still change a bit as the software still is in active development.

  • Alpha release:

    • Input Evaluation
    • Credential Query (partially available)
    • Utilities

  • Planned for Beta:

    • pejs.selectFrom() method