Merge branch 'master' of https://github.com/docusign/code-examples-node-private

Author: Raileen Del Rosario

config/appsettings.example.json

@@ -30,5 +30,6 @@
   "adminAPIUrl": "https://api-d.docusign.net/management",
   "monitorApiUrl": "https://lens-d.docusign.net",
   "webformsApiUrl": "https://apps-d.docusign.com/api/webforms/v1.1",
+  "iamBasePath": "https://api-d.docusign.com/v1",
   "codeExamplesManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/CodeExamplesManifest.json"
 }

index.js

@@ -59,6 +59,7 @@ const { eg001connect } = require('./lib/connect/controllers');
 const { eg001webforms } = require('./lib/webforms/controllers');
 const { eg004notary } = require('./lib/notary/controllers');
 const { eg001fields } = require('./lib/connectedFields/controllers');
+const { eg001Navigator, eg002Navigator } = require('./lib/navigator/controllers');
 
 const PORT = process.env.PORT || 3000;
 const HOST = process.env.HOST || 'localhost';
@@ -293,6 +294,10 @@ app.get('/neg004', eg004notary.getController)
 app.get('/feg001', eg001fields.getController)
   .post('/feg001', eg001fields.createController);
 
+app.get('/nav001', eg001Navigator.getController)
+  .post('/nav001', eg001Navigator.createController)
+  .get('/nav002', eg002Navigator.getController)
+  .post('/nav002', eg002Navigator.createController);
 
 function dsLoginCB1(req, res, next) { req.dsAuthCodeGrant.oauth_callback1(req, res, next); }
 function dsLoginCB2(req, res, next) { req.dsAuthCodeGrant.oauth_callback2(req, res, next); }

lib/connectedFields/controllers/eg001SetConnectedFields.js

@@ -5,7 +5,7 @@
  */
 
 const path = require('path');
-const { getTabGroups, sendEnvelope, extractVerificationData } = require('../examples/setConnectedFields');
+const { getTabGroups, sendEnvelope, filterData } = require('../examples/setConnectedFields');
 const validator = require('validator');
 const { getExampleByNumber } = require('../../manifestService');
 const dsConfig = require('../../../config/index.js').config;
