fast-xml-parser 4.4.0 → 4.5.0

package/README.md

@@ -1,29 +1,32 @@
 # [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser)
-[![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]
 [![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)
 
-[quality-image]: http://npm.packagequality.com/shield/fast-xml-parser.svg?style=flat-square
-[quality-url]: http://packagequality.com/#?package=fast-xml-parser
-
 
 Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.
 
-> XML Parser v5 is added for experimental use
-> https://solothought.com
+---
+
+<a href="https://www.amazon.in/Power-Glasses-world-imagination-Perspective-ebook/dp/B0CW1CJGNK/"><img align="left" src="https://github.com/NaturalIntelligence/fast-xml-parser/assets/7692328/e7a42bcc-5186-45e3-bfee-de8d8b9a69d4" alt="ads-thePowerGlassesBook"/></a>
+I had recently published a book, The Power Glasses. Please have a look. Your feedback would be helpful. You can [mail](githubissues@proton.me) me for a free copy.
+<br>
+
+Sponsor this project
 
-Sponsor this project 👉 
 <a href="https://github.com/sponsors/NaturalIntelligence"> 
-  <img src="https://raw.githubusercontent.com/NaturalIntelligence/ThankYouBackers/main/github_sponsor.png" width="200" />
+  <img src="https://raw.githubusercontent.com/NaturalIntelligence/ThankYouBackers/main/github_sponsor.png" width="180" />
 </a>
 <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 />
+  <img src="https://opencollective.com/fast-xml-parser/donate/button@2x.png?color=blue" width=180 />
 </a>
-<a href="https://paypal.me/naturalintelligence"> <img src="static/img/support_paypal.svg" alt="Stubmatic donate button" width="200"/></a>
-
+<a href="https://paypal.me/naturalintelligence"> <img src="static/img/support_paypal.svg" alt="Stubmatic donate button" width="180"/></a>
+<br>
+<br>
+<br>
 
+<!--
 ### Current Sponsors
 
 Check the complete list at [ThankYouBackers](https://github.com/NaturalIntelligence/ThankYouBackers) for our sponsors and supporters.
@@ -45,7 +48,9 @@ Through OpenCollective
 <a href="https://opencollective.com/fast-xml-parser/sponsor/7/website" target="_blank"><img src="https://opencollective.com/fast-xml-parser/sponsor/7/avatar.svg"></a>
 <a href="https://opencollective.com/fast-xml-parser/sponsor/8/website" target="_blank"><img src="https://opencollective.com/fast-xml-parser/sponsor/8/avatar.svg"></a>
 <a href="https://opencollective.com/fast-xml-parser/sponsor/9/website" target="_blank"><img src="https://opencollective.com/fast-xml-parser/sponsor/9/avatar.svg"></a>
+-->
 
+![fxp_sponsors](https://github.com/NaturalIntelligence/fast-xml-parser/assets/7692328/c9367497-d67e-410a-90a6-66e3808be929)
 
 ## Users
 
@@ -63,14 +68,15 @@ Through OpenCollective
 <a href="https://github.com/SAP" title="SAP" > <img src="https://user-images.githubusercontent.com/7692328/204835214-d9d25b58-e3df-408d-87a3-c7d36b578ee4.png" width="60px" ></a>
 <a href="https://github.com/postmanlabs" title="postman" > <img src="https://user-images.githubusercontent.com/7692328/204835529-e9e290ad-696a-49ad-9d34-08e955704715.png" width="60px" ></a>
 <a href="https://github.com/react-native-community" title="React Native Community" > <img src="https://avatars.githubusercontent.com/u/20269980?v=4" width="60px" ></a>
+<a href="https://github.com/googleapis" title="Google APIs" > <img src="https://avatars.githubusercontent.com/u/16785467?v=4" width="60px" ></a>
+<a href="https://github.com/langchain-ai" title="Langchain AI" > <img src="https://avatars.githubusercontent.com/u/126733545?v=4" width="60px" ></a>
+<a href="https://github.com/withastro" title="Astro websie builder" > <img src="https://avatars.githubusercontent.com/u/44914786?v=4" width="60px" ></a>
+<a href="https://github.com/baidu" title="Baidu" > <img src="https://avatars.githubusercontent.com/u/13245940?v=4" width="60px" ></a>
+[more](./USERs.md)
 
-Check the bigger [list](./USERs.md)
-
-<small>The list of users is collected either from the list published by Github, communicated directly through mails/chat , or from other resources. If you feel that your name in the above list is incorrectly published or you're not the user of this library anymore then you can inform us to remove it. We'll do the necessary changes ASAP.</small>
+<small>The list of users are mostly published by Github or communicated directly. Feel free to contact if you find any information wrong.</small>
 
-If you want to be an anonymous user of this application and don't want to be highlighted anywhere then you can contact me at
-- githubissues@proton.me
-- https://linkedin.com/in/amitguptagwl/
+---
 
 ## Main Features
 
@@ -79,7 +85,7 @@ If you want to be an anonymous user of this application and don't want to be hig
 * Validate XML data syntactically
 * 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)
+* Compatible to node js packages, in browser, and in CLI (click try me button above for demo)
 * Faster than any other pure JS implementation.
 * It can handle big files (tested up to 100mb).
 * Controlled parsing using various options
@@ -137,49 +143,71 @@ In a HTML page
 </script>
 ```
 
-Check lib folder for different browser bundles
+Bundle size
 
 | Bundle Name        | Size |
 | ------------------ | ---- |
-| fxbuilder.min.js   | 5.2K |
-| fxparser.js        | 50K  |
-| fxparser.min.js    | 17K  |
-| fxp.min.js         | 22K  |
+| fxbuilder.min.js   | 6.5K |
+| fxparser.min.js    | 20K  |
+| fxp.min.js         | 26K  |
 | fxvalidator.min.js | 5.7K |
 
 ### Documents
-**v3**
-* [documents](./docs/v3/docs.md)
-
-**v4**
-1. [GettingStarted.md](./docs/v4/1.GettingStarted.md)
-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.  [Entities](./docs/v4/5.Entities.md)
-6.  [HTML Document Parsing](./docs/v4/6.HTMLParsing.md)
-7. [PI Tag processing](./docs/v4/7.PITags.md)
+<table>
+  <tr><td>v3</td><td>v4</td><td>v5</td></tr>
+  <tr>
+    <td>
+      <a href="./docs/v3/docs.md">documents</a>
+    </td>
+    <td><ol>
+      <li><a href="./docs/v4/1.GettingStarted.md">Getting Started</a></li>
+      <li><a href="./docs/v4/2.XMLparseOptions.md">XML Parser</a></li>
+      <li><a href="./docs/v4/3.XMLBuilder.md">XML Builder</a></li>
+      <li><a href="./docs/v4/4.XMLValidator.md">XML Validator</a></li>
+      <li><a href="./docs/v4/5.Entities.md">Entities</a></li>
+      <li><a href="./docs/v4/6.HTMLParsing.md">HTML Document Parsing</a></li>
+      <li><a href="./docs/v4/7.PITags.md">PI Tag processing</a></li>
+    </ol></td>
+    <td><ol>
+      <li></li><a href="./docs/v5/1.GettingStarted.md">Getting Started</a></li>
+      <li><a href="./docs/v5/2.Features.md">Features</a></li>
+      <li><a href="./docs/v5/3.Options.md">Options</a></li>
+      <li><a href="./docs/v5/4.OutputBuilders.md">Output Builders</a></li>
+      <li><a href="./docs/v5/5.ValueParsers.md">Value Parsers</a></li>
+    </ol></td>
+  </tr>
+</table>
+
+**note**: version 5 is released with version 4 tfor experimental use. Based on it's demand, it'll be developed and the features can be different in final release.
+
 ## Performance
+<small>negative means error</small>
 
 ### XML Parser
 
-![](./docs/imgs/XMLParser_v4.png)
+<img align="left" src="./docs/imgs/XMLParser_v4.png" width="45%" />
+<img src="./docs/imgs/XMLParser_large_v4.png" width="47%" />
+
 * Y-axis: requests per second
 * X-axis: File size
 
-**Large files**
-![](./docs/imgs/XMLParser_large_v4.png)
-* Y-axis: requests per second
-* X-axis: File size 
 ### XML Builder
 
-![](./docs/imgs/XMLBuilder_v4.png)
+<img src="./docs/imgs/XMLBuilder_v4.png" width="50%" />
 * Y-axis: requests per second
 
-<small>negative means error</small>
 
-[![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/)
 
+<!-- [![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/) -->
+
+
+## Usage Trend
+
+[Usage Trend of fast-xml-parser](https://npm-compare.com/fast-xml-parser#timeRange=THREE_YEARS)
+  
+<a href="https://npm-compare.com/fast-xml-parser#timeRange=THREE_YEARS" target="_blank">
+  <img src="https://npm-compare.com/img/npm-trend/THREE_YEARS/fast-xml-parser.png" width="50%" alt="NPM Usage Trend of fast-xml-parser" />
+</a>
 
 ## Supporters
 ### Contributors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-xml-parser",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries",
   "main": "./src/fxp.js",
   "scripts": {
@@ -49,7 +49,6 @@
     "@babel/register": "^7.13.8",
     "@types/node": "20",
     "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

@@ -30,9 +30,17 @@ type X2jOptions = {
   /**
    * Whether to ignore attributes when parsing
    * 
+   * When `true` - ignores all the attributes
+   * 
+   * When `false` - parses all the attributes
+   * 
+   * When `Array<string | RegExp>` - filters out attributes that match provided patterns
+   * 
+   * When `Function` - calls the function for each attribute and filters out those for which the function returned `true`
+   * 
    * Defaults to `true`
    */
-  ignoreAttributes?: boolean;
+  ignoreAttributes?: boolean | (string | RegExp)[] | ((attrName: string, jPath: string) => boolean);
 
   /**
    * Whether to remove namespace string from tag and attribute names
@@ -250,11 +258,19 @@ type XmlBuilderOptions = {
   textNodeName?: string;
 
   /**
-   * Whether to ignore attributes when parsing
+   * Whether to ignore attributes when building
+   * 
+   * When `true` - ignores all the attributes
+   * 
+   * When `false` - builds all the attributes
+   * 
+   * When `Array<string | RegExp>` - filters out attributes that match provided patterns
+   * 
+   * When `Function` - calls the function for each attribute and filters out those for which the function returned `true`
    * 
    * Defaults to `true`
    */
-  ignoreAttributes?: boolean;
+  ignoreAttributes?: boolean | (string | RegExp)[] | ((attrName: string, jPath: string) => boolean);
 
   /**
    * Give a property name to set CDATA values to instead of merging to tag's text value

package/src/ignoreAttributes.js

@@ -0,0 +1,20 @@
+function getIgnoreAttributesFn(ignoreAttributes) {
+    if (typeof ignoreAttributes === 'function') {
+        return ignoreAttributes
+    }
+    if (Array.isArray(ignoreAttributes)) {
+        return (attrName) => {
+            for (const pattern of ignoreAttributes) {
+                if (typeof pattern === 'string' && attrName === pattern) {
+                    return true
+                }
+                if (pattern instanceof RegExp && pattern.test(attrName)) {
+                    return true
+                }
+            }
+        }
+    }
+    return () => false
+}
+
+module.exports = getIgnoreAttributesFn

package/src/v5/OutputBuilders/JsArrBuilder.js

@@ -3,7 +3,7 @@ const {buildOptions,registerCommonValueParsers} = require("./ParserOptionsBuilde
 class OutputBuilder{
   constructor(options){
     this.options = buildOptions(options);
-      this.registeredParsers = registerCommonValueParsers();
+      this.registeredParsers = registerCommonValueParsers(this.options);
     }
     
     registerValueParser(name,parserInstance){//existing name will override the parser without warning

package/src/v5/OutputBuilders/JsMinArrBuilder.js

@@ -3,7 +3,7 @@ const {buildOptions,registerCommonValueParsers} = require("./ParserOptionsBuilde
 class OutputBuilder{
   constructor(options){
     this.options = buildOptions(options);
-      this.registeredParsers = registerCommonValueParsers();
+      this.registeredParsers = registerCommonValueParsers(this.options);
     }
     
     registerValueParser(name,parserInstance){//existing name will override the parser without warning

package/src/v5/OutputBuilders/JsObjBuilder.js

@@ -5,7 +5,7 @@ const {buildOptions,registerCommonValueParsers} = require("./ParserOptionsBuilde
 class OutputBuilder{
   constructor(builderOptions){
       this.options = buildOptions(builderOptions);
-      this.registeredParsers = registerCommonValueParsers();
+      this.registeredParsers = registerCommonValueParsers(this.options);
   }
 
   registerValueParser(name,parserInstance){//existing name will override the parser without warning

package/src/v5/OutputBuilders/ParserOptionsBuilder.js

@@ -34,6 +34,9 @@ const defaultOptions={
       // "currency",
       // "date",
     ]
+  },
+  dataType:{
+
   }
 }
 
@@ -75,7 +78,7 @@ function copyProperties(target, source) {
   }
 }
 
-function registerCommonValueParsers(){
+function registerCommonValueParsers(options){
   return {
     "trim": new trimParser(),
     // "join": this.entityParser.parse,

package/src/v5/valueParsers/currency.js

@@ -1,4 +1,7 @@
-
+const defaultOptions = {
+    maxLength: 200,
+    // locale: "en-IN"
+}
 const localeMap = {
     "$":"en-US",
     "€":"de-DE",
@@ -6,15 +9,19 @@ const localeMap = {
     "¥":"ja-JP",
     "₹":"en-IN",
 }
+const sign = "(?:-|\+)?";
+const digitsAndSeparator = "(?:\d+|\d{1,3}(?:,\d{3})+)";
+const decimalPart = "(?:\.\d{1,2})?";
+const symbol = "(?:\$|€|¥|₹)?";
 
 const currencyCheckRegex = /^\s*(?:-|\+)?(?:\d+|\d{1,3}(?:,\d{3})+)?(?:\.\d{1,2})?\s*(?:\$|€|¥|₹)?\s*$/u;
 
 class CurrencyParser{
     constructor(options){
-        this.options = options;
+        this.options = options || defaultOptions;
     }
     parse(val){
-        if (typeof val === 'string') {
+        if (typeof val === 'string' && val.length <= this.options.maxLength) {
             if(val.indexOf(",,") !== -1 && val.indexOf(".." !== -1)){
                 const match = val.match(currencyCheckRegex);
                 if(match){
@@ -28,4 +35,6 @@ class CurrencyParser{
         return val;
     }
 }
+CurrencyParser.defaultOptions = defaultOptions;
+
 module.exports = CurrencyParser;

package/src/xmlbuilder/json2xml.js

@@ -1,6 +1,7 @@
 'use strict';
 //parse Empty Node as self closing node
 const buildFromOrderedJs = require('./orderedJs2Xml');
+const getIgnoreAttributesFn = require('../ignoreAttributes')
 
 const defaultOptions = {
   attributeNamePrefix: '@_',
@@ -38,11 +39,12 @@ const defaultOptions = {
 
 function Builder(options) {
   this.options = Object.assign({}, defaultOptions, options);
-  if (this.options.ignoreAttributes || this.options.attributesGroupName) {
+  if (this.options.ignoreAttributes === true || this.options.attributesGroupName) {
     this.isAttribute = function(/*a*/) {
       return false;
     };
   } else {
+    this.ignoreAttributesFn = getIgnoreAttributesFn(this.options.ignoreAttributes)
     this.attrPrefixLen = this.options.attributeNamePrefix.length;
     this.isAttribute = isAttribute;
   }
@@ -71,13 +73,14 @@ Builder.prototype.build = function(jObj) {
         [this.options.arrayNodeName] : jObj
       }
     }
-    return this.j2x(jObj, 0).val;
+    return this.j2x(jObj, 0, []).val;
   }
 };
 
-Builder.prototype.j2x = function(jObj, level) {
+Builder.prototype.j2x = function(jObj, level, ajPath) {
   let attrStr = '';
   let val = '';
+  const jPath = ajPath.join('.')
   for (let key in jObj) {
     if(!Object.prototype.hasOwnProperty.call(jObj, key)) continue;
     if (typeof jObj[key] === 'undefined') {
@@ -100,9 +103,9 @@ Builder.prototype.j2x = function(jObj, level) {
     } else if (typeof jObj[key] !== 'object') {
       //premitive type
       const attr = this.isAttribute(key);
-      if (attr) {
+      if (attr && !this.ignoreAttributesFn(attr, jPath)) {
         attrStr += this.buildAttrPairStr(attr, '' + jObj[key]);
-      }else {
+      } else if (!attr) {
         //tag value
         if (key === this.options.textNodeName) {
           let newval = this.options.tagValueProcessor(key, '' + jObj[key]);
@@ -115,6 +118,7 @@ Builder.prototype.j2x = function(jObj, level) {
       //repeated nodes
       const arrLen = jObj[key].length;
       let listTagVal = "";
+      let listTagAttr = "";
       for (let j = 0; j < arrLen; j++) {
         const item = jObj[key][j];
         if (typeof item === 'undefined') {
@@ -124,17 +128,27 @@ Builder.prototype.j2x = function(jObj, level) {
           else val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
           // val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
         } else if (typeof item === 'object') {
-          if(this.options.oneListGroup ){
-            listTagVal += this.j2x(item, level + 1).val;
+          if(this.options.oneListGroup){
+            const result = this.j2x(item, level + 1, ajPath.concat(key));
+            listTagVal += result.val;
+            if (this.options.attributesGroupName && item.hasOwnProperty(this.options.attributesGroupName)) {
+              listTagAttr += result.attrStr
+            }
           }else{
-            listTagVal += this.processTextOrObjNode(item, key, level)
+            listTagVal += this.processTextOrObjNode(item, key, level, ajPath)
           }
         } else {
-          listTagVal += this.buildTextValNode(item, key, '', level);
+          if (this.options.oneListGroup) {
+            let textValue = this.options.tagValueProcessor(key, item);
+            textValue = this.replaceEntitiesValue(textValue);
+            listTagVal += textValue;
+          } else {
+            listTagVal += this.buildTextValNode(item, key, '', level);
+          }
         }
       }
       if(this.options.oneListGroup){
-        listTagVal = this.buildObjectNode(listTagVal, key, '', level);
+        listTagVal = this.buildObjectNode(listTagVal, key, listTagAttr, level);
       }
       val += listTagVal;
     } else {
@@ -146,7 +160,7 @@ Builder.prototype.j2x = function(jObj, level) {
           attrStr += this.buildAttrPairStr(Ks[j], '' + jObj[key][Ks[j]]);
         }
       } else {
-        val += this.processTextOrObjNode(jObj[key], key, level)
+        val += this.processTextOrObjNode(jObj[key], key, level, ajPath)
       }
     }
   }
@@ -161,8 +175,8 @@ Builder.prototype.buildAttrPairStr = function(attrName, val){
   } else return ' ' + attrName + '="' + val + '"';
 }
 
-function processTextOrObjNode (object, key, level) {
-  const result = this.j2x(object, level + 1);
+function processTextOrObjNode (object, key, level, ajPath) {
+  const result = this.j2x(object, level + 1, ajPath.concat(key));
   if (object[this.options.textNodeName] !== undefined && Object.keys(object).length === 1) {
     return this.buildTextValNode(object[this.options.textNodeName], key, result.attrStr, level);
   } else {

package/src/xmlparser/OrderedObjParser.js

@@ -5,6 +5,7 @@ const util = require('../util');
 const xmlNode = require('./xmlNode');
 const readDocType = require("./DocTypeReader");
 const toNumber = require("strnum");
+const getIgnoreAttributesFn = require('../ignoreAttributes')
 
 // const regx =
 //   '<((!\\[CDATA\\[([\\s\\S]*?)(]]>))|((NAME:)?(NAME))([^>]*)>|((\\/)(NAME)\\s*>))([^<]*)'
@@ -53,6 +54,7 @@ class OrderedObjParser{
     this.readStopNodeData = readStopNodeData;
     this.saveTextToParentTag = saveTextToParentTag;
     this.addChild = addChild;
+    this.ignoreAttributesFn = getIgnoreAttributesFn(this.options.ignoreAttributes)
   }
 
 }
@@ -125,7 +127,7 @@ function resolveNameSpace(tagname) {
 const attrsRegx = new RegExp('([^\\s=]+)\\s*(=\\s*([\'"])([\\s\\S]*?)\\3)?', 'gm');
 
 function buildAttributesMap(attrStr, jPath, tagName) {
-  if (!this.options.ignoreAttributes && typeof attrStr === 'string') {
+  if (this.options.ignoreAttributes !== true && typeof attrStr === 'string') {
     // attrStr = attrStr.replace(/\r?\n/g, ' ');
     //attrStr = attrStr || attrStr.trim();
 
@@ -134,6 +136,9 @@ function buildAttributesMap(attrStr, jPath, tagName) {
     const attrs = {};
     for (let i = 0; i < len; i++) {
       const attrName = this.resolveNameSpace(matches[i][1]);
+      if (this.ignoreAttributesFn(attrName, jPath)) {
+        continue
+      }
       let oldVal = matches[i][4];
       let aName = this.options.attributeNamePrefix + attrName;
       if (attrName.length) {