@mattrglobal/verifier-sdk-web 1.0.2-unstable.99 → 1.1.0

package/README.md

@@ -34,7 +34,7 @@ Request or download the
 
 ## Overview
 
-The Verifier Web SDK is a powerful tool for integrating online credential verification capabilities into your web applications. It enables secure and efficient verification of [mDocs](https://learn.mattr.global/docs/formats/mdocs), supporting both [same-device](https://learn.mattr.global/docs/formats/mdocs/verification-workflows/online#same-device-verification-workflow) and [cross-device](https://learn.mattr.global/docs/formats/mdocs/verification-workflows/online#cross-device-verification-workflow) verification workflows. The SDK leverages the MATTR VII platform to handle credential presentation and verification processes.
+The Verifier Web SDK is a powerful tool for integrating online credential verification capabilities into your web applications. It enables secure and efficient verification of [mDocs](https://learn.mattr.global/docs/mdocs), supporting both [same-device](https://learn.mattr.global/docs/verification/online/mdocs/overview#same-device-verification-workflow) and [cross-device](https://learn.mattr.global/docs/verification/online/mdocs/overview#cross-device-verification-workflow) verification workflows. The SDK leverages the MATTR VII platform to handle credential presentation and verification processes.
 
 ## Features
 
@@ -49,7 +49,7 @@ The Verifier Web SDK is a powerful tool for integrating online credential verifi
 
 ## How to get access to the MATTR Pi Verifier Web SDK
 
-Refer to our [SDK Docs landing page](https://learn.mattr.global/sdk-docs) for step-by-step instructions to gain access
+Refer to our [SDK Docs landing page](https://learn.mattr.global/references#mattr-pi-sdk-docs) for step-by-step instructions to gain access
 to any of our SDKs.
 
 > Please [reach out](mailto:dev-support@mattr.global) if you need any assistance.
@@ -102,33 +102,42 @@ The SDK can make a request to create a presentation session with a configured MA
 
 ## Initialise the SDK
 
-You must initialise the SDK before you can use any of its functions and methods.
+You must initialise the SDK before you can use any of its functions and methods:
 
-When initialising the SDK, you must provide the URL of the MATTR VII verifier tenant.
+```javascript
+MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
+```
+
+- `apiBaseUrl` (required): URL of the MATTR VII verifier tenant.
+- `applicationId` (optional): Unique identifier of the verifier application. This must match the [`name`](https://learn.mattr.global/api-reference/latest/tag/mDocs-verification#operation/postVerifierApplication!path=name&t=request) parameter defined as part of a Verifier application created on the MATTR VII verifier tenant.
 
 ## 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`: 
 
 ```javascript
-const credentialQuery = {
-  "profile": "mobile",
-  "docType": "org.iso.18013.5.1.mDL",
-  "nameSpaces": {
-    "org.iso.18013.5.1": {
-      "birthdate": {
-        "intentToRetain": false
+const credentialQuery = [
+  {
+    "profile": "mobile",
+    "docType": "org.iso.18013.5.1.mDL",
+    "nameSpaces": {
+      "org.iso.18013.5.1": {
+        "birthdate": {
+          "intentToRetain": false
+        },
+        "portrait": {
+          "intentToRetain": false
+        },
+        "resident_postal_code": {
+          "intentToRetain": false
+        }
       },
-      "portrait": {},
-      "resident_postal_code": {
-        "intentToRetain": false
-      }
-    },
+    }
   }
-};
+];
 ```
 
-> The API supports multiple queries in one request. For simplicity, this example only includes a single query.
+> 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.
 
 ## Generate challenge
 
@@ -168,7 +177,7 @@ When using the same-device presentation flow, the SDK must define what URI to re
 ## Request credentials with automatic flow selection
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl }); // Initialise the SDK
+MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId }); // Initialise the SDK
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery], // Define what credential query to use
   challenge: MATTRVerifierSDK.utils.generateChallenge(), // Pass a unique challenge
@@ -195,7 +204,7 @@ const result = await MATTRVerifierSDK.requestCredentials({
 ## Request credentials with explicit same-device flow
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl });
+MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery],
   challenge: MATTRVerifierSDK.utils.generateChallenge(),
