refactor configs and common helpers annotations

Author: Ruslan Tereshchenko

.gitignore

@@ -13,3 +13,4 @@ test-settings.js
 *.DS_Store
 launch.json
 .vscode
+.history

config/eval.js

@@ -0,0 +1,13 @@
+'use strict';
+
+/**
+ * @type {EnvConfig}
+ */
+const config = {
+  api: {
+    host: 'api-eval.signnow.com',
+    port: 443,
+  },
+};
+
+module.exports = config;

config/index.js

@@ -0,0 +1,34 @@
+/* eslint-disable global-require */
+'use strict';
+
+let currentEnvironment = 'prod';
+
+/**
+ * @type {EnvConfig}
+ */
+const currentConfig = {};
+
+/**
+ * Returns environment config data
+ * @return {EnvConfig}
+ */
+const getEnvConfig = () => currentConfig;
+
+/**
+ * Sets and returns environment config data
+ * @param {string} [env]
+ * @return {EnvConfig}
+ */
+const setEnvConfig = env => {
+  if (env) {
+    currentEnvironment = env;
+    return Object.assign(currentConfig, require(`./${env}`));
+  }
+
+  return Object.assign(currentConfig, require(`./${currentEnvironment}`));
+};
+
+module.exports = {
+  getEnvConfig,
+  setEnvConfig,
+};

config/prod.js

@@ -0,0 +1,26 @@
+'use strict';
+
+/**
+ * API settings
+ * @typedef {Object} APISettings
+ * @property {string} host
+ * @property {string} port
+ */
+
+/**
+ * Environment configuration
+ * @typedef {Object} EnvConfig
+ * @property {APISettings} api
+ */
+
+/**
+ * @type {EnvConfig}
+ */
+const config = {
+  api: {
+    host: 'api.signnow.com',
+    port: 443,
+  },
+};
+
+module.exports = config;

lib/common/index.js

@@ -6,22 +6,12 @@ const {
   arch,
 } = require('os');
 const { extname } = require('path');
+const { getEnvConfig } = require('../../config');
 const {
   version: clientVersion,
   clientName,
 } = require('../../package.json');
 
