@metamask/snaps-sdk 5.0.0 → 6.1.0

package/dist/types/jsx/validation.d.ts

@@ -1,7 +1,7 @@
-import type { Struct } from 'superstruct';
+import type { Struct } from '@metamask/superstruct';
 import type { Describe } from '../internals';
-import type { GenericSnapElement, Key, MaybeArray, SnapElement, StringElement } from './component';
-import type { AddressElement, BoldElement, BoxElement, ButtonElement, CopyableElement, DividerElement, DropdownElement, OptionElement, FieldElement, FormElement, HeadingElement, ImageElement, InputElement, ItalicElement, JSXElement, LinkElement, RowElement, SpinnerElement, StandardFormattingElement, TextElement, ValueElement } from './components';
+import type { GenericSnapElement, Key, SnapElement, SnapsChildren, StringElement } from './component';
+import type { AddressElement, BoldElement, BoxElement, ButtonElement, CheckboxElement, CardElement, CopyableElement, DividerElement, DropdownElement, OptionElement, FieldElement, FormElement, HeadingElement, ImageElement, InputElement, ItalicElement, JSXElement, LinkElement, RowElement, SpinnerElement, StandardFormattingElement, TextElement, TooltipElement, ValueElement, FileInputElement, ContainerElement, FooterElement } from './components';
 /**
  * A struct for the {@link Key} type.
  */
@@ -18,6 +18,10 @@ export declare const ElementStruct: Describe<GenericSnapElement>;
  * A struct for the {@link ButtonElement} type.
  */
 export declare const ButtonStruct: Describe<ButtonElement>;
+/**
+ * A struct for the {@link CheckboxElement} type.
+ */
+export declare const CheckboxStruct: Describe<CheckboxElement>;
 /**
  * A struct for the {@link InputElement} type.
  */
@@ -30,10 +34,23 @@ export declare const OptionStruct: Describe<OptionElement>;
  * A struct for the {@link DropdownElement} type.
  */
 export declare const DropdownStruct: Describe<DropdownElement>;
+/**
+ * A struct for the {@link FileInputElement} type.
+ */
+export declare const FileInputStruct: Describe<FileInputElement>;
+/**
+ * A union of the allowed children of the Field component.
+ * This is mainly used in the simulator for validation purposes.
+ */
+export declare const FieldChildUnionStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<import("./components").CheckboxProps, "Checkbox"> | SnapElement<import("./components").InputProps, "Input"> | SnapElement<import("./components").DropdownProps, "Dropdown"> | SnapElement<import("./components").FileInputProps, "FileInput">, null>;
 /**
  * A struct for the {@link FieldElement} type.
  */
 export declare const FieldStruct: Describe<FieldElement>;
+/**
+ * A subset of JSX elements that are allowed as children of the Form component.
+ */
+export declare const FormChildStruct: Struct<SnapsChildren<GenericSnapElement>, null>;
 /**
  * A struct for the {@link FormElement} type.
  */
@@ -51,10 +68,29 @@ export declare const FormattingStruct: Describe<StandardFormattingElement>;
  * A struct for the {@link AddressElement} type.
  */
 export declare const AddressStruct: Describe<AddressElement>;
+export declare const BoxChildrenStruct: Struct<SnapsChildren<GenericSnapElement>, null>;
 /**
  * A struct for the {@link BoxElement} type.
  */
 export declare const BoxStruct: Describe<BoxElement>;
+/**
+ * A subset of JSX elements that are allowed as children of the Footer component.
+ * This set should include a single button or a tuple of two buttons.
+ */
+export declare const FooterChildStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | [SnapElement<import("./components").ButtonProps, "Button">, SnapElement<import("./components").ButtonProps, "Button">], null>;
+/**
+ * A struct for the {@link FooterElement} type.
+ */
+export declare const FooterStruct: Describe<FooterElement>;
+/**
+ * A subset of JSX elements that are allowed as children of the Container component.
+ * This set should include a single Box or a tuple of a Box and a Footer component.
+ */
+export declare const ContainerChildStruct: Struct<SnapElement<import("./components").BoxProps, "Box"> | [SnapElement<import("./components").BoxProps, "Box">, SnapElement<import("./components").FooterProps, "Footer">], null>;
+/**
+ * A struct for the {@link ContainerElement} type.
+ */
+export declare const ContainerStruct: Describe<ContainerElement>;
 /**
  * A struct for the {@link CopyableElement} type.
  */
