Merge pull request #63 from Axway-API-Builder-Ext/add-remove-all-namespaces

Author: Chris Wiechmann

api-builder-plugin-fn-xml-node/src/flow-nodes.yml

@@ -26,13 +26,21 @@ flow-nodes:
               type: boolean
           selectPath:
             name: Select object with path
-            description: "Select the object within the returned structure using this path. Example: $[\"soap:Envelope\"][\"soap:Body\"]"
+            description: "Select the object within the returned structure using this path. Example: $[\"soap:Envelope\"][\"soap:Body\"]. If you remove namespaces, remember to also remove them here."
             required: false
             initialType: string
             schema:
               type: string
+          removeAllNamespaces:
+            name: Remove all namespaces
+            description: 'This will remove all namespaces from the JSON-message. Overrides Remove Specific Namespaces.'
+            required: false
+            initialType: boolean
+            schema:
+              default: false
+              type: boolean
           removeNamespaces:
-            name: Remove namespaces
+            name: Remove specific namespaces
             description: 'An Array of namespaces to be removed from the JSON-Message. Example: ["v1"] will convert the following: "<v1:radius_airportsResponse>" into "radius_airportsResponse": {'
             required: false
             initialType: array

api-builder-plugin-fn-xml-node/src/xmlToJson.js

@@ -21,7 +21,7 @@ var jp = require('jsonpath');
  *	 does not define "next", the first defined output).
  */
 async function xml2json(params, options) {
-	const { xmlData, asString, selectPath, removeNamespaces, ignoreCdata, nativeBooleans } = params;
+	const { xmlData, asString, selectPath, removeAllNamespaces, removeNamespaces, ignoreCdata, nativeBooleans } = params;
 	const { logger } = options;
 	if (!xmlData) {
 		throw new Error('Missing required parameter: xmlData');
@@ -42,7 +42,7 @@ async function xml2json(params, options) {
 	if(nativeBooleans) {
 		xml2JsonOptions.textFn = handleTextFnNativeBoolean;
 	}
-	if (removeNamespaces) {
+	if ((removeNamespaces) || (removeAllNamespaces)) {
 		xml2JsonOptions.elementNameFn = removeNamespacesFn;
 	}
 
@@ -59,15 +59,18 @@ async function xml2json(params, options) {
 		logger.error(e.message);
 		throw new Error(`Failed to convert XML to JSON. Error: ${e.message}`);
 	}
+	
 	if (typeof result === 'undefined') {
 		throw new Error(`Failed to convert XML to JSON. Error: result is undefined`);
 	}
+	
 	if (selectPath) {
 		result = jp.value(result, selectPath);
 		if (result == undefined) {
 			throw new Error(`Nothing found in response message based on path: '${selectPath}'.`);
 		}
 	}
+	
 	return result;
 
 	function handleTextFn(value, parentElement) {
@@ -133,13 +136,22 @@ async function xml2json(params, options) {
 	}
 
 	function removeNamespacesFn(val) {
-		if (val.indexOf(":") == -1) return val;
+		if (val.indexOf(":") == -1) {
+			return val;
+		}
+
+		if (removeAllNamespaces == true) {
+			// Don't need to check for ":" because of previous check
+			return val.split(":")[1];
+		}
+
 		for (var i = 0; i < removeNamespaces.length; ++i) {
 			var namespace = removeNamespaces[i];
 			if (val.startsWith(`${namespace}:`)) {
 				return val.replace(`${namespace}:`, '');
 			}
 		}
+
 		return val;
 	}
 }

api-builder-plugin-fn-xml-node/test/testMessages/airports_soap_body_no_namespace_or_envelope.json

@@ -0,0 +1,30 @@
+{
+  "Envelope": {
+    "Header": {},
+    "Body": {
+      "radius_airportsResponse": {
+        "return": {
+          "fs": "TXL",
+          "iata": "TXL",
+          "icao": "TXL",
+          "faa": "TXL",
+          "name": "Berlin Tegel",
+          "street1": "Saatwinkler Damm",
+          "city": "Berlin",
+          "cityCode": "B",
+          "stateCode": "B",
+          "postalCode": "13405",
+          "countryCode": "DE",
+          "countryName": "Germany",
+          "regionName": "DE",
+          "timeZoneRegionName": "GMT",
+          "weatherZone": "Germany",
+          "localTime": "19:02",
+          "utcOffsetHours": "-1",
+          "latitude": "39.0438",
+          "longitude": "-77.4874"
+        }
+      }
+    }
+  }
+}

api-builder-plugin-fn-xml-node/test/xmlToJsonTest.js

@@ -104,7 +104,27 @@ describe('api-builder-plugin-fn-xml-node', () => {
 			expect(output).to.equal('error');
 		});
 
-		it('should return only the SOAP-Body and Namespaces removed', async () => {
+		it('should return only the SOAP-Body and all Namespaces removed and removeNamespaces not set', async () => {
+			var xmlMessage = require('fs').readFileSync('./test/testMessages/airports_soap_response_namespace.xml', 'utf8');
+			var jsonMessage = JSON.parse(require('fs').readFileSync('./test/testMessages/airports_soap_body_no_namespace_or_envelope.json', 'utf8'));
+			const { value, output } = await flowNode.xml2json({ xmlData: xmlMessage, selectPath: '$[\"Envelope\"][\"Body\"]', removeAllNamespaces: true, removeNamespaces: null });
+				
+			expect(output).to.equal('next');
+			expect(value).to.be.a('object');
+			expect(value).to.deep.equal(jsonMessage['Envelope']['Body']);
+		});
+		
+		it('should return only the SOAP-Body and all Namespaces removed and removeNamespaces also set to only one value', async () => {
+			var xmlMessage = require('fs').readFileSync('./test/testMessages/airports_soap_response_namespace.xml', 'utf8');
+			var jsonMessage = JSON.parse(require('fs').readFileSync('./test/testMessages/airports_soap_body_no_namespace_or_envelope.json', 'utf8'));
+			const { value, output } = await flowNode.xml2json({ xmlData: xmlMessage, selectPath: '$[\"Envelope\"][\"Body\"]', removeAllNamespaces: true, removeNamespaces: ['v1'] });
+
+			expect(output).to.equal('next');
+			expect(value).to.be.a('object');
+			expect(value).to.deep.equal(jsonMessage['Envelope']['Body']);
+		});
+
+		it('should return only the SOAP-Body and Namespaces removed and RemoveAllNamespaces not set', async () => {
 			var xmlMessage = require('fs').readFileSync('./test/testMessages/airports_soap_response_namespace.xml', 'utf8');
 			var jsonMessage = JSON.parse(require('fs').readFileSync('./test/testMessages/airports_soap_body_no_namespace.json', 'utf8'));
 			const { value, output } = await flowNode.xml2json({ xmlData: xmlMessage, selectPath: '$[\"soapenv:Envelope\"][\"soapenv:Body\"]', removeNamespaces: ['v1', 'v2'] });