jsxn v0.0.13

JSXN - JSON representation of XML by simple mapping rules

Currently experimental, expect updates to break things

Example usage

const parser = require('slimdom-sax-parser')
import {XMLDocument, Element} from "slimdom"
import {jsxn, Rule} from "./index"

const sampleXml = `
<root xmlns:y="http://localhost/yellow" xmlns:g="http://localhost/green">
    <tree>
        <branch>br1</branch>
        <branch>br2</branch>
    </tree>
    <plant type="shrub"/>
    <plant type="bush"/>
    <option value="true">
        <value>false</value>
    </option>
    <y:yellow a="b">
        text
    </y:yellow>
    <g:yellow>green</g:yellow>
    <simpleText ab="123">text of element</simpleText>
    <simpleText2 xmlns="http://abc">text of element</simpleText2>
    <dash-element dash-attribute="123" dash-dash="slash"/>
    <items>
        <item-part>1</item-part>
        <item-part>2</item-part>
    </items>
</root>
`
const document:XMLDocument = parser.sync(sampleXml)

/**
 * Default behaviors:
 * - when no rule specified, first use key to match by element localName and then by attribute name
 * - if element has no children or attributes, then automaticaly resolve as the textContent
 * - elements are assumed to be single instance unless a rule is added to indicate more than 1 by specifying type = 'multiple'
 * 
 * Rules can be used to customize the behavior of key resolution
 */
const rules:Rule[] = [
    {element:'plant', type: 'multiple'},
    {element:'value', asKey:'v'},
    {element:'yellow', asKey: 'green', namespace: 'http://localhost/green'},
    {element:'simpleText', type: 'text'},
    {element:'item-part', type: 'multiple'},
    {attribute: 'dash-dash', asKey:'dashy'}
]

const xml = jsxn(document.documentElement as Element, rules, {convertKeysToCamelCase:true})

console.log(xml.tree.branch === 'br1')
console.log(xml.plant[1].type === 'bush')
console.log(xml.option.value === 'true')
console.log(xml.option.v === 'false')
console.log(xml.yellow.a === 'b')
console.log(xml.green === 'green')
console.log(xml.simpleText === 'text of element')
console.log(xml.simpleText2 === 'text of element')
console.log(xml.dashElement.dashAttribute === '123')
console.log(xml.dashElement.dashy === 'slash')