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

package/CHANGELOG.md

@@ -1,26 +1,43 @@
 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**
+**4.0.2 / 2022-02-04**
+* builder supports `suppressUnpairedNode`
+* parser supports `ignoreDeclaration` and `ignorePiTags`
+* fix: when comment is parsed as text value if given as `<!--> ...` #423
+* builder supports decoding `&`
+
+**4.0.1 / 2022-01-08**
+* fix builder for pi tag
+* fix: support suppressBooleanAttrs by builder
+
+**4.0.0 / 2022-01-06**
+* Generating different combined, parser only, builder only, validator only browser bundles
+* Keeping cjs modules as they can be imported in cjs and esm modules both. Otherwise refer `esm` branch.
+
+**4.0.0-beta.8 / 2021-12-13**
+* call tagValueProcessor for stop nodes
+
+**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**
+**4.0.0-beta.6 / 2021-12-05**
 * Support PI Tags processing
 * Support `suppressBooleanAttributes` by XML Builder for attributes with value `true`.
 
-** 4.0.0-beta.5 / 2021-12-04**
+**4.0.0-beta.5 / 2021-12-04**
 * fix: when a tag with name "attributes"
 
-** 4.0.0-beta.4 / 2021-12-02**
+**4.0.0-beta.4 / 2021-12-02**
 * Support HTML document parsing
 * skip stop nodes parsing when building the XML from JS object
 * Support external entites without DOCTYPE
 * update dev dependency: strnum v1.0.5 to fix long number issue
 
-** 4.0.0-beta.3 / 2021-11-30**
+**4.0.0-beta.3 / 2021-11-30**
 * support global stopNodes expression like "*.stop"
 * support self-closing and paired unpaired tags
 * fix: CDATA should not be parsed.

package/README.md

