fast-xml-parser 4.0.0-beta.3 → 4.0.0-beta.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 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.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**
 * support global stopNodes expression like "*.stop"
 * support self-closing and paired unpaired tags

package/README.md

@@ -29,6 +29,7 @@ Check [ThankYouBackers](https://github.com/NaturalIntelligence/ThankYouBackers)
 <a href="http://nasa.github.io/" title="NASA" > <img src="https://avatars0.githubusercontent.com/u/848102" width="60px" ></a>
 <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>
@@ -106,7 +107,7 @@ In a HTML page
 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)
 ## Performance
 
 ### XML Parser

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-xml-parser",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.4",
   "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries",
   "main": "./src/fxp.js",
   "scripts": {
@@ -47,14 +47,14 @@
     "@babel/preset-env": "^7.13.10",
     "@babel/register": "^7.13.8",
     "babel-loader": "^8.2.2",
-    "eslint": "^5.16.0",
+    "eslint": "^8.3.0",
     "he": "^1.2.0",
     "jasmine": "^3.6.4",
     "nyc": "^15.1.0",
     "prettier": "^1.19.1",
     "publish-please": "^5.5.2",
-    "webpack": "^4.46.0",
-    "webpack-cli": "^3.3.12"
+    "webpack": "^5.64.4",
+    "webpack-cli": "^4.9.1"
   },
   "typings": "src/fxp.d.ts",
   "funding": {
@@ -62,6 +62,6 @@
     "url": "https://paypal.me/naturalintelligence"
   },
   "dependencies": {
-    "strnum": "^1.0.4"
+    "strnum": "^1.0.5"
   }
 }

package/src/fxp.d.ts

