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

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

@@ -1,12 +1,8 @@
 {
-  "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"
@@ -16,6 +12,10 @@
         }
       ]
     },
+    "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,6 +29,7 @@
       "type": "string"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",
@@ -113,70 +114,6 @@
         }
       },
       "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/chromium/ws/browser.query.json

@@ -1,12 +1,8 @@
 {
-  "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"
@@ -16,6 +12,10 @@
         }
       ]
     },
+    "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,6 +29,7 @@
       "type": "string"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",
@@ -113,70 +114,6 @@
         }
       },
       "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/chromium/ws/cdp.query.json

@@ -1,12 +1,8 @@
 {
-  "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"
@@ -16,6 +12,10 @@
         }
       ]
     },
+    "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,6 +29,7 @@
       "type": "string"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",
@@ -113,70 +114,6 @@
         }
       },
       "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/chromium/ws/page.query.json

@@ -1,12 +1,8 @@
 {
-  "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"
@@ -16,6 +12,10 @@
         }
       ]
     },
+    "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,6 +29,7 @@
       "type": "string"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",
@@ -113,70 +114,6 @@
         }
       },
       "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/chromium/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/routes/firefox/ws/playwright.d.ts

@@ -9,7 +9,8 @@ export interface QuerySchema extends SystemQueryParameters {
         };
     };
 }
-export default class FirefoxPlayWrightRoute extends BrowserWebsocketRoute {
+export default class FirefoxPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
     auth: boolean;
     browser: typeof FirefoxPlaywright;
     concurrency: boolean;

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

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