@@ -206,7 +215,7 @@ const result = await MATTRVerifierSDK.requestCredentials({
 
 // result can be retrieved on redirect uri page. for example
 window.addEventListener("load", async () => {
-  MATTRVerifierSDK.initialise({ apiBaseUrl });
+  MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
   const result = await MATTRVerifierSDK.handleRedirectCallback();
 });
 ```
@@ -218,7 +227,7 @@ window.addEventListener("load", async () => {
 ## Request credentials with explicit cross-device flow
 
 ```javascript
-MATTRVerifierSDK.initialise({ apiBaseUrl });
+MATTRVerifierSDK.initialise({ apiBaseUrl, applicationId });
 const result = await MATTRVerifierSDK.requestCredentials({
   credentialQuery: [credentialQuery],
   challenge: MATTRVerifierSDK.utils.generateChallenge(),

package/dist/lib/verifier-js-no-deps.cjs.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2024 - MATTR Limited
+ * Copyright 2025 - MATTR Limited
  * All rights reserved
  * Confidential and proprietary
  *
@@ -7,8 +7,8 @@
  * Do Not Translate or Localize
  *
  * Bundle of @mattrglobal/verifier-sdk-web
- * Generated: 2024-10-20
- * Version: 1.0.1
+ * Generated: 2025-01-07
+ * Version: 1.1.0
  * Dependencies:
  */
 
@@ -127,6 +127,9 @@ exports.MobileCredentialVerificationReasonType = void 0;
 (function(MobileCredentialVerificationReasonType) {
     MobileCredentialVerificationReasonType["Expired"] = "expired";
     MobileCredentialVerificationReasonType["Inactive"] = "inactive";
+    MobileCredentialVerificationReasonType["StatusRevoked"] = "invalid";
+    MobileCredentialVerificationReasonType["StatusSuspended"] = "suspended";
+    MobileCredentialVerificationReasonType["StatusUnknown"] = "unknown";
 })(exports.MobileCredentialVerificationReasonType || (exports.MobileCredentialVerificationReasonType = {}));
 
 exports.ClaimType = void 0;
@@ -262,7 +265,8 @@ exports.RequestCredentialsErrorType = void 0;
 })(exports.RequestCredentialsErrorType || (exports.RequestCredentialsErrorType = {}));
 
 const InitialiseOptionsValidator = v__namespace.object({
-    apiBaseUrl: v__namespace.string()
+    apiBaseUrl: v__namespace.string(),
+    applicationId: v__namespace.optional(v__namespace.string())
 });
 
 let initialiseOptions = undefined;
@@ -312,12 +316,14 @@ const getHashParamValue = (hash, param) => {
     return urlParams.get(param);
 };
 
-const createSession = async ({credentialQuery: credentialQuery, challenge: challenge, redirectUri: redirectUri, apiBaseUrl: apiBaseUrl, walletProviderId: walletProviderId}) => {
-    const postData = Object.assign(Object.assign({
+const createSession = async ({credentialQuery: credentialQuery, challenge: challenge, redirectUri: redirectUri, apiBaseUrl: apiBaseUrl, applicationId: applicationId, walletProviderId: walletProviderId}) => {
+    const postData = Object.assign(Object.assign(Object.assign({
         credentialQuery: credentialQuery,
         challenge: challenge
     }, redirectUri ? {
         redirectUri: redirectUri
+    } : {}), applicationId ? {
+        applicationId: applicationId
     } : {}), walletProviderId ? {
         walletProviderId: walletProviderId
     } : {});
@@ -481,17 +487,19 @@ const openCrossDeviceModal = options => {
     modalContainer.appendChild(style);
     modalContainer.appendChild(iframe);
     document.body.appendChild(modalContainer);
-    modalContainer.setAttribute("style", "background: rgba(0, 0, 0, 0.5) !important; position: fixed !important; top: 0 !important; left: 0 !important; width: 100% !important; height: 100% !important;");
+    modalContainer.setAttribute("style", "background: rgba(0, 0, 0, 0.5) !important; position: fixed !important; top: 0 !important; left: 0 !important; width: 100% !important; height: 100% !important; z-index: 999;");
+    modalContainer.setAttribute("class", "mattr-verifier-modal-container");
     return modalContainer;
 };
 
 const requestCredentialsCrossDevice = async options => {
     const {challenge: challenge, walletProviderId: walletProviderId, credentialQuery: credentialQuery, crossDeviceCallback: crossDeviceCallback, initialiseOptions: initialiseOptions} = options;
-    const {apiBaseUrl: apiBaseUrl} = initialiseOptions;
+    const {apiBaseUrl: apiBaseUrl, applicationId: applicationId} = initialiseOptions;
     const createSessionResult = await createSession({
         credentialQuery: credentialQuery,
         challenge: challenge,
         apiBaseUrl: apiBaseUrl,
+        applicationId: applicationId,
         walletProviderId: walletProviderId
     });
     if (createSessionResult.isErr()) {
@@ -528,7 +536,7 @@ var SameDeviceRequestCredentialsErrorMessage;
 
 const requestCredentialsSameDevice = async options => {
     const {challenge: challenge, credentialQuery: credentialQuery, redirectUri: redirectUri, walletProviderId: walletProviderId, initialiseOptions: initialiseOptions} = options;
-    const {apiBaseUrl: apiBaseUrl} = initialiseOptions;
+    const {apiBaseUrl: apiBaseUrl, applicationId: applicationId} = initialiseOptions;
     window.localStorage.setItem(LocalStorageKey.challenge, challenge);
     const storedChallenge = window.localStorage.getItem(LocalStorageKey.challenge);
     if (!storedChallenge) {
@@ -542,6 +550,7 @@ const requestCredentialsSameDevice = async options => {
         challenge: storedChallenge,
         redirectUri: redirectUri,
         apiBaseUrl: apiBaseUrl,
+        applicationId: applicationId,
         walletProviderId: walletProviderId
     });
     if (createSessionResult.isErr()) {