xmldom-sre - npm Package Compare versions

Comparing version 0.1.31 to 0.9.0-beta.6

package.json

 {
   "name": "xmldom-sre",
-  "version": "0.1.31",
-  "description": "A W3C Standard XML DOM(Level2 CORE) implementation and parser(DOMParser/XMLSerializer).",
+  "version": "0.9.0-beta.6",
+  "description": "A pure JavaScript W3C standard-based (XML DOM Level 2 Core) DOMParser and XMLSerializer module.",
   "keywords": [
@@ -12,55 +12,63 @@ "w3c",
     "DOMParser",
-    "XMLSerializer"
+    "XMLSerializer",
+    "ponyfill"
   ],
-  "homepage": "https://github.com/zorkow/xmldom",
-  "author": "jindw <[e-mail]> (http://www.xidea.org)",
+  "homepage": "https://github.com/speech-rule-engine/xmldom",
   "repository": {
     "type": "git",
-    "url": "git://github.com/zorkow/xmldom.git"
+    "url": "git://github.com/speech-rule-engine/xmldom.git"
   },
-  "main": "./dom-parser.js",
+  "main": "lib/index.js",
+  "types": "index.d.ts",
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "readme.md",
+    "SECURITY.md",
+    "index.d.ts",
+    "lib"
+  ],
   "scripts": {
-    "test": "proof platform win32 && proof test */*/*.t.js || t/test"
+    "lint": "eslint examples lib test",
+    "format": "prettier --write examples lib test",
+    "changelog": "auto-changelog --unreleased-only",
+    "start": "nodemon --watch package.json --watch lib --watch test --exec 'npm --silent run test && npm --silent run lint'",
+    "stryker": "stryker run",
+    "stryker:dry-run": "stryker run -m '' --reporters progress",
+    "test": "jest",
+    "testrelease": "npm test && eslint lib",
+    "version": "./changelog-has-version.sh",
+    "release": "np --no-yarn --test-script testrelease"
   },
   "engines": {
-    "node": ">=0.1"
+    "node": ">=10.0.0"
   },
   "dependencies": {},
   "devDependencies": {
-    "proof": "0.0.28"
+    "@stryker-mutator/core": "5.6.1",
+    "auto-changelog": "2.4.0",
+    "eslint": "8.34.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-anti-trojan-source": "1.1.1",
+    "eslint-plugin-es5": "1.5.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "get-stream": "6.0.1",
+    "jest": "27.5.1",
+    "nodemon": "2.0.20",
+    "np": "7.6.2",
+    "prettier": "2.8.4",
+    "xmltest": "1.5.0",
+    "yauzl": "2.10.0"
   },
-  "maintainers": [
-    {
-      "name": "zorkow",
-      "email": "[e-mail]",
-      "url": "http://www.cs.bham.ac.uk/~vxs"
-    }
-  ],
-  "contributors": [
-    {
-      "name": "jindw",
-      "email": "[e-mail]",
-      "url": "http://www.xidea.org"
-    },
-    {
-      "name": "Yaron Naveh",
-      "email": "[e-mail]",
-      "web": "http://webservices20.blogspot.com/"
-    },
-    {
-      "name": "Harutyun Amirjanyan",
-      "email": "[e-mail]",
-      "web": "https://github.com/nightwing"
-    },
-    {
-      "name": "Alan Gutierrez",
-      "email": "[e-mail]",
-      "web": "http://www.prettyrobots.com/"
-    }
-  ],
   "bugs": {
-    "email": "[e-mail]",
-    "url": "https://github.com/jindw/xmldom/issues"
+    "url": "https://github.com/speech-rule-engine/xmldom/issues"
   },
-  "license": "(LGPL-2.0 or MIT)"
+  "license": "MIT",
+  "auto-changelog": {
+    "prepend": true,
+    "remote": "upstream",
+    "tagPrefix": "",
+    "template": "./auto-changelog.hbs"
+  }
 }

readme.md

