@metamask/snaps-controllers 9.5.0 → 9.7.0

package/dist/interface/SnapInterfaceController.d.mts

@@ -0,0 +1,107 @@
+import type { AcceptRequest, HasApprovalRequest } from "@metamask/approval-controller";
+import type { RestrictedControllerMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { MaybeUpdateState, TestOrigin } from "@metamask/phishing-controller";
+import type { InterfaceState, SnapId, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import type { JSXElement } from "@metamask/snaps-sdk/jsx";
+import type { Json } from "@metamask/utils";
+declare const controllerName = "SnapInterfaceController";
+export type CreateInterface = {
+    type: `${typeof controllerName}:createInterface`;
+    handler: SnapInterfaceController['createInterface'];
+};
+export type GetInterface = {
+    type: `${typeof controllerName}:getInterface`;
+    handler: SnapInterfaceController['getInterface'];
+};
+export type UpdateInterface = {
+    type: `${typeof controllerName}:updateInterface`;
+    handler: SnapInterfaceController['updateInterface'];
+};
+export type DeleteInterface = {
+    type: `${typeof controllerName}:deleteInterface`;
+    handler: SnapInterfaceController['deleteInterface'];
+};
+export type UpdateInterfaceState = {
+    type: `${typeof controllerName}:updateInterfaceState`;
+    handler: SnapInterfaceController['updateInterfaceState'];
+};
+export type ResolveInterface = {
+    type: `${typeof controllerName}:resolveInterface`;
+    handler: SnapInterfaceController['resolveInterface'];
+};
+export type SnapInterfaceControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SnapInterfaceControllerState>;
+export type SnapInterfaceControllerAllowedActions = TestOrigin | MaybeUpdateState | HasApprovalRequest | AcceptRequest;
+export type SnapInterfaceControllerActions = CreateInterface | GetInterface | UpdateInterface | DeleteInterface | UpdateInterfaceState | ResolveInterface | SnapInterfaceControllerGetStateAction;
+export type SnapInterfaceControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SnapInterfaceControllerState>;
+export type SnapInterfaceControllerEvents = SnapInterfaceControllerStateChangeEvent;
+export type SnapInterfaceControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions, SnapInterfaceControllerEvents, SnapInterfaceControllerAllowedActions['type'], SnapInterfaceControllerEvents['type']>;
+export type StoredInterface = {
+    snapId: SnapId;
+    content: JSXElement;
+    state: InterfaceState;
+    context: InterfaceContext | null;
+};
+export type SnapInterfaceControllerState = {
+    interfaces: Record<string, StoredInterface>;
+};
+export type SnapInterfaceControllerArgs = {
+    messenger: SnapInterfaceControllerMessenger;
+    state?: SnapInterfaceControllerState;
+};
+/**
+ * Use this controller to manage snaps UI interfaces using RPC method hooks.
+ */
+export declare class SnapInterfaceController extends BaseController<typeof controllerName, SnapInterfaceControllerState, SnapInterfaceControllerMessenger> {
+    #private;
+    constructor({ messenger, state }: SnapInterfaceControllerArgs);
+    /**
+     * Create an interface in the controller state with the associated data.
+     *
+     * @param snapId - The snap id that created the interface.
+     * @param content - The interface content.
+     * @param context - An optional interface context object.
+     * @returns The newly interface id.
+     */
+    createInterface(snapId: SnapId, content: ComponentOrElement, context?: InterfaceContext): Promise<string>;
+    /**
+     * Get the data of a given interface id.
+     *
+     * @param snapId - The snap id requesting the interface data.
+     * @param id - The interface id.
+     * @returns The interface state.
+     */
+    getInterface(snapId: SnapId, id: string): StoredInterface;
+    /**
+     * Update the interface with the given content.
+     *
+     * @param snapId - The snap id requesting the update.
+     * @param id - The interface id.
+     * @param content - The new content.
+     */
+    updateInterface(snapId: SnapId, id: string, content: ComponentOrElement): Promise<void>;
+    /**
+     * Delete an interface from state.
+     *
+     * @param id - The interface id.
+     */
+    deleteInterface(id: string): void;
+    /**
+     * Update the interface state.
+     *
+     * @param id - The interface id.
+     * @param state - The new state.
+     */
+    updateInterfaceState(id: string, state: InterfaceState): void;
+    /**
+     * Resolve the promise of a given interface approval request.
+     * The approval needs to have the same ID as the interface.
+     *
+     * @param snapId - The snap id.
+     * @param id - The interface id.
+     * @param value - The value to resolve the promise with.
+     */
+    resolveInterface(snapId: SnapId, id: string, value: Json): Promise<void>;
+}
+export {};
+//# sourceMappingURL=SnapInterfaceController.d.mts.map

package/dist/interface/SnapInterfaceController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SnapInterfaceController.d.mts","sourceRoot":"","sources":["../../src/interface/SnapInterfaceController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EACnB,sCAAsC;AACvC,OAAO,KAAK,EACV,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,gBAAgB,EAChB,UAAU,EACX,sCAAsC;AACvC,OAAO,KAAK,EACV,cAAc,EACd,MAAM,EACN,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,gCAAgC;AAE1D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAa5C,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,kBAAkB,CAAC;IACjD,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,GAAG,OAAO,cAAc,eAAe,CAAC;IAC9C,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,kBAAkB,CAAC;IACjD,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,kBAAkB,CAAC;IACjD,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,GAAG,OAAO,cAAc,uBAAuB,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,sBAAsB,CAAC,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,GAAG,OAAO,cAAc,mBAAmB,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAC7C,UAAU,GACV,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,CAAC;AAElB,MAAM,MAAM,8BAA8B,GACtC,eAAe,GACf,YAAY,GACZ,eAAe,GACf,eAAe,GACf,oBAAoB,GACpB,gBAAgB,GAChB,qCAAqC,CAAC;AAE1C,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,4BAA4B,CAC7B,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,gCAAgC,GAAG,6BAA6B,CAC1E,OAAO,cAAc,EACrB,8BAA8B,GAAG,qCAAqC,EACtE,6BAA6B,EAC7B,qCAAqC,CAAC,MAAM,CAAC,EAC7C,6BAA6B,CAAC,MAAM,CAAC,CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,UAAU,CAAC;IACpB,KAAK,EAAE,cAAc,CAAC;IACtB,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,4BAA4B,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,cAAc,CACzD,OAAO,cAAc,EACrB,4BAA4B,EAC5B,gCAAgC,CACjC;;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,2BAA2B;IAiD7D;;;;;;;OAOG;IACG,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,gBAAgB;IAuB5B;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAMvC;;;;;;OAMG;IACG,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,kBAAkB;IAe7B;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM;IAM1B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc;IAMtD;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI;CAuG/D"}

package/dist/interface/SnapInterfaceController.mjs

@@ -1,9 +1,172 @@
-import {
-  SnapInterfaceController
-} from "../chunk-Z5QWRDUN.mjs";
-import "../chunk-HULNFJMA.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  SnapInterfaceController
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SnapInterfaceController_instances, _SnapInterfaceController_registerMessageHandlers, _SnapInterfaceController_validateArgs, _SnapInterfaceController_validateApproval, _SnapInterfaceController_triggerPhishingListUpdate, _SnapInterfaceController_checkPhishingList, _SnapInterfaceController_hasApprovalRequest, _SnapInterfaceController_acceptApprovalRequest, _SnapInterfaceController_validateContent;
+import { BaseController } from "@metamask/base-controller";
+import { getJsonSizeUnsafe, validateJsxLinks } from "@metamask/snaps-utils";
+import { assert } from "@metamask/utils";
+import { castDraft } from "immer";
+import { nanoid } from "nanoid";
+import { constructState, getJsxInterface, validateInterfaceContext } from "./utils.mjs";
+const MAX_UI_CONTENT_SIZE = 10000000; // 10 mb
+const controllerName = 'SnapInterfaceController';
+/**
+ * Use this controller to manage snaps UI interfaces using RPC method hooks.
+ */
+export class SnapInterfaceController extends BaseController {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: {
+                interfaces: { persist: false, anonymous: false },
+            },
+            name: controllerName,
+            state: { interfaces: {}, ...state },
+        });
+        _SnapInterfaceController_instances.add(this);
+        __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_registerMessageHandlers).call(this);
+    }
+    /**
+     * Create an interface in the controller state with the associated data.
+     *
+     * @param snapId - The snap id that created the interface.
+     * @param content - The interface content.
+     * @param context - An optional interface context object.
+     * @returns The newly interface id.
+     */
+    async createInterface(snapId, content, context) {
+        const element = getJsxInterface(content);
+        await __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateContent).call(this, element);
+        validateInterfaceContext(context);
+        const id = nanoid();
+        const componentState = constructState({}, element);
+        this.update((draftState) => {
+            // @ts-expect-error - TS2589: Type instantiation is excessively deep and
+            // possibly infinite.
+            draftState.interfaces[id] = {
+                snapId,
+                content: castDraft(element),
+                state: componentState,
+                context: context ?? null,
+            };
+        });
+        return id;
+    }
+    /**
+     * Get the data of a given interface id.
+     *
+     * @param snapId - The snap id requesting the interface data.
+     * @param id - The interface id.
+     * @returns The interface state.
+     */
+    getInterface(snapId, id) {
+        __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateArgs).call(this, snapId, id);
+        return this.state.interfaces[id];
+    }
+    /**
+     * Update the interface with the given content.
+     *
+     * @param snapId - The snap id requesting the update.
+     * @param id - The interface id.
+     * @param content - The new content.
+     */
+    async updateInterface(snapId, id, content) {
+        __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateArgs).call(this, snapId, id);
+        const element = getJsxInterface(content);
+        await __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateContent).call(this, element);
+        const oldState = this.state.interfaces[id].state;
+        const newState = constructState(oldState, element);
+        this.update((draftState) => {
+            draftState.interfaces[id].state = newState;
+            draftState.interfaces[id].content = castDraft(element);
+        });
+    }
+    /**
+     * Delete an interface from state.
+     *
+     * @param id - The interface id.
+     */
+    deleteInterface(id) {
+        this.update((draftState) => {
+            delete draftState.interfaces[id];
+        });
+    }
+    /**
+     * Update the interface state.
+     *
+     * @param id - The interface id.
+     * @param state - The new state.
+     */
+    updateInterfaceState(id, state) {
+        this.update((draftState) => {
+            draftState.interfaces[id].state = state;
+        });
+    }
+    /**
+     * Resolve the promise of a given interface approval request.
+     * The approval needs to have the same ID as the interface.
+     *
+     * @param snapId - The snap id.
+     * @param id - The interface id.
+     * @param value - The value to resolve the promise with.
+     */
+    async resolveInterface(snapId, id, value) {
+        __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateArgs).call(this, snapId, id);
+        __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_validateApproval).call(this, id);
+        await __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_acceptApprovalRequest).call(this, id, value);
+        this.deleteInterface(id);
+    }
+}
+_SnapInterfaceController_instances = new WeakSet(), _SnapInterfaceController_registerMessageHandlers = function _SnapInterfaceController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler(`${controllerName}:createInterface`, this.createInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:getInterface`, this.getInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateInterface`, this.updateInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:deleteInterface`, this.deleteInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateInterfaceState`, this.updateInterfaceState.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:resolveInterface`, this.resolveInterface.bind(this));
+}, _SnapInterfaceController_validateArgs = function _SnapInterfaceController_validateArgs(snapId, id) {
+    const existingInterface = this.state.interfaces[id];
+    assert(existingInterface !== undefined, `Interface with id '${id}' not found.`);
+    assert(existingInterface.snapId === snapId, `Interface not created by ${snapId}.`);
+}, _SnapInterfaceController_validateApproval = function _SnapInterfaceController_validateApproval(id) {
+    assert(__classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_hasApprovalRequest).call(this, id), `Approval request with id '${id}' not found.`);
+}, _SnapInterfaceController_triggerPhishingListUpdate = 
+/**
+ * Trigger a Phishing list update if needed.
+ */
+async function _SnapInterfaceController_triggerPhishingListUpdate() {
+    await this.messagingSystem.call('PhishingController:maybeUpdateState');
+}, _SnapInterfaceController_checkPhishingList = function _SnapInterfaceController_checkPhishingList(origin) {
+    return this.messagingSystem.call('PhishingController:testOrigin', origin)
+        .result;
+}, _SnapInterfaceController_hasApprovalRequest = function _SnapInterfaceController_hasApprovalRequest(id) {
+    return this.messagingSystem.call('ApprovalController:hasRequest', {
+        id,
+    });
+}, _SnapInterfaceController_acceptApprovalRequest = 
+/**
+ * Accept an approval request for a given interface.
+ *
+ * @param id - The interface id.
+ * @param value - The value to resolve the promise with.
+ */
+async function _SnapInterfaceController_acceptApprovalRequest(id, value) {
+    await this.messagingSystem.call('ApprovalController:acceptRequest', id, value);
+}, _SnapInterfaceController_validateContent = 
+/**
+ * Utility function to validate the components of an interface.
+ * Throws if something is invalid.
+ *
+ * @param element - The JSX element to verify.
+ */
+async function _SnapInterfaceController_validateContent(element) {
+    // We assume the validity of this JSON to be validated by the caller.
+    // E.g., in the RPC method implementation.
+    const size = getJsonSizeUnsafe(element);
+    assert(size <= MAX_UI_CONTENT_SIZE, `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1000000} MB.`);
+    await __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_triggerPhishingListUpdate).call(this);
+    validateJsxLinks(element, __classPrivateFieldGet(this, _SnapInterfaceController_instances, "m", _SnapInterfaceController_checkPhishingList).bind(this));
 };
 //# sourceMappingURL=SnapInterfaceController.mjs.map

package/dist/interface/SnapInterfaceController.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"SnapInterfaceController.mjs","sourceRoot":"","sources":["../../src/interface/SnapInterfaceController.ts"],"names":[],"mappings":";;;;;;AASA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAY3D,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,8BAA8B;AAE5E,OAAO,EAAE,MAAM,EAAE,wBAAwB;AACzC,OAAO,EAAE,SAAS,EAAE,cAAc;AAClC,OAAO,EAAE,MAAM,EAAE,eAAe;AAEhC,OAAO,EACL,cAAc,EACd,eAAe,EACf,wBAAwB,EACzB,oBAAgB;AAEjB,MAAM,mBAAmB,GAAG,QAAU,CAAC,CAAC,QAAQ;AAEhD,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAqFjD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAI5C;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA+B;QAC3D,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,UAAU,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;aACjD;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE;SACpC,CAAC,CAAC;;QAEH,uBAAA,IAAI,4FAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAsCD;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CACnB,MAAc,EACd,OAA2B,EAC3B,OAA0B;QAE1B,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,uBAAA,IAAI,oFAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC;QACrC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QAElC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QACpB,MAAM,cAAc,GAAG,cAAc,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,wEAAwE;YACxE,qBAAqB;YACrB,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG;gBAC1B,MAAM;gBACN,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;gBAC3B,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,OAAO,IAAI,IAAI;aACzB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,MAAc,EAAE,EAAU;QACrC,uBAAA,IAAI,iFAAc,MAAlB,IAAI,EAAe,MAAM,EAAE,EAAE,CAAC,CAAC;QAE/B,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CACnB,MAAc,EACd,EAAU,EACV,OAA2B;QAE3B,uBAAA,IAAI,iFAAc,MAAlB,IAAI,EAAe,MAAM,EAAE,EAAE,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,uBAAA,IAAI,oFAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC;QAErC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;QACjD,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,QAAQ,CAAC;YAC3C,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,EAAU;QACxB,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,OAAO,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,EAAU,EAAE,KAAqB;QACpD,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,EAAU,EAAE,KAAW;QAC5D,uBAAA,IAAI,iFAAc,MAAlB,IAAI,EAAe,MAAM,EAAE,EAAE,CAAC,CAAC;QAC/B,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,EAAE,CAAC,CAAC;QAE3B,MAAM,uBAAA,IAAI,0FAAuB,MAA3B,IAAI,EAAwB,EAAE,EAAE,KAAK,CAAC,CAAC;QAE7C,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;CAgGF;;IA7OG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,kBAAkB,EACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,kBAAkB,EACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,kBAAkB,EACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,uBAAuB,EACxC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,mBAAmB,EACpC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CACjC,CAAC;AACJ,CAAC,yFAwHa,MAAc,EAAE,EAAU;IACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,CACJ,iBAAiB,KAAK,SAAS,EAC/B,sBAAsB,EAAE,cAAc,CACvC,CAAC;IACF,MAAM,CACJ,iBAAiB,CAAC,MAAM,KAAK,MAAM,EACnC,4BAA4B,MAAM,GAAG,CACtC,CAAC;AACJ,CAAC,iGAOiB,EAAU;IAC1B,MAAM,CACJ,uBAAA,IAAI,uFAAoB,MAAxB,IAAI,EAAqB,EAAE,CAAC,EAC5B,6BAA6B,EAAE,cAAc,CAC9C,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;AACzE,CAAC,mGAQkB,MAAc;IAC/B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,+BAA+B,EAAE,MAAM,CAAC;SACtE,MAAM,CAAC;AACZ,CAAC,qGASmB,EAAU;IAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,+BAA+B,EAAE;QAChE,EAAE;KACH,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,KAAK,yDAAwB,EAAU,EAAE,KAAW;IAClD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7B,kCAAkC,EAClC,EAAE,EACF,KAAK,CACN,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK,mDAAkB,OAAmB;IACxC,qEAAqE;IACrE,0CAA0C;IAC1C,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,CACJ,IAAI,IAAI,mBAAmB,EAC3B,oCAAoC,mBAAmB,GAAG,OAAO,MAAM,CACxE,CAAC;IAEF,MAAM,uBAAA,IAAI,8FAA2B,MAA/B,IAAI,CAA6B,CAAC;IACxC,gBAAgB,CAAC,OAAO,EAAE,uBAAA,IAAI,sFAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAChE,CAAC","sourcesContent":["import type {\n  AcceptRequest,\n  HasApprovalRequest,\n} from '@metamask/approval-controller';\nimport type {\n  RestrictedControllerMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  MaybeUpdateState,\n  TestOrigin,\n} from '@metamask/phishing-controller';\nimport type {\n  InterfaceState,\n  SnapId,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport { getJsonSizeUnsafe, validateJsxLinks } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\nimport { castDraft } from 'immer';\nimport { nanoid } from 'nanoid';\n\nimport {\n  constructState,\n  getJsxInterface,\n  validateInterfaceContext,\n} from './utils';\n\nconst MAX_UI_CONTENT_SIZE = 10_000_000; // 10 mb\n\nconst controllerName = 'SnapInterfaceController';\n\nexport type CreateInterface = {\n  type: `${typeof controllerName}:createInterface`;\n  handler: SnapInterfaceController['createInterface'];\n};\n\nexport type GetInterface = {\n  type: `${typeof controllerName}:getInterface`;\n  handler: SnapInterfaceController['getInterface'];\n};\n\nexport type UpdateInterface = {\n  type: `${typeof controllerName}:updateInterface`;\n  handler: SnapInterfaceController['updateInterface'];\n};\n\nexport type DeleteInterface = {\n  type: `${typeof controllerName}:deleteInterface`;\n  handler: SnapInterfaceController['deleteInterface'];\n};\n\nexport type UpdateInterfaceState = {\n  type: `${typeof controllerName}:updateInterfaceState`;\n  handler: SnapInterfaceController['updateInterfaceState'];\n};\n\nexport type ResolveInterface = {\n  type: `${typeof controllerName}:resolveInterface`;\n  handler: SnapInterfaceController['resolveInterface'];\n};\n\nexport type SnapInterfaceControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SnapInterfaceControllerState\n>;\n\nexport type SnapInterfaceControllerAllowedActions =\n  | TestOrigin\n  | MaybeUpdateState\n  | HasApprovalRequest\n  | AcceptRequest;\n\nexport type SnapInterfaceControllerActions =\n  | CreateInterface\n  | GetInterface\n  | UpdateInterface\n  | DeleteInterface\n  | UpdateInterfaceState\n  | ResolveInterface\n  | SnapInterfaceControllerGetStateAction;\n\nexport type SnapInterfaceControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SnapInterfaceControllerState\n  >;\n\nexport type SnapInterfaceControllerEvents =\n  SnapInterfaceControllerStateChangeEvent;\n\nexport type SnapInterfaceControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions,\n  SnapInterfaceControllerEvents,\n  SnapInterfaceControllerAllowedActions['type'],\n  SnapInterfaceControllerEvents['type']\n>;\n\nexport type StoredInterface = {\n  snapId: SnapId;\n  content: JSXElement;\n  state: InterfaceState;\n  context: InterfaceContext | null;\n};\n\nexport type SnapInterfaceControllerState = {\n  interfaces: Record<string, StoredInterface>;\n};\n\nexport type SnapInterfaceControllerArgs = {\n  messenger: SnapInterfaceControllerMessenger;\n  state?: SnapInterfaceControllerState;\n};\n\n/**\n * Use this controller to manage snaps UI interfaces using RPC method hooks.\n */\nexport class SnapInterfaceController extends BaseController<\n  typeof controllerName,\n  SnapInterfaceControllerState,\n  SnapInterfaceControllerMessenger\n> {\n  constructor({ messenger, state }: SnapInterfaceControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        interfaces: { persist: false, anonymous: false },\n      },\n      name: controllerName,\n      state: { interfaces: {}, ...state },\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers() {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:createInterface`,\n      this.createInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:getInterface`,\n      this.getInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterface`,\n      this.updateInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:deleteInterface`,\n      this.deleteInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterfaceState`,\n      this.updateInterfaceState.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:resolveInterface`,\n      this.resolveInterface.bind(this),\n    );\n  }\n\n  /**\n   * Create an interface in the controller state with the associated data.\n   *\n   * @param snapId - The snap id that created the interface.\n   * @param content - The interface content.\n   * @param context - An optional interface context object.\n   * @returns The newly interface id.\n   */\n  async createInterface(\n    snapId: SnapId,\n    content: ComponentOrElement,\n    context?: InterfaceContext,\n  ) {\n    const element = getJsxInterface(content);\n    await this.#validateContent(element);\n    validateInterfaceContext(context);\n\n    const id = nanoid();\n    const componentState = constructState({}, element);\n\n    this.update((draftState) => {\n      // @ts-expect-error - TS2589: Type instantiation is excessively deep and\n      // possibly infinite.\n      draftState.interfaces[id] = {\n        snapId,\n        content: castDraft(element),\n        state: componentState,\n        context: context ?? null,\n      };\n    });\n\n    return id;\n  }\n\n  /**\n   * Get the data of a given interface id.\n   *\n   * @param snapId - The snap id requesting the interface data.\n   * @param id - The interface id.\n   * @returns The interface state.\n   */\n  getInterface(snapId: SnapId, id: string) {\n    this.#validateArgs(snapId, id);\n\n    return this.state.interfaces[id];\n  }\n\n  /**\n   * Update the interface with the given content.\n   *\n   * @param snapId - The snap id requesting the update.\n   * @param id - The interface id.\n   * @param content - The new content.\n   */\n  async updateInterface(\n    snapId: SnapId,\n    id: string,\n    content: ComponentOrElement,\n  ) {\n    this.#validateArgs(snapId, id);\n    const element = getJsxInterface(content);\n    await this.#validateContent(element);\n\n    const oldState = this.state.interfaces[id].state;\n    const newState = constructState(oldState, element);\n\n    this.update((draftState) => {\n      draftState.interfaces[id].state = newState;\n      draftState.interfaces[id].content = castDraft(element);\n    });\n  }\n\n  /**\n   * Delete an interface from state.\n   *\n   * @param id - The interface id.\n   */\n  deleteInterface(id: string) {\n    this.update((draftState) => {\n      delete draftState.interfaces[id];\n    });\n  }\n\n  /**\n   * Update the interface state.\n   *\n   * @param id - The interface id.\n   * @param state - The new state.\n   */\n  updateInterfaceState(id: string, state: InterfaceState) {\n    this.update((draftState) => {\n      draftState.interfaces[id].state = state;\n    });\n  }\n\n  /**\n   * Resolve the promise of a given interface approval request.\n   * The approval needs to have the same ID as the interface.\n   *\n   * @param snapId - The snap id.\n   * @param id - The interface id.\n   * @param value - The value to resolve the promise with.\n   */\n  async resolveInterface(snapId: SnapId, id: string, value: Json) {\n    this.#validateArgs(snapId, id);\n    this.#validateApproval(id);\n\n    await this.#acceptApprovalRequest(id, value);\n\n    this.deleteInterface(id);\n  }\n\n  /**\n   * Utility function to validate the args passed to the other methods.\n   *\n   * @param snapId - The snap id.\n   * @param id - The interface id.\n   */\n  #validateArgs(snapId: SnapId, id: string) {\n    const existingInterface = this.state.interfaces[id];\n\n    assert(\n      existingInterface !== undefined,\n      `Interface with id '${id}' not found.`,\n    );\n    assert(\n      existingInterface.snapId === snapId,\n      `Interface not created by ${snapId}.`,\n    );\n  }\n\n  /**\n   * Utility function to validate that the approval request exists.\n   *\n   * @param id - The interface id.\n   */\n  #validateApproval(id: string) {\n    assert(\n      this.#hasApprovalRequest(id),\n      `Approval request with id '${id}' not found.`,\n    );\n  }\n\n  /**\n   * Trigger a Phishing list update if needed.\n   */\n  async #triggerPhishingListUpdate() {\n    await this.messagingSystem.call('PhishingController:maybeUpdateState');\n  }\n\n  /**\n   * Check an origin against the phishing list.\n   *\n   * @param origin - The origin to check.\n   * @returns True if the origin is on the phishing list, otherwise false.\n   */\n  #checkPhishingList(origin: string) {\n    return this.messagingSystem.call('PhishingController:testOrigin', origin)\n      .result;\n  }\n\n  /**\n   * Check if an approval request exists for a given interface by looking up\n   * if the ApprovalController has a request with the given interface ID.\n   *\n   * @param id - The interface id.\n   * @returns True if an approval request exists, otherwise false.\n   */\n  #hasApprovalRequest(id: string) {\n    return this.messagingSystem.call('ApprovalController:hasRequest', {\n      id,\n    });\n  }\n\n  /**\n   * Accept an approval request for a given interface.\n   *\n   * @param id - The interface id.\n   * @param value - The value to resolve the promise with.\n   */\n  async #acceptApprovalRequest(id: string, value: Json) {\n    await this.messagingSystem.call(\n      'ApprovalController:acceptRequest',\n      id,\n      value,\n    );\n  }\n\n  /**\n   * Utility function to validate the components of an interface.\n   * Throws if something is invalid.\n   *\n   * @param element - The JSX element to verify.\n   */\n  async #validateContent(element: JSXElement) {\n    // We assume the validity of this JSON to be validated by the caller.\n    // E.g., in the RPC method implementation.\n    const size = getJsonSizeUnsafe(element);\n    assert(\n      size <= MAX_UI_CONTENT_SIZE,\n      `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1000000} MB.`,\n    );\n\n    await this.#triggerPhishingListUpdate();\n    validateJsxLinks(element, this.#checkPhishingList.bind(this));\n  }\n}\n"]}

package/dist/interface/index.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./SnapInterfaceController.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/interface/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA0C","sourcesContent":["export * from './SnapInterfaceController';\n"]}

package/dist/interface/index.d.cts

@@ -0,0 +1,2 @@
+export * from "./SnapInterfaceController.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/interface/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":"AAAA,8CAA0C"}

package/dist/interface/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./SnapInterfaceController.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/interface/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":"AAAA,8CAA0C"}

package/dist/interface/index.mjs

@@ -1,10 +1,2 @@
-import "../chunk-U74FML7Z.mjs";
-import {
-  SnapInterfaceController
-} from "../chunk-Z5QWRDUN.mjs";
-import "../chunk-HULNFJMA.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  SnapInterfaceController
-};
+export * from "./SnapInterfaceController.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/interface/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":"AAAA,8CAA0C","sourcesContent":["export * from './SnapInterfaceController';\n"]}

package/dist/interface/utils.cjs

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateInterfaceContext = exports.constructState = exports.assertNameIsUnique = exports.getJsxInterface = void 0;
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const jsx_1 = require("@metamask/snaps-sdk/jsx");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+/**
+ * Get a JSX element from a component or JSX element. If the component is a
+ * JSX element, it is returned as is. Otherwise, the component is converted to
+ * a JSX element.
+ *
+ * @param component - The component to convert.
+ * @returns The JSX element.
+ */
+function getJsxInterface(component) {
+    if ((0, jsx_1.isJSXElementUnsafe)(component)) {
+        return component;
+    }
+    return (0, snaps_utils_1.getJsxElementFromComponent)(component);
+}
+exports.getJsxInterface = getJsxInterface;
+/**
+ * Assert that the component name is unique in state.
+ *
+ * @param state - The interface state to verify against.
+ * @param name - The component name to verify.
+ */
+function assertNameIsUnique(state, name) {
+    (0, snaps_sdk_1.assert)(state[name] === undefined, `Duplicate component names are not allowed, found multiple instances of: "${name}".`);
+}
+exports.assertNameIsUnique = assertNameIsUnique;
+/**
+ * Construct default state for a component.
+ *
+ * This function is meant to be used inside constructInputState to account
+ * for component specific defaults and will not override the component value or existing form state.
+ *
+ * @param element - The input element.
+ * @returns The default state for the specific component, if any.
+ */
+function constructComponentSpecificDefaultState(element) {
+    switch (element.type) {
+        case 'Dropdown': {
+            const children = (0, snaps_utils_1.getJsxChildren)(element);
+            return children[0]?.props.value;
+        }
+        case 'RadioGroup': {
+            const children = (0, snaps_utils_1.getJsxChildren)(element);
+            return children[0]?.props.value;
+        }
+        case 'Selector': {
+            const children = (0, snaps_utils_1.getJsxChildren)(element);
+            return children[0]?.props.value;
+        }
+        case 'Checkbox':
+            return false;
+        default:
+            return null;
+    }
+}
+/**
+ * Get the state value for a stateful component.
+ *
+ * Most components store the state value as a `value` prop.
+ * This function exists to account for components where that isn't the case.
+ *
+ * @param element - The input element.
+ * @returns The state value for a given component.
+ */
+function getComponentStateValue(element) {
+    switch (element.type) {
+        case 'Checkbox':
+            return element.props.checked;
+        default:
+            return element.props.value;
+    }
+}
+/**
+ * Construct the state for an input field.
+ *
+ * @param oldState - The previous state.
+ * @param element - The input element.
+ * @param form - An optional form that the input is enclosed in.
+ * @returns The input state.
+ */
+function constructInputState(oldState, element, form) {
+    const oldStateUnwrapped = form ? oldState[form] : oldState;
+    const oldInputState = oldStateUnwrapped?.[element.props.name];
+    if (element.type === 'FileInput') {
+        return oldInputState ?? null;
+    }
+    return (getComponentStateValue(element) ??
+        oldInputState ??
+        constructComponentSpecificDefaultState(element) ??
+        null);
+}
+/**
+ * Construct the interface state for a given component tree.
+ *
+ * @param oldState - The previous state.
+ * @param rootComponent - The UI component to construct state from.
+ * @returns The interface state of the passed component.
+ */
+function constructState(oldState, rootComponent) {
+    const newState = {};
+    // Stack containing the forms we have visited and at which depth
+    const formStack = [];
+    (0, snaps_utils_1.walkJsx)(rootComponent, (component, depth) => {
+        let currentForm = formStack[formStack.length - 1];
+        // Pop the current form of the stack once we leave its depth.
+        if (currentForm && depth <= currentForm.depth) {
+            formStack.pop();
+            currentForm = formStack[formStack.length - 1];
+        }
+        if (component.type === 'Form') {
+            assertNameIsUnique(newState, component.props.name);
+            formStack.push({ name: component.props.name, depth });
+            newState[component.props.name] = {};
+            return;
+        }
+        // Stateful components inside a form
+        if (currentForm &&
+            (component.type === 'Input' ||
+                component.type === 'Dropdown' ||
+                component.type === 'RadioGroup' ||
+                component.type === 'FileInput' ||
+                component.type === 'Checkbox' ||
+                component.type === 'Selector')) {
+            const formState = newState[currentForm.name];
+            assertNameIsUnique(formState, component.props.name);
+            formState[component.props.name] = constructInputState(oldState, component, currentForm.name);
+            return;
+        }
+        // Stateful components outside a form
+        if (component.type === 'Input' ||
+            component.type === 'Dropdown' ||
+            component.type === 'RadioGroup' ||
+            component.type === 'FileInput' ||
+            component.type === 'Checkbox' ||
+            component.type === 'Selector') {
+            assertNameIsUnique(newState, component.props.name);
+            newState[component.props.name] = constructInputState(oldState, component);
+        }
+    });
+    return newState;
+}
+exports.constructState = constructState;
+const MAX_CONTEXT_SIZE = 1000000; // 1 mb
+/**
+ * Validate a JSON blob to be used as the interface context.
+ *
+ * @param context - The JSON blob.
+ * @throws If the JSON blob is too large.
+ */
+function validateInterfaceContext(context) {
+    if (!context) {
+        return;
+    }
+    // We assume the validity of this JSON to be validated by the caller.
+    // E.g., in the RPC method implementation.
+    const size = (0, snaps_utils_1.getJsonSizeUnsafe)(context);
+    (0, snaps_sdk_1.assert)(size <= MAX_CONTEXT_SIZE, `A Snap interface context may not be larger than ${MAX_CONTEXT_SIZE / 1000000} MB.`);
+}
+exports.validateInterfaceContext = validateInterfaceContext;
+//# sourceMappingURL=utils.cjs.map

package/dist/interface/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/interface/utils.ts"],"names":[],"mappings":";;;AAAA,mDAA6C;AAoB7C,iDAA6D;AAC7D,uDAK+B;AAE/B;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,SAA6B;IAC3D,IAAI,IAAA,wBAAkB,EAAC,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAA,wCAA0B,EAAC,SAAS,CAAC,CAAC;AAC/C,CAAC;AAND,0CAMC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,KAAqB,EAAE,IAAY;IACpE,IAAA,kBAAM,EACJ,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,EACzB,4EAA4E,IAAI,IAAI,CACrF,CAAC;AACJ,CAAC;AALD,gDAKC;AAED;;;;;;;;GAQG;AACH,SAAS,sCAAsC,CAC7C,OAKmB;IAEnB,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,QAAQ,GAAG,IAAA,4BAAc,EAAC,OAAO,CAAoB,CAAC;YAC5D,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;QAClC,CAAC;QAED,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,QAAQ,GAAG,IAAA,4BAAc,EAAC,OAAO,CAAmB,CAAC;YAC3D,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;QAClC,CAAC;QAED,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,QAAQ,GAAG,IAAA,4BAAc,EAAC,OAAO,CAA4B,CAAC;YACpE,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;QAClC,CAAC;QAED,KAAK,UAAU;YACb,OAAO,KAAK,CAAC;QAEf;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,sBAAsB,CAC7B,OAKmB;IAEnB,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,UAAU;YACb,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAE/B;YACE,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAC/B,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAC1B,QAAwB,EACxB,OAMmB,EACnB,IAAa;IAEb,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAE,QAAQ,CAAC,IAAI,CAAe,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC1E,MAAM,aAAa,GAAG,iBAAiB,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAU,CAAC;IAEvE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,aAAa,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED,OAAO,CACL,sBAAsB,CAAC,OAAO,CAAC;QAC/B,aAAa;QACb,sCAAsC,CAAC,OAAO,CAAC;QAC/C,IAAI,CACL,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,QAAwB,EACxB,aAAyB;IAEzB,MAAM,QAAQ,GAAmB,EAAE,CAAC;IAEpC,gEAAgE;IAChE,MAAM,SAAS,GAAsC,EAAE,CAAC;IAExD,IAAA,qBAAO,EAAC,aAAa,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QAC1C,IAAI,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAElD,6DAA6D;QAC7D,IAAI,WAAW,IAAI,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;YAC9C,SAAS,CAAC,GAAG,EAAE,CAAC;YAChB,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC9B,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnD,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YACtD,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACpC,OAAO;QACT,CAAC;QAED,oCAAoC;QACpC,IACE,WAAW;YACX,CAAC,SAAS,CAAC,IAAI,KAAK,OAAO;gBACzB,SAAS,CAAC,IAAI,KAAK,UAAU;gBAC7B,SAAS,CAAC,IAAI,KAAK,YAAY;gBAC/B,SAAS,CAAC,IAAI,KAAK,WAAW;gBAC9B,SAAS,CAAC,IAAI,KAAK,UAAU;gBAC7B,SAAS,CAAC,IAAI,KAAK,UAAU,CAAC,EAChC,CAAC;YACD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAc,CAAC;YAC1D,kBAAkB,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpD,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,mBAAmB,CACnD,QAAQ,EACR,SAAS,EACT,WAAW,CAAC,IAAI,CACjB,CAAC;YACF,OAAO;QACT,CAAC;QAED,qCAAqC;QACrC,IACE,SAAS,CAAC,IAAI,KAAK,OAAO;YAC1B,SAAS,CAAC,IAAI,KAAK,UAAU;YAC7B,SAAS,CAAC,IAAI,KAAK,YAAY;YAC/B,SAAS,CAAC,IAAI,KAAK,WAAW;YAC9B,SAAS,CAAC,IAAI,KAAK,UAAU;YAC7B,SAAS,CAAC,IAAI,KAAK,UAAU,EAC7B,CAAC;YACD,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnD,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC;AA5DD,wCA4DC;AAED,MAAM,gBAAgB,GAAG,OAAS,CAAC,CAAC,OAAO;AAE3C;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,OAA0B;IACjE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;IACT,CAAC;IAED,qEAAqE;IACrE,0CAA0C;IAC1C,MAAM,IAAI,GAAG,IAAA,+BAAiB,EAAC,OAAO,CAAC,CAAC;IACxC,IAAA,kBAAM,EACJ,IAAI,IAAI,gBAAgB,EACxB,mDACE,gBAAgB,GAAG,OACrB,MAAM,CACP,CAAC;AACJ,CAAC;AAdD,4DAcC","sourcesContent":["import { assert } from '@metamask/snaps-sdk';\nimport type {\n  FormState,\n  InterfaceState,\n  ComponentOrElement,\n  InterfaceContext,\n  State,\n} from '@metamask/snaps-sdk';\nimport type {\n  DropdownElement,\n  InputElement,\n  JSXElement,\n  OptionElement,\n  FileInputElement,\n  CheckboxElement,\n  RadioGroupElement,\n  RadioElement,\n  SelectorElement,\n  SelectorOptionElement,\n} from '@metamask/snaps-sdk/jsx';\nimport { isJSXElementUnsafe } from '@metamask/snaps-sdk/jsx';\nimport {\n  getJsonSizeUnsafe,\n  getJsxChildren,\n  getJsxElementFromComponent,\n  walkJsx,\n} from '@metamask/snaps-utils';\n\n/**\n * Get a JSX element from a component or JSX element. If the component is a\n * JSX element, it is returned as is. Otherwise, the component is converted to\n * a JSX element.\n *\n * @param component - The component to convert.\n * @returns The JSX element.\n */\nexport function getJsxInterface(component: ComponentOrElement): JSXElement {\n  if (isJSXElementUnsafe(component)) {\n    return component;\n  }\n\n  return getJsxElementFromComponent(component);\n}\n\n/**\n * Assert that the component name is unique in state.\n *\n * @param state - The interface state to verify against.\n * @param name - The component name to verify.\n */\nexport function assertNameIsUnique(state: InterfaceState, name: string) {\n  assert(\n    state[name] === undefined,\n    `Duplicate component names are not allowed, found multiple instances of: \"${name}\".`,\n  );\n}\n\n/**\n * Construct default state for a component.\n *\n * This function is meant to be used inside constructInputState to account\n * for component specific defaults and will not override the component value or existing form state.\n *\n * @param element - The input element.\n * @returns The default state for the specific component, if any.\n */\nfunction constructComponentSpecificDefaultState(\n  element:\n    | InputElement\n    | DropdownElement\n    | RadioGroupElement\n    | CheckboxElement\n    | SelectorElement,\n) {\n  switch (element.type) {\n    case 'Dropdown': {\n      const children = getJsxChildren(element) as OptionElement[];\n      return children[0]?.props.value;\n    }\n\n    case 'RadioGroup': {\n      const children = getJsxChildren(element) as RadioElement[];\n      return children[0]?.props.value;\n    }\n\n    case 'Selector': {\n      const children = getJsxChildren(element) as SelectorOptionElement[];\n      return children[0]?.props.value;\n    }\n\n    case 'Checkbox':\n      return false;\n\n    default:\n      return null;\n  }\n}\n\n/**\n * Get the state value for a stateful component.\n *\n * Most components store the state value as a `value` prop.\n * This function exists to account for components where that isn't the case.\n *\n * @param element - The input element.\n * @returns The state value for a given component.\n */\nfunction getComponentStateValue(\n  element:\n    | InputElement\n    | DropdownElement\n    | RadioGroupElement\n    | CheckboxElement\n    | SelectorElement,\n) {\n  switch (element.type) {\n    case 'Checkbox':\n      return element.props.checked;\n\n    default:\n      return element.props.value;\n  }\n}\n\n/**\n * Construct the state for an input field.\n *\n * @param oldState - The previous state.\n * @param element - The input element.\n * @param form - An optional form that the input is enclosed in.\n * @returns The input state.\n */\nfunction constructInputState(\n  oldState: InterfaceState,\n  element:\n    | InputElement\n    | DropdownElement\n    | RadioGroupElement\n    | FileInputElement\n    | CheckboxElement\n    | SelectorElement,\n  form?: string,\n) {\n  const oldStateUnwrapped = form ? (oldState[form] as FormState) : oldState;\n  const oldInputState = oldStateUnwrapped?.[element.props.name] as State;\n\n  if (element.type === 'FileInput') {\n    return oldInputState ?? null;\n  }\n\n  return (\n    getComponentStateValue(element) ??\n    oldInputState ??\n    constructComponentSpecificDefaultState(element) ??\n    null\n  );\n}\n\n/**\n * Construct the interface state for a given component tree.\n *\n * @param oldState - The previous state.\n * @param rootComponent - The UI component to construct state from.\n * @returns The interface state of the passed component.\n */\nexport function constructState(\n  oldState: InterfaceState,\n  rootComponent: JSXElement,\n): InterfaceState {\n  const newState: InterfaceState = {};\n\n  // Stack containing the forms we have visited and at which depth\n  const formStack: { name: string; depth: number }[] = [];\n\n  walkJsx(rootComponent, (component, depth) => {\n    let currentForm = formStack[formStack.length - 1];\n\n    // Pop the current form of the stack once we leave its depth.\n    if (currentForm && depth <= currentForm.depth) {\n      formStack.pop();\n      currentForm = formStack[formStack.length - 1];\n    }\n\n    if (component.type === 'Form') {\n      assertNameIsUnique(newState, component.props.name);\n      formStack.push({ name: component.props.name, depth });\n      newState[component.props.name] = {};\n      return;\n    }\n\n    // Stateful components inside a form\n    if (\n      currentForm &&\n      (component.type === 'Input' ||\n        component.type === 'Dropdown' ||\n        component.type === 'RadioGroup' ||\n        component.type === 'FileInput' ||\n        component.type === 'Checkbox' ||\n        component.type === 'Selector')\n    ) {\n      const formState = newState[currentForm.name] as FormState;\n      assertNameIsUnique(formState, component.props.name);\n      formState[component.props.name] = constructInputState(\n        oldState,\n        component,\n        currentForm.name,\n      );\n      return;\n    }\n\n    // Stateful components outside a form\n    if (\n      component.type === 'Input' ||\n      component.type === 'Dropdown' ||\n      component.type === 'RadioGroup' ||\n      component.type === 'FileInput' ||\n      component.type === 'Checkbox' ||\n      component.type === 'Selector'\n    ) {\n      assertNameIsUnique(newState, component.props.name);\n      newState[component.props.name] = constructInputState(oldState, component);\n    }\n  });\n\n  return newState;\n}\n\nconst MAX_CONTEXT_SIZE = 1_000_000; // 1 mb\n\n/**\n * Validate a JSON blob to be used as the interface context.\n *\n * @param context - The JSON blob.\n * @throws If the JSON blob is too large.\n */\nexport function validateInterfaceContext(context?: InterfaceContext) {\n  if (!context) {\n    return;\n  }\n\n  // We assume the validity of this JSON to be validated by the caller.\n  // E.g., in the RPC method implementation.\n  const size = getJsonSizeUnsafe(context);\n  assert(\n    size <= MAX_CONTEXT_SIZE,\n    `A Snap interface context may not be larger than ${\n      MAX_CONTEXT_SIZE / 1000000\n    } MB.`,\n  );\n}\n"]}

