Package detail

xmldom

xmldom6.5mMIT0.6.0

A pure JavaScript W3C standard-based (XML DOM Level 2 Core) DOMParser and XMLSerializer module.

w3c, dom, xml, parser

readme

XMLDOM

license npm bug issues "help wanted" issues Mutation report

A JavaScript implementation of W3C DOM for Node.js, Rhino and the browser. Fully compatible with W3C DOM level2; and some compatible with level3. Supports DOMParser and XMLSerializer interface such as in browser.

Original project location: https://github.com/jindw/xmldom

Install:

npm install xmldom

Example:

const { DOMParser } = require('xmldom')

const doc = new DOMParser().parseFromString(
    '<xml xmlns="a" xmlns:c="./lite">\n' +
        '\t<child>test</child>\n' +
        '\t<child></child>\n' +
        '\t<child/>\n' +
        '</xml>',
    'text/xml'
)
doc.documentElement.setAttribute('x', 'y')
doc.documentElement.setAttributeNS('./lite', 'c:x', 'y2')
console.info(doc)

const nsAttr = doc.documentElement.getAttributeNS('./lite', 'x')
console.info(nsAttr)

Note: in Typescript and ES6 you can use the import approach, as follows:

import { DOMParser } from 'xmldom'

API Reference

  • DOMParser:

     parseFromString(xmlsource,mimeType)
    • options extension by xmldom(not BOM standard!!)

      //added the options argument
      new DOMParser(options)
      
      //errorHandler is supported
      new DOMParser({
        /**
         * locator is always need for error position info
         */
        locator:{},
        /**
         * you can override the errorHandler for xml parser
         * @link http://www.saxproject.org/apidoc/org/xml/sax/ErrorHandler.html
         */
        errorHandler:{warning:function(w){console.warn(w)},error:callback,fatalError:callback}
        //only callback model
        //errorHandler:function(level,msg){console.log(level,msg)}
      })
  • XMLSerializer

     serializeToString(node)

    DOM level2 method and attribute:


  • Node

     attribute:
         nodeValue|prefix
     readonly attribute:
         nodeName|nodeType|parentNode|childNodes|firstChild|lastChild|previousSibling|nextSibling|attributes|ownerDocument|namespaceURI|localName
     method:    
         insertBefore(newChild, refChild)
         replaceChild(newChild, oldChild)
         removeChild(oldChild)
         appendChild(newChild)
         hasChildNodes()
         cloneNode(deep)
         normalize()
         isSupported(feature, version)
         hasAttributes()
    • DOMException The DOMException class has the following constants (and value of type Number):

    • DOMException.INDEX_SIZE_ERR (1)

    • DOMException.DOMSTRING_SIZE_ERR (2)
    • DOMException.HIERARCHY_REQUEST_ERR (3)
    • DOMException.WRONG_DOCUMENT_ERR (4)
    • DOMException.INVALID_CHARACTER_ERR (5)
    • DOMException.NO_DATA_ALLOWED_ERR (6)
    • DOMException.NO_MODIFICATION_ALLOWED_ERR (7)
    • DOMException.NOT_FOUND_ERR (8)
    • DOMException.NOT_SUPPORTED_ERR (9)
    • DOMException.INUSE_ATTRIBUTE_ERR (10)
    • DOMException.INVALID_STATE_ERR (11)
    • DOMException.SYNTAX_ERR (12)
    • DOMException.INVALID_MODIFICATION_ERR (13)
    • DOMException.NAMESPACE_ERR (14)
    • DOMException.INVALID_ACCESS_ERR (15)

    The DOMException object has the following properties: code This property is of type Number.

    • extends the Error type thrown as part of DOM API:
  • DOMImplementation

     method:
         hasFeature(feature, version)
         createDocumentType(qualifiedName, publicId, systemId)
         createDocument(namespaceURI, qualifiedName, doctype)
  • Document : Node

     readonly attribute:
         doctype|implementation|documentElement
     method:
         createElement(tagName)
         createDocumentFragment()
         createTextNode(data)
         createComment(data)
         createCDATASection(data)
         createProcessingInstruction(target, data)
         createAttribute(name)
         createEntityReference(name)
         getElementsByTagName(tagname)
         importNode(importedNode, deep)
         createElementNS(namespaceURI, qualifiedName)
         createAttributeNS(namespaceURI, qualifiedName)
         getElementsByTagNameNS(namespaceURI, localName)
         getElementById(elementId)
  • DocumentFragment : Node

  • Element : Node

     readonly attribute:
         tagName
     method:
         getAttribute(name)
         setAttribute(name, value)
         removeAttribute(name)
         getAttributeNode(name)
         setAttributeNode(newAttr)
         removeAttributeNode(oldAttr)
         getElementsByTagName(name)
         getAttributeNS(namespaceURI, localName)
         setAttributeNS(namespaceURI, qualifiedName, value)
         removeAttributeNS(namespaceURI, localName)
         getAttributeNodeNS(namespaceURI, localName)
         setAttributeNodeNS(newAttr)
         getElementsByTagNameNS(namespaceURI, localName)
         hasAttribute(name)
         hasAttributeNS(namespaceURI, localName)
  • Attr : Node

     attribute:
         value
     readonly attribute:
         name|specified|ownerElement
  • NodeList

     readonly attribute:
         length
     method:
         item(index)
  • NamedNodeMap

     readonly attribute:
         length
     method:
         getNamedItem(name)
         setNamedItem(arg)
         removeNamedItem(name)
         item(index)
         getNamedItemNS(namespaceURI, localName)
         setNamedItemNS(arg)
         removeNamedItemNS(namespaceURI, localName)
  • CharacterData : Node

     method:
         substringData(offset, count)
         appendData(arg)
         insertData(offset, arg)
         deleteData(offset, count)
         replaceData(offset, count, arg)
  • Text : CharacterData

     method:
         splitText(offset)
  • CDATASection

  • Comment : CharacterData

  • DocumentType

     readonly attribute:
         name|entities|notations|publicId|systemId|internalSubset
  • Notation : Node

     readonly attribute:
         publicId|systemId
  • Entity : Node

     readonly attribute:
         publicId|systemId|notationName
  • EntityReference : Node

  • ProcessingInstruction : Node

     attribute:
         data
     readonly attribute:
         target

