@metamask/snaps-utils 8.0.1 → 8.1.1

package/dist/ui.cjs

@@ -0,0 +1,405 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serialiseJsx = exports.walkJsx = exports.getJsxChildren = exports.hasChildren = exports.getTotalTextLength = exports.validateJsxLinks = exports.validateTextLinks = exports.validateLink = exports.getJsxElementFromComponent = exports.getTextChildren = void 0;
+const jsx_runtime_1 = require("@metamask/snaps-sdk/jsx-runtime");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const jsx_1 = require("@metamask/snaps-sdk/jsx");
+const utils_1 = require("@metamask/utils");
+const marked_1 = require("marked");
+const MAX_TEXT_LENGTH = 50000; // 50 kb
+const ALLOWED_PROTOCOLS = ['https:', 'mailto:'];
+/**
+ * Get the button variant from a legacy button component variant.
+ *
+ * @param variant - The legacy button component variant.
+ * @returns The button variant.
+ */
+function getButtonVariant(variant) {
+    switch (variant) {
+        case 'primary':
+            return 'primary';
+        case 'secondary':
+            return 'destructive';
+        default:
+            return undefined;
+    }
+}
+/**
+ * Get the children of a JSX element. If there is only one child, the child is
+ * returned directly. Otherwise, the children are returned as an array.
+ *
+ * @param elements - The JSX elements.
+ * @returns The child or children.
+ */
+function getChildren(elements) {
+    if (elements.length === 1) {
+        return elements[0];
+    }
+    return elements;
+}
+/**
+ * Get the text of a link token.
+ *
+ * @param token - The link token.
+ * @returns The text of the link token.
+ */
+function getLinkText(token) {
+    if (token.tokens && token.tokens.length > 0) {
+        return getChildren(token.tokens.flatMap(getTextChildFromToken));
+    }
+    return token.href;
+}
+/**
+ * Get the text child from a list of markdown tokens.
+ *
+ * @param tokens - The markdown tokens.
+ * @returns The text child.
+ */
+function getTextChildFromTokens(tokens) {
+    return getChildren(tokens.flatMap(getTextChildFromToken));
+}
+/**
+ * Get the text child from a markdown token.
+ *
+ * @param token - The markdown token.
+ * @returns The text child.
+ */
+function getTextChildFromToken(token) {
+    switch (token.type) {
+        case 'link': {
+            return (0, jsx_runtime_1.jsx)(jsx_1.Link, { href: token.href, children: getLinkText(token) });
+        }
+        case 'text':
+            return token.text;
+        case 'strong':
+            return ((0, jsx_runtime_1.jsx)(jsx_1.Bold, { children: getTextChildFromTokens(
+                // Due to the way `marked` is typed, `token.tokens` can be
+                // `undefined`, but it's a required field of `Tokens.Bold`, so we
+                // can safely cast it to `Token[]`.
+                token.tokens) }));
+        case 'em':
+            return ((0, jsx_runtime_1.jsx)(jsx_1.Italic, { children: getTextChildFromTokens(
+                // Due to the way `marked` is typed, `token.tokens` can be
+                // `undefined`, but it's a required field of `Tokens.Bold`, so we
+                // can safely cast it to `Token[]`.
+                token.tokens) }));
+        default:
+            return null;
+    }
+}
+/**
+ * Get all text children from a markdown string.
+ *
+ * @param value - The markdown string.
+ * @returns The text children.
+ */
+function getTextChildren(value) {
+    const rootTokens = (0, marked_1.lexer)(value, { gfm: false });
+    const children = [];
+    (0, marked_1.walkTokens)(rootTokens, (token) => {
+        if (token.type === 'paragraph') {
+            if (children.length > 0) {
+                children.push('\n\n');
+            }
+            const { tokens } = token;
+            // We do not need to consider nesting deeper than 1 level here and we can therefore cast.
+            children.push(...tokens.flatMap(getTextChildFromToken));
+        }
+    });
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+    return children.filter((child) => child !== null);
+}
+exports.getTextChildren = getTextChildren;
+/**
+ * Validate the text size of a component. The text size is the total length of
+ * all text in the component.
+ *
+ * @param component - The component to validate.
+ * @throws An error if the text size exceeds the maximum allowed size.
+ */
+function validateComponentTextSize(component) {
+    const textSize = getTotalTextLength(component);
+    (0, utils_1.assert)(textSize <= MAX_TEXT_LENGTH, `The text in a Snap UI may not be larger than ${MAX_TEXT_LENGTH / 1000} kB.`);
+}
+/**
+ * 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.
+ */
+function getJsxElementFromComponent(legacyComponent) {
+    validateComponentTextSize(legacyComponent);
+    /**
+     * Get the JSX element for a component. This function is recursive and will
+     * call itself for child components.
+     *
+     * @param component - The component to convert to a JSX element.
+     * @returns The JSX element.
+     */
+    function getElement(component) {
+        switch (component.type) {
+            case snaps_sdk_1.NodeType.Address:
+                return (0, jsx_runtime_1.jsx)(jsx_1.Address, { address: component.value });
+            case snaps_sdk_1.NodeType.Button:
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Button, { name: component.name, variant: getButtonVariant(component.variant), type: component.buttonType, children: component.value }));
+            case snaps_sdk_1.NodeType.Copyable:
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Copyable, { value: component.value, sensitive: component.sensitive }));
+            case snaps_sdk_1.NodeType.Divider:
+                return (0, jsx_runtime_1.jsx)(jsx_1.Divider, {});
+            case snaps_sdk_1.NodeType.Form:
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Form, { name: component.name, children: getChildren(component.children.map(getElement)) }));
+            case snaps_sdk_1.NodeType.Heading:
+                return (0, jsx_runtime_1.jsx)(jsx_1.Heading, { children: component.value });
+            case snaps_sdk_1.NodeType.Image:
+                // `Image` supports `alt`, but the legacy `Image` component does not.
+                return (0, jsx_runtime_1.jsx)(jsx_1.Image, { src: component.value });
+            case snaps_sdk_1.NodeType.Input:
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Field, { label: component.label, error: component.error, children: (0, jsx_runtime_1.jsx)(jsx_1.Input, { name: component.name, type: component.inputType, value: component.value, placeholder: component.placeholder }) }));
+            case snaps_sdk_1.NodeType.Panel:
+                // `Panel` is renamed to `Box` in JSX.
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Box, { children: getChildren(component.children.map(getElement)) }));
+            case snaps_sdk_1.NodeType.Row:
+                return ((0, jsx_runtime_1.jsx)(jsx_1.Row, { label: component.label, variant: component.variant, children: getElement(component.value) }));
+            case snaps_sdk_1.NodeType.Spinner:
+                return (0, jsx_runtime_1.jsx)(jsx_1.Spinner, {});
+            case snaps_sdk_1.NodeType.Text:
+                return (0, jsx_runtime_1.jsx)(jsx_1.Text, { children: getChildren(getTextChildren(component.value)) });
+            /* istanbul ignore next 2 */
+            default:
+                return (0, utils_1.assertExhaustive)(component);
+        }
+    }
+    return getElement(legacyComponent);
+}
+exports.getJsxElementFromComponent = getJsxElementFromComponent;
+/**
+ * Extract all links from a Markdown text string using the `marked` lexer.
+ *
+ * @param text - The markdown text string.
+ * @returns A list of URLs linked to in the string.
+ */
+function getMarkdownLinks(text) {
+    const tokens = (0, marked_1.lexer)(text, { gfm: false });
+    const links = [];
+    // Walk the lexed tokens and collect all link tokens
+    (0, marked_1.walkTokens)(tokens, (token) => {
+        if (token.type === 'link') {
+            links.push(token);
+        }
+    });
+    return links;
+}
+/**
+ * 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.
+ */
+function validateLink(link, isOnPhishingList) {
+    try {
+        const url = new URL(link);
+        (0, utils_1.assert)(ALLOWED_PROTOCOLS.includes(url.protocol), `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`);
+        const hostname = url.protocol === 'mailto:' ? url.pathname.split('@')[1] : url.hostname;
+        (0, utils_1.assert)(!isOnPhishingList(hostname), 'The specified URL is not allowed.');
+    }
+    catch (error) {
+        throw new Error(`Invalid URL: ${error?.code === 'ERR_ASSERTION' ? error.message : 'Unable to parse URL.'}`);
+    }
+}
+exports.validateLink = validateLink;
+/**
+ * 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.
+ * @throws If the text contains a link that is not allowed.
+ */
+function validateTextLinks(text, isOnPhishingList) {
+    const links = getMarkdownLinks(text);
+    for (const link of links) {
+        validateLink(link.href, isOnPhishingList);
+    }
+}
+exports.validateTextLinks = validateTextLinks;
+/**
+ * Walk a JSX tree and validate each {@link LinkElement} node against the
+ * phishing list.
+ *
+ * @param node - The JSX node to walk.
+ * @param isOnPhishingList - The function that checks the link against the
+ * phishing list.
+ */
+function validateJsxLinks(node, isOnPhishingList) {
+    walkJsx(node, (childNode) => {
+        if (childNode.type !== 'Link') {
+            return;
+        }
+        validateLink(childNode.props.href, isOnPhishingList);
+    });
+}
+exports.validateJsxLinks = validateJsxLinks;
+/**
+ * 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.
+ */
+function getTotalTextLength(component) {
+    const { type } = component;
+    switch (type) {
+        case snaps_sdk_1.NodeType.Panel:
+            return component.children.reduce(
+            // This is a bug in TypeScript: https://github.com/microsoft/TypeScript/issues/48313
+            // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+            (sum, node) => sum + getTotalTextLength(node), 0);
+        case snaps_sdk_1.NodeType.Row:
+            return getTotalTextLength(component.value);
+        case snaps_sdk_1.NodeType.Text:
+            return component.value.length;
+        default:
+            return 0;
+    }
+}
+exports.getTotalTextLength = getTotalTextLength;
+/**
+ * Check if a JSX element has children.
+ *
+ * @param element - A JSX element.
+ * @returns `true` if the element has children, `false` otherwise.
+ */
+function hasChildren(element) {
+    return (0, utils_1.hasProperty)(element.props, 'children');
+}
+exports.hasChildren = hasChildren;
+/**
+ * Filter a JSX child to remove `null`, `undefined`, plain booleans, and empty
+ * strings.
+ *
+ * @param child - The JSX child to filter.
+ * @returns `true` if the child is not `null`, `undefined`, a plain boolean, or
+ * an empty string, `false` otherwise.
+ */
+function filterJsxChild(child) {
+    return Boolean(child) && child !== true;
+}
+/**
+ * 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.
+ */
+function getJsxChildren(element) {
+    if (hasChildren(element)) {
+        if (Array.isArray(element.props.children)) {
+            // @ts-expect-error - Each member of the union type has signatures, but
+            // none of those signatures are compatible with each other.
+            return element.props.children.filter(filterJsxChild).flat(Infinity);
+        }
+        if (element.props.children) {
+            return [element.props.children];
+        }
+    }
+    return [];
+}
+exports.getJsxChildren = getJsxChildren;
+/**
+ * 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.
+ */
+function walkJsx(node, callback, depth = 0) {
+    if (Array.isArray(node)) {
+        for (const child of node) {
+            const childResult = walkJsx(child, callback, depth);
+            if (childResult !== undefined) {
+                return childResult;
+            }
+        }
+        return undefined;
+    }
+    const result = callback(node, depth);
+    if (result !== undefined) {
+        return result;
+    }
+    if ((0, utils_1.hasProperty)(node, 'props') &&
+        (0, utils_1.isPlainObject)(node.props) &&
+        (0, utils_1.hasProperty)(node.props, 'children')) {
+        const children = getJsxChildren(node);
+        for (const child of children) {
+            if ((0, utils_1.isPlainObject)(child)) {
+                const childResult = walkJsx(child, callback, depth + 1);
+                if (childResult !== undefined) {
+                    return childResult;
+                }
+            }
+        }
+    }
+    return undefined;
+}
+exports.walkJsx = walkJsx;
+/**
+ * Serialise a JSX prop to a string.
+ *
+ * @param prop - The JSX prop.
+ * @returns The serialised JSX prop.
+ */
+function serialiseProp(prop) {
+    if (typeof prop === 'string') {
+        return `"${prop}"`;
+    }
+    return `{${JSON.stringify(prop)}}`;
+}
+/**
+ * Serialise JSX props to a string.
+ *
+ * @param props - The JSX props.
+ * @returns The serialised JSX props.
+ */
+function serialiseProps(props) {
+    return Object.entries(props)
+        .filter(([key]) => key !== 'children')
+        .sort(([a], [b]) => a.localeCompare(b))
+        .map(([key, value]) => ` ${key}=${serialiseProp(value)}`)
+        .join('');
+}
+/**
+ * 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.
+ */
+function serialiseJsx(node, indentation = 0) {
+    if (Array.isArray(node)) {
+        return node.map((child) => serialiseJsx(child, indentation)).join('');
+    }
+    const indent = '  '.repeat(indentation);
+    if (typeof node === 'string') {
+        return `${indent}${node}\n`;
+    }
+    if (!node) {
+        return '';
+    }
+    const { type, props } = node;
+    const trailingNewline = indentation > 0 ? '\n' : '';
+    if ((0, utils_1.hasProperty)(props, 'children')) {
+        const children = serialiseJsx(props.children, indentation + 1);
+        return `${indent}<${type}${serialiseProps(props)}>\n${children}${indent}</${type}>${trailingNewline}`;
+    }
+    return `${indent}<${type}${serialiseProps(props)} />${trailingNewline}`;
+}
+exports.serialiseJsx = serialiseJsx;
+//# sourceMappingURL=ui.cjs.map

package/dist/ui.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.cjs","sourceRoot":"","sources":["../src/ui.tsx"],"names":[],"mappings":";;;;AACA,mDAA+C;AAa/C,iDAiBiC;AACjC,2CAKyB;AACzB,mCAA2C;AAG3C,MAAM,eAAe,GAAG,KAAM,CAAC,CAAC,QAAQ;AACxC,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAEhD;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAA6C;IACrE,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,WAAW;YACd,OAAO,aAAa,CAAC;QACvB;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAO,QAAgB;IACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,KAAmC;IACtD,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,OAAO,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAAC,MAAe;IAC7C,OAAO,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,KAAY;IACzC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,uBAAC,UAAI,IAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,GAAI,CAAC;QAClE,CAAC;QAED,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,IAAI,CAAC;QAEpB,KAAK,QAAQ;YACX,OAAO,CACL,uBAAC,UAAI,cAED,sBAAsB;gBACpB,0DAA0D;gBAC1D,iEAAiE;gBACjE,mCAAmC;gBACnC,KAAK,CAAC,MAAiB,CACR,GAEd,CACR,CAAC;QAEJ,KAAK,IAAI;YACP,OAAO,CACL,uBAAC,YAAM,cAEH,sBAAsB;gBACpB,0DAA0D;gBAC1D,iEAAiE;gBACjE,mCAAmC;gBACnC,KAAK,CAAC,MAAiB,CACN,GAEd,CACV,CAAC;QAEJ;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,KAAa;IAEb,MAAM,UAAU,GAAG,IAAA,cAAK,EAAC,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAChD,MAAM,QAAQ,GACZ,EAAE,CAAC;IAEL,IAAA,mBAAU,EAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAC/B,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,GAAG,KAAyB,CAAC;YAC7C,yFAAyF;YACzF,QAAQ,CAAC,IAAI,CACX,GAAI,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAKpC,CACL,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,4EAA4E;IAC5E,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAI7C,CAAC;AACN,CAAC;AAhCD,0CAgCC;AAED;;;;;;GAMG;AACH,SAAS,yBAAyB,CAAC,SAAoB;IACrD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAA,cAAM,EACJ,QAAQ,IAAI,eAAe,EAC3B,gDACE,eAAe,GAAG,IACpB,MAAM,CACP,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,0BAA0B,CACxC,eAA0B;IAE1B,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,SAAS,UAAU,CAAC,SAAoB;QACtC,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,oBAAQ,CAAC,OAAO;gBACnB,OAAO,uBAAC,aAAO,IAAC,OAAO,EAAE,SAAS,CAAC,KAAK,GAAI,CAAC;YAE/C,KAAK,oBAAQ,CAAC,MAAM;gBAClB,OAAO,CACL,uBAAC,YAAM,IACL,IAAI,EAAE,SAAS,CAAC,IAAI,EACpB,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,EAC5C,IAAI,EAAE,SAAS,CAAC,UAAU,YAEzB,SAAS,CAAC,KAAK,GACT,CACV,CAAC;YAEJ,KAAK,oBAAQ,CAAC,QAAQ;gBACpB,OAAO,CACL,uBAAC,cAAQ,IAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,GAAI,CACrE,CAAC;YAEJ,KAAK,oBAAQ,CAAC,OAAO;gBACnB,OAAO,uBAAC,aAAO,KAAG,CAAC;YAErB,KAAK,oBAAQ,CAAC,IAAI;gBAChB,OAAO,CACL,uBAAC,UAAI,IAAC,IAAI,EAAE,SAAS,CAAC,IAAI,YACvB,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAC3C,CACR,CAAC;YAEJ,KAAK,oBAAQ,CAAC,OAAO;gBACnB,OAAO,uBAAC,aAAO,IAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,GAAI,CAAC;YAEhD,KAAK,oBAAQ,CAAC,KAAK;gBACjB,qEAAqE;gBACrE,OAAO,uBAAC,WAAK,IAAC,GAAG,EAAE,SAAS,CAAC,KAAK,GAAI,CAAC;YAEzC,KAAK,oBAAQ,CAAC,KAAK;gBACjB,OAAO,CACL,uBAAC,WAAK,IAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,YACnD,uBAAC,WAAK,IACJ,IAAI,EAAE,SAAS,CAAC,IAAI,EACpB,IAAI,EAAE,SAAS,CAAC,SAAS,EACzB,KAAK,EAAE,SAAS,CAAC,KAAK,EACtB,WAAW,EAAE,SAAS,CAAC,WAAW,GAClC,GACI,CACT,CAAC;YAEJ,KAAK,oBAAQ,CAAC,KAAK;gBACjB,sCAAsC;gBACtC,OAAO,CACL,uBAAC,SAAG,IAAC,QAAQ,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAI,CACnE,CAAC;YAEJ,KAAK,oBAAQ,CAAC,GAAG;gBACf,OAAO,CACL,uBAAC,SAAG,IAAC,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,YACpD,UAAU,CAAC,SAAS,CAAC,KAAK,CAAgB,GACvC,CACP,CAAC;YAEJ,KAAK,oBAAQ,CAAC,OAAO;gBACnB,OAAO,uBAAC,aAAO,KAAG,CAAC;YAErB,KAAK,oBAAQ,CAAC,IAAI;gBAChB,OAAO,uBAAC,UAAI,cAAE,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAQ,CAAC;YAEtE,4BAA4B;YAC5B;gBACE,OAAO,IAAA,wBAAgB,EAAC,SAAS,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AACrC,CAAC;AAxFD,gEAwFC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,IAAY;IACpC,MAAM,MAAM,GAAG,IAAA,cAAK,EAAC,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAkB,EAAE,CAAC;IAEhC,oDAAoD;IACpD,IAAA,mBAAU,EAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,KAAoB,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,IAAY,EACZ,gBAA0C;IAE1C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAA,cAAM,EACJ,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EACxC,4BAA4B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC5D,CAAC;QAEF,MAAM,QAAQ,GACZ,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;QAEzE,IAAA,cAAM,EAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,mCAAmC,CAAC,CAAC;IAC3E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,gBACE,KAAK,EAAE,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,sBACpD,EAAE,CACH,CAAC;IACJ,CAAC;AACH,CAAC;AAtBD,oCAsBC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAC/B,IAAY,EACZ,gBAA0C;IAE1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AATD,8CASC;AAED;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAC9B,IAAgB,EAChB,gBAA0C;IAE1C,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,EAAE;QAC1B,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC;AAXD,4CAWC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,SAAoB;IACrD,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAE3B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,oBAAQ,CAAC,KAAK;YACjB,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM;YAC9B,oFAAoF;YACpF,qEAAqE;YACrE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAC7C,CAAC,CACF,CAAC;QAEJ,KAAK,oBAAQ,CAAC,GAAG;YACf,OAAO,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE7C,KAAK,oBAAQ,CAAC,IAAI;YAChB,OAAO,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;QAEhC;YACE,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC;AArBD,gDAqBC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,OAAgB;IAIhB,OAAO,IAAA,mBAAW,EAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAND,kCAMC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc,CAAC,KAA2C;IACjE,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,OAAmB;IAChD,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1C,uEAAuE;YACvE,2DAA2D;YAC3D,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC3B,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAdD,wCAcC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,IAA+B,EAC/B,QAAgE,EAChE,KAAK,GAAG,CAAC;IAET,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,OAAO,CAAC,KAAmB,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAClE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IACE,IAAA,mBAAW,EAAC,IAAI,EAAE,OAAO,CAAC;QAC1B,IAAA,qBAAa,EAAC,IAAI,CAAC,KAAK,CAAC;QACzB,IAAA,mBAAW,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,EACnC,CAAC;QACD,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;gBACxD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,OAAO,WAAW,CAAC;gBACrB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAtCD,0BAsCC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAa;IAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,IAAI,GAAG,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAA8B;IACpD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SACzB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAAC;SACrC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;SACtC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;SACxD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAAc,EAAE,WAAW,GAAG,CAAC;IAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,GAAG,MAAM,GAAG,IAAI,IAAI,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAA0B,CAAC;IACnD,MAAM,eAAe,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpD,IAAI,IAAA,mBAAW,EAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,QAAoB,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;QAC3E,OAAO,GAAG,MAAM,IAAI,IAAI,GAAG,cAAc,CACvC,KAAK,CACN,MAAM,QAAQ,GAAG,MAAM,KAAK,IAAI,IAAI,eAAe,EAAE,CAAC;IACzD,CAAC;IAED,OAAO,GAAG,MAAM,IAAI,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,eAAe,EAAE,CAAC;AAC1E,CAAC;AAzBD,oCAyBC","sourcesContent":["import type { Component } from '@metamask/snaps-sdk';\nimport { NodeType } from '@metamask/snaps-sdk';\nimport type {\n  BoldChildren,\n  GenericSnapElement,\n  ItalicChildren,\n  JSXElement,\n  LinkElement,\n  Nestable,\n  RowChildren,\n  SnapNode,\n  StandardFormattingElement,\n  TextChildren,\n} from '@metamask/snaps-sdk/jsx';\nimport {\n  Italic,\n  Link,\n  Bold,\n  Row,\n  Text,\n  Field,\n  Image,\n  Input,\n  Heading,\n  Form,\n  Divider,\n  Spinner,\n  Copyable,\n  Box,\n  Button,\n  Address,\n} from '@metamask/snaps-sdk/jsx';\nimport {\n  assert,\n  assertExhaustive,\n  hasProperty,\n  isPlainObject,\n} from '@metamask/utils';\nimport { lexer, walkTokens } from 'marked';\nimport type { Token, Tokens } from 'marked';\n\nconst MAX_TEXT_LENGTH = 50_000; // 50 kb\nconst ALLOWED_PROTOCOLS = ['https:', 'mailto:'];\n\n/**\n * Get the button variant from a legacy button component variant.\n *\n * @param variant - The legacy button component variant.\n * @returns The button variant.\n */\nfunction getButtonVariant(variant?: 'primary' | 'secondary' | undefined) {\n  switch (variant) {\n    case 'primary':\n      return 'primary';\n    case 'secondary':\n      return 'destructive';\n    default:\n      return undefined;\n  }\n}\n\n/**\n * Get the children of a JSX element. If there is only one child, the child is\n * returned directly. Otherwise, the children are returned as an array.\n *\n * @param elements - The JSX elements.\n * @returns The child or children.\n */\nfunction getChildren<Type>(elements: Type[]) {\n  if (elements.length === 1) {\n    return elements[0];\n  }\n\n  return elements;\n}\n\n/**\n * Get the text of a link token.\n *\n * @param token - The link token.\n * @returns The text of the link token.\n */\nfunction getLinkText(token: Tokens.Link | Tokens.Generic) {\n  if (token.tokens && token.tokens.length > 0) {\n    return getChildren(token.tokens.flatMap(getTextChildFromToken));\n  }\n\n  return token.href;\n}\n\n/**\n * Get the text child from a list of markdown tokens.\n *\n * @param tokens - The markdown tokens.\n * @returns The text child.\n */\nfunction getTextChildFromTokens(tokens: Token[]) {\n  return getChildren(tokens.flatMap(getTextChildFromToken));\n}\n\n/**\n * Get the text child from a markdown token.\n *\n * @param token - The markdown token.\n * @returns The text child.\n */\nfunction getTextChildFromToken(token: Token): TextChildren {\n  switch (token.type) {\n    case 'link': {\n      return <Link href={token.href} children={getLinkText(token)} />;\n    }\n\n    case 'text':\n      return token.text;\n\n    case 'strong':\n      return (\n        <Bold>\n          {\n            getTextChildFromTokens(\n              // Due to the way `marked` is typed, `token.tokens` can be\n              // `undefined`, but it's a required field of `Tokens.Bold`, so we\n              // can safely cast it to `Token[]`.\n              token.tokens as Token[],\n            ) as BoldChildren\n          }\n        </Bold>\n      );\n\n    case 'em':\n      return (\n        <Italic>\n          {\n            getTextChildFromTokens(\n              // Due to the way `marked` is typed, `token.tokens` can be\n              // `undefined`, but it's a required field of `Tokens.Bold`, so we\n              // can safely cast it to `Token[]`.\n              token.tokens as Token[],\n            ) as ItalicChildren\n          }\n        </Italic>\n      );\n\n    default:\n      return null;\n  }\n}\n\n/**\n * Get all text children from a markdown string.\n *\n * @param value - The markdown string.\n * @returns The text children.\n */\nexport function getTextChildren(\n  value: string,\n): (string | StandardFormattingElement | LinkElement)[] {\n  const rootTokens = lexer(value, { gfm: false });\n  const children: (string | StandardFormattingElement | LinkElement | null)[] =\n    [];\n\n  walkTokens(rootTokens, (token) => {\n    if (token.type === 'paragraph') {\n      if (children.length > 0) {\n        children.push('\\n\\n');\n      }\n\n      const { tokens } = token as Tokens.Paragraph;\n      // We do not need to consider nesting deeper than 1 level here and we can therefore cast.\n      children.push(\n        ...(tokens.flatMap(getTextChildFromToken) as (\n          | string\n          | StandardFormattingElement\n          | LinkElement\n          | null\n        )[]),\n      );\n    }\n  });\n\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n  return children.filter((child) => child !== null) as (\n    | string\n    | StandardFormattingElement\n    | LinkElement\n  )[];\n}\n\n/**\n * Validate the text size of a component. The text size is the total length of\n * all text in the component.\n *\n * @param component - The component to validate.\n * @throws An error if the text size exceeds the maximum allowed size.\n */\nfunction validateComponentTextSize(component: Component) {\n  const textSize = getTotalTextLength(component);\n  assert(\n    textSize <= MAX_TEXT_LENGTH,\n    `The text in a Snap UI may not be larger than ${\n      MAX_TEXT_LENGTH / 1000\n    } kB.`,\n  );\n}\n\n/**\n * Get a JSX element from a legacy UI component. This supports all legacy UI\n * components, and maps them to their JSX equivalents where possible.\n *\n * This function validates the text size of the component, but does not validate\n * the total size. The total size of the component should be validated before\n * calling this function.\n *\n * @param legacyComponent - The legacy UI component.\n * @returns The JSX element.\n */\nexport function getJsxElementFromComponent(\n  legacyComponent: Component,\n): JSXElement {\n  validateComponentTextSize(legacyComponent);\n\n  /**\n   * Get the JSX element for a component. This function is recursive and will\n   * call itself for child components.\n   *\n   * @param component - The component to convert to a JSX element.\n   * @returns The JSX element.\n   */\n  function getElement(component: Component) {\n    switch (component.type) {\n      case NodeType.Address:\n        return <Address address={component.value} />;\n\n      case NodeType.Button:\n        return (\n          <Button\n            name={component.name}\n            variant={getButtonVariant(component.variant)}\n            type={component.buttonType}\n          >\n            {component.value}\n          </Button>\n        );\n\n      case NodeType.Copyable:\n        return (\n          <Copyable value={component.value} sensitive={component.sensitive} />\n        );\n\n      case NodeType.Divider:\n        return <Divider />;\n\n      case NodeType.Form:\n        return (\n          <Form name={component.name}>\n            {getChildren(component.children.map(getElement))}\n          </Form>\n        );\n\n      case NodeType.Heading:\n        return <Heading children={component.value} />;\n\n      case NodeType.Image:\n        // `Image` supports `alt`, but the legacy `Image` component does not.\n        return <Image src={component.value} />;\n\n      case NodeType.Input:\n        return (\n          <Field label={component.label} error={component.error}>\n            <Input\n              name={component.name}\n              type={component.inputType}\n              value={component.value}\n              placeholder={component.placeholder}\n            />\n          </Field>\n        );\n\n      case NodeType.Panel:\n        // `Panel` is renamed to `Box` in JSX.\n        return (\n          <Box children={getChildren(component.children.map(getElement))} />\n        );\n\n      case NodeType.Row:\n        return (\n          <Row label={component.label} variant={component.variant}>\n            {getElement(component.value) as RowChildren}\n          </Row>\n        );\n\n      case NodeType.Spinner:\n        return <Spinner />;\n\n      case NodeType.Text:\n        return <Text>{getChildren(getTextChildren(component.value))}</Text>;\n\n      /* istanbul ignore next 2 */\n      default:\n        return assertExhaustive(component);\n    }\n  }\n\n  return getElement(legacyComponent);\n}\n\n/**\n * Extract all links from a Markdown text string using the `marked` lexer.\n *\n * @param text - The markdown text string.\n * @returns A list of URLs linked to in the string.\n */\nfunction getMarkdownLinks(text: string) {\n  const tokens = lexer(text, { gfm: false });\n  const links: Tokens.Link[] = [];\n\n  // Walk the lexed tokens and collect all link tokens\n  walkTokens(tokens, (token) => {\n    if (token.type === 'link') {\n      links.push(token as Tokens.Link);\n    }\n  });\n\n  return links;\n}\n\n/**\n * Validate a link against the phishing list.\n *\n * @param link - The link to validate.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n */\nexport function validateLink(\n  link: string,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  try {\n    const url = new URL(link);\n    assert(\n      ALLOWED_PROTOCOLS.includes(url.protocol),\n      `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`,\n    );\n\n    const hostname =\n      url.protocol === 'mailto:' ? url.pathname.split('@')[1] : url.hostname;\n\n    assert(!isOnPhishingList(hostname), 'The specified URL is not allowed.');\n  } catch (error) {\n    throw new Error(\n      `Invalid URL: ${\n        error?.code === 'ERR_ASSERTION' ? error.message : 'Unable to parse URL.'\n      }`,\n    );\n  }\n}\n\n/**\n * Search for Markdown links in a string and checks them against the phishing\n * list.\n *\n * @param text - The text to verify.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n * @throws If the text contains a link that is not allowed.\n */\nexport function validateTextLinks(\n  text: string,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  const links = getMarkdownLinks(text);\n\n  for (const link of links) {\n    validateLink(link.href, isOnPhishingList);\n  }\n}\n\n/**\n * Walk a JSX tree and validate each {@link LinkElement} node against the\n * phishing list.\n *\n * @param node - The JSX node to walk.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n */\nexport function validateJsxLinks(\n  node: JSXElement,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  walkJsx(node, (childNode) => {\n    if (childNode.type !== 'Link') {\n      return;\n    }\n\n    validateLink(childNode.props.href, isOnPhishingList);\n  });\n}\n\n/**\n * Calculate the total length of all text in the component.\n *\n * @param component - A custom UI component.\n * @returns The total length of all text components in the component.\n */\nexport function getTotalTextLength(component: Component): number {\n  const { type } = component;\n\n  switch (type) {\n    case NodeType.Panel:\n      return component.children.reduce<number>(\n        // This is a bug in TypeScript: https://github.com/microsoft/TypeScript/issues/48313\n        // eslint-disable-next-line @typescript-eslint/restrict-plus-operands\n        (sum, node) => sum + getTotalTextLength(node),\n        0,\n      );\n\n    case NodeType.Row:\n      return getTotalTextLength(component.value);\n\n    case NodeType.Text:\n      return component.value.length;\n\n    default:\n      return 0;\n  }\n}\n\n/**\n * Check if a JSX element has children.\n *\n * @param element - A JSX element.\n * @returns `true` if the element has children, `false` otherwise.\n */\nexport function hasChildren<Element extends JSXElement>(\n  element: Element,\n): element is Element & {\n  props: { children: Nestable<JSXElement | string> };\n} {\n  return hasProperty(element.props, 'children');\n}\n\n/**\n * Filter a JSX child to remove `null`, `undefined`, plain booleans, and empty\n * strings.\n *\n * @param child - The JSX child to filter.\n * @returns `true` if the child is not `null`, `undefined`, a plain boolean, or\n * an empty string, `false` otherwise.\n */\nfunction filterJsxChild(child: JSXElement | string | boolean | null): boolean {\n  return Boolean(child) && child !== true;\n}\n\n/**\n * Get the children of a JSX element as an array. If the element has only one\n * child, the child is returned as an array.\n *\n * @param element - A JSX element.\n * @returns The children of the element.\n */\nexport function getJsxChildren(element: JSXElement): (JSXElement | string)[] {\n  if (hasChildren(element)) {\n    if (Array.isArray(element.props.children)) {\n      // @ts-expect-error - Each member of the union type has signatures, but\n      // none of those signatures are compatible with each other.\n      return element.props.children.filter(filterJsxChild).flat(Infinity);\n    }\n\n    if (element.props.children) {\n      return [element.props.children];\n    }\n  }\n\n  return [];\n}\n\n/**\n * Walk a JSX tree and call a callback on each node.\n *\n * @param node - The JSX node to walk.\n * @param callback - The callback to call on each node.\n * @param depth - The current depth in the JSX tree for a walk.\n * @returns The result of the callback, if any.\n */\nexport function walkJsx<Value>(\n  node: JSXElement | JSXElement[],\n  callback: (node: JSXElement, depth: number) => Value | undefined,\n  depth = 0,\n): Value | undefined {\n  if (Array.isArray(node)) {\n    for (const child of node) {\n      const childResult = walkJsx(child as JSXElement, callback, depth);\n      if (childResult !== undefined) {\n        return childResult;\n      }\n    }\n\n    return undefined;\n  }\n\n  const result = callback(node, depth);\n  if (result !== undefined) {\n    return result;\n  }\n\n  if (\n    hasProperty(node, 'props') &&\n    isPlainObject(node.props) &&\n    hasProperty(node.props, 'children')\n  ) {\n    const children = getJsxChildren(node);\n    for (const child of children) {\n      if (isPlainObject(child)) {\n        const childResult = walkJsx(child, callback, depth + 1);\n        if (childResult !== undefined) {\n          return childResult;\n        }\n      }\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Serialise a JSX prop to a string.\n *\n * @param prop - The JSX prop.\n * @returns The serialised JSX prop.\n */\nfunction serialiseProp(prop: unknown): string {\n  if (typeof prop === 'string') {\n    return `\"${prop}\"`;\n  }\n\n  return `{${JSON.stringify(prop)}}`;\n}\n\n/**\n * Serialise JSX props to a string.\n *\n * @param props - The JSX props.\n * @returns The serialised JSX props.\n */\nfunction serialiseProps(props: Record<string, unknown>): string {\n  return Object.entries(props)\n    .filter(([key]) => key !== 'children')\n    .sort(([a], [b]) => a.localeCompare(b))\n    .map(([key, value]) => ` ${key}=${serialiseProp(value)}`)\n    .join('');\n}\n\n/**\n * Serialise a JSX node to a string.\n *\n * @param node - The JSX node.\n * @param indentation - The indentation level. Defaults to `0`. This should not\n * be set by the caller, as it is used for recursion.\n * @returns The serialised JSX node.\n */\nexport function serialiseJsx(node: SnapNode, indentation = 0): string {\n  if (Array.isArray(node)) {\n    return node.map((child) => serialiseJsx(child, indentation)).join('');\n  }\n\n  const indent = '  '.repeat(indentation);\n  if (typeof node === 'string') {\n    return `${indent}${node}\\n`;\n  }\n\n  if (!node) {\n    return '';\n  }\n\n  const { type, props } = node as GenericSnapElement;\n  const trailingNewline = indentation > 0 ? '\\n' : '';\n\n  if (hasProperty(props, 'children')) {\n    const children = serialiseJsx(props.children as SnapNode, indentation + 1);\n    return `${indent}<${type}${serialiseProps(\n      props,\n    )}>\\n${children}${indent}</${type}>${trailingNewline}`;\n  }\n\n  return `${indent}<${type}${serialiseProps(props)} />${trailingNewline}`;\n}\n"]}

package/dist/ui.d.cts

@@ -0,0 +1,93 @@
+import type { Component } from "@metamask/snaps-sdk";
+import type { JSXElement, LinkElement, Nestable, SnapNode, StandardFormattingElement } from "@metamask/snaps-sdk/jsx";
+/**
+ * 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.
+ */
+export declare function validateLink(link: string, isOnPhishingList: (url: string) => boolean): 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.
+ * @throws If the text contains a link that is not allowed.
+ */
+export declare function validateTextLinks(text: string, isOnPhishingList: (url: string) => boolean): void;
+/**
+ * Walk a JSX tree and validate each {@link LinkElement} node against the
+ * phishing list.
+ *
+ * @param node - The JSX node to walk.
+ * @param isOnPhishingList - The function that checks the link against the
+ * phishing list.
+ */
+export declare function validateJsxLinks(node: JSXElement, isOnPhishingList: (url: string) => boolean): 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

package/dist/ui.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.cts","sourceRoot":"","sources":["../src/ui.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAIV,UAAU,EACV,WAAW,EACX,QAAQ,EAER,QAAQ,EACR,yBAAyB,EAE1B,gCAAgC;AAuIjC;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,GACZ,CAAC,MAAM,GAAG,yBAAyB,GAAG,WAAW,CAAC,EAAE,CA8BtD;AAmBD;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,SAAS,GACzB,UAAU,CAsFZ;AAsBD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAoB3C;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAO3C;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,UAAU,EAChB,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAS3C;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAqB/D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,SAAS,UAAU,EACpD,OAAO,EAAE,OAAO,GACf,OAAO,IAAI,OAAO,GAAG;IACtB,KAAK,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,CAAA;KAAE,CAAC;CACpD,CAEA;AAcD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAc3E;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAC3B,IAAI,EAAE,UAAU,GAAG,UAAU,EAAE,EAC/B,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,GAAG,SAAS,EAChE,KAAK,SAAI,GACR,KAAK,GAAG,SAAS,CAkCnB;AA8BD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,SAAI,GAAG,MAAM,CAyBpE"}

package/dist/ui.d.mts

@@ -0,0 +1,93 @@
+import type { Component } from "@metamask/snaps-sdk";
+import type { JSXElement, LinkElement, Nestable, SnapNode, StandardFormattingElement } from "@metamask/snaps-sdk/jsx";
+/**
+ * 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.
+ */
+export declare function validateLink(link: string, isOnPhishingList: (url: string) => boolean): 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.
+ * @throws If the text contains a link that is not allowed.
+ */
+export declare function validateTextLinks(text: string, isOnPhishingList: (url: string) => boolean): void;
+/**
+ * Walk a JSX tree and validate each {@link LinkElement} node against the
+ * phishing list.
+ *
+ * @param node - The JSX node to walk.
+ * @param isOnPhishingList - The function that checks the link against the
+ * phishing list.
+ */
+export declare function validateJsxLinks(node: JSXElement, isOnPhishingList: (url: string) => boolean): 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.mts.map

package/dist/ui.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.mts","sourceRoot":"","sources":["../src/ui.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAIV,UAAU,EACV,WAAW,EACX,QAAQ,EAER,QAAQ,EACR,yBAAyB,EAE1B,gCAAgC;AAuIjC;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,GACZ,CAAC,MAAM,GAAG,yBAAyB,GAAG,WAAW,CAAC,EAAE,CA8BtD;AAmBD;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,SAAS,GACzB,UAAU,CAsFZ;AAsBD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAoB3C;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAO3C;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,UAAU,EAChB,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,QAS3C;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAqB/D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,SAAS,UAAU,EACpD,OAAO,EAAE,OAAO,GACf,OAAO,IAAI,OAAO,GAAG;IACtB,KAAK,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,CAAA;KAAE,CAAC;CACpD,CAEA;AAcD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAc3E;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAC3B,IAAI,EAAE,UAAU,GAAG,UAAU,EAAE,EAC/B,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,KAAK,GAAG,SAAS,EAChE,KAAK,SAAI,GACR,KAAK,GAAG,SAAS,CAkCnB;AA8BD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,SAAI,GAAG,MAAM,CAyBpE"}