@metamask/snaps-rpc-methods 11.0.0 → 11.1.1

package/dist/restricted/caveats/permittedDerivationPaths.mjs

@@ -1,13 +1,64 @@
-import {
-  PermittedDerivationPathsCaveatSpecification,
-  permittedDerivationPathsCaveatMapper,
-  validateBIP32CaveatPaths,
-  validateBIP32Path
-} from "../../chunk-I2P65KBQ.mjs";
-export {
-  PermittedDerivationPathsCaveatSpecification,
-  permittedDerivationPathsCaveatMapper,
-  validateBIP32CaveatPaths,
-  validateBIP32Path
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { SnapCaveatType, Bip32EntropyStruct, isEqual } from "@metamask/snaps-utils";
+import { array, size, type } from "@metamask/superstruct";
+import { assertStruct } from "@metamask/utils";
+/**
+ * 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.
+ */
+export function permittedDerivationPathsCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.PermittedDerivationPaths,
+                value,
+            },
+        ],
+    };
+}
+/**
+ * Validate a caveat path object. The object must consist of a `path` array and
+ * a `curve` string. Paths must start with `m`, and must contain at
+ * least two indices. If `ed25519` is used, this checks if all the path indices
+ * are hardened.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is invalid.
+ */
+export function validateBIP32Path(value) {
+    assertStruct(value, Bip32EntropyStruct, 'Invalid BIP-32 entropy path definition', rpcErrors.invalidParams);
+}
+/**
+ * Validate the path values associated with a caveat. This validates that the
+ * value is a non-empty array with valid derivation paths and curves.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the value is invalid.
+ */
+export function validateBIP32CaveatPaths(caveat) {
+    assertStruct(caveat, type({ value: size(array(Bip32EntropyStruct), 1, Infinity) }), 'Invalid BIP-32 entropy caveat', rpcErrors.internal);
+}
+export const PermittedDerivationPathsCaveatSpecification = {
+    [SnapCaveatType.PermittedDerivationPaths]: Object.freeze({
+        type: SnapCaveatType.PermittedDerivationPaths,
+        decorator: (method, caveat) => {
+            return async (args) => {
+                const { params } = args;
+                validateBIP32Path(params);
+                const path = caveat.value.find((caveatPath) => isEqual(params.path.slice(0, caveatPath.path.length), caveatPath.path) && caveatPath.curve === params.curve);
+                if (!path) {
+                    throw providerErrors.unauthorized({
+                        message: 'The requested path is not permitted. Allowed paths must be specified in the snap manifest.',
+                    });
+                }
+                return await method(args);
+            };
+        },
+        validator: (caveat) => validateBIP32CaveatPaths(caveat),
+    }),
 };
 //# sourceMappingURL=permittedDerivationPaths.mjs.map

package/dist/restricted/caveats/permittedDerivationPaths.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"permittedDerivationPaths.mjs","sourceRoot":"","sources":["../../../src/restricted/caveats/permittedDerivationPaths.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAEjE,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,OAAO,EACR,8BAA8B;AAC/B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,8BAA8B;AAE1D,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAE/C;;;;;;;GAOG;AACH,MAAM,UAAU,oCAAoC,CAClD,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,cAAc,CAAC,wBAAwB;gBAC7C,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAc;IAEd,YAAY,CACV,KAAK,EACL,kBAAkB,EAClB,wCAAwC,EACxC,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAA2B;IAE3B,YAAY,CACV,MAAM,EACN,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAC7D,+BAA+B,EAC/B,SAAS,CAAC,QAAQ,CACnB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,2CAA2C,GAGpD;IACF,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACvD,IAAI,EAAE,cAAc,CAAC,wBAAwB;QAC7C,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC5B,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;gBACpB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBACxB,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAE1B,MAAM,IAAI,GAAI,MAAM,CAAC,KAAwB,CAAC,IAAI,CAChD,CAAC,UAAU,EAAE,EAAE,CACb,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAC5C,UAAU,CAAC,IAAI,CAChB,IAAI,UAAU,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,CACzC,CAAC;gBAEF,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,MAAM,cAAc,CAAC,YAAY,CAAC;wBAChC,OAAO,EACL,4FAA4F;qBAC/F,CAAC,CAAC;gBACL,CAAC;gBAED,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC,CAAC;QACJ,CAAC;QACD,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC;KACxD,CAAC;CACH,CAAC","sourcesContent":["import type {\n  Caveat,\n  PermissionConstraint,\n  RestrictedMethodCaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type { Bip32Entropy } from '@metamask/snaps-utils';\nimport {\n  SnapCaveatType,\n  Bip32EntropyStruct,\n  isEqual,\n} from '@metamask/snaps-utils';\nimport { array, size, type } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\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 permittedDerivationPathsCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.PermittedDerivationPaths,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Validate a caveat path object. The object must consist of a `path` array and\n * a `curve` string. Paths must start with `m`, and must contain at\n * least two indices. If `ed25519` is used, this checks if all the path indices\n * are hardened.\n *\n * @param value - The value to validate.\n * @throws If the value is invalid.\n */\nexport function validateBIP32Path(\n  value: unknown,\n): asserts value is Bip32Entropy {\n  assertStruct(\n    value,\n    Bip32EntropyStruct,\n    'Invalid BIP-32 entropy path definition',\n    rpcErrors.invalidParams,\n  );\n}\n\n/**\n * Validate the path values associated with a caveat. This validates that the\n * value is a non-empty array with valid derivation paths and curves.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateBIP32CaveatPaths(\n  caveat: Caveat<string, any>,\n): asserts caveat is Caveat<string, Bip32Entropy[]> {\n  assertStruct(\n    caveat,\n    type({ value: size(array(Bip32EntropyStruct), 1, Infinity) }),\n    'Invalid BIP-32 entropy caveat',\n    rpcErrors.internal,\n  );\n}\n\nexport const PermittedDerivationPathsCaveatSpecification: Record<\n  SnapCaveatType.PermittedDerivationPaths,\n  RestrictedMethodCaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.PermittedDerivationPaths]: Object.freeze({\n    type: SnapCaveatType.PermittedDerivationPaths,\n    decorator: (method, caveat) => {\n      return async (args) => {\n        const { params } = args;\n        validateBIP32Path(params);\n\n        const path = (caveat.value as Bip32Entropy[]).find(\n          (caveatPath) =>\n            isEqual(\n              params.path.slice(0, caveatPath.path.length),\n              caveatPath.path,\n            ) && caveatPath.curve === params.curve,\n        );\n\n        if (!path) {\n          throw providerErrors.unauthorized({\n            message:\n              'The requested path is not permitted. Allowed paths must be specified in the snap manifest.',\n          });\n        }\n\n        return await method(args);\n      };\n    },\n    validator: (caveat) => validateBIP32CaveatPaths(caveat),\n  }),\n};\n"]}

