@digitalbazaar/oid4-client 3.3.0 → 3.4.1

package/lib/OID4Client.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2022-2023 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import {discoverIssuer, generateDIDProofJWT} from './util.js';
 import {httpClient} from '@digitalbazaar/http-client';
@@ -19,7 +19,7 @@ export class OID4Client {
   }
 
   async requestCredential({
-    credentialDefinition, did, didProofSigner, agent
+    credentialDefinition, did, didProofSigner, agent, format = 'ldp_vc'
   } = {}) {
     const {issuerConfig, offer} = this;
     let requests;
@@ -35,7 +35,7 @@ export class OID4Client {
       }
     } else {
       requests = [{
-        format: 'ldp_vc',
+        format,
         credential_definition: credentialDefinition
       }];
     }
@@ -43,7 +43,8 @@ export class OID4Client {
   }
 
   async requestCredentials({
-    requests, did, didProofSigner, agent, alwaysUseBatchEndpoint = false
+    requests, did, didProofSigner, agent, format = 'ldp_vc',
+    alwaysUseBatchEndpoint = false
   } = {}) {
     const {issuerConfig, offer} = this;
     if(requests === undefined && offer) {
@@ -53,7 +54,7 @@ export class OID4Client {
     }
     requests.forEach(_assertRequest);
     // set default `format`
-    requests = requests.map(r => ({format: 'ldp_vc', ...r}));
+    requests = requests.map(r => ({format, ...r}));
 
     try {
       /* First send credential request(s) to DS without DID proof JWT, e.g.:
@@ -120,8 +121,17 @@ export class OID4Client {
           }
           break;
         } catch(cause) {
+          // presentation is required to continue issuance
+          if(_isPresentationRequired(cause)) {
+            const {data: details} = cause;
+            const error = new Error('Presentation is required.', {cause});
+            error.name = 'NotAllowedError';
+            error.details = details;
+            throw error;
+          }
+
           if(!_isMissingProofError(cause)) {
-            // non-specific error case
+            // other non-specific error case
             throw cause;
           }
 
@@ -310,10 +320,7 @@ function _assertRequest(request) {
   if(!(request && typeof request === 'object')) {
     throw new TypeError('"request" must be an object.');
   }
-  const {credential_definition, format} = request;
-  if(format !== undefined && format !== 'ldp_vc') {
-    throw new TypeError('Credential request "format" must be "ldp_vc".');
-  }
+  const {credential_definition} = request;
   if(!(credential_definition && typeof credential_definition === 'object')) {
     throw new TypeError(
       'Credential request "credential_definition" must be an object.');
@@ -337,7 +344,7 @@ function _isMissingProofError(error) {
     Cache-Control: no-store
 
   {
-    "error": "invalid_or_missing_proof" // or "invalid_proof"
+    "error": "invalid_or_missing_proof", // or "invalid_proof"
     "error_description":
         "Credential issuer requires proof element in Credential Request"
     "c_nonce": "8YE9hCnyV2",
@@ -351,6 +358,24 @@ function _isMissingProofError(error) {
     errorType === 'invalid_or_missing_proof');
 }
 
+function _isPresentationRequired(error) {
+  /* If OID4VP is required, delivery server sends, e.g.:
+
+  HTTP/1.1 400 Bad Request
+    Content-Type: application/json
+    Cache-Control: no-store
+
+  {
+    "error": "presentation_required",
+    "error_description":
+        "Credential issuer requires presentation before Credential Request"
+    "authorization_request": {...}
+  }
+  */
+  const errorType = error.data?.error;
+  return error.status === 400 && errorType === 'presentation_required';
+}
+
 function _createCredentialRequestFromId({id, issuerConfig}) {
   const {credentials_supported: supported = []} = issuerConfig;
   const meta = supported.find(d => d.id === id);
@@ -362,9 +387,6 @@ function _createCredentialRequestFromId({id, issuerConfig}) {
     throw new Error(
       `Invalid supported credential "${id}"; "format" not specified.`);
   }
-  if(format !== 'ldp_vc') {
-    throw new Error(`Unsupported "format" "${format}".`);
-  }
   if(!(Array.isArray(credential_definition?.['@context']) &&
     Array.isArray(credential_definition?.types))) {
     throw new Error(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalbazaar/oid4-client",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "An OID4 (VC + VP) client",
   "homepage": "https://github.com/digitalbazaar/oid4-client",
   "author": {