DOM level 3 support:

  • Node

     attribute:
         textContent
     method:
         isDefaultNamespace(namespaceURI){
         lookupNamespaceURI(prefix)

DOM extension by xmldom

  • [Node] Source position extension;

      attribute:
          //Numbered starting from '1'
          lineNumber
          //Numbered starting from '1'
          columnNumber

changelog

Changelog

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning.

0.6.0

Fixes

  • Stop serializing empty namespace values like xmlns:ds="" #168
    BREAKING CHANGE: If your code expected empty namespaces attributes to be serialized.
    Thank you @pdecat and @FranckDepoortere
  • Escape < to &lt; when serializing attribute values #198 / #199

0.5.0

Fixes

  • Avoid misinterpretation of malicious XML input - GHSA-h6q6-9hqw-rwfv (CVE-2021-21366)

    • Improve error reporting; throw on duplicate attribute\ BREAKING CHANGE: It is currently not clear how to consistently deal with duplicate attributes, so it's also safer for our users to fail when detecting them. It's possible to configure the DOMParser.errorHandler before parsing, to handle those errors differently.

      To accomplish this and also be able to verify it in tests I needed to

      • create a new Error type ParseError and export it
      • Throw ParseError from errorHandler.fatalError and prevent those from being caught in XMLReader.
      • export DOMHandler constructor as __DOMHandler
    • Preserve quotes in DOCTYPE declaration Since the only purpose of parsing the DOCTYPE is to be able to restore it when serializing, we decided that it would be best to leave the parsed publicId and systemId as is, including any quotes. BREAKING CHANGE: If somebody relies on the actual unquoted values of those ids, they will need to take care of either single or double quotes and the right escaping. (Without this change this would not have been possible because the SAX parser already dropped the information about the quotes that have been used in the source.)

      https://www.w3.org/TR/2006/REC-xml11-20060816/#dtd https://www.w3.org/TR/2006/REC-xml11-20060816/#IDAX1KS (External Entity Declaration)

  • Fix breaking preprocessors' directives when parsing attributes #171

  • fix(dom): Escape ]]&gt; when serializing CharData #181
  • Switch to (only) MIT license (drop problematic LGPL license option) #178
  • Export DOMException; remove custom assertions; etc. #174

