Support for XML-Declaration added

Author: Chris Wiechmann

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

@@ -2,12 +2,12 @@ flow-nodes:
   xml-node:
     name: XML
     icon: xml-node-icon.png
-    description: Provides support to handle XML-Payload
+    description: 'Provides support to handle XML-Payload. To learn more please read: https://github.com/nashwaan/xml-js'
     category: Utils
     methods:
       xml2json:
         name: XML to JSON
-        description: Converts XML payload into JSON data.
+        description: 'Converts XML payload into JSON data. To learn more please read: https://github.com/nashwaan/xml-js'
         parameters:
           xmlData:
             name: XML Input data
@@ -84,17 +84,20 @@ flow-nodes:
 
       json2xml:
         name: JSON to XML
-        description: Converts JSON payload into XML.
+        description: 'Converts JSON payload into XML. To learn more please read: https://github.com/nashwaan/xml-js'
         parameters:
           jsonData:
             name: JSON Input data
             description: 'JSON Data.'
             required: true
-            schema:
-              type: string
+            schema: 
+              oneOf: [
+                { type: 'string' },
+                { type: 'object' }
+              ]
           asString:
             name: As string
-            description: Wether return the JSON as String or as an Object. Defaults to false.
+            description: Wether return the generated JSON as a String or as an Object. By default a Javascript Object is returned.
             required: false
             initialType: boolean
             schema:
@@ -103,7 +106,6 @@ flow-nodes:
           spaces:
             name: Spaces
             description: 'Number of spaces to be used for indenting XML output. Passing characters like " " or "\t" are also accepted.'
-            group: Standard Options
             required: false
             initialType: number
             schema:
@@ -114,12 +116,18 @@ flow-nodes:
           compact:
             name: Compact
             description: 'Whether the input object is in compact form or not. By default, input is expected to be in compact form. IMPORTANT: Remember to set this option compact: false if you are supplying non-compact json.'
-            group: Standard Options
             required: false
             initialType: boolean
             schema:
               default: true
               type: boolean
+          declaration:
+            name: Declaration
+            description: 'XML declaration attributes to use. For instance { "version": "1.0",  "encoding": "utf-8" }. The XML-Declaration might also be provided using the attribute _declaration in your JSON-Data.'
+            required: false
+            initialType: object
+            schema:
+              type: object
           fullTagEmptyElement:
             name: Full tag empty element
             description: 'Whether to produce element without sub-elements as full tag pairs <a></a> rather than self closing tag <a/>'

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

@@ -21,12 +21,12 @@ var jp = require('jsonpath');
  *	 does not define "next", the first defined output).
  */
 async function json2xml(params, options) {
-	const { jsonData, spaces, compact, fullTagEmptyElement, indentCdata, indentAttributes, ignoreDeclaration, ignoreInstruction, ignoreAttributes, ignoreComment, ignoreCdata, ignoreDoctype, ignoreText } = params;
+	const { spaces, declaration, compact, fullTagEmptyElement, indentCdata, indentAttributes, ignoreDeclaration, ignoreInstruction, ignoreAttributes, ignoreComment, ignoreCdata, ignoreDoctype, ignoreText } = params;
+	let { jsonData} = params;
 	const { logger } = options;
 	if (!jsonData) {
 		throw new Error('Missing required parameter: jsonData');
 	}
-	debugger;
 
 	const json2xmlOptions = {
 		spaces: spaces ? spaces : 0,
@@ -45,14 +45,20 @@ async function json2xml(params, options) {
 	};
 
 	let result;
+	debugger;
 	try {
-		if(jsonData instanceof Object) {
-			logger.debug('Converting given JSON Object into XML.');
-			result = convert.js2xml(jsonData, json2xmlOptions);
-		} else {
-			logger.debug('Converting given JSON String into XML.');
-			result = convert.json2xml(jsonData, json2xmlOptions);
+		// Convert String into an object
+		if (typeof jsonData === 'string' || jsonData instanceof String) {
+			jsonData = JSON.parse(jsonData);
+		}
+		if(Object.keys(jsonData).length === 0) {
+			throw new Error(`Error creating XML from JSON, as the given Javascript object is empty.`);
+		}
+		if(declaration) {
+			jsonData = Object.assign({_declaration: { _attributes: declaration } }, jsonData);
 		}
+		logger.debug('Converting given JSON Object into XML.');
+		result = convert.js2xml(jsonData, json2xmlOptions);
 	} catch (e) {
 		logger.error(e.message);
 		throw new Error(`Failed to convert JSON into XML. Error: ${e.message}`);

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

@@ -50,5 +50,24 @@ describe('json2xmlTest', () => {
 				.and.to.have.property('message');
 			expect(value.message).to.include('Failed to convert JSON into XML. Error: The JSON structure is invalid');
 		});
+
+		it('should fail with an empty Javascript object', async () => {
+			const { value, output } = await flowNode.json2xml({ jsonData: {} });
+
+			expect(output).to.equal('error');
+			expect(value).to.be.instanceOf(Error)
+				.and.to.have.property('message');
+			expect(value.message).to.include('Error creating XML from JSON, as the given Javascript object is empty.');
+		});
+
+		it('should include the given XML declaration', async () => {
+			var xmlMessage = require('fs').readFileSync('./test/testMessages/basic_message-no-attributes-incl-declaration.xml', 'utf8');
+			var jsonMessage = require('fs').readFileSync('./test/testMessages/basic_message.json', 'utf8');
+			const { value, output } = await flowNode.json2xml({ jsonData: jsonMessage, spaces: '\t', declaration: { version: "1.0",  encoding: "utf-8" } });
+
+			expect(output).to.equal('next');
+			expect(value).to.be.a('string');
+			expect(value).to.deep.equal(xmlMessage);
+		});
 	});
 });

api-builder-plugin-fn-xml-node/test/testMessages/basic_message-no-attributes-incl-declaration.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<note>
+	<title>Happy</title>
+	<todo>Work</todo>
+	<todo>Play</todo>
+	<aBoolean>false</aBoolean>
+</note>