@metamask/snaps-jest 8.3.0 → 8.3.1

package/dist/helpers.cjs

@@ -0,0 +1,240 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installSnap = exports.assertCustomDialogHasNoFooter = exports.assertCustomDialogHasPartialFooter = exports.assertCustomDialogHasFooter = exports.assertIsCustomDialog = exports.assertIsPromptDialog = exports.assertIsConfirmationDialog = exports.assertIsAlertDialog = 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 internals_1 = require("./internals/index.cjs");
+const mocks_1 = require("./internals/simulation/store/mocks.cjs");
+const log = (0, utils_1.createModuleLogger)(internals_1.rootLogger, 'helpers');
+/**
+ * Get the options for {@link installSnap}.
+ *
+ * @param snapId - The ID of the Snap, or the options.
+ * @param options - The options, if any.
+ * @returns The options.
+ */
+function getOptions(snapId, options) {
+    if (typeof snapId === 'object') {
+        return [undefined, snapId];
+    }
+    return [snapId, options];
+}
+/**
+ * Ensure that the actual response contains `getInterface`.
+ *
+ * @param response - The response of the handler.
+ */
+function assertIsResponseWithInterface(response) {
+    (0, utils_1.assertStruct)(response, internals_1.SnapResponseWithInterfaceStruct);
+}
+/**
+ * Ensure that the actual interface is an alert dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertIsAlertDialog(ui) {
+    (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Alert);
+}
+exports.assertIsAlertDialog = assertIsAlertDialog;
+/**
+ * Ensure that the actual interface is a confirmation dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertIsConfirmationDialog(ui) {
+    (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Confirmation);
+}
+exports.assertIsConfirmationDialog = assertIsConfirmationDialog;
+/**
+ * Ensure that the actual interface is a Prompt dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertIsPromptDialog(ui) {
+    (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Prompt);
+}
+exports.assertIsPromptDialog = assertIsPromptDialog;
+/**
+ * Ensure that the actual interface is a custom dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertIsCustomDialog(ui) {
+    (0, utils_1.assert)(!(0, utils_1.hasProperty)(ui, 'type'));
+}
+exports.assertIsCustomDialog = assertIsCustomDialog;
+/**
+ * Ensure that the actual interface is a custom dialog with a complete footer.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertCustomDialogHasFooter(ui) {
+    const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
+    (0, utils_1.assert)(footer && (0, snaps_utils_1.getJsxChildren)(footer).length === 2);
+}
+exports.assertCustomDialogHasFooter = assertCustomDialogHasFooter;
+/**
+ * Ensure that the actual interface is a custom dialog with a partial footer.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertCustomDialogHasPartialFooter(ui) {
+    const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
+    (0, utils_1.assert)(footer && (0, snaps_utils_1.getJsxChildren)(footer).length === 1);
+}
+exports.assertCustomDialogHasPartialFooter = assertCustomDialogHasPartialFooter;
+/**
+ * Ensure that the actual interface is a custom dialog without a footer.
+ *
+ * @param ui - The interface to verify.
+ */
+function assertCustomDialogHasNoFooter(ui) {
+    const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
+    (0, utils_1.assert)(!footer);
+}
+exports.assertCustomDialogHasNoFooter = assertCustomDialogHasNoFooter;
+/**
+ * Load a snap into the environment. This is the main entry point for testing
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
+ * snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * describe('My Snap', () => {
+ *   it('should do something', async () => {
+ *     const { request } = await installSnap('local:my-snap');
+ *     const response = await request({
+ *       method: 'foo',
+ *       params: ['bar'],
+ *     });
+ *     expect(response).toRespondWith('bar');
+ *   });
+ * });
+ * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults
+ * to the URL of the built-in server, if it is running. This supports both
+ * local snap IDs and NPM snap IDs.
+ * @param options - The options to use.
+ * @param options.executionService - The execution service to use. Defaults to
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
+ * you are testing a custom execution service.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The snap.
+ * @throws If the built-in server is not running, and no snap ID is provided.
+ */
+async function installSnap(snapId, options = {}) {
+    const resolvedOptions = getOptions(snapId, options);
+    const { snapId: installedSnapId, store, executionService, runSaga, controllerMessenger, } = await (0, internals_1.getEnvironment)().installSnap(...resolvedOptions);
+    const onTransaction = async (request) => {
+        log('Sending transaction %o.', request);
+        const { origin: transactionOrigin, chainId, ...transaction } = (0, superstruct_1.create)(request, internals_1.TransactionOptionsStruct);
+        const response = await (0, internals_1.handleRequest)({
+            snapId: installedSnapId,
+            store,
+            executionService,
+            runSaga,
+            controllerMessenger,
+            handler: snaps_utils_1.HandlerType.OnTransaction,
+            request: {
+                method: '',
+                params: {
+                    chainId,
+                    transaction,
+                    transactionOrigin,
+                },
+            },
+        });
+        assertIsResponseWithInterface(response);
+        return response;
+    };
+    const onCronjob = (request) => {
+        log('Running cronjob %o.', options);
+        return (0, internals_1.handleRequest)({
+            snapId: installedSnapId,
+            store,
+            executionService,
+            controllerMessenger,
+            runSaga,
+            handler: snaps_utils_1.HandlerType.OnCronjob,
+            request,
+        });
+    };
+    return {
+        request: (request) => {
+            log('Sending request %o.', request);
+            return (0, internals_1.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnRpcRequest,
+                request,
+            });
+        },
+        onTransaction,
+        sendTransaction: onTransaction,
+        onSignature: async (request) => {
+            log('Requesting signature %o.', request);
+            const { origin: signatureOrigin, ...signature } = (0, superstruct_1.create)(request, internals_1.SignatureOptionsStruct);
+            const response = await (0, internals_1.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnSignature,
+                request: {
+                    method: '',
+                    params: {
+                        signature,
+                        signatureOrigin,
+                    },
+                },
+            });
+            assertIsResponseWithInterface(response);
+            return response;
+        },
+        onCronjob,
+        runCronjob: onCronjob,
+        onHomePage: async () => {
+            log('Rendering home page.');
+            const response = await (0, internals_1.handleRequest)({
+                snapId: installedSnapId,
+                store,
+                executionService,
+                controllerMessenger,
+                runSaga,
+                handler: snaps_utils_1.HandlerType.OnHomePage,
+                request: {
+                    method: '',
+                },
+            });
+            assertIsResponseWithInterface(response);
+            return response;
+        },
+        mockJsonRpc(mock) {
+            log('Mocking JSON-RPC request %o.', mock);
+            const { method, result } = (0, superstruct_1.create)(mock, internals_1.JsonRpcMockOptionsStruct);
+            store.dispatch((0, mocks_1.addJsonRpcMock)({ method, result }));
+            return {
+                unmock() {
+                    log('Unmocking JSON-RPC request %o.', mock);
+                    store.dispatch((0, mocks_1.removeJsonRpcMock)(method));
+                },
+            };
+        },
+        close: async () => {
+            log('Closing execution service.');
+            (0, snaps_utils_1.logInfo)('Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.');
+            await executionService.terminateAllSnaps();
+        },
+    };
+}
+exports.installSnap = installSnap;
+//# sourceMappingURL=helpers.cjs.map