Docs

  • Update MDN links in readme.md #188

0.4.0

Commits

Fixes

  • BREAKING Restore &nbsp; behavior from v0.1.27 #67
  • BREAKING Typecheck source param before parsing #113
  • Include documents in package files list #156
  • Preserve doctype with sysid #144
  • Remove ES6 syntax from getElementsByClassName #91
  • Revert "Add lowercase of åäö in entityMap" due to duplicate entries #84
  • fix: Convert all line separators to LF #66

Docs

  • Update CHANGELOG.md through version 0.3.0 #63
  • Update badges #78
  • Add .editorconfig file #104
  • Add note about import #79
  • Modernize & improve the example in readme.md #81

CI

  • Add Stryker Mutator #70
  • Add Stryker action to update dashboard #77
  • Add Node GitHub action workflow #64
  • add & enable eslint #106
  • Use eslint-plugin-es5 to enforce ES5 syntax #107
  • Recover vows tests, drop proof tests #59
  • Add jest tessuite and first tests #114
  • Add jest testsuite with xmltest cases #112
  • Configure Renovate #108
  • Test European HTML entities #86
  • Updated devDependencies

Other

  • Remove files that are not of any use #131, #65, #33

0.3.0

Commits

0.2.1

Commits

  • Correct homepage, repository and bugs URLs in package.json.

0.2.0

Commits

0.1.31

Commits

The patch versions (v0.1.29 - v0.1.31) that have been released on the v0.1.x branch, to reflect the changed maintainers, are branched off from v0.1.27 so they don't include the breaking changes introduced in xmldom-alpha@v0.1.28:

Maintainer changes

After the last commit to the original repository https://github.com/jindw/xmldom on the 9th of May 2017, the first commit to https://github.com/xmldom/xmldom is from the 19th of December 2019. The fork has been announced in the original repository on the 2nd of March 2020.

The versions listed below have been published to one or both of the following packages:

It is currently not planned to continue publishing the xmldom-alpha package.

The new maintainers did not invest time to understand changes that led to the last xmldom version 0.1.27 published by the original maintainer, but consider it the basis for their work. A timeline of all the changes that happened from that version until 0.3.0 is available in https://github.com/xmldom/xmldom/issues/62. Any related questions should be asked there.

0.1.28

Commits

Published by @jindw on the 9th of May 2017 as

0.1.27

Published by @jindw on the 28th of Nov 2016 as

  • xmldom@0.1.27
  • xmldom-alpha@0.1.27

  • Various bug fixes.

0.1.26

Published on the 18th of Nov 2016 as xmldom@0.1.26

  • Details unknown

0.1.25

Published on the 18th of Nov 2016 as

  • xmldom@0.1.25

  • Details unknown

0.1.24

Published on the 27th of November 2016 as

  • xmldom@0.1.24
  • xmldom-alpha@0.1.24

  • Added node filter.

0.1.23

Published on the 5th of May 2016 as

  • xmldom-alpha@0.1.23

  • Add namespace support for nest node serialize.

  • Various other bug fixes.

0.1.22

  • Merge XMLNS serialization.
  • Remove \r from source string.
  • Print namespaces for child elements.
  • Switch references to nodeType to use named constants.
  • Add nodelist toString support.

0.1.21

  • Fix serialize bug.

0.1.20

  • Optimize invalid XML support.
  • Add toString sorter for attributes output.
  • Add html self closed node button.
  • Add * NS support for getElementsByTagNameNS.
  • Convert attribute's value to string in setAttributeNS.
  • Add support for HTML entities for HTML docs only.
  • Fix TypeError when Document is created with DocumentType.

0.1.19

0.1.18

  • Add default ns support.
  • parseFromString now renders entirely plain text documents as textNode.
  • Enable option to ignore white space on parsing.

0.1.17

Details missing for this and potential earlier version

0.1.16

  • Correctly handle multibyte Unicode greater than two byts. #57. #56.
  • Initial unit testing and test coverage. #53. #46. #19.
  • Create Bower component.json #52.

0.1.8

  • Add: some test case from node-o3-xml(excludes xpath support)
  • Fix: remove existed attribute before setting (bug introduced in v0.1.5)
  • Fix: index direct access for childNodes and any NodeList collection(not w3c standard)
  • Fix: remove last child bug