@zorilla/playwright-extra 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 berstend <github@berstend.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,361 @@
+# playwright-extra [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/zorillajs/zorilla/test.yml?branch=main&event=push)](https://github.com/zorillajs/zorilla/actions) [![npm](https://img.shields.io/npm/v/playwright-extra.svg)](https://www.npmjs.com/package/playwright-extra)
+
+> A modular plugin framework for [playwright](https://github.com/microsoft/playwright) to enable cool [plugins](#plugins) through a clean interface.
+
+**Part of the [zorilla](https://github.com/zorillajs/zorilla) monorepo** - a maintained fork of puppeteer-extra with modern tooling and ESM support.
+
+## Requirements
+
+- Node.js 18+ (ESM only)
+- Playwright 1.x
+
+## Installation
+
+```bash
+pnpm add playwright playwright-extra
+# - or -
+npm install playwright playwright-extra
+```
+
+After installing, make sure to install the Playwright browsers:
+
+```bash
+pnpm exec playwright install
+# - or -
+npx playwright install
+```
+
+## Quickstart
+
+```js
+// playwright-extra is a drop-in replacement for playwright,
+// it augments the installed playwright with plugin functionality
+import { chromium } from 'playwright-extra'
+
+// Load the stealth plugin and use defaults (all tricks to hide playwright usage)
+// Note: playwright-extra is compatible with most puppeteer-extra plugins
+import StealthPlugin from '@zorilla/puppeteer-extra-plugin-stealth'
+
+// Add the plugin to playwright (any number of plugins can be added)
+chromium.use(StealthPlugin())
+
+// That's it, the rest is playwright usage as normal 😊
+const browser = await chromium.launch({ headless: true })
+const page = await browser.newPage()
+
+console.log('Testing the stealth plugin..')
+await page.goto('https://bot.sannysoft.com', { waitUntil: 'networkidle' })
+await page.screenshot({ path: 'stealth.png', fullPage: true })
+
+console.log('All done, check the screenshot. ✨')
+await browser.close()
+```
+
+The above example uses the compatible [`stealth`](https://github.com/zorillajs/zorilla/tree/main/packages/puppeteer-extra-plugin-stealth) plugin, which needs to be installed as well:
+
+```bash
+pnpm add @zorilla/puppeteer-extra-plugin-stealth
+# - or -
+npm install @zorilla/puppeteer-extra-plugin-stealth
+```
+
+If you'd like to see debug output just run your script like so:
+
+```bash
+# macOS/Linux (Bash)
+DEBUG=playwright-extra*,puppeteer-extra-plugin* node myscript.js
+
+# Windows (Powershell)
+$env:DEBUG='playwright-extra*,puppeteer-extra-plugin*'; node myscript.js
+```
+
+### More examples
+
+<details>
+ <summary><strong>TypeScript usage</strong></summary><br/>
+
+`playwright-extra` and most plugins are written in TS, so you get perfect type support out of the box. :)
+
+```ts
+import { chromium } from 'playwright-extra'
+import StealthPlugin from '@zorilla/puppeteer-extra-plugin-stealth'
+
+chromium.use(StealthPlugin())
+
+const browser = await chromium.launch({ headless: true })
+const page = await browser.newPage()
+
+console.log('Testing the stealth plugin..')
+await page.goto('https://bot.sannysoft.com', { waitUntil: 'networkidle' })
+await page.screenshot({ path: 'stealth.png', fullPage: true })
+
+console.log('All done, check the screenshot. ✨')
+await browser.close()
+```
+
+New to TypeScript? Here's a quick setup:
+
+```bash
+# Create new package.json if it's a new project
+pnpm init
+
+# Add TypeScript and dependencies
+pnpm add -D typescript @types/node tsx
+
+# Add dependencies used in the quick start example
+pnpm add playwright playwright-extra @zorilla/puppeteer-extra-plugin-stealth
+
+# Create a TypeScript config
+pnpm tsc --init
+
+# Create source folder for the .ts files
+mkdir src
+
+# Now place the example code above in `src/index.ts`
+
+# Run the TypeScript code directly (no compilation needed)
+pnpm tsx src/index.ts
+```
+
+</details>
+
+<details>
+ <summary><strong>Using different browsers</strong></summary><br/>
+
+```ts
+// Any browser supported by playwright can be used with plugins
+import { chromium, firefox, webkit } from 'playwright-extra'
+
+chromium.use(plugin)
+firefox.use(plugin)
+webkit.use(plugin)
+```
+
+</details>
+
+<details>
+ <summary><strong>Multiple instances with different plugins</strong></summary><br/>
+
+Node.js imports are cached, therefore the default `chromium`, `firefox`, `webkit` exports from `playwright-extra` will always return the same playwright instance.
+
+```ts
+// Use `addExtra` to create fresh and independent instances
+import playwright from 'playwright'
+import { addExtra } from 'playwright-extra'
+
+const chromium1 = addExtra(playwright.chromium)
+const chromium2 = addExtra(playwright.chromium)
+
+chromium1.use(pluginA)
+chromium2.use(pluginB)
+// chromium1 and chromium2 are independent instances
+```
+
+</details>
+
+---
+
+## Plugins
+
+The following plugins are compatible with playwright-extra:
+
+### 🔥 [`@zorilla/puppeteer-extra-plugin-stealth`](https://github.com/zorillajs/zorilla/tree/main/packages/puppeteer-extra-plugin-stealth)
+
+- Applies various evasion techniques to make detection of automated browsers harder
+- Compatible with Puppeteer & Playwright and chromium-based browsers
+
+<details>
+<summary>&nbsp;&nbsp;Example: Using stealth in Playwright with custom options</summary>
+
+```js
+// The stealth plugin is optimized for chromium based browsers
+import { chromium } from 'playwright-extra'
+import StealthPlugin from '@zorilla/puppeteer-extra-plugin-stealth'
+
+chromium.use(StealthPlugin())
+
+// Customize options for specific evasion techniques
+chromium.plugins.setDependencyDefaults('stealth/evasions/webgl.vendor', {
+  vendor: 'Bob',
+  renderer: 'Alice'
+})
+
+// That's it, the rest is playwright usage as normal 😊
+const browser = await chromium.launch({ headless: true })
+const page = await browser.newPage()
+
+console.log('Testing the webgl spoofing feature of the stealth plugin..')
+await page.goto('https://webglreport.com', { waitUntil: 'networkidle' })
+await page.screenshot({ path: 'webgl.png', fullPage: true })
+
+console.log('All done, check the screenshot. ✨')
+await browser.close()
+```
+
+</details>
+
+### 🏴 [`puppeteer-extra-plugin-recaptcha`](https://github.com/zorillajs/zorilla/tree/main/packages/puppeteer-extra-plugin-recaptcha)
+
+- Solves reCAPTCHAs and hCaptchas automatically, using a single line of code: `page.solveRecaptchas()`
+- Compatible with Puppeteer & Playwright and all browsers (chromium, firefox, webkit)
+
+<details>
+<summary>&nbsp;&nbsp;Example: Solving captchas in Playwright & Firefox</summary>
+
+```js
+// Any browser (chromium, webkit, firefox) can be used
+import { firefox } from 'playwright-extra'
+import RecaptchaPlugin from 'puppeteer-extra-plugin-recaptcha'
+
+firefox.use(
+  RecaptchaPlugin({
+    provider: {
+      id: '2captcha',
+      token: process.env.TWOCAPTCHA_TOKEN || 'YOUR_API_KEY'
+    }
+  })
+)
+
+// Works in headless as well
+const browser = await firefox.launch({ headless: false })
+const context = await browser.newContext()
+const page = await context.newPage()
+
+await page.goto('https://www.google.com/recaptcha/api2/demo', {
+  waitUntil: 'networkidle'
+})
+
+console.log('Solving captchas..')
+await page.solveRecaptchas()
+
+await Promise.all([
+  page.waitForNavigation({ waitUntil: 'networkidle' }),
+  page.click('#recaptcha-demo-submit')
+])
+
+const content = await page.content()
+const isSuccess = content.includes('Verification Success')
+console.log('Done', { isSuccess })
+await browser.close()
+```
+
+</details>
+
+### 📡 [`@zorilla/plugin-proxy-router`](https://github.com/zorillajs/zorilla/tree/main/packages/plugin-proxy-router)
+
+- Use multiple proxies dynamically with flexible per-host routing
+- Compatible with Puppeteer & Playwright and all browsers (chromium, firefox, webkit)
+
+### 🔌 [`@zorilla/puppeteer-extra-plugin-anonymize-ua`](https://github.com/zorillajs/zorilla/tree/main/packages/puppeteer-extra-plugin-anonymize-ua)
+
+- Anonymizes the user-agent on all pages
+- Compatible with Puppeteer & Playwright
+
+**Additional Resources**
+
+- For adblocking, consider using [@cliqz/adblocker-playwright](https://www.npmjs.com/package/@cliqz/adblocker-playwright) or [blocking resources natively](https://playwright.dev/docs/network#handle-requests)
+- To write your own plugins, check out the [`@zorilla/puppeteer-extra-plugin`](https://github.com/zorillajs/zorilla/tree/main/packages/puppeteer-extra-plugin) base class
+
+---
+
+## Development
+
+This package is part of the [zorilla monorepo](https://github.com/zorillajs/zorilla) and uses:
+- **TypeScript** for type safety (ESM only, no CommonJS support)
+- **Playwright Test** for testing across chromium, firefox, and webkit
+- **c8** for coverage reporting
+- **Biome** for linting and formatting
+
+### Building and Testing
+
+```bash
+# Install dependencies (from monorepo root)
+pnpm install
+
+# Build the package
+pnpm build
+
+# Run tests (requires Playwright browsers to be installed)
+pnpm test
+
+# Run tests with coverage
+pnpm test:coverage
+```
+
+### Code Quality
+
+```bash
+# Check code formatting and linting
+npx biome check .
+
+# Auto-fix formatting issues
+npx biome check --write .
+```
+
+### Browser Installation
+
+Tests require Playwright browsers. Install them with:
+
+```bash
+pnpm exec playwright install
+```
+
+---
+
+## API
+
+### Default Export
+
+The package exports augmented browser launchers that work as drop-in replacements for playwright:
+
+```ts
+import { chromium, firefox, webkit } from 'playwright-extra'
+```
+
+### `addExtra(launcher)`
+
+Create a fresh playwright-extra instance with its own plugin registry:
+
+```ts
+import { addExtra } from 'playwright-extra'
+import playwright from 'playwright'
+
+const chromium = addExtra(playwright.chromium)
+```
+
+### `launcher.use(plugin)`
+
+Register a plugin with the browser launcher:
+
+```ts
+chromium.use(StealthPlugin())
+```
+
+### `launcher.plugins`
+
+Access the plugin registry to configure plugins:
+
+```ts
+// Set default options for a plugin dependency
+chromium.plugins.setDependencyDefaults('stealth/evasions/webgl.vendor', {
+  vendor: 'Custom',
+  renderer: 'Custom'
+})
+
+// List registered plugins
+console.log(chromium.plugins.names)
+```
+
+---
+
+## Contributors
+
+<a href="https://github.com/zorillajs/zorilla/graphs/contributors">
+  <img src="https://contributors-img.firebaseapp.com/image?repo=zorillajs/zorilla" />
+</a>
+
+---
+
+## License
+
+Copyright © 2018 - 2025, [berstend](https://github.com/berstend). Released under the MIT License.

package/dist/extra.d.ts

@@ -0,0 +1,54 @@
+import type * as pw from 'playwright-core';
+import { PluginList } from './plugins.js';
+import type { CompatiblePlugin } from './types/index.js';
+type PlaywrightBrowserLauncher = pw.BrowserType;
+/**
+ * The Playwright browser launcher APIs we're augmenting
+ * @private
+ */
+interface AugmentedLauncherAPIs extends Pick<PlaywrightBrowserLauncher, 'launch' | 'launchPersistentContext' | 'connect' | 'connectOverCDP'> {
+}
+/**
+ * Modular plugin framework to teach `playwright` new tricks.
+ */
+export declare class PlaywrightExtraClass implements AugmentedLauncherAPIs {
+    private _launcher?;
+    /** Plugin manager */
+    readonly plugins: PluginList;
+    constructor(_launcher?: Partial<PlaywrightBrowserLauncher> | undefined);
+    /**
+     * The **main interface** to register plugins.
+     *
+     * Can be called multiple times to enable multiple plugins.
+     *
+     * Plugins derived from `PuppeteerExtraPlugin` will be used with a compatiblity layer.
+     *
+     * @example
+     * chromium.use(plugin1).use(plugin2)
+     * firefox.use(plugin1).use(plugin2)
+     *
+     * @see [PuppeteerExtraPlugin]
+     *
+     * @return The same `PlaywrightExtra` instance (for optional chaining)
+     */
+    use(plugin: CompatiblePlugin): this;
+    launch(...args: Parameters<PlaywrightBrowserLauncher['launch']>): ReturnType<PlaywrightBrowserLauncher['launch']>;
+    launchPersistentContext(...args: Parameters<PlaywrightBrowserLauncher['launchPersistentContext']>): ReturnType<PlaywrightBrowserLauncher['launchPersistentContext']>;
+    connect(wsEndpointOrOptions: string | (pw.ConnectOptions & {
+        wsEndpoint?: string;
+    }), wsOptions?: pw.ConnectOptions): ReturnType<PlaywrightBrowserLauncher['connect']>;
+    connectOverCDP(wsEndpointOrOptions: string | (pw.ConnectOverCDPOptions & {
+        endpointURL?: string;
+    }), wsOptions?: pw.ConnectOverCDPOptions): ReturnType<PlaywrightBrowserLauncher['connectOverCDP']>;
+    protected _bindBrowserContextEvents(context: pw.BrowserContext, contextOptions?: pw.BrowserContextOptions): Promise<void>;
+    protected _bindBrowserEvents(browser: pw.Browser): Promise<void>;
+}
+/**
+ * PlaywrightExtra class with additional launcher methods.
+ *
+ * Augments the class with an instance proxy to pass on methods that are not augmented to the original target.
+ *
+ */
+export declare const PlaywrightExtra: typeof PlaywrightExtraClass;
+export {};
+//# sourceMappingURL=extra.d.ts.map

package/dist/extra.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extra.d.ts","sourceRoot":"","sources":["../src/extra.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAG3C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAU,MAAM,kBAAkB,CAAC;AAEjE,KAAK,yBAAyB,GAAG,EAAE,CAAC,WAAW,CAAC;AAEhD;;;GAGG;AACH,UAAU,qBACR,SAAQ,IAAI,CACV,yBAAyB,EACzB,QAAQ,GAAG,yBAAyB,GAAG,SAAS,GAAG,gBAAgB,CACpE;CAAG;AAEN;;GAEG;AACH,qBAAa,oBAAqB,YAAW,qBAAqB;IAIpD,OAAO,CAAC,SAAS,CAAC;IAH9B,qBAAqB;IACrB,SAAgB,OAAO,EAAE,UAAU,CAAC;gBAEhB,SAAS,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,YAAA;IAIlE;;;;;;;;;;;;;;OAcG;IACI,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IA4B7B,MAAM,CACjB,GAAG,IAAI,EAAE,UAAU,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,GACvD,UAAU,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IA8BrC,uBAAuB,CAClC,GAAG,IAAI,EAAE,UAAU,CAAC,yBAAyB,CAAC,yBAAyB,CAAC,CAAC,GACxE,UAAU,CAAC,yBAAyB,CAAC,yBAAyB,CAAC,CAAC;IAuB7D,OAAO,CACX,mBAAmB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,cAAc,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,EAC3E,SAAS,GAAE,EAAE,CAAC,cAAmB,GAChC,UAAU,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;IA2C7C,cAAc,CAClB,mBAAmB,EACf,MAAM,GACN,CAAC,EAAE,CAAC,qBAAqB,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,EACzD,SAAS,GAAE,EAAE,CAAC,qBAA0B,GACvC,UAAU,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;cA2C1C,yBAAyB,CACvC,OAAO,EAAE,EAAE,CAAC,cAAc,EAC1B,cAAc,CAAC,EAAE,EAAE,CAAC,qBAAqB;cA4B3B,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO;CAsBvD;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,6BAc1B,CAAC"}

package/dist/extra.js

@@ -0,0 +1,231 @@
+import Debug from 'debug';
+const debug = Debug('playwright-extra');
+import { playwrightLoader } from './helper/loader.js';
+import { PluginList } from './plugins.js';
+/**
+ * Modular plugin framework to teach `playwright` new tricks.
+ */
+export class PlaywrightExtraClass {
+    _launcher;
+    /** Plugin manager */
+    plugins;
+    constructor(_launcher) {
+        this._launcher = _launcher;
+        this.plugins = new PluginList();
+    }
+    /**
+     * The **main interface** to register plugins.
+     *
+     * Can be called multiple times to enable multiple plugins.
+     *
+     * Plugins derived from `PuppeteerExtraPlugin` will be used with a compatiblity layer.
+     *
+     * @example
+     * chromium.use(plugin1).use(plugin2)
+     * firefox.use(plugin1).use(plugin2)
+     *
+     * @see [PuppeteerExtraPlugin]
+     *
+     * @return The same `PlaywrightExtra` instance (for optional chaining)
+     */
+    use(plugin) {
+        const isValid = plugin && 'name' in plugin;
+        if (!isValid) {
+            throw new Error('A plugin must be provided to .use()');
+        }
+        if (this.plugins.add(plugin)) {
+            debug('Plugin registered', plugin.name);
+        }
+        return this;
+    }
+    /**
+     * In order to support a default export which will require vanilla playwright automatically,
+     * as well as `addExtra` to patch a provided launcher, we need to so some gymnastics here.
+     *
+     * Otherwise this would throw immediately, even when only using the `addExtra` export with an arbitrary compatible launcher.
+     *
+     * The solution is to make the vanilla launcher optional and only throw once we try to effectively use and can't find it.
+     *
+     * @internal
+     */
+    get launcher() {
+        if (!this._launcher) {
+            throw playwrightLoader.requireError;
+        }
+        return this._launcher;
+    }
+    async launch(...args) {
+        if (!this.launcher.launch) {
+            throw new Error('Launcher does not support "launch"');
+        }
+        let [options] = args;
+        options = { args: [], ...(options || {}) }; // Initialize args array
+        debug('launch', options);
+        this.plugins.prepare();
+        // Give plugins the chance to modify the options before continuing
+        options =
+            (await this.plugins.dispatchBlocking('beforeLaunch', options)) || options;
+        debug('launch with options', options);
+        if ('userDataDir' in options) {
+            debug("A plugin defined userDataDir during .launch, which isn't supported by playwright - ignoring");
+            const { userDataDir: _, ...optionsWithoutUserDataDir } = options;
+            options = optionsWithoutUserDataDir;
+        }
+        const browser = await this.launcher.launch(options);
+        await this.plugins.dispatchBlocking('onBrowser', browser);
+        await this._bindBrowserEvents(browser);
+        await this.plugins.dispatchBlocking('afterLaunch', browser);
+        return browser;
+    }
+    async launchPersistentContext(...args) {
+        if (!this.launcher.launchPersistentContext) {
+            throw new Error('Launcher does not support "launchPersistentContext"');
+        }
+        let [userDataDir, options] = args;
+        options = { args: [], ...(options || {}) }; // Initialize args array
+        debug('launchPersistentContext', options);
+        this.plugins.prepare();
+        // Give plugins the chance to modify the options before continuing
+        options =
+            (await this.plugins.dispatchBlocking('beforeLaunch', options)) || options;
+        const context = await this.launcher.launchPersistentContext(userDataDir, options);
+        await this.plugins.dispatchBlocking('afterLaunch', context);
+        this._bindBrowserContextEvents(context);
+        return context;
+    }
+    async connect(wsEndpointOrOptions, wsOptions = {}) {
+        if (!this.launcher.connect) {
+            throw new Error('Launcher does not support "connect"');
+        }
+        this.plugins.prepare();
+        // Playwright currently supports two function signatures for .connect
+        let options = {};
+        let wsEndpointAsString = false;
+        if (typeof wsEndpointOrOptions === 'object') {
+            options = { ...wsEndpointOrOptions, ...wsOptions };
+        }
+        else {
+            wsEndpointAsString = true;
+            options = { wsEndpoint: wsEndpointOrOptions, ...wsOptions };
+        }
+        debug('connect', options);
+        // Give plugins the chance to modify the options before launch/connect
+        options =
+            (await this.plugins.dispatchBlocking('beforeConnect', options)) ||
+                options;
+        // Follow call signature of end user
+        const args = [];
+        const wsEndpoint = options.wsEndpoint;
+        if (wsEndpointAsString) {
+            delete options.wsEndpoint;
+            args.push(wsEndpoint, options);
+        }
+        else {
+            args.push(options);
+        }
+        const connectFn = this.launcher.connect;
+        const browser = await connectFn.call(this.launcher, ...args);
+        await this.plugins.dispatchBlocking('onBrowser', browser);
+        await this._bindBrowserEvents(browser);
+        await this.plugins.dispatchBlocking('afterConnect', browser);
+        return browser;
+    }
+    async connectOverCDP(wsEndpointOrOptions, wsOptions = {}) {
+        if (!this.launcher.connectOverCDP) {
+            throw new Error(`Launcher does not implement 'connectOverCDP'`);
+        }
+        this.plugins.prepare();
+        // Playwright currently supports two function signatures for .connectOverCDP
+        let options = {};
+        let wsEndpointAsString = false;
+        if (typeof wsEndpointOrOptions === 'object') {
+            options = { ...wsEndpointOrOptions, ...wsOptions };
+        }
+        else {
+            wsEndpointAsString = true;
+            options = { endpointURL: wsEndpointOrOptions, ...wsOptions };
+        }
+        debug('connectOverCDP', options);
+        // Give plugins the chance to modify the options before launch/connect
+        options =
+            (await this.plugins.dispatchBlocking('beforeConnect', options)) ||
+                options;
+        // Follow call signature of end user
+        const args = [];
+        const endpointURL = options.endpointURL;
+        if (wsEndpointAsString) {
+            delete options.endpointURL;
+            args.push(endpointURL, options);
+        }
+        else {
+            args.push(options);
+        }
+        const connectOverCDPFn = this.launcher.connectOverCDP;
+        const browser = await connectOverCDPFn.call(this.launcher, ...args);
+        await this.plugins.dispatchBlocking('onBrowser', browser);
+        await this._bindBrowserEvents(browser);
+        await this.plugins.dispatchBlocking('afterConnect', browser);
+        return browser;
+    }
+    async _bindBrowserContextEvents(context, contextOptions) {
+        debug('_bindBrowserContextEvents');
+        this.plugins.dispatch('onContextCreated', context, contextOptions);
+        // Make sure things like `addInitScript` show an effect on the very first page as well
+        context.newPage = ((originalMethod, ctx) => {
+            return async () => {
+                const page = await originalMethod.call(ctx);
+                await page.goto('about:blank');
+                return page;
+            };
+        })(context.newPage, context);
+        context.on('close', () => {
+            // When using `launchPersistentContext` context closing is the same as browser closing
+            if (!context.browser()) {
+                this.plugins.dispatch('onDisconnected');
+            }
+        });
+        context.on('page', page => {
+            this.plugins.dispatch('onPageCreated', page);
+            page.on('close', () => {
+                this.plugins.dispatch('onPageClose', page);
+            });
+        });
+    }
+    async _bindBrowserEvents(browser) {
+        debug('_bindPlaywrightBrowserEvents');
+        browser.on('disconnected', () => {
+            this.plugins.dispatch('onDisconnected', browser);
+        });
+        // Note: `browser.newPage` will implicitly call `browser.newContext` as well
+        browser.newContext = ((originalMethod, ctx) => {
+            return async (options = {}) => {
+                const contextOptions = (await this.plugins.dispatchBlocking('beforeContext', options, browser)) || options;
+                const context = await originalMethod.call(ctx, contextOptions);
+                this._bindBrowserContextEvents(context, contextOptions);
+                return context;
+            };
+        })(browser.newContext, browser);
+    }
+}
+/**
+ * PlaywrightExtra class with additional launcher methods.
+ *
+ * Augments the class with an instance proxy to pass on methods that are not augmented to the original target.
+ *
+ */
+export const PlaywrightExtra = new Proxy(PlaywrightExtraClass, {
+    construct(classTarget, args) {
+        debug(`create instance of ${classTarget.name}`);
+        const result = Reflect.construct(classTarget, args);
+        return new Proxy(result, {
+            get(target, prop) {
+                if (prop in target) {
+                    return Reflect.get(target, prop);
+                }
+                debug('proxying property to original launcher: ', prop);
+                return Reflect.get(target.launcher, prop);
+            },
+        });
+    },
+});
+//# sourceMappingURL=extra.js.map

package/dist/extra.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extra.js","sourceRoot":"","sources":["../src/extra.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,KAAK,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAGxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAe1C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAIX;IAHpB,qBAAqB;IACL,OAAO,CAAa;IAEpC,YAAoB,SAA8C;QAA9C,cAAS,GAAT,SAAS,CAAqC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,GAAG,CAAC,MAAwB;QACjC,MAAM,OAAO,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAgB,CAAC,EAAE,CAAC;YACvC,KAAK,CAAC,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,gBAAgB,CAAC,YAAY,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,MAAM,CACjB,GAAG,IAAqD;QAExD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,wBAAwB;QACpE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAEvB,kEAAkE;QAClE,OAAO;YACL,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC;QAE5E,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;YAC7B,KAAK,CACH,6FAA6F,CAC9F,CAAC;YACF,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,GAAG,yBAAyB,EAAE,GACpD,OAAkC,CAAC;YACrC,OAAO,GAAG,yBAA6C,CAAC;QAC1D,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAClC,GAAG,IAAsE;QAEzE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAClC,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,wBAAwB;QACpE,KAAK,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAEvB,kEAAkE;QAClE,OAAO;YACL,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC;QAE5E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACzD,WAAW,EACX,OAAO,CACR,CAAC;QACF,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,OAAO,CACX,mBAA2E,EAC3E,YAA+B,EAAE;QAEjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAEvB,qEAAqE;QACrE,IAAI,OAAO,GAAgD,EAAE,CAAC;QAC9D,IAAI,kBAAkB,GAAG,KAAK,CAAC;QAC/B,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,EAAE,GAAG,mBAAmB,EAAE,GAAG,SAAS,EAAE,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,kBAAkB,GAAG,IAAI,CAAC;YAC1B,OAAO,GAAG,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,SAAS,EAAE,CAAC;QAC9D,CAAC;QACD,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE1B,sEAAsE;QACtE,OAAO;YACL,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;gBAC/D,OAAO,CAAC;QAEV,oCAAoC;QACpC,MAAM,IAAI,GAAc,EAAE,CAAC;QAC3B,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC,UAAU,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,OAER,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC7D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,mBAEyD,EACzD,YAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAEvB,4EAA4E;QAC5E,IAAI,OAAO,GAAwD,EAAE,CAAC;QACtE,IAAI,kBAAkB,GAAG,KAAK,CAAC;QAC/B,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,EAAE,GAAG,mBAAmB,EAAE,GAAG,SAAS,EAAE,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,kBAAkB,GAAG,IAAI,CAAC;YAC1B,OAAO,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,SAAS,EAAE,CAAC;QAC/D,CAAC;QACD,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAEjC,sEAAsE;QACtE,OAAO;YACL,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;gBAC/D,OAAO,CAAC;QAEV,oCAAoC;QACpC,MAAM,IAAI,GAAc,EAAE,CAAC;QAC3B,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC,WAAW,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,cAEf,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;QAEpE,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC7D,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,yBAAyB,CACvC,OAA0B,EAC1B,cAAyC;QAEzC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QAEnE,sFAAsF;QACtF,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC,cAAc,EAAE,GAAG,EAAE,EAAE;YACzC,OAAO,KAAK,IAAI,EAAE;gBAChB,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5C,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE7B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACvB,sFAAsF;YACtF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YACxB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,OAAmB;QACpD,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAEtC,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;YAC9B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,4EAA4E;QAC5E,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,cAAc,EAAE,GAAG,EAAE,EAAE;YAC5C,OAAO,KAAK,EAAE,UAAoC,EAAE,EAAE,EAAE;gBACtD,MAAM,cAAc,GAClB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAClC,eAAe,EACf,OAAO,EACP,OAAO,CACR,CAAC,IAAI,OAAO,CAAC;gBAChB,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;gBAC/D,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBACxD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,KAAK,CAAC,oBAAoB,EAAE;IAC7D,SAAS,CAAC,WAAW,EAAE,IAAI;QACzB,KAAK,CAAC,sBAAsB,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,CAAyB,CAAC;QAC5E,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;YACvB,GAAG,CAAC,MAAM,EAAE,IAAI;gBACd,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;oBACnB,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACnC,CAAC;gBACD,KAAK,CAAC,0CAA0C,EAAE,IAAI,CAAC,CAAC;gBACxD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC"}