@browserless.io/browserless 2.24.0-beta-2 → 2.24.0-beta-4

package/build/config.d.ts

@@ -91,7 +91,7 @@ export declare class Config extends EventEmitter {
      * do AES encoding for saving things to disk and generating
      * secure links.
      */
-    getAESKey(): Buffer;
+    getAESKey(): Buffer<ArrayBuffer>;
     getMetricsJSONPath(): string;
     setPwVersions(versions: {
         [key: string]: string;

package/build/http.d.ts

@@ -151,6 +151,7 @@ export declare enum HTTPRoutes {
 export declare enum HTTPManagementRoutes {
     active = "/active?(/)",
     config = "/config?(/)",
+    meta = "/meta?(/)",
     metrics = "/metrics?(/)",
     metricsTotal = "/metrics/total?(/)",
     pressure = "/pressure?(/)",

package/build/http.js

@@ -117,6 +117,7 @@ export var HTTPManagementRoutes;
 (function (HTTPManagementRoutes) {
     HTTPManagementRoutes["active"] = "/active?(/)";
     HTTPManagementRoutes["config"] = "/config?(/)";
+    HTTPManagementRoutes["meta"] = "/meta?(/)";
     HTTPManagementRoutes["metrics"] = "/metrics?(/)";
     HTTPManagementRoutes["metricsTotal"] = "/metrics/total?(/)";
     HTTPManagementRoutes["pressure"] = "/pressure?(/)";

package/build/routes/chrome/http/content.post.body.json

@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14497": {
+                "__@toStringTag@14520": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14497",
+                "__@toStringTag@14520",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14497",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14535": {
+        "__@species@14558": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14535",
-        "__@toStringTag@14497",
+        "__@species@14558",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },

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

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@129779": {
+                "__@toStringTag@115575": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@129779",
+                "__@toStringTag@115575",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@129779": {
+        "__@toStringTag@115575": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@129779",
+        "__@toStringTag@115575",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@129817": {
+        "__@species@115613": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@129779": {
+        "__@toStringTag@115575": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@129817",
-        "__@toStringTag@129779",
+        "__@species@115613",
+        "__@toStringTag@115575",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/scrape.post.body.json

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@144367": {
+                "__@toStringTag@144808": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@144367",
+                "__@toStringTag@144808",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@144367": {
+        "__@toStringTag@144808": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@144367",
+        "__@toStringTag@144808",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@144405": {
+        "__@species@144846": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@144367": {
+        "__@toStringTag@144808": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@144405",
-        "__@toStringTag@144367",
+        "__@species@144846",
+        "__@toStringTag@144808",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/screenshot.post.body.json

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@159032": {
+                "__@toStringTag@130197": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@159032",
+                "__@toStringTag@130197",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@159032": {
+        "__@toStringTag@130197": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@159032",
+        "__@toStringTag@130197",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@159070": {
+        "__@species@130235": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@159032": {
+        "__@toStringTag@130197": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@159070",
-        "__@toStringTag@159032",
+        "__@species@130235",
+        "__@toStringTag@130197",
         "byteLength"
       ]
     },

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

@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@187970": {
+                "__@toStringTag@173883": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@187970",
+                "__@toStringTag@173883",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@187970": {
+        "__@toStringTag@173883": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@187970",
+        "__@toStringTag@173883",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@188008": {
+        "__@species@173921": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@187970": {
+        "__@toStringTag@173883": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@188008",
-        "__@toStringTag@187970",
+        "__@species@173921",
+        "__@toStringTag@173883",
         "byteLength"
       ]
     },

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

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@260090": {
+                "__@toStringTag@260481": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@260090",
+                "__@toStringTag@260481",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@260090": {
+        "__@toStringTag@260481": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@260090",
+        "__@toStringTag@260481",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@260128": {
+        "__@species@260519": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@260090": {
+        "__@toStringTag@260481": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@260128",
-        "__@toStringTag@260090",
+        "__@species@260519",
+        "__@toStringTag@260481",
         "byteLength"
       ]
     },

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

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@289088": {
+                "__@toStringTag@289525": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@289088",
+                "__@toStringTag@289525",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@289088": {
+        "__@toStringTag@289525": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@289088",
+        "__@toStringTag@289525",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@289126": {
+        "__@species@289563": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@289088": {
+        "__@toStringTag@289525": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@289126",
-        "__@toStringTag@289088",
+        "__@species@289563",
+        "__@toStringTag@289525",
         "byteLength"
       ]
     },

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

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@318112": {
+                "__@toStringTag@304210": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@318112",
+                "__@toStringTag@304210",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@318112": {
+        "__@toStringTag@304210": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@318112",
+        "__@toStringTag@304210",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@318150": {
+        "__@species@304248": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@318112": {
+        "__@toStringTag@304210": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@318150",
-        "__@toStringTag@318112",
+        "__@species@304248",
+        "__@toStringTag@304210",
         "byteLength"
       ]
     },

package/build/routes/management/http/meta.get.d.ts

