@metamask/snaps-jest 6.0.1 → 7.0.0

package/dist/types/global.d.ts

@@ -0,0 +1,69 @@
+import type { Component, EnumToUnion, NotificationType } from '@metamask/snaps-sdk';
+interface SnapsMatchers {
+    /**
+     * Assert that the response is a JSON-RPC response with the given result. This
+     * is equivalent to calling `expect(response.result).toStrictEqual(result)`.
+     *
+     * @param response - The expected response result.
+     * @throws If the response is not a JSON-RPC response with the given result.
+     * @example
+     * const response = await request({ method: 'foo' });
+     * expect(response).toRespondWith('bar');
+     */
+    toRespondWith(response: unknown): void;
+    /**
+     * Assert that the response is a JSON-RPC response with the given error. This
+     * is equivalent to calling `expect(response.error).toStrictEqual(error)`.
+     *
+     * @param error - The expected response error.
+     * @throws If the response is not a JSON-RPC response with the given error.
+     * @example
+     * const response = await request({ method: 'foo' });
+     * expect(response).toRespondWithError({
+     *   code: -32601,
+     *   message: 'The method does not exist / is not available.',
+     *   stack: expect.any(String),
+     *   data: { method: 'foo', cause: null },
+     * });
+     */
+    toRespondWithError(error: unknown): void;
+    /**
+     * Assert that the Snap sent a notification with the expected message, and
+     * optionally the expected notification type. This is equivalent to calling
+     * `expect(response.notifications).toContainEqual({ message, type })`.
+     *
+     * @param message - The expected notification message.
+     * @param type - The expected notification type, i.e., 'inApp' or 'native'. If
+     * not provided, the type will be ignored.
+     * @throws If the snap did not send a notification with the expected message.
+     * @example
+     * const response = await request({ method: 'foo' });
+     * expect(response).toSendNotification('bar', NotificationType.InApp);
+     */
+    toSendNotification(message: string, type?: EnumToUnion<NotificationType>): void;
+    /**
+     * Assert that the Snap rendered the expected component. This is equivalent to
+     * calling `expect(interface.content).toStrictEqual(component)`.
+     *
+     * @param component - The expected rendered component.
+     * @throws If the snap did not render the expected component.
+     * @example
+     * const response = request({ method: 'foo' });
+     * const ui = await response.getInterface();
+     * expect(ui).toRender(panel([heading('Hello, world!')]));
+     */
+    toRender(component: Component): void;
+}
+declare module 'expect' {
+    interface AsymmetricMatchers extends SnapsMatchers {
+    }
+    interface Matchers<R> extends SnapsMatchers {
+    }
+}
+declare global {
+    namespace jest {
+        interface Matchers<R> extends SnapsMatchers {
+        }
+    }
+}
+export {};

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import './global';
 export { default, default as TestEnvironment } from './environment';
 export * from './helpers';
 export * from './options';

package/dist/types/internals/request.d.ts

@@ -1,7 +1,7 @@
 import type { AbstractExecutionService } from '@metamask/snaps-controllers';
-import type { SnapId, Component } from '@metamask/snaps-sdk';
+import type { SnapId } from '@metamask/snaps-sdk';
 import type { HandlerType } from '@metamask/snaps-utils';
