added code analyzer, fixed code style issues

Author: RomanBachaloSigmaSoftware

.eslintignore

@@ -0,0 +1,4 @@
+config/*
+public/*
+node_modules/*
+test/*

.eslintrc.json

@@ -0,0 +1,90 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+        "arrow-spacing": [1, { "before": true, "after": true }],
+        "block-spacing": [1, "always"],
+        "brace-style": [1, "1tbs", { "allowSingleLine": true }],
+        "comma-spacing": [1, { "before": false, "after": true }],
+        "comma-style": [1, "last"],
+        "dot-location": [1, "property"],
+        "eol-last": 1,
+        "eqeqeq": [1, "always", {"null": "ignore"}],
+        "key-spacing": [1, { "beforeColon": false, "afterColon": true }],
+        "no-cond-assign": 1,
+        "no-const-assign": 1,
+        "no-debugger": 1,
+        "no-delete-var": 1,
+        "no-dupe-args": 1,
+        "no-dupe-class-members": 1,
+        "no-dupe-keys": 1,
+        "no-duplicate-case": 1,
+        "no-empty-character-class": 1,
+        "no-labels": 1,
+        "no-ex-assign": 1,
+        "no-extra-boolean-cast": 1,
+        "no-extra-parens": [1, "functions"],
+        "no-fallthrough": 1,
+        "no-floating-decimal": 1,
+        "no-func-assign": 1,
+        "no-implied-eval": 1,
+        "no-inner-declarations": [1, "functions"],
+        "no-invalid-regexp": 1,
+        "no-irregular-whitespace": 1,
+        "no-label-var": 1,
+        "no-lone-blocks": 1,
+        "no-mixed-spaces-and-tabs": 1,
+        "no-multi-spaces": 1,
+        "no-multi-str": 1,
+        "no-multiple-empty-lines": [1, { "max": 2 }],
+        "no-native-reassign": 1,
+        "no-negated-in-lhs": 1,
+        "no-new": 1,
+        "no-new-func": 1,
+        "no-new-require": 1,
+        "no-new-wrappers": 1,
+        "no-obj-calls": 1,
+        "no-octal": 1,
+        "no-octal-escape": 1,
+        "no-return-assign": 1,
+        "no-self-compare": 1,
+        "no-sequences": 1,
+        "no-shadow-restricted-names": 1,
+        "no-spaced-func": 1,
+        "no-sparse-arrays": 1,
+        "no-throw-literal": 1,
+        "no-trailing-spaces": 1,
+        "no-undef-init": 1,
+        "no-unexpected-multiline": 1,
+        "no-unneeded-ternary": [1, { "defaultAssignment": false }],
+        "no-unreachable": 1,
+        "no-useless-call": 1,
+        "no-with": 1,
+        "one-var": [1, { "initialized": "never" }],        
+        "quotes": [1, "single", "avoid-escape"],
+        "quote-props": [1, "as-needed"],
+        "semi": [1, "always"],
+        "semi-spacing": [1, { "before": false, "after": false }],
+        "keyword-spacing": [1, { "before": true, "after": true }],
+        "space-before-function-paren": [1, {
+            "anonymous": "never",
+            "named": "never",
+            "asyncArrow": "always"
+        }],
+        "space-in-parens": [1, "never"],
+        "space-infix-ops": 1,
+        "space-unary-ops": [1, { "words": true, "nonwords": false }],
+        "spaced-comment": [1, "always", {
+            "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ",", "#region", "TODO:", "/"]
+         }],
+        "yoda": [1, "never"]
+    }
+}

embeddedSigning.js

@@ -4,8 +4,8 @@
  * @author DocuSign
  */
 
