@metamask/snaps-jest 0.35.1-flask.1

package/dist/cjs/matchers.js

@@ -0,0 +1,117 @@
+/* eslint-disable no-invalid-this */ // Note: Because this file imports from `@jest/globals`, it can only be used in
+// a Jest environment. This is why it's not exported from the index file.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    toRespondWith: function() {
+        return toRespondWith;
+    },
+    toRespondWithError: function() {
+        return toRespondWithError;
+    },
+    toSendNotification: function() {
+        return toSendNotification;
+    },
+    toRender: function() {
+        return toRender;
+    }
+});
+const _globals = require("@jest/globals");
+const _utils = require("@metamask/utils");
+const _jestmatcherutils = require("jest-matcher-utils");
+const _superstruct = require("superstruct");
+const _internals = require("./internals");
+/**
+ * Ensure that the actual value is a response from the `request` function.
+ *
+ * @param actual - The actual value.
+ * @param matcherName - The name of the matcher.
+ * @param options - The matcher options.
+ */ function assertActualIsSnapResponse(actual, matcherName, options) {
+    if (!(0, _superstruct.is)(actual, _internals.SnapResponseStruct)) {
+        throw new Error((0, _jestmatcherutils.matcherErrorMessage)((0, _jestmatcherutils.matcherHint)(matcherName, undefined, undefined, options), `${(0, _jestmatcherutils.RECEIVED_COLOR)('received')} value must be a response from the \`request\` function`, (0, _jestmatcherutils.printWithType)('Received', actual, _jestmatcherutils.printReceived)));
+    }
+}
+/**
+ * Ensure that the actual value is a response from the `request` function, and
+ * that it has a `ui` property.
+ *
+ * @param actual - The actual value.
+ * @param matcherName - The name of the matcher.
+ * @param options - The matcher options.
+ */ function assertHasInterface(actual, matcherName, options) {
+    if (!(0, _superstruct.is)(actual, _internals.InterfaceStruct) || !actual.content) {
+        throw new Error((0, _jestmatcherutils.matcherErrorMessage)((0, _jestmatcherutils.matcherHint)(matcherName, undefined, undefined, options), `${(0, _jestmatcherutils.RECEIVED_COLOR)('received')} value must have a \`content\` property`, (0, _jestmatcherutils.printWithType)('Received', actual, _jestmatcherutils.printReceived)));
+    }
+}
+const toRespondWith = function(actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWith');
+    const { response } = actual;
+    if ((0, _utils.hasProperty)(response, 'error')) {
+        const message = ()=>`${this.utils.matcherHint('.toRespondWith')}\n\n` + `Expected response: ${this.utils.printExpected(expected)}\n` + `Received error: ${this.utils.printReceived(response.error)}`;
+        return {
+            message,
+            pass: false
+        };
+    }
+    const pass = this.equals(response.result, expected);
+    const message = pass ? ()=>`${this.utils.matcherHint('.not.toRespondWith')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(response.result)}` : ()=>`${this.utils.matcherHint('.toRespondWith')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(response.result)}`;
+    return {
+        message,
+        pass
+    };
+};
+const toRespondWithError = function(actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWithError');
+    const { response } = actual;
+    if ((0, _utils.hasProperty)(response, 'result')) {
+        const message = ()=>`${this.utils.matcherHint('.toRespondWithError')}\n\n` + `Expected error: ${this.utils.printExpected(expected)}\n` + `Received result: ${this.utils.printReceived(response.result)}`;
+        return {
+            message,
+            pass: false
+        };
+    }
+    const pass = this.equals(response.error, expected);
+    const message = pass ? ()=>`${this.utils.matcherHint('.not.toRespondWithError')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(response.error)}` : ()=>`${this.utils.matcherHint('.toRespondWithError')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(response.error)}`;
+    return {
+        message,
+        pass
+    };
+};
+const toSendNotification = async function(actual, expected, type) {
+    assertActualIsSnapResponse(actual, 'toSendNotification');
+    const { notifications } = actual;
+    const pass = notifications.some((notification)=>this.equals(notification.message, expected) && (type === undefined || notification.type === type));
+    const message = pass ? ()=>`${this.utils.matcherHint('.not.toSendNotification')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Expected type: ${this.utils.printExpected(type)}\n` + `Received: ${this.utils.printReceived(notifications)}` : ()=>`${this.utils.matcherHint('.toSendNotification')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Expected type: ${this.utils.printExpected(type)}\n` + `Received: ${this.utils.printReceived(notifications)}`;
+    return {
+        message,
+        pass
+    };
+};
+const toRender = function(actual, expected) {
+    assertHasInterface(actual, 'toRender');
+    const { content } = actual;
+    const pass = this.equals(content, expected);
+    const difference = (0, _jestmatcherutils.diff)(expected, content);
+    const message = pass ? ()=>`${this.utils.matcherHint('.not.toShowInterface')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(content)}` + `${difference ? `\n\nDifference:\n\n${difference}` : ''}` : ()=>`${this.utils.matcherHint('.toShowInterface')}\n\n` + `Expected: ${this.utils.printExpected(expected)}\n` + `Received: ${this.utils.printReceived(content)}` + `${difference ? `\n\nDifference:\n\n${difference}` : ''}`;
+    return {
+        message,
+        pass
+    };
+};
+_globals.expect.extend({
+    toRespondWith,
+    toRespondWithError,
+    toSendNotification,
+    toRender
+});
+
+//# sourceMappingURL=matchers.js.map