-import type { RequestOptions, SnapRequest } from '../types';
+import type { RequestOptions, SnapHandlerInterface, SnapRequest } from '../types';
 import type { RunSagaFunction, Store } from './simulation';
 import type { RootControllerMessenger } from './simulation/controllers';
 export declare type HandleRequestOptions = {
@@ -35,11 +35,20 @@ export declare type HandleRequestOptions = {
  */
 export declare function handleRequest({ snapId, store, executionService, handler, controllerMessenger, runSaga, request: { id, origin, ...options }, }: HandleRequestOptions): SnapRequest;
 /**
- * Get the response content either from the SnapInterfaceController or the response object if there is one.
+ * Get the interface ID from the result if it's available or create a new interface if the result contains static components.
+ *
+ * @param result - The handler result object.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger.
+ * @returns The interface ID or undefined if the result doesn't include content.
+ */
+export declare function getInterfaceFromResult(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Promise<string | undefined>;
+/**
+ * Get the response content from the SnapInterfaceController and include the interaction methods.
  *
  * @param result - The handler result object.
  * @param snapId - The Snap ID.
  * @param controllerMessenger - The controller messenger.
  * @returns The content components if any.
  */
-export declare function getContentFromResult(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Component | undefined;
+export declare function getInterfaceApi(result: unknown, snapId: SnapId, controllerMessenger: RootControllerMessenger): Promise<(() => SnapHandlerInterface) | undefined>;

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

@@ -1,7 +1,7 @@
-import type { Component, SnapId } from '@metamask/snaps-sdk';
+import type { Button, Component, Input, InterfaceState, SnapId } from '@metamask/snaps-sdk';
 import { DialogType } from '@metamask/snaps-sdk';
-import type { SagaIterator } from 'redux-saga';
-import type { SnapInterface } from '../../types';
+import { type SagaIterator } from 'redux-saga';
+import type { SnapInterface, SnapInterfaceActions } from '../../types';
 import type { RootControllerMessenger } from './controllers';
 import type { RunSagaFunction } from './store';
 /**
@@ -10,9 +10,52 @@ import type { RunSagaFunction } from './store';
  * @param runSaga - A function to run a saga outside the usual Redux flow.
  * @param type - The type of the interface.
  * @param content - The content to show in the interface.
+ * @param interfaceActions - The actions to interact with the interface.
  * @returns The user interface object.
  */
-export declare function getInterfaceResponse(runSaga: RunSagaFunction, type: DialogType, content: Component): SnapInterface;
+export declare function getInterfaceResponse(runSaga: RunSagaFunction, type: DialogType, content: Component, interfaceActions: SnapInterfaceActions): SnapInterface;
+/**
+ * Get a Button or an Input from an interface.
+ *
+ * @param content - The interface content.
+ * @param name - The element name.
+ * @returns An object containing the element and the form name if it's contained in a form, otherwise undefined.
+ */
+export declare function getElement(content: Component, name: string): {
+    element: Button | Input;
+    form?: string;
+} | undefined;
+/**
+ * Click on an element of the Snap interface.
+ *
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @param id - The interface ID.
+ * @param content - The interface content.
+ * @param snapId - The Snap ID.
+ * @param name - The element name.
+ */
+export declare function clickElement(controllerMessenger: RootControllerMessenger, id: string, content: Component, snapId: SnapId, name: string): Promise<void>;
+/**
+ * Merge a value in the interface state.
+ *
+ * @param state - The actual interface state.
+ * @param name - The component name that changed value.
+ * @param value - The new value.
+ * @param form - The form name if the element is in one.
+ * @returns The state with the merged value.
+ */
+export declare function mergeValue(state: InterfaceState, name: string, value: string | null, form?: string): InterfaceState;
+/**
+ * Type a value in an interface element.
+ *
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @param id - The interface ID.
+ * @param content - The interface Components.
+ * @param snapId - The Snap ID.
+ * @param name - The element name.
+ * @param value - The value to type in the element.
+ */
+export declare function typeInField(controllerMessenger: RootControllerMessenger, id: string, content: Component, snapId: SnapId, name: string, value: string): Promise<void>;
 /**
  * Get a user interface object from a Snap.
  *

package/dist/types/internals/simulation/methods/hooks/index.d.ts

@@ -1,4 +1,3 @@
-export * from './encryption';
 export * from './get-locale';
 export * from './notifications';
 export * from './show-dialog';

package/dist/types/internals/simulation/methods/hooks/state.d.ts

@@ -1,3 +1,4 @@
+import type { Json } from '@metamask/utils';
 import type { RunSagaFunction } from '../../store';
 /**
  * Get the implementation of the `getSnapState` hook.
@@ -12,7 +13,7 @@ export declare function getGetSnapStateMethodImplementation(runSaga: RunSagaFunc
  * @param runSaga - The function to run a saga outside the usual Redux flow.
  * @returns The implementation of the `updateSnapState` hook.
  */
-export declare function getUpdateSnapStateMethodImplementation(runSaga: RunSagaFunction): (_snapId: string, newState: string, encrypted?: boolean | undefined) => void;
+export declare function getUpdateSnapStateMethodImplementation(runSaga: RunSagaFunction): (_snapId: string, newState: Record<string, Json>, encrypted?: boolean | undefined) => void;
 /**
  * Get the implementation of the `clearSnapState` hook.
  *

package/dist/types/internals/simulation/store/store.d.ts

@@ -2,13 +2,12 @@ import type { SimulationOptions } from '../options';
 /**
  * Create a Redux store.
  *
- * @param password - The password to use for state encryption.
  * @param options - The simulation options.
  * @param options.state - The initial state for the Snap.
  * @param options.unencryptedState - The initial unencrypted state for the Snap.
  * @returns A Redux store with the default state.
  */
-export declare function createStore(password: string, { state, unencryptedState }: SimulationOptions): {
+export declare function createStore({ state, unencryptedState }: SimulationOptions): {
     store: import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<{
         mocks: import("./mocks").MocksState;
         notifications: import("./notifications").NotificationsState;

package/dist/types/internals/structs.d.ts

@@ -105,48 +105,13 @@ export declare const JsonRpcMockOptionsStruct: import("superstruct").Struct<{
 }>;
 export declare const InterfaceStruct: 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;
+        error?: string | undefined;
         inputType?: "number" | "text" | "password" | undefined;
         placeholder?: string | undefined;
+        label?: string | undefined;
     } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
@@ -160,9 +125,10 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
             value?: string | undefined;
-            label?: 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;
@@ -170,9 +136,7 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | undefined;
-}, {
-    content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+    } | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -191,7 +155,7 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
     } | {
-        value: string;
+        value: `0x${string}`;
         type: import("@metamask/snaps-sdk").NodeType.Address;
     } | {
         value: {
@@ -202,19 +166,22 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
             type: import("@metamask/snaps-sdk").NodeType.Text;
             markdown?: boolean | undefined;
         } | {
-            value: string;
+            value: `0x${string}`;
             type: import("@metamask/snaps-sdk").NodeType.Address;
         };
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
-    } | {
+    } | undefined;
+}, {
+    content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
         value?: string | undefined;
-        label?: 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;
@@ -228,9 +195,10 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
             value?: string | undefined;
-            label?: 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;
@@ -238,21 +206,7 @@ export declare const InterfaceStruct: import("superstruct").Struct<{
             variant?: "primary" | "secondary" | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
-    } | undefined, null>;
-}>;
-export declare const SnapResponseStruct: import("superstruct").Struct<{
-    response: {
-        result: import("@metamask/snaps-sdk").Json;
     } | {
-        error: import("@metamask/snaps-sdk").Json;
-    };
-    id: string;
-    notifications: {
-        message: string;
-        type: "native" | "inApp";
-        id: string;
-    }[];
-    content?: import("@metamask/snaps-sdk").Panel | {
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
         sensitive?: boolean | undefined;
@@ -271,7 +225,7 @@ export declare const SnapResponseStruct: import("superstruct").Struct<{
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
     } | {
-        value: string;
+        value: `0x${string}`;
         type: import("@metamask/snaps-sdk").NodeType.Address;
     } | {
         value: {
@@ -282,43 +236,26 @@ export declare const SnapResponseStruct: import("superstruct").Struct<{
             type: import("@metamask/snaps-sdk").NodeType.Text;
             markdown?: boolean | undefined;
         } | {
-            value: string;
+            value: `0x${string}`;
             type: import("@metamask/snaps-sdk").NodeType.Address;
         };
         type: import("@metamask/snaps-sdk").NodeType.Row;
         label: string;
         variant?: "default" | "warning" | "critical" | undefined;
+    } | undefined, null>;
+}>;
+export declare const SnapResponseWithoutInterfaceStruct: import("superstruct").Struct<{
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
     } | {
-        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;
-        })[];
-    } | undefined;
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    id: string;
+    notifications: {
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }[];
 }, {
     id: import("superstruct").Struct<string, null>;
     response: import("superstruct").Struct<{
@@ -339,71 +276,65 @@ export declare const SnapResponseStruct: import("superstruct").Struct<{
         message: import("superstruct").Struct<string, null>;
         type: import("superstruct").Struct<"native" | "inApp", null>;
     }>>;
-    content: import("superstruct").Struct<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;
+}>;
+export declare const SnapResponseWithInterfaceStruct: import("superstruct").Struct<{
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
     } | {
-        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;
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    id: string;
+    getInterface: Function;
+    notifications: {
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }[];
+}, {
+    getInterface: import("superstruct").Struct<Function, null>;
+    response: import("superstruct").Struct<{
+        result: import("@metamask/snaps-sdk").Json;
     } | {
-        type: import("@metamask/snaps-sdk").NodeType.Input;
-        name: string;
-        value?: string | undefined;
-        label?: string | undefined;
-        inputType?: "number" | "text" | "password" | undefined;
-        placeholder?: string | undefined;
+        error: import("@metamask/snaps-sdk").Json;
+    }, null>;
+    id: import("superstruct").Struct<string, null>;
+    notifications: import("superstruct").Struct<{
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }[], import("superstruct").Struct<{
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }, {
+        id: import("superstruct").Struct<string, null>;
+        message: import("superstruct").Struct<string, null>;
+        type: import("superstruct").Struct<"native" | "inApp", null>;
+    }>>;
+}>;
+export declare const SnapResponseStruct: import("superstruct").Struct<{
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
     } | {
-        value: string;
-        type: import("@metamask/snaps-sdk").NodeType.Button;
-        name?: string | undefined;
-        variant?: "primary" | "secondary" | undefined;
-        buttonType?: "button" | "submit" | undefined;
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    id: string;
+    notifications: {
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }[];
+} | {
+    response: {
+        result: import("@metamask/snaps-sdk").Json;
     } | {
-        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;
-        })[];
-    } | undefined, null>;
-}>;
+        error: import("@metamask/snaps-sdk").Json;
+    };
+    id: string;
+    getInterface: Function;
+    notifications: {
+        message: string;
+        type: "native" | "inApp";
+        id: string;
+    }[];
+}, null>;

