@browserless.io/browserless 2.4.0-beta-1 → 2.4.0

package/build/metrics.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="node" />
 import { IBrowserlessStats } from '@browserless.io/browserless';
-export declare class Metrics {
+import { EventEmitter } from 'events';
+export declare class Metrics extends EventEmitter {
     protected sessionTimes: number[];
     protected successful: number;
     protected queued: number;
@@ -27,4 +29,13 @@ export declare class Metrics {
         totalTime: number;
         units: number;
     };
+    /**
+     * 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/metrics.js

@@ -1,4 +1,5 @@
-export class Metrics {
+import { EventEmitter } from 'events';
+export class Metrics extends EventEmitter {
     sessionTimes = [];
     successful = 0;
     queued = 0;
@@ -83,4 +84,15 @@ export class Metrics {
             units: sessionTimes.reduce((sum, value) => sum + Math.ceil(value / 30000), 0),
         };
     }
+    /**
+     * 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/monitoring.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="debug" />
+/// <reference types="node" />
 import { Config, IResourceLoad } from '@browserless.io/browserless';
-export declare class Monitoring {
+import { EventEmitter } from 'events';
+export declare class Monitoring extends EventEmitter {
     protected config: Config;
     protected log: import("debug").Debugger;
     constructor(config: Config);
@@ -11,4 +13,13 @@ export declare class Monitoring {
         memoryInt: number | null;
         memoryOverloaded: boolean;
     }>;
+    /**
+     * 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/monitoring.js

@@ -1,9 +1,11 @@
 import { createLogger, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import si from 'systeminformation';
-export class Monitoring {
+export class Monitoring extends EventEmitter {
     config;
     log = createLogger('hardware');
     constructor(config) {
+        super();
         this.config = config;
     }
     getMachineStats = async () => {
@@ -35,4 +37,15 @@ export class Monitoring {
             memoryOverloaded,
         };
     };
+    /**
+     * 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/router.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserManager, BrowserWebsocketRoute, Config, HTTPRoute, Limiter, Request, Response, WebSocketRoute } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import stream from 'stream';
-export declare class Router {
+export declare class Router extends EventEmitter {
     protected config: Config;
     protected browserManager: BrowserManager;
     protected limiter: Limiter;
@@ -21,8 +23,16 @@ export declare class Router {
     protected wrapWebSocketHandler: (route: WebSocketRoute | BrowserWebsocketRoute, handler: WebSocketRoute['handler'] | BrowserWebsocketRoute['handler']) => (req: Request, socket: stream.Duplex, head: Buffer) => Promise<unknown>;
     registerHTTPRoute(route: HTTPRoute | BrowserHTTPRoute): HTTPRoute | BrowserHTTPRoute;
     registerWebSocketRoute(route: WebSocketRoute | BrowserWebsocketRoute): WebSocketRoute | BrowserWebsocketRoute;
-    teardown(): Promise<void>;
     getStaticHandler(): HTTPRoute;
     getRouteForHTTPRequest(req: Request): Promise<HTTPRoute | BrowserHTTPRoute | null>;
     getRouteForWebSocketRequest(req: Request): Promise<WebSocketRoute | BrowserWebsocketRoute | undefined>;
+    /**
+     * 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/router.js

@@ -1,6 +1,7 @@
 import { HTTPManagementRoutes, contentTypes, createLogger, isConnected, writeResponse, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import micromatch from 'micromatch';
-export class Router {
+export class Router extends EventEmitter {
     config;
     browserManager;
     limiter;
@@ -9,6 +10,7 @@ export class Router {
     httpRoutes = [];
     webSocketRoutes = [];
     constructor(config, browserManager, limiter) {
+        super();
         this.config = config;
         this.browserManager = browserManager;
         this.limiter = limiter;
@@ -129,11 +131,6 @@ export class Router {
         this.webSocketRoutes.push(route);
         return route;
     }
-    teardown() {
-        this.httpRoutes = [];
-        this.webSocketRoutes = [];
-        return this.browserManager.stop();
-    }
     getStaticHandler() {
         return this.httpRoutes.find((route) => route.path.includes(HTTPManagementRoutes.static));
     }
@@ -156,4 +153,17 @@ export class Router {
         // Once registered, paths are always an array here.
         r.path.some((p) => micromatch.isMatch(pathname, p)));
     }
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown = async () => {
+        this.httpRoutes = [];
+        this.webSocketRoutes = [];
+        await this.stop();
+    };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

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

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

package/build/routes/chrome/http/content.post.query.json

@@ -16,10 +16,6 @@
         }
       ]
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/http/download.post.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/http/function.post.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -20,9 +20,6 @@
       "description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
       "type": "boolean"
     },
-    "blockModals": {
-      "type": "boolean"
-    },
     "cookies": {
       "type": "array",
       "items": {
@@ -538,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@97550": {
+                "__@toStringTag@86785": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@97550",
+                "__@toStringTag@86785",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -580,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@97550": {
+        "__@toStringTag@86785": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@97550",
+        "__@toStringTag@86785",
         "byteLength"
       ]
     },
@@ -596,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@97651": {
+        "__@species@86886": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@97550": {
+        "__@toStringTag@86785": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@97651",
-        "__@toStringTag@97550",
+        "__@species@86886",
+        "__@toStringTag@86785",
         "byteLength"
       ]
     },

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

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/http/performance.post.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

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

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

@@ -16,10 +16,6 @@
         }
       ]
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

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

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

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/ws/browser.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/ws/cdp.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/ws/page.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chrome/ws/playwright.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

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

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

@@ -16,10 +16,6 @@
         }
       ]
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chromium/http/download.post.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/routes/chromium/http/function.post.query.json

@@ -16,10 +16,6 @@
       "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
       "type": "boolean"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"