@metamask/snaps-sdk 10.3.0 → 11.0.0

package/dist/types/methods/multichain/revoke-session.cjs

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

package/dist/types/methods/multichain/revoke-session.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-session.cjs","sourceRoot":"","sources":["../../../../src/types/methods/multichain/revoke-session.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `wallet_revokeSession` method.\n *\n * @property scopes - The scopes to revoke.\n */\nexport type RevokeSessionParams = {\n  scopes?: string[];\n};\n\n/**\n * The result returned for the `wallet_revokeSession` method.\n */\nexport type RevokeSessionResult = true;\n"]}

package/dist/types/methods/multichain/revoke-session.d.cts

@@ -0,0 +1,13 @@
+/**
+ * The request parameters for the `wallet_revokeSession` method.
+ *
+ * @property scopes - The scopes to revoke.
+ */
+export type RevokeSessionParams = {
+    scopes?: string[];
+};
+/**
+ * The result returned for the `wallet_revokeSession` method.
+ */
+export type RevokeSessionResult = true;
+//# sourceMappingURL=revoke-session.d.cts.map

package/dist/types/methods/multichain/revoke-session.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-session.d.cts","sourceRoot":"","sources":["../../../../src/types/methods/multichain/revoke-session.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC"}

package/dist/types/methods/multichain/revoke-session.d.mts

@@ -0,0 +1,13 @@
+/**
+ * The request parameters for the `wallet_revokeSession` method.
+ *
+ * @property scopes - The scopes to revoke.
+ */
+export type RevokeSessionParams = {
+    scopes?: string[];
+};
+/**
+ * The result returned for the `wallet_revokeSession` method.
+ */
+export type RevokeSessionResult = true;
+//# sourceMappingURL=revoke-session.d.mts.map

package/dist/types/methods/multichain/revoke-session.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-session.d.mts","sourceRoot":"","sources":["../../../../src/types/methods/multichain/revoke-session.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC"}

package/dist/types/methods/multichain/revoke-session.mjs

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

package/dist/types/methods/multichain/revoke-session.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-session.mjs","sourceRoot":"","sources":["../../../../src/types/methods/multichain/revoke-session.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `wallet_revokeSession` method.\n *\n * @property scopes - The scopes to revoke.\n */\nexport type RevokeSessionParams = {\n  scopes?: string[];\n};\n\n/**\n * The result returned for the `wallet_revokeSession` method.\n */\nexport type RevokeSessionResult = true;\n"]}

package/dist/types/methods/notify.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"notify.cjs","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":";;;AAGA;;;;;GAKG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B","sourcesContent":["import { type EnumToUnion } from '../../internals';\nimport type { ComponentOrElement } from '../interface';\n\n/**\n * The types of notifications that can be displayed.\n *\n * - `InApp` - A notification that is displayed in by the MetaMask extension.\n * - `Native` - A notification that is displayed by the operating system.\n */\nexport enum NotificationType {\n  InApp = 'inApp',\n  Native = 'native',\n}\n\n/**\n * The request parameters for the `snap_notify` method.\n *\n * @property type - The type of notification to display.\n * @property message - The message to display in the notification.\n */\nexport type NotifyParams =\n  | {\n      type: EnumToUnion<NotificationType.Native>;\n      message: string;\n    }\n  | {\n      type: EnumToUnion<NotificationType.InApp>;\n      message: string;\n    }\n  | {\n      type: EnumToUnion<NotificationType.InApp>;\n      message: string;\n      content: ComponentOrElement;\n      title: string;\n      footerLink?: { href: string; text: string };\n    };\n\n/**\n * The result returned by the `snap_notify` method.\n *\n * This method does not return anything.\n */\nexport type NotifyResult = null;\n"]}
+{"version":3,"file":"notify.cjs","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":";;;AAGA;;;;;GAKG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B","sourcesContent":["import { type EnumToUnion } from '../../internals';\nimport type { ComponentOrElement } from '../interface';\n\n/**\n * The types of notifications that can be displayed.\n *\n * - `InApp` - A notification that is displayed in by the MetaMask extension.\n * - `Native` - A notification that is displayed by the operating system.\n */\nexport enum NotificationType {\n  InApp = 'inApp',\n  Native = 'native',\n}\n\n/**\n * An object containing the parameters for the `snap_notify` method.\n */\nexport type NotifyParams =\n  | {\n      /**\n       * The literal string \"native\" to indicate that this is a native OS\n       * notification. We recommend using `inApp` instead, as native\n       * notifications may be rate-limited by the operating system.\n       */\n      type: EnumToUnion<NotificationType.Native>;\n\n      /**\n       * The message to display in the notification.\n       */\n      message: string;\n    }\n  | {\n      /**\n       * The literal string \"inApp\" to indicate that this is an in-app\n       * notification displayed in the MetaMask UI.\n       */\n      type: EnumToUnion<NotificationType.InApp>;\n\n      /**\n       * The message to display in the notification.\n       */\n      message: string;\n    }\n  | {\n      /**\n       * The literal string \"inApp\" to indicate that this is an in-app\n       * notification displayed in the MetaMask UI.\n       */\n      type: EnumToUnion<NotificationType.InApp>;\n\n      /**\n       * A short summary shown in the notification list.\n       */\n      message: string;\n\n      /**\n       * The custom UI content to display when the notification is expanded.\n       */\n      content: ComponentOrElement;\n\n      /**\n       * The title of the expanded notification.\n       */\n      title: string;\n\n      /**\n       * An optional link to display in the footer of the expanded notification.\n       */\n      footerLink?: {\n        /**\n         * The URL to navigate to when the link is clicked.\n         */\n        href: string;\n\n        /**\n         * The link text to display.\n         */\n        text: string;\n      };\n    };\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type NotifyResult = null;\n"]}

