@mattrglobal/verifier-sdk-web 2.2.1-unstable.47 → 2.2.1-unstable.48

package/README.md

@@ -21,6 +21,7 @@
   - [Define wallet identifiers](#define-wallet-identifiers)
   - [Configure redirectUri](#configure-redirecturi)
   - [Correlate sessions with your own records using state](#correlate-sessions-with-your-own-records-using-state)
+  - [Run logic on session creation using onSessionCreate](#run-logic-on-session-creation-using-onsessioncreate)
   - [Request credentials using the DC API](#request-credentials-using-the-dc-api)
 - [Request credentials examples](#request-credentials-examples)
   - [Request credentials with automatic flow selection](#request-credentials-with-automatic-flow-selection)
@@ -113,6 +114,8 @@ the following configurations and settings:
   same-device flows).
 - Optionally pass a `state` string to correlate the session with a record in your own system (see
   [Correlate sessions with your own records using state](#correlate-sessions-with-your-own-records-using-state)).
+- Optionally pass an `onSessionCreate` hook to run your own logic once the session has been created (see
+  [Run logic on session creation using onSessionCreate](#run-logic-on-session-creation-using-onsessioncreate)).
 
 ## Initialize the SDK
 
@@ -338,6 +341,44 @@ MATTR VII platform and the SDK, see the
 [Correlating verification sessions with your system](https://learn.mattr.global/docs/verification/remote-web-verifiers/guides/correlating-verification-sessions)
 guide on MATTR Learn.
 
+## Run logic on session creation using `onSessionCreate`
+
+`requestCredentials()` accepts an optional `onSessionCreate` hook that the SDK invokes immediately after the
+presentation session has been created on the MATTR VII verifier tenant, but before it continues with the rest of the
+presentation flow (rendering the QR code for cross-device flows or redirecting to the wallet for same-device flows). Use
+it to run your own logic against the freshly created session, for example persisting the `sessionId` in your backend,
+starting a timer, or emitting analytics.
+
+The hook receives the session creation result and may be synchronous or asynchronous; the SDK awaits it before
+continuing:
+
+```typescript
+const options: MATTRVerifierSDK.RequestCredentialsOptions = {
+  credentialQuery: [credentialQuery],
+  challenge: MATTRVerifierSDK.utils.generateChallenge(),
+  openid4vpConfiguration: {
+    redirectUri: window.location.origin,
+    walletProviderId,
+  },
+  onSessionCreate: async (session) => {
+    // e.g. record the session against your own system before the flow continues
+    await fetch("/api/sessions", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ sessionId: session.sessionId }),
+    });
+  },
+};
+
+const results = await MATTRVerifierSDK.requestCredentials(options);
+```
+
+- The hook is supported in both same-device and cross-device sessions.
+- The `session` argument exposes the identifiers for the created session, including its `sessionId`.
+- Any error thrown or promise rejection from the hook is intentionally ignored so it cannot disrupt the presentation
+  flow. If a step is critical, handle its errors inside the hook rather than relying on `requestCredentials()` to
+  surface them.
+
 ## Request credentials using the DC API
 
 > DC API support is currently offered as a **tech preview**. As such, functionality may be limited, may not work in all
@@ -394,6 +435,10 @@ const result = await MATTRVerifierSDK.requestCredentials({
     walletProviderId, // Define the wallet identifier
     redirectUri, // Define the redirect URI (not required for cross-device only requests)
   },
+  onSessionCreate: (session) => {
+    // Optional: run your own logic once the session is created, before the flow continues
+    console.info("Session created", session.sessionId);
+  },
 });
 
 if (result.isErr()) {
@@ -418,6 +463,10 @@ if (result.isErr()) {
   wallet-facing request URI and stored in session records. Returned in the response from `requestCredentials()`
   (cross-device) or `handleRedirectCallback()` (same-device). See
   [Correlate sessions with your own records using state](#correlate-sessions-with-your-own-records-using-state).
+- `onSessionCreate` (optional): A hook invoked with the session creation result once the presentation session has been
+  created, before the flow continues. Supported in both same-device and cross-device flows. Errors thrown by the hook
+  are ignored. See
+  [Run logic on session creation using onSessionCreate](#run-logic-on-session-creation-using-onsessioncreate).
 - `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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattrglobal/verifier-sdk-web",
-  "version": "2.2.1-unstable.47+807e293e",
+  "version": "2.2.1-unstable.48+1fce962a",
   "main": "dist/lib/verifier-js.cjs.js",
   "types": "dist/typings/index.d.ts",
   "module": "dist/verifier-js.production.esm.js",
@@ -32,5 +32,5 @@
     "prepack": "cp README.md README_INTERNAL.md && cp README_PUBLIC.md README.md",
     "postpack": "mv README_INTERNAL.md README.md"
   },
-  "gitHead": "807e293ec0f32a15e3987f52f6361a7def1dfdc7"
+  "gitHead": "1fce962a0d14a7d84db925ce6cffb3f3e6dfaa0d"
 }