package/dist/helpers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.cjs","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAEA,mDAAiD;AAEjD,uDAA6E;AAC7E,uDAA+C;AAC/C,2CAKyB;AAEzB,qDASqB;AAErB,kEAG4C;AAmB5C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAU,EAAE,SAAS,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,SAAS,UAAU,CAKjB,MAAiE,EACjE,OAA6C;IAE7C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAS,6BAA6B,CACpC,QAAsB;IAEtB,IAAA,oBAAY,EAAC,QAAQ,EAAE,2CAA+B,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CACjC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,KAAK,CAAC,CAAC;AAClE,CAAC;AAJD,kDAIC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,YAAY,CAAC,CAAC;AACzE,CAAC;AAJD,gEAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,MAAM,CAAC,CAAC;AACnE,CAAC;AAJD,oDAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,EAAiB;IAEjB,IAAA,cAAM,EAAC,CAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;AACnC,CAAC;AAJD,oDAIC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,MAAM,IAAI,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAND,kEAMC;AAED;;;;GAIG;AACH,SAAgB,kCAAkC,CAChD,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,MAAM,IAAI,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAND,gFAMC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B,CAC3C,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC;AAND,sEAMC;AAqGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,WAAW,CAK/B,MAAsD,EACtD,UAAgD,EAAE;IAElD,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,EACJ,MAAM,EAAE,eAAe,EACvB,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,GACpB,GAAG,MAAM,IAAA,0BAAc,GAAE,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,CAAC;IAE3D,MAAM,aAAa,GAAG,KAAK,EACzB,OAA2B,EACS,EAAE;QACtC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,EACJ,MAAM,EAAE,iBAAiB,EACzB,OAAO,EACP,GAAG,WAAW,EACf,GAAG,IAAA,oBAAM,EAAC,OAAO,EAAE,oCAAwB,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;YACnC,MAAM,EAAE,eAAe;YACvB,KAAK;YACL,gBAAgB;YAChB,OAAO;YACP,mBAAmB;YACnB,OAAO,EAAE,yBAAW,CAAC,aAAa;YAClC,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE;oBACN,OAAO;oBACP,WAAW;oBACX,iBAAiB;iBAClB;aACF;SACF,CAAC,CAAC;QAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,OAAuB,EAAE,EAAE;QAC5C,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAA,yBAAa,EAAC;YACnB,MAAM,EAAE,eAAe;YACvB,KAAK;YACL,gBAAgB;YAChB,mBAAmB;YACnB,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,SAAS;YAC9B,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnB,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAA,yBAAa,EAAC;gBACnB,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,YAAY;gBACjC,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,aAAa;QACb,eAAe,EAAE,aAAa;QAE9B,WAAW,EAAE,KAAK,EAChB,OAAgB,EACoB,EAAE;YACtC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;YAEzC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,SAAS,EAAE,GAAG,IAAA,oBAAM,EACtD,OAAO,EACP,kCAAsB,CACvB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;gBACnC,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,WAAW;gBAChC,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;oBACV,MAAM,EAAE;wBACN,SAAS;wBACT,eAAe;qBAChB;iBACF;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,SAAS;QACT,UAAU,EAAE,SAAS;QAErB,UAAU,EAAE,KAAK,IAAwC,EAAE;YACzD,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAE5B,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;gBACnC,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,UAAU;gBAC/B,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;iBACX;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,WAAW,CAAC,IAAwB;YAClC,GAAG,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;YAE1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,oBAAM,EAAC,IAAI,EAAE,oCAAwB,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,CAAC,IAAA,sBAAc,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAEnD,OAAO;gBACL,MAAM;oBACJ,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;oBAE5C,KAAK,CAAC,QAAQ,CAAC,IAAA,yBAAiB,EAAC,MAAM,CAAC,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAClC,IAAA,qBAAO,EACL,uIAAuI,CACxI,CAAC;YAEF,MAAM,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC;AAhKD,kCAgKC","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DialogType } from '@metamask/snaps-sdk';\nimport type { FooterElement } from '@metamask/snaps-sdk/jsx';\nimport { HandlerType, getJsxChildren, logInfo } from '@metamask/snaps-utils';\nimport { create } from '@metamask/superstruct';\nimport {\n  assert,\n  assertStruct,\n  createModuleLogger,\n  hasProperty,\n} from '@metamask/utils';\n\nimport {\n  rootLogger,\n  handleRequest,\n  TransactionOptionsStruct,\n  getEnvironment,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  SnapResponseWithInterfaceStruct,\n  getElementByType,\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  SnapInterface,\n  SnapAlertInterface,\n  SnapInterfaceActions,\n  SnapConfirmationInterface,\n  SnapPromptInterface,\n  DefaultSnapInterface,\n  DefaultSnapInterfaceWithFooter,\n  DefaultSnapInterfaceWithPartialFooter,\n  DefaultSnapInterfaceWithoutFooter,\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 * Ensure that the actual interface is an alert dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsAlertDialog(\n  ui: SnapInterface,\n): asserts ui is SnapAlertInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Alert);\n}\n\n/**\n * Ensure that the actual interface is a confirmation dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsConfirmationDialog(\n  ui: SnapInterface,\n): asserts ui is SnapConfirmationInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Confirmation);\n}\n\n/**\n * Ensure that the actual interface is a Prompt dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsPromptDialog(\n  ui: SnapInterface,\n): asserts ui is SnapPromptInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Prompt);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsCustomDialog(\n  ui: SnapInterface,\n): asserts ui is DefaultSnapInterface & SnapInterfaceActions {\n  assert(!hasProperty(ui, 'type'));\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a complete footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(footer && getJsxChildren(footer).length === 2);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a partial footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasPartialFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(footer && getJsxChildren(footer).length === 1);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog without a footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasNoFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(!footer);\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/{types/helpers.d.ts → helpers.d.cts}

@@ -1,7 +1,7 @@
-import type { AbstractExecutionService } from '@metamask/snaps-controllers';
-import type { SnapId } from '@metamask/snaps-sdk';
-import type { InstallSnapOptions } from './internals';
-import type { Snap, SnapInterface, SnapAlertInterface, SnapInterfaceActions, SnapConfirmationInterface, SnapPromptInterface, DefaultSnapInterface, DefaultSnapInterfaceWithFooter, DefaultSnapInterfaceWithPartialFooter, DefaultSnapInterfaceWithoutFooter } from './types';
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { InstallSnapOptions } from "./internals/index.cjs";
+import type { Snap, SnapInterface, SnapAlertInterface, SnapInterfaceActions, SnapConfirmationInterface, SnapPromptInterface, DefaultSnapInterface, DefaultSnapInterfaceWithFooter, DefaultSnapInterfaceWithPartialFooter, DefaultSnapInterfaceWithoutFooter } from "./types/index.cjs";
 /**
  * Ensure that the actual interface is an alert dialog.
  *
@@ -129,3 +129,4 @@ export declare function installSnap<Service extends new (...args: any[]) => Inst
  * @throws If the built-in server is not running, and no snap ID is provided.
  */
 export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, options?: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