package/dist/types/methods/notify.d.cts

@@ -11,31 +11,63 @@ export declare enum NotificationType {
     Native = "native"
 }
 /**
- * The request parameters for the `snap_notify` method.
- *
- * @property type - The type of notification to display.
- * @property message - The message to display in the notification.
+ * An object containing the parameters for the `snap_notify` method.
  */
 export type NotifyParams = {
+    /**
+     * The literal string "native" to indicate that this is a native OS
+     * notification. We recommend using `inApp` instead, as native
+     * notifications may be rate-limited by the operating system.
+     */
     type: EnumToUnion<NotificationType.Native>;
+    /**
+     * The message to display in the notification.
+     */
     message: string;
 } | {
+    /**
+     * The literal string "inApp" to indicate that this is an in-app
+     * notification displayed in the MetaMask UI.
+     */
     type: EnumToUnion<NotificationType.InApp>;
+    /**
+     * The message to display in the notification.
+     */
     message: string;
 } | {
+    /**
+     * The literal string "inApp" to indicate that this is an in-app
+     * notification displayed in the MetaMask UI.
+     */
     type: EnumToUnion<NotificationType.InApp>;
+    /**
+     * A short summary shown in the notification list.
+     */
     message: string;
+    /**
+     * The custom UI content to display when the notification is expanded.
+     */
     content: ComponentOrElement;
+    /**
+     * The title of the expanded notification.
+     */
     title: string;
+    /**
+     * An optional link to display in the footer of the expanded notification.
+     */
     footerLink?: {
+        /**
+         * The URL to navigate to when the link is clicked.
+         */
         href: string;
+        /**
+         * The link text to display.
+         */
         text: string;
     };
 };
 /**
- * The result returned by the `snap_notify` method.
- *
- * This method does not return anything.
+ * This method does not return any data, so the result is always `null`.
  */
 export type NotifyResult = null;
 //# sourceMappingURL=notify.d.cts.map

