@metamask/snaps-jest 8.3.0 → 8.3.1

package/dist/internals/index.mjs

@@ -1,150 +1,7 @@
-import "../chunk-MF43OG3Z.mjs";
-import {
-  getEnvironment
-} from "../chunk-XK5HPZZC.mjs";
-import {
-  getInterfaceApi,
-  getInterfaceFromResult,
-  handleRequest
-} from "../chunk-PDOVVC74.mjs";
-import "../chunk-5ZFHFICZ.mjs";
-import {
-  getHooks,
-  handleInstallSnap,
-  registerActions
-} from "../chunk-Q3I6P2ZF.mjs";
-import "../chunk-ZG33OGC3.mjs";
-import "../chunk-3J2IBWXV.mjs";
-import "../chunk-6HHV6YFQ.mjs";
-import "../chunk-Q2OQXAUM.mjs";
-import "../chunk-VOYBI6T4.mjs";
-import "../chunk-IXKO6X55.mjs";
-import "../chunk-FP4H3ADT.mjs";
-import {
-  clickElement,
-  getElement,
-  getElementByType,
-  getInterface,
-  getInterfaceActions,
-  getInterfaceResponse,
-  mergeValue,
-  resolveWithSaga,
-  selectFromRadioGroup,
-  selectInDropdown,
-  typeInField,
-  uploadFile
-} from "../chunk-6JPBXAHM.mjs";
-import "../chunk-IWJ4HKDR.mjs";
-import {
-  getOptions
-} from "../chunk-G333FBBL.mjs";
-import {
-  startServer
-} from "../chunk-SLU4FNKX.mjs";
-import {
-  rootLogger
-} from "../chunk-J4ZPUCLX.mjs";
-import {
-  InterfaceStruct,
-  JsonRpcMockOptionsStruct,
-  SignatureOptionsStruct,
-  SnapOptionsStruct,
-  SnapResponseStruct,
-  SnapResponseWithInterfaceStruct,
-  SnapResponseWithoutInterfaceStruct,
-  TransactionOptionsStruct
-} from "../chunk-C26TYXXD.mjs";
-import {
-  DEFAULT_CURRENCY,
-  DEFAULT_JSON_RPC_ENDPOINT,
-  DEFAULT_LOCALE,
-  DEFAULT_SRP
-} from "../chunk-LVNNGMJ2.mjs";
-import "../chunk-LSKT2AUS.mjs";
-import "../chunk-NTOY6Y4Q.mjs";
-import "../chunk-OHRFO2BL.mjs";
-import "../chunk-UDOXICJK.mjs";
-import "../chunk-QRVFWATH.mjs";
-import "../chunk-FQWOVTBB.mjs";
-import "../chunk-ALRZENWP.mjs";
-import "../chunk-24CGIQLL.mjs";
-import "../chunk-5U5WB3SM.mjs";
-import "../chunk-RQKT6BQ2.mjs";
-import {
-  createStore
-} from "../chunk-ORR7AE5X.mjs";
-import {
-  closeInterface,
-  getCurrentInterface,
-  resolveInterface,
-  setInterface,
-  uiSlice
-} from "../chunk-ZJQSGRNK.mjs";
-import "../chunk-H2464AXT.mjs";
-import {
-  addNotification,
-  clearNotifications,
-  getNotifications,
-  notificationsSlice,
-  removeNotification
-} from "../chunk-LB4R3BUA.mjs";
-import {
-  clearState,
-  getState,
-  setState,
-  stateSlice
-} from "../chunk-MPZOXW6I.mjs";
-import "../chunk-57SGDM5B.mjs";
-import "../chunk-JMDSN227.mjs";
-export {
-  DEFAULT_CURRENCY,
-  DEFAULT_JSON_RPC_ENDPOINT,
-  DEFAULT_LOCALE,
-  DEFAULT_SRP,
-  InterfaceStruct,
-  JsonRpcMockOptionsStruct,
-  SignatureOptionsStruct,
-  SnapOptionsStruct,
-  SnapResponseStruct,
-  SnapResponseWithInterfaceStruct,
-  SnapResponseWithoutInterfaceStruct,
-  TransactionOptionsStruct,
-  addNotification,
-  clearNotifications,
-  clearState,
-  clickElement,
-  closeInterface,
-  createStore,
-  getCurrentInterface,
-  getElement,
-  getElementByType,
-  getEnvironment,
-  getHooks,
-  getInterface,
-  getInterfaceActions,
-  getInterfaceApi,
-  getInterfaceFromResult,
-  getInterfaceResponse,
-  getNotifications,
-  getOptions,
-  getState,
-  handleInstallSnap,
-  handleRequest,
-  mergeValue,
-  notificationsSlice,
-  registerActions,
-  removeNotification,
-  resolveInterface,
-  resolveWithSaga,
-  rootLogger,
-  selectFromRadioGroup,
-  selectInDropdown,
-  setInterface,
-  setState,
-  startServer,
-  stateSlice,
-  typeInField,
-  uiSlice,
-  uploadFile
-};
+export * from "./environment.mjs";
+export * from "./logger.mjs";
+export * from "./request.mjs";
+export * from "./server.mjs";
+export * from "./simulation/index.mjs";
+export * from "./structs.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/internals/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/internals/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,6BAAyB;AACzB,8BAA0B;AAC1B,6BAAyB;AACzB,uCAA6B;AAC7B,8BAA0B","sourcesContent":["export * from './environment';\nexport * from './logger';\nexport * from './request';\nexport * from './server';\nexport * from './simulation';\nexport * from './structs';\n"]}

