puppeteer-browser-ready 1.2.1 → 1.2.3

package/README.md

@@ -10,8 +10,8 @@ _Simple utility to go to a URL and wait for the HTTP response_
 **puppeteer-browser-ready** is a helper utility to reduce the amount of boilerplate code needed
 to tell Puppeteer to visit a web page and and retrieve the HTML. 
 It's primarily intended for use within [Mocha](https://mochajs.org) test cases. 
-In addition to the raw HTML, you get a [cheerio](https://cheerio.js.org) reference so you can
-immediately run queries on the DOM.
+In addition to the raw HTML, you get a [node-html-parsed](https://github.com/taoqf/node-html-parser)
+root so you can immediately run queries on the DOM.
 
 ## A) Setup
 **Install packages:**
@@ -30,15 +30,15 @@ The **Promise** will resolve with a **Web** object containing a `title` field an
 Pass the **Web** object to the `browserReady.close(web)` function to disconnect the page.
 ```javascript
 const url = 'https://pretty-print-json.js.org/';
-let web;  //fields: browser, page, response, status, location, title, html, $
+let web;  //fields: browser, page, response, status, location, title, html, root
 before(async () => web = await puppeteer.launch().then(browserReady.goto(url));
 after(async () =>  await browserReady.close(web));
 ```
 ### `goto()` Options
-| Name (key)   | Type        | Default | Description                                      |
-| :----------- | :---------- | :------ | :----------------------------------------------- |
-| `addCheerio` | **boolean** | `false` | Return a cheerio reference for querying the DOM. |
-| `verbose`    | **boolean** | `false` | Output HTTP connection debug messages.           |
+| Name (key)   | Type        | Default | Description                                               |
+| :----------- | :---------- | :------ | :-------------------------------------------------------- |
+| `parseHtml`  | **boolean** | `true`  | Return the DOM root as an HTMLElement (node-html-parsed). |
+| `verbose`    | **boolean** | `false` | Output HTTP connection debug messages.                    |
 
 ### `startWebServer()` Options
 | Name (key)    | Type        | Default| Description                                      |
@@ -62,7 +62,7 @@ type Web = {
    location: Location,
    title:    string,
    html:     string,
-   $:        cheerio.Root | null,  //library for parsing and manipulating HTML
+   root:     HTMLElement | null,  //see node-html-parsed library
    };
 ```
 
@@ -91,7 +91,7 @@ const handleResponse = (web) => {
    console.log('Hello, World!');
    console.log('web fields:', Object.keys(web).join(', '));
    console.log(`The HTML from ${web.location.href} is ${web.html.length} characters`,
-      `long and contains ${web.$('p').length} <p> tags.`);
+      `long and contains ${web.root.querySelectorAll('p').length} <p> tags.`);
    return web;
    };
 puppeteer.launch()
@@ -102,7 +102,7 @@ puppeteer.launch()
 **Output:**
 ```
 Hello, World!
-web fields: browser, page, response, title, html, $
+web fields: browser, page, response, status, location, title, html, root
 The HTML from https://pretty-print-json.js.org/ is 8200 characters
 long and contains 7 <p> tags.
 ```
@@ -119,7 +119,7 @@ import { browserReady } from 'puppeteer-browser-ready';
 
 // Setup
 const url = 'https://pretty-print-json.js.org/';
-let web;  //fields: browser, page, response, status, location, title, html, $
+let web;  //fields: browser, page, response, status, location, title, html, root
 const loadWebPage = async () =>
    web = await puppeteer.launch().then(browserReady.goto(url));
 const closeWebPage = async () =>
@@ -137,7 +137,7 @@ describe('The web page', () => {
       });
 
    it('has exactly one header, main, and footer', () => {
-      const actual =   web.$('body >*').toArray().map(elem => elem.name);
+      const actual =   getTags('body >*');
       const expected = ['header', 'main', 'footer'];
       assertDeepStrictEqual(actual, expected);
       });
@@ -211,7 +211,7 @@ Example configuration in **package.json** to allow 5,000 ms:
 ```json
    "scripts": {
       "pretest": "run-scripts clean build",
-      "test": "mocha spec/*.spec.js --timeout 5000"
+      "test": "mocha spec/*.spec.js --timeout 7000"
    },
 ```
 
@@ -222,6 +222,7 @@ Example configuration in **package.json** to allow 5,000 ms:
    - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Prepend a one-line banner comment (with license notice) to distribution files_
    - 📄 [copy-file-util](https://github.com/center-key/copy-file-util):&nbsp; _Copy or rename a file with optional package version number_
    - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):&nbsp; _Recursively copy files from one folder to another folder_
+   - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):&nbsp; _Run a command on each file in a folder and its subfolders_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):&nbsp; _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
    - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm scripts into named groups of easy to manage commands_

package/dist/puppeteer-browser-ready.d.ts

@@ -1,7 +1,8 @@
-//! puppeteer-browser-ready v1.2.1 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v1.2.3 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
 
 /// <reference types="cheerio" />
 import { Browser, HTTPResponse, Page } from 'puppeteer';
+import { HTMLElement } from 'node-html-parser';
 import { Server } from 'http';
 import { SuiteFunction } from 'mocha';
 import httpTerminator from 'http-terminator';
@@ -29,9 +30,11 @@ export type Web = {
     title: string | null;
     html: string | null;
     $: cheerio.Root | null;
+    root: HTMLElement | null;
 };
 export type BrowserReadySettings = {
     addCheerio: boolean;
+    parseHtml: boolean;
     verbose: boolean;
 };
 export type BrowserReadyOptions = Partial<BrowserReadySettings>;

package/dist/puppeteer-browser-ready.js

@@ -1,5 +1,6 @@
-//! puppeteer-browser-ready v1.2.1 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v1.2.3 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
 
+import { parse } from 'node-html-parser';
 import cheerio from 'cheerio';
 import express from 'express';
 import httpTerminator from 'http-terminator';
@@ -42,10 +43,13 @@ const browserReady = {
         return http.terminator.terminate();
     },
     goto(url, options) {
-        const defaults = { addCheerio: true, verbose: false };
+        const defaults = { addCheerio: false, parseHtml: true, verbose: false };
         const settings = { ...defaults, ...options };
+        if (settings.addCheerio)
+            console.log('puppeteer-browser-ready: Option "addCheerio" is deprecated, use "parseHtml" instead.');
         const log = (label, msg) => settings.verbose &&
             console.log('   ', Date.now() % 100000, label + ':', msg);
+        const rootInfo = (root) => root.constructor.name + '/' + root.firstChild.toString();
         const web = async (browser) => {
             log('Connected', browser.isConnected());
             try {
@@ -61,9 +65,10 @@ const browserReady = {
                 log('Title', title);
                 const html = response && await response.text();
                 log('Bytes', html?.length);
-                const $ = html && settings.addCheerio ? cheerio.load(html) : null;
-                log('$', $ && $['fn'].constructor.name);
-                return { browser, page, response, status, location, title, html, $ };
+                const $ = html && settings.addCheerio ? cheerio.load(html) : null; //deprecated
+                const root = html && settings.parseHtml ? parse(html) : null;
+                log('DOM root', root ? rootInfo(root) : null);
+                return { browser, page, response, status, location, title, html, $, root };
             }
             catch (error) {
                 const status = browser.isConnected() ? 'connected' : 'not connected';

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "puppeteer-browser-ready",
-   "version": "1.2.1",
+   "version": "1.2.3",
    "description": "Simple utility to go to a URL and wait for the HTTP response",
    "license": "MIT",
    "type": "module",
@@ -67,17 +67,19 @@
       "clean": [
          "rimraf build dist"
       ],
-      "build": [
+      "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts",
+         "eslint --max-warnings 0 . --ext .ts"
+      ],
+      "build": [
          "tsc",
          "add-dist-header build dist",
          "html-validator"
       ]
    },
    "scripts": {
-      "pretest": "run-scripts clean build",
-      "test": "mocha spec/*.spec.js --timeout 5000 --retries 1"
+      "pretest": "run-scripts clean lint build",
+      "test": "mocha spec/*.spec.js --timeout 7000 --retries 1"
    },
    "peerDependencies": {
       "puppeteer": "^15 || ^16 || ^17 || ^18 || ^19.7 || ^20 || ^21"
@@ -85,28 +87,29 @@
    "dependencies": {
       "cheerio": "~1.0.0-rc.12",
       "express": "~4.18",
-      "http-terminator": "~3.2"
+      "http-terminator": "~3.2",
+      "node-html-parser": "~6.1"
    },
    "devDependencies": {
       "@types/cheerio": "~0.22",
       "@types/express": "~4.17",
       "@types/mocha": "~10.0",
-      "@types/node": "~20.4",
+      "@types/node": "~20.6",
       "@types/ws": "~8.5",
-      "@typescript-eslint/eslint-plugin": "~6.2",
-      "@typescript-eslint/parser": "~6.2",
-      "add-dist-header": "~1.1",
+      "@typescript-eslint/eslint-plugin": "~6.7",
+      "@typescript-eslint/parser": "~6.7",
+      "add-dist-header": "~1.3",
       "assert-deep-strict-equal": "~1.1",
       "copy-file-util": "~1.1",
       "copy-folder-util": "~1.1",
-      "eslint": "~8.46",
+      "eslint": "~8.49",
       "jshint": "~2.13",
       "mocha": "~10.2",
       "open": "~9.1",
-      "puppeteer": "~21.0",
+      "puppeteer": "~21.2",
       "rimraf": "~5.0",
       "run-scripts-util": "~1.2",
-      "typescript": "~5.1",
+      "typescript": "~5.2",
       "w3c-html-validator": "~1.4"
    }
 }