@browserless.io/browserless 2.5.0-beta-1 → 2.5.0-beta-2

package/bin/browserless.js

@@ -170,7 +170,7 @@ const start = async (dev = false) => {
     importDefault(files, 'token'),
     importDefault(files, 'webhooks'),
     importDefault(files, 'disabled-routes'),
-    importDefault(files,' hooks'),
+    importDefault(files, 'hooks'),
   ]);
 
   log(`Starting Browserless`);

package/bin/scaffold/README.md

@@ -477,7 +477,7 @@ export class Hooks extends EventEmitter {
   // Can be used to inject behaviors or add events to a page's lifecycle.
   // "meta" property is a parsed URL of the original incoming request.
   // No return value or type required.
-  page(args: { meta: URL, page: puppeteer.Page }): Promise<void> {
+  page(args: { meta: URL; page: puppeteer.Page }): Promise<void> {
     return Promise.resolve(undefined);
   }
 

package/build/browserless.d.ts

@@ -42,6 +42,6 @@ export declare class Browserless extends EventEmitter {
     addHTTPRoute(httpRouteFilePath: string): void;
     addWebSocketRoute(webSocketRouteFilePath: string): void;
     setPort(port: number): void;
-    stop(): Promise<[void | undefined, void, void, void, void, void, void, void, void, void]>;
+    stop(): Promise<[void | undefined, void, void, void, void, void, void, void, void, void, void]>;
     start(): Promise<void>;
 }

package/build/browserless.js

@@ -110,6 +110,7 @@ export class Browserless extends EventEmitter {
             this.router.shutdown(),
             this.token.shutdown(),
             this.webhooks.shutdown(),
+            this.hooks.shutdown(),
         ]);
     }
     async start() {

package/build/browsers/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="debug" />
 import { BrowserHTTPRoute, BrowserInstance, BrowserWebsocketRoute, BrowserlessSession, BrowserlessSessionJSON, CDPJSONPayload, ChromiumCDP, Config, Hooks, Request } from '@browserless.io/browserless';
+import { Page } from 'puppeteer-core';
 export declare class BrowserManager {
     protected config: Config;
     protected hooks: Hooks;
@@ -12,7 +13,7 @@ export declare class BrowserManager {
     constructor(config: Config, hooks: Hooks);
     private browserIsChrome;
     protected removeUserDataDir: (userDataDir: string | null) => Promise<void>;
-    protected onNewPage: (req: Request, page: unknown) => Promise<void>;
+    protected onNewPage: (req: Request, page: Page) => Promise<void>;
     /**
      * Returns the /json/protocol API contents from Chromium or Chrome, whichever is installed,
      * and modifies URLs to set them to the appropriate addresses configured.

package/build/hooks.d.ts

@@ -1,9 +1,18 @@
 /// <reference types="node" />
+import { AfterResponse, BeforeRequest, BrowserHook, PageHook } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Hooks extends EventEmitter {
-    constructor();
-    before(...args: unknown[]): Promise<boolean>;
-    after(...args: unknown[]): Promise<boolean>;
-    page(...args: unknown[]): Promise<unknown>;
-    browser(...args: unknown[]): Promise<unknown>;
+    before(args: BeforeRequest): Promise<boolean>;
+    after(args: AfterResponse): Promise<unknown>;
+    page(args: PageHook): Promise<unknown>;
+    browser(args: BrowserHook): Promise<unknown>;
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown: () => Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/hooks.js

@@ -1,26 +1,37 @@
-// @ts-nocheck Unknown external files
 import { EventEmitter } from 'events';
 // KEPT for backwards compatibility reasons since some downstream
 // docker images will override these files to inject their own hook
 // behaviors
+// @ts-ignore
 import { default as afterRequest } from '../external/after.js';
+// @ts-ignore
 import { default as beforeRequest } from '../external/before.js';
+// @ts-ignore
 import { default as browserHook } from '../external/browser.js';
+// @ts-ignore
 import { default as pageHook } from '../external/page.js';
 export class Hooks extends EventEmitter {
-    constructor() {
-        super();
+    before(args) {
+        return beforeRequest(args);
     }
-    before(...args) {
-        return beforeRequest(...args);
+    after(args) {
+        return afterRequest(args);
     }
-    after(...args) {
-        return afterRequest(...args);
+    page(args) {
+        return pageHook(args);
     }
-    page(...args) {
-        return pageHook(...args);
-    }
-    browser(...args) {
-        return browserHook(...args);
+    browser(args) {
+        return browserHook(args);
     }
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown = async () => {
+        await this.stop();
+    };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/build/routes/chrome/http/pdf.post.body.json

@@ -535,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@86810": {
+                "__@toStringTag@75984": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@86810",
+                "__@toStringTag@75984",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@86810": {
+        "__@toStringTag@75984": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@86810",
+        "__@toStringTag@75984",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@86911": {
+        "__@species@76085": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@86810": {
+        "__@toStringTag@75984": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@86911",
-        "__@toStringTag@86810",
+        "__@species@76085",
+        "__@toStringTag@75984",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/scrape.post.body.json

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@130859": {
+                "__@toStringTag@108694": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@130859",
+                "__@toStringTag@108694",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@130859": {
+        "__@toStringTag@108694": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@130859",
+        "__@toStringTag@108694",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@130960": {
+        "__@species@108795": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@130859": {
+        "__@toStringTag@108694": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@130960",
-        "__@toStringTag@130859",
+        "__@species@108795",
+        "__@toStringTag@108694",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/screenshot.post.body.json

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@108705": {
+                "__@toStringTag@119846": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@108705",
+                "__@toStringTag@119846",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@108705": {
+        "__@toStringTag@119846": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@108705",
+        "__@toStringTag@119846",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@108806": {
+        "__@species@119947": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@108705": {
+        "__@toStringTag@119846": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@108806",
-        "__@toStringTag@108705",
+        "__@species@119947",
+        "__@toStringTag@119846",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/content.post.body.json

@@ -394,14 +394,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@119767": {
+                "__@toStringTag@130908": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@119767",
+                "__@toStringTag@130908",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@119767": {
+        "__@toStringTag@130908": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@119767",
+        "__@toStringTag@130908",
         "byteLength"
       ]
     },
@@ -452,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@119868": {
+        "__@species@131009": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@119767": {
+        "__@toStringTag@130908": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@119868",
-        "__@toStringTag@119767",
+        "__@species@131009",
+        "__@toStringTag@130908",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/pdf.post.body.json

@@ -535,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@206779": {
+                "__@toStringTag@217585": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@206779",
+                "__@toStringTag@217585",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@206779": {
+        "__@toStringTag@217585": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@206779",
+        "__@toStringTag@217585",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@206880": {
+        "__@species@217686": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@206779": {
+        "__@toStringTag@217585": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@206880",
-        "__@toStringTag@206779",
+        "__@species@217686",
+        "__@toStringTag@217585",
         "byteLength"
       ]
     },

package/build/types.d.ts

@@ -9,12 +9,12 @@ import { HTTPRequest, Page, ResponseForRequest, ScreenshotOptions } from 'puppet
 export type PathTypes = HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 export interface BeforeRequest {
     head?: Buffer;
-    req: Request;
+    req: http.IncomingMessage;
     res?: http.ServerResponse;
     socket?: stream.Duplex;
 }
 export interface AfterResponse {
-    req: http.IncomingMessage;
+    req: Request;
     start: number;
     status: 'successful' | 'error' | 'timedout';
 }

package/build/utils.js

@@ -322,15 +322,10 @@ export const availableBrowsers = Promise.all([
     }
     return availableBrowsers;
 });
-export const queryParamsToObject = (params) => {
-    const entries = params.entries();
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const result = {};
-    for (const [key, value] of entries) {
-        result[key] = value === '' ? true : jsonOrString(value);
-    }
-    return result;
-};
+export const queryParamsToObject = (params) => [...params.entries()].reduce((accum, [key, value]) => {
+    accum[key] = value;
+    return accum;
+}, {});
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
 const wrapUserFunction = (fn) => {

package/external/after.js

@@ -1 +1 @@
-export default () => true;
+export default async () => {};

package/external/before.js

@@ -1 +1 @@
-export default () => true;
+export default async () => true;

package/external/browser.js

@@ -1 +1 @@
-export default () => Promise.resolve(true);
+export default async () => {};

package/external/page.js

@@ -1 +1 @@
-export default () => Promise.resolve(true);
+export default async () => {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.5.0-beta-1",
+  "version": "2.5.0-beta-2",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",

package/src/browserless.ts

@@ -206,6 +206,7 @@ export class Browserless extends EventEmitter {
       this.router.shutdown(),
       this.token.shutdown(),
       this.webhooks.shutdown(),
+      this.hooks.shutdown(),
     ]);
   }
 

package/src/browsers/index.ts

@@ -30,6 +30,7 @@ import {
   noop,
   parseBooleanParam,
 } from '@browserless.io/browserless';
+import { Page } from 'puppeteer-core';
 import { deleteAsync } from 'del';
 import path from 'path';
 
@@ -65,7 +66,7 @@ export class BrowserManager {
     }
   };
 
-  protected onNewPage = async (req: Request, page: unknown) => {
+  protected onNewPage = async (req: Request, page: Page) => {
     await this.hooks.page({ meta: req.parsed, page });
   };
 

package/src/hooks.ts

@@ -1,32 +1,50 @@
-// @ts-nocheck Unknown external files
+import {
+  AfterResponse,
+  BeforeRequest,
+  BrowserHook,
+  PageHook,
+} from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 
 // KEPT for backwards compatibility reasons since some downstream
 // docker images will override these files to inject their own hook
 // behaviors
+// @ts-ignore
 import { default as afterRequest } from '../external/after.js';
+// @ts-ignore
 import { default as beforeRequest } from '../external/before.js';
+// @ts-ignore
 import { default as browserHook } from '../external/browser.js';
+// @ts-ignore
 import { default as pageHook } from '../external/page.js';
 
 export class Hooks extends EventEmitter {
-  constructor() {
-    super();
+  before(args: BeforeRequest): Promise<boolean> {
+    return beforeRequest(args);
   }
 
-  before(...args: unknown[]): Promise<boolean> {
-    return beforeRequest(...args);
+  after(args: AfterResponse): Promise<unknown> {
+    return afterRequest(args);
   }
 
-  after(...args: unknown[]): Promise<boolean> {
-    return afterRequest(...args);
+  page(args: PageHook): Promise<unknown> {
+    return pageHook(args);
   }
 
-  page(...args: unknown[]): Promise<unknown> {
-    return pageHook(...args);
+  browser(args: BrowserHook): Promise<unknown> {
+    return browserHook(args);
   }
 
-  browser(...args: unknown[]): Promise<unknown> {
-    return browserHook(...args);
-  }
+  /**
+   * Implement any browserless-core-specific shutdown logic here.
+   * Calls the empty-SDK stop method for downstream implementations.
+   */
+  public shutdown = async () => {
+    await this.stop();
+  };
+
+  /**
+   * Left blank for downstream SDK modules to optionally implement.
+   */
+  public stop = () => {};
 }

package/src/types.ts

@@ -31,13 +31,13 @@ export type PathTypes =
 
 export interface BeforeRequest {
   head?: Buffer;
-  req: Request;
+  req: http.IncomingMessage;
   res?: http.ServerResponse;
   socket?: stream.Duplex;
 }
 
 export interface AfterResponse {
-  req: http.IncomingMessage;
+  req: Request;
   start: number;
   status: 'successful' | 'error' | 'timedout';
 }

package/src/utils.ts

@@ -463,16 +463,14 @@ export const availableBrowsers = Promise.all([
 
 export const queryParamsToObject = (
   params: URLSearchParams,
-): Record<string, unknown> => {
-  const entries = params.entries();
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const result: any = {};
-  for (const [key, value] of entries) {
-    result[key] = value === '' ? true : jsonOrString(value);
-  }
-  return result;
-};
+): Record<string, unknown> =>
+  [...params.entries()].reduce(
+    (accum, [key, value]) => {
+      accum[key] = value;
+      return accum;
+    },
+    {} as Record<string, string>,
+  );
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;

package/static/docs/swagger.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.5.0-beta-1",
+    "version": "2.5.0-beta-2",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.5.0-beta-1",
+    "version": "2.5.0-beta-2",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"