@browserless.io/browserless 2.14.0 → 2.16.0-beta-1

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

@@ -109,7 +109,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -401,14 +408,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@143233": {
+                "__@toStringTag@132742": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@143233",
+                "__@toStringTag@132742",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -443,13 +450,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@143233": {
+        "__@toStringTag@132742": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@143233",
+        "__@toStringTag@132742",
         "byteLength"
       ]
     },
@@ -459,18 +466,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@143334": {
+        "__@species@132843": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@143233": {
+        "__@toStringTag@132742": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@143334",
-        "__@toStringTag@143233",
+        "__@species@132843",
+        "__@toStringTag@132742",
         "byteLength"
       ]
     },

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

@@ -111,7 +111,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -542,14 +549,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@231179": {
+                "__@toStringTag@187784": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@231179",
+                "__@toStringTag@187784",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -584,13 +591,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@231179": {
+        "__@toStringTag@187784": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@231179",
+        "__@toStringTag@187784",
         "byteLength"
       ]
     },
@@ -600,18 +607,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@231280": {
+        "__@species@187885": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@231179": {
+        "__@toStringTag@187784": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@231280",
-        "__@toStringTag@231179",
+        "__@species@187885",
+        "__@toStringTag@187784",
         "byteLength"
       ]
     },

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

@@ -117,7 +117,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -448,14 +455,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@198042": {
+                "__@toStringTag@231869": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@198042",
+                "__@toStringTag@231869",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -490,13 +497,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@198042": {
+        "__@toStringTag@231869": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@198042",
+        "__@toStringTag@231869",
         "byteLength"
       ]
     },
@@ -506,18 +513,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@198143": {
+        "__@species@231970": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@198042": {
+        "__@toStringTag@231869": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@198143",
-        "__@toStringTag@198042",
+        "__@species@231970",
+        "__@toStringTag@231869",
         "byteLength"
       ]
     },

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

@@ -117,7 +117,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -491,14 +498,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@242378": {
+                "__@toStringTag@243170": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@242378",
+                "__@toStringTag@243170",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -533,13 +540,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@242378": {
+        "__@toStringTag@243170": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@242378",
+        "__@toStringTag@243170",
         "byteLength"
       ]
     },
@@ -549,18 +556,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@242479": {
+        "__@species@243271": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@242378": {
+        "__@toStringTag@243170": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@242479",
-        "__@toStringTag@242378",
+        "__@species@243271",
+        "__@toStringTag@243170",
         "byteLength"
       ]
     },

