@browserless.io/browserless 2.3.0 → 2.4.0-beta-3

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@130794": {
+                "__@toStringTag@141676": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@130794",
+                "__@toStringTag@141676",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@130794": {
+        "__@toStringTag@141676": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@130794",
+        "__@toStringTag@141676",
         "byteLength"
       ]
     },
@@ -452,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@130895": {
+        "__@species@141777": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@130794": {
+        "__@toStringTag@141676": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@130895",
-        "__@toStringTag@130794",
+        "__@species@141777",
+        "__@toStringTag@141676",
         "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"

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

@@ -538,14 +538,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@217726": {
+                "__@toStringTag@206722": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@217726",
+                "__@toStringTag@206722",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -580,13 +580,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@217726": {
+        "__@toStringTag@206722": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@217726",
+        "__@toStringTag@206722",
         "byteLength"
       ]
     },
@@ -596,18 +596,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@217827": {
+        "__@species@206823": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@217726": {
+        "__@toStringTag@206722": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@217827",
-        "__@toStringTag@217726",
+        "__@species@206823",
+        "__@toStringTag@206722",
         "byteLength"
       ]
     },

package/build/routes/chromium/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/chromium/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/chromium/http/scrape.post.body.json

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

package/build/routes/chromium/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/chromium/http/screenshot.post.body.json

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

package/build/routes/chromium/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/chromium/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/chromium/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/chromium/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/chromium/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/firefox/ws/playwright.query.json

@@ -80,10 +80,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/management/http/static.get.js

@@ -38,26 +38,32 @@ export default class StaticGetRoute extends HTTPRoute {
             return streamFile(verbose, res, fileCache.path, fileCache.contentType);
         }
         const config = this.config();
+        const sdkDir = this.staticSDKDir();
         const file = path.join(config.getStatic(), pathname);
         const indexFile = path.join(file, 'index.html');
-        const filePath = (await Promise.all([
-            fileExists(file).then((exists) => (exists ? file : undefined)),
-            fileExists(indexFile).then((exists) => exists ? indexFile : undefined),
-        ])).find((_) => !!_);
-        if (!filePath) {
+        const locations = [file, indexFile];
+        if (sdkDir) {
+            const sdkPath = path.join(sdkDir, pathname);
+            locations.push(...[sdkPath, path.join(sdkPath, 'index.html')]);
+        }
+        const foundFilePaths = (await Promise.all(locations.map((l) => fileExists(l).then((e) => (e ? l : undefined))))).filter((_) => !!_);
+        if (!foundFilePaths.length) {
             throw new NotFound(`No route or file found for resource ${req.method}: ${pathname}`);
         }
-        verbose(`Found new file "${filePath}", caching path and serving`);
-        const contentType = mimeTypes.get(path.extname(filePath));
+        if (foundFilePaths.length > 1) {
+            debug(`Multiple files found for request to "${pathname}". Only the first file is served, so please name your files uniquely.`);
+        }
+        const [foundFilePath] = foundFilePaths;
+        verbose(`Found new file "${foundFilePath}", caching path and serving`);
+        const contentType = mimeTypes.get(path.extname(foundFilePath));
         if (contentType) {
             res.setHeader('Content-Type', contentType);
         }
-        // Cache the assets location so we don't have to
-        // do stat checks again when requests come back
+        // Cache the file as being found so we don't have to call 'stat'
         pathMap.set(pathname, {
             contentType,
-            path: filePath,
+            path: foundFilePath,
         });
-        return streamFile(verbose, res, filePath, contentType);
+        return streamFile(verbose, res, foundFilePath, contentType);
     };
 }

package/build/routes/webkit/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/server.d.ts