package/dist/types/methods/notify.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"notify.d.cts","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,yBAAqB;AAEvD;;;;;GAKG;AACH,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GACpB;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}
+{"version":3,"file":"notify.d.cts","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,yBAAqB;AAEvD;;;;;GAKG;AACH,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB;IACE;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}

package/dist/types/methods/notify.d.mts

@@ -11,31 +11,63 @@ export declare enum NotificationType {
     Native = "native"
 }
 /**
- * The request parameters for the `snap_notify` method.
- *
- * @property type - The type of notification to display.
- * @property message - The message to display in the notification.
+ * An object containing the parameters for the `snap_notify` method.
  */
 export type NotifyParams = {
+    /**
+     * The literal string "native" to indicate that this is a native OS
+     * notification. We recommend using `inApp` instead, as native
+     * notifications may be rate-limited by the operating system.
+     */
     type: EnumToUnion<NotificationType.Native>;
+    /**
+     * The message to display in the notification.
+     */
     message: string;
 } | {
+    /**
+     * The literal string "inApp" to indicate that this is an in-app
+     * notification displayed in the MetaMask UI.
+     */
     type: EnumToUnion<NotificationType.InApp>;
+    /**
+     * The message to display in the notification.
+     */
     message: string;
 } | {
+    /**
+     * The literal string "inApp" to indicate that this is an in-app
+     * notification displayed in the MetaMask UI.
+     */
     type: EnumToUnion<NotificationType.InApp>;
+    /**
+     * A short summary shown in the notification list.
+     */
     message: string;
+    /**
+     * The custom UI content to display when the notification is expanded.
+     */
     content: ComponentOrElement;
+    /**
+     * The title of the expanded notification.
+     */
     title: string;
+    /**
+     * An optional link to display in the footer of the expanded notification.
+     */
     footerLink?: {
+        /**
+         * The URL to navigate to when the link is clicked.
+         */
         href: string;
+        /**
+         * The link text to display.
+         */
         text: string;
     };
 };
 /**
- * The result returned by the `snap_notify` method.
- *
- * This method does not return anything.
+ * This method does not return any data, so the result is always `null`.
  */
 export type NotifyResult = null;
 //# sourceMappingURL=notify.d.mts.map

package/dist/types/methods/notify.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"notify.d.mts","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,yBAAqB;AAEvD;;;;;GAKG;AACH,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GACpB;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7C,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}
+{"version":3,"file":"notify.d.mts","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,kCAAwB;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,yBAAqB;AAEvD;;;;;GAKG;AACH,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB;IACE;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}

package/dist/types/methods/notify.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"notify.mjs","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B","sourcesContent":["import { type EnumToUnion } from '../../internals';\nimport type { ComponentOrElement } from '../interface';\n\n/**\n * The types of notifications that can be displayed.\n *\n * - `InApp` - A notification that is displayed in by the MetaMask extension.\n * - `Native` - A notification that is displayed by the operating system.\n */\nexport enum NotificationType {\n  InApp = 'inApp',\n  Native = 'native',\n}\n\n/**\n * The request parameters for the `snap_notify` method.\n *\n * @property type - The type of notification to display.\n * @property message - The message to display in the notification.\n */\nexport type NotifyParams =\n  | {\n      type: EnumToUnion<NotificationType.Native>;\n      message: string;\n    }\n  | {\n      type: EnumToUnion<NotificationType.InApp>;\n      message: string;\n    }\n  | {\n      type: EnumToUnion<NotificationType.InApp>;\n      message: string;\n      content: ComponentOrElement;\n      title: string;\n      footerLink?: { href: string; text: string };\n    };\n\n/**\n * The result returned by the `snap_notify` method.\n *\n * This method does not return anything.\n */\nexport type NotifyResult = null;\n"]}
+{"version":3,"file":"notify.mjs","sourceRoot":"","sources":["../../../src/types/methods/notify.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B","sourcesContent":["import { type EnumToUnion } from '../../internals';\nimport type { ComponentOrElement } from '../interface';\n\n/**\n * The types of notifications that can be displayed.\n *\n * - `InApp` - A notification that is displayed in by the MetaMask extension.\n * - `Native` - A notification that is displayed by the operating system.\n */\nexport enum NotificationType {\n  InApp = 'inApp',\n  Native = 'native',\n}\n\n/**\n * An object containing the parameters for the `snap_notify` method.\n */\nexport type NotifyParams =\n  | {\n      /**\n       * The literal string \"native\" to indicate that this is a native OS\n       * notification. We recommend using `inApp` instead, as native\n       * notifications may be rate-limited by the operating system.\n       */\n      type: EnumToUnion<NotificationType.Native>;\n\n      /**\n       * The message to display in the notification.\n       */\n      message: string;\n    }\n  | {\n      /**\n       * The literal string \"inApp\" to indicate that this is an in-app\n       * notification displayed in the MetaMask UI.\n       */\n      type: EnumToUnion<NotificationType.InApp>;\n\n      /**\n       * The message to display in the notification.\n       */\n      message: string;\n    }\n  | {\n      /**\n       * The literal string \"inApp\" to indicate that this is an in-app\n       * notification displayed in the MetaMask UI.\n       */\n      type: EnumToUnion<NotificationType.InApp>;\n\n      /**\n       * A short summary shown in the notification list.\n       */\n      message: string;\n\n      /**\n       * The custom UI content to display when the notification is expanded.\n       */\n      content: ComponentOrElement;\n\n      /**\n       * The title of the expanded notification.\n       */\n      title: string;\n\n      /**\n       * An optional link to display in the footer of the expanded notification.\n       */\n      footerLink?: {\n        /**\n         * The URL to navigate to when the link is clicked.\n         */\n        href: string;\n\n        /**\n         * The link text to display.\n         */\n        text: string;\n      };\n    };\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type NotifyResult = null;\n"]}

package/dist/types/methods/open-web-socket.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"open-web-socket.cjs","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_openWebSocket` method.\n *\n * @property url - The URL of the WebSocket connection to open.\n * @property protocols - The protocols to use for the WebSocket connection.\n */\nexport type OpenWebSocketParams = {\n  url: string;\n  protocols?: string[];\n};\n\n/**\n * The result returned by the `snap_openWebSocket` method.\n */\nexport type OpenWebSocketResult = string;\n"]}
+{"version":3,"file":"open-web-socket.cjs","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_openWebSocket` method.\n *\n * @property url - The `wss://` URL of the WebSocket connection to open.\n * @property protocols - The optional protocols to use for the WebSocket\n * connection.\n */\nexport type OpenWebSocketParams = {\n  url: string;\n  protocols?: string[];\n};\n\n/**\n * The ID of the opened WebSocket connection, which can be used to reference the\n * connection in subsequent calls to [`snap_sendWebSocketMessage`](https://docs.metamask.io/snaps/reference/snaps-api/snap_sendwebsocketmessage)\n * and [`snap_closeWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_closewebsocket).\n */\nexport type OpenWebSocketResult = string;\n"]}

