@itentialopensource/adapter-utils 4.47.0 → 4.48.1

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 
+## 4.48.1 [09-22-2022]
+
+* Add capability to send base64 and buffer in formData
+
+Closes ADAPT-2380
+
+See merge request itentialopensource/adapter-utils!238
+
+---
+
+## 4.48.0 [08-16-2022]
+
+* Changes to support entitypath object with multiple paths
+
+Closes ADAPT-2331
+
+See merge request itentialopensource/adapter-utils!236
+
+---
+
 ## 4.47.0 [08-13-2022]
 
 * Add SSO capability into service instance config

package/lib/connectorRest.js

@@ -45,6 +45,7 @@ let host = null;
 let port = null;
 let basepath = null;
 let version = null;
+let choosepath = null;
 let authMethod = null;
 let authField = null;
 let authFormat = null;
@@ -254,11 +255,11 @@ function matchMock(uriPath, method, type, mockresponses, respDatatype) {
   for (let p = 0; p < mockresponses.length; p += 1) {
     // is this the mock data for this call
     if (Object.hasOwnProperty.call(mockresponses[p], 'name')
-        && uriPath === mockresponses[p].name) {
+      && uriPath === mockresponses[p].name) {
       if (Object.hasOwnProperty.call(mockresponses[p], 'method')
-          && method.toUpperCase() === mockresponses[p].method.toUpperCase()) {
+        && method.toUpperCase() === mockresponses[p].method.toUpperCase()) {
         if (Object.hasOwnProperty.call(mockresponses[p], 'type')
-            && type.toUpperCase() === mockresponses[p].type.toUpperCase()) {
+          && type.toUpperCase() === mockresponses[p].type.toUpperCase()) {
           // This is the mock data we really want as it best matches the request
           const specificResp = {
             status: 'success',
@@ -269,7 +270,7 @@ function matchMock(uriPath, method, type, mockresponses, respDatatype) {
           if (Object.hasOwnProperty.call(mockresponses[p], 'response')) {
             // if a status is defined in the response, use it
             if (Object.hasOwnProperty.call(mockresponses[p].response, 'response')
-                && Object.hasOwnProperty.call(mockresponses[p].response, 'status')) {
+              && Object.hasOwnProperty.call(mockresponses[p].response, 'status')) {
               specificResp.code = mockresponses[p].response.status;
 
               if (respDatatype && respDatatype.toUpperCase() === 'XML2JSON') {
@@ -395,7 +396,7 @@ function returnStub(request, entitySchema, callProperties) {
 
   // if there is a request body, see if there is something that matches a specific input
   if (reqBody && (!entitySchema || !entitySchema.requestDatatype
-      || entitySchema.requestDatatype.toUpperCase() === 'JSON' || entitySchema.requestDatatype.toUpperCase() === 'URLENCODE')) {
+    || entitySchema.requestDatatype.toUpperCase() === 'JSON' || entitySchema.requestDatatype.toUpperCase() === 'URLENCODE')) {
     let reqBdObj = null;
     if (entitySchema && entitySchema.requestDatatype && entitySchema.requestDatatype.toUpperCase() === 'URLENCODE') {
       reqBdObj = querystring.parse(reqBody.trim());
@@ -660,38 +661,60 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
       }
       // add the data for each field into the form
       const mykeys = Object.keys(mybody);
-      for (let k = 0; k < mykeys.length; k += 1) {
-        if (mykeys[k] === 'file') {
-          let fileVal = mybody[mykeys[k]];
-          if (fileVal.indexOf('@') === 0) {
-            // if there are multiple parts - first part is file, other part can be name
-            const filePart = fileVal.split(';');
-            let fileName = null;
-            fileVal = fs.readFileSync(`node_modules/@itentialopensource/adapter-forwardnetworks/uploads/${filePart[0].substring(1)}`);
-
-            // see if we have a filename that we should add to the formdata
-            for (let p = 1; p < filePart.length; p += 1) {
-              if (filePart[p].indexOf('name=') === 0) {
-                fileName = filePart[p].substring(5);
+      if (mykeys.length === 2 && mykeys[0] === 'file' && mykeys[1] === 'convertBase64ToBuffer') {
+        const filePart = mybody[mykeys[0]].split(';');
+        let fileName = null;
+        // see if we have a filename that we should add to the formdata
+        for (let p = 1; p < filePart.length; p += 1) {
+          if (filePart[p].indexOf('name=') === 0) {
+            fileName = filePart[p].substring(5);
+          }
+        }
+        if (mybody.convertBase64ToBuffer === true) {
+          let fileBuffer = filePart[filePart.length - 1];
+          if (filePart[filePart.length - 1].startsWith('base64')) {
+            fileBuffer = Buffer.from(filePart[filePart.length - 1].substring(7), 'base64');
+          }
+          log.debug(`APPENDING: ${mykeys[0]}, WITH VALUE ${fileBuffer}, AND NAME ${fileName}`);
+          formData.append(mykeys[0], fileBuffer, fileName);
+        } else {
+          log.debug(`APPENDING: ${mykeys[0]}, WITH VALUE ${filePart[filePart.length - 1]}, AND NAME ${fileName}`);
+          formData.append(mykeys[0], filePart[filePart.length - 1], fileName);
+        }
+      } else {
+        for (let k = 0; k < mykeys.length; k += 1) {
+          if (mykeys[k] === 'file') {
+            let fileVal = mybody[mykeys[k]];
+            if (fileVal.indexOf('@') === 0) {
+              // if there are multiple parts - first part is file, other part can be name
+              const filePart = fileVal.split(';');
+              let fileName = null;
+              fileVal = fs.readFileSync(`node_modules/@itentialopensource/adapter-forwardnetworks/uploads/${filePart[0].substring(1)}`);
+
+              // see if we have a filename that we should add to the formdata
+              for (let p = 1; p < filePart.length; p += 1) {
+                if (filePart[p].indexOf('name=') === 0) {
+                  fileName = filePart[p].substring(5);
+                }
+              }
+              if (fileName) {
+                // with filename
+                log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${fileVal}, AND NAME ${fileName}`);
+                formData.append(mykeys[k], fileVal, fileName);
+              } else {
+                // with read in file but no file name
+                log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${fileVal}`);
+                formData.append(mykeys[k], fileVal);
               }
-            }
-            if (fileName) {
-              // with filename
-              log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${fileVal}, AND NAME ${fileName}`);
-              formData.append(mykeys[k], fileVal, fileName);
             } else {
-              // with read in file but no file name
+              // no file or file name just contents - original
               log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${fileVal}`);
               formData.append(mykeys[k], fileVal);
             }
           } else {
-            // no file or file name just contents - original
-            log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${fileVal}`);
-            formData.append(mykeys[k], fileVal);
+            log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${mybody[mykeys[k]]}`);
+            formData.append(mykeys[k], mybody[mykeys[k]]);
           }
-        } else {
-          log.debug(`APPENDING: ${mykeys[k]}, WITH VALUE ${mybody[mykeys[k]]}`);
-          formData.append(mykeys[k], mybody[mykeys[k]]);
         }
       }
       // get the new headers
@@ -887,7 +910,7 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
 
     // write to the http request data to the body if not a get (gets do not have data in the body)
     if ((request.header.method !== 'GET' || entitySchema.sendGetBody)
-        && ((typeof request.body === 'object' && Object.keys(request.body).length > 0)
+      && ((typeof request.body === 'object' && Object.keys(request.body).length > 0)
         || (typeof request.body === 'string' && request.body !== '{}') || entitySchema.sendEmpty)) {
       if (entitySchema.requestDatatype.toUpperCase() === 'FORM') {
         // pass the formData to the request
@@ -1204,7 +1227,7 @@ function getToken(reqPath, options, tokenSchema, bodyString, callProperties, cal
 
       // process primary token from header
       if (tokenSchema.responseSchema && tokenSchema.responseSchema.properties && tokenSchema.responseSchema.properties.token
-          && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'HEADER') {
+        && tokenSchema.responseSchema.properties.token.placement && tokenSchema.responseSchema.properties.token.placement.toUpperCase() === 'HEADER') {
         if (!tokenSchema.responseSchema.properties.token.external_name) {
           const errorObj = transUtilInst.formatErrorObject(origin, 'Unable To Get Primary Token', ['Primary Token', result.code], null, null, null);
           log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
@@ -1503,7 +1526,7 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
 
   try {
     // Get the entity schema from the file system
-    return propUtilInst.getEntitySchema('.system', 'getToken', this.dbUtil, (tokenSchema, healthError) => {
+    return propUtilInst.getEntitySchema('.system', 'getToken', choosepath, this.dbUtil, (tokenSchema, healthError) => {
       if (healthError || !tokenSchema || Object.keys(tokenSchema).length === 0) {
         log.debug(`${origin}: Using adapter properties for token information`);
         tokenSchema = null;
@@ -1793,7 +1816,7 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
 
       // only add global options if there are global options to add
       if (globalRequest && globalRequest.uriOptions
-          && Object.keys(globalRequest.uriOptions).length > 0) {
+        && Object.keys(globalRequest.uriOptions).length > 0) {
         const optionString = querystring.stringify(globalRequest.uriOptions);
 
         // if no query paramters yet - start with ?
@@ -2105,7 +2128,7 @@ function validToken(user, reqBody, invalidToken, callback) {
         // if the token expired (or will expire within a minute),
         // or it is invalid (failed) remove it from the token list
         if (tokenList[i].expire < expireCheck
-            || tokenList[i].token.token === invalidToken) {
+          || tokenList[i].token.token === invalidToken) {
           tokenList.splice(i, 1);
           break;
         }
@@ -2819,7 +2842,7 @@ function handleEndThrottleResponse(request, myTransTime, claimedLic, makeResp, r
 
       // If the request was successful
       if (makeResp !== null && makeResp.code !== undefined
-          && Number(makeResp.code) >= 200 && Number(makeResp.code) <= 299) {
+        && Number(makeResp.code) >= 200 && Number(makeResp.code) <= 299) {
         const newResp = {
           icode: `AD.${makeResp.code}`,
           response: makeResp.response,
@@ -2918,7 +2941,7 @@ function retryInvalidResponse(request, callProperties, myTransTime, claimedLic,
       let retries = numRetries;
       if (callProperties && callProperties.request && callProperties.request.limit_retry_error) {
         if (typeof callProperties.request.limit_retry_error === 'number'
-            || typeof callProperties.request.limit_retry_error === 'string') {
+          || typeof callProperties.request.limit_retry_error === 'string') {
           retryError = [Number(callProperties.request.limit_retry_error)];
         } else if (Array.isArray(callProperties.request.limit_retry_error)) {
           retryError = [];
@@ -2926,10 +2949,10 @@ function retryInvalidResponse(request, callProperties, myTransTime, claimedLic,
             if (typeof callProperties.request.limit_retry_error[l] === 'number') {
               retryError.push(Number(callProperties.request.limit_retry_error[l]));
             } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
+              && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
               retryError.push(Number(callProperties.request.limit_retry_error[l]));
             } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
+              && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
               const srange = Number(callProperties.request.limit_retry_error[l].split('-')[0]);
               const erange = Number(callProperties.request.limit_retry_error[l].split('-')[1]);
               for (let r = srange; r <= erange; r += 1) {
@@ -2946,7 +2969,7 @@ function retryInvalidResponse(request, callProperties, myTransTime, claimedLic,
       // if the response is valid - good data or legitimate data error
       // stop trying if we have tried enough
       if (numTries > retries || (mres !== null && mres.code !== undefined && !retryError.includes(Number(mres.code))
-          && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
+        && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
         const newresp = mres;
         newresp.retries = numTries;
 
@@ -3082,7 +3105,7 @@ function noQueueRequest(request, callProperties, overallTime, entitySchema, call
       let retries = numRetries;
       if (callProperties && callProperties.request && callProperties.request.limit_retry_error) {
         if (typeof callProperties.request.limit_retry_error === 'number'
-            || typeof callProperties.request.limit_retry_error === 'string') {
+          || typeof callProperties.request.limit_retry_error === 'string') {
           retryError = [Number(callProperties.request.limit_retry_error)];
         } else if (Array.isArray(callProperties.request.limit_retry_error)) {
           retryError = [];
@@ -3090,10 +3113,10 @@ function noQueueRequest(request, callProperties, overallTime, entitySchema, call
             if (typeof callProperties.request.limit_retry_error[l] === 'number') {
               retryError.push(Number(callProperties.request.limit_retry_error[l]));
             } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
+              && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
               retryError.push(Number(callProperties.request.limit_retry_error[l]));
             } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
+              && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
               const srange = Number(callProperties.request.limit_retry_error[l].split('-')[0]);
               const erange = Number(callProperties.request.limit_retry_error[l].split('-')[1]);
               for (let r = srange; r <= erange; r += 1) {
@@ -3109,14 +3132,14 @@ function noQueueRequest(request, callProperties, overallTime, entitySchema, call
 
       // if invalid token, handle that and retry
       if (mres !== null && mres.code !== undefined && Number(mres.code) === Number(tokenError)
-          && authMethod === 'request_token') {
+        && authMethod === 'request_token') {
         // if we took an invalid token - try one more time
         return handleInvalidToken(request, callProperties, 0, { request_id: 0 }, mres, overallTime, overallTime, 0, 1, entitySchema, callback);
       }
 
       // if the response is valid - good data or legitimate data error
       if (retries < 1 || (mres !== null && mres.code !== undefined && !retryError.includes(Number(mres.code))
-          && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
+        && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
         return handleEndResponse(request, mres, overallTime, callback);
       }
 
@@ -3181,7 +3204,7 @@ function queueThrottleRequest(request, callProperties, myRequestId, myTransTime,
           let retries = numRetries;
           if (callProperties && callProperties.request && callProperties.request.limit_retry_error) {
             if (typeof callProperties.request.limit_retry_error === 'number'
-                || typeof callProperties.request.limit_retry_error === 'string') {
+              || typeof callProperties.request.limit_retry_error === 'string') {
               retryError = [Number(callProperties.request.limit_retry_error)];
             } else if (Array.isArray(callProperties.request.limit_retry_error)) {
               retryError = [];
@@ -3189,10 +3212,10 @@ function queueThrottleRequest(request, callProperties, myRequestId, myTransTime,
                 if (typeof callProperties.request.limit_retry_error[l] === 'number') {
                   retryError.push(Number(callProperties.request.limit_retry_error[l]));
                 } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                    && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
+                  && callProperties.request.limit_retry_error[l].indexOf('-') < 0) {
                   retryError.push(Number(callProperties.request.limit_retry_error[l]));
                 } else if (typeof callProperties.request.limit_retry_error[l] === 'string'
-                    && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
+                  && callProperties.request.limit_retry_error[l].indexOf('-') >= 0) {
                   const srange = Number(callProperties.request.limit_retry_error[l].split('-')[0]);
                   const erange = Number(callProperties.request.limit_retry_error[l].split('-')[1]);
                   for (let r = srange; r <= erange; r += 1) {
@@ -3208,14 +3231,14 @@ function queueThrottleRequest(request, callProperties, myRequestId, myTransTime,
 
           // if invalid token, handle that and retry
           if (mres !== null && mres.code !== undefined && Number(mres.code) === Number(tokenError)
-              && authMethod === 'request_token') {
+            && authMethod === 'request_token') {
             // if we took an invalid token - try one more time
             return handleInvalidToken(request, callProperties, myTransTime, claimedLic, mres, reqTime, overallTime, waitEnd, 1, entitySchema, callback);
           }
 
           // if the response is valid - good data or legitimate data error
           if (retries < 1 || (mres !== null && mres.code !== undefined && !retryError.includes(Number(mres.code))
-              && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
+            && (authMethod !== 'request_token' || Number(mres.code) !== Number(tokenError)))) {
             return handleEndThrottleResponse(request, myTransTime, claimedLic, mres, reqTime, overallTime, waitEnd, callback);
           }
 
@@ -3317,6 +3340,11 @@ class ConnectorRest {
       version = props.version;
     }
 
+    // set the choosepath (optional - default is null)
+    if (typeof props.choosepath === 'string') {
+      choosepath = props.choosepath;
+    }
+
     if (props.authentication) {
       // set the authentication method (required - default is null)
       if (typeof props.authentication.auth_method === 'string') {
@@ -3360,13 +3388,13 @@ class ConnectorRest {
 
       // set the invalid token error (optional - default is null)
       if (typeof props.authentication.invalid_token_error === 'number'
-          || typeof props.authentication.invalid_token_error === 'string') {
+        || typeof props.authentication.invalid_token_error === 'string') {
         tokenError = Number(props.authentication.invalid_token_error);
       }
 
       // set the token timeout (optional - default is null)
       if (typeof props.authentication.token_timeout === 'number'
-          || typeof props.authentication.token_timeout === 'string') {
+        || typeof props.authentication.token_timeout === 'string') {
         tokenTimeout = Number(props.authentication.token_timeout);
       }
 
@@ -3447,19 +3475,19 @@ class ConnectorRest {
     if (props.request) {
       // set the number of redirects (optional - default is 0)
       if (typeof props.request.number_redirects === 'number'
-          || typeof props.request.number_redirects === 'string') {
+        || typeof props.request.number_redirects === 'string') {
         numRedirects = Number(props.request.number_redirects);
       }
 
       // set the number of retries (optional - default is 3)
       if (typeof props.request.number_retries === 'number'
-          || typeof props.request.number_retries === 'string') {
+        || typeof props.request.number_retries === 'string') {
         numRetries = Number(props.request.number_retries);
       }
 
       // set the request retry error (optional - default is 0)
       if (typeof props.request.limit_retry_error === 'number'
-          || typeof props.request.limit_retry_error === 'string') {
+        || typeof props.request.limit_retry_error === 'string') {
         limitRetryError = [Number(props.request.limit_retry_error)];
       } else if (Array.isArray(props.request.limit_retry_error)) {
         limitRetryError = [];
@@ -3467,10 +3495,10 @@ class ConnectorRest {
           if (typeof props.request.limit_retry_error[l] === 'number') {
             limitRetryError.push(Number(props.request.limit_retry_error[l]));
           } else if (typeof props.request.limit_retry_error[l] === 'string'
-              && props.request.limit_retry_error[l].indexOf('-') < 0) {
+            && props.request.limit_retry_error[l].indexOf('-') < 0) {
             limitRetryError.push(Number(props.request.limit_retry_error[l]));
           } else if (typeof props.request.limit_retry_error[l] === 'string'
-              && props.request.limit_retry_error[l].indexOf('-') >= 0) {
+            && props.request.limit_retry_error[l].indexOf('-') >= 0) {
             const srange = Number(props.request.limit_retry_error[l].split('-')[0]);
             const erange = Number(props.request.limit_retry_error[l].split('-')[1]);
             for (let r = srange; r <= erange; r += 1) {
@@ -3482,7 +3510,7 @@ class ConnectorRest {
 
       // set the request attempt timeout (optional - default is 5000)
       if (typeof props.request.attempt_timeout === 'number'
-          || typeof props.request.attempt_timeout === 'string') {
+        || typeof props.request.attempt_timeout === 'string') {
         attemptTimeout = Number(props.request.attempt_timeout);
       }
 
@@ -3904,7 +3932,7 @@ class ConnectorRest {
         }
 
         if (pres !== null && pres.code !== undefined
-            && (Number(pres.code) < 200 || Number(pres.code) > 299)) {
+          && (Number(pres.code) < 200 || Number(pres.code) > 299)) {
           let errorObj = null;
 
           if (pres.code === -2) {

package/lib/propertyUtil.js

@@ -30,7 +30,7 @@ class AdapterPropertyUtil {
    *
    * @return {Object} entitySchema - the entity schema object
    */
-  getEntitySchemaFromFS(entityName, actionName) {
+  getEntitySchemaFromFS(entityName, actionName, choosepath) {
     const origin = `${this.myid}-propertyUtil-getEntitySchemaFromFS`;
     log.trace(origin);
 
@@ -264,6 +264,32 @@ class AdapterPropertyUtil {
       entitySchema.responseObjects = [];
       entitySchema.mockresponses = [];
 
+      // if the entitypath is an object instead of a string need to figure out which path to use
+      if (actionInfo.entitypath && typeof actionInfo.entitypath === 'object') {
+        const ekeys = Object.keys(actionInfo.entitypath);
+        if (ekeys.length > 0) {
+          // the first one is the default so if we do not have a match that is the one that will be used
+          entitySchema.entitypath = actionInfo.entitypath[ekeys[0]];
+          for (let ep = 1; ep < ekeys.length; ep += 1) {
+            // see if the key matches the choosepath value, if it does set the entitypath
+            if (choosepath && ekeys[ep] === choosepath) {
+              entitySchema.entitypath = actionInfo.entitypath[ekeys[ep]];
+              break;
+            }
+          }
+        } else {
+          // add the specific pieces of the error object
+          errorObj.type = 'Invalid Action File';
+          errorObj.vars = ['missing entity path', actionFile];
+
+          // log (if not system entity) and throw the error
+          if (entityName !== '.system') {
+            log.error(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
+          }
+          throw new Error(JSON.stringify(errorObj));
+        }
+      }
+
       // if info provided, replace the defaults
       if (actionInfo.querykey) {
         entitySchema.querykey = actionInfo.querykey;
@@ -399,7 +425,7 @@ class AdapterPropertyUtil {
    *
    * @return {Object} entitySchema - the entity schema object
    */
-  getEntitySchemaFromDB(dbObj, entityName, actionName, dbUtils, callback) {
+  getEntitySchemaFromDB(dbObj, entityName, actionName, choosepath, dbUtils, callback) {
     const origin = `${this.myid}-propertyUtil-getEntitySchemaFromDB`;
     log.trace(origin);
 
@@ -672,6 +698,33 @@ class AdapterPropertyUtil {
         entitySchema.responseObjects = [];
         entitySchema.mockresponses = [];
 
+        // if the entitypath is an object instead of a string need to figure out which path to use
+        if (actionInfo.entitypath && typeof actionInfo.entitypath === 'object') {
+          const ekeys = Object.keys(actionInfo.entitypath);
+          if (ekeys.length > 0) {
+            // the first one is the default so if we do not have a match that is the one that will be used
+            entitySchema.entitypath = actionInfo.entitypath[ekeys[0]];
+            for (let ep = 1; ep < ekeys.length; ep += 1) {
+              // see if the key matches the choosepath value, if it does set the entitypath
+              if (choosepath && ekeys[ep] === choosepath) {
+                entitySchema.entitypath = actionInfo.entitypath[ekeys[ep]];
+                break;
+              }
+            }
+          } else {
+          // add the specific pieces of the error object
+            errorObj.type = 'Invalid Action File';
+            errorObj.vars = ['missing entity path', entityName];
+
+            // log (if not system entity) and return the error
+            if (entityName !== '.system') {
+              log.error(`${origin}: Entity ${entityName} action ${actionName} - missing entity path`);
+              errorObj.error = [`${origin}: Entity ${entityName} action ${actionName} - missing entity path`];
+            }
+            return callback(null, errorObj);
+          }
+        }
+
         // if info provided, replace the defaults
         if (actionInfo.querykey) {
           entitySchema.querykey = actionInfo.querykey;
@@ -796,14 +849,14 @@ class AdapterPropertyUtil {
    *
    * @return {Object} entitySchema - the entity schema object
    */
-  getEntitySchema(entityName, actionName, dbUtils, callback) {
+  getEntitySchema(entityName, actionName, choosepath, dbUtils, callback) {
     const origin = `${this.myid}-propertyUtil-getEntitySchema`;
     log.trace(origin);
 
     // need to try to get the entity schema from the adapter database
     try {
       // call to get the adapter schema from the database
-      return this.getEntitySchemaFromDB(null, entityName, actionName, dbUtils, (dbresp, dberror) => {
+      return this.getEntitySchemaFromDB(null, entityName, actionName, choosepath, dbUtils, (dbresp, dberror) => {
         // if we got an error back - just means db config not in place
         if (dberror || !dbresp || (dbresp && Object.keys(dbresp).length === 0)) {
           log.debug('unable to get adapter config from adapter database');
@@ -816,7 +869,7 @@ class AdapterPropertyUtil {
           };
 
           // need to try to get the entity schema from the iap database
-          return this.getEntitySchemaFromDB(iapDB, entityName, actionName, dbUtils, (iapdbresp, iapdberror) => {
+          return this.getEntitySchemaFromDB(iapDB, entityName, actionName, choosepath, dbUtils, (iapdbresp, iapdberror) => {
             // if we got an error back - just means db config not in place
             if (iapdberror || !iapdbresp || (iapdbresp && Object.keys(iapdbresp).length === 0)) {
               log.debug('unable to get adapter config from iap database');
@@ -824,7 +877,7 @@ class AdapterPropertyUtil {
               // need to try to get the entity schema from the filesystem
               log.debug('returning adapter config from file system');
               try {
-                return callback(this.getEntitySchemaFromFS(entityName, actionName), null);
+                return callback(this.getEntitySchemaFromFS(entityName, actionName, choosepath), null);
               } catch (exc) {
                 log.error('Exception caught on File System');
                 return callback(null, exc);

package/lib/requestHandler.js

@@ -117,6 +117,11 @@ function walkThroughActionFiles(directory) {
     const actionSchema = JSON.parse(fs.readFileSync(actionSchemaFile, 'utf-8'));
     const entitydir = `${directory}/entities`;
 
+    // if there is no entity directory - return
+    if (!fs.existsSync(directory) || !fs.existsSync(entitydir)) {
+      return clean;
+    }
+
     // if there is an entity directory
     if (fs.statSync(directory).isDirectory() && fs.statSync(entitydir).isDirectory()) {
       const entities = fs.readdirSync(entitydir);
@@ -577,7 +582,7 @@ class RequestHandler {
       }
 
       // Get the entity schema from the file system
-      return this.propUtil.getEntitySchema(entity, action, this.dbUtil, (entitySchema, entityError) => {
+      return this.propUtil.getEntitySchema(entity, action, this.props.choosepath, this.dbUtil, (entitySchema, entityError) => {
         // verify protocol for call
         if (entityError) {
           const errorObj = this.transUtil.checkAndReturn(entityError, origin, 'Issue identifiying request');
@@ -673,7 +678,7 @@ class RequestHandler {
       let prot = this.props.healthcheck.protocol;
 
       // Get the entity schema from the file system
-      return this.propUtil.getEntitySchema('.system', 'healthcheck', this.dbUtil, (healthSchema, healthError) => {
+      return this.propUtil.getEntitySchema('.system', 'healthcheck', this.props.choosepath, this.dbUtil, (healthSchema, healthError) => {
         if (healthError || !healthSchema || Object.keys(healthSchema).length === 0) {
           log.debug(`${origin}: Using adapter properties for healthcheck information`);
         } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "4.47.0",
+  "version": "4.48.1",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",

package/schemas/actionSchema.json

@@ -32,10 +32,12 @@
             ]
           },
           "entitypath": {
-            "type": "string",
-            "description": "the path to use for this action",
-            "default": "GET",
-            "pattern": "^({base_path}|\\/)[-a-zA-Z0-9!@$:&%_+.,~#\\/*=:]*({version})?([-a-zA-Z0-9!@$:&%_+.,~#\\/*=:]*({pathv[0-9]+})?)*(\\??[-a-zA-Z0-9!@$:&%_+.,\\(\\)~#\\/*=:]*({username})?[-a-zA-Z0-9!@$:&%_+.,\\(\\)~#\/*=:]*({password})?({query})?)?$",
+            "type": [
+              "string",
+              "object"
+            ],
+            "description": "the path(s) to use for this action",
+            "default": "",
             "examples": [
               "/api/devices{pathv1}{query}", "/api/devices{pathv1}/components{pathv2}{query}",
               "/api/devices", "/api/devices{query}"

package/schemas/propertiesSchema.json

@@ -18,6 +18,11 @@
       "minimum": 1,
       "maximum": 65535
     },
+    "choosepath": {
+      "type": "string",
+      "description": "choose the path to use -- requires entityPath choices",
+      "default": ""
+    },
     "base_path": {
       "type": "string",
       "description": "a base path that is consistent across api calls",
@@ -382,7 +387,8 @@
         },
         "query_object": {
           "type": "object",
-          "description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
+          "description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter",
+          "default": {}
         }
       },
       "required": [
@@ -462,6 +468,7 @@
         "priorities": {
           "type": "array",
           "description": "define your priorities here",
+          "default": [],
           "items": {
             "type": "object",
             "properties": {
@@ -532,6 +539,7 @@
         "failover_codes": {
           "type": "array",
           "description": "An array of codes where it is ok to try another method",
+          "default": [],
           "items": {
             "type": "integer"
           }
@@ -549,19 +557,23 @@
           "properties": {
             "payload": {
               "type": "object",
-              "description": "payload fields that will be appended to the provided payload (excluding GET calls)"
+              "description": "payload fields that will be appended to the provided payload (excluding GET calls)",
+              "default": {}
             },
             "uriOptions": {
               "type": "object",
-              "description": "options that will be appended to all GET calls"
+              "description": "options that will be appended to all GET calls",
+              "default": {}
             },
             "addlHeaders": {
               "type": "object",
-              "description": "headers that will be appended to the headers for the call"
+              "description": "headers that will be appended to the headers for the call",
+              "default": {}
             },
             "authData": {
               "type": "object",
-              "description": "authentication data that will be appended to the payload for authentication calls"
+              "description": "authentication data that will be appended to the payload for authentication calls",
+              "default": {}
             }
           }
         },