@mattrglobal/verifier-sdk-web 1.1.1-unstable.16 → 1.1.1-unstable.161

package/README.md

@@ -12,7 +12,7 @@
     - [Web project with an existing bundler set up](#web-project-with-an-existing-bundler-set-up)
     - [Loading directly from script tag](#loading-directly-from-script-tag)
 - [Usage](#usage)
-  - [Initialise the SDK](#initialise-the-sdk)
+  - [Initialize the SDK](#initialize-the-sdk)
   - [Prepare a credential query](#prepare-a-credential-query)
   - [Generate challenge](#generate-challenge)
   - [Determine supported presentation flows](#determine-supported-presentation-flows)
@@ -29,7 +29,7 @@
 ## Licensing
 
 Request or download the
-[MATTR Pi SDK Trial Licence Agreement](https://learn.mattr.global/docs/terms/mattr-pi-sdk-licence-agreement) and the
+[MATTR Pi SDK Trial License Agreement](https://learn.mattr.global/docs/terms/mattr-pi-sdk-licence-agreement) and the
 [MATTR Customer Agreement](https://learn.mattr.global/docs/terms/customer-agreement) and review these terms carefully.
 
 ## Overview
@@ -69,7 +69,7 @@ yarn add @mattrglobal/verifier-sdk-web
 ```javascript
 import * as MATTRVerifierSDK from "@mattrglobal/verifier-sdk-web";
 
-MATTRVerifierSDK.initialise(...);
+MATTRVerifierSDK.initialize(...);
 ```
 
 ### Loading directly from script tag
@@ -86,26 +86,26 @@ MATTRVerifierSDK.initialise(...);
 
 ```javascript
 <script> 
-   MATTRVerifierSDK.initialise(...);
+   MATTRVerifierSDK.initialize(...);
 </script> 
 ```
 
 # Usage
 
 The SDK can make a request to create a presentation session with a configured MATTR VII verifier tenant. This requires the following configurations and settings:
-* Initialise the SDK with the URL of the MATTR VII tenant that will handle the verification request.
+* Initialize the SDK with the URL of the MATTR VII tenant that will handle the verification request.
 * Prepare a credential query that defines what claims are required for verification.
 * Generate a unique challenge for the presentation session.
 * Determine what presentation flows are supported in the session.
 * Define what wallets can be used to respond to the verification request.
 * Configure the URI the user will be redirected to when the verification workflow is completed (only required for same-device flows).
 
-## Initialise the SDK
+## Initialize the SDK
 
-You must initialise the SDK before you can use any of its functions and methods:
+You must initialize the SDK before you can use any of its functions and methods:
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
+MATTRVerifierSDK.initialize({ apiBaseUrl, applicationId });
 ```
 
 - `apiBaseUrl` (required): URL of the MATTR VII verifier tenant.
@@ -113,7 +113,7 @@ MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
 
 ## Prepare a credential query
 
-The following example credential query will request the `birthdate` and `portrait` claims from a `mobile` credential `profile` with `org.iso.18013.5.1.mDL` as a `docType`: 
+The following example credential query will request the `given_name`, `family_name`, `birth_date` and `portrait` claims from a `mobile` credential profile with `org.iso.18013.5.1.mDL` as a docType: 
 
 ```javascript
 const credentialQuery = [
@@ -122,7 +122,13 @@ const credentialQuery = [
     "docType": "org.iso.18013.5.1.mDL",
     "nameSpaces": {
       "org.iso.18013.5.1": {
-        "birthdate": {
+        "given_name": {
+          "intentToRetain": false
+        },
+        "family_name": {
+          "intentToRetain": false
+        },
+        "birth_date": {
           "intentToRetain": false
         },
         "portrait": {
@@ -136,9 +142,23 @@ const credentialQuery = [
   }
 ];
 ```
-
+* `profile`: Credential format of the credential that will be verified. Currently only mobile (mDocs) is supported.
+* `docType`: the mDL’s type. Confirm with the certificate issuer for what docType they are issuing. Some common examples include:
+  * Mobile Driver License (`org.iso.18013.5.1.mDL`).
+  * PhotoID (`org.iso.23220.photoid.1`).
+  * Mobile Vehicle Registration Card (`org.iso.7367.1.mVRC`).
+  * Health certificate (`org.micov.vtr.1`).
+* `nameSpaces`: Each namespace corresponds to a group of claims included in the credential. These can be claims that are part of a specific standard, jurisdiction or any other reference. The namespace would usually correspond to the requested `docType`.
+  * `intentToRetain` (Optional): When set to `true`, the holder will be indicated that the verifier intends to retain this claim beyond the verification workflow. Defaults to `false` when not specified.
+  
 > The API supports including multiple query objects in the `credentialQuery` array in a single request. For simplicity, this example only includes a single query object.
 
+In this example the `credentialQuery` query will request for the `birthdate`, `portrait` and `resident_postal_code` claims from any credentials whose `profile` is `mobile` and `docType` is `org.iso.18013.5.1.mDL`.
+
+It also sets `intentToRetain` as `false` for all claims, indicating to the holder that the verifier will not retain any of these claims.
+
+> While `intentToRetain` defaults to false, it is explicitly set to `false` in the example above for clarity purposes. If there is no intention to retain a claim, it is sufficient to simply exclude `intentToRetain` from the query.
+
 ## Generate challenge
 
 The Verifier Web SDK passes a unique challenge to the MATTR VII verifier tenant with every request to create a new presentation session. The purpose of the challenge is to ensure the security and integrity of the credential verification process by preventing replay attacks and verifying the authenticity of each request and response. You can either:
@@ -170,52 +190,53 @@ You can define an identifier of a specific wallet you want to invoke with this v
 
 ## Configure redirectUri
 
-When using the same-device presentation flow, the SDK must define what URI to redirect the user to once they complete the verification workflow in their wallet app. This can be any URI (including custom URI schemes), and must match one of the values defined in the [`redirectUris` array](https://learn.mattr.global/latest/tag/mDocs-verification#operation/putVerifierConfiguration!path=redirectUris&t=request) in the MATTR VII tenant's verifier configuration.
+When using the same-device presentation flow, the SDK must define what URI to redirect the user to once they complete the verification workflow in their wallet app. This can be any URI (including custom URI schemes), and must match one of the values defined in the [`redirectUris` array](https://learn.mattr.global/api-reference/latest/tag/mDocs-verification#operation/postVerifierApplication!path=openid4vpConfiguration/redirectUris&t=request) in the MATTR VII tenant's verifier configuration.
 
 # Request credentials examples
 
 ## Request credentials with automatic flow selection
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId }); // Initialise the SDK
+MATTRVerifierSDK.initialize({ apiBaseUrl, applicationId }); // Initialize the SDK
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery], // Define what credential query to use
   challenge: MATTRVerifierSDK.utils.generateChallenge(), // Pass a unique challenge
-  walletProviderId, // Define the wallet identifier
-  redirectUri, // Define the redirect URI (not required for cross-device only requests)
-  crossDeviceCallback: { // Define how to handle completion/failure of cross-device flows (not required for same-device only requests)
-    onComplete: (result) => {
-      console.info("<<< MATTRVerifierSDK.requestCredentials crossDeviceCallback.onComplete", result);
-    },
-    onFailure: (error) => {
-      console.info("<<< MATTRVerifierSDK.requestCredentials crossDeviceCallback.onFailure", error);
-    },
-  },
+  openid4vpConfiguration: {
+      walletProviderId, // Define the wallet identifier
+      redirectUri, // Define the redirect URI (not required for cross-device only requests)
+  }
 });
+
+if (result.isErr()) {
+  console.info("<<< MATTRVerifierSDK.requestCredentials succeed", result.error);
+} else {
+  console.info("<<< MATTRVerifierSDK.requestCredentials failure", result.value);
+}
 ```
-* `apiBaseUrl` : Replace with the [`tenant_url`](https://learn.mattr.global/docs/security/authentication) of your MATTR VII verifier tenant.
+* `apiBaseUrl` : Replace with the [`tenant_url`](https://learn.mattr.global/docs/platform-management/authentication) of your MATTR VII verifier tenant.
 * `credentialQuery`: The credential query to be used in the request.
 * `challenge`: The challenge that will be passed to the MATTR VII tenant with the request to create a presentation session. This example uses the SDK built-in method to generate the challenge, but you can replace it with a challenge generated by your backend system.
 * `walletProviderId`: Replace with a wallet identifier that matches one of the values in the [`walletProviders` array](https://learn.mattr.global/api-reference/latest/tag/mDocs-verification#operation/putVerifierConfiguration!path=walletProviders/id&t=request) of the MATTR VII tenant's verifier configuration.
 * `mode`: When omitted, the SDK defaults to automatically selecting a flow based on the browser's user agent (set to `undefined` in the example for clarity).
-* `redirectUri` Replace with a URI that matches one of the values in the [`redirectUris` array](https://learn.mattr.global/latest/tag/mDocs-verification#operation/putVerifierConfiguration!path=redirectUris&t=request) in the MATTR VII tenant's verifier configuration.
-* `crossDeviceCallback`: Defines how to handle completion (`onComplete`) or failure (`onFailure`) of the verification workflow.
+* `redirectUri` Replace with a URI that matches one of the values in the [`redirectUris` array](https://learn.mattr.global/api-reference/latest/tag/mDocs-verification#operation/postVerifierApplication!path=openid4vpConfiguration/redirectUris&t=request) in the MATTR VII tenant's verifier application configuration.
 
 ## Request credentials with explicit same-device flow
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
+MATTRVerifierSDK.initialize({ apiBaseUrl, applicationId });
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery],
   challenge: MATTRVerifierSDK.utils.generateChallenge(),
-  redirectUri,
-  walletProviderId,
-  mode: "sameDevice",
+  openid4vpConfiguration: {
+      redirectUri,
+      walletProviderId,
+      mode: "sameDevice",
+  }
 });
 
 // result can be retrieved on redirect uri page. for example
 window.addEventListener("load", async () => {
-  MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
+  MATTRVerifierSDK.initialize({ apiBaseUrl, applicationId });
   const result = await MATTRVerifierSDK.handleRedirectCallback();
 });
 ```
@@ -227,21 +248,21 @@ window.addEventListener("load", async () => {
 ## Request credentials with explicit cross-device flow
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
+MATTRVerifierSDK.initialize({ apiBaseUrl, applicationId });
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery],
   challenge: MATTRVerifierSDK.utils.generateChallenge(),
-  walletProviderId,
-  mode: "crossDevice",
-  crossDeviceCallback: {
-    onComplete: (result) => {
-      console.info("<<< MATTRVerifierSDK.requestCredentials crossDeviceCallback.onComplete", result);
-    },
-    onFailure: (error) => {
-      console.info("<<< MATTRVerifierSDK.requestCredentials crossDeviceCallback.onFailure", error);
-    },
-  },
+  openid4vpConfiguration: {
+      walletProviderId,
+      mode: "crossDevice",
+  }
 });
+
+if (result.isErr()) {
+  console.info("<<< MATTRVerifierSDK.requestCredentials succeed", result.error);
+} else {
+  console.info("<<< MATTRVerifierSDK.requestCredentials failure", result.value);
+}
 ```
 
 * `mode`: When set to `crossDevice`, the SDK will only support cross-device flow in this verification workflow.