@browserless.io/browserless 2.2.0-beta-6 → 2.2.0

package/build/{routes/chromium/http/json-list.js → shared/json-list.http.js}

@@ -1,5 +1,4 @@
 import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, } from '@browserless.io/browserless';
-import { getCDPJSONPayload } from '../utils/cdp.js';
 export default class GetJSONList extends HTTPRoute {
     accepts = [contentTypes.any];
     auth = true;
@@ -7,17 +6,15 @@ export default class GetJSONList extends HTTPRoute {
     concurrency = false;
     contentTypes = [contentTypes.json];
     description = dedent(`
-    Returns a JSON payload that acts as a pass-through to the DevTools /json/list HTTP API in Chromium.
-    Browserless mocks this payload so that remote clients can connect to the underlying "webSocketDebuggerUrl"
-    which will cause Browserless to start the browser and proxy that request into a blank page.
+    Returns a JSON payload that acts as a pass-through to the DevTools /json/list HTTP API in Chromium and Chrome.
+    Browserless crafts this payload so that remote clients can connect to the underlying "webSocketDebuggerUrl"
+    properly, excluding any API tokens in that URL. If under authentication be sure to include your authorization.
   `);
     method = Methods.get;
     path = HTTPRoutes.jsonList;
     tags = [APITags.browserAPI];
     handler = async (_req, res) => {
-        const config = this.config();
-        const externalAddress = config.getExternalAddress();
-        const payload = getCDPJSONPayload(externalAddress);
-        return jsonResponse(res, 200, [payload]);
+        const browserManage = this.browserManager();
+        return jsonResponse(res, 200, await browserManage.getJSONList());
     };
 }

package/build/{routes/chromium/http/json-list.d.ts → shared/json-new.http.d.ts}

@@ -1,6 +1,5 @@
-import { APITags, HTTPRoute, HTTPRoutes, Methods, Request, Response, contentTypes } from '@browserless.io/browserless';
-import { getCDPJSONPayload } from '../utils/cdp.js';
-export type ResponseSchema = Array<ReturnType<typeof getCDPJSONPayload>>;
+import { APITags, CDPJSONPayload, HTTPRoute, HTTPRoutes, Methods, Request, Response, contentTypes } from '@browserless.io/browserless';
+export type ResponseSchema = CDPJSONPayload;
 export default class GetJSONList extends HTTPRoute {
     accepts: contentTypes[];
     auth: boolean;

package/build/shared/json-new.http.js

@@ -0,0 +1,34 @@
+import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, pageID, } from '@browserless.io/browserless';
+import path from 'path';
+export default class GetJSONList extends HTTPRoute {
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = dedent(`
+    Returns a JSON payload that acts as a pass-through to the DevTools /json/new HTTP API in Chromium.
+    Browserless mocks this payload so that remote clients can connect to the underlying "webSocketDebuggerUrl"
+    which will cause Browserless to start the browser and proxy that request into a blank page.
+  `);
+    method = Methods.put;
+    path = HTTPRoutes.jsonNew;
+    tags = [APITags.browserAPI];
+    handler = async (_req, res) => {
+        const config = this.config();
+        const externalAddress = config.getExternalWebSocketAddress();
+        const id = pageID();
+        const { protocol, host, pathname, href } = new URL(`/devtools/page/${id}`, externalAddress);
+        const param = protocol.includes('wss') ? 'wss' : 'ws';
+        const value = path.join(host, pathname);
+        return jsonResponse(res, 200, {
+            description: '',
+            devtoolsFrontendUrl: `/devtools/inspector.html?${param}=${value}`,
+            id,
+            title: 'New Tab',
+            type: 'page',
+            url: 'about:blank',
+            webSocketDebuggerUrl: href,
+        });
+    };
+}

package/build/{routes/chromium/http/json-protocol-get.js → shared/json-protocol.http.js}

@@ -1,15 +1,15 @@
 import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 export default class GetJSONVersion extends HTTPRoute {
+    cachedProtocol;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;
     concurrency = false;
     contentTypes = [contentTypes.json];
-    description = `Returns Protocol JSON meta-data that Chrome comes with.`;
+    description = `Returns Protocol JSON meta-data that Chrome and Chromium come with.`;
     method = Methods.get;
     path = HTTPRoutes.jsonProtocol;
     tags = [APITags.browserAPI];
-    cachedProtocol;
     handler = async (_req, res) => {
         const browserManager = this.browserManager();
         if (!this.cachedProtocol) {

package/build/{routes/chromium/http/json-version-get.js → shared/json-version.http.js}

@@ -1,21 +1,21 @@
 import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, writeResponse, } from '@browserless.io/browserless';
 export default class GetJSONVersion extends HTTPRoute {
+    cachedJSON;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;
     concurrency = false;
     contentTypes = [contentTypes.json];
-    description = `Returns a JSON payload that acts as a pass-through to the DevTools /json/version protocol in Chrome.`;
+    description = `Returns a JSON payload that acts as a pass-through to the DevTools /json/version protocol in Chrome and Chromium.`;
     method = Methods.get;
     path = HTTPRoutes.jsonVersion;
     tags = [APITags.browserAPI];
-    cachedJSON;
     handler = async (req, res) => {
         const baseUrl = req.parsed.host;
         const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
-        const browserManager = this.browserManager();
         try {
             if (!this.cachedJSON) {
+                const browserManager = this.browserManager();
                 this.cachedJSON = {
                     ...(await browserManager.getVersionJSON()),
                     webSocketDebuggerUrl: `${protocol}://${baseUrl}`,

package/build/shared/page.ws.d.ts

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

package/build/shared/page.ws.js

@@ -0,0 +1,13 @@
+import { APITags, BrowserWebsocketRoute, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
+export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+    auth = true;
+    browser = ChromiumCDP;
+    concurrency = false;
+    description = dedent(`Connect to an existing page in Chromium with a library like
+    chrome-remote-interface or others that work the page websocketDebugger
+    URL. You can get this unique URL by calling the /json/list API
+    or by finding the page's unique ID from your library of choice.`);
+    path = WebsocketRoutes.page;
+    tags = [APITags.browserWS];
+    handler = async (req, socket, head, browser) => browser.proxyPageWebSocket(req, socket, head);
+}

package/build/{routes/chromium/http/pdf-post.d.ts → shared/pdf.http.d.ts}

@@ -1,5 +1,5 @@
 /// <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 { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, 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 {
@@ -36,12 +36,12 @@ export type ResponseSchema = string;
 export default class PDFPost extends BrowserHTTPRoute {
     accepts: contentTypes[];
     auth: boolean;
-    browser: typeof CDPChromium;
+    browser: typeof ChromiumCDP;
     concurrency: boolean;
     contentTypes: contentTypes[];
     description: string;
     method: Methods;
-    path: HTTPRoutes;
+    path: HTTPRoutes[];
     tags: APITags[];
     handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
 }

package/build/{routes/chromium/http/pdf-post.js → shared/pdf.http.js}

@@ -1,9 +1,9 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
 import { Stream } from 'stream';
 export default class PDFPost extends BrowserHTTPRoute {
     accepts = [contentTypes.json];
     auth = true;
-    browser = CDPChromium;
+    browser = ChromiumCDP;
     concurrency = true;
     contentTypes = [contentTypes.pdf];
     description = dedent(`
@@ -13,7 +13,7 @@ export default class PDFPost extends BrowserHTTPRoute {
     selectors, timers and more.
   `);
     method = Methods.post;
-    path = HTTPRoutes.pdf;
+    path = [HTTPRoutes.pdf, HTTPRoutes.chromiumPdf];
     tags = [APITags.browserAPI];
     handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')

package/build/{routes/chromium/http/performance.d.ts → shared/performance.http.d.ts}

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

package/build/{routes/chromium/http/performance.js → shared/performance.http.js}

@@ -1,14 +1,14 @@
-import { APITags, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
-import main from '../utils/performance/main.js';
+import { APITags, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import main from './utils/performance/main.js';
 export default class PerformancePost extends BrowserHTTPRoute {
     accepts = [contentTypes.json];
     auth = true;
-    browser = CDPChromium;
+    browser = ChromiumCDP;
     concurrency = true;
     contentTypes = [contentTypes.json];
     description = `Run lighthouse performance audits with a supplied "url" in your JSON payload.`;
     method = Methods.post;
-    path = HTTPRoutes.performance;
+    path = [HTTPRoutes.performance, HTTPRoutes.chromiumPerformance];
     tags = [APITags.browserAPI];
     handler = async (req, res, browser) => {
         const config = this.config();

package/build/{routes/chromium/http/scrape-post.d.ts → shared/scrape.http.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, InBoundRequest, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Cookie, Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface BodySchema {
@@ -107,12 +107,12 @@ export interface ResponseSchema {
 export default class ScrapePost extends BrowserHTTPRoute {
     accepts: contentTypes[];
     auth: boolean;
-    browser: typeof CDPChromium;
+    browser: typeof ChromiumCDP;
     concurrency: boolean;
     contentTypes: contentTypes[];
     description: string;
     method: Methods;
-    path: HTTPRoutes;
+    path: HTTPRoutes[];
     tags: APITags[];
     handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
 }

package/build/{routes/chromium/http/scrape-post.js → shared/scrape.http.js}

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 const scrape = async (elements) => {
     const wait = (selector, timeout = 30000) => {
         return new Promise((resolve, reject) => {
@@ -42,7 +42,7 @@ const scrape = async (elements) => {
 export default class ScrapePost extends BrowserHTTPRoute {
     accepts = [contentTypes.json];
     auth = true;
-    browser = CDPChromium;
+    browser = ChromiumCDP;
     concurrency = true;
     contentTypes = [contentTypes.json];
     description = dedent(`
@@ -51,7 +51,7 @@ export default class ScrapePost extends BrowserHTTPRoute {
     property. Responds with an array of JSON objects.
   `);
     method = Methods.post;
-    path = HTTPRoutes.scrape;
+    path = [HTTPRoutes.scrape, HTTPRoutes.chromiumScrape];
     tags = [APITags.browserAPI];
     handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')

package/build/{routes/chromium/http/screenshot-post.d.ts → shared/screenshot.http.d.ts}

@@ -1,5 +1,5 @@
 /// <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 { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, 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 {
@@ -38,12 +38,12 @@ export interface BodySchema {
 export default class ScreenshotPost extends BrowserHTTPRoute {
     accepts: contentTypes[];
     auth: boolean;
-    browser: typeof CDPChromium;
+    browser: typeof ChromiumCDP;
     concurrency: boolean;
     contentTypes: contentTypes[];
     description: string;
     method: Methods;
-    path: HTTPRoutes;
+    path: HTTPRoutes[];
     tags: APITags[];
     handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
 }

package/build/{routes/chromium/http/screenshot-post.js → shared/screenshot.http.js}

@@ -1,9 +1,9 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 import Stream from 'stream';
 export default class ScreenshotPost extends BrowserHTTPRoute {
     accepts = [contentTypes.json];
     auth = true;
-    browser = CDPChromium;
+    browser = ChromiumCDP;
     concurrency = true;
     contentTypes = [contentTypes.png, contentTypes.jpeg, contentTypes.text];
     description = dedent(`
@@ -12,7 +12,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     cookies, user-agents, setting timers and network mocks.
   `);
     method = Methods.post;
-    path = HTTPRoutes.screenshot;
+    path = [HTTPRoutes.screenshot, HTTPRoutes.chromiumScreenshot];
     tags = [APITags.browserAPI];
     handler = async (req, res, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')

package/build/shared/utils/performance/child.d.ts

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

package/build/{routes/chromium → shared}/utils/performance/main.js

@@ -7,7 +7,7 @@ const DEFAULT_AUDIT_CONFIG = {
 const debug = createLogger('http:performance:main');
 export default async ({ browser, context, timeout, }) => {
     return new Promise((resolve, reject) => {
-        const childPath = path.join('./', 'build', 'routes', 'chromium', 'utils', 'performance', 'child.js');
+        const childPath = path.join('./', 'build', 'shared', 'utils', 'performance', 'child.js');
         debug(`Starting up child at ${childPath}`);
         const child = fork(childPath);
         const port = new URL(browser.wsEndpoint() || '').port;

package/build/shared/utils/performance/types.js

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

package/build/shim.js

@@ -22,7 +22,8 @@ export const shimLegacyRequests = (url) => {
         const headless = searchParams.get('headless') ?? launchParams.headless;
         if (typeof headless !== 'undefined' &&
             launchParams.headless === undefined) {
-            launchParams.headless = headless === 'shell' ? 'shell' : headless !== 'false';
+            launchParams.headless =
+                headless === 'shell' ? 'shell' : headless !== 'false';
         }
         if (typeof slowMo !== 'undefined' && launchParams.slowMo === undefined) {
             launchParams.slowMo = +slowMo;

package/build/types.d.ts

@@ -4,8 +4,9 @@
 /// <reference types="debug" />
 import * as http from 'http';
 import * as stream from 'stream';
-import { APITags, Browserless, CDPChromium, Config, HTTPManagementRoutes, HTTPRoutes, Methods, Metrics, PlaywrightChromium, PlaywrightFirefox, PlaywrightWebkit, Request, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
+import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Methods, Metrics, Request, WebkitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
 import { HTTPRequest, Page, ResponseForRequest, ScreenshotOptions } from 'puppeteer-core';
+export type PathTypes = HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 export interface BeforeRequest {
     head?: Buffer;
     req: Request;
@@ -18,7 +19,7 @@ export interface AfterResponse {
     status: 'successful' | 'error' | 'timedout';
 }
 export interface BrowserHook {
-    browser: CDPChromium | PlaywrightChromium | PlaywrightFirefox | PlaywrightWebkit;
+    browser: ChromiumCDP | ChromiumPlaywright | FirefoxPlaywright | WebkitPlaywright;
     meta: URL;
 }
 export interface PageHook {
@@ -33,8 +34,8 @@ export interface RouteParams {
 /**
  * The type of browser required to run this route or handler.
  */
-export type BrowserClasses = typeof CDPChromium | typeof PlaywrightChromium | typeof PlaywrightFirefox | typeof PlaywrightWebkit;
-export type BrowserInstance = CDPChromium | PlaywrightChromium | PlaywrightFirefox | PlaywrightWebkit;
+export type BrowserClasses = typeof ChromiumCDP | typeof ChromiumPlaywright | typeof FirefoxPlaywright | typeof WebkitPlaywright;
+export type BrowserInstance = ChromiumCDP | ChromiumPlaywright | FirefoxPlaywright | WebkitPlaywright;
 export interface BrowserJSON {
     Browser: string;
     'Protocol-Version': string;
@@ -129,9 +130,10 @@ declare abstract class Route {
      */
     monitoring: () => import("@browserless.io/browserless").Monitoring;
     /**
-     * The HTTP path that this route handles, eg '/my-route'
+     * The HTTP path that this route handles, eg '/my-route' OR an
+     * array of paths that this route can handle.
      */
-    abstract path: HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
+    abstract path: PathTypes | Array<PathTypes>;
     /**
      * The tag(s) for the route to categorize it in the
      * documentation portal
@@ -267,7 +269,7 @@ export interface BrowserlessSession {
     launchOptions: CDPLaunchOptions | BrowserServerOptions;
     numbConnected: number;
     resolver: (val: unknown) => void;
-    routePath: string;
+    routePath: string | string[];
     startedOn: number;
     ttl: number;
     userDataDir: string | null;
@@ -280,7 +282,7 @@ export interface BrowserlessSessionJSON {
     killURL: string | null;
     launchOptions: CDPLaunchOptions | BrowserServerOptions;
     numbConnected: number;
-    routePath: string;
+    routePath: string | string[];
     startedOn: number;
     timeAliveMs: number;
     userDataDir: string | null;

package/build/utils.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { CDPChromium, Config, PlaywrightChromium, PlaywrightFirefox, PlaywrightWebkit, Request, WaitForEventOptions, WaitForFunctionOptions, codes, contentTypes } from '@browserless.io/browserless';
+import { ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, Request, WaitForEventOptions, WaitForFunctionOptions, WebkitPlaywright, codes, contentTypes } from '@browserless.io/browserless';
 import { CDPSession } from 'playwright-core';
 import { Duplex } from 'stream';
 import { Page } from 'puppeteer-core';
@@ -13,7 +13,7 @@ export declare const jsonExtension = ".json";
 export declare const jsExtension = ".js";
 export declare const id: () => string;
 /**
- * Generates a random, Chrome-compliant page ID with "BLESS"
+ * Generates a random, Chromium-compliant page ID with "BLESS"
  * prepended. This prepended text signals to other parts of the
  * system that this is a Browserless-created ID so it can be appropriately
  * handled.
@@ -34,6 +34,11 @@ export declare const removeNullStringify: (json: unknown, allowNull?: boolean) =
 export declare const jsonOrString: (maybeJson: string) => unknown | string;
 export declare const generateDataDir: (sessionId: string | undefined, config: Config) => Promise<string>;
 export declare const readBody: (req: Request) => Promise<ReturnType<typeof safeParse>>;
+/**
+ * Lists the path of Chromes (stable) install since
+ * no library or utility out there does it including playwright.
+ */
+export declare const chromeExecutablePath: string;
 export declare const getRouteFiles: (config: Config) => Promise<string[][]>;
 export declare const make404: (...messages: string[]) => string;
 /**
@@ -61,7 +66,7 @@ export declare const exists: (path: string) => Promise<boolean>;
  */
 export declare const fileExists: (path: string) => Promise<boolean>;
 export declare const convertIfBase64: (item: string) => string;
-export declare const availableBrowsers: Promise<(typeof CDPChromium | typeof PlaywrightChromium | typeof PlaywrightFirefox | typeof PlaywrightWebkit)[]>;
+export declare const availableBrowsers: Promise<(typeof ChromiumCDP | typeof ChromiumPlaywright | typeof FirefoxPlaywright | typeof WebkitPlaywright)[]>;
 export declare const queryParamsToObject: (params: URLSearchParams) => Record<string, unknown>;
 export declare const waitForFunction: (page: Page, opts: WaitForFunctionOptions) => Promise<void>;
 export declare const waitForEvent: (page: Page, opts: WaitForEventOptions) => Promise<void>;

package/build/utils.js

@@ -1,5 +1,5 @@
 import * as fs from 'fs/promises';
-import { BLESS_PAGE_IDENTIFIER, CDPChromium, PlaywrightChromium, PlaywrightFirefox, PlaywrightWebkit, codes, contentTypes, encodings, encryptionAlgo, encryptionSep, } from '@browserless.io/browserless';
+import { BLESS_PAGE_IDENTIFIER, ChromeCDP, ChromePlaywright, ChromiumCDP, ChromiumPlaywright, FirefoxPlaywright, WebkitPlaywright, codes, contentTypes, encodings, encryptionAlgo, encryptionSep, } from '@browserless.io/browserless';
 import playwright from 'playwright-core';
 import crypto from 'crypto';
 import debug from 'debug';
@@ -27,7 +27,7 @@ export const jsonExtension = '.json';
 export const jsExtension = '.js';
 export const id = () => crypto.randomUUID();
 /**
- * Generates a random, Chrome-compliant page ID with "BLESS"
+ * Generates a random, Chromium-compliant page ID with "BLESS"
  * prepended. This prepended text signals to other parts of the
  * system that this is a Browserless-created ID so it can be appropriately
  * handled.
@@ -199,6 +199,15 @@ export const readBody = async (req) => {
         ? safeParse(body)
         : body;
 };
+/**
+ * Lists the path of Chromes (stable) install since
+ * no library or utility out there does it including playwright.
+ */
+export const chromeExecutablePath = process.platform === 'win32'
+    ? `%ProgramFiles%\\Google\\Chrome\\Application\\chrome.exe`
+    : process.platform === 'darwin'
+        ? '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
+        : '/usr/bin/google-chrome-stable';
 export const getRouteFiles = async (config) => {
     const routes = config.getRoutes();
     const foundRoutes = await fs
@@ -208,12 +217,12 @@ export const getRouteFiles = async (config) => {
         path.join(routes, d, 'http'),
     ]))
         .catch(() => []);
-    const [httpRouteFolders, wsRouteFolders] = foundRoutes.reduce(([http, ws], route) => {
-        if (route.endsWith('http')) {
-            http.push(route);
+    const [httpRouteFolders, wsRouteFolders] = foundRoutes.reduce(([http, ws], routePath) => {
+        if (routePath.endsWith('http')) {
+            http.push(routePath);
         }
-        if (route.endsWith('ws')) {
-            ws.push(route);
+        if (routePath.endsWith('ws')) {
+            ws.push(routePath);
         }
         return [http, ws];
     }, [[], []]);
@@ -291,16 +300,20 @@ export const availableBrowsers = Promise.all([
     exists(playwright.chromium.executablePath()),
     exists(playwright.firefox.executablePath()),
     exists(playwright.webkit.executablePath()),
-]).then(([chromeExists, firefoxExists, webkitExists]) => {
+    exists(chromeExecutablePath),
+]).then(([chromiumExists, firefoxExists, webkitExists, chromeExists]) => {
     const availableBrowsers = [];
+    if (chromiumExists) {
+        availableBrowsers.push(ChromiumCDP, ChromiumPlaywright);
+    }
     if (chromeExists) {
-        availableBrowsers.push(...[CDPChromium, PlaywrightChromium]);
+        availableBrowsers.push(ChromeCDP, ChromePlaywright);
     }
     if (firefoxExists) {
-        availableBrowsers.push(PlaywrightFirefox);
+        availableBrowsers.push(FirefoxPlaywright);
     }
     if (webkitExists) {
-        availableBrowsers.push(PlaywrightWebkit);
+        availableBrowsers.push(WebkitPlaywright);
     }
     return availableBrowsers;
 });

package/docker/base/Dockerfile

@@ -1,6 +1,6 @@
 FROM ubuntu:20.04
 
-LABEL org.opencontainers.image.source https://github.com/browserless/chrome
+LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 ARG DEBIAN_FRONTEND=noninteractive
 ARG TZ=America/Los_Angeles

package/docker/chrome/Dockerfile

@@ -1,12 +1,12 @@
 ARG VERSION=latest
 FROM ghcr.io/browserless/base:$VERSION
-LABEL org.opencontainers.image.source https://github.com/browserless/chrome
+LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
-COPY src/routes/chromium src/routes/chromium/
+COPY src/routes/chrome src/routes/chrome/
 
 RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true" | debconf-set-selections && \
   apt-get -y -qq install software-properties-common &&\
@@ -26,8 +26,8 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN npx --yes playwright install chromium &&\
-  npx --yes playwright install-deps chromium &&\
+RUN npx --yes playwright install chrome &&\
+  npx --yes playwright install-deps chrome &&\
   npm run build &&\
   npm run build:function &&\
   npm prune production &&\

package/docker/chromium/.dockerignore

@@ -0,0 +1,16 @@
+# Build Files
+node_modules/
+build/
+
+# Editor preferences
+.editorconfig
+.dockerignore
+.git/
+.no-git/
+.vscode/
+
+# ENV files
+*.env*
+
+# Other non-production dotfiles
+.eslintrc

package/docker/chromium/Dockerfile

@@ -0,0 +1,40 @@
+ARG VERSION=latest
+FROM ghcr.io/browserless/base:$VERSION
+LABEL org.opencontainers.image.source https://github.com/browserless/browserless
+
+COPY fonts/* /usr/share/fonts/truetype/
+COPY src src/
+RUN rm -r src/routes/
+COPY src/routes/management src/routes/management/
+COPY src/routes/chromium src/routes/chromium/
+
+RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true" | debconf-set-selections && \
+  apt-get -y -qq install software-properties-common &&\
+  apt-add-repository "deb http://archive.canonical.com/ubuntu $(lsb_release -sc) partner" && \
+  apt-get -y -qq --no-install-recommends install \
+    fontconfig \
+    fonts-freefont-ttf \
+    fonts-gfs-neohellenic \
+    fonts-indic \
+    fonts-ipafont-gothic \
+    fonts-kacst \
+    fonts-liberation \
+    fonts-noto-cjk \
+    fonts-noto-color-emoji \
+    fonts-roboto \
+    fonts-thai-tlwg \
+    fonts-ubuntu \
+    fonts-wqy-zenhei
+
+RUN npx --yes playwright install chromium &&\
+  npx --yes playwright install-deps chromium &&\
+  npm run build &&\
+  npm run build:function &&\
+  npm prune production &&\
+  chown -R blessuser:blessuser $APP_DIR &&\
+  fc-cache -f -v && \
+  apt-get -qq clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/fonts/truetype/noto
+
+USER blessuser
+
+CMD ["./scripts/start.sh"]

package/docker/firefox/Dockerfile

@@ -1,6 +1,6 @@
 ARG VERSION=latest
 FROM ghcr.io/browserless/base:$VERSION
-LABEL org.opencontainers.image.source https://github.com/browserless/chrome
+LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/