@metamask/snaps-rpc-methods 8.0.0 → 9.0.0

package/dist/types/permitted/createInterface.d.ts

@@ -1,48 +1,16 @@
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { Component, CreateInterfaceParams, CreateInterfaceResult } from '@metamask/snaps-sdk';
+import type { CreateInterfaceParams, CreateInterfaceResult, ComponentOrElement } from '@metamask/snaps-sdk';
 import { type InferMatching } from '@metamask/snaps-utils';
 export declare type CreateInterfaceMethodHooks = {
     /**
      * @param ui - The UI components.
      * @returns The unique identifier of the interface.
      */
-    createInterface: (ui: Component) => Promise<string>;
+    createInterface: (ui: ComponentOrElement) => Promise<string>;
 };
 export declare const createInterfaceHandler: PermittedHandlerExport<CreateInterfaceMethodHooks, CreateInterfaceParameters, CreateInterfaceResult>;
 declare const CreateInterfaceParametersStruct: import("superstruct").Struct<{
-    ui: import("@metamask/snaps-sdk").Panel | {
-        type: import("@metamask/snaps-sdk").NodeType.Input;
-        name: string;
-        value?: string | undefined;
-        error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
-        label?: 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;
-            error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
-            placeholder?: string | undefined;
-            label?: string | undefined;
-        } | {
-            value: string;
-            type: import("@metamask/snaps-sdk").NodeType.Button;
-            name?: string | undefined;
-            variant?: "primary" | "secondary" | undefined;
-            buttonType?: "button" | "submit" | undefined;
-        })[];
-    } | {
+    ui: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -78,16 +46,14 @@ declare const CreateInterfaceParametersStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-}, {
-    ui: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -102,9 +68,9 @@ declare const CreateInterfaceParametersStruct: import("superstruct").Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -112,7 +78,9 @@ declare const CreateInterfaceParametersStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+}, {
+    ui: import("superstruct").Struct<import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -148,6 +116,38 @@ declare const CreateInterfaceParametersStruct: 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;
+        error?: string | undefined;
+        placeholder?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | 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;
+            error?: string | undefined;
+            placeholder?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>;
 }>;
 export declare type CreateInterfaceParameters = InferMatching<typeof CreateInterfaceParametersStruct, CreateInterfaceParams>;

package/dist/types/permitted/handlers.d.ts

@@ -2,7 +2,7 @@ export declare const methodHandlers: {
     wallet_getAllSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult>;
     wallet_getSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult>;
     wallet_requestSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult>;
-    wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
+    wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeSnapSugar").InvokeSnapSugarHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
     wallet_invokeKeyring: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
     snap_getClientStatus: import("@metamask/permission-controller").PermittedHandlerExport<import("./getClientStatus").GetClientStatusHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetClientStatusResult>;
     snap_getFile: import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string>;
@@ -10,4 +10,4 @@ export declare const methodHandlers: {
     snap_updateInterface: import("@metamask/permission-controller").PermittedHandlerExport<import("./updateInterface").UpdateInterfaceMethodHooks, import("@metamask/snaps-sdk").UpdateInterfaceParams, null>;
     snap_getInterfaceState: import("@metamask/permission-controller").PermittedHandlerExport<import("./getInterfaceState").GetInterfaceStateMethodHooks, import("@metamask/snaps-sdk").GetInterfaceStateParams, Record<string, string | Record<string, string | null> | null>>;
 };
-export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./createInterface").CreateInterfaceMethodHooks, import("@metamask/snaps-sdk").CreateInterfaceParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getClientStatus").GetClientStatusHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetClientStatusResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getInterfaceState").GetInterfaceStateMethodHooks, import("@metamask/snaps-sdk").GetInterfaceStateParams, Record<string, string | Record<string, string | null> | null>> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./updateInterface").UpdateInterfaceMethodHooks, import("@metamask/snaps-sdk").UpdateInterfaceParams, null> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];
+export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./createInterface").CreateInterfaceMethodHooks, import("@metamask/snaps-sdk").CreateInterfaceParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getClientStatus").GetClientStatusHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetClientStatusResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getInterfaceState").GetInterfaceStateMethodHooks, import("@metamask/snaps-sdk").GetInterfaceStateParams, Record<string, string | Record<string, string | null> | null>> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./updateInterface").UpdateInterfaceMethodHooks, import("@metamask/snaps-sdk").UpdateInterfaceParams, null> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeSnapSugar").InvokeSnapSugarHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];

package/dist/types/permitted/invokeSnapSugar.d.ts

