@browserless.io/browserless 2.0.0-beta-5 → 2.0.0-beta-7

package/build/file-system.js

@@ -1,11 +1,28 @@
-import { decrypt, encrypt } from '@browserless.io/browserless';
+import { createLogger, decrypt, encrypt, } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
 export class FileSystem {
     config;
     fsMap = new Map();
+    currentAESKey;
+    log = createLogger('file-system');
     constructor(config) {
         this.config = config;
+        this.currentAESKey = config.getAESKey();
+        this.config.on('token', this.handleTokenChange);
     }
+    handleTokenChange = async () => {
+        this.log(`Token has changed, updating file-system contents`);
+        const start = Date.now();
+        const newAESKey = this.config.getAESKey();
+        await Promise.all(Array.from(this.fsMap).map(async ([filePath, contents]) => {
+            const newlyEncoded = encrypt(contents.join('\n'), Buffer.from(newAESKey));
+            return writeFile(filePath, newlyEncoded);
+        })).catch((e) => {
+            this.log(`Error in setting new token: "${e}"`);
+        });
+        this.log(`Successfully updated file encodings in ${Date.now() - start}ms`);
+        this.currentAESKey = this.config.getAESKey();
+    };
     /**
      * Appends contents to a file-path for persistance. File contents are
      * encrypted before being saved to disk. Reads happen via the in-memory
@@ -19,8 +36,7 @@ export class FileSystem {
         const contents = await this.read(path);
         contents.push(newContent);
         this.fsMap.set(path, contents);
-        const key = this.config.getAESKey();
-        const encoded = await encrypt(contents.join('\n'), Buffer.from(key));
+        const encoded = await encrypt(contents.join('\n'), Buffer.from(this.currentAESKey));
         return writeFile(path, encoded.toString());
     };
     /**
@@ -35,10 +51,9 @@ export class FileSystem {
         if (hasKey) {
             return this.fsMap.get(path);
         }
-        const key = this.config.getAESKey();
         const contents = (await readFile(path).catch(() => '')).toString();
         const splitContents = contents.length
-            ? (await decrypt(contents, Buffer.from(key))).split('\n')
+            ? (await decrypt(contents, Buffer.from(this.currentAESKey))).split('\n')
             : [];
         this.fsMap.set(path, splitContents);
         return splitContents;

package/build/file-system.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/file-system.spec.js

@@ -0,0 +1,44 @@
+import { Config, FileSystem, sleep } from '@browserless.io/browserless';
+import { readFile, unlink } from 'fs/promises';
+import { expect } from 'chai';
+const filePath = '/tmp/_browserless_test_fs_';
+describe.only('File-System', () => {
+    afterEach(async () => unlink(filePath));
+    it('saves and encodes files', async () => {
+        const mySecretContents = 'pony-foo';
+        const config = new Config();
+        config.setToken('browserless.io');
+        const f = new FileSystem(config);
+        await f.append(filePath, mySecretContents);
+        expect(await f.read(filePath)).to.eql([mySecretContents]);
+        const rawText = (await readFile(filePath)).toString();
+        expect(rawText.toString()).to.not.include(mySecretContents);
+    });
+    it('appends newlines to files', async () => {
+        const mySecretContents = 'pony-foo';
+        const moreSecretContents = 'pony-pony-foo-foo';
+        const config = new Config();
+        config.setToken('browserless.io');
+        const f = new FileSystem(config);
+        await f.append(filePath, mySecretContents);
+        expect(await f.read(filePath)).to.eql([mySecretContents]);
+        await f.append(filePath, moreSecretContents);
+        expect(await f.read(filePath)).to.eql([
+            mySecretContents,
+            moreSecretContents,
+        ]);
+    });
+    it('re-encodes files on token changes', async () => {
+        const config = new Config();
+        config.setToken('browserless.io');
+        const f = new FileSystem(config);
+        const mySecretContents = 'pony-foo';
+        await f.append(filePath, mySecretContents);
+        const oldText = (await readFile(filePath)).toString();
+        config.setToken('super-browserless-64');
+        await sleep(200);
+        const newText = (await readFile(filePath)).toString();
+        expect(oldText).to.not.equal(newText);
+        expect(await f.read(filePath)).to.eql([mySecretContents]);
+    });
+});

package/build/http.d.ts

@@ -132,9 +132,9 @@ export declare enum HTTPManagementRoutes {
     static = "/"
 }
 export declare enum APITags {
-    'browserAPI' = "Browser APIs",
-    'browserWS' = "Browser WebSockets",
-    'management' = "Management APIs"
+    'browserAPI' = "Browser REST APIs",
+    'browserWS' = "Browser WebSocket APIs",
+    'management' = "Management REST APIs"
 }
 export interface Request extends http.IncomingMessage {
     body: unknown;

package/build/http.js

@@ -98,7 +98,7 @@ export var HTTPManagementRoutes;
 })(HTTPManagementRoutes || (HTTPManagementRoutes = {}));
 export var APITags;
 (function (APITags) {
-    APITags["browserAPI"] = "Browser APIs";
-    APITags["browserWS"] = "Browser WebSockets";
-    APITags["management"] = "Management APIs";
+    APITags["browserAPI"] = "Browser REST APIs";
+    APITags["browserWS"] = "Browser WebSocket APIs";
+    APITags["management"] = "Management REST APIs";
 })(APITags || (APITags = {}));

package/build/router.js

@@ -38,7 +38,7 @@ export class Router {
             this.log(`HTTP Request has closed prior to running`);
             return Promise.resolve();
         }
-        if (route.browser) {
+        if ('browser' in route && route.browser) {
             const browser = await this.browserManager.getBrowserForRequest(req, route);
             if (!isConnected(res)) {
                 this.log(`HTTP Request has closed prior to running`);
@@ -68,7 +68,7 @@ export class Router {
             this.log(`WebSocket Request has closed prior to running`);
             return Promise.resolve();
         }
-        if (route.browser) {
+        if ('browser' in route && route.browser) {
             const browser = await this.browserManager.getBrowserForRequest(req, route);
             if (!isConnected(socket)) {
                 this.log(`WebSocket Request has closed prior to running`);
@@ -92,7 +92,6 @@ export class Router {
     };
     registerHTTPRoute(route) {
         this.verbose(`Registering HTTP ${route.method.toUpperCase()} ${route.path}`);
-        route.getBrowserManager = () => this.browserManager;
         const bound = route.handler.bind(route);
         const wrapped = this.wrapHTTPHandler(route, bound);
         route.handler = route.concurrency
@@ -103,7 +102,6 @@ export class Router {
     }
     registerWebSocketRoute(route) {
         this.verbose(`Registering WebSocket "${route.path}"`);
-        route.getBrowserManager = () => this.browserManager;
         const bound = route.handler.bind(route);
         const wrapped = this.wrapWebSocketHandler(route, bound);
         route.handler = route.concurrency

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

@@ -398,14 +398,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10725": {
+                "__@toStringTag@10732": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10725",
+                "__@toStringTag@10732",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -440,13 +440,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10725": {
+        "__@toStringTag@10732": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10725",
+        "__@toStringTag@10732",
         "byteLength"
       ]
     },
@@ -456,18 +456,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@10826": {
+        "__@species@10833": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10725": {
+        "__@toStringTag@10732": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@10826",
-        "__@toStringTag@10725",
+        "__@species@10833",
+        "__@toStringTag@10732",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/content-post.d.ts

@@ -1,5 +1,7 @@
-import { BrowserHTTPRoute, CDPLaunchOptions, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, rejectRequestPattern, rejectResourceTypes, requestInterceptors, setJavaScriptEnabled } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors, setJavaScriptEnabled } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
+import { ServerResponse } from 'http';
 export interface BodySchema {
     addScriptTag?: Array<Parameters<Page['addScriptTag']>[0]>;
     addStyleTag?: Array<Parameters<Page['addStyleTag']>[0]>;
@@ -30,5 +32,15 @@ export type ResponseSchema = string;
 export type QuerySchema = SystemQueryParameters & {
     launch?: CDPLaunchOptions | string;
 };
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class ContentPostRoute extends BrowserHTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+}

package/build/routes/chromium/http/content-post.js

@@ -1,12 +1,15 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
-const route = {
-    accepts: [contentTypes.json],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.html],
-    description: `A JSON-based API. Given a "url" or "html" field, runs and returns HTML content after the page has loaded and JavaScript has parsed.`,
-    handler: async (req, res, browser) => {
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+export default class ContentPostRoute extends BrowserHTTPRoute {
+    accepts = [contentTypes.json];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.html];
+    description = `A JSON-based API. Given a "url" or "html" field, runs and returns HTML content after the page has loaded and JavaScript has parsed.`;
+    method = Methods.post;
+    path = HTTPRoutes.content;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? contentTypes.html
             : req.headers.accept;
@@ -101,9 +104,5 @@ const route = {
         const markup = await page.content();
         page.close().catch(noop);
         return writeResponse(res, 200, markup, contentTypes.html);
-    },
-    method: Methods.post,
-    path: HTTPRoutes.content,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}

package/build/routes/chromium/http/download-post.d.ts

@@ -1,4 +1,6 @@
-import { BrowserHTTPRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 interface JSONSchema {
     code: string;
     context?: Record<string, string | number>;
@@ -12,5 +14,16 @@ export interface QuerySchema extends SystemQueryParameters {
  * themselves, so there isn't a static response type for this API.
  */
 export type ResponseSchema = unknown;
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class DownloadPost extends BrowserHTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+}
+export {};