package/dist/internals/logger.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rootLogger = void 0;
+const utils_1 = require("@metamask/utils");
+exports.rootLogger = (0, utils_1.createProjectLogger)('snaps-jest');
+//# sourceMappingURL=logger.cjs.map

package/dist/internals/logger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.cjs","sourceRoot":"","sources":["../../src/internals/logger.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEzC,QAAA,UAAU,GAAG,IAAA,2BAAmB,EAAC,YAAY,CAAC,CAAC","sourcesContent":["import { createProjectLogger } from '@metamask/utils';\n\nexport const rootLogger = createProjectLogger('snaps-jest');\n"]}

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

@@ -1,2 +1,3 @@
 /// <reference types="debug" />
 export declare const rootLogger: import("debug").Debugger;
+//# sourceMappingURL=logger.d.cts.map

package/dist/internals/logger.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.cts","sourceRoot":"","sources":["../../src/internals/logger.ts"],"names":[],"mappings":";AAEA,eAAO,MAAM,UAAU,0BAAoC,CAAC"}

package/dist/internals/logger.d.mts

@@ -0,0 +1,3 @@
+/// <reference types="debug" />
+export declare const rootLogger: import("debug").Debugger;
+//# sourceMappingURL=logger.d.mts.map

package/dist/internals/logger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.mts","sourceRoot":"","sources":["../../src/internals/logger.ts"],"names":[],"mappings":";AAEA,eAAO,MAAM,UAAU,0BAAoC,CAAC"}

package/dist/internals/logger.mjs

@@ -1,8 +1,3 @@
-import {
-  rootLogger
-} from "../chunk-J4ZPUCLX.mjs";
-import "../chunk-JMDSN227.mjs";
-export {
-  rootLogger
-};
+import { createProjectLogger } from "@metamask/utils";
+export const rootLogger = createProjectLogger('snaps-jest');
 //# sourceMappingURL=logger.mjs.map

package/dist/internals/logger.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"logger.mjs","sourceRoot":"","sources":["../../src/internals/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,wBAAwB;AAEtD,MAAM,CAAC,MAAM,UAAU,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC","sourcesContent":["import { createProjectLogger } from '@metamask/utils';\n\nexport const rootLogger = createProjectLogger('snaps-jest');\n"]}

