xml-toolkit 1.0.38 → 1.0.40

package/index.js

@@ -14,6 +14,7 @@ for (const name of [
 	'XMLParser',
 	'SOAPFault',
 	'SOAPEncoding',
+	'XMLPrinter',
 
 ]) module.exports [name] = require ('./lib/' + name)
 

package/lib/XMLNode.js

@@ -1,4 +1,6 @@
+const os = require ('os')
 const SAXEvent      = require ('./SAXEvent.js')
+const XMLPrinter    = require ('./XMLPrinter.js')
 const AttributesMap = require ('./AttributesMap')
 const NamespacesMap = require ('./NamespacesMap')
 const MoxyLikeJsonEncoder = require ('./MoxyLikeJsonEncoder')
@@ -10,6 +12,19 @@ const PARENT     = Symbol ('_parent')
 const LEVEL      = Symbol ('_level')
 const NS_MAP     = Symbol ('_ns_map')
 
+const stringEscape = require ('string-escape-map')
+
+const ESC = [
+  ['<', '&lt;'],
+  ['>', '&gt;'],
+  ['&', '&amp;'],  
+  [String.fromCharCode (10), '&#xA;'],
+  [String.fromCharCode (13), '&#xD;'],
+]
+
+const ESC_BODY = new stringEscape (ESC)
+const ESC_ATTR = new stringEscape ([...ESC,	['"', '&quot;']])
+
 const m2o = 
 	Object.fromEntries ? m => Object.fromEntries (m.entries ()) :
 	m => {let o = {}; for (const [k, v] of m.entries ()) o [k] = v; return o}
@@ -126,6 +141,30 @@ const XMLNode = class extends SAXEvent {
 	
 	}
 	
