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

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

@@ -26,6 +26,15 @@
         "$ref": "#/definitions/CookieParam"
       }
     },
+    "debugOpts": {
+      "$ref": "#/definitions/ScrapeDebugOptions"
+    },
+    "elements": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/ScrapeElementSelector"
+      }
+    },
     "emulateMediaType": {
       "type": "string"
     },
@@ -92,7 +101,6 @@
       "$ref": "#/definitions/Record<string,string>"
     },
     "setJavaScriptEnabled": {
-      "description": "Whether or not to allow JavaScript to run on the page.",
       "type": "boolean"
     },
     "url": {
@@ -169,6 +177,9 @@
     }
   },
   "additionalProperties": false,
+  "required": [
+    "elements"
+  ],
   "definitions": {
     "FrameAddScriptTagOptions": {
       "type": "object",
@@ -308,6 +319,42 @@
         "value"
       ]
     },
+    "ScrapeDebugOptions": {
+      "type": "object",
+      "properties": {
+        "console": {
+          "type": "boolean"
+        },
+        "cookies": {
+          "type": "boolean"
+        },
+        "html": {
+          "type": "boolean"
+        },
+        "network": {
+          "type": "boolean"
+        },
+        "screenshot": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ScrapeElementSelector": {
+      "type": "object",
+      "properties": {
+        "selector": {
+          "type": "string"
+        },
+        "timeout": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "selector"
+      ]
+    },
     "GoToOptions": {
       "type": "object",
       "properties": {
@@ -394,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@298790": {
+                "__@toStringTag@206584": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@298790",
+                "__@toStringTag@206584",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@298790": {
+        "__@toStringTag@206584": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@298790",
+        "__@toStringTag@206584",
         "byteLength"
       ]
     },
@@ -452,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@302943": {
+        "__@species@206685": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@298790": {
+        "__@toStringTag@206584": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@302943",
-        "__@toStringTag@298790",
+        "__@species@206685",
+        "__@toStringTag@206584",
         "byteLength"
       ]
     },

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

@@ -1,5 +1,309 @@
 {
   "description": "The JSON response body",
-  "type": "string",
+  "type": "object",
+  "properties": {
+    "data": {
+      "anyOf": [
+        {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "results": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "attributes": {
+                      "description": "A list of HTML attributes of the element",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "description": "The name of the HTML attribute for the element",
+                            "type": "string"
+                          },
+                          "value": {
+                            "description": "The value of the HTML attribute for the element",
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": false,
+                        "required": [
+                          "name",
+                          "value"
+                        ]
+                      }
+                    },
+                    "height": {
+                      "description": "The height the element",
+                      "type": "number"
+                    },
+                    "html": {
+                      "description": "The HTML the element",
+                      "type": "string"
+                    },
+                    "left": {
+                      "description": "The amount of pixels from the left of the page",
+                      "type": "number"
+                    },
+                    "text": {
+                      "description": "The text the element",
+                      "type": "string"
+                    },
+                    "top": {
+                      "description": "The amount of pixels from the top of the page",
+                      "type": "number"
+                    },
+                    "width": {
+                      "description": "The width the element",
+                      "type": "number"
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "attributes",
+                    "height",
+                    "html",
+                    "left",
+                    "text",
+                    "top",
+                    "width"
+                  ]
+                }
+              },
+              "selector": {
+                "description": "The DOM selector of the element",
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "results",
+              "selector"
+            ]
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "debug": {
+      "description": "When debugOpts options are present, results are here",
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "console": {
+              "description": "A list of console messages from the browser",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "cookies": {
+              "description": "List of cookies for the site or null",
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/definitions/Cookie"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "html": {
+              "description": "The HTML string of the website or null",
+              "type": [
+                "null",
+                "string"
+              ]
+            },
+            "network": {
+              "type": "object",
+              "properties": {
+                "inbound": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/definitions/InBoundRequest"
+                  }
+                },
+                "outbound": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/definitions/OutBoundRequest"
+                  }
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "inbound",
+                "outbound"
+              ]
+            },
+            "screenshot": {
+              "description": "A base64-encoded string of the site or null",
+              "type": [
+                "null",
+                "string"
+              ]
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "console",
+            "cookies",
+            "html",
+            "network",
+            "screenshot"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "data",
+    "debug"
+  ],
+  "definitions": {
+    "Cookie": {
+      "description": "Represents a cookie object.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "Cookie name.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Cookie value.",
+          "type": "string"
+        },
+        "domain": {
+          "description": "Cookie domain.",
+          "type": "string"
+        },
+        "path": {
+          "description": "Cookie path.",
+          "type": "string"
+        },
+        "expires": {
+          "description": "Cookie expiration date as the number of seconds since the UNIX epoch. Set to `-1` for\nsession cookies",
+          "type": "number"
+        },
+        "size": {
+          "description": "Cookie size.",
+          "type": "number"
+        },
+        "httpOnly": {
+          "description": "True if cookie is http-only.",
+          "type": "boolean"
+        },
+        "secure": {
+          "description": "True if cookie is secure.",
+          "type": "boolean"
+        },
+        "session": {
+          "description": "True in case of session cookie.",
+          "type": "boolean"
+        },
+        "sameSite": {
+          "description": "Cookie SameSite type.",
+          "enum": [
+            "Lax",
+            "None",
+            "Strict"
+          ],
+          "type": "string"
+        },
+        "priority": {
+          "description": "Cookie Priority. Supported only in Chrome.",
+          "enum": [
+            "High",
+            "Low",
+            "Medium"
+          ],
+          "type": "string"
+        },
+        "sameParty": {
+          "description": "True if cookie is SameParty. Supported only in Chrome.",
+          "type": "boolean"
+        },
+        "sourceScheme": {
+          "description": "Cookie source scheme type. Supported only in Chrome.",
+          "enum": [
+            "NonSecure",
+            "Secure",
+            "Unset"
+          ],
+          "type": "string"
+        },
+        "partitionKey": {
+          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
+          "type": "string"
+        },
+        "partitionKeyOpaque": {
+          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "domain",
+        "expires",
+        "httpOnly",
+        "name",
+        "path",
+        "secure",
+        "session",
+        "size",
+        "value"
+      ]
+    },
+    "InBoundRequest": {
+      "type": "object",
+      "properties": {
+        "headers": {},
+        "status": {
+          "type": "number"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "headers",
+        "status",
+        "url"
+      ]
+    },
+    "OutBoundRequest": {
+      "type": "object",
+      "properties": {
+        "headers": {},
+        "method": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "headers",
+        "method",
+        "url"
+      ]
+    }
+  },
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

@@ -35,6 +35,9 @@
     "html": {
       "type": "string"
     },
+    "options": {
+      "$ref": "#/definitions/ScreenshotOptions"
+    },
     "rejectRequestPattern": {
       "type": "array",
       "items": {
@@ -88,11 +91,16 @@
         ]
       }
     },
