@metamask/snaps-rpc-methods 15.1.0 → 16.0.0

package/dist/restricted/notify.mjs

@@ -3,7 +3,7 @@ import { rpcErrors } from "@metamask/rpc-errors";
 import { enumValue, NotificationType, union, ContentType, getErrorMessage, ComponentOrElementStruct } from "@metamask/snaps-sdk";
 import { createUnion, validateLink, validateTextLinks } from "@metamask/snaps-utils";
 import { object, string, optional } from "@metamask/superstruct";
-import { hasProperty, isObject } from "@metamask/utils";
+import { assertExhaustive, hasProperty, isObject } from "@metamask/utils";
 const methodName = 'snap_notify';
 const NativeNotificationStruct = object({
     type: enumValue(NotificationType.Native),
@@ -34,25 +34,22 @@ const NotificationParametersStruct = union([
  *
  * @param options - The specification builder options.
  * @param options.allowedCaveats - The optional allowed caveats for the permission.
+ * @param options.messenger - The messenger.
  * @param options.methodHooks - The RPC method hooks needed by the method implementation.
  * @returns The specification for the `snap_notify` permission.
  */
-export const specificationBuilder = ({ allowedCaveats = null, methodHooks }) => {
+export const specificationBuilder = ({ allowedCaveats = null, methodHooks, messenger, }) => {
     return {
         permissionType: PermissionType.RestrictedMethod,
         targetName: methodName,
         allowedCaveats,
-        methodImplementation: getImplementation(methodHooks),
+        methodImplementation: getImplementation({ methodHooks, messenger }),
         subjectTypes: [SubjectType.Snap],
     };
 };
 const methodHooks = {
-    showNativeNotification: true,
-    showInAppNotification: true,
     isOnPhishingList: true,
     maybeUpdatePhishingList: true,
-    createInterface: true,
-    getSnap: true,
 };
 /**
  * Display a
@@ -132,38 +129,47 @@ export const notifyBuilder = Object.freeze({
     targetName: methodName,
     specificationBuilder,
     methodHooks,
+    actionNames: [
+        'RateLimitController:call',
+        'SnapController:getSnap',
+        'SnapInterfaceController:createInterface',
+    ],
 });
 /**
  * Builds the method implementation for `snap_notify`.
  *
- * @param hooks - The RPC method hooks.
- * @param hooks.showNativeNotification - A function that shows a native browser notification.
- * @param hooks.showInAppNotification - A function that shows a notification in the MetaMask UI.
- * @param hooks.isOnPhishingList - A function that checks for links against the phishing list.
- * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.
- * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.
- * @param hooks.getSnap - A function that checks if a snap is installed.
+ * @param options - The options.
+ * @param options.messenger - The messenger.
+ * @param options.methodHooks - The RPC method hooks.
+ * @param options.methodHooks.isOnPhishingList - A function that checks for links against the phishing list.
+ * @param options.methodHooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.
  * @returns The method implementation which returns `null` on success.
  * @throws If the params are invalid.
  */
-export function getImplementation({ showNativeNotification, showInAppNotification, isOnPhishingList, maybeUpdatePhishingList, createInterface, getSnap, }) {
+export function getImplementation({ methodHooks: { isOnPhishingList, maybeUpdatePhishingList }, messenger, }) {
     return async function implementation(args) {
         const { params, context: { origin }, } = args;
         await maybeUpdatePhishingList();
-        const validatedParams = getValidatedParams(params, isOnPhishingList, getSnap);
+        const validatedParams = getValidatedParams(params, isOnPhishingList, messenger);
         if (hasProperty(validatedParams, 'content')) {
-            const id = await createInterface(origin, validatedParams.content, undefined, ContentType.Notification);
+            const id = messenger.call('SnapInterfaceController:createInterface', origin, validatedParams.content, undefined, ContentType.Notification);
             validatedParams.content = id;
         }
         switch (validatedParams.type) {
             case NotificationType.Native:
-                return await showNativeNotification(origin, validatedParams);
-            case NotificationType.InApp:
-                return await showInAppNotification(origin, validatedParams);
+                return (await messenger.call('RateLimitController:call', origin, 'showNativeNotification', origin, validatedParams.message));
+            case NotificationType.InApp: {
+                const { content, message, title, footerLink } = validatedParams;
+                return (await messenger.call('RateLimitController:call', origin, 'showInAppNotification', origin, {
+                    interfaceId: content,
+                    message,
+                    title,
+                    footerLink,
+                }));
+            }
+            /* istanbul ignore next */
             default:
-                throw rpcErrors.invalidParams({
-                    message: 'Must specify a valid notification "type".',
-                });
+                return assertExhaustive(validatedParams.type);
         }
     };
 }
@@ -173,11 +179,11 @@ export function getImplementation({ showNativeNotification, showInAppNotificatio
  *
  * @param params - The unvalidated params object from the method request.
  * @param isOnPhishingList - The function that checks for links against the phishing list.
- * @param getSnap - A function that checks if a snap is installed.
+ * @param messenger - The messenger.
  * @returns The validated method parameter object.
  * @throws If the params are invalid.
  */
-export function getValidatedParams(params, isOnPhishingList, getSnap) {
+export function getValidatedParams(params, isOnPhishingList, messenger) {
     if (!isObject(params)) {
         throw rpcErrors.invalidParams({
             message: 'Expected params to be a single object.',
@@ -207,6 +213,7 @@ export function getValidatedParams(params, isOnPhishingList, getSnap) {
     }
     try {
         const validatedParams = createUnion(params, NotificationParametersStruct, 'type');
+        const getSnap = (snapId) => messenger.call('SnapController:getSnap', snapId);
         validateTextLinks(validatedParams.message, isOnPhishingList, getSnap);
         if (hasProperty(validatedParams, 'footerLink')) {
             validateLink(validatedParams.footerLink.href, isOnPhishingList, getSnap);

package/dist/restricted/notify.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"notify.mjs","sourceRoot":"","sources":["../../src/restricted/notify.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,WAAW,EACX,eAAe,EACf,wBAAwB,EACzB,4BAA4B;AAC7B,OAAO,EACL,WAAW,EACX,YAAY,EACZ,iBAAiB,EAClB,8BAA8B;AAE/B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,8BAA8B;AAEjE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAIxD,MAAM,UAAU,GAAG,aAAa,CAAC;AAEjC,MAAM,wBAAwB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,MAAM,CAAC;IACrC,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACvC,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,MAAM,CAAC;IAChD,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACvC,OAAO,EAAE,MAAM,EAAE;IACjB,OAAO,EAAE,wBAAwB;IACjC,KAAK,EAAE,MAAM,EAAE;IACf,UAAU,EAAE,QAAQ,CAClB,MAAM,CAAC;QACL,IAAI,EAAE,MAAM,EAAE;QACd,IAAI,EAAE,MAAM,EAAE;KACf,CAAC,CACH;CACF,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,KAAK,CAAC;IACzC,uBAAuB;IACvB,kCAAkC;IAClC,wBAAwB;CACzB,CAAC,CAAC;AAmDH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAI7B,CAAC,EAAE,cAAc,GAAG,IAAI,EAAE,WAAW,EAA+B,EAAE,EAAE;IAC1E,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,UAAU;QACtB,cAAc;QACd,oBAAoB,EAAE,iBAAiB,CAAC,WAAW,CAAC;QACpD,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAyC;IACxD,sBAAsB,EAAE,IAAI;IAC5B,qBAAqB,EAAE,IAAI;IAC3B,gBAAgB,EAAE,IAAI;IACtB,uBAAuB,EAAE,IAAI;IAC7B,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,IAAI;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,UAAU;IACtB,oBAAoB;IACpB,WAAW;CACH,CAAC,CAAC;AAEZ;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAChC,sBAAsB,EACtB,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,OAAO,GACW;IAClB,OAAO,KAAK,UAAU,cAAc,CAClC,IAA2C;QAE3C,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAG,IAAI,CAAC;QAET,MAAM,uBAAuB,EAAE,CAAC;QAEhC,MAAM,eAAe,GAAG,kBAAkB,CACxC,MAAM,EACN,gBAAgB,EAChB,OAAO,CACR,CAAC;QAEF,IAAI,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC;YAC5C,MAAM,EAAE,GAAG,MAAM,eAAe,CAC9B,MAAM,EACN,eAAe,CAAC,OAA6B,EAC7C,SAAS,EACT,WAAW,CAAC,YAAY,CACzB,CAAC;YACF,eAAe,CAAC,OAAO,GAAG,EAAE,CAAC;QAC/B,CAAC;QAED,QAAQ,eAAe,CAAC,IAAI,EAAE,CAAC;YAC7B,KAAK,gBAAgB,CAAC,MAAM;gBAC1B,OAAO,MAAM,sBAAsB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YAC/D,KAAK,gBAAgB,CAAC,KAAK;gBACzB,OAAO,MAAM,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YAC9D;gBACE,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,2CAA2C;iBACrD,CAAC,CAAC;QACP,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAe,EACf,gBAAuD,EACvD,OAAqC;IAErC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEjC,IACE,CAAC,IAAI;QACL,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,IAAwB,CAAC,EACnE,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,2CAA2C;SACrD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;IAC5D,+DAA+D;IAC/D,IACE,IAAI,KAAK,gBAAgB,CAAC,MAAM;QAChC,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EACrC,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EACL,yEAAyE;SAC5E,CAAC,CAAC;IACL,CAAC;IAED,IACE,IAAI,KAAK,gBAAgB,CAAC,KAAK;QAC/B,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,EACtC,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EACL,0EAA0E;SAC7E,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,WAAW,CACjC,MAAM,EACN,4BAA4B,EAC5B,MAAM,CACP,CAAC;QAEF,iBAAiB,CAAC,eAAe,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAEtE,IAAI,WAAW,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC;YAC/C,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,eAAe,CAAC,KAAK,CAAC,EAAE;SACrD,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  NotifyParams,\n  NotifyResult,\n  InterfaceContext,\n  ComponentOrElement,\n} from '@metamask/snaps-sdk';\nimport {\n  enumValue,\n  NotificationType,\n  union,\n  ContentType,\n  getErrorMessage,\n  ComponentOrElementStruct,\n} from '@metamask/snaps-sdk';\nimport {\n  createUnion,\n  validateLink,\n  validateTextLinks,\n} from '@metamask/snaps-utils';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport { object, string, optional } from '@metamask/superstruct';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_notify';\n\nconst NativeNotificationStruct = object({\n  type: enumValue(NotificationType.Native),\n  message: string(),\n});\n\nconst InAppNotificationStruct = object({\n  type: enumValue(NotificationType.InApp),\n  message: string(),\n});\n\nconst InAppNotificationWithDetailsStruct = object({\n  type: enumValue(NotificationType.InApp),\n  message: string(),\n  content: ComponentOrElementStruct,\n  title: string(),\n  footerLink: optional(\n    object({\n      href: string(),\n      text: string(),\n    }),\n  ),\n});\n\nconst NotificationParametersStruct = union([\n  InAppNotificationStruct,\n  InAppNotificationWithDetailsStruct,\n  NativeNotificationStruct,\n]);\n\nexport type NotificationArgs = InferMatching<\n  typeof NotificationParametersStruct,\n  NotifyParams\n>;\n\nexport type NotifyMethodHooks = {\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showNativeNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showInAppNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  isOnPhishingList: (url: string) => boolean;\n\n  maybeUpdatePhishingList: () => Promise<void>;\n\n  createInterface: (\n    origin: string,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n    contentType?: ContentType,\n  ) => Promise<string>;\n  getSnap: (snapId: string) => Snap | null;\n};\n\ntype SpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: NotifyMethodHooks;\n};\n\ntype Specification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_notify` permission.\n * `snap_notify` allows snaps to send multiple types of notifications to its users.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the permission.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_notify` permission.\n */\nexport const specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  SpecificationBuilderOptions,\n  Specification\n> = ({ allowedCaveats = null, methodHooks }: SpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<NotifyMethodHooks> = {\n  showNativeNotification: true,\n  showInAppNotification: true,\n  isOnPhishingList: true,\n  maybeUpdatePhishingList: true,\n  createInterface: true,\n  getSnap: true,\n};\n\n/**\n * Display a\n * [notification](https://docs.metamask.io/snaps/features/notifications/) in\n * MetaMask or natively in the OS. Snaps can trigger a short (up to 80\n * characters) notification message for actionable or time sensitive\n * information. `inApp` notifications can also include an optional\n * [expanded view](https://docs.metamask.io/snaps/features/notifications/#expanded-view).\n * The expanded view has a title, content, and optional footer link shown when\n * a user clicks on the notification.\n *\n * @example Basic in app notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'inApp',\n *     message: 'This is an in-app notification',\n *   },\n * });\n * ```\n *\n * @example Expandable in app notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'inApp',\n *     message: 'This is an in-app notification',\n *     title: 'Notification Title',\n *     content: (\n *       <Box>\n *         <Text>This is the expanded content of the notification.</Text>\n *       </Box>\n *     ),\n *     footerLink: {\n *       href: 'https://example.com',\n *       text: 'Click here for more info',\n *     },\n *   },\n * });\n * ```\n *\n * @example Native notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'native',\n *     message: 'This is a native notification',\n *   },\n * });\n * ```\n */\nexport const notifyBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_notify`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.showNativeNotification - A function that shows a native browser notification.\n * @param hooks.showInAppNotification - A function that shows a notification in the MetaMask UI.\n * @param hooks.isOnPhishingList - A function that checks for links against the phishing list.\n * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.\n * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.\n * @param hooks.getSnap - A function that checks if a snap is installed.\n * @returns The method implementation which returns `null` on success.\n * @throws If the params are invalid.\n */\nexport function getImplementation({\n  showNativeNotification,\n  showInAppNotification,\n  isOnPhishingList,\n  maybeUpdatePhishingList,\n  createInterface,\n  getSnap,\n}: NotifyMethodHooks) {\n  return async function implementation(\n    args: RestrictedMethodOptions<NotifyParams>,\n  ): Promise<NotifyResult> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    await maybeUpdatePhishingList();\n\n    const validatedParams = getValidatedParams(\n      params,\n      isOnPhishingList,\n      getSnap,\n    );\n\n    if (hasProperty(validatedParams, 'content')) {\n      const id = await createInterface(\n        origin,\n        validatedParams.content as ComponentOrElement,\n        undefined,\n        ContentType.Notification,\n      );\n      validatedParams.content = id;\n    }\n\n    switch (validatedParams.type) {\n      case NotificationType.Native:\n        return await showNativeNotification(origin, validatedParams);\n      case NotificationType.InApp:\n        return await showInAppNotification(origin, validatedParams);\n      default:\n        throw rpcErrors.invalidParams({\n          message: 'Must specify a valid notification \"type\".',\n        });\n    }\n  };\n}\n\n/**\n * Validates the notify 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 * @param isOnPhishingList - The function that checks for links against the phishing list.\n * @param getSnap - A function that checks if a snap is installed.\n * @returns The validated method parameter object.\n * @throws If the params are invalid.\n */\nexport function getValidatedParams(\n  params: unknown,\n  isOnPhishingList: NotifyMethodHooks['isOnPhishingList'],\n  getSnap: NotifyMethodHooks['getSnap'],\n): NotifyParams {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { type, message } = params;\n\n  if (\n    !type ||\n    typeof type !== 'string' ||\n    !Object.values(NotificationType).includes(type as NotificationType)\n  ) {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid notification \"type\".',\n    });\n  }\n\n  const isNotString = !message || typeof message !== 'string';\n  // Set to the max message length on a Mac notification for now.\n  if (\n    type === NotificationType.Native &&\n    (isNotString || message.length >= 50)\n  ) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 50 characters long.',\n    });\n  }\n\n  if (\n    type === NotificationType.InApp &&\n    (isNotString || message.length >= 500)\n  ) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 500 characters long.',\n    });\n  }\n\n  try {\n    const validatedParams = createUnion(\n      params,\n      NotificationParametersStruct,\n      'type',\n    );\n\n    validateTextLinks(validatedParams.message, isOnPhishingList, getSnap);\n\n    if (hasProperty(validatedParams, 'footerLink')) {\n      validateLink(validatedParams.footerLink.href, isOnPhishingList, getSnap);\n    }\n\n    return validatedParams;\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${getErrorMessage(error)}`,\n    });\n  }\n}\n"]}
+{"version":3,"file":"notify.mjs","sourceRoot":"","sources":["../../src/restricted/notify.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAMjD,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,WAAW,EACX,eAAe,EACf,wBAAwB,EACzB,4BAA4B;AAC7B,OAAO,EACL,WAAW,EACX,YAAY,EACZ,iBAAiB,EAClB,8BAA8B;AAE/B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,8BAA8B;AAEjE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAS1E,MAAM,UAAU,GAAG,aAAa,CAAC;AAEjC,MAAM,wBAAwB,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,MAAM,CAAC;IACrC,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACvC,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,MAAM,CAAC;IAChD,IAAI,EAAE,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACvC,OAAO,EAAE,MAAM,EAAE;IACjB,OAAO,EAAE,wBAAwB;IACjC,KAAK,EAAE,MAAM,EAAE;IACf,UAAU,EAAE,QAAQ,CAClB,MAAM,CAAC;QACL,IAAI,EAAE,MAAM,EAAE;QACd,IAAI,EAAE,MAAM,EAAE;KACf,CAAC,CACH;CACF,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,KAAK,CAAC;IACzC,uBAAuB;IACvB,kCAAkC;IAClC,wBAAwB;CACzB,CAAC,CAAC;AA+BH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAI7B,CAAC,EACH,cAAc,GAAG,IAAI,EACrB,WAAW,EACX,SAAS,GACmB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,gBAAgB;QAC/C,UAAU,EAAE,UAAU;QACtB,cAAc;QACd,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QACnE,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAyC;IACxD,gBAAgB,EAAE,IAAI;IACtB,uBAAuB,EAAE,IAAI;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,UAAU;IACtB,oBAAoB;IACpB,WAAW;IACX,WAAW,EAAE;QACX,0BAA0B;QAC1B,wBAAwB;QACxB,yCAAyC;KAC1C;CACO,CAAC,CAAC;AAEZ;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAChC,WAAW,EAAE,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,EAC1D,SAAS,GACmB;IAC5B,OAAO,KAAK,UAAU,cAAc,CAClC,IAA2C;QAE3C,MAAM,EACJ,MAAM,EACN,OAAO,EAAE,EAAE,MAAM,EAAE,GACpB,GAAG,IAAI,CAAC;QAET,MAAM,uBAAuB,EAAE,CAAC;QAEhC,MAAM,eAAe,GAAG,kBAAkB,CACxC,MAAM,EACN,gBAAgB,EAChB,SAAS,CACV,CAAC;QAEF,IAAI,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC;YAC5C,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CACvB,yCAAyC,EACzC,MAAM,EACN,eAAe,CAAC,OAA6B,EAC7C,SAAS,EACT,WAAW,CAAC,YAAY,CACzB,CAAC;YACF,eAAe,CAAC,OAAO,GAAG,EAAE,CAAC;QAC/B,CAAC;QAED,QAAQ,eAAe,CAAC,IAAI,EAAE,CAAC;YAC7B,KAAK,gBAAgB,CAAC,MAAM;gBAC1B,OAAO,CAAC,MAAM,SAAS,CAAC,IAAI,CAC1B,0BAA0B,EAC1B,MAAM,EACN,wBAAwB,EACxB,MAAM,EACN,eAAe,CAAC,OAAO,CACxB,CAAiB,CAAC;YACrB,KAAK,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC5B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,GAC3C,eAIC,CAAC;gBACJ,OAAO,CAAC,MAAM,SAAS,CAAC,IAAI,CAC1B,0BAA0B,EAC1B,MAAM,EACN,uBAAuB,EACvB,MAAM,EACN;oBACE,WAAW,EAAE,OAAO;oBACpB,OAAO;oBACP,KAAK;oBACL,UAAU;iBACX,CACF,CAAiB,CAAC;YACrB,CAAC;YACD,0BAA0B;YAC1B;gBACE,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAa,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAe,EACf,gBAAuD,EACvD,SAAoD;IAEpD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEjC,IACE,CAAC,IAAI;QACL,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,IAAwB,CAAC,EACnE,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,2CAA2C;SACrD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;IAC5D,+DAA+D;IAC/D,IACE,IAAI,KAAK,gBAAgB,CAAC,MAAM;QAChC,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EACrC,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EACL,yEAAyE;SAC5E,CAAC,CAAC;IACL,CAAC;IAED,IACE,IAAI,KAAK,gBAAgB,CAAC,KAAK;QAC/B,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,EACtC,CAAC;QACD,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EACL,0EAA0E;SAC7E,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,WAAW,CACjC,MAAM,EACN,4BAA4B,EAC5B,MAAM,CACP,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CACjC,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;QAEnD,iBAAiB,CAAC,eAAe,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAEtE,IAAI,WAAW,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC;YAC/C,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mBAAmB,eAAe,CAAC,KAAK,CAAC,EAAE;SACrD,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type { Messenger } from '@metamask/messenger';\nimport type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  NotifyParams,\n  NotifyResult,\n  ComponentOrElement,\n} from '@metamask/snaps-sdk';\nimport {\n  enumValue,\n  NotificationType,\n  union,\n  ContentType,\n  getErrorMessage,\n  ComponentOrElementStruct,\n} from '@metamask/snaps-sdk';\nimport {\n  createUnion,\n  validateLink,\n  validateTextLinks,\n} from '@metamask/snaps-utils';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { object, string, optional } from '@metamask/superstruct';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assertExhaustive, hasProperty, isObject } from '@metamask/utils';\n\nimport type {\n  RateLimitControllerCallAction,\n  SnapControllerGetSnapAction,\n  SnapInterfaceControllerCreateInterfaceAction,\n} from '../types';\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_notify';\n\nconst NativeNotificationStruct = object({\n  type: enumValue(NotificationType.Native),\n  message: string(),\n});\n\nconst InAppNotificationStruct = object({\n  type: enumValue(NotificationType.InApp),\n  message: string(),\n});\n\nconst InAppNotificationWithDetailsStruct = object({\n  type: enumValue(NotificationType.InApp),\n  message: string(),\n  content: ComponentOrElementStruct,\n  title: string(),\n  footerLink: optional(\n    object({\n      href: string(),\n      text: string(),\n    }),\n  ),\n});\n\nconst NotificationParametersStruct = union([\n  InAppNotificationStruct,\n  InAppNotificationWithDetailsStruct,\n  NativeNotificationStruct,\n]);\n\nexport type NotificationArgs = InferMatching<\n  typeof NotificationParametersStruct,\n  NotifyParams\n>;\n\nexport type NotifyMethodHooks = {\n  isOnPhishingList: (url: string) => boolean;\n\n  maybeUpdatePhishingList: () => Promise<void>;\n};\n\nexport type NotifyMessengerActions =\n  | RateLimitControllerCallAction\n  | SnapControllerGetSnapAction\n  | SnapInterfaceControllerCreateInterfaceAction;\n\ntype SpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: NotifyMethodHooks;\n  messenger: Messenger<string, NotifyMessengerActions>;\n};\n\ntype Specification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_notify` permission.\n * `snap_notify` allows snaps to send multiple types of notifications to its users.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the permission.\n * @param options.messenger - The messenger.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_notify` permission.\n */\nexport const specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  SpecificationBuilderOptions,\n  Specification\n> = ({\n  allowedCaveats = null,\n  methodHooks,\n  messenger,\n}: SpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getImplementation({ methodHooks, messenger }),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<NotifyMethodHooks> = {\n  isOnPhishingList: true,\n  maybeUpdatePhishingList: true,\n};\n\n/**\n * Display a\n * [notification](https://docs.metamask.io/snaps/features/notifications/) in\n * MetaMask or natively in the OS. Snaps can trigger a short (up to 80\n * characters) notification message for actionable or time sensitive\n * information. `inApp` notifications can also include an optional\n * [expanded view](https://docs.metamask.io/snaps/features/notifications/#expanded-view).\n * The expanded view has a title, content, and optional footer link shown when\n * a user clicks on the notification.\n *\n * @example Basic in app notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'inApp',\n *     message: 'This is an in-app notification',\n *   },\n * });\n * ```\n *\n * @example Expandable in app notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'inApp',\n *     message: 'This is an in-app notification',\n *     title: 'Notification Title',\n *     content: (\n *       <Box>\n *         <Text>This is the expanded content of the notification.</Text>\n *       </Box>\n *     ),\n *     footerLink: {\n *       href: 'https://example.com',\n *       text: 'Click here for more info',\n *     },\n *   },\n * });\n * ```\n *\n * @example Native notification\n * ```json name=\"Manifest\"\n * {\n *   \"initialPermissions\": {\n *     \"snap_notify\": {}\n *   }\n * }\n * ```\n * ```ts name=\"Usage\"\n * snap.request({\n *   method: 'snap_notify',\n *   params: {\n *     type: 'native',\n *     message: 'This is a native notification',\n *   },\n * });\n * ```\n */\nexport const notifyBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n  actionNames: [\n    'RateLimitController:call',\n    'SnapController:getSnap',\n    'SnapInterfaceController:createInterface',\n  ],\n} as const);\n\n/**\n * Builds the method implementation for `snap_notify`.\n *\n * @param options - The options.\n * @param options.messenger - The messenger.\n * @param options.methodHooks - The RPC method hooks.\n * @param options.methodHooks.isOnPhishingList - A function that checks for links against the phishing list.\n * @param options.methodHooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.\n * @returns The method implementation which returns `null` on success.\n * @throws If the params are invalid.\n */\nexport function getImplementation({\n  methodHooks: { isOnPhishingList, maybeUpdatePhishingList },\n  messenger,\n}: SpecificationBuilderOptions) {\n  return async function implementation(\n    args: RestrictedMethodOptions<NotifyParams>,\n  ): Promise<NotifyResult> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    await maybeUpdatePhishingList();\n\n    const validatedParams = getValidatedParams(\n      params,\n      isOnPhishingList,\n      messenger,\n    );\n\n    if (hasProperty(validatedParams, 'content')) {\n      const id = messenger.call(\n        'SnapInterfaceController:createInterface',\n        origin,\n        validatedParams.content as ComponentOrElement,\n        undefined,\n        ContentType.Notification,\n      );\n      validatedParams.content = id;\n    }\n\n    switch (validatedParams.type) {\n      case NotificationType.Native:\n        return (await messenger.call(\n          'RateLimitController:call',\n          origin,\n          'showNativeNotification',\n          origin,\n          validatedParams.message,\n        )) as NotifyResult;\n      case NotificationType.InApp: {\n        const { content, message, title, footerLink } =\n          validatedParams as NotificationArgs & {\n            content?: string;\n            title?: string;\n            footerLink?: { href: string; text: string };\n          };\n        return (await messenger.call(\n          'RateLimitController:call',\n          origin,\n          'showInAppNotification',\n          origin,\n          {\n            interfaceId: content,\n            message,\n            title,\n            footerLink,\n          },\n        )) as NotifyResult;\n      }\n      /* istanbul ignore next */\n      default:\n        return assertExhaustive(validatedParams.type as never);\n    }\n  };\n}\n\n/**\n * Validates the notify 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 * @param isOnPhishingList - The function that checks for links against the phishing list.\n * @param messenger - The messenger.\n * @returns The validated method parameter object.\n * @throws If the params are invalid.\n */\nexport function getValidatedParams(\n  params: unknown,\n  isOnPhishingList: NotifyMethodHooks['isOnPhishingList'],\n  messenger: Messenger<string, NotifyMessengerActions>,\n): NotifyParams {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { type, message } = params;\n\n  if (\n    !type ||\n    typeof type !== 'string' ||\n    !Object.values(NotificationType).includes(type as NotificationType)\n  ) {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid notification \"type\".',\n    });\n  }\n\n  const isNotString = !message || typeof message !== 'string';\n  // Set to the max message length on a Mac notification for now.\n  if (\n    type === NotificationType.Native &&\n    (isNotString || message.length >= 50)\n  ) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 50 characters long.',\n    });\n  }\n\n  if (\n    type === NotificationType.InApp &&\n    (isNotString || message.length >= 500)\n  ) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 500 characters long.',\n    });\n  }\n\n  try {\n    const validatedParams = createUnion(\n      params,\n      NotificationParametersStruct,\n      'type',\n    );\n\n    const getSnap = (snapId: string) =>\n      messenger.call('SnapController:getSnap', snapId);\n\n    validateTextLinks(validatedParams.message, isOnPhishingList, getSnap);\n\n    if (hasProperty(validatedParams, 'footerLink')) {\n      validateLink(validatedParams.footerLink.href, isOnPhishingList, getSnap);\n    }\n\n    return validatedParams;\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${getErrorMessage(error)}`,\n    });\n  }\n}\n"]}

package/dist/types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  AuxiliaryFileEncoding,\n  BackgroundEvent,\n  ComponentOrElement,\n  GetSnapsResult,\n  GetWebSocketsResult,\n  InterfaceContext,\n  InterfaceState,\n  RequestSnapsResult,\n  ContentType,\n  RequestSnapsParams,\n  SnapId,\n} from '@metamask/snaps-sdk';\nimport type {\n  Snap,\n  SnapRpcHookArgs,\n  TruncatedSnap,\n} from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\n\nexport type JsonRpcRequestWithOrigin<\n  Params extends JsonRpcParams = JsonRpcParams,\n> = JsonRpcRequest<Params> & { origin: string };\n\nexport type HdKeyring = {\n  type: 'HD Key Tree';\n  seed?: Uint8Array;\n  mnemonic?: Uint8Array;\n};\n\nexport type KeyringControllerWithKeyringAction = {\n  type: 'KeyringController:withKeyring';\n  handler: (\n    selector:\n      | {\n          type: string;\n          index?: number;\n        }\n      | { id: string },\n    operation: (args: { keyring: HdKeyring }) => Promise<unknown>,\n  ) => Promise<unknown>;\n};\n\nexport type KeyringControllerGetStateAction = {\n  type: `KeyringController:getState`;\n  handler: () => {\n    isUnlocked: boolean;\n    keyrings: {\n      type: string;\n      metadata: { id: string; name: string };\n    }[];\n  };\n};\n\nexport type ApprovalControllerAddRequestAction = {\n  type: 'ApprovalController:addRequest';\n  handler: (\n    opts: {\n      id?: string;\n      origin: string;\n      type: string;\n      requestData?: Record<string, unknown>;\n      requestState?: Record<string, Json>;\n    },\n    shouldShowRequest: boolean,\n  ) => Promise<Json>;\n};\n\nexport type SnapInterfaceControllerCreateInterfaceAction = {\n  type: 'SnapInterfaceController:createInterface';\n  handler: (\n    snapId: string,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n    contentType?: ContentType,\n  ) => string;\n};\n\nexport type SnapInterfaceControllerGetInterfaceAction = {\n  type: 'SnapInterfaceController:getInterface';\n  handler: (\n    snapId: string,\n    id: string,\n  ) => {\n    content: ComponentOrElement;\n    snapId: SnapId;\n    state: InterfaceState;\n    context: InterfaceContext | null;\n  };\n};\n\nexport type SnapInterfaceControllerSetInterfaceDisplayedAction = {\n  type: 'SnapInterfaceController:setInterfaceDisplayed';\n  handler: (snapId: string, id: string) => void;\n};\n\nexport type SnapInterfaceControllerGetInterfaceStateAction = {\n  type: `SnapInterfaceController:getInterfaceState`;\n  handler: (snapId: string, id: string) => InterfaceState;\n};\n\nexport type SnapInterfaceControllerUpdateInterfaceAction = {\n  type: `SnapInterfaceController:updateInterface`;\n  handler: (\n    snapId: string,\n    id: string,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\nexport type SnapInterfaceControllerResolveInterfaceAction = {\n  type: `SnapInterfaceController:resolveInterface`;\n  handler: (snapId: string, id: string, value: Json) => Promise<void>;\n};\n\nexport type SnapControllerHandleRequestAction = {\n  type: 'SnapController:handleRequest';\n  handler: (args: SnapRpcHookArgs & { snapId: string }) => Promise<unknown>;\n};\n\nexport type SnapControllerGetSnapAction = {\n  type: 'SnapController:getSnap';\n  handler: (snapId: string) => Snap | null;\n};\n\nexport type SnapControllerClearSnapStateAction = {\n  type: 'SnapController:clearSnapState';\n  handler: (snapId: string, encrypted: boolean) => void;\n};\n\nexport type SnapControllerGetSnapStateAction = {\n  type: 'SnapController:getSnapState';\n  handler: (\n    snapId: string,\n    encrypted: boolean,\n  ) => Promise<Record<string, Json> | null>;\n};\n\nexport type SnapControllerUpdateSnapStateAction = {\n  type: 'SnapController:updateSnapState';\n  handler: (\n    snapId: string,\n    newState: Record<string, Json>,\n    encrypted: boolean,\n  ) => Promise<void>;\n};\n\nexport type SnapControllerGetAllSnapsAction = {\n  type: `SnapController:getAllSnaps`;\n  handler: () => TruncatedSnap[];\n};\n\nexport type SnapControllerGetPermittedSnapsAction = {\n  type: `SnapController:getPermittedSnaps`;\n  handler: (origin: string) => GetSnapsResult;\n};\n\nexport type SnapControllerInstallSnapsAction = {\n  type: `SnapController:installSnaps`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type SnapControllerGetSnapFileAction = {\n  type: `SnapController:getSnapFile`;\n  handler: (\n    snapId: string,\n    path: string,\n    encoding?: AuxiliaryFileEncoding,\n  ) => Promise<string | null>;\n};\n\nexport type RateLimitControllerCallAction = {\n  type: 'RateLimitController:call';\n  handler: (\n    origin: string,\n    type: string,\n    ...args: unknown[]\n  ) => Promise<unknown>;\n};\n\nexport type CronjobControllerCancelAction = {\n  type: `CronjobController:cancel`;\n  handler: (origin: string, id: string) => void;\n};\n\nexport type CronjobControllerScheduleAction = {\n  type: `CronjobController:schedule`;\n  handler: (event: {\n    snapId: string;\n    request: {\n      method: string;\n      jsonrpc?: '2.0';\n      id?: string | number | null;\n      params?: Json[] | Record<string, Json>;\n    };\n    schedule: string;\n    id?: string;\n  }) => string;\n};\n\nexport type CronjobControllerGetAction = {\n  type: `CronjobController:get`;\n  handler: (snapId: string) => BackgroundEvent[];\n};\n\nexport type WebSocketServiceOpenAction = {\n  type: `WebSocketService:open`;\n  handler: (\n    snapId: string,\n    url: string,\n    protocols?: string[],\n  ) => Promise<string>;\n};\n\nexport type WebSocketServiceCloseAction = {\n  type: `WebSocketService:close`;\n  handler: (snapId: string, id: string) => void;\n};\n\nexport type WebSocketServiceSendMessageAction = {\n  type: `WebSocketService:sendMessage`;\n  handler: (\n    snapId: string,\n    id: string,\n    data: string | number[],\n  ) => Promise<void>;\n};\n\nexport type WebSocketServiceGetAllAction = {\n  type: `WebSocketService:getAll`;\n  handler: (snapId: string) => GetWebSocketsResult;\n};\n"]}

package/dist/types.d.cts

@@ -0,0 +1,155 @@
+import type { AuxiliaryFileEncoding, BackgroundEvent, ComponentOrElement, GetSnapsResult, GetWebSocketsResult, InterfaceContext, InterfaceState, RequestSnapsResult, ContentType, RequestSnapsParams, SnapId } from "@metamask/snaps-sdk";
+import type { Snap, SnapRpcHookArgs, TruncatedSnap } from "@metamask/snaps-utils";
+import type { Json, JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
+export type JsonRpcRequestWithOrigin<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcRequest<Params> & {
+    origin: string;
+};
+export type HdKeyring = {
+    type: 'HD Key Tree';
+    seed?: Uint8Array;
+    mnemonic?: Uint8Array;
+};
+export type KeyringControllerWithKeyringAction = {
+    type: 'KeyringController:withKeyring';
+    handler: (selector: {
+        type: string;
+        index?: number;
+    } | {
+        id: string;
+    }, operation: (args: {
+        keyring: HdKeyring;
+    }) => Promise<unknown>) => Promise<unknown>;
+};
+export type KeyringControllerGetStateAction = {
+    type: `KeyringController:getState`;
+    handler: () => {
+        isUnlocked: boolean;
+        keyrings: {
+            type: string;
+            metadata: {
+                id: string;
+                name: string;
+            };
+        }[];
+    };
+};
+export type ApprovalControllerAddRequestAction = {
+    type: 'ApprovalController:addRequest';
+    handler: (opts: {
+        id?: string;
+        origin: string;
+        type: string;
+        requestData?: Record<string, unknown>;
+        requestState?: Record<string, Json>;
+    }, shouldShowRequest: boolean) => Promise<Json>;
+};
+export type SnapInterfaceControllerCreateInterfaceAction = {
+    type: 'SnapInterfaceController:createInterface';
+    handler: (snapId: string, content: ComponentOrElement, context?: InterfaceContext, contentType?: ContentType) => string;
+};
+export type SnapInterfaceControllerGetInterfaceAction = {
+    type: 'SnapInterfaceController:getInterface';
+    handler: (snapId: string, id: string) => {
+        content: ComponentOrElement;
+        snapId: SnapId;
+        state: InterfaceState;
+        context: InterfaceContext | null;
+    };
+};
+export type SnapInterfaceControllerSetInterfaceDisplayedAction = {
+    type: 'SnapInterfaceController:setInterfaceDisplayed';
+    handler: (snapId: string, id: string) => void;
+};
+export type SnapInterfaceControllerGetInterfaceStateAction = {
+    type: `SnapInterfaceController:getInterfaceState`;
+    handler: (snapId: string, id: string) => InterfaceState;
+};
+export type SnapInterfaceControllerUpdateInterfaceAction = {
+    type: `SnapInterfaceController:updateInterface`;
+    handler: (snapId: string, id: string, content: ComponentOrElement, context?: InterfaceContext) => void;
+};
+export type SnapInterfaceControllerResolveInterfaceAction = {
+    type: `SnapInterfaceController:resolveInterface`;
+    handler: (snapId: string, id: string, value: Json) => Promise<void>;
+};
+export type SnapControllerHandleRequestAction = {
+    type: 'SnapController:handleRequest';
+    handler: (args: SnapRpcHookArgs & {
+        snapId: string;
+    }) => Promise<unknown>;
+};
+export type SnapControllerGetSnapAction = {
+    type: 'SnapController:getSnap';
+    handler: (snapId: string) => Snap | null;
+};
+export type SnapControllerClearSnapStateAction = {
+    type: 'SnapController:clearSnapState';
+    handler: (snapId: string, encrypted: boolean) => void;
+};
+export type SnapControllerGetSnapStateAction = {
+    type: 'SnapController:getSnapState';
+    handler: (snapId: string, encrypted: boolean) => Promise<Record<string, Json> | null>;
+};
+export type SnapControllerUpdateSnapStateAction = {
+    type: 'SnapController:updateSnapState';
+    handler: (snapId: string, newState: Record<string, Json>, encrypted: boolean) => Promise<void>;
+};
+export type SnapControllerGetAllSnapsAction = {
+    type: `SnapController:getAllSnaps`;
+    handler: () => TruncatedSnap[];
+};
+export type SnapControllerGetPermittedSnapsAction = {
+    type: `SnapController:getPermittedSnaps`;
+    handler: (origin: string) => GetSnapsResult;
+};
+export type SnapControllerInstallSnapsAction = {
+    type: `SnapController:installSnaps`;
+    handler: (origin: string, requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
+};
+export type SnapControllerGetSnapFileAction = {
+    type: `SnapController:getSnapFile`;
+    handler: (snapId: string, path: string, encoding?: AuxiliaryFileEncoding) => Promise<string | null>;
+};
+export type RateLimitControllerCallAction = {
+    type: 'RateLimitController:call';
+    handler: (origin: string, type: string, ...args: unknown[]) => Promise<unknown>;
+};
+export type CronjobControllerCancelAction = {
+    type: `CronjobController:cancel`;
+    handler: (origin: string, id: string) => void;
+};
+export type CronjobControllerScheduleAction = {
+    type: `CronjobController:schedule`;
+    handler: (event: {
+        snapId: string;
+        request: {
+            method: string;
+            jsonrpc?: '2.0';
+            id?: string | number | null;
+            params?: Json[] | Record<string, Json>;
+        };
+        schedule: string;
+        id?: string;
+    }) => string;
+};
+export type CronjobControllerGetAction = {
+    type: `CronjobController:get`;
+    handler: (snapId: string) => BackgroundEvent[];
+};
+export type WebSocketServiceOpenAction = {
+    type: `WebSocketService:open`;
+    handler: (snapId: string, url: string, protocols?: string[]) => Promise<string>;
+};
+export type WebSocketServiceCloseAction = {
+    type: `WebSocketService:close`;
+    handler: (snapId: string, id: string) => void;
+};
+export type WebSocketServiceSendMessageAction = {
+    type: `WebSocketService:sendMessage`;
+    handler: (snapId: string, id: string, data: string | number[]) => Promise<void>;
+};
+export type WebSocketServiceGetAllAction = {
+    type: `WebSocketService:getAll`;
+    handler: (snapId: string) => GetWebSocketsResult;
+};
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,MAAM,EACP,4BAA4B;AAC7B,OAAO,KAAK,EACV,IAAI,EACJ,eAAe,EACf,aAAa,EACd,8BAA8B;AAC/B,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB;AAE3E,MAAM,MAAM,wBAAwB,CAClC,MAAM,SAAS,aAAa,GAAG,aAAa,IAC1C,cAAc,CAAC,MAAM,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CACP,QAAQ,EACJ;QACE,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACD;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAClB,SAAS,EAAE,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,SAAS,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,KAC1D,OAAO,CAAC,OAAO,CAAC,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM;QACb,UAAU,EAAE,OAAO,CAAC;QACpB,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,EAAE,MAAM,CAAA;aAAE,CAAC;SACxC,EAAE,CAAC;KACL,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CACP,IAAI,EAAE;QACJ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACrC,EACD,iBAAiB,EAAE,OAAO,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,WAAW,CAAC,EAAE,WAAW,KACtB,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,KACP;QACH,OAAO,EAAE,kBAAkB,CAAC;QAC5B,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,cAAc,CAAC;QACtB,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,gBAAgB,KACvB,IAAI,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3E,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,OAAO,KACf,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,SAAS,EAAE,OAAO,KACf,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,aAAa,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,qBAAqB,KAC7B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,OAAO,CAAC,OAAO,CAAC,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,CAAC,KAAK,EAAE;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,CAAC,EAAE,KAAK,CAAC;YAChB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;YAC5B,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;QACF,QAAQ,EAAE,MAAM,CAAC;QACjB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,KAAK,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,EAAE,KACjB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,155 @@
+import type { AuxiliaryFileEncoding, BackgroundEvent, ComponentOrElement, GetSnapsResult, GetWebSocketsResult, InterfaceContext, InterfaceState, RequestSnapsResult, ContentType, RequestSnapsParams, SnapId } from "@metamask/snaps-sdk";
+import type { Snap, SnapRpcHookArgs, TruncatedSnap } from "@metamask/snaps-utils";
+import type { Json, JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
+export type JsonRpcRequestWithOrigin<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcRequest<Params> & {
+    origin: string;
+};
+export type HdKeyring = {
+    type: 'HD Key Tree';
+    seed?: Uint8Array;
+    mnemonic?: Uint8Array;
+};
+export type KeyringControllerWithKeyringAction = {
+    type: 'KeyringController:withKeyring';
+    handler: (selector: {
+        type: string;
+        index?: number;
+    } | {
+        id: string;
+    }, operation: (args: {
+        keyring: HdKeyring;
+    }) => Promise<unknown>) => Promise<unknown>;
+};
+export type KeyringControllerGetStateAction = {
+    type: `KeyringController:getState`;
+    handler: () => {
+        isUnlocked: boolean;
+        keyrings: {
+            type: string;
+            metadata: {
+                id: string;
+                name: string;
+            };
+        }[];
+    };
+};
+export type ApprovalControllerAddRequestAction = {
+    type: 'ApprovalController:addRequest';
+    handler: (opts: {
+        id?: string;
+        origin: string;
+        type: string;
+        requestData?: Record<string, unknown>;
+        requestState?: Record<string, Json>;
+    }, shouldShowRequest: boolean) => Promise<Json>;
+};
+export type SnapInterfaceControllerCreateInterfaceAction = {
+    type: 'SnapInterfaceController:createInterface';
+    handler: (snapId: string, content: ComponentOrElement, context?: InterfaceContext, contentType?: ContentType) => string;
+};
+export type SnapInterfaceControllerGetInterfaceAction = {
+    type: 'SnapInterfaceController:getInterface';
+    handler: (snapId: string, id: string) => {
+        content: ComponentOrElement;
+        snapId: SnapId;
+        state: InterfaceState;
+        context: InterfaceContext | null;
+    };
+};
+export type SnapInterfaceControllerSetInterfaceDisplayedAction = {
+    type: 'SnapInterfaceController:setInterfaceDisplayed';
+    handler: (snapId: string, id: string) => void;
+};
+export type SnapInterfaceControllerGetInterfaceStateAction = {
+    type: `SnapInterfaceController:getInterfaceState`;
+    handler: (snapId: string, id: string) => InterfaceState;
+};
+export type SnapInterfaceControllerUpdateInterfaceAction = {
+    type: `SnapInterfaceController:updateInterface`;
+    handler: (snapId: string, id: string, content: ComponentOrElement, context?: InterfaceContext) => void;
+};
+export type SnapInterfaceControllerResolveInterfaceAction = {
+    type: `SnapInterfaceController:resolveInterface`;
+    handler: (snapId: string, id: string, value: Json) => Promise<void>;
+};
+export type SnapControllerHandleRequestAction = {
+    type: 'SnapController:handleRequest';
+    handler: (args: SnapRpcHookArgs & {
+        snapId: string;
+    }) => Promise<unknown>;
+};
+export type SnapControllerGetSnapAction = {
+    type: 'SnapController:getSnap';
+    handler: (snapId: string) => Snap | null;
+};
+export type SnapControllerClearSnapStateAction = {
+    type: 'SnapController:clearSnapState';
+    handler: (snapId: string, encrypted: boolean) => void;
+};
+export type SnapControllerGetSnapStateAction = {
+    type: 'SnapController:getSnapState';
+    handler: (snapId: string, encrypted: boolean) => Promise<Record<string, Json> | null>;
+};
+export type SnapControllerUpdateSnapStateAction = {
+    type: 'SnapController:updateSnapState';
+    handler: (snapId: string, newState: Record<string, Json>, encrypted: boolean) => Promise<void>;
+};
+export type SnapControllerGetAllSnapsAction = {
+    type: `SnapController:getAllSnaps`;
+    handler: () => TruncatedSnap[];
+};
+export type SnapControllerGetPermittedSnapsAction = {
+    type: `SnapController:getPermittedSnaps`;
+    handler: (origin: string) => GetSnapsResult;
+};
+export type SnapControllerInstallSnapsAction = {
+    type: `SnapController:installSnaps`;
+    handler: (origin: string, requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
+};
+export type SnapControllerGetSnapFileAction = {
+    type: `SnapController:getSnapFile`;
+    handler: (snapId: string, path: string, encoding?: AuxiliaryFileEncoding) => Promise<string | null>;
+};
+export type RateLimitControllerCallAction = {
+    type: 'RateLimitController:call';
+    handler: (origin: string, type: string, ...args: unknown[]) => Promise<unknown>;
+};
+export type CronjobControllerCancelAction = {
+    type: `CronjobController:cancel`;
+    handler: (origin: string, id: string) => void;
+};
+export type CronjobControllerScheduleAction = {
+    type: `CronjobController:schedule`;
+    handler: (event: {
+        snapId: string;
+        request: {
+            method: string;
+            jsonrpc?: '2.0';
+            id?: string | number | null;
+            params?: Json[] | Record<string, Json>;
+        };
+        schedule: string;
+        id?: string;
+    }) => string;
+};
+export type CronjobControllerGetAction = {
+    type: `CronjobController:get`;
+    handler: (snapId: string) => BackgroundEvent[];
+};
+export type WebSocketServiceOpenAction = {
+    type: `WebSocketService:open`;
+    handler: (snapId: string, url: string, protocols?: string[]) => Promise<string>;
+};
+export type WebSocketServiceCloseAction = {
+    type: `WebSocketService:close`;
+    handler: (snapId: string, id: string) => void;
+};
+export type WebSocketServiceSendMessageAction = {
+    type: `WebSocketService:sendMessage`;
+    handler: (snapId: string, id: string, data: string | number[]) => Promise<void>;
+};
+export type WebSocketServiceGetAllAction = {
+    type: `WebSocketService:getAll`;
+    handler: (snapId: string) => GetWebSocketsResult;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,MAAM,EACP,4BAA4B;AAC7B,OAAO,KAAK,EACV,IAAI,EACJ,eAAe,EACf,aAAa,EACd,8BAA8B;AAC/B,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB;AAE3E,MAAM,MAAM,wBAAwB,CAClC,MAAM,SAAS,aAAa,GAAG,aAAa,IAC1C,cAAc,CAAC,MAAM,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CACP,QAAQ,EACJ;QACE,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACD;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAClB,SAAS,EAAE,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,SAAS,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,KAC1D,OAAO,CAAC,OAAO,CAAC,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM;QACb,UAAU,EAAE,OAAO,CAAC;QACpB,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,EAAE,MAAM,CAAA;aAAE,CAAC;SACxC,EAAE,CAAC;KACL,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CACP,IAAI,EAAE;QACJ,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACrC,EACD,iBAAiB,EAAE,OAAO,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,WAAW,CAAC,EAAE,WAAW,KACtB,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,KACP;QACH,OAAO,EAAE,kBAAkB,CAAC;QAC5B,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,cAAc,CAAC;QACtB,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,gBAAgB,KACvB,IAAI,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3E,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,OAAO,KACf,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,SAAS,EAAE,OAAO,KACf,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,aAAa,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,kBAAkB,KAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,qBAAqB,KAC7B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,OAAO,CAAC,OAAO,CAAC,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,CAAC,KAAK,EAAE;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,CAAC,EAAE,KAAK,CAAC;YAChB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;YAC5B,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;QACF,QAAQ,EAAE,MAAM,CAAC;QACjB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,KAAK,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,EAAE,KACjB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  AuxiliaryFileEncoding,\n  BackgroundEvent,\n  ComponentOrElement,\n  GetSnapsResult,\n  GetWebSocketsResult,\n  InterfaceContext,\n  InterfaceState,\n  RequestSnapsResult,\n  ContentType,\n  RequestSnapsParams,\n  SnapId,\n} from '@metamask/snaps-sdk';\nimport type {\n  Snap,\n  SnapRpcHookArgs,\n  TruncatedSnap,\n} from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\n\nexport type JsonRpcRequestWithOrigin<\n  Params extends JsonRpcParams = JsonRpcParams,\n> = JsonRpcRequest<Params> & { origin: string };\n\nexport type HdKeyring = {\n  type: 'HD Key Tree';\n  seed?: Uint8Array;\n  mnemonic?: Uint8Array;\n};\n\nexport type KeyringControllerWithKeyringAction = {\n  type: 'KeyringController:withKeyring';\n  handler: (\n    selector:\n      | {\n          type: string;\n          index?: number;\n        }\n      | { id: string },\n    operation: (args: { keyring: HdKeyring }) => Promise<unknown>,\n  ) => Promise<unknown>;\n};\n\nexport type KeyringControllerGetStateAction = {\n  type: `KeyringController:getState`;\n  handler: () => {\n    isUnlocked: boolean;\n    keyrings: {\n      type: string;\n      metadata: { id: string; name: string };\n    }[];\n  };\n};\n\nexport type ApprovalControllerAddRequestAction = {\n  type: 'ApprovalController:addRequest';\n  handler: (\n    opts: {\n      id?: string;\n      origin: string;\n      type: string;\n      requestData?: Record<string, unknown>;\n      requestState?: Record<string, Json>;\n    },\n    shouldShowRequest: boolean,\n  ) => Promise<Json>;\n};\n\nexport type SnapInterfaceControllerCreateInterfaceAction = {\n  type: 'SnapInterfaceController:createInterface';\n  handler: (\n    snapId: string,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n    contentType?: ContentType,\n  ) => string;\n};\n\nexport type SnapInterfaceControllerGetInterfaceAction = {\n  type: 'SnapInterfaceController:getInterface';\n  handler: (\n    snapId: string,\n    id: string,\n  ) => {\n    content: ComponentOrElement;\n    snapId: SnapId;\n    state: InterfaceState;\n    context: InterfaceContext | null;\n  };\n};\n\nexport type SnapInterfaceControllerSetInterfaceDisplayedAction = {\n  type: 'SnapInterfaceController:setInterfaceDisplayed';\n  handler: (snapId: string, id: string) => void;\n};\n\nexport type SnapInterfaceControllerGetInterfaceStateAction = {\n  type: `SnapInterfaceController:getInterfaceState`;\n  handler: (snapId: string, id: string) => InterfaceState;\n};\n\nexport type SnapInterfaceControllerUpdateInterfaceAction = {\n  type: `SnapInterfaceController:updateInterface`;\n  handler: (\n    snapId: string,\n    id: string,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\nexport type SnapInterfaceControllerResolveInterfaceAction = {\n  type: `SnapInterfaceController:resolveInterface`;\n  handler: (snapId: string, id: string, value: Json) => Promise<void>;\n};\n\nexport type SnapControllerHandleRequestAction = {\n  type: 'SnapController:handleRequest';\n  handler: (args: SnapRpcHookArgs & { snapId: string }) => Promise<unknown>;\n};\n\nexport type SnapControllerGetSnapAction = {\n  type: 'SnapController:getSnap';\n  handler: (snapId: string) => Snap | null;\n};\n\nexport type SnapControllerClearSnapStateAction = {\n  type: 'SnapController:clearSnapState';\n  handler: (snapId: string, encrypted: boolean) => void;\n};\n\nexport type SnapControllerGetSnapStateAction = {\n  type: 'SnapController:getSnapState';\n  handler: (\n    snapId: string,\n    encrypted: boolean,\n  ) => Promise<Record<string, Json> | null>;\n};\n\nexport type SnapControllerUpdateSnapStateAction = {\n  type: 'SnapController:updateSnapState';\n  handler: (\n    snapId: string,\n    newState: Record<string, Json>,\n    encrypted: boolean,\n  ) => Promise<void>;\n};\n\nexport type SnapControllerGetAllSnapsAction = {\n  type: `SnapController:getAllSnaps`;\n  handler: () => TruncatedSnap[];\n};\n\nexport type SnapControllerGetPermittedSnapsAction = {\n  type: `SnapController:getPermittedSnaps`;\n  handler: (origin: string) => GetSnapsResult;\n};\n\nexport type SnapControllerInstallSnapsAction = {\n  type: `SnapController:installSnaps`;\n  handler: (\n    origin: string,\n    requestedSnaps: RequestSnapsParams,\n  ) => Promise<RequestSnapsResult>;\n};\n\nexport type SnapControllerGetSnapFileAction = {\n  type: `SnapController:getSnapFile`;\n  handler: (\n    snapId: string,\n    path: string,\n    encoding?: AuxiliaryFileEncoding,\n  ) => Promise<string | null>;\n};\n\nexport type RateLimitControllerCallAction = {\n  type: 'RateLimitController:call';\n  handler: (\n    origin: string,\n    type: string,\n    ...args: unknown[]\n  ) => Promise<unknown>;\n};\n\nexport type CronjobControllerCancelAction = {\n  type: `CronjobController:cancel`;\n  handler: (origin: string, id: string) => void;\n};\n\nexport type CronjobControllerScheduleAction = {\n  type: `CronjobController:schedule`;\n  handler: (event: {\n    snapId: string;\n    request: {\n      method: string;\n      jsonrpc?: '2.0';\n      id?: string | number | null;\n      params?: Json[] | Record<string, Json>;\n    };\n    schedule: string;\n    id?: string;\n  }) => string;\n};\n\nexport type CronjobControllerGetAction = {\n  type: `CronjobController:get`;\n  handler: (snapId: string) => BackgroundEvent[];\n};\n\nexport type WebSocketServiceOpenAction = {\n  type: `WebSocketService:open`;\n  handler: (\n    snapId: string,\n    url: string,\n    protocols?: string[],\n  ) => Promise<string>;\n};\n\nexport type WebSocketServiceCloseAction = {\n  type: `WebSocketService:close`;\n  handler: (snapId: string, id: string) => void;\n};\n\nexport type WebSocketServiceSendMessageAction = {\n  type: `WebSocketService:sendMessage`;\n  handler: (\n    snapId: string,\n    id: string,\n    data: string | number[],\n  ) => Promise<void>;\n};\n\nexport type WebSocketServiceGetAllAction = {\n  type: `WebSocketService:getAll`;\n  handler: (snapId: string) => GetWebSocketsResult;\n};\n"]}