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

package/CHANGELOG.md

@@ -1,6 +1,16 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.15.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.16.1...main)
 - Dependency updates.
 
+# [Latest](https://github.com/browserless/chrome/compare/v2.16.0...v2.16.1)
+- Dependency updates.
+- Fixes numerous SDK issues when creating and building new projects.
+
+# [v2.16.0](https://github.com/browserless/chrome/compare/v2.15.0...v2.16.0)
+- Dependency updates.
+- Better extension handling and merging when passing in custom extensions.
+- Fixes a bug where a failed job (error thrown) causes the internal queue to drain.
+- Prettier and other source improvements.
+
 # [v2.15.0](https://github.com/browserless/chrome/compare/v2.14.0...v2.15.0)
 - Bug fix to avoid removing healthy jobs from limiter when a job fails
 - Dependency updates.

package/bin/browserless.js

@@ -11,15 +11,17 @@ import {
   prompt,
 } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
-import buildOpenAPI from '../scripts/build-open-api.js';
-import buildSchemas from '../scripts/build-schemas.js';
 
 import debug from 'debug';
-import { dedent } from '../build/utils.js';
 import { fileURLToPath } from 'url';
 import fs from 'fs/promises';
 import path from 'path';
 
+import { buildDockerImage } from '../build/sdk-utils.js';
+import buildOpenAPI from '../scripts/build-open-api.js';
+import buildSchemas from '../scripts/build-schemas.js';
+import { dedent } from '../build/utils.js';
+
 if (typeof process.env.DEBUG === 'undefined') {
   debug.enable('browserless*');
 }
@@ -277,7 +279,7 @@ const buildDocker = async () => {
 
   log(`Generating Dockerfile at "${finalDockerPath}"`);
 
-  await fs.writeFile(compiledDir, dockerContents);
+  await fs.writeFile(finalDockerPath, dockerContents);
 
   const from =
     argSwitches.from ||

package/bin/scaffold/src/hello-world.http.ts

@@ -23,7 +23,7 @@ export default class HelloWorldHTTPRoute extends HTTPRoute {
   path = '/hello';
   tags = [APITags.management];
   async handler(req: Request, res: Response, logger: Logger): Promise<void> {
-    logger.verbose(`${req.method} /hello was called!`);
+    logger.debug(`${req.method} /hello was called!`);
     const response: ResponseSchema = 'Hello World!';
     return writeResponse(res, 200, response, contentTypes.text);
   }

package/build/logger.js

@@ -20,7 +20,7 @@ export class Logger {
         this._fatal = logger.extend('fatal');
     }
     get reqInfo() {
-        return this.request ? this.request.socket.remoteAddress ?? 'Unknown' : '';
+        return this.request ? (this.request.socket.remoteAddress ?? 'Unknown') : '';
     }
     trace(...messages) {
         this._trace(this.reqInfo, ...messages);

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

@@ -356,6 +356,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -369,6 +373,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "Partial<ResponseForRequest>": {
       "type": "object",
       "properties": {
@@ -408,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@11070": {
+                "__@toStringTag@11906": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@11070",
+                "__@toStringTag@11906",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -450,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@11070": {
+        "__@toStringTag@11906": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@11070",
+        "__@toStringTag@11906",
         "byteLength"
       ]
     },
@@ -466,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11171": {
+        "__@species@11945": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@11070": {
+        "__@toStringTag@11906": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11171",
-        "__@toStringTag@11070",
+        "__@species@11945",
+        "__@toStringTag@11906",
         "byteLength"
       ]
     },

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

@@ -358,6 +358,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -371,6 +375,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "PDFOptions": {
       "description": "Valid options to configure PDF generation via {@link Page.pdf}.",
       "type": "object",
@@ -474,8 +504,12 @@
           "type": "boolean"
         },
         "timeout": {
-          "description": "Timeout in milliseconds. Pass `0` to disable timeout.",
+          "description": "Timeout in milliseconds. Pass `0` to disable timeout.\n\nThe default value can be changed by using {@link Page.setDefaultTimeout}",
           "type": "number"
+        },
+        "waitForFonts": {
+          "description": "If true, waits for `document.fonts.ready` to resolve. This might require\nactivating the page using {@link Page.bringToFront} if the page is in the\nbackground.",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -549,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@88036": {
+                "__@toStringTag@106450": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@88036",
+                "__@toStringTag@106450",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -591,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@88036": {
+        "__@toStringTag@106450": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@88036",
+        "__@toStringTag@106450",
         "byteLength"
       ]
     },
