xml-toolkit 1.0.39 → 1.0.41

package/index.js

@@ -1,21 +1,20 @@
-for (const name of [
-
-	'XMLLexer',
-	'XMLReader',
-	'SAXEvent',
-	'AttributesMap',
-	'MoxyLikeJsonEncoder',
-	'XMLNode',
-	'XMLSchemata',
-	'SOAP11',
-	'SOAP12',
-	'EntityResolver',
-	'XMLIterator',
-	'XMLParser',
-	'SOAPFault',
-	'SOAPEncoding',
-
-]) module.exports [name] = require ('./lib/' + name)
+module.exports = {
+	AttributesMap:       require ('./lib/AttributesMap'),	
+	EntityResolver:      require ('./lib/EntityResolver'),	
+	MoxyLikeJsonEncoder: require ('./lib/MoxyLikeJsonEncoder'),
+	SOAP11:              require ('./lib/SOAP11'),
+	SOAP12:              require ('./lib/SOAP12'),
+	SOAPEncoding:        require ('./lib/SOAPEncoding'),
+	SOAPFault:           require ('./lib/SOAPFault'),
+	SAXEvent:            require ('./lib/SAXEvent'),
+	XMLIterator:         require ('./lib/XMLIterator'),
+	XMLNode:             require ('./lib/XMLNode'),
+	XMLLexer:            require ('./lib/XMLLexer'),
+	XMLParser:           require ('./lib/XMLParser'),
+	XMLPrinter:          require ('./lib/XMLPrinter'),
+	XMLReader:           require ('./lib/XMLReader'),
+	XMLSchemata:         require ('./lib/XMLSchemata'),
+}
 
 module.exports.SOAP = v => {switch (String (v)) {
 

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,17 +141,27 @@ const XMLNode = class extends SAXEvent {
 	
 	}
 	
-	toString () {
+	toString (options, level = 0) {
 
-		const {src} = this; if (this.type !== SAXEvent.TYPES.END_ELEMENT || this.isSelfEnclosed) return src
+		if (arguments.length === 0) return this.toSourceString ()
 
-		let s = this.src
+		const xp = new XMLPrinter ({level, ...options})
 
-		for (const child of this.children) s += child
+		xp.writeNode (this)
 
-		s += this.xml
+		return xp.text
 
-		return s
+	}
+
+	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
 
 	}
 

package/lib/XMLPrinter.js

@@ -0,0 +1,280 @@
+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.decl = o.decl
+
+		this.reset ()
+
+	}
+
+	reset () {
+
+		this.text = ''
+		this.stack = []
+		this.isOpening = false
+
+		const {decl} = this; if (decl) this.writeXMLDecl (decl)
+
+		return this
+
+	}
+
+	newLine (delta = 0) {
+
+		this.text += `${this.EOL}${this.space.repeat (this.level + this.stack.length + delta)}`
+
+	}
+
+	get lastCharCode () {
+
+		const {text} = this
+
+		return text.charCodeAt (text.length - 1)
+
+	}
+
+	openElement (name) {
+
+		if (this.stack.length !== 0) {
+			if (this.attrSpace && this.lastCharCode === CH_QQ) this.newLine (-1)
+			if (this.isOpening) this.text += `>`
+		}
+
+		if (this.space && this.text) this.newLine ()
+
+		this.text += `<${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))
+
+		if (this.attrSpace) {
+
+			this.newLine (-1)
+
+			this.text += this.attrSpace
+
+		}
+		else {
+
+			this.text += ' '
+
+		}
+
+		this.text += `${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.newLine (-1)
+			this.text += `>`
+			this.isOpening = false
+		}
+
+		this.text += this.ESC_BODY.escape (value)
+
+		return this
+
+	}
+
+	closeElement () {
+
+		const name = this.stack.pop ()
+
+		if (this.isOpening) {
+			if (this.attrSpace && this.lastCharCode === CH_QQ) this.newLine ()
+			this.text += ` />`
+			this.isOpening = false
+		}
+		else {
+			if (this.space && this.lastCharCode === CH_GT) this.newLine ()
+			this.text += `</${name}>`
+		}
+
+		return this
+
+	}
+
+	writeNode (node) {
+
+		if (node.type !== SAXEvent.TYPES.END_ELEMENT) return this.writeCharacters (node.src)
+
+		this.openElement (node.name)
+
+		if (this.stack.length === 1) {
+
+			const {namespacesMap} = node; if (namespacesMap != null) {
+
+				let min = Infinity; for (const name of namespacesMap.keys ()) {
+
+					const {length} = name
+
+					if (min > length) min = length
+
+				}
+
+				min += 2
+
+				const prefixes = new Set ()
+
+				const checkName = name => {
+
+					if (name.length < min) return
+
+					const pos = name.indexOf (':'); if (pos === -1) return
+
+					const prefix = name.substring (0, pos); if (!namespacesMap.has (prefix)) return
+
+					prefixes.add (prefix)
+
+				}
+
+				const checkNames = n => {
+
+					checkName (n.name)
+
+					for (const [name, value] of n.attributes.entries ()) {
+						checkName (name)
+						checkName (value)
+					}
+
+					for (const child of n.children) if (child.type === SAXEvent.TYPES.END_ELEMENT) checkNames (child); else checkName (child.src)
+
+				}
+
+				checkNames (node)
+
+				for (const prefix of prefixes.values ())
+
+					this.writeAttribute ('xmlns:' + prefix, namespacesMap.get (prefix))
+
+			}						
+
+		}
+
+		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.text += '<?xml version="1.0"'
+
+		if (encoding != null) this.text += ` encoding="${encoding}"`
+		
+		if (standalone != null) this.text += ` standalone="${standalone ? 'yes' : 'no'}"`
+
+		this.text += '?>'
+
+		return this
+
+	}	
+
+}
+
+module.exports = XMLPrinter

package/package.json

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