xml-toolkit 1.1.5 → 1.1.6

package/README.md

@@ -30,6 +30,8 @@ const parser = new XMLParser  ({
 
 const document = parser.process (xml)
 
+// console.log (parser.validationMessages)
+
 for (const element of document.detach ().children) {
   console.log (element.attributes)
 }
@@ -46,7 +48,9 @@ const records = new XMLReader ({
 //xs,
   filterElements : 'Record', 
   map            : XMLNode.toObject ({})
-}).process (xmlSource)
+})
+//.on ('validation-message', s => console.log (s))
+  .process (xmlSource)
 
 // ...then:
 // await someLoader.load (records)

package/lib/XMLMessages.js

@@ -6,6 +6,9 @@ const VOCABULARY = new Map ([
 	['XML-00002', 'Unbalanced end element'],
 	['XML-00003', 'Unmatched end element, </${%s}> expected'],
 
+	['XSD-00001', 'Unknown namespace: %s'],
+	['XSD-00002', 'The element %s is not found in %s'],
+
 	['XVC-00001', 'No nested elements allowed inside %s'],
 	['XVC-00002', 'is unexpected here; should be %s'],
 	['XVC-00003', 'Unknown attribute: %s'],
@@ -28,7 +31,7 @@ const VOCABULARY = new Map ([
 	['XVS-00014', `'%s' is not a valid decimal: '%s' can occur only at the beginning`],
 	['XVS-00015', `'%s' is not a valid decimal: 2nd period occured at position %i`],
 	['XVS-00016', `'%s' is not a valid decimal: '%s' occured at position %i`],
-	['XVS-00017', `'%s' is not a valid decimal: is has no digits at all`],
+	['XVS-00017', `'%s' is not a valid decimal: it has no digits at all`],
 	['XVS-00018', `'%s' has %i digits, only %i allowed`],
 	['XVS-00019', `'%s' has  %i digits after period, only %i allowed`],
 	['XVS-00020', `No floating point number can be empty`],
@@ -37,6 +40,22 @@ const VOCABULARY = new Map ([
 	['XVS-00023', `For a dateTime value, the time part is mandatory, missing from '%s'`],
 	['XVS-00024', `For a dateTimeStamp value, both time and timezone parts are mandatory, missing from '%s'`],
 	['XVS-00025', `The year separator is not found in '%s'`],
+	['XVS-00026', `'%s': '%s' is not a valid year, must be 4 chars long`],
+	['XVS-00027', `'%s': The character at %i must be '-', not '%s'`],
+	['XVS-00028', `'%s': The day part must be 2 chars long, found '%s'`],
+	['XVS-00029', `'%s': Invalid time part: the character at position %i must be ':', not '%s'`],
+	['XVS-00030', `'%s': '%s' is not a valid year: '%s' at position %i`],
+	['XVS-00031', `'%s': Invalid month '%s'`],
+	['XVS-00032', `'%s': Invalid day '%s'`],
+	['XVS-00033', `'%s': Non existing day`],
+	['XVS-00034', `'%s': Invalid hour '%s'`],
+	['XVS-00035', `'%s': Invalid minute '%s'`],
+	['XVS-00036', `'%s': Invalid second '%s'`],
+	['XVS-00037', `'%s': Invalid TZ hour '%s'`],
+	['XVS-00038', `'%s': Invalid TZ minute '%s'`],
+	['XVS-00039', `'%s': Unless 'Z', the timezone must start with either '+' or '-', not '%s'`],
+	['XVS-00040', `'%s': Invalid timezone length '%i'`],
+	['XVS-00041', `'%s': Invalid timezone: ':' not found at position 3`],
 
 ])
 
@@ -46,9 +65,21 @@ class XMLMessages {
 
 	static format (args) {
 
-		args [0] = VOCABULARY.get (args [0])
+		const code = args [0]
+
+		args [0] = VOCABULARY.get (code)
+
+		return code + ' ' + util.format.apply (util, args)
+
+	}
+
+	static raise (args) {
+
+		const error = Error (XMLMessages.format (args))
+
+		error.args = args
 
-		return util.format.apply (util, args)
+		throw error
 
 	}
 	

package/lib/XMLParser.js

@@ -48,6 +48,7 @@ const XMLParser = class {
 		this.text = ''
 		this.document = null
 		this.element = null
+		this.validationMessages = []
 
 		const {entityResolver} = this, nodes = new XMLIterator (src, {entityResolver})
 		
@@ -67,9 +68,7 @@ const XMLParser = class {
 
 					if (this.stripSpace) this.text = this.text.trim ()
 					if (this.text.length === 0) break
-					if (this.validator) {
-						this.validator.characters (this.text)
-					}
+					if (this.validator) {this.validator.characters (this.text)}
 					(new XMLNode (this.text, null, SAXEvent.TYPES.CHARACTERS)).parent = this.element
 					this.text = ''
 
@@ -84,10 +83,17 @@ const XMLParser = class {
 					this.element = node
 					if (this.document === null) {
 						this.document = node
-						if (this.xs !== null) this.validator = new XMLValidatior (this.xs, node, nodes.position)
+						if (this.xs !== null) {
+							try {
+								this.validator = new XMLValidatior (this.xs, node, nodes.position, message => this.validationMessages.push (message))
+							}
+							catch (err) {
+								this.validationMessages.push (nodes.position + err.message)
+							}							
+						}
 					}
 					else {
-						if (this.xs !== null) this.validator.startElement (node)
+						if (this.validator) this.validator.startElement (node)
 					}
 					break
 
@@ -98,7 +104,7 @@ const XMLParser = class {
 					node ['_ns_map'] = this.element ['_ns_map']
 					this.element.type = type
 					this.element = this.element.parent
-					if (this.xs !== null) this.validator.endElement (node)
+					if (this.validator) this.validator.endElement (node)
 					break
 
 			}

package/lib/XMLReader.js

@@ -147,13 +147,20 @@ const XMLReader = class extends Transform {
 		if (!this.validator) switch (xmlNode.type) {
 
 			case SAXEvent.TYPES.START_ELEMENT:									
-				this.validator = new XMLValidatior (this.xs, xmlNode, this.lex.position)
+				try {
+					this.validator = new XMLValidatior (this.xs, xmlNode, this.lex.position, s => this.emit ('validation-message', s))
+				}
+				catch (err) {
+					this.emit ('validation-message', this.lex.position + err.message)
+				}
 
 			default:
 				return
 
 		}
 
+		// if (!this.validator) return
+
 		switch (xmlNode.type) {
 
 			case SAXEvent.TYPES.START_ELEMENT : return this.validator.startElement (xmlNode)
@@ -170,17 +177,17 @@ const XMLReader = class extends Transform {
 
 		if (type !== null) xmlNode.type = type
 
-		if (this.xs) try {
+		if (this.xs) /*try {*/
 
 			this.validate (xmlNode)
-
+/*
 		}
 		catch (error) {
 
 			this.destroy (error)
 
 		}
-
+*/
 		const {filter} = this; if (filter !== null) {
 
 			if (!filter (xmlNode)) return

package/lib/XMLSchema.js

@@ -1,3 +1,4 @@
+const XMLMessages = require ('./XMLMessages.js')
 const TYPES = Symbol ('_types')
 
 const FORM_U = 'unqualified'
@@ -91,7 +92,7 @@ const XMLSchema = class extends Map {
 
 		const el = this.get (localName)
 
-		if (!el || el.localName !== 'element') throw Error (`The element ${localName} is not found in ${this.targetNamespace}`)
+		if (!el || el.localName !== 'element') XMLMessages.raise (['XSD-00002', localName, this.targetNamespace])
 
 		return el
 

package/lib/XMLSchemata.js

@@ -168,7 +168,7 @@ const XMLSchemata = class extends Map {
 
 	getSchema (namespaceURI) {
 
-		if (!this.has (namespaceURI)) throw new Error ('Unknown namespace: ' + namespaceURI)
+		if (!this.has (namespaceURI)) XMLMessages.raise (['XSD-00001', namespaceURI])
 
 		return this.get (namespaceURI)
 

package/lib/simple/DT7.js

@@ -9,44 +9,44 @@ const CH_9      = '9'.charCodeAt (0)
 
 const tzCache = new Set (['Z', '+14:00', '-14:00'])
 
-const die = payload => {
-
-	const err = Error ('DT7 error')
-
-	err.payload = payload
-
-	throw err
-
-}
-
 class DT7 {
 	
 	constructor (src) {
 
 		const t = typeof src; if (t !== 'string') throw Error (`The Seven-property Date Time Model can only be constructed from a string, not a(n) ${t}`)
 
-		const {length} = src; if (length < MIN_LENGTH) die (['XVS-00005', src, length, MIN_LENGTH])
-
 		this.src = src
 
+		const {length} = src; if (length < MIN_LENGTH) this.raise ('XVS-00005', length, MIN_LENGTH)
+
 		this.parse ()
 		this.validate ()
 
 	}
 
+	raise (code, ...args) {
+
+		const err = Error ('DT7 error')
+
+		err.payload = [code, this.src, ...args]
+
+		throw err
+
+	}
+
 	parse () {
 
 		this.posMonth = this.src.indexOf ('-', 1)
 
-		if (this.posMonth === -1) die (['XVS-00025', this.src])
-		
-		if (this.posMonth < 3) throw Error (`'${this.year}' is not a valid year: cannot be shorter than 4 characters`)
+		if (this.posMonth === -1) this.raise ('XVS-00025')
 
-		if (this.src.charCodeAt (this.posDay) !== CH_MINUS) throw Error (`The character at ${this.posDay} must be '-', not '${this.src.charAt (this.posDay)}'`)
+		if (this.posMonth < 3) this.raise ('XVS-00026', this.year)
+
+		if (this.src.charCodeAt (this.posDay) !== CH_MINUS) this.raise ('XVS-00027', this.posDay, this.src.charAt (this.posDay))
 		
 		const {length} = this.src
 
-		if (length < this.endOfDate) throw Error (`The day part must be 2 chars long, found '${this.day}'`)
+		if (length < this.endOfDate) this.raise ('XVS-00028', this.day)
 
 		if (length !== (this.endOfDateTime = this.endOfDate)) this.parseAfterDate ()
 
@@ -56,12 +56,8 @@ class DT7 {
 		
 		if (this.src.charCodeAt (this.endOfDate) !== CH_T) return
 
-		for (const pos of [this.endOfHour, this.endOfMinute])
-
-			if (this.src.charCodeAt (pos) !== CH_COLON)
+		for (const pos of [this.endOfHour, this.endOfMinute]) if (this.src.charCodeAt (pos) !== CH_COLON) this.raise ('XVS-00029', pos, this.src.charAt (pos))
 				
-				throw Error (`Invalid time part: the character at position ${pos} must be ':', not '${this.src.charAt (pos)}'`)
-
 		this.hasTime = true
 
 		this.parseAfterMinute ()	
@@ -174,13 +170,13 @@ class DT7 {
 
 		const {year} = this, {length} = year, base = year.charCodeAt (0) === CH_MINUS ? 1 : 0
 
-		if (year.charCodeAt (base) === CH_0 && length - base !== 4) throw Error (`Starting with 0, the year must have exactly 4 digits`)
+		if (year.charCodeAt (base) === CH_0 && length - base !== 4) this.raise ('XVS-00026', year)
 		
 		for (let i = base; i < length; i ++) {
 
 			const c = year.charCodeAt (i)
 
-			if (c > CH_9 || c < CH_0) throw Error (`Invalid year: '${year.charAt (i)} at position ${i}'`)
+			if (c > CH_9 || c < CH_0) this.raise ('XVS-00030', year, year.charAt (i), i)
 
 		}
 
@@ -190,7 +186,13 @@ class DT7 {
 
 		const {month} = this
 
-		if (month < '01' || month > '12') throw Error (`Invalid month`)
+		if (month < '01' || month > '12') this.raise ('XVS-00031', month)
+
+	}
+
+	validate2digits (value, code, max = '59', min = '00') {
+
+		if (value < min || value > max) this.raise (code, value)
 
 	}
 
@@ -198,11 +200,11 @@ class DT7 {
 
 		const {day} = this
 
-		if (day < '01' || day > '31') throw Error (`Invalid day`)
+		this.validate2digits (day, 'XVS-00032', '31', '01')
 
 		if (day === '31' || (this.month === '02' && day > '28')) {
 
-			if (new Date (this.src.substring (0, this.endOfDate)).getDate () != day) throw Error (`Non existing day`)
+			if (new Date (this.src.substring (0, this.endOfDate)).getDate () != day) this.raise ('XVS-00033')
 
 		}
 
@@ -210,14 +212,12 @@ class DT7 {
 
 	validateTime () {
 
-		const {hour, minute, second} = this
-
-		if (hour      < '00'    || hour      > '23') throw Error (`Invalid hour`)
-		if (minute    < '00'    || minute    > '59') throw Error (`Invalid minute`)
+		this.validate2digits (this.hour,   'XVS-00034', '23')
+		this.validate2digits (this.minute, 'XVS-00035')
 
-		const intSecond = second.length === 2 ? second : second.substring (0, 2)
+		const {second} = this, intSecond = second.length === 2 ? second : second.substring (0, 2)
 
-		if (intSecond < '00'    || intSecond > '59') throw Error (`Invalid second`)
+		this.validate2digits (intSecond,   'XVS-00036')
 
 	}
 
@@ -230,24 +230,15 @@ class DT7 {
 			case CH_MINUS:
 				break
 			default:
-				throw Error (`Unless 'Z', the timezone must start with either '+' or '-', not ${tz.charAt (0)}`)
+				this.raise ('XVS-00039', tz.charAt (0))
 		}
 
-		if (tz.length !== 6) throw Error (`Invalid timezone length: ${tz.length}`)
+		if (tz.length !== 6) this.raise ('XVS-00040', tz.length)
 
-		if (tz.charCodeAt (3) !== CH_COLON) throw Error (`Invalid timezone: ':' not found at position 3`)
+		if (tz.charCodeAt (3) !== CH_COLON) this.raise ('XVS-00041')
 
-		{
-
-			const hh = tz.substring (1, 3); if (hh < '00' || hh > '13') throw Error (`Invalid TZ hour: ${hh}`)
-
-		}
-
-		{
-
-			const mm = tz.substring (4, 6); if (mm < '00' || mm > '59') throw Error (`Invalid TZ minute: ${mm}`)
-
-		}
+		this.validate2digits (tz.substring (1, 3), 'XVS-00037', '13')
+		this.validate2digits (tz.substring (4, 6), 'XVS-00038')
 
 		tzCache.add (tz)
 

package/lib/simple/XSSimpleTypeDT.js

@@ -64,9 +64,20 @@ class XSSimpleTypeDateTime extends XSSimpleTypeDT {
 
 	testFormat (s) {
 
-		const dt7 = new DT7 (s)
+		try {
+
+			const dt7 = new DT7 (s)
+
+			if (dt7.hour === undefined) return ['XVS-00023', s]
+			
+		}
+		catch (err) {
+
+			if ('payload' in err) return err.payload
 
-		if (dt7.hour === undefined) return ['XVS-00023', s]
+			throw err
+
+		}
 
 	}
 
@@ -86,9 +97,20 @@ class XSSimpleTypeDateTimeStamp extends XSSimpleTypeDateTime {
 
 	testFormat (s) {
 
-		const dt7 = new DT7 (s)
+		try {
+
+			const dt7 = new DT7 (s)
+
+			if (dt7.hour === undefined || dt7.tz === undefined) return ['XVS-00024', s]
+
+		}
+		catch (err) {
+
+			if ('payload' in err) return err.payload
 
-		if (dt7.hour === undefined || dt7.tz === undefined) return ['XVS-00024', s]
+			throw err
+
+		}
 
 	}
 

package/lib/validation/XMLValidationState.js

@@ -8,53 +8,36 @@ class XMLValidationState {
 
 	constructor (parent, parsedNode, elementDefinition) {
 
-		this.xs = (this.parent = parent).xs
+		const xs = this.xs = (this.parent = parent).xs
 		this.parsedNode = parsedNode
-		
-		try {
 
-			this.setTypeFrom (elementDefinition)
+		const typeDefinition = xs.getTypeDefinition (elementDefinition)
 
-		}
-		catch (cause) {
+		this.anyType = xs.getAnyType (typeDefinition)
 
-			this.warn (cause.message)
+		this.validateAttributes (this.parsedNode.attributes)
 
-		}
+		const {content} = this.anyType; if (content) this.match = content.createMatch ()
 
 	}
 
 	warn (message, cause) {
 
-		this.parent.warn (message, cause)
-
-	}
-
-	setTypeFrom (element) {
-
-		const {xs} = this
-
-		const typeDefinition = xs.getTypeDefinition (element)
-
-		this.anyType = xs.getAnyType (typeDefinition)
-
-		this.validateAttributes (this.parsedNode.attributes)
-
-		const {content} = this.anyType; if (content) this.match = content.createMatch ()
+		return this.parent.warn (message, cause)
 
 	}
 
 	blameNothingExpected () {
 
-		this.warn (['XVC-00001', this.parsedNode.src])
+		return this.warn (['XVC-00001', this.parsedNode.src])
 
 	}
 
 	blameUnexpectedTag (parsedNode, match) {
 
-		const expected = match.allExpected (parsedNode); if (expected == null) this.blameNothingExpected ()
+		const expected = match.allExpected (parsedNode); if (expected == null) return this.blameNothingExpected ()
 
-		this.warn (['XVC-00002', expected])
+		return this.warn (['XVC-00002', expected])
 
 	}
 
@@ -62,9 +45,9 @@ class XMLValidationState {
 
 		if (this.#child !== null) return this.#child.startElement (parsedNode)
 
-		const {match} = this; if (!match) this.warn (['XVC-00001', this.anyType.debugQName])
+		const {match} = this; if (!match) return this.warn (['XVC-00001', this.anyType.debugQName])
 
-		const element = match.getElementDefinition (parsedNode); if (!element) this.blameUnexpectedTag (parsedNode, match)
+		const element = match.getElementDefinition (parsedNode); if (!element) return this.blameUnexpectedTag (parsedNode, match)
 
 		if (element.localName === 'any') return
 
@@ -78,7 +61,7 @@ class XMLValidationState {
 
 			if (!this.#hadText) this.characters ('')
 
-			const {match} = this; if (match && !match.isSatisfied) this.blameUnexpectedTag (parsedNode, match)
+			const {match} = this; if (match && !match.isSatisfied) return this.blameUnexpectedTag (parsedNode, match)
 			
 			return null
 
@@ -146,7 +129,7 @@ class XMLValidationState {
 
 				if (attributesMap.getNamespaceURI (name) === XSINamespace) continue
 
-				this.warn (['XVC-00003', name])
+				return this.warn (['XVC-00003', name])
 
 			}
 
@@ -154,7 +137,7 @@ class XMLValidationState {
 
 			const {attributes: {fixed, type}} = def
 
-			if (typeof fixed === 'string' && value !== fixed) this.warn (['XVC-00004', name, fixed, value])
+			if (typeof fixed === 'string' && value !== fixed) return this.warn (['XVC-00004', name, fixed, value])
 
 			if (type) {
 
@@ -173,7 +156,7 @@ class XMLValidationState {
 
 		for (const [name, def] of attributes) if (!matched.has (def)) {
 
-			if (def.attributes.use === 'required') this.warn (['XVC-00005', name])
+			if (def.attributes.use === 'required') return this.warn (['XVC-00005', name])
 
 			if ('default' in def.attributes) attributesMap.set (name, def.attributes.default)
 

package/lib/validation/XMLValidatior.js

@@ -4,12 +4,13 @@ class XMLValidatior {
 
 	#state = null
 
-	constructor (xs, rootNode, position) {
+	constructor (xs, rootNode, position, onMessage) {
 
 		this.xs = xs
 		this.position = position
 
-		this.startElement (rootNode)
+		this.onMessage = onMessage
+		this.startElement (rootNode)		
 
 	}
 
@@ -17,7 +18,13 @@ class XMLValidatior {
 
 		const {position} = this
 
-		throw Error (Array.isArray (message) ? position.format (message) : this.position + message)
+		if (Array.isArray (message)) message = position.format (message)
+
+		this.onMessage (message)
+
+		return null
+
+		// throw Error (message)
 
 	}
 

package/package.json

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