package/dist/internals/request.cjs

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInterfaceApi = exports.getInterfaceFromResult = exports.handleRequest = void 0;
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const toolkit_1 = require("@reduxjs/toolkit");
+const simulation_1 = require("./simulation/index.cjs");
+const structs_1 = require("./structs.cjs");
+/**
+ * Send a JSON-RPC request to the Snap, and wrap the response in a
+ * {@link SnapResponse} object.
+ *
+ * @param options - The request options.
+ * @param options.snapId - The ID of the Snap to send the request to.
+ * @param options.store - The Redux store.
+ * @param options.executionService - The execution service to use to send the
+ * request.
+ * @param options.handler - The handler to use to send the request.
+ * @param options.controllerMessenger - The controller messenger used to call actions.
+ * @param options.runSaga - A function to run a saga outside the usual Redux
+ * flow.
+ * @param options.request - The request to send.
+ * @param options.request.id - The ID of the request. If not provided, a random
+ * ID will be generated.
+ * @param options.request.origin - The origin of the request. Defaults to
+ * `https://metamask.io`.
+ * @returns The response, wrapped in a {@link SnapResponse} object.
+ */
+function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id = (0, toolkit_1.nanoid)(), origin = 'https://metamask.io', ...options }, }) {
+    const getInterfaceError = () => {
+        throw new Error('Unable to get the interface from the Snap: The request to the Snap failed.');
+    };
+    const promise = executionService
+        .handleRpcRequest(snapId, {
+        origin,
+        handler,
+        request: {
+            jsonrpc: '2.0',
+            id: 1,
+            ...options,
+        },
+    })
+        .then(async (result) => {
+        const notifications = (0, simulation_1.getNotifications)(store.getState());
+        store.dispatch((0, simulation_1.clearNotifications)());
+        try {
+            const getInterfaceFn = await getInterfaceApi(result, snapId, controllerMessenger);
+            return {
+                id: String(id),
+                response: {
+                    result: (0, utils_1.getSafeJson)(result),
+                },
+                notifications,
+                ...(getInterfaceFn ? { getInterface: getInterfaceFn } : {}),
+            };
+        }
+        catch (error) {
+            const [unwrappedError] = (0, snaps_utils_1.unwrapError)(error);
+            return {
+                id: String(id),
+                response: {
+                    error: unwrappedError.serialize(),
+                },
+                notifications: [],
+                getInterface: getInterfaceError,
+            };
+        }
+    })
+        .catch((error) => {
+        const [unwrappedError] = (0, snaps_utils_1.unwrapError)(error);
+        return {
+            id: String(id),
+            response: {
+                error: unwrappedError.serialize(),
+            },
+            notifications: [],
+            getInterface: getInterfaceError,
+        };
+    });
+    promise.getInterface = async () => {
+        const sagaPromise = runSaga(simulation_1.getInterface, runSaga, snapId, controllerMessenger).toPromise();
+        const result = await Promise.race([promise, sagaPromise]);
+        // If the request promise has resolved to an error, we should throw
+        // instead of waiting for an interface that likely will never be displayed
+        if ((0, superstruct_1.is)(result, structs_1.SnapResponseStruct) &&
+            (0, utils_1.hasProperty)(result.response, 'error')) {
+            throw new Error(`Unable to get the interface from the Snap: The returned interface may be invalid. The error message received was: ${result.response.error.message}`);
+        }
+        return await sagaPromise;
+    };
+    return promise;
+}
+exports.handleRequest = handleRequest;
+/**
+ * Get the interface ID from the result if it's available or create a new interface if the result contains static components.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The interface ID or undefined if the result doesn't include content.
+ */
+async function getInterfaceFromResult(result, snapId, controllerMessenger) {
+    if ((0, utils_1.isPlainObject)(result) && (0, utils_1.hasProperty)(result, 'id')) {
+        return result.id;
+    }
+    if ((0, utils_1.isPlainObject)(result) && (0, utils_1.hasProperty)(result, 'content')) {
+        (0, utils_1.assert)((0, superstruct_1.is)(result.content, snaps_sdk_1.ComponentOrElementStruct), 'The Snap returned an invalid interface.');
+        const id = await controllerMessenger.call('SnapInterfaceController:createInterface', snapId, result.content);
+        return id;
+    }
+    return undefined;
+}
+exports.getInterfaceFromResult = getInterfaceFromResult;
+/**
+ * Get the response content from the `SnapInterfaceController` and include the
+ * interaction methods.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The content components if any.
+ */
+async function getInterfaceApi(result, snapId, controllerMessenger) {
+    const interfaceId = await getInterfaceFromResult(result, snapId, controllerMessenger);
+    if (interfaceId) {
+        return () => {
+            const { content } = controllerMessenger.call('SnapInterfaceController:getInterface', snapId, interfaceId);
+            const actions = (0, simulation_1.getInterfaceActions)(snapId, controllerMessenger, {
+                id: interfaceId,
+                content,
+            });
+            return {
+                content,
+                ...actions,
+            };
+        };
+    }
+    return undefined;
+}
+exports.getInterfaceApi = getInterfaceApi;
+//# sourceMappingURL=request.cjs.map