@@ -67,6 +103,10 @@ export declare const DividerStruct: Describe<DividerElement>;
  * A struct for the {@link ValueElement} type.
  */
 export declare const ValueStruct: Describe<ValueElement>;
+/**
+ * A struct for the {@link CardElement} type.
+ */
+export declare const CardStruct: Describe<CardElement>;
 /**
  * A struct for the {@link HeadingElement} type.
  */
@@ -83,6 +123,23 @@ export declare const LinkStruct: Describe<LinkElement>;
  * A struct for the {@link TextElement} type.
  */
 export declare const TextStruct: Describe<TextElement>;
+/**
+ * A subset of JSX elements that are allowed as children of the Tooltip component.
+ * This set should include all text components and the Image.
+ */
+export declare const TooltipChildStruct: Struct<boolean | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<{
+    src: string;
+    alt?: string | undefined;
+}, "Image"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text">, null>;
+/**
+ * A subset of JSX elements that are allowed as content of the Tooltip component.
+ * This set should include all text components.
+ */
+export declare const TooltipContentStruct: Struct<string | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text">, null>;
+/**
+ * A struct for the {@link TooltipElement} type.
+ */
+export declare const TooltipStruct: Describe<TooltipElement>;
 /**
  * A struct for the {@link RowElement} type.
  */
@@ -93,55 +150,25 @@ export declare const RowStruct: Describe<RowElement>;
 export declare const SpinnerStruct: Describe<SpinnerElement>;
 /**
  * A subset of JSX elements that are allowed as children of the Box component.
- * This set should include all components, except components that need to be nested
- * in another component (e.g. Field must be contained in a Form).
- */
-export declare const BoxChildStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<{
-    name: string;
-    type?: "number" | "text" | "password" | undefined;
-    value?: string | undefined;
-    placeholder?: string | undefined;
-}, "Input"> | SnapElement<{
-    name: string;
-    value?: string | undefined;
-    children: MaybeArray<SnapElement<{
-        value: string;
-        children: string;
-    }, "Option">>;
-}, "Dropdown"> | SnapElement<{
-    children: MaybeArray<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<import("./components").FieldProps, "Field">>;
-    name: string;
-}, "Form"> | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<import("./components").AddressProps, "Address"> | SnapElement<import("./components").BoxProps, "Box"> | SnapElement<import("./components").CopyableProps, "Copyable"> | SnapElement<Record<string, never>, "Divider"> | SnapElement<{
+ * This set includes all components, except components that need to be nested in
+ * another component (e.g., Field must be contained in a Form).
+ */
+export declare const BoxChildStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<import("./components").CheckboxProps, "Checkbox"> | SnapElement<import("./components").FormProps, "Form"> | SnapElement<import("./components").InputProps, "Input"> | SnapElement<import("./components").DropdownProps, "Dropdown"> | SnapElement<import("./components").FileInputProps, "FileInput"> | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<import("./components").AddressProps, "Address"> | SnapElement<import("./components").BoxProps, "Box"> | SnapElement<import("./components").CardProps, "Card"> | SnapElement<import("./components").CopyableProps, "Copyable"> | SnapElement<Record<string, never>, "Divider"> | SnapElement<{
     children: StringElement;
 }, "Heading"> | SnapElement<{
     src: string;
     alt?: string | undefined;
-}, "Image"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text"> | SnapElement<import("./components").RowProps, "Row"> | SnapElement<Record<string, never>, "Spinner">, null>;
+}, "Image"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text"> | SnapElement<import("./components").RowProps, "Row"> | SnapElement<Record<string, never>, "Spinner"> | SnapElement<import("./components").TooltipProps, "Tooltip">, null>;
 /**
  * For now, the allowed JSX elements at the root are the same as the allowed
  * children of the Box component.
  */