@@ -1,7 +1,6 @@
 # [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser)
 [![Backers on Open Collective](https://opencollective.com/fast-xml-parser/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/fast-xml-parser/sponsors/badge.svg)](#sponsors) [![Known Vulnerabilities](https://snyk.io/test/github/naturalintelligence/fast-xml-parser/badge.svg)](https://snyk.io/test/github/naturalintelligence/fast-xml-parser)
 [![NPM quality][quality-image]][quality-url]
-[![Travis ci Build Status](https://travis-ci.org/NaturalIntelligence/fast-xml-parser.svg?branch=master)](https://travis-ci.org/NaturalIntelligence/fast-xml-parser)
 [![Coverage Status](https://coveralls.io/repos/github/NaturalIntelligence/fast-xml-parser/badge.svg?branch=master)](https://coveralls.io/github/NaturalIntelligence/fast-xml-parser?branch=master)
 [<img src="https://img.shields.io/badge/Try-me-blue.svg?colorA=FFA500&colorB=0000FF" alt="Try me"/>](https://naturalintelligence.github.io/fast-xml-parser/)
 [![NPM total downloads](https://img.shields.io/npm/dt/fast-xml-parser.svg)](https://npm.im/fast-xml-parser)
@@ -90,7 +89,7 @@ const xmlContent = builder.build(jObj);
 
 In a HTML page
 ```html
-<script src="path/to/fxparser.js"></script>
+<script src="path/to/fxp.min.js"></script>
 :
 <script>
   const parser = new fxparser.XMLParser();
@@ -98,6 +97,16 @@ In a HTML page
 </script>
 ```
 
+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 |
+| fxvalidator.min.js | 5.7K |
+
 ### Documents
 **v3**
 * [documents](./docs/v3/docs.md)
@@ -107,9 +116,9 @@ In a HTML page
 2.  [XML Parser](./docs/v4/2.XMLparseOptions.md)
 3.  [XML Builder](./docs/v4/3.XMLBuilder.md)
 4.  [XML Validator](./docs/v4/4.XMLValidator.md)
-5.  [Entites](./docs/5.Entities.md)
-6.  [HTML Document Parsing](./docs/6.HTMLParsing.md)
-7. [PI Tag processing](./docs/7.PITags.md)
+5.  [Entites](./docs/v4/5.Entities.md)
+6.  [HTML Document Parsing](./docs/v4/6.HTMLParsing.md)
+7. [PI Tag processing](./docs/v4/7.PITags.md)
 ## Performance
 
 ### XML Parser
@@ -135,6 +144,7 @@ In a HTML page
   * Run tests for a route or from a route
   * Customizable reporting
   * Central dashboard for better monitoring
+  * Options to integrate E2E tests with Jira, Github etc using Central dashboard `Tian`.
 * **[Stubmatic](https://github.com/NaturalIntelligence/Stubmatic)** : Create fake webservices, DynamoDB or S3 servers, Manage fake/mock stub data, Or fake any HTTP(s) call.
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-xml-parser",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.2",
   "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries",
   "main": "./src/fxp.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "coverage": "nyc report --reporter html --reporter text -t .nyc_output --report-dir .nyc_output/summary",
     "perf": "node ./benchmark/perfTest3.js",
     "lint": "eslint src/*.js spec/*.js",
-    "bundle": "webpack && webpack --config webpack-prod.config.js",
+    "bundle": "webpack --config webpack-prod.config.js",
     "prettier": "prettier --write src/**/*.js",
     "publish-please": "publish-please",
     "checkReadiness": "publish-please --dry-run"
@@ -47,6 +47,7 @@
     "@babel/preset-env": "^7.13.10",
     "@babel/register": "^7.13.8",
     "babel-loader": "^8.2.2",
+    "cytorus": "^0.2.9",
     "eslint": "^8.3.0",
     "he": "^1.2.0",
     "jasmine": "^3.6.4",

package/src/fxp.d.ts

@@ -20,6 +20,8 @@ type X2jOptions = {
   isArray: (tagName: string, jPath: string, isLeafNode: boolean, isAttribute: boolean) => boolean;
   processEntities: boolean;
   htmlEntities: boolean;
+  ignoreDeclaration: boolean;
+  ignorePiTags: boolean;
 };
 type strnumOptions = {
   hex: boolean;
@@ -44,6 +46,7 @@ type XmlBuilderOptions = {
   indentBy: string;
   arrayNodeName: string;
   suppressEmptyNode: boolean;
+  suppressUnpairedNode: boolean;
   suppressBooleanAttributes: boolean;
   preserveOrder: boolean;
   unpairedTags: string[];

package/src/fxp_cjs

@@ -0,0 +1,8 @@
+
+
+const XMLValidator = require('./validator.js');
+const XMLParser = require('./xmlparser/XMLParser.js');
+const XMLBuilder = require('./xmlbuilder/json2xml.js');
+
+module.exports = {XMLParser,XMLValidator, XMLBuilder};
+

package/src/xmlbuilder/json2xml.js

@@ -11,6 +11,7 @@ const defaultOptions = {
   format: false,
   indentBy: '  ',
   suppressEmptyNode: false,
+  suppressUnpairedNode: true,
   suppressBooleanAttributes: true,
   tagValueProcessor: function(key, a) {
     return a;
@@ -21,12 +22,13 @@ const defaultOptions = {
   preserveOrder: false,
   commentPropName: false,
   unpairedTags: [],
-  entities: {
-    ">" : { regex: new RegExp(">", "g"), val: ">" },
-    "<" : { regex: new RegExp("<", "g"), val: "&lt;" },
-    "sQuot" : { regex: new RegExp("\'", "g"), val: "&apos;" },
-    "dQuot" : { regex: new RegExp("\"", "g"), val: "&quot;" }
-  },
+  entities: [
+    { regex: new RegExp("&", "g"), val: "&amp;" },//it must be on top
+    { regex: new RegExp(">", "g"), val: "&gt;" },
+    { regex: new RegExp("<", "g"), val: "&lt;" },
+    { regex: new RegExp("\'", "g"), val: "&apos;" },
+    { regex: new RegExp("\"", "g"), val: "&quot;" }
+  ],
   processEntities: true,
   stopNodes: []
 };
@@ -68,6 +70,7 @@ function Builder(options) {
   this.buildObjectNode = buildObjectNode;
 
   this.replaceEntitiesValue = replaceEntitiesValue;
+  this.buildAttrPairStr = buildAttrPairStr;
 }
 
 Builder.prototype.build = function(jObj) {
@@ -90,16 +93,16 @@ Builder.prototype.j2x = function(jObj, level) {
     if (typeof jObj[key] === 'undefined') {
       // supress undefined node
     } else if (jObj[key] === null) {
-      val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+      if(key[0] === "?") val += this.indentate(level) + '<' + key + '?' + this.tagEndChar;
+      else val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+      // val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
     } else if (jObj[key] instanceof Date) {
       val += this.buildTextNode(jObj[key], key, '', level);
     } else if (typeof jObj[key] !== 'object') {
       //premitive type
       const attr = this.isAttribute(key);
       if (attr) {
-        let val = this.options.attributeValueProcessor(attr, '' + jObj[key]);
-        val = this.replaceEntitiesValue(val);
-        attrStr += ' ' + attr + '="' + val + '"';
+        attrStr += this.buildAttrPairStr(attr, '' + jObj[key]);
       }else {
         //tag value
         if (key === this.options.textNodeName) {
@@ -117,7 +120,9 @@ Builder.prototype.j2x = function(jObj, level) {
         if (typeof item === 'undefined') {
           // supress undefined node
         } else if (item === null) {
-          val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+          if(key[0] === "?") val += this.indentate(level) + '<' + key + '?' + this.tagEndChar;
+          else val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+          // val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
         } else if (typeof item === 'object') {
           val += this.processTextOrObjNode(item, key, level)
         } else {
@@ -130,9 +135,7 @@ Builder.prototype.j2x = function(jObj, level) {
         const Ks = Object.keys(jObj[key]);
         const L = Ks.length;
         for (let j = 0; j < L; j++) {
-          let val = this.options.attributeValueProcessor(Ks[j], '' + jObj[key][Ks[j]]);
-          val = this.replaceEntitiesValue(val);
-          attrStr += ' ' + Ks[j] + '="' + val + '"';
+          attrStr += this.buildAttrPairStr(Ks[j], '' + jObj[key][Ks[j]]);
         }
       } else {
         val += this.processTextOrObjNode(jObj[key], key, level)
@@ -142,6 +145,14 @@ Builder.prototype.j2x = function(jObj, level) {
   return {attrStr: attrStr, val: val};
 };
 
+function buildAttrPairStr(attrName, val){
+  val = this.options.attributeValueProcessor(attrName, '' + val);
+  val = this.replaceEntitiesValue(val);
+  if (this.options.suppressBooleanAttributes && val === "true") {
+    return ' ' + attrName;
+  } else return ' ' + attrName + '="' + val + '"';
+}
+
 function processTextOrObjNode (object, key, level) {
   const result = this.j2x(object, level + 1);
   if (object[this.options.textNodeName] !== undefined && Object.keys(object).length === 1) {
@@ -152,34 +163,24 @@ function processTextOrObjNode (object, key, level) {
 }
 
 function buildObjectNode(val, key, attrStr, level) {
+  let tagEndExp = '</' + key + this.tagEndChar;
+  let piClosingChar = "";
+  
+  if(key[0] === "?") {
+    piClosingChar = "?";
+    tagEndExp = "";
+  }
+
   if (attrStr && val.indexOf('<') === -1) {
     return (
-      this.indentate(level) +
-      '<' +
-      key +
-      attrStr +
-      '>' +
+      this.indentate(level) + '<' +  key + attrStr + piClosingChar + '>' +
       val +
-      //+ this.newLine
-      // + this.indentate(level)
-      '</' +
-      key +
-      this.tagEndChar
-    );
+      tagEndExp    );
   } else {
     return (
-      this.indentate(level) +
-      '<' +
-      key +
-      attrStr +
-      this.tagEndChar +
+      this.indentate(level) + '<' + key + attrStr + piClosingChar + this.tagEndChar +
       val +
-      //+ this.newLine
-      this.indentate(level) +
-      '</' +
-      key +
-      this.tagEndChar
-    );
+      this.indentate(level) + tagEndExp    );
   }
 }
 
@@ -187,32 +188,32 @@ function buildEmptyObjNode(val, key, attrStr, level) {
   if (val !== '') {
     return this.buildObjectNode(val, key, attrStr, level);
   } else {
-    return this.indentate(level) + '<' + key + attrStr + '/' + this.tagEndChar;
-    //+ this.newLine
+    if(key[0] === "?") return  this.indentate(level) + '<' + key + attrStr+ '?' + this.tagEndChar;
+    else return  this.indentate(level) + '<' + key + attrStr + '/' + this.tagEndChar;
   }
 }
 
 function buildTextValNode(val, key, attrStr, level) {
-  let textValue = this.options.tagValueProcessor(key, val);
-  textValue = this.replaceEntitiesValue(textValue);
-  
-  return (
-    this.indentate(level) +
-    '<' +
-    key +
-    attrStr +
-    '>' +
-     textValue +
-    '</' +
-    key +
-    this.tagEndChar
-  );
+  const textValue = this.replaceEntitiesValue(val);
+
+  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  );
+  }
 }
 
 function replaceEntitiesValue(textValue){
   if(textValue && textValue.length > 0 && this.options.processEntities){
-    for (const entityName in this.options.entities) {
-      const entity = this.options.entities[entityName];
+    for (let i=0; i<this.options.entities.length; i++) {
+      const entity = this.options.entities[i];
       textValue = textValue.replace(entity.regex, entity.val);
     }
   }
@@ -220,12 +221,17 @@ function replaceEntitiesValue(textValue){
 }
 
 function buildEmptyTextNode(val, key, attrStr, level) {
-  if( val === '' && this.options.unpairedTags.indexOf(key) !== -1){
-    return this.indentate(level) + '<' + key + attrStr + this.tagEndChar;
-  }else if (val !== '') {
+  if( val === '' && 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 if (val !== '') { //empty
     return this.buildTextValNode(val, key, attrStr, level);
   } else {
-    return this.indentate(level) + '<' + key + attrStr + '/' + this.tagEndChar;
+    if(key[0] === "?") return  this.indentate(level) + '<' + key + attrStr+ '?' + this.tagEndChar; //PI tag
+    else return  this.indentate(level) + '<' + key + attrStr + '/' + this.tagEndChar; //normal
   }
 }
 

package/src/xmlbuilder/orderedJs2Xml.js

@@ -1,4 +1,4 @@
-const {EOL} = require('os');
+const EOL = "\n";
 
 /**
  * 
@@ -48,7 +48,8 @@ function arrToStr(arr, options, jPath, level){
         let tagStart =  indentation + `<${tagName}${attStr}`;
         let tagValue = arrToStr(tagObj[tagName], options, newJPath, level + 1);
         if(options.unpairedTags.indexOf(tagName) !== -1){
-            xmlStr += tagStart + ">"; 
+            if(options.suppressUnpairedNode)  xmlStr += tagStart + ">"; 
+            else xmlStr += tagStart + "/>"; 
         }else if( (!tagValue || tagValue.length === 0) && options.suppressEmptyNode){ 
             xmlStr += tagStart + "/>"; 
         }else{ 
@@ -95,8 +96,8 @@ function isStopNode(jPath, options){
 
 function replaceEntitiesValue(textValue, options){
     if(textValue && textValue.length > 0 && options.processEntities){
-      for (const entityName in options.entities) {
-        const entity = options.entities[entityName];
+      for (let i=0; i< options.entities.length; i++) {
+        const entity = options.entities[i];
         textValue = textValue.replace(entity.regex, entity.val);
       }
     }

package/src/xmlparser/OptionsBuilder.js

@@ -29,6 +29,8 @@ const defaultOptions = {
     unpairedTags: [],
     processEntities: true,
     htmlEntities: false,
+    ignoreDeclaration: false,
+    ignorePiTags: false
 };
    
 const buildOptions = function(options) {

package/src/xmlparser/OrderedObjParser.js

@@ -72,14 +72,15 @@ function addExternalEntities(externalEntities){
  * @param {boolean} dontTrim
  * @param {boolean} hasAttributes
  * @param {boolean} isLeafNode
+ * @param {boolean} escapeEntities
  */
-function parseTextData(val, tagName, jPath, dontTrim, hasAttributes, isLeafNode) {
+function parseTextData(val, tagName, jPath, dontTrim, hasAttributes, isLeafNode, escapeEntities) {
   if (val !== undefined) {
     if (this.options.trimValues && !dontTrim) {
       val = val.trim();
     }
     if(val.length > 0){
-      val = this.replaceEntitiesValue(val);
+      if(!escapeEntities) val = this.replaceEntitiesValue(val);
       
       const newval = this.options.tagValueProcessor(tagName, val, jPath, hasAttributes, isLeafNode);
       if(newval === null || newval === undefined){
@@ -193,14 +194,7 @@ const parseXml = function(xmlData) {
         }
 
         if(currentNode){
-          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);
         }
 
         jPath = jPath.substr(0, jPath.lastIndexOf("."));
@@ -209,21 +203,29 @@ const parseXml = function(xmlData) {
         textData = "";
         i = closeIndex;
       } else if( xmlData[i+1] === '?') {
+
         let tagData = readTagExp(xmlData,i, false, "?>");
         if(!tagData) throw new Error("Pi Tag is not closed.");
+
         textData = this.saveTextToParentTag(textData, currentNode, jPath);
+        if( (this.options.ignoreDeclaration && tagData.tagName === "?xml") || this.options.ignorePiTags){
+
+        }else{
+  
+          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);
 
-        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 = tagData.closeIndex + 1;
       } else if(xmlData.substr(i + 1, 3) === '!--') {
-        const endIndex = findClosingIndex(xmlData, "-->", i, "Comment is not closed.")
+        const endIndex = findClosingIndex(xmlData, "-->", i+4, "Comment is not closed.")
         if(this.options.commentPropName){
           const comment = xmlData.substring(i + 4, endIndex - 2);
 
@@ -266,14 +268,7 @@ const parseXml = function(xmlData) {
         if (currentNode && textData) {
           if(currentNode.tagname !== '!xml'){
             //when nested tag is found
-            textData = this.parseTextData(textData
-              , currentNode.tagname
-              , jPath
-              , false
-              , currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false
-              , false);
-            if(textData !== undefined &&  textData !== "") currentNode.add(this.options.textNodeName, textData);
-            textData = "";
+            textData = this.saveTextToParentTag(textData, currentNode, jPath, false);
           }
         }
 
@@ -306,6 +301,10 @@ const parseXml = function(xmlData) {
           if(tagName !== tagExp && attrExpPresent){
             childNode[":@"] = this.buildAttributesMap(tagExp, jPath);
           }
+          if(tagContent) {
+            tagContent = this.parseTextData(tagContent, tagName, jPath, true, attrExpPresent, true, true);
+          }
+          
           jPath = jPath.substr(0, jPath.lastIndexOf("."));
           childNode.add(this.options.textNodeName, tagContent);
           
@@ -369,14 +368,16 @@ const replaceEntitiesValue = function(val){
   }
   return val;
 }
-function saveTextToParentTag(textData, currentNode, jPath) {
+function saveTextToParentTag(textData, currentNode, jPath, isLeafNode) {
   if (textData) { //store previously collected data as textNode
+    if(isLeafNode === undefined) isLeafNode = Object.keys(currentNode.child).length === 0
+    
     textData = this.parseTextData(textData,
       currentNode.tagname,
       jPath,
       false,
       currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false,
-      Object.keys(currentNode.child).length === 0);
+      isLeafNode);
 
     if (textData !== undefined && textData !== "")
       currentNode.add(this.options.textNodeName, textData);