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

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

@@ -1,4 +1,235 @@
 {
-  "type": "string",
+  "type": "array",
+  "items": {
+    "$ref": "#/definitions/BrowserlessSessionJSON"
+  },
+  "definitions": {
+    "BrowserlessSessionJSON": {
+      "type": "object",
+      "properties": {
+        "browser": {
+          "type": "string"
+        },
+        "browserId": {
+          "type": "string"
+        },
+        "id": {
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "initialConnectURL": {
+          "type": "string"
+        },
+        "killURL": {
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "launchOptions": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CDPLaunchOptions"
+            },
+            {
+              "$ref": "#/definitions/BrowserServerOptions"
+            }
+          ]
+        },
+        "numbConnected": {
+          "type": "number"
+        },
+        "routePath": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "startedOn": {
+          "type": "number"
+        },
+        "timeAliveMs": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": [
+            "null",
+            "string"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "browser",
+        "browserId",
+        "id",
+        "initialConnectURL",
+        "killURL",
+        "launchOptions",
+        "numbConnected",
+        "routePath",
+        "startedOn",
+        "timeAliveMs",
+        "userDataDir"
+      ]
+    },
+    "CDPLaunchOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "defaultViewport": {
+          "type": "object",
+          "properties": {
+            "deviceScaleFactor": {
+              "type": "number"
+            },
+            "hasTouch": {
+              "type": "boolean"
+            },
+            "height": {
+              "type": "number"
+            },
+            "isLandscape": {
+              "type": "boolean"
+            },
+            "isMobile": {
+              "type": "boolean"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "height",
+            "width"
+          ]
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "dumpio": {
+          "type": "boolean"
+        },
+        "headless": {
+          "enum": [
+            false,
+            "shell",
+            true
+          ]
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "ignoreHTTPSErrors": {
+          "type": "boolean"
+        },
+        "slowMo": {
+          "type": "number"
+        },
+        "stealth": {
+          "type": "boolean"
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": "string"
+        },
+        "waitForInitialPage": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "BrowserServerOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "chromiumSandbox": {
+          "type": "boolean"
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "downloadsPath": {
+          "type": "string"
+        },
+        "headless": {
+          "type": "boolean"
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "proxy": {
+          "type": "object",
+          "properties": {
+            "bypass": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "server": {
+              "type": "string"
+            },
+            "username": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "server"
+          ]
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "tracesDir": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

@@ -2,6 +2,7 @@
 import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export default class StaticGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

package/build/routes/management/http/static.get.js

@@ -1,4 +1,4 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, NotFound, contentTypes, fileExists, mimeTypes, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, NotFound, contentTypes, fileExists, mimeTypes, } from '@browserless.io/browserless';
 import { createReadStream } from 'fs';
 import path from 'path';
 const pathMap = new Map();
@@ -19,6 +19,7 @@ const streamFile = (debug, res, file, contentType) => new Promise((resolve, reje
         .pipe(res);
 });
 export default class StaticGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.StaticGetRoute;
     accepts = [contentTypes.any];
     auth = false;
     browser = null;

package/build/routes/webkit/ws/playwright.d.ts

@@ -5,7 +5,8 @@ import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: BrowserServerOptions | string;
 }
-export default class WebkitPlaywrightRoute extends BrowserWebsocketRoute {
+export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof WebkitPlaywright;
     concurrency: boolean;

package/build/routes/webkit/ws/playwright.js

@@ -1,5 +1,6 @@
-import { APITags, BadRequest, BrowserWebsocketRoute, WebkitPlaywright, WebsocketRoutes, } from '@browserless.io/browserless';
-export default class WebkitPlaywrightRoute extends BrowserWebsocketRoute {
+import { APITags, BadRequest, BrowserWebsocketRoute, BrowserlessRoutes, WebkitPlaywright, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.WebKitPlaywrightWebSocketRoute;
     auth = true;
     browser = WebkitPlaywright;
     concurrency = true;

package/build/routes/webkit/ws/playwright.query.json

@@ -1,21 +1,21 @@
 {
-  "additionalProperties": false,
   "type": "object",
   "properties": {
-    "blockAds": {
-      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
-      "type": "boolean"
-    },
     "launch": {
+      "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
       "anyOf": [
         {
-          "$ref": "#/definitions/CDPLaunchOptions"
+          "$ref": "#/definitions/BrowserServerOptions"
         },
         {
           "type": "string"
         }
       ]
     },
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
     "record": {
       "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
       "type": "boolean"
@@ -29,91 +29,8 @@
       "type": "string"
     }
   },
+  "additionalProperties": false,
   "definitions": {
-    "CDPLaunchOptions": {
-      "type": "object",
-      "properties": {
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "defaultViewport": {
-          "type": "object",
-          "properties": {
-            "deviceScaleFactor": {
-              "type": "number"
-            },
-            "hasTouch": {
-              "type": "boolean"
-            },
-            "height": {
-              "type": "number"
-            },
-            "isLandscape": {
-              "type": "boolean"
-            },
-            "isMobile": {
-              "type": "boolean"
-            },
-            "width": {
-              "type": "number"
-            }
-          },
-          "additionalProperties": false,
-          "required": [
-            "height",
-            "width"
-          ]
-        },
-        "devtools": {
-          "type": "boolean"
-        },
-        "dumpio": {
-          "type": "boolean"
-        },
-        "headless": {
-          "enum": [
-            false,
-            "shell",
-            true
-          ]
-        },
-        "ignoreDefaultArgs": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "boolean"
-            }
-          ]
-        },
-        "ignoreHTTPSErrors": {
-          "type": "boolean"
-        },
-        "slowMo": {
-          "type": "number"
-        },
-        "stealth": {
-          "type": "boolean"
-        },
-        "timeout": {
-          "type": "number"
-        },
-        "userDataDir": {
-          "type": "string"
-        },
-        "waitForInitialPage": {
-          "type": "boolean"
-        }
-      },
-      "additionalProperties": false
-    },
     "BrowserServerOptions": {
       "type": "object",
       "properties": {

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

@@ -5,7 +5,8 @@ import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+export default class ChromiumBrowserWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof ChromiumCDP;
     concurrency: boolean;

package/build/shared/browser.ws.js

@@ -1,5 +1,6 @@
-import { APITags, BrowserWebsocketRoute, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
-export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+import { APITags, BrowserWebsocketRoute, BrowserlessRoutes, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
+export default class ChromiumBrowserWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.ChromiumBrowserWebSocketRoute;
     auth = true;
     browser = ChromiumCDP;
     concurrency = true;

package/build/shared/chromium.playwright.ws.d.ts

@@ -5,7 +5,8 @@ import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: BrowserServerOptions | string;
 }
-export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof ChromiumPlaywright;
     concurrency: boolean;

package/build/shared/chromium.playwright.ws.js

@@ -1,5 +1,6 @@
-import { APITags, BadRequest, BrowserWebsocketRoute, ChromiumPlaywright, WebsocketRoutes, } from '@browserless.io/browserless';
-export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+import { APITags, BadRequest, BrowserWebsocketRoute, BrowserlessRoutes, ChromiumPlaywright, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.ChromiumPlaywrightWebSocketRoute;
     auth = true;
     browser = ChromiumPlaywright;
     concurrency = true;

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

@@ -5,7 +5,8 @@ import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-export default class ChromiumCDPRoute extends BrowserWebsocketRoute {
+export default class ChromiumCDPWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof ChromiumCDP;
     concurrency: boolean;

package/build/shared/chromium.ws.js

@@ -1,5 +1,6 @@
-import { APITags, BrowserWebsocketRoute, ChromiumCDP, WebsocketRoutes, } from '@browserless.io/browserless';
-export default class ChromiumCDPRoute extends BrowserWebsocketRoute {
+import { APITags, BrowserWebsocketRoute, BrowserlessRoutes, ChromiumCDP, WebsocketRoutes, } from '@browserless.io/browserless';
+export default class ChromiumCDPWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.ChromiumCDPWebSocketRoute;
     auth = true;
     browser = ChromiumCDP;
     concurrency = true;

package/build/shared/content.http.d.ts

@@ -32,7 +32,8 @@ export type ResponseSchema = string;
 export type QuerySchema = SystemQueryParameters & {
     launch?: CDPLaunchOptions | string;
 };
-export default class ContentPostRoute extends BrowserHTTPRoute {
+export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/content.http.js

@@ -1,5 +1,6 @@
-import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
-export default class ContentPostRoute extends BrowserHTTPRoute {
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumContentPostRoute;
     accepts = [contentTypes.json];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/download.http.d.ts

@@ -14,7 +14,8 @@ export interface QuerySchema extends SystemQueryParameters {
  * themselves, so there isn't a static response type for this API.
  */
 export type ResponseSchema = unknown;
-export default class DownloadPost extends BrowserHTTPRoute {
+export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/download.http.js

@@ -1,10 +1,11 @@
-import { APITags, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, NotFound, contentTypes, dedent, id, mimeTypes, once, sleep, } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, 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';
-export default class DownloadPost extends BrowserHTTPRoute {
+export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumDownloadPostRoute;
     accepts = [contentTypes.json, contentTypes.javascript];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/function.http.d.ts

@@ -16,7 +16,8 @@ export interface QuerySchema extends SystemQueryParameters {
  * by type (HTML data is "text/html", Objects are "application/json")
  */
 export type ResponseSchema = unknown;
-export default class FunctionPost extends BrowserHTTPRoute {
+export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/function.http.js

@@ -1,8 +1,9 @@
-import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, contentTypes, dedent, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, 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';
-export default class FunctionPost extends BrowserHTTPRoute {
+export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumFunctionPostRoute;
     accepts = [contentTypes.json, contentTypes.javascript];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/json-list.http.d.ts

@@ -1,6 +1,7 @@
 import { APITags, CDPJSONPayload, HTTPRoute, HTTPRoutes, Methods, Request, Response, contentTypes } from '@browserless.io/browserless';
 export type ResponseSchema = Array<CDPJSONPayload>;
-export default class GetJSONList extends HTTPRoute {
+export default class ChromiumJSONListGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

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

@@ -1,5 +1,6 @@
-import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, } from '@browserless.io/browserless';
-export default class GetJSONList extends HTTPRoute {
+import { APITags, BrowserlessRoutes, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, } from '@browserless.io/browserless';
+export default class ChromiumJSONListGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.ChromiumJSONListGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/shared/json-new.http.d.ts

@@ -1,6 +1,7 @@
 import { APITags, CDPJSONPayload, HTTPRoute, HTTPRoutes, Methods, Request, Response, contentTypes } from '@browserless.io/browserless';
 export type ResponseSchema = CDPJSONPayload;
-export default class GetJSONList extends HTTPRoute {
+export default class ChromiumJSONNewPutRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

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

@@ -1,6 +1,7 @@
-import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, pageID, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPRoute, HTTPRoutes, Methods, contentTypes, dedent, jsonResponse, pageID, } from '@browserless.io/browserless';
 import path from 'path';
-export default class GetJSONList extends HTTPRoute {
+export default class ChromiumJSONNewPutRoute extends HTTPRoute {
+    name = BrowserlessRoutes.ChromiumJSONNewPutRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/shared/json-protocol.http.d.ts

@@ -1,7 +1,8 @@
 import { APITags, HTTPRoute, HTTPRoutes, Methods, Request, Response, contentTypes } from '@browserless.io/browserless';
 export type ResponseSchema = object;
-export default class GetJSONVersion extends HTTPRoute {
+export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
     private cachedProtocol;
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

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

@@ -1,6 +1,7 @@
-import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
-export default class GetJSONVersion extends HTTPRoute {
+import { APITags, BrowserlessRoutes, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
     cachedProtocol;
+    name = BrowserlessRoutes.ChromiumJSONProtocolGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/shared/json-version.http.d.ts

@@ -1,7 +1,8 @@
 import { APITags, BrowserManager, HTTPRoute, HTTPRoutes, Methods, Request, Response, UnwrapPromise, contentTypes } from '@browserless.io/browserless';
 export type ResponseSchema = UnwrapPromise<ReturnType<BrowserManager['getVersionJSON']>>;
-export default class GetJSONVersion extends HTTPRoute {
+export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
     private cachedJSON;
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

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

@@ -1,6 +1,7 @@
-import { APITags, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, writeResponse, } from '@browserless.io/browserless';
-export default class GetJSONVersion extends HTTPRoute {
+import { APITags, BrowserlessRoutes, HTTPRoute, HTTPRoutes, Methods, contentTypes, jsonResponse, writeResponse, } from '@browserless.io/browserless';
+export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
     cachedJSON;
+    name = BrowserlessRoutes.ChromiumJSONVersionGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

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

@@ -5,7 +5,8 @@ import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
 }
-export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof ChromiumCDP;
     concurrency: boolean;

package/build/shared/page.ws.js

@@ -1,5 +1,6 @@
-import { APITags, BrowserWebsocketRoute, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
-export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+import { APITags, BrowserWebsocketRoute, BrowserlessRoutes, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
+export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.ChromiumPageWebSocketRoute;
     auth = true;
     browser = ChromiumCDP;
     concurrency = false;

package/build/shared/pdf.http.d.ts

@@ -33,7 +33,8 @@ export interface QuerySchema extends SystemQueryParameters {
  * Responds with an application/pdf content-type and a binary PDF
  */
 export type ResponseSchema = string;
-export default class PDFPost extends BrowserHTTPRoute {
+export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;