updated maestro examples

Author: RomanBachaloSigmaSoftware

config/appsettings.example.json

@@ -29,6 +29,6 @@
   "clickAPIUrl": "https://demo.docusign.net/clickapi",
   "adminAPIUrl": "https://api-d.docusign.net/management",
   "monitorApiUrl": "https://lens-d.docusign.net",
-  "maestroApiIrl": "https://demo.services.docusign.net/aow-manage/v1.0",
+  "maestroApiUrl": "https://demo.services.docusign.net/",
   "codeExamplesManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/CodeExamplesManifest.json"
 }

index.js

@@ -275,6 +275,7 @@ app.get('/cneg001', eg001connect.getController)
 
 app.get('/mseg001', eg001maestro.getController)
   .post('/mseg001', eg001maestro.createController)
+  .post('/mseg001publish', eg001maestro.publishController)
   .get('/mseg002', eg002maestro.getController)
   .post('/mseg002', eg002maestro.createController)
   .get('/mseg003', eg003maestro.getController)

lib/maestro/controllers/eg001TriggerWorkflow.js

@@ -9,7 +9,7 @@ const validator = require('validator');
 const { formatString, API_TYPES } = require('../../utils.js');
 const { getExampleByNumber } = require('../../manifestService');
 const dsConfig = require('../../../config/index.js').config;
-const { getWorkflowDefinition, triggerWorkflow } = require('../examples/triggerWorkflow');
+const { getWorkflowDefinitions, getWorkflowDefinition, triggerWorkflow } = require('../examples/triggerWorkflow');
 const { createWorkflow, publishWorkflow } = require('../workflowUtils.js');
 
 const eg001TriggerWorkflow = exports;
@@ -18,6 +18,7 @@ const eg = `mseg00${exampleNumber}`; // This example reference.
 const api = API_TYPES.MAESTRO;
 const mustAuthenticate = '/ds/mustAuthenticate';
 const minimumBufferMin = 3;