@@ -1,24 +1,29 @@
 import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from '@metamask/json-rpc-engine';
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
 import type { InvokeSnapParams, InvokeSnapResult } from '@metamask/snaps-sdk';
-import type { JsonRpcRequest } from '@metamask/utils';
+import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';
 /**
  * `wallet_invokeSnap` attempts to invoke an RPC method of the specified Snap.
  */
-export declare const invokeSnapSugarHandler: PermittedHandlerExport<void, InvokeSnapParams, InvokeSnapResult>;
+export declare const invokeSnapSugarHandler: PermittedHandlerExport<InvokeSnapSugarHooks, InvokeSnapParams, InvokeSnapResult>;
+export declare type InvokeSnapSugarHooks = {
+    invokeSnap: (params: InvokeSnapParams) => Promise<InvokeSnapResult>;
+};
 /**
  * The `wallet_invokeSnap` method implementation.
- * Reroutes incoming JSON-RPC requests that are targeting snaps, by modifying the method and params.
+ * Effectively calls `wallet_snap` under the hood.
  *
  * @param req - The JSON-RPC request object.
- * @param _res - The JSON-RPC response object. Not used by this
- * function.
- * @param next - The `json-rpc-engine` "next" callback.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback.
  * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.invokeSnap - A function to invoke a snap designated by its parameters,
+ * bound to the requesting origin.
  * @returns Nothing.
  * @throws If the params are invalid.
  */
-export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapParams>, _res: unknown, next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback): void;
+export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapParams>, res: PendingJsonRpcResponse<InvokeSnapResult>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, { invokeSnap }: InvokeSnapSugarHooks): Promise<void>;
 /**
  * Validates the wallet_invokeSnap method `params` and returns them cast to the correct
  * type. Throws if validation fails.

package/dist/types/permitted/updateInterface.d.ts

@@ -1,49 +1,17 @@
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { Component, UpdateInterfaceParams, UpdateInterfaceResult } from '@metamask/snaps-sdk';
+import type { UpdateInterfaceParams, UpdateInterfaceResult, ComponentOrElement } from '@metamask/snaps-sdk';
 import { type InferMatching } from '@metamask/snaps-utils';
 export declare type UpdateInterfaceMethodHooks = {
     /**
      * @param id - The interface ID.
      * @param ui - The UI components.
      */
-    updateInterface: (id: string, ui: Component) => Promise<void>;
+    updateInterface: (id: string, ui: ComponentOrElement) => Promise<void>;
 };
 export declare const updateInterfaceHandler: PermittedHandlerExport<UpdateInterfaceMethodHooks, UpdateInterfaceParameters, UpdateInterfaceResult>;
 declare const UpdateInterfaceParametersStruct: import("superstruct").Struct<{
     id: string;
-    ui: import("@metamask/snaps-sdk").Panel | {
-        type: import("@metamask/snaps-sdk").NodeType.Input;
-        name: string;
-        value?: string | undefined;
-        error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
-        label?: 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;
-            error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
-            placeholder?: string | undefined;
-            label?: string | undefined;
-        } | {
-            value: string;
-            type: import("@metamask/snaps-sdk").NodeType.Button;
-            name?: string | undefined;
-            variant?: "primary" | "secondary" | undefined;
-            buttonType?: "button" | "submit" | undefined;
-        })[];
-    } | {
+    ui: import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -79,17 +47,14 @@ declare const UpdateInterfaceParametersStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    };
-}, {
-    id: import("superstruct").Struct<string, null>;
-    ui: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
         error?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
         label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -104,9 +69,9 @@ declare const UpdateInterfaceParametersStruct: import("superstruct").Struct<{
             name: string;
             value?: string | undefined;
             error?: string | undefined;
-            inputType?: "number" | "text" | "password" | undefined;
             placeholder?: string | undefined;
             label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
         } | {
             value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -114,7 +79,10 @@ declare const UpdateInterfaceParametersStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | {
+    };
+}, {
+    id: import("superstruct").Struct<string, null>;
+    ui: import("superstruct").Struct<import("@metamask/snaps-sdk/jsx-runtime").JSXElement | import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -150,6 +118,38 @@ declare const UpdateInterfaceParametersStruct: 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;
+        error?: string | undefined;
+        placeholder?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | 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;
+            error?: string | undefined;
+            placeholder?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
     }, null>;
 }>;
 export declare type UpdateInterfaceParameters = InferMatching<typeof UpdateInterfaceParametersStruct, UpdateInterfaceParams>;