package/build/routes/chromium/http/download-post.js

@@ -1,29 +1,28 @@
-import { APITags, CDPChromium, HTTPRoutes, Methods, NotFound, ServerError, contentTypes, dedent, id, mimeTypes, once, sleep, } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, NotFound, contentTypes, dedent, id, mimeTypes, once, sleep, } from '@browserless.io/browserless';
 import { mkdir, readdir } from 'fs/promises';
 import { createReadStream } from 'fs';
 import { deleteAsync } from 'del';
 import functionHandler from '../utils/function/handler.js';
 import path from 'path';
-const route = {
-    accepts: [contentTypes.json, contentTypes.javascript],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.any],
-    description: dedent(`
+export default class DownloadPost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json, contentTypes.javascript];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.any];
+    description = dedent(`
   A JSON or JavaScript content-type API for returning files Chrome has downloaded during
   the execution of puppeteer code, which is ran inside context of the browser.
   Browserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.
   You can load external libraries via the "import" syntax, and import ESM-style modules
   that are written for execution inside of the browser. Once your script is finished, any
-  downloaded files from Chromium are returned back with the appropriate content-type header.`),
-    handler: async (req, res, browser) => new Promise(async (resolve, reject) => {
-        const { getConfig: getConfig, getDebug: getDebug } = route;
-        if (!getConfig || !getDebug) {
-            return reject(new ServerError(`Couldn't load configuration for request`));
-        }
-        const debug = getDebug();
-        const config = getConfig();
+  downloaded files from Chromium are returned back with the appropriate content-type header.`);
+    method = Methods.post;
+    path = HTTPRoutes.download;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => new Promise(async (resolve, reject) => {
+        const debug = this.debug();
+        const config = this.config();
         const downloadPath = path.join(await config.getDownloadsDir(), `.browserless.download.${id()}`);
         debug(`Generating a download directory at "${downloadPath}"`);
         await mkdir(downloadPath);
@@ -84,9 +83,5 @@ const route = {
             return resolve();
         })
             .pipe(res);
-    }),
-    method: Methods.post,
-    path: HTTPRoutes.download,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    });
+}

package/build/routes/chromium/http/function-post.d.ts

@@ -1,4 +1,6 @@
-import { BrowserHTTPRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 interface JSONSchema {
     code: string;
     context?: Record<string, string | number>;
@@ -14,5 +16,16 @@ export interface QuerySchema extends SystemQueryParameters {
  * by type (HTML data is "text/html", Objects are "application/json")
  */
 export type ResponseSchema = unknown;
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class FunctionPost extends BrowserHTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+}
+export {};

package/build/routes/chromium/http/function-post.js

@@ -1,26 +1,25 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, ServerError, contentTypes, dedent, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, contentTypes, dedent, writeResponse, } from '@browserless.io/browserless';
 import Stream from 'stream';
 import { fileTypeFromBuffer } from 'file-type';
 import functionHandler from '../utils/function/handler.js';
-const route = {
-    accepts: [contentTypes.json, contentTypes.javascript],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.any],
-    description: dedent(`
+export default class FunctionPost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json, contentTypes.javascript];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.any];
+    description = dedent(`
   A JSON or JavaScript content-type API for running puppeteer code in the browser's context.
   Browserless sets up a blank page, injects your puppeteer code, and runs it.
   You can optionally load external libraries via the "import" module that are meant for browser usage.
   Values returned from the function are checked and an appropriate content-type and response is sent back
-  to your HTTP call.`),
-    handler: async (req, res, browser) => {
-        const { getConfig: getConfig, getDebug: getDebug } = route;
-        if (!getConfig || !getDebug) {
-            throw new ServerError(`Couldn't load configuration for request`);
-        }
-        const debug = getDebug();
-        const config = getConfig();
+  to your HTTP call.`);
+    method = Methods.post;
+    path = HTTPRoutes.function;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
+        const debug = this.debug();
+        const config = this.config();
         const handler = functionHandler(config, debug);
         const { contentType, payload, page } = await handler(req, browser);
         debug(`Got function response of "${contentType}"`);
@@ -45,9 +44,5 @@ const route = {
             writeResponse(res, 200, payload, contentType);
         }
         return;
-    },
-    method: Methods.post,
-    path: HTTPRoutes.function,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}

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

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

package/build/routes/chromium/http/pdf-post.d.ts

@@ -1,5 +1,7 @@
-import { BrowserHTTPRoute, CDPLaunchOptions, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
+import { ServerResponse } from 'http';
 export interface BodySchema {
     addScriptTag?: Array<Parameters<Page['addScriptTag']>[0]>;
     addStyleTag?: Array<Parameters<Page['addStyleTag']>[0]>;
@@ -31,5 +33,15 @@ export interface QuerySchema extends SystemQueryParameters {
  * Responds with an application/pdf content-type and a binary PDF
  */
 export type ResponseSchema = string;
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class PDFPost extends BrowserHTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+}

package/build/routes/chromium/http/pdf-post.js

@@ -1,12 +1,20 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
-const route = {
-    accepts: [contentTypes.json],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.pdf],
-    description: `A JSON-based API for getting a PDF binary from either a supplied "url" or "html" payload in your request.`,
-    handler: async (req, res, browser) => {
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+export default class PDFPost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.pdf];
+    description = dedent(`
+    A JSON-based API for getting a PDF binary from either a supplied
+    "url" or "html" payload in your request. Many options exist for
+    injecting cookies, request interceptors, user-agents and waiting for
+    selectors, timers and more.
+  `);
+    method = Methods.post;
+    path = HTTPRoutes.pdf;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'application/pdf'
             : req.headers.accept;
@@ -99,9 +107,5 @@ const route = {
             return pdfStream.pipe(res).once('finish', resolve).once('error', reject);
         });
         page.close().catch(noop);
-    },
-    method: Methods.post,
-    path: HTTPRoutes.pdf,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}

package/build/routes/chromium/http/performance.d.ts

@@ -1,4 +1,6 @@
-import { BrowserHTTPRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 export interface BodySchema {
     budgets?: Array<object>;
     config?: object;
@@ -13,5 +15,15 @@ export interface QuerySchema extends SystemQueryParameters {
  * JSON body
  */
 export type ResponseSchema = object;
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class PerformancePost extends BrowserHTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+}

package/build/routes/chromium/http/performance.js

@@ -1,30 +1,22 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, ServerError, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 import main from '../utils/performance/main.js';
-const route = {
-    accepts: [contentTypes.json],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.json],
-    description: `Run lighthouse performance audits with a supplied "url" in your JSON payload.`,
-    handler: async (req, res, browser) => {
-        const { getConfig: getConfig } = route;
-        if (!req.body) {
-            throw new BadRequest(`No JSON body present`);
-        }
-        if (!getConfig) {
-            throw new ServerError(`Couldn't load configuration for timeouts`);
-        }
-        const config = getConfig();
+export default class PerformancePost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.json];
+    description = `Run lighthouse performance audits with a supplied "url" in your JSON payload.`;
+    method = Methods.post;
+    path = HTTPRoutes.performance;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
+        const config = this.config();
         const response = await main({
             browser,
             context: req.body,
             timeout: config.getTimeout(),
         });
         return jsonResponse(res, 200, response);
-    },
-    method: Methods.post,
-    path: HTTPRoutes.performance,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}