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

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

@@ -1,510 +1,26 @@
 {
   "type": "object",
   "properties": {
-    "addScriptTag": {
+    "budgets": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/FrameAddScriptTagOptions"
-      }
-    },
-    "addStyleTag": {
-      "type": "array",
-      "items": {
-        "$ref": "#/definitions/FrameAddStyleTagOptions"
-      }
-    },
-    "authenticate": {
-      "$ref": "#/definitions/Credentials"
-    },
-    "bestAttempt": {
-      "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"
-    },
-    "cookies": {
-      "type": "array",
-      "items": {
-        "$ref": "#/definitions/CookieParam"
-      }
-    },
-    "emulateMediaType": {
-      "type": "string"
-    },
-    "gotoOptions": {
-      "$ref": "#/definitions/GoToOptions"
-    },
-    "html": {
-      "type": "string"
-    },
-    "rejectRequestPattern": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "rejectResourceTypes": {
-      "type": "array",
-      "items": {
-        "enum": [
-          "cspviolationreport",
-          "document",
-          "eventsource",
-          "fetch",
-          "font",
-          "image",
-          "manifest",
-          "media",
-          "other",
-          "ping",
-          "prefetch",
-          "preflight",
-          "script",
-          "signedexchange",
-          "stylesheet",
-          "texttrack",
-          "websocket",
-          "xhr"
-        ],
-        "type": "string"
-      }
-    },
-    "requestInterceptors": {
-      "type": "array",
-      "items": {
-        "description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
         "type": "object",
-        "properties": {
-          "pattern": {
-            "description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
-            "type": "string"
-          },
-          "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "pattern",
-          "response"
-        ]
+        "properties": {},
+        "additionalProperties": true
       }
     },
-    "setExtraHTTPHeaders": {
-      "$ref": "#/definitions/Record<string,string>"
-    },
-    "setJavaScriptEnabled": {
-      "description": "Whether or not to allow JavaScript to run on the page.",
-      "type": "boolean"
+    "config": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": true
     },
     "url": {
       "type": "string"
-    },
-    "userAgent": {
-      "type": "string"
-    },
-    "viewport": {
-      "$ref": "#/definitions/Viewport"
-    },
-    "waitForEvent": {
-      "type": "object",
-      "properties": {
-        "event": {
-          "type": "string"
-        },
-        "timeout": {
-          "type": "number"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "event"
-      ]
-    },
-    "waitForFunction": {
-      "type": "object",
-      "properties": {
-        "fn": {
-          "description": "The function, or statement, to be evaluated in browser context",
-          "type": "string"
-        },
-        "polling": {
-          "description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
-          "type": [
-            "string",
-            "number"
-          ]
-        },
-        "timeout": {
-          "description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
-          "type": "number"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "fn"
-      ]
-    },
-    "waitForSelector": {
-      "type": "object",
-      "properties": {
-        "hidden": {
-          "type": "boolean"
-        },
-        "selector": {
-          "type": "string"
-        },
-        "timeout": {
-          "type": "number"
-        },
-        "visible": {
-          "type": "boolean"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "selector"
-      ]
-    },
-    "waitForTimeout": {
-      "type": "number"
     }
   },
   "additionalProperties": false,
-  "definitions": {
-    "FrameAddScriptTagOptions": {
-      "type": "object",
-      "properties": {
-        "url": {
-          "description": "URL of the script to be added.",
-          "type": "string"
-        },
-        "path": {
-          "description": "Path to a JavaScript file to be injected into the frame.",
-          "type": "string"
-        },
-        "content": {
-          "description": "JavaScript to be injected into the frame.",
-          "type": "string"
-        },
-        "type": {
-          "description": "Sets the `type` of the script. Use `module` in order to load an ES2015 module.",
-          "type": "string"
-        },
-        "id": {
-          "description": "Sets the `id` of the script.",
-          "type": "string"
-        }
-      },
-      "additionalProperties": false
-    },
-    "FrameAddStyleTagOptions": {
-      "type": "object",
-      "properties": {
-        "url": {
-          "description": "the URL of the CSS file to be added.",
-          "type": "string"
-        },
-        "path": {
-          "description": "The path to a CSS file to be injected into the frame.",
-          "type": "string"
-        },
-        "content": {
-          "description": "Raw CSS content to be injected into the frame.",
-          "type": "string"
-        }
-      },
-      "additionalProperties": false
-    },
-    "Credentials": {
-      "type": "object",
-      "properties": {
-        "username": {
-          "type": "string"
-        },
-        "password": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "password",
-        "username"
-      ]
-    },
-    "CookieParam": {
-      "description": "Cookie parameter object",
-      "type": "object",
-      "properties": {
-        "name": {
-          "description": "Cookie name.",
-          "type": "string"
-        },
-        "value": {
-          "description": "Cookie value.",
-          "type": "string"
-        },
-        "url": {
-          "description": "The request-URI to associate with the setting of the cookie. This value can affect\nthe default domain, path, and source scheme values of the created cookie.",
-          "type": "string"
-        },
-        "domain": {
-          "description": "Cookie domain.",
-          "type": "string"
-        },
-        "path": {
-          "description": "Cookie path.",
-          "type": "string"
-        },
-        "secure": {
-          "description": "True if cookie is secure.",
-          "type": "boolean"
-        },
-        "httpOnly": {
-          "description": "True if cookie is http-only.",
-          "type": "boolean"
-        },
-        "sameSite": {
-          "description": "Cookie SameSite type.",
-          "enum": [
-            "Lax",
-            "None",
-            "Strict"
-          ],
-          "type": "string"
-        },
-        "expires": {
-          "description": "Cookie expiration date, session cookie if not set",
-          "type": "number"
-        },
-        "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. If not set, the cookie will\nbe set as not partitioned.",
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "name",
-        "value"
-      ]
-    },
-    "GoToOptions": {
-      "type": "object",
-      "properties": {
-        "referer": {
-          "description": "If provided, it will take preference over the referer header value set by\n{@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.",
-          "type": "string"
-        },
-        "referrerPolicy": {
-          "description": "If provided, it will take preference over the referer-policy header value\nset by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.",
-          "type": "string"
-        },
-        "timeout": {
-          "description": "Maximum wait time in milliseconds. Pass 0 to disable the timeout.\n\nThe default value can be changed by using the\n{@link Page.setDefaultTimeout} or {@link Page.setDefaultNavigationTimeout}\nmethods.",
-          "type": "number"
-        },
-        "waitUntil": {
-          "description": "When to consider waiting succeeds. Given an array of event strings, waiting\nis considered to be successful after all events have been fired.",
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/PuppeteerLifeCycleEvent"
-              }
-            },
-            {
-              "enum": [
-                "domcontentloaded",
-                "load",
-                "networkidle0",
-                "networkidle2"
-              ],
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
-    "PuppeteerLifeCycleEvent": {
-      "enum": [
-        "domcontentloaded",
-        "load",
-        "networkidle0",
-        "networkidle2"
-      ],
-      "type": "string"
-    },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers. All values are converted to strings.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@132019": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@132019",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
-    "Record<string,unknown>": {
-      "type": "object",
-      "additionalProperties": false
-    },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@132019": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@132019",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@136174": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@132019": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@136174",
-        "__@toStringTag@132019",
-        "byteLength"
-      ]
-    },
-    "Record<string,string>": {
-      "type": "object",
-      "additionalProperties": false
-    },
-    "Viewport": {
-      "type": "object",
-      "properties": {
-        "width": {
-          "description": "The page width in CSS pixels.",
-          "type": "number"
-        },
-        "height": {
-          "description": "The page height in CSS pixels.",
-          "type": "number"
-        },
-        "deviceScaleFactor": {
-          "description": "Specify device scale factor.\nSee {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio devicePixelRatio} for more info.",
-          "type": "number"
-        },
-        "isMobile": {
-          "description": "Whether the `meta viewport` tag is taken into account.",
-          "type": "boolean"
-        },
-        "isLandscape": {
-          "description": "Specifies if the viewport is in landscape mode.",
-          "type": "boolean"
-        },
-        "hasTouch": {
-          "description": "Specify if the viewport supports touch events.",
-          "type": "boolean"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "height",
-        "width"
-      ]
-    }
-  },
+  "required": [
+    "url"
+  ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

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

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

@@ -1,6 +1,7 @@
 import { default as Performance, } from '../../../shared/performance.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
-export default class ChromePerformance extends Performance {
+import { BrowserlessRoutes, ChromeCDP, HTTPRoutes, } from '@browserless.io/browserless';
+export default class ChromePerformancePostRoute extends Performance {
+    name = BrowserlessRoutes.ChromePerformancePostRoute;
     browser = ChromeCDP;
     path = [HTTPRoutes.chromePerformance];
 }

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

@@ -1,5 +1,7 @@
 {
   "description": "The response of the lighthouse stats. Response objects are\ndetermined by the type of budgets and config in the POST\nJSON body",
-  "type": "string",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": true,
   "$schema": "http://json-schema.org/draft-07/schema#"
 }