@metamask/snaps-jest 8.2.0 → 8.3.1

package/dist/options.d.mts

@@ -0,0 +1,61 @@
+import type { Infer } from "@metamask/superstruct";
+declare const SnapsEnvironmentOptionsStruct: import("@metamask/superstruct").Struct<{
+    server: {
+        port: number;
+        enabled: boolean;
+        root: string;
+    };
+}, {
+    server: import("@metamask/superstruct").Struct<{
+        port: number;
+        enabled: boolean;
+        root: string;
+    }, {
+        enabled: import("@metamask/superstruct").Struct<boolean, null>;
+        port: import("@metamask/superstruct").Struct<number, null>;
+        root: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+}>;
+/**
+ * The options for the environment. These can be specified in the Jest
+ * configuration under `testEnvironmentOptions`.
+ *
+ * @example
+ * {
+ *   "testEnvironment": "@metamask/snaps-jest",
+ *   "testEnvironmentOptions": {
+ *     "executionEnvironmentUrl": "http://localhost:8080",
+ *     "server": {
+ *       "port": 8080,
+ *       /* ... *\/
+ *     }
+ *   }
+ * }
+ * @property server - The options for the built-in HTTP server.
+ * @property server.enabled - Whether to run the built-in HTTP server. Defaults
+ * to `true`.
+ * @property server.port - The port to use for the built-in HTTP server. If this
+ * is not provided, a random available port will be used.
+ * @property server.root - The root directory to serve from the built-in HTTP
+ * 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.
+ */
+export type SnapsEnvironmentOptions = Infer<typeof SnapsEnvironmentOptionsStruct>;
+/**
+ * Get the environment options. This validates the options, and returns the
+ * default options if none are provided.
+ *
+ * @param testEnvironmentOptions - The test environment options as defined in
+ * the Jest configuration.
+ * @returns The environment options.
+ */
+export declare function getOptions(testEnvironmentOptions: Record<string, unknown>): {
+    server: {
+        port: number;
+        enabled: boolean;
+        root: string;
+    };
+};
+export {};
+//# sourceMappingURL=options.d.mts.map

package/dist/options.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.mts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD,QAAA,MAAM,6BAA6B;;;;;;;;;;;;;;;;EASjC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;EAEzE"}

package/dist/options.mjs

@@ -1,8 +1,20 @@
-import {
-  getOptions
-} from "./chunk-B73P64TE.mjs";
-import "./chunk-JMDSN227.mjs";
-export {
-  getOptions
-};
+import { boolean, create, defaulted, number, object, string, type } from "@metamask/superstruct";
+const SnapsEnvironmentOptionsStruct = type({
+    server: defaulted(object({
+        enabled: defaulted(boolean(), true),
+        port: defaulted(number(), 0),
+        root: defaulted(string(), process.cwd()),
+    }), {}),
+});
+/**
+ * Get the environment options. This validates the options, and returns the
+ * default options if none are provided.
+ *
+ * @param testEnvironmentOptions - The test environment options as defined in
+ * the Jest configuration.
+ * @returns The environment options.
+ */
+export function getOptions(testEnvironmentOptions) {
+    return create(testEnvironmentOptions, SnapsEnvironmentOptionsStruct);
+}
 //# sourceMappingURL=options.mjs.map

package/dist/options.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"options.mjs","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,MAAM,EACN,SAAS,EACT,MAAM,EACN,MAAM,EACN,MAAM,EACN,IAAI,EACL,8BAA8B;AAE/B,MAAM,6BAA6B,GAAG,IAAI,CAAC;IACzC,MAAM,EAAE,SAAS,CACf,MAAM,CAAC;QACL,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC;QACnC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5B,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;KACzC,CAAC,EACF,EAAE,CACH;CACF,CAAC,CAAC;AA+BH;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,sBAA+C;IACxE,OAAO,MAAM,CAAC,sBAAsB,EAAE,6BAA6B,CAAC,CAAC;AACvE,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  boolean,\n  create,\n  defaulted,\n  number,\n  object,\n  string,\n  type,\n} from '@metamask/superstruct';\n\nconst SnapsEnvironmentOptionsStruct = type({\n  server: defaulted(\n    object({\n      enabled: defaulted(boolean(), true),\n      port: defaulted(number(), 0),\n      root: defaulted(string(), process.cwd()),\n    }),\n    {},\n  ),\n});\n\n/**\n * The options for the environment. These can be specified in the Jest\n * configuration under `testEnvironmentOptions`.\n *\n * @example\n * {\n *   \"testEnvironment\": \"@metamask/snaps-jest\",\n *   \"testEnvironmentOptions\": {\n *     \"executionEnvironmentUrl\": \"http://localhost:8080\",\n *     \"server\": {\n *       \"port\": 8080,\n *       /* ... *\\/\n *     }\n *   }\n * }\n * @property server - The options for the built-in HTTP server.\n * @property server.enabled - Whether to run the built-in HTTP server. Defaults\n * to `true`.\n * @property server.port - The port to use for the built-in HTTP server. If this\n * is not provided, a random available port will be used.\n * @property server.root - The root directory to serve from the built-in HTTP\n * server. Defaults to the current working directory. This is assumed to be the\n * directory containing the snap manifest and `dist` files. If this is a\n * relative path, it will be resolved relative to the current working directory.\n */\nexport type SnapsEnvironmentOptions = Infer<\n  typeof SnapsEnvironmentOptionsStruct\n>;\n\n/**\n * Get the environment options. This validates the options, and returns the\n * default options if none are provided.\n *\n * @param testEnvironmentOptions - The test environment options as defined in\n * the Jest configuration.\n * @returns The environment options.\n */\nexport function getOptions(testEnvironmentOptions: Record<string, unknown>) {\n  return create(testEnvironmentOptions, SnapsEnvironmentOptionsStruct);\n}\n"]}

