xml-toolkit 1.0.60 → 1.0.61

package/index.js

@@ -20,7 +20,8 @@ module.exports = {
 	XMLNode:             require ('./lib/XMLNode'),
 	XMLLexer:            require ('./lib/XMLLexer'),
 	XMLParser:           require ('./lib/XMLParser'),
-	XMLPrinter:          require ('./lib/XMLPrinter'),
+	XMLPrinter:          require ('./lib/printer/XMLPrinter'),
+	XMLStreamPrinter:    require ('./lib/printer/XMLStreamPrinter'),
 	XMLReader:           require ('./lib/XMLReader'),
 	XMLSchema:           require ('./lib/XMLSchema'),
 	XMLSchemaBuiltIn:    require ('./lib/XMLSchemaBuiltIn'),

package/lib/XMLMarshaller.js

@@ -1,6 +1,8 @@
 const assert       = require ('assert')
 const NamespacePrefixesMap = require ('./NamespacePrefixesMap.js')
-const XMLPrinter = require ('./XMLPrinter.js')
+const XMLPrinter = require ('./printer/XMLPrinter.js')
+const XMLStreamPrinter = require ('./printer/XMLStreamPrinter.js')
+const {Readable} = require ('node:stream')
 
 const XSI_TYPE = Symbol.for ('type')
 
@@ -15,10 +17,10 @@ const XMLMarshaller = class {
 		this.schemaElement = this.schema.get (localName); assert (this.schemaElement, 'No schema element found for namespaceURI = ' + namespaceURI + ', localName = ' + localName)
 
 		this.ns = new NamespacePrefixesMap (xs)
-		
+
 		this.isNsDumped = false
-		
-		this.printer = new XMLPrinter (printerOptions)
+
+		this.printer = new ('out' in printerOptions ? XMLStreamPrinter : XMLPrinter) (printerOptions)
 
 	}
 	
@@ -40,7 +42,18 @@ const XMLMarshaller = class {
 
 		try {
 
-			this.appendElement (schemaElement, data, this.ns.QName (o.localName || attributes.name, targetNamespace))
+			const result = this.appendElement (schemaElement, data, this.ns.QName (o.localName || attributes.name, targetNamespace))
+
+			if (result instanceof Promise) {
+
+				result.then (printer.end, printer.destroy)
+
+			}
+			else {
+
+				return printer.text
+
+			}
 
 		}
 		catch (cause) {
@@ -51,17 +64,17 @@ const XMLMarshaller = class {
 
 		}
 
-		return printer.text
-
 	}	
 	
 	appendElement (node, data, qName) {
 
 		this.appendStartTag (node, data, qName)
-		
-		this.appendElementBody (node, data)
-		
-		this.printer.closeElement ()
+
+		const result = this.appendElementBody (node, data), finish = () => this.printer.closeElement ()
+
+		if (!(result instanceof Promise)) return finish ()
+
+		return result.then (finish, this.printer.destroy)
 
 	}
 	
@@ -71,7 +84,7 @@ const XMLMarshaller = class {
 
 		if (!this.isNsDumped) {
 		
-			this.printer.text += this.ns
+			this.printer.write (this.ns.toString ())
 		
 			this.isNsDumped = true
 
@@ -110,13 +123,19 @@ const XMLMarshaller = class {
 		const {attributes: {type}, children} = node
 
 		if (data && data [XSI_TYPE]) {
-			let d = {}; for (let k in data) d [k] = data [k]
-			this.appendContent (this.schema.getType (data [XSI_TYPE]), d)
+
+			const d = {}; for (let k in data) d [k] = data [k]
+
+			return this.appendContent (this.schema.getType (data [XSI_TYPE]), d)
+
 		}
+		else if (type) {
 
-		if (type) return this.appendContent (this.xs.getType (type), data)
+			return this.appendContent (this.xs.getType (type), data)
 
-		for (const i of children) this.appendContent (i, data)
+		}
+
+		return this.appendAllContent (children, data)
 
 	}
 
@@ -142,7 +161,7 @@ const XMLMarshaller = class {
 
 				return this.printer.writeAttribute (
 					this.ns.QName (name, targetNamespace), 
-					this.xs.getAttributeSimpleType (node).stringify (v)
+					this.xs.getAttributeSimpleType (node).stringify (v) // throws
 				)
 
 			case 'extension':
@@ -178,7 +197,7 @@ const XMLMarshaller = class {
 
 				const type = this.xs.getSimpleType (node)
 
-				const xml = type.stringify (data)
+				const xml = type.stringify (data) // throws
 				
 				this.printer.writeCharacters (xml)
 
@@ -192,6 +211,8 @@ const XMLMarshaller = class {
 
 				const qName = this.ns.QName (name, targetNamespace)
 				
+				if (v instanceof Readable) return this.printer.forEach (v, d => this.appendElement (node, d, qName))
+
 				if (!Array.isArray (v)) return this.appendElement (node, v, qName)
 				
 				for (const d of v) this.appendElement (node, d, qName)
@@ -199,17 +220,29 @@ const XMLMarshaller = class {
 				return
 				
 			case 'extension':
-			
-				this.appendContent (this.xs.getType (attributes.base), data)
-				
+
+				return this.appendAllContent ([this.xs.getType (attributes.base), ...children], data)
+
 			default:
 
-				for (const i of children) this.appendContent (i, data)
+				return this.appendAllContent (children, data)
 				
 		}
 
 	}
-		
+
+	appendAllContent (list, data) {
+
+		for (let i = 0; i < list.length; i ++) {
+
+			const result = this.appendContent (list [i], data); if (!(result instanceof Promise)) continue
+
+			return result.then (this.appendAllContent (list.slice (i + 1), data), this.printer.destroy)
+
+		}
+
+	}
+
 }
 
 module.exports = XMLMarshaller

package/lib/XMLNode.js

@@ -1,5 +1,5 @@
 const SAXEvent      = require ('./SAXEvent.js')
-const XMLPrinter    = require ('./XMLPrinter.js')
+const XMLPrinter    = require ('./printer/XMLPrinter.js')
 const NamespacesMap = require ('./NamespacesMap')
 const MoxyLikeJsonEncoder = require ('./MoxyLikeJsonEncoder')
 

package/lib/{XMLPrinter.js → printer/Base.js}

@@ -1,6 +1,6 @@
 const os = require ('os')
 const stringEscape = require ('string-escape-map')
-const SAXEvent     = require ('./SAXEvent.js')
+const SAXEvent     = require ('../SAXEvent.js')
 
 const CH_QQ = '"'.charCodeAt (0)
 const CH_GT = '>'.charCodeAt (0)
@@ -19,7 +19,7 @@ const ESC = [
 
 const isSafeNonNegative = value => Number.isSafeInteger (value) && value >= 0
 
-const XMLPrinter = class {
+module.exports = class {
 
 	constructor (o = {}) {
 
@@ -85,7 +85,6 @@ const XMLPrinter = class {
 
 	reset () {
 
-		this.text = ''
 		this.stack = []
 		this.isOpening = false
 
@@ -97,15 +96,7 @@ const XMLPrinter = class {
 
 	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)
+		this.write (`${this.EOL}${this.space.repeat (this.level + this.stack.length + delta)}`)
 
 	}
 
@@ -113,12 +104,12 @@ const XMLPrinter = class {
 
 		if (this.stack.length !== 0) {
 			if (this.attrSpace && this.lastCharCode === CH_QQ) this.newLine (-1)
-			if (this.isOpening) this.text += `>`
+			if (this.isOpening) this.write (`>`)
 		}
 
-		if (this.space && this.text) this.newLine ()
+		if (this.space && !this.isVirgin) this.newLine ()
 
-		this.text += `<${name}`
+		this.write (`<${name}`)
 		this.stack.push (name)
 
 		this.isOpening = true
@@ -139,16 +130,16 @@ const XMLPrinter = class {
 
 			this.newLine (-1)
 
-			this.text += this.attrSpace
+			this.write (this.attrSpace)
 
 		}
 		else {
 
-			this.text += ' '
+			this.write (' ')
 
 		}
 
-		this.text += `${name}="${this.ESC_ATTR.escape (value)}"`
+		this.write (`${name}="${this.ESC_ATTR.escape (value)}"`)
 
 		return this
 
@@ -170,11 +161,11 @@ const XMLPrinter = class {
 
 		if (this.isOpening) {
 			if (this.attrSpace && this.lastCharCode === CH_QQ) this.newLine (-1)
-			this.text += `>`
+			this.write (`>`)
 			this.isOpening = false
 		}
 
-		this.text += value
+		this.write (value)
 
 		return this
 
@@ -186,12 +177,12 @@ const XMLPrinter = class {
 
 		if (this.isOpening) {
 			if (this.attrSpace && this.lastCharCode === CH_QQ) this.newLine ()
-			this.text += ` />`
+			this.write (` />`)
 			this.isOpening = false
 		}
 		else {
 			if (this.space && this.lastCharCode === CH_GT) this.newLine ()
-			this.text += `</${name}>`
+			this.write (`</${name}>`)
 		}
 
 		return this
@@ -271,18 +262,16 @@ const XMLPrinter = class {
 
 		if (this.stack.length !== 0) throw Error ('The document is already started')
 
-		this.text += '<?xml version="1.0"'
+		this.write ('<?xml version="1.0"')
 
-		if (encoding != null) this.text += ` encoding="${encoding}"`
+		if (encoding != null) this.write (` encoding="${encoding}"`)
 		
-		if (standalone != null) this.text += ` standalone="${standalone ? 'yes' : 'no'}"`
+		if (standalone != null) this.write (` standalone="${standalone ? 'yes' : 'no'}"`)
 
-		this.text += '?>'
+		this.write ('?>')
 
 		return this
 
-	}	
-
-}
+	}
 
-module.exports = XMLPrinter
+}

package/lib/printer/XMLPrinter.js

@@ -0,0 +1,39 @@
+const XMLPrinter = class extends (require ('./Base.js')) {
+
+	get destroy () {
+
+		return err => {throw err}
+
+	}	
+
+	reset () {
+
+		this.text = ''
+
+		return super.reset ()
+
+	}
+
+	get lastCharCode () {
+
+		const {text} = this
+
+		return text.charCodeAt (text.length - 1)
+
+	}
+
+	get isVirgin () {
+
+		return this.text.length === 0
+
+	}
+
+	write (s) {
+
+		this.text += s
+
+	}
+
+}
+
+module.exports = XMLPrinter

package/lib/printer/XMLStreamPrinter.js

@@ -0,0 +1,122 @@
+const {Writable} = require ('node:stream')
+
+const XMLStreamPrinter = class extends (require ('./Base.js')) {
+
+	#inStreams    = []
+	#isVirgin     = true
+	#lastCharCode = 0
+	#open         = true
+
+	constructor (o) {
+
+		if (!o || typeof o !== 'object' || !('out' in o)) throw Error (`XMLStreamPrinter requires an .out option`)
+		if (!(o.out instanceof Writable)) throw Error (`.out must be Writable, ${typeof o.out} ${o.out} found`)
+
+		super (o)
+
+		this.out = o.out
+		this.out.on ('drain', () => this.open = true)
+
+	}
+
+	get end () {
+
+		return () => this.out.end ()
+
+	}
+
+	get destroy () {
+
+		return err => this.out.destroy (err)
+
+	}	
+
+	get inStream () {
+
+		return this.#inStreams.at (-1)
+
+	}
+
+	forEach (stream, onData) {
+
+		if (this.#inStreams.length !== 0) return this.destroy (Error ('Nested streams not yet supported'))
+
+		if (!this.#open) stream.pause ()
+		
+		this.#inStreams.push (stream)
+
+		return new Promise ((ok, fail) => {
+
+			stream.on ('error', err => {
+
+				this.destroy (err)
+
+				fail (err)
+
+			})
+
+			stream.on ('end', () => {
+
+				this.#inStreams.pop ()
+
+				ok ()
+
+			})
+
+			stream.on ('data', data => {
+
+				try {
+
+					onData (data)
+
+				}
+				catch (err) {
+
+					stream.destroy (err)
+
+				}
+							
+			})
+
+		}) 
+
+	}
+
+	set open (nowOpen) {
+
+		const wasOpen = this.#open; if (wasOpen === nowOpen) return
+
+		this.#open = nowOpen
+
+		if (!this.inStream) return
+
+		nowOpen ? this.inStream.resume () : this.inStream.pause ()
+
+	}
+
+	get lastCharCode () {
+
+		return this.#lastCharCode
+
+	}
+
+	get isVirgin () {
+
+		return this.#isVirgin
+
+	}
+
+	write (s) {
+
+		const {length} = s; if (length === 0) return
+
+		this.#lastCharCode = s.charCodeAt (length - 1)
+		this.#isVirgin = false
+
+		this.open = this.out.write (s)
+
+	}
+
+}
+
+module.exports = XMLStreamPrinter

package/package.json

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