@itentialopensource/adapter-utils 5.2.0 → 5.3.1

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 
+## 5.3.1 [11-17-2023]
+
+* logic to convert object to array when specified
+
+Closes ADAPT-2943
+
+See merge request itentialopensource/adapter-utils!280
+
+---
+
+## 5.3.0 [10-19-2023]
+
+* ADAPT-485: AWS Auth
+
+Closes ADAPT-485
+
+See merge request itentialopensource/adapter-utils!278
+
+---
+
 ## 5.2.0 [10-04-2023]
 
 * Broker Changes

package/lib/connectorRest.js

@@ -40,6 +40,7 @@ const noFailover = 'AD.500';
 let transUtilInst = null;
 let propUtilInst = null;
 let dbUtilInst = null;
+let authUtilInst = null;
 
 // Global Variables - From Properties
 let props = {};
@@ -1701,7 +1702,7 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
           if (tokenSchema && tokenSchema.responseDatatype && tokenSchema.responseDatatype.toUpperCase() === 'PLAIN') {
             // add the Plain headers if they were not set already
             thisAHdata.Accept = 'text/plain';
-          } else if (tokenSchema && tokenSchema.responseDatatype && tokenSchema.responseDatatype.toUpperCase() === 'XML') {
+          } else if (tokenSchema && tokenSchema.responseDatatype && (tokenSchema.responseDatatype.toUpperCase() === 'XML' || tokenSchema.responseDatatype.toUpperCase() === 'XML2JSON')) {
             // add the XML headers if they were not set already
             thisAHdata.Accept = 'application/xml';
           } else if (tokenSchema && tokenSchema.responseDatatype && tokenSchema.responseDatatype.toUpperCase() === 'URLENCODE') {
@@ -3133,6 +3134,30 @@ function requestAuthenticate(request, entitySchema, invalidToken, callProperties
         return makeRequest(request, entitySchema, callProperties, null, 0, callback);
       });
     }
+
+    if (authMethod === 'aws_authentication') {
+      let stsParams = null; let roleName = null;
+      if (request.authData) {
+        stsParams = request.authData.stsParams;
+        roleName = request.authData.roleName;
+      }
+      const { service } = props;
+      if (request.header.headers['Content-length']) {
+        delete request.header.headers['Content-length'];
+      }
+      const reqObjAWS = {
+        payload: request.body,
+        addlHeaders: request.header.headers,
+        callProperties
+      };
+      return authUtilInst.getAWSAuthorization(request.header.method, reqObjAWS, request.header.path, service, stsParams, roleName, (signature, awsError) => {
+        if (awsError) {
+          return callback(awsError);
+        }
+        request.header.headers = { ...request.header.headers, ...signature };
+        return makeRequest(request, entitySchema, callProperties, null, 0, callback);
+      });
+    }
     // if no_authentication, there is no change to the request!
 
     // actual call to make the request