package/dist/cjs/matchers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/matchers.ts"],"sourcesContent":["/* eslint-disable no-invalid-this */\n\n// Note: Because this file imports from `@jest/globals`, it can only be used in\n// a Jest environment. This is why it's not exported from the index file.\n\nimport { expect } from '@jest/globals';\nimport { NotificationType } from '@metamask/rpc-methods';\nimport { Component } from '@metamask/snaps-ui';\nimport { EnumToUnion } from '@metamask/snaps-utils';\nimport { hasProperty, Json } from '@metamask/utils';\nimport type { MatcherFunction } from 'expect';\nimport {\n  diff,\n  matcherErrorMessage,\n  matcherHint,\n  MatcherHintOptions,\n  printReceived,\n  printWithType,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\nimport { is } from 'superstruct';\n\nimport { InterfaceStruct, SnapResponseStruct } from './internals';\nimport { SnapResponse } from './types';\n\n/**\n * Ensure that the actual value is a response from the `request` function.\n *\n * @param actual - The actual value.\n * @param matcherName - The name of the matcher.\n * @param options - The matcher options.\n */\nfunction assertActualIsSnapResponse(\n  actual: unknown,\n  matcherName: string,\n  options?: MatcherHintOptions,\n): asserts actual is SnapResponse {\n  if (!is(actual, SnapResponseStruct)) {\n    throw new Error(\n      matcherErrorMessage(\n        matcherHint(matcherName, undefined, undefined, options),\n        `${RECEIVED_COLOR(\n          'received',\n        )} value must be a response from the \\`request\\` function`,\n        printWithType('Received', actual, printReceived),\n      ),\n    );\n  }\n}\n\n/**\n * Ensure that the actual value is a response from the `request` function, and\n * that it has a `ui` property.\n *\n * @param actual - The actual value.\n * @param matcherName - The name of the matcher.\n * @param options - The matcher options.\n */\nfunction assertHasInterface(\n  actual: unknown,\n  matcherName: string,\n  options?: MatcherHintOptions,\n): asserts actual is { content: Component } {\n  if (!is(actual, InterfaceStruct) || !actual.content) {\n    throw new Error(\n      matcherErrorMessage(\n        matcherHint(matcherName, undefined, undefined, options),\n        `${RECEIVED_COLOR('received')} value must have a \\`content\\` property`,\n        printWithType('Received', actual, printReceived),\n      ),\n    );\n  }\n}\n\n/**\n * Check if a JSON-RPC response matches the expected value. This matcher is\n * intended to be used with the `expect` global.\n *\n * @param actual - The actual response.\n * @param expected - The expected response.\n * @returns The status and message.\n */\nexport const toRespondWith: MatcherFunction<[expected: Json]> = function (\n  actual,\n  expected,\n) {\n  assertActualIsSnapResponse(actual, 'toRespondWith');\n\n  const { response } = actual;\n  if (hasProperty(response, 'error')) {\n    const message = () =>\n      `${this.utils.matcherHint('.toRespondWith')}\\n\\n` +\n      `Expected response: ${this.utils.printExpected(expected)}\\n` +\n      `Received error: ${this.utils.printReceived(response.error)}`;\n\n    return { message, pass: false };\n  }\n\n  const pass = this.equals(response.result, expected);\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toRespondWith')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(response.result)}`\n    : () =>\n        `${this.utils.matcherHint('.toRespondWith')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(response.result)}`;\n\n  return { message, pass };\n};\n\nexport const toRespondWithError: MatcherFunction<[expected: Json]> = function (\n  actual,\n  expected,\n) {\n  assertActualIsSnapResponse(actual, 'toRespondWithError');\n\n  const { response } = actual;\n  if (hasProperty(response, 'result')) {\n    const message = () =>\n      `${this.utils.matcherHint('.toRespondWithError')}\\n\\n` +\n      `Expected error: ${this.utils.printExpected(expected)}\\n` +\n      `Received result: ${this.utils.printReceived(response.result)}`;\n\n    return { message, pass: false };\n  }\n\n  const pass = this.equals(response.error, expected);\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toRespondWithError')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(response.error)}`\n    : () =>\n        `${this.utils.matcherHint('.toRespondWithError')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(response.error)}`;\n\n  return { message, pass };\n};\n\n/**\n * Check if the snap sent a notification with the expected message. This matcher\n * is intended to be used with the `expect` global.\n *\n * @param actual - The actual response.\n * @param expected - The expected notification message.\n * @param type - The expected notification type.\n * @returns The status and message.\n */\nexport const toSendNotification: MatcherFunction<\n  [expected: string, type?: EnumToUnion<NotificationType> | undefined]\n> = async function (actual, expected, type) {\n  assertActualIsSnapResponse(actual, 'toSendNotification');\n\n  const { notifications } = actual;\n  const pass = notifications.some(\n    (notification) =>\n      this.equals(notification.message, expected) &&\n      (type === undefined || notification.type === type),\n  );\n\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toSendNotification')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Expected type: ${this.utils.printExpected(type)}\\n` +\n        `Received: ${this.utils.printReceived(notifications)}`\n    : () =>\n        `${this.utils.matcherHint('.toSendNotification')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Expected type: ${this.utils.printExpected(type)}\\n` +\n        `Received: ${this.utils.printReceived(notifications)}`;\n\n  return { message, pass };\n};\n\nexport const toRender: MatcherFunction<[expected: Component]> = function (\n  actual,\n  expected,\n) {\n  assertHasInterface(actual, 'toRender');\n\n  const { content } = actual;\n  const pass = this.equals(content, expected);\n\n  const difference = diff(expected, content);\n\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toShowInterface')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(content)}` +\n        `${difference ? `\\n\\nDifference:\\n\\n${difference}` : ''}`\n    : () =>\n        `${this.utils.matcherHint('.toShowInterface')}\\n\\n` +\n        `Expected: ${this.utils.printExpected(expected)}\\n` +\n        `Received: ${this.utils.printReceived(content)}` +\n        `${difference ? `\\n\\nDifference:\\n\\n${difference}` : ''}`;\n\n  return { message, pass };\n};\n\nexpect.extend({\n  toRespondWith,\n  toRespondWithError,\n  toSendNotification,\n  toRender,\n});\n"],"names":["toRespondWith","toRespondWithError","toSendNotification","toRender","assertActualIsSnapResponse","actual","matcherName","options","is","SnapResponseStruct","Error","matcherErrorMessage","matcherHint","undefined","RECEIVED_COLOR","printWithType","printReceived","assertHasInterface","InterfaceStruct","content","expected","response","hasProperty","message","utils","printExpected","error","pass","equals","result","type","notifications","some","notification","difference","diff","expect","extend"],"mappings":"AAAA,kCAAkC,GAElC,+EAA+E;AAC/E,yEAAyE;;;;;;;;;;;;IA+E5DA,aAAa;eAAbA;;IA8BAC,kBAAkB;eAAlBA;;IAuCAC,kBAAkB;eAAlBA;;IA2BAC,QAAQ;eAARA;;;yBA7KU;uBAIW;kCAU3B;6BACY;2BAEiC;AAGpD;;;;;;CAMC,GACD,SAASC,2BACPC,MAAe,EACfC,WAAmB,EACnBC,OAA4B;IAE5B,IAAI,CAACC,IAAAA,eAAE,EAACH,QAAQI,6BAAkB,GAAG;QACnC,MAAM,IAAIC,MACRC,IAAAA,qCAAmB,EACjBC,IAAAA,6BAAW,EAACN,aAAaO,WAAWA,WAAWN,UAC/C,CAAC,EAAEO,IAAAA,gCAAc,EACf,YACA,uDAAuD,CAAC,EAC1DC,IAAAA,+BAAa,EAAC,YAAYV,QAAQW,+BAAa;IAGrD;AACF;AAEA;;;;;;;CAOC,GACD,SAASC,mBACPZ,MAAe,EACfC,WAAmB,EACnBC,OAA4B;IAE5B,IAAI,CAACC,IAAAA,eAAE,EAACH,QAAQa,0BAAe,KAAK,CAACb,OAAOc,OAAO,EAAE;QACnD,MAAM,IAAIT,MACRC,IAAAA,qCAAmB,EACjBC,IAAAA,6BAAW,EAACN,aAAaO,WAAWA,WAAWN,UAC/C,CAAC,EAAEO,IAAAA,gCAAc,EAAC,YAAY,uCAAuC,CAAC,EACtEC,IAAAA,+BAAa,EAAC,YAAYV,QAAQW,+BAAa;IAGrD;AACF;AAUO,MAAMhB,gBAAmD,SAC9DK,MAAM,EACNe,QAAQ;IAERhB,2BAA2BC,QAAQ;IAEnC,MAAM,EAAEgB,QAAQ,EAAE,GAAGhB;IACrB,IAAIiB,IAAAA,kBAAW,EAACD,UAAU,UAAU;QAClC,MAAME,UAAU,IACd,CAAC,EAAE,IAAI,CAACC,KAAK,CAACZ,WAAW,CAAC,kBAAkB,IAAI,CAAC,GACjD,CAAC,mBAAmB,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GAC5D,CAAC,gBAAgB,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASK,KAAK,EAAE,CAAC;QAE/D,OAAO;YAAEH;YAASI,MAAM;QAAM;IAChC;IAEA,MAAMA,OAAO,IAAI,CAACC,MAAM,CAACP,SAASQ,MAAM,EAAET;IAC1C,MAAMG,UAAUI,OACZ,IACE,CAAC,EAAE,IAAI,CAACH,KAAK,CAACZ,WAAW,CAAC,sBAAsB,IAAI,CAAC,GACrD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASQ,MAAM,EAAE,CAAC,GAC1D,IACE,CAAC,EAAE,IAAI,CAACL,KAAK,CAACZ,WAAW,CAAC,kBAAkB,IAAI,CAAC,GACjD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASQ,MAAM,EAAE,CAAC;IAE9D,OAAO;QAAEN;QAASI;IAAK;AACzB;AAEO,MAAM1B,qBAAwD,SACnEI,MAAM,EACNe,QAAQ;IAERhB,2BAA2BC,QAAQ;IAEnC,MAAM,EAAEgB,QAAQ,EAAE,GAAGhB;IACrB,IAAIiB,IAAAA,kBAAW,EAACD,UAAU,WAAW;QACnC,MAAME,UAAU,IACd,CAAC,EAAE,IAAI,CAACC,KAAK,CAACZ,WAAW,CAAC,uBAAuB,IAAI,CAAC,GACtD,CAAC,gBAAgB,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACzD,CAAC,iBAAiB,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASQ,MAAM,EAAE,CAAC;QAEjE,OAAO;YAAEN;YAASI,MAAM;QAAM;IAChC;IAEA,MAAMA,OAAO,IAAI,CAACC,MAAM,CAACP,SAASK,KAAK,EAAEN;IACzC,MAAMG,UAAUI,OACZ,IACE,CAAC,EAAE,IAAI,CAACH,KAAK,CAACZ,WAAW,CAAC,2BAA2B,IAAI,CAAC,GAC1D,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASK,KAAK,EAAE,CAAC,GACzD,IACE,CAAC,EAAE,IAAI,CAACF,KAAK,CAACZ,WAAW,CAAC,uBAAuB,IAAI,CAAC,GACtD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACK,SAASK,KAAK,EAAE,CAAC;IAE7D,OAAO;QAAEH;QAASI;IAAK;AACzB;AAWO,MAAMzB,qBAET,eAAgBG,MAAM,EAAEe,QAAQ,EAAEU,IAAI;IACxC1B,2BAA2BC,QAAQ;IAEnC,MAAM,EAAE0B,aAAa,EAAE,GAAG1B;IAC1B,MAAMsB,OAAOI,cAAcC,IAAI,CAC7B,CAACC,eACC,IAAI,CAACL,MAAM,CAACK,aAAaV,OAAO,EAAEH,aACjCU,CAAAA,SAASjB,aAAaoB,aAAaH,IAAI,KAAKA,IAAG;IAGpD,MAAMP,UAAUI,OACZ,IACE,CAAC,EAAE,IAAI,CAACH,KAAK,CAACZ,WAAW,CAAC,2BAA2B,IAAI,CAAC,GAC1D,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,eAAe,EAAE,IAAI,CAACI,KAAK,CAACC,aAAa,CAACK,MAAM,EAAE,CAAC,GACpD,CAAC,UAAU,EAAE,IAAI,CAACN,KAAK,CAACR,aAAa,CAACe,eAAe,CAAC,GACxD,IACE,CAAC,EAAE,IAAI,CAACP,KAAK,CAACZ,WAAW,CAAC,uBAAuB,IAAI,CAAC,GACtD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,eAAe,EAAE,IAAI,CAACI,KAAK,CAACC,aAAa,CAACK,MAAM,EAAE,CAAC,GACpD,CAAC,UAAU,EAAE,IAAI,CAACN,KAAK,CAACR,aAAa,CAACe,eAAe,CAAC;IAE5D,OAAO;QAAER;QAASI;IAAK;AACzB;AAEO,MAAMxB,WAAmD,SAC9DE,MAAM,EACNe,QAAQ;IAERH,mBAAmBZ,QAAQ;IAE3B,MAAM,EAAEc,OAAO,EAAE,GAAGd;IACpB,MAAMsB,OAAO,IAAI,CAACC,MAAM,CAACT,SAASC;IAElC,MAAMc,aAAaC,IAAAA,sBAAI,EAACf,UAAUD;IAElC,MAAMI,UAAUI,OACZ,IACE,CAAC,EAAE,IAAI,CAACH,KAAK,CAACZ,WAAW,CAAC,wBAAwB,IAAI,CAAC,GACvD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACG,SAAS,CAAC,GAChD,CAAC,EAAEe,aAAa,CAAC,mBAAmB,EAAEA,WAAW,CAAC,GAAG,GAAG,CAAC,GAC3D,IACE,CAAC,EAAE,IAAI,CAACV,KAAK,CAACZ,WAAW,CAAC,oBAAoB,IAAI,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACY,KAAK,CAACC,aAAa,CAACL,UAAU,EAAE,CAAC,GACnD,CAAC,UAAU,EAAE,IAAI,CAACI,KAAK,CAACR,aAAa,CAACG,SAAS,CAAC,GAChD,CAAC,EAAEe,aAAa,CAAC,mBAAmB,EAAEA,WAAW,CAAC,GAAG,GAAG,CAAC;IAE/D,OAAO;QAAEX;QAASI;IAAK;AACzB;AAEAS,eAAM,CAACC,MAAM,CAAC;IACZrC;IACAC;IACAC;IACAC;AACF"}

