refactor: wrap up rewrite in TS

package.json

@@ -42,7 +42,6 @@
 	"dependencies": {
 		"@apify/log": "^1.0.0",
 		"fs-extra": "^9.1.0",
-		"lodash": "^4.17.21",
 		"lodash.merge": "^4.6.2",
 		"nanoid": "^3.1.22",
 		"ow": "^0.23.0",
@@ -54,7 +53,6 @@
 		"@apify/eslint-config-ts": "^0.1.1",
 		"@types/fs-extra": "^9.0.11",
 		"@types/jest": "^26.0.22",
-		"@types/lodash": "^4.14.172",
 		"@types/lodash.merge": "^4.6.6",
 		"@types/node": "^14.17.7",
 		"@typescript-eslint/eslint-plugin": "^4.22.0",

src/abstract-classes/browser-controller.ts

@@ -87,7 +87,7 @@ export interface Cookie {
  * @hideconstructor
  */
 export abstract class BrowserController<
-    Library extends CommonLibrary,
+    Library extends CommonLibrary = CommonLibrary,
     LibraryOptions = Parameters<Library['launch']>[0],
     LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>,
     NewPageOptions = Parameters<LaunchResult['newPage']>[0],

src/abstract-classes/browser-plugin.ts

@@ -21,11 +21,14 @@ export interface CommonLibrary {
     name?: () => string;
 }
 
-/**
- * @internal
- */
+/** @internal */
 export interface CommonBrowser {
-    newPage(...args: unknown[]): unknown;
+    newPage(...args: unknown[]): Promise<CommonPage>;
+}
+
+/** @internal */
+export interface CommonPage {
+    close(...args: unknown[]): Promise<unknown>;
 }
 
 export interface BrowserPluginOptions<LibraryOptions> {
@@ -57,7 +60,7 @@ export interface BrowserPluginOptions<LibraryOptions> {
 
 export type CreateLaunchContextOptions<
     Library extends CommonLibrary,
-    LibraryOptions = Parameters<Library['launch']>[0],
+    LibraryOptions extends unknown = Parameters<Library['launch']>[0],
     LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>,
     NewPageOptions = Parameters<LaunchResult['newPage']>[0],
     NewPageResult = UnwrapPromise<ReturnType<LaunchResult['newPage']>>,
@@ -70,8 +73,8 @@ export type CreateLaunchContextOptions<
  * feed them to {@link BrowserPool} for use.
  */
 export abstract class BrowserPlugin<
-    Library extends CommonLibrary,
-    LibraryOptions = Parameters<Library['launch']>[0],
+    Library extends CommonLibrary = CommonLibrary,
+    LibraryOptions extends unknown = Parameters<Library['launch']>[0],
     LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>,
     NewPageOptions = Parameters<LaunchResult['newPage']>[0],
     NewPageResult = UnwrapPromise<ReturnType<LaunchResult['newPage']>>,
@@ -137,7 +140,9 @@ export abstract class BrowserPlugin<
     /**
      * Launches the browser using provided launch context.
      */
-    async launch(launchContext = this.createLaunchContext()): Promise<LaunchResult> {
+    async launch(
+        launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult> = this.createLaunchContext(),
+    ): Promise<LaunchResult> {
         const { proxyUrl, useIncognitoPages, userDataDir } = launchContext;
 
         if (proxyUrl) {

src/index.js → src/index.ts

@@ -1,9 +1,3 @@
-const BrowserPool = require('./browser-pool');
-// eslint-disable-next-line import/extensions
-const { PuppeteerPlugin } = require('./puppeteer/puppeteer-plugin');
-// eslint-disable-next-line import/extensions
-const { PlaywrightPlugin } = require('./playwright/playwright-plugin');
-
 /**
  * The `browser-pool` module exports three constructors. One for `BrowserPool`
  * itself and two for the included Puppeteer and Playwright plugins.
@@ -26,13 +20,8 @@ const { PlaywrightPlugin } = require('./playwright/playwright-plugin');
  * });
  * ```
  *
- * @property {BrowserPool} BrowserPool
- * @property {PuppeteerPlugin} PuppeteerPlugin
- * @property {PlaywrightPlugin} PlaywrightPlugin
  * @module browser-pool
  */
-module.exports = {
-    BrowserPool,
-    PuppeteerPlugin,
-    PlaywrightPlugin,
-};
+export * from './browser-pool';
+export * from './playwright/playwright-plugin';
+export * from './puppeteer/puppeteer-plugin';

src/launch-context.ts

@@ -12,7 +12,7 @@ import { UnwrapPromise } from './utils';
  * values, such as session IDs.
  */
 export interface LaunchContextOptions<
-    Library extends CommonLibrary,
+    Library extends CommonLibrary = CommonLibrary,
     LibraryOptions = Parameters<Library['launch']>[0],
     LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>,
     NewPageOptions = Parameters<LaunchResult['newPage']>[0],
@@ -47,7 +47,7 @@ export interface LaunchContextOptions<
 }
 
 export class LaunchContext<
-    Library extends CommonLibrary,
+    Library extends CommonLibrary = CommonLibrary,
     LibraryOptions = Parameters<Library['launch']>[0],
     LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>,
     NewPageOptions = Parameters<LaunchResult['newPage']>[0],

src/utils.ts

@@ -1,3 +1,6 @@
+import type { PlaywrightPlugin, PuppeteerPlugin } from '.';
+import type { BrowserPlugin } from './abstract-classes/browser-plugin';
+
 export function addTimeoutToPromise<T>(promise: Promise<T>, timeoutMillis: number, errorMessage: string): Promise<T> {
     return new Promise(async (resolve, reject) => { // eslint-disable-line
         const timeout = setTimeout(() => reject(new Error(errorMessage)), timeoutMillis);
@@ -16,3 +19,36 @@ export type UnwrapPromise<T> = T extends PromiseLike<infer R> ? UnwrapPromise<R>
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
 export function noop(..._args: unknown[]): void {}
+
+export type InferBrowserPluginArray<
+    // The original array input
+    Input extends readonly unknown[],
+    // The results of this type
+    Result extends BrowserPlugin[] = []
+> =
+    // If the input is a tuple or a readonly array (`[] as const`), get the first and the rest of the values
+    Input extends readonly [infer FirstValue, ...infer Rest] | [infer FirstValue, ...infer Rest]
+    // If the first value is a PlaywrightPlugin
+    ? FirstValue extends PlaywrightPlugin
+        // Add it to the result, and continue parsing
+        ? InferBrowserPluginArray<Rest, [...Result, PlaywrightPlugin]>
+        // Else if the first value is a PuppeteerPlugin
+        : FirstValue extends PuppeteerPlugin
+            // Add it to the result, and continue parsing
+            ? InferBrowserPluginArray<Rest, [...Result, PuppeteerPlugin]>
+            // Return never as it isn't a valid type
+            : never
+    // If there's no more inputs to parse
+    : Input extends []
+        // Return the results
+        ? Result
+        // If the input is a general array of elements (not a tuple), infer it's values type
+        : Input extends Array<infer U>
+            // If the values are a union of the plugins
+            ? [U] extends [PuppeteerPlugin | PlaywrightPlugin]
+                // Return an array of the union
+                ? U[]
+                // Return never as it isn't a valid type
+                : never
+            // Return the result
+            : Result;