fast-xml-parser 4.0.6 → 4.0.9

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 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.9 / 2022-07-10**
+* fix #470: stop-tag can have self-closing tag with same name
+* fix #472: stopNode can have any special tag inside
+* Allow !ATTLIST and !NOTATION with DOCTYPE
+* Add transformTagName option to transform tag names when parsing (#469) (By [Erik Rothoff Andersson](https://github.com/erkie))
+
+**4.0.8 / 2022-05-28**
+* Fix CDATA parsing returning empty string when value = 0 (#451) (By [ndelanou](https://github.com/ndelanou))
+* Fix stopNodes when same tag appears inside node (#456) (By [patrickshipe](https://github.com/patrickshipe))
+* fix #468: prettify own properties only
+
+**4.0.7 / 2022-03-18**
+* support CDATA even if tag order is not preserved
+* support Comments even if tag order is not preserved
+* fix #446: XMLbuilder should not indent XML declaration
+
 **4.0.6 / 2022-03-08**
 * fix: call tagValueProcessor only once for array items
 * fix: missing changed for #437

package/README.md

@@ -11,6 +11,8 @@
 
 Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.
 
+> Looking for maintainers
+
 <a href="https://opencollective.com/fast-xml-parser/donate" target="_blank">
   <img src="https://opencollective.com/fast-xml-parser/donate/button@2x.png?color=blue" width=200 />
 </a>
@@ -18,6 +20,8 @@ Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++
 
 Check [ThankYouBackers](https://github.com/NaturalIntelligence/ThankYouBackers) for our contributors
 
+
+
 [![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/)
 ## Users
 
@@ -100,12 +104,12 @@ In a HTML page
 
 Check lib folder for different browser bundles
 
-| Bundle Name | Size |
-| -- | -- |
-| fxbuilder.min.js | 5.2K |
-| fxparser.js |  50K |
-| fxparser.min.js |  17K |
-| fxp.min.js |  22K |
+| Bundle Name        | Size |
+| ------------------ | ---- |
+| fxbuilder.min.js   | 5.2K |
+| fxparser.js        | 50K  |
+| fxparser.min.js    | 17K  |
+| fxp.min.js         | 22K  |
 | fxvalidator.min.js | 5.7K |
 
 ### Documents
@@ -140,7 +144,7 @@ Check lib folder for different browser bundles
 * **[BigBit standard](https://github.com/amitguptagwl/bigbit)** : 
   * Single text encoding to replace UTF-8, UTF-16, UTF-32 and more with less memory.
   * Single Numeric datatype alternative of integer, float, double, long, decimal and more without precision loss.
-* **[Cytorus](https://github.com/NaturalIntelligence/cytorus)**: Now be specific and flexible while running E2E tests.
+* **[Cytorus](https://github.com/NaturalIntelligence/cytorus)**:  Be specific and flexible while running E2E tests.
   * Run tests only for a particular User Story
   * Run tests for a route or from a route
   * Customizable reporting

package/package.json

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

package/src/fxp.d.ts

@@ -22,6 +22,7 @@ type X2jOptions = {
   htmlEntities: boolean;
   ignoreDeclaration: boolean;
   ignorePiTags: boolean;
+  transformTagName: ((tagName: string) => string) | false;
 };
 type strnumOptions = {
   hex: boolean;

package/src/xmlbuilder/json2xml.js

@@ -30,7 +30,8 @@ const defaultOptions = {
     { regex: new RegExp("\"", "g"), val: """ }
   ],
   processEntities: true,
-  stopNodes: []
+  stopNodes: [],
+  transformTagName: false,
 };
 
 function Builder(options) {
@@ -172,11 +173,10 @@ function buildObjectNode(val, key, attrStr, level) {
   }
 
   if (attrStr && val.indexOf('<') === -1) {
-    return (
-      this.indentate(level) + '<' +  key + attrStr + piClosingChar + '>' +
-      val +
-      tagEndExp    );
-  } else {
+    return ( this.indentate(level) + '<' +  key + attrStr + piClosingChar + '>' + val + tagEndExp );
+  } else if (this.options.commentPropName !== false && key === this.options.commentPropName && piClosingChar.length === 0) {
+    return this.indentate(level) + `<!--${val}-->` + this.newLine;
+  }else {
     return (
       this.indentate(level) + '<' + key + attrStr + piClosingChar + this.tagEndChar +
       val +
@@ -194,20 +194,27 @@ function buildEmptyObjNode(val, key, attrStr, level) {
 }
 
 function buildTextValNode(val, key, attrStr, level) {
-  let textValue = this.options.tagValueProcessor(key, val);
-  textValue = this.replaceEntitiesValue(textValue);
-
-  if( textValue === '' && this.options.unpairedTags.indexOf(key) !== -1){ //unpaired
-    if(this.options.suppressUnpairedNode){
-      return this.indentate(level) + '<' + key + this.tagEndChar;
-    }else{
-      return this.indentate(level) + '<' + key + "/" + this.tagEndChar;
-    }
+  if (this.options.cdataPropName !== false && key === this.options.cdataPropName) {
+    return this.indentate(level) + `<![CDATA[${val}]]>` +  this.newLine;
+  }else if (this.options.commentPropName !== false && key === this.options.commentPropName) {
+    return this.indentate(level) + `<!--${val}-->` +  this.newLine;
   }else{
-    return (
-      this.indentate(level) + '<' + key + attrStr + '>' +
-       textValue +
-      '</' + key + this.tagEndChar  );
+    let textValue = this.options.tagValueProcessor(key, val);
+    textValue = this.replaceEntitiesValue(textValue);
+  
+    if( textValue === '' && this.options.unpairedTags.indexOf(key) !== -1){ //unpaired
+      if(this.options.suppressUnpairedNode){
+        return this.indentate(level) + '<' + key + this.tagEndChar;
+      }else{
+        return this.indentate(level) + '<' + key + "/" + this.tagEndChar;
+      }
+    } else{
+      return (
+        this.indentate(level) + '<' + key + attrStr + '>' +
+         textValue +
+        '</' + key + this.tagEndChar  );
+    }
+
   }
 }
 

package/src/xmlbuilder/orderedJs2Xml.js

@@ -41,7 +41,10 @@ function arrToStr(arr, options, jPath, level){
             continue;
         }else if( tagName[0] === "?"){
             const attStr = attr_to_str(tagObj[":@"], options);
-            xmlStr += indentation + `<${tagName} ${tagObj[tagName][0][options.textNodeName]} ${attStr}?>`;
+            const tempInd = tagName === "?xml" ? "" : indentation;
+            let piTextNodeName = tagObj[tagName][0][options.textNodeName];
+            piTextNodeName = piTextNodeName.length !== 0 ? " " + piTextNodeName : ""; //remove extra spacing
+            xmlStr += tempInd + `<${tagName}${piTextNodeName}${attStr}?>`;
             continue;
         }
         const attStr = attr_to_str(tagObj[":@"], options);

package/src/xmlparser/DocTypeReader.js

@@ -38,6 +38,31 @@ function readDocType(xmlData, i){
                 ){
                     //Not supported
                     i += 8;
+                }else if( hasBody && 
+                    xmlData[i+1] === '!' &&
+                    xmlData[i+2] === 'A' &&
+                    xmlData[i+3] === 'T' &&
+                    xmlData[i+4] === 'T' &&
+                    xmlData[i+5] === 'L' &&
+                    xmlData[i+6] === 'I' &&
+                    xmlData[i+7] === 'S' &&
+                    xmlData[i+8] === 'T'
+                ){
+                    //Not supported
+                    i += 8;
+                }else if( hasBody && 
+                    xmlData[i+1] === '!' &&
+                    xmlData[i+2] === 'N' &&
+                    xmlData[i+3] === 'O' &&
+                    xmlData[i+4] === 'T' &&
+                    xmlData[i+5] === 'A' &&
+                    xmlData[i+6] === 'T' &&
+                    xmlData[i+7] === 'I' &&
+                    xmlData[i+8] === 'O' &&
+                    xmlData[i+9] === 'N'
+                ){
+                    //Not supported
+                    i += 9;
                 }else if( //comment
                     xmlData[i+1] === '!' &&
                     xmlData[i+2] === '-' &&

package/src/xmlparser/OptionsBuilder.js

@@ -30,7 +30,8 @@ const defaultOptions = {
     processEntities: true,
     htmlEntities: false,
     ignoreDeclaration: false,
-    ignorePiTags: false
+    ignorePiTags: false,
+    transformTagName: false,
 };
    
 const buildOptions = function(options) {

package/src/xmlparser/OrderedObjParser.js

@@ -193,6 +193,10 @@ const parseXml = function(xmlData) {
           }
         }
 
+        if(this.options.transformTagName) {
+          tagName = this.options.transformTagName(tagName);
+        }
+
         if(currentNode){
           textData = this.saveTextToParentTag(textData, currentNode, jPath);
         }
@@ -251,18 +255,21 @@ const parseXml = function(xmlData) {
           currentNode.add(this.options.cdataPropName, [ { [this.options.textNodeName] : tagExp } ]);
         }else{
           let val = this.parseTextData(tagExp, currentNode.tagname, jPath, true, false, true);
-          if(!val) val = "";
+          if(val == undefined) val = "";
           currentNode.add(this.options.textNodeName, val);
         }
         
         i = closeIndex + 2;
       }else {//Opening tag
-       
         let result = readTagExp(xmlData,i, this. options.removeNSPrefix);
         let tagName= result.tagName;
         let tagExp = result.tagExp;
         let attrExpPresent = result.attrExpPresent;
         let closeIndex = result.closeIndex;
+
+        if (this.options.transformTagName) {
+          tagName = this.options.transformTagName(tagName);
+        }
         
         //save text as child node
         if (currentNode && textData) {
@@ -322,6 +329,10 @@ const parseXml = function(xmlData) {
             }else{
               tagExp = tagExp.substr(0, tagExp.length - 1);
             }
+            
+            if(this.options.transformTagName) {
+              tagName = this.options.transformTagName(tagName);
+            }
 
             const childNode = new xmlNode(tagName);
             if(tagName !== tagExp && attrExpPresent){
@@ -486,17 +497,44 @@ function readTagExp(xmlData,i, removeNSPrefix, closingChar = ">"){
  */
 function readStopNodeData(xmlData, tagName, i){
   const startIndex = i;
+  // Starting at 1 since we already have an open tag
+  let openTagCount = 1;
+
   for (; i < xmlData.length; i++) {
-    if( xmlData[i] === "<" && xmlData[i+1] === "/"){ 
-        const closeIndex = findClosingIndex(xmlData, ">", i, `${tagName} is not closed`);
-        let closeTagName = xmlData.substring(i+2,closeIndex).trim();
-        if(closeTagName === tagName){
-          return {
-            tagContent: xmlData.substring(startIndex, i),
-            i : closeIndex
+    if( xmlData[i] === "<"){ 
+      if (xmlData[i+1] === "/") {//close tag
+          const closeIndex = findClosingIndex(xmlData, ">", i, `${tagName} is not closed`);
+          let closeTagName = xmlData.substring(i+2,closeIndex).trim();
+          if(closeTagName === tagName){
+            openTagCount--;
+            if (openTagCount === 0) {
+              return {
+                tagContent: xmlData.substring(startIndex, i),
+                i : closeIndex
+              }
+            }
+          }
+          i=closeIndex;
+        } else if(xmlData[i+1] === '?') { 
+          const closeIndex = findClosingIndex(xmlData, "?>", i+1, "StopNode is not closed.")
+          i=closeIndex;
+        } else if(xmlData.substr(i + 1, 3) === '!--') { 
+          const closeIndex = findClosingIndex(xmlData, "-->", i+3, "StopNode is not closed.")
+          i=closeIndex;
+        } else if(xmlData.substr(i + 1, 2) === '![') { 
+          const closeIndex = findClosingIndex(xmlData, "]]>", i, "StopNode is not closed.") - 2;
+          i=closeIndex;
+        } else {
+          const tagData = readTagExp(xmlData, i, '>')
+
+          if (tagData) {
+            const openTagName = tagData && tagData.tagName;
+            if (openTagName === tagName && tagData.tagExp[tagData.tagExp.length-1] !== "/") {
+              openTagCount++;
+            }
+            i=tagData.closeIndex;
           }
         }
-        i=closeIndex;
       }
   }//end for loop
 }

package/src/xmlparser/node2json.js

@@ -46,9 +46,9 @@ function compress(arr, options, jPath){
         else val = "";
       }
 
-      if(compressedObj[property] !== undefined) {
+      if(compressedObj[property] !== undefined && compressedObj.hasOwnProperty(property)) {
         if(!Array.isArray(compressedObj[property])) {
-          compressedObj[property] = [ compressedObj[property] ];
+            compressedObj[property] = [ compressedObj[property] ];
         }
         compressedObj[property].push(val);
       }else{