package/dist/types/methods/open-web-socket.d.cts

@@ -1,15 +1,18 @@
 /**
  * The request parameters for the `snap_openWebSocket` method.
  *
- * @property url - The URL of the WebSocket connection to open.
- * @property protocols - The protocols to use for the WebSocket connection.
+ * @property url - The `wss://` URL of the WebSocket connection to open.
+ * @property protocols - The optional protocols to use for the WebSocket
+ * connection.
  */
 export type OpenWebSocketParams = {
     url: string;
     protocols?: string[];
 };
 /**
- * The result returned by the `snap_openWebSocket` method.
+ * The ID of the opened WebSocket connection, which can be used to reference the
+ * connection in subsequent calls to [`snap_sendWebSocketMessage`](https://docs.metamask.io/snaps/reference/snaps-api/snap_sendwebsocketmessage)
+ * and [`snap_closeWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_closewebsocket).
  */
 export type OpenWebSocketResult = string;
 //# sourceMappingURL=open-web-socket.d.cts.map

package/dist/types/methods/open-web-socket.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"open-web-socket.d.cts","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"open-web-socket.d.cts","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC"}

package/dist/types/methods/open-web-socket.d.mts

@@ -1,15 +1,18 @@
 /**
  * The request parameters for the `snap_openWebSocket` method.
  *
- * @property url - The URL of the WebSocket connection to open.
- * @property protocols - The protocols to use for the WebSocket connection.
+ * @property url - The `wss://` URL of the WebSocket connection to open.
+ * @property protocols - The optional protocols to use for the WebSocket
+ * connection.
  */
 export type OpenWebSocketParams = {
     url: string;
     protocols?: string[];
 };
 /**
- * The result returned by the `snap_openWebSocket` method.
+ * The ID of the opened WebSocket connection, which can be used to reference the
+ * connection in subsequent calls to [`snap_sendWebSocketMessage`](https://docs.metamask.io/snaps/reference/snaps-api/snap_sendwebsocketmessage)
+ * and [`snap_closeWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_closewebsocket).
  */
 export type OpenWebSocketResult = string;
 //# sourceMappingURL=open-web-socket.d.mts.map

package/dist/types/methods/open-web-socket.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"open-web-socket.d.mts","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"open-web-socket.d.mts","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC"}

package/dist/types/methods/open-web-socket.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"open-web-socket.mjs","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_openWebSocket` method.\n *\n * @property url - The URL of the WebSocket connection to open.\n * @property protocols - The protocols to use for the WebSocket connection.\n */\nexport type OpenWebSocketParams = {\n  url: string;\n  protocols?: string[];\n};\n\n/**\n * The result returned by the `snap_openWebSocket` method.\n */\nexport type OpenWebSocketResult = string;\n"]}
+{"version":3,"file":"open-web-socket.mjs","sourceRoot":"","sources":["../../../src/types/methods/open-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_openWebSocket` method.\n *\n * @property url - The `wss://` URL of the WebSocket connection to open.\n * @property protocols - The optional protocols to use for the WebSocket\n * connection.\n */\nexport type OpenWebSocketParams = {\n  url: string;\n  protocols?: string[];\n};\n\n/**\n * The ID of the opened WebSocket connection, which can be used to reference the\n * connection in subsequent calls to [`snap_sendWebSocketMessage`](https://docs.metamask.io/snaps/reference/snaps-api/snap_sendwebsocketmessage)\n * and [`snap_closeWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_closewebsocket).\n */\nexport type OpenWebSocketResult = string;\n"]}

