puppeteer-browser-ready 1.0.1 → 1.2.0

package/README.md

@@ -8,8 +8,8 @@ _Simple utility to go to a URL and wait for the HTTP response_
 [![Vulnerabilities](https://snyk.io/test/github/center-key/puppeteer-browser-ready/badge.svg)](https://snyk.io/test/github/center-key/puppeteer-browser-ready)
 [![Build](https://github.com/center-key/puppeteer-browser-ready/workflows/build/badge.svg)](https://github.com/center-key/puppeteer-browser-ready/actions/workflows/run-spec-on-push.yaml)
 
-**puppeteer-browser-ready** is a convenient helper utility to reduce the amount of boilerplate
-code needed to tell Puppeteer to visit a web page and and retrieve the HTML. 
+**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.
@@ -63,7 +63,7 @@ type Web = {
    location: Location,
    title:    string,
    html:     string,
-   $:        cheerio.Root | null,  //like jQuery
+   $:        cheerio.Root | null,  //library for parsing and manipulating HTML
    };
 ```
 
@@ -138,12 +138,8 @@ describe('The web page', () => {
       });
 
    it('has exactly one header, main, and footer', () => {
-      const actual = {
-         header: web.$('body >header').length,
-         main:   web.$('body >main').length,
-         footer: web.$('body >footer').length,
-         };
-      const expected = { header: 1, main: 1, footer: 1 };
+      const actual =   web.$('body >*').toArray().map(elem => elem.name);
+      const expected = ['header', 'main', 'footer'];
       assertDeepStrictEqual(actual, expected);
       });
 
@@ -215,7 +211,7 @@ option to bump up the allowed test execution time.
 Example configuration in **package.json** to allow 5,000 ms:
 ```json
    "scripts": {
-      "pretest": "run-scripts build",
+      "pretest": "run-scripts clean build",
       "test": "mocha spec/*.spec.js --timeout 5000"
    },
 ```

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

@@ -1,4 +1,4 @@
-//! puppeteer-browser-ready v1.0.1 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v1.2.0 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
 
 /// <reference types="cheerio" />
 import { Browser, HTTPResponse, Page } from 'puppeteer';

package/dist/puppeteer-browser-ready.js

@@ -1,4 +1,4 @@
-//! puppeteer-browser-ready v1.0.1 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v1.2.0 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
 
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/package.json

@@ -1,19 +1,18 @@
 {
    "name": "puppeteer-browser-ready",
-   "version": "1.0.1",
+   "version": "1.2.0",
    "description": "Simple utility to go to a URL and wait for the HTTP response",
    "license": "MIT",
    "type": "module",
    "module": "dist/puppeteer-browser-ready.js",
-   "main": "dist/puppeteer-browser-ready.umd.cjs",
+   "main": "dist/puppeteer-browser-ready.js",
    "types": "dist/puppeteer-browser-ready.d.ts",
    "files": [
       "dist"
    ],
    "exports": {
       ".": {
-         "import": "./dist/puppeteer-browser-ready.js",
-         "require": "./dist/puppeteer-browser-ready.umd.cjs"
+         "import": "./dist/puppeteer-browser-ready.js"
       },
       "./": "./dist/"
    },
@@ -65,23 +64,23 @@
       }
    },
    "runScriptsConfig": {
+      "clean": [
+         "rimraf build dist"
+      ],
       "build": [
-         "rimraf build dist",
          "jshint . --exclude-path .gitignore",
          "eslint --max-warnings 0 . --ext .ts",
          "tsc",
-         "tsc --module UMD --outDir build/umd",
-         "copy-file build/umd/puppeteer-browser-ready.js build/puppeteer-browser-ready.umd.cjs",
          "add-dist-header build dist",
          "html-validator"
       ]
    },
    "scripts": {
-      "pretest": "run-scripts build",
+      "pretest": "run-scripts clean build",
       "test": "mocha spec/*.spec.js --timeout 5000 --retries 1"
    },
    "peerDependencies": {
-      "puppeteer": "^5 || ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || ^13 || ^14 || ^15 || ^16 || ^17 || ^18 || ^19.7"
+      "puppeteer": "^10 || ^11 || ^12 || ^13 || ^14 || ^15 || ^16 || ^17 || ^18 || ^19.7 || ^20"
    },
    "dependencies": {
       "cheerio": "~1.0.0-rc.12",
@@ -92,22 +91,22 @@
       "@types/cheerio": "~0.22",
       "@types/express": "~4.17",
       "@types/mocha": "~10.0",
-      "@types/node": "~18.15",
+      "@types/node": "~20.3",
       "@types/ws": "~8.5",
-      "@typescript-eslint/eslint-plugin": "~5.56",
-      "@typescript-eslint/parser": "~5.56",
-      "add-dist-header": "~1.0",
-      "assert-deep-strict-equal": "~1.0",
-      "copy-file-util": "~1.0",
-      "copy-folder-util": "~1.0",
-      "eslint": "~8.36",
+      "@typescript-eslint/eslint-plugin": "~5.60",
+      "@typescript-eslint/parser": "~5.60",
+      "add-dist-header": "~1.1",
+      "assert-deep-strict-equal": "~1.1",
+      "copy-file-util": "~1.1",
+      "copy-folder-util": "~1.1",
+      "eslint": "~8.43",
       "jshint": "~2.13",
       "mocha": "~10.2",
-      "open": "~8.4",
-      "puppeteer": "~19.7",
-      "rimraf": "~4.4",
-      "run-scripts-util": "~1.0",
-      "typescript": "~5.0",
-      "w3c-html-validator": "~1.3"
+      "open": "~9.1",
+      "puppeteer": "~20.7",
+      "rimraf": "~5.0",
+      "run-scripts-util": "~1.2",
+      "typescript": "~5.1",
+      "w3c-html-validator": "~1.4"
    }
 }

package/dist/puppeteer-browser-ready.umd.cjs

@@ -1,110 +0,0 @@
-//! puppeteer-browser-ready v1.0.1 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
-
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "cheerio", "express", "http-terminator"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.browserReady = void 0;
-    const cheerio_1 = __importDefault(require("cheerio"));
-    const express_1 = __importDefault(require("express"));
-    const http_terminator_1 = __importDefault(require("http-terminator"));
-    // Package
-    const browserReady = {
-        log(...args) {
-            const indent = typeof globalThis.describe === 'function' ? '  [' : '[';
-            console.log(indent + new Date().toISOString() + ']', ...args);
-        },
-        startWebServer(options) {
-            const defaults = { folder: '.', port: 0, verbose: true, autoCleanup: true };
-            const settings = Object.assign(Object.assign({}, defaults), options);
-            const server = (0, express_1.default)().use(express_1.default.static(settings.folder)).listen(settings.port);
-            const terminator = http_terminator_1.default.createHttpTerminator({ server });
-            const port = () => server.address().port;
-            const url = () => 'http://localhost:' + String(port()) + '/';
-            const logListening = () => this.log('Web Server - listening:', server.listening, port(), url());
-            const logClose = () => this.log('Web Server - shutdown:', !server.listening);
-            const http = () => ({
-                server: server,
-                terminator: terminator,
-                folder: settings.folder,
-                url: url(),
-                port: port(),
-                verbose: settings.verbose,
-            });
-            let done;
-            server.on('listening', () => done(http()));
-            if (settings.verbose)
-                server.on('listening', logListening).on('close', logClose);
-            const cleanup = () => {
-                console.log('[SIGINT]');
-                terminator.terminate();
-            };
-            if (settings.autoCleanup)
-                process.on('SIGINT', cleanup);
-            return new Promise(resolve => done = resolve);
-        },
-        shutdownWebServer(http) {
-            return http.terminator.terminate();
-        },
-        goto(url, options) {
-            const defaults = { addCheerio: true, verbose: false };
-            const settings = Object.assign(Object.assign({}, defaults), options);
-            const log = (label, msg) => settings.verbose &&
-                console.log('   ', Date.now() % 100000, label + ':', msg);
-            const web = (browser) => __awaiter(this, void 0, void 0, function* () {
-                log('Connected', browser.isConnected());
-                try {
-                    const page = yield browser.newPage();
-                    log('Page....', url);
-                    const response = yield page.goto(url);
-                    log('Response', response === null || response === void 0 ? void 0 : response.url());
-                    const status = response && response.status();
-                    log('Status', status);
-                    const location = yield page.evaluate(() => globalThis.location);
-                    log('Host', location.host);
-                    const title = response && (yield page.title());
-                    log('Title', title);
-                    const html = response && (yield response.text());
-                    log('Bytes', html === null || html === void 0 ? void 0 : html.length);
-                    const $ = html && settings.addCheerio ? cheerio_1.default.load(html) : null;
-                    log('$', $ && $['fn'].constructor.name);
-                    return { browser, page, response, status, location, title, html, $ };
-                }
-                catch (error) {
-                    const status = browser.isConnected() ? 'connected' : 'not connected';
-                    console.log('[puppeteer-browser-ready]', settings, status);
-                    console.log(error);
-                    throw error;
-                }
-            });
-            return web;
-        },
-        close(web) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (web && web.browser)
-                    yield web.browser.close();
-                return web;
-            });
-        },
-    };
-    exports.browserReady = browserReady;
-});