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

package/CHANGELOG.md

@@ -1,4 +1,17 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.3.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.4.0...main)
+- Dependency updates.
+
+# [v2.4.0](https://github.com/browserless/chrome/compare/v2.3.0...v2.4.0)
+**Potentially Breaking**
+- Drops support for recording and screencasting in favor of library-based approaches.
+- `playwright@1.42.1` and `puppeteer@22.4.0`.
+
+**Other Changes**
+- SDK routes now take precedence over core routes when a path-collision occurs.
+- Support SDK projects with their own `static` directories.
+- Adds support for user-specified `stop` methods in SDK Module extensions.
+- Core modules now extend `EventEmitter`, making them able to publish events.
+- Fixes issues with `addStyleTag` happening before `goto` calls in REST APIs.
 - Dependency updates.
 
 # [v2.3.0](https://github.com/browserless/chrome/compare/v2.2.0...v2.3.0)

package/bin/scaffold/README.md

@@ -356,6 +356,8 @@ export default class PDFToS3Route extends BrowserHTTPRoute {
 }
 ```
 
+On shutdown (SIGTERM, SIGINT, SIGHUP, SIGUSR2, process.on('exit'), `uncaughtException`) browserless will call a `stop` method on all modules. This method is intentionally left blank for SDK extensions to implement. This allows for you to implement any teardown, cleanup, timer clearing, or event unbinding. You don't need to copy over any browserless-core specific teardown as these are handled elsewhere.
+
 With this approach you can effectively write, extend and author your own workflows within browserless!
 
 ## Disabling Routes

package/build/browserless.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="debug" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { BrowserManager, Config, FileSystem, HTTPServer, Limiter, Metrics, Monitoring, Router, Token, WebHooks } from '@browserless.io/browserless';
-export declare class Browserless {
+import { EventEmitter } from 'events';
+export declare class Browserless extends EventEmitter {
     protected debug: debug.Debugger;
     protected browserManager: BrowserManager;
     protected config: Config;
@@ -38,6 +40,6 @@ export declare class Browserless {
     addHTTPRoute(httpRouteFilePath: string): void;
     addWebSocketRoute(webSocketRouteFilePath: string): void;
     setPort(port: number): void;
-    stop(): Promise<[void | undefined]>;
+    stop(): Promise<[void | undefined, void, void, void, void, void, void, void, void, void]>;
     start(): Promise<void>;
 }

package/build/browserless.js

@@ -1,9 +1,10 @@
 import * as path from 'path';
 import { BrowserManager, ChromeCDP, ChromiumCDP, ChromiumPlaywright, Config, FileSystem, FirefoxPlaywright, HTTPServer, Limiter, Metrics, Monitoring, Router, Token, WebHooks, WebkitPlaywright, availableBrowsers, createLogger, getRouteFiles, makeExternalURL, printLogo, safeParse, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import { readFile } from 'fs/promises';
 import { userInfo } from 'os';
 const routeSchemas = ['body', 'query'];
-export class Browserless {
+export class Browserless extends EventEmitter {
     debug = createLogger('index');
     browserManager;
     config;
@@ -22,6 +23,7 @@ export class Browserless {
     metricsSaveInterval = 5 * 60 * 1000;
     metricsSaveIntervalID;
     constructor({ browserManager, config, fileSystem, limiter, metrics, monitoring, router, token, webhooks, } = {}) {
+        super();
         this.config = config || new Config();
         this.metrics = metrics || new Metrics();
         this.token = token || new Token(this.config);
@@ -94,7 +96,18 @@ export class Browserless {
     }
     async stop() {
         clearInterval(this.metricsSaveIntervalID);
-        return Promise.all([this.server?.stop()]);
+        return Promise.all([
+            this.server?.shutdown(),
+            this.browserManager.shutdown(),
+            this.config.shutdown(),
+            this.fileSystem.shutdown(),
+            this.limiter.shutdown(),
+            this.metrics.shutdown(),
+            this.monitoring.shutdown(),
+            this.router.shutdown(),
+            this.token.shutdown(),
+            this.webhooks.shutdown(),
+        ]);
     }
     async start() {
         const httpRoutes = [];
@@ -112,8 +125,8 @@ export class Browserless {
         this.debug(`Running as user "${userInfo().username}"`);
         this.debug('Starting import of HTTP Routes');
         for (const httpRoute of [
-            ...internalHttpRouteFiles,
             ...this.httpRouteFiles,
+            ...internalHttpRouteFiles,
         ]) {
             if (httpRoute.endsWith('js')) {
                 const { name } = path.parse(httpRoute);
@@ -141,8 +154,8 @@ export class Browserless {
         }
         this.debug('Starting import of WebSocket Routes');
         for (const wsRoute of [
-            ...internalWsRouteFiles,
             ...this.webSocketRouteFiles,
+            ...internalWsRouteFiles,
         ]) {
             if (wsRoute.endsWith('js')) {
                 const { name } = path.parse(wsRoute);

package/build/browsers/chromium.cdp.d.ts

@@ -12,7 +12,6 @@ import httpProxy from 'http-proxy';
 export declare class ChromiumCDP extends EventEmitter {
     protected config: Config;
     protected userDataDir: string | null;
-    protected record: boolean;
     protected blockAds: boolean;
     protected running: boolean;
     protected browser: Browser | null;
@@ -21,16 +20,13 @@ export declare class ChromiumCDP extends EventEmitter {
     protected debug: import("debug").Debugger;
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected executablePath: string;
-    constructor({ userDataDir, config, record, blockAds, }: {
+    constructor({ blockAds, config, userDataDir, }: {
         blockAds: boolean;
         config: Config;
-        record: boolean;
         userDataDir: ChromiumCDP['userDataDir'];
     });
     protected cleanListeners(): void;
-    protected setUpEmbeddedAPI: (page: Page, id: string, record: boolean) => Promise<void>;
     getPageId: (page: Page) => string;
-    makeLiveURL: (browserId: string, pageId: string) => string;
     protected onTargetCreated: (target: Target) => Promise<void>;
     isRunning: () => boolean;
     newPage: () => Promise<Page>;

package/build/browsers/chromium.cdp.js

@@ -1,4 +1,4 @@
-import { BLESS_PAGE_IDENTIFIER, ServerError, createLogger, encrypt, liveURLSep, makeExternalURL, noop, once, } from '@browserless.io/browserless';
+import { BLESS_PAGE_IDENTIFIER, ServerError, createLogger, noop, once, } from '@browserless.io/browserless';
 import puppeteer from 'puppeteer-core';
 import { EventEmitter } from 'events';
 import StealthPlugin from 'puppeteer-extra-plugin-stealth';
@@ -12,7 +12,6 @@ puppeteerStealth.use(StealthPlugin());
 export class ChromiumCDP extends EventEmitter {
     config;
     userDataDir;
-    record;
     blockAds;
     running = false;
     browser = null;
@@ -21,11 +20,10 @@ export class ChromiumCDP extends EventEmitter {
     debug = createLogger('browsers:chromium:cdp');
     proxy = httpProxy.createProxyServer();
     executablePath = playwright.chromium.executablePath();
-    constructor({ userDataDir, config, record, blockAds, }) {
+    constructor({ blockAds, config, userDataDir, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.record = record;
         this.blockAds = blockAds;
         this.debug(`Starting new browser instance`);
     }
@@ -33,104 +31,10 @@ export class ChromiumCDP extends EventEmitter {
         this.browser?.removeAllListeners();
         this.removeAllListeners();
     }
-    setUpEmbeddedAPI = async (page, id, record) => {
-        const pageId = this.getPageId(page);
-        const liveUrl = this.makeLiveURL(id, pageId);
-        const embeddedAPI = (pageId, liveUrl, record) => {
-            Object.defineProperty(window, 'browserless', {
-                configurable: false,
-                enumerable: false,
-                value: {},
-                writable: false,
-            });
-            Object.defineProperties(window.browserless, {
-                liveUrl: {
-                    configurable: false,
-                    enumerable: false,
-                    value: () => liveUrl,
-                    writable: false,
-                },
-                pageId: {
-                    configurable: false,
-                    enumerable: false,
-                    value: () => pageId,
-                    writable: false,
-                },
-                startRecording: {
-                    configurable: false,
-                    enumerable: false,
-                    value: (params) => new Promise((resolve, reject) => {
-                        if (!record) {
-                            throw new Error(`Must connect with a record query-param set to "true" in order to use recording`);
-                        }
-                        const start = () => window.postMessage({ ...params, id: pageId, type: 'REC_START' }, '*');
-                        const onStart = (event) => {
-                            if (event.data.id !== pageId)
-                                return;
-                            if (event.data.message === 'REC_STARTED') {
-                                window.removeEventListener('message', onStart);
-                                return resolve(undefined);
-                            }
-                            if (event.data.message === 'REC_START_FAIL') {
-                                window.removeEventListener('message', onStart);
-                                return reject(new Error(event.data.error));
-                            }
-                        };
-                        window.addEventListener('message', onStart);
-                        return document.readyState == 'complete'
-                            ? start()
-                            : window.addEventListener('load', start);
-                    }),
-                    writable: false,
-                },
-                stopRecording: {
-                    configurable: false,
-                    enumerable: false,
-                    value: () => new Promise((resolve, reject) => {
-                        if (!record) {
-                            return reject(new Error(`Must connect with a record query-param set to "true" in order to use recording`));
-                        }
-                        const onStop = (event) => {
-                            if (event.data.id !== pageId)
-                                return;
-                            if (event.data.message === 'REC_FILE') {
-                                window.removeEventListener('message', onStop);
-                                return resolve(event.data.file);
-                            }
-                            if (event.data.message === 'REC_STOP_FAIL') {
-                                window.removeEventListener('message', onStop);
-                                return reject(new Error(event.data.error));
-                            }
-                            if (event.data.message === 'REC_NOT_STARTED') {
-                                window.removeEventListener('message', onStop);
-                                return reject(new Error(`Recording hasn't started, did you forget to start it?`));
-                            }
-                        };
-                        window.addEventListener('message', onStop);
-                        return window.postMessage({ id: pageId, type: 'REC_STOP' }, '*');
-                    }),
-                    writable: false,
-                },
-            });
-        };
-        // Setup the browserless embedded API
-        await Promise.all([
-            page.evaluate(embeddedAPI, pageId, liveUrl, record),
-            page.evaluateOnNewDocument(embeddedAPI, pageId, liveUrl, record),
-        ]).catch((err) => this.debug(`Error setting up embedded API:`, err.message));
-    };
     getPageId = (page) => {
         // @ts-ignore
         return page.target()._targetId;
     };