@@ -46,6 +46,7 @@ type XmlBuilderOptions = {
   suppressEmptyNode: boolean;
   preserveOrder: boolean;
   unpairedTags: string[];
+  stopNodes: string[];
   tagValueProcessor: (name: string, value: string) => string;
   attributeValueProcessor: (name: string, value: string) => string;
   processEntities: boolean;
@@ -66,6 +67,12 @@ type ValidationError = {
 export class XMLParser {
   constructor(options?: X2jOptionsOptional);
   parse(xmlData: string | Buffer ,validationOptions?: validationOptionsOptional | boolean): any;
+  /**
+   * Add Entity which is not by default supported by this library
+   * @param entityIndentifier {string} Eg: 'ent' for &ent;
+   * @param entityValue {string} Eg: '\r'
+   */
+  addEntity(entityIndentifier: string, entityValue: string): void;
 }
 
 export class XMLValidator{

package/src/xmlbuilder/json2xml.js

@@ -27,7 +27,8 @@ const defaultOptions = {
     "sQuot" : { regex: new RegExp("\'", "g"), val: "'" },
     "dQuot" : { regex: new RegExp("\"", "g"), val: """ }
   },
-  processEntities: true
+  processEntities: true,
+  stopNodes: []
 };
 
 const props = [
@@ -47,6 +48,7 @@ const props = [
   "unpairedTags",
   "entities",
   "processEntities",
+  "stopNodes",
   // 'rootNodeName', //when jsObject have multiple properties on root level
 ];
 

package/src/xmlbuilder/orderedJs2Xml.js

@@ -7,10 +7,10 @@ const {EOL} = require('os');
  * @returns 
  */
 function toXml(jArray, options){
-    return arrToStr( jArray, options, 0);
+    return arrToStr( jArray, options, "", 0);
 }
 
-function arrToStr(arr, options, level){
+function arrToStr(arr, options, jPath, level){
     let xmlStr = "";
 
     let indentation = "";
@@ -21,10 +21,16 @@ function arrToStr(arr, options, level){
     for (let i = 0; i < arr.length; i++) {
         const tagObj = arr[i];
         const tagName = propName(tagObj);
+        let newJPath = "";
+        if(jPath.length === 0) newJPath = tagName
+        else newJPath = `${jPath}.${tagName}`;
 
         if(tagName === options.textNodeName){
-            let tagText = options.tagValueProcessor( tagName, tagObj[tagName]);
-            tagText = replaceEntitiesValue(tagText, options);
+            let tagText = tagObj[tagName];
+            if(!isStopNode(newJPath, options)){
+                tagText = options.tagValueProcessor( tagName, tagText);
+                tagText = replaceEntitiesValue(tagText, options);
+            }
             xmlStr += indentation + tagText;
             continue;
         }else if( tagName === options.cdataPropName){
@@ -36,7 +42,7 @@ function arrToStr(arr, options, level){
         }
         const attStr = attr_to_str(tagObj.attributes, options);
         let tagStart =  indentation + `<${tagName}${attStr}`;
-        let tagValue = arrToStr(tagObj[tagName], options, level + 1);
+        let tagValue = arrToStr(tagObj[tagName], options, newJPath, level + 1);
         if( (!tagValue || tagValue.length === 0) && options.suppressEmptyNode){ 
             if(options.unpairedTags.indexOf(tagName) !== -1){
                 xmlStr += tagStart + ">"; 
@@ -72,6 +78,15 @@ function attr_to_str(attrMap, options){
     return attrStr;
 }
 
+function isStopNode(jPath, options){
+    jPath = jPath.substr(0,jPath.length - options.textNodeName.length - 1);
+    let tagName = jPath.substr(jPath.lastIndexOf(".") + 1);
+    for(let index in options.stopNodes){
+        if(options.stopNodes[index] === jPath || options.stopNodes[index] === "*."+tagName) return true;
+    }
+    return false;
+}
+
 function replaceEntitiesValue(textValue, options){
     if(textValue && textValue.length > 0 && options.processEntities){
       for (const entityName in options.entities) {

package/src/xmlparser/OrderedObjParser.js

@@ -40,6 +40,7 @@ class OrderedObjParser{
       "reg" : { regex: /&(reg|#174);/g, val: "®" },
       "inr" : { regex: /&(inr|#8377);/g, val: "₹" },
     };
+    this.addExternalEntities = addExternalEntities;
     this.parseXml = parseXml;
     this.parseTextData = parseTextData;
     this.resolveNameSpace = resolveNameSpace;
@@ -52,6 +53,17 @@ class OrderedObjParser{
 
 }
 
+function addExternalEntities(externalEntities){
+  const entKeys = Object.keys(externalEntities);
+  for (let i = 0; i < entKeys.length; i++) {
+    const ent = entKeys[i];
+    this.lastEntities[ent] = {
+       regex: new RegExp("&"+ent+";","g"),
+       val : externalEntities[ent]
+    }
+  }
+}
+
 /**
  * @param {string} val
  * @param {string} tagName

package/src/xmlparser/XMLParser.js

@@ -4,8 +4,11 @@ const { prettify} = require("./node2json");
 const validator = require('../validator');
 
 class XMLParser{
+    
     constructor(options){
+        this.externalEntities = {};
         this.options = buildOptions(options);
+        
     }
     /**
      * Parse XML dats to JS object 
@@ -28,10 +31,26 @@ class XMLParser{
             }
           }
         const orderedObjParser = new OrderedObjParser(this.options);
+        orderedObjParser.addExternalEntities(this.externalEntities);
         const orderedResult = orderedObjParser.parseXml(xmlData);
         if(this.options.preserveOrder || orderedResult === undefined) return orderedResult;
         else return prettify(orderedResult, this.options);
     }
+
+    /**
+     * Add Entity which is not by default supported by this library
+     * @param {string} key 
+     * @param {string} value 
+     */
+    addEntity(key, value){
+        if(value.indexOf("&") !== -1){
+            throw new Error("Entity value can't have '&'")
+        }else if(key.indexOf("&") !== -1 || key.indexOf(";") !== -1){
+            throw new Error("An entity must be set without '&' and ';'. Eg. use '#xD' for '
'")
+        }else{
+            this.externalEntities[key] = value;
+        }
+    }
 }
 
 module.exports = XMLParser;