feat: custom automation (#332)

* implement custom automation option

* minor fixes

src/index.ts

@@ -5,6 +5,7 @@ export {
   DappeteerLaunchOptions,
   MetaMaskOptions,
   TransactionOptions,
+  CustomAutomation,
 } from "./types";
 export { DappeteerBrowser } from "./browser";
 export { DappeteerPage } from "./page";

src/setup/launch.ts

@@ -71,6 +71,17 @@ export async function launch(
 
   if (options.automation) {
     switch (options.automation) {
+      case "custom":
+        console.warn("Custom automation in use. Proceed at own risk.");
+        if (!options.customAutomation) {
+          fs.rmSync(userDataDir, { recursive: true, force: true });
+          throw new Error("Missing customBootstrap method in options");
+        }
+        return await options.customAutomation(
+          metamaskPath,
+          userDataDir,
+          options
+        );
       case "playwright":
         return await launchPlaywright(metamaskPath, userDataDir, options);
       case "puppeteer":

src/types.ts

@@ -6,7 +6,7 @@ import { Path } from "./setup/utils/metaMaskDownloader";
 import { InstallStep } from "./snap/install";
 import { NotificationItem, NotificationList } from "./snap/types";
 import NotificationsEmitter from "./snap/NotificationsEmitter";
-import { RECOMMENDED_METAMASK_VERSION } from "./index";
+import { DappeteerBrowser, RECOMMENDED_METAMASK_VERSION } from "./index";
 
 export type DappeteerLaunchOptions = {
   metaMaskVersion?:
@@ -19,14 +19,21 @@ export type DappeteerLaunchOptions = {
   //install flask (canary) version of metamask.
   metaMaskFlask?: boolean;
   //fallbacks to installed dependency and prefers playwright if both are installed
-  automation?: "puppeteer" | "playwright";
+  automation?: "puppeteer" | "playwright" | "custom";
+  customAutomation?: CustomAutomation;
   headless?: boolean; // default true
   puppeteerOptions?: Parameters<typeof puppeteerLaunch>[0];
   playwrightOptions?: PlaywrightLaunchOptions;
   userDataDir?: string;
   key?: string;
 };
 
+export type CustomAutomation = (
+  metamaskPath: string,
+  userDataDir: string,
+  options: DappeteerLaunchOptions
+) => Promise<DappeteerBrowser>;
+
 declare global {
   interface Window {
     ethereum: MetaMaskInpageProvider;