@metamask/snaps-jest 4.0.1 → 6.0.0

package/dist/types/types.d.ts

@@ -1,7 +1,7 @@
 import type { NotificationType, EnumToUnion, Component } from '@metamask/snaps-sdk';
-import type { JsonRpcId, JsonRpcParams } from '@metamask/utils';
+import type { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';
 import type { Infer } from 'superstruct';
-import type { Mock, MockJsonRpcOptions, MockOptions, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from './internals';
+import type { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from './internals';
 declare module 'expect' {
     interface AsymmetricMatchers {
         toRespondWith(response: unknown): void;
@@ -16,27 +16,6 @@ declare module 'expect' {
         toRender(component: Component): R;
     }
 }
-/**
- * Deeply partialize a type.
- *
- * @template Type - The type to partialize.
- * @returns The deeply partialized type.
- * @example
- * ```ts
- * type Foo = {
- *   bar: {
- *     baz: string;
- *   };
- *   qux: number;
- * };
- *
- * type PartialFoo = DeepPartial<Foo>;
- * // { bar?: { baz?: string; }; qux?: number; }
- * ```
- */
-export declare type DeepPartial<Type> = {
-    [Key in keyof Type]?: Type[Key] extends Record<string, unknown> ? DeepPartial<Type[Key]> : Type[Key];
-};
 export declare type RequestOptions = {
     /**
      * The JSON-RPC request ID.
@@ -82,6 +61,17 @@ export declare type CronjobOptions = Omit<RequestOptions, 'origin'>;
  * @property nonce - The nonce to use for the transaction. Defaults to `0`.
  */
 export declare type TransactionOptions = Infer<typeof TransactionOptionsStruct>;
+/**
+ * The options to use for signature requests.
+ *
+ * @property origin - The origin to send the signature request from. Defaults to
+ * `metamask.io`.
+ * @property from - The address to send the signature from. Defaults to a
+ * randomly generated address.
+ * @property data - The data to sign. Defaults to `0x`.
+ * @property signatureMethod - The signature method.
+ */
+export declare type SignatureOptions = Infer<typeof SignatureOptionsStruct>;
 /**
  * The options to use for requests to the snap.
  *
@@ -167,19 +157,31 @@ export declare type SnapRequestObject = {
  * {@link SnapRequestObject} fields.
  */
 export declare type SnapRequest = Promise<SnapResponse> & SnapRequestObject;
+/**
+ * The options to use for mocking a JSON-RPC request.
+ */
+export declare type JsonRpcMockOptions = {
+    /**
+     * The JSON-RPC request method.
+     */
+    method: string;
+    /**
+     * The JSON-RPC response, which will be returned when a request with the
+     * specified method is sent.
+     */
+    result: Json;
+};
 /**
  * This is the main entry point to interact with the snap. It is returned by
  * {@link installSnap}, and has methods to send requests to the snap.
  *
  * @example
- * ```ts
  * import { installSnap } from '@metamask/snaps-jest';
  *
  * const snap = await installSnap();
  * const response = await snap.request({ method: 'hello' });
  *
  * expect(response).toRespondWith('Hello, world!');
- * ```
  */
 export declare type Snap = {
     /**
@@ -198,7 +200,26 @@ export declare type Snap = {
      * will be filled in with default values.
      * @returns The response.
      */
+    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponse>;
+    /**
+     * Send a transaction to the snap.
+     *
+     * @param transaction - The transaction. This is similar to an Ethereum
+     * transaction object, but has an extra `origin` field. Any missing fields
+     * will be filled in with default values.
+     * @returns The response.
+     * @deprecated Use {@link onTransaction} instead.
+     */
     sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponse>;
+    /**
+     * Send a signature request to the snap.
+     *
+     * @param signature - The signature request object. Contains the params from
+     * the various signature methods, but has an extra `origin` and `signatureMethod` field.
+     * Any missing fields will be filled in with default values.
+     * @returns The response.
+     */
+    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponse>;
     /**
      * Run a cronjob in the snap. This is similar to {@link request}, but the
      * request will be sent to the `onCronjob` method of the snap.
@@ -208,31 +229,57 @@ export declare type Snap = {
      * `endowment:cronjob` permission.
      * @returns The response promise, with extra {@link SnapRequestObject} fields.
      */
+    onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;
+    /**
+     * Run a cronjob in the snap. This is similar to {@link request}, but the
+     * request will be sent to the `onCronjob` method of the snap.
+     *
+     * @param cronjob - The cronjob request. This is similar to a JSON-RPC
+     * request, and is normally specified in the snap manifest, under the
+     * `endowment:cronjob` permission.
+     * @returns The response promise, with extra {@link SnapRequestObject} fields.
+     * @deprecated Use {@link onCronjob} instead.
+     */
     runCronjob(cronjob: CronjobOptions): SnapRequest;
     /**
-     * Close the page running the snap. This is mainly useful for cleaning up
-     * the test environment, and calling it is not strictly necessary.
+     * Get the response from the snap's `onHomePage` method.
      *
-     * @returns A promise that resolves when the page is closed.
+     * @returns The response.
      */
-    close(): Promise<void>;
+    onHomePage(): Promise<SnapResponse>;
     /**
-     * Enable network mocking for the snap.
+     * Mock a JSON-RPC request. This will cause the snap to respond with the
+     * specified response when a request with the specified method is sent.
      *
-     * @param options - The options for the network mocking.
-     * @returns A {@link Mock} object, with an `unmock` function.
+     * @param mock - The mock options.
+     * @param mock.method - The JSON-RPC request method.
+     * @param mock.result - The JSON-RPC response, which will be returned when a
+     * request with the specified method is sent.
+     * @example
+     * import { installSnap } from '@metamask/snaps-jest';
+     *
+     * // In the test
+     * const snap = await installSnap();
+     * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });
+     *
+     * // In the Snap
+     * const response =
+     *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']
      */
-    mock(options: DeepPartial<MockOptions>): Promise<Mock>;
+    mockJsonRpc(mock: JsonRpcMockOptions): {
+        /**
+         * Remove the mock.
+         */
+        unmock(): void;
+    };
     /**
-     * Enable JSON-RPC provider mocking for the snap. This will mock any requests
-     * sent through the `ethereum` global, with the specified `method`.
+     * Close the page running the snap. This is mainly useful for cleaning up
+     * the test environment, and calling it is not strictly necessary.
      *
-     * @param options - The options for the JSON-RPC mocking.
-     * @param options.method - The JSON-RPC method to mock, e.g.,
-     * `eth_blockNumber`.
-     * @param options.result - The JSON value to return.
-     * @returns A {@link Mock} object, with an `unmock` function.
+     * @returns A promise that resolves when the page is closed.
+     * @deprecated Snaps are now automatically closed when the test ends. This
+     * method will be removed in a future release.
      */
-    mockJsonRpc(options: MockJsonRpcOptions): Promise<Mock>;
+    close(): Promise<void>;
 };
 export declare type SnapResponse = Infer<typeof SnapResponseStruct>;

package/dist/types/vendor/readable-stream.d.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=readable-stream.d.js.map

package/dist/types/vendor/readable-stream.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/vendor/readable-stream.d.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=readable-stream.d.mjs.map

package/dist/types/vendor/readable-stream.d.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";require('./chunk-QNDLJ2W7.js');
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+import "./chunk-JZJWUVD7.mjs";
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/jest-preset.js

@@ -12,7 +12,7 @@ const config = {
   // timeout to 30 seconds by default.
   testTimeout: 30000,
 
-  setupFilesAfterEnv: [resolve(__dirname, 'dist', 'cjs', 'setup.js')],
+  setupFilesAfterEnv: [resolve(__dirname, 'dist', 'setup.js')],
 };
 
 module.exports = config;

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "@metamask/snaps-jest",
-  "version": "4.0.1",
+  "version": "6.0.0",
   "description": "A Jest preset for end-to-end testing MetaMask Snaps, including a Jest environment, and a set of Jest matchers.",
   "sideEffects": false,
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./jest-preset": "./jest-preset.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/types/index.d.ts",
   "files": [
-    "dist/cjs/**",
-    "dist/esm/**",
-    "dist/types/**",
+    "dist",
     "jest-preset.js"
   ],
   "scripts": {
@@ -22,41 +29,46 @@
     "lint:ci": "yarn lint",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-jest",
-    "build": "yarn build:source && yarn build:types",
-    "build:source": "yarn build:esm && yarn build:cjs",
+    "build": "tsup --clean && yarn build:types",
     "build:types": "tsc --project tsconfig.build.json",
-    "build:esm": "swc src --out-dir dist/esm --config-file ../../.swcrc.build.json --config module.type=es6",
-    "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
-    "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
     "publish:preview": "yarn npm publish --tag preview",
-    "lint:dependencies": "depcheck"
+    "lint:dependencies": "depcheck",
+    "build:ci": "tsup --clean"
   },
   "dependencies": {
     "@jest/environment": "^29.5.0",
     "@jest/expect": "^29.5.0",
     "@jest/globals": "^29.5.0",
-    "@metamask/snaps-execution-environments": "^3.4.1",
-    "@metamask/snaps-sdk": "^1.2.0",
-    "@metamask/snaps-simulator": "^2.4.1",
-    "@metamask/snaps-utils": "^5.0.0",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/base-controller": "^4.1.0",
+    "@metamask/eth-json-rpc-middleware": "^12.1.0",
+    "@metamask/json-rpc-engine": "^7.3.2",
+    "@metamask/json-rpc-middleware-stream": "^6.0.2",
+    "@metamask/key-tree": "^9.0.0",
+    "@metamask/permission-controller": "^8.0.1",
+    "@metamask/snaps-controllers": "^6.0.0",
+    "@metamask/snaps-execution-environments": "^5.0.0",
+    "@metamask/snaps-rpc-methods": "^7.0.0",
+    "@metamask/snaps-sdk": "^3.0.0",
+    "@metamask/snaps-utils": "^7.0.0",
+    "@metamask/utils": "^8.3.0",
+    "@reduxjs/toolkit": "^1.9.5",
     "express": "^4.18.2",
     "jest-environment-node": "^29.5.0",
     "jest-matcher-utils": "^29.5.0",
-    "pptr-testing-library": "^0.7.0",
-    "puppeteer": "21.1.1",
-    "superstruct": "^1.0.3",
-    "webdriverio": "^8.19.0"
+    "readable-stream": "^3.6.2",
+    "redux": "^4.2.1",
+    "redux-saga": "^1.2.3",
+    "superstruct": "^1.0.3"
   },
   "devDependencies": {
-    "@lavamoat/allow-scripts": "^2.5.1",
-    "@metamask/auto-changelog": "^3.4.3",
+    "@jest/types": "^29.6.3",
+    "@lavamoat/allow-scripts": "^3.0.2",
+    "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
-    "@swc/cli": "^0.1.62",
     "@swc/core": "1.3.78",
     "@swc/jest": "^0.2.26",
     "@types/jest": "^27.5.1",
@@ -78,6 +90,7 @@
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
+    "tsup": "^8.0.1",
     "typescript": "~4.8.4"
   },
   "engines": {

package/dist/cjs/environment.js

@@ -1,205 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    SnapsEnvironment: function() {
-        return SnapsEnvironment;
-    },
-    default: function() {
-        return _default;
-    }
-});
-const _utils = require("@metamask/utils");
-const _jestenvironmentnode = /*#__PURE__*/ _interop_require_default(require("jest-environment-node"));
-const _webdriverio = require("webdriverio");
-const _internals = require("./internals");
-const _options = require("./options");
-function _check_private_redeclaration(obj, privateCollection) {
-    if (privateCollection.has(obj)) {
-        throw new TypeError("Cannot initialize the same private elements twice on an object");
-    }
-}
-function _class_apply_descriptor_get(receiver, descriptor) {
-    if (descriptor.get) {
-        return descriptor.get.call(receiver);
-    }
-    return descriptor.value;
-}
-function _class_apply_descriptor_set(receiver, descriptor, value) {
-    if (descriptor.set) {
-        descriptor.set.call(receiver, value);
-    } else {
-        if (!descriptor.writable) {
-            throw new TypeError("attempted to set read only private field");
-        }
-        descriptor.value = value;
-    }
-}
-function _class_extract_field_descriptor(receiver, privateMap, action) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to " + action + " private field on non-instance");
-    }
-    return privateMap.get(receiver);
-}
-function _class_private_field_get(receiver, privateMap) {
-    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
-    return _class_apply_descriptor_get(receiver, descriptor);
-}
-function _class_private_field_init(obj, privateMap, value) {
-    _check_private_redeclaration(obj, privateMap);
-    privateMap.set(obj, value);
-}
-function _class_private_field_set(receiver, privateMap, value) {
-    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
-    _class_apply_descriptor_set(receiver, descriptor, value);
-    return value;
-}
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-/* eslint-enable */ const log = (0, _utils.createModuleLogger)(_internals.rootLogger, 'environment');
-var _options1 = /*#__PURE__*/ new WeakMap(), _server = /*#__PURE__*/ new WeakMap();
-class SnapsEnvironment extends _jestenvironmentnode.default {
-    /**
-   * Set up the environment. This starts the built-in HTTP server, and creates a
-   * new browser instance.
-   */ async setup() {
-        await super.setup();
-        if (_class_private_field_get(this, _options1).server.enabled) {
-            log('Starting server.');
-            _class_private_field_set(this, _server, await (0, _internals.startServer)(_class_private_field_get(this, _options1).server));
-        }
-        const args = [];
-        if (_class_private_field_get(this, _options1).browser.headless) {
-            args.push('--headless', '--disable-gpu');
-        }
-        log('Starting browser.');
-        this.browser = await (0, _webdriverio.remote)({
-            logLevel: 'error',
-            capabilities: {
-                browserName: 'chrome',
-                // eslint-disable-next-line @typescript-eslint/naming-convention
-                'goog:chromeOptions': {
-                    args
-                }
-            }
-        });
-        this.global.browser = this.browser;
-        this.global.snapsEnvironment = this;
-    }
-    /**
-   * Tear down the environment. This closes the browser, and stops the built-in
-   * HTTP server.
-   */ async teardown() {
-        if (_class_private_field_get(this, _options1).keepAlive) {
-            log('Not tearing down environment because keepAlive is enabled.');
-            return;
-        }
-        log('Closing browser, and stopping server.');
-        await this.browser?.deleteSession();
-        _class_private_field_get(this, _server)?.close();
-        await super.teardown();
-    }
-    /**
-   * Get the URL to the simulator, including the environment URL.
-   *
-   * @returns The simulator URL.
-   * @throws If the server is not running.
-   */ get url() {
-        (0, _utils.assert)(_class_private_field_get(this, _server), 'Server is not running.');
-        const { port } = _class_private_field_get(this, _server).address();
-        const simulatorUrl = _class_private_field_get(this, _options1).simulatorUrl ?? `http://localhost:${port}/simulator/`;
-        const executionEnvironmentUrl = _class_private_field_get(this, _options1).executionEnvironmentUrl ?? `http://localhost:${port}/environment/`;
-        return `${simulatorUrl}?environment=${encodeURIComponent(executionEnvironmentUrl)}`;
-    }
-    /**
-   * Get the snap ID for the current environment, which is used if no snap ID is
-   * passed to {@link installSnap}. This assumes that the built-in server is
-   * running.
-   *
-   * @returns The snap ID.
-   * @throws If the server is not running.
-   */ get snapId() {
-        (0, _utils.assert)(_class_private_field_get(this, _server), 'You must specify a snap ID, because the built-in server is not running.');
-        const { port } = _class_private_field_get(this, _server).address();
-        return `local:http://localhost:${port}`;
-    }
-    /**
-   * Create a new page, and attach logging handlers.
-   *
-   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,
-   * or the default simulator URL if none is specified.
-   * @param timeout - The page timeout, in milliseconds.
-   * @returns The new page.
-   */ async createPage(url = this.url, timeout = 10000) {
-        const puppeteer = await this.browser.getPuppeteer();
-        const page = await puppeteer.newPage();
-        page.setDefaultTimeout(timeout);
-        page.setDefaultNavigationTimeout(timeout);
-        // Give the page permission to show notifications. This is required for
-        // testing `snap_notify`.
-        await page.browserContext().overridePermissions(url, [
-            'notifications'
-        ]);
-        // `networkidle0` is used to ensure that the page is fully loaded. This
-        // makes it wait for no requests to be made, which guarantees that the page
-        // is ready.
-        await page.goto(url, {
-            waitUntil: 'networkidle0'
-        });
-        const browserLog = (0, _utils.createModuleLogger)(_internals.rootLogger, 'browser');
-        page// This is fired when the page calls `console.log` or similar.
-        .on('console', (message)=>{
-            browserLog(`[${message.type()}] ${message.text()}`);
-        })// This is fired when the page throws an error.
-        .on('pageerror', ({ message })=>{
-            browserLog(`[page error] ${message}`);
-        });
-        return page;
-    }
-    /**
-   * Constructor.
-   *
-   * @param options - The environment options.
-   * @param context - The environment context.
-   */ constructor(options, context){
-        super(options, context);
-        // `browser` is always set in the environment setup function. To avoid needing
-        // to check for `undefined` everywhere, we use a type assertion here.
-        _define_property(this, "browser", void 0);
-        _class_private_field_init(this, _options1, {
-            writable: true,
-            value: void 0
-        });
-        _class_private_field_init(this, _server, {
-            writable: true,
-            value: void 0
-        });
-        _class_private_field_set(this, _options1, (0, _options.getOptions)(options.projectConfig.testEnvironmentOptions));
-    }
-}
-const _default = SnapsEnvironment;
-
-//# sourceMappingURL=environment.js.map

package/dist/cjs/environment.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/environment.ts"],"sourcesContent":["import type {\n  EnvironmentContext,\n  JestEnvironmentConfig,\n} from '@jest/environment';\nimport { assert, createModuleLogger } from '@metamask/utils';\nimport type { Server } from 'http';\nimport NodeEnvironment from 'jest-environment-node';\nimport type { AddressInfo } from 'net';\nimport type { Browser } from 'puppeteer';\nimport { remote } from 'webdriverio';\n\nimport { rootLogger, startServer } from './internals';\nimport type { SnapsEnvironmentOptions } from './options';\nimport { getOptions } from './options';\n\n/* eslint-disable */\ndeclare global {\n  const browser: WebdriverIO.Browser;\n  const snapsEnvironment: SnapsEnvironment;\n}\n/* eslint-enable */\n\nconst log = createModuleLogger(rootLogger, 'environment');\n\nexport class SnapsEnvironment extends NodeEnvironment {\n  // `browser` is always set in the environment setup function. To avoid needing\n  // to check for `undefined` everywhere, we use a type assertion here.\n  browser!: WebdriverIO.Browser;\n\n  #options: SnapsEnvironmentOptions;\n\n  #server: Server | undefined;\n\n  /**\n   * Constructor.\n   *\n   * @param options - The environment options.\n   * @param context - The environment context.\n   */\n  constructor(options: JestEnvironmentConfig, context: EnvironmentContext) {\n    super(options, context);\n    this.#options = getOptions(options.projectConfig.testEnvironmentOptions);\n  }\n\n  /**\n   * Set up the environment. This starts the built-in HTTP server, and creates a\n   * new browser instance.\n   */\n  async setup() {\n    await super.setup();\n\n    if (this.#options.server.enabled) {\n      log('Starting server.');\n      this.#server = await startServer(this.#options.server);\n    }\n\n    const args = [];\n    if (this.#options.browser.headless) {\n      args.push('--headless', '--disable-gpu');\n    }\n\n    log('Starting browser.');\n    this.browser = await remote({\n      logLevel: 'error',\n      capabilities: {\n        browserName: 'chrome',\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        'goog:chromeOptions': {\n          args,\n        },\n      },\n    });\n\n    this.global.browser = this.browser;\n    this.global.snapsEnvironment = this;\n  }\n\n  /**\n   * Tear down the environment. This closes the browser, and stops the built-in\n   * HTTP server.\n   */\n  async teardown() {\n    if (this.#options.keepAlive) {\n      log('Not tearing down environment because keepAlive is enabled.');\n      return;\n    }\n\n    log('Closing browser, and stopping server.');\n    await this.browser?.deleteSession();\n    this.#server?.close();\n\n    await super.teardown();\n  }\n\n  /**\n   * Get the URL to the simulator, including the environment URL.\n   *\n   * @returns The simulator URL.\n   * @throws If the server is not running.\n   */\n  get url() {\n    assert(this.#server, 'Server is not running.');\n\n    const { port } = this.#server.address() as AddressInfo;\n    const simulatorUrl =\n      this.#options.simulatorUrl ?? `http://localhost:${port}/simulator/`;\n\n    const executionEnvironmentUrl =\n      this.#options.executionEnvironmentUrl ??\n      `http://localhost:${port}/environment/`;\n\n    return `${simulatorUrl}?environment=${encodeURIComponent(\n      executionEnvironmentUrl,\n    )}`;\n  }\n\n  /**\n   * Get the snap ID for the current environment, which is used if no snap ID is\n   * passed to {@link installSnap}. This assumes that the built-in server is\n   * running.\n   *\n   * @returns The snap ID.\n   * @throws If the server is not running.\n   */\n  get snapId() {\n    assert(\n      this.#server,\n      'You must specify a snap ID, because the built-in server is not running.',\n    );\n\n    const { port } = this.#server.address() as AddressInfo;\n    return `local:http://localhost:${port}`;\n  }\n\n  /**\n   * Create a new page, and attach logging handlers.\n   *\n   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,\n   * or the default simulator URL if none is specified.\n   * @param timeout - The page timeout, in milliseconds.\n   * @returns The new page.\n   */\n  async createPage(url: string = this.url, timeout = 10000) {\n    const puppeteer = (await this.browser.getPuppeteer()) as unknown as Browser;\n    const page = await puppeteer.newPage();\n\n    page.setDefaultTimeout(timeout);\n    page.setDefaultNavigationTimeout(timeout);\n\n    // Give the page permission to show notifications. This is required for\n    // testing `snap_notify`.\n    await page.browserContext().overridePermissions(url, ['notifications']);\n\n    // `networkidle0` is used to ensure that the page is fully loaded. This\n    // makes it wait for no requests to be made, which guarantees that the page\n    // is ready.\n    await page.goto(url, { waitUntil: 'networkidle0' });\n\n    const browserLog = createModuleLogger(rootLogger, 'browser');\n\n    page\n      // This is fired when the page calls `console.log` or similar.\n      .on('console', (message) => {\n        browserLog(`[${message.type()}] ${message.text()}`);\n      })\n\n      // This is fired when the page throws an error.\n      .on('pageerror', ({ message }) => {\n        browserLog(`[page error] ${message}`);\n      });\n\n    return page;\n  }\n}\n\nexport default SnapsEnvironment;\n"],"names":["SnapsEnvironment","log","createModuleLogger","rootLogger","NodeEnvironment","setup","options","server","enabled","startServer","args","browser","headless","push","remote","logLevel","capabilities","browserName","global","snapsEnvironment","teardown","keepAlive","deleteSession","close","url","assert","port","address","simulatorUrl","executionEnvironmentUrl","encodeURIComponent","snapId","createPage","timeout","puppeteer","getPuppeteer","page","newPage","setDefaultTimeout","setDefaultNavigationTimeout","browserContext","overridePermissions","goto","waitUntil","browserLog","on","message","type","text","constructor","context","getOptions","projectConfig","testEnvironmentOptions"],"mappings":";;;;;;;;;;;IAwBaA,gBAAgB;eAAhBA;;IAuJb,OAAgC;eAAhC;;;uBA3K2C;4EAEf;6BAGL;2BAEiB;yBAEb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAO3B,iBAAiB,GAEjB,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;IAOzC,yCAEA;AAPK,MAAMH,yBAAyBI,4BAAe;IAoBnD;;;GAGC,GACD,MAAMC,QAAQ;QACZ,MAAM,KAAK,CAACA;QAEZ,IAAI,yBAAA,IAAI,EAAEC,WAAQC,MAAM,CAACC,OAAO,EAAE;YAChCP,IAAI;2CACEM,SAAS,MAAME,IAAAA,sBAAW,EAAC,yBAAA,IAAI,EAAEH,WAAQC,MAAM;QACvD;QAEA,MAAMG,OAAO,EAAE;QACf,IAAI,yBAAA,IAAI,EAAEJ,WAAQK,OAAO,CAACC,QAAQ,EAAE;YAClCF,KAAKG,IAAI,CAAC,cAAc;QAC1B;QAEAZ,IAAI;QACJ,IAAI,CAACU,OAAO,GAAG,MAAMG,IAAAA,mBAAM,EAAC;YAC1BC,UAAU;YACVC,cAAc;gBACZC,aAAa;gBACb,gEAAgE;gBAChE,sBAAsB;oBACpBP;gBACF;YACF;QACF;QAEA,IAAI,CAACQ,MAAM,CAACP,OAAO,GAAG,IAAI,CAACA,OAAO;QAClC,IAAI,CAACO,MAAM,CAACC,gBAAgB,GAAG,IAAI;IACrC;IAEA;;;GAGC,GACD,MAAMC,WAAW;QACf,IAAI,yBAAA,IAAI,EAAEd,WAAQe,SAAS,EAAE;YAC3BpB,IAAI;YACJ;QACF;QAEAA,IAAI;QACJ,MAAM,IAAI,CAACU,OAAO,EAAEW;iCACpB,IAAI,EAAEf,UAAQgB;QAEd,MAAM,KAAK,CAACH;IACd;IAEA;;;;;GAKC,GACD,IAAII,MAAM;QACRC,IAAAA,aAAM,2BAAC,IAAI,EAAElB,UAAQ;QAErB,MAAM,EAAEmB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEnB,SAAOoB,OAAO;QACrC,MAAMC,eACJ,yBAAA,IAAI,EAAEtB,WAAQsB,YAAY,IAAI,CAAC,iBAAiB,EAAEF,KAAK,WAAW,CAAC;QAErE,MAAMG,0BACJ,yBAAA,IAAI,EAAEvB,WAAQuB,uBAAuB,IACrC,CAAC,iBAAiB,EAAEH,KAAK,aAAa,CAAC;QAEzC,OAAO,CAAC,EAAEE,aAAa,aAAa,EAAEE,mBACpCD,yBACA,CAAC;IACL;IAEA;;;;;;;GAOC,GACD,IAAIE,SAAS;QACXN,IAAAA,aAAM,2BACJ,IAAI,EAAElB,UACN;QAGF,MAAM,EAAEmB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEnB,SAAOoB,OAAO;QACrC,OAAO,CAAC,uBAAuB,EAAED,KAAK,CAAC;IACzC;IAEA;;;;;;;GAOC,GACD,MAAMM,WAAWR,MAAc,IAAI,CAACA,GAAG,EAAES,UAAU,KAAK,EAAE;QACxD,MAAMC,YAAa,MAAM,IAAI,CAACvB,OAAO,CAACwB,YAAY;QAClD,MAAMC,OAAO,MAAMF,UAAUG,OAAO;QAEpCD,KAAKE,iBAAiB,CAACL;QACvBG,KAAKG,2BAA2B,CAACN;QAEjC,uEAAuE;QACvE,yBAAyB;QACzB,MAAMG,KAAKI,cAAc,GAAGC,mBAAmB,CAACjB,KAAK;YAAC;SAAgB;QAEtE,uEAAuE;QACvE,2EAA2E;QAC3E,YAAY;QACZ,MAAMY,KAAKM,IAAI,CAAClB,KAAK;YAAEmB,WAAW;QAAe;QAEjD,MAAMC,aAAa1C,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;QAElDiC,IACE,8DAA8D;SAC7DS,EAAE,CAAC,WAAW,CAACC;YACdF,WAAW,CAAC,CAAC,EAAEE,QAAQC,IAAI,GAAG,EAAE,EAAED,QAAQE,IAAI,GAAG,CAAC;QACpD,EAEA,+CAA+C;SAC9CH,EAAE,CAAC,aAAa,CAAC,EAAEC,OAAO,EAAE;YAC3BF,WAAW,CAAC,aAAa,EAAEE,QAAQ,CAAC;QACtC;QAEF,OAAOV;IACT;IA3IA;;;;;GAKC,GACDa,YAAY3C,OAA8B,EAAE4C,OAA2B,CAAE;QACvE,KAAK,CAAC5C,SAAS4C;QAfjB,8EAA8E;QAC9E,qEAAqE;QACrEvC,uBAAAA,WAAAA,KAAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAUQL,WAAU6C,IAAAA,mBAAU,EAAC7C,QAAQ8C,aAAa,CAACC,sBAAsB;IACzE;AAmIF;MAEA,WAAerD"}

package/dist/cjs/helpers.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "installSnap", {
-    enumerable: true,
-    get: function() {
-        return installSnap;
-    }
-});
-const _utils = require("@metamask/utils");
-const _pptrtestinglibrary = require("pptr-testing-library");
-const _internals = require("./internals");
-// eslint-disable-next-line @typescript-eslint/unbound-method
-const { getByTestId } = _pptrtestinglibrary.queries;
-const log = (0, _utils.createModuleLogger)(_internals.rootLogger, 'helpers');
-async function installSnap(snapId = (0, _internals.getEnvironment)().snapId) {
-    const environment = (0, _internals.getEnvironment)();
-    log('Installing snap %s.', snapId);
-    const page = await environment.createPage();
-    const document = await (0, _pptrtestinglibrary.getDocument)(page);
-    log('Setting snap ID to %s.', snapId);
-    await page.evaluate((payload)=>{
-        window.__SIMULATOR_API__.dispatch({
-            type: 'configuration/setSnapId',
-            payload
-        });
-    }, snapId);
-    log('Waiting for snap to install.');
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    await (0, _internals.waitFor)(async ()=>await getByTestId(document, 'status-ok'), {
-        timeout: 10000,
-        message: `Timed out waiting for snap to install. Make sure the snap ID ("${snapId}") is correct, and the server is running.`
-    });
-    return {
-        request: (options)=>{
-            log('Sending request %o.', options);
-            // Note: This function is intentionally not async, so that we can access
-            // the `getInterface` method on the response.
-            return (0, _internals.request)(page, options);
-        },
-        sendTransaction: async (options = {})=>{
-            log('Sending transaction %o.', options);
-            return await (0, _internals.sendTransaction)(page, options);
-        },
-        runCronjob: (options)=>{
-            log('Running cronjob %o.', options);
-            // Note: This function is intentionally not async, so that we can access
-            // the `getInterface` method on the response.
-            return (0, _internals.runCronjob)(page, options);
-        },
-        close: async ()=>{
-            log('Closing page.');
-            await page.close();
-        },
-        mock: async (options)=>{
-            log('Mocking %o.', options);
-            return await (0, _internals.mock)(page, options);
-        },
-        mockJsonRpc: async (options)=>{
-            log('Mocking JSON-RPC %o.', options);
-            return await (0, _internals.mockJsonRpc)(page, options);
-        }
-    };
-}
-
-//# sourceMappingURL=helpers.js.map

package/dist/cjs/helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/helpers.ts"],"sourcesContent":["import { createModuleLogger } from '@metamask/utils';\nimport { getDocument, queries } from 'pptr-testing-library';\n\nimport {\n  getEnvironment,\n  mock,\n  waitFor,\n  request,\n  sendTransaction,\n  runCronjob,\n  mockJsonRpc,\n  rootLogger,\n} from './internals';\nimport type { Snap, SnapResponse } from './types';\n\n// eslint-disable-next-line @typescript-eslint/unbound-method\nconst { getByTestId } = queries;\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * ```ts\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * ```\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap(\n  snapId: string = getEnvironment().snapId,\n): Promise<Snap> {\n  const environment = getEnvironment();\n\n  log('Installing snap %s.', snapId);\n\n  const page = await environment.createPage();\n  const document = await getDocument(page);\n\n  log('Setting snap ID to %s.', snapId);\n  await page.evaluate((payload) => {\n    window.__SIMULATOR_API__.dispatch({\n      type: 'configuration/setSnapId',\n      payload,\n    });\n  }, snapId);\n\n  log('Waiting for snap to install.');\n  // eslint-disable-next-line @typescript-eslint/no-misused-promises\n  await waitFor(async () => await getByTestId(document, 'status-ok'), {\n    timeout: 10000,\n    message: `Timed out waiting for snap to install. Make sure the snap ID (\"${snapId}\") is correct, and the server is running.`,\n  });\n\n  return {\n    request: (options) => {\n      log('Sending request %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return request(page, options);\n    },\n\n    sendTransaction: async (options = {}): Promise<SnapResponse> => {\n      log('Sending transaction %o.', options);\n\n      return await sendTransaction(page, options);\n    },\n\n    runCronjob: (options) => {\n      log('Running cronjob %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return runCronjob(page, options);\n    },\n\n    close: async () => {\n      log('Closing page.');\n\n      await page.close();\n    },\n\n    mock: async (options) => {\n      log('Mocking %o.', options);\n\n      return await mock(page, options);\n    },\n\n    mockJsonRpc: async (options) => {\n      log('Mocking JSON-RPC %o.', options);\n\n      return await mockJsonRpc(page, options);\n    },\n  };\n}\n"],"names":["installSnap","getByTestId","queries","log","createModuleLogger","rootLogger","snapId","getEnvironment","environment","page","createPage","document","getDocument","evaluate","payload","window","__SIMULATOR_API__","dispatch","type","waitFor","timeout","message","request","options","sendTransaction","runCronjob","close","mock","mockJsonRpc"],"mappings":";;;;+BA8CsBA;;;eAAAA;;;uBA9Ca;oCACE;2BAW9B;AAGP,6DAA6D;AAC7D,MAAM,EAAEC,WAAW,EAAE,GAAGC,2BAAO;AAE/B,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;AA4BpC,eAAeL,YACpBM,SAAiBC,IAAAA,yBAAc,IAAGD,MAAM;IAExC,MAAME,cAAcD,IAAAA,yBAAc;IAElCJ,IAAI,uBAAuBG;IAE3B,MAAMG,OAAO,MAAMD,YAAYE,UAAU;IACzC,MAAMC,WAAW,MAAMC,IAAAA,+BAAW,EAACH;IAEnCN,IAAI,0BAA0BG;IAC9B,MAAMG,KAAKI,QAAQ,CAAC,CAACC;QACnBC,OAAOC,iBAAiB,CAACC,QAAQ,CAAC;YAChCC,MAAM;YACNJ;QACF;IACF,GAAGR;IAEHH,IAAI;IACJ,kEAAkE;IAClE,MAAMgB,IAAAA,kBAAO,EAAC,UAAY,MAAMlB,YAAYU,UAAU,cAAc;QAClES,SAAS;QACTC,SAAS,CAAC,+DAA+D,EAAEf,OAAO,yCAAyC,CAAC;IAC9H;IAEA,OAAO;QACLgB,SAAS,CAACC;YACRpB,IAAI,uBAAuBoB;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOD,IAAAA,kBAAO,EAACb,MAAMc;QACvB;QAEAC,iBAAiB,OAAOD,UAAU,CAAC,CAAC;YAClCpB,IAAI,2BAA2BoB;YAE/B,OAAO,MAAMC,IAAAA,0BAAe,EAACf,MAAMc;QACrC;QAEAE,YAAY,CAACF;YACXpB,IAAI,uBAAuBoB;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOE,IAAAA,qBAAU,EAAChB,MAAMc;QAC1B;QAEAG,OAAO;YACLvB,IAAI;YAEJ,MAAMM,KAAKiB,KAAK;QAClB;QAEAC,MAAM,OAAOJ;YACXpB,IAAI,eAAeoB;YAEnB,OAAO,MAAMI,IAAAA,eAAI,EAAClB,MAAMc;QAC1B;QAEAK,aAAa,OAAOL;YAClBpB,IAAI,wBAAwBoB;YAE5B,OAAO,MAAMK,IAAAA,sBAAW,EAACnB,MAAMc;QACjC;IACF;AACF"}