@xmldom/xmldom 0.8.10 → 0.9.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmldom/xmldom",
-  "version": "0.8.10",
+  "version": "0.9.0-beta.10",
   "description": "A pure JavaScript W3C standard-based (XML DOM Level 2 Core) DOMParser and XMLSerializer module.",
   "keywords": [
     "w3c",
@@ -28,33 +28,35 @@
     "lib"
   ],
   "scripts": {
-    "lint": "eslint lib test",
-    "format": "prettier --write 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",
+    "test:types": "cd examples/typescript-node-es6 && ./pretest.sh 3 && ./pretest.sh 4 && ./pretest.sh 5 && node dist/index.js",
     "testrelease": "npm test && eslint lib",
     "version": "./changelog-has-version.sh",
-    "release": "np --no-yarn --test-script testrelease --branch release-0.8.x patch"
+    "release": "np --no-yarn --test-script testrelease"
   },
   "engines": {
     "node": ">=10.0.0"
   },
   "dependencies": {},
   "devDependencies": {
-    "@stryker-mutator/core": "5.6.1",
+    "@homer0/prettier-plugin-jsdoc": "6.0.5",
     "auto-changelog": "2.4.0",
-    "eslint": "8.25.0",
-    "eslint-config-prettier": "8.5.0",
+    "eslint": "8.44.0",
+    "eslint-config-prettier": "8.8.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.7.1",
+    "nodemon": "3.0.1",
+    "np": "7.7.0",
+    "prettier": "2.8.8",
+    "rxjs": "7.8.1",
     "xmltest": "1.5.0",
     "yauzl": "2.10.0"
   },

package/readme.md

@@ -4,12 +4,15 @@
 *For better readability in the docs we will continue to talk about this library as "xmldom".*
 
 [![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)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/@xmldom/xmldom)](https://socket.dev/npm/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)
+
+[![npm:latest](https://img.shields.io/npm/v/@xmldom/xmldom/latest?style=flat-square)](https://www.npmjs.com/package/@xmldom/xmldom)
+[![npm:next](https://img.shields.io/npm/v/@xmldom/xmldom/next?style=flat-square)](https://www.npmjs.com/package/@xmldom/xmldom?activeTab=versions)
+[![npm:lts](https://img.shields.io/npm/v/@xmldom/xmldom/lts?style=flat-square)](https://www.npmjs.com/package/@xmldom/xmldom?activeTab=versions)
+
 [![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)
-
 
 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
@@ -55,7 +58,7 @@ const doc = new DOMParser().parseFromString(source, 'text/xml')
 const serialized = new XMLSerializer().serializeToString(doc)
 ```
 
-Note: in Typescript ~and ES6~(see #316) you can use the `import` approach, as follows:
+Note: in Typescript ~~and ES6~~ (see [#316](https://github.com/xmldom/xmldom/issues/316)) you can use the `import` approach, as follows:
 
 ```typescript
 import { DOMParser } from '@xmldom/xmldom'
@@ -63,33 +66,18 @@ import { DOMParser } from '@xmldom/xmldom'
 
 ## API Reference
 
- * [DOMParser](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser):
+* [DOMParser](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser):
 
-	```javascript
-	parseFromString(xmlsource,mimeType)
-	```
-	* **options extension** _by xmldom_ (not DOM standard!!)
+   ```javascript
+   parseFromString(xmlsource, mimeType)
+   ```
+   * **options extension** _by xmldom_ (not DOM standard!!)
 
-	```javascript
-	//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)}
-	})
-		
-	```
+   ```javascript
+   // the options argument can be used to modify behavior
+   // for more details check the documentation on the code or type definition  
+   new DOMParser(options)
+   ```
 
  * [XMLSerializer](https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer)
  
@@ -160,7 +148,7 @@ import { DOMParser } from '@xmldom/xmldom'
 * [DOMImplementation](http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID-102161490)
 
   method:
-  - `hasFeature(feature, version)`
+  - `hasFeature(feature, version)` (deprecated)
   - `createDocumentType(qualifiedName, publicId, systemId)`
   - `createDocument(namespaceURI, qualifiedName, doctype)`
 
@@ -318,24 +306,26 @@ Note: [The latest version of this spec](https://w3c.github.io/DOM-Parsing/) has
 ### 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.
+In the past there have been multiple (even breaking) changes to align xmldom with the living standard,
+so if you find a difference that is not documented, any contribution to resolve the difference is very welcome (even just reporting it as an issue). 
 
-xmldom implements the following interfaces (most constructors are currently not exposed):
-- `Attr`
+xmldom implements the following interfaces (only the ones marked with `*` are currently exposed):
+- `Attr` *
 - `CDATASection`
 - `CharacterData`
 - `Comment`
-- `Document`
+- `Document` *
 - `DocumentFragment`
-- `DocumentType`
-- `DOMException` (constructor exposed) 
-- `DOMImplementation` (constructor exposed)
-- `Element`
+- `DocumentType` *
+- `DOMException` * 
+- `DOMImplementation` *
+- `Element` *
 - `Entity`
 - `EntityReference`
 - `LiveNodeList`
-- `NamedNodeMap`
-- `Node` (constructor exposed)
-- `NodeList`
+- `NamedNodeMap` *
+- `Node` *
+- `NodeList` *
 - `Notation`
 - `ProcessingInstruction`
 - `Text`
@@ -344,8 +334,7 @@ more details are available in the (incomplete) [API Reference](#api-reference) s
 
 ### 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>.
+xmldom does not have any goal of supporting the full spec, but it has some capability to parse, report and serialize things differently when it is told to parse HTML (by passing the HTML namespace).
 
 ### SAX, XML, XMLNS