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

package/src/fxp.d.ts

@@ -0,0 +1,84 @@
+type X2jOptions = {
+  preserveOrder: boolean;
+  attributeNamePrefix: string;
+  attributesGroupName: false | string;
+  textNodeName: string;
+  ignoreAttributes: boolean;
+  removeNSPrefix: boolean;
+  allowBooleanAttributes: boolean;
+  parseTagValue: boolean;
+  parseAttributeValue: boolean;
+  trimValues: boolean;
+  cdataPropName: false | string;
+  commentPropName: false | string;
+  tagValueProcessor: (tagName: string, tagValue: string, jPath: string, hasAttributes: boolean, isLeafNode: boolean) => string;
+  attributeValueProcessor: (attrName: string, attrValue: string, jPath: string) => string;
+  numberParseOptions: strnumOptions;
+  stopNodes: string[];
+  unpairedTags: string[];
+  alwaysCreateTextNode: boolean;
+  isArray: (tagName: string, jPath: string, isLeafNode: boolean, isAttribute: boolean) => boolean;
+  processEntities: boolean;
+  htmlEntities: boolean;
+};
+type strnumOptions = {
+  hex: boolean;
+  leadingZeros: boolean,
+  skipLike?: RegExp
+}
+type X2jOptionsOptional = Partial<X2jOptions>;
+type validationOptions = {
+  allowBooleanAttributes: boolean;
+  unpairedTags: string[];
+};
+type validationOptionsOptional = Partial<validationOptions>;
+
+type XmlBuilderOptions = {
+  attributeNamePrefix: string;
+  attributesGroupName: false | string;
+  textNodeName: string;
+  ignoreAttributes: boolean;
+  cdataPropName: false | string;
+  commentPropName: false | string;
+  format: boolean;
+  indentBy: string;
+  arrayNodeName: string;
+  suppressEmptyNode: boolean;
+  preserveOrder: boolean;
+  unpairedTags: string[];
+  stopNodes: string[];
+  tagValueProcessor: (name: string, value: string) => string;
+  attributeValueProcessor: (name: string, value: string) => string;
+  processEntities: boolean;
+};
+type XmlBuilderOptionsOptional = Partial<XmlBuilderOptions>;
+
+type ESchema = string | object | Array<string|object>;
+
+type ValidationError = {
+  err: { 
+    code: string;
+    msg: string,
+    line: number,
+    col: number 
+  };
+};
+
+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{
+  static validate(  xmlData: string,  options?: validationOptionsOptional): true | ValidationError;
+}
+export class XMLBuilder {
+  constructor(options: XmlBuilderOptionsOptional);
+  build(jObj: any): any;
+}

package/src/fxp.js

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

package/src/util.js

