multi tab support

Author: RomanBachaloSigmaSoftware

lib/connectedFields/controllers/eg001SetConnectedFields.js

@@ -40,12 +40,13 @@ eg001SetConnectedFields.createController = async (req, res) => {
   // Step 2. Call the worker method
   const { body } = req;
   const selectedAppId = validator.escape(body.appId);
-  const verificationData = extractVerificationData(selectedAppId, req.session.apps);
+  const selectedApp = req.session.apps.filter(app => app.appId === selectedAppId)[0];
   const envelopeArgs = {
     signerEmail: validator.escape(body.signerEmail),
     signerName: validator.escape(body.signerName),
     docFile: path.resolve(demoDocsPath, pdfFile),
-    verificationData
+    appId: selectedAppId,
+    app: selectedApp,
   };
   const args = {
     accessToken: req.user.accessToken,

lib/connectedFields/examples/setConnectedFields.js

@@ -26,8 +26,15 @@ const getTabGroups = async (args) => {
   const response = await axios.get(url, { headers });
   const responseData = response.data;
 
+  const filteredApps = responseData.filter(app =>
+    app.tabs?.some(tab =>
+      (tab.extensionData?.actionContract?.includes('Verify')) ||
+      (tab.tabLabel?.includes('connecteddata'))
+    )
+  );
+
   let uniqueApps = [];
-  if (responseData && responseData.length > 0) {
+  if (filteredApps.length > 0) {
     uniqueApps = [...new Map(responseData.map(item => [item.appId, item])).values()];
   }
   //ds-snippet-end:ConnectedFields1Step3
@@ -71,31 +78,27 @@ const sendEnvelope = async (args) => {
 /**
  * This function gets the verification data for selected extension app
  * @param {string} selectedAppId the GUID of selected extension app
- * @param {array} apps the list of extension apps
+ * @param {array} tab the extension tab
  * @returns {Object} Verification data
  */
 //ds-snippet-start:ConnectedFields1Step4
-const extractVerificationData = (selectedAppId, apps) => {
-  const selectedApp = apps.filter(app => app.appId === selectedAppId)[0];
+const extractVerificationData = (selectedAppId, tab) => {
+  const extensionData = tab.extensionData;
 
   return {
-    appId: selectedApp.appId,
-    extensionGroupId: selectedApp.tabs[0].extensionData.extensionGroupId,
-    publisherName: selectedApp.tabs[0].extensionData.publisherName,
-    applicationName: selectedApp.tabs[0].extensionData.applicationName,
-    actionName: selectedApp.tabs[0].extensionData.actionName,
-    actionInputKey: selectedApp.tabs[0].extensionData.actionInputKey,
-    actionContract: selectedApp.tabs[0].extensionData.actionContract,
-    extensionName: selectedApp.tabs[0].extensionData.extensionName,
-    extensionContract: selectedApp.tabs[0].extensionData.extensionContract,
-    requiredForExtension: selectedApp.tabs[0].extensionData.requiredForExtension,
-    tabLabel: selectedApp.tabs.map((tab) => tab.tabLabel).join(', '),
-    connectionKey: selectedApp.tabs[0].extensionData.connectionInstances
-      ? selectedApp.tabs[0].extensionData.connectionInstances[0].connectionKey
-      : '',
-    connectionValue: selectedApp.tabs[0].extensionData.connectionInstances
-      ? selectedApp.tabs[0].extensionData.connectionInstances[0].connectionValue
-      : '',
+    appId: selectedAppId,
+    extensionGroupId: extensionData.extensionGroupId,
+    publisherName: extensionData.publisherName,
+    applicationName: extensionData.applicationName,
+    actionName: extensionData.actionName,
+    actionInputKey: extensionData.actionInputKey,
+    actionContract: extensionData.actionContract,
+    extensionName: extensionData.extensionName,
+    extensionContract: extensionData.extensionContract,
+    requiredForExtension: extensionData.requiredForExtension,
+    tabLabel: tab.tabLabel,
+    connectionKey: extensionData.connectionInstances ? extensionData.connectionInstances[0].connectionKey : '',
+    connectionValue: extensionData.connectionInstances ? extensionData.connectionInstances[0].connectionValue : '',
   };
 };
 //ds-snippet-end:ConnectedFields1Step4
@@ -121,15 +124,14 @@ function makeEnvelope(args) {
   // The envelope has one recipients.
   // recipient 1 - signer
 
-  let docPdfBytes;
-  // read file from a local directory
-  // The read could raise an exception if the file is not available!
-  docPdfBytes = fs.readFileSync(args.docFile);
-
   // create the envelope definition
   let env = new docusign.EnvelopeDefinition();
   env.emailSubject = 'Please sign this document';
 
+  // read file from a local directory
+  // The read could raise an exception if the file is not available!
+  const docPdfBytes = fs.readFileSync(args.docFile);
+
   // add the documents
   let doc = new docusign.Document();
   let docb64 = Buffer.from(docPdfBytes).toString('base64');
@@ -142,77 +144,42 @@ function makeEnvelope(args) {
   env.documents = [doc];
 
   // Create a signer recipient to sign the document, identified by name and email
-  let signer = docusign.Signer.constructFromObject({
-    email: args.signerEmail,
-    name: args.signerName,
-    recipientId: 1,
-  });
+  let signer = new docusign.Signer();
+  signer.email = args.signerEmail;
+  signer.name = args.signerName;
+  signer.recipientId = '1';
+  signer.routingOrder = '1';
 
   // Create signHere fields (also known as tabs) on the documents,
   // We're using anchor (autoPlace) positioning
   //
   // The DocuSign platform seaches throughout your envelope's
   // documents for matching anchor strings.
-  let signHere = docusign.SignHere.constructFromObject({
-    anchorString: '/sn1/',
-    anchorYOffset: '10',
-    anchorUnits: 'pixels',
-    anchorXOffset: '20',
-  });
+  let signHere = new docusign.SignHere();
+  signHere.anchorString = '/sn1/';
+  signHere.anchorYOffset = '10';
+  signHere.anchorUnits = 'pixels';
+  signHere.anchorXOffset = '20';
+
+  let textTabs = [];
+  for (const tab of args.app.tabs.filter(t => !t.tabLabel.includes('SuggestionInput'))) {
+    const verificationData = extractVerificationData(args.appId, tab);
+    const textTab = makeTextTab(verificationData, textTabs.length);
+
+    textTabs.push(textTab);
+  }
 
-  const extensionData = {
-    extensionGroupId: args.verificationData.extensionGroupId,
-    publisherName: args.verificationData.publisherName,
-    applicationId: args.verificationData.appId,
-    applicationName: args.verificationData.applicationName,
-    actionName: args.verificationData.actionName,
-    actionContract: args.verificationData.actionContract,
-    extensionName: args.verificationData.extensionName,
-    extensionContract: args.verificationData.extensionContract,
-    requiredForExtension: args.verificationData.requiredForExtension,
-    actionInputKey: args.verificationData.actionInputKey,
-    extensionPolicy: 'None',
-    connectionInstances: [
-      {
-        connectionKey: args.verificationData.connectionKey,
-        connectionValue: args.verificationData.connectionValue,
-      }
-    ]
-  };
-  let textTab = docusign.Text.constructFromObject({
-    requireInitialOnSharedChange: false,
-    requireAll: false,
-    name: args.verificationData.applicationName,
-    required: true,
-    locked: false,
-    disableAutoSize: false,
-    maxLength: 4000,
-    tabLabel: args.verificationData.tabLabel,
-    font: 'lucidaconsole',
-    fontColor: 'black',
-    fontSize: 'size9',
-    documentId: '1',
-    recipientId: '1',
-    pageNumber: '1',
-    xPosition: '273',
-    yPosition: '191',
-    width: '84',
-    height: '22',
-    templateRequired: false,
-    tabType: 'text',
-  });
   // Tabs are set per recipient / signer
-  let signerTabs = docusign.Tabs.constructFromObject({
-    signHereTabs: [signHere],
-    textTabs: [textTab]
-  });
+  let signerTabs = new docusign.Tabs();
+  signerTabs.signHereTabs = [signHere];
+  signerTabs.textTabs = textTabs;
+
   signer.tabs = signerTabs;
 
   // Add the recipient to the envelope object
-  let recipients = docusign.Recipients.constructFromObject({
-    signers: [signer],
-  });
-  recipients.signers[0].tabs.textTabs[0].extensionData = extensionData;
+  let recipients = new docusign.Recipients();
+  recipients.signers = [signer];
+
   env.recipients = recipients;
 
   // Request that the envelope be sent by setting |status| to "sent".
@@ -221,6 +188,51 @@ function makeEnvelope(args) {
 
   return env;
 }
+
+const getExtensionData = (verificationData) => ({
+  extensionGroupId: verificationData.extensionGroupId,
+  publisherName: verificationData.publisherName,
+  applicationId: verificationData.appId,
+  applicationName: verificationData.applicationName,
+  actionName: verificationData.actionName,
+  actionContract: verificationData.actionContract,
+  extensionName: verificationData.extensionName,
+  extensionContract: verificationData.extensionContract,
+  requiredForExtension: verificationData.requiredForExtension,
+  actionInputKey: verificationData.actionInputKey,
+  extensionPolicy: 'MustVerifyToSign',
+  connectionInstances: [
+    {
+      connectionKey: verificationData.connectionKey,
+      connectionValue: verificationData.connectionValue,
+    },
+  ],
+});
+
+const makeTextTab = (verificationData, textTabsCount) => ({
+  requireInitialOnSharedChange: false,
+  requireAll: false,
+  name: verificationData.applicationName,
+  required: true,
+  locked: false,
+  disableAutoSize: false,
+  maxLength: 4000,
+  tabLabel: verificationData.tabLabel,
+  font: 'lucidaconsole',
+  fontColor: 'black',
+  fontSize: 'size9',
+  documentId: '1',
+  recipientId: '1',
+  pageNumber: '1',
+  xPosition: `${70 + 100 * Math.floor(textTabsCount / 10)}`,
+  yPosition: `${560 + 20 * (textTabsCount % 10)}`,
+  width: '84',
+  height: '22',
+  templateRequired: false,
+  tabType: 'text',
+  tooltip: verificationData.actionInputKey,
+  extensionData: getExtensionData(verificationData)
+});
 //ds-snippet-end:ConnectedFields1Step5
 
 module.exports = { getTabGroups, sendEnvelope, extractVerificationData };