package/dist/restricted/caveats/snapIds.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapIdsCaveatSpecification = exports.validateSnapIdsCaveat = exports.snapIdsCaveatMapper = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+/**
+ * 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 snapIdsCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: snaps_utils_1.SnapCaveatType.SnapIds,
+                value,
+            },
+        ],
+    };
+}
+exports.snapIdsCaveatMapper = snapIdsCaveatMapper;
+/**
+ * Validates that the caveat value exists and is a non-empty object.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat is invalid.
+ */
+function validateSnapIdsCaveat(caveat) {
+    (0, utils_1.assertStruct)(caveat, (0, superstruct_1.type)({
+        value: snaps_utils_1.SnapIdsStruct,
+    }), 'Expected caveat to have a value property of a non-empty object of snap IDs.', rpc_errors_1.rpcErrors.invalidParams);
+}
+exports.validateSnapIdsCaveat = validateSnapIdsCaveat;
+exports.SnapIdsCaveatSpecification = {
+    [snaps_utils_1.SnapCaveatType.SnapIds]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.SnapIds,
+        validator: (caveat) => validateSnapIdsCaveat(caveat),
+        decorator: (method, caveat) => {
+            return async (args) => {
+                const { params, context: { origin }, } = args;
+                const snapIds = caveat.value;
+                const { snapId } = params;
+                if (!(0, utils_1.hasProperty)(snapIds, snapId)) {
+                    throw new Error(`${origin} does not have permission to invoke ${snapId} snap.`);
+                }
+                return await method(args);
+            };
+        },
+    }),
+};
+//# sourceMappingURL=snapIds.cjs.map

package/dist/restricted/caveats/snapIds.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapIds.cjs","sourceRoot":"","sources":["../../../src/restricted/caveats/snapIds.ts"],"names":[],"mappings":";;;AAOA,qDAAiD;AAEjD,uDAAsE;AACtE,uDAA6C;AAE7C,2CAA4D;AAI5D;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,OAAO;gBAC5B,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,kDAWC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,MAA2B;IAE3B,IAAA,oBAAY,EACV,MAAM,EACN,IAAA,kBAAI,EAAC;QACH,KAAK,EAAE,2BAAa;KACrB,CAAC,EACF,6EAA6E,EAC7E,sBAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAXD,sDAWC;AAEY,QAAA,0BAA0B,GAGnC;IACF,CAAC,4BAAc,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACtC,IAAI,EAAE,4BAAc,CAAC,OAAO;QAC5B,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACpD,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC5B,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;gBACpB,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAwD,IAAI,CAAC;gBAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAgB,CAAC;gBACxC,MAAM,EAAE,MAAM,EAAE,GAAG,MAA0B,CAAC;gBAC9C,IAAI,CAAC,IAAA,mBAAW,EAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,uCAAuC,MAAM,QAAQ,CAC/D,CAAC;gBACJ,CAAC;gBACD,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;CACH,CAAC","sourcesContent":["import type {\n  Caveat,\n  RestrictedMethodOptions,\n  RestrictedMethodParameters,\n  RestrictedMethodCaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { SnapIds } from '@metamask/snaps-utils';\nimport { SnapCaveatType, SnapIdsStruct } from '@metamask/snaps-utils';\nimport { type } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { hasProperty, assertStruct } from '@metamask/utils';\n\nimport type { InvokeSnapParams } from '../invokeSnap';\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 snapIdsCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapIds,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Validates that the caveat value exists and is a non-empty object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat is invalid.\n */\nexport function validateSnapIdsCaveat(\n  caveat: Caveat<string, any>,\n): asserts caveat is Caveat<string, SnapIds> {\n  assertStruct(\n    caveat,\n    type({\n      value: SnapIdsStruct,\n    }),\n    'Expected caveat to have a value property of a non-empty object of snap IDs.',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const SnapIdsCaveatSpecification: Record<\n  SnapCaveatType.SnapIds,\n  RestrictedMethodCaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SnapIds]: Object.freeze({\n    type: SnapCaveatType.SnapIds,\n    validator: (caveat) => validateSnapIdsCaveat(caveat),\n    decorator: (method, caveat) => {\n      return async (args) => {\n        const {\n          params,\n          context: { origin },\n        }: RestrictedMethodOptions<RestrictedMethodParameters> = args;\n        const snapIds = caveat.value as SnapIds;\n        const { snapId } = params as InvokeSnapParams;\n        if (!hasProperty(snapIds, snapId)) {\n          throw new Error(\n            `${origin} does not have permission to invoke ${snapId} snap.`,\n          );\n        }\n        return await method(args);\n      };\n    },\n  }),\n};\n"]}

package/dist/{types/restricted/caveats/snapIds.d.ts → restricted/caveats/snapIds.d.cts}

@@ -1,7 +1,7 @@
-import type { Caveat, RestrictedMethodCaveatSpecificationConstraint, PermissionConstraint } from '@metamask/permission-controller';
-import type { SnapIds } from '@metamask/snaps-utils';
-import { SnapCaveatType } from '@metamask/snaps-utils';
-import type { Json } from '@metamask/utils';
+import type { Caveat, RestrictedMethodCaveatSpecificationConstraint, PermissionConstraint } from "@metamask/permission-controller";
+import type { SnapIds } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json } from "@metamask/utils";
 /**
  * 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
@@ -19,3 +19,4 @@ export declare function snapIdsCaveatMapper(value: Json): Pick<PermissionConstra
  */
 export declare function validateSnapIdsCaveat(caveat: Caveat<string, any>): asserts caveat is Caveat<string, SnapIds>;
 export declare const SnapIdsCaveatSpecification: Record<SnapCaveatType.SnapIds, RestrictedMethodCaveatSpecificationConstraint>;