@@ -1,49 +0,81 @@
-# XMLDOM [![Build Status](https://secure.travis-ci.org/bigeasy/xmldom.png?branch=master)](http://travis-ci.org/bigeasy/xmldom) [![Coverage Status](https://coveralls.io/repos/bigeasy/xmldom/badge.png?branch=master)](https://coveralls.io/r/bigeasy/xmldom) [![NPM version](https://badge.fury.io/js/xmldom.png)](http://badge.fury.io/js/xmldom)
+# @xmldom/xmldom
 
-**This is a fork of [jindw](https://github.com/jindw)'s
-[xmldom](https://github.com/jindw/xmldom) library together with
-[Rui Azevedo](https://github.com/neu-rah) code for compareDocumentPosition. It
-allows the use of
-[wicked-good-xpath](https://github.com/google/wicked-good-xpath) together with
-xmldom, using a little hack. For an example see
-[speech-rule-engine](https://github.com/zorkow/speech-rule-engine/blob/master/src/common/system_external.js).**
+**This is a fork of the [@xmldom/xmldom](https://github.com/xmldom/xmldom) that
+adds `compareDocumentPosition` originally suggested by [Rui
+Azevedo](https://github.com/neu-rah) for the old `xmldom` library. It allows the
+use of [wicked-good-xpath](https://github.com/google/wicked-good-xpath) together
+with xmldom. For an example see
+[speech-rule-engine](https://github.com/zorkow/speech-rule-engine/blob/master/src/common/system_external.js). While
+this is not my code, I will try to keep it in sync with developments in the
+`@xmldom/xmldom` library.**
 
-_Just to be clear: This is not my code! You are welcome to use the package, but
-I can not fix any bugs!_
+***Since version 0.7.0 this package is published to npm as [`@xmldom/xmldom`](https://www.npmjs.com/package/@xmldom/xmldom) and no longer as [`xmldom`](https://www.npmjs.com/package/xmldom), because [we are no longer able to publish `xmldom`](https://github.com/xmldom/xmldom/issues/271).***  
+*For better readability in the docs we will continue to talk about this library as "xmldom".*
 
-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.
+[![license(MIT)](https://img.shields.io/npm/l/@xmldom/xmldom?color=blue&style=flat-square)](https://github.com/xmldom/xmldom/blob/master/LICENSE)
+[![npm](https://img.shields.io/npm/v/@xmldom/xmldom?style=flat-square)](https://www.npmjs.com/package/@xmldom/xmldom)
+[![snyk.io package health](https://snyk.io/advisor/npm-package/@xmldom/xmldom/badge.svg)](https://snyk.io/advisor/npm-package/@xmldom/xmldom)
+[![bug issues](https://img.shields.io/github/issues/xmldom/xmldom/bug?color=red&style=flat-square)](https://github.com/xmldom/xmldom/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
+[![help-wanted issues](https://img.shields.io/github/issues/xmldom/xmldom/help-wanted?color=darkgreen&style=flat-square)](https://github.com/xmldom/xmldom/issues?q=is%3Aissue+is%3Aopen+label%3Ahelp-wanted)
+[![Mutation report](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fxmldom%2Fxmldom%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/xmldom/xmldom/master)
 
 
-Install:
--------
->npm install xmldom-sre
+xmldom is a javascript [ponyfill](https://ponyfill.com/) to provide the following APIs [that are present in modern browsers](https://caniuse.com/xml-serializer) to other runtimes:
+- convert an XML string into a DOM tree
+  ```
+  new DOMParser().parseFromString(xml, mimeType) => Document
+  ```
+- create, access and modify a DOM tree
+  ```
+  new DOMImplementation().createDocument(...) => Document
+  ```
+- serialize a DOM tree back into an XML string
+  ```
+  new XMLSerializer().serializeToString(node) => string
+  ```
 
-Example:
-====
+The target runtimes `xmldom` supports are currently Node >= v10 (ES5) and Rhino ([not tested as part of CI](https://github.com/xmldom/xmldom/discussions/214)).
+
+When deciding how to fix bugs or implement features, `xmldom` tries to stay as close  as possible to the various [related specifications/standards](#specs).  
+As indicated by the version starting with `0.`, this implementation is not feature complete and some implemented features differ from what the specifications describe.  
+**Issues and PRs for such differences are always welcome, even when they only provide a failing test case.**
+
+This project was forked from it's [original source](https://github.com/jindw/xmldom) in 2019, more details about that transition can be found in the [CHANGELOG](CHANGELOG.md#maintainer-changes).
+
+## Usage
+
+### Install:
+
+> npm install @xmldom/xmldom
+
+### Example:
+
+[In NodeJS](examples/nodejs/src/index.js)
 ```javascript
-var DOMParser = require('xmldom').DOMParser;
-var 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');
-var nsAttr = doc.documentElement.getAttributeNS('./lite','x')
-console.info(nsAttr)
-console.info(doc)
+const { DOMParser, XMLSerializer } = require('@xmldom/xmldom')
+
+const source = `<xml xmlns="a">
+	<child>test</child>
+	<child/>
+</xml>`
+
+const doc = new DOMParser().parseFromString(source, 'text/xml')
+
+const serialized = new XMLSerializer().serializeToString(doc)
 ```
-API Reference
-=====
 
- * [DOMParser](https://developer.mozilla.org/en/DOMParser):
+Note: in Typescript ~and ES6~(see #316) you can use the `import` approach, as follows:
 
+```typescript
+import { DOMParser } from '@xmldom/xmldom'
+```
+
+## API Reference
+
+ * [DOMParser](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser):
+
 	```javascript
 	parseFromString(xmlsource,mimeType)
 	```
-	* **options extension** _by xmldom_(not BOM standard!!)
+	* **options extension** _by xmldom_ (not DOM standard!!)
 
@@ -71,3 +103,3 @@ ```javascript
 
- * [XMLSerializer](https://developer.mozilla.org/en/XMLSerializer)
+ * [XMLSerializer](https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer)
  
@@ -77,157 +109,259 @@ ```javascript
 	```
-DOM level2 method and attribute:
-------
+### DOM level2 method and attribute:
 
- * [Node](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247)
-	
-		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()
+* [Node](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1950641247)
 
- * [DOMImplementation](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-102161490)
-		
-		method:
-			hasFeature(feature, version)
-			createDocumentType(qualifiedName, publicId, systemId)
-			createDocument(namespaceURI, qualifiedName, doctype)
+  readonly class properties (aka `NodeType`),  
+  these can be accessed from any `Node` instance `node`:  
+  `if (node.nodeType === node.ELEMENT_NODE) {...`
+  
+    1. `ELEMENT_NODE` (`1`)
+    2. `ATTRIBUTE_NODE` (`2`)
+    3. `TEXT_NODE` (`3`)
+    4. `CDATA_SECTION_NODE` (`4`)
+    5. `ENTITY_REFERENCE_NODE` (`5`)
+    6. `ENTITY_NODE` (`6`)
+    7. `PROCESSING_INSTRUCTION_NODE` (`7`)
+    8. `COMMENT_NODE` (`8`)
+    9. `DOCUMENT_NODE` (`9`)
+    10. `DOCUMENT_TYPE_NODE` (`10`)
+    11. `DOCUMENT_FRAGMENT_NODE` (`11`)
+    12. `NOTATION_NODE` (`12`)
+  
+  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](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/ecma-script-binding.html)
 
- * [Document](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#i-Document) : Node
+  extends the Error type thrown as part of DOM API.
+
+  readonly class properties:
+  - `INDEX_SIZE_ERR` (`1`)
+  - `DOMSTRING_SIZE_ERR` (`2`)
+  - `HIERARCHY_REQUEST_ERR` (`3`)
+  - `WRONG_DOCUMENT_ERR` (`4`)
+  - `INVALID_CHARACTER_ERR` (`5`)
+  - `NO_DATA_ALLOWED_ERR` (`6`)
+  - `NO_MODIFICATION_ALLOWED_ERR` (`7`)
+  - `NOT_FOUND_ERR` (`8`)
+  - `NOT_SUPPORTED_ERR` (`9`)
+  - `INUSE_ATTRIBUTE_ERR` (`10`)
+  - `INVALID_STATE_ERR` (`11`)
+  - `SYNTAX_ERR` (`12`)
+  - `INVALID_MODIFICATION_ERR` (`13`)
+  - `NAMESPACE_ERR` (`14`)
+  - `INVALID_ACCESS_ERR` (`15`)
+   
+  attributes:
+  -  `code` with a value matching one of the above constants.
+
+* [DOMImplementation](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-102161490)
+
+  method:
+  - `hasFeature(feature, version)`
+  - `createDocumentType(qualifiedName, publicId, systemId)`
+  - `createDocument(namespaceURI, qualifiedName, doctype)`
+
+* [Document](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#i-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)
+  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](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-B63ED1A3) : Node
- * [Element](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-745549614) : Node
+* [DocumentFragment](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-B63ED1A3) : Node
+* [Element](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-745549614) : 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)
+  readonly attribute:
+  - `tagName`
 
- * [Attr](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-637646024) : Node
-	
-		attribute:
-			value
-		readonly attribute:
-			name|specified|ownerElement
+  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)`
 
- * [NodeList](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-536297177)
+* [Attr](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-637646024) : Node
+
+  attribute:
+  - `value`
+
+  readonly attribute:
+  - `name` | `specified` | `ownerElement`
+
+* [NodeList](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-536297177)
 		
-		readonly attribute:
-			length
-		method:
-			item(index)
+  readonly attribute:
+  - `length`
+  
+  method:
+  - `item(index)`
 	
- * [NamedNodeMap](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1780488922)
+* [NamedNodeMap](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1780488922)
 
-		readonly attribute:
-			length
-		method:
-			getNamedItem(name)
-			setNamedItem(arg)
-			removeNamedItem(name)
-			item(index)
-			getNamedItemNS(namespaceURI, localName)
-			setNamedItemNS(arg)
-			removeNamedItemNS(namespaceURI, localName)
+  readonly attribute:
+  - `length`
+  
+  method:
+  - `getNamedItem(name)`
+  - `setNamedItem(arg)`
+  - `removeNamedItem(name)`
+  - `item(index)`
+  - `getNamedItemNS(namespaceURI, localName)`
+  - `setNamedItemNS(arg)`
+  - `removeNamedItemNS(namespaceURI, localName)`
 		
- * [CharacterData](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-FF21A306) : Node
+* [CharacterData](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-FF21A306) : Node
 	
-		method:
-			substringData(offset, count)
-			appendData(arg)
-			insertData(offset, arg)
-			deleteData(offset, count)
-			replaceData(offset, count, arg)
+  method:
+  - `substringData(offset, count)`
+  - `appendData(arg)`
+  - `insertData(offset, arg)`
+  - `deleteData(offset, count)`
+  - `replaceData(offset, count, arg)`
 		
- * [Text](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1312295772) : CharacterData
-	
-		method:
-			splitText(offset)
+* [Text](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1312295772) : CharacterData
+	 
+  method:
+  - `splitText(offset)`
 			
- * [CDATASection](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-667469212)
- * [Comment](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1728279322) : CharacterData
+* [CDATASection](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-667469212)
+* [Comment](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-1728279322) : CharacterData
 	
- * [DocumentType](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-412266927)
+* [DocumentType](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-412266927)
 	
-		readonly attribute:
-			name|entities|notations|publicId|systemId|internalSubset
+  readonly attribute:
+  - `name` | `entities` | `notations` | `publicId` | `systemId` | `internalSubset`
 			
- * Notation : Node
+* Notation : Node
 	
-		readonly attribute:
-			publicId|systemId
+  readonly attribute:
+  - `publicId` | `systemId`
 			
- * Entity : Node
+* Entity : Node
 	
-		readonly attribute:
-			publicId|systemId|notationName
+  readonly attribute:
+  - `publicId` | `systemId` | `notationName`
 			
- * EntityReference : Node 
- * ProcessingInstruction : Node 
-	
-		attribute:
-			data
-		readonly attribute:
-			target
+* EntityReference : Node 
+* ProcessingInstruction : Node 
+
+  attribute:
+  - `data`
+  readonly attribute:
+  - `target`
 		
-DOM level 3 support:
------
+### DOM level 3 support:
 
- * [Node](http://www.w3.org/TR/DOM-Level-3-Core/core.html#Node3-textContent)
+* [Node](http://www.w3.org/TR/DOM-Level-3-Core/core.html#Node3-textContent)
 		
-		attribute:
-			textContent
-		method:
-			isDefaultNamespace(namespaceURI){
-			lookupNamespaceURI(prefix)
+  attribute:
+  - `textContent`
+  
+  method:
+  - `isDefaultNamespace(namespaceURI)`
+  - `lookupNamespaceURI(prefix)`
 
-DOM extension by xmldom
----
- * [Node] Source position extension; 
+### DOM extension by xmldom
+
+* [Node] Source position extension; 
 		
-		attribute:
-			//Numbered starting from '1'
-			lineNumber
-			//Numbered starting from '1'
-			columnNumber
+  attribute:
+  - `lineNumber` //number starting from `1`
+  - `columnNumber` //number starting from `1`
+
+## Specs
+
+The implementation is based on several specifications:
+
+<!-- Should open in new tab and the links in the SVG should be clickable there! -->
+<a href="https://raw.githubusercontent.com/xmldom/xmldom/master/docs/specs.svg" target="_blank" rel="noopener noreferrer nofollow" >![Overview of related specifications and their relations](docs/specs.svg)</a>
+
+### DOM Parsing and Serialization
+
+From the [W3C DOM Parsing and Serialization (WD 2016)](https://www.w3.org/TR/2016/WD-DOM-Parsing-20160517/) `xmldom` provides an implementation for the interfaces:
+- `DOMParser`
+- `XMLSerializer`
+
+Note that there are some known deviations between this implementation and the W3 specifications.
+
+Note: [The latest version of this spec](https://w3c.github.io/DOM-Parsing/) has the status "Editors Draft", since it is under active development. One major change is that [the definition of the `DOMParser` interface has been moved to the HTML spec](https://w3c.github.io/DOM-Parsing/#the-domparser-interface)
+
+
+### DOM
+
+The original author claims that xmldom implements [DOM Level 2] in a "fully compatible" way and some parts of [DOM Level 3], but there are not enough tests to prove this. Both Specifications are now superseded by the [DOM Level 4 aka Living standard] wich has a much broader scope than xmldom.
+
+xmldom implements the following interfaces (most constructors are currently not exposed):
+- `Attr`
+- `CDATASection`
+- `CharacterData`
+- `Comment`
+- `Document`
+- `DocumentFragment`
+- `DocumentType`
+- `DOMException` (constructor exposed) 
+- `DOMImplementation` (constructor exposed)
+- `Element`
+- `Entity`
+- `EntityReference`
+- `LiveNodeList`
+- `NamedNodeMap`
+- `Node` (constructor exposed)
+- `NodeList`
+- `Notation`
+- `ProcessingInstruction`
+- `Text`
+
+more details are available in the (incomplete) [API Reference](#api-reference) section.
+
+### HTML
+
+xmldom does not have any goal of supporting the full spec, but it has some capability to parse, report and serialize things differently when "detecting HTML" (by checking the default namespace).
+There is an upcoming change to better align the implementation with the latest specs, related to <https://github.com/xmldom/xmldom/issues/203>.
+
+### SAX, XML, XMLNS
+
+xmldom has an own SAX parser implementation to do the actual parsing, which implements some interfaces in alignment with the Java interfaces SAX defines:
+- `XMLReader`
+- `DOMHandler`
+
+There is an idea/proposal to make it possible to replace it with something else in <https://github.com/xmldom/xmldom/issues/55>

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

Fixed alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

220238

increased by77.15%

Number of package files

13

increased by18.18%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by25%

Lines of code

5690

increased by31.99%

Number of lines in readme file

366

increased by57.76%

Worsened metrics

Dev dependency count

15

increased by1400%

Number of low maintenance alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes