@metamask/snaps-jest 8.3.0 → 8.3.1

package/dist/matchers.cjs

@@ -0,0 +1,160 @@
+"use strict";
+/* eslint-disable no-invalid-this */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toRender = exports.toSendNotification = exports.toRespondWithError = exports.toRespondWith = void 0;
+const globals_1 = require("@jest/globals");
+const jsx_1 = require("@metamask/snaps-sdk/jsx");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const jest_matcher_utils_1 = require("jest-matcher-utils");
+const internals_1 = require("./internals/index.cjs");
+/**
+ * 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_1.is)(actual, internals_1.SnapResponseStruct)) {
+        throw new Error((0, jest_matcher_utils_1.matcherErrorMessage)((0, jest_matcher_utils_1.matcherHint)(matcherName, undefined, undefined, options), `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} value must be a response from the \`request\` function`, (0, jest_matcher_utils_1.printWithType)('Received', actual, jest_matcher_utils_1.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_1.is)(actual, internals_1.InterfaceStruct) || !actual.content) {
+        throw new Error((0, jest_matcher_utils_1.matcherErrorMessage)((0, jest_matcher_utils_1.matcherHint)(matcherName, undefined, undefined, options), `${(0, jest_matcher_utils_1.RECEIVED_COLOR)('received')} value must have a \`content\` property`, (0, jest_matcher_utils_1.printWithType)('Received', actual, jest_matcher_utils_1.printReceived)));
+    }
+}
+/**
+ * Check if a JSON-RPC response matches the expected value. This matcher is
+ * intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected response.
+ * @returns The status and message.
+ */
+const toRespondWith = function (actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWith');
+    const { response } = actual;
+    if ((0, utils_1.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 };
+};
+exports.toRespondWith = toRespondWith;
+const toRespondWithError = function (actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWithError');
+    const { response } = actual;
+    if ((0, utils_1.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 };
+};
+exports.toRespondWithError = toRespondWithError;
+/**
+ * Check if the snap sent a notification with the expected message. This matcher
+ * is intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected notification message.
+ * @param type - The expected notification type.
+ * @returns The status and message.
+ */
+const toSendNotification = 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 };
+};
+exports.toSendNotification = toSendNotification;
+const toRenderLegacy = function (actual, expected) {
+    assertHasInterface(actual, 'toRender');
+    const { content } = actual;
+    const expectedElement = (0, snaps_utils_1.getJsxElementFromComponent)(expected);
+    const pass = this.equals(content, expectedElement);
+    // This is typed as `string | null`, but in practice it's always a string.
+    // The function only returns `null` if both the expected and actual values
+    // are numbers, bigints, or booleans, which is never the case here.
+    const difference = (0, jest_matcher_utils_1.diff)(expectedElement, content);
+    const message = pass
+        ? () => `${this.utils.matcherHint('.not.toRender')}\n\n` +
+            `Expected:\n${this.utils.printExpected(expectedElement)}\n\n` +
+            `Received:\n${this.utils.printReceived(content)}` +
+            `\n\nDifference:\n\n${difference}`
+        : () => `${this.utils.matcherHint('.toRender')}\n\n` +
+            `Expected:\n${this.utils.printExpected(expectedElement)}\n\n` +
+            `Received:\n${this.utils.printReceived(content)}` +
+            `\n\nDifference:\n\n${difference}`;
+    return { message, pass };
+};
+const toRender = function (actual, expected) {
+    assertHasInterface(actual, 'toRender');
+    if (!(0, jsx_1.isJSXElementUnsafe)(expected)) {
+        return toRenderLegacy.call(this, actual, expected);
+    }
+    const { content } = actual;
+    const pass = this.equals(content, expected);
+    // This is typed as `string | null`, but in practice it's always a string.
+    // The function only returns `null` if both the expected and actual values
+    // are numbers, bigints, or booleans, which is never the case here.
+    const difference = (0, jest_matcher_utils_1.diff)((0, snaps_utils_1.serialiseJsx)(expected), (0, snaps_utils_1.serialiseJsx)(content));
+    const message = pass
+        ? () => `${this.utils.matcherHint('.not.toRender')}\n\n` +
+            `Expected:\n${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, snaps_utils_1.serialiseJsx)(expected))}\n\n` +
+            `Received:\n${(0, jest_matcher_utils_1.RECEIVED_COLOR)((0, snaps_utils_1.serialiseJsx)(content))}` +
+            `\n\nDifference:\n\n${difference}`
+        : () => `${this.utils.matcherHint('.toRender')}\n\n` +
+            `Expected:\n${(0, jest_matcher_utils_1.EXPECTED_COLOR)((0, snaps_utils_1.serialiseJsx)(expected))}\n\n` +
+            `Received:\n${(0, jest_matcher_utils_1.RECEIVED_COLOR)((0, snaps_utils_1.serialiseJsx)(content))}` +
+            `\n\nDifference:\n\n${difference}`;
+    return { message, pass };
+};
+exports.toRender = toRender;
+globals_1.expect.extend({
+    toRespondWith: exports.toRespondWith,
+    toRespondWithError: exports.toRespondWithError,
+    toSendNotification: exports.toSendNotification,
+    toRender: exports.toRender,
+});
+//# sourceMappingURL=matchers.cjs.map

