@metamask/snaps-rpc-methods 14.2.0 → 15.0.0

package/dist/permitted/getFile.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.cts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAiB,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAO3D,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAMF,eAAO,MAAM,cAAc,EAAE,sBAAsB,CACjD,YAAY,EACZ,qBAAqB,EACrB,MAAM,CAKP,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC"}
+{"version":3,"file":"getFile.d.cts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAQF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;;CAIoD,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,cAAc,CAAC,qBAAqB,CAAC,EAC1C,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAoBf"}

package/dist/permitted/getFile.d.mts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetFileParams } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { GetFileParams, GetFileResult } from "@metamask/snaps-sdk";
 import type { InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     path: string;
     encoding?: "base64" | "hex" | "utf8" | undefined;
@@ -9,8 +11,52 @@ export declare const GetFileArgsStruct: import("@metamask/superstruct").Struct<{
     encoding: import("@metamask/superstruct").Struct<"base64" | "hex" | "utf8" | undefined, null>;
 }>;
 export type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetFileParams>;
-export declare const getFileHandler: PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;
+/**
+ * Gets a static file's content in UTF-8, Base64, or hexadecimal.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
+export declare const getFileHandler: {
+    methodNames: ["snap_getFile"];
+    implementation: typeof implementation;
+    hookNames: MethodHooksObject<GetFileHooks>;
+};
 export type GetFileHooks = {
     getSnapFile: (path: InferredGetFileParams['path'], encoding: InferredGetFileParams['encoding']) => Promise<string>;
 };
+/**
+ * The `snap_getFile` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.getSnapFile - The function to load a static snap file.
+ * @returns Nothing.
+ */
+declare function implementation(req: JsonRpcRequest<InferredGetFileParams>, res: PendingJsonRpcResponse<GetFileResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getSnapFile }: GetFileHooks): Promise<void>;
+export {};
 //# sourceMappingURL=getFile.d.mts.map

package/dist/permitted/getFile.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.mts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAiB,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAO3D,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAMF,eAAO,MAAM,cAAc,EAAE,sBAAsB,CACjD,YAAY,EACZ,qBAAqB,EACrB,MAAM,CAKP,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC"}
+{"version":3,"file":"getFile.d.mts","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,4BAA4B;AAExE,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAElD,eAAO,MAAM,iBAAiB;;;;;;EAS5B,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,OAAO,iBAAiB,EACxB,aAAa,CACd,CAAC;AAQF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;;;;CAIoD,CAAC;AAEhF,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,EACnC,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,KACxC,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,cAAc,CAAC,qBAAqB,CAAC,EAC1C,GAAG,EAAE,sBAAsB,CAAC,aAAa,CAAC,EAC1C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,WAAW,EAAE,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAoBf"}

package/dist/permitted/getFile.mjs

@@ -10,11 +10,38 @@ export const GetFileArgsStruct = object({
         enumValue(AuxiliaryFileEncoding.Utf8),
     ])),
 });
+const methodName = 'snap_getFile';
 const hookNames = {
     getSnapFile: true,
 };
+/**
+ * Gets a static file's content in UTF-8, Base64, or hexadecimal.
+ *
+ * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "source": {
+ *     "files": ["./files/my-file.bin"]
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * const contents = await snap.request({
+ *   method: 'snap_getFile',
+ *   params: {
+ *     path: './files/myfile.bin',
+ *     encoding: 'hex',
+ *   },
+ * })
+ *
+ * // '0x...'
+ * console.log(contents)
+ * ```
+ */
 export const getFileHandler = {
-    methodNames: ['snap_getFile'],
+    methodNames: [methodName],
     implementation,
     hookNames,
 };

