puppeteer-browser-ready 0.5.6 → 0.5.8

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2022 individual contributors to puppeteer-browser-ready
+Copyright (c) 2020-2023 Individual contributors to puppeteer-browser-ready
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -27,7 +27,7 @@ import { browserReady } from 'puppeteer-browser-ready';
 
 ## B) Usage
 Use the `browserReady.goto(url, options)` function to tell Puppeteer which page to open.
-The **Promise** will resolve with a **Web** object containing a `title` field and a `html` field.  
+The **Promise** will resolve with a **Web** object containing a `title` field and a `html` field.
 Pass the **Web** object to the `browserReady.close(web)` function to disconnect the page.
 ```javascript
 const url = 'https://pretty-print-json.js.org/';
@@ -50,8 +50,8 @@ after(async () =>  await browserReady.close(web));
 | `verbose`     | **boolean** | `true` | Output informational messages.                   |
 
 ## C) TypeScript Declarations
-The **TypeScript Declaration File** file is
-[puppeteer-browser-ready.d.ts](dist/puppeteer-browser-ready.d.ts) in the **dist** folder.
+See the TypeScript declarations at the top of the
+[puppeteer-browser-ready.ts](puppeteer-browser-ready.ts) file.
 
 The `browserReady.goto(url, options)` function returns a function that takes a Puppeteer **Browser**
 object and returns a **Promise** that resolves with a **Web** object:
@@ -123,7 +123,7 @@ const url = 'https://pretty-print-json.js.org/';
 let web;  //fields: browser, page, response, status, location, title, html, $
 const loadWebPage = async () =>
    web = await puppeteer.launch().then(browserReady.goto(url));
-const closeWebPage = async () =>  
+const closeWebPage = async () =>
    await browserReady.close(web);
 
 /////////////////////////////////////////////////////////////////////////////////////

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

@@ -1,16 +1,17 @@
-//! puppeteer-browser-ready v0.5.6 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v0.5.8 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
 
 /// <reference types="cheerio" />
-import httpTerminator from 'http-terminator';
 import { Browser, HTTPResponse, Page } from 'puppeteer';
 import { Server } from 'http';
-export declare type StartWebServerOptions = {
-    folder?: string;
-    port?: number;
-    verbose?: boolean;
-    autoCleanup?: boolean;
+import httpTerminator from 'http-terminator';
+export type StartWebServerSettings = {
+    folder: string;
+    port: number;
+    verbose: boolean;
+    autoCleanup: boolean;
 };
-export declare type Http = {
+export type StartWebServerOptions = Partial<StartWebServerSettings>;
+export type Http = {
     server: Server;
     terminator: httpTerminator.HttpTerminator;
     folder: string;
@@ -18,7 +19,7 @@ export declare type Http = {
     port: number;
     verbose: boolean;
 };
-export declare type Web = {
+export type Web = {
     browser: Browser;
     page: Page;
     response: HTTPResponse | null;
@@ -28,10 +29,11 @@ export declare type Web = {
     html: string | null;
     $: cheerio.Root | null;
 };
-export declare type BrowserReadyOptions = {
-    addCheerio?: boolean;
-    verbose?: boolean;
+export type BrowserReadySettings = {
+    addCheerio: boolean;
+    verbose: boolean;
 };
+export type BrowserReadyOptions = Partial<BrowserReadySettings>;
 declare const browserReady: {
     log(...args: unknown[]): void;
     startWebServer(options?: StartWebServerOptions): Promise<Http>;

package/dist/puppeteer-browser-ready.js

@@ -1,4 +1,4 @@
-//! puppeteer-browser-ready v0.5.6 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v0.5.8 ~~ 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); }); }
@@ -9,7 +9,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-// Imports
 import cheerio from 'cheerio';
 import express from 'express';
 import httpTerminator from 'http-terminator';

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

@@ -1,4 +1,4 @@
-//! puppeteer-browser-ready v0.5.6 ~~ https://github.com/center-key/puppeteer-browser-ready ~~ MIT License
+//! puppeteer-browser-ready v0.5.8 ~~ 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); }); }
@@ -24,7 +24,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.browserReady = void 0;
-    // Imports
     const cheerio_1 = __importDefault(require("cheerio"));
     const express_1 = __importDefault(require("express"));
     const http_terminator_1 = __importDefault(require("http-terminator"));

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "puppeteer-browser-ready",
-   "version": "0.5.6",
+   "version": "0.5.8",
    "description": "Simple utility to go to a URL and wait for the HTTP response (written in TypeScript)",
    "license": "MIT",
    "type": "module",
@@ -34,7 +34,7 @@
       "url"
    ],
    "jshintConfig": {
-      "esversion": 9,
+      "esversion": 11,
       "strict": "implied",
       "eqeqeq": true,
       "latedef": true,
@@ -64,20 +64,24 @@
          "@typescript-eslint/no-non-null-assertion": "off"
       }
    },
+   "runScriptsConfig": {
+      "build": [
+         "rimraf build dist **/.DS_Store",
+         "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": {
-      "step:01": "rimraf build dist **/.DS_Store",
-      "step:02": "jshint . --exclude-path .gitignore",
-      "step:03": "eslint --max-warnings 0 . --ext .ts",
-      "step:04": "tsc",
-      "step:05": "tsc --module UMD --outDir build/umd",
-      "step:06": "cpy build/umd/puppeteer-browser-ready.js build --rename=puppeteer-browser-ready.umd.cjs --flat=true",
-      "step:07": "add-dist-header build dist",
-      "step:08": "w3c-html-validator",
-      "pretest": "npm-run-all step:*",
-      "test": "mocha spec/*.spec.js --timeout 5000"
+      "pretest": "run-scripts 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"
+      "puppeteer": "^5 || ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || ^13 || ^14 || ^15 || ^16 || ^17 || ^18 || ^19"
    },
    "dependencies": {
       "cheerio": "~1.0.0-rc.12",
@@ -87,22 +91,22 @@
    "devDependencies": {
       "@types/cheerio": "~0.22",
       "@types/express": "~4.17",
-      "@types/node": "~18.7",
+      "@types/node": "~18.11",
       "@types/ws": "~8.5",
-      "@typescript-eslint/eslint-plugin": "~5.38",
-      "@typescript-eslint/parser": "~5.38",
-      "add-dist-header": "~0.2",
+      "@typescript-eslint/eslint-plugin": "~5.48",
+      "@typescript-eslint/parser": "~5.48",
+      "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
-      "cpy-cli": "~4.2",
-      "copy-folder-cli": "~0.0",
-      "eslint": "~8.23",
+      "copy-file-util": "~0.1",
+      "copy-folder-util": "~0.2",
+      "eslint": "~8.32",
       "jshint": "~2.13",
-      "mocha": "~10.0",
-      "npm-run-all2": "~6.0",
+      "mocha": "~10.2",
       "open": "~8.4",
-      "puppeteer": "~18.0",
-      "rimraf": "~3.0",
-      "typescript": "~4.8",
-      "w3c-html-validator": "~1.1"
+      "puppeteer": "~19.5",
+      "rimraf": "~4.0",
+      "run-scripts-util": "~0.1",
+      "typescript": "~4.9",
+      "w3c-html-validator": "~1.3"
    }
 }