@metamask/snaps-jest 8.3.0 → 8.3.1

package/dist/internals/simulation/interface.d.mts

@@ -0,0 +1,152 @@
+import type { DialogApprovalTypes } from "@metamask/snaps-rpc-methods";
+import type { InterfaceState, SnapId, File } from "@metamask/snaps-sdk";
+import { DialogType } from "@metamask/snaps-sdk";
+import { type JSXElement } from "@metamask/snaps-sdk/jsx";
+import { type SagaIterator } from "redux-saga";
+import type { FileOptions, SnapInterface, SnapInterfaceActions } from "../../types/index.mjs";
+import type { RootControllerMessenger } from "./controllers.mjs";
+import type { Interface, RunSagaFunction } from "./store/index.mjs";
+/**
+ * Get a user interface object from a type and content object.
+ *
+ * @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: DialogApprovalTypes[DialogType | 'default'], content: JSXElement, interfaceActions: SnapInterfaceActions): SnapInterface;
+/**
+ * Resolve the current user interface with the given value.
+ *
+ * @param value - The value to resolve the user interface with.
+ * @yields Puts the resolve user interface action.
+ */
+export declare function resolveWithSaga(value: unknown): SagaIterator;
+/**
+ * A JSX element with a name.
+ */
+export type NamedJSXElement = JSXElement & {
+    props: {
+        name: string;
+    };
+};
+/**
+ * Get an element from a JSX tree with the given name.
+ *
+ * @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: JSXElement, name: string): {
+    element: NamedJSXElement;
+    form?: string;
+} | undefined;
+/**
+ * Get an element from a JSX tree with the given type.
+ *
+ * @param content - The interface content.
+ * @param type - The element type.
+ * @returns The element with the given type.
+ */
+export declare function getElementByType<Element extends JSXElement>(content: JSXElement, type: string): Element | 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: JSXElement, 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 | File | boolean | 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: JSXElement, snapId: SnapId, name: string, value: string): Promise<void>;
+/**
+ * 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 selectInDropdown(controllerMessenger: RootControllerMessenger, id: string, content: JSXElement, snapId: SnapId, name: string, value: string): Promise<void>;
+/**
+ * Choose an option with value from radio group 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 selectFromRadioGroup(controllerMessenger: RootControllerMessenger, id: string, content: JSXElement, snapId: SnapId, name: string, value: string): Promise<void>;
+/**
+ * Upload a file to 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 file - The file to upload. This can be a path to a file or a
+ * `Uint8Array` containing the file contents. If this is a path, the file is
+ * resolved relative to the current working directory.
+ * @param options - The file options.
+ * @param options.fileName - The name of the file. By default, this is
+ * inferred from the file path if it's a path, and defaults to an empty string
+ * if it's a `Uint8Array`.
+ * @param options.contentType - The content type of the file. By default, this
+ * is inferred from the file name if it's a path, and defaults to
+ * `application/octet-stream` if it's a `Uint8Array` or the content type
+ * cannot be inferred from the file name.
+ */
+export declare function uploadFile(controllerMessenger: RootControllerMessenger, id: string, content: JSXElement, snapId: SnapId, name: string, file: string | Uint8Array, options?: FileOptions): Promise<void>;
+/**
+ * Get the user interface actions for a Snap interface. These actions can be
+ * used to interact with the interface.
+ *
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @param interface - The interface object.
+ * @param interface.content - The interface content.
+ * @param interface.id - The interface ID.
+ * @returns The user interface actions.
+ */
+export declare function getInterfaceActions(snapId: SnapId, controllerMessenger: RootControllerMessenger, { content, id }: Omit<Interface, 'type'> & {
+    content: JSXElement;
+}): SnapInterfaceActions;
+/**
+ * Get a user interface object from a Snap.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @param snapId - The Snap ID.
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @yields Takes the set interface action.
+ * @returns The user interface object.
+ */
+export declare function getInterface(runSaga: RunSagaFunction, snapId: SnapId, controllerMessenger: RootControllerMessenger): SagaIterator;
+//# sourceMappingURL=interface.d.mts.map

package/dist/internals/simulation/interface.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.mts","sourceRoot":"","sources":["../../../src/internals/simulation/interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AAEvE,OAAO,KAAK,EAGV,cAAc,EACd,MAAM,EAEN,IAAI,EACL,4BAA4B;AAC7B,OAAO,EAAE,UAAU,EAA8B,4BAA4B;AAE7E,OAAO,EAAoB,KAAK,UAAU,EAAE,gCAAgC;AAS5E,OAAO,EAAE,KAAK,YAAY,EAAE,mBAAmB;AAG/C,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,oBAAoB,EACrB,8BAAoB;AACrB,OAAO,KAAK,EAAE,uBAAuB,EAAE,0BAAsB;AAE7D,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,0BAAgB;AAQ1D;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,eAAe,EACxB,IAAI,EAAE,mBAAmB,CAAC,UAAU,GAAG,SAAS,CAAC,EACjD,OAAO,EAAE,UAAU,EACnB,gBAAgB,EAAE,oBAAoB,GACrC,aAAa,CAgEf;AAED;;;;;GAKG;AACH,wBAAiB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAE7D;AA+DD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG;IAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAyCvE;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,GAEV;IACE,OAAO,EAAE,eAAe,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GACD,SAAS,CAgBZ;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,UAAU,EACzD,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,uBASb;AA0CD;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAChC,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CAkFf;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,IAAI,EACrC,IAAI,CAAC,EAAE,MAAM,GACZ,cAAc,CAYhB;AAED;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAC/B,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,iBA6Cd;AAED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CACpC,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,iBAwDd;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,iBAwDd;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,UAAU,CAC9B,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,WAAW,iBAyDtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,EAC5C,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG;IAAE,OAAO,EAAE,UAAU,CAAA;CAAE,GACjE,oBAAoB,CAgDtB;AAED;;;;;;;;GAQG;AACH,wBAAiB,YAAY,CAC3B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,uBAAuB,GAC3C,YAAY,CAmBd"}