@browserless.io/browserless 2.0.0-beta-4 → 2.0.0-beta-6

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

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 const scrape = async (elements) => {
     const wait = (selector, timeout = 30000) => {
         return new Promise((resolve, reject) => {
@@ -39,18 +39,21 @@ const scrape = async (elements) => {
         };
     });
 };
-const route = {
-    accepts: [contentTypes.json],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.json],
-    description: dedent(`
+export default class ScrapePost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.json];
+    description = dedent(`
     A JSON-based API that returns text, html, and meta-data from a given list of selectors.
     Debugging information is available by sending in the appropriate flags in the "debugOpts"
     property. Responds with an array of JSON objects.
-  `),
-    handler: async (req, res, browser) => {
+  `);
+    method = Methods.post;
+    path = HTTPRoutes.scrape;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? contentTypes.html
             : req.headers.accept;
@@ -197,9 +200,5 @@ const route = {
         };
         page.close().catch(noop);
         return jsonResponse(res, 200, response, false);
-    },
-    method: Methods.post,
-    path: HTTPRoutes.scrape,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}

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

@@ -488,14 +488,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@75317": {
+                "__@toStringTag@75362": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@75317",
+                "__@toStringTag@75362",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -530,13 +530,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@75317": {
+        "__@toStringTag@75362": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@75317",
+        "__@toStringTag@75362",
         "byteLength"
       ]
     },
@@ -546,18 +546,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@75418": {
+        "__@species@75463": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@75317": {
+        "__@toStringTag@75362": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@75418",
-        "__@toStringTag@75317",
+        "__@species@75463",
+        "__@toStringTag@75362",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/screenshot-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 QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
@@ -33,5 +35,15 @@ export interface BodySchema {
     waitForSelector?: WaitForSelectorOptions;
     waitForTimeout?: Parameters<Page['waitForTimeout']>[0];
 }
-declare const route: BrowserHTTPRoute;
-export default route;
+export default class ScreenshotPost 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/screenshot-post.js