+//# sourceMappingURL=snapIds.d.cts.map

package/dist/restricted/caveats/snapIds.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapIds.d.cts","sourceRoot":"","sources":["../../../src/restricted/caveats/snapIds.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EAGN,6CAA6C,EAC7C,oBAAoB,EACrB,wCAAwC;AAEzC,OAAO,KAAK,EAAE,OAAO,EAAE,8BAA8B;AACrD,OAAO,EAAE,cAAc,EAAiB,8BAA8B;AAEtE,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAK5C;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC1B,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAS3C;AAED,eAAO,MAAM,0BAA0B,EAAE,MAAM,CAC7C,cAAc,CAAC,OAAO,EACtB,6CAA6C,CAsB9C,CAAC"}

package/dist/restricted/caveats/snapIds.d.mts

@@ -0,0 +1,22 @@
+import type { Caveat, RestrictedMethodCaveatSpecificationConstraint, PermissionConstraint } from "@metamask/permission-controller";
+import type { SnapIds } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json } from "@metamask/utils";
+/**
+ * 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.
+ */
+export declare function snapIdsCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Validates that the caveat value exists and is a non-empty object.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat is invalid.
+ */
+export declare function validateSnapIdsCaveat(caveat: Caveat<string, any>): asserts caveat is Caveat<string, SnapIds>;
+export declare const SnapIdsCaveatSpecification: Record<SnapCaveatType.SnapIds, RestrictedMethodCaveatSpecificationConstraint>;
+//# sourceMappingURL=snapIds.d.mts.map

package/dist/restricted/caveats/snapIds.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapIds.d.mts","sourceRoot":"","sources":["../../../src/restricted/caveats/snapIds.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EAGN,6CAA6C,EAC7C,oBAAoB,EACrB,wCAAwC;AAEzC,OAAO,KAAK,EAAE,OAAO,EAAE,8BAA8B;AACrD,OAAO,EAAE,cAAc,EAAiB,8BAA8B;AAEtE,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAK5C;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC1B,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAS3C;AAED,eAAO,MAAM,0BAA0B,EAAE,MAAM,CAC7C,cAAc,CAAC,OAAO,EACtB,6CAA6C,CAsB9C,CAAC"}

package/dist/restricted/caveats/snapIds.mjs

@@ -1,11 +1,51 @@
-import {
-  SnapIdsCaveatSpecification,
-  snapIdsCaveatMapper,
-  validateSnapIdsCaveat
-} from "../../chunk-FJ7COFRJ.mjs";
-export {
-  SnapIdsCaveatSpecification,
-  snapIdsCaveatMapper,
-  validateSnapIdsCaveat
+import { rpcErrors } from "@metamask/rpc-errors";
+import { SnapCaveatType, SnapIdsStruct } from "@metamask/snaps-utils";
+import { type } from "@metamask/superstruct";
+import { hasProperty, assertStruct } from "@metamask/utils";
+/**
+ * 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.
+ */
+export function snapIdsCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.SnapIds,
+                value,
+            },
+        ],
+    };
+}
+/**
+ * Validates that the caveat value exists and is a non-empty object.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat is invalid.
+ */
+export function validateSnapIdsCaveat(caveat) {
+    assertStruct(caveat, type({
+        value: SnapIdsStruct,
+    }), 'Expected caveat to have a value property of a non-empty object of snap IDs.', rpcErrors.invalidParams);
+}
+export const SnapIdsCaveatSpecification = {
+    [SnapCaveatType.SnapIds]: Object.freeze({
+        type: SnapCaveatType.SnapIds,
+        validator: (caveat) => validateSnapIdsCaveat(caveat),
+        decorator: (method, caveat) => {
+            return async (args) => {
+                const { params, context: { origin }, } = args;
+                const snapIds = caveat.value;
+                const { snapId } = params;
+                if (!hasProperty(snapIds, snapId)) {
+                    throw new Error(`${origin} does not have permission to invoke ${snapId} snap.`);
+                }
+                return await method(args);
+            };
+        },
+    }),
 };
 //# sourceMappingURL=snapIds.mjs.map