package/dist/types/methods/request-snaps.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"request-snaps.cjs","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap } from '../snap';\n\n/**\n * The request parameters for the `wallet_requestSnaps` method.\n *\n * It consists of a map of Snap IDs to optional version strings to request.\n */\nexport type RequestSnapsParams = Record<string, { version?: string }>;\n\n/**\n * The result returned by the `wallet_requestSnaps` method.\n *\n * It consists of a map of Snap IDs to either the Snap object or an error.\n */\nexport type RequestSnapsResult = Record<string, { error: JsonRpcError } | Snap>;\n"]}
+{"version":3,"file":"request-snaps.cjs","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap } from '../snap';\n\n/**\n * An object mapping the IDs of the requested Snaps to optional SemVer version\n * ranges. The SemVer version ranges use the same semantics as NPM\n * `package.json` ranges.\n */\nexport type RequestSnapsParams = Record<string, { version?: string }>;\n\n/**\n * An object mapping the IDs of the requested Snaps to either the installed Snap\n * or an error if the Snap failed to install or was not permitted.\n */\nexport type RequestSnapsResult = Record<string, { error: JsonRpcError } | Snap>;\n"]}

package/dist/types/methods/request-snaps.d.cts

@@ -1,17 +1,16 @@
 import type { JsonRpcError } from "@metamask/utils";
 import type { Snap } from "../snap.cjs";
 /**
- * The request parameters for the `wallet_requestSnaps` method.
- *
- * It consists of a map of Snap IDs to optional version strings to request.
+ * An object mapping the IDs of the requested Snaps to optional SemVer version
+ * ranges. The SemVer version ranges use the same semantics as NPM
+ * `package.json` ranges.
  */
 export type RequestSnapsParams = Record<string, {
     version?: string;
 }>;
 /**
- * The result returned by the `wallet_requestSnaps` method.
- *
- * It consists of a map of Snap IDs to either the Snap object or an error.
+ * An object mapping the IDs of the requested Snaps to either the installed Snap
+ * or an error if the Snap failed to install or was not permitted.
  */
 export type RequestSnapsResult = Record<string, {
     error: JsonRpcError;

package/dist/types/methods/request-snaps.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"request-snaps.d.cts","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAgB;AAEpC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"request-snaps.d.cts","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAgB;AAEpC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}

package/dist/types/methods/request-snaps.d.mts

@@ -1,17 +1,16 @@
 import type { JsonRpcError } from "@metamask/utils";
 import type { Snap } from "../snap.mjs";
 /**
- * The request parameters for the `wallet_requestSnaps` method.
- *
- * It consists of a map of Snap IDs to optional version strings to request.
+ * An object mapping the IDs of the requested Snaps to optional SemVer version
+ * ranges. The SemVer version ranges use the same semantics as NPM
+ * `package.json` ranges.
  */
 export type RequestSnapsParams = Record<string, {
     version?: string;
 }>;
 /**
- * The result returned by the `wallet_requestSnaps` method.
- *
- * It consists of a map of Snap IDs to either the Snap object or an error.
+ * An object mapping the IDs of the requested Snaps to either the installed Snap
+ * or an error if the Snap failed to install or was not permitted.
  */
 export type RequestSnapsResult = Record<string, {
     error: JsonRpcError;

package/dist/types/methods/request-snaps.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"request-snaps.d.mts","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAgB;AAEpC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"request-snaps.d.mts","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAgB;AAEpC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC"}

package/dist/types/methods/request-snaps.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"request-snaps.mjs","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap } from '../snap';\n\n/**\n * The request parameters for the `wallet_requestSnaps` method.\n *\n * It consists of a map of Snap IDs to optional version strings to request.\n */\nexport type RequestSnapsParams = Record<string, { version?: string }>;\n\n/**\n * The result returned by the `wallet_requestSnaps` method.\n *\n * It consists of a map of Snap IDs to either the Snap object or an error.\n */\nexport type RequestSnapsResult = Record<string, { error: JsonRpcError } | Snap>;\n"]}
+{"version":3,"file":"request-snaps.mjs","sourceRoot":"","sources":["../../../src/types/methods/request-snaps.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcError } from '@metamask/utils';\n\nimport type { Snap } from '../snap';\n\n/**\n * An object mapping the IDs of the requested Snaps to optional SemVer version\n * ranges. The SemVer version ranges use the same semantics as NPM\n * `package.json` ranges.\n */\nexport type RequestSnapsParams = Record<string, { version?: string }>;\n\n/**\n * An object mapping the IDs of the requested Snaps to either the installed Snap\n * or an error if the Snap failed to install or was not permitted.\n */\nexport type RequestSnapsResult = Record<string, { error: JsonRpcError } | Snap>;\n"]}

