@bedrock/vc-delivery 4.2.0 → 4.4.0

package/lib/index.js

@@ -1,28 +1,34 @@
 /*!
- * Copyright (c) 2022-2023 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
-import * as exchangerSchemas from '../schemas/bedrock-vc-exchanger.js';
+import * as workflowSchemas from '../schemas/bedrock-vc-workflow.js';
 import {createService, schemas} from '@bedrock/service-core';
 import {addRoutes} from './http.js';
 import {initializeServiceAgent} from '@bedrock/service-agent';
 import {klona} from 'klona';
+import {parseLocalId} from './helpers.js';
 import '@bedrock/express';
 
 // load config defaults
 import './config.js';
 
-const serviceType = 'vc-exchanger';
 const {util: {BedrockError}} = bedrock;
 
 bedrock.events.on('bedrock.init', async () => {
+  await _initService({serviceType: 'vc-workflow', routePrefix: '/workflows'});
+  // backwards compatibility: deprecrated `exchangers` service
+  await _initService({serviceType: 'vc-exchanger', routePrefix: '/exchangers'});
+});
+
+async function _initService({serviceType, routePrefix}) {
   // add customizations to config validators...
   const createConfigBody = klona(schemas.createConfigBody);
   const updateConfigBody = klona(schemas.updateConfigBody);
   const schemasToUpdate = [createConfigBody, updateConfigBody];
-  const {credentialTemplates, steps, initialStep} = exchangerSchemas;
+  const {credentialTemplates, steps, initialStep} = workflowSchemas;
   for(const schema of schemasToUpdate) {
-    // add config requirements to exchanger configs
+    // add config requirements to workflow configs
     schema.properties.credentialTemplates = credentialTemplates;
     schema.properties.steps = steps;
     schema.properties.initialStep = initialStep;
@@ -31,10 +37,14 @@ bedrock.events.on('bedrock.init', async () => {
     // schema.required.push('credentialTemplates');
   }
 
-  // create `vc-exchanger` service
+  // allow `id` property in `createConfigBody`, to be more rigorously validated
+  // below in `validateConfigFn`
+  createConfigBody.properties.id = updateConfigBody.properties.id;
+
+  // create workflow service
   const service = await createService({
     serviceType,
-    routePrefix: '/exchangers',
+    routePrefix,
     storageCost: {
       config: 1,
       revocation: 1
@@ -42,7 +52,9 @@ bedrock.events.on('bedrock.init', async () => {
     validation: {
       createConfigBody,
       updateConfigBody,
-      validateConfigFn,
+      async validateConfigFn({config, op} = {}) {
+        return validateConfigFn({config, op, routePrefix});
+      },
       // these zcaps are optional (by reference ID)
       zcapReferenceIds: [{
         referenceId: 'issue',
@@ -67,7 +79,7 @@ bedrock.events.on('bedrock.init', async () => {
     await addRoutes({app, service});
   });
 
-  // initialize vc-exchanger service agent early (after database is ready) if
+  // initialize vc-workflow service agent early (after database is ready) if
   // KMS system is externalized; otherwise we must wait until KMS system
   // is ready
   const externalKms = !bedrock.config['service-agent'].kms.baseUrl.startsWith(
@@ -76,7 +88,7 @@ bedrock.events.on('bedrock.init', async () => {
   bedrock.events.on(event, async () => {
     await initializeServiceAgent({serviceType});
   });
-});
+}
 
 async function usageAggregator({meter, signal, service} = {}) {
   const {id: meterId} = meter;
@@ -84,8 +96,25 @@ async function usageAggregator({meter, signal, service} = {}) {
   return service.configStorage.getUsage({meterId, signal});
 }
 
-async function validateConfigFn({config} = {}) {
+async function validateConfigFn({config, op, routePrefix} = {}) {
   try {
+    // validate any `id` in a new config
+    if(op === 'create' && config.id !== undefined) {
+      try {
+        _validateId({id: config.id, routePrefix});
+      } catch(e) {
+        throw new BedrockError(
+          `Invalid client-provided configuration ID: ${e.message}.`, {
+            name: 'DataError',
+            details: {
+              httpStatusCode: 400,
+              public: true
+            },
+            cause: e
+          });
+      }
+    }
+
     // if credential templates are specified, then `zcaps` MUST include at
     // least `issue`
     const {credentialTemplates = [], zcaps = {}} = config;
@@ -118,3 +147,29 @@ async function validateConfigFn({config} = {}) {
   }
   return {valid: true};
 }
+
+function _validateId({id, routePrefix} = {}) {
+  // format: <base>/<localId>
+
+  // ensure `id` starts with appropriate base URL
+  const {baseUri} = bedrock.config.server;
+  const base = `${baseUri}${routePrefix}/`;
+  if(id.startsWith(base)) {
+    // ensure `id` ends with appropriate local ID
+    const expectedLastSlashIndex = base.length - 1;
+    const idx = id.lastIndexOf('/');
+    if(idx === expectedLastSlashIndex) {
+      return parseLocalId({id});
+    }
+  }
+
+  throw new BedrockError(
+    `Configuration "id" must start with "${base}" and end in a multibase, ` +
+    'base58-encoded local identifier.', {
+      name: 'DataError',
+      details: {
+        httpStatusCode: 400,
+        public: true
+      }
+    });
+}

package/lib/issue.js

@@ -1,24 +1,24 @@
 /*!
- * Copyright (c) 2022-2023 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2022-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import {evaluateTemplate, getZcapClient} from './helpers.js';
 import {createPresentation} from '@digitalbazaar/vc';
 
-export async function issue({exchanger, exchange} = {}) {
-  // use any templates from exchanger and variables from exchange to produce
+export async function issue({workflow, exchange} = {}) {
+  // use any templates from workflow and variables from exchange to produce
   // credentials to be issued; issue via the configured issuer instance
   const verifiableCredential = [];
-  const {credentialTemplates = []} = exchanger;
+  const {credentialTemplates = []} = workflow;
   if(!credentialTemplates || credentialTemplates.length === 0) {
     // nothing to issue
     return {};
   }
 
   // evaluate template
-  const credentials = await Promise.all(credentialTemplates.map(
-    typedTemplate => evaluateTemplate({exchanger, exchange, typedTemplate})));
+  const credentialRequests = await Promise.all(credentialTemplates.map(
+    typedTemplate => evaluateTemplate({workflow, exchange, typedTemplate})));
   // issue all VCs
-  const vcs = await _issue({exchanger, credentials});
+  const vcs = await _issue({workflow, credentialRequests});
   verifiableCredential.push(...vcs);
 
   // generate VP to return VCs
@@ -32,9 +32,9 @@ export async function issue({exchanger, exchange} = {}) {
   return {verifiablePresentation};
 }
 
-async function _issue({exchanger, credentials} = {}) {
+async function _issue({workflow, credentialRequests} = {}) {
   // create zcap client for issuing VCs
-  const {zcapClient, zcaps} = await getZcapClient({exchanger});
+  const {zcapClient, zcaps} = await getZcapClient({workflow});
 
   // issue VCs in parallel
   const capability = zcaps.issue;
@@ -42,14 +42,15 @@ async function _issue({exchanger, credentials} = {}) {
   // is not specific to it
   let url = capability.invocationTarget;
   if(!capability.invocationTarget.endsWith('/credentials/issue')) {
-    if(!capability.invocationTarget.endsWith('/credentials')) {
-      url += '/credentials/issue';
-    } else {
-      url += '/issue';
-    }
+    url += capability.invocationTarget.endsWith('/credentials') ?
+      '/issue' : '/credentials/issue';
   }
-  const results = await Promise.all(credentials.map(
-    credential => zcapClient.write({url, capability, json: {credential}})));
+  const results = await Promise.all(credentialRequests.map(request => {
+    // normalize credential templates that return full VC API issue credential
+    // requests and those that return only the `credential` param directly
+    const json = request.credential ? request : {credential: request};
+    return zcapClient.write({url, capability, json});
+  }));
 
   // parse VCs from results
   const verifiableCredentials = results.map(

package/lib/logger.js

@@ -1,6 +1,6 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
  */
 import {loggers} from '@bedrock/core';
 
-export const logger = loggers.get('app').child('bedrock-vc-exchanger');
+export const logger = loggers.get('app').child('bedrock-vc-workflow');