@@ -2,9 +2,11 @@
 /// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import * as http from 'http';
 import * as stream from 'stream';
 import { Config, Metrics, Request, Response, Router, Token } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 export interface HTTPServerOptions {
     concurrent: number;
     host: string;
@@ -12,7 +14,7 @@ export interface HTTPServerOptions {
     queued: number;
     timeout: number;
 }
-export declare class HTTPServer {
+export declare class HTTPServer extends EventEmitter {
     protected config: Config;
     protected metrics: Metrics;
     protected token: Token;
@@ -26,8 +28,11 @@ export declare class HTTPServer {
     protected onHTTPUnauthorized: (_req: Request, res: Response) => void;
     protected onWebsocketUnauthorized: (_req: Request, socket: stream.Duplex) => void;
     start(): Promise<void>;
-    stop(): Promise<void>;
-    protected tearDown(): void;
     protected handleRequest: (request: http.IncomingMessage, res: http.ServerResponse) => Promise<void | http.ServerResponse<http.IncomingMessage>>;
     protected handleWebSocket: (request: http.IncomingMessage, socket: stream.Duplex, head: Buffer) => Promise<void>;
+    shutdown(): Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/server.js

@@ -1,8 +1,9 @@
 import * as http from 'http';
 import { BadRequest, NotFound, Timeout, TooManyRequests, Unauthorized, beforeRequest, contentTypes, convertPathToURL, createLogger, queryParamsToObject, readBody, shimLegacyRequests, writeResponse, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 // @ts-ignore
 import Enjoi from 'enjoi';
-export class HTTPServer {
+export class HTTPServer extends EventEmitter {
     config;
     metrics;
     token;
@@ -13,6 +14,7 @@ export class HTTPServer {
     log = createLogger('server');
     verbose = createLogger('server:verbose');
     constructor(config, metrics, token, router) {
+        super();
         this.config = config;
         this.metrics = metrics;
         this.token = token;
@@ -49,18 +51,6 @@ export class HTTPServer {
             });
         });
     }
-    async stop() {
-        this.log(`HTTP Server is shutting down`);
-        await new Promise((r) => this.server.close(r));
-        await Promise.all([this.tearDown(), this.router.teardown()]);
-        this.log(`HTTP Server shutdown complete`);
-    }
-    tearDown() {
-        this.log(`Tearing down all listeners and internal routes`);
-        this.server && this.server.removeAllListeners();
-        // @ts-ignore garbage collect this reference
-        this.server = null;
-    }
     handleRequest = async (request, res) => {
         this.verbose(`Handling inbound HTTP request on "${request.method}: ${request.url}"`);
         const req = request;
@@ -241,4 +231,16 @@ export class HTTPServer {
         this.log(`No matching WebSocket route handler for "${req.parsed.href}"`);
         return writeResponse(socket, 404, 'Not Found');
     };
+    async shutdown() {
+        this.log(`HTTP Server is shutting down`);
+        await new Promise((r) => this.server.close(r));
+        this.server && this.server.removeAllListeners();
+        // @ts-ignore garbage collect this reference
+        this.server = null;
+        this.log(`HTTP Server shutdown complete`);
+    }
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/build/token.d.ts

@@ -1,6 +1,17 @@
+/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserWebsocketRoute, Config, HTTPRoute, Request, WebSocketRoute } from '@browserless.io/browserless';
-export declare class Token {
+import { EventEmitter } from 'events';
+export declare class Token extends EventEmitter {
     protected config: Config;
     constructor(config: Config);
     isAuthorized: (req: Request, route: BrowserHTTPRoute | BrowserWebsocketRoute | HTTPRoute | WebSocketRoute) => Promise<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/token.js

@@ -1,7 +1,9 @@
 import { getTokenFromRequest, } from '@browserless.io/browserless';
-export class Token {
+import { EventEmitter } from 'events';
+export class Token extends EventEmitter {
     config;
     constructor(config) {
+        super();
         this.config = config;
     }
     isAuthorized = async (req, route) => {
@@ -18,4 +20,15 @@ export class Token {
         }
         return (Array.isArray(token) ? token : [token]).includes(requestToken);
     };
+    /**
+     * 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/types.d.ts

@@ -55,7 +55,8 @@ declare abstract class Route {
     protected _debug: Browserless['debug'];
     protected _metrics: Browserless['metrics'];
     protected _monitoring: Browserless['monitoring'];
-    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring']);
+    protected _staticSDKDir: Browserless['staticSDKDir'];
+    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
     /**
      * A unique name to identify this route. Used in downstream
      * SDKs to potentially remove or disable.
@@ -134,6 +135,13 @@ declare abstract class Route {
      * @returns Monitor
      */
     monitoring: () => import("@browserless.io/browserless").Monitoring;
+    /**
+     * When running in an SDK environment, this returns the fully-qualified
+     * directory of that static directory. When "null" then no SDK directory
+     * has been set.
+     * @returns {string | null} The full path location of the SDK's static directory
+     */
+    staticSDKDir: () => string | null;
     /**
      * The HTTP path that this route handles, eg '/my-route' OR an
      * array of paths that this route can handle.
@@ -354,17 +362,6 @@ export interface InBoundRequest {
     url: string;
 }
 export declare const debugScreenshotOpts: ScreenshotOptions;
-declare global {
-    interface Window {
-        browserless: BrowserlessEmbeddedAPI;
-    }
-}
-export interface BrowserlessEmbeddedAPI {
-    getRecording: () => Promise<string>;
-    liveUrl: () => string;
-    saveRecording: () => Promise<boolean>;
-    startRecording: () => void;
-}
 /**
  * When bestAttempt is set to true, browserless attempt to proceed
  * when "awaited" events fail or timeout. This includes things like