@itentialopensource/adapter-utils 5.3.10 → 5.5.0

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 
+## 5.5.0 [05-30-2024]
+
+* Add support for gzip responsedatatype
+
+Closes ADAPT-3270
+
+See merge request itentialopensource/adapter-utils!293
+
+---
+
+## 5.4.0 [04-26-2024]
+
+* changes to support changing scope and resource
+
+Closes ADAPT-3342
+
+See merge request itentialopensource/adapter-utils!292
+
+---
+
 ## 5.3.10 [03-06-2024]
 
 * Fix some security vulnerabilities

package/lib/connectorRest.js

@@ -58,6 +58,8 @@ let username = null;
 let password = null;
 let clientId = null;
 let clientSecret = null;
+let scope = null;
+let resource = null;
 let grantType = null;
 let staticToken = null;
 let tokenUserField = 'username';
@@ -2083,6 +2085,12 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
               if (clientSecret) {
                 creds.client_secret = clientSecret;
               }
+              if (scope) {
+                creds.scope = scope;
+              }
+              if (resource) {
+                creds.resource = resource;
+              }
               if (grantType) {
                 creds.grant_type = grantType;
               }
@@ -2092,6 +2100,12 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
               if (callProperties && callProperties.authentication && callProperties.authentication.client_secret) {
                 creds.client_secret = callProperties.authentication.client_secret;
               }
+              if (callProperties && callProperties.authentication && callProperties.authentication.scope) {
+                creds.scope = callProperties.authentication.scope;
+              }
+              if (callProperties && callProperties.authentication && callProperties.authentication.resource) {
+                creds.resource = callProperties.authentication.resource;
+              }
               if (callProperties && callProperties.authentication && callProperties.authentication.grant_type) {
                 creds.grant_type = callProperties.authentication.grant_type;
               }
@@ -3986,6 +4000,16 @@ class ConnectorRest {
         clientSecret = props.authentication.client_secret;
       }
 
+      // set the client secret (optional - default is null)
+      if (typeof props.authentication.scope === 'string') {
+        scope = props.authentication.scope;
+      }
+
+      // set the client secret (optional - default is null)
+      if (typeof props.authentication.resource === 'string') {
+        resource = props.authentication.resource;
+      }
+
       // set the grant type (optional - default is null)
       if (typeof props.authentication.grant_type === 'string') {
         grantType = props.authentication.grant_type;

package/lib/restHandler.js

@@ -8,6 +8,7 @@ const querystring = require('querystring');
 const jsonQuery = require('json-query');
 const jsonxml = require('jsontoxml');
 const xml2js = require('xml2js');
+const pako = require('pako');
 
 const globalSchema = JSON.parse(require('fs').readFileSync(require('path').join(__dirname, '/../schemas/globalSchema.json')));
 
@@ -52,6 +53,19 @@ function matchResponse(uriPath, method, type, mockresponses) {
   return null;
 }
 
+/*
+ * INTERNAL FUNCTION: Parse XML
+ */
+function parseXML(xmlString, callback) {
+  const parser = new xml2js.Parser({ explicitArray: false, attrkey: '_attr' });
+  parser.parseString(xmlString, (error, result) => {
+    if (error) {
+      return callback(error);
+    }
+    return callback(null, result);
+  });
+}
+
 /*
  * INTERNAL FUNCTION: recursively inspect body data if heirarchical
  */
@@ -477,6 +491,53 @@ function handleRestRequest(request, entityId, entitySchema, callProperties, filt
       if (entitySchema && entitySchema.responseDatatype && entitySchema.responseDatatype.toUpperCase() === 'URLENCODE') {
         // return the response
         retResponse = querystring.parse(resObj.response.trim());
+      } else if (entitySchema && entitySchema.responseDatatype && (entitySchema.responseDatatype.toUpperCase() === 'GZIP2PLAIN'
+          || entitySchema.responseDatatype.toUpperCase() === 'GZIP2JSON' || entitySchema.responseDatatype.toUpperCase() === 'GZIP2XML'
+          || entitySchema.responseDatatype.toUpperCase() === 'GZIP2XML2JSON')) {
+        // If response is GZIP
+        const responseDatatype = entitySchema.responseDatatype.toUpperCase();
+        const responseBody = pako.inflate(Buffer.from(resObj.response, 'binary'), { to: 'string' });
+        // Handle conversion based on responseDatatype
+        if (responseDatatype === 'GZIP2PLAIN') {
+          retObject.response = responseBody;
+        } else if (responseDatatype === 'GZIP2JSON') {
+          // Parse responseBody as JSON
+          retObject.response = JSON.parse(responseBody);
+        } else if (responseDatatype === 'GZIP2XML' || responseDatatype === 'GZIP2XML2JSON') {
+          parseXML(responseBody, (error, xmlResult) => {
+            if (error) {
+              log.warn(`${origin}: Error parsing XML response: ${error}`);
+              return callback(retObject);
+            }
+
+            retObject.response = xmlResult;
+
+            if (responseDatatype === 'GZIP2XML2JSON') {
+              // Optionally convert XML to JSON
+              try {
+                const parser = new xml2js.Parser({ explicitArray: false, attrkey: '_attr' });
+                return parser.parseString(xmlResult, (err, result) => {
+                  if (err) {
+                    log.warn(`${origin}: Unable to parse xml to json ${err}`);
+                    return callback(retObject);
+                  }
+                  // Logic to convert keys specified to array if object
+                  if (xmlArrayKeys) {
+                    setArrays(result, xmlArrayKeys);
+                  }
+                  retObject.response = result;
+                  return callback(retObject);
+                });
+              } catch (ex) {
+                log.warn(`${origin}: Unable to get json from xml ${ex}`);
+                return callback(retObject);
+              }
+            }
+
+            log.debug(`${origin}: RESPONSE: ${retObject.response}`);
+            return callback(retObject);
+          });
+        }
       } else {
         // process the response - parse it
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "5.3.10",
+  "version": "5.5.0",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",
@@ -31,7 +31,7 @@
     "aws4": "^1.9.1",
     "cookie": "^0.5.0",
     "crypto-js": "^4.1.1",
-    "ejs": "^3.1.9",
+    "ejs": "^3.1.10",
     "form-data": "^4.0.0",
     "fs-extra": "^11.1.1",
     "https-proxy-agent": "^7.0.0",
@@ -39,6 +39,7 @@
     "jsontoxml": "^1.0.1",
     "jsonwebtoken": "^9.0.1",
     "mongodb": "^3.7.4",
+    "pako": "^2.1.0",
     "querystring": "^0.2.0",
     "readline-sync": "^1.4.10",
     "socks-proxy-agent": "^8.0.1",
@@ -59,6 +60,5 @@
     "testdouble": "^3.18.0",
     "winston": "^3.9.0"
   },
-  "peerDependencies": {},
   "private": false
 }