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

package/CHANGELOG.md

@@ -1,6 +1,10 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.16.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.

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/browserless.js

@@ -135,7 +135,7 @@ export class Browserless extends EventEmitter {
         const [[internalHttpRouteFiles, internalWsRouteFiles], installedBrowsers] = await Promise.all([getRouteFiles(this.config), availableBrowsers]);
         const hasDebugger = await this.config.hasDebugger();
         const debuggerURL = hasDebugger &&
-            makeExternalURL(this.config.getExternalAddress(), `/debugger/?token=${this.config.getToken()}`);
+            makeExternalURL(this.config.getExternalAddress(), `/debugger/?token=xxx`);
         const docsLink = makeExternalURL(this.config.getExternalAddress(), '/docs');
         this.logger.info(printLogo(docsLink, debuggerURL));
         this.logger.info(`Running as user "${userInfo().username}"`);

package/build/config.d.ts

@@ -24,6 +24,9 @@ export declare class Config extends EventEmitter {
     protected allowCors: boolean;
     protected corsMethods: string;
     protected corsOrigin: string;
+    protected corsHeaders: string;
+    protected corsCredentials: string;
+    protected corsExposeHeaders: string;
     protected corsMaxAge: number;
     protected maxCpu: number;
     protected maxMemory: number;
@@ -162,8 +165,11 @@ export declare class Config extends EventEmitter {
      * and `CORS_MAX_AGE`
      */
     getCORSHeaders(): {
+        'Access-Control-Allow-Credentials': string;
+        'Access-Control-Allow-Headers': string;
         'Access-Control-Allow-Methods': string;
         'Access-Control-Allow-Origin': string;
+        'Access-Control-Expose-Headers': string;
         'Access-Control-Max-Age': number;
     };
     /**

package/build/config.js

@@ -132,6 +132,9 @@ export class Config extends EventEmitter {
     allowCors = !!parseEnvVars(false, 'CORS', 'ENABLE_CORS');
     corsMethods = process.env.CORS_ALLOW_METHODS ?? 'OPTIONS, POST, GET';
     corsOrigin = process.env.CORS_ALLOW_ORIGIN ?? '*';
+    corsHeaders = process.env.CORS_ALLOW_HEADERS ?? '*';
+    corsCredentials = process.env.CORS_ALLOW_CREDENTIALS ?? 'true';
+    corsExposeHeaders = process.env.CORS_EXPOSE_HEADERS ?? '*';
     corsMaxAge = +(process.env.CORS_MAX_AGE ?? '2592000');
     maxCpu = +(process.env.MAX_CPU_PERCENT ?? '99');
     maxMemory = +(process.env.MAX_MEMORY_PERCENT ?? '99');
@@ -443,8 +446,11 @@ export class Config extends EventEmitter {
      */
     getCORSHeaders() {
         return {
+            'Access-Control-Allow-Credentials': this.corsCredentials,
+            'Access-Control-Allow-Headers': this.corsHeaders,
             'Access-Control-Allow-Methods': this.corsMethods,
             'Access-Control-Allow-Origin': this.corsOrigin,
+            'Access-Control-Expose-Headers': this.corsExposeHeaders,
             'Access-Control-Max-Age': this.corsMaxAge,
         };
     }

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@11061": {
+                "__@toStringTag@11909": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@11061",
+                "__@toStringTag@11909",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -450,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@11061": {
+        "__@toStringTag@11909": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@11061",
+        "__@toStringTag@11909",
         "byteLength"
       ]
     },
@@ -466,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11100": {
+        "__@species@11948": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@11061": {
+        "__@toStringTag@11909": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11100",
-        "__@toStringTag@11061",
+        "__@species@11948",
+        "__@toStringTag@11909",
         "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",
@@ -553,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@76992": {
+                "__@toStringTag@82852": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@76992",
+                "__@toStringTag@82852",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -595,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@76992": {
+        "__@toStringTag@82852": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@76992",
+        "__@toStringTag@82852",
         "byteLength"
       ]
     },
@@ -611,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@77031": {
+        "__@species@82891": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@76992": {
+        "__@toStringTag@82852": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@77031",
-        "__@toStringTag@76992",
+        "__@species@82891",
+        "__@toStringTag@82852",
         "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@110270": {
+                "__@toStringTag@118478": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@110270",
+                "__@toStringTag@118478",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -497,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@110270": {
+        "__@toStringTag@118478": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@110270",
+        "__@toStringTag@118478",
         "byteLength"
       ]
     },
@@ -513,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@110309": {
+        "__@species@118517": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@110270": {
+        "__@toStringTag@118478": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@110309",
-        "__@toStringTag@110270",
+        "__@species@118517",
+        "__@toStringTag@118478",
         "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@99117": {
+                "__@toStringTag@130556": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@99117",
+                "__@toStringTag@130556",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -540,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@99117": {
+        "__@toStringTag@130556": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@99117",
+        "__@toStringTag@130556",
         "byteLength"
       ]
     },
@@ -556,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@99156": {
+        "__@species@130595": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@99117": {
+        "__@toStringTag@130556": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@99156",
-        "__@toStringTag@99117",
+        "__@species@130595",
+        "__@toStringTag@130556",
         "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@121476": {
+                "__@toStringTag@142544": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@121476",
+                "__@toStringTag@142544",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -450,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@121476": {
+        "__@toStringTag@142544": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@121476",
+        "__@toStringTag@142544",
         "byteLength"
       ]
     },
@@ -466,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@121515": {
+        "__@species@142583": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@121476": {
+        "__@toStringTag@142544": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@121515",
-        "__@toStringTag@121476",
+        "__@species@142583",
+        "__@toStringTag@142544",
         "byteLength"
       ]
     },