@@ -0,0 +1,41 @@
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
+export interface ResponseSchema {
+    /**
+     * The semantic version of the Browserless API
+     */
+    version: string;
+    /**
+     * The version of Chromium installed, or null if not installed
+     */
+    chromium: string | null;
+    /**
+     * The version of Webkit installed, or null if not installed
+     */
+    webkit: string | null;
+    /**
+     * The version of Firefox installed, or null if not installed
+     */
+    firefox: string | null;
+    /**
+     * The supported version(s) of puppeteer
+     */
+    playwright: string[];
+    /**
+     * The supported version(s) of playwright
+     */
+    puppeteer: string[];
+}
+export default class MetaGetRoute extends HTTPRoute {
+    name: string;
+    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/meta.get.js

@@ -0,0 +1,40 @@
+import { APITags, BrowserlessRoutes, ChromiumCDP, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoute, Methods, WebKitPlaywright, availableBrowsers, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { createRequire } from 'module';
+const semverReg = /(\*|\^|>|=|<|~)/gi;
+const require = createRequire(import.meta.url);
+const blessPackageJSON = require('../../../../package.json');
+const { browsers } = require('../../../../node_modules/playwright-core/browsers.json');
+const chromium = browsers.find((b) => b.name === 'chromium').browserVersion;
+const firefox = browsers.find((b) => b.name === 'firefox').browserVersion;
+const webkit = browsers.find((b) => b.name === 'webkit').browserVersion;
+const playwrightCore = blessPackageJSON.dependencies['playwright-core'].replace(semverReg, '');
+const puppeteer = blessPackageJSON.dependencies['puppeteer-core'].replace(semverReg, '');
+const playwright = Object.entries(blessPackageJSON.playwrightVersions)
+    .map(([, v]) => blessPackageJSON.dependencies[v])
+    .filter((_) => !!_)
+    .map((v) => v.match(/[0-9.]+/g).join(''))
+    .concat(playwrightCore);
+export default class MetaGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.MetaGetRoute;
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Returns a JSON payload of the current system versions, including the core API version.`;
+    method = Methods.get;
+    path = HTTPManagementRoutes.meta;
+    tags = [APITags.management];
+    async handler(_req, res) {
+        const installedBrowsers = await availableBrowsers;
+        const response = {
+            version: blessPackageJSON.version,
+            chromium: installedBrowsers.includes(ChromiumCDP) ? chromium : null,
+            firefox: installedBrowsers.includes(FirefoxPlaywright) ? firefox : null,
+            webkit: installedBrowsers.includes(WebKitPlaywright) ? webkit : null,
+            playwright: [...new Set(playwright)],
+            puppeteer: [puppeteer],
+        };
+        return jsonResponse(res, 200, response);
+    }
+}

package/build/routes/management/http/meta.get.response.json

@@ -0,0 +1,54 @@
+{
+  "type": "object",
+  "properties": {
+    "version": {
+      "description": "The semantic version of the Browserless API",
+      "type": "string"
+    },
+    "chromium": {
+      "description": "The version of Chromium installed, or null if not installed",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "webkit": {
+      "description": "The version of Webkit installed, or null if not installed",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "firefox": {
+      "description": "The version of Firefox installed, or null if not installed",
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "playwright": {
+      "description": "The supported version(s) of puppeteer",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "puppeteer": {
+      "description": "The supported version(s) of playwright",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "chromium",
+    "firefox",
+    "playwright",
+    "puppeteer",
+    "version",
+    "webkit"
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/management/tests/management.spec.js

@@ -17,6 +17,13 @@ describe('Management APIs', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('allows requests to /meta', async () => {
+        await start();
+        await fetch('http://localhost:3000/meta?token=6R0W53R135510').then(async (res) => {
+            expect(res.headers.get('content-type')).to.equal('application/json; charset=UTF-8');
+            expect(res.status).to.equal(200);
+        });
+    });
     it('allows requests to /metrics', async () => {
         await start();
         await fetch('http://localhost:3000/metrics?token=6R0W53R135510').then(async (res) => {

package/build/shared/utils/function/handler.js

@@ -1,4 +1,4 @@
-import { BadRequest, HTTPRoutes, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
+import { BadRequest, HTTPRoutes, ServerError, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
 import fs from 'fs';
 import path from 'path';
 export default (config, logger, options = {}) => async (req, browser) => {
@@ -17,7 +17,7 @@ export default (config, logger, options = {}) => async (req, browser) => {
     const code = convertIfBase64(rawCode);
     const browserWSEndpoint = browser.publicWSEndpoint(getTokenFromRequest(req) ?? '');
     if (!browserWSEndpoint) {
-        throw new Error(`No browser endpoint was found, is the browser running?`);
+        throw new ServerError(`No browser endpoint was found, is the browser running?`);
     }
     const functionCodeJS = `browserless-function-${id()}.js`;
     const page = (await browser.newPage());

package/build/types.d.ts

@@ -520,6 +520,7 @@ export declare const BrowserlessWebKitRoutes: {
 export declare const BrowserlessManagementRoutes: {
     ActiveGetRoute: string;
     ConfigGetRoute: string;
+    MetaGetRoute: string;
     MetricsGetRoute: string;
     MetricsTotalGetRoute: string;
     PressureGetRoute: string;
@@ -529,6 +530,7 @@ export declare const BrowserlessManagementRoutes: {
 export declare const BrowserlessRoutes: {
     ActiveGetRoute: string;
     ConfigGetRoute: string;
+    MetaGetRoute: string;
     MetricsGetRoute: string;
     MetricsTotalGetRoute: string;
     PressureGetRoute: string;

package/build/types.js

@@ -190,6 +190,7 @@ export const BrowserlessWebKitRoutes = {
 export const BrowserlessManagementRoutes = {
     ActiveGetRoute: 'ActiveGetRoute',
     ConfigGetRoute: 'ConfigGetRoute',
+    MetaGetRoute: 'MetaGetRoute',
     MetricsGetRoute: 'MetricsGetRoute',
     MetricsTotalGetRoute: 'MetricsTotalGetRoute',
     PressureGetRoute: 'PressureGetRoute',