+//# sourceMappingURL=helpers.d.cts.map

package/dist/helpers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.cts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAsBlD,OAAO,KAAK,EAAE,kBAAkB,EAAE,8BAAoB;AAKtD,OAAO,KAAK,EAIV,IAAI,EAGJ,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,8BAA8B,EAC9B,qCAAqC,EACrC,iCAAiC,EAClC,0BAAgB;AAqCjB;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,kBAAkB,GAAG,oBAAoB,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,yBAAyB,GAAG,oBAAoB,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,mBAAmB,GAAG,oBAAoB,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,oBAAoB,GAAG,oBAAoB,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,8BAA8B,GAAG,oBAAoB,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,qCAAqC,GAAG,oBAAoB,CAI5E;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,iCAAiC,GAAG,oBAAoB,CAIxE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EACD,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/helpers.d.mts

@@ -0,0 +1,132 @@
+import type { AbstractExecutionService } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import type { InstallSnapOptions } from "./internals/index.mjs";
+import type { Snap, SnapInterface, SnapAlertInterface, SnapInterfaceActions, SnapConfirmationInterface, SnapPromptInterface, DefaultSnapInterface, DefaultSnapInterfaceWithFooter, DefaultSnapInterfaceWithPartialFooter, DefaultSnapInterfaceWithoutFooter } from "./types/index.mjs";
+/**
+ * Ensure that the actual interface is an alert dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertIsAlertDialog(ui: SnapInterface): asserts ui is SnapAlertInterface & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a confirmation dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertIsConfirmationDialog(ui: SnapInterface): asserts ui is SnapConfirmationInterface & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a Prompt dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertIsPromptDialog(ui: SnapInterface): asserts ui is SnapPromptInterface & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a custom dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertIsCustomDialog(ui: SnapInterface): asserts ui is DefaultSnapInterface & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a custom dialog with a complete footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertCustomDialogHasFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a custom dialog with a partial footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertCustomDialogHasPartialFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions;
+/**
+ * Ensure that the actual interface is a custom dialog without a footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export declare function assertCustomDialogHasNoFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions;
+/**
+ * Load a snap into the environment. This is the main entry point for testing
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
+ * snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * describe('My Snap', () => {
+ *   it('should do something', async () => {
+ *     const { request } = await installSnap('local:my-snap');
+ *     const response = await request({
+ *       method: 'foo',
+ *       params: ['bar'],
+ *     });
+ *     expect(response).toRespondWith('bar');
+ *   });
+ * });
+ * @returns The snap.
+ * @throws If the built-in server is not running, and no snap ID is provided.
+ */
+export declare function installSnap(): Promise<Snap>;
+/**
+ * Load a snap into the environment. This is the main entry point for testing
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
+ * snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * describe('My Snap', () => {
+ *   it('should do something', async () => {
+ *     const { request } = await installSnap('local:my-snap');
+ *     const response = await request({
+ *       method: 'foo',
+ *       params: ['bar'],
+ *     });
+ *     expect(response).toRespondWith('bar');
+ *   });
+ * });
+ * @param options - The options to use.
+ * @param options.executionService - The execution service to use. Defaults to
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
+ * you are testing a custom execution service.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The snap.
+ * @throws If the built-in server is not running, and no snap ID is provided.
+ */
+export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
+/**
+ * Load a snap into the environment. This is the main entry point for testing
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
+ * snap.
+ *
+ * @example
+ * import { installSnap } from '@metamask/snaps-jest';
+ *
+ * describe('My Snap', () => {
+ *   it('should do something', async () => {
+ *     const { request } = await installSnap('local:my-snap');
+ *     const response = await request({
+ *       method: 'foo',
+ *       params: ['bar'],
+ *     });
+ *     expect(response).toRespondWith('bar');
+ *   });
+ * });
+ * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults
+ * to the URL of the built-in server, if it is running. This supports both
+ * local snap IDs and NPM snap IDs.
+ * @param options - The options to use.
+ * @param options.executionService - The execution service to use. Defaults to
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
+ * you are testing a custom execution service.
+ * @param options.executionServiceOptions - The options to use when creating the
+ * execution service, if any. This should only include options specific to the
+ * provided execution service.
+ * @param options.options - The simulation options.
+ * @returns The snap.
+ * @throws If the built-in server is not running, and no snap ID is provided.
+ */
+export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, options?: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
+//# sourceMappingURL=helpers.d.mts.map

package/dist/helpers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.mts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAsBlD,OAAO,KAAK,EAAE,kBAAkB,EAAE,8BAAoB;AAKtD,OAAO,KAAK,EAIV,IAAI,EAGJ,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,8BAA8B,EAC9B,qCAAqC,EACrC,iCAAiC,EAClC,0BAAgB;AAqCjB;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,kBAAkB,GAAG,oBAAoB,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,yBAAyB,GAAG,oBAAoB,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,mBAAmB,GAAG,oBAAoB,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,oBAAoB,GAAG,oBAAoB,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,8BAA8B,GAAG,oBAAoB,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,qCAAqC,GAAG,oBAAoB,CAI5E;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,iCAAiC,GAAG,oBAAoB,CAIxE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EACD,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC"}