package/dist/types/types.d.ts

@@ -1,21 +1,8 @@
-import type { NotificationType, EnumToUnion, Component } from '@metamask/snaps-sdk';
+import type { Component, NotificationType, EnumToUnion } from '@metamask/snaps-sdk';
+import type { InferMatching } from '@metamask/snaps-utils';
 import type { Json, JsonRpcId, JsonRpcParams } from '@metamask/utils';
 import type { Infer } from 'superstruct';
 import type { SignatureOptionsStruct, SnapOptionsStruct, SnapResponseStruct, TransactionOptionsStruct } from './internals';
-declare module 'expect' {
-    interface AsymmetricMatchers {
-        toRespondWith(response: unknown): void;
-        toRespondWithError(error: unknown): void;
-        toSendNotification(message: string, type?: EnumToUnion<NotificationType>): void;
-        toRender(component: Component): void;
-    }
-    interface Matchers<R> {
-        toRespondWith(response: unknown): R;
-        toRespondWithError(error: unknown): R;
-        toSendNotification(message: string, type?: EnumToUnion<NotificationType>): R;
-        toRender(component: Component): R;
-    }
-}
 export declare type RequestOptions = {
     /**
      * The JSON-RPC request ID.
@@ -78,6 +65,21 @@ export declare type SignatureOptions = Infer<typeof SignatureOptionsStruct>;
  * @property timeout - The timeout in milliseconds to use. Defaults to `1000`.
  */
 export declare type SnapOptions = Infer<typeof SnapOptionsStruct>;
+export declare type SnapInterfaceActions = {
+    /**
+     * Click on an interface element.
+     *
+     * @param name - The element name to click.
+     */
+    clickElement(name: string): Promise<void>;
+    /**
+     * Type a value in a interface field.
+     *
+     * @param name - The element name to type in.
+     * @param value - The value to type.
+     */
+    typeInField(name: string, value: string): Promise<void>;
+};
 /**
  * A `snap_dialog` alert interface.
  */
@@ -139,7 +141,7 @@ export declare type SnapPromptInterface = {
      */
     cancel(): Promise<void>;
 };
-export declare type SnapInterface = SnapAlertInterface | SnapConfirmationInterface | SnapPromptInterface;
+export declare type SnapInterface = (SnapAlertInterface | SnapConfirmationInterface | SnapPromptInterface) & SnapInterfaceActions;
 export declare type SnapRequestObject = {
     /**
      * Get a user interface object from a snap. This will throw an error if the
@@ -200,7 +202,7 @@ export declare type Snap = {
      * will be filled in with default values.
      * @returns The response.
      */
-    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponse>;
+    onTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
     /**
      * Send a transaction to the snap.
      *
@@ -210,7 +212,7 @@ export declare type Snap = {
      * @returns The response.
      * @deprecated Use {@link onTransaction} instead.
      */
-    sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponse>;
+    sendTransaction(transaction?: Partial<TransactionOptions>): Promise<SnapResponseWithInterface>;
     /**
      * Send a signature request to the snap.
      *
@@ -219,7 +221,7 @@ export declare type Snap = {
      * Any missing fields will be filled in with default values.
      * @returns The response.
      */
-    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponse>;
+    onSignature(signature?: Partial<SignatureOptions>): Promise<SnapResponseWithInterface>;
     /**
      * Run a cronjob in the snap. This is similar to {@link request}, but the
      * request will be sent to the `onCronjob` method of the snap.
@@ -246,7 +248,7 @@ export declare type Snap = {
      *
      * @returns The response.
      */
-    onHomePage(): Promise<SnapResponse>;
+    onHomePage(): Promise<SnapResponseWithInterface>;
     /**
      * Mock a JSON-RPC request. This will cause the snap to respond with the
      * specified response when a request with the specified method is sent.
@@ -282,4 +284,23 @@ export declare type Snap = {
      */
     close(): Promise<void>;
 };
-export declare type SnapResponse = Infer<typeof SnapResponseStruct>;
+export declare type SnapHandlerInterface = {
+    content: Component;
+} & SnapInterfaceActions;
+export declare type SnapResponseWithInterface = {
+    id: string;
+    response: {
+        result: Json;
+    } | {
+        error: Json;
+    };
+    notifications: {
+        id: string;
+        message: string;
+        type: EnumToUnion<NotificationType>;
+    }[];
+    getInterface(): SnapHandlerInterface;
+};
+export declare type SnapResponseWithoutInterface = Omit<SnapResponseWithInterface, 'getInterface'>;
+export declare type SnapResponseType = SnapResponseWithoutInterface | SnapResponseWithInterface;
+export declare type SnapResponse = InferMatching<typeof SnapResponseStruct, SnapResponseType>;