+const workflowName = 'Example workflow - send invite to signer';
 
 
 /**
@@ -47,7 +48,8 @@ eg001TriggerWorkflow.createController = async (req, res) => {
     ccName: validator.escape(body.ccName),
     workflowId: req.session.workflowId,
     accessToken: req.user.accessToken,
-    basePath: dsConfig.maestroApiIrl,
+    basePath: dsConfig.maestroApiUrl,
+    triggerWorkflowBasePath: dsConfig.maestroTriggerWorkflowApiUrl,
     accountId: req.session.accountId,
   };
   let results = null;
@@ -56,13 +58,16 @@ eg001TriggerWorkflow.createController = async (req, res) => {
     const workflow = await getWorkflowDefinition(args);
     results = await triggerWorkflow(workflow, args);
   } catch (error) {
-    const errorBody = error && error.response && error.response.body;
-    // we can pull the DocuSign error code and message from the response body
-    const errorCode = errorBody && errorBody.errorCode;
-    const errorMessage = errorBody && errorBody.message;
-    // In production, may want to provide customized error messages and
-    // remediation advice to the user.
-    res.render('pages/error', { err: error, errorCode, errorMessage });
+    const errorCode = error?.response?.statusCode;
+    const errorMessage = error?.response?.body?.message;
+    let errorInfo;
+
+    // use custom error message if Maestro is not enabled for the account
+    if (errorCode === 403) {
+      errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
+    }
+
+    return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
   }
   if (results) {
     req.session.instanceId = results.instanceId; // Save for use by other examples
@@ -90,33 +95,128 @@ eg001TriggerWorkflow.getController = async (req, res) => {
     return res.redirect(mustAuthenticate);
   }
 
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+  const additionalPageData = example.AdditionalPage.filter(p => p.Name === 'publish_workflow')[0];
+  const sourceFile =
+    path.basename(__filename)[5].toLowerCase() +
+    path.basename(__filename).substr(6);
+
   const args = {
     templateId: req.session.templateId,
     accessToken: req.user.accessToken,
-    basePath: dsConfig.maestroApiIrl,
+    basePath: dsConfig.maestroApiUrl,
     accountId: req.session.accountId,
   };
 
-  // if there is no workflow, then create one
-  if (!req.session.workflowId) {
-    if (!req.session.templateId) {
-      return res.redirect('/eg008');
+  try {
+    const workflows = await getWorkflowDefinitions(args);
+
+    if (workflows.count > 0) {
+      const workflow = workflows.value
+        .filter(workflow => workflow.name === workflowName)
+        .sort((wf1, wf2) => wf2.lastUpdatedDate - wf1.lastUpdatedDate)[0];
+      if (workflow) {
+        req.session.workflowId = workflow.id;
+      }
     }
 
-    req.session.workflowId = await createWorkflow(args);
+    // if there is no workflow, then create one
+    if (!req.session.workflowId) {
+      if (!req.session.templateId) {
+        return res.render('pages/maestro-examples/eg001TriggerWorkflow', {
+          eg: eg,
+          csrfToken: req.csrfToken(),
+          example: example,
+          templateOk: false,
+          sourceFile: sourceFile,
+          sourceUrl: dsConfig.githubExampleUrl + 'maestro/examples/' + sourceFile,
+          documentation: dsConfig.documentation + eg,
+          showDoc: dsConfig.documentation,
+        });
+      }
+
+      req.session.workflowId = await createWorkflow(args);
+
+      const consentUrl = await publishWorkflow(args, req.session.workflowId);
+      if (consentUrl) {
+        return res.render('pages/maestro-examples/eg001PublishWorkflow', {
+          example,
+          consentUrl,
+          message: additionalPageData.ResultsPageText,
+          csrfToken: req.csrfToken(),
+        });
+      }
+    }
+  } catch (error) {
+    const errorCode = error?.response?.statusCode;
+    const errorMessage = error?.response?.body?.message;
+    let errorInfo;
+
+    // use custom error message if Maestro is not enabled for the account
+    if (errorCode === 403) {
+      errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
+    }
+
+    return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
   }
 
-  if (!req.session.workflowPublished) {
+  res.render('pages/maestro-examples/eg001TriggerWorkflow', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    example: example,
+    sourceFile: sourceFile,
+    templateOk: true,
+    sourceUrl: dsConfig.githubExampleUrl + 'maestro/examples/' + sourceFile,
+    documentation: dsConfig.documentation + eg,
+    showDoc: dsConfig.documentation,
+  });
+};
+
+/**
+ * Publish workflow page
+ */
+eg001TriggerWorkflow.publishController = async (req, res) => {
+  // Check that the authentication token is ok with a long buffer time.
+  // If needed, now is the best time to ask the user to authenticate
+  // since they have not yet entered any information into the form.
+  const isTokenOK = req.dsAuth.checkToken();
+  if (!isTokenOK) {
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    return res.redirect(mustAuthenticate);
+  }
+
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+  const additionalPageData = example.AdditionalPage.filter(p => p.Name === 'publish_workflow')[0];
+
+  try {
+    const args = {
+      accessToken: req.user.accessToken,
+      basePath: dsConfig.maestroApiUrl,
+      accountId: req.session.accountId,
+    };
     const consentUrl = await publishWorkflow(args, req.session.workflowId);
     if (consentUrl) {
-      const redirectUrl = `${consentUrl}&host=${dsConfig.appUrl}/${eg}`;
-      return res.redirect(redirectUrl);
+      return res.render('pages/maestro-examples/eg001PublishWorkflow', {
+        example,
+        consentUrl,
+        message: additionalPageData.ResultsPageText,
+        csrfToken: req.csrfToken(),
+      });
+    }
+  } catch (error) {
+    const errorCode = error?.response?.statusCode;
+    const errorMessage = error?.response?.body?.message;
+    let errorInfo;
+
+    // use custom error message if Maestro is not enabled for the account
+    if (errorCode === 403) {
+      errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
     }
 
-    req.session.workflowPublished = true;
+    return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
   }
 
-  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
   const sourceFile =
     path.basename(__filename)[5].toLowerCase() +
     path.basename(__filename).substr(6);
@@ -125,10 +225,9 @@ eg001TriggerWorkflow.getController = async (req, res) => {
     csrfToken: req.csrfToken(),
     example: example,
     sourceFile: sourceFile,
+    templateOk: true,
     sourceUrl: dsConfig.githubExampleUrl + 'maestro/examples/' + sourceFile,
     documentation: dsConfig.documentation + eg,
     showDoc: dsConfig.documentation,
   });
 };
-
-

lib/maestro/controllers/eg002CancelWorkflow.js

@@ -8,7 +8,7 @@ const path = require('path');
 const { formatString, API_TYPES } = require('../../utils.js');
 const { getExampleByNumber } = require('../../manifestService');
 const dsConfig = require('../../../config/index.js').config;
-const { cancelWorkflowInstance } = require('../examples/cancelWorkflow');
+const { cancelWorkflowInstance, getWorkflowInstanceState } = require('../examples/cancelWorkflow');
 
 const eg002CancelWorkflow = exports;
 const exampleNumber = 2;
