xml-toolkit 0.0.4 → 0.0.5

package/lib/MoxyLikeJsonEncoder.js

@@ -12,9 +12,9 @@ const set = (o, k, nv) => {
 
 const xform = ({children, attributes}) => {
 
-	let o = Object.fromEntries (attributes.entries ())
+	let o = attributes == null ? {} : Object.fromEntries (attributes.entries ())
 
-	if (children !== null) for (const child of children) switch (child.type) {
+	if (children != null) for (const child of children) switch (child.type) {
 
 		case SAXEvent.TYPES.CHARACTERS:  return child.text
 

package/lib/XMLReader.js

@@ -2,8 +2,8 @@ const assert      = require ('assert')
 const {Transform} = require ('stream')
 const SAXEvent    = require ('./SAXEvent.js')
 const XMLNode     = require ('./XMLNode.js')
+const XMLLexer    = require ('./XMLLexer.js')
 
-const OPT_ONCE = Symbol ('_once')
 const OPT_SRC  = Symbol ('_src')
 const OPT_SAX  = Symbol ('_sax')
 
@@ -23,8 +23,30 @@ const XMLReader = class extends Transform {
 		if (!('useNamespaces' in options)) options.useNamespaces = true
 		assert (options.useNamespaces === true || options.useNamespaces === false, 'options.useNamespaces must be boolean, not ' + typeof options.useNamespaces)
 
-		const {collect} = options; delete options.collect
+		let {filterElements} = options; delete options.filterElements; if (filterElements != null) {		
+			
+			assert (!('filter' in options), 'filter and filterElements options cannot be set simultaneously')
+			
+			switch (typeof filterElements) {
+			
+				case 'string':
+					const localName = filterElements
+					filterElements = e => e.localName === localName
+					
+				case 'function':
+					options.filter = e => e.type === SAXEvent.TYPES.END_ELEMENT && filterElements (e)
+					break
+					
+				default: 
+					assert.fail ('options.filterElements must be a string or function')
+
+			}
+		
+		}
+
+		let {collect} = options; delete options.collect
 		assert (collect == null || typeof collect === 'function', 'options.collect must be a function, not ' + typeof collect)
+		if (collect == null && filterElements != null) collect = filterElements
 
 		const {filter} = options; delete options.filter
 		assert (filter == null || typeof filter === 'function', 'options.filter must be a function, not ' + typeof filter)
@@ -32,19 +54,14 @@ const XMLReader = class extends Transform {
 		const {map} = options; delete options.map
 		assert (map == null || typeof map === 'function', 'options.map must be a function, not ' + typeof map)
 
-		const {find} = options; delete options.find
-		assert (filter == null || find == null, 'filter & find options cannot be set together')
-		assert (find == null || typeof find === 'function', 'options.find must be a function, not ' + typeof find)
-
 		super (options)
 
 		this.stripSpace    = options.stripSpace
 		this.useEntities   = options.useEntities
 		this.useNamespaces = options.useNamespaces
 		this.collect       = collect || null
-		this.filter        = filter || find || null
+		this.filter        = filter || null
 		this.map           = map || null
-		this [OPT_ONCE]    = find != null
 
 		if (this.useEntities) this.entityResolver = new (require ('./EntityResolver.js')) ()
 		
@@ -57,6 +74,50 @@ const XMLReader = class extends Transform {
 		this [OPT_SAX] = null
 
 	}
+	
+	async findFirst () {
+	
+		assert (!this.isSAX, 'SAX event subscriber detected, findFirst () cannot be used')
+
+		return new Promise ((ok, fail) => {
+		
+			this.once ('error', fail)
+			
+			const THE_END = 'finish',  nope = () => ok (null)
+
+			this.on (THE_END, nope)
+			
+			this.on ('data', e => {
+			
+				this.off (THE_END, nope)
+				
+				if (e.type === SAXEvent.TYPES.END_DOCUMENT) return nope ()
+
+				const src = this [OPT_SRC]; if (src !== null) src.unpipe (this)
+				
+				ok (e)
+				
+				this.destroy ()
+			
+			})
+		
+		})
+	
+	}
+
+	process (src, lexerOptions = {}) {
+
+		const lex = new XMLLexer (lexerOptions)
+		
+		lex.once ('error', x => this.destroy (x))
+		
+		lex.pipe (this)
+		
+		if (Buffer.isBuffer (src) || typeof src === 'string') lex.end (src); else src.pipe (lex)
+
+		return this
+
+	}
 
 	_flush (callback) {
 	
@@ -72,7 +133,7 @@ const XMLReader = class extends Transform {
 
 		const v = this [OPT_SAX]; if (v !== null) return v
 
-		for (const type in SAXEvent.TYPES) if (this.listenerCount (type) !== 0) return this [OPT_SAX] = true
+		for (const type of Object.values (SAXEvent.TYPES)) if (this.listenerCount (type) !== 0) return this [OPT_SAX] = true
 
 		return this [OPT_SAX] = false
 
@@ -97,14 +158,6 @@ const XMLReader = class extends Transform {
 
 		}		
 
-		if (this [OPT_ONCE]) {
-
-			const src = this [OPT_SRC]; if (src !== null) src.unpipe (this)
-
-			this.destroy ()
-
-		}
-
 	}
 	
 	flush_text () {

package/package.json

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

package/test/test.js

@@ -57,74 +57,43 @@ async function test_003_emitter_sync (fn) {
 	
 console.log (xml)
 
-	const lex = new XMLLexer ({
-//		maxLength: 40,
-//		encoding: 'ascii',
-//		stripSpace: true,
-	})
-
 	const sax = new XMLReader ({
 		stripSpace: true,
-		collect: e => true,
-		find: e => true
-//			&& e.type  === SAXEvent.TYPES.CHARACTERS
-			&& e.localName === 'SendRequestRequest'
-			&& e.type  === SAXEvent.TYPES.END_ELEMENT
-//			&& e.level === 6
-		,
+		filterElements: 'SendRequestRequest',
 		map: MoxyLikeJsonEncoder ({wrap: 1})
-//		useEntities: false,
 	})
 
-	lex.pipe (sax)
-
-
+/*
 	for (let event of [
-		'StartDocument',
-		'ProcessingInstruction',
-		'Comment',
-		'DTD',
-		'StartElement',
-		'Characters',
-		'EndElement',
-		'EndDocument',
+		'data',
+		'close',
+		'end',
+		'finish',
+//		'EndElement',
 	]) sax.on (event, data => {
-	
-//		console.log ([event, data])
-		
-		console.log (JSON.stringify (data, null, 2))
-
-/*	
-		console.log ([event, data, data.name, data.localName, data.namespaceURI])
-		
-		const {attributes} = data; for (const [k, v] of attributes.entries ()) {
-		
-			console.log ([k, attributes.getLocalName (k), attributes.getNamespaceURI (k), v])
-
-			console.log ([attributes.get ('ns0:foo')])
 			
-			console.log ([attributes.get ('foo')])
-			
-			console.log ([attributes.get ('foo', 'urn:dom.gosuslugi.ru/common/1.2.0')])
-		
-		}
-*/		
+		console.log ([JSON.stringify (data, null, 2), event])
+	
 	})
-		
+*/
+
+	
+//	sax.process (fs.createReadStream ('test/' + fn))
 	
+	sax.process (xml)
 
+//console.log (sax)
+//console.log (sax.isSAX)
 
 /*
-	sax.on ('StartElement', event => {	
-		console.log ([event, event.attributes])
-	})
+	for await (const e of sax) {
+		console.log (e)
+	}
 */
-//	lexer.on ('data', data => console.log ({data}))
-	
-//	for (let c of xml) lexer.write (c); lexer.end ()
-//	for (let c of xml) lexer.write (Buffer.from ([c])); lexer.end ()
 
-	lex.end (xml)
+	const v = await sax.findFirst ()
+
+	console.log (JSON.stringify (v, null, 2))
 
 }