@metamask/snaps-rpc-methods 11.0.0 → 11.1.1

package/dist/restricted/dialog.d.cts

@@ -0,0 +1,488 @@
+import type { PermissionSpecificationBuilder, RestrictedMethodOptions } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import { DialogType } from "@metamask/snaps-sdk";
+import type { DialogParams, InterfaceState, SnapId, ComponentOrElement } from "@metamask/snaps-sdk";
+import type { InferMatching } from "@metamask/snaps-utils";
+import type { Infer } from "@metamask/superstruct";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { type MethodHooksObject } from "../utils.cjs";
+declare const methodName = "snap_dialog";
+export type DialogApprovalTypes = Record<DialogType, string> & {
+    default: string;
+};
+export declare const DIALOG_APPROVAL_TYPES: {
+    alert: string;
+    confirmation: string;
+    prompt: string;
+    default: string;
+};
+declare const PlaceholderStruct: import("@metamask/superstruct").Struct<string | undefined, null>;
+export type Placeholder = Infer<typeof PlaceholderStruct>;
+type RequestUserApprovalOptions = {
+    id?: string;
+    origin: string;
+    type: string;
+    requestData: {
+        id: string;
+        placeholder?: string;
+    };
+};
+type RequestUserApproval = (opts: RequestUserApprovalOptions) => Promise<boolean | null | string | Json>;
+type CreateInterface = (snapId: string, content: ComponentOrElement) => Promise<string>;
+type GetInterface = (snapId: string, id: string) => {
+    content: ComponentOrElement;
+    snapId: SnapId;
+    state: InterfaceState;
+};
+export type DialogMethodHooks = {
+    /**
+     * @param opts - The `requestUserApproval` options.
+     * @param opts.id - The approval ID. If not provided, a new approval ID will be generated.
+     * @param opts.origin - The origin of the request. In this case, the Snap ID.
+     * @param opts.type - The type of the approval request.
+     * @param opts.requestData - The data of the approval request.
+     * @param opts.requestData.id - The ID of the interface.
+     * @param opts.requestData.placeholder - The placeholder of the `Prompt` dialog.
+     */
+    requestUserApproval: RequestUserApproval;
+    /**
+     * @param snapId - The Snap ID creating the interface.
+     * @param content - The content of the interface.
+     */
+    createInterface: CreateInterface;
+    /**
+     * @param snapId - The SnapId requesting the interface.
+     * @param id - The interface ID.
+     */
+    getInterface: GetInterface;
+};
+type DialogSpecificationBuilderOptions = {
+    allowedCaveats?: Readonly<NonEmptyArray<string>> | null;
+    methodHooks: DialogMethodHooks;
+};
+export declare const dialogBuilder: Readonly<{
+    readonly targetName: "snap_dialog";
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, DialogSpecificationBuilderOptions, {
+        permissionType: PermissionType.RestrictedMethod;
+        targetName: typeof methodName;
+        methodImplementation: ReturnType<typeof getDialogImplementation>;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+    }>;
+    readonly methodHooks: MethodHooksObject<DialogMethodHooks>;
+}>;
+declare const DialogParametersStruct: import("@metamask/superstruct").Struct<{
+    type: "alert";
+    id: string;
+} | {
+    type: "alert";
+    content: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        value: {
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+            value: string;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
+            markdown?: boolean | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
+        };
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        error?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
+        placeholder?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        value: string;
+        variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        /**
+         * The specification builder for the `snap_dialog` permission. `snap_dialog`
+         * lets the Snap display one of the following dialogs to the user:
+         * - An alert, for displaying information.
+         * - A confirmation, for accepting or rejecting some action.
+         * - A prompt, for inputting some information.
+         *
+         * @param options - The specification builder options.
+         * @param options.allowedCaveats - The optional allowed caveats for the
+         * permission.
+         * @param options.methodHooks - The RPC method hooks needed by the method
+         * implementation.
+         * @returns The specification for the `snap_dialog` permission.
+         */
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            error?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
+            placeholder?: string | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            value: string;
+            variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        name: string;
+        value?: string | undefined;
+        children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
+            value: string;
+            children: string;
+        }, "Radio">>;
+    }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        children: import("@metamask/snaps-sdk/jsx").StringElement;
+    }, "Heading">;
+} | {
+    type: "confirmation";
+    id: string;
+} | {
+    type: "confirmation";
+    content: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        value: {
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+            value: string;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
+            markdown?: boolean | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
+        };
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        error?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
+        placeholder?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        value: string;
+        variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        /**
+         * The specification builder for the `snap_dialog` permission. `snap_dialog`
+         * lets the Snap display one of the following dialogs to the user:
+         * - An alert, for displaying information.
+         * - A confirmation, for accepting or rejecting some action.
+         * - A prompt, for inputting some information.
+         *
+         * @param options - The specification builder options.
+         * @param options.allowedCaveats - The optional allowed caveats for the
+         * permission.
+         * @param options.methodHooks - The RPC method hooks needed by the method
+         * implementation.
+         * @returns The specification for the `snap_dialog` permission.
+         */
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            error?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
+            placeholder?: string | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            value: string;
+            variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        name: string;
+        value?: string | undefined;
+        children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
+            value: string;
+            children: string;
+        }, "Radio">>;
+    }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        children: import("@metamask/snaps-sdk/jsx").StringElement;
+    }, "Heading">;
+} | {
+    type: "prompt";
+    id: string;
+    placeholder?: string | undefined;
+} | {
+    type: "prompt";
+    content: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        value: {
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+            value: string;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
+            markdown?: boolean | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
+        };
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        error?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
+        placeholder?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        value: string;
+        variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        /**
+         * The specification builder for the `snap_dialog` permission. `snap_dialog`
+         * lets the Snap display one of the following dialogs to the user:
+         * - An alert, for displaying information.
+         * - A confirmation, for accepting or rejecting some action.
+         * - A prompt, for inputting some information.
+         *
+         * @param options - The specification builder options.
+         * @param options.allowedCaveats - The optional allowed caveats for the
+         * permission.
+         * @param options.methodHooks - The RPC method hooks needed by the method
+         * implementation.
+         * @returns The specification for the `snap_dialog` permission.
+         */
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            error?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
+            placeholder?: string | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            value: string;
+            variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        name: string;
+        value?: string | undefined;
+        children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
+            value: string;
+            children: string;
+        }, "Radio">>;
+    }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        children: import("@metamask/snaps-sdk/jsx").StringElement;
+    }, "Heading">;
+    placeholder?: string | undefined;
+} | {
+    id: string;
+} | {
+    content: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
+        markdown?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        value: {
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+            value: string;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
+            markdown?: boolean | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
+        };
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        error?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
+        placeholder?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        value: string;
+        variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        /**
+         * The specification builder for the `snap_dialog` permission. `snap_dialog`
+         * lets the Snap display one of the following dialogs to the user:
+         * - An alert, for displaying information.
+         * - A confirmation, for accepting or rejecting some action.
+         * - A prompt, for inputting some information.
+         *
+         * @param options - The specification builder options.
+         * @param options.allowedCaveats - The optional allowed caveats for the
+         * permission.
+         * @param options.methodHooks - The RPC method hooks needed by the method
+         * implementation.
+         * @returns The specification for the `snap_dialog` permission.
+         */
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            error?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
+            placeholder?: string | undefined;
+        } | {
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            value: string;
+            variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        name: string;
+        value?: string | undefined;
+        children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
+            value: string;
+            children: string;
+        }, "Radio">>;
+    }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        children: import("@metamask/snaps-sdk/jsx").StringElement;
+    }, "Heading">;
+}, null>;
+export type DialogParameters = InferMatching<typeof DialogParametersStruct, DialogParams>;
+/**
+ * Builds the method implementation for `snap_dialog`.
+ *
+ * @param hooks - The RPC method hooks.
+ * @param hooks.requestUserApproval - A function that creates a new Approval in the ApprovalController.
+ * This function should return a Promise that resolves with the appropriate value when the user has approved or rejected the request.
+ * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.
+ * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.
+ * @returns The method implementation which return value depends on the dialog
+ * type, valid return types are: string, boolean, null.
+ */
+export declare function getDialogImplementation({ requestUserApproval, createInterface, getInterface, }: DialogMethodHooks): (args: RestrictedMethodOptions<DialogParameters>) => Promise<boolean | null | string | Json>;
+export {};
+//# sourceMappingURL=dialog.d.cts.map