-export declare const RootJSXElementStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<{
-    name: string;
-    type?: "number" | "text" | "password" | undefined;
-    value?: string | undefined;
-    placeholder?: string | undefined;
-}, "Input"> | SnapElement<{
-    name: string;
-    value?: string | undefined;
-    children: MaybeArray<SnapElement<{
-        value: string;
-        children: string;
-    }, "Option">>;
-}, "Dropdown"> | SnapElement<{
-    children: MaybeArray<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<import("./components").FieldProps, "Field">>;
-    name: string;
-}, "Form"> | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<import("./components").AddressProps, "Address"> | SnapElement<import("./components").BoxProps, "Box"> | SnapElement<import("./components").CopyableProps, "Copyable"> | SnapElement<Record<string, never>, "Divider"> | SnapElement<{
+export declare const RootJSXElementStruct: Struct<SnapElement<import("./components").ButtonProps, "Button"> | SnapElement<import("./components").CheckboxProps, "Checkbox"> | SnapElement<import("./components").FormProps, "Form"> | SnapElement<import("./components").InputProps, "Input"> | SnapElement<import("./components").DropdownProps, "Dropdown"> | SnapElement<import("./components").FileInputProps, "FileInput"> | SnapElement<import("./components").BoldProps, "Bold"> | SnapElement<import("./components").ItalicProps, "Italic"> | SnapElement<import("./components").AddressProps, "Address"> | SnapElement<import("./components").BoxProps, "Box"> | SnapElement<import("./components").CardProps, "Card"> | SnapElement<import("./components").ContainerProps, "Container"> | SnapElement<import("./components").CopyableProps, "Copyable"> | SnapElement<Record<string, never>, "Divider"> | SnapElement<{
     children: StringElement;
 }, "Heading"> | SnapElement<{
     src: string;
     alt?: string | undefined;
-}, "Image"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text"> | SnapElement<import("./components").RowProps, "Row"> | SnapElement<Record<string, never>, "Spinner">, null>;
+}, "Image"> | SnapElement<import("./components").LinkProps, "Link"> | SnapElement<import("./components").TextProps, "Text"> | SnapElement<import("./components").RowProps, "Row"> | SnapElement<Record<string, never>, "Spinner"> | SnapElement<import("./components").TooltipProps, "Tooltip">, null>;
 /**
  * A struct for the {@link JSXElement} type.
  */

package/dist/types/types/handlers/user-input.d.ts

@@ -1,4 +1,4 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import type { InterfaceContext } from '../interface';
 /**
  * The type of user input event fired.
@@ -7,65 +7,180 @@ import type { InterfaceContext } from '../interface';
  * - `ButtonClickEvent` - A button has been clicked in the UI.
  * - `FormSubmitEvent` - A Form has been submitted in the UI.
  * - `InputChangeEvent` - The value of an input field has changed in the UI.
+ * - `FileUploadEvent` - A file has been uploaded in the UI.
  */
 export declare enum UserInputEventType {
     ButtonClickEvent = "ButtonClickEvent",
     FormSubmitEvent = "FormSubmitEvent",
-    InputChangeEvent = "InputChangeEvent"
+    InputChangeEvent = "InputChangeEvent",
+    FileUploadEvent = "FileUploadEvent"
 }