package/dist/permitted/getFile.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.mjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,4BAA4B;AAEvE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,8BAA8B;AAExE,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAI/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,EAAE;IACd,QAAQ,EAAE,QAAQ,CAChB,KAAK,CAAC;QACJ,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACvC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC;QACpC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AAOH,MAAM,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAIvB;IACF,WAAW,EAAE,CAAC,cAAc,CAAC;IAC7B,cAAc;IACd,SAAS;CACV,CAAC;AASF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAA0C,EAC1C,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAgB;IAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,YAAY,CACV,MAAM,EACN,iBAAiB,EACjB,mCAAmC,EACnC,SAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,WAAW,CAC5B,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAChD,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nconst hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\nexport const getFileHandler: PermittedHandlerExport<\n  GetFileHooks,\n  InferredGetFileParams,\n  string\n> = {\n  methodNames: ['snap_getFile'],\n  implementation,\n  hookNames,\n};\n\nexport type GetFileHooks = {\n  getSnapFile: (\n    path: InferredGetFileParams['path'],\n    encoding: InferredGetFileParams['encoding'],\n  ) => Promise<string>;\n};\n\n/**\n * The `snap_getFile` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getSnapFile - The function to load a static snap file.\n * @returns Nothing.\n */\nasync function implementation(\n  req: JsonRpcRequest<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getSnapFile }: GetFileHooks,\n): Promise<void> {\n  const { params } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await getSnapFile(\n      params.path,\n      params.encoding ?? AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"getFile.mjs","sourceRoot":"","sources":["../../src/permitted/getFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,4BAA4B;AAEvE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,8BAA8B;AAExE,OAAO,EAAE,YAAY,EAAE,wBAAwB;AAI/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,EAAE;IACd,QAAQ,EAAE,QAAQ,CAChB,KAAK,CAAC;QACJ,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC;QACvC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC;QACpC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAC;AAOH,MAAM,UAAU,GAAG,cAAc,CAAC;AAElC,MAAM,SAAS,GAAoC;IACjD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc;IACd,SAAS;CACoE,CAAC;AAShF;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAA0C,EAC1C,GAA0C,EAC1C,KAAc,EACd,GAA6B,EAC7B,EAAE,WAAW,EAAgB;IAE7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,YAAY,CACV,MAAM,EACN,iBAAiB,EACjB,mCAAmC,EACnC,SAAS,CAAC,aAAa,CACxB,CAAC;IAEF,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,MAAM,WAAW,CAC5B,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,IAAI,qBAAqB,CAAC,MAAM,CAChD,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetFileParams, GetFileResult } from '@metamask/snaps-sdk';\nimport { AuxiliaryFileEncoding, enumValue } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, optional, string, union } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\nimport { assertStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nexport const GetFileArgsStruct = object({\n  path: string(),\n  encoding: optional(\n    union([\n      enumValue(AuxiliaryFileEncoding.Base64),\n      enumValue(AuxiliaryFileEncoding.Hex),\n      enumValue(AuxiliaryFileEncoding.Utf8),\n    ]),\n  ),\n});\n\nexport type InferredGetFileParams = InferMatching<\n  typeof GetFileArgsStruct,\n  GetFileParams\n>;\n\nconst methodName = 'snap_getFile';\n\nconst hookNames: MethodHooksObject<GetFileHooks> = {\n  getSnapFile: true,\n};\n\n/**\n * Gets a static file's content in UTF-8, Base64, or hexadecimal.\n *\n * The file must be specified in [the Snap's manifest file](https://docs.metamask.io/snaps/features/static-files/).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"source\": {\n *     \"files\": [\"./files/my-file.bin\"]\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * const contents = await snap.request({\n *   method: 'snap_getFile',\n *   params: {\n *     path: './files/myfile.bin',\n *     encoding: 'hex',\n *   },\n * })\n *\n * // '0x...'\n * console.log(contents)\n * ```\n */\nexport const getFileHandler = {\n  methodNames: [methodName] as const,\n  implementation,\n  hookNames,\n} satisfies PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;\n\nexport type GetFileHooks = {\n  getSnapFile: (\n    path: InferredGetFileParams['path'],\n    encoding: InferredGetFileParams['encoding'],\n  ) => Promise<string>;\n};\n\n/**\n * The `snap_getFile` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getSnapFile - The function to load a static snap file.\n * @returns Nothing.\n */\nasync function implementation(\n  req: JsonRpcRequest<InferredGetFileParams>,\n  res: PendingJsonRpcResponse<GetFileResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getSnapFile }: GetFileHooks,\n): Promise<void> {\n  const { params } = req;\n\n  assertStruct(\n    params,\n    GetFileArgsStruct,\n    'Invalid \"snap_getFile\" parameters',\n    rpcErrors.invalidParams,\n  );\n\n  try {\n    res.result = await getSnapFile(\n      params.path,\n      params.encoding ?? AuxiliaryFileEncoding.Base64,\n    );\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/getInterfaceContext.cjs

@@ -3,11 +3,50 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInterfaceContextHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("../utils.cjs");
+const methodName = 'snap_getInterfaceContext';
 const hookNames = {
+    hasPermission: true,
     getInterfaceContext: true,
 };
+/**
+ * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
+ * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+ *
+ * @example
+ * ```ts
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = await snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Hello, world!</Heading>
+ *         <Text>Welcome to my Snap homepage!</Text>
+ *       </Box>
+ *     ),
+ *     context: {
+ *       key: 'value'
+ *     }
+ *   },
+ * })
+ *
+ * const context = await snap.request({
+ *   method: 'snap_getInterfaceContext',
+ *   params: {
+ *     id: interfaceId,
+ *   },
+ * })
+ *
+ * console.log(context)
+ * // {
+ * //   key: 'value'
+ * // }
+ * ```
+ */
 exports.getInterfaceContextHandler = {
-    methodNames: ['snap_getInterfaceContext'],
+    methodNames: [methodName],
     implementation: getInterfaceContextImplementation,
     hookNames,
 };
@@ -23,10 +62,17 @@ const GetInterfaceContextParametersStruct = (0, superstruct_1.object)({
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if the Snap has a given
+ * permission.
  * @param hooks.getInterfaceContext - The function to get the interface context.
- * @returns Noting.
+ * @returns Nothing.
  */
-function getInterfaceContextImplementation(req, res, _next, end, { getInterfaceContext }) {
+function getInterfaceContextImplementation(req, res, _next, end, { hasPermission, getInterfaceContext }) {
+    if (!utils_1.UI_PERMISSIONS.some(hasPermission)) {
+        return end(rpc_errors_1.providerErrors.unauthorized({
+            message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
+        }));
+    }
     const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);

package/dist/permitted/getInterfaceContext.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceContext.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,uDAA4E;AAK5E,MAAM,SAAS,GAAsD;IACnE,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAUW,QAAA,0BAA0B,GAInC;IACF,WAAW,EAAE,CAAC,0BAA0B,CAAC;IACzC,cAAc,EAAE,iCAAiC;IACjD,SAAS;CACV,CAAC;AAEF,MAAM,mCAAmC,GAAG,IAAA,oBAAM,EAAC;IACjD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,iCAAiC,CACxC,GAAkD,EAClD,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,mBAAmB,EAAkC;IAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n  InterfaceContext,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetInterfaceContextMethodHooks> = {\n  getInterfaceContext: true,\n};\n\nexport type GetInterfaceContextMethodHooks = {\n  /**\n   * @param id - The interface ID.\n   * @returns The interface context.\n   */\n  getInterfaceContext: (id: string) => InterfaceContext | null;\n};\n\nexport const getInterfaceContextHandler: PermittedHandlerExport<\n  GetInterfaceContextMethodHooks,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult\n> = {\n  methodNames: ['snap_getInterfaceContext'],\n  implementation: getInterfaceContextImplementation,\n  hookNames,\n};\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getInterfaceContext - The function to get the interface context.\n * @returns Noting.\n */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequest<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getInterfaceContext }: GetInterfaceContextMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceContext(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext 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 getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"getInterfaceContext.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAQjE,uDAA4E;AAI5E,wCAA0C;AAE1C,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C,MAAM,SAAS,GAAsD;IACnE,aAAa,EAAE,IAAI;IACnB,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAgBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACU,QAAA,0BAA0B,GAAG;IACxC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,iCAAiC;IACjD,SAAS;CAKV,CAAC;AAEF,MAAM,mCAAmC,GAAG,IAAA,oBAAM,EAAC;IACjD,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,iCAAiC,CACxC,GAAkD,EAClD,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,mBAAmB,EAAkC;IAEtE,IAAI,CAAC,sBAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n  InterfaceContext,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_getInterfaceContext';\n\nconst hookNames: MethodHooksObject<GetInterfaceContextMethodHooks> = {\n  hasPermission: true,\n  getInterfaceContext: true,\n};\n\nexport type GetInterfaceContextMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @returns The interface context.\n   */\n  getInterfaceContext: (id: string) => InterfaceContext | null;\n};\n\n/**\n * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)\n * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n *\n * @example\n * ```ts\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         <Heading>Hello, world!</Heading>\n *         <Text>Welcome to my Snap homepage!</Text>\n *       </Box>\n *     ),\n *     context: {\n *       key: 'value'\n *     }\n *   },\n * })\n *\n * const context = await snap.request({\n *   method: 'snap_getInterfaceContext',\n *   params: {\n *     id: interfaceId,\n *   },\n * })\n *\n * console.log(context)\n * // {\n * //   key: 'value'\n * // }\n * ```\n */\nexport const getInterfaceContextHandler = {\n  methodNames: [methodName] as const,\n  implementation: getInterfaceContextImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetInterfaceContextMethodHooks,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult\n>;\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.getInterfaceContext - The function to get the interface context.\n * @returns Nothing.\n */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequest<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getInterfaceContext }: GetInterfaceContextMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceContext(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext 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 getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/getInterfaceContext.d.cts

@@ -1,19 +1,81 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetInterfaceContextParams, GetInterfaceContextResult, InterfaceContext } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { GetInterfaceContextParams, GetInterfaceContextResult, InterfaceContext, JsonRpcRequest } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export type GetInterfaceContextMethodHooks = {
+    /**
+     * @param permissionName - The name of the permission to check.
+     * @returns Whether the Snap has the permission.
+     */
+    hasPermission: (permissionName: string) => boolean;
     /**
      * @param id - The interface ID.
      * @returns The interface context.
      */
     getInterfaceContext: (id: string) => InterfaceContext | null;
 };
-export declare const getInterfaceContextHandler: PermittedHandlerExport<GetInterfaceContextMethodHooks, GetInterfaceContextParameters, GetInterfaceContextResult>;
+/**
+ * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
+ * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+ *
+ * @example
+ * ```ts
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = await snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Hello, world!</Heading>
+ *         <Text>Welcome to my Snap homepage!</Text>
+ *       </Box>
+ *     ),
+ *     context: {
+ *       key: 'value'
+ *     }
+ *   },
+ * })
+ *
+ * const context = await snap.request({
+ *   method: 'snap_getInterfaceContext',
+ *   params: {
+ *     id: interfaceId,
+ *   },
+ * })
+ *
+ * console.log(context)
+ * // {
+ * //   key: 'value'
+ * // }
+ * ```
+ */
+export declare const getInterfaceContextHandler: {
+    methodNames: ["snap_getInterfaceContext"];
+    implementation: typeof getInterfaceContextImplementation;
+    hookNames: MethodHooksObject<GetInterfaceContextMethodHooks>;
+};
 declare const GetInterfaceContextParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
 }, {
     id: import("@metamask/superstruct").Struct<string, null>;
 }>;
 export type GetInterfaceContextParameters = InferMatching<typeof GetInterfaceContextParametersStruct, GetInterfaceContextParams>;
+/**
+ * The `snap_getInterfaceContext` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if the Snap has a given
+ * permission.
+ * @param hooks.getInterfaceContext - The function to get the interface context.
+ * @returns Nothing.
+ */
+declare function getInterfaceContextImplementation(req: JsonRpcRequest<GetInterfaceContextParameters>, res: PendingJsonRpcResponse<GetInterfaceContextResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getInterfaceContext }: GetInterfaceContextMethodHooks): void;
 export {};
 //# sourceMappingURL=getInterfaceContext.d.cts.map

package/dist/permitted/getInterfaceContext.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceContext.d.cts","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,gBAAgB,EAEjB,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,gBAAgB,GAAG,IAAI,CAAC;CAC9D,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAC7D,8BAA8B,EAC9B,6BAA6B,EAC7B,yBAAyB,CAK1B,CAAC;AAEF,QAAA,MAAM,mCAAmC;;;;EAEvC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,aAAa,CACvD,OAAO,mCAAmC,EAC1C,yBAAyB,CAC1B,CAAC"}
+{"version":3,"file":"getInterfaceContext.d.cts","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACf,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;OAGG;IACH,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,gBAAgB,GAAG,IAAI,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,0BAA0B;;;;CAQtC,CAAC;AAEF,QAAA,MAAM,mCAAmC;;;;EAEvC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,aAAa,CACvD,OAAO,mCAAmC,EAC1C,yBAAyB,CAC1B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,iCAAiC,CACxC,GAAG,EAAE,cAAc,CAAC,6BAA6B,CAAC,EAClD,GAAG,EAAE,sBAAsB,CAAC,yBAAyB,CAAC,EACtD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,mBAAmB,EAAE,EAAE,8BAA8B,GACrE,IAAI,CAsBN"}

package/dist/permitted/getInterfaceContext.d.mts

@@ -1,19 +1,81 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { GetInterfaceContextParams, GetInterfaceContextResult, InterfaceContext } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { GetInterfaceContextParams, GetInterfaceContextResult, InterfaceContext, JsonRpcRequest } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export type GetInterfaceContextMethodHooks = {
+    /**
+     * @param permissionName - The name of the permission to check.
+     * @returns Whether the Snap has the permission.
+     */
+    hasPermission: (permissionName: string) => boolean;
     /**
      * @param id - The interface ID.
      * @returns The interface context.
      */
     getInterfaceContext: (id: string) => InterfaceContext | null;
 };
-export declare const getInterfaceContextHandler: PermittedHandlerExport<GetInterfaceContextMethodHooks, GetInterfaceContextParameters, GetInterfaceContextResult>;
+/**
+ * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
+ * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+ *
+ * @example
+ * ```ts
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = await snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Hello, world!</Heading>
+ *         <Text>Welcome to my Snap homepage!</Text>
+ *       </Box>
+ *     ),
+ *     context: {
+ *       key: 'value'
+ *     }
+ *   },
+ * })
+ *
+ * const context = await snap.request({
+ *   method: 'snap_getInterfaceContext',
+ *   params: {
+ *     id: interfaceId,
+ *   },
+ * })
+ *
+ * console.log(context)
+ * // {
+ * //   key: 'value'
+ * // }
+ * ```
+ */
+export declare const getInterfaceContextHandler: {
+    methodNames: ["snap_getInterfaceContext"];
+    implementation: typeof getInterfaceContextImplementation;
+    hookNames: MethodHooksObject<GetInterfaceContextMethodHooks>;
+};
 declare const GetInterfaceContextParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
 }, {
     id: import("@metamask/superstruct").Struct<string, null>;
 }>;
 export type GetInterfaceContextParameters = InferMatching<typeof GetInterfaceContextParametersStruct, GetInterfaceContextParams>;
+/**
+ * The `snap_getInterfaceContext` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if the Snap has a given
+ * permission.
+ * @param hooks.getInterfaceContext - The function to get the interface context.
+ * @returns Nothing.
+ */
+declare function getInterfaceContextImplementation(req: JsonRpcRequest<GetInterfaceContextParameters>, res: PendingJsonRpcResponse<GetInterfaceContextResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, getInterfaceContext }: GetInterfaceContextMethodHooks): void;
 export {};
 //# sourceMappingURL=getInterfaceContext.d.mts.map

package/dist/permitted/getInterfaceContext.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceContext.d.mts","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,gBAAgB,EAEjB,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,gBAAgB,GAAG,IAAI,CAAC;CAC9D,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAC7D,8BAA8B,EAC9B,6BAA6B,EAC7B,yBAAyB,CAK1B,CAAC;AAEF,QAAA,MAAM,mCAAmC;;;;EAEvC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,aAAa,CACvD,OAAO,mCAAmC,EAC1C,yBAAyB,CAC1B,CAAC"}
+{"version":3,"file":"getInterfaceContext.d.mts","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,gBAAgB,EAChB,cAAc,EACf,4BAA4B;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;OAGG;IACH,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,gBAAgB,GAAG,IAAI,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,0BAA0B;;;;CAQtC,CAAC;AAEF,QAAA,MAAM,mCAAmC;;;;EAEvC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,aAAa,CACvD,OAAO,mCAAmC,EAC1C,yBAAyB,CAC1B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,iCAAiC,CACxC,GAAG,EAAE,cAAc,CAAC,6BAA6B,CAAC,EAClD,GAAG,EAAE,sBAAsB,CAAC,yBAAyB,CAAC,EACtD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,mBAAmB,EAAE,EAAE,8BAA8B,GACrE,IAAI,CAsBN"}

package/dist/permitted/getInterfaceContext.mjs

@@ -1,10 +1,49 @@
-import { rpcErrors } from "@metamask/rpc-errors";
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
 import { StructError, create, object, string } from "@metamask/superstruct";
+import { UI_PERMISSIONS } from "../utils.mjs";
+const methodName = 'snap_getInterfaceContext';
 const hookNames = {
+    hasPermission: true,
     getInterfaceContext: true,
 };
+/**
+ * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
+ * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+ *
+ * @example
+ * ```ts
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = await snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Hello, world!</Heading>
+ *         <Text>Welcome to my Snap homepage!</Text>
+ *       </Box>
+ *     ),
+ *     context: {
+ *       key: 'value'
+ *     }
+ *   },
+ * })
+ *
+ * const context = await snap.request({
+ *   method: 'snap_getInterfaceContext',
+ *   params: {
+ *     id: interfaceId,
+ *   },
+ * })
+ *
+ * console.log(context)
+ * // {
+ * //   key: 'value'
+ * // }
+ * ```
+ */
 export const getInterfaceContextHandler = {
-    methodNames: ['snap_getInterfaceContext'],
+    methodNames: [methodName],
     implementation: getInterfaceContextImplementation,
     hookNames,
 };
@@ -20,10 +59,17 @@ const GetInterfaceContextParametersStruct = object({
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if the Snap has a given
+ * permission.
  * @param hooks.getInterfaceContext - The function to get the interface context.
- * @returns Noting.
+ * @returns Nothing.
  */
-function getInterfaceContextImplementation(req, res, _next, end, { getInterfaceContext }) {
+function getInterfaceContextImplementation(req, res, _next, end, { hasPermission, getInterfaceContext }) {
+    if (!UI_PERMISSIONS.some(hasPermission)) {
+        return end(providerErrors.unauthorized({
+            message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,
+        }));
+    }
     const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);

package/dist/permitted/getInterfaceContext.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceContext.mjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAQjD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAK5E,MAAM,SAAS,GAAsD;IACnE,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAUF,MAAM,CAAC,MAAM,0BAA0B,GAInC;IACF,WAAW,EAAE,CAAC,0BAA0B,CAAC;IACzC,cAAc,EAAE,iCAAiC;IACjD,SAAS;CACV,CAAC;AAEF,MAAM,mCAAmC,GAAG,MAAM,CAAC;IACjD,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,iCAAiC,CACxC,GAAkD,EAClD,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,mBAAmB,EAAkC;IAEvD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n  InterfaceContext,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetInterfaceContextMethodHooks> = {\n  getInterfaceContext: true,\n};\n\nexport type GetInterfaceContextMethodHooks = {\n  /**\n   * @param id - The interface ID.\n   * @returns The interface context.\n   */\n  getInterfaceContext: (id: string) => InterfaceContext | null;\n};\n\nexport const getInterfaceContextHandler: PermittedHandlerExport<\n  GetInterfaceContextMethodHooks,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult\n> = {\n  methodNames: ['snap_getInterfaceContext'],\n  implementation: getInterfaceContextImplementation,\n  hookNames,\n};\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getInterfaceContext - The function to get the interface context.\n * @returns Noting.\n */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequest<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getInterfaceContext }: GetInterfaceContextMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceContext(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext 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 getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"getInterfaceContext.mjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAQjE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B;AAI5E,OAAO,EAAE,cAAc,EAAE,qBAAiB;AAE1C,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAE9C,MAAM,SAAS,GAAsD;IACnE,aAAa,EAAE,IAAI;IACnB,mBAAmB,EAAE,IAAI;CAC1B,CAAC;AAgBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,iCAAiC;IACjD,SAAS;CAKV,CAAC;AAEF,MAAM,mCAAmC,GAAG,MAAM,CAAC;IACjD,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,iCAAiC,CACxC,GAAkD,EAClD,GAAsD,EACtD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,mBAAmB,EAAkC;IAEtE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,cAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceContextParams,\n  GetInterfaceContextResult,\n  InterfaceContext,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_getInterfaceContext';\n\nconst hookNames: MethodHooksObject<GetInterfaceContextMethodHooks> = {\n  hasPermission: true,\n  getInterfaceContext: true,\n};\n\nexport type GetInterfaceContextMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @returns The interface context.\n   */\n  getInterfaceContext: (id: string) => InterfaceContext | null;\n};\n\n/**\n * Get the context of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)\n * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n *\n * @example\n * ```ts\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         <Heading>Hello, world!</Heading>\n *         <Text>Welcome to my Snap homepage!</Text>\n *       </Box>\n *     ),\n *     context: {\n *       key: 'value'\n *     }\n *   },\n * })\n *\n * const context = await snap.request({\n *   method: 'snap_getInterfaceContext',\n *   params: {\n *     id: interfaceId,\n *   },\n * })\n *\n * console.log(context)\n * // {\n * //   key: 'value'\n * // }\n * ```\n */\nexport const getInterfaceContextHandler = {\n  methodNames: [methodName] as const,\n  implementation: getInterfaceContextImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetInterfaceContextMethodHooks,\n  GetInterfaceContextParameters,\n  GetInterfaceContextResult\n>;\n\nconst GetInterfaceContextParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceContextParameters = InferMatching<\n  typeof GetInterfaceContextParametersStruct,\n  GetInterfaceContextParams\n>;\n\n/**\n * The `snap_getInterfaceContext` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.getInterfaceContext - The function to get the interface context.\n * @returns Nothing.\n */\nfunction getInterfaceContextImplementation(\n  req: JsonRpcRequest<GetInterfaceContextParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceContextResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getInterfaceContext }: GetInterfaceContextMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceContext(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceContext 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 getInterfaceContext method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceContextParameters {\n  try {\n    return create(params, GetInterfaceContextParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/getInterfaceState.cjs

@@ -3,11 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInterfaceStateHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("../utils.cjs");
+const methodName = 'snap_getInterfaceState';
 const hookNames = {
+    hasPermission: true,
     getInterfaceState: true,
 };
+/**
+ * Get the form state of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
+ * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+ *
+ * @example
+ * ```ts
+ * const state = await snap.request({
+ *   method: 'snap_getInterfaceState',
+ *   params: {
+ *     id: interfaceId,
+ *   },
+ * });
+ * ```
+ */
 exports.getInterfaceStateHandler = {
-    methodNames: ['snap_getInterfaceState'],
+    methodNames: [methodName],
     implementation: getGetInterfaceStateImplementation,
     hookNames,
 };
@@ -23,10 +40,17 @@ const GetInterfaceStateParametersStruct = (0, superstruct_1.object)({
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
+ * @param hooks.hasPermission - The function to check if the Snap has a given
+ * permission.
  * @param hooks.getInterfaceState - The function to get the interface state.
- * @returns Noting.
+ * @returns Nothing.
  */
-function getGetInterfaceStateImplementation(req, res, _next, end, { getInterfaceState }) {
+function getGetInterfaceStateImplementation(req, res, _next, end, { hasPermission, getInterfaceState }) {
+    if (!utils_1.UI_PERMISSIONS.some(hasPermission)) {
+        return end(rpc_errors_1.providerErrors.unauthorized({
+            message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
+        }));
+    }
     const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);

package/dist/permitted/getInterfaceState.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"getInterfaceState.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceState.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,uDAA4E;AAK5E,MAAM,SAAS,GAAoD;IACjE,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAUW,QAAA,wBAAwB,GAIjC;IACF,WAAW,EAAE,CAAC,wBAAwB,CAAC;IACvC,cAAc,EAAE,kCAAkC;IAClD,SAAS;CACV,CAAC;AAEF,MAAM,iCAAiC,GAAG,IAAA,oBAAM,EAAC;IAC/C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,kCAAkC,CACzC,GAAgD,EAChD,GAAoD,EACpD,KAAc,EACd,GAA6B,EAC7B,EAAE,iBAAiB,EAAgC;IAEnD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceStateParams,\n  GetInterfaceStateResult,\n  InterfaceState,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetInterfaceStateMethodHooks> = {\n  getInterfaceState: true,\n};\n\nexport type GetInterfaceStateMethodHooks = {\n  /**\n   * @param id - The interface ID.\n   * @returns The interface state.\n   */\n  getInterfaceState: (id: string) => InterfaceState;\n};\n\nexport const getInterfaceStateHandler: PermittedHandlerExport<\n  GetInterfaceStateMethodHooks,\n  GetInterfaceStateParameters,\n  GetInterfaceStateResult\n> = {\n  methodNames: ['snap_getInterfaceState'],\n  implementation: getGetInterfaceStateImplementation,\n  hookNames,\n};\n\nconst GetInterfaceStateParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceStateParameters = InferMatching<\n  typeof GetInterfaceStateParametersStruct,\n  GetInterfaceStateParams\n>;\n\n/**\n * The `snap_getInterfaceState` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getInterfaceState - The function to get the interface state.\n * @returns Noting.\n */\nfunction getGetInterfaceStateImplementation(\n  req: JsonRpcRequest<GetInterfaceStateParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getInterfaceState }: GetInterfaceStateMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceState(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceState 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 getInterfaceState method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceStateParameters {\n  try {\n    return create(params, GetInterfaceStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"getInterfaceState.cjs","sourceRoot":"","sources":["../../src/permitted/getInterfaceState.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAQjE,uDAA4E;AAI5E,wCAA0C;AAE1C,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAE5C,MAAM,SAAS,GAAoD;IACjE,aAAa,EAAE,IAAI;IACnB,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAgBF;;;;;;;;;;;;;GAaG;AACU,QAAA,wBAAwB,GAAG;IACtC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,kCAAkC;IAClD,SAAS;CAKV,CAAC;AAEF,MAAM,iCAAiC,GAAG,IAAA,oBAAM,EAAC;IAC/C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,kCAAkC,CACzC,GAAgD,EAChD,GAAoD,EACpD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,iBAAiB,EAAgC;IAElE,IAAI,CAAC,sBAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC;QAE/B,GAAG,CAAC,MAAM,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  GetInterfaceStateParams,\n  GetInterfaceStateResult,\n  InterfaceState,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, string } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_getInterfaceState';\n\nconst hookNames: MethodHooksObject<GetInterfaceStateMethodHooks> = {\n  hasPermission: true,\n  getInterfaceState: true,\n};\n\nexport type GetInterfaceStateMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @returns The interface state.\n   */\n  getInterfaceState: (id: string) => InterfaceState;\n};\n\n/**\n * Get the form state of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)\n * created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n *\n * @example\n * ```ts\n * const state = await snap.request({\n *   method: 'snap_getInterfaceState',\n *   params: {\n *     id: interfaceId,\n *   },\n * });\n * ```\n */\nexport const getInterfaceStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: getGetInterfaceStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  GetInterfaceStateMethodHooks,\n  GetInterfaceStateParameters,\n  GetInterfaceStateResult\n>;\n\nconst GetInterfaceStateParametersStruct = object({\n  id: string(),\n});\n\nexport type GetInterfaceStateParameters = InferMatching<\n  typeof GetInterfaceStateParametersStruct,\n  GetInterfaceStateParams\n>;\n\n/**\n * The `snap_getInterfaceState` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.getInterfaceState - The function to get the interface state.\n * @returns Nothing.\n */\nfunction getGetInterfaceStateImplementation(\n  req: JsonRpcRequest<GetInterfaceStateParameters>,\n  res: PendingJsonRpcResponse<GetInterfaceStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, getInterfaceState }: GetInterfaceStateMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id } = validatedParams;\n\n    res.result = getInterfaceState(id);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the getInterfaceState 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 getInterfaceState method parameter object.\n */\nfunction getValidatedParams(params: unknown): GetInterfaceStateParameters {\n  try {\n    return create(params, GetInterfaceStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}