@@ -67,7 +67,7 @@ exports.getValue = function(v) {
 // const fakeCall = function(a) {return a;};
 // const fakeCallNoReturn = function() {};
 
-exports.buildOptions = function(options, defaultOptions, props) {
+const buildOptions = function(options, defaultOptions, props) {
   let newOptions = {};
   if (!options) {
     return defaultOptions; //if there are not options
@@ -83,26 +83,7 @@ exports.buildOptions = function(options, defaultOptions, props) {
   return newOptions;
 };
 
-/**
- * Check if a tag name should be treated as array
- *
- * @param tagName the node tagname
- * @param arrayMode the array mode option
- * @param parentTagName the parent tag name
- * @returns {boolean} true if node should be parsed as array
- */
-exports.isTagNameInArrayMode = function (tagName, arrayMode, parentTagName) {
-  if (arrayMode === false) {
-    return false;
-  } else if (arrayMode instanceof RegExp) {
-    return arrayMode.test(tagName);
-  } else if (typeof arrayMode === 'function') {
-    return !!arrayMode(tagName, parentTagName);
-  }
-
-  return arrayMode === "strict";
-}
-
+exports.buildOptions = buildOptions;
 exports.isName = isName;
 exports.getAllMatches = getAllMatches;
 exports.nameRegexp = nameRegexp;

package/src/validator.js

@@ -4,9 +4,13 @@ const util = require('./util');
 
 const defaultOptions = {
   allowBooleanAttributes: false, //A tag can have attributes without any value
+  unpairedTags: []
 };
 
-const props = ['allowBooleanAttributes'];
+const props = [
+  'allowBooleanAttributes',
+  'unpairedTags'
+];
 
 //const tagsPattern = new RegExp("<\\/?([\\w:\\-_\.]+)\\s*\/?>","g");
 exports.validate = function (xmlData, options) {
@@ -25,7 +29,7 @@ exports.validate = function (xmlData, options) {
     // check for byte order mark (BOM)
     xmlData = xmlData.substr(1);
   }
-
+  
   for (let i = 0; i < xmlData.length; i++) {
 
     if (xmlData[i] === '<' && xmlData[i+1] === '?') {
@@ -130,6 +134,8 @@ exports.validate = function (xmlData, options) {
           //if the root level has been reached before ...
           if (reachedRoot === true) {
             return getErrorObject('InvalidXml', 'Multiple possible root nodes found.', getLineNumberForPosition(xmlData, i));
+          } else if(options.unpairedTags.indexOf(tagName) !== -1){
+            //don't push into stack
           } else {
             tags.push({tagName, tagStartPos});
           }
@@ -156,6 +162,10 @@ exports.validate = function (xmlData, options) {
             if (afterAmp == -1)
               return getErrorObject('InvalidChar', "char '&' is not expected.", getLineNumberForPosition(xmlData, i));
             i = afterAmp;
+          }else{
+            if (reachedRoot === true && !isWhiteSpace(xmlData[i])) {
+              return getErrorObject('InvalidXml', "Extra text at the end", getLineNumberForPosition(xmlData, i));
+            }
           }
         } //end of reading tag text value
         if (xmlData[i] === '<') {
@@ -163,7 +173,7 @@ exports.validate = function (xmlData, options) {
         }
       }
     } else {
-      if (xmlData[i] === ' ' || xmlData[i] === '\t' || xmlData[i] === '\n' || xmlData[i] === '\r') {
+      if ( isWhiteSpace(xmlData[i])) {
         continue;
       }
       return getErrorObject('InvalidChar', "char '"+xmlData[i]+"' is not expected.", getLineNumberForPosition(xmlData, i));
@@ -183,6 +193,9 @@ exports.validate = function (xmlData, options) {
   return true;
 };
 
+function isWhiteSpace(char){
+  return char === ' ' || char === '\t' || char === '\n'  || char === '\r';
+}
 /**
  * Read Processing insstructions and skip
  * @param {*} xmlData

package/src/{json2xml.js → xmlbuilder/json2xml.js}

@@ -1,43 +1,60 @@
 'use strict';
 //parse Empty Node as self closing node
-const buildOptions = require('./util').buildOptions;
+const buildOptions = require('../util').buildOptions;
+const buildFromOrderedJs = require('./orderedJs2Xml');
 
 const defaultOptions = {
   attributeNamePrefix: '@_',
-  attrNodeName: false,
+  attributesGroupName: false,
   textNodeName: '#text',
   ignoreAttributes: true,
-  cdataTagName: false,
-  cdataPositionChar: '\\c',
+  cdataPropName: false,
   format: false,
   indentBy: '  ',
-  supressEmptyNode: false,
-  tagValueProcessor: function(a) {
+  suppressEmptyNode: false,
+  tagValueProcessor: function(key, a) {
     return a;
   },
-  attrValueProcessor: function(a) {
+  attributeValueProcessor: function(attrName, a) {
     return a;
   },
+  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;" }
+  },
+  processEntities: true,
+  stopNodes: []
 };
 
 const props = [
   'attributeNamePrefix',
-  'attrNodeName',
+  'attributesGroupName',
   'textNodeName',
   'ignoreAttributes',
-  'cdataTagName',
-  'cdataPositionChar',
+  'cdataPropName',
   'format',
   'indentBy',
-  'supressEmptyNode',
+  'suppressEmptyNode',
   'tagValueProcessor',
-  'attrValueProcessor',
-  'rootNodeName', //when array as root
+  'attributeValueProcessor',
+  'arrayNodeName', //when array as root
+  'preserveOrder',
+  "commentPropName",
+  "unpairedTags",
+  "entities",
+  "processEntities",
+  "stopNodes",
+  // 'rootNodeName', //when jsObject have multiple properties on root level
 ];
 
-function Parser(options) {
+function Builder(options) {
   this.options = buildOptions(options, defaultOptions, props);
-  if (this.options.ignoreAttributes || this.options.attrNodeName) {
+  if (this.options.ignoreAttributes || this.options.attributesGroupName) {
     this.isAttribute = function(/*a*/) {
       return false;
     };
@@ -45,15 +62,6 @@ function Parser(options) {
     this.attrPrefixLen = this.options.attributeNamePrefix.length;
     this.isAttribute = isAttribute;
   }
-  if (this.options.cdataTagName) {
-    this.isCDATA = isCDATA;
-  } else {
-    this.isCDATA = function(/*a*/) {
-      return false;
-    };
-  }
-  this.replaceCDATAstr = replaceCDATAstr;
-  this.replaceCDATAarr = replaceCDATAarr;
 
   this.processTextOrObjNode = processTextOrObjNode
 
@@ -69,7 +77,7 @@ function Parser(options) {
     this.newLine = '';
   }
 
-  if (this.options.supressEmptyNode) {
+  if (this.options.suppressEmptyNode) {
     this.buildTextNode = buildEmptyTextNode;
     this.buildObjNode = buildEmptyObjNode;
   } else {
@@ -79,18 +87,24 @@ function Parser(options) {
 
   this.buildTextValNode = buildTextValNode;
   this.buildObjectNode = buildObjectNode;
+
+  this.replaceEntitiesValue = replaceEntitiesValue;
 }
 
-Parser.prototype.parse = function(jObj) {
-  if(Array.isArray(jObj) && this.options.rootNodeName && this.options.rootNodeName.length > 1){
-    jObj = {
-      [this.options.rootNodeName] : jObj
+Builder.prototype.build = function(jObj) {
+  if(this.options.preserveOrder){
+    return buildFromOrderedJs(jObj, this.options);
+  }else {
+    if(Array.isArray(jObj) && this.options.arrayNodeName && this.options.arrayNodeName.length > 1){
+      jObj = {
+        [this.options.arrayNodeName] : jObj
+      }
     }
+    return this.j2x(jObj, 0).val;
   }
-  return this.j2x(jObj, 0).val;
 };
 
-Parser.prototype.j2x = function(jObj, level) {
+Builder.prototype.j2x = function(jObj, level) {
   let attrStr = '';
   let val = '';
   for (let key in jObj) {
@@ -104,57 +118,42 @@ Parser.prototype.j2x = function(jObj, level) {
       //premitive type
       const attr = this.isAttribute(key);
       if (attr) {
-        attrStr += ' ' + attr + '="' + this.options.attrValueProcessor('' + jObj[key]) + '"';
-      } else if (this.isCDATA(key)) {
-        if (jObj[this.options.textNodeName]) {
-          val += this.replaceCDATAstr(jObj[this.options.textNodeName], jObj[key]);
-        } else {
-          val += this.replaceCDATAstr('', jObj[key]);
-        }
-      } else {
+        let val = this.options.attributeValueProcessor(attr, '' + jObj[key]);
+        val = this.replaceEntitiesValue(val);
+        attrStr += ' ' + attr + '="' + val + '"';
+      }else {
         //tag value
         if (key === this.options.textNodeName) {
-          if (jObj[this.options.cdataTagName]) {
-            //value will added while processing cdata
-          } else {
-            val += this.options.tagValueProcessor('' + jObj[key]);
-          }
+          let newval = this.options.tagValueProcessor(key, '' + jObj[key]);
+          val += this.replaceEntitiesValue(newval);
         } else {
           val += this.buildTextNode(jObj[key], key, '', level);
         }
       }
     } else if (Array.isArray(jObj[key])) {
       //repeated nodes
-      if (this.isCDATA(key)) {
-        val += this.indentate(level);
-        if (jObj[this.options.textNodeName]) {
-          val += this.replaceCDATAarr(jObj[this.options.textNodeName], jObj[key]);
+      const arrLen = jObj[key].length;
+      for (let j = 0; j < arrLen; j++) {
+        const item = jObj[key][j];
+        if (typeof item === 'undefined') {
+          // supress undefined node
+        } else if (item === null) {
+          val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+        } else if (typeof item === 'object') {
+          val += this.processTextOrObjNode(item, key, level)
         } else {
-          val += this.replaceCDATAarr('', jObj[key]);
-        }
-      } else {
-        //nested nodes
-        const arrLen = jObj[key].length;
-        for (let j = 0; j < arrLen; j++) {
-          const item = jObj[key][j];
-          if (typeof item === 'undefined') {
-            // supress undefined node
-          } else if (item === null) {
-            val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
-          } else if (typeof item === 'object') {
-            val += this.processTextOrObjNode(item, key, level)
-          } else {
-            val += this.buildTextNode(item, key, '', level);
-          }
+          val += this.buildTextNode(item, key, '', level);
         }
       }
     } else {
       //nested node
-      if (this.options.attrNodeName && key === this.options.attrNodeName) {
+      if (this.options.attributesGroupName && key === this.options.attributesGroupName) {
         const Ks = Object.keys(jObj[key]);
         const L = Ks.length;
         for (let j = 0; j < L; j++) {
-          attrStr += ' ' + Ks[j] + '="' + this.options.attrValueProcessor('' + jObj[key][Ks[j]]) + '"';
+          let val = this.options.attributeValueProcessor(Ks[j], '' + jObj[key][Ks[j]]);
+          val = this.replaceEntitiesValue(val);
+          attrStr += ' ' + Ks[j] + '="' + val + '"';
         }
       } else {
         val += this.processTextOrObjNode(jObj[key], key, level)
@@ -173,27 +172,6 @@ function processTextOrObjNode (object, key, level) {
   }
 }
 
-function replaceCDATAstr(str, cdata) {
-  str = this.options.tagValueProcessor('' + str);
-  if (this.options.cdataPositionChar === '' || str === '') {
-    return str + '<![CDATA[' + cdata + ']]' + this.tagEndChar;
-  } else {
-    return str.replace(this.options.cdataPositionChar, '<![CDATA[' + cdata + ']]' + this.tagEndChar);
-  }
-}
-
-function replaceCDATAarr(str, cdata) {
-  str = this.options.tagValueProcessor('' + str);
-  if (this.options.cdataPositionChar === '' || str === '') {
-    return str + '<![CDATA[' + cdata.join(']]><![CDATA[') + ']]' + this.tagEndChar;
-  } else {
-    for (let v in cdata) {
-      str = str.replace(this.options.cdataPositionChar, '<![CDATA[' + cdata[v] + ']]>');
-    }
-    return str + this.newLine;
-  }
-}
-
 function buildObjectNode(val, key, attrStr, level) {
   if (attrStr && val.indexOf('<') === -1) {
     return (
@@ -236,21 +214,36 @@ function buildEmptyObjNode(val, key, attrStr, level) {
 }
 
 function buildTextValNode(val, key, attrStr, level) {
+  let textValue = this.options.tagValueProcessor(key, val);
+  textValue = this.replaceEntitiesValue(textValue);
+  
   return (
     this.indentate(level) +
     '<' +
     key +
     attrStr +
     '>' +
-    this.options.tagValueProcessor(val) +
+     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];
+      textValue = textValue.replace(entity.regex, entity.val);
+    }
+  }
+  return textValue;
+}
+
 function buildEmptyTextNode(val, key, attrStr, level) {
-  if (val !== '') {
+  if( val === '' && this.options.unpairedTags.indexOf(key) !== -1){
+    return this.indentate(level) + '<' + key + attrStr + this.tagEndChar;
+  }else if (val !== '') {
     return this.buildTextValNode(val, key, attrStr, level);
   } else {
     return this.indentate(level) + '<' + key + attrStr + '/' + this.tagEndChar;
@@ -269,12 +262,4 @@ function isAttribute(name /*, options*/) {
   }
 }
 
-function isCDATA(name) {
-  return name === this.options.cdataTagName;
-}
-
-//formatting
-//indentation
-//\n after each closing or self closing tag
-
-module.exports = Parser;
+module.exports = Builder;

package/src/xmlbuilder/orderedJs2Xml.js

@@ -0,0 +1,99 @@
+const {EOL} = require('os');
+
+/**
+ * 
+ * @param {array} jArray 
+ * @param {any} options 
+ * @returns 
+ */
+function toXml(jArray, options){
+    return arrToStr( jArray, options, "", 0);
+}
+
+function arrToStr(arr, options, jPath, level){
+    let xmlStr = "";
+
+    let indentation = "";
+    if(options.format && options.indentBy.length > 0){//TODO: this logic can be avoided for each call
+        indentation = EOL + "" + options.indentBy.repeat(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 = tagObj[tagName];
+            if(!isStopNode(newJPath, options)){
+                tagText = options.tagValueProcessor( tagName, tagText);
+                tagText = replaceEntitiesValue(tagText, options);
+            }
+            xmlStr += indentation + tagText;
+            continue;
+        }else if( tagName === options.cdataPropName){
+            xmlStr += indentation + `<![CDATA[${tagObj[tagName][0][options.textNodeName]}]]>`;
+            continue;
+        }else if( tagName === options.commentPropName){
+            xmlStr += indentation + `<!--${tagObj[tagName][0][options.textNodeName]}-->`;
+            continue;
+        }
+        const attStr = attr_to_str(tagObj.attributes, options);
+        let tagStart =  indentation + `<${tagName}${attStr}`;
+        let tagValue = arrToStr(tagObj[tagName], options, newJPath, level + 1);
+        if( (!tagValue || tagValue.length === 0) && options.suppressEmptyNode){ 
+            if(options.unpairedTags.indexOf(tagName) !== -1){
+                xmlStr += tagStart + ">"; 
+            }else{
+                xmlStr += tagStart + "/>"; 
+            }
+        }else{ 
+            //TODO: node with only text value should not parse the text value in next line
+            xmlStr += tagStart + `>${tagValue}${indentation}</${tagName}>` ;
+        }
+    }
+    
+    return xmlStr;
+}
+
+function propName(obj){
+    const keys = Object.keys(obj);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      if(key !== "attributes") return key;
+    }
+  }
+
+function attr_to_str(attrMap, options){
+    let attrStr = "";
+    if(attrMap && !options.ignoreAttributes){
+        for( attr in attrMap){
+            let attrVal = options.attributeValueProcessor(attr, attrMap[attr]);
+            attrVal = replaceEntitiesValue(attrVal, options);
+            attrStr+= ` ${attr.substr(options.attributeNamePrefix.length)}="${attrVal}"`;
+        }
+    }
+    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) {
+        const entity = options.entities[entityName];
+        textValue = textValue.replace(entity.regex, entity.val);
+      }
+    }
+    return textValue;
+  }
+module.exports = toXml;

package/src/xmlparser/DocTypeReader.js

@@ -0,0 +1,92 @@
+//TODO: handle comments
+function readDocType(xmlData, i){
+    
+    const entities = {};
+    if( xmlData[i + 3] === 'O' &&
+         xmlData[i + 4] === 'C' &&
+         xmlData[i + 5] === 'T' &&
+         xmlData[i + 6] === 'Y' &&
+         xmlData[i + 7] === 'P' &&
+         xmlData[i + 8] === 'E')
+    {    
+        i = i+9;
+        let angleBracketsCount = 1;
+        let hasBody = false, entity = false, comment = false;
+        let exp = "";
+        for(;i<xmlData.length;i++){
+            if (xmlData[i] === '<') {
+                if( hasBody && 
+                     xmlData[i+1] === '!' &&
+                     xmlData[i+2] === 'E' &&
+                     xmlData[i+3] === 'N' &&
+                     xmlData[i+4] === 'T' &&
+                     xmlData[i+5] === 'I' &&
+                     xmlData[i+6] === 'T' &&
+                     xmlData[i+7] === 'Y'
+                ){
+                    i += 7;
+                    entity = true;
+                }else if( hasBody && 
+                    xmlData[i+1] === '!' &&
+                     xmlData[i+2] === 'E' &&
+                     xmlData[i+3] === 'L' &&
+                     xmlData[i+4] === 'E' &&
+                     xmlData[i+5] === 'M' &&
+                     xmlData[i+6] === 'E' &&
+                     xmlData[i+7] === 'N' &&
+                     xmlData[i+8] === 'T'
+                ){
+                    //Not supported
+                    i += 8;
+                }else if( //comment
+                    xmlData[i+1] === '!' &&
+                    xmlData[i+2] === '-' &&
+                    xmlData[i+3] === '-'
+                ){
+                    comment = true;
+                }else{
+                    throw new Error("Invalid DOCTYPE");
+                }
+                angleBracketsCount++;
+                exp = "";
+            } else if (xmlData[i] === '>') {
+                if(comment){
+                    if( xmlData[i - 1] === "-" && xmlData[i - 2] === "-"){
+                        comment = false;
+                    }else{
+                        throw new Error(`Invalid XML comment in DOCTYPE`);
+                    }
+                }else if(entity){
+                    parseEntityExp(exp, entities);
+                    entity = false;
+                }
+                angleBracketsCount--;
+                if (angleBracketsCount === 0) {
+                  break;
+                }
+            }else if( xmlData[i] === '['){
+                hasBody = true;
+            }else{
+                exp += xmlData[i];
+            }
+        }
+        if(angleBracketsCount !== 0){
+            throw new Error(`Unclosed DOCTYPE`);
+        }
+    }else{
+        throw new Error(`Invalid Tag instead of DOCTYPE`);
+    }
+    return {entities, i};
+}
+
+const entityRegex = RegExp("^\\s([a-zA-z0-0]+)[ \t](['\"])([^&]+)\\2");
+function parseEntityExp(exp, entities){
+    const match = entityRegex.exec(exp);
+    if(match){
+        entities[ match[1] ] = {
+            regx : RegExp( `&${match[1]};`,"g"),
+            val: match[3]
+        };
+    }
+}
+module.exports = readDocType;