@zorilla/playwright-extra 1.0.0

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAmB,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,oCAAoC;AACpC,MAAM,MAAM,yBAAyB,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;AAC3D,8DAA8D;AAC9D,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GACzD,yBAAyB,CAAC;AAE5B;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACjD,uBAAuB,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;IACzE,cAAc,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;CAC1D;AAgBD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,SAAS,4BAA4B,EACpE,WAAW,QAAQ,KACiB,oBAAoB,GAAG,QAAQ,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,QAAQ,2CAA0C,CAAC;AAChE;;;GAGG;AACH,eAAO,MAAM,OAAO,2CAAyC,CAAC;AAC9D;;;GAGG;AACH,eAAO,MAAM,MAAM,2CAAwC,CAAC;AAG5D,eAAO,MAAM,QAAQ,YAAyC,CAAC;AAC/D,eAAO,MAAM,SAAS,aAA0C,CAAC;AACjE,eAAO,MAAM,OAAO,eAAwC,CAAC;AAC7D,eAAO,MAAM,SAAS,cAA0C,CAAC;AACjE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAwC,CAAC;AAC7D,eAAO,MAAM,MAAM,kBAAuC,CAAC;AAE3D,2CAA2C;AAC3C,QAAA,MAAM,aAAa;;;;eA/CM,QAAQ,SAAS,4BAA4B,aACzD,QAAQ,KACiB,oBAAoB,GAAG,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8DJ,CAAC;AAElE,eAAe,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,80 @@
+import { PlaywrightExtra, PlaywrightExtraClass } from './extra.js';
+import { playwrightLoader as loader } from './helper/loader.js';
+import { PluginList } from './plugins.js';
+export { PlaywrightExtra, PlaywrightExtraClass } from './extra.js';
+export { PluginList } from './plugins.js';
+/**
+ * Augment the provided Playwright browser launcher with plugin functionality.
+ *
+ * Using `addExtra` will always create a fresh PlaywrightExtra instance.
+ *
+ * @example
+ * import playwright from 'playwright'
+ * import { addExtra } from '@zorilla/playwright-extra'
+ *
+ * const chromium = addExtra(playwright.chromium)
+ * chromium.use(plugin)
+ *
+ * @param launcher - Playwright (or compatible) browser launcher
+ */
+export const addExtra = (launcher) => new PlaywrightExtra(launcher);
+/**
+ * This object can be used to launch or connect to Chromium with plugin functionality.
+ *
+ * This default export will behave exactly the same as the regular playwright
+ * (just with extra plugin functionality) and can be used as a drop-in replacement.
+ *
+ * Behind the scenes it will try to require either the `playwright-core`
+ * or `playwright` module from the installed dependencies.
+ *
+ * @note
+ * Due to Node.js import caching this will result in a single
+ * PlaywrightExtra instance, even when used in different files. If you need multiple
+ * instances with different plugins please use `addExtra`.
+ *
+ * @example
+ * // javascript import
+ * // ESM import
+ * import { chromium } from '@zorilla/playwright-extra'
+ *
+ * // Add plugins
+ * chromium.use(...)
+ */
+export const chromium = addExtra(loader.loadModule()?.chromium);
+/**
+ * This object can be used to launch or connect to Firefox with plugin functionality
+ * @note This export will always return the same instance, if you wish to use multiple instances with different plugins use `addExtra`
+ */
+export const firefox = addExtra(loader.loadModule()?.firefox);
+/**
+ * This object can be used to launch or connect to Webkit with plugin functionality
+ * @note This export will always return the same instance, if you wish to use multiple instances with different plugins use `addExtra`
+ */
+export const webkit = addExtra(loader.loadModule()?.webkit);
+// Other playwright module exports we simply re-export with lazy loading
+export const _android = loader.lazyloadExportOrDie('_android');
+export const _electron = loader.lazyloadExportOrDie('_electron');
+export const request = loader.lazyloadExportOrDie('request');
+export const selectors = loader.lazyloadExportOrDie('selectors');
+export const devices = loader.lazyloadExportOrDie('devices');
+export const errors = loader.lazyloadExportOrDie('errors');
+/** Playwright with plugin functionality */
+const moduleExports = {
+    // custom exports
+    PlaywrightExtra,
+    PlaywrightExtraClass,
+    PluginList,
+    addExtra,
+    chromium,
+    firefox,
+    webkit,
+    // vanilla exports
+    _android,
+    _electron,
+    request,
+    selectors,
+    devices,
+    errors,
+};
+export default moduleExports;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,gBAAgB,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAiC1C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,QAAmB,EACnB,EAAE,CAAC,IAAI,eAAe,CAAC,QAAQ,CAAoC,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,QAAQ,CAAC,CAAC;AAChE;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;AAC9D;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,MAAM,CAAC,CAAC;AAE5D,wEAAwE;AACxE,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAC/D,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE3D,2CAA2C;AAC3C,MAAM,aAAa,GAAG;IACpB,iBAAiB;IACjB,eAAe;IACf,oBAAoB;IACpB,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IAEN,kBAAkB;IAClB,QAAQ;IACR,SAAS;IACT,OAAO;IACP,SAAS;IACT,OAAO;IACP,MAAM;CACyD,CAAC;AAElE,eAAe,aAAa,CAAC"}