package/dist/setup.cjs

@@ -0,0 +1,7 @@
+"use strict";
+// Setup file for Jest. This file is used in the Jest preset configuration, and
+// not intended to be exported or used directly.
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line import/no-unassigned-import
+require("./matchers.cjs");
+//# sourceMappingURL=setup.cjs.map

package/dist/setup.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.cjs","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,gDAAgD;;AAEhD,uDAAuD;AACvD,0BAAoB","sourcesContent":["// Setup file for Jest. This file is used in the Jest preset configuration, and\n// not intended to be exported or used directly.\n\n// eslint-disable-next-line import/no-unassigned-import\nimport './matchers';\n"]}

package/dist/setup.d.cts

@@ -0,0 +1,2 @@
+import "./matchers.cjs";
+//# sourceMappingURL=setup.d.cts.map

package/dist/setup.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.cts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAIA,wBAAoB"}

package/dist/setup.d.mts

@@ -0,0 +1,2 @@
+import "./matchers.mjs";
+//# sourceMappingURL=setup.d.mts.map

package/dist/setup.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.mts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAIA,wBAAoB"}

package/dist/setup.mjs

@@ -1,38 +1,5 @@
-import "./chunk-MAT5SBM7.mjs";
-import "./chunk-MF43OG3Z.mjs";
-import "./chunk-XK5HPZZC.mjs";
-import "./chunk-5SGLRSWR.mjs";
-import "./chunk-5ZFHFICZ.mjs";
-import "./chunk-43HRTFLS.mjs";
-import "./chunk-O24GTINW.mjs";
-import "./chunk-ZG33OGC3.mjs";
-import "./chunk-KNJNL723.mjs";
-import "./chunk-6HHV6YFQ.mjs";
-import "./chunk-Q2OQXAUM.mjs";
-import "./chunk-VOYBI6T4.mjs";
-import "./chunk-IXKO6X55.mjs";
-import "./chunk-FP4H3ADT.mjs";
-import "./chunk-IWJ4HKDR.mjs";
-import "./chunk-IH7UNS5A.mjs";
-import "./chunk-SLU4FNKX.mjs";
-import "./chunk-J4ZPUCLX.mjs";
-import "./chunk-HOI6FPLR.mjs";
-import "./chunk-6KXCBUNZ.mjs";
-import "./chunk-GG2BCPQH.mjs";
-import "./chunk-NTOY6Y4Q.mjs";
-import "./chunk-TMAWGVZP.mjs";
-import "./chunk-UDOXICJK.mjs";
-import "./chunk-KSIBNOB2.mjs";
-import "./chunk-FQWOVTBB.mjs";
-import "./chunk-ALRZENWP.mjs";
-import "./chunk-ORO3T6BU.mjs";
-import "./chunk-5U5WB3SM.mjs";
-import "./chunk-RQKT6BQ2.mjs";
-import "./chunk-3M4GRUMH.mjs";
-import "./chunk-74TIKA2T.mjs";
-import "./chunk-H2464AXT.mjs";
-import "./chunk-LB4R3BUA.mjs";
-import "./chunk-MPZOXW6I.mjs";
-import "./chunk-57SGDM5B.mjs";
-import "./chunk-JMDSN227.mjs";
+// Setup file for Jest. This file is used in the Jest preset configuration, and
+// not intended to be exported or used directly.
+// eslint-disable-next-line import/no-unassigned-import
+import "./matchers.mjs";
 //# sourceMappingURL=setup.mjs.map