-/**
- * Common request setting object
- */
-const settings = {
-  api: {
-    host: 'api-eval.signnow.com',
-    port: 443,
-    credentials: '',
-  },
-};
-
 const acceptedDocumentExtensions = [
   'doc',
   'docx',
@@ -92,26 +82,77 @@ const errorHandler = callback => err => {
 };
 
 /**
- * user agent string format:
+ * Composes user agent string in format:
  * <client name>/<version> (<OS type> <OS version>; <platform>; <arch>) <runtime>/<version>
+ * @return {string}
  */
 const getUserAgent = () => {
   const { version: runtimeVersion } = process;
   return `${clientName}/v${clientVersion} (${OSType} ${OSVersion}; ${platform}; ${arch}) node/${runtimeVersion}`;
 };
 
+/**
+ * @type {string}
+ */
+let basicCredentials;
+
+/**
+ * @return {string}
+ */
+const getCredentials = () => basicCredentials;
+
+/**
+ * @param {string}
+ * @return {string}
+ */
+const setCredentials = credentials => {
+  return basicCredentials = credentials;
+};
+
+/**
+ * Build Request authorization settings
+ * @typedef {Object} BuildRequestAuthorization
+ * @property {string} [type="Basic"]
+ * @property {string} [token=basicCredentials]
+ */
+
+/**
+ * Build Request Options object params
+ * @typedef {Object} BuildRequestOptionsParams
+ * @property {string} [method="GET"]
+ * @property {string} [path="/"]
+ * @property {BuildRequestAuthorization} [authorization]
+ * @property {Object} [headers]
+ */
+
+/**
+ * Request Options object
+ * @typedef {Object} RequestOptions
+ * @property {string} host
+ * @property {string} port
+ * @property {string} method
+ * @property {string} path
+ * @property {Object} headers
+ */
+
+/**
+ * Builds Request Options object
+ * @param {BuildRequestOptionsParams}
+ * @return {RequestOptions}
+ */
 const buildRequestOptions = ({
   method = 'GET',
   path = '/',
   authorization: {
     type = 'Basic',
-    token = settings.api.credentials,
+    token = getCredentials(),
   } = {},
   headers = {},
 }) => {
+  const { api: { host, port } } = getEnvConfig();
   const options = {
-    host: settings.api.host,
-    port: settings.api.port,
+    host,
+    port,
     method,
     path,
     headers,
@@ -121,14 +162,10 @@ const buildRequestOptions = ({
   return options;
 };
 
-const setProductionApiHost = () => {
-  settings.api.host = 'api.signnow.com';
-};
-
-const setCredentials = credentials => {
-  settings.api.credentials = credentials;
-};
-
+/**
+ * @param {Object} queryParams
+ * @return {string}
+ */
 const stringifyQueryParams = queryParams => Object
   .entries(queryParams)
   .reduce((acc, cur) => `${acc}${cur.join('=')}&`, '')
@@ -175,15 +212,25 @@ const isDocumentTypeAcceptable = fileExtension => acceptedDocumentExtensions.inc
  */
 const isCSVFile = filePath => extname(filePath).substr(1).toLowerCase() === 'csv';
 
-// get signers email by status
-const getByStatus = (arr, key, status) => {
-  return arr
-    .filter(field => field.status === status)
-    .map(val => val[key]);
-};
+/**
+ * Return signer emails by status
+ * @param {Object[]} arr
+ * @param {string} key
+ * @param {string} status
+ * @return {string[]}
+ */
+const getByStatus = (arr, key, status) => arr
+  .filter(field => field.status === status)
+  .map(val => val[key]);
 
-// get signers email by key and status
-const getSignersEmails = (arr, key, status) => {
+/**
+ * Returns signer emails by key and status
+ * @param {Object[]} arr
+ * @param {string} key
+ * @param {string|string[]} status
+ * @return {string[]}
+ */
+const getSignerEmails = (arr, key, status) => {
   if (!arr || arr.length <= 0) {
     return;
   }
@@ -213,7 +260,11 @@ const getSignersEmails = (arr, key, status) => {
   return arr;
 };
 
-// get signers email with declined status
+/**
+ * Returns signer emails with declined to sign status
+ * @param {Object[]} arr
+ * @param {string[]} status
+ */
 const getByDeclinedStatus = (arr, status) => {
   if (status.includes('declined') || status === 'declined') {
     return arr
@@ -228,13 +279,12 @@ module.exports = {
   responseHandler,
   errorHandler,
   buildRequestOptions,
-  setProductionApiHost,
   setCredentials,
   stringifyQueryParams,
   getMimeTypeByFileExtension,
   isDocumentTypeAcceptable,
   isCSVFile,
   getFormDataBoundary,
   getByDeclinedStatus,
-  getSignersEmails,
+  getSignerEmails,
 };

lib/document/index.js

@@ -11,7 +11,7 @@ const {
   isDocumentTypeAcceptable,
   getFormDataBoundary,
   getByDeclinedStatus,
-  getSignersEmails,
+  getSignerEmails,
 } = require('../common');
 const { promisify } = require('../../utils');
 
@@ -1044,11 +1044,11 @@ class Document {
    * @property {boolean} [allSignatures=true] - if true receive all document signers email
    * @property {boolean} [freeFormInvites=false] - if `true` return free from invite signer emails
    * @property {?string[]} [fieldInvitesStatus=null] - return signers according to specified field invite status(es)
-     * Accepts list of statuses or a single status.
-     * Acceptable statuses: all, pending, declined, fulfilled, created, skipped.
+   * Accepts list of statuses or a single status.
+   * Acceptable statuses: all, pending, declined, fulfilled, created, skipped.
    * @property {?string[]} [paymentRequestsStatus=null] - return signers according to specified to payment request status(es)
-     * Accepts list of statuses or a single status.
-     * Available statuses: all, pending, fulfilled, created, skipped.
+   * Accepts list of statuses or a single status.
+   * Available statuses: all, pending, fulfilled, created, skipped.
    */
 
   /**
@@ -1094,21 +1094,21 @@ class Document {
         const emails = [];
 
         if (Object.keys(options).length === 0) {
-          const fieldInvitesEmails = getSignersEmails(field_invites, 'email') || [];
-          const freeFormInvitesEmails = getSignersEmails(requests, 'signer_email') || [];
+          const fieldInvitesEmails = getSignerEmails(field_invites, 'email') || [];
+          const freeFormInvitesEmails = getSignerEmails(requests, 'signer_email') || [];
 
           emails.push(...fieldInvitesEmails);
           emails.push(...freeFormInvitesEmails);
         }
 
         if (freeFormInvites) {
-          const freeFomInvites = getSignersEmails(requests, 'signer_email') || [];
+          const freeFomInvites = getSignerEmails(requests, 'signer_email') || [];
 
           emails.push(...freeFomInvites);
         }
 
         if (fieldInviteStatus) {
-          const fieldInvites = getSignersEmails(field_invites, 'email', fieldInviteStatus) || [];
+          const fieldInvites = getSignerEmails(field_invites, 'email', fieldInviteStatus) || [];
           const declined = getByDeclinedStatus(field_invites, fieldInviteStatus) || [];
 
           if (fieldInvites.length > 0) {
@@ -1120,14 +1120,14 @@ class Document {
         }
 
         if (paymentRequestStatus) {
-          const paymentRequests = getSignersEmails(field_invites, 'email', paymentRequestStatus) || [];
+          const paymentRequests = getSignerEmails(field_invites, 'email', paymentRequestStatus) || [];
 
           emails.push(...paymentRequests);
         }
 
         callback(null, [...new Set(emails)]);
       })
-      .catch(err => callback(null, err));
+      .catch(err => callback(err));
   }
 }
 

lib/index.js

@@ -9,7 +9,8 @@ const template = require('./template');
 const link = require('./link');
 const documentGroup = require('./document-group');
 const documentGroupTemplate = require('./document-group-template');
-const { setProductionApiHost, setCredentials } = require('./common');
+const { setCredentials } = require('./common');
+const { setEnvConfig } = require('../config');
 
 /**
  * Api client initialization params
@@ -36,17 +37,17 @@ const { setProductionApiHost, setCredentials } = require('./common');
  * @return {Features}
  */
 module.exports = function init ({
-  credentials,
   production = true,
+  credentials,
 }) {
-
   if (credentials) {
     setCredentials(credentials);
   }
 
-  // toggle production
   if (production) {
-    setProductionApiHost();
+    setEnvConfig('prod');
+  } else {
+    setEnvConfig('eval');
   }
 
   return {

package.json

@@ -44,6 +44,7 @@
   },
   "files": [
     "lib",
+    "config",
     "utils",
     "bin"
   ],