\r\n
![\"Sphereon\"](\"https://sphereon.com/content/themes/sphereon/assets/img/logo.svg\"){kind=logo}
\r\n Presentation Exchange v1 and v2\r\n
TypeScript Library\r\n
\r\n
\r\n PresentationDefinition | PresentationSubmission | the presentation definition or presentation submission to be validated |\r\n\r\n#### Return value\r\n\r\nThe `validate` method returns a validated results array `NonEmptyArrayPresentationDefinition | the presentation definition that you need to decide the version for |\r\n\r\n#### Return value\r\n\r\nThe `definitionVersionDiscovery` method returns a version or an error, with following structure:\r\n\r\n```typescript\r\ninterface DiscoveredVersion {\r\n version?: PEVersion;\r\n error?: string;\r\n}\r\n\r\nenum PEVersion {\r\n v1 = 'v1',\r\n v2 = 'v2',\r\n}\r\n```\r\n\r\n## From V1 to V2\r\n\r\nThe following changes has been made in the v2 version of the Presentation Exchange specification. V1 is still the most\r\npredominant version, because it is typically used quite a bite in OpenID4VC scenarios and interop profiles.\r\n\r\n1. The required `schema` has been removed altogether from `InputDescriptor` properties, because it was confusing and\r\n redundant.\r\n2. `presentation_definition` has another property called `frame` and if present, its value MUST be a JSON LD Framing\r\n Document object. Used for selective disclosure. Although this library does not use it currently, as we can perform it\r\n without frames.\r\n3. `filter` has several more options for filtering:\r\n - formatMaximum\r\n - formatMinimum\r\n - formatExclusiveMaximum\r\n - formatExclusiveMinimum\r\n\r\nAs a result we introduced the `PEX` class to replace the former `PEJS` class. This class does feature detection on the\r\npresentation definition to determine whether it is a v1 or v2 spec. Then it delegates the functionality to the PEXv1 or\r\nPEXv2 class respectively. See also: [v0.6 Breaking changes](#breaking-change-class-and-package-renamed-as-of-v060)\r\n\r\n**WARNING: Please be aware that this library does not support the latest V2 specification!. Support will be added as\r\npart of a V3 major version of this library**\r\n\r\n## Workflow Diagram\r\n\r\nThe below diagram shows how a typical interaction between a verifier and a wallet looks like.\r\nIt makes no assumptions about the actual transport (DIDComm, SIOPv2/OIDC4VP, CHAPI, REST)\r\n\r\n\r\n\r\n## For PEX developers\r\n\r\nThis project has been created using:\r\n\r\n- `yarn` version 1.22.5\r\n- `node` version >= 16\r\n\r\n### Install\r\n\r\n```shell\r\nyarn install\r\n```\r\n\r\n### Build\r\n\r\n```shell\r\nyarn build\r\n```\r\n\r\n### Test\r\n\r\nThe test command runs:\r\n\r\n- `eslint`\r\n- `prettier`\r\n- `unit`\r\n\r\nYou can also run only a single section of these tests, using for example `yarn test:unit`.\r\n\r\n```shell\r\nyarn test\r\n```\r\n\r\n### Utility scripts\r\n\r\nThere are several other utility scripts that help with development.\r\n\r\n- `yarn fix` - runs `eslint --fix` as well as `prettier` to fix code style\r\n- `yarn cov` - generates code coverage report\r\n\r\n# Glossary\r\n\r\n| Term | Definition |\r\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| Credential | A set of one or more claims made by an issuer. |\r\n| Verifiable Credential | Is a tamper-evident credential that has authorship that can be cryptographically verified. Verifiable credentials can be used to build Verifiable Presentations, which can also be cryptographically verified. The claims in a credential can be about different subjects. PEX accepts Verifiable credential in 3 forms: 1. JSON_LD which is know in our system as IVerifiableCredential, 2. JWT-Wrapped VC which is known in our system as JwtWrappedVerifiableCredential or string which is a valid Verifiable credential jwt |\r\n| Presentation Definition | Presentation Definitions are objects that articulate what proofs a Verifier requires. |\r\n| Holder | Holders are entities that have one or more verifiable credentials in their possession. Holders are also the entities that submit proofs to Verifiers to satisfy the requirements described in a Presentation Definition. |\r\n| Holder's Did | Unique ID URI string and PKI metadata document format for describing the cryptographic keys and other fundamental PKI values linked to a unique, user-controlled, self-sovereign identifier in holder's wallet |\r\n| Verifier | Verifiers are entities that define what proofs they require from a Holder (via a Presentation Definition) in order to proceed with an interaction. |\r\n| Issuer | A role an entity can perform by asserting claims about one or more subjects, creating a verifiable credential from these claims, and transmitting the verifiable credential to a holder. |\r\n| Presentation | Data derived from one or more verifiable credentials, issued by one or more issuers |\r\n| Verifiable Presentation | Is a tamper-evident presentation encoded in such a way that authorship of the data can be trusted after a process of cryptographic verification. |\r\n\r\n## Further work:\r\n\r\nThis implementation fully supports V1 and Vpartially 2 of the Presentation Exchange specification with the following\r\nexception:\r\n\r\n- Support for hashlink verification in the schema part of the V1 specification is not fully incorporated as it depends\r\n on missing external library support. We generate a warning about the missing verification if we encounter them.\r\n- Support for complete [json-schema](http://json-schema.org/draft-07/schema#) in `pex-models`\r\n - which means if you're relying on our version-discovery feature (with calling general `PEX`) and\r\n sending `presentation_definition` object with unsupported fields, you'll get an exception. However if you call\r\n specific version of PEX (PEXv1 or PEXv2) it will work.\r\n- The V2 implementation does not contain latest V2 changes. These will become available in V3 of this library\r\n\r\n## Breaking changes\r\n\r\n### v2.0.0 Argument and result objects changed slightly\r\n\r\nIn V2 of the library we have done some refactoring on the PEX external interfaces, to make them more uniform.\r\n\r\nOptional arguments for all PEX methods are now part of an optional `opts` Object argument. This allows for cleaner\r\nfuture extensions, and\r\nalso solves the problem of optional argument order in case multiple optional arguments are needed.\r\n\r\nCertain non state related methods part of the PEX/PEXv1/PEXv2 classes have moved to static methods, to make the\r\ndistinction between state related methods and non-state related methods more clear.\r\n\r\n`presentationFrom` and `verifiablePresentationFrom` now return a result object instead of directly returning a (\r\nVerifiable) Presentation.\r\nReason is that in certain use cases you will want to have an external Presentation Submission object, like for instance\r\nin OpenID4VP.\r\n\r\nYou can now provide an optional argument where the Presentation Submission object should be located. It will always be\r\nreturned in the methods, as well as an indication whether it is used externally or embedded into the (Verifiable)\r\nPresentation.\r\n\r\nThe (Verifiable) Presentation object is present in the result object in the presentation resp. verifiablePresentation\r\nproperty.\r\n\r\nNo more need for _const and _enum models/properties in Presentation Definitions. They are now `const` and `enum` (fixed\r\nin OpenAPI model generation). The code replaces the previous versions to be sure.\r\n\r\n### v0.6.0: class and package renamed\r\n\r\nAs part of introducing Presentation Exchange v1 and v2 feature based detection support to our Presentation Exchange\r\nlibrary and not reaching version 1.X yet, we decided to change the name of both the package and the main entry class:\r\n\r\n- The package was changed from `@sphereon/pe-js` to `@sphereon/pex`\r\n- The main class was changed from `PEJS` to `PEX`. The latter class has internal feature detection support on the\r\n provided definition, delegating the actual implementation to the new `PEXv1` or `PEXv2` class internally. If you don't\r\n want the automatic feature detection you can also choose to use the `PEXv1` and `PEXv2` classes directly.\r\n\r\n## License\r\n\r\nThis Presentation Exchange library Open Source software released under\r\nthe [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).\r\n\r\n## Funded & supported by\r\n\r\n![](\"logos-supporter.png\")
\r\n","readmeFilename":"README.md"}