package/dist/plugins.d.ts

@@ -0,0 +1,84 @@
+import type { CompatiblePluginModule, Plugin, PluginMethodFn, PluginMethodName } from './types/index.js';
+export declare class PluginList {
+    private readonly _plugins;
+    private readonly _dependencyDefaults;
+    private readonly _dependencyResolution;
+    /**
+     * Get a list of all registered plugins.
+     */
+    get list(): import("./types/index.js").PuppeteerExtraPlugin[];
+    /**
+     * Get the names of all registered plugins.
+     */
+    get names(): string[];
+    /** Check if the shape of a plugin is correct or warn */
+    protected isValidPluginInstance(plugin: Plugin): boolean;
+    /** Error callback in case calling a plugin method throws an error. Can be overwritten. */
+    onPluginError(plugin: Plugin, method: PluginMethodName, err: Error): void;
+    /**
+     * Define default values for plugins implicitly required through the `dependencies` plugin stanza.
+     *
+     * @param dependencyPath - The string by which the dependency is listed (not the plugin name)
+     *
+     * @example
+     * chromium.use(stealth)
+     * chromium.plugins.setDependencyDefaults('stealth/evasions/webgl.vendor', { vendor: 'Bob', renderer: 'Alice' })
+     */
+    setDependencyDefaults(dependencyPath: string, opts: unknown): this;
+    /**
+     * Define custom plugin modules for plugins implicitly required through the `dependencies` plugin stanza.
+     *
+     * Using this will prevent dynamic imports from being used, which JS bundlers often have issues with.
+     *
+     * @example
+     * chromium.use(stealth)
+     * chromium.plugins.setDependencyResolution('stealth/evasions/webgl.vendor', VendorPlugin)
+     */
+    setDependencyResolution(dependencyPath: string, pluginModule: CompatiblePluginModule): this;
+    /** Return all plugins using the supplied method */
+    protected filterByMethod(methodName: PluginMethodName): import("./types/index.js").PuppeteerExtraPlugin[];
+    /** Conditionally add puppeteer compatibility to values provided to the plugins */
+    protected _addPuppeteerCompatIfNeeded<TMethod extends PluginMethodName>(plugin: Plugin, method: TMethod, args: Parameters<PluginMethodFn<TMethod>>): Parameters<PluginMethodFn<TMethod>>;
+    /**
+     * Order plugins that have expressed a special placement requirement.
+     *
+     * This is useful/necessary for e.g. plugins that depend on the data from other plugins.
+     *
+     * @private
+     */
+    protected order(): void;
+    /**
+     * Collects the exposed `data` property of all registered plugins.
+     * Will be reduced/flattened to a single array.
+     *
+     * Can be accessed by plugins that listed the `dataFromPlugins` requirement.
+     *
+     * Implemented mainly for plugins that need data from other plugins (e.g. `user-preferences`).
+     *
+     * @see [PuppeteerExtraPlugin]/data
+     * @param name - Filter data by optional name
+     *
+     * @private
+     */
+    protected getData(name?: string): unknown[];
+    /**
+     * Handle `plugins` stanza (already instantiated plugins that don't require dynamic imports)
+     */
+    protected resolvePluginsStanza(): void;
+    /**
+     * Handle `dependencies` stanza (which requires dynamic imports)
+     *
+     * Plugins can define `dependencies` as a Set or Array of dependency paths, or a Map with additional opts
+     *
+     * @note
+     * - The default opts for implicit dependencies can be defined using `setDependencyDefaults()`
+     * - Dynamic imports can be avoided by providing plugin modules with `setDependencyResolution()`
+     */
+    protected resolveDependenciesStanza(): void;
+    /**
+     * Lightweight plugin dependency management to require plugins and code mods on demand.
+     * @private
+     */
+    protected resolveDependencies(): void;
+}
+//# sourceMappingURL=plugins.d.ts.map