package/dist/types/methods/resolve-interface.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-interface.cjs","sourceRoot":"","sources":["../../../src/types/methods/resolve-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_resolveInterface` method.\n *\n * @property id - The interface id.\n * @property value - The value to resolve the interface with.\n */\nexport type ResolveInterfaceParams = {\n  id: string;\n  value: Json;\n};\n\n/**\n * The result returned by the `snap_resolveInterface` method.\n */\nexport type ResolveInterfaceResult = null;\n"]}
+{"version":3,"file":"resolve-interface.cjs","sourceRoot":"","sources":["../../../src/types/methods/resolve-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_resolveInterface` method.\n *\n * @property id - The interface ID.\n * @property value - The value to resolve the interface with.\n */\nexport type ResolveInterfaceParams = {\n  id: string;\n  value: Json;\n};\n\n/**\n * The result returned by the `snap_resolveInterface` method.\n */\nexport type ResolveInterfaceResult = null;\n"]}

package/dist/types/methods/resolve-interface.d.cts

@@ -2,7 +2,7 @@ import type { Json } from "@metamask/utils";
 /**
  * The request parameters for the `snap_resolveInterface` method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  * @property value - The value to resolve the interface with.
  */
 export type ResolveInterfaceParams = {

package/dist/types/methods/resolve-interface.d.mts

@@ -2,7 +2,7 @@ import type { Json } from "@metamask/utils";
 /**
  * The request parameters for the `snap_resolveInterface` method.
  *
- * @property id - The interface id.
+ * @property id - The interface ID.
  * @property value - The value to resolve the interface with.
  */
 export type ResolveInterfaceParams = {

package/dist/types/methods/resolve-interface.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-interface.mjs","sourceRoot":"","sources":["../../../src/types/methods/resolve-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_resolveInterface` method.\n *\n * @property id - The interface id.\n * @property value - The value to resolve the interface with.\n */\nexport type ResolveInterfaceParams = {\n  id: string;\n  value: Json;\n};\n\n/**\n * The result returned by the `snap_resolveInterface` method.\n */\nexport type ResolveInterfaceResult = null;\n"]}
+{"version":3,"file":"resolve-interface.mjs","sourceRoot":"","sources":["../../../src/types/methods/resolve-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * The request parameters for the `snap_resolveInterface` method.\n *\n * @property id - The interface ID.\n * @property value - The value to resolve the interface with.\n */\nexport type ResolveInterfaceParams = {\n  id: string;\n  value: Json;\n};\n\n/**\n * The result returned by the `snap_resolveInterface` method.\n */\nexport type ResolveInterfaceResult = null;\n"]}

package/dist/types/methods/schedule-background-event.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"schedule-background-event.cjs","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cronjob } from '../permissions';\n\n/**\n * The request parameters for the `snap_scheduleBackgroundEvent` method.\n *\n * Note: The date generated from a duration will be represented in UTC.\n *\n * @property date - The ISO 8601 date of when to fire the background event.\n * @property duration - The ISO 8601 duration of when to fire the background event.\n * @property request - The request to be called when the event fires.\n */\nexport type ScheduleBackgroundEventParams =\n  | {\n      date: string;\n      request: Cronjob['request'];\n    }\n  | { duration: string; request: Cronjob['request'] };\n\n/**\n * The result returned by the `snap_scheduleBackgroundEvent` method, which is the ID of the scheduled event.\n */\nexport type ScheduleBackgroundEventResult = string;\n"]}
+{"version":3,"file":"schedule-background-event.cjs","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cronjob } from '../permissions';\n\n/**\n * An object containing the parameters for the `snap_scheduleBackgroundEvent`\n * method.\n */\nexport type ScheduleBackgroundEventParams =\n  | {\n      /**\n       * The ISO 8601 date string of when to fire the background event (e.g.,\n       * `\"2025-01-01T00:00:00Z\"`).\n       */\n      date: string;\n\n      /**\n       * The JSON-RPC request to call when the event fires.\n       */\n      request: Cronjob['request'];\n    }\n  | {\n      /**\n       * The ISO 8601 duration string of how long to wait before firing the\n       * background event (e.g., `\"P1D\"` for one day). The resulting date will\n       * be calculated in UTC.\n       */\n      duration: string;\n\n      /**\n       * The JSON-RPC request to call when the event fires.\n       */\n      request: Cronjob['request'];\n    };\n\n/**\n * The ID of the scheduled background event.\n */\nexport type ScheduleBackgroundEventResult = string;\n"]}

