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

Author: nianiB9

config/appsettings.example.json

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

demo_documents/web-form-config.json

@@ -56,7 +56,7 @@ const {
 } = require('./lib/admin/controllers');
 
 const { eg001connect } = require('./lib/connect/controllers');
-const { eg001webforms } = require('./lib/webforms/controllers');
+const { eg001webforms, eg002webforms } = require('./lib/webforms/controllers');
 const { eg004notary } = require('./lib/notary/controllers');
 const { eg001fields } = require('./lib/connectedFields/controllers');
 const { eg001Navigator, eg002Navigator } = require('./lib/navigator/controllers');
@@ -287,7 +287,11 @@ app.get('/cneg001', eg001connect.getController)
 app.get('/weg001', eg001webforms.getController)
   .get('/weg001webForm', eg001webforms.getWebFormCreateController)
   .post('/weg001', eg001webforms.createWebFormTemplate)
-  .post('/weg001webForm', eg001webforms.createWebFormInstance);
+  .post('/weg001webForm', eg001webforms.createWebFormInstance)
+  .get('/weg002', eg002webforms.getController)
+  .get('/weg002webForm', eg002webforms.getWebFormCreateController)
+  .post('/weg002', eg002webforms.createWebFormTemplate)
+  .post('/weg002webForm', eg002webforms.createWebFormInstance);
 
 app.get('/neg004', eg004notary.getController)
   .post('/neg004', eg004notary.createController);

index.js

@@ -0,0 +1,181 @@
+/**
+ * @file
+ * Example 002: Create a remote instance of a Web Form
+ * @author DocuSign
+ */
+
+const path = require('path');
+const validator = require('validator');
+const { API_TYPES, replaceTemplateId } = require('../../utils.js');
+const { getExampleByNumber } = require('../../manifestService');
+const dsConfig = require('../../../config/index.js').config;
+const { createWebFormInstance, createWebFormTemplate, listWebForms } = require('../examples/createRemoteInstance');
+
+const eg002CreateRemoteInstance = exports;
+const exampleNumber = 2;
+const eg = `weg00${exampleNumber}`; // This example reference.
+const api = API_TYPES.WEBFORMS;
+const mustAuthenticate = '/ds/mustAuthenticate';
+const minimumBufferMin = 3;
+const demoDocsPath = path.resolve(__dirname, '../../../demo_documents');
+const docFile = 'World_Wide_Corp_Web_Form.pdf';
+const webFormConfigFile = 'web-form-config.json';
+
+/**
+ * Create the web form template
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+eg002CreateRemoteInstance.createWebFormTemplate = 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: req.session.basePath,
+    accountId: req.session.accountId,
+    templateName: 'Web Form Example Template',
+    docFile: path.resolve(demoDocsPath, docFile),
+  };
+  let webFormTemplateId = null;
+
+  try {
+    webFormTemplateId = await createWebFormTemplate(args);
+    replaceTemplateId(path.resolve(demoDocsPath, webFormConfigFile), webFormTemplateId);
+  } 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.
+    return res.render('pages/error', { err: error, errorCode, errorMessage });
+  }
+  if (webFormTemplateId) {
+    req.session.webFormTemplateId = webFormTemplateId;
+    return res.redirect(`/${eg}webForm`);
+  }
+};
+
+/**
+ * Create the web form instance
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+eg002CreateRemoteInstance.createWebFormInstance = 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.webformsApiUrl,
+    accountId: req.session.accountId,
+    signerEmail: validator.escape(dsConfig.signerEmail),
+    signerName: validator.escape(dsConfig.signerName),
+    formName: 'Web Form Example Template',
+  };
+  let results = null;
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+
+  try {
+    const forms = await listWebForms(args);
+
+    if (!forms.items || forms.items.length === 0) {
+      const errorCode = '404';
+      const errorMessage = 'No Web Forms found';
+      const errorInfo = example.CustomErrorTexts[0].ErrorMessage;
+      return res.render('pages/error', { errorCode, errorMessage, errorInfo });
+    }
+
+    results = await createWebFormInstance(forms.items[0].id, args);
+  } catch (error) {
+    const errorBody = error?.response?.body || error?.body;
+    const errorCode = errorBody?.errorCode || errorBody?.status;
+    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 });
+  }
+  if (results) {
+    res.render('pages/example_done', {
+      title: example.ExampleName,
+      message: formatString(example.ResultsPageText, results.envelopes[0].id, results.id),
+    });
+  }
+};
+
+/**
+ * Form page for this application
+ */
+eg002CreateRemoteInstance.getController = (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);
+  return res.render('pages/webforms-examples/eg002CreateRemoteInstance', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    example: example,
+    sourceFile: sourceFile,
+    sourceUrl: dsConfig.githubExampleUrl + 'webforms/examples/' + sourceFile,
+    documentation: dsConfig.documentation + eg,
+    showDoc: dsConfig.documentation,
+  });
+};
+
+/**
+ * Form page for this application
+ */
+eg002CreateRemoteInstance.getWebFormCreateController = (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);
+  }
+
+  if (!req.session.webFormTemplateId) {
+    return res.redirect(`/${eg}`);
+  }
+
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+  const additionalPageData = example.AdditionalPage.find(p => p.Name === 'create_web_form');
+  return res.render('pages/webforms-examples/eg002WebFormCreate', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    title: example.ExampleName,
+    description: formatString(additionalPageData.ResultsPageText, 'demo_documents'),
+    example: example,
+  });
+};

lib/webforms/controllers/eg002CreateRemoteInstance.js

@@ -1 +1,2 @@
-module.exports.eg001webforms = require('./eg001CreateInstance');
+module.exports.eg001webforms = require('./eg001CreateInstance');
+module.exports.eg002webforms = require('./eg002CreateRemoteInstance');