@@ -607,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@88137": {
+        "__@species@106489": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@88036": {
+        "__@toStringTag@106450": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@88137",
-        "__@toStringTag@88036",
+        "__@species@106489",
+        "__@toStringTag@106450",
         "byteLength"
       ]
     },

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

@@ -403,6 +403,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -416,6 +420,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "Partial<ResponseForRequest>": {
       "type": "object",
       "properties": {
@@ -455,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@110224": {
+                "__@toStringTag@118448": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@110224",
+                "__@toStringTag@118448",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -497,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@110224": {
+        "__@toStringTag@118448": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@110224",
+        "__@toStringTag@118448",
         "byteLength"
       ]
     },
@@ -513,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@110325": {
+        "__@species@118487": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@110224": {
+        "__@toStringTag@118448": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@110325",
-        "__@toStringTag@110224",
+        "__@species@118487",
+        "__@toStringTag@118448",
         "byteLength"
       ]
     },

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

@@ -364,6 +364,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -377,6 +381,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "ScreenshotOptions": {
       "type": "object",
       "properties": {
@@ -498,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@121528": {
+                "__@toStringTag@154319": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@121528",
+                "__@toStringTag@154319",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -540,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@121528": {
+        "__@toStringTag@154319": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@121528",
+        "__@toStringTag@154319",
         "byteLength"
       ]
     },
@@ -556,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@121629": {
+        "__@species@154358": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@121528": {
+        "__@toStringTag@154319": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@121629",
-        "__@toStringTag@121528",
+        "__@species@154358",
+        "__@toStringTag@154319",
         "byteLength"
       ]
     },

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

@@ -356,6 +356,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -369,6 +373,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "Partial<ResponseForRequest>": {
       "type": "object",
       "properties": {
@@ -408,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@132742": {
+                "__@toStringTag@142293": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@132742",
+                "__@toStringTag@142293",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -450,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@132742": {
+        "__@toStringTag@142293": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@132742",
+        "__@toStringTag@142293",
         "byteLength"
       ]
     },
@@ -466,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@132843": {
+        "__@species@142332": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@132742": {
+        "__@toStringTag@142293": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@132843",
-        "__@toStringTag@132742",
+        "__@species@142332",
+        "__@toStringTag@142293",
         "byteLength"
       ]
     },

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

@@ -358,6 +358,10 @@
               "type": "string"
             }
           ]
+        },
+        "signal": {
+          "description": "A signal object that allows you to cancel the call.",
+          "$ref": "#/definitions/AbortSignal"
         }
       },
       "additionalProperties": false
@@ -371,6 +375,32 @@
       ],
       "type": "string"
     },
+    "AbortSignal": {
+      "type": "object",
+      "properties": {
+        "aborted": {
+          "type": "boolean"
+        },
+        "onabort": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reason": {}
+      },
+      "additionalProperties": false,
+      "required": [
+        "aborted",
+        "onabort",
+        "reason"
+      ]
+    },
     "PDFOptions": {
       "description": "Valid options to configure PDF generation via {@link Page.pdf}.",
       "type": "object",
@@ -474,8 +504,12 @@
           "type": "boolean"
         },
         "timeout": {
-          "description": "Timeout in milliseconds. Pass `0` to disable timeout.",
+          "description": "Timeout in milliseconds. Pass `0` to disable timeout.\n\nThe default value can be changed by using {@link Page.setDefaultTimeout}",
           "type": "number"
+        },
+        "waitForFonts": {
+          "description": "If true, waits for `document.fonts.ready` to resolve. This might require\nactivating the page using {@link Page.bringToFront} if the page is in the\nbackground.",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -549,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@187784": {
+                "__@toStringTag@225235": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@187784",
+                "__@toStringTag@225235",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -591,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@187784": {
+        "__@toStringTag@225235": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@187784",
+        "__@toStringTag@225235",
         "byteLength"
       ]
     },
@@ -607,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@187885": {
+        "__@species@225274": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@187784": {
+        "__@toStringTag@225235": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@187885",
-        "__@toStringTag@187784",
+        "__@species@225274",
+        "__@toStringTag@225235",
         "byteLength"
       ]
     },