package/dist/setup.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"setup.mjs","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,gDAAgD;AAEhD,uDAAuD;AACvD,wBAAoB","sourcesContent":["// Setup file for Jest. This file is used in the Jest preset configuration, and\n// not intended to be exported or used directly.\n\n// eslint-disable-next-line import/no-unassigned-import\nimport './matchers';\n"]}

package/dist/types/index.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/types/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAAwB","sourcesContent":["export * from './types';\n"]}

package/dist/types/index.d.cts

@@ -0,0 +1,2 @@
+export * from "./types.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/types/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4BAAwB"}

package/dist/types/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./types.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/types/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4BAAwB"}

package/dist/types/index.mjs

@@ -0,0 +1,2 @@
+export * from "./types.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4BAAwB","sourcesContent":["export * from './types';\n"]}

package/dist/types/types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.cjs.map

package/dist/types/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { NotificationType, EnumToUnion } from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport type { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';\n\nimport type {\n  SignatureOptionsStruct,\n  SnapOptionsStruct,\n  SnapResponseStruct,\n  TransactionOptionsStruct,\n} from '../internals';\n\nexport type RequestOptions = {\n  /**\n   * The JSON-RPC request ID.\n   */\n  id?: JsonRpcId;\n\n  /**\n   * The JSON-RPC method.\n   */\n  method: string;\n\n  /**\n   * The JSON-RPC params.\n   */\n  params?: JsonRpcParams;\n\n  /**\n   * The origin to send the request from.\n   */\n  origin?: string;\n};\n\n/**\n * The `runCronjob` options. This is the same as {@link RequestOptions}, except\n * that it does not have an `origin` property.\n */\nexport type CronjobOptions = Omit<RequestOptions, 'origin'>;\n\n/**\n * The options to use for transaction requests.\n *\n * @property chainId - The CAIP-2 chain ID to send the transaction on. Defaults\n * to `eip155:1`.\n * @property origin - The origin to send the transaction from. Defaults to\n * `metamask.io`.\n * @property from - The address to send the transaction from. Defaults to a\n * randomly generated address.\n * @property to - The address to send the transaction to. Defaults to a randomly\n * generated address.\n * @property value - The value to send with the transaction. Defaults to `0`.\n * @property data - The data to send with the transaction. Defaults to `0x`.\n * @property gasLimit - The gas limit to use for the transaction. Defaults to\n * `21_000`.\n * @property maxFeePerGas - The maximum fee per gas to use for the transaction.\n * Defaults to `1`.\n * @property maxPriorityFeePerGas - The maximum priority fee per gas to use for\n * the transaction. Defaults to `1`.\n * @property nonce - The nonce to use for the transaction. Defaults to `0`.\n */\nexport type TransactionOptions = Infer<typeof TransactionOptionsStruct>;\n\n/**\n * The options to use for signature requests.\n *\n * @property origin - The origin to send the signature request from. Defaults to\n * `metamask.io`.\n * @property from - The address to send the signature from. Defaults to a\n * randomly generated address.\n * @property data - The data to sign. Defaults to `0x`.\n * @property signatureMethod - The signature method.\n */\nexport type SignatureOptions = Infer<typeof SignatureOptionsStruct>;\n\n/**\n * The options to use for requests to the snap.\n *\n * @property timeout - The timeout in milliseconds to use. Defaults to `1000`.\n */\nexport type SnapOptions = Infer<typeof SnapOptionsStruct>;\n\n/**\n * Options for uploading a file.\n *\n * @property fileName - The name of the file. By default, this is inferred from\n * the file path if it's a path, and defaults to an empty string if it's a\n * `Uint8Array`.\n * @property contentType - The content type of the file. By default, this is\n * inferred from the file name if it's a path, and defaults to\n * `application/octet-stream` if it's a `Uint8Array` or the content type cannot\n * be inferred from the file name.\n */\nexport type FileOptions = {\n  fileName?: string;\n  contentType?: string;\n};\n\nexport type SnapInterfaceActions = {\n  /**\n   * Click on an interface element.\n   *\n   * @param name - The element name to click.\n   */\n  clickElement(name: string): Promise<void>;\n\n  /**\n   * Type a value in a interface field.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  typeInField(name: string, value: string): Promise<void>;\n\n  /**\n   * Select an option with a value in a dropdown.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  selectInDropdown(name: string, value: string): Promise<void>;\n\n  /**\n   * Choose an option with a value from radio group.\n   *\n   * @param name - The element name to type in.\n   * @param value - The value to type.\n   */\n  selectFromRadioGroup(name: string, value: string): Promise<void>;\n\n  /**\n   * Upload a file.\n   *\n   * @param name - The element name to upload the file to.\n   * @param file - The file to upload. This can be a path to a file or a\n   * `Uint8Array` containing the file contents. If this is a path, the file is\n   * resolved relative to the current working directory.\n   * @param options - The file options.\n   * @param options.fileName - The name of the file. By default, this is\n   * inferred from the file path if it's a path, and defaults to an empty string\n   * if it's a `Uint8Array`.\n   * @param options.contentType - The content type of the file. By default, this\n   * is inferred from the file name if it's a path, and defaults to\n   * `application/octet-stream` if it's a `Uint8Array` or the content type\n   * cannot be inferred from the file name.\n   */\n  uploadFile(\n    name: string,\n    file: string | Uint8Array,\n    options?: FileOptions,\n  ): Promise<void>;\n};\n\n/**\n * A `snap_dialog` alert interface.\n */\nexport type SnapAlertInterface = {\n  /**\n   * The type of the interface. This is always `alert`.\n   */\n  type: 'alert';\n\n  /**\n   * The content to show in the alert.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the alert.\n   */\n  ok(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` confirmation interface.\n */\nexport type SnapConfirmationInterface = {\n  /**\n   * The type of the interface. This is always `confirmation`.\n   */\n  type: 'confirmation';\n\n  /**\n   * The content to show in the confirmation.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the confirmation.\n   */\n  ok(): Promise<void>;\n\n  /**\n   * Cancel the confirmation.\n   */\n  cancel(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` prompt interface.\n */\nexport type SnapPromptInterface = {\n  /**\n   * The type of the interface. This is always `prompt`.\n   */\n  type: 'prompt';\n\n  /**\n   * The content to show in the prompt.\n   */\n  content: JSXElement;\n\n  /**\n   * Close the prompt.\n   *\n   * @param value - The value to close the prompt with.\n   */\n  ok(value?: string): Promise<void>;\n\n  /**\n   * Cancel the prompt.\n   */\n  cancel(): Promise<void>;\n};\n\n/**\n * A `snap_dialog` default interface that has a Footer with two buttons defined.\n * The approval of this confirmation is handled by the snap.\n */\nexport type DefaultSnapInterfaceWithFooter = {\n  /**\n   * The content to show in the interface.\n   */\n  content: JSXElement;\n};\n\n/**\n * A `snap_dialog` default interface that has a Footer with one button defined.\n * A cancel button is automatically applied to the interface in this case.\n */\nexport type DefaultSnapInterfaceWithPartialFooter =\n  DefaultSnapInterfaceWithFooter & {\n    /**\n     * Cancel the dialog.\n     */\n    cancel(): Promise<void>;\n  };\n\n/**\n * A `snap_dialog` default interface that has no Footer defined.\n * A cancel and ok button is automatically applied to the interface in this case.\n */\nexport type DefaultSnapInterfaceWithoutFooter =\n  DefaultSnapInterfaceWithPartialFooter & {\n    /**\n     * Close the dialog.\n     *\n     */\n    ok(): Promise<void>;\n  };\n\nexport type DefaultSnapInterface =\n  | DefaultSnapInterfaceWithFooter\n  | DefaultSnapInterfaceWithPartialFooter\n  | DefaultSnapInterfaceWithoutFooter;\n\nexport type SnapInterface = (\n  | SnapAlertInterface\n  | SnapConfirmationInterface\n  | SnapPromptInterface\n  | DefaultSnapInterface\n) &\n  SnapInterfaceActions;\n\nexport type SnapRequestObject = {\n  /**\n   * Get a user interface object from a snap. This will throw an error if the\n   * snap does not show a user interface within the timeout.\n   *\n   * @param options - The options to use.\n   * @param options.timeout - The timeout in milliseconds to use. Defaults to\n   * `1000`.\n   * @returns The user interface object.\n   */\n  getInterface(options?: SnapOptions): Promise<SnapInterface>;\n};\n\n/**\n * A pending request object. This is a promise with extra\n * {@link SnapRequestObject} fields.\n */\nexport type SnapRequest = Promise<SnapResponse> & SnapRequestObject;\n\n/**\n * The options to use for mocking a JSON-RPC request.\n */\nexport type JsonRpcMockOptions = {\n  /**\n   * The JSON-RPC request method.\n   */\n  method: string;\n\n  /**\n   * The JSON-RPC response, which will be returned when a request with the\n   * specified method is sent.\n   */\n  result: Json;\n};\n\n/**\n * This is the main entry point to interact with the snap. It is returned by\n * {@link installSnap}, and has methods to send requests to the snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * const snap = await installSnap();\n * const response = await snap.request({ method: 'hello' });\n *\n * expect(response).toRespondWith('Hello, world!');\n */\nexport type Snap = {\n  /**\n   * Send a JSON-RPC request to the snap.\n   *\n   * @param request - The request. This is similar to a JSON-RPC request, but\n   * has an extra `origin` field.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  request(request: RequestOptions): SnapRequest;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   */\n  onTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a transaction to the snap.\n   *\n   * @param transaction - The transaction. This is similar to an Ethereum\n   * transaction object, but has an extra `origin` field. Any missing fields\n   * will be filled in with default values.\n   * @returns The response.\n   * @deprecated Use {@link onTransaction} instead.\n   */\n  sendTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Send a signature request to the snap.\n   *\n   * @param signature - The signature request object. Contains the params from\n   * the various signature methods, but has an extra `origin` and `signatureMethod` field.\n   * Any missing fields will be filled in with default values.\n   * @returns The response.\n   */\n  onSignature(\n    signature?: Partial<SignatureOptions>,\n  ): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   */\n  onCronjob(cronjob?: Partial<CronjobOptions>): SnapRequest;\n\n  /**\n   * Run a cronjob in the snap. This is similar to {@link request}, but the\n   * request will be sent to the `onCronjob` method of the snap.\n   *\n   * @param cronjob - The cronjob request. This is similar to a JSON-RPC\n   * request, and is normally specified in the snap manifest, under the\n   * `endowment:cronjob` permission.\n   * @returns The response promise, with extra {@link SnapRequestObject} fields.\n   * @deprecated Use {@link onCronjob} instead.\n   */\n  runCronjob(cronjob: CronjobOptions): SnapRequest;\n\n  /**\n   * Get the response from the snap's `onHomePage` method.\n   *\n   * @returns The response.\n   */\n  onHomePage(): Promise<SnapResponseWithInterface>;\n\n  /**\n   * Mock a JSON-RPC request. This will cause the snap to respond with the\n   * specified response when a request with the specified method is sent.\n   *\n   * @param mock - The mock options.\n   * @param mock.method - The JSON-RPC request method.\n   * @param mock.result - The JSON-RPC response, which will be returned when a\n   * request with the specified method is sent.\n   * @example\n   * import { installSnap } from '@metamask/snaps-jest';\n   *\n   * // In the test\n   * const snap = await installSnap();\n   * snap.mockJsonRpc({ method: 'eth_accounts', result: ['0x1234'] });\n   *\n   * // In the Snap\n   * const response =\n   *   await ethereum.request({ method: 'eth_accounts' }); // ['0x1234']\n   */\n  mockJsonRpc(mock: JsonRpcMockOptions): {\n    /**\n     * Remove the mock.\n     */\n    unmock(): void;\n  };\n\n  /**\n   * Close the page running the snap. This is mainly useful for cleaning up\n   * the test environment, and calling it is not strictly necessary.\n   *\n   * @returns A promise that resolves when the page is closed.\n   * @deprecated Snaps are now automatically closed when the test ends. This\n   * method will be removed in a future release.\n   */\n  close(): Promise<void>;\n};\n\nexport type SnapHandlerInterface = {\n  content: JSXElement;\n} & SnapInterfaceActions;\n\nexport type SnapResponseWithInterface = {\n  id: string;\n  response: { result: Json } | { error: Json };\n  notifications: {\n    id: string;\n    message: string;\n    type: EnumToUnion<NotificationType>;\n  }[];\n  getInterface(): SnapHandlerInterface;\n};\n\nexport type SnapResponseWithoutInterface = Omit<\n  SnapResponseWithInterface,\n  'getInterface'\n>;\n\nexport type SnapResponseType =\n  | SnapResponseWithoutInterface\n  | SnapResponseWithInterface;\n\nexport type SnapResponse = InferMatching<\n  typeof SnapResponseStruct,\n  SnapResponseType\n>;\n"]}