package/dist/cjs/options.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getOptions", {
+    enumerable: true,
+    get: function() {
+        return getOptions;
+    }
+});
+const _superstruct = require("superstruct");
+const SnapsEnvironmentOptionsStruct = (0, _superstruct.type)({
+    executionEnvironmentUrl: (0, _superstruct.optional)((0, _superstruct.string)()),
+    simulatorUrl: (0, _superstruct.optional)((0, _superstruct.string)()),
+    keepAlive: (0, _superstruct.defaulted)((0, _superstruct.boolean)(), false),
+    server: (0, _superstruct.defaulted)((0, _superstruct.object)({
+        enabled: (0, _superstruct.defaulted)((0, _superstruct.boolean)(), true),
+        port: (0, _superstruct.defaulted)((0, _superstruct.number)(), 0),
+        root: (0, _superstruct.defaulted)((0, _superstruct.string)(), process.cwd())
+    }), {}),
+    browser: (0, _superstruct.defaulted)((0, _superstruct.object)({
+        headless: (0, _superstruct.defaulted)((0, _superstruct.boolean)(), true)
+    }), {})
+});
+function getOptions(testEnvironmentOptions) {
+    return (0, _superstruct.create)(testEnvironmentOptions, SnapsEnvironmentOptionsStruct);
+}
+
+//# sourceMappingURL=options.js.map

