fast-xml-parser 4.0.8 → 4.0.10

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 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.8 / 2022-03-18**
+**4.0.10 / 2022-09-14**
+* fix broken links in demo site (By [Yannick Lang](https://github.com/layaxx))
+* fix #491: tagValueProcessor type definition (By [Andrea Francesco Speziale](https://github.com/andreafspeziale))
+* Add jsdocs for tagValueProcessor
+
+
+**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

package/README.md

@@ -34,7 +34,6 @@ Check [ThankYouBackers](https://github.com/NaturalIntelligence/ThankYouBackers)
 <a href="https://github.com/prettier" title="Prettier" > <img src="https://avatars0.githubusercontent.com/u/25822731" width="60px" ></a>
 <a href="http://brain.js.org/" title="brain.js" > <img src="https://avatars2.githubusercontent.com/u/23732838" width="60px" ></a>
 <a href="https://github.com/aws" title="AWS SDK" > <img src="https://avatars.githubusercontent.com/u/2232217" width="60px" ></a>
-<a href="#" title="NHS Connect" > <img src="https://avatars3.githubusercontent.com/u/20316669" width="60px" ></a>
 <a href="http://www.fda.gov/" title="Food and Drug Administration " > <img src="https://avatars2.githubusercontent.com/u/6471964" width="60px" ></a>
 <a href="http://www.magento.com/" title="Magento" > <img src="https://avatars2.githubusercontent.com/u/168457" width="60px" ></a>
 
@@ -50,7 +49,7 @@ Check the list of all known users [here](./USERs.md);
 * Parse XML to JS Object
 * Build XML from JS Object
 * Works with node packages, in browser, and in CLI (press try me button above for demo)
-* Faster than any pure JS implementation.
+* Faster than any other pure JS implementation.
 * It can handle big files (tested up to 100mb).
 * Controlled parsing using various options
 * XML Entities, HTML entities, and DOCTYPE entites are supported.
@@ -121,7 +120,7 @@ Check lib folder for different browser bundles
 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/v4/5.Entities.md)
+5.  [Entities](./docs/v4/5.Entities.md)
 6.  [HTML Document Parsing](./docs/v4/6.HTMLParsing.md)
 7. [PI Tag processing](./docs/v4/7.PITags.md)
 ## Performance
@@ -191,4 +190,4 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
 # License
 * MIT License
 
-![Donate $5](static/img/donation_quote.png)
+![Donate $5](static/img/donation_quote.png)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-xml-parser",
-  "version": "4.0.8",
+  "version": "4.0.10",
   "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries",
   "main": "./src/fxp.js",
   "scripts": {
@@ -53,7 +53,7 @@
     "jasmine": "^3.6.4",
     "nyc": "^15.1.0",
     "prettier": "^1.19.1",
-    "publish-please": "^5.5.2",
+    "publish-please": "^2.4.1",
     "webpack": "^5.64.4",
     "webpack-cli": "^4.9.1"
   },

package/src/fxp.d.ts

@@ -11,7 +11,15 @@ type X2jOptions = {
   trimValues: boolean;
   cdataPropName: false | string;
   commentPropName: false | string;
-  tagValueProcessor: (tagName: string, tagValue: string, jPath: string, hasAttributes: boolean, isLeafNode: boolean) => string;
+    /**
+Control how tag value should be parsed. Called only if tag value is not empty
+
+@returns {undefined|null} `undefined` or `null` to set original value.
+@returns {unknown} 
+1. Different value or value with different data type to set new value. <br>
+2. Same value to set parsed value if `parseTagValue: true`.
+   */
+  tagValueProcessor: (tagName: string, tagValue: string, jPath: string, hasAttributes: boolean, isLeafNode: boolean) => unknown;
   attributeValueProcessor: (attrName: string, attrValue: string, jPath: string) => string;
   numberParseOptions: strnumOptions;
   stopNodes: string[];
@@ -22,6 +30,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) {

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);
         }
@@ -257,12 +261,15 @@ const parseXml = function(xmlData) {
         
         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){
@@ -491,7 +502,7 @@ function readStopNodeData(xmlData, tagName, i){
 
   for (; i < xmlData.length; i++) {
     if( xmlData[i] === "<"){ 
-      if (xmlData[i+1] === "/") {
+      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){
@@ -504,12 +515,21 @@ function readStopNodeData(xmlData, tagName, i){
             }
           }
           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) {
+            if (openTagName === tagName && tagData.tagExp[tagData.tagExp.length-1] !== "/") {
               openTagCount++;
             }
             i=tagData.closeIndex;