@metamask/snaps-utils 5.2.0 → 6.1.0

package/dist/types/handlers.d.ts

@@ -1,4 +1,4 @@
-import type { OnCronjobHandler, OnHomePageHandler, OnKeyringRequestHandler, OnNameLookupHandler, OnRpcRequestHandler, OnSignatureHandler, OnTransactionHandler } from '@metamask/snaps-sdk';
+import type { OnCronjobHandler, OnHomePageHandler, OnKeyringRequestHandler, OnNameLookupHandler, OnRpcRequestHandler, OnSignatureHandler, OnTransactionHandler, OnUserInputHandler } from '@metamask/snaps-sdk';
 import { SeverityLevel } from '@metamask/snaps-sdk';
 import type { SnapHandler } from './handler-types';
 import { HandlerType } from './handler-types';
@@ -53,8 +53,25 @@ export declare const SNAP_EXPORTS: {
         readonly required: true;
         readonly validator: (snapExport: unknown) => snapExport is OnSignatureHandler;
     };
+    readonly onUserInput: {
+        readonly type: HandlerType.OnUserInput;
+        readonly required: true;
+        readonly validator: (snapExport: unknown) => snapExport is OnUserInputHandler;
+    };
 };
-export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
+export declare const OnTransactionSeverityResponseStruct: import("superstruct").Struct<{
+    severity?: SeverityLevel | undefined;
+}, {
+    severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
+}>;
+export declare const OnTransactionResponseWithIdStruct: import("superstruct").Struct<{
+    id: string;
+    severity?: SeverityLevel | undefined;
+}, {
+    id: import("superstruct").Struct<string, null>;
+    severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
+}>;
+export declare const OnTransactionResponseWithContentStruct: import("superstruct").Struct<{
     content: import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
@@ -91,9 +108,39 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     };
     severity?: SeverityLevel | undefined;
-} | null, {
+}, {
     content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
@@ -130,10 +177,43 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>;
     severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
 }>;
-export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
+export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
+    id: string;
+    severity?: SeverityLevel | undefined;
+} | {
     content: import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
@@ -170,10 +250,44 @@ export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     };
     severity?: SeverityLevel | undefined;
-} | null, {
-    content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+} | null, null>;
+export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
+    id: string;
+    severity?: SeverityLevel | undefined;
+} | {
+    content: import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -209,10 +323,40 @@ export declare const OnSignatureResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    }, null>;
-    severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
-}>;
-export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    };
+    severity?: SeverityLevel | undefined;
+} | null, null>;
+export declare const OnHomePageResponseWithContentStruct: import("superstruct").Struct<{
     content: import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
@@ -249,6 +393,36 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     };
 }, {
     content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
@@ -287,8 +461,173 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>;
 }>;
+export declare const OnHomePageResponseWithIdStruct: import("superstruct").Struct<{
+    id: string;
+}, {
+    id: import("superstruct").Struct<string, null>;
+}>;
+export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
+    content: import("@metamask/snaps-sdk").Panel | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    };
+} | {
+    id: string;
+}, null>;
+export declare const AddressResolutionStruct: import("superstruct").Struct<{
+    protocol: string;
+    resolvedDomain: string;
+}, {
+    protocol: import("superstruct").Struct<string, null>;
+    resolvedDomain: import("superstruct").Struct<string, null>;
+}>;
+export declare const DomainResolutionStruct: import("superstruct").Struct<{
+    protocol: string;
+    resolvedAddress: string;
+}, {
+    protocol: import("superstruct").Struct<string, null>;
+    resolvedAddress: import("superstruct").Struct<string, null>;
+}>;
+export declare const AddressResolutionResponseStruct: import("superstruct").Struct<{
+    resolvedDomains: {
+        protocol: string;
+        resolvedDomain: string;
+    }[];
+}, {
+    resolvedDomains: import("superstruct").Struct<{
+        protocol: string;
+        resolvedDomain: string;
+    }[], import("superstruct").Struct<{
+        protocol: string;
+        resolvedDomain: string;
+    }, {
+        protocol: import("superstruct").Struct<string, null>;
+        resolvedDomain: import("superstruct").Struct<string, null>;
+    }>>;
+}>;
+export declare const DomainResolutionResponseStruct: import("superstruct").Struct<{
+    resolvedAddresses: {
+        protocol: string;
+        resolvedAddress: string;
+    }[];
+}, {
+    resolvedAddresses: import("superstruct").Struct<{
+        protocol: string;
+        resolvedAddress: string;
+    }[], import("superstruct").Struct<{
+        protocol: string;
+        resolvedAddress: string;
+    }, {
+        protocol: import("superstruct").Struct<string, null>;
+        resolvedAddress: import("superstruct").Struct<string, null>;
+    }>>;
+}>;
+export declare const OnNameLookupResponseStruct: import("superstruct").Struct<{
+    resolvedDomains: {
+        protocol: string;
+        resolvedDomain: string;
+    }[];
+} | {
+    resolvedAddresses: {
+        protocol: string;
+        resolvedAddress: string;
+    }[];
+} | null, null>;
 /**
  * Utility type for getting the handler function type from a handler type.
  */