+	toString (options, level = 0) {
+
+		if (arguments.length === 0) return this.toSourceString ()
+
+		const xp = new XMLPrinter ({level, ...options})
+
+		xp.writeNode (this)
+
+		return xp.text
+
+	}
+
+	toSourceString () {
+
+		const {src} = this; if (this.type !== SAXEvent.TYPES.END_ELEMENT || this.isSelfEnclosed) return src
+
+		let s = this.src
+	
+		for (const child of this.children) s += child.toSourceString ()
+		
+		return s + this.xml
+
+	}
+
 	get text () {
 
 		let s = super.text

package/lib/XMLPrinter.js

@@ -0,0 +1,215 @@
+const os = require ('os')
+const stringEscape = require ('string-escape-map')
+const SAXEvent     = require ('./SAXEvent.js')
+
+const CH_QQ = '"'.charCodeAt (0)
+const CH_GT = '>'.charCodeAt (0)
+
+const ESC = [
+
+	[ '"', '"'],
+	[ '<', '&lt;'],
+	[ '>', '&gt;'],
+	[ '&', '&amp;'],
+
+	['\n', '&#xA;'],
+	['\r', '&#xD;'],
+
+]
+
+const isSafeNonNegative = value => Number.isSafeInteger (value) && value >= 0
+
+const XMLPrinter = class {
+
+	constructor (o = {}) {
+
+		this.level = o.level ?? 0
+		
+		if (!isSafeNonNegative (this.level)) throw Error ('Invalid level: ' + o.level)
+
+		const setSpaceOption = name => {
+
+			const value = o [name] || 0
+
+			this [name] = (() => {
+
+				switch (typeof value) {
+
+					case 'string': return value
+
+					case 'number': if (isSafeNonNegative (value)) return ' '.repeat (value)
+
+					default: throw Error (`Invalid ${name}: ${value}`)
+				
+				}
+
+			}) ()
+
+		}
+
+		setSpaceOption ('space')
+
+		if (this.space) {
+
+			setSpaceOption ('attrSpace')
+
+			this.EOL = o.EOL ?? os.EOL
+
+			if (typeof this.EOL !== 'string') throw Error ('Invalid EOL: ' + o.EOL)
+
+		}
+		else {
+
+			for (const name of ['attrSpace', 'EOL']) if (o [name] != null) throw Error (`Without .space, .${name} cannot be set`)
+
+			this.EOL = ''
+
+		}
+
+		this.encodeLineBreaks = o.encodeLineBreaks ?? true
+
+		{
+
+			const to = this.encodeLineBreaks ? Infinity : -2
+
+			this.ESC_BODY = new stringEscape (ESC.slice (1, to))
+			this.ESC_ATTR = new stringEscape (ESC.slice (0, to))
+
+		}
+
+		this.reset ()
+
+	}
+
+	reset () {
+
+		this.text = ''
+		this.stack = []
+		this.isOpening = false
+
+	}
+
+	newLine (delta = 0) {
+
+		return this.EOL + this.space.repeat (this.level + this.stack.length + delta)
+
+	}
+
+	append (s) {
+
+		this.text += s
+
+		this.lastCharCode = s.charCodeAt (s.length - 1)
+
+	}
+
+	openElement (name) {
+
+		if (this.stack.length !== 0) {
+			if (this.attrSpace && this.lastCharCode === CH_QQ) this.append (this.newLine (-1))
+			if (this.isOpening) this.append (`>`)
+			if (this.space)     this.append (this.newLine ())
+		}
+
+		this.append (`<${name}`)
+		this.stack.push (name)
+
+		this.isOpening = true
+
+		return this
+
+	}
+
+	writeAttribute (name, value) {
+
+		if (!this.isOpening) throw Error ('No attribute allowed at this point')
+
+		if (typeof name !== 'string') throw Error ('The attribute name must be a string, not ' + (typeof name))
+
+		if (typeof value !== 'string') throw Error ('The attribute value must be a string, not ' + (typeof value))
+
+		this.append (`${this.attrSpace ? `${this.newLine (-1)}${this.attrSpace}` : ' '}${name}="${this.ESC_ATTR.escape (value)}"`)
+
+		return this
+
+	}
+
+	writeCharacters (value) {
+
+		if (this.stack.length === 0) throw Error ('No element started yet')
+
+		if (typeof value !== 'string') throw Error ('The text content must be a string, not ' + (typeof value))
+
+		if (value.length === 0) return this
+
+		if (this.isOpening) {
+			if (this.attrSpace && this.lastCharCode === CH_QQ) this.append (this.newLine (-1))
+			this.append (`>`)
+			this.isOpening = false
+		}
+
+		this.append (this.ESC_BODY.escape (value))
+
+		return this
+
+	}
+
+	closeElement () {
+
+		const name = this.stack.pop ()
+
+		if (this.isOpening) {
+			if (this.attrSpace && this.lastCharCode === CH_QQ) this.append (this.newLine ())
+			this.append (` />`)
+			this.isOpening = false
+		}
+		else {
+			if (this.space && this.lastCharCode === CH_GT) this.append (this.newLine ())
+			this.append (`</${name}>`)
+		}
+
+		return this
+
+	}
+
+	writeNode (node) {
+
+		if (node.type !== SAXEvent.TYPES.END_ELEMENT) return this.writeCharacters (node.src)
+
+		this.openElement (node.name)
+
+		for (const [name, value] of node.attributes.entries ()) this.writeAttribute (name, value)
+
+		for (const child of node.children) this.writeNode (child)
+		
+		this.closeElement ()
+
+		return this
+
+	}
+
+	writeXMLDecl (encoding, standalone) {
+
+		if (this.stack.length !== 0) throw Error ('The document is already started')
+
+		this.append ('<?xml version="1.0"')
+
+		if (encoding != null) this.append (` encoding="${encoding}"`)
+		
+		if (standalone != null) {
+
+			if (standalone !== 'yes' && standalone !== 'no') throw Error ('Invalid `standalone`: ' + standalone)
+
+			this.append (` standalone="${standalone}"`)
+
+		}
+
+		this.append ('?>')
+
+		return this
+
+	}	
+
+}
+
+module.exports = XMLPrinter

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xml-toolkit",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "description": "XML parser, marshaller, SOAP adapter",
   "main": "index.js",
   "files": [