xml-toolkit 0.0.6 → 1.0.0

package/README.md

@@ -1,4 +1,57 @@
 # node-xml-toolkit
 Collection of classes for dealing with XML
 
-This is a project template. The actual code is yet to be written.
+# Installation
+
+```
+npm i xml-toolkit
+```
+
+# Using
+* [Reading a Record List](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Reading-a-Record-List)
+
+```js
+const {XMLReader, XMLNode} = require ('xml-toolkit')
+
+const records = new XMLReader ({
+  filterElements : 'Record', 
+  map            : XMLNode.toObject ({})
+}).process (xmlSource)
+
+// ...then:
+// await someLoader.load (records)
+
+// ...or
+// for await (const record of records) { // pull parser mode
+
+// ...or
+// records.on ('error', e => console.log (e))
+// records.pipe (nextStream)
+
+// ...or
+// records.on ('error', e => console.log (e))
+// records.on ('data', record => doSomethingWith (record))
+```
+
+* [Getting a Single Element](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Getting-a-Single-Element)
+
+```js
+const {XMLReader, XMLNode} = require ('xml-toolkit')
+
+const data = await new XMLReader ({
+  filterElements : 'MyElementName', 
+  map            : XMLNode.toObject ({})
+}).process (xmlSource).findFirst ()
+```
+
+* [Patching XML](https://github.com/do-/node-xml-toolkit/wiki/Use-Case:-Patching-XML)
+
+```js
+const {XMLReader} = require ('xml-toolkit')
+
+let xmlResult = ''; for await (const node of new XMLReader ().process (xmlSource)) xmlResult += 
+    node.isCharacters && node.parent.localName === 'ThePlaceHolder' ? id : 
+    node.xml
+```
+
+More information available in [wiki docs](https://github.com/do-/node-xml-toolkit/wiki).

package/index.js

@@ -3,5 +3,6 @@ const XMLReader           = require ('./lib/XMLReader')
 const SAXEvent            = require ('./lib/SAXEvent')
 const AttributesMap       = require ('./lib/AttributesMap')
 const MoxyLikeJsonEncoder = require ('./lib/MoxyLikeJsonEncoder')
+const XMLNode             = require ('./lib/XMLNode')
 
-module.exports = {XMLLexer, XMLReader, SAXEvent, AttributesMap, MoxyLikeJsonEncoder}
+module.exports = {XMLLexer, XMLReader, SAXEvent, AttributesMap, MoxyLikeJsonEncoder, XMLNode}

package/lib/AttributesMap.js

@@ -65,7 +65,7 @@ const AttributesMap = class extends Map {
 
 		}
 
-		return super.set (k, this.fixText (v))
+		return super.set (k, v === '' ? null : this.fixText (v))
 
 	}
 

package/lib/MoxyLikeJsonEncoder.js

@@ -1,39 +1,63 @@
-const SAXEvent = require ('./SAXEvent.js')
+const SAXEvent = require ('./SAXEvent.js'), {CHARACTERS, END_ELEMENT} = SAXEvent.TYPES
 
-const set = (o, k, nv) => {
+const GET_LOCAL_NAME = (localName, namespaceURI) => localName
 
-	if (!(k in o)) return o [k] = nv
+const MoxyLikeJsonEncoder = function (options = {}) {
 
-	const ov = o [k]; if (!Array.isArray (ov)) o [k] = [ov]
-	
-	o [k].push (nv)
+	let {getName} = options; if (!getName) getName = GET_LOCAL_NAME
 
-}
+	const xform = ({children, attributes}) => {
 
-const xform = ({children, attributes}) => {
+		let o = null
 
-	let o = attributes == null ? {} : Object.fromEntries (attributes.entries ())
+		const set = (nv, localName, namespaceURI) => {
+		
+			const k = getName (localName, namespaceURI)
 
-	if (children != null) for (const child of children) switch (child.type) {
+			if (o === null) return o = {[k]: nv}
 
-		case SAXEvent.TYPES.CHARACTERS:  return child.text
+			if (!(k in o)) return o [k] = nv
 
-		case SAXEvent.TYPES.END_ELEMENT: set (o, child.localName, xform (child))
+			const ov = o [k]; if (!Array.isArray (ov)) return o [k] = [ov, nv]
 
-	}
-	
-	return o
+			ov.push (nv)
 
-}
+		}
 
-const MoxyLikeJsonEncoder = function (options = {}) {
+		if (attributes != null)
+					
+			for (const [name, value] of attributes.entries ())
+			
+				set (value, attributes.getLocalName (name), attributes.getNamespaceURI (name))
+
+		if (children != null) for (const child of children) switch (child.type) {
+
+			case CHARACTERS:
+			
+				return child.text
+
+			case END_ELEMENT:
+
+				set (xform (child), child.localName, child.namespaceURI)
+
+		}
+
+		return o
+
+	}
 
 	return function (node) {
 	
 		let result = xform (node)
-	
-		return options.wrap ? {[node.localName]: result} : result
-			
+		
+		const {wrap, map} = options
+
+		if (wrap) result = {[getName (node.localName, node.namespaceURI)]: result}
+		
+		if (map) result = map (result)
+
+		return result
+
 	}
 
 }

package/lib/SAXEvent.js

@@ -196,6 +196,24 @@ const SAXEvent = class {
 	
 	}
 
+	get isStartElement () {
+		
+		return this.type === START_ELEMENT
+		
+	}
+
+	get isEndElement () {
+		
+		return this.type === END_ELEMENT
+		
+	}
+
+	get isCharacters () {
+		
+		return this.type === CHARACTERS
+		
+	}
+
 }
 
 SAXEvent.TYPES = {

package/lib/XMLNode.js

@@ -1,6 +1,7 @@
 const SAXEvent      = require ('./SAXEvent.js')
 const AttributesMap = require ('./AttributesMap')
 const NamespacesMap = require ('./NamespacesMap')
+const MoxyLikeJsonEncoder = require ('./MoxyLikeJsonEncoder')
 
 const XML_READER = Symbol ('_xmlReader')
 const ATTRIBUTES = Symbol ('_attributes')
@@ -31,8 +32,9 @@ const XMLNode = class extends SAXEvent {
 
 		e [PARENT]     = this [PARENT]
 		e [LEVEL]      = this [LEVEL]
-		e [ATTRIBUTES] = this [ATTRIBUTES]
-		e [NS_MAP]     = this [NS_MAP]
+
+		if (ATTRIBUTES in this) e [ATTRIBUTES] = this [ATTRIBUTES]
+		if (NS_MAP     in this) e [NS_MAP]     = this [NS_MAP]
 
 		return e
 
@@ -96,7 +98,9 @@ const XMLNode = class extends SAXEvent {
 
 	get namespaceURI () {
 	
-		return this.namespacesMap.getNamespaceURI (this.name, true)
+		const {namespacesMap} = this; if (namespacesMap == null) return null
+	
+		return namespacesMap.getNamespaceURI (this.name, true)
 
 	}
 	
@@ -138,4 +142,6 @@ XMLNode.getLocalName = name => {
 
 }
 
+XMLNode.toObject = MoxyLikeJsonEncoder
+
 module.exports = XMLNode

package/lib/XMLReader.js

@@ -14,7 +14,7 @@ const XMLReader = class extends Transform {
 		options.decodeStrings = false
 		options.objectMode = true
 		
-		if (!('stripSpace' in options)) options.stripSpace = false
+		if (!('stripSpace' in options)) options.stripSpace = ('filterElements' in options)
 		assert (options.stripSpace === true || options.stripSpace === false, 'options.stripSpace must be boolean, not ' + typeof options.stripSpace)
 
 		if (!('useEntities' in options)) options.useEntities = true

package/package.json

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

package/test/soap.xml

@@ -2,7 +2,7 @@
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
     <SendRequestRequest xmlns="urn://x-artefacts-smev-gov-ru/services/message-exchange/types/1.1" xmlns:ns0="urn://x-artefacts-smev-gov-ru/services/message-exchange/types/basic/1.1">
-      <SenderProvidedRequestData Id="Ue7e71ce1-7ce3-4ca5-a689-1a8f2edbb1af">
+      <SenderProvidedRequestData Id="Ue7e71ce1-7ce3-4ca5-a689-1a8f2edbb1af" IDDQD="">
         <MessageID>3931cda8-3245-11ec-b0bc-000c293433a0</MessageID>
         <ns0:MessagePrimaryContent>
           <ExportDebtRequestsRequest xmlns="urn:dom.gosuslugi.ru/debt-responses/1.0.0" xmlns:ns0="urn:dom.gosuslugi.ru/common/1.2.0">

package/test/test.js

@@ -1,6 +1,6 @@
 const fs = require ('fs')
 const assert = require ('assert')
-const {XMLReader, SAXEvent, XMLLexer, AttributesMap, MoxyLikeJsonEncoder} = require ('../')
+const {XMLReader, SAXEvent, XMLLexer, AttributesMap, XMLNode} = require ('../')
 
 async function test_001_lexer_sync (fn) {
 
@@ -59,8 +59,12 @@ console.log (xml)
 
 	const sax = new XMLReader ({
 //		stripSpace: true,
-//		filterElements: 'SendRequestRequest',
-//		map: MoxyLikeJsonEncoder ({wrap: 1})
+		filterElements: 'SendRequestRequest',
+		map: XMLNode.toObject ({
+//			wrap: 1,
+			getName: (localName, namespaceURI) => (!namespaceURI ? '' : '{' + namespaceURI + '}') + localName,
+			map: o => Object.fromEntries (Object.entries (o).map (([k, v]) => [k + '111', v]))
+		})
 	})
 
 /*
@@ -77,26 +81,22 @@ console.log (xml)
 	})
 */
 
-	
-//	sax.process (fs.createReadStream ('test/' + fn))
-	
-	sax.process (xml)
-
+		
 //console.log (sax)
 //console.log (sax.isSAX)
 
-
+/*
 	let s = ''
-	for await (const {type, src, xml, parent} of sax) {
+	for await (const e of sax) {
 		s += xml
-//		console.log ([type, src, xml, (parent || {}).localName])
+//		console.log ([e.type, e.isStartElement, e.isEndElement , e.isCharacters])
 	}
+*/
+//console.log ([xml, s])
 
-console.log ([xml, s])
-
-//	const v = await sax.findFirst ()
+	const v = await sax.process (xml).findFirst ()
 
-//	console.log (JSON.stringify (v, null, 2))
+	console.log (JSON.stringify (v, null, 2))
 
 }