fast-xml-parser 4.0.0-beta.6 → 4.0.0-beta.7

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 Note: If you find missing information about particular minor version, that version must have been changed without any functional change in this library.
 
+** 4.0.0-beta.7 / 2021-12-09**
+* fix Validator bug when an attribute has no value but '=' only
+* XML Builder should suppress unpaired tags by default.
+* documents update for missing features
+* refactoring to use Object.assign
+* refactoring to remove repeated code
+
 ** 4.0.0-beta.6 / 2021-12-05**
 * Support PI Tags processing
 * Support `suppressBooleanAttributes` by XML Builder for attributes with value `true`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-xml-parser",
-  "version": "4.0.0-beta.6",
+  "version": "4.0.0-beta.7",
   "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries",
   "main": "./src/fxp.js",
   "scripts": {

package/src/util.js

@@ -67,23 +67,6 @@ exports.getValue = function(v) {
 // const fakeCall = function(a) {return a;};
 // const fakeCallNoReturn = function() {};
 
-const buildOptions = function(options, defaultOptions, props) {
-  let newOptions = {};
-  if (!options) {
-    return defaultOptions; //if there are not options
-  }
-
-  for (let i = 0; i < props.length; i++) {
-    if (options[props[i]] !== undefined) {
-      newOptions[props[i]] = options[props[i]];
-    } else {
-      newOptions[props[i]] = defaultOptions[props[i]];
-    }
-  }
-  return newOptions;
-};
-
-exports.buildOptions = buildOptions;
 exports.isName = isName;
 exports.getAllMatches = getAllMatches;
 exports.nameRegexp = nameRegexp;

package/src/validator.js

@@ -7,14 +7,9 @@ const defaultOptions = {
   unpairedTags: []
 };
 
-const props = [
-  'allowBooleanAttributes',
-  'unpairedTags'
-];
-
 //const tagsPattern = new RegExp("<\\/?([\\w:\\-_\.]+)\\s*\/?>","g");
 exports.validate = function (xmlData, options) {
-  options = util.buildOptions(options, defaultOptions, props);
+  options = Object.assign({}, defaultOptions, options);
 
   //xmlData = xmlData.replace(/(\r\n|\n|\r)/gm,"");//make it single line
   //xmlData = xmlData.replace(/(^\s*<\?xml.*?\?>)/g,"");//Remove XML starting tag
@@ -331,6 +326,8 @@ function validateAttributeString(attrStr, options) {
     if (matches[i][1].length === 0) {
       //nospace before attribute name: a="sd"b="saf"
       return getErrorObject('InvalidAttr', "Attribute '"+matches[i][2]+"' has no space in starting.", getPositionFromMatch(matches[i]))
+    } else if (matches[i][3] !== undefined && matches[i][4] === undefined) {
+      return getErrorObject('InvalidAttr', "Attribute '"+matches[i][2]+"' is without value.", getPositionFromMatch(matches[i]));
     } else if (matches[i][3] === undefined && !options.allowBooleanAttributes) {
       //independent attribute: ab
       return getErrorObject('InvalidAttr', "boolean attribute '"+matches[i][2]+"' is not allowed.", getPositionFromMatch(matches[i]));

package/src/xmlbuilder/json2xml.js

@@ -1,6 +1,5 @@
 'use strict';
 //parse Empty Node as self closing node
-const buildOptions = require('../util').buildOptions;
 const buildFromOrderedJs = require('./orderedJs2Xml');
 
 const defaultOptions = {
@@ -32,30 +31,8 @@ const defaultOptions = {
   stopNodes: []
 };
 
-const props = [
-  'attributeNamePrefix',
-  'attributesGroupName',
-  'textNodeName',
-  'ignoreAttributes',
-  'cdataPropName',
-  'format',
-  'indentBy',
-  'suppressEmptyNode',
-  'suppressBooleanAttributes',
-  'tagValueProcessor',
-  'attributeValueProcessor',
-  'arrayNodeName', //when array as root
-  'preserveOrder',
-  "commentPropName",
-  "unpairedTags",
-  "entities",
-  "processEntities",
-  "stopNodes",
-  // 'rootNodeName', //when jsObject have multiple properties on root level
-];
-
 function Builder(options) {
-  this.options = buildOptions(options, defaultOptions, props);
+  this.options = Object.assign({}, defaultOptions, options);
   if (this.options.ignoreAttributes || this.options.attributesGroupName) {
     this.isAttribute = function(/*a*/) {
       return false;

package/src/xmlbuilder/orderedJs2Xml.js

@@ -47,12 +47,10 @@ function arrToStr(arr, options, jPath, level){
         const attStr = attr_to_str(tagObj[":@"], options);
         let tagStart =  indentation + `<${tagName}${attStr}`;
         let tagValue = arrToStr(tagObj[tagName], options, newJPath, level + 1);
-        if( (!tagValue || tagValue.length === 0) && options.suppressEmptyNode){ 
-            if(options.unpairedTags.indexOf(tagName) !== -1){
-                xmlStr += tagStart + ">"; 
-            }else{
-                xmlStr += tagStart + "/>"; 
-            }
+        if(options.unpairedTags.indexOf(tagName) !== -1){
+            xmlStr += tagStart + ">"; 
+        }else if( (!tagValue || tagValue.length === 0) && options.suppressEmptyNode){ 
+            xmlStr += tagStart + "/>"; 
         }else{ 
             //TODO: node with only text value should not parse the text value in next line
             xmlStr += tagStart + `>${tagValue}${indentation}</${tagName}>` ;

package/src/xmlparser/OptionsBuilder.js

@@ -31,36 +31,9 @@ const defaultOptions = {
     htmlEntities: false,
 };
    
-const props = [
-    'preserveOrder',
-    'attributeNamePrefix',
-    'attributesGroupName',
-    'textNodeName',
-    'ignoreAttributes',
-    'removeNSPrefix',
-    'allowBooleanAttributes',
-    'parseTagValue',
-    'parseAttributeValue',
-    'trimValues',
-    'cdataPropName',
-    'tagValueProcessor',
-    'attributeValueProcessor',
-    'numberParseOptions',
-    'stopNodes',
-    'alwaysCreateTextNode',
-    'isArray',
-    'commentPropName',
-    'unpairedTags',
-    'processEntities',
-    'htmlEntities'
-];
-  
-const util = require('../util');
-
 const buildOptions = function(options) {
-    return util.buildOptions(options, defaultOptions, props);
+    return Object.assign({}, defaultOptions, options);
 };
 
 exports.buildOptions = buildOptions;
-exports.defaultOptions = defaultOptions;
-exports.props = props;
+exports.defaultOptions = defaultOptions;

package/src/xmlparser/OrderedObjParser.js

@@ -49,6 +49,7 @@ class OrderedObjParser{
     this.isItStopNode = isItStopNode;
     this.replaceEntitiesValue = replaceEntitiesValue;
     this.readStopNodeData = readStopNodeData;
+    this.saveTextToParentTag = saveTextToParentTag;
   }
 
 }
@@ -208,53 +209,26 @@ const parseXml = function(xmlData) {
         textData = "";
         i = closeIndex;
       } else if( xmlData[i+1] === '?') {
-        let result = readTagExp(xmlData,i, false, "?>");
-        if(!result) throw new Error("Pi Tag is not closed.");
-        
-        let tagName= result.tagName;
-        let tagExp = result.tagExp;
-        let attrExpPresent = result.attrExpPresent;
-        let closeIndex = result.closeIndex;
-
-          //TODO: remove repeated code
-          if(textData){ //store previously collected data as textNode
-            textData = this.parseTextData(textData
-              , currentNode.tagname
-              , jPath
-              ,false
-              , currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false
-              , Object.keys(currentNode.child).length === 0);
-
-            if(textData !== undefined &&  textData !== "") currentNode.add(this.options.textNodeName, textData);
-            textData = "";
-          }
+        let tagData = readTagExp(xmlData,i, false, "?>");
+        if(!tagData) throw new Error("Pi Tag is not closed.");
+        textData = this.saveTextToParentTag(textData, currentNode, jPath);
 
-          const childNode = new xmlNode(tagName);
-          childNode.add(this.options.textNodeName, "");
-          
-          if(tagName !== tagExp && attrExpPresent){
-            childNode[":@"] = this.buildAttributesMap(tagExp, jPath);
-          }
-          currentNode.addChild(childNode);
+        const childNode = new xmlNode(tagData.tagName);
+        childNode.add(this.options.textNodeName, "");
+        
+        if(tagData.tagName !== tagData.tagExp && tagData.attrExpPresent){
+          childNode[":@"] = this.buildAttributesMap(tagData.tagExp, jPath);
+        }
+        currentNode.addChild(childNode);
 
-        i = closeIndex + 1;
+        i = tagData.closeIndex + 1;
       } else if(xmlData.substr(i + 1, 3) === '!--') {
         const endIndex = findClosingIndex(xmlData, "-->", i, "Comment is not closed.")
         if(this.options.commentPropName){
           const comment = xmlData.substring(i + 4, endIndex - 2);
 
-          //TODO: remove repeated code
-          if(textData){ //store previously collected data as textNode
-            textData = this.parseTextData(textData
-              , currentNode.tagname
-              , jPath
-              ,false
-              , currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false
-              , Object.keys(currentNode.child).length === 0);
-  
-            if(textData !== undefined &&  textData !== "") currentNode.add(this.options.textNodeName, textData);
-            textData = "";
-          }
+          textData = this.saveTextToParentTag(textData, currentNode, jPath);
+
           currentNode.add(this.options.commentPropName, [ { [this.options.textNodeName] : comment } ]);
         }
         i = endIndex;
@@ -266,17 +240,7 @@ const parseXml = function(xmlData) {
         const closeIndex = findClosingIndex(xmlData, "]]>", i, "CDATA is not closed.") - 2;
         const tagExp = xmlData.substring(i + 9,closeIndex);
 
-        if(textData){ //store previously collected data as textNode
-          textData = this.parseTextData(textData
-            , currentNode.tagname
-            , jPath
-            ,false
-            , currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false
-            , Object.keys(currentNode.child).length === 0);
-
-          if(textData !== undefined &&  textData !== "") currentNode.add(this.options.textNodeName, textData);
-          textData = "";
-        }
+        textData = this.saveTextToParentTag(textData, currentNode, jPath);
 
         //cdata should be set even if it is 0 length string
         if(this.options.cdataPropName){
@@ -405,6 +369,22 @@ const replaceEntitiesValue = function(val){
   }
   return val;
 }
+function saveTextToParentTag(textData, currentNode, jPath) {
+  if (textData) { //store previously collected data as textNode
+    textData = this.parseTextData(textData,
+      currentNode.tagname,
+      jPath,
+      false,
+      currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false,
+      Object.keys(currentNode.child).length === 0);
+
+    if (textData !== undefined && textData !== "")
+      currentNode.add(this.options.textNodeName, textData);
+    textData = "";
+  }
+  return textData;
+}
+
 //TODO: use jPath to simplify the logic
 /**
  *