package/dist/{types/interface/utils.d.ts → interface/utils.d.cts}

@@ -1,5 +1,5 @@
-import type { InterfaceState, ComponentOrElement, InterfaceContext } from '@metamask/snaps-sdk';
-import type { JSXElement } from '@metamask/snaps-sdk/jsx';
+import type { InterfaceState, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import type { JSXElement } from "@metamask/snaps-sdk/jsx";
 /**
  * Get a JSX element from a component or JSX element. If the component is a
  * JSX element, it is returned as is. Otherwise, the component is converted to
@@ -31,3 +31,4 @@ export declare function constructState(oldState: InterfaceState, rootComponent:
  * @throws If the JSON blob is too large.
  */
 export declare function validateInterfaceContext(context?: InterfaceContext): void;
+//# sourceMappingURL=utils.d.cts.map

package/dist/interface/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/interface/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAEjB,4BAA4B;AAC7B,OAAO,KAAK,EAGV,UAAU,EAQX,gCAAgC;AASjC;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,kBAAkB,GAAG,UAAU,CAMzE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,QAKrE;AAuGD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,cAAc,EACxB,aAAa,EAAE,UAAU,GACxB,cAAc,CAyDhB;AAID;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,CAAC,EAAE,gBAAgB,QAclE"}

package/dist/interface/utils.d.mts

@@ -0,0 +1,34 @@
+import type { InterfaceState, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import type { JSXElement } from "@metamask/snaps-sdk/jsx";
+/**
+ * Get a JSX element from a component or JSX element. If the component is a
+ * JSX element, it is returned as is. Otherwise, the component is converted to
+ * a JSX element.
+ *
+ * @param component - The component to convert.
+ * @returns The JSX element.
+ */
+export declare function getJsxInterface(component: ComponentOrElement): JSXElement;
+/**
+ * Assert that the component name is unique in state.
+ *
+ * @param state - The interface state to verify against.
+ * @param name - The component name to verify.
+ */
+export declare function assertNameIsUnique(state: InterfaceState, name: string): void;
+/**
+ * Construct the interface state for a given component tree.
+ *
+ * @param oldState - The previous state.
+ * @param rootComponent - The UI component to construct state from.
+ * @returns The interface state of the passed component.
+ */
+export declare function constructState(oldState: InterfaceState, rootComponent: JSXElement): InterfaceState;
+/**
+ * Validate a JSON blob to be used as the interface context.
+ *
+ * @param context - The JSON blob.
+ * @throws If the JSON blob is too large.
+ */
+export declare function validateInterfaceContext(context?: InterfaceContext): void;
+//# sourceMappingURL=utils.d.mts.map

package/dist/interface/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/interface/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAEjB,4BAA4B;AAC7B,OAAO,KAAK,EAGV,UAAU,EAQX,gCAAgC;AASjC;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,kBAAkB,GAAG,UAAU,CAMzE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,QAKrE;AAuGD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,cAAc,EACxB,aAAa,EAAE,UAAU,GACxB,cAAc,CAyDhB;AAID;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,CAAC,EAAE,gBAAgB,QAclE"}