fix: properly type Puppeteer BrowserController (#54)

* Properly type Puppeteer BrowserController

* bump version

* fixes

* Remove duplicated interface

Author: szmarczak

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "browser-pool",
-	"version": "3.0.0",
+	"version": "3.0.1",
 	"description": "Rotate multiple browsers using popular automation libraries such as Playwright or Puppeteer.",
     "engines": {
         "node": ">=15.10.0"

src/puppeteer/puppeteer-controller.ts

@@ -1,16 +1,11 @@
-import type Puppeteer from 'puppeteer';
+import type Puppeteer from './puppeteer-proxy-per-page';
 import { BrowserController, Cookie } from '../abstract-classes/browser-controller';
 import { log } from '../logger';
 
 const PROCESS_KILL_TIMEOUT_MILLIS = 5000;
 
-interface ContextOptions extends Puppeteer.BrowserContextOptions {
-    proxyUsername?: string;
-    proxyPassword?: string;
-}
-
 export class PuppeteerController extends BrowserController<typeof Puppeteer> {
-    protected async _newPage(contextOptions?: ContextOptions): Promise<Puppeteer.Page> {
+    protected async _newPage(contextOptions?: Puppeteer.ContextOptions): Promise<Puppeteer.Page> {
         if (contextOptions !== undefined) {
             if (!this.launchContext.useIncognitoPages) {
                 throw new Error('A new page can be created with provided context only when using incognito pages.');

src/puppeteer/puppeteer-plugin.ts

@@ -1,7 +1,7 @@
 // eslint isn't compatible with `import type`
 /* eslint-disable import/no-duplicates */
-import type Puppeteer from 'puppeteer';
-import type { Browser, Credentials, Target } from 'puppeteer';
+import type Puppeteer from './puppeteer-proxy-per-page';
+import type { Browser, Credentials, Target, BrowserContext } from './puppeteer-proxy-per-page';
 import { BrowserController } from '../abstract-classes/browser-controller';
 import { BrowserPlugin } from '../abstract-classes/browser-plugin';
 import { LaunchContext } from '../launch-context';
@@ -48,7 +48,7 @@ export class PuppeteerPlugin extends BrowserPlugin<typeof Puppeteer> {
         browser = new Proxy(browser, {
             get: (target, property: keyof typeof browser) => {
                 if (property === 'newPage') {
-                    return (async (...args) => {
+                    return (async (...args: Parameters<BrowserContext['newPage']>) => {
                         let page: Puppeteer.Page;
 
                         if (useIncognitoPages) {
@@ -66,7 +66,7 @@ export class PuppeteerPlugin extends BrowserPlugin<typeof Puppeteer> {
                         }
 
                         return page;
-                    }) as typeof browser.newPage;
+                    });
                 }
 
                 return target[property];

src/puppeteer/puppeteer-proxy-per-page.d.ts

@@ -0,0 +1,25 @@
+import type {
+    BrowserContextOptions,
+    Browser as PuppeteerBrowser,
+    Page,
+    LaunchOptions,
+    BrowserLaunchArgumentOptions,
+    BrowserConnectOptions,
+    Product,
+} from 'puppeteer';
+
+export * from 'puppeteer';
+
+export interface ContextOptions extends BrowserContextOptions {
+    proxyUsername?: string;
+    proxyPassword?: string;
+}
+
+export declare class Browser extends PuppeteerBrowser {
+    newPage: (contextOptions?: ContextOptions) => Promise<Page>;
+}
+
+export declare function launch(options?: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & {
+    product?: Product;
+    extraPrefsFirefox?: Record<string, unknown>;
+}): Promise<Browser>;

test/browser-plugins/plugins.test.ts

@@ -133,7 +133,7 @@ const runPluginTest = <
             browserController.activate();
 
             try {
-                const page = await browserController.newPage({} as any);
+                const page = await browserController.newPage({});
                 await page.close();
 
                 expect(false).toBe(true);
@@ -300,7 +300,7 @@ describe('Plugins', () => {
                 proxyUsername: 'foo',
                 proxyPassword: 'bar',
                 proxyBypassList: ['<-loopback>'],
-            } as any);
+            });
 
             const response = await page.goto(`http://127.0.0.1:${(target.address() as AddressInfo).port}`);
             const text = await response!.text();