@metamask/snaps-jest 4.0.0 → 5.0.0

package/dist/types/internals/structs.d.ts

@@ -61,6 +61,32 @@ export declare const TransactionOptionsStruct: import("superstruct").Struct<{
      */
     data: import("superstruct").Struct<`0x${string}`, null>;
 }>;
+export declare const SignatureOptionsStruct: import("superstruct").Struct<{
+    data: `0x${string}` | Record<string, any> | Record<string, any>[];
+    from: `0x${string}`;
+    origin: string;
+    signatureMethod: "eth_sign" | "personal_sign" | "eth_signTypedData" | "eth_signTypedData_v3" | "eth_signTypedData_v4";
+}, {
+    /**
+     * The origin making the signature request.
+     */
+    origin: import("superstruct").Struct<string, null>;
+    /**
+     * The address signing the signature request. Defaults to a randomly generated
+     * address.
+     */
+    from: import("superstruct").Struct<`0x${string}`, null>;
+    /**
+     * The data to send with the transaction. The data may be specified as a
+     * `string`, an object, or an array of objects. This covers the data types
+     * for the supported signature methods. Defaults to `0x`.
+     */
+    data: import("superstruct").Struct<`0x${string}` | Record<string, any> | Record<string, any>[], null>;
+    /**
+     * The signature method being used.
+     */
+    signatureMethod: import("superstruct").Struct<"eth_sign" | "personal_sign" | "eth_signTypedData" | "eth_signTypedData_v3" | "eth_signTypedData_v4", null>;
+}>;
 export declare const SnapOptionsStruct: import("superstruct").Struct<{
     timeout?: number | undefined;
 }, {
@@ -70,6 +96,13 @@ export declare const SnapOptionsStruct: import("superstruct").Struct<{
      */
     timeout: import("superstruct").Struct<number | undefined, null>;
 }>;
+export declare const JsonRpcMockOptionsStruct: import("superstruct").Struct<{
+    result: import("@metamask/snaps-sdk").Json;
+    method: string;
+}, {
+    method: import("superstruct").Struct<string, null>;
+    result: import("superstruct").Struct<import("@metamask/snaps-sdk").Json, unknown>;
+}>;
 export declare const InterfaceStruct: import("superstruct").Struct<{
     content?: import("@metamask/snaps-sdk").Panel | {
         value: string;
@@ -87,11 +120,56 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Text; /**
-         * The timeout in milliseconds to use for requests to the snap. Defaults to
-         * `1000`.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     } | undefined;
 }, {
     content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
@@ -110,11 +188,56 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Text; /**
-         * The timeout in milliseconds to use for requests to the snap. Defaults to
-         * `1000`.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     } | undefined, null>;
 }>;
 export declare const SnapResponseStruct: import("superstruct").Struct<{
@@ -145,11 +268,56 @@ export declare const SnapResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Text; /**
-         * The timeout in milliseconds to use for requests to the snap. Defaults to
-         * `1000`.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     } | undefined;
 }, {
     id: import("superstruct").Struct<string, null>;
@@ -187,10 +355,55 @@ export declare const SnapResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Text; /**
-         * The timeout in milliseconds to use for requests to the snap. Defaults to
-         * `1000`.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     } | undefined, null>;
 }>;

package/dist/types/options.d.ts

@@ -1,41 +1,26 @@
 import type { Infer } from 'superstruct';
 declare const SnapsEnvironmentOptionsStruct: import("superstruct").Struct<{
-    keepAlive: boolean;
     server: {
         port: number;
-        root: string;
         enabled: boolean;
+        root: string;
     };
-    browser: {
-        headless: boolean;
-    };
-    executionEnvironmentUrl?: string | undefined;
-    simulatorUrl?: string | undefined;
 }, {
-    executionEnvironmentUrl: import("superstruct").Struct<string | undefined, null>;
-    simulatorUrl: import("superstruct").Struct<string | undefined, null>;
-    keepAlive: import("superstruct").Struct<boolean, null>;
     server: import("superstruct").Struct<{
         port: number;
-        root: string;
         enabled: boolean;
+        root: string;
     }, {
         enabled: import("superstruct").Struct<boolean, null>;
         port: import("superstruct").Struct<number, null>;
         root: import("superstruct").Struct<string, null>;
     }>;
-    browser: import("superstruct").Struct<{
-        headless: boolean;
-    }, {
-        headless: import("superstruct").Struct<boolean, null>;
-    }>;
 }>;
 /**
  * The options for the environment. These can be specified in the Jest
  * configuration under `testEnvironmentOptions`.
  *
  * @example
- * ```json
  * {
  *   "testEnvironment": "@metamask/snaps-jest",
  *   "testEnvironmentOptions": {
@@ -46,14 +31,6 @@ declare const SnapsEnvironmentOptionsStruct: import("superstruct").Struct<{
  *     }
  *   }
  * }
- * ```
- * @property executionEnvironmentUrl - The URL of the execution environment. If
- * this is not provided, the execution environment will be served from the
- * built-in HTTP server.
- * @property simulatorUrl - The URL of the simulator. If this is not provided,
- * the simulator will be served from the built-in HTTP server.
- * @property keepAlive - Whether to keep the browser open after the tests have
- * finished. This is useful for debugging. Defaults to `false`.
  * @property server - The options for the built-in HTTP server.
  * @property server.enabled - Whether to run the built-in HTTP server. Defaults
  * to `true`.
@@ -63,9 +40,6 @@ declare const SnapsEnvironmentOptionsStruct: import("superstruct").Struct<{
  * server. Defaults to the current working directory. This is assumed to be the
  * directory containing the snap manifest and `dist` files. If this is a
  * relative path, it will be resolved relative to the current working directory.
- * @property browser - The options for the browser.
- * @property browser.headless - Whether to run the browser in headless mode.
- * Defaults to `true`.
  */
 export declare type SnapsEnvironmentOptions = Infer<typeof SnapsEnvironmentOptionsStruct>;
 /**
@@ -77,16 +51,10 @@ export declare type SnapsEnvironmentOptions = Infer<typeof SnapsEnvironmentOptio
  * @returns The environment options.
  */
 export declare function getOptions(testEnvironmentOptions: Record<string, unknown>): {
-    keepAlive: boolean;
     server: {
         port: number;
-        root: string;
         enabled: boolean;
+        root: string;
     };
-    browser: {
-        headless: boolean;
-    };
-    executionEnvironmentUrl?: string | undefined;
-    simulatorUrl?: string | undefined;
 };
 export {};

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-jest",
-  "version": "4.0.0",
+  "version": "5.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",
@@ -36,22 +36,31 @@
     "@jest/environment": "^29.5.0",
     "@jest/expect": "^29.5.0",
     "@jest/globals": "^29.5.0",
-    "@metamask/snaps-execution-environments": "^3.3.0",
-    "@metamask/snaps-sdk": "^1.0.0",
-    "@metamask/snaps-simulator": "^2.4.0",
-    "@metamask/snaps-utils": "^4.0.0",
-    "@metamask/utils": "^8.1.0",
+    "@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.0",
+    "@metamask/snaps-controllers": "^5.0.0",
+    "@metamask/snaps-execution-environments": "^4.0.0",
+    "@metamask/snaps-rpc-methods": "^6.0.0",
+    "@metamask/snaps-sdk": "^2.0.0",
+    "@metamask/snaps-utils": "^6.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.0",
+    "@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",