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

package/build/routes/firefox/ws/playwright.query.json

@@ -1,120 +1,9 @@
 {
-  "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"
-        }
-      ]
-    },
-    "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"
-    },
-    "timeout": {
-      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
-      "type": "number"
-    },
-    "token": {
-      "description": "The authorization token",
-      "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": {
+      "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.",
+      "additionalProperties": false,
       "type": "object",
       "properties": {
         "args": {
@@ -174,10 +63,36 @@
         },
         "tracesDir": {
           "type": "string"
+        },
+        "firefoxUserPrefs": {
+          "type": "object",
+          "additionalProperties": {
+            "type": [
+              "string",
+              "number",
+              "boolean"
+            ]
+          }
         }
-      },
-      "additionalProperties": false
+      }
+    },
+    "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"
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    },
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
     }
   },
+  "additionalProperties": false,
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/config.get.d.ts

@@ -24,6 +24,7 @@ export interface ResponseSchema {
     token: string | null;
 }
 export default class ConfigGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

package/build/routes/management/http/config.get.js

@@ -1,5 +1,6 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 export default class ConfigGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.ConfigGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/routes/management/http/config.get.response.json

@@ -1,4 +1,107 @@
 {
-  "type": "string",
+  "type": "object",
+  "properties": {
+    "allowCORS": {
+      "type": "boolean"
+    },
+    "allowFileProtocol": {
+      "type": "boolean"
+    },
+    "allowGetCalls": {
+      "type": "boolean"
+    },
+    "concurrent": {
+      "type": "number"
+    },
+    "data": {
+      "type": "string"
+    },
+    "debug": {
+      "type": "string"
+    },
+    "errorAlertURL": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "healthFailureURL": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "host": {
+      "type": "string"
+    },
+    "maxCPU": {
+      "type": "number"
+    },
+    "maxMemory": {
+      "type": "number"
+    },
+    "metricsJSONPath": {
+      "type": "string"
+    },
+    "port": {
+      "type": "number"
+    },
+    "queued": {
+      "type": "number"
+    },
+    "queuedAlertURL": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "rejectAlertURL": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "retries": {
+      "type": "number"
+    },
+    "timeout": {
+      "type": "number"
+    },
+    "timeoutAlertURL": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "token": {
+      "type": [
+        "null",
+        "string"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "allowCORS",
+    "allowFileProtocol",
+    "allowGetCalls",
+    "concurrent",
+    "data",
+    "debug",
+    "errorAlertURL",
+    "healthFailureURL",
+    "host",
+    "maxCPU",
+    "maxMemory",
+    "metricsJSONPath",
+    "port",
+    "queued",
+    "queuedAlertURL",
+    "rejectAlertURL",
+    "retries",
+    "timeout",
+    "timeoutAlertURL",
+    "token"
+  ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/metrics-total.get.d.ts

@@ -3,6 +3,7 @@ import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessMetricTotals, Met
 import { ServerResponse } from 'http';
 export type ResponseSchema = IBrowserlessMetricTotals;
 export default class MetricsTotalGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

package/build/routes/management/http/metrics-total.get.js

@@ -1,6 +1,7 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
 const fiveMinuteIntervalsInAMonth = 8640;
 export default class MetricsTotalGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.MetricsTotalGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/routes/management/http/metrics-total.get.response.json

@@ -1,4 +1,72 @@
 {
-  "type": "string",
+  "type": "object",
+  "properties": {
+    "error": {
+      "type": "number"
+    },
+    "estimatedMonthlyUnits": {
+      "type": "number"
+    },
+    "maxConcurrent": {
+      "type": "number"
+    },
+    "maxTime": {
+      "type": "number"
+    },
+    "meanTime": {
+      "type": "number"
+    },
+    "minTime": {
+      "type": "number"
+    },
+    "minutesOfMetricsAvailable": {
+      "type": "number"
+    },
+    "queued": {
+      "type": "number"
+    },
+    "rejected": {
+      "type": "number"
+    },
+    "sessionTimes": {
+      "type": "array",
+      "items": {
+        "type": "number"
+      }
+    },
+    "successful": {
+      "type": "number"
+    },
+    "timedout": {
+      "type": "number"
+    },
+    "totalTime": {
+      "type": "number"
+    },
+    "unhealthy": {
+      "type": "number"
+    },
+    "units": {
+      "type": "number"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "error",
+    "estimatedMonthlyUnits",
+    "maxConcurrent",
+    "maxTime",
+    "meanTime",
+    "minTime",
+    "minutesOfMetricsAvailable",
+    "queued",
+    "rejected",
+    "sessionTimes",
+    "successful",
+    "timedout",
+    "totalTime",
+    "unhealthy",
+    "units"
+  ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/metrics.get.d.ts

@@ -3,6 +3,7 @@ import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessStats, Methods, R
 import { ServerResponse } from 'http';
 export type ResponseSchema = Array<IBrowserlessStats>;
 export default class MetricsGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

package/build/routes/management/http/metrics.get.js

@@ -1,5 +1,6 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
 export default class MetricsGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.MetricsGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;

package/build/routes/management/http/metrics.get.response.json

@@ -1,4 +1,94 @@
 {
-  "type": "string",
+  "type": "array",
+  "items": {
+    "$ref": "#/definitions/IBrowserlessStats"
+  },
+  "definitions": {
+    "IBrowserlessStats": {
+      "type": "object",
+      "properties": {
+        "cpu": {
+          "type": [
+            "null",
+            "number"
+          ]
+        },
+        "date": {
+          "type": "number"
+        },
+        "error": {
+          "type": "number"
+        },
+        "maxConcurrent": {
+          "type": "number"
+        },
+        "maxTime": {
+          "type": "number"
+        },
+        "meanTime": {
+          "type": "number"
+        },
+        "memory": {
+          "type": [
+            "null",
+            "number"
+          ]
+        },
+        "minTime": {
+          "type": "number"
+        },
+        "queued": {
+          "type": "number"
+        },
+        "rejected": {
+          "type": "number"
+        },
+        "sessionTimes": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        },
+        "successful": {
+          "type": "number"
+        },
+        "timedout": {
+          "type": "number"
+        },
+        "totalTime": {
+          "type": "number"
+        },
+        "unauthorized": {
+          "type": "number"
+        },
+        "unhealthy": {
+          "type": "number"
+        },
+        "units": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "cpu",
+        "date",
+        "error",
+        "maxConcurrent",
+        "maxTime",
+        "meanTime",
+        "memory",
+        "minTime",
+        "queued",
+        "rejected",
+        "sessionTimes",
+        "successful",
+        "timedout",
+        "totalTime",
+        "unauthorized",
+        "unhealthy",
+        "units"
+      ]
+    }
+  },
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/sessions.get.d.ts

@@ -3,6 +3,7 @@ import { APITags, BrowserlessSessionJSON, HTTPManagementRoutes, HTTPRoute, Metho
 import { ServerResponse } from 'http';
 export type ResponseSchema = BrowserlessSessionJSON[];
 export default class SessionsGetRoute extends HTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: null;

package/build/routes/management/http/sessions.get.js

@@ -1,5 +1,6 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 export default class SessionsGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.SessionsGetRoute;
     accepts = [contentTypes.any];
     auth = true;
     browser = null;