package/dist/restricted/caveats/snapIds.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"snapIds.mjs","sourceRoot":"","sources":["../../../src/restricted/caveats/snapIds.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,8BAA8B;AACtE,OAAO,EAAE,IAAI,EAAE,8BAA8B;AAE7C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,wBAAwB;AAI5D;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAA2B;IAE3B,YAAY,CACV,MAAM,EACN,IAAI,CAAC;QACH,KAAK,EAAE,aAAa;KACrB,CAAC,EACF,6EAA6E,EAC7E,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAGnC;IACF,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACtC,IAAI,EAAE,cAAc,CAAC,OAAO;QAC5B,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACpD,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC5B,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;gBACpB,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAwD,IAAI,CAAC;gBAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAgB,CAAC;gBACxC,MAAM,EAAE,MAAM,EAAE,GAAG,MAA0B,CAAC;gBAC9C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,uCAAuC,MAAM,QAAQ,CAC/D,CAAC;gBACJ,CAAC;gBACD,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;CACH,CAAC","sourcesContent":["import type {\n  Caveat,\n  RestrictedMethodOptions,\n  RestrictedMethodParameters,\n  RestrictedMethodCaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { SnapIds } from '@metamask/snaps-utils';\nimport { SnapCaveatType, SnapIdsStruct } from '@metamask/snaps-utils';\nimport { type } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { hasProperty, assertStruct } from '@metamask/utils';\n\nimport type { InvokeSnapParams } from '../invokeSnap';\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 snapIdsCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapIds,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Validates that the caveat value exists and is a non-empty object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat is invalid.\n */\nexport function validateSnapIdsCaveat(\n  caveat: Caveat<string, any>,\n): asserts caveat is Caveat<string, SnapIds> {\n  assertStruct(\n    caveat,\n    type({\n      value: SnapIdsStruct,\n    }),\n    'Expected caveat to have a value property of a non-empty object of snap IDs.',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const SnapIdsCaveatSpecification: Record<\n  SnapCaveatType.SnapIds,\n  RestrictedMethodCaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SnapIds]: Object.freeze({\n    type: SnapCaveatType.SnapIds,\n    validator: (caveat) => validateSnapIdsCaveat(caveat),\n    decorator: (method, caveat) => {\n      return async (args) => {\n        const {\n          params,\n          context: { origin },\n        }: RestrictedMethodOptions<RestrictedMethodParameters> = args;\n        const snapIds = caveat.value as SnapIds;\n        const { snapId } = params as InvokeSnapParams;\n        if (!hasProperty(snapIds, snapId)) {\n          throw new Error(\n            `${origin} does not have permission to invoke ${snapId} snap.`,\n          );\n        }\n        return await method(args);\n      };\n    },\n  }),\n};\n"]}

