@metamask/snaps-jest 8.1.3 → 8.3.0

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

@@ -1,4 +1,4 @@
-export declare const TransactionOptionsStruct: import("superstruct").Struct<{
+export declare const TransactionOptionsStruct: import("@metamask/superstruct").Struct<{
     value: `0x${string}`;
     data: `0x${string}`;
     from: `0x${string}`;
@@ -13,55 +13,55 @@ export declare const TransactionOptionsStruct: import("superstruct").Struct<{
     /**
      * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.
      */
-    chainId: import("superstruct").Struct<string, null>;
+    chainId: import("@metamask/superstruct").Struct<string, null>;
     /**
      * The origin to send the transaction from. Defaults to `metamask.io`.
      */
-    origin: import("superstruct").Struct<string, null>;
+    origin: import("@metamask/superstruct").Struct<string, null>;
     /**
      * The address to send the transaction from. Defaults to a randomly generated
      * address.
      */
-    from: import("superstruct").Struct<`0x${string}`, null>;
+    from: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The address to send the transaction to. Defaults to a randomly generated
      * address.
      */
-    to: import("superstruct").Struct<`0x${string}`, null>;
+    to: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The value to send with the transaction. The value may be specified as a
      * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
      */
-    value: import("superstruct").Struct<`0x${string}`, null>;
+    value: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The gas limit to use for the transaction. The gas limit may be specified
      * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.
      */
-    gasLimit: import("superstruct").Struct<`0x${string}`, null>;
+    gasLimit: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The max fee per gas (in Wei) to use for the transaction. The max fee per
      * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.
      * Defaults to `1`.
      */
-    maxFeePerGas: import("superstruct").Struct<`0x${string}`, null>;
+    maxFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The max priority fee per gas (in Wei) to use for the transaction. The max
      * priority fee per gas may be specified as a `number`, `bigint`, `string`,
      * or `Uint8Array`. Defaults to `1`.
      */
-    maxPriorityFeePerGas: import("superstruct").Struct<`0x${string}`, null>;
+    maxPriorityFeePerGas: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The nonce to use for the transaction. The nonce may be specified as a
      * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.
      */
-    nonce: import("superstruct").Struct<`0x${string}`, null>;
+    nonce: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * The data to send with the transaction. The data may be specified as a
      * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.
      */
-    data: import("superstruct").Struct<`0x${string}`, null>;
+    data: import("@metamask/superstruct").Struct<`0x${string}`, null>;
 }>;
-export declare const SignatureOptionsStruct: import("superstruct").Struct<{
+export declare const SignatureOptionsStruct: import("@metamask/superstruct").Struct<{
     data: `0x${string}` | Record<string, any> | Record<string, any>[];
     from: `0x${string}`;
     origin: string;
@@ -70,45 +70,45 @@ export declare const SignatureOptionsStruct: import("superstruct").Struct<{
     /**
      * The origin making the signature request.
      */
-    origin: import("superstruct").Struct<string, null>;
+    origin: import("@metamask/superstruct").Struct<string, null>;
     /**
      * The address signing the signature request. Defaults to a randomly generated
      * address.
      */
-    from: import("superstruct").Struct<`0x${string}`, null>;
+    from: import("@metamask/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>;
+    data: import("@metamask/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>;
+    signatureMethod: import("@metamask/superstruct").Struct<"eth_sign" | "personal_sign" | "eth_signTypedData" | "eth_signTypedData_v3" | "eth_signTypedData_v4", null>;
 }>;
-export declare const SnapOptionsStruct: import("superstruct").Struct<{
+export declare const SnapOptionsStruct: import("@metamask/superstruct").Struct<{
     timeout?: number | undefined;
 }, {
     /**
      * The timeout in milliseconds to use for requests to the snap. Defaults to
      * `1000`.
      */
-    timeout: import("superstruct").Struct<number | undefined, null>;
+    timeout: import("@metamask/superstruct").Struct<number | undefined, null>;
 }>;
-export declare const JsonRpcMockOptionsStruct: import("superstruct").Struct<{
+export declare const JsonRpcMockOptionsStruct: import("@metamask/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>;
+    method: import("@metamask/superstruct").Struct<string, null>;
+    result: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Json, unknown>;
 }>;
-export declare const InterfaceStruct: import("superstruct").Struct<{
+export declare const InterfaceStruct: import("@metamask/superstruct").Struct<{
     content?: import("@metamask/snaps-sdk/jsx").JSXElement | undefined;
 }, {
-    content: import("superstruct").Struct<import("@metamask/snaps-sdk/jsx").JSXElement | undefined, null>;
+    content: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk/jsx").JSXElement | undefined, null>;
 }>;
-export declare const SnapResponseWithoutInterfaceStruct: import("superstruct").Struct<{
+export declare const SnapResponseWithoutInterfaceStruct: import("@metamask/superstruct").Struct<{
     id: string;
     response: {
         result: import("@metamask/snaps-sdk").Json;
@@ -121,27 +121,27 @@ export declare const SnapResponseWithoutInterfaceStruct: import("superstruct").S
         id: string;
     }[];
 }, {
-    id: import("superstruct").Struct<string, null>;
-    response: import("superstruct").Struct<{
+    id: import("@metamask/superstruct").Struct<string, null>;
+    response: import("@metamask/superstruct").Struct<{
         result: import("@metamask/snaps-sdk").Json;
     } | {
         error: import("@metamask/snaps-sdk").Json;
     }, null>;
-    notifications: import("superstruct").Struct<{
+    notifications: import("@metamask/superstruct").Struct<{
         type: "native" | "inApp";
         message: string;
         id: string;
-    }[], import("superstruct").Struct<{
+    }[], import("@metamask/superstruct").Struct<{
         type: "native" | "inApp";
         message: string;
         id: string;
     }, {
-        id: import("superstruct").Struct<string, null>;
-        message: import("superstruct").Struct<string, null>;
-        type: import("superstruct").Struct<"native" | "inApp", null>;
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
     }>>;
 }>;
-export declare const SnapResponseWithInterfaceStruct: import("superstruct").Struct<{
+export declare const SnapResponseWithInterfaceStruct: import("@metamask/superstruct").Struct<{
     id: string;
     response: {
         result: import("@metamask/snaps-sdk").Json;
@@ -155,28 +155,28 @@ export declare const SnapResponseWithInterfaceStruct: import("superstruct").Stru
         id: string;
     }[];
 }, {
-    getInterface: import("superstruct").Struct<Function, null>;
-    id: import("superstruct").Struct<string, null>;
-    response: import("superstruct").Struct<{
+    getInterface: import("@metamask/superstruct").Struct<Function, null>;
+    id: import("@metamask/superstruct").Struct<string, null>;
+    response: import("@metamask/superstruct").Struct<{
         result: import("@metamask/snaps-sdk").Json;
     } | {
         error: import("@metamask/snaps-sdk").Json;
     }, null>;
-    notifications: import("superstruct").Struct<{
+    notifications: import("@metamask/superstruct").Struct<{
         type: "native" | "inApp";
         message: string;
         id: string;
-    }[], import("superstruct").Struct<{
+    }[], import("@metamask/superstruct").Struct<{
         type: "native" | "inApp";
         message: string;
         id: string;
     }, {
-        id: import("superstruct").Struct<string, null>;
-        message: import("superstruct").Struct<string, null>;
-        type: import("superstruct").Struct<"native" | "inApp", null>;
+        id: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+        type: import("@metamask/superstruct").Struct<"native" | "inApp", null>;
     }>>;
 }>;
-export declare const SnapResponseStruct: import("superstruct").Struct<{
+export declare const SnapResponseStruct: import("@metamask/superstruct").Struct<{
     id: string;
     response: {
         result: import("@metamask/snaps-sdk").Json;

package/dist/types/matchers.d.ts

@@ -1,6 +1,5 @@
 import type { MatcherFunction } from '@jest/expect';
 import type { NotificationType, EnumToUnion, ComponentOrElement } from '@metamask/snaps-sdk';
-import type { SnapNode } from '@metamask/snaps-sdk/jsx';
 import type { Json } from '@metamask/utils';
 /**
  * Check if a JSON-RPC response matches the expected value. This matcher is
@@ -25,13 +24,4 @@ export declare const toSendNotification: MatcherFunction<[
     expected: string,
     type?: EnumToUnion<NotificationType> | undefined
 ]>;
-/**
- * Serialise a JSX node to a string.
- *
- * @param node - The JSX node.
- * @param indentation - The indentation level. Defaults to `0`. This should not
- * be set by the caller, as it is used for recursion.
- * @returns The serialised JSX node.
- */
-export declare function serialiseJsx(node: SnapNode, indentation?: number): string;
 export declare const toRender: MatcherFunction<[expected: ComponentOrElement]>;

package/dist/types/options.d.ts

@@ -1,19 +1,19 @@
-import type { Infer } from 'superstruct';
-declare const SnapsEnvironmentOptionsStruct: import("superstruct").Struct<{
+import type { Infer } from '@metamask/superstruct';
+declare const SnapsEnvironmentOptionsStruct: import("@metamask/superstruct").Struct<{
     server: {
         port: number;
         enabled: boolean;
         root: string;
     };
 }, {
-    server: import("superstruct").Struct<{
+    server: import("@metamask/superstruct").Struct<{
         port: number;
         enabled: boolean;
         root: string;
     }, {
-        enabled: import("superstruct").Struct<boolean, null>;
-        port: import("superstruct").Struct<number, null>;
-        root: import("superstruct").Struct<string, null>;
+        enabled: import("@metamask/superstruct").Struct<boolean, null>;
+        port: import("@metamask/superstruct").Struct<number, null>;
+        root: import("@metamask/superstruct").Struct<string, null>;
     }>;
 }>;
 /**
@@ -41,7 +41,7 @@ declare const SnapsEnvironmentOptionsStruct: import("superstruct").Struct<{
  * directory containing the snap manifest and `dist` files. If this is a
  * relative path, it will be resolved relative to the current working directory.
  */
-export declare type SnapsEnvironmentOptions = Infer<typeof SnapsEnvironmentOptionsStruct>;
+export type SnapsEnvironmentOptions = Infer<typeof SnapsEnvironmentOptionsStruct>;
 /**
  * Get the environment options. This validates the options, and returns the
  * default options if none are provided.

package/dist/types/types.d.ts

@@ -1,10 +1,10 @@
 import type { NotificationType, EnumToUnion } from '@metamask/snaps-sdk';
 import type { JSXElement } from '@metamask/snaps-sdk/jsx';
 import type { InferMatching } from '@metamask/snaps-utils';
+import type { Infer } from '@metamask/superstruct';
 import type { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';
-import type { Infer } from 'superstruct';
 import type { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from './internals';
-export declare type RequestOptions = {
+export type RequestOptions = {
     /**
      * The JSON-RPC request ID.
      */
@@ -26,7 +26,7 @@ export declare type RequestOptions = {
  * The `runCronjob` options. This is the same as {@link RequestOptions}, except
  * that it does not have an `origin` property.
  */
-export declare type CronjobOptions = Omit<RequestOptions, 'origin'>;
+export type CronjobOptions = Omit<RequestOptions, 'origin'>;
 /**
  * The options to use for transaction requests.
  *
@@ -48,7 +48,7 @@ export declare type CronjobOptions = Omit<RequestOptions, 'origin'>;
  * the transaction. Defaults to `1`.
  * @property nonce - The nonce to use for the transaction. Defaults to `0`.
  */
-export declare type TransactionOptions = Infer<typeof TransactionOptionsStruct>;
+export type TransactionOptions = Infer<typeof TransactionOptionsStruct>;
 /**
  * The options to use for signature requests.
  *
@@ -59,14 +59,29 @@ export declare type TransactionOptions = Infer<typeof TransactionOptionsStruct>;
  * @property data - The data to sign. Defaults to `0x`.
  * @property signatureMethod - The signature method.
  */
-export declare type SignatureOptions = Infer<typeof SignatureOptionsStruct>;
+export type SignatureOptions = Infer<typeof SignatureOptionsStruct>;
 /**
  * The options to use for requests to the snap.
  *
  * @property timeout - The timeout in milliseconds to use. Defaults to `1000`.
  */
-export declare type SnapOptions = Infer<typeof SnapOptionsStruct>;
-export declare type SnapInterfaceActions = {
+export type SnapOptions = Infer<typeof SnapOptionsStruct>;
+/**
+ * Options for uploading a file.
+ *
+ * @property fileName - The name of the file. By default, this is inferred from
+ * the file path if it's a path, and defaults to an empty string if it's a
+ * `Uint8Array`.
+ * @property contentType - The content type of the file. By default, this is
+ * inferred from the file name if it's a path, and defaults to
+ * `application/octet-stream` if it's a `Uint8Array` or the content type cannot
+ * be inferred from the file name.
+ */
+export type FileOptions = {
+    fileName?: string;
+    contentType?: string;
+};
+export type SnapInterfaceActions = {
     /**
      * Click on an interface element.
      *
@@ -87,11 +102,35 @@ export declare type SnapInterfaceActions = {
      * @param value - The value to type.
      */
     selectInDropdown(name: string, value: string): Promise<void>;
+    /**
+     * Choose an option with a value from radio group.
+     *
+     * @param name - The element name to type in.
+     * @param value - The value to type.
+     */
+    selectFromRadioGroup(name: string, value: string): Promise<void>;
+    /**
+     * Upload a file.
+     *
+     * @param name - The element name to upload the file to.
+     * @param file - The file to upload. This can be a path to a file or a
+     * `Uint8Array` containing the file contents. If this is a path, the file is
+     * resolved relative to the current working directory.
+     * @param options - The file options.
+     * @param options.fileName - The name of the file. By default, this is
+     * inferred from the file path if it's a path, and defaults to an empty string
+     * if it's a `Uint8Array`.
+     * @param options.contentType - The content type of the file. By default, this
+     * is inferred from the file name if it's a path, and defaults to
+     * `application/octet-stream` if it's a `Uint8Array` or the content type
+     * cannot be inferred from the file name.
+     */
+    uploadFile(name: string, file: string | Uint8Array, options?: FileOptions): Promise<void>;
 };
 /**
  * A `snap_dialog` alert interface.
  */
-export declare type SnapAlertInterface = {
+export type SnapAlertInterface = {
     /**
      * The type of the interface. This is always `alert`.
      */
@@ -108,7 +147,7 @@ export declare type SnapAlertInterface = {
 /**
  * A `snap_dialog` confirmation interface.
  */
-export declare type SnapConfirmationInterface = {
+export type SnapConfirmationInterface = {
     /**
      * The type of the interface. This is always `confirmation`.
      */
@@ -129,7 +168,7 @@ export declare type SnapConfirmationInterface = {
 /**
  * A `snap_dialog` prompt interface.
  */
-export declare type SnapPromptInterface = {
+export type SnapPromptInterface = {
     /**
      * The type of the interface. This is always `prompt`.
      */
@@ -149,8 +188,40 @@ export declare type SnapPromptInterface = {
      */
     cancel(): Promise<void>;
 };
-export declare type SnapInterface = (SnapAlertInterface | SnapConfirmationInterface | SnapPromptInterface) & SnapInterfaceActions;
-export declare type SnapRequestObject = {
+/**
+ * A `snap_dialog` default interface that has a Footer with two buttons defined.
+ * The approval of this confirmation is handled by the snap.
+ */
+export type DefaultSnapInterfaceWithFooter = {
+    /**
+     * The content to show in the interface.
+     */
+    content: JSXElement;
+};
+/**
+ * A `snap_dialog` default interface that has a Footer with one button defined.
+ * A cancel button is automatically applied to the interface in this case.
+ */
+export type DefaultSnapInterfaceWithPartialFooter = DefaultSnapInterfaceWithFooter & {
+    /**
+     * Cancel the dialog.
+     */
+    cancel(): Promise<void>;
+};
+/**
+ * A `snap_dialog` default interface that has no Footer defined.
+ * A cancel and ok button is automatically applied to the interface in this case.
+ */
+export type DefaultSnapInterfaceWithoutFooter = DefaultSnapInterfaceWithPartialFooter & {
+    /**
+     * Close the dialog.
+     *
+     */
+    ok(): Promise<void>;
+};
+export type DefaultSnapInterface = DefaultSnapInterfaceWithFooter | DefaultSnapInterfaceWithPartialFooter | DefaultSnapInterfaceWithoutFooter;
+export type SnapInterface = (SnapAlertInterface | SnapConfirmationInterface | SnapPromptInterface | DefaultSnapInterface) & SnapInterfaceActions;
+export type SnapRequestObject = {
     /**
      * Get a user interface object from a snap. This will throw an error if the
      * snap does not show a user interface within the timeout.
@@ -166,11 +237,11 @@ export declare type SnapRequestObject = {
  * A pending request object. This is a promise with extra
  * {@link SnapRequestObject} fields.
  */
-export declare type SnapRequest = Promise<SnapResponse> & SnapRequestObject;
+export type SnapRequest = Promise<SnapResponse> & SnapRequestObject;
 /**
  * The options to use for mocking a JSON-RPC request.
  */
-export declare type JsonRpcMockOptions = {
+export type JsonRpcMockOptions = {
     /**
      * The JSON-RPC request method.
      */
@@ -193,7 +264,7 @@ export declare type JsonRpcMockOptions = {
  *
  * expect(response).toRespondWith('Hello, world!');
  */
-export declare type Snap = {
+export type Snap = {
     /**
      * Send a JSON-RPC request to the snap.
      *
@@ -292,10 +363,10 @@ export declare type Snap = {
      */
     close(): Promise<void>;
 };
-export declare type SnapHandlerInterface = {
+export type SnapHandlerInterface = {
     content: JSXElement;
 } & SnapInterfaceActions;
-export declare type SnapResponseWithInterface = {
+export type SnapResponseWithInterface = {
     id: string;
     response: {
         result: Json;
@@ -309,6 +380,6 @@ export declare type SnapResponseWithInterface = {
     }[];
     getInterface(): SnapHandlerInterface;
 };
-export declare type SnapResponseWithoutInterface = Omit<SnapResponseWithInterface, 'getInterface'>;
-export declare type SnapResponseType = SnapResponseWithoutInterface | SnapResponseWithInterface;
-export declare type SnapResponse = InferMatching<typeof SnapResponseStruct, SnapResponseType>;
+export type SnapResponseWithoutInterface = Omit<SnapResponseWithInterface, 'getInterface'>;
+export type SnapResponseType = SnapResponseWithoutInterface | SnapResponseWithInterface;
+export type SnapResponse = InferMatching<typeof SnapResponseStruct, SnapResponseType>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-jest",
-  "version": "8.1.3",
+  "version": "8.3.0",
   "description": "A Jest preset for end-to-end testing MetaMask Snaps, including a Jest environment, and a set of Jest matchers.",
   "sideEffects": false,
   "exports": {
@@ -40,26 +40,27 @@
     "@jest/environment": "^29.5.0",
     "@jest/expect": "^29.5.0",
     "@jest/globals": "^29.5.0",
-    "@metamask/base-controller": "^6.0.0",
-    "@metamask/eth-json-rpc-middleware": "^12.1.2",
-    "@metamask/json-rpc-engine": "^9.0.0",
-    "@metamask/json-rpc-middleware-stream": "^8.0.0",
-    "@metamask/key-tree": "^9.1.1",
-    "@metamask/permission-controller": "^10.0.0",
-    "@metamask/snaps-controllers": "^9.0.0",
-    "@metamask/snaps-execution-environments": "^6.4.0",
-    "@metamask/snaps-rpc-methods": "^9.1.3",
-    "@metamask/snaps-sdk": "^5.0.0",
-    "@metamask/snaps-utils": "^7.6.0",
-    "@metamask/utils": "^8.3.0",
+    "@metamask/base-controller": "^6.0.2",
+    "@metamask/eth-json-rpc-middleware": "^13.0.0",
+    "@metamask/json-rpc-engine": "^9.0.2",
+    "@metamask/json-rpc-middleware-stream": "^8.0.2",
+    "@metamask/key-tree": "^9.1.2",
+    "@metamask/permission-controller": "^11.0.0",
+    "@metamask/snaps-controllers": "^9.4.0",
+    "@metamask/snaps-execution-environments": "^6.6.2",
+    "@metamask/snaps-rpc-methods": "^11.0.0",
+    "@metamask/snaps-sdk": "^6.2.0",
+    "@metamask/snaps-utils": "^8.0.0",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^9.1.0",
     "@reduxjs/toolkit": "^1.9.5",
     "express": "^4.18.2",
     "jest-environment-node": "^29.5.0",
     "jest-matcher-utils": "^29.5.0",
+    "mime": "^3.0.0",
     "readable-stream": "^3.6.2",
     "redux": "^4.2.1",
-    "redux-saga": "^1.2.3",
-    "superstruct": "^1.0.3"
+    "redux-saga": "^1.2.3"
   },
   "devDependencies": {
     "@jest/types": "^29.6.3",
@@ -72,6 +73,7 @@
     "@swc/core": "1.3.78",
     "@swc/jest": "^0.2.26",
     "@types/jest": "^27.5.1",
+    "@types/mime": "^3.0.0",
     "@types/semver": "^7.5.0",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
@@ -91,7 +93,7 @@
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
     "tsup": "^8.0.1",
-    "typescript": "~4.8.4"
+    "typescript": "~5.0.4"
   },
   "engines": {
     "node": "^18.16 || >=20"

package/dist/chunk-265BMFM5.js

@@ -1,13 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/internals/simulation/methods/hooks/get-locale.ts
-function getGetLocaleMethodImplementation({
-  locale
-}) {
-  return async () => {
-    return locale;
-  };
-}
-
-
-
-exports.getGetLocaleMethodImplementation = getGetLocaleMethodImplementation;
-//# sourceMappingURL=chunk-265BMFM5.js.map

package/dist/chunk-265BMFM5.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/internals/simulation/methods/hooks/get-locale.ts"],"names":[],"mappings":";AASO,SAAS,iCAAiC;AAAA,EAC/C;AACF,GAAsB;AACpB,SAAO,YAAY;AACjB,WAAO;AAAA,EACT;AACF","sourcesContent":["import type { SimulationOptions } from '../../options';\n\n/**\n * Get the implementation of the `getLocale` hook.\n *\n * @param options - The simulation options.\n * @param options.locale - The locale to use.\n * @returns The implementation of the `getLocale` hook.\n */\nexport function getGetLocaleMethodImplementation({\n  locale,\n}: SimulationOptions) {\n  return async () => {\n    return locale;\n  };\n}\n"]}

package/dist/chunk-2OHD2VKS.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/internals/request.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA;AAAA,EAIE;AAAA,OACK;AAEP,SAAS,mBAAmB;AAC5B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,cAAc;AACvB,SAAS,UAAU;AAiDZ,SAAS,cAAc;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,SAAS,EAAE,KAAK,OAAO,GAAG,SAAS,uBAAuB,GAAG,QAAQ;AACvE,GAAsC;AACpC,QAAM,oBAAoB,MAAM;AAC9B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,UAAU,iBACb,iBAAiB,QAAQ;AAAA,IACxB;AAAA,IACA;AAAA,IACA,SAAS;AAAA,MACP,SAAS;AAAA,MACT,IAAI;AAAA,MACJ,GAAG;AAAA,IACL;AAAA,EACF,CAAC,EACA,KAAK,OAAO,WAAW;AACtB,UAAM,gBAAgB,iBAAiB,MAAM,SAAS,CAAC;AACvD,UAAM,SAAS,mBAAmB,CAAC;AAEnC,QAAI;AACF,YAAM,iBAAiB,MAAM;AAAA,QAC3B;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO;AAAA,QACL,IAAI,OAAO,EAAE;AAAA,QACb,UAAU;AAAA,UACR,QAAQ,YAAY,MAAM;AAAA,QAC5B;AAAA,QACA;AAAA,QACA,GAAI,iBAAiB,EAAE,cAAc,eAAe,IAAI,CAAC;AAAA,MAC3D;AAAA,IACF,SAAS,OAAO;AACd,YAAM,CAAC,cAAc,IAAI,YAAY,KAAK;AAC1C,aAAO;AAAA,QACL,IAAI,OAAO,EAAE;AAAA,QACb,UAAU;AAAA,UACR,OAAO,eAAe,UAAU;AAAA,QAClC;AAAA,QACA,eAAe,CAAC;AAAA,QAChB,cAAc;AAAA,MAChB;AAAA,IACF;AAAA,EACF,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,UAAM,CAAC,cAAc,IAAI,YAAY,KAAK;AAE1C,WAAO;AAAA,MACL,IAAI,OAAO,EAAE;AAAA,MACb,UAAU;AAAA,QACR,OAAO,eAAe,UAAU;AAAA,MAClC;AAAA,MACA,eAAe,CAAC;AAAA,MAChB,cAAc;AAAA,IAChB;AAAA,EACF,CAAC;AAEH,UAAQ,eAAe,YAAY;AACjC,UAAM,cAAc;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,UAAU;AACZ,UAAM,SAAS,MAAM,QAAQ,KAAK,CAAC,SAAS,WAAW,CAAC;AAIxD,QACE,GAAG,QAAQ,kBAAkB,KAC7B,YAAY,OAAO,UAAU,OAAO,GACpC;AACA,YAAM,IAAI;AAAA,QACR,qHACG,OAAO,SAAS,MAAuB,OAC1C;AAAA,MACF;AAAA,IACF;AAEA,WAAO,MAAM;AAAA,EACf;AAEA,SAAO;AACT;AAUA,eAAsB,uBACpB,QACA,QACA,qBACA;AACA,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,IAAI,GAAG;AACtD,WAAO,OAAO;AAAA,EAChB;AAEA,MAAI,cAAc,MAAM,KAAK,YAAY,QAAQ,SAAS,GAAG;AAC3D;AAAA,MACE,GAAG,OAAO,SAAS,wBAAwB;AAAA,MAC3C;AAAA,IACF;AACA,UAAM,KAAK,MAAM,oBAAoB;AAAA,MACnC;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAUA,eAAsB,gBACpB,QACA,QACA,qBACmD;AACnD,QAAM,cAAc,MAAM;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,aAAa;AACf,WAAO,MAAM;AACX,YAAM,EAAE,QAAQ,IAAI,oBAAoB;AAAA,QACtC;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO;AAAA,QACL;AAAA,QACA,cAAc,OAAO,SAAS;AAC5B,gBAAM;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,QACA,aAAa,OAAO,MAAM,UAAU;AAClC,gBAAM;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,QACA,kBAAkB,OAAO,MAAM,UAAU;AACvC,gBAAM;AAAA,YACJ;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  type SnapId,\n  type JsonRpcError,\n  type ComponentOrElement,\n  ComponentOrElementStruct,\n} from '@metamask/snaps-sdk';\nimport type { HandlerType } from '@metamask/snaps-utils';\nimport { unwrapError } from '@metamask/snaps-utils';\nimport {\n  assert,\n  getSafeJson,\n  hasProperty,\n  isPlainObject,\n} from '@metamask/utils';\nimport { nanoid } from '@reduxjs/toolkit';\nimport { is } from 'superstruct';\n\nimport type {\n  RequestOptions,\n  SnapHandlerInterface,\n  SnapRequest,\n} from '../types';\nimport {\n  clearNotifications,\n  clickElement,\n  getInterface,\n  getNotifications,\n  typeInField,\n  selectInDropdown,\n} from './simulation';\nimport type { RunSagaFunction, Store } from './simulation';\nimport type { RootControllerMessenger } from './simulation/controllers';\nimport { SnapResponseStruct } from './structs';\n\nexport type HandleRequestOptions = {\n  snapId: SnapId;\n  store: Store;\n  executionService: AbstractExecutionService<unknown>;\n  handler: HandlerType;\n  controllerMessenger: RootControllerMessenger;\n  runSaga: RunSagaFunction;\n  request: RequestOptions;\n};\n\n/**\n * Send a JSON-RPC request to the Snap, and wrap the response in a\n * {@link SnapResponse} object.\n *\n * @param options - The request options.\n * @param options.snapId - The ID of the Snap to send the request to.\n * @param options.store - The Redux store.\n * @param options.executionService - The execution service to use to send the\n * request.\n * @param options.handler - The handler to use to send the request.\n * @param options.controllerMessenger - The controller messenger used to call actions.\n * @param options.runSaga - A function to run a saga outside the usual Redux\n * flow.\n * @param options.request - The request to send.\n * @param options.request.id - The ID of the request. If not provided, a random\n * ID will be generated.\n * @param options.request.origin - The origin of the request. Defaults to\n * `https://metamask.io`.\n * @returns The response, wrapped in a {@link SnapResponse} object.\n */\nexport function handleRequest({\n  snapId,\n  store,\n  executionService,\n  handler,\n  controllerMessenger,\n  runSaga,\n  request: { id = nanoid(), origin = 'https://metamask.io', ...options },\n}: HandleRequestOptions): SnapRequest {\n  const getInterfaceError = () => {\n    throw new Error(\n      'Unable to get the interface from the Snap: The request to the Snap failed.',\n    );\n  };\n\n  const promise = executionService\n    .handleRpcRequest(snapId, {\n      origin,\n      handler,\n      request: {\n        jsonrpc: '2.0',\n        id: 1,\n        ...options,\n      },\n    })\n    .then(async (result) => {\n      const notifications = getNotifications(store.getState());\n      store.dispatch(clearNotifications());\n\n      try {\n        const getInterfaceFn = await getInterfaceApi(\n          result,\n          snapId,\n          controllerMessenger,\n        );\n\n        return {\n          id: String(id),\n          response: {\n            result: getSafeJson(result),\n          },\n          notifications,\n          ...(getInterfaceFn ? { getInterface: getInterfaceFn } : {}),\n        };\n      } catch (error) {\n        const [unwrappedError] = unwrapError(error);\n        return {\n          id: String(id),\n          response: {\n            error: unwrappedError.serialize(),\n          },\n          notifications: [],\n          getInterface: getInterfaceError,\n        };\n      }\n    })\n    .catch((error) => {\n      const [unwrappedError] = unwrapError(error);\n\n      return {\n        id: String(id),\n        response: {\n          error: unwrappedError.serialize(),\n        },\n        notifications: [],\n        getInterface: getInterfaceError,\n      };\n    }) as unknown as SnapRequest;\n\n  promise.getInterface = async () => {\n    const sagaPromise = runSaga(\n      getInterface,\n      runSaga,\n      snapId,\n      controllerMessenger,\n    ).toPromise();\n    const result = await Promise.race([promise, sagaPromise]);\n\n    // If the request promise has resolved to an error, we should throw\n    // instead of waiting for an interface that likely will never be displayed\n    if (\n      is(result, SnapResponseStruct) &&\n      hasProperty(result.response, 'error')\n    ) {\n      throw new Error(\n        `Unable to get the interface from the Snap: The returned interface may be invalid. The error message received was: ${\n          (result.response.error as JsonRpcError).message\n        }`,\n      );\n    }\n\n    return await sagaPromise;\n  };\n\n  return promise;\n}\n\n/**\n * Get the interface ID from the result if it's available or create a new interface if the result contains static components.\n *\n * @param result - The handler result object.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The interface ID or undefined if the result doesn't include content.\n */\nexport async function getInterfaceFromResult(\n  result: unknown,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n) {\n  if (isPlainObject(result) && hasProperty(result, 'id')) {\n    return result.id as string;\n  }\n\n  if (isPlainObject(result) && hasProperty(result, 'content')) {\n    assert(\n      is(result.content, ComponentOrElementStruct),\n      'The Snap returned an invalid interface.',\n    );\n    const id = await controllerMessenger.call(\n      'SnapInterfaceController:createInterface',\n      snapId,\n      result.content as ComponentOrElement,\n    );\n\n    return id;\n  }\n\n  return undefined;\n}\n\n/**\n * Get the response content from the SnapInterfaceController and include the interaction methods.\n *\n * @param result - The handler result object.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The content components if any.\n */\nexport async function getInterfaceApi(\n  result: unknown,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): Promise<(() => SnapHandlerInterface) | undefined> {\n  const interfaceId = await getInterfaceFromResult(\n    result,\n    snapId,\n    controllerMessenger,\n  );\n\n  if (interfaceId) {\n    return () => {\n      const { content } = controllerMessenger.call(\n        'SnapInterfaceController:getInterface',\n        snapId,\n        interfaceId,\n      );\n\n      return {\n        content,\n        clickElement: async (name) => {\n          await clickElement(\n            controllerMessenger,\n            interfaceId,\n            content,\n            snapId,\n            name,\n          );\n        },\n        typeInField: async (name, value) => {\n          await typeInField(\n            controllerMessenger,\n            interfaceId,\n            content,\n            snapId,\n            name,\n            value,\n          );\n        },\n        selectInDropdown: async (name, value) => {\n          await selectInDropdown(\n            controllerMessenger,\n            interfaceId,\n            content,\n            snapId,\n            name,\n            value,\n          );\n        },\n      };\n    };\n  }\n\n  return undefined;\n}\n"]}

package/dist/chunk-3FDEYMQU.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,aAAa,eAAe;AACrC,SAAS,cAAc,0BAA0B;AACjD,SAAS,cAAc;AAyBvB,IAAM,MAAM,mBAAmB,YAAY,SAAS;AASpD,SAAS,WAKP,QACA,SAC4D;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,CAAC,QAAW,MAAM;AAAA,EAC3B;AAEA,SAAO,CAAC,QAAQ,OAAO;AACzB;AAOA,SAAS,8BACP,UAC+C;AAC/C,eAAa,UAAU,+BAA+B;AACxD;AAqIA,eAAsB,YAKpB,QACA,UAAgD,CAAC,GAClC;AACf,QAAM,kBAAkB,WAAW,QAAQ,OAAO;AAClD,QAAM;AAAA,IACJ,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,MAAM,eAAe,EAAE,YAAY,GAAG,eAAe;AAEzD,QAAM,gBAAgB,OACpB,YACuC;AACvC,QAAI,2BAA2B,OAAO;AAEtC,UAAM;AAAA,MACJ,QAAQ;AAAA,MACR;AAAA,MACA,GAAG;AAAA,IACL,IAAI,OAAO,SAAS,wBAAwB;AAE5C,UAAM,WAAW,MAAM,cAAc;AAAA,MACnC,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB,SAAS;AAAA,QACP,QAAQ;AAAA,QACR,QAAQ;AAAA,UACN;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,kCAA8B,QAAQ;AAEtC,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,CAAC,YAA4B;AAC7C,QAAI,uBAAuB,OAAO;AAElC,WAAO,cAAc;AAAA,MACnB,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,SAAS,CAAC,YAAY;AACpB,UAAI,uBAAuB,OAAO;AAElC,aAAO,cAAc;AAAA,QACnB,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA;AAAA,IACA,iBAAiB;AAAA,IAEjB,aAAa,OACX,YACuC;AACvC,UAAI,4BAA4B,OAAO;AAEvC,YAAM,EAAE,QAAQ,iBAAiB,GAAG,UAAU,IAAI;AAAA,QAChD;AAAA,QACA;AAAA,MACF;AAEA,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,UACR,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA;AAAA,IACA,YAAY;AAAA,IAEZ,YAAY,YAAgD;AAC1D,UAAI,sBAAsB;AAE1B,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,QACV;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA,YAAY,MAA0B;AACpC,UAAI,gCAAgC,IAAI;AAExC,YAAM,EAAE,QAAQ,OAAO,IAAI,OAAO,MAAM,wBAAwB;AAChE,YAAM,SAAS,eAAe,EAAE,QAAQ,OAAO,CAAC,CAAC;AAEjD,aAAO;AAAA,QACL,SAAS;AACP,cAAI,kCAAkC,IAAI;AAE1C,gBAAM,SAAS,kBAAkB,MAAM,CAAC;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,IAEA,OAAO,YAAY;AACjB,UAAI,4BAA4B;AAChC;AAAA,QACE;AAAA,MACF;AAEA,YAAM,iBAAiB,kBAAkB;AAAA,IAC3C;AAAA,EACF;AACF","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType, logInfo } from '@metamask/snaps-utils';\nimport { assertStruct, createModuleLogger } from '@metamask/utils';\nimport { create } from 'superstruct';\n\nimport {\n  rootLogger,\n  handleRequest,\n  TransactionOptionsStruct,\n  getEnvironment,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  SnapResponseWithInterfaceStruct,\n} from './internals';\nimport type { InstallSnapOptions } from './internals';\nimport {\n  addJsonRpcMock,\n  removeJsonRpcMock,\n} from './internals/simulation/store/mocks';\nimport type {\n  SnapResponseWithInterface,\n  CronjobOptions,\n  JsonRpcMockOptions,\n  Snap,\n  SnapResponse,\n  TransactionOptions,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * Get the options for {@link installSnap}.\n *\n * @param snapId - The ID of the Snap, or the options.\n * @param options - The options, if any.\n * @returns The options.\n */\nfunction getOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId | Partial<InstallSnapOptions<Service>> | undefined,\n  options: Partial<InstallSnapOptions<Service>>,\n): [SnapId | undefined, Partial<InstallSnapOptions<Service>>] {\n  if (typeof snapId === 'object') {\n    return [undefined, snapId];\n  }\n\n  return [snapId, options];\n}\n\n/**\n * Ensure that the actual response contains `getInterface`.\n *\n * @param response - The response of the handler.\n */\nfunction assertIsResponseWithInterface(\n  response: SnapResponse,\n): asserts response is SnapResponseWithInterface {\n  assertStruct(response, SnapResponseWithInterfaceStruct);\n}\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 * 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 * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap(): Promise<Snap>;\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 * 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 * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\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  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;\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 * 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 * @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 * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\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  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  options?: Partial<InstallSnapOptions<Service>>,\n): Promise<Snap>;\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 * 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 * @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 * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\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  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId?: SnapId | Partial<InstallSnapOptions<Service>>,\n  options: Partial<InstallSnapOptions<Service>> = {},\n): Promise<Snap> {\n  const resolvedOptions = getOptions(snapId, options);\n  const {\n    snapId: installedSnapId,\n    store,\n    executionService,\n    runSaga,\n    controllerMessenger,\n  } = await getEnvironment().installSnap(...resolvedOptions);\n\n  const onTransaction = async (\n    request: TransactionOptions,\n  ): Promise<SnapResponseWithInterface> => {\n    log('Sending transaction %o.', request);\n\n    const {\n      origin: transactionOrigin,\n      chainId,\n      ...transaction\n    } = create(request, TransactionOptionsStruct);\n\n    const response = await handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      runSaga,\n      controllerMessenger,\n      handler: HandlerType.OnTransaction,\n      request: {\n        method: '',\n        params: {\n          chainId,\n          transaction,\n          transactionOrigin,\n        },\n      },\n    });\n\n    assertIsResponseWithInterface(response);\n\n    return response;\n  };\n\n  const onCronjob = (request: CronjobOptions) => {\n    log('Running cronjob %o.', options);\n\n    return handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      controllerMessenger,\n      runSaga,\n      handler: HandlerType.OnCronjob,\n      request,\n    });\n  };\n\n  return {\n    request: (request) => {\n      log('Sending request %o.', request);\n\n      return handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnRpcRequest,\n        request,\n      });\n    },\n\n    onTransaction,\n    sendTransaction: onTransaction,\n\n    onSignature: async (\n      request: unknown,\n    ): Promise<SnapResponseWithInterface> => {\n      log('Requesting signature %o.', request);\n\n      const { origin: signatureOrigin, ...signature } = create(\n        request,\n        SignatureOptionsStruct,\n      );\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnSignature,\n        request: {\n          method: '',\n          params: {\n            signature,\n            signatureOrigin,\n          },\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    onCronjob,\n    runCronjob: onCronjob,\n\n    onHomePage: async (): Promise<SnapResponseWithInterface> => {\n      log('Rendering home page.');\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnHomePage,\n        request: {\n          method: '',\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    mockJsonRpc(mock: JsonRpcMockOptions) {\n      log('Mocking JSON-RPC request %o.', mock);\n\n      const { method, result } = create(mock, JsonRpcMockOptionsStruct);\n      store.dispatch(addJsonRpcMock({ method, result }));\n\n      return {\n        unmock() {\n          log('Unmocking JSON-RPC request %o.', mock);\n\n          store.dispatch(removeJsonRpcMock(method));\n        },\n      };\n    },\n\n    close: async () => {\n      log('Closing execution service.');\n      logInfo(\n        'Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.',\n      );\n\n      await executionService.terminateAllSnaps();\n    },\n  };\n}\n"]}

package/dist/chunk-44ARQBXS.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/internals/simulation/controllers.ts"],"names":[],"mappings":";;;;;;;;AAOA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,+BAA+B;AAMxC;AAAA,EACE,wBAAwB;AAAA,EACxB,iCAAiC;AAAA,EACjC;AAAA,OACK;AAGP,SAAS,mBAAmB;AA0CrB,SAAS,eAAe,SAA6C;AAC1E,QAAM,EAAE,oBAAoB,IAAI;AAChC,QAAM,4BAA4B,IAAI,0BAA0B;AAAA,IAC9D,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB,CAAC;AAAA,MACjB,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,mBAAmB;AAAA,EACrB,CAAC;AAED,QAAM,sBAAsB,IAAI,wBAAwB;AAAA,IACtD,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAAA,MACA,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,EACH,CAAC;AAED,QAAM,uBAAuB,wBAAwB,OAAO;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAUA,SAAS,wBAAwB,SAAgC;AAC/D,QAAM,EAAE,oBAAoB,IAAI;AAChC,QAAM,2BAA2B,4BAA4B,OAAO;AACpE,SAAO,IAAI,qBAAqB;AAAA,IAC9B,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB;AAAA,QACd;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,MACA,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,sBAAsB;AAAA,MACpB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAAA,IACA;AAAA,IACA,qBAAqB;AAAA,EACvB,CAAC;AACH;AAWA,eAAsB,aACpB,QACA,UACA;AAAA,EACE;AAAA,EACA;AACF,GACA;AACA,4BAA0B,mBAAmB;AAAA,IAC3C,QAAQ;AAAA,IACR,aAAa,YAAY;AAAA,EAC3B,CAAC;AAED,QAAM,sBAAsB;AAAA,IAC1B,YAAY,SAAS,kBAAkB;AAAA,EACzC;AAEA,uBAAqB,iBAAiB;AAAA,IACpC;AAAA,IACA,SAAS,EAAE,QAAQ,OAAO;AAAA,IAC1B,6BAA6B;AAAA,EAC/B,CAAC;AACH","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  CaveatSpecificationConstraint,\n  PermissionSpecificationConstraint,\n  PermissionControllerActions,\n  SubjectMetadataControllerActions,\n} from '@metamask/permission-controller';\nimport {\n  PermissionController,\n  SubjectMetadataController,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapInterfaceController } from '@metamask/snaps-controllers';\nimport type {\n  ExecutionServiceActions,\n  SnapInterfaceControllerActions,\n  SnapInterfaceControllerAllowedActions,\n} from '@metamask/snaps-controllers';\nimport {\n  caveatSpecifications as snapsCaveatsSpecifications,\n  endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,\n  processSnapPermissions,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { SnapManifest } from '@metamask/snaps-utils';\nimport { getSafeJson } from '@metamask/utils';\n\nimport { getPermissionSpecifications } from './methods';\nimport { UNRESTRICTED_METHODS } from './methods/constants';\nimport type { SimulationOptions } from './options';\nimport type { MiddlewareHooks } from './simulation';\nimport type { RunSagaFunction } from './store';\n\nexport type RootControllerAllowedActions =\n  | SnapInterfaceControllerActions\n  | SnapInterfaceControllerAllowedActions\n  | PermissionControllerActions\n  | ExecutionServiceActions\n  | SubjectMetadataControllerActions;\n\nexport type RootControllerMessenger = ControllerMessenger<\n  RootControllerAllowedActions,\n  any\n>;\n\nexport type GetControllersOptions = {\n  controllerMessenger: ControllerMessenger<any, any>;\n  hooks: MiddlewareHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\nexport type Controllers = {\n  permissionController: PermissionController<\n    PermissionSpecificationConstraint,\n    CaveatSpecificationConstraint\n  >;\n  subjectMetadataController: SubjectMetadataController;\n  interfaceController: SnapInterfaceController;\n};\n\n/**\n * Get the controllers for the Snap.\n *\n * @param options - The options.\n * @returns The controllers for the Snap.\n */\nexport function getControllers(options: GetControllersOptions): Controllers {\n  const { controllerMessenger } = options;\n  const subjectMetadataController = new SubjectMetadataController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SubjectMetadataController',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    subjectCacheLimit: 100,\n  });\n\n  const interfaceController = new SnapInterfaceController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'SnapInterfaceController',\n      allowedActions: [\n        'PhishingController:maybeUpdateState',\n        'PhishingController:testOrigin',\n      ],\n      allowedEvents: [],\n    }),\n  });\n\n  const permissionController = getPermissionController(options);\n\n  return {\n    permissionController,\n    subjectMetadataController,\n    interfaceController,\n  };\n}\n\n/**\n * Get the permission controller for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.options - Miscellaneous options.\n * @returns The permission controller for the Snap.\n */\nfunction getPermissionController(options: GetControllersOptions) {\n  const { controllerMessenger } = options;\n  const permissionSpecifications = getPermissionSpecifications(options);\n  return new PermissionController({\n    messenger: controllerMessenger.getRestricted({\n      name: 'PermissionController',\n      allowedActions: [\n        `ApprovalController:addRequest`,\n        `ApprovalController:hasRequest`,\n        `ApprovalController:acceptRequest`,\n        `ApprovalController:rejectRequest`,\n        `SnapController:getPermitted`,\n        `SnapController:install`,\n        `SubjectMetadataController:getSubjectMetadata`,\n      ],\n      allowedEvents: [],\n    }),\n    caveatSpecifications: {\n      ...snapsCaveatsSpecifications,\n      ...snapsEndowmentCaveatSpecifications,\n    },\n    permissionSpecifications,\n    unrestrictedMethods: UNRESTRICTED_METHODS,\n  });\n}\n\n/**\n * Register the Snap. This sets up the Snap's permissions and subject metadata.\n *\n * @param snapId - The ID of the Snap to install.\n * @param manifest - The parsed manifest.\n * @param controllers - The controllers for the Snap.\n * @param controllers.permissionController - The permission controller.\n * @param controllers.subjectMetadataController - The subject metadata controller.\n */\nexport async function registerSnap(\n  snapId: SnapId,\n  manifest: SnapManifest,\n  {\n    permissionController,\n    subjectMetadataController,\n  }: Omit<Controllers, 'interfaceController'>,\n) {\n  subjectMetadataController.addSubjectMetadata({\n    origin: snapId,\n    subjectType: SubjectType.Snap,\n  });\n\n  const approvedPermissions = processSnapPermissions(\n    getSafeJson(manifest.initialPermissions),\n  );\n\n  permissionController.grantPermissions({\n    approvedPermissions,\n    subject: { origin: snapId },\n    preserveExistingPermissions: false,\n  });\n}\n"]}