@@ -1,13 +1,20 @@
-import { APITags, BadRequest, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, scrollThroughPage, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 import Stream from 'stream';
-const route = {
-    accepts: [contentTypes.json],
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    contentTypes: [contentTypes.png, contentTypes.jpeg, contentTypes.text],
-    description: `A JSON-based API for getting a screenshot binary from either a supplied "url" or "html" payload in your request.`,
-    handler: async (req, res, browser) => {
+export default class ScreenshotPost extends BrowserHTTPRoute {
+    accepts = [contentTypes.json];
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    contentTypes = [contentTypes.png, contentTypes.jpeg, contentTypes.text];
+    description = dedent(`
+    A JSON-based API for getting a screenshot binary from either a supplied
+    "url" or "html" payload in your request. Many options exist including
+    cookies, user-agents, setting timers and network mocks.
+  `);
+    method = Methods.post;
+    path = HTTPRoutes.screenshot;
+    tags = [APITags.browserAPI];
+    handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'image/png'
             : req.headers.accept;
@@ -116,9 +123,5 @@ const route = {
         readStream.end(buffer);
         await new Promise((r) => readStream.pipe(res).once('close', r));
         page.close().catch(noop);
-    },
-    method: Methods.post,
-    path: HTTPRoutes.screenshot,
-    tags: [APITags.browserAPI],
-};
-export default route;
+    };
+}

package/build/routes/chromium/tests/websocket.spec.js

@@ -123,6 +123,25 @@ describe('WebSocket API', function () {
         await sleep(1000);
         expect(await exists(userDataDir)).to.be.false;
     });
+    it('allows specified user-data-dirs', async () => {
+        const dataDir = '/tmp/data-dir';
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const launch = JSON.stringify({
+            args: [`--user-data-dir=${dataDir}`],
+        });
+        const browser = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000?token=browserless&launch=${launch}`,
+        });
+        const [{ userDataDir }] = await fetch('http://localhost:3000/sessions?token=browserless').then((r) => r.json());
+        expect(await exists(userDataDir)).to.be.true;
+        expect(userDataDir).to.equal(dataDir);
+        await browser.disconnect();
+        await sleep(1000);
+        expect(await exists(userDataDir)).to.be.true;
+    });
     it('creates user-data-dirs with userDataDir options', async () => {
         const dataDirLocation = '/tmp/browserless-test-dir';
         const launch = JSON.stringify({
@@ -146,7 +165,7 @@ describe('WebSocket API', function () {
     it('creates user-data-dirs with CLI flags', async () => {
         const dataDirLocation = '/tmp/browserless-test-dir';
         const launch = JSON.stringify({
-            args: [`--user-data-dir==${dataDirLocation}`],
+            args: [`--user-data-dir=${dataDirLocation}`],
         });
         const config = new Config();
         config.setToken('browserless');

package/build/routes/chromium/utils/function/handler.js

@@ -1,4 +1,4 @@
-import { BadRequest, HTTPRoutes, contentTypes, convertIfBase64, exists, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
+import { BadRequest, HTTPRoutes, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
 import fs from 'fs';
 import path from 'path';
 export default (config, debug, options = {}) => async (req, browser) => {
@@ -14,7 +14,7 @@ export default (config, debug, options = {}) => async (req, browser) => {
         };
     const context = JSON.stringify(rawContext);
     const code = convertIfBase64(rawCode);
-    const browserWSEndpoint = browser.publicWSEndpoint(req.parsed.searchParams.get('token') ?? '');
+    const browserWSEndpoint = browser.publicWSEndpoint(getTokenFromRequest(req) ?? '');
     if (!browserWSEndpoint) {
         throw new Error(`No browser endpoint was found, is the browser running?`);
     }

package/build/routes/chromium/ws/browser.d.ts

@@ -1,6 +1,16 @@
-import { BrowserWebsocketRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+/// <reference types="node" />
+import { APITags, BrowserWebsocketRoute, CDPChromium, CDPLaunchOptions, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-declare const route: BrowserWebsocketRoute;
-export default route;
+export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler: (req: Request, socket: Duplex, head: Buffer, chrome: CDPChromium) => Promise<void>;
+}

package/build/routes/chromium/ws/browser.js

@@ -1,11 +1,10 @@
-import { APITags, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
-const route = {
-    auth: true,
-    browser: CDPChromium,
-    concurrency: false,
-    description: `Connect to an already-running Chromium with a library like puppeteer, or others, that work over chrome-devtools-protocol.`,
-    handler: async (req, socket, head, chrome) => chrome.proxyWebSocket(req, socket, head),
-    path: WebsocketRoutes.browser,
-    tags: [APITags.browserWS],
-};
-export default route;
+import { APITags, BrowserWebsocketRoute, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+    auth = true;
+    browser = CDPChromium;
+    concurrency = false;
+    description = `Connect to an already-running Chromium with a library like puppeteer, or others, that work over chrome-devtools-protocol.`;
+    path = WebsocketRoutes.browser;
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, chrome) => chrome.proxyWebSocket(req, socket, head);
+}

package/build/routes/chromium/ws/cdp-chromium.d.ts

@@ -1,6 +1,16 @@
-import { BrowserWebsocketRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+/// <reference types="node" />
+import { APITags, BrowserWebsocketRoute, CDPChromium, CDPLaunchOptions, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-declare const route: BrowserWebsocketRoute;
-export default route;
+export default class CDPChromiumRoute extends BrowserWebsocketRoute {
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler: (req: Request, socket: Duplex, head: Buffer, chrome: CDPChromium) => Promise<void>;
+}

package/build/routes/chromium/ws/cdp-chromium.js

@@ -1,11 +1,10 @@
-import { APITags, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
-const route = {
-    auth: true,
-    browser: CDPChromium,
-    concurrency: true,
-    description: `Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.`,
-    handler: async (req, socket, head, chrome) => chrome.proxyWebSocket(req, socket, head),
-    path: WebsocketRoutes['/'],
-    tags: [APITags.browserWS],
-};
-export default route;
+import { APITags, BrowserWebsocketRoute, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class CDPChromiumRoute extends BrowserWebsocketRoute {
+    auth = true;
+    browser = CDPChromium;
+    concurrency = true;
+    description = `Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.`;
+    path = WebsocketRoutes['/'];
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, chrome) => chrome.proxyWebSocket(req, socket, head);
+}

package/build/routes/chromium/ws/page.d.ts

@@ -1,6 +1,16 @@
-import { BrowserWebsocketRoute, CDPLaunchOptions, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+/// <reference types="node" />
+import { APITags, BrowserWebsocketRoute, CDPChromium, CDPLaunchOptions, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-declare const route: BrowserWebsocketRoute;
-export default route;
+export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+    auth: boolean;
+    browser: typeof CDPChromium;
+    concurrency: boolean;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler: (req: Request, socket: Duplex, head: Buffer, chrome: CDPChromium) => Promise<void>;
+}

package/build/routes/chromium/ws/page.js

@@ -1,11 +1,10 @@
-import { APITags, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
-const route = {
-    auth: true,
-    browser: CDPChromium,
-    concurrency: false,
-    description: `Connect to Chromium with a library like chrome-remote-interface or others that work over JSON chrome-devtools-protocol.`,
-    handler: async (req, socket, head, chrome) => chrome.proxyPageWebSocket(req, socket, head),
-    path: WebsocketRoutes.page,
-    tags: [APITags.browserWS],
-};
-export default route;
+import { APITags, BrowserWebsocketRoute, CDPChromium, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+    auth = true;
+    browser = CDPChromium;
+    concurrency = false;
+    description = `Connect to Chromium with a library like chrome-remote-interface or others that work over JSON chrome-devtools-protocol.`;
+    path = WebsocketRoutes.page;
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, chrome) => chrome.proxyPageWebSocket(req, socket, head);
+}

package/build/routes/chromium/ws/playwright-chromium.d.ts

@@ -1,6 +1,16 @@
-import { BrowserServerOptions, BrowserWebsocketRoute, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+/// <reference types="node" />
+import { APITags, BrowserServerOptions, BrowserWebsocketRoute, PlaywrightChromium, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: BrowserServerOptions | string;
 }
-declare const route: BrowserWebsocketRoute;
-export default route;
+export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+    auth: boolean;
+    browser: typeof PlaywrightChromium;
+    concurrency: boolean;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler: (req: Request, socket: Duplex, head: Buffer, browser: PlaywrightChromium) => Promise<void>;
+}

package/build/routes/chromium/ws/playwright-chromium.js

@@ -1,10 +1,12 @@
-import { APITags, BadRequest, PlaywrightChromium, WebsocketRoutes, } from '@browserless.io/browserless';
-const route = {
-    auth: true,
-    browser: PlaywrightChromium,
-    concurrency: true,
-    description: `Connect to Chromium with any playwright-compliant library.`,
-    handler: async (req, socket, head, browser) => {
+import { APITags, BadRequest, BrowserWebsocketRoute, PlaywrightChromium, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+    auth = true;
+    browser = PlaywrightChromium;
+    concurrency = true;
+    description = `Connect to Chromium with any playwright style library.`;
+    path = WebsocketRoutes.playwrightChromium;
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, browser) => {
         const isPlaywright = req.headers['user-agent']
             ?.toLowerCase()
             .includes('playwright');
@@ -12,8 +14,5 @@ const route = {
             throw new BadRequest(`Only playwright is allowed to work with this route`);
         }
         return browser.proxyWebSocket(req, socket, head);
-    },
-    path: WebsocketRoutes.playwrightChromium,
-    tags: [APITags.browserWS],
-};
-export default route;
+    };
+}

package/build/routes/firefox/ws/playwright-firefox.d.ts

@@ -1,6 +1,16 @@
-import { BrowserServerOptions, BrowserWebsocketRoute, SystemQueryParameters } from '@browserless.io/browserless';
+/// <reference types="node" />
+/// <reference types="node" />
+import { APITags, BrowserServerOptions, BrowserWebsocketRoute, PlaywrightFirefox, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: BrowserServerOptions | string;
 }
-declare const route: BrowserWebsocketRoute;
-export default route;
+export default class PlayWrightFirefoxRoute extends BrowserWebsocketRoute {
+    auth: boolean;
+    browser: typeof PlaywrightFirefox;
+    concurrency: boolean;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler: (req: Request, socket: Duplex, head: Buffer, browser: PlaywrightFirefox) => Promise<void>;
+}

package/build/routes/firefox/ws/playwright-firefox.js

@@ -1,10 +1,12 @@
-import { APITags, BadRequest, PlaywrightFirefox, WebsocketRoutes, } from '@browserless.io/browserless';
-const route = {
-    auth: true,
-    browser: PlaywrightFirefox,
-    concurrency: true,
-    description: `Connect to Firefox with any playwright-compliant library.`,
-    handler: async (req, socket, head, browser) => {
+import { APITags, BadRequest, BrowserWebsocketRoute, PlaywrightFirefox, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class PlayWrightFirefoxRoute extends BrowserWebsocketRoute {
+    auth = true;
+    browser = PlaywrightFirefox;
+    concurrency = true;
+    description = `Connect to Firefox with any playwright-compliant library.`;
+    path = WebsocketRoutes.playwrightFirefox;
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, browser) => {
         const isPlaywright = req.headers['user-agent']
             ?.toLowerCase()
             .includes('playwright');
@@ -12,8 +14,5 @@ const route = {
             throw new BadRequest(`Only playwright is allowed to work with this route`);
         }
         return browser.proxyWebSocket(req, socket, head);
-    },
-    path: WebsocketRoutes.playwrightFirefox,
-    tags: [APITags.browserWS],
-};
-export default route;
+    };
+}

package/build/routes/management/http/config-get.d.ts

@@ -1,4 +1,6 @@
-import { HTTPRoute } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 export interface ResponseSchema {
     allowCORS: boolean;
     allowFileProtocol: boolean;
@@ -21,5 +23,15 @@ export interface ResponseSchema {
     timeoutAlertURL: string | null;
     token: string | null;
 }
-declare const route: HTTPRoute;
-export default route;
+export default class ConfigGetRoute extends HTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPManagementRoutes;
+    tags: APITags[];
+    handler: (_req: Request, res: ServerResponse) => Promise<void>;
+}

package/build/routes/management/http/config-get.js

@@ -1,17 +1,16 @@
-import { APITags, HTTPManagementRoutes, Methods, ServerError, contentTypes, jsonResponse, } from '@browserless.io/browserless';
-const route = {
-    accepts: [contentTypes.any],
-    auth: true,
-    browser: null,
-    concurrency: false,
-    contentTypes: [contentTypes.json],
-    description: `Returns a JSON payload of the current system configuration.`,
-    handler: async (_req, res) => {
-        const { getConfig: getConfig } = route;
-        if (!getConfig) {
-            throw new ServerError(`Couldn't locate the config object`);
-        }
-        const config = getConfig();
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+export default class ConfigGetRoute extends HTTPRoute {
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Returns a JSON payload of the current system configuration.`;
+    method = Methods.get;
+    path = HTTPManagementRoutes.config;
+    tags = [APITags.management];
+    handler = async (_req, res) => {
+        const config = this.config();
         const response = {
             allowCORS: config.getAllowCORS(),
             allowFileProtocol: config.getAllowFileProtocol(),
@@ -35,9 +34,5 @@ const route = {
             token: config.getToken(),
         };
         return jsonResponse(res, 200, response);
-    },
-    method: Methods.get,
-    path: HTTPManagementRoutes.config,
-    tags: [APITags.management],
-};
-export default route;
+    };
+}

package/build/routes/management/http/metrics-get.d.ts

@@ -1,4 +1,16 @@
-import { HTTPRoute, IBrowserlessStats } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessStats, Methods, Request, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 export type ResponseSchema = Array<IBrowserlessStats>;
-declare const route: HTTPRoute;
-export default route;
+export default class MetricsGetRoute extends HTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPManagementRoutes;
+    tags: APITags[];
+    handler: (_req: Request, res: ServerResponse) => Promise<void>;
+}

package/build/routes/management/http/metrics-get.js

@@ -1,24 +1,19 @@
-import { APITags, HTTPManagementRoutes, Methods, ServerError, contentTypes, writeResponse, } from '@browserless.io/browserless';
-const route = {
-    accepts: [contentTypes.any],
-    auth: true,
-    browser: null,
-    concurrency: false,
-    contentTypes: [contentTypes.json],
-    description: `Gets total metric details from the time the server started.`,
-    handler: async (_req, res) => {
-        const { getFileSystem: _fileSystem, getConfig: _config } = route;
-        if (!_fileSystem || !_config) {
-            throw new ServerError(`Couldn't locate the file-system or config module`);
-        }
-        const fileSystem = _fileSystem();
-        const config = _config();
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
+export default class MetricsGetRoute extends HTTPRoute {
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Gets total metric details from the time the server started.`;
+    method = Methods.get;
+    path = HTTPManagementRoutes.metrics;
+    tags = [APITags.management];
+    handler = async (_req, res) => {
+        const fileSystem = this.fileSystem();
+        const config = this.config();
         const stats = await fileSystem.read(config.getMetricsJSONPath());
         const response = `[${stats.join(',')}]`;
         return writeResponse(res, 200, response, contentTypes.json);
-    },
-    method: Methods.get,
-    path: HTTPManagementRoutes.metrics,
-    tags: [APITags.management],
-};
-export default route;
+    };
+}

package/build/routes/management/http/metrics-total-get.d.ts

@@ -1,4 +1,16 @@
-import { HTTPRoute, IBrowserlessMetricTotals } from '@browserless.io/browserless';
+/// <reference types="node" />
+import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessMetricTotals, Methods, Request, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
 export type ResponseSchema = IBrowserlessMetricTotals;
-declare const route: HTTPRoute;
-export default route;
+export default class MetricsTotalGetRoute extends HTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPManagementRoutes;
+    tags: APITags[];
+    handler: (_req: Request, res: ServerResponse) => Promise<void>;
+}