-const fs = require("fs-extra");
-const docusign = require("docusign-esign");
+const fs = require('fs-extra');
+const docusign = require('docusign-esign');
 
 /**
  * This function does the work of creating the envelope and the
@@ -20,9 +20,9 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
 
   let dsApiClient = new docusign.ApiClient();
   dsApiClient.setBasePath(args.basePath);
-  dsApiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
-  let envelopesApi = new docusign.EnvelopesApi(dsApiClient),
-    results = null;
+  dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
+  let envelopesApi = new docusign.EnvelopesApi(dsApiClient);
+  let results = null;
 
   // Step 1. Make the envelope request body
   let envelope = makeEnvelope(args.envelopeArgs);
@@ -59,7 +59,7 @@ function makeEnvelope(args) {
   // args.signerEmail
   // args.signerName
   // args.signerClientId
-  // docFile 
+  // docFile
 
   // document 1 (pdf) has tag /sn1/
   //
@@ -73,15 +73,15 @@ function makeEnvelope(args) {
 
   // create the envelope definition
   let env = new docusign.EnvelopeDefinition();
-  env.emailSubject = "Please sign this document";
+  env.emailSubject = 'Please sign this document';
 
   // add the documents
-  let doc1 = new docusign.Document(),
-    doc1b64 = Buffer.from(docPdfBytes).toString("base64");
+  let doc1 = new docusign.Document();
+  let doc1b64 = Buffer.from(docPdfBytes).toString('base64');
   doc1.documentBase64 = doc1b64;
-  doc1.name = "Lorem Ipsum"; // can be different from actual file name
-  doc1.fileExtension = "pdf";
-  doc1.documentId = "3";
+  doc1.name = 'Lorem Ipsum'; // can be different from actual file name
+  doc1.fileExtension = 'pdf';
+  doc1.documentId = '3';
 
   // The order in the docs array determines the order in the envelope
   env.documents = [doc1];
@@ -102,10 +102,10 @@ function makeEnvelope(args) {
   // The DocuSign platform seaches throughout your envelope's
   // documents for matching anchor strings.
   let signHere1 = docusign.SignHere.constructFromObject({
-    anchorString: "/sn1/",
-    anchorYOffset: "10",
-    anchorUnits: "pixels",
-    anchorXOffset: "20",
+    anchorString: '/sn1/',
+    anchorYOffset: '10',
+    anchorUnits: 'pixels',
+    anchorXOffset: '20',
   });
   // Tabs are set per recipient / signer
   let signer1Tabs = docusign.Tabs.constructFromObject({
@@ -121,7 +121,7 @@ function makeEnvelope(args) {
 
   // Request that the envelope be sent by setting |status| to "sent".
   // To request that the envelope be created as a draft, set to "created"
-  env.status = "sent";
+  env.status = 'sent';
 
   return env;
 }
@@ -143,12 +143,12 @@ function makeRecipientViewRequest(args) {
   // the DocuSign signing. It's usually better to use
   // the session mechanism of your web framework. Query parameters
   // can be changed/spoofed very easily.
-  viewRequest.returnUrl = args.dsReturnUrl + "?state=123";
+  viewRequest.returnUrl = args.dsReturnUrl + '?state=123';
 
   // How has your app authenticated the user? In addition to your app's
   // authentication, you can include authenticate steps from DocuSign.
   // Eg, SMS authentication
-  viewRequest.authenticationMethod = "none";
+  viewRequest.authenticationMethod = 'none';
 
   // Recipient information must match embedded recipient info
   // we used to create the envelope.

index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const express = require('express');
-const session = require('express-session');  // https://github.com/expressjs/session
+const session = require('express-session'); // https://github.com/expressjs/session
 const bodyParser = require('body-parser');
 const cookieParser = require('cookie-parser');
 const MemoryStore = require('memorystore')(session); // https://github.com/roccomuso/memorystore
@@ -19,7 +19,7 @@ const helmet = require('helmet'); // https://expressjs.com/en/advanced/best-prac
 const moment = require('moment');
 const csrf = require('csurf'); // https://www.npmjs.com/package/csurf
 const examplesApi = require('./config/examplesAPI.json');
-const { getManifest } = require('./lib/manifestService')
+const { getManifest } = require('./lib/manifestService');
 
 const eg001 = require('./lib/eSignature/controllers/eg001EmbeddedSigning');
 
@@ -30,36 +30,36 @@ const {
   eg024, eg025, eg026, eg027, eg028, eg029, eg030,
   eg031, eg032, eg033, eg034, eg035, eg036, eg037,
   eg038, eg039, eg040
-} = require("./lib/eSignature/controllers");
+} = require('./lib/eSignature/controllers');
 
 const {
   eg001click, eg002click, eg003click,
   eg004click, eg005click,
-} = require("./lib/click/controllers");
+} = require('./lib/click/controllers');
 
 const {
   eg001rooms, eg002rooms, eg003rooms,
   eg004rooms, eg005rooms, eg006rooms,
   eg007rooms, eg008rooms, eg009rooms,
-} = require("./lib/rooms/controllers");
+} = require('./lib/rooms/controllers');
 
 const {
   eg001monitor, eg002monitor
-} = require("./lib/monitor/controllers/index");
+} = require('./lib/monitor/controllers/index');
 
 const {
   eg001admin, eg002admin, eg003admin,
   eg004admin, eg005admin, eg006admin,
   eg007admin, eg008admin, eg009admin
-} = require("./lib/admin/controllers");
+} = require('./lib/admin/controllers');
 
 const PORT = process.env.PORT || 3000;
 const HOST = process.env.HOST || 'localhost';
 const max_session_min = 180;
 const csrfProtection = csrf({ cookie: true });
 
-let hostUrl = 'http://' + HOST + ':' + PORT
-if (dsConfig.appUrl != '' && dsConfig.appUrl != '{APP_URL}') { hostUrl = dsConfig.appUrl }
+let hostUrl = 'http://' + HOST + ':' + PORT;
+if (dsConfig.appUrl !== '' && dsConfig.appUrl !== '{APP_URL}') { hostUrl = dsConfig.appUrl; }
 
 let app = express()
   .use(helmet())
@@ -78,14 +78,14 @@ let app = express()
   .use(passport.initialize())
   .use(passport.session())
   .use(bodyParser.urlencoded({ extended: true }))
-  .use(((req, res, next) => {
+  .use((req, res, next) => {
     res.locals.user = req.user;
     res.locals.session = req.session;
     res.locals.dsConfig = { ...dsConfig, docOptions: docOptions, docNames: docNames };
-    res.locals.examplesApi = examplesApi
+    res.locals.examplesApi = examplesApi;
     res.locals.hostUrl = hostUrl; // Used by DSAuthCodeGrant#logout
-    next()
-  })) // Send user info to views
+    next();
+  }) // Send user info to views
   .use(flash())
   .set('views', path.join(__dirname, 'views'))
   .set('view engine', 'ejs')
@@ -97,12 +97,12 @@ let app = express()
     if (req.session.authMethod === 'jwt-auth') {
       req.dsAuth = req.dsAuthJwt;
     }
-    next()
+    next();
   })
   .use(async (req, res, next) => {
     let manifestUrl;
 
-    switch(true) {
+    switch (true) {
       case examplesApi.examplesApi.isRoomsApi:
         manifestUrl = dsConfig.roomsManifestUrl;
         break;
@@ -158,7 +158,7 @@ if (examplesApi.examplesApi.isRoomsApi) {
     .get('/eg008', eg008rooms.getController)
     .post('/eg008', eg008rooms.createController)
     .get('/eg009', eg009rooms.getController)
-    .post('/eg009', eg009rooms.createController)
+    .post('/eg009', eg009rooms.createController);
 } else if (examplesApi.examplesApi.isClickApi) {
   app.get('/eg001', eg001click.getController)
     .post('/eg001', eg001click.createController)
@@ -169,12 +169,12 @@ if (examplesApi.examplesApi.isRoomsApi) {
     .get('/eg004', eg004click.getController)
     .post('/eg004', eg004click.createController)
     .get('/eg005', eg005click.getController)
-    .post('/eg005', eg005click.createController)
+    .post('/eg005', eg005click.createController);
 } else if (examplesApi.examplesApi.isMonitorApi) {
   app.get('/eg001', eg001monitor.getController)
     .post('/eg001', eg001monitor.createController)
     .get('/eg002', eg002monitor.getController)
-    .post('/eg002', eg002monitor.createController)
+    .post('/eg002', eg002monitor.createController);
 } else if (examplesApi.examplesApi.isAdminApi) {
     app.get('/eg001', eg001admin.getController)
     .post('/eg001', eg001admin.createController)
@@ -194,7 +194,7 @@ if (examplesApi.examplesApi.isRoomsApi) {
     .get('/eg008', eg008admin.getController)
     .post('/eg008', eg008admin.createController)
     .get('/eg009', eg009admin.getController)
-    .post('/eg009', eg009admin.createController)
+    .post('/eg009', eg009admin.createController);
 } else {
   app.get('/eg001', eg001.getController)
     .post('/eg001', eg001.createController)
@@ -273,16 +273,16 @@ if (examplesApi.examplesApi.isRoomsApi) {
     .get('/eg039', eg039.getController)
     .post('/eg039', eg039.createController)
     .get('/eg040', eg040.getController)
-    .post('/eg040', eg040.createController)
+    .post('/eg040', eg040.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) }
+function dsLoginCB1(req, res, next) { req.dsAuthCodeGrant.oauth_callback1(req, res, next); }
+function dsLoginCB2(req, res, next) { req.dsAuthCodeGrant.oauth_callback2(req, res, next); }
 
 /* Start the web server */
 if (dsConfig.dsClientId && dsConfig.dsClientId !== '{CLIENT_ID}' &&
   dsConfig.dsClientSecret && dsConfig.dsClientSecret !== '{CLIENT_SECRET}') {
-  app.listen(PORT)
+  app.listen(PORT);
   console.log(`Listening on ${PORT}`);
   console.log(`Ready! Open ${hostUrl}`);
 } else {
@@ -298,25 +298,25 @@ You can set them in the configuration file config/appsettings.json or set enviro
 //   the user by ID when deserializing.  However, since this example does not
 //   have a database of user records, the complete DocuSign profile is serialized
 //   and deserialized.
-passport.serializeUser(function (user, done) { done(null, user) });
-passport.deserializeUser(function (obj, done) { done(null, obj) });
+passport.serializeUser(function(user, done) { done(null, user); });
+passport.deserializeUser(function(obj, done) { done(null, obj); });
 
-const SCOPES = ["signature"];
+const SCOPES = ['signature'];
 const ROOM_SCOPES = [
-  "signature", "dtr.rooms.read", "dtr.rooms.write",
-  "dtr.documents.read", "dtr.documents.write", "dtr.profile.read", "dtr.profile.write",
-  "dtr.company.read", "dtr.company.write", "room_forms"
+  'signature', 'dtr.rooms.read', 'dtr.rooms.write',
+  'dtr.documents.read', 'dtr.documents.write', 'dtr.profile.read', 'dtr.profile.write',
+  'dtr.company.read', 'dtr.company.write', 'room_forms'
 ];
 const CLICK_SCOPES = [
-  "signature", "click.manage", "click.send"
+  'signature', 'click.manage', 'click.send'
 ];
 const MONITOR_SCOPES = [
-  "signature", "impersonation"
+  'signature', 'impersonation'
 ];
 const ADMIN_SCOPES = [
-  "organization_read", "group_read", "permission_read	",
-  "user_read", "user_write", "account_read",
-  "domain_read", "identity_provider_read", "signature"
+  'organization_read', 'group_read', 'permission_read	',
+  'user_read', 'user_write', 'account_read',
+  'domain_read', 'identity_provider_read', 'signature'
 ];
 let scope;
 if (examplesApi.examplesApi.isRoomsApi) {
@@ -334,7 +334,7 @@ if (examplesApi.examplesApi.isRoomsApi) {
 let docusignStrategy = new DocusignStrategy({
     production: dsConfig.production,
     clientID: dsConfig.dsClientId,
-    scope: scope.join(" "),
+    scope: scope.join(' '),
     clientSecret: dsConfig.dsClientSecret,
     callbackURL: hostUrl + '/ds/callback',
     state: true // automatic CSRF protection.
@@ -361,8 +361,8 @@ let docusignStrategy = new DocusignStrategy({
  */
 if (!dsConfig.allowSilentAuthentication) {
   // See https://stackoverflow.com/a/32877712/64904
-  docusignStrategy.authorizationParams = function (options) {
+  docusignStrategy.authorizationParams = function(options) {
     return { prompt: 'login' };
-  }
+  };
 }
 passport.use(docusignStrategy);