@metamask/snaps-sdk 10.4.0 → 11.0.0

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

@@ -1,15 +1,15 @@
 /**
- * The request parameters for the `snap_cancelBackgroundEvent` method.
- *
- * @property id - The id of the background event to cancel.
+ * An object containing the parameters for the `snap_cancelBackgroundEvent`
+ * method.
  */
 export type CancelBackgroundEventParams = {
+    /**
+     * The ID of the background event to cancel.
+     */
     id: string;
 };
 /**
- * The result returned for the `snap_cancelBackgroundEvent` method.
- *
- * This method does not return anything.
+ * This method does not return any data, so the result is always `null`.
  */
 export type CancelBackgroundEventResult = null;
 //# sourceMappingURL=cancel-background-event.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"cancel-background-event.d.mts","sourceRoot":"","sources":["../../../src/types/methods/cancel-background-event.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC"}
+{"version":3,"file":"cancel-background-event.d.mts","sourceRoot":"","sources":["../../../src/types/methods/cancel-background-event.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"cancel-background-event.mjs","sourceRoot":"","sources":["../../../src/types/methods/cancel-background-event.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_cancelBackgroundEvent` method.\n *\n * @property id - The id of the background event to cancel.\n */\nexport type CancelBackgroundEventParams = {\n  id: string;\n};\n\n/**\n * The result returned for the `snap_cancelBackgroundEvent` method.\n *\n * This method does not return anything.\n */\nexport type CancelBackgroundEventResult = null;\n"]}
+{"version":3,"file":"cancel-background-event.mjs","sourceRoot":"","sources":["../../../src/types/methods/cancel-background-event.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object containing the parameters for the `snap_cancelBackgroundEvent`\n * method.\n */\nexport type CancelBackgroundEventParams = {\n  /**\n   * The ID of the background event to cancel.\n   */\n  id: string;\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type CancelBackgroundEventResult = null;\n"]}

package/dist/types/methods/clear-state.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"clear-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_clearState` method.\n *\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the extension is unlocked, while unencrypted state can be used\n * whether the extension is locked or unlocked.\n */\nexport type ClearStateParams = {\n  encrypted?: boolean;\n};\n\n/**\n * The result returned by the `snap_clearState` method.\n */\nexport type ClearStateResult = null;\n"]}
+{"version":3,"file":"clear-state.cjs","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object containing the parameters for the `snap_clearState` method.\n *\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n *\n * Use the encrypted state for sensitive data (such as private keys or secrets),\n * and the unencrypted state for non-sensitive data that needs to be accessed\n * while the client is locked.\n */\nexport type ClearStateParams = {\n  encrypted?: boolean;\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type ClearStateResult = null;\n"]}

package/dist/types/methods/clear-state.d.cts

@@ -1,16 +1,20 @@
 /**
- * The request parameters for the `snap_clearState` method.
+ * An object containing the parameters for the `snap_clearState` method.
  *
  * @property encrypted - Whether to use the separate encrypted state, or the
  * unencrypted state. Defaults to the encrypted state. Encrypted state can only
- * be used if the extension is unlocked, while unencrypted state can be used
- * whether the extension is locked or unlocked.
+ * be used if the client is unlocked, while unencrypted state can be used
+ * whether the client is locked or unlocked.
+ *
+ * Use the encrypted state for sensitive data (such as private keys or secrets),
+ * and the unencrypted state for non-sensitive data that needs to be accessed
+ * while the client is locked.
  */
 export type ClearStateParams = {
     encrypted?: boolean;
 };
 /**
- * The result returned by the `snap_clearState` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type ClearStateResult = null;
 //# sourceMappingURL=clear-state.d.cts.map

package/dist/types/methods/clear-state.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"clear-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC"}
+{"version":3,"file":"clear-state.d.cts","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC"}

package/dist/types/methods/clear-state.d.mts

@@ -1,16 +1,20 @@
 /**
- * The request parameters for the `snap_clearState` method.
+ * An object containing the parameters for the `snap_clearState` method.
  *
  * @property encrypted - Whether to use the separate encrypted state, or the
  * unencrypted state. Defaults to the encrypted state. Encrypted state can only
- * be used if the extension is unlocked, while unencrypted state can be used
- * whether the extension is locked or unlocked.
+ * be used if the client is unlocked, while unencrypted state can be used
+ * whether the client is locked or unlocked.
+ *
+ * Use the encrypted state for sensitive data (such as private keys or secrets),
+ * and the unencrypted state for non-sensitive data that needs to be accessed
+ * while the client is locked.
  */
 export type ClearStateParams = {
     encrypted?: boolean;
 };
 /**
- * The result returned by the `snap_clearState` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type ClearStateResult = null;
 //# sourceMappingURL=clear-state.d.mts.map

package/dist/types/methods/clear-state.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"clear-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC"}
+{"version":3,"file":"clear-state.d.mts","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC"}

package/dist/types/methods/clear-state.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"clear-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_clearState` method.\n *\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the extension is unlocked, while unencrypted state can be used\n * whether the extension is locked or unlocked.\n */\nexport type ClearStateParams = {\n  encrypted?: boolean;\n};\n\n/**\n * The result returned by the `snap_clearState` method.\n */\nexport type ClearStateResult = null;\n"]}
+{"version":3,"file":"clear-state.mjs","sourceRoot":"","sources":["../../../src/types/methods/clear-state.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object containing the parameters for the `snap_clearState` method.\n *\n * @property encrypted - Whether to use the separate encrypted state, or the\n * unencrypted state. Defaults to the encrypted state. Encrypted state can only\n * be used if the client is unlocked, while unencrypted state can be used\n * whether the client is locked or unlocked.\n *\n * Use the encrypted state for sensitive data (such as private keys or secrets),\n * and the unencrypted state for non-sensitive data that needs to be accessed\n * while the client is locked.\n */\nexport type ClearStateParams = {\n  encrypted?: boolean;\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type ClearStateResult = null;\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"close-web-socket.cjs","sourceRoot":"","sources":["../../../src/types/methods/close-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_closeWebSocket` method.\n *\n * @property id - The id of the WebSocket connection to close.\n */\nexport type CloseWebSocketParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_closeWebSocket` method.\n */\nexport type CloseWebSocketResult = null;\n"]}
+{"version":3,"file":"close-web-socket.cjs","sourceRoot":"","sources":["../../../src/types/methods/close-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object containing the parameters for the `snap_closeWebSocket` method.\n *\n * @property id - The ID of the WebSocket connection to close.\n */\nexport type CloseWebSocketParams = {\n  id: string;\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type CloseWebSocketResult = null;\n"]}

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

@@ -1,13 +1,13 @@
 /**
- * The request parameters for the `snap_closeWebSocket` method.
+ * An object containing the parameters for the `snap_closeWebSocket` method.
  *
- * @property id - The id of the WebSocket connection to close.
+ * @property id - The ID of the WebSocket connection to close.
  */
 export type CloseWebSocketParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_closeWebSocket` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type CloseWebSocketResult = null;
 //# sourceMappingURL=close-web-socket.d.cts.map

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

@@ -1,13 +1,13 @@
 /**
- * The request parameters for the `snap_closeWebSocket` method.
+ * An object containing the parameters for the `snap_closeWebSocket` method.
  *
- * @property id - The id of the WebSocket connection to close.
+ * @property id - The ID of the WebSocket connection to close.
  */
 export type CloseWebSocketParams = {
     id: string;
 };
 /**
- * The result returned by the `snap_closeWebSocket` method.
+ * This method does not return any data, so the result is always `null`.
  */
 export type CloseWebSocketResult = null;
 //# sourceMappingURL=close-web-socket.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"close-web-socket.mjs","sourceRoot":"","sources":["../../../src/types/methods/close-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The request parameters for the `snap_closeWebSocket` method.\n *\n * @property id - The id of the WebSocket connection to close.\n */\nexport type CloseWebSocketParams = {\n  id: string;\n};\n\n/**\n * The result returned by the `snap_closeWebSocket` method.\n */\nexport type CloseWebSocketResult = null;\n"]}
+{"version":3,"file":"close-web-socket.mjs","sourceRoot":"","sources":["../../../src/types/methods/close-web-socket.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * An object containing the parameters for the `snap_closeWebSocket` method.\n *\n * @property id - The ID of the WebSocket connection to close.\n */\nexport type CloseWebSocketParams = {\n  id: string;\n};\n\n/**\n * This method does not return any data, so the result is always `null`.\n */\nexport type CloseWebSocketResult = null;\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"create-interface.cjs","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentOrElement, InterfaceContext } from '..';\n\n/**\n * The request parameters for the `snap_createInterface` method.\n *\n * @property ui - The components to display in the interface.\n */\nexport type CreateInterfaceParams = {\n  ui: ComponentOrElement;\n  context?: InterfaceContext;\n};\n\n/**\n * The result returned by the `snap_createInterface` method, which is the id of the created interface.\n */\nexport type CreateInterfaceResult = string;\n"]}
+{"version":3,"file":"create-interface.cjs","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentOrElement, InterfaceContext } from '..';\n\n/**\n * An object containing the parameters for the `snap_createInterface` method.\n */\nexport type CreateInterfaceParams = {\n  /**\n   * The [custom UI](https://docs.metamask.io/snaps/features/custom-ui/) to\n   * create.\n   */\n  ui: ComponentOrElement;\n\n  /**\n   * Optional context for the interface, which can be used to provide additional\n   * information about the interface to the Snap, without being part of the UI\n   * itself.\n   */\n  context?: InterfaceContext;\n};\n\n/**\n * The interface's ID to be used in subsequent calls to custom UI methods such\n * as [`snap_updateInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_updateinterface),\n * or to display the interface using one of the interface display methods such\n * as [`snap_dialog`](https://docs.metamask.io/snaps/reference/snaps-api/snap_dialog).\n */\nexport type CreateInterfaceResult = string;\n"]}

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

@@ -1,15 +1,25 @@
 import type { ComponentOrElement, InterfaceContext } from "../index.cjs";
 /**
- * The request parameters for the `snap_createInterface` method.
- *
- * @property ui - The components to display in the interface.
+ * An object containing the parameters for the `snap_createInterface` method.
  */
 export type CreateInterfaceParams = {
+    /**
+     * The [custom UI](https://docs.metamask.io/snaps/features/custom-ui/) to
+     * create.
+     */
     ui: ComponentOrElement;
+    /**
+     * Optional context for the interface, which can be used to provide additional
+     * information about the interface to the Snap, without being part of the UI
+     * itself.
+     */
     context?: InterfaceContext;
 };
 /**
- * The result returned by the `snap_createInterface` method, which is the id of the created interface.
+ * The interface's ID to be used in subsequent calls to custom UI methods such
+ * as [`snap_updateInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_updateinterface),
+ * or to display the interface using one of the interface display methods such
+ * as [`snap_dialog`](https://docs.metamask.io/snaps/reference/snaps-api/snap_dialog).
  */
 export type CreateInterfaceResult = string;
 //# sourceMappingURL=create-interface.d.cts.map

package/dist/types/methods/create-interface.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"create-interface.d.cts","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,qBAAW;AAE/D;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,kBAAkB,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"create-interface.d.cts","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,qBAAW;AAE/D;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,EAAE,EAAE,kBAAkB,CAAC;IAEvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC"}

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

@@ -1,15 +1,25 @@
 import type { ComponentOrElement, InterfaceContext } from "../index.mjs";
 /**
- * The request parameters for the `snap_createInterface` method.
- *
- * @property ui - The components to display in the interface.
+ * An object containing the parameters for the `snap_createInterface` method.
  */
 export type CreateInterfaceParams = {
+    /**
+     * The [custom UI](https://docs.metamask.io/snaps/features/custom-ui/) to
+     * create.
+     */
     ui: ComponentOrElement;
+    /**
+     * Optional context for the interface, which can be used to provide additional
+     * information about the interface to the Snap, without being part of the UI
+     * itself.
+     */
     context?: InterfaceContext;
 };
 /**
- * The result returned by the `snap_createInterface` method, which is the id of the created interface.
+ * The interface's ID to be used in subsequent calls to custom UI methods such
+ * as [`snap_updateInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_updateinterface),
+ * or to display the interface using one of the interface display methods such
+ * as [`snap_dialog`](https://docs.metamask.io/snaps/reference/snaps-api/snap_dialog).
  */
 export type CreateInterfaceResult = string;
 //# sourceMappingURL=create-interface.d.mts.map

package/dist/types/methods/create-interface.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"create-interface.d.mts","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,qBAAW;AAE/D;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,kBAAkB,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"create-interface.d.mts","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,qBAAW;AAE/D;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,EAAE,EAAE,kBAAkB,CAAC;IAEvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"create-interface.mjs","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentOrElement, InterfaceContext } from '..';\n\n/**\n * The request parameters for the `snap_createInterface` method.\n *\n * @property ui - The components to display in the interface.\n */\nexport type CreateInterfaceParams = {\n  ui: ComponentOrElement;\n  context?: InterfaceContext;\n};\n\n/**\n * The result returned by the `snap_createInterface` method, which is the id of the created interface.\n */\nexport type CreateInterfaceResult = string;\n"]}
+{"version":3,"file":"create-interface.mjs","sourceRoot":"","sources":["../../../src/types/methods/create-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentOrElement, InterfaceContext } from '..';\n\n/**\n * An object containing the parameters for the `snap_createInterface` method.\n */\nexport type CreateInterfaceParams = {\n  /**\n   * The [custom UI](https://docs.metamask.io/snaps/features/custom-ui/) to\n   * create.\n   */\n  ui: ComponentOrElement;\n\n  /**\n   * Optional context for the interface, which can be used to provide additional\n   * information about the interface to the Snap, without being part of the UI\n   * itself.\n   */\n  context?: InterfaceContext;\n};\n\n/**\n * The interface's ID to be used in subsequent calls to custom UI methods such\n * as [`snap_updateInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_updateinterface),\n * or to display the interface using one of the interface display methods such\n * as [`snap_dialog`](https://docs.metamask.io/snaps/reference/snaps-api/snap_dialog).\n */\nexport type CreateInterfaceResult = string;\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"dialog.cjs","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":";;;AAKA;;;;;;;GAOG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\n\n/**\n * The type of dialog to display.\n *\n * - `alert` - A dialog with a single button.\n * - `confirmation` - A dialog with two buttons, one to confirm and one to\n * cancel.\n * - `prompt` - A dialog with two buttons and a text input.\n */\nexport enum DialogType {\n  Alert = 'alert',\n  Confirmation = 'confirmation',\n  Prompt = 'prompt',\n}\n\nexport type DefaultDialog =\n  | {\n      id: string;\n    }\n  | { content: ComponentOrElement };\n\n/**\n * An alert dialog.\n *\n * @property type - The type of dialog. Must be `alert`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n */\nexport type AlertDialog =\n  | {\n      type: EnumToUnion<DialogType.Alert>;\n      content: ComponentOrElement;\n    }\n  | {\n      type: EnumToUnion<DialogType.Alert>;\n      id: string;\n    };\n\n/**\n * A confirmation dialog.\n *\n * @property type - The type of dialog. Must be `confirmation`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n */\nexport type ConfirmationDialog =\n  | {\n      type: EnumToUnion<DialogType.Confirmation>;\n      content: ComponentOrElement;\n    }\n  | {\n      type: EnumToUnion<DialogType.Confirmation>;\n      id: string;\n    };\n\n/**\n * A prompt dialog.\n *\n * @property type - The type of dialog. Must be `prompt`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - An optional placeholder text to display in the text\n * input.\n */\nexport type PromptDialog =\n  | {\n      type: EnumToUnion<DialogType.Prompt>;\n      content: ComponentOrElement;\n      placeholder?: string;\n    }\n  | {\n      type: EnumToUnion<DialogType.Prompt>;\n      id: string;\n      placeholder?: string;\n    };\n\n/**\n * The request parameters for the `snap_dialog` method.\n *\n * @property type - The type of dialog to display.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - The placeholder text to display in the dialog. Only\n * applicable for the `prompt` dialog.\n */\nexport type DialogParams =\n  | AlertDialog\n  | ConfirmationDialog\n  | PromptDialog\n  | DefaultDialog;\n\n/**\n * The result returned by the `snap_dialog` method.\n *\n * - If the dialog is an `alert`, the result is `null`.\n * - If the dialog is a `confirmation`, the result is a boolean indicating\n * whether the user confirmed the dialog.\n * - If the dialog is a `prompt`, the result is the value entered by\n * the user.\n */\nexport type DialogResult = null | boolean | string | Json;\n"]}
+{"version":3,"file":"dialog.cjs","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":";;;AAKA;;;;;;;GAOG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\n\n/**\n * The type of dialog to display.\n *\n * - `alert` - A dialog with a single button.\n * - `confirmation` - A dialog with two buttons, one to confirm and one to\n * cancel.\n * - `prompt` - A dialog with two buttons and a text input.\n */\nexport enum DialogType {\n  Alert = 'alert',\n  Confirmation = 'confirmation',\n  Prompt = 'prompt',\n}\n\nexport type DefaultDialog =\n  | {\n      id: string;\n    }\n  | { content: ComponentOrElement };\n\n/**\n * An alert dialog.\n */\nexport type AlertDialog =\n  | {\n      /**\n       * The literal string \"alert\" to indicate that this is an alert dialog.\n       */\n      type: EnumToUnion<DialogType.Alert>;\n\n      /**\n       * The content to display in the alert dialog.\n       */\n      content: ComponentOrElement;\n    }\n  | {\n      /**\n       * The literal string \"alert\" to indicate that this is an alert dialog.\n       */\n      type: EnumToUnion<DialogType.Alert>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n    };\n\n/**\n * A confirmation dialog.\n */\nexport type ConfirmationDialog =\n  | {\n      /**\n       * The literal string \"confirmation\" to indicate that this is a\n       * confirmation dialog.\n       */\n      type: EnumToUnion<DialogType.Confirmation>;\n\n      /**\n       * The content to display in the confirmation dialog.\n       */\n      content: ComponentOrElement;\n    }\n  | {\n      /**\n       * The literal string \"confirmation\" to indicate that this is a\n       * confirmation dialog.\n       */\n      type: EnumToUnion<DialogType.Confirmation>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n    };\n\n/**\n * A prompt dialog.\n */\nexport type PromptDialog =\n  | {\n      /**\n       * The literal string \"prompt\" to indicate that this is a prompt dialog.\n       */\n      type: EnumToUnion<DialogType.Prompt>;\n\n      /**\n       * The content to display in the prompt dialog.\n       */\n      content: ComponentOrElement;\n\n      /**\n       * An optional placeholder text to display in the text input.\n       */\n      placeholder?: string;\n    }\n  | {\n      /**\n       * The literal string \"prompt\" to indicate that this is a prompt dialog.\n       */\n      type: EnumToUnion<DialogType.Prompt>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n\n      /**\n       * An optional placeholder text to display in the text input.\n       */\n      placeholder?: string;\n    };\n\n/**\n * An object containing the contents of the dialog.\n *\n * @property type - The type of dialog to display.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - The placeholder text to display in the dialog. Only\n * applicable for the `prompt` dialog.\n */\nexport type DialogParams =\n  | AlertDialog\n  | ConfirmationDialog\n  | PromptDialog\n  | DefaultDialog;\n\n/**\n * - If the dialog is an `alert`, the result is `null`.\n * - If the dialog is a `confirmation`, the result is a boolean indicating\n * whether the user confirmed the dialog.\n * - If the dialog is a `prompt`, the result is the value entered by\n * the user.\n */\nexport type DialogResult = Json;\n"]}

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

@@ -21,52 +21,85 @@ export type DefaultDialog = {
 };
 /**
  * An alert dialog.
- *
- * @property type - The type of dialog. Must be `alert`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
  */
 export type AlertDialog = {
+    /**
+     * The literal string "alert" to indicate that this is an alert dialog.
+     */
     type: EnumToUnion<DialogType.Alert>;
+    /**
+     * The content to display in the alert dialog.
+     */
     content: ComponentOrElement;
 } | {
+    /**
+     * The literal string "alert" to indicate that this is an alert dialog.
+     */
     type: EnumToUnion<DialogType.Alert>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
 };
 /**
  * A confirmation dialog.
- *
- * @property type - The type of dialog. Must be `confirmation`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
  */
 export type ConfirmationDialog = {
+    /**
+     * The literal string "confirmation" to indicate that this is a
+     * confirmation dialog.
+     */
     type: EnumToUnion<DialogType.Confirmation>;
+    /**
+     * The content to display in the confirmation dialog.
+     */
     content: ComponentOrElement;
 } | {
+    /**
+     * The literal string "confirmation" to indicate that this is a
+     * confirmation dialog.
+     */
     type: EnumToUnion<DialogType.Confirmation>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
 };
 /**
  * A prompt dialog.
- *
- * @property type - The type of dialog. Must be `prompt`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
- * @property placeholder - An optional placeholder text to display in the text
- * input.
  */
 export type PromptDialog = {
+    /**
+     * The literal string "prompt" to indicate that this is a prompt dialog.
+     */
     type: EnumToUnion<DialogType.Prompt>;
+    /**
+     * The content to display in the prompt dialog.
+     */
     content: ComponentOrElement;
+    /**
+     * An optional placeholder text to display in the text input.
+     */
     placeholder?: string;
 } | {
+    /**
+     * The literal string "prompt" to indicate that this is a prompt dialog.
+     */
     type: EnumToUnion<DialogType.Prompt>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
+    /**
+     * An optional placeholder text to display in the text input.
+     */
     placeholder?: string;
 };
 /**
- * The request parameters for the `snap_dialog` method.
+ * An object containing the contents of the dialog.
  *
  * @property type - The type of dialog to display.
  * @property content - The content to display in the dialog.
@@ -76,13 +109,11 @@ export type PromptDialog = {
  */
 export type DialogParams = AlertDialog | ConfirmationDialog | PromptDialog | DefaultDialog;
 /**
- * The result returned by the `snap_dialog` method.
- *
  * - If the dialog is an `alert`, the result is `null`.
  * - If the dialog is a `confirmation`, the result is a boolean indicating
  * whether the user confirmed the dialog.
  * - If the dialog is a `prompt`, the result is the value entered by
  * the user.
  */
-export type DialogResult = null | boolean | string | Json;
+export type DialogResult = Json;
 //# sourceMappingURL=dialog.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"dialog.d.cts","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;;;;;;GAOG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GACrB;IACE,EAAE,EAAE,MAAM,CAAC;CACZ,GACD;IAAE,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAC3C,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAC3C,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,aAAa,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC"}
+{"version":3,"file":"dialog.d.cts","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;;;;;;GAOG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GACrB;IACE,EAAE,EAAE,MAAM,CAAC;CACZ,GACD;IAAE,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEpC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEpC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAE3C;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,aAAa,CAAC;AAElB;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}

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

@@ -21,52 +21,85 @@ export type DefaultDialog = {
 };
 /**
  * An alert dialog.
- *
- * @property type - The type of dialog. Must be `alert`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
  */
 export type AlertDialog = {
+    /**
+     * The literal string "alert" to indicate that this is an alert dialog.
+     */
     type: EnumToUnion<DialogType.Alert>;
+    /**
+     * The content to display in the alert dialog.
+     */
     content: ComponentOrElement;
 } | {
+    /**
+     * The literal string "alert" to indicate that this is an alert dialog.
+     */
     type: EnumToUnion<DialogType.Alert>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
 };
 /**
  * A confirmation dialog.
- *
- * @property type - The type of dialog. Must be `confirmation`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
  */
 export type ConfirmationDialog = {
+    /**
+     * The literal string "confirmation" to indicate that this is a
+     * confirmation dialog.
+     */
     type: EnumToUnion<DialogType.Confirmation>;
+    /**
+     * The content to display in the confirmation dialog.
+     */
     content: ComponentOrElement;
 } | {
+    /**
+     * The literal string "confirmation" to indicate that this is a
+     * confirmation dialog.
+     */
     type: EnumToUnion<DialogType.Confirmation>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
 };
 /**
  * A prompt dialog.
- *
- * @property type - The type of dialog. Must be `prompt`.
- * @property content - The content to display in the dialog.
- * @property id - The Snap interface ID.
- * @property placeholder - An optional placeholder text to display in the text
- * input.
  */
 export type PromptDialog = {
+    /**
+     * The literal string "prompt" to indicate that this is a prompt dialog.
+     */
     type: EnumToUnion<DialogType.Prompt>;
+    /**
+     * The content to display in the prompt dialog.
+     */
     content: ComponentOrElement;
+    /**
+     * An optional placeholder text to display in the text input.
+     */
     placeholder?: string;
 } | {
+    /**
+     * The literal string "prompt" to indicate that this is a prompt dialog.
+     */
     type: EnumToUnion<DialogType.Prompt>;
+    /**
+     * The Snap interface ID, which can be used to display a previously
+     * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
+     */
     id: string;
+    /**
+     * An optional placeholder text to display in the text input.
+     */
     placeholder?: string;
 };
 /**
- * The request parameters for the `snap_dialog` method.
+ * An object containing the contents of the dialog.
  *
  * @property type - The type of dialog to display.
  * @property content - The content to display in the dialog.
@@ -76,13 +109,11 @@ export type PromptDialog = {
  */
 export type DialogParams = AlertDialog | ConfirmationDialog | PromptDialog | DefaultDialog;
 /**
- * The result returned by the `snap_dialog` method.
- *
  * - If the dialog is an `alert`, the result is `null`.
  * - If the dialog is a `confirmation`, the result is a boolean indicating
  * whether the user confirmed the dialog.
  * - If the dialog is a `prompt`, the result is the value entered by
  * the user.
  */
-export type DialogResult = null | boolean | string | Json;
+export type DialogResult = Json;
 //# sourceMappingURL=dialog.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"dialog.d.mts","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;;;;;;GAOG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GACrB;IACE,EAAE,EAAE,MAAM,CAAC;CACZ,GACD;IAAE,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAC3C,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAC3C,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,aAAa,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC"}
+{"version":3,"file":"dialog.d.mts","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAW;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,kCAAwB;AAEnD;;;;;;;GAOG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GACrB;IACE,EAAE,EAAE,MAAM,CAAC;CACZ,GACD;IAAE,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEpC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEpC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAE3C;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IACE;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,aAAa,CAAC;AAElB;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"dialog.mjs","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\n\n/**\n * The type of dialog to display.\n *\n * - `alert` - A dialog with a single button.\n * - `confirmation` - A dialog with two buttons, one to confirm and one to\n * cancel.\n * - `prompt` - A dialog with two buttons and a text input.\n */\nexport enum DialogType {\n  Alert = 'alert',\n  Confirmation = 'confirmation',\n  Prompt = 'prompt',\n}\n\nexport type DefaultDialog =\n  | {\n      id: string;\n    }\n  | { content: ComponentOrElement };\n\n/**\n * An alert dialog.\n *\n * @property type - The type of dialog. Must be `alert`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n */\nexport type AlertDialog =\n  | {\n      type: EnumToUnion<DialogType.Alert>;\n      content: ComponentOrElement;\n    }\n  | {\n      type: EnumToUnion<DialogType.Alert>;\n      id: string;\n    };\n\n/**\n * A confirmation dialog.\n *\n * @property type - The type of dialog. Must be `confirmation`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n */\nexport type ConfirmationDialog =\n  | {\n      type: EnumToUnion<DialogType.Confirmation>;\n      content: ComponentOrElement;\n    }\n  | {\n      type: EnumToUnion<DialogType.Confirmation>;\n      id: string;\n    };\n\n/**\n * A prompt dialog.\n *\n * @property type - The type of dialog. Must be `prompt`.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - An optional placeholder text to display in the text\n * input.\n */\nexport type PromptDialog =\n  | {\n      type: EnumToUnion<DialogType.Prompt>;\n      content: ComponentOrElement;\n      placeholder?: string;\n    }\n  | {\n      type: EnumToUnion<DialogType.Prompt>;\n      id: string;\n      placeholder?: string;\n    };\n\n/**\n * The request parameters for the `snap_dialog` method.\n *\n * @property type - The type of dialog to display.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - The placeholder text to display in the dialog. Only\n * applicable for the `prompt` dialog.\n */\nexport type DialogParams =\n  | AlertDialog\n  | ConfirmationDialog\n  | PromptDialog\n  | DefaultDialog;\n\n/**\n * The result returned by the `snap_dialog` method.\n *\n * - If the dialog is an `alert`, the result is `null`.\n * - If the dialog is a `confirmation`, the result is a boolean indicating\n * whether the user confirmed the dialog.\n * - If the dialog is a `prompt`, the result is the value entered by\n * the user.\n */\nexport type DialogResult = null | boolean | string | Json;\n"]}
+{"version":3,"file":"dialog.mjs","sourceRoot":"","sources":["../../../src/types/methods/dialog.ts"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,+BAAiB,CAAA;AACnB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { ComponentOrElement } from '..';\nimport type { EnumToUnion } from '../../internals';\n\n/**\n * The type of dialog to display.\n *\n * - `alert` - A dialog with a single button.\n * - `confirmation` - A dialog with two buttons, one to confirm and one to\n * cancel.\n * - `prompt` - A dialog with two buttons and a text input.\n */\nexport enum DialogType {\n  Alert = 'alert',\n  Confirmation = 'confirmation',\n  Prompt = 'prompt',\n}\n\nexport type DefaultDialog =\n  | {\n      id: string;\n    }\n  | { content: ComponentOrElement };\n\n/**\n * An alert dialog.\n */\nexport type AlertDialog =\n  | {\n      /**\n       * The literal string \"alert\" to indicate that this is an alert dialog.\n       */\n      type: EnumToUnion<DialogType.Alert>;\n\n      /**\n       * The content to display in the alert dialog.\n       */\n      content: ComponentOrElement;\n    }\n  | {\n      /**\n       * The literal string \"alert\" to indicate that this is an alert dialog.\n       */\n      type: EnumToUnion<DialogType.Alert>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n    };\n\n/**\n * A confirmation dialog.\n */\nexport type ConfirmationDialog =\n  | {\n      /**\n       * The literal string \"confirmation\" to indicate that this is a\n       * confirmation dialog.\n       */\n      type: EnumToUnion<DialogType.Confirmation>;\n\n      /**\n       * The content to display in the confirmation dialog.\n       */\n      content: ComponentOrElement;\n    }\n  | {\n      /**\n       * The literal string \"confirmation\" to indicate that this is a\n       * confirmation dialog.\n       */\n      type: EnumToUnion<DialogType.Confirmation>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n    };\n\n/**\n * A prompt dialog.\n */\nexport type PromptDialog =\n  | {\n      /**\n       * The literal string \"prompt\" to indicate that this is a prompt dialog.\n       */\n      type: EnumToUnion<DialogType.Prompt>;\n\n      /**\n       * The content to display in the prompt dialog.\n       */\n      content: ComponentOrElement;\n\n      /**\n       * An optional placeholder text to display in the text input.\n       */\n      placeholder?: string;\n    }\n  | {\n      /**\n       * The literal string \"prompt\" to indicate that this is a prompt dialog.\n       */\n      type: EnumToUnion<DialogType.Prompt>;\n\n      /**\n       * The Snap interface ID, which can be used to display a previously\n       * created interface. See [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).\n       */\n      id: string;\n\n      /**\n       * An optional placeholder text to display in the text input.\n       */\n      placeholder?: string;\n    };\n\n/**\n * An object containing the contents of the dialog.\n *\n * @property type - The type of dialog to display.\n * @property content - The content to display in the dialog.\n * @property id - The Snap interface ID.\n * @property placeholder - The placeholder text to display in the dialog. Only\n * applicable for the `prompt` dialog.\n */\nexport type DialogParams =\n  | AlertDialog\n  | ConfirmationDialog\n  | PromptDialog\n  | DefaultDialog;\n\n/**\n * - If the dialog is an `alert`, the result is `null`.\n * - If the dialog is a `confirmation`, the result is a boolean indicating\n * whether the user confirmed the dialog.\n * - If the dialog is a `prompt`, the result is the value entered by\n * the user.\n */\nexport type DialogResult = Json;\n"]}

package/dist/types/methods/get-background-events.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-background-events.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-background-events.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { SnapId } from '../snap';\n\n/**\n * Background event type.\n *\n * Note: The date generated when scheduling an event with a duration will be\n * represented in UTC.\n *\n * @property id - The unique id representing the event.\n * @property scheduledAt - The ISO 8601 time stamp of when the event was\n * scheduled.\n * @property snapId - The id of the snap that scheduled the event.\n * @property date - The ISO 8601 date of when the event is scheduled for.\n * @property request - The request that is supplied to the `onCronjob` handler\n * when the event is fired.\n */\nexport type BackgroundEvent = {\n  id: string;\n  scheduledAt: string;\n  snapId: SnapId;\n  date: string;\n  request: {\n    method: string;\n    jsonrpc?: '2.0' | undefined;\n    id?: string | number | null | undefined;\n    params?: Json[] | Record<string, Json> | undefined;\n  };\n};\n\n/**\n * The result returned by the `snap_getBackgroundEvents` method.\n *\n * It consists of an array background events (if any) for a snap.\n */\nexport type GetBackgroundEventsResult = BackgroundEvent[];\n\n/**\n * The request parameters for the `snap_getBackgroundEvents` method.\n *\n * This method does not accept any parameters.\n */\nexport type GetBackgroundEventsParams = never;\n"]}
+{"version":3,"file":"get-background-events.cjs","sourceRoot":"","sources":["../../../src/types/methods/get-background-events.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { SnapId } from '../snap';\n\n/**\n * Background event type.\n *\n * Note: The date generated when scheduling an event with a duration will be\n * represented in UTC.\n *\n * @property id - The unique ID representing the event.\n * @property scheduledAt - The ISO 8601 timestamp of when the event was\n * scheduled.\n * @property snapId - The ID of the Snap that scheduled the event.\n * @property date - The ISO 8601 date of when the event is scheduled for.\n * @property request - The request that is supplied to the `onCronjob` handler\n * when the event is fired.\n */\nexport type BackgroundEvent = {\n  id: string;\n  scheduledAt: string;\n  snapId: SnapId;\n  date: string;\n  request: {\n    /**\n     * The method to be called when the event is fired.\n     */\n    method: string;\n\n    /**\n     * The optional JSON-RPC version for the request, which is always \"2.0\" if\n     * provided.\n     */\n    jsonrpc?: '2.0' | undefined;\n\n    /**\n     * The optional ID for the request.\n     */\n    id?: string | number | null | undefined;\n\n    /**\n     * The optional parameters for the request.\n     */\n    params?: Json[] | Record<string, Json> | undefined;\n  };\n};\n\n/**\n * An array of scheduled background events.\n */\nexport type GetBackgroundEventsResult = BackgroundEvent[];\n\n/**\n * This method does not accept any parameters.\n */\nexport type GetBackgroundEventsParams = never;\n"]}

package/dist/types/methods/get-background-events.d.cts

@@ -6,10 +6,10 @@ import type { SnapId } from "../snap.cjs";
  * Note: The date generated when scheduling an event with a duration will be
  * represented in UTC.
  *
- * @property id - The unique id representing the event.
- * @property scheduledAt - The ISO 8601 time stamp of when the event was
+ * @property id - The unique ID representing the event.
+ * @property scheduledAt - The ISO 8601 timestamp of when the event was
  * scheduled.
- * @property snapId - The id of the snap that scheduled the event.
+ * @property snapId - The ID of the Snap that scheduled the event.
  * @property date - The ISO 8601 date of when the event is scheduled for.
  * @property request - The request that is supplied to the `onCronjob` handler
  * when the event is fired.
@@ -20,21 +20,30 @@ export type BackgroundEvent = {
     snapId: SnapId;
     date: string;
     request: {
+        /**
+         * The method to be called when the event is fired.
+         */
         method: string;
+        /**
+         * The optional JSON-RPC version for the request, which is always "2.0" if
+         * provided.
+         */
         jsonrpc?: '2.0' | undefined;
+        /**
+         * The optional ID for the request.
+         */
         id?: string | number | null | undefined;
+        /**
+         * The optional parameters for the request.
+         */
         params?: Json[] | Record<string, Json> | undefined;
     };
 };
 /**
- * The result returned by the `snap_getBackgroundEvents` method.
- *
- * It consists of an array background events (if any) for a snap.
+ * An array of scheduled background events.
  */
 export type GetBackgroundEventsResult = BackgroundEvent[];
 /**
- * The request parameters for the `snap_getBackgroundEvents` method.
- *
  * This method does not accept any parameters.
  */
 export type GetBackgroundEventsParams = never;