-    makeLiveURL = (browserId, pageId) => {
-        const serverAddress = this.config.getExternalAddress();
-        const key = this.config.getAESKey();
-        const path = `${browserId}${liveURLSep}${pageId}`;
-        const encoded = encrypt(path, key);
-        const query = `?id=${encoded}`;
-        return makeExternalURL(serverAddress, 'live', query);
-    };
     onTargetCreated = async (target) => {
         if (target.type() === 'page') {
             const page = await target.page().catch((e) => {
@@ -155,8 +59,6 @@ export class ChromiumCDP extends EventEmitter {
                         }
                     });
                 }
-                const browserId = this.wsEndpoint()?.split('/').pop();
-                await this.setUpEmbeddedAPI(page, browserId, this.record);
                 this.emit('newPage', page);
             }
         }
@@ -196,23 +98,11 @@ export class ChromiumCDP extends EventEmitter {
             ].filter((_) => !!_),
             executablePath: this.executablePath,
         };
-        if (this.record || this.blockAds) {
-            const requiredExtensionArgs = [];
+        if (this.blockAds) {
             // Necessary to load extensions
             finalOptions.headless = false;
-            if (this.record) {
-                finalOptions.ignoreDefaultArgs = ['--enable-automation'];
-                requiredExtensionArgs.push('--enable-usermedia-screen-capturing', '--enable-blink-features=GetUserMedia', '--allow-http-screen-capture', '--auto-select-desktop-capture-source=browserless-screencast', '--disable-infobars');
-            }
-            const loadExtensionPaths = [
-                ...(this.record
-                    ? [path.join(__dirname, '..', '..', 'extensions', 'screencast')]
-                    : []),
-                ...(this.blockAds
-                    ? [path.join(__dirname, '..', '..', 'extensions', 'ublock')]
-                    : []),
-            ].join(',');
-            finalOptions.args.push(...requiredExtensionArgs, '--load-extension=' + loadExtensionPaths, '--disable-extensions-except=' + loadExtensionPaths);
+            const loadExtensionPaths = path.join(__dirname, '..', '..', 'extensions', 'ublock');
+            finalOptions.args.push('--load-extension=' + loadExtensionPaths, '--disable-extensions-except=' + loadExtensionPaths);
         }
         const launch = options.stealth
             ? puppeteerStealth.launch.bind(puppeteerStealth)

package/build/browsers/chromium.playwright.d.ts

@@ -11,16 +11,14 @@ import httpProxy from 'http-proxy';
 export declare class ChromiumPlaywright extends EventEmitter {
     protected config: Config;
     protected userDataDir: string | null;
-    protected record: boolean;
     protected running: boolean;
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected browser: playwright.BrowserServer | null;
     protected browserWSEndpoint: string | null;
     protected debug: import("debug").Debugger;
     protected executablePath: string;
-    constructor({ config, userDataDir, record, }: {
+    constructor({ config, userDataDir, }: {
         config: Config;
-        record: boolean;
         userDataDir: ChromiumPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;

package/build/browsers/chromium.playwright.js

@@ -5,18 +5,16 @@ import httpProxy from 'http-proxy';
 export class ChromiumPlaywright extends EventEmitter {
     config;
     userDataDir;
-    record;
     running = false;
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
     debug = createLogger('browsers:chromium:playwright');
     executablePath = playwright.chromium.executablePath();
-    constructor({ config, userDataDir, record, }) {
+    constructor({ config, userDataDir, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.record = record;
         this.debug(`Starting new browser instance`);
     }
     cleanListeners() {
@@ -50,9 +48,6 @@ export class ChromiumPlaywright extends EventEmitter {
     };
     launch = async (options = {}) => {
         this.debug(`Launching Playwright Handler`);
-        if (this.record) {
-            throw new ServerError(`Recording is not yet available with this browser`);
-        }
         this.browser = await playwright.chromium.launchServer({
             ...options,
             args: [

package/build/browsers/firefox.playwright.d.ts

@@ -11,15 +11,13 @@ import httpProxy from 'http-proxy';
 export declare class FirefoxPlaywright extends EventEmitter {
     protected config: Config;
     protected userDataDir: string | null;
-    protected record: boolean;
     protected running: boolean;
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected browser: playwright.BrowserServer | null;
     protected browserWSEndpoint: string | null;
     protected debug: import("debug").Debugger;
-    constructor({ config, userDataDir, record, }: {
+    constructor({ config, userDataDir, }: {
         config: Config;
-        record: boolean;
         userDataDir: FirefoxPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;

package/build/browsers/firefox.playwright.js

@@ -5,17 +5,15 @@ import httpProxy from 'http-proxy';
 export class FirefoxPlaywright extends EventEmitter {
     config;
     userDataDir;
-    record;
     running = false;
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
     debug = createLogger('browsers:firefox:playwright');
-    constructor({ config, userDataDir, record, }) {
+    constructor({ config, userDataDir, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.record = record;
         this.debug(`Starting new browser instance`);
     }
     cleanListeners() {
@@ -44,9 +42,6 @@ export class FirefoxPlaywright extends EventEmitter {
         throw new ServerError(`Can't create new page with this browser`);
     };
     launch = async (options = {}) => {
-        if (this.record) {
-            throw new ServerError(`Recording is not yet available with this browser`);
-        }
         this.debug(`Launching Playwright Handler`);
         this.browser = await playwright.firefox.launchServer({
             ...options,

package/build/browsers/index.d.ts

@@ -35,5 +35,9 @@ export declare class BrowserManager {
     getAllSessions: () => Promise<BrowserlessSessionJSON[]>;
     complete: (browser: BrowserInstance) => Promise<void>;
     getBrowserForRequest: (req: Request, router: BrowserHTTPRoute | BrowserWebsocketRoute) => Promise<BrowserInstance>;
-    stop: () => Promise<void>;
+    shutdown: () => Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/browsers/index.js

@@ -42,7 +42,6 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds: false,
             config: this.config,
-            record: false,
             userDataDir: null,
         });
         await browser.launch();
@@ -70,7 +69,6 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds: false,
             config: this.config,
-            record: false,
             userDataDir: null,
         });
         await browser.launch();
@@ -217,7 +215,6 @@ export class BrowserManager {
     };
     getBrowserForRequest = async (req, router) => {
         const { browser: Browser } = router;
-        const record = parseBooleanParam(req.parsed.searchParams, 'record', false);
         const blockAds = parseBooleanParam(req.parsed.searchParams, 'blockAds', false);
         const decodedLaunchOptions = convertIfBase64(req.parsed.searchParams.get('launch') || '{}');
         let parsedLaunchOptions;
@@ -300,7 +297,6 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds,
             config: this.config,
-            record,
             userDataDir,
         });
         const connectionMeta = {
@@ -324,7 +320,7 @@ export class BrowserManager {
         });
         return browser;
     };
-    stop = async () => {
+    shutdown = async () => {
         this.debug(`Closing down browser instances`);
         const sessions = Array.from(this.browsers);
         await Promise.all(sessions.map(([b]) => b.close()));
@@ -333,6 +329,11 @@ export class BrowserManager {
         this.timers.forEach((t) => clearTimeout(t));
         this.browsers = new Map();
         this.timers = new Map();
+        await this.stop();
         this.debug(`Shutdown complete`);
     };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/build/browsers/webkit.playwright.d.ts

@@ -11,15 +11,13 @@ import httpProxy from 'http-proxy';
 export declare class WebkitPlaywright extends EventEmitter {
     protected config: Config;
     protected userDataDir: string | null;
-    protected record: boolean;
     protected running: boolean;
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected browser: playwright.BrowserServer | null;
     protected browserWSEndpoint: string | null;
     protected debug: import("debug").Debugger;
-    constructor({ config, userDataDir, record, }: {
+    constructor({ config, userDataDir, }: {
         config: Config;
-        record: boolean;
         userDataDir: WebkitPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;

package/build/browsers/webkit.playwright.js

@@ -5,17 +5,15 @@ import httpProxy from 'http-proxy';
 export class WebkitPlaywright extends EventEmitter {
     config;
     userDataDir;
-    record;
     running = false;
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
     debug = createLogger('browsers:webkit:playwright');
-    constructor({ config, userDataDir, record, }) {
+    constructor({ config, userDataDir, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.record = record;
         this.debug(`Starting new browser instance`);
     }
     cleanListeners() {
@@ -44,9 +42,6 @@ export class WebkitPlaywright extends EventEmitter {
         throw new ServerError(`Can't create new page with this browser`);
     };
     launch = async (options = {}) => {
-        if (this.record) {
-            throw new ServerError(`Recording is not yet available with this browser`);
-        }
         this.debug(`Launching Playwright Handler`);
         this.browser = await playwright.webkit.launchServer({
             ...options,

package/build/config.d.ts

@@ -144,4 +144,13 @@ export declare class Config extends EventEmitter {
         'Access-Control-Allow-Origin': string;
         'Access-Control-Max-Age': 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/config.js

@@ -361,4 +361,15 @@ export class Config extends EventEmitter {
         'Access-Control-Allow-Origin': this.corsOrigin,
         'Access-Control-Max-Age': this.corsMaxAge,
     });
+    /**
+     * 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/constants.d.ts

@@ -1,5 +1,4 @@
 export declare const encryptionAlgo = "aes-192-cbc";
 export declare const encryptionSep = ".";
-export declare const liveURLSep = ":";
 export declare const keyLength = 24;
 export declare const BLESS_PAGE_IDENTIFIER = "BLESS";

package/build/constants.js

@@ -1,5 +1,4 @@
 export const encryptionAlgo = 'aes-192-cbc';
 export const encryptionSep = '.';
-export const liveURLSep = ':';
 export const keyLength = 24;
 export const BLESS_PAGE_IDENTIFIER = 'BLESS';

package/build/file-system.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
 /// <reference types="debug" />
+/// <reference types="node" />
 import { Config } from '@browserless.io/browserless';
-export declare class FileSystem {
+import { EventEmitter } from 'events';
+export declare class FileSystem extends EventEmitter {
     protected config: Config;
     protected fsMap: Map<string, string[]>;
     protected currentAESKey: Buffer;
@@ -26,4 +28,13 @@ export declare class FileSystem {
      * @returns Promise of the contents separated by newlines
      */
     read: (path: string) => Promise<string[]>;
+    /**
+     * 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/file-system.js

@@ -1,11 +1,13 @@
 import { createLogger, decrypt, encrypt, } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
-export class FileSystem {
+import { EventEmitter } from 'events';
+export class FileSystem extends EventEmitter {
     config;
     fsMap = new Map();
     currentAESKey;
     log = createLogger('file-system');
     constructor(config) {
+        super();
         this.config = config;
         this.currentAESKey = config.getAESKey();
         this.config.on('token', this.handleTokenChange);
@@ -58,4 +60,15 @@ export class FileSystem {
         this.fsMap.set(path, splitContents);
         return splitContents;
     };
+    /**
+     * 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/http.d.ts

@@ -181,13 +181,6 @@ export interface SystemQueryParameters {
      * object, or a base64-encoded JSON object.
      */
     launch?: CDPLaunchOptions | BrowserServerOptions | string;
-    /**
-     * Whether or nor to record the session. The browser will run
-     * in "head-full" mode, and recording is started and closed
-     * via the embedded browserless API. Please refer to the "Recording"
-     * section in the live documentation site for more details.
-     */
-    record?: boolean;
     /**
      * Override the system-level timeout for this request.
      * Accepts a value in milliseconds.

package/build/limiter.d.ts

@@ -44,5 +44,14 @@ export declare class Limiter extends q {
     get concurrencySize(): number;
     get hasCapacity(): boolean;
     limit: <TArgs extends unknown[], TResult>(limitFn: LimitFn<TArgs, TResult>, overCapacityFn: ErrorFn<TArgs>, onTimeoutFn: ErrorFn<TArgs>, timeoutOverrideFn: (...args: TArgs) => number | undefined) => LimitFn<TArgs, 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;
 }
 export {};

package/build/limiter.js

@@ -147,4 +147,15 @@ export class Limiter extends q {
             return bound;
         });
     };
+    /**
+     * 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 = () => { };
 }