-export declare const GenericEventStruct: import("superstruct").Struct<{
+export declare const GenericEventStruct: import("@metamask/superstruct").Struct<{
     type: string;
     name?: string | undefined;
 }, {
-    type: import("superstruct").Struct<string, null>;
-    name: import("superstruct").Struct<string | undefined, null>;
+    type: import("@metamask/superstruct").Struct<string, null>;
+    name: import("@metamask/superstruct").Struct<string | undefined, null>;
 }>;
-export declare const ButtonClickEventStruct: import("superstruct").Struct<{
+export declare const ButtonClickEventStruct: import("@metamask/superstruct").Struct<{
     type: UserInputEventType.ButtonClickEvent;
     name?: string | undefined;
 }, {
-    type: import("superstruct").Struct<UserInputEventType.ButtonClickEvent, UserInputEventType.ButtonClickEvent>;
-    name: import("superstruct").Struct<string | undefined, null>;
+    type: import("@metamask/superstruct").Struct<UserInputEventType.ButtonClickEvent, UserInputEventType.ButtonClickEvent>;
+    name: import("@metamask/superstruct").Struct<string | undefined, null>;
 }>;
-export declare const FormSubmitEventStruct: import("superstruct").Struct<{
-    value: Record<string, string | null>;
+/**
+ * A button click event fired in the UI. This is passed to the params of the
+ * `onUserInput` handler.
+ *
+ * @property type - The type of event fired. See {@link UserInputEventType} for
+ * the different types. This is always `ButtonClickEvent`.
+ * @property name - The optional component name that fired the event.
+ */
+export declare type ButtonClickEvent = Infer<typeof ButtonClickEventStruct>;
+export declare const FileStruct: import("@metamask/superstruct").Struct<{
+    name: string;
+    size: number;
+    contentType: string;
+    contents: string;
+}, {
+    name: import("@metamask/superstruct").Struct<string, null>;
+    size: import("@metamask/superstruct").Struct<number, null>;
+    contentType: import("@metamask/superstruct").Struct<string, null>;
+    contents: import("@metamask/superstruct").Struct<string, null>;
+}>;
+/**
+ * A file object containing the file name, size, content type, and the base64
+ * encoded contents of the file.
+ *
+ * @property name - The name of the file.
+ * @property size - The size of the file in bytes.
+ * @property contentType - The content type of the file.
+ * @property contents - The base64 encoded contents of the file.
+ */
+export declare type File = Infer<typeof FileStruct>;
+export declare const FormSubmitEventStruct: import("@metamask/superstruct").Struct<{
+    value: Record<string, string | boolean | {
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null>;
     type: UserInputEventType.FormSubmitEvent;
     name: string;
 }, {
-    type: import("superstruct").Struct<UserInputEventType.FormSubmitEvent, UserInputEventType.FormSubmitEvent>;
-    value: import("superstruct").Struct<Record<string, string | null>, null>;
-    name: import("superstruct").Struct<string, null>;
+    type: import("@metamask/superstruct").Struct<UserInputEventType.FormSubmitEvent, UserInputEventType.FormSubmitEvent>;
+    value: import("@metamask/superstruct").Struct<Record<string, string | boolean | {
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null>, null>;
+    name: import("@metamask/superstruct").Struct<string, null>;
 }>;
-export declare const InputChangeEventStruct: import("superstruct").Struct<{
-    value: string;
+/**
+ * A form submit event, which is fired when a submit button is clicked.
+ *
+ * @property type - The type of event fired. This is always `FormSubmitEvent`.
+ * @property name - The name of the form that was submitted.
+ * @property value - The form values submitted as an object. The keys are the
+ * names of the form fields and the values are the values of the form fields. If
+ * a form field is empty, the value is `null` or an empty string.
+ * @property files - The files uploaded in the form. The keys are the names of
+ * the file input fields and the values are the file objects containing the file
+ * name, size, content type, and the base64 encoded contents of the file. See
+ * {@link File}.
+ */
+export declare type FormSubmitEvent = Infer<typeof FormSubmitEventStruct>;
+export declare const InputChangeEventStruct: import("@metamask/superstruct").Struct<{
+    value: string | boolean;
     type: UserInputEventType.InputChangeEvent;
     name: string;
 }, {
-    type: import("superstruct").Struct<UserInputEventType.InputChangeEvent, UserInputEventType.InputChangeEvent>;
-    name: import("superstruct").Struct<string, null>;
-    value: import("superstruct").Struct<string, null>;
+    type: import("@metamask/superstruct").Struct<UserInputEventType.InputChangeEvent, UserInputEventType.InputChangeEvent>;
+    name: import("@metamask/superstruct").Struct<string, null>;
+    value: import("@metamask/superstruct").Struct<string | boolean, null>;
 }>;
-export declare const UserInputEventStruct: import("superstruct").Struct<{
+/**
+ * An input change event, which is fired when the value of an input field
+ * changes.
+ *
+ * @property type - The type of event fired. This is always `InputChangeEvent`.
+ * @property name - The name of the input field that changed.
+ * @property value - The new value of the input field.
+ */
+export declare type InputChangeEvent = Infer<typeof InputChangeEventStruct>;
+export declare const FileUploadEventStruct: import("@metamask/superstruct").Struct<{
+    type: UserInputEventType.FileUploadEvent;
+    name: string;
+    file: {
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null;
+}, {
+    type: import("@metamask/superstruct").Struct<UserInputEventType.FileUploadEvent, UserInputEventType.FileUploadEvent>;
+    name: import("@metamask/superstruct").Struct<string, null>;
+    file: import("@metamask/superstruct").Struct<{
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null, {
+        name: import("@metamask/superstruct").Struct<string, null>;
+        size: import("@metamask/superstruct").Struct<number, null>;
+        contentType: import("@metamask/superstruct").Struct<string, null>;
+        contents: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+}>;
+/**
+ * A file upload event, which is fired when a file is uploaded.
+ *
+ * @property type - The type of event fired. This is always `FileUploadEvent`.
+ * @property name - The name of the file input field that was used to upload the
+ * file.
+ * @property file - The file object containing the file name, size,
+ * content type, and the base64 encoded contents of the file.
+ * @see File
+ */
+export declare type FileUploadEvent = Infer<typeof FileUploadEventStruct>;
+export declare const UserInputEventStruct: import("@metamask/superstruct").Struct<{
     type: UserInputEventType.ButtonClickEvent;
     name?: string | undefined;
 } | {
-    value: Record<string, string | null>;
+    value: Record<string, string | boolean | {
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null>;
     type: UserInputEventType.FormSubmitEvent;
     name: string;
 } | {
-    value: string;
+    value: string | boolean;
     type: UserInputEventType.InputChangeEvent;
     name: string;
+} | {
+    type: UserInputEventType.FileUploadEvent;
+    name: string;
+    file: {
+        name: string;
+        size: number;
+        contentType: string;
+        contents: string;
+    } | null;
 }, null>;
 /**
  * A user input event fired in the UI. This is passed to the params of the `onUserInput` handler.
  *
  * @property type - The type of event fired. See {@link UserInputEventType} for the different types.
- * @property name - The component name that fired the event. It is optional for an {@link UserInputEventType.ButtonClickEvent}.
- * @property value - The value associated with the event. Only available when an {@link UserInputEventType.FormSubmitEvent} is fired.
- * It contains the form values submitted.
+ * @property name - The component name that fired the event. It is optional for
+ * an {@link UserInputEventType.ButtonClickEvent}.
+ * @property value - The value associated with the event. Only available when an
+ * {@link UserInputEventType.FormSubmitEvent} is fired. It contains the form values submitted.
  */
-export declare type UserInputEvent = Infer<typeof UserInputEventStruct>;
+export declare type UserInputEvent = ButtonClickEvent | FormSubmitEvent | InputChangeEvent | FileUploadEvent;
 /**
  * The `onUserInput` handler. This is called when an user input event is fired in the UI.
  *

package/dist/types/types/interface.d.ts

@@ -1,17 +1,40 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import type { JSXElement } from '../jsx';
 import type { Component } from '../ui';
 /**
- * To avoid typing problems with the interface state when manipulating it we have to differentiate the state of
- * a form (that will be contained inside the root state) and the root state since a key in the root stat can contain
+ * To avoid typing problems with the interface state when manipulating it we
+ * have to differentiate the state of a form (that will be contained inside the
+ * root state) and the root state since a key in the root stat can contain
  * either the value of an input or a sub-state of a form.
  */
-export declare const FormStateStruct: import("superstruct").Struct<Record<string, string | null>, null>;
-export declare const InterfaceStateStruct: import("superstruct").Struct<Record<string, string | Record<string, string | null> | null>, null>;
+export declare const StateStruct: import("@metamask/superstruct").Struct<string | boolean | {
+    name: string;
+    size: number;
+    contentType: string;
+    contents: string;
+}, null>;
+export declare const FormStateStruct: import("@metamask/superstruct").Struct<Record<string, string | boolean | {
+    name: string;
+    size: number;
+    contentType: string;
+    contents: string;
+} | null>, null>;
+export declare const InterfaceStateStruct: import("@metamask/superstruct").Struct<Record<string, string | boolean | {
+    name: string;
+    size: number;
+    contentType: string;
+    contents: string;
+} | Record<string, string | boolean | {
+    name: string;
+    size: number;
+    contentType: string;
+    contents: string;
+} | null> | null>, null>;
+export declare type State = Infer<typeof StateStruct>;
 export declare type FormState = Infer<typeof FormStateStruct>;
 export declare type InterfaceState = Infer<typeof InterfaceStateStruct>;
 export declare type ComponentOrElement = Component | JSXElement;
-export declare const ComponentOrElementStruct: import("superstruct").Struct<{
+export declare const ComponentOrElementStruct: import("@metamask/superstruct").Struct<{
     value: string;
     type: import("../ui").NodeType.Copyable;
     sensitive?: boolean | undefined;
@@ -79,26 +102,11 @@ export declare const ComponentOrElementStruct: import("superstruct").Struct<{
         variant?: "primary" | "secondary" | undefined;
         buttonType?: "button" | "submit" | undefined;
     })[];
-} | import("../jsx").SnapElement<import("../jsx").ButtonProps, "Button"> | import("../jsx").SnapElement<{
-    name: string;
-    type?: "number" | "text" | "password" | undefined;
-    value?: string | undefined;
-    placeholder?: string | undefined;
-}, "Input"> | import("../jsx").SnapElement<{
-    name: string;
-    value?: string | undefined;
-    children: import("../jsx").MaybeArray<import("../jsx").SnapElement<{
-        value: string;
-        children: string;
-    }, "Option">>;
-}, "Dropdown"> | import("../jsx").SnapElement<{
-    children: import("../jsx").MaybeArray<import("../jsx").SnapElement<import("../jsx").ButtonProps, "Button"> | import("../jsx").SnapElement<import("../jsx").FieldProps, "Field">>;
-    name: string;
-}, "Form"> | import("../jsx").SnapElement<import("../jsx").BoldProps, "Bold"> | import("../jsx").SnapElement<import("../jsx").ItalicProps, "Italic"> | import("../jsx").SnapElement<import("../jsx").AddressProps, "Address"> | import("../jsx").SnapElement<import("../jsx").BoxProps, "Box"> | import("../jsx").SnapElement<import("../jsx").CopyableProps, "Copyable"> | import("../jsx").SnapElement<Record<string, never>, "Divider"> | import("../jsx").SnapElement<{
+} | import("../jsx").SnapElement<import("../jsx").ButtonProps, "Button"> | import("../jsx").SnapElement<import("../jsx").CheckboxProps, "Checkbox"> | import("../jsx").SnapElement<import("../jsx").FormProps, "Form"> | import("../jsx").SnapElement<import("../jsx").InputProps, "Input"> | import("../jsx").SnapElement<import("../jsx").DropdownProps, "Dropdown"> | import("../jsx").SnapElement<import("../jsx").FileInputProps, "FileInput"> | import("../jsx").SnapElement<import("../jsx").BoldProps, "Bold"> | import("../jsx").SnapElement<import("../jsx").ItalicProps, "Italic"> | import("../jsx").SnapElement<import("../jsx").AddressProps, "Address"> | import("../jsx").SnapElement<import("../jsx").BoxProps, "Box"> | import("../jsx").SnapElement<import("../jsx").CardProps, "Card"> | import("../jsx").SnapElement<import("../jsx").ContainerProps, "Container"> | import("../jsx").SnapElement<import("../jsx").CopyableProps, "Copyable"> | import("../jsx").SnapElement<Record<string, never>, "Divider"> | import("../jsx").SnapElement<{
     children: import("../jsx").StringElement;
 }, "Heading"> | import("../jsx").SnapElement<{
     src: string;
     alt?: string | undefined;
-}, "Image"> | import("../jsx").SnapElement<import("../jsx").LinkProps, "Link"> | import("../jsx").SnapElement<import("../jsx").TextProps, "Text"> | import("../jsx").SnapElement<import("../jsx").RowProps, "Row"> | import("../jsx").SnapElement<Record<string, never>, "Spinner">, null>;
-export declare const InterfaceContextStruct: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+}, "Image"> | import("../jsx").SnapElement<import("../jsx").LinkProps, "Link"> | import("../jsx").SnapElement<import("../jsx").TextProps, "Text"> | import("../jsx").SnapElement<import("../jsx").RowProps, "Row"> | import("../jsx").SnapElement<Record<string, never>, "Spinner"> | import("../jsx").SnapElement<import("../jsx").TooltipProps, "Tooltip">, null>;
+export declare const InterfaceContextStruct: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
 export declare type InterfaceContext = Infer<typeof InterfaceContextStruct>;

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

@@ -1,3 +1,4 @@
+import type { Json } from '@metamask/utils';
 import type { ComponentOrElement } from '..';
 import type { EnumToUnion } from '../../internals';
 /**
@@ -13,6 +14,11 @@ export declare enum DialogType {
     Confirmation = "confirmation",
     Prompt = "prompt"
 }
+export declare type DefaultDialog = {
+    id: string;
+} | {
+    content: ComponentOrElement;
+};
 /**
  * An alert dialog.
  *
@@ -68,7 +74,7 @@ export declare type PromptDialog = {
  * @property placeholder - The placeholder text to display in the dialog. Only
  * applicable for the `prompt` dialog.
  */
-export declare type DialogParams = AlertDialog | ConfirmationDialog | PromptDialog;
+export declare type DialogParams = AlertDialog | ConfirmationDialog | PromptDialog | DefaultDialog;
 /**
  * The result returned by the `snap_dialog` method.
  *
@@ -78,4 +84,4 @@ export declare type DialogParams = AlertDialog | ConfirmationDialog | PromptDial
  * - If the dialog is a `prompt`, the result is the value entered by
  * the user.
  */
-export declare type DialogResult = null | boolean | string;
+export declare type DialogResult = null | boolean | string | Json;

package/dist/types/types/methods/index.d.ts

@@ -17,3 +17,4 @@ export * from './methods';
 export * from './notify';
 export * from './request-snaps';
 export * from './update-interface';
+export * from './resolve-interface';

package/dist/types/types/methods/methods.d.ts

@@ -16,6 +16,7 @@ import type { ManageAccountsParams, ManageAccountsResult } from './manage-accoun
 import type { ManageStateParams, ManageStateResult } from './manage-state';
 import type { NotifyParams, NotifyResult } from './notify';
 import type { RequestSnapsParams, RequestSnapsResult } from './request-snaps';
+import type { ResolveInterfaceParams, ResolveInterfaceResult } from './resolve-interface';
 import type { UpdateInterfaceParams, UpdateInterfaceResult } from './update-interface';
 /**
  * The methods that are available to the Snap. Each method is a tuple of the
@@ -36,6 +37,7 @@ export declare type SnapMethods = {
     snap_createInterface: [CreateInterfaceParams, CreateInterfaceResult];
     snap_updateInterface: [UpdateInterfaceParams, UpdateInterfaceResult];
     snap_getInterfaceState: [GetInterfaceStateParams, GetInterfaceStateResult];
+    snap_resolveInterface: [ResolveInterfaceParams, ResolveInterfaceResult];
     wallet_getSnaps: [GetSnapsParams, GetSnapsResult];
     wallet_invokeKeyring: [InvokeKeyringParams, InvokeKeyringResult];
     wallet_invokeSnap: [InvokeSnapParams, InvokeSnapResult];

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

@@ -0,0 +1,15 @@
+import type { Json } from '@metamask/utils';
+/**
+ * The request parameters for the `snap_resolveInterface` method.
+ *
+ * @property id - The interface id.
+ * @property value - The value to resolve the interface with.
+ */
+export declare type ResolveInterfaceParams = {
+    id: string;
+    value: Json;
+};
+/**
+ * The result returned by the `snap_resolveInterface` method.
+ */
+export declare type ResolveInterfaceResult = null;

package/dist/types/ui/builder.d.ts

@@ -1,4 +1,4 @@
-import type { Struct } from 'superstruct';
+import type { Struct } from '@metamask/superstruct';
 import type { Component } from './components';
 import type { NodeType } from './nodes';
 /**

package/dist/types/ui/components/address.d.ts

@@ -1,11 +1,11 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import { NodeType } from '../nodes';
-export declare const AddressStruct: import("superstruct").Struct<{
+export declare const AddressStruct: import("@metamask/superstruct").Struct<{
     value: `0x${string}`;
     type: NodeType.Address;
 }, {
-    type: import("superstruct").Struct<NodeType.Address, NodeType.Address>;
-    value: import("superstruct").Struct<`0x${string}`, null>;
+    type: import("@metamask/superstruct").Struct<NodeType.Address, NodeType.Address>;
+    value: import("@metamask/superstruct").Struct<`0x${string}`, null>;
 }>;
 /**
  * A address node, that renders an EVM-like address and its icon.

package/dist/types/ui/components/button.d.ts

@@ -1,4 +1,4 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import { NodeType } from '../nodes';
 export declare enum ButtonVariant {
     Primary = "primary",
@@ -8,18 +8,18 @@ export declare enum ButtonType {
     Button = "button",
     Submit = "submit"
 }
-export declare const ButtonStruct: import("superstruct").Struct<{
+export declare const ButtonStruct: import("@metamask/superstruct").Struct<{
     value: string;
     type: NodeType.Button;
     name?: string | undefined;
     variant?: "primary" | "secondary" | undefined;
     buttonType?: "button" | "submit" | undefined;
 }, {
-    type: import("superstruct").Struct<NodeType.Button, NodeType.Button>;
-    value: import("superstruct").Struct<string, null>;
-    variant: import("superstruct").Struct<"primary" | "secondary" | undefined, null>;
-    buttonType: import("superstruct").Struct<"button" | "submit" | undefined, null>;
-    name: import("superstruct").Struct<string | undefined, null>;
+    type: import("@metamask/superstruct").Struct<NodeType.Button, NodeType.Button>;
+    value: import("@metamask/superstruct").Struct<string, null>;
+    variant: import("@metamask/superstruct").Struct<"primary" | "secondary" | undefined, null>;
+    buttonType: import("@metamask/superstruct").Struct<"button" | "submit" | undefined, null>;
+    name: import("@metamask/superstruct").Struct<string | undefined, null>;
 }>;
 /**
  * A button node, that renders either a primary or a secondary button.

package/dist/types/ui/components/copyable.d.ts

@@ -1,13 +1,13 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import { NodeType } from '../nodes';
-export declare const CopyableStruct: import("superstruct").Struct<{
+export declare const CopyableStruct: import("@metamask/superstruct").Struct<{
     value: string;
     type: NodeType.Copyable;
     sensitive?: boolean | undefined;
 }, {
-    type: import("superstruct").Struct<NodeType.Copyable, NodeType.Copyable>;
-    value: import("superstruct").Struct<string, null>;
-    sensitive: import("superstruct").Struct<boolean | undefined, null>;
+    type: import("@metamask/superstruct").Struct<NodeType.Copyable, NodeType.Copyable>;
+    value: import("@metamask/superstruct").Struct<string, null>;
+    sensitive: import("@metamask/superstruct").Struct<boolean | undefined, null>;
 }>;
 /**
  * Text that can be copied to the clipboard. It can optionally be marked as

package/dist/types/ui/components/divider.d.ts

@@ -1,9 +1,9 @@
-import type { Infer } from 'superstruct';
+import type { Infer } from '@metamask/superstruct';
 import { NodeType } from '../nodes';
-export declare const DividerStruct: import("superstruct").Struct<{
+export declare const DividerStruct: import("@metamask/superstruct").Struct<{
     type: NodeType.Divider;
 }, {
-    type: import("superstruct").Struct<NodeType.Divider, NodeType.Divider>;
+    type: import("@metamask/superstruct").Struct<NodeType.Divider, NodeType.Divider>;
 }>;
 /**
  * A divider node, that renders a line between other nodes.