package/dist/restricted/dialog.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.d.cts","sourceRoot":"","sources":["../../src/restricted/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,uBAAuB,EAExB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,EACL,UAAU,EAIX,4BAA4B;AAC7B,OAAO,KAAK,EACV,YAAY,EAEZ,cAAc,EACd,MAAM,EAEN,kBAAkB,EACnB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAC3D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAG3D,OAAO,EAAE,KAAK,iBAAiB,EAAE,qBAAiB;AAElD,QAAA,MAAM,UAAU,gBAAgB,CAAC;AAEjC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IAC7D,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;CAKjC,CAAC;AAEF,QAAA,MAAM,iBAAiB,kEAAkC,CAAC;AAE1D,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D,KAAK,0BAA0B,GAAG;IAChC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,KAAK,mBAAmB,GAAG,CACzB,IAAI,EAAE,0BAA0B,KAC7B,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AAE7C,KAAK,eAAe,GAAG,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB,KAAK,YAAY,GAAG,CAClB,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,KACP;IAAE,OAAO,EAAE,kBAAkB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,cAAc,CAAA;CAAE,CAAC;AAE5E,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;;;;OAQG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC;;;OAGG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,KAAK,iCAAiC,GAAG;IACvC,cAAc,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;IACxD,WAAW,EAAE,iBAAiB,CAAC;CAChC,CAAC;AA8CF,eAAO,MAAM,aAAa;;;wBA3CR,eAAe,gBAAgB;oBACnC,iBAAiB;8BACP,WAAW,8BAA8B,CAAC;wBAChD,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;;;EA4C7C,CAAC;AAsEZ,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA/G5B;;;;;;;;;;;;;WAaG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAbH;;;;;;;;;;;;;WAaG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAbH;;;;;;;;;;;;;WAaG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAbH;;;;;;;;;;;;;WAaG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqHD,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAC1C,OAAO,sBAAsB,EAC7B,YAAY,CACb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,EAAE,iBAAiB,UAEV,wBAAwB,gBAAgB,CAAC,KAC9C,QAAQ,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAoD3C"}