package/dist/plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,sBAAsB,EACtB,MAAM,EACN,cAAc,EACd,gBAAgB,EAEjB,MAAM,kBAAkB,CAAC;AAE1B,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;IACvE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAC1B;IAEZ;;OAEG;IACH,IAAW,IAAI,sDAEd;IAED;;OAEG;IACH,IAAW,KAAK,aAEf;IA0BD,wDAAwD;IACxD,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM;IAsB9C,0FAA0F;IACnF,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,KAAK;IAOzE;;;;;;;;OAQG;IACI,qBAAqB,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;IAKlE;;;;;;;;OAQG;IACI,uBAAuB,CAC5B,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,sBAAsB;IAetC,mDAAmD;IACnD,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB;IAarD,kFAAkF;IAClF,SAAS,CAAC,2BAA2B,CAAC,OAAO,SAAS,gBAAgB,EACpE,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAyI3C;;;;;;OAMG;IACH,SAAS,CAAC,KAAK;IAiBf;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM;IAgB/B;;OAEG;IACH,SAAS,CAAC,oBAAoB;IAc9B;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB;IAsFnC;;;OAGG;IACH,SAAS,CAAC,mBAAmB;CAK9B"}

package/dist/plugins.js

@@ -0,0 +1,363 @@
+import Debug from 'debug';
+const debug = Debug('playwright-extra:plugins');
+import { requirePackages } from './helper/loader.js';
+import { addPuppeteerCompat } from './puppeteer-compatiblity-shim/index.js';
+export class PluginList {
+    _plugins = [];
+    _dependencyDefaults = new Map();
+    _dependencyResolution = new Map();
+    /**
+     * Get a list of all registered plugins.
+     */
+    get list() {
+        return this._plugins;
+    }
+    /**
+     * Get the names of all registered plugins.
+     */
+    get names() {
+        return this._plugins.map(p => p.name);
+    }
+    /**
+     * Add a new plugin to the list (after checking if it's well-formed).
+     *
+     * @param plugin
+     * @internal
+     */
+    add(plugin) {
+        if (!this.isValidPluginInstance(plugin)) {
+            return false;
+        }
+        if (plugin.onPluginRegistered) {
+            plugin.onPluginRegistered({ framework: 'playwright' });
+        }
+        // PuppeteerExtraPlugin: Populate `_childClassMembers` list containing methods defined by the plugin
+        if (plugin._registerChildClassMembers) {
+            plugin._registerChildClassMembers(Object.getPrototypeOf(plugin));
+        }
+        if (plugin.requirements?.has('dataFromPlugins')) {
+            plugin.getDataFromPlugins = this.getData.bind(this);
+        }
+        this._plugins.push(plugin);
+        return true;
+    }
+    /** Check if the shape of a plugin is correct or warn */
+    isValidPluginInstance(plugin) {
+        if (!plugin ||
+            typeof plugin !== 'object' ||
+            !plugin._isPuppeteerExtraPlugin) {
+            console.error(`Warning: Plugin is not derived from PuppeteerExtraPlugin, ignoring.`, plugin);
+            return false;
+        }
+        if (!plugin.name) {
+            console.error(`Warning: Plugin with no name registering, ignoring.`, plugin);
+            return false;
+        }
+        return true;
+    }
+    /** Error callback in case calling a plugin method throws an error. Can be overwritten. */
+    onPluginError(plugin, method, err) {
+        console.warn(`An error occured while executing "${method}" in plugin "${plugin.name}":`, err);
+    }
+    /**
+     * Define default values for plugins implicitly required through the `dependencies` plugin stanza.
+     *
+     * @param dependencyPath - The string by which the dependency is listed (not the plugin name)
+     *
+     * @example
+     * chromium.use(stealth)
+     * chromium.plugins.setDependencyDefaults('stealth/evasions/webgl.vendor', { vendor: 'Bob', renderer: 'Alice' })
+     */
+    setDependencyDefaults(dependencyPath, opts) {
+        this._dependencyDefaults.set(dependencyPath, opts);
+        return this;
+    }
+    /**
+     * Define custom plugin modules for plugins implicitly required through the `dependencies` plugin stanza.
+     *
+     * Using this will prevent dynamic imports from being used, which JS bundlers often have issues with.
+     *
+     * @example
+     * chromium.use(stealth)
+     * chromium.plugins.setDependencyResolution('stealth/evasions/webgl.vendor', VendorPlugin)
+     */
+    setDependencyResolution(dependencyPath, pluginModule) {
+        this._dependencyResolution.set(dependencyPath, pluginModule);
+        return this;
+    }
+    /**
+     * Prepare plugins to be used (resolve dependencies, ordering)
+     * @internal
+     */
+    prepare() {
+        this.resolveDependencies();
+        this.order();
+    }
+    /** Return all plugins using the supplied method */
+    filterByMethod(methodName) {
+        return this._plugins.filter(plugin => {
+            // PuppeteerExtraPlugin: The base class will already define all methods, hence we need to do a different check
+            if (!!plugin._childClassMembers &&
+                Array.isArray(plugin._childClassMembers)) {
+                return plugin._childClassMembers.includes(methodName);
+            }
+            return methodName in plugin;
+        });
+    }
+    /** Conditionally add puppeteer compatibility to values provided to the plugins */
+    _addPuppeteerCompatIfNeeded(plugin, method, args) {
+        const canUseShim = plugin._isPuppeteerExtraPlugin && !plugin.noPuppeteerShim;
+        const methodWhitelist = [
+            'onBrowser',
+            'onPageCreated',
+            'onPageClose',
+            'afterConnect',
+            'afterLaunch',
+        ];
+        const shouldUseShim = methodWhitelist.includes(method);
+        if (!canUseShim || !shouldUseShim) {
+            return args;
+        }
+        debug('add puppeteer compatibility', plugin.name, method);
+        return [
+            ...args.map(arg => addPuppeteerCompat(arg)),
+        ];
+    }
+    /**
+     * Dispatch plugin lifecycle events in a typesafe way.
+     * Only Plugins that expose the supplied property will be called.
+     *
+     * Will not await results to dispatch events as fast as possible to all plugins.
+     *
+     * @param method - The lifecycle method name
+     * @param args - Optional: Any arguments to be supplied to the plugin methods
+     * @internal
+     */
+    dispatch(method, ...args) {
+        const plugins = this.filterByMethod(method);
+        debug('dispatch', method, {
+            all: this._plugins.length,
+            filteredByMethod: plugins.length,
+        });
+        for (const plugin of plugins) {
+            try {
+                args = this._addPuppeteerCompatIfNeeded.bind(this)(plugin, method, args);
+                const fnType = plugin[method]?.constructor?.name;
+                debug('dispatch to plugin', {
+                    plugin: plugin.name,
+                    method,
+                    fnType,
+                });
+                if (fnType === 'AsyncFunction') {
+                    const asyncMethod = plugin[method];
+                    asyncMethod
+                        .call(plugin, ...args)
+                        .catch((err) => this.onPluginError(plugin, method, err instanceof Error ? err : new Error(String(err))));
+                }
+                else {
+                    const syncMethod = plugin[method];
+                    syncMethod.call(plugin, ...args);
+                }
+            }
+            catch (err) {
+                this.onPluginError(plugin, method, err instanceof Error ? err : new Error(String(err)));
+            }
+        }
+    }
+    /**
+     * Dispatch plugin lifecycle events in a typesafe way.
+     * Only Plugins that expose the supplied property will be called.
+     *
+     * Can also be used to get a definite return value after passing it to plugins:
+     * Calls plugins sequentially and passes on a value (waterfall style).
+     *
+     * The plugins can either modify the value or return an updated one.
+     * Will return the latest, updated value which ran through all plugins.
+     *
+     * By convention only the first argument will be used as the updated value.
+     *
+     * @param method - The lifecycle method name
+     * @param args - Optional: Any arguments to be supplied to the plugin methods
+     * @internal
+     */
+    async dispatchBlocking(method, ...args) {
+        const plugins = this.filterByMethod(method);
+        debug('dispatchBlocking', method, {
+            all: this._plugins.length,
+            filteredByMethod: plugins.length,
+        });
+        let retValue = null;
+        for (const plugin of plugins) {
+            try {
+                args = this._addPuppeteerCompatIfNeeded.bind(this)(plugin, method, args);
+                const pluginMethod = plugin[method];
+                if (typeof pluginMethod === 'function') {
+                    // @ts-expect-error - Dynamic plugin method invocation with variable args
+                    retValue = (await pluginMethod.call(plugin, ...args));
+                    // In case we got a return value use that as new first argument for followup function calls
+                    if (retValue !== undefined) {
+                        args[0] = retValue;
+                    }
+                }
+            }
+            catch (err) {
+                this.onPluginError(plugin, method, err instanceof Error ? err : new Error(String(err)));
+                return retValue;
+            }
+        }
+        return retValue;
+    }
+    /**
+     * Order plugins that have expressed a special placement requirement.
+     *
+     * This is useful/necessary for e.g. plugins that depend on the data from other plugins.
+     *
+     * @private
+     */
+    order() {
+        debug('order:before', this.names);
+        const runLast = this._plugins
+            .filter(p => p.requirements?.has('runLast'))
+            .map(p => p.name);
+        for (const name of runLast) {
+            const index = this._plugins.findIndex(p => p.name === name);
+            if (index >= 0) {
+                const plugin = this._plugins.splice(index, 1)[0];
+                if (plugin) {
+                    this._plugins.push(plugin);
+                }
+            }
+        }
+        debug('order:after', this.names);
+    }
+    /**
+     * Collects the exposed `data` property of all registered plugins.
+     * Will be reduced/flattened to a single array.
+     *
+     * Can be accessed by plugins that listed the `dataFromPlugins` requirement.
+     *
+     * Implemented mainly for plugins that need data from other plugins (e.g. `user-preferences`).
+     *
+     * @see [PuppeteerExtraPlugin]/data
+     * @param name - Filter data by optional name
+     *
+     * @private
+     */
+    getData(name) {
+        const data = this._plugins
+            .filter(p => !!p.data)
+            .map(p => (Array.isArray(p.data) ? p.data : [p.data]))
+            .reduce((acc, arr) => acc.concat(arr), []);
+        return name
+            ? data.filter((d) => typeof d === 'object' &&
+                d !== null &&
+                'name' in d &&
+                d.name === name)
+            : data;
+    }
+    /**
+     * Handle `plugins` stanza (already instantiated plugins that don't require dynamic imports)
+     */
+    resolvePluginsStanza() {
+        debug('resolvePluginsStanza');
+        const pluginNames = new Set(this.names);
+        this._plugins
+            .filter(p => !!p.plugins && p.plugins.length)
+            .filter(p => !pluginNames.has(p.name)) // TBD: Do we want to filter out existing?
+            .forEach(parent => {
+            (parent.plugins || []).forEach(p => {
+                debug(parent.name, 'adding missing plugin', p.name);
+                this.add(p);
+            });
+        });
+    }
+    /**
+     * Handle `dependencies` stanza (which requires dynamic imports)
+     *
+     * Plugins can define `dependencies` as a Set or Array of dependency paths, or a Map with additional opts
+     *
+     * @note
+     * - The default opts for implicit dependencies can be defined using `setDependencyDefaults()`
+     * - Dynamic imports can be avoided by providing plugin modules with `setDependencyResolution()`
+     */
+    resolveDependenciesStanza() {
+        debug('resolveDependenciesStanza');
+        /** Attempt to dynamically require a plugin module */
+        const requireDependencyOrDie = (parentName, dependencyPath) => {
+            // If the user provided the plugin module already we use that
+            if (this._dependencyResolution.has(dependencyPath)) {
+                return this._dependencyResolution.get(dependencyPath);
+            }
+            const possiblePrefixes = ['puppeteer-extra-plugin-']; // could be extended later
+            const isAlreadyPrefixed = possiblePrefixes.some(prefix => dependencyPath.startsWith(prefix));
+            const packagePaths = [];
+            // If the dependency is not already prefixed we attempt to require all possible combinations to find one that works
+            if (!isAlreadyPrefixed) {
+                packagePaths.push(...possiblePrefixes.map(prefix => prefix + dependencyPath));
+            }
+            // We always attempt to require the path verbatim (as a last resort)
+            packagePaths.push(dependencyPath);
+            const pluginModule = requirePackages(packagePaths);
+            if (pluginModule) {
+                return pluginModule;
+            }
+            const explanation = `
+The plugin '${parentName}' listed '${dependencyPath}' as dependency,
+which could not be found. Please install it:
+
+${packagePaths
+                .map(packagePath => `npm i ${packagePath.split('/')[0]}`)
+                .join(`\n or:\n`)}
+
+Note: You don't need to require the plugin yourself,
+unless you want to modify it's default settings.
+
+If your bundler has issues with dynamic imports take a look at '.plugins.setDependencyResolution()'.
+      `;
+            console.warn(explanation);
+            throw new Error('Plugin dependency not found');
+        };
+        const existingPluginNames = new Set(this.names);
+        const recursivelyLoadMissingDependencies = ({ name: parentName, dependencies, }) => {
+            if (!dependencies) {
+                return;
+            }
+            const processDependency = (dependencyPath, opts) => {
+                const pluginModule = requireDependencyOrDie(parentName, dependencyPath);
+                opts = opts || this._dependencyDefaults.get(dependencyPath) || {};
+                const plugin = pluginModule(opts);
+                if (existingPluginNames.has(plugin.name)) {
+                    debug(parentName, '=> dependency already exists:', plugin.name);
+                    return;
+                }
+                existingPluginNames.add(plugin.name);
+                debug(parentName, '=> adding new dependency:', plugin.name, opts);
+                this.add(plugin);
+                return recursivelyLoadMissingDependencies(plugin);
+            };
+            if (dependencies instanceof Set || Array.isArray(dependencies)) {
+                for (const dependencyPath of dependencies) {
+                    processDependency(dependencyPath);
+                }
+                return;
+            }
+            if (dependencies instanceof Map) {
+                // Note: `k,v => v,k` (Map + forEach will reverse the order)
+                for (const [k, v] of dependencies) {
+                    processDependency(k, v);
+                }
+            }
+        };
+        this.list.forEach(recursivelyLoadMissingDependencies);
+    }
+    /**
+     * Lightweight plugin dependency management to require plugins and code mods on demand.
+     * @private
+     */
+    resolveDependencies() {
+        debug('resolveDependencies');
+        this.resolvePluginsStanza();
+        this.resolveDependenciesStanza();
+    }
+}
+//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,KAAK,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAS5E,MAAM,OAAO,UAAU;IACJ,QAAQ,GAAa,EAAE,CAAC;IACxB,mBAAmB,GAAyB,IAAI,GAAG,EAAE,CAAC;IACtD,qBAAqB,GACpC,IAAI,GAAG,EAAE,CAAC;IAEZ;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,MAAc;QACvB,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC9B,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,oGAAoG;QACpG,IAAI,MAAM,CAAC,0BAA0B,EAAE,CAAC;YACtC,MAAM,CAAC,0BAA0B,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wDAAwD;IAC9C,qBAAqB,CAAC,MAAc;QAC5C,IACE,CAAC,MAAM;YACP,OAAO,MAAM,KAAK,QAAQ;YAC1B,CAAC,MAAM,CAAC,uBAAuB,EAC/B,CAAC;YACD,OAAO,CAAC,KAAK,CACX,qEAAqE,EACrE,MAAM,CACP,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,KAAK,CACX,qDAAqD,EACrD,MAAM,CACP,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0FAA0F;IACnF,aAAa,CAAC,MAAc,EAAE,MAAwB,EAAE,GAAU;QACvE,OAAO,CAAC,IAAI,CACV,qCAAqC,MAAM,gBAAgB,MAAM,CAAC,IAAI,IAAI,EAC1E,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,qBAAqB,CAAC,cAAsB,EAAE,IAAa;QAChE,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,uBAAuB,CAC5B,cAAsB,EACtB,YAAoC;QAEpC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,mDAAmD;IACzC,cAAc,CAAC,UAA4B;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YACnC,8GAA8G;YAC9G,IACE,CAAC,CAAC,MAAM,CAAC,kBAAkB;gBAC3B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EACxC,CAAC;gBACD,OAAO,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACxD,CAAC;YACD,OAAO,UAAU,IAAI,MAAM,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kFAAkF;IACxE,2BAA2B,CACnC,MAAc,EACd,MAAe,EACf,IAAyC;QAEzC,MAAM,UAAU,GACd,MAAM,CAAC,uBAAuB,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QAC5D,MAAM,eAAe,GAAuB;YAC1C,WAAW;YACX,eAAe;YACf,aAAa;YACb,cAAc;YACd,aAAa;SACd,CAAC;QACF,MAAM,aAAa,GAAG,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,CAAC,6BAA6B,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE1D,OAAO;YACL,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC,GAAe,CAAC,CAAC;SACjB,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACI,QAAQ,CACb,MAAe,EACf,GAAG,IAAyC;QAE5C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE;YACxB,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YACzB,gBAAgB,EAAE,OAAO,CAAC,MAAM;SACjC,CAAC,CAAC;QACH,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAChD,MAAM,EACN,MAAM,EACN,IAAI,CACL,CAAC;gBACF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC;gBACjD,KAAK,CAAC,oBAAoB,EAAE;oBAC1B,MAAM,EAAE,MAAM,CAAC,IAAI;oBACnB,MAAM;oBACN,MAAM;iBACP,CAAC,CAAC;gBACH,IAAI,MAAM,KAAK,eAAe,EAAE,CAAC;oBAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAEZ,CAAC;oBACtB,WAAW;yBACR,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;yBACrB,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE,CACtB,IAAI,CAAC,aAAa,CAChB,MAAM,EACN,MAAM,EACN,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CACpD,CACF,CAAC;gBACN,CAAC;qBAAM,CAAC;oBACN,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAoC,CAAC;oBACrE,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,aAAa,CAChB,MAAM,EACN,MAAM,EACN,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CACpD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,gBAAgB,CAC3B,MAAe,EACf,GAAG,IAAyC;QAE5C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,CAAC,kBAAkB,EAAE,MAAM,EAAE;YAChC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YACzB,gBAAgB,EAAE,OAAO,CAAC,MAAM;SACjC,CAAC,CAAC;QAGH,IAAI,QAAQ,GAAW,IAAc,CAAC;QACtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAChD,MAAM,EACN,MAAM,EACN,IAAI,CACL,CAAC;gBACF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;oBACvC,yEAAyE;oBACzE,QAAQ,GAAG,CAAC,MAAM,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAW,CAAC;oBAChE,2FAA2F;oBAC3F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,IAAI,CAAC,CAAC,CAAC,GAAG,QAAkD,CAAC;oBAC/D,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,aAAa,CAChB,MAAM,EACN,MAAM,EACN,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CACpD,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACO,KAAK;QACb,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ;aAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;aAC3C,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC5D,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,IAAI,MAAM,EAAE,CAAC;oBACX,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;OAYG;IACO,OAAO,CAAC,IAAa;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;aACvB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;aACrB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;aACrD,MAAM,CAAY,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,OAAO,IAAI;YACT,CAAC,CAAC,IAAI,CAAC,MAAM,CACT,CAAC,CAAU,EAAE,EAAE,CACb,OAAO,CAAC,KAAK,QAAQ;gBACrB,CAAC,KAAK,IAAI;gBACV,MAAM,IAAI,CAAC;gBACV,CAAuB,CAAC,IAAI,KAAK,IAAI,CACzC;YACH,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED;;OAEG;IACO,oBAAoB;QAC5B,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC9B,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ;aACV,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;aAC5C,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,0CAA0C;aAChF,OAAO,CAAC,MAAM,CAAC,EAAE;YAChB,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACjC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,CAAC,GAAG,CAAC,CAAW,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACO,yBAAyB;QACjC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAEnC,qDAAqD;QACrD,MAAM,sBAAsB,GAAG,CAC7B,UAAkB,EAClB,cAAsB,EACtB,EAAE;YACF,6DAA6D;YAC7D,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;gBACnD,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,cAAc,CAAiB,CAAC;YACxE,CAAC;YAED,MAAM,gBAAgB,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC,0BAA0B;YAChF,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACvD,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAClC,CAAC;YACF,MAAM,YAAY,GAAa,EAAE,CAAC;YAClC,mHAAmH;YACnH,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,YAAY,CAAC,IAAI,CACf,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,cAAc,CAAC,CAC3D,CAAC;YACJ,CAAC;YACD,oEAAoE;YACpE,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAClC,MAAM,YAAY,GAAG,eAAe,CAAe,YAAY,CAAC,CAAC;YACjE,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,YAAY,CAAC;YACtB,CAAC;YAED,MAAM,WAAW,GAAG;cACZ,UAAU,aAAa,cAAc;;;EAGjD,YAAY;iBACX,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;iBACxD,IAAI,CAAC,UAAU,CAAC;;;;;;OAMZ,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChD,MAAM,kCAAkC,GAAG,CAAC,EAC1C,IAAI,EAAE,UAAU,EAChB,YAAY,GACL,EAAQ,EAAE;YACjB,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAO;YACT,CAAC;YACD,MAAM,iBAAiB,GAAG,CAAC,cAAsB,EAAE,IAAc,EAAE,EAAE;gBACnE,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;gBACxE,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;gBAClE,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,KAAK,CAAC,UAAU,EAAE,+BAA+B,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;oBAChE,OAAO;gBACT,CAAC;gBACD,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACrC,KAAK,CAAC,UAAU,EAAE,2BAA2B,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAClE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACjB,OAAO,kCAAkC,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC,CAAC;YAEF,IAAI,YAAY,YAAY,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC/D,KAAK,MAAM,cAAc,IAAI,YAAY,EAAE,CAAC;oBAC1C,iBAAiB,CAAC,cAAc,CAAC,CAAC;gBACpC,CAAC;gBACD,OAAO;YACT,CAAC;YACD,IAAI,YAAY,YAAY,GAAG,EAAE,CAAC;gBAChC,4DAA4D;gBAC5D,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,YAAY,EAAE,CAAC;oBAClC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACO,mBAAmB;QAC3B,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACnC,CAAC;CACF"}

