@metamask/snaps-rpc-methods 10.0.1 → 11.1.0

package/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [11.1.0]
+### Changed
+- Improve error messaging ([#2696](https://github.com/MetaMask/snaps/pull/2696))
+- Increase character limit for in-app notification messages ([#2684](https://github.com/MetaMask/snaps/pull/2684))
+
+### Fixed
+- Fix ESM version of the package ([#2682](https://github.com/MetaMask/snaps/pull/2682))
+  - This fixes the ESM version of the package to be fully compliant with the ESM
+    standard.
+- Bump `@metamask/utils` from `^9.1.0` to `^9.2.1` ([#2680](https://github.com/MetaMask/snaps/pull/2680))
+- Bump other MetaMask dependencies ([#2703](https://github.com/MetaMask/snaps/pull/2703))
+
+## [11.0.0]
+### Added
+- **BREAKING:** Add `snap_getPreferences` ([#2607](https://github.com/MetaMask/snaps/pull/2607))
+  - This is breaking because a `getPreferences` method hook is now required.
+
 ## [10.0.1]
 ### Changed
 - Bump `@metamask/json-rpc-engine` from `^9.0.0` to `^9.0.2` ([#2593](https://github.com/metamask/snaps/pull/2593))
@@ -184,7 +201,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@10.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.1.0...HEAD
+[11.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@11.0.0...@metamask/snaps-rpc-methods@11.1.0
+[11.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@10.0.1...@metamask/snaps-rpc-methods@11.0.0
 [10.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@10.0.0...@metamask/snaps-rpc-methods@10.0.1
 [10.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@9.1.4...@metamask/snaps-rpc-methods@10.0.0
 [9.1.4]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@9.1.3...@metamask/snaps-rpc-methods@9.1.4

package/dist/__fixtures__/entropy.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENTROPY_VECTORS = void 0;
+/**
+ * SIP-6 test vectors.
+ */
+exports.ENTROPY_VECTORS = [
+    {
+        snapId: 'foo',
+        derivationPath: "m/1399742832'/1323571613'/1848851859'/458888073'/1339050117'/513522582'/1371866341'/2121938770'/1014285256'",
+        entropy: '0x8bbb59ec55a4a8dd5429268e367ebbbe54eee7467c0090ca835c64d45c33a155',
+    },
+    {
+        snapId: 'bar',
+        derivationPath: "m/1399742832'/767024459'/1206550137'/1427647479'/1048031962'/1656784813'/1860822351'/1362389435'/2133253878'",
+        entropy: '0xbdae5c0790d9189d8ae27fd4860b3b57bab420b6594c420ae9ae3a9f87c1ea14',
+    },
+    {
+        snapId: 'foo',
+        salt: 'bar',
+        derivationPath: "m/1399742832'/2002032866'/301374032'/1159533269'/453247377'/187127851'/1859522268'/152471137'/187531423'",
+        entropy: '0x59cbec1fa877ecb38d88c3a2326b23bff374954b39ad9482c9b082306ac4b3ad',
+    },
+    {
+        snapId: 'bar',
+        salt: 'baz',
+        derivationPath: "m/1399742832'/734358031'/701613791'/1618075622'/1535938847'/1610213550'/18831365'/356906080'/2095933563'",
+        entropy: '0x814c1f121eb4067d1e1d177246461e8a1cc6a1b1152756737aba7fa9c2161ba2',
+    },
+];
+//# sourceMappingURL=entropy.cjs.map

package/dist/__fixtures__/entropy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.cjs","sourceRoot":"","sources":["../../src/__fixtures__/entropy.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B;QACE,MAAM,EAAE,KAAK;QACb,cAAc,EACZ,6GAA6G;QAC/G,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,cAAc,EACZ,8GAA8G;QAChH,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,cAAc,EACZ,0GAA0G;QAC5G,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,cAAc,EACZ,0GAA0G;QAC5G,OAAO,EACL,oEAAoE;KACvE;CACF,CAAC","sourcesContent":["/**\n * SIP-6 test vectors.\n */\nexport const ENTROPY_VECTORS = [\n  {\n    snapId: 'foo',\n    derivationPath:\n      \"m/1399742832'/1323571613'/1848851859'/458888073'/1339050117'/513522582'/1371866341'/2121938770'/1014285256'\",\n    entropy:\n      '0x8bbb59ec55a4a8dd5429268e367ebbbe54eee7467c0090ca835c64d45c33a155',\n  },\n  {\n    snapId: 'bar',\n    derivationPath:\n      \"m/1399742832'/767024459'/1206550137'/1427647479'/1048031962'/1656784813'/1860822351'/1362389435'/2133253878'\",\n    entropy:\n      '0xbdae5c0790d9189d8ae27fd4860b3b57bab420b6594c420ae9ae3a9f87c1ea14',\n  },\n  {\n    snapId: 'foo',\n    salt: 'bar',\n    derivationPath:\n      \"m/1399742832'/2002032866'/301374032'/1159533269'/453247377'/187127851'/1859522268'/152471137'/187531423'\",\n    entropy:\n      '0x59cbec1fa877ecb38d88c3a2326b23bff374954b39ad9482c9b082306ac4b3ad',\n  },\n  {\n    snapId: 'bar',\n    salt: 'baz',\n    derivationPath:\n      \"m/1399742832'/734358031'/701613791'/1618075622'/1535938847'/1610213550'/18831365'/356906080'/2095933563'\",\n    entropy:\n      '0x814c1f121eb4067d1e1d177246461e8a1cc6a1b1152756737aba7fa9c2161ba2',\n  },\n];\n"]}

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

@@ -12,3 +12,4 @@ export declare const ENTROPY_VECTORS: ({
     derivationPath: string;
     entropy: string;
 })[];
+//# sourceMappingURL=entropy.d.cts.map

package/dist/__fixtures__/entropy.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.cts","sourceRoot":"","sources":["../../src/__fixtures__/entropy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;IA+B3B,CAAC"}

package/dist/__fixtures__/entropy.d.mts

@@ -0,0 +1,15 @@
+/**
+ * SIP-6 test vectors.
+ */
+export declare const ENTROPY_VECTORS: ({
+    snapId: string;
+    derivationPath: string;
+    entropy: string;
+    salt?: undefined;
+} | {
+    snapId: string;
+    salt: string;
+    derivationPath: string;
+    entropy: string;
+})[];
+//# sourceMappingURL=entropy.d.mts.map

package/dist/__fixtures__/entropy.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.mts","sourceRoot":"","sources":["../../src/__fixtures__/entropy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;IA+B3B,CAAC"}

package/dist/__fixtures__/entropy.mjs

@@ -0,0 +1,28 @@
+/**
+ * SIP-6 test vectors.
+ */
+export const ENTROPY_VECTORS = [
+    {
+        snapId: 'foo',
+        derivationPath: "m/1399742832'/1323571613'/1848851859'/458888073'/1339050117'/513522582'/1371866341'/2121938770'/1014285256'",
+        entropy: '0x8bbb59ec55a4a8dd5429268e367ebbbe54eee7467c0090ca835c64d45c33a155',
+    },
+    {
+        snapId: 'bar',
+        derivationPath: "m/1399742832'/767024459'/1206550137'/1427647479'/1048031962'/1656784813'/1860822351'/1362389435'/2133253878'",
+        entropy: '0xbdae5c0790d9189d8ae27fd4860b3b57bab420b6594c420ae9ae3a9f87c1ea14',
+    },
+    {
+        snapId: 'foo',
+        salt: 'bar',
+        derivationPath: "m/1399742832'/2002032866'/301374032'/1159533269'/453247377'/187127851'/1859522268'/152471137'/187531423'",
+        entropy: '0x59cbec1fa877ecb38d88c3a2326b23bff374954b39ad9482c9b082306ac4b3ad',
+    },
+    {
+        snapId: 'bar',
+        salt: 'baz',
+        derivationPath: "m/1399742832'/734358031'/701613791'/1618075622'/1535938847'/1610213550'/18831365'/356906080'/2095933563'",
+        entropy: '0x814c1f121eb4067d1e1d177246461e8a1cc6a1b1152756737aba7fa9c2161ba2',
+    },
+];
+//# sourceMappingURL=entropy.mjs.map

package/dist/__fixtures__/entropy.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.mjs","sourceRoot":"","sources":["../../src/__fixtures__/entropy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;QACE,MAAM,EAAE,KAAK;QACb,cAAc,EACZ,6GAA6G;QAC/G,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,cAAc,EACZ,8GAA8G;QAChH,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,cAAc,EACZ,0GAA0G;QAC5G,OAAO,EACL,oEAAoE;KACvE;IACD;QACE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,cAAc,EACZ,0GAA0G;QAC5G,OAAO,EACL,oEAAoE;KACvE;CACF,CAAC","sourcesContent":["/**\n * SIP-6 test vectors.\n */\nexport const ENTROPY_VECTORS = [\n  {\n    snapId: 'foo',\n    derivationPath:\n      \"m/1399742832'/1323571613'/1848851859'/458888073'/1339050117'/513522582'/1371866341'/2121938770'/1014285256'\",\n    entropy:\n      '0x8bbb59ec55a4a8dd5429268e367ebbbe54eee7467c0090ca835c64d45c33a155',\n  },\n  {\n    snapId: 'bar',\n    derivationPath:\n      \"m/1399742832'/767024459'/1206550137'/1427647479'/1048031962'/1656784813'/1860822351'/1362389435'/2133253878'\",\n    entropy:\n      '0xbdae5c0790d9189d8ae27fd4860b3b57bab420b6594c420ae9ae3a9f87c1ea14',\n  },\n  {\n    snapId: 'foo',\n    salt: 'bar',\n    derivationPath:\n      \"m/1399742832'/2002032866'/301374032'/1159533269'/453247377'/187127851'/1859522268'/152471137'/187531423'\",\n    entropy:\n      '0x59cbec1fa877ecb38d88c3a2326b23bff374954b39ad9482c9b082306ac4b3ad',\n  },\n  {\n    snapId: 'bar',\n    salt: 'baz',\n    derivationPath:\n      \"m/1399742832'/734358031'/701613791'/1618075622'/1535938847'/1610213550'/18831365'/356906080'/2095933563'\",\n    entropy:\n      '0x814c1f121eb4067d1e1d177246461e8a1cc6a1b1152756737aba7fa9c2161ba2',\n  },\n];\n"]}

package/dist/__fixtures__/index.cjs

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

package/dist/__fixtures__/index.cjs.map

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

package/dist/__fixtures__/index.d.cts

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

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

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

package/dist/__fixtures__/index.d.mts

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

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

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

package/dist/__fixtures__/index.mjs

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

package/dist/__fixtures__/index.mjs.map

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

package/dist/endowments/caveats/generic.cjs

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGenericPermissionValidator = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+/**
+ * Create a generic permission validator that validates the presence of certain caveats.
+ *
+ * This validator only validates the types of the caveats, not the values.
+ *
+ * @param caveatsToValidate - A list of objects that represent caveats.
+ * @param caveatsToValidate.type - The string defining the caveat type.
+ * @param caveatsToValidate.optional - An optional boolean flag that defines
+ * whether the caveat is optional or not.
+ * @returns A function that validates a permission.
+ */
+function createGenericPermissionValidator(caveatsToValidate) {
+    const validCaveatTypes = new Set(caveatsToValidate.map((caveat) => caveat.type));
+    const requiredCaveats = caveatsToValidate.filter((caveat) => !caveat.optional);
+    return function ({ caveats }) {
+        const actualCaveats = caveats ?? [];
+        const passedCaveatTypes = actualCaveats.map((caveat) => caveat.type);
+        const passedCaveatsSet = new Set(passedCaveatTypes);
+        // Disallow duplicates
+        if (passedCaveatsSet.size !== passedCaveatTypes.length) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: 'Duplicate caveats are not allowed.',
+            });
+        }
+        // Disallow caveats that don't match expected types
+        if (!actualCaveats.every((caveat) => validCaveatTypes.has(caveat.type))) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Expected the following caveats: ${caveatsToValidate
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}, received ${actualCaveats
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}.`,
+            });
+        }
+        // Fail if not all required caveats are specified
+        if (!requiredCaveats.every((caveat) => passedCaveatsSet.has(caveat.type))) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Expected the following caveats: ${requiredCaveats
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}.`,
+            });
+        }
+    };
+}
+exports.createGenericPermissionValidator = createGenericPermissionValidator;
+//# sourceMappingURL=generic.cjs.map

package/dist/endowments/caveats/generic.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic.cjs","sourceRoot":"","sources":["../../../src/endowments/caveats/generic.ts"],"names":[],"mappings":";;;AAIA,qDAAiD;AAOjD;;;;;;;;;;GAUG;AACH,SAAgB,gCAAgC,CAC9C,iBAGG;IAEH,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAC/C,CAAC;IACF,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,CAC9C,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAC7B,CAAC;IAEF,OAAO,UAAU,EAAE,OAAO,EAAE;QAC1B,MAAM,aAAa,GAAG,OAAO,IAAI,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAEpD,sBAAsB;QACtB,IAAI,gBAAgB,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,oCAAoC;aAC9C,CAAC,CAAC;QACL,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACxE,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mCAAmC,iBAAiB;qBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,cAAc,aAAa;qBACrC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,GAAG;aACjB,CAAC,CAAC;QACL,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC1E,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mCAAmC,eAAe;qBACxD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,GAAG;aACjB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AA7CD,4EA6CC","sourcesContent":["import type {\n  PermissionConstraint,\n  PermissionValidatorConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { Json } from '@metamask/utils';\n\nexport type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;\n\nexport type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;\n\n/**\n * Create a generic permission validator that validates the presence of certain caveats.\n *\n * This validator only validates the types of the caveats, not the values.\n *\n * @param caveatsToValidate - A list of objects that represent caveats.\n * @param caveatsToValidate.type - The string defining the caveat type.\n * @param caveatsToValidate.optional - An optional boolean flag that defines\n * whether the caveat is optional or not.\n * @returns A function that validates a permission.\n */\nexport function createGenericPermissionValidator(\n  caveatsToValidate: {\n    type: string;\n    optional?: boolean;\n  }[],\n): PermissionValidatorConstraint {\n  const validCaveatTypes = new Set(\n    caveatsToValidate.map((caveat) => caveat.type),\n  );\n  const requiredCaveats = caveatsToValidate.filter(\n    (caveat) => !caveat.optional,\n  );\n\n  return function ({ caveats }) {\n    const actualCaveats = caveats ?? [];\n    const passedCaveatTypes = actualCaveats.map((caveat) => caveat.type);\n    const passedCaveatsSet = new Set(passedCaveatTypes);\n\n    // Disallow duplicates\n    if (passedCaveatsSet.size !== passedCaveatTypes.length) {\n      throw rpcErrors.invalidParams({\n        message: 'Duplicate caveats are not allowed.',\n      });\n    }\n\n    // Disallow caveats that don't match expected types\n    if (!actualCaveats.every((caveat) => validCaveatTypes.has(caveat.type))) {\n      throw rpcErrors.invalidParams({\n        message: `Expected the following caveats: ${caveatsToValidate\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}, received ${actualCaveats\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}.`,\n      });\n    }\n\n    // Fail if not all required caveats are specified\n    if (!requiredCaveats.every((caveat) => passedCaveatsSet.has(caveat.type))) {\n      throw rpcErrors.invalidParams({\n        message: `Expected the following caveats: ${requiredCaveats\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}.`,\n      });\n    }\n  };\n}\n"]}

package/dist/{types/endowments/caveats/generic.d.ts → endowments/caveats/generic.d.cts}

@@ -1,7 +1,7 @@
-import type { PermissionConstraint, PermissionValidatorConstraint } from '@metamask/permission-controller';
-import type { Json } from '@metamask/utils';
-export declare type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;
-export declare type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;
+import type { PermissionConstraint, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import type { Json } from "@metamask/utils";
+export type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;
+export type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;
 /**
  * Create a generic permission validator that validates the presence of certain caveats.
  *
@@ -17,3 +17,4 @@ export declare function createGenericPermissionValidator(caveatsToValidate: {
     type: string;
     optional?: boolean;
 }[]): PermissionValidatorConstraint;
+//# sourceMappingURL=generic.d.cts.map

package/dist/endowments/caveats/generic.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic.d.cts","sourceRoot":"","sources":["../../../src/endowments/caveats/generic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,6BAA6B,EAC9B,wCAAwC;AAEzC,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;AAE5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,uBAAuB,CAAC;AAE5E;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAC9C,iBAAiB,EAAE;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,EAAE,GACF,6BAA6B,CAwC/B"}

package/dist/endowments/caveats/generic.d.mts

@@ -0,0 +1,20 @@
+import type { PermissionConstraint, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import type { Json } from "@metamask/utils";
+export type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;
+export type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;
+/**
+ * Create a generic permission validator that validates the presence of certain caveats.
+ *
+ * This validator only validates the types of the caveats, not the values.
+ *
+ * @param caveatsToValidate - A list of objects that represent caveats.
+ * @param caveatsToValidate.type - The string defining the caveat type.
+ * @param caveatsToValidate.optional - An optional boolean flag that defines
+ * whether the caveat is optional or not.
+ * @returns A function that validates a permission.
+ */
+export declare function createGenericPermissionValidator(caveatsToValidate: {
+    type: string;
+    optional?: boolean;
+}[]): PermissionValidatorConstraint;
+//# sourceMappingURL=generic.d.mts.map

package/dist/endowments/caveats/generic.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic.d.mts","sourceRoot":"","sources":["../../../src/endowments/caveats/generic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,6BAA6B,EAC9B,wCAAwC;AAEzC,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;AAE5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,uBAAuB,CAAC;AAE5E;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAC9C,iBAAiB,EAAE;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,EAAE,GACF,6BAA6B,CAwC/B"}

package/dist/endowments/caveats/generic.mjs

@@ -1,7 +1,46 @@
-import {
-  createGenericPermissionValidator
-} from "../../chunk-TT4DP2YW.mjs";
-export {
-  createGenericPermissionValidator
-};
+import { rpcErrors } from "@metamask/rpc-errors";
+/**
+ * Create a generic permission validator that validates the presence of certain caveats.
+ *
+ * This validator only validates the types of the caveats, not the values.
+ *
+ * @param caveatsToValidate - A list of objects that represent caveats.
+ * @param caveatsToValidate.type - The string defining the caveat type.
+ * @param caveatsToValidate.optional - An optional boolean flag that defines
+ * whether the caveat is optional or not.
+ * @returns A function that validates a permission.
+ */
+export function createGenericPermissionValidator(caveatsToValidate) {
+    const validCaveatTypes = new Set(caveatsToValidate.map((caveat) => caveat.type));
+    const requiredCaveats = caveatsToValidate.filter((caveat) => !caveat.optional);
+    return function ({ caveats }) {
+        const actualCaveats = caveats ?? [];
+        const passedCaveatTypes = actualCaveats.map((caveat) => caveat.type);
+        const passedCaveatsSet = new Set(passedCaveatTypes);
+        // Disallow duplicates
+        if (passedCaveatsSet.size !== passedCaveatTypes.length) {
+            throw rpcErrors.invalidParams({
+                message: 'Duplicate caveats are not allowed.',
+            });
+        }
+        // Disallow caveats that don't match expected types
+        if (!actualCaveats.every((caveat) => validCaveatTypes.has(caveat.type))) {
+            throw rpcErrors.invalidParams({
+                message: `Expected the following caveats: ${caveatsToValidate
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}, received ${actualCaveats
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}.`,
+            });
+        }
+        // Fail if not all required caveats are specified
+        if (!requiredCaveats.every((caveat) => passedCaveatsSet.has(caveat.type))) {
+            throw rpcErrors.invalidParams({
+                message: `Expected the following caveats: ${requiredCaveats
+                    .map((caveat) => `"${caveat.type}"`)
+                    .join(', ')}.`,
+            });
+        }
+    };
+}
 //# sourceMappingURL=generic.mjs.map

package/dist/endowments/caveats/generic.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"generic.mjs","sourceRoot":"","sources":["../../../src/endowments/caveats/generic.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gCAAgC,CAC9C,iBAGG;IAEH,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAC/C,CAAC;IACF,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,CAC9C,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAC7B,CAAC;IAEF,OAAO,UAAU,EAAE,OAAO,EAAE;QAC1B,MAAM,aAAa,GAAG,OAAO,IAAI,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAEpD,sBAAsB;QACtB,IAAI,gBAAgB,CAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,oCAAoC;aAC9C,CAAC,CAAC;QACL,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACxE,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mCAAmC,iBAAiB;qBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,cAAc,aAAa;qBACrC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,GAAG;aACjB,CAAC,CAAC;QACL,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC1E,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mCAAmC,eAAe;qBACxD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC;qBACnC,IAAI,CAAC,IAAI,CAAC,GAAG;aACjB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  PermissionConstraint,\n  PermissionValidatorConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { Json } from '@metamask/utils';\n\nexport type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;\n\nexport type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;\n\n/**\n * Create a generic permission validator that validates the presence of certain caveats.\n *\n * This validator only validates the types of the caveats, not the values.\n *\n * @param caveatsToValidate - A list of objects that represent caveats.\n * @param caveatsToValidate.type - The string defining the caveat type.\n * @param caveatsToValidate.optional - An optional boolean flag that defines\n * whether the caveat is optional or not.\n * @returns A function that validates a permission.\n */\nexport function createGenericPermissionValidator(\n  caveatsToValidate: {\n    type: string;\n    optional?: boolean;\n  }[],\n): PermissionValidatorConstraint {\n  const validCaveatTypes = new Set(\n    caveatsToValidate.map((caveat) => caveat.type),\n  );\n  const requiredCaveats = caveatsToValidate.filter(\n    (caveat) => !caveat.optional,\n  );\n\n  return function ({ caveats }) {\n    const actualCaveats = caveats ?? [];\n    const passedCaveatTypes = actualCaveats.map((caveat) => caveat.type);\n    const passedCaveatsSet = new Set(passedCaveatTypes);\n\n    // Disallow duplicates\n    if (passedCaveatsSet.size !== passedCaveatTypes.length) {\n      throw rpcErrors.invalidParams({\n        message: 'Duplicate caveats are not allowed.',\n      });\n    }\n\n    // Disallow caveats that don't match expected types\n    if (!actualCaveats.every((caveat) => validCaveatTypes.has(caveat.type))) {\n      throw rpcErrors.invalidParams({\n        message: `Expected the following caveats: ${caveatsToValidate\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}, received ${actualCaveats\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}.`,\n      });\n    }\n\n    // Fail if not all required caveats are specified\n    if (!requiredCaveats.every((caveat) => passedCaveatsSet.has(caveat.type))) {\n      throw rpcErrors.invalidParams({\n        message: `Expected the following caveats: ${requiredCaveats\n          .map((caveat) => `\"${caveat.type}\"`)\n          .join(', ')}.`,\n      });\n    }\n  };\n}\n"]}

package/dist/endowments/caveats/index.cjs

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

package/dist/endowments/caveats/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/endowments/caveats/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA0B;AAC1B,oDAA8B","sourcesContent":["export * from './generic';\nexport * from './requestTime';\n"]}

package/dist/endowments/caveats/index.d.cts

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

package/dist/endowments/caveats/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/endowments/caveats/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,kCAA8B"}

package/dist/endowments/caveats/index.d.mts

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

package/dist/endowments/caveats/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/endowments/caveats/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,kCAA8B"}

package/dist/endowments/caveats/index.mjs

@@ -1,18 +1,3 @@
-import "../../chunk-TG63GBK3.mjs";
-import {
-  createGenericPermissionValidator
-} from "../../chunk-TT4DP2YW.mjs";
-import {
-  createMaxRequestTimeMapper,
-  getMaxRequestTimeCaveat,
-  getMaxRequestTimeCaveatMapper,
-  maxRequestTimeCaveatSpecifications
-} from "../../chunk-23XDKQW2.mjs";
-export {
-  createGenericPermissionValidator,
-  createMaxRequestTimeMapper,
-  getMaxRequestTimeCaveat,
-  getMaxRequestTimeCaveatMapper,
-  maxRequestTimeCaveatSpecifications
-};
+export * from "./generic.mjs";
+export * from "./requestTime.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/endowments/caveats/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/endowments/caveats/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,kCAA8B","sourcesContent":["export * from './generic';\nexport * from './requestTime';\n"]}

package/dist/endowments/caveats/requestTime.cjs

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maxRequestTimeCaveatSpecifications = exports.getMaxRequestTimeCaveat = exports.createMaxRequestTimeMapper = exports.getMaxRequestTimeCaveatMapper = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+/**
+ * Asserts that the given value is a valid `maxRequestTime` value.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid `maxRequestTime` value.
+ */
+function assertIsMaxRequestTime(value, // eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    (0, utils_1.assertStruct)(value, snaps_utils_1.MaxRequestTimeStruct, 'Invalid maxRequestTime', ErrorWrapper);
+}
+/**
+ * Validate the value of a caveat. This does not validate the type of the
+ * caveat itself, only the value of the caveat.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */
+function validateMaxRequestTimeCaveat(caveat) {
+    if (!(0, utils_1.hasProperty)(caveat, 'value')) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: 'Invalid maxRequestTime caveat.',
+        });
+    }
+    const { value } = caveat;
+    assertIsMaxRequestTime(value, rpc_errors_1.rpcErrors.invalidParams);
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+function getMaxRequestTimeCaveatMapper(value) {
+    if (!value ||
+        !(0, utils_1.isObject)(value) ||
+        ((0, utils_1.isObject)(value) && !(0, utils_1.hasProperty)(value, 'maxRequestTime'))) {
+        return { caveats: null };
+    }
+    return {
+        caveats: [
+            {
+                type: snaps_utils_1.SnapCaveatType.MaxRequestTime,
+                value: value.maxRequestTime,
+            },
+        ],
+    };
+}
+exports.getMaxRequestTimeCaveatMapper = getMaxRequestTimeCaveatMapper;
+/**
+ * Creates a wrapping caveat mapper that creates the `maxRequestTime` caveat
+ * and merges it with any other caveats created by the mapper function.
+ *
+ * @param mapper - Another caveat mapper function.
+ * @returns The caveat specification.
+ */
+function createMaxRequestTimeMapper(mapper) {
+    return function (value) {
+        // We assume this to be used only with caveats of this type
+        const { maxRequestTime, ...rest } = value;
+        const mapperResult = mapper(rest);
+        if (!maxRequestTime) {
+            return mapperResult;
+        }
+        return {
+            ...mapperResult,
+            caveats: [
+                ...(mapperResult.caveats ?? []),
+                {
+                    type: snaps_utils_1.SnapCaveatType.MaxRequestTime,
+                    value: maxRequestTime,
+                },
+            ],
+        };
+    };
+}
+exports.createMaxRequestTimeMapper = createMaxRequestTimeMapper;
+/**
+ * Getter function to get the {@link MaxRequestTime} caveat value from a permission if specified.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value if present, otherwise null.
+ */
+function getMaxRequestTimeCaveat(permission) {
+    const foundCaveat = permission?.caveats?.find((caveat) => caveat.type === snaps_utils_1.SnapCaveatType.MaxRequestTime);
+    return foundCaveat?.value ?? null;
+}
+exports.getMaxRequestTimeCaveat = getMaxRequestTimeCaveat;
+exports.maxRequestTimeCaveatSpecifications = {
+    [snaps_utils_1.SnapCaveatType.MaxRequestTime]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.MaxRequestTime,
+        validator: (caveat) => validateMaxRequestTimeCaveat(caveat),
+    }),
+};
+//# sourceMappingURL=requestTime.cjs.map

package/dist/{chunk-FCVWU5XH.js.map → endowments/caveats/requestTime.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["../src/endowments/caveats/requestTime.ts"],"names":[],"mappings":";AAKA,SAAS,iBAAiB;AAC1B,SAAS,sBAAsB,sBAAsB;AAErD,SAAS,cAAc,aAAa,gBAAgB;AAYpD,SAAS,uBACP,OACA,cACyB;AACzB;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AASA,SAAS,6BAA6B,QAA6B;AACjE,MAAI,CAAC,YAAY,QAAQ,OAAO,GAAG;AACjC,UAAM,UAAU,cAAc;AAAA,MAC5B,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAEA,QAAM,EAAE,MAAM,IAAI;AAClB,yBAAuB,OAAO,UAAU,aAAa;AACvD;AAUO,SAAS,8BACd,OACyB;AACzB,MACE,CAAC,SACD,CAAC,SAAS,KAAK,KACd,SAAS,KAAK,KAAK,CAAC,YAAY,OAAO,gBAAgB,GACxD;AACA,WAAO,EAAE,SAAS,KAAK;AAAA,EACzB;AACA,SAAO;AAAA,IACL,SAAS;AAAA,MACP;AAAA,QACE,MAAM,eAAe;AAAA,QACrB,OAAO,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EACF;AACF;AASO,SAAS,2BACd,QACsB;AACtB,SAAO,SAAU,OAAa;AAE5B,UAAM,EAAE,gBAAgB,GAAG,KAAK,IAAI;AAEpC,UAAM,eAAe,OAAO,IAAI;AAEhC,QAAI,CAAC,gBAAgB;AACnB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,MACL,GAAG;AAAA,MACH,SAAS;AAAA,QACP,GAAI,aAAa,WAAW,CAAC;AAAA,QAC7B;AAAA,UACE,MAAM,eAAe;AAAA,UACrB,OAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAQO,SAAS,wBACd,YACe;AACf,QAAM,cAAc,YAAY,SAAS;AAAA,IACvC,CAAC,WAAW,OAAO,SAAS,eAAe;AAAA,EAC7C;AACA,SAAQ,aAAa,SAAoB;AAC3C;AAEO,IAAM,qCAGT;AAAA,EACF,CAAC,eAAe,cAAc,GAAG,OAAO,OAAO;AAAA,IAC7C,MAAM,eAAe;AAAA,IACrB,WAAW,CAAC,WACV,6BAA6B,MAAM;AAAA,EACvC,CAAC;AACH","sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { MaxRequestTimeStruct, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { AssertionErrorConstructor, Json } from '@metamask/utils';\nimport { assertStruct, hasProperty, isObject } from '@metamask/utils';\n\nimport type { CaveatMapperFunction, CaveatMapperReturnValue } from './generic';\n\n/**\n * Asserts that the given value is a valid `maxRequestTime` value.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid `maxRequestTime` value.\n */\nfunction assertIsMaxRequestTime(\n  value: unknown, // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is number {\n  assertStruct(\n    value,\n    MaxRequestTimeStruct,\n    'Invalid maxRequestTime',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateMaxRequestTimeCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value')) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid maxRequestTime caveat.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsMaxRequestTime(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getMaxRequestTimeCaveatMapper(\n  value: Json,\n): CaveatMapperReturnValue {\n  if (\n    !value ||\n    !isObject(value) ||\n    (isObject(value) && !hasProperty(value, 'maxRequestTime'))\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.MaxRequestTime,\n        value: value.maxRequestTime,\n      },\n    ],\n  };\n}\n\n/**\n * Creates a wrapping caveat mapper that creates the `maxRequestTime` caveat\n * and merges it with any other caveats created by the mapper function.\n *\n * @param mapper - Another caveat mapper function.\n * @returns The caveat specification.\n */\nexport function createMaxRequestTimeMapper(\n  mapper: CaveatMapperFunction,\n): CaveatMapperFunction {\n  return function (value: Json) {\n    // We assume this to be used only with caveats of this type\n    const { maxRequestTime, ...rest } = value as Record<string, Json>;\n\n    const mapperResult = mapper(rest);\n\n    if (!maxRequestTime) {\n      return mapperResult;\n    }\n\n    return {\n      ...mapperResult,\n      caveats: [\n        ...(mapperResult.caveats ?? []),\n        {\n          type: SnapCaveatType.MaxRequestTime,\n          value: maxRequestTime,\n        },\n      ],\n    };\n  };\n}\n\n/**\n * Getter function to get the {@link MaxRequestTime} caveat value from a permission if specified.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value if present, otherwise null.\n */\nexport function getMaxRequestTimeCaveat(\n  permission?: PermissionConstraint,\n): number | null {\n  const foundCaveat = permission?.caveats?.find(\n    (caveat) => caveat.type === SnapCaveatType.MaxRequestTime,\n  );\n  return (foundCaveat?.value as number) ?? null;\n}\n\nexport const maxRequestTimeCaveatSpecifications: Record<\n  SnapCaveatType.MaxRequestTime,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.MaxRequestTime]: Object.freeze({\n    type: SnapCaveatType.MaxRequestTime,\n    validator: (caveat: Caveat<string, any>) =>\n      validateMaxRequestTimeCaveat(caveat),\n  }),\n};\n"]}
+{"version":3,"file":"requestTime.cjs","sourceRoot":"","sources":["../../../src/endowments/caveats/requestTime.ts"],"names":[],"mappings":";;;AAKA,qDAAiD;AACjD,uDAA6E;AAE7E,2CAAsE;AAItE;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC7B,KAAc,EAAE,gEAAgE;AAChF,YAAwC;IAExC,IAAA,oBAAY,EACV,KAAK,EACL,kCAAoB,EACpB,wBAAwB,EACxB,YAAY,CACb,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,4BAA4B,CAAC,MAA2B;IAC/D,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QAClC,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,gCAAgC;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,sBAAsB,CAAC,KAAK,EAAE,sBAAS,CAAC,aAAa,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,6BAA6B,CAC3C,KAAW;IAEX,IACE,CAAC,KAAK;QACN,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC;QAChB,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,EAC1D,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,cAAc;gBACnC,KAAK,EAAE,KAAK,CAAC,cAAc;aAC5B;SACF;KACF,CAAC;AACJ,CAAC;AAlBD,sEAkBC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACxC,MAA4B;IAE5B,OAAO,UAAU,KAAW;QAC1B,2DAA2D;QAC3D,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,KAA6B,CAAC;QAElE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,OAAO;YACL,GAAG,YAAY;YACf,OAAO,EAAE;gBACP,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC/B;oBACE,IAAI,EAAE,4BAAc,CAAC,cAAc;oBACnC,KAAK,EAAE,cAAc;iBACtB;aACF;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAxBD,gEAwBC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,UAAiC;IAEjC,MAAM,WAAW,GAAG,UAAU,EAAE,OAAO,EAAE,IAAI,CAC3C,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,4BAAc,CAAC,cAAc,CAC1D,CAAC;IACF,OAAQ,WAAW,EAAE,KAAgB,IAAI,IAAI,CAAC;AAChD,CAAC;AAPD,0DAOC;AAEY,QAAA,kCAAkC,GAG3C;IACF,CAAC,4BAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC7C,IAAI,EAAE,4BAAc,CAAC,cAAc;QACnC,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CACzC,4BAA4B,CAAC,MAAM,CAAC;KACvC,CAAC;CACH,CAAC","sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { MaxRequestTimeStruct, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { AssertionErrorConstructor, Json } from '@metamask/utils';\nimport { assertStruct, hasProperty, isObject } from '@metamask/utils';\n\nimport type { CaveatMapperFunction, CaveatMapperReturnValue } from './generic';\n\n/**\n * Asserts that the given value is a valid `maxRequestTime` value.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid `maxRequestTime` value.\n */\nfunction assertIsMaxRequestTime(\n  value: unknown, // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is number {\n  assertStruct(\n    value,\n    MaxRequestTimeStruct,\n    'Invalid maxRequestTime',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateMaxRequestTimeCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value')) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid maxRequestTime caveat.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsMaxRequestTime(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getMaxRequestTimeCaveatMapper(\n  value: Json,\n): CaveatMapperReturnValue {\n  if (\n    !value ||\n    !isObject(value) ||\n    (isObject(value) && !hasProperty(value, 'maxRequestTime'))\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.MaxRequestTime,\n        value: value.maxRequestTime,\n      },\n    ],\n  };\n}\n\n/**\n * Creates a wrapping caveat mapper that creates the `maxRequestTime` caveat\n * and merges it with any other caveats created by the mapper function.\n *\n * @param mapper - Another caveat mapper function.\n * @returns The caveat specification.\n */\nexport function createMaxRequestTimeMapper(\n  mapper: CaveatMapperFunction,\n): CaveatMapperFunction {\n  return function (value: Json) {\n    // We assume this to be used only with caveats of this type\n    const { maxRequestTime, ...rest } = value as Record<string, Json>;\n\n    const mapperResult = mapper(rest);\n\n    if (!maxRequestTime) {\n      return mapperResult;\n    }\n\n    return {\n      ...mapperResult,\n      caveats: [\n        ...(mapperResult.caveats ?? []),\n        {\n          type: SnapCaveatType.MaxRequestTime,\n          value: maxRequestTime,\n        },\n      ],\n    };\n  };\n}\n\n/**\n * Getter function to get the {@link MaxRequestTime} caveat value from a permission if specified.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value if present, otherwise null.\n */\nexport function getMaxRequestTimeCaveat(\n  permission?: PermissionConstraint,\n): number | null {\n  const foundCaveat = permission?.caveats?.find(\n    (caveat) => caveat.type === SnapCaveatType.MaxRequestTime,\n  );\n  return (foundCaveat?.value as number) ?? null;\n}\n\nexport const maxRequestTimeCaveatSpecifications: Record<\n  SnapCaveatType.MaxRequestTime,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.MaxRequestTime]: Object.freeze({\n    type: SnapCaveatType.MaxRequestTime,\n    validator: (caveat: Caveat<string, any>) =>\n      validateMaxRequestTimeCaveat(caveat),\n  }),\n};\n"]}

package/dist/{types/endowments/caveats/requestTime.d.ts → endowments/caveats/requestTime.d.cts}

@@ -1,7 +1,7 @@
-import type { CaveatSpecificationConstraint, PermissionConstraint } from '@metamask/permission-controller';
-import { SnapCaveatType } from '@metamask/snaps-utils';
-import type { Json } from '@metamask/utils';
-import type { CaveatMapperFunction, CaveatMapperReturnValue } from './generic';
+import type { CaveatSpecificationConstraint, PermissionConstraint } from "@metamask/permission-controller";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json } from "@metamask/utils";
+import type { CaveatMapperFunction, CaveatMapperReturnValue } from "./generic.cjs";
 /**
  * Map a raw value from the `initialPermissions` to a caveat specification.
  * Note that this function does not do any validation, that's handled by the
@@ -27,3 +27,4 @@ export declare function createMaxRequestTimeMapper(mapper: CaveatMapperFunction)
  */
 export declare function getMaxRequestTimeCaveat(permission?: PermissionConstraint): number | null;
 export declare const maxRequestTimeCaveatSpecifications: Record<SnapCaveatType.MaxRequestTime, CaveatSpecificationConstraint>;
+//# sourceMappingURL=requestTime.d.cts.map

package/dist/endowments/caveats/requestTime.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestTime.d.cts","sourceRoot":"","sources":["../../../src/endowments/caveats/requestTime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,6BAA6B,EAC7B,oBAAoB,EACrB,wCAAwC;AAEzC,OAAO,EAAwB,cAAc,EAAE,8BAA8B;AAC7E,OAAO,KAAK,EAA6B,IAAI,EAAE,wBAAwB;AAGvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,sBAAkB;AAwC/E;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,IAAI,GACV,uBAAuB,CAgBzB;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,oBAAoB,GAC3B,oBAAoB,CAsBtB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,CAAC,EAAE,oBAAoB,GAChC,MAAM,GAAG,IAAI,CAKf;AAED,eAAO,MAAM,kCAAkC,EAAE,MAAM,CACrD,cAAc,CAAC,cAAc,EAC7B,6BAA6B,CAO9B,CAAC"}