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

package/build/routes/chrome/http/json-list.get.response.json

@@ -1,4 +1,52 @@
 {
-  "type": "string",
+  "type": "array",
+  "items": {
+    "$ref": "#/definitions/CDPJSONPayload"
+  },
+  "definitions": {
+    "CDPJSONPayload": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "description": "The description of the target. Generally the page's title.",
+          "type": "string"
+        },
+        "devtoolsFrontendUrl": {
+          "description": "The fully-qualified URL of the Devtools inspector app.",
+          "type": "string"
+        },
+        "id": {
+          "description": "A Unique Id for the underlying target.",
+          "type": "string"
+        },
+        "title": {
+          "description": "The title of the target. For pages this is the page's title.",
+          "type": "string"
+        },
+        "type": {
+          "description": "The type of target, generally \"page\" or \"background_page\".",
+          "type": "string"
+        },
+        "url": {
+          "description": "The current URL the target is consuming or visiting.",
+          "type": "string"
+        },
+        "webSocketDebuggerUrl": {
+          "description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "description",
+        "devtoolsFrontendUrl",
+        "id",
+        "title",
+        "type",
+        "url",
+        "webSocketDebuggerUrl"
+      ]
+    }
+  },
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/chrome/http/json-new.put.d.ts

@@ -1 +1,5 @@
-export { default, ResponseSchema } from '../../../shared/json-new.http.js';
+export { ResponseSchema } from '../../../shared/json-new.http.js';
+import { default as ChromiumJSONNewPutRoute } from '../../../shared/json-new.http.js';
+export default class ChromeJSONNewPutRoute extends ChromiumJSONNewPutRoute {
+    name: string;
+}

package/build/routes/chrome/http/json-new.put.js

@@ -1 +1,5 @@
-export { default } from '../../../shared/json-new.http.js';
+import { BrowserlessRoutes } from '@browserless.io/browserless';
+import { default as ChromiumJSONNewPutRoute } from '../../../shared/json-new.http.js';
+export default class ChromeJSONNewPutRoute extends ChromiumJSONNewPutRoute {
+    name = BrowserlessRoutes.ChromeJSONNewPutRoute;
+}

package/build/routes/chrome/http/json-new.put.response.json

