Merge branch 'master' into beroburny/speedup-init

# Conflicts:
#	.github/workflows/main.yml

.github/workflows/main-release.yml

@@ -0,0 +1,30 @@
+name: "Main Branch Beta Release"
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+      - run: yarn --prefer-offline --frozen-lockfile
+      - run: yarn build
+      - name: "Retrieving package version"
+        uses: martinbeentjes/npm-get-version-action@main
+        id: version
+      - name: "Retrieving commit hash"
+        id: commit
+        uses: pr-mpt/actions-commit-hash@v2
+      - run: yarn publish --access public --tag beta --new-version ${{steps.version.outputs.current-version}}-${{steps.commit.outputs.short}}
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

.github/workflows/main.yml

@@ -10,7 +10,41 @@ on:
       - '**'
 
 jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          cache: 'yarn'
+      - name: Install deps
+        run: yarn --prefer-offline --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Download metamask
+        run: yarn run download:metamask
+      - uses: actions/cache/save@v3
+        with:
+          path: .metamask
+          key: metamask-extension
+  lint:
+    needs: build
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          cache: 'yarn'
+      - name: Install deps
+        run: yarn --prefer-offline --frozen-lockfile
+      - name: Lint
+        run: yarn run lint
   tests:
+    needs: build
     name: Tests
     runs-on: ubuntu-latest
     strategy:
@@ -24,10 +58,14 @@ jobs:
         with:
           node-version: "16"
           cache: 'yarn'
+      - uses: actions/cache/restore@v3
+        with:
+          path: .metamask
+          key: metamask-extension
       - name: Install
         run: yarn --prefer-offline --frozen-lockfile
       - name: Tests
-        run: 'yarn run test:${{matrix.automation}}:${{matrix.mm-version}} --timeout 50000'
+        run: 'yarn run test:${{matrix.automation}}:${{ matrix.mm-version }} --timeout 50000'
       - uses: actions/upload-artifact@v3
         if: always()
         with:
@@ -36,7 +74,7 @@ jobs:
   tests-user-data:
     name: Tests UserData
     runs-on: ubuntu-latest
-    needs: [tests]
+    needs: tests
     strategy:
       fail-fast: false
       matrix:
@@ -51,33 +89,6 @@ jobs:
         run: yarn --prefer-offline --frozen-lockfile
       - name: Tests UserData
         run: 'yarn run test:${{matrix.automation}}:userData --timeout 240000'
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-          cache: 'yarn'
-      - name: Install deps
-        run: yarn --prefer-offline --frozen-lockfile
-      - name: Lint
-        run: yarn run lint
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    needs: [lint]
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-          cache: 'yarn'
-      - name: Install deps
-        run: yarn --prefer-offline --frozen-lockfile
-      - name: Build
-        run: yarn build
 
   maybe-release:
     name: release

package.json

@@ -24,7 +24,8 @@
     "test:puppeteer:mm": "AUTOMATION=puppeteer yarn run test:mm",
     "test:puppeteer:flask": "AUTOMATION=puppeteer yarn run test:flask",
     "test:playwright:mm": "AUTOMATION=playwright yarn run test:mm",
-    "test:playwright:flask": "AUTOMATION=playwright yarn run test:flask"
+    "test:playwright:flask": "AUTOMATION=playwright yarn run test:flask",
+    "download:metamask": "node -r ts-node/register ./scripts/download_metamask.ts"
   },
   "repository": {
     "type": "git",

scripts/download_metamask.ts

@@ -0,0 +1,11 @@
+import downloader from "../src/setup/utils/metaMaskDownloader";
+import {RECOMMENDED_METAMASK_VERSION} from "../src"
+
+(async function() {
+    await downloader(RECOMMENDED_METAMASK_VERSION, {
+        flask: false,
+      });
+    await downloader(RECOMMENDED_METAMASK_VERSION, {
+        flask: true,
+      });
+})()

src/index.ts

@@ -1,10 +1,15 @@
 // re-export
 export { getMetaMask, getMetaMaskWindow } from "./metamask";
-export * from "./types";
-export * from "./browser";
-export * from "./page";
-export * from "./element";
-export * from "./setup";
+export {
+  Dappeteer,
+  DappeteerLaunchOptions,
+  MetaMaskOptions,
+  TransactionOptions,
+} from "./types";
+export { DappeteerBrowser } from "./browser";
+export { DappeteerPage } from "./page";
+export { DappeteerElementHandle } from "./element";
+export { bootstrap, initSnapEnv, launch, setupMetaMask } from "./setup";
 export { DapeteerJestConfig } from "./jest/global";
 
 // default constants

src/setup/index.ts

@@ -8,6 +8,9 @@ import { setupMetaMask } from "./setupMetaMask";
 export * from "./launch";
 export * from "./setupMetaMask";
 
+/**
+ * Launches browser and installs required metamask version along with setting up initial account
+ */
 export const bootstrap = async ({
   seed,
   password,
@@ -32,6 +35,9 @@ export const bootstrap = async ({
   };
 };
 
+/**
+ * Used to quickly bootstrap dappeteer testing environment with installed snap
+ */
 export const initSnapEnv = async (
   opts: DappeteerLaunchOptions &
     MetaMaskOptions &

src/setup/utils/metaMaskDownloader.ts

@@ -6,7 +6,13 @@ import * as path from "path";
 
 import StreamZip from "node-stream-zip";
 
-const defaultDirectory = path.resolve(__dirname, "..", "..", "..", ".metamask");
+export const defaultDirectory = path.resolve(
+  __dirname,
+  "..",
+  "..",
+  "..",
+  ".metamask"
+);
 
 export type Path =
   | string

tsconfig.json

@@ -14,7 +14,8 @@
     "declaration": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
-    "outDir": "dist"
+    "outDir": "dist",
+    "removeComments": false
   },
   "files": ["./node_modules/@metamask/snap-types/global.d.ts"],
   "include": [