package/dist/puppeteer-compatiblity-shim/index.d.ts

@@ -0,0 +1,26 @@
+import type * as pw from 'playwright-core';
+export type PlaywrightObject = pw.Page | pw.Frame | pw.Browser;
+export interface PuppeteerBrowserShim {
+    isCompatShim?: boolean;
+    isPlaywright?: boolean;
+    pages?: pw.BrowserContext['pages'];
+    userAgent: () => Promise<'string'>;
+}
+export interface PuppeteerPageShim {
+    isCompatShim?: boolean;
+    isPlaywright?: boolean;
+    browser?: () => pw.Browser;
+    evaluateOnNewDocument?: pw.Page['addInitScript'];
+    _client: () => pw.CDPSession;
+}
+export declare const isPlaywrightPage: (obj: unknown) => obj is pw.Page;
+export declare const isPlaywrightFrame: (obj: unknown) => obj is pw.Frame;
+export declare const isPlaywrightBrowser: (obj: unknown) => obj is pw.Browser;
+export declare const isPuppeteerCompat: (obj?: unknown) => obj is PlaywrightObject;
+/** Augment a Playwright object with compatibility with certain Puppeteer methods */
+export declare function addPuppeteerCompat<Input extends pw.Page | pw.Frame | pw.Browser | null>(object: Input): Input;
+export declare function getPageCDPSession(page: pw.Page | pw.Frame): Promise<pw.CDPSession>;
+export declare function getBrowserCDPSession(browser: pw.Browser): Promise<pw.CDPSession>;
+export declare function createPageShim(page: pw.Page | pw.Frame): pw.Page | pw.Frame;
+export declare function createBrowserShim(browser: pw.Browser): pw.Browser;
+//# sourceMappingURL=index.d.ts.map

package/dist/puppeteer-compatiblity-shim/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/puppeteer-compatiblity-shim/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE3C,MAAM,MAAM,gBAAgB,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC;IAC3B,qBAAqB,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACjD,OAAO,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC;CAC9B;AAED,eAAO,MAAM,gBAAgB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,EAAE,CAAC,IAEzD,CAAC;AACF,eAAO,MAAM,iBAAiB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,EAAE,CAAC,KAE1D,CAAC;AACF,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,EAAE,CAAC,OAE5D,CAAC;AACF,eAAO,MAAM,iBAAiB,GAAI,MAAM,OAAO,KAAG,GAAG,IAAI,gBAMxD,CAAC;AAUF,oFAAoF;AACpF,wBAAgB,kBAAkB,CAChC,KAAK,SAAS,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,OAAO,GAAG,IAAI,EACpD,MAAM,EAAE,KAAK,GAAG,KAAK,CAuBtB;AAYD,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,KAAK,0BAsB/D;AAED,wBAAsB,oBAAoB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,0BAmB7D;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,KAAK,sBAoFtD;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,cAyBpD"}