package/dist/types/{types.d.ts → types.d.cts}

@@ -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 { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';
-import type { Infer } from 'superstruct';
-import type { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from './internals';
-export declare type RequestOptions = {
+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 { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from "../internals/index.cjs";
+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,13 +59,13 @@ 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 type SnapOptions = Infer<typeof SnapOptionsStruct>;
 /**
  * Options for uploading a file.
  *
@@ -77,11 +77,11 @@ export declare type SnapOptions = Infer<typeof SnapOptionsStruct>;
  * `application/octet-stream` if it's a `Uint8Array` or the content type cannot
  * be inferred from the file name.
  */
-export declare type FileOptions = {
+export type FileOptions = {
     fileName?: string;
     contentType?: string;
 };
-export declare type SnapInterfaceActions = {
+export type SnapInterfaceActions = {
     /**
      * Click on an interface element.
      *
@@ -102,6 +102,13 @@ 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.
      *
@@ -123,7 +130,7 @@ export declare type SnapInterfaceActions = {
 /**
  * A `snap_dialog` alert interface.
  */
-export declare type SnapAlertInterface = {
+export type SnapAlertInterface = {
     /**
      * The type of the interface. This is always `alert`.
      */
@@ -140,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`.
      */
@@ -161,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`.
      */
@@ -181,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.
@@ -198,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.
      */
@@ -225,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.
      *
@@ -324,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;
@@ -341,6 +380,7 @@ 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>;
+//# sourceMappingURL=types.d.cts.map

package/dist/types/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,4BAA4B;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,gCAAgC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAC3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,wBAAwB;AAEtE,OAAO,KAAK,EACV,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACzB,+BAAqB;AAEtB,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;OAKG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IAEpB;;;;OAIG;IACH,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC/C,8BAA8B,GAAG;IAC/B;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAC3C,qCAAqC,GAAG;IACtC;;;OAGG;IACH,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,CAAC;AAEJ,MAAM,MAAM,oBAAoB,GAC5B,8BAA8B,GAC9B,qCAAqC,GACrC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,aAAa,GAAG,CACxB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,oBAAoB,CACvB,GACC,oBAAoB,CAAC;AAEvB,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC7D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAE9C;;;;;;;OAOG;IACH,aAAa,CACX,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,eAAe,CACb,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,WAAW,CACT,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;IAE1D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,WAAW,CAAC;IAEjD;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG;QACrC;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;KAChB,CAAC;IAEF;;;;;;;OAOG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,UAAU,CAAC;CACrB,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE;QAAE,MAAM,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC;IAC7C,aAAa,EAAE;QACb,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;KACrC,EAAE,CAAC;IACJ,YAAY,IAAI,oBAAoB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,yBAAyB,EACzB,cAAc,CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,4BAA4B,GAC5B,yBAAyB,CAAC;AAE9B,MAAM,MAAM,YAAY,GAAG,aAAa,CACtC,OAAO,kBAAkB,EACzB,gBAAgB,CACjB,CAAC"}