@itentialopensource/adapter-utils 4.45.7 → 4.48.0

package/CHANGELOG.md

@@ -1,4 +1,34 @@
 
+## 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
+
+Closes ADAPT-2328
+
+See merge request itentialopensource/adapter-utils!235
+
+---
+
+## 4.46.0 [07-27-2022]
+
+* Added code to skip split string on  dot for special cases
+
+Closes ADAPT-2266
+
+See merge request itentialopensource/adapter-utils!234
+
+---
+
 ## 4.45.7 [07-25-2022]
 
 * Fix issue on no token where it takes exception

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;
@@ -62,6 +63,7 @@ let tokenTimeout = -1;
 let tokenError = 401;
 let tokenPath = null;
 let tokenCache = 'local';
+let sso = null;
 const tokenList = [];
 const tokenlock = 0;
 let stub = false;
@@ -1502,7 +1504,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;
@@ -1646,6 +1648,28 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
       }
 
       // specific token properties override everything (Single Sign On System)
+      if (sso && sso.host) {
+        options.hostname = sso.host;
+      }
+      if (sso && sso.port) {
+        options.port = sso.port;
+      }
+      if (sso && sso.protocol) {
+        // need to put protocol in token schema
+        if (!tokenSchema) {
+          tokenSchema = {
+            sso: {
+              protocol: sso.protocol
+            }
+          };
+        } else if (tokenSchema && !tokenSchema.sso) {
+          tokenSchema.sso = {
+            protocol: sso.protocol
+          };
+        } else if (tokenSchema && tokenSchema.sso && !tokenSchema.sso.protocol) {
+          tokenSchema.sso.protocol = sso.protocol;
+        }
+      }
       if (tokenSchema && tokenSchema.sso && tokenSchema.sso.host) {
         options.hostname = tokenSchema.sso.host;
       }
@@ -3294,6 +3318,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') {
@@ -3347,19 +3376,19 @@ class ConnectorRest {
         tokenTimeout = Number(props.authentication.token_timeout);
       }
 
-      // set the token cache (required - default is local)
+      // set the token cache (optional - default is local)
       if (typeof props.authentication.token_cache === 'string') {
         tokenCache = props.authentication.token_cache;
       }
 
-      // set the auth field (required - default is null)
+      // set the auth field (optional - default is null)
       if (typeof props.authentication.auth_field === 'string') {
         authField = [props.authentication.auth_field];
       } else if (Array.isArray(props.authentication.auth_field)) {
         authField = props.authentication.auth_field;
       }
 
-      // set the auth format (required - default is null)
+      // set the auth format (optional - default is null)
       if (typeof props.authentication.auth_field_format === 'string') {
         authFormat = [props.authentication.auth_field_format];
       } else if (Array.isArray(props.authentication.auth_field_format)) {
@@ -3371,20 +3400,25 @@ class ConnectorRest {
         authLogging = props.authentication.auth_logging;
       }
 
-      // set the client id (required - default is null)
+      // set the client id (optional - default is null)
       if (typeof props.authentication.client_id === 'string') {
         clientId = props.authentication.client_id;
       }
 
-      // set the client secret (required - default is null)
+      // set the client secret (optional - default is null)
       if (typeof props.authentication.client_secret === 'string') {
         clientSecret = props.authentication.client_secret;
       }
 
-      // set the grant type (required - default is null)
+      // set the grant type (optional - default is null)
       if (typeof props.authentication.grant_type === 'string') {
         grantType = props.authentication.grant_type;
       }
+
+      // set the sso (optional - default is null)
+      if (props.authentication.sso && typeof props.authentication.sso === 'object') {
+        sso = props.authentication.sso;
+      }
     }
 
     // set the stub mode (optional - default is false)

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/lib/translatorUtil.js

@@ -247,6 +247,7 @@ function extractObject(dataObj, entitySchema, dynamicFields) {
   log.trace(origin);
   const returnObj = {};
   let addFields = dynamicFields;
+  const regex = /(?<!\\)\./gm;
 
   // if no translation needed - just return the object
   if (Object.hasOwnProperty.call(entitySchema, 'translate')
@@ -278,7 +279,7 @@ function extractObject(dataObj, entitySchema, dynamicFields) {
       // if the external name is something get that field
       if (field.external_name) {
         // need to determine the field in the incoming object where the data is
-        const externalPath = field.external_name.split('.');
+        const externalPath = field.external_name.split(regex).map((e) => (e.replace(/\\./g, '.')));
         let location = dataObj;
         let inField = null;
 
@@ -349,7 +350,7 @@ function extractObject(dataObj, entitySchema, dynamicFields) {
         // if the field is not in the schema - we need to add it
         // using the field name that came in since no translation
         if (field.external_name) {
-          const externalPath = field.external_name.split('.');
+          const externalPath = field.external_name.split(regex).map((e) => (e.replace(/\\./g, '.')));
 
           if (externalPath[externalPath.length - 1] === objectKeys[o]) {
             found = true;
@@ -488,7 +489,7 @@ function extractJSONEntity(dataObj, entitySchema) {
 function buildObject(dataObj, entitySchema, dynamicFields) {
   const origin = `${id}-translatorUtil-buildObject`;
   log.trace(origin);
-
+  const regex = /(?<!\\)\./gm;
   const returnObj = {};
   let addFields = dynamicFields;
 
@@ -531,7 +532,7 @@ function buildObject(dataObj, entitySchema, dynamicFields) {
         // if in the data object, add to the system entity
         if (fieldValue !== null) {
           // need to determine the field in the object where the data should go
-          const externalPath = field.external_name.split('.');
+          const externalPath = field.external_name.split(regex).map((e) => (e.replace(/\\./g, '.')));
           let location = returnObj;
 
           // get to the field in the object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "4.45.7",
+  "version": "4.48.0",
   "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",
@@ -252,6 +257,34 @@
           "type": "string",
           "description": "The grant type for OAuth requests - can also provide in schema",
           "default": ""
+        },
+        "sso": {
+          "type": "object",
+          "properties": {
+            "protocol": {
+              "type": "string",
+              "description": "the protocol to request token from system",
+              "default": "",
+              "enum": [
+                "http", "https", ""
+              ]
+            },
+            "host": {
+              "type": "string",
+              "description": "hostname of the authentication system",
+              "default": "",
+              "examples": [
+                "systemx.customer.com"
+              ]
+            },
+            "port": {
+              "type": "integer",
+              "description": "port on which to connect to the authentication system",
+              "default": 0,
+              "minimum": 0,
+              "maximum": 65535
+            }
+          }
         }
       },
       "required": [
@@ -354,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": [
@@ -434,6 +468,7 @@
         "priorities": {
           "type": "array",
           "description": "define your priorities here",
+          "default": [],
           "items": {
             "type": "object",
             "properties": {
@@ -504,6 +539,7 @@
         "failover_codes": {
           "type": "array",
           "description": "An array of codes where it is ok to try another method",
+          "default": [],
           "items": {
             "type": "integer"
           }
@@ -521,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": {}
             }
           }
         },