package/dist/internals/request.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.cjs","sourceRoot":"","sources":["../../src/internals/request.ts"],"names":[],"mappings":";;;AACA,mDAK6B;AAE7B,uDAAoD;AACpD,uDAA2C;AAC3C,2CAKyB;AACzB,8CAA0C;AAQ1C,uDAKsB;AAEtB,2CAA+C;AAY/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,aAAa,CAAC,EAC5B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,EACP,OAAO,EAAE,EAAE,EAAE,GAAG,IAAA,gBAAM,GAAE,EAAE,MAAM,GAAG,qBAAqB,EAAE,GAAG,OAAO,EAAE,GACjD;IACrB,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC7B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,gBAAgB;SAC7B,gBAAgB,CAAC,MAAM,EAAE;QACxB,MAAM;QACN,OAAO;QACP,OAAO,EAAE;YACP,OAAO,EAAE,KAAK;YACd,EAAE,EAAE,CAAC;YACL,GAAG,OAAO;SACX;KACF,CAAC;SACD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACrB,MAAM,aAAa,GAAG,IAAA,6BAAgB,EAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzD,KAAK,CAAC,QAAQ,CAAC,IAAA,+BAAkB,GAAE,CAAC,CAAC;QAErC,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,MAAM,eAAe,CAC1C,MAAM,EACN,MAAM,EACN,mBAAmB,CACpB,CAAC;YAEF,OAAO;gBACL,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;gBACd,QAAQ,EAAE;oBACR,MAAM,EAAE,IAAA,mBAAW,EAAC,MAAM,CAAC;iBAC5B;gBACD,aAAa;gBACb,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC5D,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,cAAc,CAAC,GAAG,IAAA,yBAAW,EAAC,KAAK,CAAC,CAAC;YAC5C,OAAO;gBACL,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;gBACd,QAAQ,EAAE;oBACR,KAAK,EAAE,cAAc,CAAC,SAAS,EAAE;iBAClC;gBACD,aAAa,EAAE,EAAE;gBACjB,YAAY,EAAE,iBAAiB;aAChC,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,CAAC,cAAc,CAAC,GAAG,IAAA,yBAAW,EAAC,KAAK,CAAC,CAAC;QAE5C,OAAO;YACL,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;YACd,QAAQ,EAAE;gBACR,KAAK,EAAE,cAAc,CAAC,SAAS,EAAE;aAClC;YACD,aAAa,EAAE,EAAE;YACjB,YAAY,EAAE,iBAAiB;SAChC,CAAC;IACJ,CAAC,CAA2B,CAAC;IAE/B,OAAO,CAAC,YAAY,GAAG,KAAK,IAAI,EAAE;QAChC,MAAM,WAAW,GAAG,OAAO,CACzB,yBAAY,EACZ,OAAO,EACP,MAAM,EACN,mBAAmB,CACpB,CAAC,SAAS,EAAE,CAAC;QACd,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;QAE1D,mEAAmE;QACnE,0EAA0E;QAC1E,IACE,IAAA,gBAAE,EAAC,MAAM,EAAE,4BAAkB,CAAC;YAC9B,IAAA,mBAAW,EAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EACrC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,qHACG,MAAM,CAAC,QAAQ,CAAC,KAAsB,CAAC,OAC1C,EAAE,CACH,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,WAAW,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AA/FD,sCA+FC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAC1C,MAAe,EACf,MAAc,EACd,mBAA4C;IAE5C,IAAI,IAAA,qBAAa,EAAC,MAAM,CAAC,IAAI,IAAA,mBAAW,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;QACvD,OAAO,MAAM,CAAC,EAAY,CAAC;IAC7B,CAAC;IAED,IAAI,IAAA,qBAAa,EAAC,MAAM,CAAC,IAAI,IAAA,mBAAW,EAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;QAC5D,IAAA,cAAM,EACJ,IAAA,gBAAE,EAAC,MAAM,CAAC,OAAO,EAAE,oCAAwB,CAAC,EAC5C,yCAAyC,CAC1C,CAAC;QACF,MAAM,EAAE,GAAG,MAAM,mBAAmB,CAAC,IAAI,CACvC,yCAAyC,EACzC,MAAM,EACN,MAAM,CAAC,OAA6B,CACrC,CAAC;QAEF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAxBD,wDAwBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,eAAe,CACnC,MAAe,EACf,MAAc,EACd,mBAA4C;IAE5C,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAC9C,MAAM,EACN,MAAM,EACN,mBAAmB,CACpB,CAAC;IAEF,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,GAAG,EAAE;YACV,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,IAAI,CAC1C,sCAAsC,EACtC,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,gCAAmB,EAAC,MAAM,EAAE,mBAAmB,EAAE;gBAC/D,EAAE,EAAE,WAAW;gBACf,OAAO;aACR,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO;gBACP,GAAG,OAAO;aACX,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAhCD,0CAgCC","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  type ComponentOrElement,\n  ComponentOrElementStruct,\n  type JsonRpcError,\n  type SnapId,\n} from '@metamask/snaps-sdk';\nimport type { HandlerType } from '@metamask/snaps-utils';\nimport { unwrapError } from '@metamask/snaps-utils';\nimport { is } from '@metamask/superstruct';\nimport {\n  assert,\n  getSafeJson,\n  hasProperty,\n  isPlainObject,\n} from '@metamask/utils';\nimport { nanoid } from '@reduxjs/toolkit';\n\nimport type {\n  RequestOptions,\n  SnapHandlerInterface,\n  SnapRequest,\n} from '../types';\nimport type { RunSagaFunction, Store } from './simulation';\nimport {\n  clearNotifications,\n  getInterface,\n  getInterfaceActions,\n  getNotifications,\n} 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\n * 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      const actions = getInterfaceActions(snapId, controllerMessenger, {\n        id: interfaceId,\n        content,\n      });\n\n      return {\n        content,\n        ...actions,\n      };\n    };\n  }\n\n  return undefined;\n}\n"]}

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

