@browserless.io/browserless 2.12.0-beta-4 → 2.12.0

package/build/config.js

@@ -142,49 +142,99 @@ export class Config extends EventEmitter {
     timeoutAlertURL = process.env.TIMEOUT_ALERT_URL ?? null;
     errorAlertURL = process.env.ERROR_ALERT_URL ?? null;
     pwVersions = {};
-    getRoutes = () => this.routes;
-    getHost = () => this.host;
-    getPort = () => this.port;
-    getIsWin = () => this.isWin;
-    getToken = () => this.token;
-    getDebug = () => this.debug;
-    getPwVersions = () => this.pwVersions;
+    getRoutes() {
+        return this.routes;
+    }
+    getHost() {
+        return this.host;
+    }
+    getPort() {
+        return this.port;
+    }
+    getIsWin() {
+        return this.isWin;
+    }
+    getToken() {
+        return this.token;
+    }
+    getDebug() {
+        return this.debug;
+    }
+    getPwVersions() {
+        return this.pwVersions;
+    }
     /**
      * The maximum number of concurrent sessions allowed. Set
      * to "-1" or "Infinity" for no limit.
      * @returns number
      */
-    getConcurrent = () => this.concurrent;
+    getConcurrent() {
+        return this.concurrent;
+    }
     /**
      * The maximum number of queued sessions allowed. Set to
      * "-1" or "Infinity" for no limit.
      * @returns number
      */
-    getQueued = () => this.queued;
-    getTimeout = () => this.timeout;
-    getStatic = () => this.static;
-    getDebuggerDir = () => this.debuggerDir;
-    getRetries = () => this.retries;
-    getAllowFileProtocol = () => this.allowFileProtocol;
-    getCPULimit = () => this.maxCpu;
-    getMemoryLimit = () => this.maxMemory;
-    getHealthChecksEnabled = () => this.healthCheck;
-    getFailedHealthURL = () => this.failedHealthURL;
-    getQueueAlertURL = () => this.queueAlertURL;
-    getRejectAlertURL = () => this.rejectAlertURL;
-    getTimeoutAlertURL = () => this.timeoutAlertURL;
-    getErrorAlertURL = () => this.errorAlertURL;
-    hasDebugger = () => exists(this.debuggerDir);
+    getQueued() {
+        return this.queued;
+    }
+    getTimeout() {
+        return this.timeout;
+    }
+    getStatic() {
+        return this.static;
+    }
+    getDebuggerDir() {
+        return this.debuggerDir;
+    }
+    getRetries() {
+        return this.retries;
+    }
+    getAllowFileProtocol() {
+        return this.allowFileProtocol;
+    }
+    getCPULimit() {
+        return this.maxCpu;
+    }
+    getMemoryLimit() {
+        return this.maxMemory;
+    }
+    getHealthChecksEnabled() {
+        return this.healthCheck;
+    }
+    getFailedHealthURL() {
+        return this.failedHealthURL;
+    }
+    getQueueAlertURL() {
+        return this.queueAlertURL;
+    }
+    getRejectAlertURL() {
+        return this.rejectAlertURL;
+    }
+    getTimeoutAlertURL() {
+        return this.timeoutAlertURL;
+    }
+    getErrorAlertURL() {
+        return this.errorAlertURL;
+    }
+    hasDebugger() {
+        return exists(this.debuggerDir);
+    }
     /**
      * If true, allows GET style calls on our browser-based APIs, using
      * ?body=JSON format.
      */
-    getAllowGetCalls = () => this.allowGet;
+    getAllowGetCalls() {
+        return this.allowGet;
+    }
     /**
      * Determines if CORS is allowed
      */
-    getAllowCORS = () => this.allowCors;
-    getDataDir = async () => {
+    getAllowCORS() {
+        return this.allowCors;
+    }
+    async getDataDir() {
         if (this.createDataDir && !(await exists(this.dataDir))) {
             await mkdir(this.dataDir, { recursive: true }).catch((err) => {
                 throw new Error(`Error in creating the data directory ${err}, exiting`);
@@ -195,8 +245,8 @@ export class Config extends EventEmitter {
             throw new Error(`"${this.dataDir}" Directory doesn't exist, did you forget to mount or make it?`);
         }
         return this.dataDir;
-    };
-    getDownloadsDir = async () => {
+    }
+    async getDownloadsDir() {
         if (this.createDownloadsDir && !(await exists(this.downloadsDir))) {
             await mkdir(this.downloadsDir, { recursive: true }).catch((err) => {
                 throw new Error(`Error in creating the downloads directory ${err}, exiting`);
@@ -207,21 +257,23 @@ export class Config extends EventEmitter {
             throw new Error(`"${this.downloadsDir}" Directory doesn't exist, did you forget to mount or make it?`);
         }
         return this.downloadsDir;
-    };
+    }
     /**
      * Repeats the TOKEN parameter up to 24 characters so we can
      * do AES encoding for saving things to disk and generating
      * secure links.
      */
-    getAESKey = () => {
+    getAESKey() {
         const aesToken = this.token || 'browserless';
         return Buffer.from(aesToken.repeat(keyLength).substring(0, keyLength));
-    };
-    getMetricsJSONPath = () => this.metricsJSONPath;
-    setPwVersions = (versions) => {
-        this.pwVersions = versions;
-    };
-    loadPwVersion = async (version) => {
+    }
+    getMetricsJSONPath() {
+        return this.metricsJSONPath;
+    }
+    setPwVersions(versions) {
+        return (this.pwVersions = versions);
+    }
+    async loadPwVersion(version) {
         const versions = this.getPwVersions();
         try {
             return await import(versions[version] || versions['default']);
@@ -230,107 +282,107 @@ export class Config extends EventEmitter {
             debug.log('Error importing Playwright. Using default version', err);
             return playwright;
         }
-    };
-    setDataDir = async (newDataDir) => {
+    }
+    async setDataDir(newDataDir) {
         if (!(await exists(newDataDir))) {
             throw new Error(`New data-directory "${newDataDir}" doesn't exist, did you forget to mount or create it?`);
         }
         this.dataDir = newDataDir;
         this.emit('data-dir', newDataDir);
         return this.dataDir;
-    };
-    setRoutes = (newRoutePath) => {
+    }
+    setRoutes(newRoutePath) {
         this.emit('routes', newRoutePath);
         return (this.routes = newRoutePath);
-    };
-    setConcurrent = (newConcurrent) => {
+    }
+    setConcurrent(newConcurrent) {
         this.emit('concurrent', newConcurrent);
         return (this.concurrent = newConcurrent);
-    };
-    setQueued = (newQueued) => {
+    }
+    setQueued(newQueued) {
         this.emit('queued', newQueued);
         return (this.queued = newQueued);
-    };
-    setToken = (newToken) => {
+    }
+    setToken(newToken) {
         this.emit('token', newToken);
         return (this.token = newToken);
-    };
-    setTimeout = (newTimeout) => {
+    }
+    setTimeout(newTimeout) {
         this.emit('timeout', newTimeout);
         return (this.timeout = newTimeout);
-    };
-    setStatic = (newStatic) => {
+    }
+    setStatic(newStatic) {
         this.emit('static', newStatic);
         return (this.static = newStatic);
-    };
-    setRetries = (newRetries) => {
+    }
+    setRetries(newRetries) {
         this.emit('retries', newRetries);
         return (this.retries = newRetries);
-    };
-    setCPULimit = (limit) => {
+    }
+    setCPULimit(limit) {
         this.emit('cpuLimit', limit);
         return (this.maxCpu = limit);
-    };
-    setMemoryLimit = (limit) => {
+    }
+    setMemoryLimit(limit) {
         this.emit('memoryLimit', limit);
         return (this.maxMemory = limit);
-    };
-    enableHealthChecks = (enable) => {
+    }
+    enableHealthChecks(enable) {
         this.emit('healthCheck', enable);
         return (this.healthCheck = enable);
-    };
-    enableGETRequests = (enable) => {
+    }
+    enableGETRequests(enable) {
         this.emit('getRequests', enable);
         return (this.allowGet = enable);
-    };
-    enableCORS = (enable) => {
+    }
+    enableCORS(enable) {
         this.emit('cors', enable);
         return (this.allowCors = enable);
-    };
-    setCORSMethods = (methods) => {
+    }
+    setCORSMethods(methods) {
         this.emit('corsMethods', methods);
         return (this.corsMethods = methods);
-    };
-    setCORSOrigin = (origin) => {
+    }
+    setCORSOrigin(origin) {
         this.emit('corsOrigin', origin);
         return (this.corsOrigin = origin);
-    };
-    setCORSMaxAge = (maxAge) => {
+    }
+    setCORSMaxAge(maxAge) {
         this.emit('corsMaxAge', maxAge);
         return (this.corsMaxAge = maxAge);
-    };
-    setFailedHealthURL = (url) => {
+    }
+    setFailedHealthURL(url) {
         this.emit('failedHealthURL');
         return (this.failedHealthURL = url);
-    };
-    setQueueAlertURL = (url) => {
+    }
+    setQueueAlertURL(url) {
         this.emit('queueAlertURL');
         return (this.queueAlertURL = url);
-    };
-    setRejectAlertURL = (url) => {
+    }
+    setRejectAlertURL(url) {
         this.emit('rejectAlertURL');
         return (this.rejectAlertURL = url);
-    };
-    setTimeoutAlertURL = (url) => {
+    }
+    setTimeoutAlertURL(url) {
         this.emit('timeoutAlertURL');
         return (this.timeoutAlertURL = url);
-    };
-    setErrorAlertURL = (url) => {
+    }
+    setErrorAlertURL(url) {
         this.emit('errorAlertURL');
         return (this.errorAlertURL = url);
-    };
-    setMetricsJSONPath = (path) => {
+    }
+    setMetricsJSONPath(path) {
         this.emit('metricsJSONPath', path);
         return (this.metricsJSONPath = path);
-    };
-    setPort = (port) => {
+    }
+    setPort(port) {
         this.emit('port', port);
         return (this.port = port);
-    };
-    setAllowFileProtocol = (allow) => {
+    }
+    setAllowFileProtocol(allow) {
         this.emit('allowFileProtocol', allow);
         return (this.allowFileProtocol = allow);
-    };
+    }
     /**
      * Returns the fully-qualified server address, which
      * includes host, protocol, and port for which the
@@ -340,11 +392,13 @@ export class Config extends EventEmitter {
      *
      * @returns Fully-qualified server address
      */
-    getServerAddress = () => this.port === 443
-        ? `https://${this.host}:${this.port}`
-        : this.port === 80
-            ? `http://${this.host}`
-            : `http://${this.host}:${this.port}`;
+    getServerAddress() {
+        return this.port === 443
+            ? `https://${this.host}:${this.port}`
+            : this.port === 80
+                ? `http://${this.host}`
+                : `http://${this.host}:${this.port}`;
+    }
     /**
      * Returns the fully-qualified URL for the
      * external address that browserless might be
@@ -353,7 +407,9 @@ export class Config extends EventEmitter {
      *
      * @returns {string} The URL to reach the server
      */
-    getExternalAddress = () => this.external ?? this.getServerAddress();
+    getExternalAddress() {
+        return this.external ?? this.getServerAddress();
+    }
     /**
      * Set the external URL, which Browserless uses for encoding
      * URLs over the HOST:PORT that it's bound to.
@@ -361,7 +417,9 @@ export class Config extends EventEmitter {
      * @param address The fully-qualified URL, eg https://www.example.com/
      * @returns {string} The address
      */
-    setExternalAddress = (address) => (this.external = address);
+    setExternalAddress(address) {
+        return (this.external = address);
+    }
     /**
      * Returns the fully-qualified WebSocket URL for the
      * external address that browserless might be
@@ -370,33 +428,35 @@ export class Config extends EventEmitter {
      *
      * @returns {string} The URL to reach the server
      */
-    getExternalWebSocketAddress = () => {
+    getExternalWebSocketAddress() {
         const httpAddress = new URL(this.external ?? this.getServerAddress());
         httpAddress.protocol = httpAddress.protocol.startsWith('https')
             ? 'wss:'
             : 'ws:';
         return httpAddress.href;
-    };
+    }
     /**
      * When CORS is enabled, returns relevant CORS headers
      * to requests and for the OPTIONS call. Values can be
      * overridden by specifying `CORS_ALLOW_METHODS`, `CORS_ALLOW_ORIGIN`,
      * and `CORS_MAX_AGE`
      */
-    getCORSHeaders = () => ({
-        'Access-Control-Allow-Methods': this.corsMethods,
-        'Access-Control-Allow-Origin': this.corsOrigin,
-        'Access-Control-Max-Age': this.corsMaxAge,
-    });
+    getCORSHeaders() {
+        return {
+            'Access-Control-Allow-Methods': this.corsMethods,
+            'Access-Control-Allow-Origin': this.corsOrigin,
+            'Access-Control-Max-Age': this.corsMaxAge,
+        };
+    }
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown = async () => {
+    async shutdown() {
         await this.stop();
-    };
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/build/file-system.d.ts

@@ -17,7 +17,7 @@ export declare class FileSystem extends EventEmitter {
      * @param newContent A string of new content to add to the file
      * @returns void
      */
-    append: (path: string, newContent: string, shouldEncode: boolean) => Promise<void>;
+    append(path: string, newContent: string, shouldEncode: boolean): Promise<void>;
     /**
      * Reads contents from the local map, if any exist, or loads
      * from the file system and hydrates the cache for the particular filepath
@@ -25,14 +25,14 @@ export declare class FileSystem extends EventEmitter {
      * @param path The filepath of the contents to read
      * @returns Promise of the contents separated by newlines
      */
-    read: (path: string, encoded: boolean) => Promise<string[]>;
+    read(path: string, encoded: boolean): Promise<string[]>;
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown: () => Promise<void>;
+    shutdown(): Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop: () => void;
+    stop(): void;
 }

package/build/file-system.js

@@ -20,7 +20,7 @@ export class FileSystem extends EventEmitter {
      * @param newContent A string of new content to add to the file
      * @returns void
      */
-    append = async (path, newContent, shouldEncode) => {
+    async append(path, newContent, shouldEncode) {
         const contents = await this.read(path, shouldEncode);
         contents.push(newContent);
         this.fsMap.set(path, contents);
@@ -28,7 +28,7 @@ export class FileSystem extends EventEmitter {
             ? await encrypt(contents.join('\n'), this.currentAESKey)
             : contents.join('\n');
         return writeFile(path, encoded.toString());
-    };
+    }
     /**
      * Reads contents from the local map, if any exist, or loads
      * from the file system and hydrates the cache for the particular filepath
@@ -36,7 +36,7 @@ export class FileSystem extends EventEmitter {
      * @param path The filepath of the contents to read
      * @returns Promise of the contents separated by newlines
      */
-    read = async (path, encoded) => {
+    async read(path, encoded) {
         const hasKey = this.fsMap.has(path);
         if (hasKey) {
             return this.fsMap.get(path);
@@ -48,16 +48,16 @@ export class FileSystem extends EventEmitter {
         const splitContents = decoded.length ? decoded.split('\n') : [];
         this.fsMap.set(path, splitContents);
         return splitContents;
-    };
+    }
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown = async () => {
-        await this.stop();
-    };
+    async shutdown() {
+        return await this.stop();
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/build/hooks.d.ts

@@ -10,9 +10,9 @@ export declare class Hooks extends EventEmitter {
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown: () => Promise<void>;
+    shutdown(): Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop: () => void;
+    stop(): void;
 }

package/build/hooks.js

@@ -27,11 +27,11 @@ export class Hooks extends EventEmitter {
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown = async () => {
-        await this.stop();
-    };
+    async shutdown() {
+        return await this.stop();
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/build/limiter.d.ts

@@ -5,7 +5,7 @@ export type ErrorFn<TArgs extends unknown[]> = (...args: TArgs) => void;
 interface Job {
     (): Promise<unknown>;
     args: unknown[];
-    onTimeoutFn: (job: Job) => unknown;
+    onTimeoutFn(job: Job): unknown;
     start: number;
     timeout: number;
 }
@@ -43,15 +43,15 @@ export declare class Limiter extends q {
     get willQueue(): boolean;
     get concurrencySize(): number;
     get hasCapacity(): boolean;
-    limit: <TArgs extends unknown[], TResult>(limitFn: LimitFn<TArgs, TResult>, overCapacityFn: ErrorFn<TArgs>, onTimeoutFn: ErrorFn<TArgs>, timeoutOverrideFn: (...args: TArgs) => number | undefined) => LimitFn<TArgs, unknown>;
+    limit<TArgs extends unknown[], TResult>(limitFn: LimitFn<TArgs, TResult>, overCapacityFn: ErrorFn<TArgs>, onTimeoutFn: ErrorFn<TArgs>, timeoutOverrideFn: (...args: TArgs) => number | undefined): LimitFn<TArgs, unknown>;
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown: () => Promise<void>;
+    shutdown(): Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop: () => void;
+    stop(): void;
 }
 export {};

package/build/limiter.js

@@ -34,12 +34,12 @@ export class Limiter extends q {
             this.timeout = timeout <= 0 ? 0 : timeout;
         });
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.addEventListener('timeout', this.handleJobTimeout);
+        this.addEventListener('timeout', this.handleJobTimeout.bind(this));
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.addEventListener('success', this.handleSuccess);
+        this.addEventListener('success', this.handleSuccess.bind(this));
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.addEventListener('error', this.handleFail);
-        this.addEventListener('end', this.handleEnd);
+        this.addEventListener('error', this.handleFail.bind(this));
+        this.addEventListener('end', this.handleEnd.bind(this));
     }
     handleEnd() {
         this.logQueue('All jobs complete.');
@@ -100,7 +100,7 @@ export class Limiter extends q {
     get hasCapacity() {
         return this.length < this.concurrency + this.queued;
     }
-    limit = (limitFn, overCapacityFn, onTimeoutFn, timeoutOverrideFn) => {
+    limit(limitFn, overCapacityFn, onTimeoutFn, timeoutOverrideFn) {
         return (...args) => new Promise(async (res, rej) => {
             const timeout = timeoutOverrideFn(...args) ?? this.timeout;
             this.logQueue(`Adding to queue, max time allowed is ${timeout.toLocaleString()}ms`);
@@ -148,16 +148,16 @@ export class Limiter extends q {
             this.push(job);
             return bound;
         });
-    };
+    }
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown = async () => {
-        await this.stop();
-    };
+    async shutdown() {
+        return await this.stop();
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/build/logger.d.ts

@@ -10,10 +10,10 @@ export declare class Logger {
     protected _fatal: (...args: unknown[]) => void;
     constructor(prefix: string, request?: Request | undefined);
     protected get reqInfo(): string;
-    trace: (...messages: unknown[]) => void;
-    debug: (...messages: unknown[]) => void;
-    info: (...messages: unknown[]) => void;
-    warn: (...messages: unknown[]) => void;
-    error: (...messages: unknown[]) => void;
-    fatal: (...messages: unknown[]) => void;
+    trace(...messages: unknown[]): void;
+    debug(...messages: unknown[]): void;
+    info(...messages: unknown[]): void;
+    warn(...messages: unknown[]): void;
+    error(...messages: unknown[]): void;
+    fatal(...messages: unknown[]): void;
 }

package/build/logger.js

@@ -22,22 +22,22 @@ export class Logger {
     get reqInfo() {
         return this.request ? this.request.socket.remoteAddress ?? 'Unknown' : '';
     }
-    trace = (...messages) => {
+    trace(...messages) {
         this._trace(this.reqInfo, ...messages);
-    };
-    debug = (...messages) => {
+    }
+    debug(...messages) {
         this._debug(this.reqInfo, ...messages);
-    };
-    info = (...messages) => {
+    }
+    info(...messages) {
         this._info(this.reqInfo, ...messages);
-    };
-    warn = (...messages) => {
+    }
+    warn(...messages) {
         this._warn(this.reqInfo, ...messages);
-    };
-    error = (...messages) => {
+    }
+    error(...messages) {
         this._error(this.reqInfo, ...messages);
-    };
-    fatal = (...messages) => {
+    }
+    fatal(...messages) {
         this._fatal(this.reqInfo, ...messages);
-    };
+    }
 }