@crawlee/browser-pool 3.0.0-alpha.1 → 3.0.0-alpha.3

package/dist/abstract-classes/browser-controller.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserController = void 0;
+const nanoid_1 = require("nanoid");
+const tiny_typed_emitter_1 = require("tiny-typed-emitter");
+const timeout_1 = require("@apify/timeout");
+const logger_1 = require("../logger");
+const utils_1 = require("./utils");
+const PROCESS_KILL_TIMEOUT_MILLIS = 5000;
+/**
+ * The `BrowserController` serves two purposes. First, it is the base class that
+ * specialized controllers like `PuppeteerController` or `PlaywrightController`
+ * extend. Second, it defines the public interface of the specialized classes
+ * which provide only private methods. Therefore, we do not keep documentation
+ * for the specialized classes, because it's the same for all of them.
+ * @hideconstructor
+ */
+class BrowserController extends tiny_typed_emitter_1.TypedEmitter {
+    constructor(browserPlugin) {
+        super();
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (0, nanoid_1.nanoid)()
+        });
+        /**
+         * The `BrowserPlugin` instance used to launch the browser.
+         */
+        Object.defineProperty(this, "browserPlugin", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Browser representation of the underlying automation library.
+         */
+        Object.defineProperty(this, "browser", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        /**
+         * The configuration the browser was launched with.
+         */
+        Object.defineProperty(this, "launchContext", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        Object.defineProperty(this, "isActive", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "activePages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "totalPages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "lastPageOpenedAt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: Date.now()
+        });
+        Object.defineProperty(this, "_activate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "isActivePromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Promise((resolve) => {
+                this._activate = resolve;
+            })
+        });
+        Object.defineProperty(this, "commitBrowser", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "hasBrowserPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Promise((resolve) => {
+                this.commitBrowser = resolve;
+            })
+        });
+        this.browserPlugin = browserPlugin;
+    }
+    /**
+     * Activates the BrowserController. If you try to open new pages before
+     * activation, the pages will get queued and will only be opened after
+     * activate is called.
+     * @ignore
+     */
+    activate() {
+        if (!this.browser) {
+            throw new Error('Cannot activate BrowserController without an assigned browser.');
+        }
+        this._activate();
+        this.isActive = true;
+    }
+    /**
+     * @ignore
+     */
+    assignBrowser(browser, launchContext) {
+        if (this.browser) {
+            throw new Error('BrowserController already has a browser instance assigned.');
+        }
+        this.browser = browser;
+        this.launchContext = launchContext;
+        this.commitBrowser();
+    }
+    /**
+     * Gracefully closes the browser and makes sure
+     * there will be no lingering browser processes.
+     *
+     * Emits 'browserClosed' event.
+     */
+    async close() {
+        await this.hasBrowserPromise;
+        try {
+            await this._close();
+            // TODO: shouldn't this go in a finally instead?
+            this.isActive = false;
+        }
+        catch (error) {
+            logger_1.log.debug(`Could not close browser.\nCause: ${error.message}`, { id: this.id });
+        }
+        this.emit("browserClosed" /* BROWSER_CLOSED */, this);
+        setTimeout(() => {
+            this._kill().catch((err) => {
+                logger_1.log.debug(`Could not kill browser.\nCause: ${err.message}`, { id: this.id });
+            });
+        }, PROCESS_KILL_TIMEOUT_MILLIS);
+    }
+    /**
+     * Immediately kills the browser process.
+     *
+     * Emits 'browserClosed' event.
+     */
+    async kill() {
+        await this.hasBrowserPromise;
+        await this._kill();
+        this.emit("browserClosed" /* BROWSER_CLOSED */, this);
+    }
+    /**
+     * Opens new browser page.
+     * @ignore
+     */
+    async newPage(pageOptions) {
+        this.activePages++;
+        this.totalPages++;
+        await this.isActivePromise;
+        const page = await this._newPage(pageOptions);
+        (0, timeout_1.tryCancel)();
+        this.lastPageOpenedAt = Date.now();
+        return page;
+    }
+    async setCookies(page, cookies) {
+        return this._setCookies(page, cookies);
+    }
+    async getCookies(page) {
+        return this._getCookies(page);
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren
+    async _close() {
+        (0, utils_1.throwImplementationNeeded)('_close');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren
+    async _kill() {
+        (0, utils_1.throwImplementationNeeded)('_kill');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars
+    async _newPage(pageOptions) {
+        (0, utils_1.throwImplementationNeeded)('_newPage');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars
+    async _setCookies(page, cookies) {
+        (0, utils_1.throwImplementationNeeded)('_setCookies');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars
+    async _getCookies(page) {
+        (0, utils_1.throwImplementationNeeded)('_getCookies');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars
+    normalizeProxyOptions(proxyUrl, pageOptions) {
+        (0, utils_1.throwImplementationNeeded)('_normalizeProxyOptions');
+    }
+}
+exports.BrowserController = BrowserController;
+//# sourceMappingURL=browser-controller.js.map

package/dist/abstract-classes/browser-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-controller.js","sourceRoot":"","sources":["../../src/abstract-classes/browser-controller.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAChC,2DAAkD;AAClD,4CAA2C;AAG3C,sCAAgC;AAGhC,mCAAoD;AAEpD,MAAM,2BAA2B,GAAG,IAAI,CAAC;AAuEzC;;;;;;;GAOG;AACH,MAAsB,iBAMpB,SAAQ,iCAA2G;IAsCjH,YAAY,aAAkG;QAC1G,KAAK,EAAE,CAAC;QAtCZ;;;;mBAAK,IAAA,eAAM,GAAE;WAAC;QAEd;;WAEG;QACH;;;;;WAAmG;QAEnG;;WAEG;QACH;;;;mBAAwB,SAAU;WAAC;QAEnC;;WAEG;QACH;;;;mBAAqG,SAAU;WAAC;QAEhH;;;;mBAAW,KAAK;WAAC;QAEjB;;;;mBAAc,CAAC;WAAC;QAEhB;;;;mBAAa,CAAC;WAAC;QAEf;;;;mBAAmB,IAAI,CAAC,GAAG,EAAE;WAAC;QAE9B;;;;;WAA+B;QAE/B;;;;mBAA0B,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACpD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YAC7B,CAAC,CAAC;WAAC;QAEH;;;;;WAAmC;QAEnC;;;;mBAA4B,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACtD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;YACjC,CAAC,CAAC;WAAC;QAIC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;SACrF;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,OAAqB,EAAE,aAAkG;QACnI,IAAI,IAAI,CAAC,OAAO,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SACjF;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK;QACP,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAE7B,IAAI;YACA,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,gDAAgD;YAChD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACzB;QAAC,OAAO,KAAK,EAAE;YACZ,YAAG,CAAC,KAAK,CAAC,oCAAqC,KAAe,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;SAC9F;QAED,IAAI,CAAC,IAAI,uCAA2C,IAAI,CAAC,CAAC;QAE1D,UAAU,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACvB,YAAG,CAAC,KAAK,CAAC,mCAAmC,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,2BAA2B,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAC7B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,uCAA2C,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,WAA4B;QACtC,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,eAAe,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC9C,IAAA,mBAAS,GAAE,CAAC;QACZ,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAmB,EAAE,OAAiB;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAmB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,uDAAuD;IACpC,KAAK,CAAC,MAAM;QAC3B,IAAA,iCAAyB,EAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,uDAAuD;IACpC,KAAK,CAAC,KAAK;QAC1B,IAAA,iCAAyB,EAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,0FAA0F;IACvE,KAAK,CAAC,QAAQ,CAAC,WAA4B;QAC1D,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,0FAA0F;IACvE,KAAK,CAAC,WAAW,CAAC,IAAmB,EAAE,OAAiB;QACvE,IAAA,iCAAyB,EAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,0FAA0F;IACvE,KAAK,CAAC,WAAW,CAAC,IAAmB;QACpD,IAAA,iCAAyB,EAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,0FAA0F;IACjF,qBAAqB,CAAC,QAA4B,EAAE,WAAgB;QACzE,IAAA,iCAAyB,EAAC,wBAAwB,CAAC,CAAC;IACxD,CAAC;CACJ;AA5LD,8CA4LC"}

package/dist/abstract-classes/browser-plugin.d.ts

@@ -0,0 +1,91 @@
+import { LaunchContext, LaunchContextOptions } from '../launch-context';
+import { BrowserController } from './browser-controller';
+import { UnwrapPromise } from '../utils';
+/**
+ * Each plugin expects an instance of the object with the `.launch()` property.
+ * For Puppeteer, it is the `puppeteer` module itself, whereas for Playwright
+ * it is one of the browser types, such as `puppeteer.chromium`.
+ * `BrowserPlugin` does not include the library. You can choose any version
+ * or fork of the library. It also keeps `browser-pool` installation small.
+ */
+export interface CommonLibrary {
+    product?: string;
+    launch(...args: unknown[]): Promise<CommonBrowser>;
+    name?: () => string;
+}
+/** @internal */
+export interface CommonBrowser {
+    newPage(...args: unknown[]): Promise<CommonPage>;
+}
+/** @internal */
+export interface CommonPage {
+    close(...args: unknown[]): Promise<unknown>;
+    url(): string | Promise<string>;
+}
+export interface BrowserPluginOptions<LibraryOptions> {
+    /**
+     * Options that will be passed down to the automation library. E.g.
+     * `puppeteer.launch(launchOptions);`. This is a good place to set
+     * options that you want to apply as defaults. To dynamically override
+     * those options per-browser, see the `preLaunchHooks` of {@link BrowserPool}.
+     */
+    launchOptions?: LibraryOptions;
+    /**
+     * Automation libraries configure proxies differently. This helper allows you
+     * to set a proxy URL without worrying about specific implementations.
+     * It also allows you use an authenticated proxy without extra code.
+     */
+    proxyUrl?: string;
+    /**
+     * By default pages share the same browser context.
+     * If set to true each page uses its own context that is destroyed once the page is closed or crashes.
+     *
+     * @default false
+     */
+    useIncognitoPages?: boolean;
+    /**
+     * Path to a User Data Directory, which stores browser session data like cookies and local storage.
+     */
+    userDataDir?: string;
+}
+export declare type CreateLaunchContextOptions<Library extends CommonLibrary, LibraryOptions = Parameters<Library['launch']>[0], LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>, NewPageOptions = Parameters<LaunchResult['newPage']>[0], NewPageResult = UnwrapPromise<ReturnType<LaunchResult['newPage']>>> = Partial<Omit<LaunchContextOptions<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>, 'browserPlugin'>>;
+/**
+ * The `BrowserPlugin` serves two purposes. First, it is the base class that
+ * specialized controllers like `PuppeteerPlugin` or `PlaywrightPlugin` extend.
+ * Second, it allows the user to configure the automation libraries and
+ * feed them to {@link BrowserPool} for use.
+ */
+export declare abstract class BrowserPlugin<Library extends CommonLibrary = CommonLibrary, LibraryOptions = Parameters<Library['launch']>[0], LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>, NewPageOptions = Parameters<LaunchResult['newPage']>[0], NewPageResult = UnwrapPromise<ReturnType<LaunchResult['newPage']>>> {
+    name: string;
+    library: Library;
+    launchOptions: LibraryOptions;
+    proxyUrl?: string;
+    userDataDir?: string;
+    useIncognitoPages: boolean;
+    constructor(library: Library, options?: BrowserPluginOptions<LibraryOptions>);
+    /**
+     * Creates a `LaunchContext` with all the information needed
+     * to launch a browser. Aside from library specific launch options,
+     * it also includes internal properties used by `BrowserPool` for
+     * management of the pool and extra features.
+     */
+    createLaunchContext(options?: CreateLaunchContextOptions<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>;
+    createController(): BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>;
+    /**
+     * Launches the browser using provided launch context.
+     */
+    launch(launchContext?: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): Promise<LaunchResult>;
+    /**
+     * @private
+     */
+    protected abstract _addProxyToLaunchOptions(launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): Promise<void>;
+    /**
+     * @private
+     */
+    protected abstract _launch(launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): Promise<LaunchResult>;
+    /**
+     * @private
+     */
+    protected abstract _createController(): BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>;
+}
+//# sourceMappingURL=browser-plugin.d.ts.map

package/dist/abstract-classes/browser-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-plugin.d.ts","sourceRoot":"","sources":["../../src/abstract-classes/browser-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnD,IAAI,CAAC,EAAE,MAAM,MAAM,CAAC;CACvB;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC1B,OAAO,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACpD;AAED,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACvB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,GAAG,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB,CAAC,cAAc;IAChD;;;;;OAKG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,0BAA0B,CAClC,OAAO,SAAS,aAAa,EAC7B,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EACjD,YAAY,SAAS,aAAa,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EACjF,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvD,aAAa,GAAG,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAClE,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;AAE/H;;;;;GAKG;AACH,8BAAsB,aAAa,CAC/B,OAAO,SAAS,aAAa,GAAG,aAAa,EAC7C,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EACjD,YAAY,SAAS,aAAa,GAAG,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EACjF,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvD,aAAa,GAAG,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAElE,IAAI,SAAyB;IAE7B,OAAO,EAAE,OAAO,CAAC;IAEjB,aAAa,EAAE,cAAc,CAAC;IAE9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,EAAE,OAAO,CAAC;gBAEf,OAAO,EAAE,OAAO,EAAE,OAAO,GAAE,oBAAoB,CAAC,cAAc,CAAM;IAehF;;;;;OAKG;IACH,mBAAmB,CACf,OAAO,GAAE,0BAA0B,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAM,GAC/G,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC;IAmBtF,gBAAgB,IAAI,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC;IAI3G;;OAEG;IACG,MAAM,CACR,aAAa,GAAE,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAA8B,GAChI,OAAO,CAAC,YAAY,CAAC;IAUxB;;OAEG;IAGH,SAAS,CAAC,QAAQ,CAAC,wBAAwB,CAAC,aAAa,EAAE,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9J;;OAEG;IAGH,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrJ;;OAEG;IAGH,SAAS,CAAC,QAAQ,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC;CAGlI"}

package/dist/abstract-classes/browser-plugin.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserPlugin = void 0;
+const tslib_1 = require("tslib");
+const lodash_merge_1 = tslib_1.__importDefault(require("lodash.merge"));
+const launch_context_1 = require("../launch-context");
+const utils_1 = require("./utils");
+;
+/**
+ * The `BrowserPlugin` serves two purposes. First, it is the base class that
+ * specialized controllers like `PuppeteerPlugin` or `PlaywrightPlugin` extend.
+ * Second, it allows the user to configure the automation libraries and
+ * feed them to {@link BrowserPool} for use.
+ */
+class BrowserPlugin {
+    constructor(library, options = {}) {
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: this.constructor.name
+        });
+        Object.defineProperty(this, "library", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "launchOptions", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "proxyUrl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "userDataDir", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "useIncognitoPages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const { launchOptions = {}, proxyUrl, userDataDir, useIncognitoPages = false, } = options;
+        this.library = library;
+        this.launchOptions = launchOptions;
+        this.proxyUrl = proxyUrl && new URL(proxyUrl).href;
+        this.userDataDir = userDataDir;
+        this.useIncognitoPages = useIncognitoPages;
+    }
+    /**
+     * Creates a `LaunchContext` with all the information needed
+     * to launch a browser. Aside from library specific launch options,
+     * it also includes internal properties used by `BrowserPool` for
+     * management of the pool and extra features.
+     */
+    createLaunchContext(options = {}) {
+        const { id, launchOptions = {}, proxyUrl = this.proxyUrl, useIncognitoPages = this.useIncognitoPages, userDataDir = this.userDataDir, } = options;
+        return new launch_context_1.LaunchContext({
+            id,
+            launchOptions: (0, lodash_merge_1.default)({}, this.launchOptions, launchOptions),
+            browserPlugin: this,
+            proxyUrl,
+            useIncognitoPages,
+            userDataDir,
+        });
+    }
+    createController() {
+        return this._createController();
+    }
+    /**
+     * Launches the browser using provided launch context.
+     */
+    async launch(launchContext = this.createLaunchContext()) {
+        const { proxyUrl } = launchContext;
+        if (proxyUrl) {
+            await this._addProxyToLaunchOptions(launchContext);
+        }
+        return this._launch(launchContext);
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars, max-len
+    _addProxyToLaunchOptions(launchContext) {
+        (0, utils_1.throwImplementationNeeded)('_addProxyToLaunchOptions');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren, @typescript-eslint/no-unused-vars, max-len
+    _launch(launchContext) {
+        (0, utils_1.throwImplementationNeeded)('_launch');
+    }
+    /**
+     * @private
+     */
+    // @ts-expect-error Give runtime error as well as compile time
+    // eslint-disable-next-line space-before-function-paren
+    _createController() {
+        (0, utils_1.throwImplementationNeeded)('_createController');
+    }
+}
+exports.BrowserPlugin = BrowserPlugin;
+//# sourceMappingURL=browser-plugin.js.map

package/dist/abstract-classes/browser-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-plugin.js","sourceRoot":"","sources":["../../src/abstract-classes/browser-plugin.ts"],"names":[],"mappings":";;;;AAAA,wEAAiC;AACjC,sDAAwE;AAExE,mCAAoD;AAoDnD,CAAC;AAUF;;;;;GAKG;AACH,MAAsB,aAAa;IAmB/B,YAAY,OAAgB,EAAE,UAAgD,EAAE;QAZhF;;;;mBAAO,IAAI,CAAC,WAAW,CAAC,IAAI;WAAC;QAE7B;;;;;WAAiB;QAEjB;;;;;WAA8B;QAE9B;;;;;WAAkB;QAElB;;;;;WAAqB;QAErB;;;;;WAA2B;QAGvB,MAAM,EACF,aAAa,GAAG,EAAoB,EACpC,QAAQ,EACR,WAAW,EACX,iBAAiB,GAAG,KAAK,GAC5B,GAAG,OAAO,CAAC;QAEZ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;QACnD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CACf,UAA4G,EAAE;QAE9G,MAAM,EACF,EAAE,EACF,aAAa,GAAG,EAAE,EAClB,QAAQ,GAAG,IAAI,CAAC,QAAQ,EACxB,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAC1C,WAAW,GAAG,IAAI,CAAC,WAAW,GACjC,GAAG,OAAO,CAAC;QAEZ,OAAO,IAAI,8BAAa,CAAC;YACrB,EAAE;YACF,aAAa,EAAE,IAAA,sBAAK,EAAC,EAAE,EAAE,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC;YAC3D,aAAa,EAAE,IAAI;YACnB,QAAQ;YACR,iBAAiB;YACjB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB;QACZ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACR,gBAAqG,IAAI,CAAC,mBAAmB,EAAE;QAE/H,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;QAEnC,IAAI,QAAQ,EAAE;YACV,MAAM,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;SACtD;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,mGAAmG;IAChF,wBAAwB,CAAC,aAAkG;QAC1I,IAAA,iCAAyB,EAAC,0BAA0B,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,mGAAmG;IAChF,OAAO,CAAC,aAAkG;QACzH,IAAA,iCAAyB,EAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,uDAAuD;IACpC,iBAAiB;QAChC,IAAA,iCAAyB,EAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;CACJ;AA1GD,sCA0GC"}

package/dist/abstract-classes/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function throwImplementationNeeded(methodName: string): never;
+//# sourceMappingURL=utils.d.ts.map

package/dist/abstract-classes/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/abstract-classes/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,CAEnE"}

package/dist/abstract-classes/utils.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwImplementationNeeded = void 0;
+function throwImplementationNeeded(methodName) {
+    throw new Error(`You need to implement method ${methodName}.`);
+}
+exports.throwImplementationNeeded = throwImplementationNeeded;
+//# sourceMappingURL=utils.js.map

package/dist/abstract-classes/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/abstract-classes/utils.ts"],"names":[],"mappings":";;;AAAA,SAAgB,yBAAyB,CAAC,UAAkB;IACxD,MAAM,IAAI,KAAK,CAAC,gCAAgC,UAAU,GAAG,CAAC,CAAC;AACnE,CAAC;AAFD,8DAEC"}