package/dist/cjs/options.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/options.ts"],"sourcesContent":["import {\n  boolean,\n  create,\n  defaulted,\n  Infer,\n  number,\n  object,\n  optional,\n  string,\n  type,\n} from 'superstruct';\n\nconst SnapsEnvironmentOptionsStruct = type({\n  executionEnvironmentUrl: optional(string()),\n  simulatorUrl: optional(string()),\n  keepAlive: defaulted(boolean(), false),\n\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  browser: defaulted(\n    object({\n      headless: defaulted(boolean(), true),\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 * ```json\n * {\n *   \"testEnvironment\": \"@metamask/snaps-jest\",\n *   \"testEnvironmentOptions\": {\n *     \"executionEnvironmentUrl\": \"http://localhost:8080\",\n *     \"server\": {\n *       \"port\": 8080,\n *       /* ... *\\/\n *     }\n *   }\n * }\n * ```\n * @property executionEnvironmentUrl - The URL of the execution environment. If\n * this is not provided, the execution environment will be served from the\n * built-in HTTP server.\n * @property simulatorUrl - The URL of the simulator. If this is not provided,\n * the simulator will be served from the built-in HTTP server.\n * @property keepAlive - Whether to keep the browser open after the tests have\n * finished. This is useful for debugging. Defaults to `false`.\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 * @property browser - The options for the browser.\n * @property browser.headless - Whether to run the browser in headless mode.\n * Defaults to `true`.\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"],"names":["getOptions","SnapsEnvironmentOptionsStruct","type","executionEnvironmentUrl","optional","string","simulatorUrl","keepAlive","defaulted","boolean","server","object","enabled","port","number","root","process","cwd","browser","headless","testEnvironmentOptions","create"],"mappings":";;;;+BAmFgBA;;;eAAAA;;;6BAzET;AAEP,MAAMC,gCAAgCC,IAAAA,iBAAI,EAAC;IACzCC,yBAAyBC,IAAAA,qBAAQ,EAACC,IAAAA,mBAAM;IACxCC,cAAcF,IAAAA,qBAAQ,EAACC,IAAAA,mBAAM;IAC7BE,WAAWC,IAAAA,sBAAS,EAACC,IAAAA,oBAAO,KAAI;IAEhCC,QAAQF,IAAAA,sBAAS,EACfG,IAAAA,mBAAM,EAAC;QACLC,SAASJ,IAAAA,sBAAS,EAACC,IAAAA,oBAAO,KAAI;QAC9BI,MAAML,IAAAA,sBAAS,EAACM,IAAAA,mBAAM,KAAI;QAC1BC,MAAMP,IAAAA,sBAAS,EAACH,IAAAA,mBAAM,KAAIW,QAAQC,GAAG;IACvC,IACA,CAAC;IAGHC,SAASV,IAAAA,sBAAS,EAChBG,IAAAA,mBAAM,EAAC;QACLQ,UAAUX,IAAAA,sBAAS,EAACC,IAAAA,oBAAO,KAAI;IACjC,IACA,CAAC;AAEL;AAmDO,SAAST,WAAWoB,sBAA+C;IACxE,OAAOC,IAAAA,mBAAM,EAACD,wBAAwBnB;AACxC"}

package/dist/cjs/setup.js

@@ -0,0 +1,10 @@
+// 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
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+require("./matchers");
+
+//# sourceMappingURL=setup.js.map

package/dist/cjs/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/setup.ts"],"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"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,gDAAgD;AAEhD,uDAAuD;;;;;QAChD"}

package/dist/cjs/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "NotificationType", {
+    enumerable: true,
+    get: function() {
+        return _rpcmethods.NotificationType;
+    }
+});
+const _rpcmethods = require("@metamask/rpc-methods");
+
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import { NotificationType } from '@metamask/rpc-methods';\nimport { Component } from '@metamask/snaps-ui';\nimport { EnumToUnion } from '@metamask/snaps-utils';\nimport { JsonRpcId, JsonRpcParams } from '@metamask/utils';\nimport { Infer } from 'superstruct';\n\nimport {\n  Mock,\n  MockJsonRpcOptions,\n  MockOptions,\n  SnapOptionsStruct,\n  SnapResponseStruct,\n  TransactionOptionsStruct,\n} from './internals';\n\n/* eslint-disable @typescript-eslint/consistent-type-definitions */\ndeclare module 'expect' {\n  interface AsymmetricMatchers {\n    toRespondWith(response: unknown): void;\n    toRespondWithError(error: unknown): void;\n    toSendNotification(\n      message: string,\n      type?: EnumToUnion<NotificationType>,\n    ): void;\n    toRender(component: Component): void;\n  }\n\n  // Ideally we would use `Matchers<Result>` instead of `Matchers<R>`, but\n  // TypeScript doesn't allow this:\n  // TS2428: All declarations of 'Matchers' must have identical type parameters.\n  interface Matchers<R> {\n    toRespondWith(response: unknown): R;\n    toRespondWithError(error: unknown): R;\n    toSendNotification(\n      message: string,\n      type?: EnumToUnion<NotificationType>,\n    ): R;\n    toRender(component: Component): R;\n  }\n}\n/* eslint-enable @typescript-eslint/consistent-type-definitions */\n\n/**\n * Deeply partialize a type.\n *\n * @template Type - The type to partialize.\n * @returns The deeply partialized type.\n * @example\n * ```ts\n * type Foo = {\n *   bar: {\n *     baz: string;\n *   };\n *   qux: number;\n * };\n *\n * type PartialFoo = DeepPartial<Foo>;\n * // { bar?: { baz?: string; }; qux?: number; }\n * ```\n */\nexport type DeepPartial<Type> = {\n  [Key in keyof Type]?: Type[Key] extends Record<string, unknown>\n    ? DeepPartial<Type[Key]>\n    : Type[Key];\n};\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 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 * 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: Component;\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: Component;\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: Component;\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\nexport type SnapInterface =\n  | SnapAlertInterface\n  | SnapConfirmationInterface\n  | SnapPromptInterface;\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 * 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 * ```ts\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 * ```\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  sendTransaction(\n    transaction?: Partial<TransactionOptions>,\n  ): Promise<SnapResponse>;\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  runCronjob(cronjob: CronjobOptions): SnapRequest;\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   */\n  // TODO: Find a way to do this automatically.\n  close(): Promise<void>;\n\n  /**\n   * Enable network mocking for the snap.\n   *\n   * @param options - The options for the network mocking.\n   * @returns A {@link Mock} object, with an `unmock` function.\n   */\n  mock(options: DeepPartial<MockOptions>): Promise<Mock>;\n\n  /**\n   * Enable JSON-RPC provider mocking for the snap. This will mock any requests\n   * sent through the `ethereum` global, with the specified `method`.\n   *\n   * @param options - The options for the JSON-RPC mocking.\n   * @param options.method - The JSON-RPC method to mock, e.g.,\n   * `eth_blockNumber`.\n   * @param options.result - The JSON value to return.\n   * @returns A {@link Mock} object, with an `unmock` function.\n   */\n  mockJsonRpc(options: MockJsonRpcOptions): Promise<Mock>;\n};\n\nexport type SnapResponse = Infer<typeof SnapResponseStruct>;\n\nexport { NotificationType } from '@metamask/rpc-methods';\n"],"names":["NotificationType"],"mappings":";;;;+BA2SSA;;;eAAAA,4BAAgB;;;4BAAQ"}

package/dist/esm/environment.js

@@ -0,0 +1,182 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { assert, createModuleLogger } from '@metamask/utils';
+import NodeEnvironment from 'jest-environment-node';
+import { remote } from 'webdriverio';
+import { rootLogger, startServer } from './internals';
+import { getOptions } from './options';
+/* eslint-enable */ const log = createModuleLogger(rootLogger, 'environment');
+var _options = /*#__PURE__*/ new WeakMap(), _server = /*#__PURE__*/ new WeakMap();
+export class SnapsEnvironment extends NodeEnvironment {
+    /**
+   * Set up the environment. This starts the built-in HTTP server, and creates a
+   * new browser instance.
+   */ async setup() {
+        await super.setup();
+        if (_class_private_field_get(this, _options).server.enabled) {
+            log('Starting server.');
+            _class_private_field_set(this, _server, await startServer(_class_private_field_get(this, _options).server));
+        }
+        const args = [];
+        if (_class_private_field_get(this, _options).browser.headless) {
+            args.push('--headless', '--disable-gpu');
+        }
+        log('Starting browser.');
+        this.browser = await remote({
+            logLevel: 'error',
+            capabilities: {
+                browserName: 'chrome',
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                'goog:chromeOptions': {
+                    args
+                }
+            }
+        });
+        this.global.browser = this.browser;
+        this.global.snapsEnvironment = this;
+    }
+    /**
+   * Tear down the environment. This closes the browser, and stops the built-in
+   * HTTP server.
+   */ async teardown() {
+        if (_class_private_field_get(this, _options).keepAlive) {
+            log('Not tearing down environment because keepAlive is enabled.');
+            return;
+        }
+        log('Closing browser, and stopping server.');
+        await this.browser?.deleteSession();
+        _class_private_field_get(this, _server)?.close();
+        await super.teardown();
+    }
+    /**
+   * Get the URL to the simulator, including the environment URL.
+   *
+   * @returns The simulator URL.
+   * @throws If the server is not running.
+   */ get url() {
+        assert(_class_private_field_get(this, _server), 'Server is not running.');
+        const { port } = _class_private_field_get(this, _server).address();
+        const simulatorUrl = _class_private_field_get(this, _options).simulatorUrl ?? `http://localhost:${port}/simulator/`;
+        const executionEnvironmentUrl = _class_private_field_get(this, _options).executionEnvironmentUrl ?? `http://localhost:${port}/environment/`;
+        return `${simulatorUrl}?environment=${encodeURIComponent(executionEnvironmentUrl)}`;
+    }
+    /**
+   * Get the snap ID for the current environment, which is used if no snap ID is
+   * passed to {@link installSnap}. This assumes that the built-in server is
+   * running.
+   *
+   * @returns The snap ID.
+   * @throws If the server is not running.
+   */ get snapId() {
+        assert(_class_private_field_get(this, _server), 'You must specify a snap ID, because the built-in server is not running.');
+        const { port } = _class_private_field_get(this, _server).address();
+        return `local:http://localhost:${port}`;
+    }
+    /**
+   * Create a new page, and attach logging handlers.
+   *
+   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,
+   * or the default simulator URL if none is specified.
+   * @param timeout - The page timeout, in milliseconds.
+   * @returns The new page.
+   */ async createPage(url = this.url, timeout = 10000) {
+        const puppeteer = await this.browser.getPuppeteer();
+        const page = await puppeteer.newPage();
+        page.setDefaultTimeout(timeout);
+        page.setDefaultNavigationTimeout(timeout);
+        // Give the page permission to show notifications. This is required for
+        // testing `snap_notify`.
+        await page.browserContext().overridePermissions(url, [
+            'notifications'
+        ]);
+        // `networkidle0` is used to ensure that the page is fully loaded. This
+        // makes it wait for no requests to be made, which guarantees that the page
+        // is ready.
+        await page.goto(url, {
+            waitUntil: 'networkidle0'
+        });
+        const browserLog = createModuleLogger(rootLogger, 'browser');
+        page// This is fired when the page calls `console.log` or similar.
+        .on('console', (message)=>{
+            browserLog(`[${message.type()}] ${message.text()}`);
+        })// This is fired when the page throws an error.
+        .on('pageerror', ({ message })=>{
+            browserLog(`[page error] ${message}`);
+        });
+        return page;
+    }
+    /**
+   * Constructor.
+   *
+   * @param options - The environment options.
+   * @param context - The environment context.
+   */ constructor(options, context){
+        super(options, context);
+        // `browser` is always set in the environment setup function. To avoid needing
+        // to check for `undefined` everywhere, we use a type assertion here.
+        _define_property(this, "browser", void 0);
+        _class_private_field_init(this, _options, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _server, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_set(this, _options, getOptions(options.projectConfig.testEnvironmentOptions));
+    }
+}
+export default SnapsEnvironment;
+
+//# sourceMappingURL=environment.js.map

package/dist/esm/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/environment.ts"],"sourcesContent":["import { EnvironmentContext, JestEnvironmentConfig } from '@jest/environment';\nimport { assert, createModuleLogger } from '@metamask/utils';\nimport { Server } from 'http';\nimport NodeEnvironment from 'jest-environment-node';\nimport { AddressInfo } from 'net';\nimport { Browser } from 'puppeteer';\nimport { remote } from 'webdriverio';\n\nimport { rootLogger, startServer } from './internals';\nimport { getOptions, SnapsEnvironmentOptions } from './options';\n\n/* eslint-disable */\ndeclare global {\n  const browser: WebdriverIO.Browser;\n  const snapsEnvironment: SnapsEnvironment;\n}\n/* eslint-enable */\n\nconst log = createModuleLogger(rootLogger, 'environment');\n\nexport class SnapsEnvironment extends NodeEnvironment {\n  // `browser` is always set in the environment setup function. To avoid needing\n  // to check for `undefined` everywhere, we use a type assertion here.\n  browser!: WebdriverIO.Browser;\n\n  #options: SnapsEnvironmentOptions;\n\n  #server: Server | undefined;\n\n  /**\n   * Constructor.\n   *\n   * @param options - The environment options.\n   * @param context - The environment context.\n   */\n  constructor(options: JestEnvironmentConfig, context: EnvironmentContext) {\n    super(options, context);\n    this.#options = getOptions(options.projectConfig.testEnvironmentOptions);\n  }\n\n  /**\n   * Set up the environment. This starts the built-in HTTP server, and creates a\n   * new browser instance.\n   */\n  async setup() {\n    await super.setup();\n\n    if (this.#options.server.enabled) {\n      log('Starting server.');\n      this.#server = await startServer(this.#options.server);\n    }\n\n    const args = [];\n    if (this.#options.browser.headless) {\n      args.push('--headless', '--disable-gpu');\n    }\n\n    log('Starting browser.');\n    this.browser = await remote({\n      logLevel: 'error',\n      capabilities: {\n        browserName: 'chrome',\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        'goog:chromeOptions': {\n          args,\n        },\n      },\n    });\n\n    this.global.browser = this.browser;\n    this.global.snapsEnvironment = this;\n  }\n\n  /**\n   * Tear down the environment. This closes the browser, and stops the built-in\n   * HTTP server.\n   */\n  async teardown() {\n    if (this.#options.keepAlive) {\n      log('Not tearing down environment because keepAlive is enabled.');\n      return;\n    }\n\n    log('Closing browser, and stopping server.');\n    await this.browser?.deleteSession();\n    this.#server?.close();\n\n    await super.teardown();\n  }\n\n  /**\n   * Get the URL to the simulator, including the environment URL.\n   *\n   * @returns The simulator URL.\n   * @throws If the server is not running.\n   */\n  get url() {\n    assert(this.#server, 'Server is not running.');\n\n    const { port } = this.#server.address() as AddressInfo;\n    const simulatorUrl =\n      this.#options.simulatorUrl ?? `http://localhost:${port}/simulator/`;\n\n    const executionEnvironmentUrl =\n      this.#options.executionEnvironmentUrl ??\n      `http://localhost:${port}/environment/`;\n\n    return `${simulatorUrl}?environment=${encodeURIComponent(\n      executionEnvironmentUrl,\n    )}`;\n  }\n\n  /**\n   * Get the snap ID for the current environment, which is used if no snap ID is\n   * passed to {@link installSnap}. This assumes that the built-in server is\n   * running.\n   *\n   * @returns The snap ID.\n   * @throws If the server is not running.\n   */\n  get snapId() {\n    assert(\n      this.#server,\n      'You must specify a snap ID, because the built-in server is not running.',\n    );\n\n    const { port } = this.#server.address() as AddressInfo;\n    return `local:http://localhost:${port}`;\n  }\n\n  /**\n   * Create a new page, and attach logging handlers.\n   *\n   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,\n   * or the default simulator URL if none is specified.\n   * @param timeout - The page timeout, in milliseconds.\n   * @returns The new page.\n   */\n  async createPage(url: string = this.url, timeout = 10000) {\n    const puppeteer = (await this.browser.getPuppeteer()) as unknown as Browser;\n    const page = await puppeteer.newPage();\n\n    page.setDefaultTimeout(timeout);\n    page.setDefaultNavigationTimeout(timeout);\n\n    // Give the page permission to show notifications. This is required for\n    // testing `snap_notify`.\n    await page.browserContext().overridePermissions(url, ['notifications']);\n\n    // `networkidle0` is used to ensure that the page is fully loaded. This\n    // makes it wait for no requests to be made, which guarantees that the page\n    // is ready.\n    await page.goto(url, { waitUntil: 'networkidle0' });\n\n    const browserLog = createModuleLogger(rootLogger, 'browser');\n\n    page\n      // This is fired when the page calls `console.log` or similar.\n      .on('console', (message) => {\n        browserLog(`[${message.type()}] ${message.text()}`);\n      })\n\n      // This is fired when the page throws an error.\n      .on('pageerror', ({ message }) => {\n        browserLog(`[page error] ${message}`);\n      });\n\n    return page;\n  }\n}\n\nexport default SnapsEnvironment;\n"],"names":["assert","createModuleLogger","NodeEnvironment","remote","rootLogger","startServer","getOptions","log","SnapsEnvironment","setup","options","server","enabled","args","browser","headless","push","logLevel","capabilities","browserName","global","snapsEnvironment","teardown","keepAlive","deleteSession","close","url","port","address","simulatorUrl","executionEnvironmentUrl","encodeURIComponent","snapId","createPage","timeout","puppeteer","getPuppeteer","page","newPage","setDefaultTimeout","setDefaultNavigationTimeout","browserContext","overridePermissions","goto","waitUntil","browserLog","on","message","type","text","constructor","context","projectConfig","testEnvironmentOptions"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,MAAM,EAAEC,kBAAkB,QAAQ,kBAAkB;AAE7D,OAAOC,qBAAqB,wBAAwB;AAGpD,SAASC,MAAM,QAAQ,cAAc;AAErC,SAASC,UAAU,EAAEC,WAAW,QAAQ,cAAc;AACtD,SAASC,UAAU,QAAiC,YAAY;AAOhE,iBAAiB,GAEjB,MAAMC,MAAMN,mBAAmBG,YAAY;IAOzC,wCAEA;AAPF,OAAO,MAAMI,yBAAyBN;IAoBpC;;;GAGC,GACD,MAAMO,QAAQ;QACZ,MAAM,KAAK,CAACA;QAEZ,IAAI,yBAAA,IAAI,EAAEC,UAAQC,MAAM,CAACC,OAAO,EAAE;YAChCL,IAAI;2CACEI,SAAS,MAAMN,YAAY,yBAAA,IAAI,EAAEK,UAAQC,MAAM;QACvD;QAEA,MAAME,OAAO,EAAE;QACf,IAAI,yBAAA,IAAI,EAAEH,UAAQI,OAAO,CAACC,QAAQ,EAAE;YAClCF,KAAKG,IAAI,CAAC,cAAc;QAC1B;QAEAT,IAAI;QACJ,IAAI,CAACO,OAAO,GAAG,MAAMX,OAAO;YAC1Bc,UAAU;YACVC,cAAc;gBACZC,aAAa;gBACb,gEAAgE;gBAChE,sBAAsB;oBACpBN;gBACF;YACF;QACF;QAEA,IAAI,CAACO,MAAM,CAACN,OAAO,GAAG,IAAI,CAACA,OAAO;QAClC,IAAI,CAACM,MAAM,CAACC,gBAAgB,GAAG,IAAI;IACrC;IAEA;;;GAGC,GACD,MAAMC,WAAW;QACf,IAAI,yBAAA,IAAI,EAAEZ,UAAQa,SAAS,EAAE;YAC3BhB,IAAI;YACJ;QACF;QAEAA,IAAI;QACJ,MAAM,IAAI,CAACO,OAAO,EAAEU;iCACpB,IAAI,EAAEb,UAAQc;QAEd,MAAM,KAAK,CAACH;IACd;IAEA;;;;;GAKC,GACD,IAAII,MAAM;QACR1B,gCAAO,IAAI,EAAEW,UAAQ;QAErB,MAAM,EAAEgB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEhB,SAAOiB,OAAO;QACrC,MAAMC,eACJ,yBAAA,IAAI,EAAEnB,UAAQmB,YAAY,IAAI,CAAC,iBAAiB,EAAEF,KAAK,WAAW,CAAC;QAErE,MAAMG,0BACJ,yBAAA,IAAI,EAAEpB,UAAQoB,uBAAuB,IACrC,CAAC,iBAAiB,EAAEH,KAAK,aAAa,CAAC;QAEzC,OAAO,CAAC,EAAEE,aAAa,aAAa,EAAEE,mBACpCD,yBACA,CAAC;IACL;IAEA;;;;;;;GAOC,GACD,IAAIE,SAAS;QACXhC,gCACE,IAAI,EAAEW,UACN;QAGF,MAAM,EAAEgB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEhB,SAAOiB,OAAO;QACrC,OAAO,CAAC,uBAAuB,EAAED,KAAK,CAAC;IACzC;IAEA;;;;;;;GAOC,GACD,MAAMM,WAAWP,MAAc,IAAI,CAACA,GAAG,EAAEQ,UAAU,KAAK,EAAE;QACxD,MAAMC,YAAa,MAAM,IAAI,CAACrB,OAAO,CAACsB,YAAY;QAClD,MAAMC,OAAO,MAAMF,UAAUG,OAAO;QAEpCD,KAAKE,iBAAiB,CAACL;QACvBG,KAAKG,2BAA2B,CAACN;QAEjC,uEAAuE;QACvE,yBAAyB;QACzB,MAAMG,KAAKI,cAAc,GAAGC,mBAAmB,CAAChB,KAAK;YAAC;SAAgB;QAEtE,uEAAuE;QACvE,2EAA2E;QAC3E,YAAY;QACZ,MAAMW,KAAKM,IAAI,CAACjB,KAAK;YAAEkB,WAAW;QAAe;QAEjD,MAAMC,aAAa5C,mBAAmBG,YAAY;QAElDiC,IACE,8DAA8D;SAC7DS,EAAE,CAAC,WAAW,CAACC;YACdF,WAAW,CAAC,CAAC,EAAEE,QAAQC,IAAI,GAAG,EAAE,EAAED,QAAQE,IAAI,GAAG,CAAC;QACpD,EAEA,+CAA+C;SAC9CH,EAAE,CAAC,aAAa,CAAC,EAAEC,OAAO,EAAE;YAC3BF,WAAW,CAAC,aAAa,EAAEE,QAAQ,CAAC;QACtC;QAEF,OAAOV;IACT;IA3IA;;;;;GAKC,GACDa,YAAYxC,OAA8B,EAAEyC,OAA2B,CAAE;QACvE,KAAK,CAACzC,SAASyC;QAfjB,8EAA8E;QAC9E,qEAAqE;QACrErC,uBAAAA,WAAAA,KAAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAUQJ,UAAUJ,WAAWI,QAAQ0C,aAAa,CAACC,sBAAsB;IACzE;AAmIF;AAEA,eAAe7C,iBAAiB"}

package/dist/esm/helpers.js

@@ -0,0 +1,82 @@
+import { createModuleLogger } from '@metamask/utils';
+import { getDocument, queries } from 'pptr-testing-library';
+import { getEnvironment, mock, waitFor, request, sendTransaction, runCronjob, mockJsonRpc, rootLogger } from './internals';
+// eslint-disable-next-line @typescript-eslint/unbound-method
+const { getByTestId } = queries;
+const log = createModuleLogger(rootLogger, 'helpers');
+/**
+ * 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
+ * ```ts
+ * 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.
+ * @returns The snap.
+ * @throws If the built-in server is not running, and no snap ID is provided.
+ */ export async function installSnap(snapId = getEnvironment().snapId) {
+    const environment = getEnvironment();
+    log('Installing snap %s.', snapId);
+    const page = await environment.createPage();
+    const document = await getDocument(page);
+    log('Setting snap ID to %s.', snapId);
+    await page.evaluate((payload)=>{
+        window.__SIMULATOR_API__.dispatch({
+            type: 'configuration/setSnapId',
+            payload
+        });
+    }, snapId);
+    log('Waiting for snap to install.');
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    await waitFor(async ()=>await getByTestId(document, 'status-ok'), {
+        timeout: 10000,
+        message: `Timed out waiting for snap to install. Make sure the snap ID ("${snapId}") is correct, and the server is running.`
+    });
+    return {
+        request: (options)=>{
+            log('Sending request %o.', options);
+            // Note: This function is intentionally not async, so that we can access
+            // the `getInterface` method on the response.
+            return request(page, options);
+        },
+        sendTransaction: async (options = {})=>{
+            log('Sending transaction %o.', options);
+            return await sendTransaction(page, options);
+        },
+        runCronjob: (options)=>{
+            log('Running cronjob %o.', options);
+            // Note: This function is intentionally not async, so that we can access
+            // the `getInterface` method on the response.
+            return runCronjob(page, options);
+        },
+        close: async ()=>{
+            log('Closing page.');
+            await page.close();
+        },
+        mock: async (options)=>{
+            log('Mocking %o.', options);
+            return await mock(page, options);
+        },
+        mockJsonRpc: async (options)=>{
+            log('Mocking JSON-RPC %o.', options);
+            return await mockJsonRpc(page, options);
+        }
+    };
+}
+
+//# sourceMappingURL=helpers.js.map

package/dist/esm/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/helpers.ts"],"sourcesContent":["import { createModuleLogger } from '@metamask/utils';\nimport { getDocument, queries } from 'pptr-testing-library';\n\nimport {\n  getEnvironment,\n  mock,\n  waitFor,\n  request,\n  sendTransaction,\n  runCronjob,\n  mockJsonRpc,\n  rootLogger,\n} from './internals';\nimport type { Snap, SnapResponse } from './types';\n\n// eslint-disable-next-line @typescript-eslint/unbound-method\nconst { getByTestId } = queries;\n\nconst log = createModuleLogger(rootLogger, 'helpers');\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 * ```ts\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 * ```\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 * @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  snapId: string = getEnvironment().snapId,\n): Promise<Snap> {\n  const environment = getEnvironment();\n\n  log('Installing snap %s.', snapId);\n\n  const page = await environment.createPage();\n  const document = await getDocument(page);\n\n  log('Setting snap ID to %s.', snapId);\n  await page.evaluate((payload) => {\n    window.__SIMULATOR_API__.dispatch({\n      type: 'configuration/setSnapId',\n      payload,\n    });\n  }, snapId);\n\n  log('Waiting for snap to install.');\n  // eslint-disable-next-line @typescript-eslint/no-misused-promises\n  await waitFor(async () => await getByTestId(document, 'status-ok'), {\n    timeout: 10000,\n    message: `Timed out waiting for snap to install. Make sure the snap ID (\"${snapId}\") is correct, and the server is running.`,\n  });\n\n  return {\n    request: (options) => {\n      log('Sending request %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return request(page, options);\n    },\n\n    sendTransaction: async (options = {}): Promise<SnapResponse> => {\n      log('Sending transaction %o.', options);\n\n      return await sendTransaction(page, options);\n    },\n\n    runCronjob: (options) => {\n      log('Running cronjob %o.', options);\n\n      // Note: This function is intentionally not async, so that we can access\n      // the `getInterface` method on the response.\n      return runCronjob(page, options);\n    },\n\n    close: async () => {\n      log('Closing page.');\n\n      await page.close();\n    },\n\n    mock: async (options) => {\n      log('Mocking %o.', options);\n\n      return await mock(page, options);\n    },\n\n    mockJsonRpc: async (options) => {\n      log('Mocking JSON-RPC %o.', options);\n\n      return await mockJsonRpc(page, options);\n    },\n  };\n}\n"],"names":["createModuleLogger","getDocument","queries","getEnvironment","mock","waitFor","request","sendTransaction","runCronjob","mockJsonRpc","rootLogger","getByTestId","log","installSnap","snapId","environment","page","createPage","document","evaluate","payload","window","__SIMULATOR_API__","dispatch","type","timeout","message","options","close"],"mappings":"AAAA,SAASA,kBAAkB,QAAQ,kBAAkB;AACrD,SAASC,WAAW,EAAEC,OAAO,QAAQ,uBAAuB;AAE5D,SACEC,cAAc,EACdC,IAAI,EACJC,OAAO,EACPC,OAAO,EACPC,eAAe,EACfC,UAAU,EACVC,WAAW,EACXC,UAAU,QACL,cAAc;AAGrB,6DAA6D;AAC7D,MAAM,EAAEC,WAAW,EAAE,GAAGT;AAExB,MAAMU,MAAMZ,mBAAmBU,YAAY;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;CAyBC,GACD,OAAO,eAAeG,YACpBC,SAAiBX,iBAAiBW,MAAM;IAExC,MAAMC,cAAcZ;IAEpBS,IAAI,uBAAuBE;IAE3B,MAAME,OAAO,MAAMD,YAAYE,UAAU;IACzC,MAAMC,WAAW,MAAMjB,YAAYe;IAEnCJ,IAAI,0BAA0BE;IAC9B,MAAME,KAAKG,QAAQ,CAAC,CAACC;QACnBC,OAAOC,iBAAiB,CAACC,QAAQ,CAAC;YAChCC,MAAM;YACNJ;QACF;IACF,GAAGN;IAEHF,IAAI;IACJ,kEAAkE;IAClE,MAAMP,QAAQ,UAAY,MAAMM,YAAYO,UAAU,cAAc;QAClEO,SAAS;QACTC,SAAS,CAAC,+DAA+D,EAAEZ,OAAO,yCAAyC,CAAC;IAC9H;IAEA,OAAO;QACLR,SAAS,CAACqB;YACRf,IAAI,uBAAuBe;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOrB,QAAQU,MAAMW;QACvB;QAEApB,iBAAiB,OAAOoB,UAAU,CAAC,CAAC;YAClCf,IAAI,2BAA2Be;YAE/B,OAAO,MAAMpB,gBAAgBS,MAAMW;QACrC;QAEAnB,YAAY,CAACmB;YACXf,IAAI,uBAAuBe;YAE3B,wEAAwE;YACxE,6CAA6C;YAC7C,OAAOnB,WAAWQ,MAAMW;QAC1B;QAEAC,OAAO;YACLhB,IAAI;YAEJ,MAAMI,KAAKY,KAAK;QAClB;QAEAxB,MAAM,OAAOuB;YACXf,IAAI,eAAee;YAEnB,OAAO,MAAMvB,KAAKY,MAAMW;QAC1B;QAEAlB,aAAa,OAAOkB;YAClBf,IAAI,wBAAwBe;YAE5B,OAAO,MAAMlB,YAAYO,MAAMW;QACjC;IACF;AACF"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export { default, default as TestEnvironment } from './environment';
+export * from './helpers';
+export * from './options';
+export * from './types';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export { default, default as TestEnvironment } from './environment';\nexport * from './helpers';\nexport * from './options';\nexport * from './types';\n"],"names":["default","TestEnvironment"],"mappings":"AAAA,SAASA,OAAO,EAAEA,WAAWC,eAAe,QAAQ,gBAAgB;AACpE,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,UAAU"}

package/dist/esm/internals/environment.js

@@ -0,0 +1,14 @@
+import { assert } from '@metamask/utils';
+/**
+ * Get the Snaps environment. This asserts that the environment has been
+ * configured.
+ *
+ * @returns The Snaps environment.
+ */ export function getEnvironment() {
+    // `snapsEnvironment` is a global variable that is set by the Jest
+    // environment.
+    assert(snapsEnvironment, 'Snaps environment not found. Make sure you have configured the environment correctly.');
+    return snapsEnvironment;
+}
+
+//# sourceMappingURL=environment.js.map

package/dist/esm/internals/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/internals/environment.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\n\n/**\n * Get the Snaps environment. This asserts that the environment has been\n * configured.\n *\n * @returns The Snaps environment.\n */\nexport function getEnvironment() {\n  // `snapsEnvironment` is a global variable that is set by the Jest\n  // environment.\n  assert(\n    snapsEnvironment,\n    'Snaps environment not found. Make sure you have configured the environment correctly.',\n  );\n\n  return snapsEnvironment;\n}\n"],"names":["assert","getEnvironment","snapsEnvironment"],"mappings":"AAAA,SAASA,MAAM,QAAQ,kBAAkB;AAEzC;;;;;CAKC,GACD,OAAO,SAASC;IACd,kEAAkE;IAClE,eAAe;IACfD,OACEE,kBACA;IAGF,OAAOA;AACT"}

package/dist/esm/internals/index.js

@@ -0,0 +1,12 @@
+export * from './environment';
+export * from './interface';
+export * from './logger';
+export * from './network';
+export * from './request';
+export * from './server';
+export * from './structs';
+// eslint-disable-next-line import/export
+export * from './types';
+export * from './wait-for';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/internals/index.ts"],"sourcesContent":["export * from './environment';\nexport * from './interface';\nexport * from './logger';\nexport * from './network';\nexport * from './request';\nexport * from './server';\nexport * from './structs';\n// eslint-disable-next-line import/export\nexport * from './types';\nexport * from './wait-for';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB;AAC9B,cAAc,cAAc;AAC5B,cAAc,WAAW;AACzB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,WAAW;AACzB,cAAc,YAAY;AAC1B,yCAAyC;AACzC,cAAc,UAAU;AACxB,cAAc,aAAa"}