@metamask/snaps-rpc-methods 14.2.0 → 15.0.0

package/dist/permitted/startTrace.mjs

@@ -1,6 +1,7 @@
 import { rpcErrors } from "@metamask/rpc-errors";
 import { boolean, number, record, union, create, object, string, StructError, exactOptional } from "@metamask/superstruct";
 import { JsonStruct } from "@metamask/utils";
+const methodName = 'snap_startTrace';
 const hookNames = {
     startTrace: true,
     getSnap: true,
@@ -15,9 +16,11 @@ const StartTraceParametersStruct = object({
 });
 /**
  * Handler for the `snap_startTrace` method.
+ *
+ * @internal
  */
 export const startTraceHandler = {
-    methodNames: ['snap_startTrace'],
+    methodNames: [methodName],
     implementation: getStartTraceImplementation,
     hookNames,
 };

package/dist/permitted/startTrace.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"startTrace.mjs","sourceRoot":"","sources":["../../src/permitted/startTrace.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AASjD,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,KAAK,EACL,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACX,aAAa,EACd,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAI7C,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAmBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7E,EAAE,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,EAAE;IACd,aAAa,EAAE,aAAa,CAAC,UAAU,CAAC;IACxC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;IAClC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;CAC9E,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAgC,EAChC,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAChD,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,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 { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  JsonRpcRequest,\n  StartTraceParams,\n  StartTraceResult,\n  TraceContext,\n  TraceRequest,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  number,\n  record,\n  union,\n  create,\n  object,\n  string,\n  StructError,\n  exactOptional,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<StartTraceMethodHooks> = {\n  startTrace: true,\n  getSnap: true,\n};\n\nexport type StartTraceMethodHooks = {\n  /**\n   * Start a performance trace in Sentry.\n   *\n   * @param request - The trace request object.\n   * @returns The performance trace context.\n   */\n  startTrace: (request: TraceRequest) => TraceContext;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst StartTraceParametersStruct = object({\n  data: exactOptional(record(string(), union([string(), number(), boolean()]))),\n  id: exactOptional(string()),\n  name: string(),\n  parentContext: exactOptional(JsonStruct),\n  startTime: exactOptional(number()),\n  tags: exactOptional(record(string(), union([string(), number(), boolean()]))),\n});\n\nexport type StartTraceParameters = InferMatching<\n  typeof StartTraceParametersStruct,\n  StartTraceParams\n>;\n\n/**\n * Handler for the `snap_startTrace` method.\n */\nexport const startTraceHandler: PermittedHandlerExport<\n  StartTraceMethodHooks,\n  StartTraceParameters,\n  StartTraceResult\n> = {\n  methodNames: ['snap_startTrace'],\n  implementation: getStartTraceImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_startTrace` method implementation. This method is used to start a\n * performance trace in Sentry. It is only available to preinstalled Snaps.\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.startTrace - The hook function to start a performance trace.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getStartTraceImplementation(\n  request: JsonRpcRequest<StartTraceParameters>,\n  response: PendingJsonRpcResponse,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { startTrace, getSnap }: StartTraceMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<StartTraceParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    response.result = startTrace(validatedParams);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_startTrace` 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): StartTraceParameters {\n  try {\n    return create(params, StartTraceParametersStruct);\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":"startTrace.mjs","sourceRoot":"","sources":["../../src/permitted/startTrace.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AASjD,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,KAAK,EACL,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACX,aAAa,EACd,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAI7C,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAmBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7E,EAAE,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,EAAE;IACd,aAAa,EAAE,aAAa,CAAC,UAAU,CAAC;IACxC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC;IAClC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;CAC9E,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAgC,EAChC,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAChD,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,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 { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  JsonRpcRequest,\n  StartTraceParams,\n  StartTraceResult,\n  TraceContext,\n  TraceRequest,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  boolean,\n  number,\n  record,\n  union,\n  create,\n  object,\n  string,\n  StructError,\n  exactOptional,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_startTrace';\n\nconst hookNames: MethodHooksObject<StartTraceMethodHooks> = {\n  startTrace: true,\n  getSnap: true,\n};\n\nexport type StartTraceMethodHooks = {\n  /**\n   * Start a performance trace in Sentry.\n   *\n   * @param request - The trace request object.\n   * @returns The performance trace context.\n   */\n  startTrace: (request: TraceRequest) => TraceContext;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst StartTraceParametersStruct = object({\n  data: exactOptional(record(string(), union([string(), number(), boolean()]))),\n  id: exactOptional(string()),\n  name: string(),\n  parentContext: exactOptional(JsonStruct),\n  startTime: exactOptional(number()),\n  tags: exactOptional(record(string(), union([string(), number(), boolean()]))),\n});\n\nexport type StartTraceParameters = InferMatching<\n  typeof StartTraceParametersStruct,\n  StartTraceParams\n>;\n\n/**\n * Handler for the `snap_startTrace` method.\n *\n * @internal\n */\nexport const startTraceHandler = {\n  methodNames: [methodName] as const,\n  implementation: getStartTraceImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  StartTraceMethodHooks,\n  StartTraceParameters,\n  StartTraceResult\n>;\n\n/**\n * The `snap_startTrace` method implementation. This method is used to start a\n * performance trace in Sentry. It is only available to preinstalled Snaps.\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.startTrace - The hook function to start a performance trace.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getStartTraceImplementation(\n  request: JsonRpcRequest<StartTraceParameters>,\n  response: PendingJsonRpcResponse,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { startTrace, getSnap }: StartTraceMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<StartTraceParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    response.result = startTrace(validatedParams);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_startTrace` 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): StartTraceParameters {\n  try {\n    return create(params, StartTraceParametersStruct);\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/trackError.cjs

@@ -4,6 +4,7 @@ exports.trackErrorHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const superstruct_1 = require("@metamask/superstruct");
+const methodName = 'snap_trackError';
 const hookNames = {
     trackError: true,
     getSnap: true,
@@ -13,9 +14,11 @@ const TrackErrorParametersStruct = (0, superstruct_1.object)({
 });
 /**
  * Handler for the `snap_trackError` method.
+ *
+ * @internal
  */
 exports.trackErrorHandler = {
-    methodNames: ['snap_trackError'],
+    methodNames: [methodName],
     implementation: getTrackErrorImplementation,
     hookNames,
 };

package/dist/permitted/trackError.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackError.cjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,uDAA6D;AAC7D,uDAAoE;AAKpE,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,kCAAoB;CAC5B,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,0BAA0B,CAAC,CAAC;IACpD,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;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport { TrackableErrorStruct } from '@metamask/snaps-utils';\nimport { create, object, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n */\nexport const trackErrorHandler: PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n> = {\n  methodNames: ['snap_trackError'],\n  implementation: getTrackErrorImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_trackError` 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\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\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}
+{"version":3,"file":"trackError.cjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,uDAA6D;AAC7D,uDAAoE;AAKpE,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,kCAAoB;CAC5B,CAAC,CAAC;AAOH;;;;GAIG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,0BAA0B,CAAC,CAAC;IACpD,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;QAED,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport { TrackableErrorStruct } from '@metamask/snaps-utils';\nimport { create, object, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackError';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n *\n * @internal\n */\nexport const trackErrorHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackErrorImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n>;\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_trackError` 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\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\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}

package/dist/permitted/trackError.d.cts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
 import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export type TrackErrorMethodHooks = {
     /**
      * Track an error.
@@ -25,7 +27,28 @@ declare const TrackErrorParametersStruct: import("@metamask/superstruct").Struct
 export type TrackErrorParameters = InferMatching<typeof TrackErrorParametersStruct, TrackErrorParams>;
 /**
  * Handler for the `snap_trackError` method.
+ *
+ * @internal
  */
-export declare const trackErrorHandler: PermittedHandlerExport<TrackErrorMethodHooks, TrackErrorParameters, TrackErrorResult>;
+export declare const trackErrorHandler: {
+    methodNames: ["snap_trackError"];
+    implementation: typeof getTrackErrorImplementation;
+    hookNames: MethodHooksObject<TrackErrorMethodHooks>;
+};
+/**
+ * The `snap_trackError` method implementation. This method allows preinstalled
+ * Snaps to send errors to the Sentry instance in the client for tracking.
+ *
+ * @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.trackError - The hook function to track an error.
+ * @param hooks.getSnap - The hook function to get Snap metadata.
+ * @returns Nothing.
+ */
+declare function getTrackErrorImplementation(request: JsonRpcRequest<TrackErrorParameters>, response: PendingJsonRpcResponse<TrackErrorResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackError, getSnap }: TrackErrorMethodHooks): void;
 export {};
 //# sourceMappingURL=trackError.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackError.d.cts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAYjE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}
+{"version":3,"file":"trackError.d.cts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAGjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,2BAA2B,CAClC,OAAO,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAC7C,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAqBN"}

package/dist/permitted/trackError.d.mts

@@ -1,6 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, TrackableError, TrackErrorParams, TrackErrorResult } from "@metamask/snaps-sdk";
 import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export type TrackErrorMethodHooks = {
     /**
      * Track an error.
@@ -25,7 +27,28 @@ declare const TrackErrorParametersStruct: import("@metamask/superstruct").Struct
 export type TrackErrorParameters = InferMatching<typeof TrackErrorParametersStruct, TrackErrorParams>;
 /**
  * Handler for the `snap_trackError` method.
+ *
+ * @internal
  */
-export declare const trackErrorHandler: PermittedHandlerExport<TrackErrorMethodHooks, TrackErrorParameters, TrackErrorResult>;
+export declare const trackErrorHandler: {
+    methodNames: ["snap_trackError"];
+    implementation: typeof getTrackErrorImplementation;
+    hookNames: MethodHooksObject<TrackErrorMethodHooks>;
+};
+/**
+ * The `snap_trackError` method implementation. This method allows preinstalled
+ * Snaps to send errors to the Sentry instance in the client for tracking.
+ *
+ * @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.trackError - The hook function to track an error.
+ * @param hooks.getSnap - The hook function to get Snap metadata.
+ * @returns Nothing.
+ */
+declare function getTrackErrorImplementation(request: JsonRpcRequest<TrackErrorParameters>, response: PendingJsonRpcResponse<TrackErrorResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackError, getSnap }: TrackErrorMethodHooks): void;
 export {};
 //# sourceMappingURL=trackError.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackError.d.mts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAYjE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}
+{"version":3,"file":"trackError.d.mts","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAGjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AASlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;IAErC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;EAE9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,2BAA2B,CAClC,OAAO,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAC7C,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAqBN"}

package/dist/permitted/trackError.mjs

@@ -1,6 +1,7 @@
 import { rpcErrors } from "@metamask/rpc-errors";
 import { TrackableErrorStruct } from "@metamask/snaps-utils";
 import { create, object, StructError } from "@metamask/superstruct";
+const methodName = 'snap_trackError';
 const hookNames = {
     trackError: true,
     getSnap: true,
@@ -10,9 +11,11 @@ const TrackErrorParametersStruct = object({
 });
 /**
  * Handler for the `snap_trackError` method.
+ *
+ * @internal
  */
 export const trackErrorHandler = {
-    methodNames: ['snap_trackError'],
+    methodNames: [methodName],
     implementation: getTrackErrorImplementation,
     hookNames,
 };

package/dist/permitted/trackError.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackError.mjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAQjD,OAAO,EAAE,oBAAoB,EAAE,8BAA8B;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B;AAKpE,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,oBAAoB;CAC5B,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,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;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport { TrackableErrorStruct } from '@metamask/snaps-utils';\nimport { create, object, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n */\nexport const trackErrorHandler: PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n> = {\n  methodNames: ['snap_trackError'],\n  implementation: getTrackErrorImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_trackError` 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\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\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}
+{"version":3,"file":"trackError.mjs","sourceRoot":"","sources":["../../src/permitted/trackError.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAQjD,OAAO,EAAE,oBAAoB,EAAE,8BAA8B;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B;AAKpE,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAoBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,oBAAoB;CAC5B,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,2BAA2B,CAClC,OAA6C,EAC7C,QAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,OAAiE,CAAC,MAAM,CAC1E,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtD,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,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,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;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,MAAM,iBAAiB,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnD,iBAAiB,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACpC,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,SAAS,CAAC;IACnD,iBAAiB,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;QACnC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,iBAAiB,CAAC;AAC3B,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  JsonRpcRequest,\n  TrackableError,\n  TrackErrorParams,\n  TrackErrorResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport { TrackableErrorStruct } from '@metamask/snaps-utils';\nimport { create, object, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackError';\n\nconst hookNames: MethodHooksObject<TrackErrorMethodHooks> = {\n  trackError: true,\n  getSnap: true,\n};\n\nexport type TrackErrorMethodHooks = {\n  /**\n   * Track an error.\n   *\n   * @param error - The error object to track.\n   * @returns The ID of the tracked error, as returned by the Sentry instance\n   * in the client.\n   */\n  trackError: (error: Error) => string;\n\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nconst TrackErrorParametersStruct = object({\n  error: TrackableErrorStruct,\n});\n\nexport type TrackErrorParameters = InferMatching<\n  typeof TrackErrorParametersStruct,\n  TrackErrorParams\n>;\n\n/**\n * Handler for the `snap_trackError` method.\n *\n * @internal\n */\nexport const trackErrorHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackErrorImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackErrorMethodHooks,\n  TrackErrorParameters,\n  TrackErrorResult\n>;\n\n/**\n * The `snap_trackError` method implementation. This method allows preinstalled\n * Snaps to send errors to the Sentry instance in the client for tracking.\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.trackError - The hook function to track an error.\n * @param hooks.getSnap - The hook function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackErrorImplementation(\n  request: JsonRpcRequest<TrackErrorParameters>,\n  response: PendingJsonRpcResponse<TrackErrorResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackError, getSnap }: TrackErrorMethodHooks,\n): void {\n  const snap = getSnap(\n    (request as JsonRpcRequest<TrackErrorParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = request;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    const error = deserializeError(validatedParams.error);\n\n    response.result = trackError(error);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the parameters for the `snap_trackError` 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): TrackErrorParameters {\n  try {\n    return create(params, TrackErrorParametersStruct);\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\n/**\n * Deserialize a {@link TrackableError} into a standard {@link Error} object.\n *\n * @param error - The error to deserialize.\n * @returns A standard {@link Error} object with the same properties as the\n * original {@link TrackableError}.\n */\nfunction deserializeError(error: TrackableError): Error {\n  const deserializedError = new Error(error.message);\n  deserializedError.name = error.name;\n  deserializedError.stack = error.stack ?? undefined;\n  deserializedError.cause = error.cause\n    ? deserializeError(error.cause)\n    : undefined;\n\n  return deserializedError;\n}\n"]}

package/dist/permitted/trackEvent.cjs

@@ -4,6 +4,7 @@ exports.trackEventHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("@metamask/utils");
+const methodName = 'snap_trackEvent';
 const PropertiesStruct = (0, superstruct_1.optional)((0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct));
 const snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;
 const SnakeCasePropertiesStruct = (0, superstruct_1.refine)(PropertiesStruct, 'snake_case_keys', (value) => {
@@ -25,9 +26,11 @@ const TrackEventParametersStruct = (0, superstruct_1.object)({
 });
 /**
  * Handler for the `snap_trackEvent` method.
+ *
+ * @internal
  */
 exports.trackEventHandler = {
-    methodNames: ['snap_trackEvent'],
+    methodNames: [methodName],
     implementation: getTrackEventImplementation,
     hookNames,
 };

package/dist/permitted/trackEvent.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.cjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAOjD,uDAQ+B;AAE/B,2CAA6C;AAI7C,MAAM,gBAAgB,GAAG,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,IAAA,oBAAM,EACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,IAAA,oBAAM,EAAC;QACZ,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,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,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n */\nexport const trackEventHandler: PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n> = {\n  methodNames: ['snap_trackEvent'],\n  implementation: getTrackEventImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\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_trackEvent 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): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\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":"trackEvent.cjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAOjD,uDAQ+B;AAE/B,2CAA6C;AAI7C,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,gBAAgB,GAAG,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,IAAA,oBAAM,EACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,IAAA,oBAAM,EAAC;QACZ,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,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,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackEvent';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\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_trackEvent 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): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\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/trackEvent.d.cts

@@ -1,7 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
 import type { InferMatching, Snap } from "@metamask/snaps-utils";
-import type { Json } from "@metamask/utils";
+import type { Json, PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.cjs";
 export type TrackEventMethodHooks = {
     /**
      * Track an event.
@@ -41,7 +42,27 @@ declare const TrackEventParametersStruct: import("@metamask/superstruct").Struct
 export type TrackEventParameters = InferMatching<typeof TrackEventParametersStruct, TrackEventParams>;
 /**
  * Handler for the `snap_trackEvent` method.
+ *
+ * @internal
  */
-export declare const trackEventHandler: PermittedHandlerExport<TrackEventMethodHooks, TrackEventParameters, TrackEventResult>;
+export declare const trackEventHandler: {
+    methodNames: ["snap_trackEvent"];
+    implementation: typeof getTrackEventImplementation;
+    hookNames: MethodHooksObject<TrackEventMethodHooks>;
+};
+/**
+ * The `snap_trackEvent` method implementation.
+ * This method allows pre-installed Snaps to submit tracking events to the client.
+ *
+ * @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.trackEvent - The function to track the event.
+ * @param hooks.getSnap - The function to get Snap metadata.
+ * @returns Nothing.
+ */
+declare function getTrackEventImplementation(req: JsonRpcRequest<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent, getSnap }: TrackEventMethodHooks): void;
 export {};
 //# sourceMappingURL=trackEvent.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAA0B,wBAAwB;AA0BpE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}
+{"version":3,"file":"trackEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAyBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,cAAc,CAAC,oBAAoB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAoBN"}

package/dist/permitted/trackEvent.d.mts

@@ -1,7 +1,8 @@
-import type { PermittedHandlerExport } from "@metamask/permission-controller";
-import type { TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
+import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
 import type { InferMatching, Snap } from "@metamask/snaps-utils";
-import type { Json } from "@metamask/utils";
+import type { Json, PendingJsonRpcResponse } from "@metamask/utils";
+import type { MethodHooksObject } from "../utils.mjs";
 export type TrackEventMethodHooks = {
     /**
      * Track an event.
@@ -41,7 +42,27 @@ declare const TrackEventParametersStruct: import("@metamask/superstruct").Struct
 export type TrackEventParameters = InferMatching<typeof TrackEventParametersStruct, TrackEventParams>;
 /**
  * Handler for the `snap_trackEvent` method.
+ *
+ * @internal
  */
-export declare const trackEventHandler: PermittedHandlerExport<TrackEventMethodHooks, TrackEventParameters, TrackEventResult>;
+export declare const trackEventHandler: {
+    methodNames: ["snap_trackEvent"];
+    implementation: typeof getTrackEventImplementation;
+    hookNames: MethodHooksObject<TrackEventMethodHooks>;
+};
+/**
+ * The `snap_trackEvent` method implementation.
+ * This method allows pre-installed Snaps to submit tracking events to the client.
+ *
+ * @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.trackEvent - The function to track the event.
+ * @param hooks.getSnap - The function to get Snap metadata.
+ * @returns Nothing.
+ */
+declare function getTrackEventImplementation(req: JsonRpcRequest<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent, getSnap }: TrackEventMethodHooks): void;
 export {};
 //# sourceMappingURL=trackEvent.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAEV,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAA0B,wBAAwB;AA0BpE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,sBAAsB,CACpD,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,CAKjB,CAAC"}
+{"version":3,"file":"trackEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAyBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,cAAc,CAAC,oBAAoB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAoBN"}

package/dist/permitted/trackEvent.mjs

@@ -1,6 +1,7 @@
 import { rpcErrors } from "@metamask/rpc-errors";
 import { create, object, optional, record, refine, string, StructError } from "@metamask/superstruct";
 import { JsonStruct } from "@metamask/utils";
+const methodName = 'snap_trackEvent';
 const PropertiesStruct = optional(record(string(), JsonStruct));
 const snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;
 const SnakeCasePropertiesStruct = refine(PropertiesStruct, 'snake_case_keys', (value) => {
@@ -22,9 +23,11 @@ const TrackEventParametersStruct = object({
 });
 /**
  * Handler for the `snap_trackEvent` method.
+ *
+ * @internal
  */
 export const trackEventHandler = {
-    methodNames: ['snap_trackEvent'],
+    methodNames: [methodName],
     implementation: getTrackEventImplementation,
     hookNames,
 };

package/dist/permitted/trackEvent.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.mjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAI7C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,MAAM,CACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAI1B;IACF,WAAW,EAAE,CAAC,iBAAiB,CAAC;IAChC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CACV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,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,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n */\nexport const trackEventHandler: PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n> = {\n  methodNames: ['snap_trackEvent'],\n  implementation: getTrackEventImplementation,\n  hookNames,\n};\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\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_trackEvent 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): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\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":"trackEvent.mjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAI7C,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,MAAM,CACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,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,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackEvent';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\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_trackEvent 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): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\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/updateInterface.cjs

@@ -4,11 +4,49 @@ exports.updateInterfaceHandler = 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_updateInterface';
 const hookNames = {
+    hasPermission: true,
     updateInterface: true,
 };
+/**
+ * Update an interactive interface. For use in
+ * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
+ *
+ * @example
+ * ```tsx
+ * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
+ *
+ * // First, create an interface and get its ID.
+ * const id = await snap.request({
+ *   method: 'snap_createInterface',
+ *   params: {
+ *     ui: (
+ *       <Box>
+ *         ...
+ *       </Box>
+ *     ),
+ *   },
+ * });
+ *
+ * // Later, update the interface with new content using the ID.
+ * snap.request({
+ *   method: 'snap_updateInterface',
+ *   params: {
+ *     id: 'interface-id',
+ *     ui: (
+ *       <Box>
+ *         <Heading>Updated Interface</Heading>
+ *         <Text>This interface has been updated.</Text>
+ *       </Box>
+ *     ),
+ *   },
+ * });
+ * ```
+ */
 exports.updateInterfaceHandler = {
-    methodNames: ['snap_updateInterface'],
+    methodNames: [methodName],
     implementation: getUpdateInterfaceImplementation,
     hookNames,
 };
@@ -26,10 +64,17 @@ const UpdateInterfaceParametersStruct = (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.updateInterface - The function to update the interface.
  * @returns Nothing.
  */
-function getUpdateInterfaceImplementation(req, res, _next, end, { updateInterface }) {
+function getUpdateInterfaceImplementation(req, res, _next, end, { hasPermission, updateInterface }) {
+    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/updateInterface.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"updateInterface.cjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,mDAG6B;AAE7B,uDAM+B;AAK/B,MAAM,SAAS,GAAkD;IAC/D,eAAe,EAAE,IAAI;CACtB,CAAC;AAeW,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,IAAA,oBAAM,GAAE;IACZ,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,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACjC,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,+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  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<UpdateInterfaceMethodHooks> = {\n  updateInterface: true,\n};\n\nexport type UpdateInterfaceMethodHooks = {\n  /**\n   * @param id - The interface ID.\n   * @param ui - The UI components.\n   * @param context - The optional interface context object.\n   */\n  updateInterface: (\n    id: string,\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\nexport const updateInterfaceHandler: PermittedHandlerExport<\n  UpdateInterfaceMethodHooks,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult\n> = {\n  methodNames: ['snap_updateInterface'],\n  implementation: getUpdateInterfaceImplementation,\n  hookNames,\n};\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` 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.updateInterface - The function to update the interface.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequest<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { updateInterface }: UpdateInterfaceMethodHooks,\n): void {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui, context } = validatedParams;\n\n    updateInterface(id, ui, context);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\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":"updateInterface.cjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAQjE,mDAG6B;AAE7B,uDAM+B;AAI/B,wCAA0C;AAE1C,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACtB,CAAC;AAqBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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,IAAA,oBAAM,GAAE;IACZ,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,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACjC,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,+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  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_updateInterface';\n\nconst hookNames: MethodHooksObject<UpdateInterfaceMethodHooks> = {\n  hasPermission: true,\n  updateInterface: true,\n};\n\nexport type UpdateInterfaceMethodHooks = {\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   * @param ui - The UI components.\n   * @param context - The optional interface context object.\n   */\n  updateInterface: (\n    id: string,\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\n/**\n * Update an interactive interface. For use in\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 * // First, create an interface and get its ID.\n * const id = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         ...\n *       </Box>\n *     ),\n *   },\n * });\n *\n * // Later, update the interface with new content using the ID.\n * snap.request({\n *   method: 'snap_updateInterface',\n *   params: {\n *     id: 'interface-id',\n *     ui: (\n *       <Box>\n *         <Heading>Updated Interface</Heading>\n *         <Text>This interface has been updated.</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const updateInterfaceHandler = {\n  methodNames: [methodName] as const,\n  implementation: getUpdateInterfaceImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  UpdateInterfaceMethodHooks,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult\n>;\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` 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.updateInterface - The function to update the interface.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequest<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, updateInterface }: UpdateInterfaceMethodHooks,\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, ui, context } = validatedParams;\n\n    updateInterface(id, ui, context);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\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"]}