@browserless.io/browserless 2.25.0-beta-2 → 2.25.0

package/build/routes/edge/http/content.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/content.post.response.json

@@ -0,0 +1,5 @@
+{
+  "description": "An HTML payload of the website or HTML after JavaScript\nparsing and execution.",
+  "type": "string",
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/download.post.body.json

@@ -0,0 +1,32 @@
+{
+  "anyOf": [
+    {
+      "$ref": "#/definitions/JSONSchema"
+    },
+    {
+      "type": "string"
+    }
+  ],
+  "definitions": {
+    "JSONSchema": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string"
+        },
+        "context": {
+          "$ref": "#/definitions/Record<string,string|number>"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "code"
+      ]
+    },
+    "Record<string,string|number>": {
+      "type": "object",
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/download.post.d.ts

@@ -0,0 +1,8 @@
+import { EdgeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import { BodySchema, default as Download, QuerySchema, ResponseSchema } from '../../../shared/download.http.js';
+export default class EdgeDownloadPostRoute extends Download {
+    name: string;
+    browser: typeof EdgeCDP;
+    path: HTTPRoutes[];
+}
+export { BodySchema, QuerySchema, ResponseSchema };

package/build/routes/edge/http/download.post.js

@@ -0,0 +1,7 @@
+import { BrowserlessRoutes, EdgeCDP, HTTPRoutes, } from '@browserless.io/browserless';
+import { default as Download, } from '../../../shared/download.http.js';
+export default class EdgeDownloadPostRoute extends Download {
+    name = BrowserlessRoutes.EdgeDownloadPostRoute;
+    browser = EdgeCDP;
+    path = [HTTPRoutes.edgeDownload];
+}

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

@@ -0,0 +1,120 @@
+{
+  "type": "object",
+  "properties": {
+    "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"
+        },
+        {
+          "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"
+    },
+    "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"
+    }
+  },
+  "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
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/download.post.response.json

@@ -0,0 +1,4 @@
+{
+  "description": "Responses are determined by the returned value of the downloads\nthemselves, so there isn't a static response type for this API.",
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/function.post.body.json

@@ -0,0 +1,32 @@
+{
+  "anyOf": [
+    {
+      "$ref": "#/definitions/JSONSchema"
+    },
+    {
+      "type": "string"
+    }
+  ],
+  "definitions": {
+    "JSONSchema": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string"
+        },
+        "context": {
+          "$ref": "#/definitions/Record<string,string|number>"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "code"
+      ]
+    },
+    "Record<string,string|number>": {
+      "type": "object",
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/function.post.d.ts

@@ -0,0 +1,8 @@
+import { EdgeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import { BodySchema, default as Function, QuerySchema, ResponseSchema } from '../../../shared/function.http.js';
+export default class EdgeFunctionPostRoute extends Function {
+    name: string;
+    browser: typeof EdgeCDP;
+    path: HTTPRoutes[];
+}
+export { BodySchema, QuerySchema, ResponseSchema };

package/build/routes/edge/http/function.post.js

@@ -0,0 +1,7 @@
+import { BrowserlessRoutes, EdgeCDP, HTTPRoutes, } from '@browserless.io/browserless';
+import { default as Function, } from '../../../shared/function.http.js';
+export default class EdgeFunctionPostRoute extends Function {
+    name = BrowserlessRoutes.EdgeFunctionPostRoute;
+    browser = EdgeCDP;
+    path = [HTTPRoutes.edgeFunction];
+}

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

@@ -0,0 +1,120 @@
+{
+  "type": "object",
+  "properties": {
+    "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"
+        },
+        {
+          "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"
+    },
+    "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"
+    }
+  },
+  "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
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/function.post.response.json

@@ -0,0 +1,4 @@
+{
+  "description": "Responses are determined by the returned value of the function\nitself. Binary responses (PDF's, screenshots) are returned back\nas binary data, and primitive JavaScript values are returned back\nby type (HTML data is \"text/html\", Objects are \"application/json\")",
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/http/json-list.get.d.ts

@@ -0,0 +1,5 @@
+import { default as ChromiumJSONListGetRoute } from '../../../shared/json-list.http.js';
+export { ResponseSchema } from '../../../shared/json-list.http.js';
+export default class EdgeJSONListGetRoute extends ChromiumJSONListGetRoute {
+    name: string;
+}

package/build/routes/edge/http/json-list.get.js

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

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

@@ -0,0 +1,52 @@
+{
+  "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/edge/http/json-new.put.d.ts

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

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

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

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

@@ -0,0 +1,44 @@
+{
+  "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/edge/http/json-protocol.get.d.ts

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

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

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