@metamask/snaps-utils/dist/ui.d.cts

A collection of utilities for MetaMask Snaps

import type { CaipAccountId, Component } from "@metamask/snaps-sdk";
import type { JSXElement, LinkElement, Nestable, SnapNode, StandardFormattingElement } from "@metamask/snaps-sdk/jsx";
import type { InternalAccount } from "./account.cjs";
import type { Snap } from "./snaps.cjs";
/**
 * Get all text children from a markdown string.
 *
 * @param value - The markdown string.
 * @returns The text children.
 */
export declare function getTextChildren(value: string): (string | StandardFormattingElement | LinkElement)[];
/**
 * Get a JSX element from a legacy UI component. This supports all legacy UI
 * components, and maps them to their JSX equivalents where possible.
 *
 * This function validates the text size of the component, but does not validate
 * the total size. The total size of the component should be validated before
 * calling this function.
 *
 * @param legacyComponent - The legacy UI component.
 * @returns The JSX element.
 */
export declare function getJsxElementFromComponent(legacyComponent: Component): JSXElement;
/**
 * Validate a link against the phishing list.
 *
 * @param link - The link to validate.
 * @param isOnPhishingList - The function that checks the link against the
 * phishing list.
 * @param getSnap - The function that returns a snap if installed, undefined otherwise.
 * @throws If the link is invalid.
 */
export declare function validateLink(link: string, isOnPhishingList: (url: string) => boolean, getSnap: (id: string) => Snap | undefined): void;
/**
 * Search for Markdown links in a string and checks them against the phishing
 * list.
 *
 * @param text - The text to verify.
 * @param isOnPhishingList - The function that checks the link against the
 * phishing list.
 * @param getSnap - The function that returns a snap if installed, undefined otherwise.
 * @throws If the text contains a link that is not allowed.
 */
export declare function validateTextLinks(text: string, isOnPhishingList: (url: string) => boolean, getSnap: (id: string) => Snap | undefined): void;
/**
 * Validate the asset selector component.
 *
 * @param address - The address of the account to pull the assets from.
 * @param getAccountByAddress - A function to get an account by its address.
 *
 * @throws If the asset selector is invalid.
 */
export declare function validateAssetSelector(address: CaipAccountId, getAccountByAddress: (address: CaipAccountId) => InternalAccount | undefined): void;
/**
 * Walk a JSX tree and validate elements.
 * This function validates Links and AssetSelectors.
 *
 * @param node - The JSX node to walk.
 * @param hooks - The hooks to use for validation.
 * @param hooks.isOnPhishingList - The function that checks the link against the
 * phishing list.
 * @param hooks.getSnap - The function that returns a snap if installed, undefined otherwise.
 * @param hooks.getAccountByAddress - The function that returns an account by address.
 */
export declare function validateJsxElements(node: JSXElement, { isOnPhishingList, getSnap, getAccountByAddress, }: {
    isOnPhishingList: (url: string) => boolean;
    getSnap: (id: string) => Snap | undefined;
    getAccountByAddress: (address: CaipAccountId) => InternalAccount | undefined;
}): void;
/**
 * Calculate the total length of all text in the component.
 *
 * @param component - A custom UI component.
 * @returns The total length of all text components in the component.
 */
export declare function getTotalTextLength(component: Component): number;
/**
 * Check if a JSX element has children.
 *
 * @param element - A JSX element.
 * @returns `true` if the element has children, `false` otherwise.
 */
export declare function hasChildren<Element extends JSXElement>(element: Element): element is Element & {
    props: {
        children: Nestable<JSXElement | string>;
    };
};
/**
 * Get the children of a JSX element as an array. If the element has only one
 * child, the child is returned as an array.
 *
 * @param element - A JSX element.
 * @returns The children of the element.
 */
export declare function getJsxChildren(element: JSXElement): (JSXElement | string)[];
/**
 * Walk a JSX tree and call a callback on each node.
 *
 * @param node - The JSX node to walk.
 * @param callback - The callback to call on each node.
 * @param depth - The current depth in the JSX tree for a walk.
 * @returns The result of the callback, if any.
 */
export declare function walkJsx<Value>(node: JSXElement | JSXElement[], callback: (node: JSXElement, depth: number) => Value | undefined, depth?: number): Value | undefined;
/**
 * Serialise a JSX node to a string.
 *
 * @param node - The JSX node.
 * @param indentation - The indentation level. Defaults to `0`. This should not
 * be set by the caller, as it is used for recursion.
 * @returns The serialised JSX node.
 */
export declare function serialiseJsx(node: SnapNode, indentation?: number): string;
//# sourceMappingURL=ui.d.cts.map