@metamask/snaps-rpc-methods 14.2.0 → 15.0.0

package/dist/permitted/clearState.d.mts

@@ -1,10 +1,26 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
 import type { ClearStateParams, ClearStateResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
-export declare const clearStateHandler: PermittedHandlerExport<ClearStateHooks, ClearStateParameters, ClearStateResult>;
+export declare const clearStateHandler: {
+    methodNames: ["snap_clearState"];
+    implementation: typeof clearStateImplementation;
+    hookNames: MethodHooksObject<ClearStateHooks>;
+};
 export type ClearStateHooks = {
     /**
      * A function that clears the state of the requesting Snap.
@@ -24,5 +40,21 @@ declare const ClearStateParametersStruct: import("@metamask/superstruct").Struct
     encrypted: import("@metamask/superstruct").Struct<boolean | undefined, null>;
 }>;
 export type ClearStateParameters = InferMatching<typeof ClearStateParametersStruct, ClearStateParams>;
+/**
+ * The `snap_clearState` method implementation.
+ *
+ * @param request - The JSON-RPC request object.
+ * @param response - 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.clearSnapState - A function that clears the state of the
+ * requesting Snap.
+ * @param hooks.hasPermission - Check whether a given origin has a given
+ * permission.
+ * @returns Nothing.
+ */
+declare function clearStateImplementation(request: JsonRpcRequest<ClearStateParameters>, response: PendingJsonRpcResponse<ClearStateResult>, _next: unknown, end: JsonRpcEngineEndCallback, { clearSnapState, hasPermission }: ClearStateHooks): Promise<void>;
 export {};
 //# sourceMappingURL=clearState.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"clearState.d.mts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAkB3D;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,eAAe,EACf,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC"}
+{"version":3,"file":"clearState.d.mts","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,wBAAwB;AAG9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,wBAAwB,CACrC,OAAO,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAC7C,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAE,EAAE,eAAe,GACjD,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/dist/permitted/clearState.mjs

@@ -1,15 +1,26 @@
 import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
 import { boolean, create, object, optional, StructError } from "@metamask/superstruct";
 import { manageStateBuilder } from "../restricted/manageState.mjs";
+const methodName = 'snap_clearState';
 const hookNames = {
     clearSnapState: true,
     hasPermission: true,
 };
 /**
- * `snap_clearState` clears the state of the Snap.
+ * Clear the entire state of the Snap.
+ *
+ * @example
+ * ```ts
+ * await snap.request({
+ *   method: 'snap_clearState',
+ *   params: {
+ *     encrypted: true, // Optional, defaults to true
+ *   },
+ * });
+ * ```
  */
 export const clearStateHandler = {
-    methodNames: ['snap_clearState'],
+    methodNames: [methodName],
     implementation: clearStateImplementation,
     hookNames,
 };

package/dist/permitted/clearState.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"clearState.mjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAG/D,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CACV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,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;QAED,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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * `snap_clearState` clears the state of the Snap.\n */\nexport const clearStateHandler: PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n> = {\n  methodNames: ['snap_clearState'],\n  implementation: clearStateImplementation,\n  hookNames,\n};\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - 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.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"clearState.mjs","sourceRoot":"","sources":["../../src/permitted/clearState.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAGjE,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,WAAW,EACZ,8BAA8B;AAG/B,OAAO,EAAE,kBAAkB,EAAE,sCAAkC;AAG/D,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAAuC;IACpD,cAAc,EAAE,IAAI;IACpB,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,wBAAwB;IACxC,SAAS;CAKV,CAAC;AAiBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,cAAc,EAAE,aAAa,EAAmB;IAElD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC;QAE7C,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAgB;IAC1C,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,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;QAED,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 { ClearStateParams, ClearStateResult } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  create,\n  object,\n  optional,\n  StructError,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse, JsonRpcRequest } from '@metamask/utils';\n\nimport { manageStateBuilder } from '../restricted/manageState';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_clearState';\n\nconst hookNames: MethodHooksObject<ClearStateHooks> = {\n  clearSnapState: true,\n  hasPermission: true,\n};\n\n/**\n * Clear the entire state of the Snap.\n *\n * @example\n * ```ts\n * await snap.request({\n *   method: 'snap_clearState',\n *   params: {\n *     encrypted: true, // Optional, defaults to true\n *   },\n * });\n * ```\n */\nexport const clearStateHandler = {\n  methodNames: [methodName] as const,\n  implementation: clearStateImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  ClearStateHooks,\n  ClearStateParameters,\n  ClearStateResult\n>;\n\nexport type ClearStateHooks = {\n  /**\n   * A function that clears the state of the requesting Snap.\n   */\n  clearSnapState: (encrypted: boolean) => void;\n\n  /**\n   * Check if the requesting origin has a given permission.\n   *\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the origin has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n};\n\nconst ClearStateParametersStruct = object({\n  encrypted: optional(boolean()),\n});\n\nexport type ClearStateParameters = InferMatching<\n  typeof ClearStateParametersStruct,\n  ClearStateParams\n>;\n\n/**\n * The `snap_clearState` method implementation.\n *\n * @param request - The JSON-RPC request object.\n * @param response - 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.clearSnapState - A function that clears the state of the\n * requesting Snap.\n * @param hooks.hasPermission - Check whether a given origin has a given\n * permission.\n * @returns Nothing.\n */\nasync function clearStateImplementation(\n  request: JsonRpcRequest<ClearStateParameters>,\n  response: PendingJsonRpcResponse<ClearStateResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { clearSnapState, hasPermission }: ClearStateHooks,\n): Promise<void> {\n  const { params } = request;\n\n  if (!hasPermission(manageStateBuilder.targetName)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const { encrypted = true } = validatedParams;\n\n    clearSnapState(encrypted);\n    response.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters of the `snap_clearState` method.\n *\n * @param params - The parameters to validate.\n * @returns The validated parameters.\n */\nfunction getValidatedParams(params?: unknown) {\n  try {\n    return create(params, ClearStateParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/closeWebSocket.cjs

@@ -4,6 +4,7 @@ exports.closeWebSocketHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const endowments_1 = require("../endowments/index.cjs");
+const methodName = 'snap_closeWebSocket';
 const hookNames = {
     hasPermission: true,
     closeWebSocket: true,
@@ -12,10 +13,26 @@ const CloseWebSocketParametersStruct = (0, superstruct_1.object)({
     id: (0, superstruct_1.string)(),
 });
 /**
- * Handler for the `snap_closeWebSocket` method.
+ * Closes a WebSocket connection that was previously opened with
+ * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * await snap.request({
+ *   method: 'snap_closeWebSocket',
+ *   params: { id: 'websocket-1' },
+ * });
+ * ```
  */
 exports.closeWebSocketHandler = {
-    methodNames: ['snap_closeWebSocket'],
+    methodNames: [methodName],
     implementation: closeWebSocketImplementation,
     hookNames,
 };

package/dist/permitted/closeWebSocket.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"closeWebSocket.cjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,IAAA,oBAAM,EAAC;IAC5C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,qBAAqB,GAI9B;IACF,WAAW,EAAE,CAAC,qBAAqB,CAAC;IACpC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Handler for the `snap_closeWebSocket` method.\n */\nexport const closeWebSocketHandler: PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n> = {\n  methodNames: ['snap_closeWebSocket'],\n  implementation: closeWebSocketImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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":"closeWebSocket.cjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAOjE,uDAA4E;AAG5E,wDAA+C;AAG/C,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,IAAA,oBAAM,EAAC;IAC5C,EAAE,EAAE,IAAA,oBAAM,GAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,qBAAqB,GAAG;IACnC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_closeWebSocket';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Closes a WebSocket connection that was previously opened with\n * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"endowment:network-access\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * await snap.request({\n *   method: 'snap_closeWebSocket',\n *   params: { id: 'websocket-1' },\n * });\n * ```\n */\nexport const closeWebSocketHandler = {\n  methodNames: [methodName] as const,\n  implementation: closeWebSocketImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n>;\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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/closeWebSocket.d.cts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { CloseWebSocketParams, CloseWebSocketResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, CloseWebSocketParams, CloseWebSocketResult } 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 CloseWebSocketMethodHooks = {
     hasPermission: (permissionName: string) => boolean;
     closeWebSocket: (id: string) => void;
@@ -12,8 +14,41 @@ declare const CloseWebSocketParametersStruct: import("@metamask/superstruct").St
 }>;
 export type CloseWebSocketParameters = InferMatching<typeof CloseWebSocketParametersStruct, CloseWebSocketParams>;
 /**
- * Handler for the `snap_closeWebSocket` method.
+ * Closes a WebSocket connection that was previously opened with
+ * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * await snap.request({
+ *   method: 'snap_closeWebSocket',
+ *   params: { id: 'websocket-1' },
+ * });
+ * ```
  */
-export declare const closeWebSocketHandler: PermittedHandlerExport<CloseWebSocketMethodHooks, CloseWebSocketParams, CloseWebSocketResult>;
+export declare const closeWebSocketHandler: {
+    methodNames: ["snap_closeWebSocket"];
+    implementation: typeof closeWebSocketImplementation;
+    hookNames: MethodHooksObject<CloseWebSocketMethodHooks>;
+};
+/**
+ * The `snap_closeWebSocket` 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 a snap has the `endowment:network-access` permission.
+ * @param hooks.closeWebSocket - The function to close a WebSocket.
+ * @returns Nothing.
+ */
+declare function closeWebSocketImplementation(req: JsonRpcRequest<CloseWebSocketParameters>, res: PendingJsonRpcResponse<CloseWebSocketResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks): void;
 export {};
 //# sourceMappingURL=closeWebSocket.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"closeWebSocket.d.cts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAY3D,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACtC,CAAC;AAEF,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,sBAAsB,CACxD,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,CAKrB,CAAC"}
+{"version":3,"file":"closeWebSocket.d.cts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACtC,CAAC;AAEF,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB;;;;CAQjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,4BAA4B,CACnC,GAAG,EAAE,cAAc,CAAC,wBAAwB,CAAC,EAC7C,GAAG,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,EACjD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,cAAc,EAAE,EAAE,yBAAyB,GAC3D,IAAI,CAgBN"}

package/dist/permitted/closeWebSocket.d.mts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { CloseWebSocketParams, CloseWebSocketResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, CloseWebSocketParams, CloseWebSocketResult } 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 CloseWebSocketMethodHooks = {
     hasPermission: (permissionName: string) => boolean;
     closeWebSocket: (id: string) => void;
@@ -12,8 +14,41 @@ declare const CloseWebSocketParametersStruct: import("@metamask/superstruct").St
 }>;
 export type CloseWebSocketParameters = InferMatching<typeof CloseWebSocketParametersStruct, CloseWebSocketParams>;
 /**
- * Handler for the `snap_closeWebSocket` method.
+ * Closes a WebSocket connection that was previously opened with
+ * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * await snap.request({
+ *   method: 'snap_closeWebSocket',
+ *   params: { id: 'websocket-1' },
+ * });
+ * ```
  */
-export declare const closeWebSocketHandler: PermittedHandlerExport<CloseWebSocketMethodHooks, CloseWebSocketParams, CloseWebSocketResult>;
+export declare const closeWebSocketHandler: {
+    methodNames: ["snap_closeWebSocket"];
+    implementation: typeof closeWebSocketImplementation;
+    hookNames: MethodHooksObject<CloseWebSocketMethodHooks>;
+};
+/**
+ * The `snap_closeWebSocket` 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 a snap has the `endowment:network-access` permission.
+ * @param hooks.closeWebSocket - The function to close a WebSocket.
+ * @returns Nothing.
+ */
+declare function closeWebSocketImplementation(req: JsonRpcRequest<CloseWebSocketParameters>, res: PendingJsonRpcResponse<CloseWebSocketResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks): void;
 export {};
 //# sourceMappingURL=closeWebSocket.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"closeWebSocket.d.mts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAY3D,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACtC,CAAC;AAEF,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,sBAAsB,CACxD,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,CAKrB,CAAC"}
+{"version":3,"file":"closeWebSocket.d.mts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACtC,CAAC;AAEF,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB;;;;CAQjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,4BAA4B,CACnC,GAAG,EAAE,cAAc,CAAC,wBAAwB,CAAC,EAC7C,GAAG,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,EACjD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,cAAc,EAAE,EAAE,yBAAyB,GAC3D,IAAI,CAgBN"}

package/dist/permitted/closeWebSocket.mjs

@@ -1,6 +1,7 @@
 import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
 import { create, object, string, StructError } from "@metamask/superstruct";
 import { SnapEndowments } from "../endowments/index.mjs";
+const methodName = 'snap_closeWebSocket';
 const hookNames = {
     hasPermission: true,
     closeWebSocket: true,
@@ -9,10 +10,26 @@ const CloseWebSocketParametersStruct = object({
     id: string(),
 });
 /**
- * Handler for the `snap_closeWebSocket` method.
+ * Closes a WebSocket connection that was previously opened with
+ * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
+ *
+ * @example
+ * ```json name="Manifest"
+ * {
+ *   "initialPermissions": {
+ *     "endowment:network-access": {}
+ *   }
+ * }
+ * ```
+ * ```ts name="Usage"
+ * await snap.request({
+ *   method: 'snap_closeWebSocket',
+ *   params: { id: 'websocket-1' },
+ * });
+ * ```
  */
 export const closeWebSocketHandler = {
-    methodNames: ['snap_closeWebSocket'],
+    methodNames: [methodName],
     implementation: closeWebSocketImplementation,
     hookNames,
 };

package/dist/permitted/closeWebSocket.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"closeWebSocket.mjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAOjE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B;AAG5E,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,MAAM,CAAC;IAC5C,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAI9B;IACF,WAAW,EAAE,CAAC,qBAAqB,CAAC;IACpC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Handler for the `snap_closeWebSocket` method.\n */\nexport const closeWebSocketHandler: PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n> = {\n  methodNames: ['snap_closeWebSocket'],\n  implementation: closeWebSocketImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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":"closeWebSocket.mjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAOjE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B;AAG5E,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC,MAAM,SAAS,GAAiD;IAC9D,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOF,MAAM,8BAA8B,GAAG,MAAM,CAAC;IAC5C,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,4BAA4B;IAC5C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CACnC,GAA6C,EAC7C,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,cAAc,EAA6B;IAE5D,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;QACjD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,cAAc,CAAC,EAAE,CAAC,CAAC;QACnB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,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,8BAA8B,CAAC,CAAC;IACxD,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  JsonRpcRequest,\n  CloseWebSocketParams,\n  CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_closeWebSocket';\n\nconst hookNames: MethodHooksObject<CloseWebSocketMethodHooks> = {\n  hasPermission: true,\n  closeWebSocket: true,\n};\n\nexport type CloseWebSocketMethodHooks = {\n  hasPermission: (permissionName: string) => boolean;\n  closeWebSocket: (id: string) => void;\n};\n\nconst CloseWebSocketParametersStruct = object({\n  id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n  typeof CloseWebSocketParametersStruct,\n  CloseWebSocketParams\n>;\n\n/**\n * Closes a WebSocket connection that was previously opened with\n * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"endowment:network-access\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * await snap.request({\n *   method: 'snap_closeWebSocket',\n *   params: { id: 'websocket-1' },\n * });\n * ```\n */\nexport const closeWebSocketHandler = {\n  methodNames: [methodName] as const,\n  implementation: closeWebSocketImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CloseWebSocketMethodHooks,\n  CloseWebSocketParams,\n  CloseWebSocketResult\n>;\n\n/**\n * The `snap_closeWebSocket` 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 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 a snap has the `endowment:network-access` permission.\n * @param hooks.closeWebSocket - The function to close a WebSocket.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n  req: JsonRpcRequest<CloseWebSocketParameters>,\n  res: PendingJsonRpcResponse<CloseWebSocketResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, closeWebSocket }: CloseWebSocketMethodHooks,\n): void {\n  if (!hasPermission(SnapEndowments.NetworkAccess)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { params } = req;\n\n  try {\n    const { id } = getValidatedParams(params);\n    closeWebSocket(id);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n  try {\n    return create(params, CloseWebSocketParametersStruct);\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/createInterface.cjs

@@ -4,11 +4,35 @@ exports.createInterfaceHandler = void 0;
 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("../utils.cjs");
+const methodName = 'snap_createInterface';
 const hookNames = {
+    hasPermission: true,
     createInterface: true,
 };
+/**
+ * Create the interactive interface for use in the
+ * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
+ *
+ * @example
+ * ```tsx
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Example Interface</Heading>
+ *         <Text>This is an example interface created by "snap_createInterface".</Text>
+ *       </Box>
+ *     ),
+ *   },
+ * });
+ * ```
+ */
 exports.createInterfaceHandler = {
-    methodNames: ['snap_createInterface'],
+    methodNames: [methodName],
     implementation: getCreateInterfaceImplementation,
     hookNames,
 };
@@ -25,10 +49,17 @@ const CreateInterfaceParametersStruct = (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.createInterface - The function to create the interface.
  * @returns Nothing.
  */
-function getCreateInterfaceImplementation(req, res, _next, end, { createInterface }) {
+function getCreateInterfaceImplementation(req, res, _next, end, { hasPermission, createInterface }) {
+    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/createInterface.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createInterface.cjs","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AASjD,mDAG6B;AAE7B,uDAA8E;AAK9E,MAAM,SAAS,GAAkD;IAC/D,eAAe,EAAE,IAAI;CACtB,CAAC;AAcW,QAAA,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CACV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,gCAAgC,CACvC,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,eAAe,EAA8B;IAE/C,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAExC,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5C,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,+BAA+B,CAAC,CAAC;IACzD,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  CreateInterfaceParams,\n  CreateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n  ContentType,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, optional } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<CreateInterfaceMethodHooks> = {\n  createInterface: true,\n};\n\nexport type CreateInterfaceMethodHooks = {\n  /**\n   * @param ui - The UI components.\n   * @returns The unique identifier of the interface.\n   */\n  createInterface: (\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n    contentType?: ContentType,\n  ) => string;\n};\n\nexport const createInterfaceHandler: PermittedHandlerExport<\n  CreateInterfaceMethodHooks,\n  CreateInterfaceParameters,\n  CreateInterfaceResult\n> = {\n  methodNames: ['snap_createInterface'],\n  implementation: getCreateInterfaceImplementation,\n  hookNames,\n};\n\nconst CreateInterfaceParametersStruct = object({\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type CreateInterfaceParameters = InferMatching<\n  typeof CreateInterfaceParametersStruct,\n  CreateInterfaceParams\n>;\n\n/**\n * The `snap_createInterface` 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.createInterface - The function to create the interface.\n * @returns Nothing.\n */\nfunction getCreateInterfaceImplementation(\n  req: JsonRpcRequest<CreateInterfaceParameters>,\n  res: PendingJsonRpcResponse<CreateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { createInterface }: CreateInterfaceMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { ui, context } = validatedParams;\n\n    res.result = createInterface(ui, context);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the createInterface 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 createInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CreateInterfaceParameters {\n  try {\n    return create(params, CreateInterfaceParametersStruct);\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":"createInterface.cjs","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AASjE,mDAG6B;AAE7B,uDAA8E;AAI9E,wCAA0C;AAE1C,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACtB,CAAC;AAsBF;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CAKV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,gCAAgC,CACvC,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,eAAe,EAA8B;IAE9D,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,OAAO,EAAE,GAAG,eAAe,CAAC;QAExC,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5C,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,+BAA+B,CAAC,CAAC;IACzD,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  CreateInterfaceParams,\n  CreateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n  ContentType,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, optional } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_createInterface';\n\nconst hookNames: MethodHooksObject<CreateInterfaceMethodHooks> = {\n  hasPermission: true,\n  createInterface: true,\n};\n\nexport type CreateInterfaceMethodHooks = {\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 ui - The UI components.\n   * @param context - An optional interface context object.\n   * @param contentType - The optional content type.\n   * @returns The unique identifier of the interface.\n   */\n  createInterface: (\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n    contentType?: ContentType,\n  ) => string;\n};\n\n/**\n * Create the interactive interface for use in the\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         <Heading>Example Interface</Heading>\n *         <Text>This is an example interface created by \"snap_createInterface\".</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const createInterfaceHandler = {\n  methodNames: [methodName] as const,\n  implementation: getCreateInterfaceImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  CreateInterfaceMethodHooks,\n  CreateInterfaceParameters,\n  CreateInterfaceResult\n>;\n\nconst CreateInterfaceParametersStruct = object({\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type CreateInterfaceParameters = InferMatching<\n  typeof CreateInterfaceParametersStruct,\n  CreateInterfaceParams\n>;\n\n/**\n * The `snap_createInterface` 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.createInterface - The function to create the interface.\n * @returns Nothing.\n */\nfunction getCreateInterfaceImplementation(\n  req: JsonRpcRequest<CreateInterfaceParameters>,\n  res: PendingJsonRpcResponse<CreateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, createInterface }: CreateInterfaceMethodHooks,\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 { ui, context } = validatedParams;\n\n    res.result = createInterface(ui, context);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the createInterface 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 createInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CreateInterfaceParameters {\n  try {\n    return create(params, CreateInterfaceParametersStruct);\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/createInterface.d.cts

@@ -1,14 +1,48 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { CreateInterfaceParams, CreateInterfaceResult, ComponentOrElement, InterfaceContext, ContentType } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { CreateInterfaceParams, CreateInterfaceResult, JsonRpcRequest, ComponentOrElement, InterfaceContext, ContentType } 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 CreateInterfaceMethodHooks = {
+    /**
+     * @param permissionName - The name of the permission to check.
+     * @returns Whether the Snap has the permission.
+     */
+    hasPermission: (permissionName: string) => boolean;
     /**
      * @param ui - The UI components.
+     * @param context - An optional interface context object.
+     * @param contentType - The optional content type.
      * @returns The unique identifier of the interface.
      */
     createInterface: (ui: ComponentOrElement, context?: InterfaceContext, contentType?: ContentType) => string;
 };
-export declare const createInterfaceHandler: PermittedHandlerExport<CreateInterfaceMethodHooks, CreateInterfaceParameters, CreateInterfaceResult>;
+/**
+ * Create the interactive interface for use in the
+ * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
+ *
+ * @example
+ * ```tsx
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * const interfaceId = snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         <Heading>Example Interface</Heading>
+ *         <Text>This is an example interface created by "snap_createInterface".</Text>
+ *       </Box>
+ *     ),
+ *   },
+ * });
+ * ```
+ */
+export declare const createInterfaceHandler: {
+    methodNames: ["snap_createInterface"];
+    implementation: typeof getCreateInterfaceImplementation;
+    hookNames: MethodHooksObject<CreateInterfaceMethodHooks>;
+};
 declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
     ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AccountSelectorProps, "AccountSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressInputProps, "AddressInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AssetSelectorProps, "AssetSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DateTimePickerProps, "DateTimePicker"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FieldProps, "Field"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AvatarProps, "Avatar"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BannerProps, "Banner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SkeletonProps, "Skeleton"> | {
         value: string;
@@ -21,13 +55,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         type: import("@metamask/snaps-sdk").NodeType.Heading;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Image; /**
-         * Validate the createInterface 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 createInterface method parameter object.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Image;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
@@ -70,6 +98,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         type: import("@metamask/snaps-sdk").NodeType.Form;
         name: string;
         children: ({
+            /**
+             * Validate the createInterface 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 createInterface method parameter object.
+             */
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
             value?: string | undefined;
@@ -116,13 +151,7 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         type: import("@metamask/snaps-sdk").NodeType.Heading;
     } | {
         value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Image; /**
-         * Validate the createInterface 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 createInterface method parameter object.
-         */
+        type: import("@metamask/snaps-sdk").NodeType.Image;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
@@ -165,6 +194,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         type: import("@metamask/snaps-sdk").NodeType.Form;
         name: string;
         children: ({
+            /**
+             * Validate the createInterface 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 createInterface method parameter object.
+             */
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
             value?: string | undefined;
@@ -201,5 +237,20 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
     context: import("@metamask/superstruct").Struct<Record<string, import("@metamask/snaps-sdk").Json> | undefined, null>;
 }>;
 export type CreateInterfaceParameters = InferMatching<typeof CreateInterfaceParametersStruct, CreateInterfaceParams>;
+/**
+ * The `snap_createInterface` 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.createInterface - The function to create the interface.
+ * @returns Nothing.
+ */
+declare function getCreateInterfaceImplementation(req: JsonRpcRequest<CreateInterfaceParameters>, res: PendingJsonRpcResponse<CreateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, createInterface }: CreateInterfaceMethodHooks): void;
 export {};
 //# sourceMappingURL=createInterface.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACZ,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,EAC1B,WAAW,CAAC,EAAE,WAAW,KACtB,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;4DA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4DANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}
+{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACZ,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;;;OAKG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,EAC1B,WAAW,CAAC,EAAE,WAAW,KACtB,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB;;;;CAQlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAsDrC;;;;;;eAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YANH;;;;;;eAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAzDD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,cAAc,CAAC,yBAAyB,CAAC,EAC9C,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,0BAA0B,GAC7D,IAAI,CAsBN"}