@digitalbazaar/oid4-client 3.6.0 → 3.8.0

package/lib/OID4Client.js

@@ -27,7 +27,9 @@ export class OID4Client {
       if(!offer) {
         throw new TypeError('"credentialDefinition" must be an object.');
       }
-      requests = _createCredentialRequestsFromOffer({issuerConfig, offer});
+      requests = _createCredentialRequestsFromOffer({
+        issuerConfig, offer, format
+      });
       if(requests.length > 1) {
         throw new Error(
           'More than one credential is offered; ' +
@@ -48,7 +50,9 @@ export class OID4Client {
   } = {}) {
     const {issuerConfig, offer} = this;
     if(requests === undefined && offer) {
-      requests = _createCredentialRequestsFromOffer({issuerConfig, offer});
+      requests = _createCredentialRequestsFromOffer({
+        issuerConfig, offer, format
+      });
     } else if(!(Array.isArray(requests) && requests.length > 0)) {
       throw new TypeError('"requests" must be an array of length >= 1.');
     }
@@ -174,7 +178,7 @@ export class OID4Client {
         }
       }
 
-      // wallet / client receives credential:
+      // wallet / client receives credential(s):
       /* Note: The credential is not wrapped here in a VP in the current spec:
 
       HTTP/1.1 200 OK
@@ -182,10 +186,17 @@ export class OID4Client {
         Cache-Control: no-store
 
       {
-        "format": "ldp_vc"
+        "format": "ldp_vc",
         "credential" : {...}
       }
 
+      OR (if multiple VCs *of the same type* were issued)
+
+      {
+        "format": "ldp_vc",
+        "credentials" : {...}
+      }
+
       OR (if multiple `requests` were given)
 
       {
@@ -393,19 +404,29 @@ function _isPresentationRequired(error) {
   return error.status === 400 && errorType === 'presentation_required';
 }
 
-function _createCredentialRequestsFromOffer({issuerConfig, offer}) {
+function _createCredentialRequestsFromOffer({
+  issuerConfig, offer, format
+}) {
   // get any supported credential configurations from issuer config
   const supported = _createSupportedCredentialsMap({issuerConfig});
 
-  // build requests from credentials identified in `offer`
+  // build requests from credentials identified in `offer` and remove any
+  // that do not match the given format
   const credentials = offer.credential_configuration_ids ?? offer.credentials;
-  return credentials.map(c => {
+  const requests = credentials.map(c => {
     if(typeof c === 'string') {
       // use supported credential config
       return _getSupportedCredentialById({id: c, supported});
     }
     return c;
-  });
+  }).filter(r => r.format === format);
+
+  if(requests.length === 0) {
+    throw new Error(
+      `No supported credential(s) with format "${format}" found.`);
+  }
+
+  return requests;
 }
 
 function _createSupportedCredentialsMap({issuerConfig}) {

package/lib/index.js

@@ -5,6 +5,7 @@ export * as oid4vp from './oid4vp.js';
 export {
   discoverIssuer,
   generateDIDProofJWT,
+  getCredentialOffer,
   parseCredentialOfferUrl,
   robustDiscoverIssuer,
   signJWT

package/lib/oid4vp.js

@@ -446,7 +446,9 @@ function _filterToValue({filter, strict = false}) {
     partial support as it will be treated as a simple string not a regex; regex
     is a DoS attack vector
 
-  `array`: with `items` or `contains` where uses a `string` filter
+  `array`: with `contains` where uses a `string` filter
+
+  `allOf`: supported only with the above schemas present in it.
 
   */
   let value;
@@ -455,14 +457,18 @@ function _filterToValue({filter, strict = false}) {
   if(type === 'array') {
     if(filter.contains) {
       if(Array.isArray(filter.contains)) {
-        value = filter.contains.map(filter => _filterToValue({filter, strict}));
-      } else {
-        value = _filterToValue({filter: filter.contains, strict});
+        return filter.contains.map(filter => _filterToValue({filter, strict}));
       }
-    } else if(strict) {
+      return _filterToValue({filter: filter.contains, strict});
+    }
+    if(Array.isArray(filter.allOf) && filter.allOf.every(f => f.contains)) {
+      return filter.allOf.map(
+        f => _filterToValue({filter: f.contains, strict}));
+    }
+    if(strict) {
       throw new Error(
-        'Unsupported filter; array filters must use "enum" or "contains" ' +
-        'with a string filter.');
+        'Unsupported filter; array filters must use "allOf" and/or ' +
+        '"contains" with a string filter.');
     }
     return value;
   }
@@ -584,6 +590,13 @@ export function _fromQueryByExampleQuery({credentialQuery, prefixJwtVcPath}) {
     const filter = {};
     if(Array.isArray(value)) {
       filter.type = 'array';
+      // FIXME: create `allOf`
+      /*filter.allOf = value.map(v => ({
+        contains: {
+          type: 'string',
+          const: v
+        }
+      }));*/
       filter.contains = value.map(v => ({
         type: 'string',
         const: v

package/lib/util.js

@@ -162,6 +162,43 @@ export async function generateDIDProofJWT({
   return signJWT({payload, protectedHeader, signer});
 }
 
+export async function getCredentialOffer({url, agent} = {}) {
+  const {protocol, searchParams} = new URL(url);
+  if(protocol !== 'openid-credential-offer:') {
+    throw new SyntaxError(
+      '"url" must express a URL with the ' +
+      '"openid-credential-offer" protocol.');
+  }
+  const offer = searchParams.get('credential_offer');
+  if(offer) {
+    return JSON.parse(offer);
+  }
+
+  // try to fetch offer from URL
+  const offerUrl = searchParams.get('credential_offer_uri');
+  if(!offerUrl) {
+    throw new SyntaxError(
+      'OID4VCI credential offer must have "credential_offer" or ' +
+      '"credential_offer_uri".');
+  }
+
+  if(!offerUrl.startsWith('https://')) {
+    const error = new Error(
+      `"credential_offer_uri" (${offerUrl}) must start with "https://".`);
+    error.name = 'NotSupportedError';
+    throw error;
+  }
+
+  const response = await fetchJSON({url: offerUrl, agent});
+  if(!response.data) {
+    const error = new Error(
+      `Credential offer fetched from "${offerUrl}" is not JSON.`);
+    error.name = 'DataError';
+    throw error;
+  }
+  return response.data;
+}
+
 export function parseCredentialOfferUrl({url} = {}) {
   assert(url, 'url', 'string');
 

package/package.json

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