@@ -1,9 +1,9 @@
-import type { AbstractExecutionService } from '@metamask/snaps-controllers';
-import { type SnapId } from '@metamask/snaps-sdk';
-import type { HandlerType } from '@metamask/snaps-utils';
-import type { RequestOptions, SnapHandlerInterface, SnapRequest } from '../types';
-import type { RunSagaFunction, Store } from './simulation';
-import type { RootControllerMessenger } from './simulation/controllers';
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import { type SnapId } from "@metamask/snaps-sdk";
+import type { HandlerType } from "@metamask/snaps-utils";
+import type { RequestOptions, SnapHandlerInterface, SnapRequest } from "../types/index.cjs";
+import type { RunSagaFunction, Store } from "./simulation/index.cjs";
+import type { RootControllerMessenger } from "./simulation/controllers.cjs";
 export type HandleRequestOptions = {
     snapId: SnapId;
     store: Store;
@@ -53,3 +53,4 @@ export declare function getInterfaceFromResult(result: unknown, snapId: SnapId,
  * @returns The content components if any.
  */
 export declare function getInterfaceApi(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Promise<(() => SnapHandlerInterface) | undefined>;
+//# sourceMappingURL=request.d.cts.map

package/dist/internals/request.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.cts","sourceRoot":"","sources":["../../src/internals/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,EAIL,KAAK,MAAM,EACZ,4BAA4B;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAWzD,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,WAAW,EACZ,2BAAiB;AAClB,OAAO,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,+BAAqB;AAO3D,OAAO,KAAK,EAAE,uBAAuB,EAAE,qCAAiC;AAGxE,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACpD,OAAO,EAAE,WAAW,CAAC;IACrB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAAC,EAC5B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,EACP,OAAO,EAAE,EAAE,EAAa,EAAE,MAA8B,EAAE,GAAG,OAAO,EAAE,GACvE,EAAE,oBAAoB,GAAG,WAAW,CAuFpC;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,+BAqB7C;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,GAC3C,OAAO,CAAC,CAAC,MAAM,oBAAoB,CAAC,GAAG,SAAS,CAAC,CA4BnD"}

package/dist/internals/request.d.mts

@@ -0,0 +1,56 @@
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import { type SnapId } from "@metamask/snaps-sdk";
+import type { HandlerType } from "@metamask/snaps-utils";
+import type { RequestOptions, SnapHandlerInterface, SnapRequest } from "../types/index.mjs";
+import type { RunSagaFunction, Store } from "./simulation/index.mjs";
+import type { RootControllerMessenger } from "./simulation/controllers.mjs";
+export type HandleRequestOptions = {
+    snapId: SnapId;
+    store: Store;
+    executionService: AbstractExecutionService<unknown>;
+    handler: HandlerType;
+    controllerMessenger: RootControllerMessenger;
+    runSaga: RunSagaFunction;
+    request: RequestOptions;
+};
+/**
+ * Send a JSON-RPC request to the Snap, and wrap the response in a
+ * {@link SnapResponse} object.
+ *
+ * @param options - The request options.
+ * @param options.snapId - The ID of the Snap to send the request to.
+ * @param options.store - The Redux store.
+ * @param options.executionService - The execution service to use to send the
+ * request.
+ * @param options.handler - The handler to use to send the request.
+ * @param options.controllerMessenger - The controller messenger used to call actions.
+ * @param options.runSaga - A function to run a saga outside the usual Redux
+ * flow.
+ * @param options.request - The request to send.
+ * @param options.request.id - The ID of the request. If not provided, a random
+ * ID will be generated.
+ * @param options.request.origin - The origin of the request. Defaults to
+ * `https://metamask.io`.
+ * @returns The response, wrapped in a {@link SnapResponse} object.
+ */
+export declare function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id, origin, ...options }, }: HandleRequestOptions): SnapRequest;
+/**
+ * Get the interface ID from the result if it's available or create a new interface if the result contains static components.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The interface ID or undefined if the result doesn't include content.
+ */
+export declare function getInterfaceFromResult(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Promise<string | undefined>;
+/**
+ * Get the response content from the `SnapInterfaceController` and include the
+ * interaction methods.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The content components if any.
+ */
+export declare function getInterfaceApi(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Promise<(() => SnapHandlerInterface) | undefined>;
+//# sourceMappingURL=request.d.mts.map

package/dist/internals/request.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.mts","sourceRoot":"","sources":["../../src/internals/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,EAIL,KAAK,MAAM,EACZ,4BAA4B;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAWzD,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,WAAW,EACZ,2BAAiB;AAClB,OAAO,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,+BAAqB;AAO3D,OAAO,KAAK,EAAE,uBAAuB,EAAE,qCAAiC;AAGxE,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACpD,OAAO,EAAE,WAAW,CAAC;IACrB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAAC,EAC5B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,EACnB,OAAO,EACP,OAAO,EAAE,EAAE,EAAa,EAAE,MAA8B,EAAE,GAAG,OAAO,EAAE,GACvE,EAAE,oBAAoB,GAAG,WAAW,CAuFpC;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,+BAqB7C;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,GAC3C,OAAO,CAAC,CAAC,MAAM,oBAAoB,CAAC,GAAG,SAAS,CAAC,CA4BnD"}

package/dist/internals/request.mjs

@@ -1,42 +1,138 @@
-import {
-  getInterfaceApi,
-  getInterfaceFromResult,
-  handleRequest
-} from "../chunk-PDOVVC74.mjs";
-import "../chunk-5ZFHFICZ.mjs";
-import "../chunk-Q3I6P2ZF.mjs";
-import "../chunk-ZG33OGC3.mjs";
-import "../chunk-3J2IBWXV.mjs";
-import "../chunk-6HHV6YFQ.mjs";
-import "../chunk-Q2OQXAUM.mjs";
-import "../chunk-VOYBI6T4.mjs";
-import "../chunk-IXKO6X55.mjs";
-import "../chunk-FP4H3ADT.mjs";
-import "../chunk-6JPBXAHM.mjs";
-import "../chunk-IWJ4HKDR.mjs";
-import "../chunk-G333FBBL.mjs";
-import "../chunk-C26TYXXD.mjs";
-import "../chunk-LVNNGMJ2.mjs";
-import "../chunk-LSKT2AUS.mjs";
-import "../chunk-NTOY6Y4Q.mjs";
-import "../chunk-OHRFO2BL.mjs";
-import "../chunk-UDOXICJK.mjs";
-import "../chunk-QRVFWATH.mjs";
-import "../chunk-FQWOVTBB.mjs";
-import "../chunk-ALRZENWP.mjs";
-import "../chunk-24CGIQLL.mjs";
-import "../chunk-5U5WB3SM.mjs";
-import "../chunk-RQKT6BQ2.mjs";
-import "../chunk-ORR7AE5X.mjs";
-import "../chunk-ZJQSGRNK.mjs";
-import "../chunk-H2464AXT.mjs";
-import "../chunk-LB4R3BUA.mjs";
-import "../chunk-MPZOXW6I.mjs";
-import "../chunk-57SGDM5B.mjs";
-import "../chunk-JMDSN227.mjs";
-export {
-  getInterfaceApi,
-  getInterfaceFromResult,
-  handleRequest
-};
+import { ComponentOrElementStruct } from "@metamask/snaps-sdk";
+import { unwrapError } from "@metamask/snaps-utils";
+import { is } from "@metamask/superstruct";
+import { assert, getSafeJson, hasProperty, isPlainObject } from "@metamask/utils";
+import $reduxjstoolkit from "@reduxjs/toolkit";
+const { nanoid } = $reduxjstoolkit;
+import { clearNotifications, getInterface, getInterfaceActions, getNotifications } from "./simulation/index.mjs";
+import { SnapResponseStruct } from "./structs.mjs";
+/**
+ * Send a JSON-RPC request to the Snap, and wrap the response in a
+ * {@link SnapResponse} object.
+ *
+ * @param options - The request options.
+ * @param options.snapId - The ID of the Snap to send the request to.
+ * @param options.store - The Redux store.
+ * @param options.executionService - The execution service to use to send the
+ * request.
+ * @param options.handler - The handler to use to send the request.
+ * @param options.controllerMessenger - The controller messenger used to call actions.
+ * @param options.runSaga - A function to run a saga outside the usual Redux
+ * flow.
+ * @param options.request - The request to send.
+ * @param options.request.id - The ID of the request. If not provided, a random
+ * ID will be generated.
+ * @param options.request.origin - The origin of the request. Defaults to
+ * `https://metamask.io`.
+ * @returns The response, wrapped in a {@link SnapResponse} object.
+ */
+export function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id = nanoid(), origin = 'https://metamask.io', ...options }, }) {
+    const getInterfaceError = () => {
+        throw new Error('Unable to get the interface from the Snap: The request to the Snap failed.');
+    };
+    const promise = executionService
+        .handleRpcRequest(snapId, {
+        origin,
+        handler,
+        request: {
+            jsonrpc: '2.0',
+            id: 1,
+            ...options,
+        },
+    })
+        .then(async (result) => {
+        const notifications = getNotifications(store.getState());
+        store.dispatch(clearNotifications());
+        try {
+            const getInterfaceFn = await getInterfaceApi(result, snapId, controllerMessenger);
+            return {
+                id: String(id),
+                response: {
+                    result: getSafeJson(result),
+                },
+                notifications,
+                ...(getInterfaceFn ? { getInterface: getInterfaceFn } : {}),
+            };
+        }
+        catch (error) {
+            const [unwrappedError] = unwrapError(error);
+            return {
+                id: String(id),
+                response: {
+                    error: unwrappedError.serialize(),
+                },
+                notifications: [],
+                getInterface: getInterfaceError,
+            };
+        }
+    })
+        .catch((error) => {
+        const [unwrappedError] = unwrapError(error);
+        return {
+            id: String(id),
+            response: {
+                error: unwrappedError.serialize(),
+            },
+            notifications: [],
+            getInterface: getInterfaceError,
+        };
+    });
+    promise.getInterface = async () => {
+        const sagaPromise = runSaga(getInterface, runSaga, snapId, controllerMessenger).toPromise();
+        const result = await Promise.race([promise, sagaPromise]);
+        // If the request promise has resolved to an error, we should throw
+        // instead of waiting for an interface that likely will never be displayed
+        if (is(result, SnapResponseStruct) &&
+            hasProperty(result.response, 'error')) {
+            throw new Error(`Unable to get the interface from the Snap: The returned interface may be invalid. The error message received was: ${result.response.error.message}`);
+        }
+        return await sagaPromise;
+    };
+    return promise;
+}
+/**
+ * Get the interface ID from the result if it's available or create a new interface if the result contains static components.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The interface ID or undefined if the result doesn't include content.
+ */
+export async function getInterfaceFromResult(result, snapId, controllerMessenger) {
+    if (isPlainObject(result) && hasProperty(result, 'id')) {
+        return result.id;
+    }
+    if (isPlainObject(result) && hasProperty(result, 'content')) {
+        assert(is(result.content, ComponentOrElementStruct), 'The Snap returned an invalid interface.');
+        const id = await controllerMessenger.call('SnapInterfaceController:createInterface', snapId, result.content);
+        return id;
+    }
+    return undefined;
+}
+/**
+ * Get the response content from the `SnapInterfaceController` and include the
+ * interaction methods.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The content components if any.
+ */
+export async function getInterfaceApi(result, snapId, controllerMessenger) {
+    const interfaceId = await getInterfaceFromResult(result, snapId, controllerMessenger);
+    if (interfaceId) {
+        return () => {
+            const { content } = controllerMessenger.call('SnapInterfaceController:getInterface', snapId, interfaceId);
+            const actions = getInterfaceActions(snapId, controllerMessenger, {
+                id: interfaceId,
+                content,
+            });
+            return {
+                content,
+                ...actions,
+            };
+        };
+    }
+    return undefined;
+}
 //# sourceMappingURL=request.mjs.map