xml-toolkit 1.0.24 → 1.0.26

package/README.md

@@ -1,5 +1,5 @@
 # node-xml-toolkit
-Collection of classes for dealing with XML
+XML parsers (synchronous, streaming), marshaller, SOAP adapters (1.1, 1.2)
 
 # Installation
 
@@ -25,7 +25,7 @@ for (const element of document.detach ().children) {
 }
 ```
 
-* [Reading a Record List](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Reading-a-Record-List)
+* [Reading a Record List](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Reading-a-Record-List), streaming mode
 
 ```js
 const {XMLReader, XMLNode} = require ('xml-toolkit')
@@ -50,7 +50,7 @@ const records = new XMLReader ({
 // records.on ('data', record => doSomethingWith (record))
 ```
 
-* [Getting a Single Element](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Getting-a-Single-Element)
+* [Getting a Single Element](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Getting-a-Single-Element), streaming mode
 
 ```js
 const {XMLReader, XMLNode} = require ('xml-toolkit')
@@ -93,13 +93,13 @@ const xml = xs.stringify (data)
 */
 ```
 
-* Invoking a [SOAP 1.1](https://github.com/do-/node-xml-toolkit/wiki/SOAP11) Web Service
+* Invoking a [SOAP 1.1](https://github.com/do-/node-xml-toolkit/wiki/SOAP11) or [SOAP 1.2](https://github.com/do-/node-xml-toolkit/wiki/SOAP12) Web Service
 
 ```js
 const http = require ('http')
-const {SOAP11} = require ('xml-toolkit')
+const {SOAP11, SOAP12} = require ('xml-toolkit')
 
-const soap = new SOAP11 ('their.wsdl')
+const soap = new SOAP11 ('their.wsdl') // or SOAP12
 
 const {method, headers, body} = soap.http ({RequestElementNameOfTheirs: {amount: '0.01'}})
 
@@ -107,4 +107,4 @@ const rq = http.request (endpointURL, {method, headers})
 rq.write (body)
 ```
 
-More information available in [wiki docs](https://github.com/do-/node-xml-toolkit/wiki).
+For more information, see [wiki docs](https://github.com/do-/node-xml-toolkit/wiki).

package/index.js

@@ -8,8 +8,10 @@ for (const name of [
 	'XMLNode',
 	'XMLSchemata',
 	'SOAP11',
+	'SOAP12',
 	'EntityResolver',
 	'XMLIterator',
 	'XMLParser',
+	'SOAPFault',
 
 ]) module.exports [name] = require ('./lib/' + name)

package/lib/SOAP11.js

@@ -1,12 +1,52 @@
 const fs          = require ('fs')
+const path        = require ('path')
 
 const XMLSchemata = require ('./XMLSchemata.js')
 const XMLReader   = require ('./XMLReader.js')
 const XMLNode     = require ('./XMLNode.js')
-const SOAPHTTP    = require ('./SOAPHTTP.js')
+const SOAPFault   = require ('./SOAPFault.js')
 
 const WSDL = {namespaceURI: 'http://schemas.xmlsoap.org/wsdl/'}
 
+let _xs = null
+
+const get_xs = () => {
+
+	if (_xs === null) _xs = new XMLSchemata (path.join (path.dirname (module.filename), 'soap-1.1.xsd'))
+
+	return _xs
+
+}
+
+const _fault_xml = ({code, message, actor, detail}) => {
+
+	if (typeof code === 'string') code = {localName: code, namespaceURI: 'http://schemas.xmlsoap.org/soap/envelope/'}
+
+	const Fault = {
+		faultstring: message, 
+		faultcode: code, 
+		faultactor: actor, 
+		detail
+	}
+		
+	return get_xs ().stringify ({Fault})
+
+}
+
+const _message = (body, header, o) => {
+
+	if (!Array.isArray (body)) body = [body, {}]
+
+	if (body [0] instanceof SOAPFault) body [0] = _fault_xml (body [0])
+
+	let Envelope = {Body: XMLSchemata.any (body)}
+	
+	if (header != null) Envelope.Header = XMLSchemata.any (header)
+	
+	return get_xs ().stringify ({Envelope}, o)
+
+}
+
 const SOAP11 = class {
 
 	constructor (fn) {
@@ -81,27 +121,29 @@ const SOAP11 = class {
 	
 	}
 	
-	toSOAPHTTP (o) {
-		
-		let rq = new SOAPHTTP ('1.1')
+	http (body, header) {
 
-		for (const elementLocalName in o) {
+		if (!Array.isArray (body)) body = [body, {}]
+		
+		const encoding = 'UTF-8'
+		
+		let headers = {'Content-Type': 'text/xml; charset=' + encoding.toLowerCase ()}
+		
+		for (const elementLocalName in body [0]) {
 
 			const SOAPAction = this.getSoapActionByElementLocalName (elementLocalName)
 
-			if (SOAPAction) rq.http.headers.SOAPAction = SOAPAction
+			if (SOAPAction) headers.SOAPAction = SOAPAction
 
 		}
 
-		rq.soap.Body.content = this.xs.stringify (o)
-		
-		return rq.build ()
+		body [0] = this.xs.stringify (body [0])
 	
-	}
-
-	http (o) {
-	
-		return this.toSOAPHTTP (o).http
+		return {
+			method: 'POST',
+			headers,
+			body: _message (body, header, {declaration: {encoding}})
+  		}
 	
 	}
 
@@ -127,4 +169,6 @@ SOAP11.fromFile = async function (fn, options = {}) {
 
 }
 
+SOAP11.message = _message
+
 module.exports = SOAP11

package/lib/SOAP12.js

@@ -0,0 +1,74 @@
+const path        = require ('path')
+const XMLSchemata = require ('./XMLSchemata.js')
+const SOAPFault   = require ('./SOAPFault.js')
+
+let _xs = null
+
+const get_xs = () => {
+
+	if (_xs === null) _xs = new XMLSchemata (path.join (path.dirname (module.filename), 'soap-1.2.xsd'))
+
+	return _xs
+
+}
+
+const _fault_xml = ({code, message, actor, detail}) => {
+
+	if (typeof code === 'string') code = {localName: code, namespaceURI: 'http://www.w3.org/2003/05/soap-envelope'}
+
+	const Fault = {
+		Reason: {Text: message}, 
+		Code: {Value: code}, 
+		Role: actor, 
+		Detail: detail
+	}
+		
+	return get_xs ().stringify ({Fault})
+
+}
+
+const _message = (body, header, o) => {
+
+	if (!Array.isArray (body)) body = [body, {}]
+
+	if (body [0] instanceof SOAPFault) body [0] = _fault_xml (body [0])
+
+	let Envelope = {Body: XMLSchemata.any (body)}
+	
+	if (header != null) Envelope.Header = XMLSchemata.any (header)
+	
+	return get_xs ().stringify ({Envelope}, o)
+
+}
+
+const SOAP12 = class {
+
+	constructor (fn) {
+	
+		this.definitions = []
+		
+		if (fn) this.xs = new XMLSchemata (fn)
+	
+	}
+	
+	http (body, header) {
+
+		if (!Array.isArray (body)) body = [body, {}]
+		
+		const encoding = 'UTF-8'
+		
+		body [0] = this.xs.stringify (body [0])
+	
+		return {
+			method: 'POST',
+			headers: {'Content-Type': 'application/soap+xml; charset=' + encoding.toLowerCase ()},
+			body: _message (body, header, {declaration: {encoding}})
+  		}
+	
+	}
+
+}
+
+SOAP12.message = _message
+
+module.exports = SOAP12

package/lib/SOAPFault.js

@@ -0,0 +1,30 @@
+const XMLSchemata = require ('./XMLSchemata.js')
+
+const SOAPFault = class {
+
+	constructor (message, o) {
+
+		if (o == null && typeof message === 'object') {
+			o = message
+			this.message = o.message
+		}
+		else {
+			this.message = message
+		}
+
+		this.code = 'code' in o ? o.code: 'Server'
+
+		if ('actor' in o) {
+			this.actor = o.actor
+		}
+		else if ('role' in o) {
+			this.actor = o.role
+		}
+
+		if ('detail' in o) this.detail = XMLSchemata.any (o.detail)
+
+	}
+
+}
+
+module.exports = SOAPFault

package/lib/XMLMarshaller.js

@@ -24,6 +24,30 @@ const BOOL = new Map ([
 	['Y',     'true'],
 ])
 
+const XML_DECL = [
+	['version', '1.0'], 
+	['encoding', null], 
+	['standalone', null]
+]
+
+const _declaration = o => {
+
+	if (typeof o !== 'object' || o === null) return
+
+	let s = '<?xml'
+
+	for (const [name, def] of XML_DECL) {
+	
+		const f = name in o; if (!f && def === null) continue
+	
+		s += ' ' + name + '="' + (f ? o [name] : def) + '"'
+
+	}
+
+	return s + '?>'
+
+}
+
 const XMLMarshaller = class {
 
 	constructor (xs, localName, namespaceURI) {
@@ -42,13 +66,15 @@ const XMLMarshaller = class {
 
 	}
 	
-	stringify (data, name) {
-
+	stringify (data, o = {}) {
+	
 		const {schemaElement} = this, {targetNamespace, attributes, children} = schemaElement
 
-		this.buf = ''
+		if (typeof o === 'string') o = {localName: o}
 
-		this.appendElement (schemaElement, data, this.ns.QName (name || attributes.name, targetNamespace))
+		this.buf = 'declaration' in o ? _declaration (o.declaration) : ''
+
+		this.appendElement (schemaElement, data, this.ns.QName (o.localName || attributes.name, targetNamespace))
 
 		let xml = this.buf
 
@@ -246,7 +272,7 @@ const XMLMarshaller = class {
 	to_string (v, type, restriction = {}) {
 
 		const carp = () => {throw new Error (`Invalid value for ${type} type: ${v} (${typeof v})`)}
-	
+
 		switch (type) {
 		
 			case 'boolean':
@@ -332,6 +358,9 @@ const XMLMarshaller = class {
 				if (typeof v === 'number') return fractionDigits ? v.toFixed (fractionDigits.value) : '' + v
 				carp ()
 
+			case 'QName':
+				if (typeof v === 'object' && 'localName' in v) v = this.ns.QName (v.localName, v.namespaceURI)
+
 			default:
 				return XML_ATTR.escape ('' + v)
 			
@@ -341,4 +370,6 @@ const XMLMarshaller = class {
 	
 }
 
+XMLMarshaller.declaration = _declaration
+
 module.exports = XMLMarshaller

package/lib/XMLSchemata.js

@@ -85,15 +85,15 @@ const XMLSchemata = class extends Map {
 	
 	}
 	
-	stringify (o) {
+	stringify (data, o) {
 	
-		assert.strictEqual (typeof o, 'object')
+		assert.strictEqual (typeof data, 'object')
 		
-		assert.strictEqual (Object.keys (o).length, 1)
+		assert.strictEqual (Object.keys (data).length, 1)
 		
-		for (let [localName, content] of Object.entries (o)) 
+		for (let [localName, content] of Object.entries (data)) 
 		
-			return this.createMarshaller (localName).stringify (content)
+			return this.createMarshaller (localName).stringify (content, o)
 	
 	}
 			
@@ -199,4 +199,20 @@ XMLSchemata.fromFile = async function (fn, options = {}) {
 
 }
 
+XMLSchemata.any = (xml, attributes) => {
+
+	if (attributes == null && Array.isArray (xml) && xml.length === 2) {
+
+		attributes = xml [1]
+
+		xml = xml [0]
+
+	}
+	
+	if (attributes == null) attributes = {}
+
+	return {null: {[xml]: attributes}}
+
+}
+
 module.exports = XMLSchemata

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xml-toolkit",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "description": "Collection of classes for dealing with XML",
   "main": "index.js",
   "scripts": {

package/test/test.js

@@ -1,6 +1,6 @@
 const fs = require ('fs')
 const assert = require ('assert')
-const {XMLReader, SAXEvent, XMLLexer, AttributesMap, XMLNode, XMLSchemata, SOAP11, EntityResolver, XMLIterator, XMLParser} = require ('../')
+const {XMLReader, SAXEvent, XMLLexer, AttributesMap, XMLNode, XMLSchemata, SOAP11, SOAP12, EntityResolver, XMLIterator, XMLParser, SOAPFault} = require ('../')
 
 async function test_001_lexer_sync (fn) {
 
@@ -332,17 +332,15 @@ async function test_006_schemata (fn) {
 
 }
 
-async function test_007_wsdl (fn) {
+function test_007_wsdl (fn) {
 
-	const soap = await SOAP11.fromFile ('test/20186.wsdl')
-	const soaps = new SOAP11 ('test/20186.wsdl')
+	const soap11 = new SOAP11 ('test/20186.wsdl')
+	const soap12 = new SOAP12 ('test/20186.wsdl')
 	
 	const d = {GetForm9Sync: {address: {Region: {Code: 78}}}}
 
-	console.log (soap.http (d))
-	console.log (soaps.http (d))
-
-//	console.log (soap)
+	console.log (soap11.http (d))
+	console.log (soap12.http (d))
 
 }
 
@@ -455,105 +453,22 @@ for (const element of doc.children) {
 
 function test_013_soap () {
 
-	const xs11 = new XMLSchemata ('test/soap-1.1.xsd')
-
-//	console.log (xs.get ('http://schemas.xmlsoap.org/soap/envelope/'))
-//	console.log (xs.get ('http://schemas.xmlsoap.org/soap/envelope/').getType ('Fault').children[0].children)
-//	console.log (xs.getType ('Fault'))	
-	
-/*
-	console.log (xs.stringify ({
-		Envelope: {
-			Body: {null: {'<foo>bar</foo>': {Id: 1}}},
-		}
-	}))
-
-
-			<faultcode>SOAP-ENV:Client</faultcode>
-			<faultstring>Message does not have necessary info</faultstring>
-			<faultactor>http://gizmos.com/order</faultactor>
-			<detail>
-				<PO:order xmlns:PO="http://gizmos.com/orders/">Quantity element does not have a value</PO:order>
-				<PO:confirmation xmlns:PO="http://gizmos.com/confirm">Incomplete address: no zip code</PO:confirmation>
-			</detail>
-
-
-*/
-
-	let Fault = {
-		faultcode: 'SOAP-ENV:Client',
-		faultstring: 'Message does not have necessary info',
-		faultactor: 'http://gizmos.com/order',
-		detail: {
-			null: {
-				[`
-					<PO:order xmlns:PO="http://gizmos.com/orders/">Quantity element does not have a value</PO:order>
-					<PO:confirmation xmlns:PO="http://gizmos.com/confirm">Incomplete address: no zip code</PO:confirmation>
-				`]: {}
-			}
-		}
-	}
-
-	const soap11 = {
-		Envelope: {
-			Body: {
-				null: {
-					[xs11.stringify ({Fault})]: {}
-				}
-			}
-		}
-	}
-
-/*
-<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
-	<env:Header/>
-	<env:Body>
-		<env:Fault>
-			<env:Code>
-				<env:Value>env:Sender</env:Value>
-			</env:Code>
-			<env:Reason>
-				<env:Text xml:lang="en-US">Message does not have necessary info</env:Text>
-			</env:Reason>
-			<env:Role>http://gizmos.com/order</env:Role>
-			<env:Detail>
-				<PO:order xmlns:PO="http://gizmos.com/orders/">Quantity element does not have a value</PO:order>
-				<PO:confirmation xmlns:PO="http://gizmos.com/confirm">Incomplete address: no zip code</PO:confirmation>
-			</env:Detail>
-		</env:Fault>
-	</env:Body>
-</env:Envelope>
-*/
+	const xs11 = new XMLSchemata ('lib/soap-1.1.xsd')
 
-	console.log (xs11.stringify (soap11))
+	const detail = `
+		<PO:order xmlns:PO="http://gizmos.com/orders/">Quantity element does not have a value</PO:order>
+		<PO:confirmation xmlns:PO="http://gizmos.com/confirm">Incomplete address: no zip code</PO:confirmation>
+	`	
 	
-	const xs12 = new XMLSchemata ('test/soap-1.2.xsd')
-
-	Fault = {
-		Code: {Value: 'env:Sender'},
-		Reason: {Text: 'Message does not have necessary info'},
-		Role: 'http://gizmos.com/order',
-		Detail: {
-			null: {
-				[`
-					<PO:order xmlns:PO="http://gizmos.com/orders/">Quantity element does not have a value</PO:order>
-					<PO:confirmation xmlns:PO="http://gizmos.com/confirm">Incomplete address: no zip code</PO:confirmation>
-				`]: {}
-			}
-		}
-	}
+	const f = 
+			new SOAPFault ('Message does not have necessary info', {
+				code: 'Client',
+				actor: 'http://gizmos.com/order',
+				detail
+			})
 	
-	const soap12 = {
-		Envelope: {
-			Body: {
-				null: {
-					[xs12.stringify ({Fault})]: {}
-				}
-			}
-		}
-	}
-
-	console.log (xs12.stringify (soap12))
+	console.log (SOAP11.message (f))
+	console.log (SOAP12.message (f))
 
 }
 
@@ -576,7 +491,7 @@ async function main () {
 //	await test_004_schemata ()
 //	await test_005_schemata ()
 //	await test_006_schemata ()
-//	await test_007_wsdl ()
+	test_007_wsdl ()
 //	await test_008_schemata ()
 	
 //	test_009_schemata ('smev-message-exchange-service-1.1.xsd')
@@ -589,7 +504,7 @@ async function main () {
 //	test_012_parser ('param_types.xml')
 //	test_012_parser ('20040.wsdl')
 
- test_013_soap ()
+// test_013_soap ()
 	
 }
 

package/lib/SOAPHTTP.js

@@ -1,84 +0,0 @@
-const zlib = require ('zlib')
-
-const VER = {
-
-	'1.1': {
-		contentType  : 'text/xml',
-		namespaceURI : 'http://schemas.xmlsoap.org/soap/envelope/',
-	},
-
-	'1.2': {
-		contentType  : 'application/soap+xml',
-		namespaceURI : 'http://www.w3.org/2003/05/soap-envelope',
-	},
-
-}
-
-const SOAPHTTP = class {
-
-	constructor (versionNumber) {
-
-		if (!(versionNumber in VER)) throw new Exception ('Unknown SOAP version: ' + version)
-
-		const {contentType, namespaceURI} = VER [versionNumber]
-
-		this.charset = 'utf-8'
-
-		this.http = {
-			method  : 'POST',
-			headers : {"Content-Type": contentType},
-		}
-
-		this.soap = {
-			Envelope: {attributes: `xmlns:soap="${namespaceURI}"`},
-			Header:   {attributes: '', content: ''},
-			Body:     {attributes: '', content: ''},
-		}
-
-	}
-
-	el (name) {
-
-		const {attributes, content} = this.soap [name]
-	
-		const qName = 'soap:' + name
-
-		let s = '<' + qName
-
-		if (attributes) s += ' ' + attributes
-
-		if (!content) return s + '/>'
-
-		return s + '>' + content + '</' + qName + '>'
-
-	}
-
-	build () {
-
-		this.http.headers ['Content-Type'] += '; charset=' + this.charset
-
-		this.soap.Envelope.content = this.el ('Header') + this.el ('Body')
-		
-		this.http.body = '<?xml version="1.0" encoding="' + this.charset + '"?>' + this.el ('Envelope')
-
-		return this
-
-	}
-	
-	gzip (options = {}) {
-
-		if (!('level' in options)) options.level = 9
-
-		this.http.body = zlib.gzipSync (this.http.body, options)
-		
-		this.http.headers ['Content-Encoding'] = 'gzip'
-
-		this.http.headers ['Content-Length'] = this.http.body.length
-
-		return this
-
-	}
-
-}
-
-module.exports = SOAPHTTP