+    "scrollPage": {
+      "type": "boolean"
+    },
+    "selector": {
+      "type": "string"
+    },
     "setExtraHTTPHeaders": {
       "$ref": "#/definitions/Record<string,string>"
     },
     "setJavaScriptEnabled": {
-      "description": "Whether or not to allow JavaScript to run on the page.",
       "type": "boolean"
     },
     "url": {
@@ -355,6 +363,88 @@
       ],
       "type": "string"
     },
+    "ScreenshotOptions": {
+      "type": "object",
+      "properties": {
+        "optimizeForSpeed": {
+          "type": "boolean"
+        },
+        "type": {
+          "enum": [
+            "jpeg",
+            "png",
+            "webp"
+          ],
+          "type": "string"
+        },
+        "quality": {
+          "description": "Quality of the image, between 0-100. Not applicable to `png` images.",
+          "type": "number"
+        },
+        "fromSurface": {
+          "description": "Capture the screenshot from the surface, rather than the view.",
+          "type": "boolean"
+        },
+        "fullPage": {
+          "description": "When `true`, takes a screenshot of the full page.",
+          "type": "boolean"
+        },
+        "omitBackground": {
+          "description": "Hides default white background and allows capturing screenshots with transparency.",
+          "type": "boolean"
+        },
+        "path": {
+          "description": "The file path to save the image to. The screenshot type will be inferred\nfrom file extension. If path is a relative path, then it is resolved\nrelative to current working directory. If no path is provided, the image\nwon't be saved to the disk.",
+          "type": "string"
+        },
+        "clip": {
+          "description": "Specifies the region of the page to clip.",
+          "$ref": "#/definitions/ScreenshotClip"
+        },
+        "encoding": {
+          "description": "Encoding of the image.",
+          "enum": [
+            "base64",
+            "binary"
+          ],
+          "type": "string"
+        },
+        "captureBeyondViewport": {
+          "description": "Capture the screenshot beyond the viewport.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ScreenshotClip": {
+      "type": "object",
+      "properties": {
+        "scale": {
+          "type": "number"
+        },
+        "width": {
+          "description": "the width of the element in pixels.",
+          "type": "number"
+        },
+        "height": {
+          "description": "the height of the element in pixels.",
+          "type": "number"
+        },
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "height",
+        "width",
+        "x",
+        "y"
+      ]
+    },
     "Partial<ResponseForRequest>": {
       "type": "object",
       "properties": {
@@ -394,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@268553": {
+                "__@toStringTag@239597": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@268553",
+                "__@toStringTag@239597",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@268553": {
+        "__@toStringTag@239597": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@268553",
+        "__@toStringTag@239597",
         "byteLength"
       ]
     },
@@ -452,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@272705": {
+        "__@species@239698": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@268553": {
+        "__@toStringTag@239597": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@272705",
-        "__@toStringTag@268553",
+        "__@species@239698",
+        "__@toStringTag@239597",
         "byteLength"
       ]
     },