node-html-parser 6.1.10 → 6.1.12

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [6.1.12](https://github.com/taoqf/node-fast-html-parser/compare/v6.1.11...v6.1.12) (2023-12-25)
+
+
+### Bug Fixes
+
+* [#258](https://github.com/taoqf/node-fast-html-parser/issues/258) ([5a6a614](https://github.com/taoqf/node-fast-html-parser/commit/5a6a61489a62264221dde5e8f76a5d35b18d17bd))
+* nullable return types of HTMLElement ([fe83c3e](https://github.com/taoqf/node-fast-html-parser/commit/fe83c3ee405b2fd973a9d46e4b2ff40f68a5471f))
+
+### [6.1.11](https://github.com/taoqf/node-fast-html-parser/compare/v6.1.10...v6.1.11) (2023-10-25)
+
+
+### Bug Fixes
+
+* [#254](https://github.com/taoqf/node-fast-html-parser/issues/254) ([8e4e9e0](https://github.com/taoqf/node-fast-html-parser/commit/8e4e9e0a13796ed9a39ebb930b0ee5e55b578b82))
+* Fixed typo in JSDoc for HTMLElement `structure` method ([3a52ee9](https://github.com/taoqf/node-fast-html-parser/commit/3a52ee97463d8ab1f35ef7c0f08d3696bc38e5c4))
+
 ### [6.1.10](https://github.com/taoqf/node-fast-html-parser/compare/v6.1.9...v6.1.10) (2023-09-15)
 
 

package/README.md

@@ -202,7 +202,7 @@ Note: Full range of CSS3 selectors supported since v3.0.0.
 
 ### querySelector(selector)
 
-Query CSS Selector to find matching node.
+Query CSS Selector to find matching node. `null` if not found.
 
 ### getElementsByTagName(tagName)
 
@@ -212,7 +212,7 @@ Note: Use * for all elements.
 
 ### closest(selector)
 
-Query closest element by css selector.
+Query closest element by css selector. `null` if not found.
 
 ### appendChild(node)
 
@@ -236,7 +236,7 @@ Remove `key` attribute.
 
 ### getAttribute(key: string)
 
-Get `key` attribute.
+Get `key` attribute. `undefined` if not set.
 
 ### exchangeChild(oldNode: Node, newNode: Node)
 
@@ -292,7 +292,7 @@ Get class names.
 
 Clone a node.
 
-#### getElementById(id: string): HTMLElement
+#### getElementById(id: string): HTMLElement | null
 
 Get element by it's ID.
 
@@ -322,11 +322,11 @@ Get DOM structure.
 
 ### firstChild
 
-Get first child node.
+Get first child node. `undefined` if no child.
 
 ### lastChild
 
-Get last child node.
+Get last child node. `undefined` if no child
 
 ### innerHTML
 
@@ -338,19 +338,19 @@ Get outerHTML.
 
 ### nextSibling
 
-Returns a reference to the next child node of the current element's parent.
+Returns a reference to the next child node of the current element's parent. `null` if not found.
 
 ### nextElementSibling
 
-Returns a reference to the next child element of the current element's parent.
+Returns a reference to the next child element of the current element's parent. `null` if not found.
 
 ### previousSibling
 
-Returns a reference to the previous child node of the current element's parent.
+Returns a reference to the previous child node of the current element's parent. `null` if not found.
 
 ### previousElementSibling
 
-Returns a reference to the previous child element of the current element's parent.
+Returns a reference to the previous child element of the current element's parent. `null` if not found.
 
 ### textContent
 

package/dist/main.js

@@ -592,7 +592,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
              */
             get: function () {
                 // https://github.com/taoqf/node-html-parser/issues/249
-                if (/br/i.test(this.rawTagName)) {
+                if (/^br$/i.test(this.rawTagName)) {
                     return '\n';
                 }
                 return this.childNodes.reduce(function (pre, cur) {
@@ -772,7 +772,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         Object.defineProperty(HTMLElement.prototype, "structure", {
             /**
              * Get DOM structure
-             * @return {string} strucutre
+             * @return {string} structure
              */
             get: function () {
                 var res = [];
@@ -888,6 +888,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         /**
          * find element by it's id
          * @param {string} id the id of the element to select
+         * @returns {HTMLElement | null} the element with the given id or null if not found
          */
         HTMLElement.prototype.getElementById = function (id) {
             var stack = [];
@@ -925,6 +926,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         /**
          * traverses the Element and its parents (heading toward the document root) until it finds a node that matches the provided selector string. Will return itself or the matching ancestor. If no such element exists, it returns null.
          * @param selector a DOMString containing a selector list
+         * @returns {HTMLElement | null} the element with the given id or null if not found
          */
         HTMLElement.prototype.closest = function (selector) {
             var mapChild = new Map();
@@ -986,7 +988,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         Object.defineProperty(HTMLElement.prototype, "firstChild", {
             /**
              * Get first child node
-             * @return {Node} first child node
+             * @return {Node | undefined} first child node; or undefined if none
              */
             get: function () {
                 return this.childNodes[0];
@@ -997,7 +999,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         Object.defineProperty(HTMLElement.prototype, "lastChild", {
             /**
              * Get last child node
-             * @return {Node} last child node
+             * @return {Node | undefined} last child node; or undefined if none
              */
             get: function () {
                 return (0, back_1.default)(this.childNodes);
@@ -1078,9 +1080,8 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
             this.rawAttrs = Object.keys(attrs)
                 .map(function (name) {
                 var val = _this.quoteAttribute(attrs[name]);
-                if (val === undefined || val === 'null') {
+                if (val === 'null' || val === '""')
                     return name;
-                }
                 return "".concat(name, "=").concat(val);
             })
                 .join(' ');
@@ -1095,7 +1096,7 @@ define("nodes/html", ["require", "exports", "css-select", "he", "back", "matcher
         };
         /**
          * Get an attribute
-         * @return {string} value of the attribute
+         * @return {string | undefined} value of the attribute; or undefined if not exist
          */
         HTMLElement.prototype.getAttribute = function (key) {
             return this.attrs[key.toLowerCase()];

package/dist/nodes/html.d.ts

@@ -109,7 +109,7 @@ export default class HTMLElement extends Node {
     trimRight(pattern: RegExp): this;
     /**
      * Get DOM structure
-     * @return {string} strucutre
+     * @return {string} structure
      */
     get structure(): string;
     /**
@@ -137,13 +137,15 @@ export default class HTMLElement extends Node {
     /**
      * find element by it's id
      * @param {string} id the id of the element to select
+     * @returns {HTMLElement | null} the element with the given id or null if not found
      */
-    getElementById(id: string): HTMLElement;
+    getElementById(id: string): HTMLElement | null;
     /**
      * traverses the Element and its parents (heading toward the document root) until it finds a node that matches the provided selector string. Will return itself or the matching ancestor. If no such element exists, it returns null.
      * @param selector a DOMString containing a selector list
+     * @returns {HTMLElement | null} the element with the given id or null if not found
      */
-    closest(selector: string): HTMLElement;
+    closest(selector: string): HTMLElement | null;
     /**
      * Append a child node to childNodes
      * @param  {Node} node node to append
@@ -152,14 +154,14 @@ export default class HTMLElement extends Node {
     appendChild<T extends Node = Node>(node: T): T;
     /**
      * Get first child node
-     * @return {Node} first child node
+     * @return {Node | undefined} first child node; or undefined if none
      */
-    get firstChild(): Node;
+    get firstChild(): Node | undefined;
     /**
      * Get last child node
-     * @return {Node} last child node
+     * @return {Node | undefined} last child node; or undefined if none
      */
-    get lastChild(): Node;
+    get lastChild(): Node | undefined;
     /**
      * Get attributes
      * @access private
@@ -176,7 +178,7 @@ export default class HTMLElement extends Node {
     hasAttribute(key: string): boolean;
     /**
      * Get an attribute
-     * @return {string} value of the attribute
+     * @return {string | undefined} value of the attribute; or undefined if not exist
      */
     getAttribute(key: string): string | undefined;
     /**
@@ -191,10 +193,10 @@ export default class HTMLElement extends Node {
      */
     setAttributes(attributes: Attributes): this;
     insertAdjacentHTML(where: InsertPosition, html: string): this;
-    get nextSibling(): Node;
-    get nextElementSibling(): HTMLElement;
-    get previousSibling(): Node;
-    get previousElementSibling(): HTMLElement;
+    get nextSibling(): Node | null;
+    get nextElementSibling(): HTMLElement | null;
+    get previousSibling(): Node | null;
+    get previousElementSibling(): HTMLElement | null;
     get classNames(): string;
     /**
      * Clone this Node

package/dist/nodes/html.js

@@ -258,7 +258,7 @@ var HTMLElement = /** @class */ (function (_super) {
          */
         get: function () {
             // https://github.com/taoqf/node-html-parser/issues/249
-            if (/br/i.test(this.rawTagName)) {
+            if (/^br$/i.test(this.rawTagName)) {
                 return '\n';
             }
             return this.childNodes.reduce(function (pre, cur) {
@@ -438,7 +438,7 @@ var HTMLElement = /** @class */ (function (_super) {
     Object.defineProperty(HTMLElement.prototype, "structure", {
         /**
          * Get DOM structure
-         * @return {string} strucutre
+         * @return {string} structure
          */
         get: function () {
             var res = [];
@@ -554,6 +554,7 @@ var HTMLElement = /** @class */ (function (_super) {
     /**
      * find element by it's id
      * @param {string} id the id of the element to select
+     * @returns {HTMLElement | null} the element with the given id or null if not found
      */
     HTMLElement.prototype.getElementById = function (id) {
         var stack = [];
@@ -591,6 +592,7 @@ var HTMLElement = /** @class */ (function (_super) {
     /**
      * traverses the Element and its parents (heading toward the document root) until it finds a node that matches the provided selector string. Will return itself or the matching ancestor. If no such element exists, it returns null.
      * @param selector a DOMString containing a selector list
+     * @returns {HTMLElement | null} the element with the given id or null if not found
      */
     HTMLElement.prototype.closest = function (selector) {
         var mapChild = new Map();
@@ -652,7 +654,7 @@ var HTMLElement = /** @class */ (function (_super) {
     Object.defineProperty(HTMLElement.prototype, "firstChild", {
         /**
          * Get first child node
-         * @return {Node} first child node
+         * @return {Node | undefined} first child node; or undefined if none
          */
         get: function () {
             return this.childNodes[0];
@@ -663,7 +665,7 @@ var HTMLElement = /** @class */ (function (_super) {
     Object.defineProperty(HTMLElement.prototype, "lastChild", {
         /**
          * Get last child node
-         * @return {Node} last child node
+         * @return {Node | undefined} last child node; or undefined if none
          */
         get: function () {
             return (0, back_1.default)(this.childNodes);
@@ -744,9 +746,8 @@ var HTMLElement = /** @class */ (function (_super) {
         this.rawAttrs = Object.keys(attrs)
             .map(function (name) {
             var val = _this.quoteAttribute(attrs[name]);
-            if (val === undefined || val === 'null') {
+            if (val === 'null' || val === '""')
                 return name;
-            }
             return "".concat(name, "=").concat(val);
         })
             .join(' ');
@@ -761,7 +762,7 @@ var HTMLElement = /** @class */ (function (_super) {
     };
     /**
      * Get an attribute
-     * @return {string} value of the attribute
+     * @return {string | undefined} value of the attribute; or undefined if not exist
      */
     HTMLElement.prototype.getAttribute = function (key) {
         return this.attrs[key.toLowerCase()];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-html-parser",
-	"version": "6.1.10",
+	"version": "6.1.12",
 	"description": "A very fast HTML parser, generating a simplified DOM, with basic element query support.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -22,9 +22,9 @@
 		"reset": "yarn run clean:global && yarn install && yarn build",
 		"--------------- ": "",
 		"test:target": "mocha --recursive \"./test/tests\"",
-		"test:ci": "cross-env TEST_TARGET=dist yarn run test:target",
+		"test:ci": "cd test && yarn install && cd .. && cross-env TEST_TARGET=dist yarn run test:target",
 		"posttest": "yarn run benchmark",
-		"prepare": "cd test && yarn install",
+		"prepare": "npm run build",
 		"release": "standard-version && git push --follow-tags origin main"
 	},
 	"keywords": [