package/dist/types/methods/schedule-background-event.d.cts

@@ -1,22 +1,32 @@
 import type { Cronjob } from "../permissions.cjs";
 /**
- * The request parameters for the `snap_scheduleBackgroundEvent` method.
- *
- * Note: The date generated from a duration will be represented in UTC.
- *
- * @property date - The ISO 8601 date of when to fire the background event.
- * @property duration - The ISO 8601 duration of when to fire the background event.
- * @property request - The request to be called when the event fires.
+ * An object containing the parameters for the `snap_scheduleBackgroundEvent`
+ * method.
  */
 export type ScheduleBackgroundEventParams = {
+    /**
+     * The ISO 8601 date string of when to fire the background event (e.g.,
+     * `"2025-01-01T00:00:00Z"`).
+     */
     date: string;
+    /**
+     * The JSON-RPC request to call when the event fires.
+     */
     request: Cronjob['request'];
 } | {
+    /**
+     * The ISO 8601 duration string of how long to wait before firing the
+     * background event (e.g., `"P1D"` for one day). The resulting date will
+     * be calculated in UTC.
+     */
     duration: string;
+    /**
+     * The JSON-RPC request to call when the event fires.
+     */
     request: Cronjob['request'];
 };
 /**
- * The result returned by the `snap_scheduleBackgroundEvent` method, which is the ID of the scheduled event.
+ * The ID of the scheduled background event.
  */
 export type ScheduleBackgroundEventResult = string;
 //# sourceMappingURL=schedule-background-event.d.cts.map

package/dist/types/methods/schedule-background-event.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"schedule-background-event.d.cts","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,2BAAuB;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,GACrC;IACE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,GACD;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;CAAE,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC"}
+{"version":3,"file":"schedule-background-event.d.cts","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,2BAAuB;AAE9C;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GACrC;IACE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,GACD;IACE;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC"}

package/dist/types/methods/schedule-background-event.d.mts

@@ -1,22 +1,32 @@
 import type { Cronjob } from "../permissions.mjs";
 /**
- * The request parameters for the `snap_scheduleBackgroundEvent` method.
- *
- * Note: The date generated from a duration will be represented in UTC.
- *
- * @property date - The ISO 8601 date of when to fire the background event.
- * @property duration - The ISO 8601 duration of when to fire the background event.
- * @property request - The request to be called when the event fires.
+ * An object containing the parameters for the `snap_scheduleBackgroundEvent`
+ * method.
  */
 export type ScheduleBackgroundEventParams = {
+    /**
+     * The ISO 8601 date string of when to fire the background event (e.g.,
+     * `"2025-01-01T00:00:00Z"`).
+     */
     date: string;
+    /**
+     * The JSON-RPC request to call when the event fires.
+     */
     request: Cronjob['request'];
 } | {
+    /**
+     * The ISO 8601 duration string of how long to wait before firing the
+     * background event (e.g., `"P1D"` for one day). The resulting date will
+     * be calculated in UTC.
+     */
     duration: string;
+    /**
+     * The JSON-RPC request to call when the event fires.
+     */
     request: Cronjob['request'];
 };
 /**
- * The result returned by the `snap_scheduleBackgroundEvent` method, which is the ID of the scheduled event.
+ * The ID of the scheduled background event.
  */
 export type ScheduleBackgroundEventResult = string;
 //# sourceMappingURL=schedule-background-event.d.mts.map

package/dist/types/methods/schedule-background-event.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"schedule-background-event.d.mts","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,2BAAuB;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,GACrC;IACE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,GACD;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;CAAE,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC"}
+{"version":3,"file":"schedule-background-event.d.mts","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,2BAAuB;AAE9C;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GACrC;IACE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,GACD;IACE;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC7B,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC"}

