metamask-extension/ui/components/app/metamask-translation/metamask-translation.js

import React from 'react';
import PropTypes from 'prop-types';
import { useI18nContext } from '../../../hooks/useI18nContext';
import MetaMaskTemplateRenderer, {
  SectionShape,
} from '../metamask-template-renderer/metamask-template-renderer';

/**
 * MetaMaskTranslation is a simple helper component for adding full translation
 * support to the template system. We do pass the translation function to the
 * template getValues function, but passing it React components as variables
 * would require React to be in scope, and breaks the object pattern paradigm.
 *
 * This component gets around that by converting variables that are templates
 * themselves into tiny React trees. This component does additional validation
 * to make sure that the tree has a single root node, with maximum two leaves.
 * Each subnode can have a maximum of one child that must be a string.
 *
 * This enforces a maximum recursion depth of 2, preventing translation strings
 * from being performance hogs. We could further limit this, and also attenuate
 * the safeComponentList for what kind of components we allow these special
 * trees to contain.
 *
 * @param options
 * @param options.translationKey
 * @param options.variables
 */
export default function MetaMaskTranslation({ translationKey, variables }) {
  const t = useI18nContext();

  return t(
    translationKey,
    variables?.map((variable) => {
      if (
        typeof variable === 'object' &&
        !Array.isArray(variable) &&
        variable.element
      ) {
        if (!variable.key) {
          throw new Error(
            `When using MetaMask Template Language in a MetaMaskTranslation variable, you must provide a key for the section regardless of syntax.
            Section with element '${variable.element}' for translationKey: '${translationKey}' has no key property`,
          );
        }
        if (
          variable.children &&
          Array.isArray(variable.children) &&
          variable.children.length > 2
        ) {
          throw new Error(
            'MetaMaskTranslation only renders templates with a single section and maximum two children',
          );
        } else if (
          (variable.children?.[0]?.children !== undefined &&
            typeof variable.children[0].children !== 'string') ||
          (variable.children?.[1]?.children !== undefined &&
            typeof variable.children[1].children !== 'string')
        ) {
          throw new Error(
            'MetaMaskTranslation does not allow for component trees of non trivial depth',
          );
        }
        return (
          <MetaMaskTemplateRenderer
            key={`${translationKey}-${variable.key}`}
            sections={variable}
          />
        );
      }
      return variable;
    }),
  );
}

MetaMaskTranslation.propTypes = {
  /**
   * Translation object key
   */
  translationKey: PropTypes.string.isRequired,
  /**
   * Array of variables for the MetaMaskTranslation component
   */
  variables: PropTypes.arrayOf(
    PropTypes.oneOfType([
      PropTypes.string,
      PropTypes.number,
      PropTypes.shape(SectionShape),
    ]),
  ),
};