@@ -1,4 +1,44 @@
 {
-  "type": "string",
+  "type": "object",
+  "properties": {
+    "description": {
+      "description": "The description of the target. Generally the page's title.",
+      "type": "string"
+    },
+    "devtoolsFrontendUrl": {
+      "description": "The fully-qualified URL of the Devtools inspector app.",
+      "type": "string"
+    },
+    "id": {
+      "description": "A Unique Id for the underlying target.",
+      "type": "string"
+    },
+    "title": {
+      "description": "The title of the target. For pages this is the page's title.",
+      "type": "string"
+    },
+    "type": {
+      "description": "The type of target, generally \"page\" or \"background_page\".",
+      "type": "string"
+    },
+    "url": {
+      "description": "The current URL the target is consuming or visiting.",
+      "type": "string"
+    },
+    "webSocketDebuggerUrl": {
+      "description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "description",
+    "devtoolsFrontendUrl",
+    "id",
+    "title",
+    "type",
+    "url",
+    "webSocketDebuggerUrl"
+  ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/chrome/http/json-protocol.get.d.ts

@@ -1 +1,5 @@
-export { default, ResponseSchema } from '../../../shared/json-protocol.http.js';
+export { ResponseSchema } from '../../../shared/json-protocol.http.js';
+import { default as ChromiumJSONProtocolGetRoute } from '../../../shared/json-protocol.http.js';
+export default class ChromeJSONProtocolGetRoute extends ChromiumJSONProtocolGetRoute {
+    name: string;
+}

package/build/routes/chrome/http/json-protocol.get.js

@@ -1 +1,5 @@
-export { default } from '../../../shared/json-protocol.http.js';
+import { BrowserlessRoutes } from '@browserless.io/browserless';
+import { default as ChromiumJSONProtocolGetRoute } from '../../../shared/json-protocol.http.js';
+export default class ChromeJSONProtocolGetRoute extends ChromiumJSONProtocolGetRoute {
+    name = BrowserlessRoutes.ChromeJSONProtocolGetRoute;
+}

package/build/routes/chrome/http/json-protocol.get.response.json

@@ -1,4 +1,6 @@
 {
-  "type": "string",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": true,
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/chrome/http/json-version.get.d.ts

@@ -1 +1,5 @@
-export { default, ResponseSchema } from '../../../shared/json-version.http.js';
+export { ResponseSchema } from '../../../shared/json-version.http.js';
+import { default as ChromiumJSONVersionGetRoute } from '../../../shared/json-version.http.js';
+export default class ChromeJSONVersionGetRoute extends ChromiumJSONVersionGetRoute {
+    name: string;
+}

package/build/routes/chrome/http/json-version.get.js

@@ -1 +1,5 @@
-export { default } from '../../../shared/json-version.http.js';
+import { BrowserlessRoutes } from '@browserless.io/browserless';
+import { default as ChromiumJSONVersionGetRoute } from '../../../shared/json-version.http.js';
+export default class ChromeJSONVersionGetRoute extends ChromiumJSONVersionGetRoute {
+    name = BrowserlessRoutes.ChromeJSONVersionGetRoute;
+}

package/build/routes/chrome/http/json-version.get.response.json

@@ -1,4 +1,44 @@
 {
-  "type": "string",
+  "type": "object",
+  "properties": {
+    "description": {
+      "description": "The description of the target. Generally the page's title.",
+      "type": "string"
+    },
+    "devtoolsFrontendUrl": {
+      "description": "The fully-qualified URL of the Devtools inspector app.",
+      "type": "string"
+    },
+    "id": {
+      "description": "A Unique Id for the underlying target.",
+      "type": "string"
+    },
+    "title": {
+      "description": "The title of the target. For pages this is the page's title.",
+      "type": "string"
+    },
+    "type": {
+      "description": "The type of target, generally \"page\" or \"background_page\".",
+      "type": "string"
+    },
+    "url": {
+      "description": "The current URL the target is consuming or visiting.",
+      "type": "string"
+    },
+    "webSocketDebuggerUrl": {
+      "description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "description",
+    "devtoolsFrontendUrl",
+    "id",
+    "title",
+    "type",
+    "url",
+    "webSocketDebuggerUrl"
+  ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

@@ -20,6 +20,9 @@
       "description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
       "type": "boolean"
     },
+    "blockModals": {
+      "type": "boolean"
+    },
     "cookies": {
       "type": "array",
       "items": {
@@ -35,6 +38,9 @@
     "html": {
       "type": "string"
     },
+    "options": {
+      "$ref": "#/definitions/PDFOptions"
+    },
     "rejectRequestPattern": {
       "type": "array",
       "items": {
@@ -92,7 +98,6 @@
       "$ref": "#/definitions/Record<string,string>"
     },
     "setJavaScriptEnabled": {
-      "description": "Whether or not to allow JavaScript to run on the page.",
       "type": "boolean"
     },
     "url": {
@@ -355,6 +360,145 @@
       ],
       "type": "string"
     },
+    "PDFOptions": {
+      "description": "Valid options to configure PDF generation via {@link Page.pdf}.",
+      "type": "object",
+      "properties": {
+        "scale": {
+          "description": "Scales the rendering of the web page. Amount must be between `0.1` and `2`.",
+          "type": "number"
+        },
+        "displayHeaderFooter": {
+          "description": "Whether to show the header and footer.",
+          "type": "boolean"
+        },
+        "headerTemplate": {
+          "description": "HTML template for the print header. Should be valid HTML with the following\nclasses used to inject values into them:\n\n- `date` formatted print date\n\n- `title` document title\n\n- `url` document location\n\n- `pageNumber` current page number\n\n- `totalPages` total pages in the document",
+          "type": "string"
+        },
+        "footerTemplate": {
+          "description": "HTML template for the print footer. Has the same constraints and support\nfor special classes as {@link PDFOptionsPDFOptions.headerTemplate}.",
+          "type": "string"
+        },
+        "printBackground": {
+          "description": "Set to `true` to print background graphics.",
+          "type": "boolean"
+        },
+        "landscape": {
+          "description": "Whether to print in landscape orientation.",
+          "type": "boolean"
+        },
+        "pageRanges": {
+          "description": "Paper ranges to print, e.g. `1-5, 8, 11-13`.",
+          "type": "string"
+        },
+        "format": {
+          "description": "All the valid paper format types when printing a PDF.",
+          "enum": [
+            "A0",
+            "A1",
+            "A2",
+            "A3",
+            "A4",
+            "A5",
+            "A6",
+            "LEDGER",
+            "LEGAL",
+            "LETTER",
+            "Ledger",
+            "Legal",
+            "Letter",
+            "TABLOID",
+            "Tabloid",
+            "a0",
+            "a1",
+            "a2",
+            "a3",
+            "a4",
+            "a5",
+            "a6",
+            "ledger",
+            "legal",
+            "letter",
+            "tabloid"
+          ],
+          "type": "string"
+        },
+        "width": {
+          "description": "Sets the width of paper. You can pass in a number or a string with a unit.",
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "height": {
+          "description": "Sets the height of paper. You can pass in a number or a string with a unit.",
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "preferCSSPageSize": {
+          "description": "Give any CSS `@page` size declared in the page priority over what is\ndeclared in the `width` or `height` or `format` option.",
+          "type": "boolean"
+        },
+        "margin": {
+          "description": "Set the PDF margins.",
+          "$ref": "#/definitions/PDFMargin"
+        },
+        "path": {
+          "description": "The path to save the file to.",
+          "type": "string"
+        },
+        "omitBackground": {
+          "description": "Hides default white background and allows generating pdfs with transparency.",
+          "type": "boolean"
+        },
+        "tagged": {
+          "description": "Generate tagged (accessible) PDF.",
+          "type": "boolean"
+        },
+        "outline": {
+          "description": "Generate document outline.",
+          "type": "boolean"
+        },
+        "timeout": {
+          "description": "Timeout in milliseconds. Pass `0` to disable timeout.",
+          "type": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "PDFMargin": {
+      "type": "object",
+      "properties": {
+        "top": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "bottom": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "left": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "right": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "Partial<ResponseForRequest>": {
       "type": "object",
       "properties": {
@@ -394,14 +538,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@101779": {
+                "__@toStringTag@86180": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@101779",
+                "__@toStringTag@86180",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +580,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@101779": {
+        "__@toStringTag@86180": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@101779",
+        "__@toStringTag@86180",
         "byteLength"
       ]
     },
@@ -452,18 +596,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@105934": {
+        "__@species@86281": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@101779": {
+        "__@toStringTag@86180": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@105934",
-        "__@toStringTag@101779",
+        "__@species@86281",
+        "__@toStringTag@86180",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/pdf.post.d.ts

@@ -1,6 +1,7 @@
 import { BodySchema, default as PDF, QuerySchema, ResponseSchema } from '../../../shared/pdf.http.js';
 import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
-export default class ChromePDF extends PDF {
+export default class ChromePDFPostRoute extends PDF {
+    name: string;
     browser: typeof ChromeCDP;
     path: HTTPRoutes[];
 }

package/build/routes/chrome/http/pdf.post.js

@@ -1,6 +1,7 @@
 import { default as PDF, } from '../../../shared/pdf.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
-export default class ChromePDF extends PDF {
+import { BrowserlessRoutes, ChromeCDP, HTTPRoutes, } from '@browserless.io/browserless';
+export default class ChromePDFPostRoute extends PDF {
+    name = BrowserlessRoutes.ChromePDFPostRoute;
     browser = ChromeCDP;
     path = [HTTPRoutes.chromePdf];
 }

package/build/routes/chrome/http/pdf.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#"