package/dist/types/methods/schedule-background-event.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"schedule-background-event.mjs","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cronjob } from '../permissions';\n\n/**\n * The request parameters for the `snap_scheduleBackgroundEvent` method.\n *\n * Note: The date generated from a duration will be represented in UTC.\n *\n * @property date - The ISO 8601 date of when to fire the background event.\n * @property duration - The ISO 8601 duration of when to fire the background event.\n * @property request - The request to be called when the event fires.\n */\nexport type ScheduleBackgroundEventParams =\n  | {\n      date: string;\n      request: Cronjob['request'];\n    }\n  | { duration: string; request: Cronjob['request'] };\n\n/**\n * The result returned by the `snap_scheduleBackgroundEvent` method, which is the ID of the scheduled event.\n */\nexport type ScheduleBackgroundEventResult = string;\n"]}
+{"version":3,"file":"schedule-background-event.mjs","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cronjob } from '../permissions';\n\n/**\n * An object containing the parameters for the `snap_scheduleBackgroundEvent`\n * method.\n */\nexport type ScheduleBackgroundEventParams =\n  | {\n      /**\n       * The ISO 8601 date string of when to fire the background event (e.g.,\n       * `\"2025-01-01T00:00:00Z\"`).\n       */\n      date: string;\n\n      /**\n       * The JSON-RPC request to call when the event fires.\n       */\n      request: Cronjob['request'];\n    }\n  | {\n      /**\n       * The ISO 8601 duration string of how long to wait before firing the\n       * background event (e.g., `\"P1D\"` for one day). The resulting date will\n       * be calculated in UTC.\n       */\n      duration: string;\n\n      /**\n       * The JSON-RPC request to call when the event fires.\n       */\n      request: Cronjob['request'];\n    };\n\n/**\n * The ID of the scheduled background event.\n */\nexport type ScheduleBackgroundEventResult = string;\n"]}

package/dist/types/methods/send-web-socket-message.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"send-web-socket-message.cjs","sourceRoot":"","sources":["../../../src/types/methods/send-web-socket-message.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_sendWebSocketMessage` method.\n *\n * @property id - The id of the WebSocket connection to send a message to.\n * @property message - The message to send.\n */\nexport type SendWebSocketMessageParams = {\n  id: string;\n  message: string | number[];\n};\n\n/**\n * The result returned by the `snap_sendWebSocketMessage` method.\n */\nexport type SendWebSocketMessageResult = null;\n"]}
+{"version":3,"file":"send-web-socket-message.cjs","sourceRoot":"","sources":["../../../src/types/methods/send-web-socket-message.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object describing the WebSocket message to send.\n */\nexport type SendWebSocketMessageParams = {\n  /**\n   * The ID of the WebSocket connection to send a message to.\n   */\n  id: string;\n\n  /**\n   * The message to send. This can be either a string or an array of numbers\n   * representing binary data.\n   */\n  message: string | number[];\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type SendWebSocketMessageResult = null;\n"]}

package/dist/types/methods/send-web-socket-message.d.cts

@@ -1,15 +1,19 @@
 /**
- * The request parameters for the `snap_sendWebSocketMessage` method.
- *
- * @property id - The id of the WebSocket connection to send a message to.
- * @property message - The message to send.
+ * An object describing the WebSocket message to send.
  */
 export type SendWebSocketMessageParams = {
+    /**
+     * The ID of the WebSocket connection to send a message to.
+     */
     id: string;
+    /**
+     * The message to send. This can be either a string or an array of numbers
+     * representing binary data.
+     */
     message: string | number[];
 };
 /**
- * The result returned by the `snap_sendWebSocketMessage` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type SendWebSocketMessageResult = null;
 //# sourceMappingURL=send-web-socket-message.d.cts.map

package/dist/types/methods/send-web-socket-message.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"send-web-socket-message.d.cts","sourceRoot":"","sources":["../../../src/types/methods/send-web-socket-message.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC"}
+{"version":3,"file":"send-web-socket-message.d.cts","sourceRoot":"","sources":["../../../src/types/methods/send-web-socket-message.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC"}

package/dist/types/methods/send-web-socket-message.d.mts

@@ -1,15 +1,19 @@
 /**
- * The request parameters for the `snap_sendWebSocketMessage` method.
- *
- * @property id - The id of the WebSocket connection to send a message to.
- * @property message - The message to send.
+ * An object describing the WebSocket message to send.
  */
 export type SendWebSocketMessageParams = {
+    /**
+     * The ID of the WebSocket connection to send a message to.
+     */
     id: string;
+    /**
+     * The message to send. This can be either a string or an array of numbers
+     * representing binary data.
+     */
     message: string | number[];
 };
 /**
- * The result returned by the `snap_sendWebSocketMessage` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type SendWebSocketMessageResult = null;
 //# sourceMappingURL=send-web-socket-message.d.mts.map