package/dist/restricted/dialog.cjs

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDialogImplementation = exports.dialogBuilder = exports.DIALOG_APPROVAL_TYPES = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const methodName = 'snap_dialog';
+exports.DIALOG_APPROVAL_TYPES = {
+    [snaps_sdk_1.DialogType.Alert]: `${methodName}:alert`,
+    [snaps_sdk_1.DialogType.Confirmation]: `${methodName}:confirmation`,
+    [snaps_sdk_1.DialogType.Prompt]: `${methodName}:prompt`,
+    default: methodName,
+};
+const PlaceholderStruct = (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.string)(), 1, 40));
+/**
+ * The specification builder for the `snap_dialog` permission. `snap_dialog`
+ * lets the Snap display one of the following dialogs to the user:
+ * - An alert, for displaying information.
+ * - A confirmation, for accepting or rejecting some action.
+ * - A prompt, for inputting some information.
+ *
+ * @param options - The specification builder options.
+ * @param options.allowedCaveats - The optional allowed caveats for the
+ * permission.
+ * @param options.methodHooks - The RPC method hooks needed by the method
+ * implementation.
+ * @returns The specification for the `snap_dialog` permission.
+ */
+const specificationBuilder = ({ allowedCaveats = null, methodHooks, }) => {
+    return {
+        permissionType: permission_controller_1.PermissionType.RestrictedMethod,
+        targetName: methodName,
+        allowedCaveats,
+        methodImplementation: getDialogImplementation(methodHooks),
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+const methodHooks = {
+    requestUserApproval: true,
+    createInterface: true,
+    getInterface: true,
+};
+exports.dialogBuilder = Object.freeze({
+    targetName: methodName,
+    specificationBuilder,
+    methodHooks,
+});
+const AlertParametersWithContentStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Alert),
+    content: snaps_sdk_1.ComponentOrElementStruct,
+});
+const AlertParametersWithIdStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Alert),
+    id: (0, superstruct_1.string)(),
+});
+const AlertParametersStruct = (0, snaps_sdk_1.selectiveUnion)((value) => {
+    if ((0, utils_1.isPlainObject)(value) && (0, utils_1.hasProperty)(value, 'id')) {
+        return AlertParametersWithIdStruct;
+    }
+    return AlertParametersWithContentStruct;
+});
+const ConfirmationParametersWithContentStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Confirmation),
+    content: snaps_sdk_1.ComponentOrElementStruct,
+});
+const ConfirmationParametersWithIdStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Confirmation),
+    id: (0, superstruct_1.string)(),
+});
+const ConfirmationParametersStruct = (0, snaps_sdk_1.selectiveUnion)((value) => {
+    if ((0, utils_1.isPlainObject)(value) && (0, utils_1.hasProperty)(value, 'id')) {
+        return ConfirmationParametersWithIdStruct;
+    }
+    return ConfirmationParametersWithContentStruct;
+});
+const PromptParametersWithContentStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Prompt),
+    content: snaps_sdk_1.ComponentOrElementStruct,
+    placeholder: PlaceholderStruct,
+});
+const PromptParametersWithIdStruct = (0, superstruct_1.object)({
+    type: (0, snaps_sdk_1.enumValue)(snaps_sdk_1.DialogType.Prompt),
+    id: (0, superstruct_1.string)(),
+    placeholder: PlaceholderStruct,
+});
+const PromptParametersStruct = (0, snaps_sdk_1.selectiveUnion)((value) => {
+    if ((0, utils_1.isPlainObject)(value) && (0, utils_1.hasProperty)(value, 'id')) {
+        return PromptParametersWithIdStruct;
+    }
+    return PromptParametersWithContentStruct;
+});
+const DefaultParametersWithContentStruct = (0, superstruct_1.object)({
+    content: snaps_sdk_1.ComponentOrElementStruct,
+});
+const DefaultParametersWithIdStruct = (0, superstruct_1.object)({
+    id: (0, superstruct_1.string)(),
+});
+const DefaultParametersStruct = (0, snaps_sdk_1.selectiveUnion)((value) => {
+    if ((0, utils_1.isPlainObject)(value) && (0, utils_1.hasProperty)(value, 'id')) {
+        return DefaultParametersWithIdStruct;
+    }
+    return DefaultParametersWithContentStruct;
+});
+const DialogParametersStruct = (0, snaps_sdk_1.selectiveUnion)((value) => {
+    if ((0, utils_1.isPlainObject)(value) && (0, utils_1.hasProperty)(value, 'type')) {
+        switch (value.type) {
+            // We cannot use typedUnion here unfortunately.
+            case snaps_sdk_1.DialogType.Alert:
+                return AlertParametersStruct;
+            case snaps_sdk_1.DialogType.Confirmation:
+                return ConfirmationParametersStruct;
+            case snaps_sdk_1.DialogType.Prompt:
+                return PromptParametersStruct;
+            default:
+                throw new Error(`The "type" property must be one of: ${Object.values(snaps_sdk_1.DialogType).join(', ')}.`);
+        }
+    }
+    return DefaultParametersStruct;
+});
+/**
+ * Builds the method implementation for `snap_dialog`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.requestUserApproval - A function that creates a new Approval in the ApprovalController.
+ * This function should return a Promise that resolves with the appropriate value when the user has approved or rejected the request.
+ * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.
+ * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.
+ * @returns The method implementation which return value depends on the dialog
+ * type, valid return types are: string, boolean, null.
+ */
+function getDialogImplementation({ requestUserApproval, createInterface, getInterface, }) {
+    return async function dialogImplementation(args) {
+        const { params, context: { origin }, } = args;
+        if (!(0, utils_1.isObject)(params)) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: 'Invalid params: Expected params to be a single object.',
+            });
+        }
+        const validatedParams = getValidatedParams(params);
+        const placeholder = isPromptDialog(validatedParams)
+            ? validatedParams.placeholder
+            : undefined;
+        const validatedType = (0, utils_1.hasProperty)(validatedParams, 'type')
+            ? validatedParams.type
+            : 'default';
+        const approvalType = exports.DIALOG_APPROVAL_TYPES[validatedType];
+        if ((0, utils_1.hasProperty)(validatedParams, 'content')) {
+            const id = await createInterface(origin, validatedParams.content);
+            return requestUserApproval({
+                id: approvalType === exports.DIALOG_APPROVAL_TYPES.default ? id : undefined,
+                origin,
+                type: approvalType,
+                requestData: { id, placeholder },
+            });
+        }
+        validateInterface(origin, validatedParams.id, getInterface);
+        return requestUserApproval({
+            id: approvalType === exports.DIALOG_APPROVAL_TYPES.default
+                ? validatedParams.id
+                : undefined,
+            origin,
+            type: approvalType,
+            requestData: { id: validatedParams.id, placeholder },
+        });
+    };
+}
+exports.getDialogImplementation = getDialogImplementation;
+/**
+ * Validate that the interface ID is valid.
+ *
+ * @param origin - The origin of the request.
+ * @param id - The interface ID.
+ * @param getInterface - The function to get the interface.
+ */
+function validateInterface(origin, id, getInterface) {
+    try {
+        getInterface(origin, id);
+    }
+    catch (error) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: `Invalid params: ${error.message}`,
+        });
+    }
+}
+/**
+ * Gets the dialog type from the dialog parameters.
+ *
+ * @param params - The dialog parameters.
+ * @returns The dialog type.
+ */
+function getDialogType(params) {
+    return (0, utils_1.hasProperty)(params, 'type') ? params.type : undefined;
+}
+/**
+ * Checks if the dialog parameters are for a prompt dialog.
+ *
+ * @param params - The dialog parameters.
+ * @returns `true` if the dialog parameters are for a prompt dialog, `false` otherwise.
+ */
+function isPromptDialog(params) {
+    return getDialogType(params) === snaps_sdk_1.DialogType.Prompt;
+}
+/**
+ * Validates the confirm method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated confirm method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, DialogParametersStruct);
+    }
+    catch (error) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: `Invalid params: ${error.message}`,
+        });
+    }
+}
+//# sourceMappingURL=dialog.cjs.map

package/dist/restricted/dialog.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.cjs","sourceRoot":"","sources":["../../src/restricted/dialog.ts"],"names":[],"mappings":";;;AAKA,2EAA8E;AAC9E,qDAAiD;AACjD,mDAK6B;AAW7B,uDAA+E;AAE/E,2CAAuE;AAIvE,MAAM,UAAU,GAAG,aAAa,CAAC;AAMpB,QAAA,qBAAqB,GAAG;IACnC,CAAC,sBAAU,CAAC,KAAK,CAAC,EAAE,GAAG,UAAU,QAAQ;IACzC,CAAC,sBAAU,CAAC,YAAY,CAAC,EAAE,GAAG,UAAU,eAAe;IACvD,CAAC,sBAAU,CAAC,MAAM,CAAC,EAAE,GAAG,UAAU,SAAS;IAC3C,OAAO,EAAE,UAAU;CACpB,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAgE1D;;;;;;;;;;;;;GAaG;AACH,MAAM,oBAAoB,GAItB,CAAC,EACH,cAAc,GAAG,IAAI,EACrB,WAAW,GACuB,EAAE,EAAE;IACtC,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,UAAU;QACtB,cAAc;QACd,oBAAoB,EAAE,uBAAuB,CAAC,WAAW,CAAC;QAC1D,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAyC;IACxD,mBAAmB,EAAE,IAAI;IACzB,eAAe,EAAE,IAAI;IACrB,YAAY,EAAE,IAAI;CACnB,CAAC;AAEW,QAAA,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,UAAU;IACtB,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ,MAAM,gCAAgC,GAAG,IAAA,oBAAM,EAAC;IAC9C,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,oCAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,IAAA,oBAAM,EAAC;IACzC,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,KAAK,CAAC;IACjC,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,IAAA,0BAAc,EAAC,CAAC,KAAK,EAAE,EAAE;IACrD,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,2BAA2B,CAAC;IACrC,CAAC;IACD,OAAO,gCAAgC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,IAAA,oBAAM,EAAC;IACrD,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,YAAY,CAAC;IACxC,OAAO,EAAE,oCAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IAChD,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,YAAY,CAAC;IACxC,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,IAAA,0BAAc,EAAC,CAAC,KAAK,EAAE,EAAE;IAC5D,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IACD,OAAO,uCAAuC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,MAAM,iCAAiC,GAAG,IAAA,oBAAM,EAAC;IAC/C,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,MAAM,CAAC;IAClC,OAAO,EAAE,oCAAwB;IACjC,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,IAAA,oBAAM,EAAC;IAC1C,IAAI,EAAE,IAAA,qBAAS,EAAC,sBAAU,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAA,0BAAc,EAAC,CAAC,KAAK,EAAE,EAAE;IACtD,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,4BAA4B,CAAC;IACtC,CAAC;IACD,OAAO,iCAAiC,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IAChD,OAAO,EAAE,oCAAwB;CAClC,CAAC,CAAC;AAEH,MAAM,6BAA6B,GAAG,IAAA,oBAAM,EAAC;IAC3C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,IAAA,0BAAc,EAAC,CAAC,KAAK,EAAE,EAAE;IACvD,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,6BAA6B,CAAC;IACvC,CAAC;IACD,OAAO,kCAAkC,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAA,0BAAc,EAAC,CAAC,KAAK,EAAE,EAAE;IACtD,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACvD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,+CAA+C;YAC/C,KAAK,sBAAU,CAAC,KAAK;gBACnB,OAAO,qBAAqB,CAAC;YAC/B,KAAK,sBAAU,CAAC,YAAY;gBAC1B,OAAO,4BAA4B,CAAC;YACtC,KAAK,sBAAU,CAAC,MAAM;gBACpB,OAAO,sBAAsB,CAAC;YAChC;gBACE,MAAM,IAAI,KAAK,CACb,uCAAuC,MAAM,CAAC,MAAM,CAAC,sBAAU,CAAC,CAAC,IAAI,CACnE,IAAI,CACL,GAAG,CACL,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC,CAAC,CAAC;AAOH;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CAAC,EACtC,mBAAmB,EACnB,eAAe,EACf,YAAY,GACM;IAClB,OAAO,KAAK,UAAU,oBAAoB,CACxC,IAA+C;QAE/C,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAG,IAAI,CAAC;QAET,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;YACtB,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,wDAAwD;aAClE,CAAC,CAAC;QACL,CAAC;QAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC;YACjD,CAAC,CAAC,eAAe,CAAC,WAAW;YAC7B,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,aAAa,GAAG,IAAA,mBAAW,EAAC,eAAe,EAAE,MAAM,CAAC;YACxD,CAAC,CAAC,eAAe,CAAC,IAAI;YACtB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,YAAY,GAChB,6BAAqB,CACnB,aAAmD,CACpD,CAAC;QAEJ,IAAI,IAAA,mBAAW,EAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC;YAC5C,MAAM,EAAE,GAAG,MAAM,eAAe,CAC9B,MAAM,EACN,eAAe,CAAC,OAAoB,CACrC,CAAC;YAEF,OAAO,mBAAmB,CAAC;gBACzB,EAAE,EAAE,YAAY,KAAK,6BAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;gBACnE,MAAM;gBACN,IAAI,EAAE,YAAY;gBAClB,WAAW,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;aACjC,CAAC,CAAC;QACL,CAAC;QAED,iBAAiB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,mBAAmB,CAAC;YACzB,EAAE,EACA,YAAY,KAAK,6BAAqB,CAAC,OAAO;gBAC5C,CAAC,CAAC,eAAe,CAAC,EAAE;gBACpB,CAAC,CAAC,SAAS;YACf,MAAM;YACN,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,WAAW,EAAE;SACrD,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AA3DD,0DA2DC;AACD;;;;;;GAMG;AACH,SAAS,iBAAiB,CACxB,MAAc,EACd,EAAU,EACV,YAA0B;IAE1B,IAAI,CAAC;QACH,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,MAAwB;IAC7C,OAAO,IAAA,mBAAW,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,MAAM,CAAC,IAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,MAAwB;IAC9C,OAAO,aAAa,CAAC,MAAM,CAAC,KAAK,sBAAU,CAAC,MAAM,CAAC;AACrD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  DialogType,\n  enumValue,\n  ComponentOrElementStruct,\n  selectiveUnion,\n} from '@metamask/snaps-sdk';\nimport type {\n  DialogParams,\n  Component,\n  InterfaceState,\n  SnapId,\n  PromptDialog,\n  ComponentOrElement,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { create, object, optional, size, string } from '@metamask/superstruct';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isObject, isPlainObject } from '@metamask/utils';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_dialog';\n\nexport type DialogApprovalTypes = Record<DialogType, string> & {\n  default: string;\n};\n\nexport const DIALOG_APPROVAL_TYPES = {\n  [DialogType.Alert]: `${methodName}:alert`,\n  [DialogType.Confirmation]: `${methodName}:confirmation`,\n  [DialogType.Prompt]: `${methodName}:prompt`,\n  default: methodName,\n};\n\nconst PlaceholderStruct = optional(size(string(), 1, 40));\n\nexport type Placeholder = Infer<typeof PlaceholderStruct>;\n\ntype RequestUserApprovalOptions = {\n  id?: string;\n  origin: string;\n  type: string;\n  requestData: {\n    id: string;\n    placeholder?: string;\n  };\n};\n\ntype RequestUserApproval = (\n  opts: RequestUserApprovalOptions,\n) => Promise<boolean | null | string | Json>;\n\ntype CreateInterface = (\n  snapId: string,\n  content: ComponentOrElement,\n) => Promise<string>;\n\ntype GetInterface = (\n  snapId: string,\n  id: string,\n) => { content: ComponentOrElement; snapId: SnapId; state: InterfaceState };\n\nexport type DialogMethodHooks = {\n  /**\n   * @param opts - The `requestUserApproval` options.\n   * @param opts.id - The approval ID. If not provided, a new approval ID will be generated.\n   * @param opts.origin - The origin of the request. In this case, the Snap ID.\n   * @param opts.type - The type of the approval request.\n   * @param opts.requestData - The data of the approval request.\n   * @param opts.requestData.id - The ID of the interface.\n   * @param opts.requestData.placeholder - The placeholder of the `Prompt` dialog.\n   */\n  requestUserApproval: RequestUserApproval;\n\n  /**\n   * @param snapId - The Snap ID creating the interface.\n   * @param content - The content of the interface.\n   */\n  createInterface: CreateInterface;\n  /**\n   * @param snapId - The SnapId requesting the interface.\n   * @param id - The interface ID.\n   */\n  getInterface: GetInterface;\n};\n\ntype DialogSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: DialogMethodHooks;\n};\n\ntype DialogSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getDialogImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_dialog` permission. `snap_dialog`\n * lets the Snap display one of the following dialogs to the user:\n * - An alert, for displaying information.\n * - A confirmation, for accepting or rejecting some action.\n * - A prompt, for inputting some information.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the\n * permission.\n * @param options.methodHooks - The RPC method hooks needed by the method\n * implementation.\n * @returns The specification for the `snap_dialog` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  DialogSpecificationBuilderOptions,\n  DialogSpecification\n> = ({\n  allowedCaveats = null,\n  methodHooks,\n}: DialogSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getDialogImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<DialogMethodHooks> = {\n  requestUserApproval: true,\n  createInterface: true,\n  getInterface: true,\n};\n\nexport const dialogBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\nconst AlertParametersWithContentStruct = object({\n  type: enumValue(DialogType.Alert),\n  content: ComponentOrElementStruct,\n});\n\nconst AlertParametersWithIdStruct = object({\n  type: enumValue(DialogType.Alert),\n  id: string(),\n});\n\nconst AlertParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return AlertParametersWithIdStruct;\n  }\n  return AlertParametersWithContentStruct;\n});\n\nconst ConfirmationParametersWithContentStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  content: ComponentOrElementStruct,\n});\n\nconst ConfirmationParametersWithIdStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  id: string(),\n});\n\nconst ConfirmationParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return ConfirmationParametersWithIdStruct;\n  }\n  return ConfirmationParametersWithContentStruct;\n});\n\nconst PromptParametersWithContentStruct = object({\n  type: enumValue(DialogType.Prompt),\n  content: ComponentOrElementStruct,\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersWithIdStruct = object({\n  type: enumValue(DialogType.Prompt),\n  id: string(),\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return PromptParametersWithIdStruct;\n  }\n  return PromptParametersWithContentStruct;\n});\n\nconst DefaultParametersWithContentStruct = object({\n  content: ComponentOrElementStruct,\n});\n\nconst DefaultParametersWithIdStruct = object({\n  id: string(),\n});\n\nconst DefaultParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'id')) {\n    return DefaultParametersWithIdStruct;\n  }\n  return DefaultParametersWithContentStruct;\n});\n\nconst DialogParametersStruct = selectiveUnion((value) => {\n  if (isPlainObject(value) && hasProperty(value, 'type')) {\n    switch (value.type) {\n      // We cannot use typedUnion here unfortunately.\n      case DialogType.Alert:\n        return AlertParametersStruct;\n      case DialogType.Confirmation:\n        return ConfirmationParametersStruct;\n      case DialogType.Prompt:\n        return PromptParametersStruct;\n      default:\n        throw new Error(\n          `The \"type\" property must be one of: ${Object.values(DialogType).join(\n            ', ',\n          )}.`,\n        );\n    }\n  }\n  return DefaultParametersStruct;\n});\n\nexport type DialogParameters = InferMatching<\n  typeof DialogParametersStruct,\n  DialogParams\n>;\n\n/**\n * Builds the method implementation for `snap_dialog`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.requestUserApproval - A function that creates a new Approval in the ApprovalController.\n * This function should return a Promise that resolves with the appropriate value when the user has approved or rejected the request.\n * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.\n * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.\n * @returns The method implementation which return value depends on the dialog\n * type, valid return types are: string, boolean, null.\n */\nexport function getDialogImplementation({\n  requestUserApproval,\n  createInterface,\n  getInterface,\n}: DialogMethodHooks) {\n  return async function dialogImplementation(\n    args: RestrictedMethodOptions<DialogParameters>,\n  ): Promise<boolean | null | string | Json> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    if (!isObject(params)) {\n      throw rpcErrors.invalidParams({\n        message: 'Invalid params: Expected params to be a single object.',\n      });\n    }\n\n    const validatedParams = getValidatedParams(params);\n    const placeholder = isPromptDialog(validatedParams)\n      ? validatedParams.placeholder\n      : undefined;\n\n    const validatedType = hasProperty(validatedParams, 'type')\n      ? validatedParams.type\n      : 'default';\n\n    const approvalType =\n      DIALOG_APPROVAL_TYPES[\n        validatedType as keyof typeof DIALOG_APPROVAL_TYPES\n      ];\n\n    if (hasProperty(validatedParams, 'content')) {\n      const id = await createInterface(\n        origin,\n        validatedParams.content as Component,\n      );\n\n      return requestUserApproval({\n        id: approvalType === DIALOG_APPROVAL_TYPES.default ? id : undefined,\n        origin,\n        type: approvalType,\n        requestData: { id, placeholder },\n      });\n    }\n\n    validateInterface(origin, validatedParams.id, getInterface);\n\n    return requestUserApproval({\n      id:\n        approvalType === DIALOG_APPROVAL_TYPES.default\n          ? validatedParams.id\n          : undefined,\n      origin,\n      type: approvalType,\n      requestData: { id: validatedParams.id, placeholder },\n    });\n  };\n}\n/**\n * Validate that the interface ID is valid.\n *\n * @param origin - The origin of the request.\n * @param id - The interface ID.\n * @param getInterface - The function to get the interface.\n */\nfunction validateInterface(\n  origin: string,\n  id: string,\n  getInterface: GetInterface,\n) {\n  try {\n    getInterface(origin, id);\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${error.message}`,\n    });\n  }\n}\n\n/**\n * Gets the dialog type from the dialog parameters.\n *\n * @param params - The dialog parameters.\n * @returns The dialog type.\n */\nfunction getDialogType(params: DialogParameters): DialogType | undefined {\n  return hasProperty(params, 'type') ? (params.type as DialogType) : undefined;\n}\n\n/**\n * Checks if the dialog parameters are for a prompt dialog.\n *\n * @param params - The dialog parameters.\n * @returns `true` if the dialog parameters are for a prompt dialog, `false` otherwise.\n */\nfunction isPromptDialog(params: DialogParameters): params is PromptDialog {\n  return getDialogType(params) === DialogType.Prompt;\n}\n\n/**\n * Validates the confirm method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated confirm method parameter object.\n */\nfunction getValidatedParams(params: unknown): DialogParameters {\n  try {\n    return create(params, DialogParametersStruct);\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${error.message}`,\n    });\n  }\n}\n"]}