package/build/routes/firefox/ws/playwright.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserServerOptions, BrowserWebsocketRoute, FirefoxPlaywright, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export default class ActiveGetRoute extends HTTPRoute {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface ResponseSchema {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessMetricTotals, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export type ResponseSchema = IBrowserlessMetricTotals;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, IBrowserlessStats, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export type ResponseSchema = Array<IBrowserlessStats>;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export type ResponseSchema = {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserlessSessionJSON, HTTPManagementRoutes, HTTPRoute, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface QuerySchema extends SystemQueryParameters {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, HTTPManagementRoutes, HTTPRoute, Logger, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export default class StaticGetRoute extends HTTPRoute {

package/build/routes/webkit/ws/playwright.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserServerOptions, BrowserWebsocketRoute, Logger, Request, SystemQueryParameters, WebKitPlaywright, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

package/build/server.d.ts

@@ -1,7 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as http from 'http';
 import * as stream from 'stream';
 import { Logger as BlessLogger, Config, Hooks, Metrics, Request, Response, Router, Token } from '@browserless.io/browserless';

package/build/shared/browser.ws.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

package/build/shared/chromium.playwright.ws.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserServerOptions, BrowserWebsocketRoute, ChromiumPlaywright, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

package/build/shared/chromium.ws.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

package/build/shared/content.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors, setJavaScriptEnabled } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';

package/build/shared/download.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 interface JSONSchema {

package/build/shared/function.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 interface JSONSchema {

package/build/shared/page.ws.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {

package/build/shared/pdf.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';

package/build/shared/performance.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface BodySchema {

package/build/shared/scrape.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Logger, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Cookie, Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';

package/build/shared/screenshot.http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';

package/build/token.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserWebsocketRoute, Config, HTTPRoute, Request, WebSocketRoute } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Token extends EventEmitter {

package/build/types.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as http from 'http';
 import * as stream from 'stream';
 import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Logger, Methods, Metrics, Request, WebKitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';

package/build/utils.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, Request, WaitForEventOptions, WaitForFunctionOptions, WebKitPlaywright, codes, contentTypes } from '@browserless.io/browserless';
 import { CDPSession } from 'playwright-core';
 import { Duplex } from 'stream';
@@ -131,4 +128,5 @@ export declare const fetchTimeout: (input: RequestInfo | URL, initWithTimeout?:
 export declare const untildify: (path: string) => string;
 export declare const printLogo: (docsLink: string, debugURL?: string | boolean) => string;
 export declare const getCDPClient: (page: Page) => CDPSession;
+export declare const ublockPath: string;
 export {};

package/build/utils.js

@@ -3,12 +3,14 @@ import { BLESS_PAGE_IDENTIFIER, ChromeCDP, ChromePlaywright, ChromiumCDP, Chromi
 import playwright from 'playwright-core';
 import crypto from 'crypto';
 import debug from 'debug';
+import { fileURLToPath } from 'url';
 import gradient from 'gradient-string';
 import { homedir } from 'os';
 import path from 'path';
 const isHTTP = (writeable) => {
     return writeable.writeHead !== undefined;
 };
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const getAuthHeaderToken = (header) => {
     if (header.startsWith('Basic')) {
         const username = header.split(/\s+/).pop() || '';
@@ -332,7 +334,8 @@ export const availableBrowsers = Promise.all([
     return availableBrowsers;
 });
 export const queryParamsToObject = (params) => [...params.entries()].reduce((accum, [key, value]) => {
-    accum[key] = value;
+    accum[key] =
+        value === '' || value === undefined || value === null ? true : value;
     return accum;
 }, {});
 // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -609,3 +612,4 @@ export const getCDPClient = (page) => {
     const c = page._client;
     return typeof c === 'function' ? c.call(page) : c;
 };
+export const ublockPath = path.join(__dirname, '..', 'extensions', 'ublock');

package/build/webhooks.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Config } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class WebHooks extends EventEmitter {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.14.0",
+  "version": "2.16.0-beta-1",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -51,18 +51,18 @@
     "debug": "^4.3.5",
     "del": "^7.0.0",
     "enjoi": "^9.0.1",
-    "file-type": "^19.0.0",
+    "file-type": "^19.1.0",
     "get-port": "^7.1.0",
     "gradient-string": "^2.0.0",
     "http-proxy": "^1.18.1",
     "lighthouse": "^12.1.0",
     "micromatch": "^4.0.7",
-    "playwright-1.40": "npm:playwright-core@1.40.1",
     "playwright-1.41": "npm:playwright-core@1.41.2",
     "playwright-1.42": "npm:playwright-core@1.42.1",
     "playwright-1.43": "npm:playwright-core@1.43.1",
-    "playwright-core": "^1.44.1",
-    "puppeteer-core": "^22.11.2",
+    "playwright-1.44": "npm:playwright-core@1.44.1",
+    "playwright-core": "^1.45.1",
+    "puppeteer-core": "^22.12.1",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
@@ -74,38 +74,38 @@
     "@types/debug": "^4.1.12",
     "@types/gradient-string": "^1.1.6",
     "@types/http-proxy": "^1.17.14",
-    "@types/micromatch": "^4.0.7",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.14.5",
+    "@types/micromatch": "^4.0.9",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.10",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.13.1",
-    "@typescript-eslint/parser": "^7.13.1",
+    "@typescript-eslint/eslint-plugin": "^7.15.0",
+    "@typescript-eslint/parser": "^7.16.0",
     "assert": "^2.0.0",
     "chai": "^5.1.1",
     "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.21.5",
+    "esbuild": "^0.23.0",
     "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.57.0",
     "eslint-plugin-typescript-sort-keys": "^3.2.0",
     "extract-zip": "^2.0.1",
     "gunzip-maybe": "^1.4.2",
-    "marked": "^13.0.0",
-    "mocha": "^10.4.0",
+    "marked": "^13.0.2",
+    "mocha": "^10.6.0",
     "move-file": "^3.1.0",
     "prettier": "^3.3.2",
     "sinon": "^18.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5",
+    "typescript": "^5.5.3",
     "typescript-json-schema": "^0.64.0"
   },
   "playwrightVersions": {
     "default": "playwright-core",
-    "1.44": "playwright-core",
+    "1.45": "playwright-core",
+    "1.44": "playwright-1.44",
     "1.43": "playwright-1.43",
     "1.42": "playwright-1.42",
-    "1.41": "playwright-1.41",
-    "1.40": "playwright-1.40"
+    "1.41": "playwright-1.41"
   },
   "eslintConfig": {
     "root": true,

package/scripts/build-schemas.js

@@ -12,7 +12,7 @@ const moduleMain = path.normalize(import.meta.url).endsWith(process.argv[1]);
 
 /**
  * Find an exported interface in a TypeScript AST
- * 
+ *
  * @param {ts.Node} node The node to search for the exported interface
  * @param {string} interfaceName The name of the interface to search for
  * @returns {ts.InterfaceDeclaration | ts.Identifier | null}
@@ -29,7 +29,11 @@ const findExportedInterface = (node, interfaceName) => {
   }
 
   // Check for re-exported interfaces
-  if (ts.isExportDeclaration(node) && node.exportClause && ts.isNamedExports(node.exportClause)) {
+  if (
+    ts.isExportDeclaration(node) &&
+    node.exportClause &&
+    ts.isNamedExports(node.exportClause)
+  ) {
     const elements = node.exportClause.elements;
     for (const element of elements) {
       if (element.name.text === interfaceName) {
@@ -50,7 +54,7 @@ const findExportedInterface = (node, interfaceName) => {
 
 /**
  * Creates an standard JSON schema file for each route (see https://json-schema.org/specification)
- * 
+ *
  * @param {string[]} externalHTTPRoutes Additional HTTP routes to parse
  * @param {string[]} externalWebSocketRoutes Additional WS routes to parse
  */