@browserless.io/browserless 2.24.3 → 2.25.0

package/build/routes/edge/http/scrape.post.query.json

@@ -0,0 +1,183 @@
+{
+  "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": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CDPLaunchOptions"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    },
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
+    }
+  },
+  "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": {
+        "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/edge/http/scrape.post.response.json

@@ -0,0 +1,334 @@
+{
+  "description": "The JSON response body",
+  "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. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "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"
+      ]
+    },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
+    "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#"
+}