Add includeCredentials option.

Author: dlongley

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @digitalbazaar/vc ChangeLog
 
+## 7.2.0 - 2025-mm-dd
+
+### Added
+- Add `includeCredentials` option to be passed to `verify()` to include
+  each `credential` in `credentialResults` when verifying a presentation.
+
 ## 7.1.2 - 2025-03-17
 
 ### Changed

lib/index.js

@@ -5,7 +5,7 @@
  * @author David I. Lehn
  *
  * @license BSD 3-Clause License
- * Copyright (c) 2017-2023 Digital Bazaar, Inc.
+ * Copyright (c) 2017-2025 Digital Bazaar, Inc.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -229,6 +229,8 @@ export async function derive({
  *   that clocks may be skewed when checking capability expiration date-times
  *   against `date` and when comparing invocation proof creation time against
  *   delegation proof creation time.
+ * @param {boolean} [options.includeCredentials=false] - Set to `true` to
+ *   include the credentials in the credential results.
  *
  * @returns {Promise<VerifyPresentationResult>} The verification result.
  */
@@ -488,7 +490,7 @@ export async function signPresentation(options = {}) {
  * @returns {Promise<VerifyPresentationResult>} The verification result.
  */
 async function _verifyPresentation(options = {}) {
-  const {presentation, unsignedPresentation} = options;
+  const {presentation, unsignedPresentation, includeCredentials} = options;
 
   _checkPresentation(presentation);
 
@@ -508,7 +510,11 @@ async function _verifyPresentation(options = {}) {
     }));
 
     for(const [i, credentialResult] of credentialResults.entries()) {
-      credentialResult.credentialId = credentials[i].id;
+      const credential = credentials[i];
+      credentialResult.credentialId = credential.id;
+      if(includeCredentials) {
+        credentialResult.credential = credential;
+      }
     }
 
     const allCredentialsVerified = credentialResults.every(r => r.verified);

test/10-verify.spec.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2019-2024 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2025 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bbs2023Cryptosuite from '@digitalbazaar/bbs-2023-cryptosuite';
 import * as Bls12381Multikey from '@digitalbazaar/bls12-381-multikey';
@@ -806,6 +806,30 @@ for(const [version, mockCredential] of versionedCredentials) {
         result.verified.should.be.a('boolean');
         result.verified.should.be.true;
       });
+      it('includes credentials in verification results', async () => {
+        const challenge = uuid();
+
+        const {presentation, suite, documentLoader} =
+          await _generatePresentation({challenge, mockCredential, version});
+
+        const result = await vc.verify({
+          challenge,
+          suite,
+          documentLoader,
+          presentation,
+          includeCredentials: true
+        });
+
+        if(result.error) {
+          const firstError = [].concat(result.error)[0];
+          throw firstError;
+        }
+        result.verified.should.be.a('boolean');
+        result.verified.should.be.true;
+        result.credentialResults.length.should.equal(1);
+        result.credentialResults[0].credential.should.deep.equal(
+          presentation.verifiableCredential[0]);
+      });
       it('verifies an unsigned presentation', async () => {
         const {
           presentation,
@@ -831,6 +855,35 @@ for(const [version, mockCredential] of versionedCredentials) {
         result.verified.should.be.a('boolean');
         result.verified.should.be.true;
       });
+      it('includes credentials in unsigned presentation results', async () => {
+        const {
+          presentation,
+          suite: vcSuite,
+          documentLoader,
+        } = await _generatePresentation({
+          unsigned: true,
+          mockCredential,
+          version
+        });
+
+        const result = await vc.verify({
+          documentLoader,
+          presentation,
+          suite: vcSuite,
+          unsignedPresentation: true,
+          includeCredentials: true
+        });
+
+        if(result.error) {
+          const firstError = [].concat(result.error)[0];
+          throw firstError;
+        }
+        result.verified.should.be.a('boolean');
+        result.verified.should.be.true;
+        result.credentialResults.length.should.equal(1);
+        result.credentialResults[0].credential.should.deep.equal(
+          presentation.verifiableCredential[0]);
+      });
     });
 
     describe(`VerifiablePresentations Version ${version} w/ multiple VCs`,