@@ -94,10 +94,11 @@ eg001SetConnectedFields.createController = async (req, res) => {
 
   const args = {
     accessToken: req.user.accessToken,
-    basePath: 'https://api-d.docusign.com',
+    basePath: dsConfig.iamBasePath,
     accountId: req.session.accountId,
   };
-  const tabGroups = await getTabGroups(args);
+  let tabGroups = await getTabGroups(args);
+  tabGroups = filterData(tabGroups);
 
   const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
   if (tabGroups.length === 0) {

lib/connectedFields/examples/setConnectedFields.js

@@ -4,43 +4,31 @@
  * @author DocuSign
  */
 
-const axios = require('axios');
 const fs = require('fs-extra');
 const docusign = require('docusign-esign');
+const iam = require('@docusign/iam-sdk');
 
 /**
  * This function does the work of retrieving the tab groups
  * @param {object} args
  */
+//ds-snippet-start:ConnectedFields1Step2
 const getTabGroups = async (args) => {
-  //ds-snippet-start:ConnectedFields1Step2
-  const headers = {
-    Authorization: 'Bearer ' + args.accessToken,
-    Accept: 'application/json',
-    'Content-Type': 'application/json',
-  };
-  //ds-snippet-end:ConnectedFields1Step2
-
-  //ds-snippet-start:ConnectedFields1Step3
-  const url = `${args.basePath}/v1/accounts/${args.accountId}/connected-fields/tab-groups`;
-  const response = await axios.get(url, { headers });
-  const responseData = response.data;
+  const client = new iam.IamClient({ accessToken: args.accessToken, serverURL: args.basePath });
+  return await client.connectedFields.tabInfo.getConnectedFieldsTabGroups({ accountId: args.accountId });
+};
+//ds-snippet-end:ConnectedFields1Step2
 
-  const filteredApps = responseData.filter(app =>
+//ds-snippet-start:ConnectedFields1Step3
+const filterData = (connectedFields) => {
+  return connectedFields.filter(app =>
     app.tabs?.some(tab =>
       (tab.extensionData?.actionContract?.includes('Verify')) ||
       (tab.tabLabel?.includes('connecteddata'))
     )
   );
-
-  let uniqueApps = [];
-  if (filteredApps.length > 0) {
-    uniqueApps = [...new Map(responseData.map(item => [item.appId, item])).values()];
-  }
-  //ds-snippet-end:ConnectedFields1Step3
-
-  return uniqueApps;
 };
+//ds-snippet-end:ConnectedFields1Step3
 
 /**
  * This function does the work of creating the envelope
@@ -58,11 +46,8 @@ const sendEnvelope = async (args) => {
   dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
   let envelopesApi = new docusign.EnvelopesApi(dsApiClient);
 
-  // Step 1. Make the envelope request body
   const envelope = makeEnvelope(args.envelopeArgs);
 
-  // Step 2. call Envelopes::create API method
-  // Exceptions will be caught by the calling function
   const results = await envelopesApi.createEnvelope(args.accountId, {
     envelopeDefinition: envelope,
   });
@@ -234,4 +219,4 @@ const makeTextTab = (verificationData, textTabsCount) => ({
 });
 //ds-snippet-end:ConnectedFields1Step5
 
-module.exports = { getTabGroups, sendEnvelope, extractVerificationData };
+module.exports = { getTabGroups, filterData, sendEnvelope, extractVerificationData };

lib/navigator/controllers/eg001ListAgreements.js

@@ -0,0 +1,93 @@
+/**
+ * @file
+ * Example 001: List agreements
+ * @author DocuSign
+ */
+
+const path = require('path');
+const { listAgreements } = require('../examples/listAgreements');
+const { getExampleByNumber } = require('../../manifestService');
+const dsConfig = require('../../../config/index.js').config;
+const { API_TYPES } = require('../../utils.js');
+
+const eg001ListAgreements = exports;
+const exampleNumber = 1;
+const eg = `nav00${exampleNumber}`; // This example reference.
+const api = API_TYPES.NAVIGATOR;
+const mustAuthenticate = '/ds/mustAuthenticate';
+const minimumBufferMin = 3;
+
+/**
+ * Get the list of agreements
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+eg001ListAgreements.createController = async (req, res) => {
+  // Step 1. Check the token
+  // At this point we should have a good token. But we
+  // double-check here to enable a better UX to the user.
+  const isTokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!isTokenOK) {
+    req.flash('info', 'Sorry, you need to re-authenticate.');
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    return res.redirect(mustAuthenticate);
+  }
+
+  // Step 2. Call the worker method
+  const args = {
+    accessToken: req.user.accessToken,
+    basePath: dsConfig.iamBasePath,
+    accountId: req.session.accountId,
+  };
+
+  let results = null;
+  try {
+    results = await listAgreements(args);
+  } catch (error) {
+    const errorBody = error?.body || error?.response?.body;
+    // we can pull the DocuSign error code and message from the response body
+    const errorCode = errorBody?.errorCode;
+    const errorMessage = 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 });
+  }
+  if (results) {
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+    res.render('pages/example_done', {
+      title: example.ExampleName,
+      message: example.ResultsPageText,
+      json: JSON.stringify(results).replace(/'/g, ''),
+    });
+  }
+};
+
+/**
+  * Form page for this application
+  */
+eg001ListAgreements.getController = 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 sourceFile =
+    path.basename(__filename)[5].toLowerCase() +
+    path.basename(__filename).substr(6);
+  res.render('pages/navigator-examples/eg001ListAgreements', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    example: example,
+    sourceFile: sourceFile,
+    sourceUrl: dsConfig.githubExampleUrl + 'navigator/examples/' + sourceFile,
+    documentation: dsConfig.documentation + eg,
+    showDoc: dsConfig.documentation
+  });
+};

lib/navigator/controllers/eg002GetSingleAgreement.js

@@ -0,0 +1,116 @@
+/**
+ * @file
+ * Example 002: Get single agreement
+ * @author DocuSign
+ */
+
+const path = require('path');
+const { listAgreements, getAgreement } = require('../examples/getSingleAgreement');
+const validator = require('validator');
+const { getExampleByNumber } = require('../../manifestService');
+const dsConfig = require('../../../config/index.js').config;
+const { API_TYPES } = require('../../utils.js');
+
+const eg002GetSingleAgreement = exports;
+const exampleNumber = 2;
+const eg = `nav00${exampleNumber}`; // This example reference.
+const api = API_TYPES.NAVIGATOR;
+const mustAuthenticate = '/ds/mustAuthenticate';
+const minimumBufferMin = 3;
+
+/**
+ * Get a single agreement
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+eg002GetSingleAgreement.createController = async (req, res) => {
+  // Step 1. Check the token
+  // At this point we should have a good token. But we
+  // double-check here to enable a better UX to the user.
+  const isTokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!isTokenOK) {
+    req.flash('info', 'Sorry, you need to re-authenticate.');
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    return res.redirect(mustAuthenticate);
+  }
+
+  // Step 2. Call the worker method
+  const { body } = req;
+  const args = {
+    accessToken: req.user.accessToken,
+    basePath: dsConfig.iamBasePath,
+    accountId: req.session.accountId,
+    agreementId: validator.escape(body.agreementId),
+  };
+
+  let results = null;
+  try {
+    results = await getAgreement(args);
+  } catch (error) {
+    const errorBody = error?.body || error?.response?.body;
+    // we can pull the DocuSign error code and message from the response body
+    const errorCode = errorBody?.errorCode;
+    const errorMessage = 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 });
+  }
+  if (results) {
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+    res.render('pages/example_done', {
+      title: example.ExampleName,
+      message: example.ResultsPageText,
+      json: JSON.stringify(results).replace(/'/g, ''),
+    });
+  }
+};
+
+/**
+  * Form page for this application
+  */
+eg002GetSingleAgreement.getController = 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 args = {
+    accessToken: req.user.accessToken,
+    basePath: dsConfig.iamBasePath,
+    accountId: req.session.accountId,
+  };
+
+  let agreements = null;
+  try {
+    agreements = await listAgreements(args);
+  } catch (error) {
+    const errorBody = error?.body || error?.response?.body;
+    // we can pull the DocuSign error code and message from the response body
+    const errorCode = errorBody?.errorCode;
+    const errorMessage = errorBody?.message;
+    // In production, may want to provide customized error messages and
+    // remediation advice to the user.
+    return res.render('pages/error', { err: error, errorCode, errorMessage });
+  }
+
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+  const sourceFile =
+    path.basename(__filename)[5].toLowerCase() +
+    path.basename(__filename).substr(6);
+  res.render('pages/navigator-examples/eg002GetSingleAgreement', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    example: example,
+    sourceFile: sourceFile,
+    sourceUrl: dsConfig.githubExampleUrl + 'navigator/examples/' + sourceFile,
+    documentation: dsConfig.documentation + eg,
+    showDoc: dsConfig.documentation,
+    agreements: agreements,
+  });
+};