package/dist/matchers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.cjs","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;AAMpC,2CAAuC;AAQvC,iDAA6D;AAC7D,uDAG+B;AAC/B,uDAA2C;AAE3C,2CAA8C;AAE9C,2DAQ4B;AAE5B,qDAAkE;AAGlE;;;;;;GAMG;AACH,SAAS,0BAA0B,CACjC,MAAe,EACf,WAAmB,EACnB,OAA4B;IAE5B,IAAI,CAAC,IAAA,gBAAE,EAAC,MAAM,EAAE,8BAAkB,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CACb,IAAA,wCAAmB,EACjB,IAAA,gCAAW,EAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACvD,GAAG,IAAA,mCAAc,EACf,UAAU,CACX,yDAAyD,EAC1D,IAAA,kCAAa,EAAC,UAAU,EAAE,MAAM,EAAE,kCAAa,CAAC,CACjD,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CACzB,MAAe,EACf,WAAmB,EACnB,OAA4B;IAE5B,IAAI,CAAC,IAAA,gBAAE,EAAC,MAAM,EAAE,2BAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,IAAA,wCAAmB,EACjB,IAAA,gCAAW,EAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACvD,GAAG,IAAA,mCAAc,EAAC,UAAU,CAAC,yCAAyC,EACtE,IAAA,kCAAa,EAAC,UAAU,EAAE,MAAM,EAAE,kCAAa,CAAC,CACjD,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACI,MAAM,aAAa,GAAsC,UAC9D,MAAM,EACN,QAAQ;IAER,0BAA0B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEpD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,IAAI,IAAA,mBAAW,EAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM;YACjD,sBAAsB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YAC5D,mBAAmB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAEhE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,MAAM;YACrD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC5D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM;YACjD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;IAE/D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AA5BW,QAAA,aAAa,iBA4BxB;AAEK,MAAM,kBAAkB,GAAsC,UACnE,MAAM,EACN,QAAQ;IAER,0BAA0B,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAEzD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,IAAI,IAAA,mBAAW,EAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,mBAAmB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACzD,oBAAoB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAElE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,yBAAyB,CAAC,MAAM;YAC1D,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QAC3D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IAE9D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AA5BW,QAAA,kBAAkB,sBA4B7B;AAEF;;;;;;;;GAQG;AACI,MAAM,kBAAkB,GAE3B,UAAU,MAAM,EAAE,QAAQ,EAAE,IAAI;IAClC,0BAA0B,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAEzD,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;IACjC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAC7B,CAAC,YAAY,EAAE,EAAE,CACf,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC3C,CAAC,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,CAAC,CACrD,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,yBAAyB,CAAC,MAAM;YAC1D,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,kBAAkB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI;YACpD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;QAC1D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,kBAAkB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI;YACpD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;IAE7D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAzBW,QAAA,kBAAkB,sBAyB7B;AAEF,MAAM,cAAc,GAA2C,UAC7D,MAAM,EACN,QAAQ;IAER,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEvC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,eAAe,GAAG,IAAA,wCAA0B,EAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAEnD,0EAA0E;IAC1E,0EAA0E;IAC1E,mEAAmE;IACnE,MAAM,UAAU,GAAG,IAAA,yBAAI,EAAC,eAAe,EAAE,OAAO,CAAW,CAAC;IAE5D,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM;YAChD,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM;YAC7D,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;YACjD,sBAAsB,UAAU,EAAE;QACtC,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM;YAC5C,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM;YAC7D,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;YACjD,sBAAsB,UAAU,EAAE,CAAC;IAEzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEK,MAAM,QAAQ,GACnB,UAAU,MAAM,EAAE,QAAQ;IACxB,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEvC,IAAI,CAAC,IAAA,wBAAkB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE5C,0EAA0E;IAC1E,0EAA0E;IAC1E,mEAAmE;IACnE,MAAM,UAAU,GAAG,IAAA,yBAAI,EACrB,IAAA,0BAAY,EAAC,QAAQ,CAAC,EACtB,IAAA,0BAAY,EAAC,OAAO,CAAC,CACZ,CAAC;IAEZ,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM;YAChD,cAAc,IAAA,mCAAc,EAAC,IAAA,0BAAY,EAAC,QAAQ,CAAC,CAAC,MAAM;YAC1D,cAAc,IAAA,mCAAc,EAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,CAAC,EAAE;YACrD,sBAAsB,UAAU,EAAE;QACtC,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM;YAC5C,cAAc,IAAA,mCAAc,EAAC,IAAA,0BAAY,EAAC,QAAQ,CAAC,CAAC,MAAM;YAC1D,cAAc,IAAA,mCAAc,EAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,CAAC,EAAE;YACrD,sBAAsB,UAAU,EAAE,CAAC;IAEzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAhCS,QAAA,QAAQ,YAgCjB;AAEJ,gBAAM,CAAC,MAAM,CAAC;IACZ,aAAa,EAAb,qBAAa;IACb,kBAAkB,EAAlB,0BAAkB;IAClB,kBAAkB,EAAlB,0BAAkB;IAClB,QAAQ,EAAR,gBAAQ;CACT,CAAC,CAAC","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 type { MatcherFunction } from '@jest/expect';\nimport { expect } from '@jest/globals';\nimport type {\n  NotificationType,\n  EnumToUnion,\n  ComponentOrElement,\n  Component,\n} from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport { isJSXElementUnsafe } from '@metamask/snaps-sdk/jsx';\nimport {\n  getJsxElementFromComponent,\n  serialiseJsx,\n} from '@metamask/snaps-utils';\nimport { is } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\nimport type { MatcherHintOptions } from 'jest-matcher-utils';\nimport {\n  EXPECTED_COLOR,\n  diff,\n  matcherErrorMessage,\n  matcherHint,\n  printReceived,\n  printWithType,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\n\nimport { InterfaceStruct, SnapResponseStruct } from './internals';\nimport type { 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: JSXElement } {\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> = 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\nconst toRenderLegacy: MatcherFunction<[expected: Component]> = function (\n  actual,\n  expected,\n) {\n  assertHasInterface(actual, 'toRender');\n\n  const { content } = actual;\n  const expectedElement = getJsxElementFromComponent(expected);\n  const pass = this.equals(content, expectedElement);\n\n  // This is typed as `string | null`, but in practice it's always a string.\n  // The function only returns `null` if both the expected and actual values\n  // are numbers, bigints, or booleans, which is never the case here.\n  const difference = diff(expectedElement, content) as string;\n\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toRender')}\\n\\n` +\n        `Expected:\\n${this.utils.printExpected(expectedElement)}\\n\\n` +\n        `Received:\\n${this.utils.printReceived(content)}` +\n        `\\n\\nDifference:\\n\\n${difference}`\n    : () =>\n        `${this.utils.matcherHint('.toRender')}\\n\\n` +\n        `Expected:\\n${this.utils.printExpected(expectedElement)}\\n\\n` +\n        `Received:\\n${this.utils.printReceived(content)}` +\n        `\\n\\nDifference:\\n\\n${difference}`;\n\n  return { message, pass };\n};\n\nexport const toRender: MatcherFunction<[expected: ComponentOrElement]> =\n  function (actual, expected) {\n    assertHasInterface(actual, 'toRender');\n\n    if (!isJSXElementUnsafe(expected)) {\n      return toRenderLegacy.call(this, actual, expected);\n    }\n\n    const { content } = actual;\n    const pass = this.equals(content, expected);\n\n    // This is typed as `string | null`, but in practice it's always a string.\n    // The function only returns `null` if both the expected and actual values\n    // are numbers, bigints, or booleans, which is never the case here.\n    const difference = diff(\n      serialiseJsx(expected),\n      serialiseJsx(content),\n    ) as string;\n\n    const message = pass\n      ? () =>\n          `${this.utils.matcherHint('.not.toRender')}\\n\\n` +\n          `Expected:\\n${EXPECTED_COLOR(serialiseJsx(expected))}\\n\\n` +\n          `Received:\\n${RECEIVED_COLOR(serialiseJsx(content))}` +\n          `\\n\\nDifference:\\n\\n${difference}`\n      : () =>\n          `${this.utils.matcherHint('.toRender')}\\n\\n` +\n          `Expected:\\n${EXPECTED_COLOR(serialiseJsx(expected))}\\n\\n` +\n          `Received:\\n${RECEIVED_COLOR(serialiseJsx(content))}` +\n          `\\n\\nDifference:\\n\\n${difference}`;\n\n    return { message, pass };\n  };\n\nexpect.extend({\n  toRespondWith,\n  toRespondWithError,\n  toSendNotification,\n  toRender,\n});\n"]}

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

@@ -1,6 +1,6 @@
-import type { MatcherFunction } from '@jest/expect';
-import type { NotificationType, EnumToUnion, ComponentOrElement } from '@metamask/snaps-sdk';
-import type { Json } from '@metamask/utils';
+import type { MatcherFunction } from "@jest/expect";
+import type { NotificationType, EnumToUnion, ComponentOrElement } from "@metamask/snaps-sdk";
+import type { Json } from "@metamask/utils";
 /**
  * Check if a JSON-RPC response matches the expected value. This matcher is
  * intended to be used with the `expect` global.
@@ -25,3 +25,4 @@ export declare const toSendNotification: MatcherFunction<[
     type?: EnumToUnion<NotificationType> | undefined
 ]>;
 export declare const toRender: MatcherFunction<[expected: ComponentOrElement]>;
+//# sourceMappingURL=matchers.d.cts.map

package/dist/matchers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.d.cts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB;AAEpD,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAEnB,4BAA4B;AAQ7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAiE5C;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CA4B3D,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CA4BhE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,EAAE,eAAe,CAC9C;IAAC,QAAQ,EAAE,MAAM;IAAE,IAAI,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,GAAG,SAAS;CAAC,CAwBrE,CAAC;AAgCF,eAAO,MAAM,QAAQ,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAgClE,CAAC"}

package/dist/matchers.d.mts

@@ -0,0 +1,28 @@
+import type { MatcherFunction } from "@jest/expect";
+import type { NotificationType, EnumToUnion, ComponentOrElement } from "@metamask/snaps-sdk";
+import type { Json } from "@metamask/utils";
+/**
+ * Check if a JSON-RPC response matches the expected value. This matcher is
+ * intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected response.
+ * @returns The status and message.
+ */
+export declare const toRespondWith: MatcherFunction<[expected: Json]>;
+export declare const toRespondWithError: MatcherFunction<[expected: Json]>;
+/**
+ * Check if the snap sent a notification with the expected message. This matcher
+ * is intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected notification message.
+ * @param type - The expected notification type.
+ * @returns The status and message.
+ */
+export declare const toSendNotification: MatcherFunction<[
+    expected: string,
+    type?: EnumToUnion<NotificationType> | undefined
+]>;
+export declare const toRender: MatcherFunction<[expected: ComponentOrElement]>;
+//# sourceMappingURL=matchers.d.mts.map

package/dist/matchers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.d.mts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB;AAEpD,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAEnB,4BAA4B;AAQ7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAiE5C;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CA4B3D,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CA4BhE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,EAAE,eAAe,CAC9C;IAAC,QAAQ,EAAE,MAAM;IAAE,IAAI,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,GAAG,SAAS;CAAC,CAwBrE,CAAC;AAgCF,eAAO,MAAM,QAAQ,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAgClE,CAAC"}

package/dist/matchers.mjs

@@ -1,49 +1,154 @@
-import {
-  toRender,
-  toRespondWith,
-  toRespondWithError,
-  toSendNotification
-} from "./chunk-7PCHIR6O.mjs";
-import "./chunk-MF43OG3Z.mjs";
-import "./chunk-XK5HPZZC.mjs";
-import "./chunk-PDOVVC74.mjs";
-import "./chunk-5ZFHFICZ.mjs";
-import "./chunk-Q3I6P2ZF.mjs";
-import "./chunk-ZG33OGC3.mjs";
-import "./chunk-3J2IBWXV.mjs";
-import "./chunk-6HHV6YFQ.mjs";
-import "./chunk-Q2OQXAUM.mjs";
-import "./chunk-VOYBI6T4.mjs";
-import "./chunk-IXKO6X55.mjs";
-import "./chunk-FP4H3ADT.mjs";
-import "./chunk-6JPBXAHM.mjs";
-import "./chunk-IWJ4HKDR.mjs";
-import "./chunk-G333FBBL.mjs";
-import "./chunk-SLU4FNKX.mjs";
-import "./chunk-J4ZPUCLX.mjs";
-import "./chunk-C26TYXXD.mjs";
-import "./chunk-LVNNGMJ2.mjs";
-import "./chunk-LSKT2AUS.mjs";
-import "./chunk-NTOY6Y4Q.mjs";
-import "./chunk-OHRFO2BL.mjs";
-import "./chunk-UDOXICJK.mjs";
-import "./chunk-QRVFWATH.mjs";
-import "./chunk-FQWOVTBB.mjs";
-import "./chunk-ALRZENWP.mjs";
-import "./chunk-24CGIQLL.mjs";
-import "./chunk-5U5WB3SM.mjs";
-import "./chunk-RQKT6BQ2.mjs";
-import "./chunk-ORR7AE5X.mjs";
-import "./chunk-ZJQSGRNK.mjs";
-import "./chunk-H2464AXT.mjs";
-import "./chunk-LB4R3BUA.mjs";
-import "./chunk-MPZOXW6I.mjs";
-import "./chunk-57SGDM5B.mjs";
-import "./chunk-JMDSN227.mjs";
-export {
-  toRender,
-  toRespondWith,
-  toRespondWithError,
-  toSendNotification
+/* eslint-disable no-invalid-this */
+import $jestglobals from "@jest/globals";
+const { expect } = $jestglobals;
+import { isJSXElementUnsafe } from "@metamask/snaps-sdk/jsx";
+import { getJsxElementFromComponent, serialiseJsx } from "@metamask/snaps-utils";
+import { is } from "@metamask/superstruct";
+import { hasProperty } from "@metamask/utils";
+import { EXPECTED_COLOR, diff, matcherErrorMessage, matcherHint, printReceived, printWithType, RECEIVED_COLOR } from "jest-matcher-utils";
+import { InterfaceStruct, SnapResponseStruct } from "./internals/index.mjs";
+/**
+ * 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 (!is(actual, SnapResponseStruct)) {
+        throw new Error(matcherErrorMessage(matcherHint(matcherName, undefined, undefined, options), `${RECEIVED_COLOR('received')} value must be a response from the \`request\` function`, printWithType('Received', actual, 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 (!is(actual, InterfaceStruct) || !actual.content) {
+        throw new Error(matcherErrorMessage(matcherHint(matcherName, undefined, undefined, options), `${RECEIVED_COLOR('received')} value must have a \`content\` property`, printWithType('Received', actual, printReceived)));
+    }
+}
+/**
+ * Check if a JSON-RPC response matches the expected value. This matcher is
+ * intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected response.
+ * @returns The status and message.
+ */
+export const toRespondWith = function (actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWith');
+    const { response } = actual;
+    if (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 };
 };
+export const toRespondWithError = function (actual, expected) {
+    assertActualIsSnapResponse(actual, 'toRespondWithError');
+    const { response } = actual;
+    if (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 };
+};
+/**
+ * Check if the snap sent a notification with the expected message. This matcher
+ * is intended to be used with the `expect` global.
+ *
+ * @param actual - The actual response.
+ * @param expected - The expected notification message.
+ * @param type - The expected notification type.
+ * @returns The status and message.
+ */
+export const toSendNotification = 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 toRenderLegacy = function (actual, expected) {
+    assertHasInterface(actual, 'toRender');
+    const { content } = actual;
+    const expectedElement = getJsxElementFromComponent(expected);
+    const pass = this.equals(content, expectedElement);
+    // This is typed as `string | null`, but in practice it's always a string.
+    // The function only returns `null` if both the expected and actual values
+    // are numbers, bigints, or booleans, which is never the case here.
+    const difference = diff(expectedElement, content);
+    const message = pass
+        ? () => `${this.utils.matcherHint('.not.toRender')}\n\n` +
+            `Expected:\n${this.utils.printExpected(expectedElement)}\n\n` +
+            `Received:\n${this.utils.printReceived(content)}` +
+            `\n\nDifference:\n\n${difference}`
+        : () => `${this.utils.matcherHint('.toRender')}\n\n` +
+            `Expected:\n${this.utils.printExpected(expectedElement)}\n\n` +
+            `Received:\n${this.utils.printReceived(content)}` +
+            `\n\nDifference:\n\n${difference}`;
+    return { message, pass };
+};
+export const toRender = function (actual, expected) {
+    assertHasInterface(actual, 'toRender');
+    if (!isJSXElementUnsafe(expected)) {
+        return toRenderLegacy.call(this, actual, expected);
+    }
+    const { content } = actual;
+    const pass = this.equals(content, expected);
+    // This is typed as `string | null`, but in practice it's always a string.
+    // The function only returns `null` if both the expected and actual values
+    // are numbers, bigints, or booleans, which is never the case here.
+    const difference = diff(serialiseJsx(expected), serialiseJsx(content));
+    const message = pass
+        ? () => `${this.utils.matcherHint('.not.toRender')}\n\n` +
+            `Expected:\n${EXPECTED_COLOR(serialiseJsx(expected))}\n\n` +
+            `Received:\n${RECEIVED_COLOR(serialiseJsx(content))}` +
+            `\n\nDifference:\n\n${difference}`
+        : () => `${this.utils.matcherHint('.toRender')}\n\n` +
+            `Expected:\n${EXPECTED_COLOR(serialiseJsx(expected))}\n\n` +
+            `Received:\n${RECEIVED_COLOR(serialiseJsx(content))}` +
+            `\n\nDifference:\n\n${difference}`;
+    return { message, pass };
+};
+expect.extend({
+    toRespondWith,
+    toRespondWithError,
+    toSendNotification,
+    toRender,
+});
 //# sourceMappingURL=matchers.mjs.map

package/dist/matchers.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"matchers.mjs","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAAA,oCAAoC;;;AAcpC,OAAO,EAAE,kBAAkB,EAAE,gCAAgC;AAC7D,OAAO,EACL,0BAA0B,EAC1B,YAAY,EACb,8BAA8B;AAC/B,OAAO,EAAE,EAAE,EAAE,8BAA8B;AAE3C,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EACL,cAAc,EACd,IAAI,EACJ,mBAAmB,EACnB,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACf,2BAA2B;AAE5B,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,8BAAoB;AAGlE;;;;;;GAMG;AACH,SAAS,0BAA0B,CACjC,MAAe,EACf,WAAmB,EACnB,OAA4B;IAE5B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CACb,mBAAmB,CACjB,WAAW,CAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACvD,GAAG,cAAc,CACf,UAAU,CACX,yDAAyD,EAC1D,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CACjD,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CACzB,MAAe,EACf,WAAmB,EACnB,OAA4B;IAE5B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,mBAAmB,CACjB,WAAW,CAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACvD,GAAG,cAAc,CAAC,UAAU,CAAC,yCAAyC,EACtE,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CACjD,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAsC,UAC9D,MAAM,EACN,QAAQ;IAER,0BAA0B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEpD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,IAAI,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM;YACjD,sBAAsB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YAC5D,mBAAmB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAEhE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,MAAM;YACrD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC5D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM;YACjD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;IAE/D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAsC,UACnE,MAAM,EACN,QAAQ;IAER,0BAA0B,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAEzD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,IAAI,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,mBAAmB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACzD,oBAAoB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAElE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,yBAAyB,CAAC,MAAM;YAC1D,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QAC3D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IAE9D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAE3B,UAAU,MAAM,EAAE,QAAQ,EAAE,IAAI;IAClC,0BAA0B,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAEzD,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;IACjC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAC7B,CAAC,YAAY,EAAE,EAAE,CACf,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC3C,CAAC,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,CAAC,CACrD,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,yBAAyB,CAAC,MAAM;YAC1D,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,kBAAkB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI;YACpD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;QAC1D,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,CAAC,MAAM;YACtD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;YACnD,kBAAkB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI;YACpD,aAAa,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;IAE7D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,cAAc,GAA2C,UAC7D,MAAM,EACN,QAAQ;IAER,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEvC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,eAAe,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAEnD,0EAA0E;IAC1E,0EAA0E;IAC1E,mEAAmE;IACnE,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,EAAE,OAAO,CAAW,CAAC;IAE5D,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM;YAChD,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM;YAC7D,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;YACjD,sBAAsB,UAAU,EAAE;QACtC,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM;YAC5C,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM;YAC7D,cAAc,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;YACjD,sBAAsB,UAAU,EAAE,CAAC;IAEzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GACnB,UAAU,MAAM,EAAE,QAAQ;IACxB,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEvC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE5C,0EAA0E;IAC1E,0EAA0E;IAC1E,mEAAmE;IACnE,MAAM,UAAU,GAAG,IAAI,CACrB,YAAY,CAAC,QAAQ,CAAC,EACtB,YAAY,CAAC,OAAO,CAAC,CACZ,CAAC;IAEZ,MAAM,OAAO,GAAG,IAAI;QAClB,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM;YAChD,cAAc,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,MAAM;YAC1D,cAAc,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE;YACrD,sBAAsB,UAAU,EAAE;QACtC,CAAC,CAAC,GAAG,EAAE,CACH,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM;YAC5C,cAAc,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,MAAM;YAC1D,cAAc,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE;YACrD,sBAAsB,UAAU,EAAE,CAAC;IAEzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,CAAC;IACZ,aAAa;IACb,kBAAkB;IAClB,kBAAkB;IAClB,QAAQ;CACT,CAAC,CAAC","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 type { MatcherFunction } from '@jest/expect';\nimport { expect } from '@jest/globals';\nimport type {\n  NotificationType,\n  EnumToUnion,\n  ComponentOrElement,\n  Component,\n} from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport { isJSXElementUnsafe } from '@metamask/snaps-sdk/jsx';\nimport {\n  getJsxElementFromComponent,\n  serialiseJsx,\n} from '@metamask/snaps-utils';\nimport { is } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\nimport type { MatcherHintOptions } from 'jest-matcher-utils';\nimport {\n  EXPECTED_COLOR,\n  diff,\n  matcherErrorMessage,\n  matcherHint,\n  printReceived,\n  printWithType,\n  RECEIVED_COLOR,\n} from 'jest-matcher-utils';\n\nimport { InterfaceStruct, SnapResponseStruct } from './internals';\nimport type { 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: JSXElement } {\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> = 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\nconst toRenderLegacy: MatcherFunction<[expected: Component]> = function (\n  actual,\n  expected,\n) {\n  assertHasInterface(actual, 'toRender');\n\n  const { content } = actual;\n  const expectedElement = getJsxElementFromComponent(expected);\n  const pass = this.equals(content, expectedElement);\n\n  // This is typed as `string | null`, but in practice it's always a string.\n  // The function only returns `null` if both the expected and actual values\n  // are numbers, bigints, or booleans, which is never the case here.\n  const difference = diff(expectedElement, content) as string;\n\n  const message = pass\n    ? () =>\n        `${this.utils.matcherHint('.not.toRender')}\\n\\n` +\n        `Expected:\\n${this.utils.printExpected(expectedElement)}\\n\\n` +\n        `Received:\\n${this.utils.printReceived(content)}` +\n        `\\n\\nDifference:\\n\\n${difference}`\n    : () =>\n        `${this.utils.matcherHint('.toRender')}\\n\\n` +\n        `Expected:\\n${this.utils.printExpected(expectedElement)}\\n\\n` +\n        `Received:\\n${this.utils.printReceived(content)}` +\n        `\\n\\nDifference:\\n\\n${difference}`;\n\n  return { message, pass };\n};\n\nexport const toRender: MatcherFunction<[expected: ComponentOrElement]> =\n  function (actual, expected) {\n    assertHasInterface(actual, 'toRender');\n\n    if (!isJSXElementUnsafe(expected)) {\n      return toRenderLegacy.call(this, actual, expected);\n    }\n\n    const { content } = actual;\n    const pass = this.equals(content, expected);\n\n    // This is typed as `string | null`, but in practice it's always a string.\n    // The function only returns `null` if both the expected and actual values\n    // are numbers, bigints, or booleans, which is never the case here.\n    const difference = diff(\n      serialiseJsx(expected),\n      serialiseJsx(content),\n    ) as string;\n\n    const message = pass\n      ? () =>\n          `${this.utils.matcherHint('.not.toRender')}\\n\\n` +\n          `Expected:\\n${EXPECTED_COLOR(serialiseJsx(expected))}\\n\\n` +\n          `Received:\\n${RECEIVED_COLOR(serialiseJsx(content))}` +\n          `\\n\\nDifference:\\n\\n${difference}`\n      : () =>\n          `${this.utils.matcherHint('.toRender')}\\n\\n` +\n          `Expected:\\n${EXPECTED_COLOR(serialiseJsx(expected))}\\n\\n` +\n          `Received:\\n${RECEIVED_COLOR(serialiseJsx(content))}` +\n          `\\n\\nDifference:\\n\\n${difference}`;\n\n    return { message, pass };\n  };\n\nexpect.extend({\n  toRespondWith,\n  toRespondWithError,\n  toSendNotification,\n  toRender,\n});\n"]}

package/dist/options.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOptions = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const SnapsEnvironmentOptionsStruct = (0, superstruct_1.type)({
+    server: (0, superstruct_1.defaulted)((0, superstruct_1.object)({
+        enabled: (0, superstruct_1.defaulted)((0, superstruct_1.boolean)(), true),
+        port: (0, superstruct_1.defaulted)((0, superstruct_1.number)(), 0),
+        root: (0, superstruct_1.defaulted)((0, superstruct_1.string)(), process.cwd()),
+    }), {}),
+});
+/**
+ * Get the environment options. This validates the options, and returns the
+ * default options if none are provided.
+ *
+ * @param testEnvironmentOptions - The test environment options as defined in
+ * the Jest configuration.
+ * @returns The environment options.
+ */
+function getOptions(testEnvironmentOptions) {
+    return (0, superstruct_1.create)(testEnvironmentOptions, SnapsEnvironmentOptionsStruct);
+}
+exports.getOptions = getOptions;
+//# sourceMappingURL=options.cjs.map

package/dist/options.cjs.map

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

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

@@ -1,4 +1,4 @@
-import type { Infer } from '@metamask/superstruct';
+import type { Infer } from "@metamask/superstruct";
 declare const SnapsEnvironmentOptionsStruct: import("@metamask/superstruct").Struct<{
     server: {
         port: number;
@@ -58,3 +58,4 @@ export declare function getOptions(testEnvironmentOptions: Record<string, unknow
     };
 };
 export {};
+//# sourceMappingURL=options.d.cts.map

package/dist/options.d.cts.map

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

package/dist/options.d.mts

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

package/dist/options.d.mts.map

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

package/dist/options.mjs

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