@@ -3768,7 +3793,7 @@ class ConnectorRest {
    * Connector
    * @constructor
    */
-  constructor(prongid, properties, transUtilCl, propUtilCl, dbUtilCl) {
+  constructor(prongid, properties, transUtilCl, propUtilCl, dbUtilCl, authUtilCl) {
     this.myid = prongid;
     id = prongid;
 
@@ -3778,6 +3803,8 @@ class ConnectorRest {
     propUtilInst = this.propUtil;
     this.dbUtil = dbUtilCl;
     dbUtilInst = this.dbUtil;
+    this.authUtil = authUtilCl;
+    authUtilInst = this.authUtil;
 
     // this uniquely identifies this adapter on this pronghorn system
     phInstance = `${id}-${os.hostname()}`;

package/lib/requestHandler.js

@@ -459,6 +459,7 @@ class RequestHandler {
       this.transUtil = new TransUtilCl(prongId, this.propUtil);
       transUtilInst = this.transUtil;
 
+      this.authHandler = new AuthHandlerCl(this.myid, this.props, this);
       // validate the action files for the adapter
       this.clean = walkThroughActionFiles(this.directory);
 
@@ -469,12 +470,11 @@ class RequestHandler {
       this.refreshProperties(properties);
 
       // instantiate other runtime components
-      this.connector = new ConnectorCl(this.myid, this.props, this.transUtil, this.propUtil, this.dbUtil);
+      this.connector = new ConnectorCl(this.myid, this.props, this.transUtil, this.propUtil, this.dbUtil, this.authHandler);
       this.restHandler = new RestHandlerCl(this.myid, this.props, this.connector, this.transUtil);
       this.brokerHandler = new BrokerHandlerCl(this.myid, this.props, this.directory, this);
       this.genericHandler = new GenericHandlerCl(this.myid, this.props, this);
       this.cacheHandler = new CacheHandlerCl(this.myid, this.props, this.directory, this);
-      this.authHandler = new AuthHandlerCl(this.myid, this.props, this);
     } catch (e) {
       // handle any exception
       const origin = `${this.myid}-requestHandler-constructor`;

package/lib/restHandler.js

@@ -25,6 +25,7 @@ let encodeUri = true;
 let stripEscapes = false;
 let returnResponseHeaders = true;
 let healthcheckHeaders = null;
+let xmlArrayKeys = null;
 // INTERNAL FUNCTIONS
 /*
  * INTERNAL FUNCTION: Get the best match for the mock data response
@@ -105,6 +106,24 @@ function checkBodyData(uriPath, method, reqBdObj, mockresponses) {
   return specificResp;
 }
 
+/*
+ * INTERNAL FUNCTION: recursively convert objects to array at keys specified in keys array
+ */
+function setArrays(obj, keys) {
+  const currentObj = obj;
+  if (typeof currentObj === 'object') {
+    Object.keys(currentObj).forEach((key) => {
+      if (keys.includes(key)) {
+        if (!Array.isArray(currentObj[key])) {
+          currentObj[key] = [currentObj[key]];
+        }
+      }
+      // Recurse for nested keys
+      setArrays(currentObj[key], keys);
+    });
+  }
+}
+
 /**
  * INTERNAL FUNCTION
  *
@@ -405,6 +424,10 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
               log.warn(`${origin}: Unable to parse xml to json ${error}`);
               return callback(retObject);
             }
+            // Logic to convert keys specified to array if object
+            if (xmlArrayKeys) {
+              setArrays(result, xmlArrayKeys);
+            }
             retObject.response = result;
             return callback(retObject);
           });
@@ -864,7 +887,7 @@ function mergeHeaders(addlHeaders, entitySchema) {
     if (entitySchema && entitySchema.responseDatatype && entitySchema.responseDatatype.toUpperCase() === 'PLAIN') {
       // add the Plain headers if they were not set already
       thisAHdata.Accept = 'text/plain';
-    } else if (entitySchema && entitySchema.responseDatatype && entitySchema.responseDatatype.toUpperCase() === 'XML') {
+    } else if (entitySchema && entitySchema.responseDatatype && (entitySchema.responseDatatype.toUpperCase() === 'XML' || entitySchema.responseDatatype.toUpperCase() === 'XML2JSON')) {
       // add the XML headers if they were not set already
       thisAHdata.Accept = 'application/xml';
     } else if (entitySchema && entitySchema.responseDatatype && entitySchema.responseDatatype.toUpperCase() === 'URLENCODE') {
@@ -1063,6 +1086,10 @@ class RestHandler {
     if (properties.healthcheck && typeof properties.healthcheck.addlHeaders === 'object') {
       healthcheckHeaders = properties.healthcheck.addlHeaders;
     }
+
+    if (properties.xmlArrayKeys && typeof properties.xmlArrayKeys === 'object') {
+      xmlArrayKeys = properties.xmlArrayKeys;
+    }
   }
 
   /**

package/package.json

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

package/schemas/propertiesSchema.json

@@ -83,6 +83,14 @@
         "https"
       ]
     },
+    "service" : {
+      "type" : "string",
+      "description": "Service we are integrating with -- used with AWS Authentication",
+      "examples" : [
+        "ec2",
+        "route53"
+      ]
+    },
     "authentication": {
       "$ref": "#/definitions/authentication"
     },
@@ -131,7 +139,8 @@
             "jwt_token",
             "request_token",
             "no_authentication",
-            "multi_step_authentication"
+            "multi_step_authentication",
+            "aws_authentication"
           ]
         },
         "username": {