package/dist/types/icon.d.ts

@@ -1,4 +1,19 @@
 import type { VirtualFile } from './virtual-file';
 export declare const SVG_MAX_BYTE_SIZE = 100000;
 export declare const SVG_MAX_BYTE_SIZE_TEXT: string;
-export declare const assertIsSnapIcon: (icon: VirtualFile) => void;
+/**
+ * Assert that a virtual file containing a Snap icon is valid.
+ *
+ * @param icon - A virtual file containing a Snap icon.
+ */
+export declare function assertIsSnapIcon(icon: VirtualFile): void;
+/**
+ * Extract the dimensions of an image from an SVG string if possible.
+ *
+ * @param svg - An SVG string.
+ * @returns The height and width of the SVG or null.
+ */
+export declare function getSvgDimensions(svg: string): {
+    height: number;
+    width: number;
+} | null;

package/dist/types/localization.d.ts

@@ -100,15 +100,6 @@ export declare function getLocalizedSnapManifest(snapManifest: SnapManifest, loc
         wallet_snap?: Record<string, {
             version?: string | undefined;
         }> | undefined;
-        'endowment:ethereum-provider'?: {} | undefined;
-        'endowment:network-access'?: {} | undefined;
-        'endowment:webassembly'?: {} | undefined;
-        'endowment:signature-insight'?: {
-            allowSignatureOrigin?: boolean | undefined;
-        } | undefined;
-        'endowment:transaction-insight'?: {
-            allowTransactionOrigin?: boolean | undefined;
-        } | undefined;
         'endowment:cronjob'?: {
             jobs: {
                 request: {
@@ -119,17 +110,46 @@ export declare function getLocalizedSnapManifest(snapManifest: SnapManifest, loc
                 };
                 expression: string;
             }[];
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:ethereum-provider'?: {} | undefined;
+        'endowment:keyring'?: {
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:lifecycle-hooks'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:name-lookup'?: {
+            chains?: `${string}:${string}`[] | undefined;
+            maxRequestTime?: number | undefined;
+            matchers?: {
+                tlds: string[];
+            } | {
+                schemes: string[];
+            } | {
+                tlds: string[];
+                schemes: string[];
+            } | undefined;
+        } | undefined;
+        'endowment:network-access'?: {} | undefined;
+        'endowment:page-home'?: {
+            maxRequestTime?: number | undefined;
         } | undefined;
         'endowment:rpc'?: {
             dapps?: boolean | undefined;
             snaps?: boolean | undefined;
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
-        'endowment:keyring'?: {
-            allowedOrigins?: string[] | undefined;
+        'endowment:signature-insight'?: {
+            maxRequestTime?: number | undefined;
+            allowSignatureOrigin?: boolean | undefined;
+        } | undefined;
+        'endowment:transaction-insight'?: {
+            maxRequestTime?: number | undefined;
+            allowTransactionOrigin?: boolean | undefined;
         } | undefined;
-        snap_confirm?: {} | undefined;
+        'endowment:webassembly'?: {} | undefined;
     };
     manifestVersion: "0.1";
     repository?: {