@@ -39,21 +39,24 @@ eg002CancelWorkflow.createController = async (req, res) => {
   const args = {
     instanceId: req.session.instanceId,
     accessToken: req.user.accessToken,
-    basePath: dsConfig.maestroApiIrl,
+    basePath: dsConfig.maestroApiUrl,
     accountId: req.session.accountId,
   };
   let results = null;
 
   try {
     results = await cancelWorkflowInstance(args);
   } catch (error) {
-    const errorBody = error && error.response && error.response.body;
-    // we can pull the DocuSign error code and message from the response body
-    const errorCode = errorBody && errorBody.errorCode;
-    const errorMessage = errorBody && errorBody.message;
-    // In production, may want to provide customized error messages and
-    // remediation advice to the user.
-    res.render('pages/error', { err: error, errorCode, errorMessage });
+    const errorCode = error?.response?.statusCode;
+    const errorMessage = error?.response?.body?.message;
+    let errorInfo;
+
+    // use custom error message if Maestro is not enabled for the account
+    if (errorCode === 403) {
+      errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
+    }
+
+    return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
   }
   if (results) {
     // which need an envelopeId
@@ -80,17 +83,45 @@ eg002CancelWorkflow.getController = async (req, res) => {
     return res.redirect(mustAuthenticate);
   }
 
+  let instanceOk = false;
+  if (req.session.workflowId && req.session.instanceId) {
+    const args = {
+      workflowId: req.session.workflowId,
+      instanceId: req.session.instanceId,
+      accessToken: req.user.accessToken,
+      basePath: dsConfig.maestroApiUrl,
+      accountId: req.session.accountId,
+    };
+
+    try {
+      const state = await getWorkflowInstanceState(args);
+      instanceOk = state.toLowerCase().includes('in progress');
+    } catch (error) {
+      const errorCode = error?.response?.statusCode;
+      const errorMessage = error?.response?.body?.message;
+      let errorInfo;
+
+      // use custom error message if Maestro is not enabled for the account
+      if (errorCode === 403) {
+        errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
+      }
+
+      return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
+    }
+  }
+
   const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
   const sourceFile =
     path.basename(__filename)[5].toLowerCase() +
     path.basename(__filename).substr(6);
   res.render('pages/maestro-examples/eg002CancelWorkflow', {
-    eg: eg,
+    eg,
     csrfToken: req.csrfToken(),
-    example: example,
+    example,
+    instanceOk,
     workflowId: req.session.workflowId,
     instanceId: req.session.instanceId,
-    sourceFile: sourceFile,
+    sourceFile,
     sourceUrl: dsConfig.githubExampleUrl + 'maestro/examples/' + sourceFile,
     documentation: dsConfig.documentation + eg,
     showDoc: dsConfig.documentation,

lib/maestro/controllers/eg003GetWorkflowStatus.js

@@ -40,21 +40,24 @@ eg002CancelWorkflow.createController = async (req, res) => {
     workflowId: req.session.workflowId,
     instanceId: req.session.instanceId,
     accessToken: req.user.accessToken,
-    basePath: dsConfig.maestroApiIrl,
+    basePath: dsConfig.maestroApiUrl,
     accountId: req.session.accountId,
   };
   let results = null;
 
   try {
     results = await getWorkflowInstance(args);
   } catch (error) {
-    const errorBody = error && error.response && error.response.body;
-    // we can pull the DocuSign error code and message from the response body
-    const errorCode = errorBody && errorBody.errorCode;
-    const errorMessage = errorBody && errorBody.message;
-    // In production, may want to provide customized error messages and
-    // remediation advice to the user.
-    res.render('pages/error', { err: error, errorCode, errorMessage });
+    const errorCode = error?.response?.statusCode;
+    const errorMessage = error?.response?.body?.message;
+    let errorInfo;
+
+    // use custom error message if Maestro is not enabled for the account
+    if (errorCode === 403) {
+      errorInfo = formatString(res.locals.manifest.SupportingTexts.ContactSupportToEnableFeature, 'Maestro');
+    }
+
+    return res.render('pages/error', { err: error, errorCode, errorMessage, errorInfo });
   }
   if (results) {
     // which need an envelopeId

lib/maestro/examples/cancelWorkflow.js

@@ -25,4 +25,20 @@ const cancelWorkflowInstance = async (args) => {
   return cancelResponse;
 };
 
-module.exports = { cancelWorkflowInstance };
+const getWorkflowInstanceState = async (args) => {
+  const dsApiClient = new docusign.ApiClient();
+  dsApiClient.setBasePath(args.basePath);
+  dsApiClient.addDefaultHeader('Authorization', `Bearer ${args.accessToken}`);
+
+  const workflowInstanceManagementApi = new docusign.WorkflowInstanceManagementApi(dsApiClient);
+  const workflowInstance =
+    await workflowInstanceManagementApi.getWorkflowInstance(
+      args.accountId,
+      args.workflowId,
+      args.instanceId
+    );
+
+  return workflowInstance.instanceState;
+};
+
+module.exports = { cancelWorkflowInstance, getWorkflowInstanceState };