lib/navigator/controllers/index.js

@@ -0,0 +1,2 @@
+module.exports.eg001Navigator = require('./eg001ListAgreements');
+module.exports.eg002Navigator = require('./eg002GetSingleAgreement');

lib/navigator/examples/getSingleAgreement.js

@@ -0,0 +1,23 @@
+/**
+ * @file
+ * Example 002: Get a single agreement
+ * @author DocuSign
+ */
+
+const iam = require('@docusign/iam-sdk');
+
+const listAgreements = async (args) => {
+//ds-snippet-start:Navigator2Step2
+  const client = new iam.IamClient({ accessToken: args.accessToken, serverURL: args.basePath });
+//ds-snippet-end:Navigator2Step2
+  return await client.navigator.agreements.getAgreementsList({ accountId: args.accountId });
+};
+
+//ds-snippet-start:Navigator2Step3
+const getAgreement = async (args) => {
+  const client = new iam.IamClient({ accessToken: args.accessToken, serverURL: args.basePath });
+  return await client.navigator.agreements.getAgreement({ accountId: args.accountId, agreementId: args.agreementId });
+};
+
+module.exports = { listAgreements, getAgreement };
+//ds-snippet-end:Navigator2Step3

lib/navigator/examples/listAgreements.js

@@ -0,0 +1,18 @@
+/**
+ * @file
+ * Example 001: List agreements
+ * @author DocuSign
+ */
+
+const iam = require('@docusign/iam-sdk');
+
+const listAgreements = async (args) => {
+//ds-snippet-start:Navigator1Step2
+  const client = new iam.IamClient({ accessToken: args.accessToken, serverURL: args.basePath });
+//ds-snippet-end:Navigator1Step2
+//ds-snippet-start:Navigator1Step3
+  return await client.navigator.agreements.getAgreementsList({ accountId: args.accountId });
+};
+
+module.exports = { listAgreements };
+//ds-snippet-end:Navigator1Step3

lib/utils.js

@@ -23,7 +23,8 @@ const API_TYPES = {
   CONNECT: 'Connect',
   WEBFORMS: 'WebForms',
   NOTARY: 'Notary',
-  CONNECTED_FIELDS: 'ConnectedFields'
+  CONNECTED_FIELDS: 'ConnectedFields',
+  NAVIGATOR: 'Navigator',
 };
 
 async function isCFR(accessToken, accountId, basePath) {