@yext/phonenumber-util 0.1.0

package/src/index.js

@@ -0,0 +1,380 @@
+import { AREA_CODE_LIST } from './areaCodeList.js';
+import { PHONE_FORMATS } from './phoneFormats.js';
+
+const DASHES = '-\u2010-\u2015\u2212\u30FC\uFF0D';
+const SLASHES = '\uFF0F/';
+const DOTS = '\uFF0E.';
+const WHITESPACE = ' \u00A0\u00AD\u200B\u2060\u3000';
+const BRACKETS = '()\\[\\]\uFF08\uFF09\uFF3B\uFF3D';
+const TILDES = '~\u2053\u223C\uFF5E';
+const VALID_DIGITS = '0-9';
+const PLUS_CHARS = '\\+';
+
+const VALID_PUNCTUATION = `${DASHES}${SLASHES}${DOTS}${WHITESPACE}${BRACKETS}${TILDES}`;
+
+const VALID_PHONE_NUMBER = new RegExp(
+  `(?:(?:${PLUS_CHARS}?[${VALID_DIGITS}]{1,3}[${VALID_PUNCTUATION}]*)?` + // Country code (optional)
+    `(?:\\(?[${VALID_DIGITS}]{1,4}\\)?[${VALID_PUNCTUATION}]*)?` + // Area code (optional)
+    `(?:[${VALID_DIGITS}]{1,4}[${VALID_PUNCTUATION}]*){1,5}` + // Phone number segments
+    `[${VALID_DIGITS}]{1,4})`, // Final segment
+);
+
+/**
+ * Formats a phone number into the E.164 international standard.
+ *
+ * This function takes the components of a phone number and formats it into the
+ * E.164 standard, which includes the region code and the local number. The format
+ *
+ * @param {Object} phoneParts - An object containing parts of the phone number.
+ * @param {string} phoneParts.areaCode - The area code of the phone number.
+ * @param {string} phoneParts.regionCode - The region code of the phone number.
+ * @param {string} phoneParts.localNumber - The local part of the phone number.
+ * @returns {string|null} The formatted phone number in E.164 format, or null if the region code or local number is not present.
+ */
+export const formatPhoneNumberForE164 = ({
+  regionCode,
+  areaCode,
+  localNumber,
+}) => {
+  if ((regionCode !== '1' || areaCode) && regionCode && localNumber) {
+    // A US number passed with area code decoupled from the localNumber.  Assumes the format:
+    // regionCode: 1, areaCode: 310, localNumber: 3496200
+    if (regionCode === '1' && areaCode && localNumber.length === 7) {
+      return `+1${areaCode}${localNumber}`;
+    }
+    // Combine the region code and the formatted local number - this assumes US localNumber includes area code
+    // This is for all intl and all US with format:
+    // regionCode: 1, localNumber: 3103496200
+    return areaCode ? `+1${localNumber}` : `+${regionCode}${localNumber}`;
+  }
+
+  return null;
+};
+
+/**
+ * Formats a phone number into a tel: link format.
+ *
+ * This function takes the components of a phone number and formats it into a
+ * `tel:` link, which can be used in HTML for clickable phone numbers.
+ *
+ * @param {Object} phoneParts - An object containing parts of the phone number.
+ * @param {string} phoneParts.regionCode - The region code of the phone number.
+ * @param {string} phoneParts.areaCode - The area code of the phone number.
+ * @param {string} phoneParts.localNumber - The local part of the phone number.
+ * @returns {string|null} The formatted phone number link, or null if the local number is not present.
+ */
+export const formatPhoneNumberLink = ({
+  regionCode,
+  areaCode,
+  localNumber,
+}) => {
+  if (localNumber) {
+    if (regionCode === '1') {
+      return areaCode
+        ? `tel:+1${areaCode}${localNumber}`
+        : `tel:${localNumber}`;
+    } else {
+      return `tel:+${regionCode}${localNumber}`;
+    }
+  }
+
+  return null;
+};
+
+/**
+ * Validates a phone number based on a regex pattern and the ability to extract useful parts.
+ *
+ * This function first checks the phone number against a predefined regular expression pattern
+ * to determine its validity. It then uses the `getPhoneParts` function to extract relevant parts
+ * of the phone number and further confirms its validity based on the presence of these parts.
+ *
+ * @param {string} phoneNumber - The phone number to validate.
+ * @returns {boolean} Returns true if the phone number is valid, otherwise false.
+ */
+export const isValidPhoneNumber = (phoneNumber) => {
+  // Check the big chunky regex for phone validity
+  const phonePattern = new RegExp(VALID_PHONE_NUMBER, 'ig');
+  if (phonePattern.test(phoneNumber)) {
+    const phoneParts = getPhoneParts(phoneNumber);
+
+    // Also check for phone validity by ability to extract useful parts.
+    // This will also confirm area codes / region codes are valid.
+    if (
+      phoneParts &&
+      phoneParts.localNumber &&
+      phoneParts.regionCode &&
+      (phoneParts.areaCode || phoneParts.regionCode !== '1')
+    ) {
+      return true;
+    }
+  }
+  return false;
+};
+
+/**
+ * Extracts and formats parts of a phone number, including area code, region code, and local number.
+ *
+ * This function takes a phone number and optionally a region code, then processes it to extract
+ * relevant parts like the area code, region code, and local number. It also validates the phone
+ * number and ensures it conforms to specific formats, particularly for US numbers.
+ *
+ * @param {string} phoneNumber - The phone number to process.
+ * @returns {Object} An object containing relevant phone number information.
+ * @property {string|null} areaCode - The area code of the phone number.
+ * @property {string|null} e164 - The E.164 formatted version of the phone number.
+ * @property {string|null} href - A formatted phone number link.
+ * @property {string|null} localNumber - The local part of the phone number.
+ * @property {string} rawNumber - The original raw phone number.  Unsanitized.
+ * @property {string|null} regionCode - The region code of the phone number.
+ */
+export const getPhoneParts = (phoneNumber) => {
+  const regionCodeLengths = [1, 2, 3];
+  let phoneParts = {
+    areaCode: null,
+    e164: null,
+    format: null,
+    formattedNumber: null,
+    href: null,
+    localNumber: null,
+    rawNumber: phoneNumber,
+    regionCode: null,
+  };
+
+  if (!phoneNumber) {
+    return phoneParts;
+  }
+
+  // Remove all non-digit characters except the leading '+'
+  let strippedPhoneNumber = sanitizeRawNumber(phoneNumber);
+
+  // The shortest length for a phone number (that we care about) is 7 digits.
+  // The longest phone number is 15 digits.
+  if (
+    strippedPhoneNumber.replace(/\D/g, '').length >= 7 &&
+    strippedPhoneNumber.replace(/\D/g, '').length <= 15
+  ) {
+    // Extract the region code if not explicitly provided and it is part of the
+    // phone number
+    if (strippedPhoneNumber.startsWith('+')) {
+      // US number formatted with +12065551234
+      if (
+        strippedPhoneNumber.length === 12 &&
+        strippedPhoneNumber.startsWith('+1')
+      ) {
+        phoneParts.regionCode = '1';
+        phoneParts.localNumber = strippedPhoneNumber.slice(2); // Strip out the "+1"
+        phoneParts.areaCode = phoneParts.localNumber.slice(0, 3); // Grab the area code
+      }
+      // Otherwise, an intl number which may have 1, 2 or 3 digit region
+      else if (
+        strippedPhoneNumber.length >= 7 &&
+        strippedPhoneNumber.length <= 14
+      ) {
+        // Try to match the phone number with each possible region code length
+        for (let length of regionCodeLengths) {
+          let match = strippedPhoneNumber.match(
+            new RegExp(`^\\+(\\d{${length}})(\\d+)`),
+          );
+          if (match && PHONE_FORMATS[match[1]]) {
+            phoneParts.regionCode = match[1];
+            phoneParts.localNumber = match[2];
+            break;
+          }
+        }
+      }
+    }
+    // If no region code is provided, assume US with the format 3109309000 after being stripped of non-numeric values.
+    // We'll try and derive the area code by looking it up against the known area codes.
+    else if (strippedPhoneNumber.length === 10) {
+      if (AREA_CODE_LIST.indexOf(strippedPhoneNumber.substring(0, 3)) !== -1) {
+        phoneParts.regionCode = '1';
+        phoneParts.areaCode = strippedPhoneNumber.substring(0, 3);
+        phoneParts.localNumber = strippedPhoneNumber.substring(3);
+      }
+    }
+    // If no region code is provided, assume US with the format 9309000 after being stripped of non-numeric values.
+    // This is not able to be validated or formatted since it lacks an area code.
+    else if (strippedPhoneNumber.length === 7) {
+      phoneParts.regionCode = '1';
+      phoneParts.localNumber = strippedPhoneNumber;
+    }
+
+    // Default to region code 1 for US numbers if none is provided
+    if (
+      strippedPhoneNumber.length === 11 &&
+      strippedPhoneNumber.startsWith('1')
+    ) {
+      phoneParts.regionCode = '1';
+      phoneParts.localNumber = strippedPhoneNumber.slice(1);
+      phoneParts.areaCode = phoneParts.localNumber.slice(0, 3);
+    }
+
+    // US likes a format that isn't as common
+    if (phoneParts.localNumber && phoneParts.regionCode === '1') {
+      // Specific format for US numbers with areaCode (206-930-9000).
+      if (phoneParts.localNumber.length === 10) {
+        phoneParts.areaCode = phoneParts.localNumber.slice(0, 3);
+      }
+    } else if (phoneParts.localNumber) {
+      // General format for shorter numbers
+      phoneParts.localNumber = phoneParts.localNumber.replace(/\D/g, '');
+    }
+  }
+
+  // Unset any known invalid area codes.  We only care about region 1 (USA).
+  if (
+    AREA_CODE_LIST.indexOf(phoneParts.areaCode) === -1 ||
+    phoneParts.regionCode !== '1'
+  ) {
+    phoneParts.areaCode = null;
+  }
+
+  if (phoneParts.localNumber && phoneParts.regionCode) {
+    phoneParts.href = formatPhoneNumberLink(phoneParts);
+    phoneParts.e164 = formatPhoneNumberForE164(phoneParts);
+    phoneParts.format = findPhoneFormat(phoneParts);
+    phoneParts.formattedNumber = formatPhoneNumber(phoneParts);
+
+    // If there are left over x's, the formatting ran into something unexpected.
+    // This may be ok depending on the region and their phone number formats.
+    // But it does mean we don't want to display this number.
+    if (
+      phoneParts.formattedNumber &&
+      phoneParts.formattedNumber.indexOf('x') !== -1
+    ) {
+      // Since `rawNumber` isn't sanitized, we'll use a simple format that we
+      // are assured to be safe.
+      phoneParts.formattedNumber = strippedPhoneNumber;
+    }
+  }
+
+  return phoneParts;
+};
+
+/**
+ * Sanitizes a phone number by removing all non-numeric characters
+ * except for the leading plus sign (+) if it exists.
+ *
+ * @param {string} phoneNumber - The raw phone number input.
+ * @returns {string} - The sanitized phone number containing only digits and an optional leading plus sign.
+ */
+export const sanitizeRawNumber = (phoneNumber) => {
+  return phoneNumber.replace(/(?!^\+)\D/g, '');
+};
+
+/**
+ * Finds valid phone numbers in a given text string.
+ *
+ * This function uses a regular expression to locate potential phone numbers in the text.
+ * Valid matches are then processed to extract relevant information.
+ *
+ * @param {string} text - The text string to search for phone numbers.
+ * @returns {Array<Object>} An array of objects, each containing the index, lastIndex, and parts of the valid phone numbers found.
+ * @property {number} index - The starting index of the phone number in the text.
+ * @property {number} lastIndex - The ending index of the phone number in the text.
+ * @property {Object} phoneParts - The parts of the phone number, as returned by the getPhoneParts function.
+ */
+export const findNumbersInString = (text) => {
+  const regex = new RegExp(VALID_PHONE_NUMBER, 'g');
+  let matches = [];
+  let match;
+
+  // Regex finds possible matches.  Go through each of them to further validate and extract relevant info.
+  while ((match = regex.exec(text)) !== null) {
+    let number = match[0].trim(); // Access the captured group
+
+    // Ensure number is not just a partial match by checking it contains at least 6 digits.
+    if (
+      number.replace(new RegExp(`[${VALID_PUNCTUATION}]`, 'g'), '').length >= 6
+    ) {
+      const index = text.indexOf(number);
+      const lastIndex = index + number.length;
+      const phoneParts = getPhoneParts(number);
+
+      // Presumed phone numbers may be invalidated by omission of formattedNumber from getPhoneParts.
+      // This will prevent short-numbers that ommit area code from being fetched from a larger string since it may be unreliable.
+      if (phoneParts.formattedNumber) {
+        matches.push({
+          index,
+          lastIndex,
+          ...phoneParts,
+        });
+      }
+    }
+  }
+
+  return matches;
+};
+
+/**
+ * Finds the phone number format for a given region code.
+ *
+ * This function retrieves the phone number format corresponding to the provided
+ * region code from the PHONE_FORMATS object. If the region code is not found,
+ * it defaults to the format for region code '1' (US).
+ *
+ * @param {Object} params - The parameters for formatting the phone number.
+ * @param {string} regionCode - The region code to look up the phone number format.
+ * @param {string} params.e164 - The E.164 formatted phone number to format. Example: `+12065551234`.
+ * @returns {string} The phone number format for the given region code in the format of "(xxx) xxx-xxxx".
+ */
+export const findPhoneFormat = ({ regionCode, e164 }) => {
+  const formatRaw = PHONE_FORMATS[regionCode];
+  const numberLength = e164 && e164.replace(/\D/g, '').length;
+  // If the region isn't defined or no matching length is found in the PHONE_FORMATS, we'll fall back to the US format.
+  let format = PHONE_FORMATS[1];
+
+  if (formatRaw && numberLength) {
+    // The PHONE_FORMATS will have arrays for regions with inconsistent number lengths / formats.
+    if (Array.isArray(formatRaw)) {
+      formatRaw.forEach((value) => {
+        const templateLength = value.split('x').length - 1;
+        if (numberLength === templateLength) {
+          format = value;
+        }
+      });
+    }
+    // Some region (such as the US) will have a consistent format, so we expect a string.
+    else if (formatRaw) {
+      format = formatRaw;
+    }
+  }
+
+  return format;
+};
+
+/**
+ * Formats a phone number according to a specified format.
+ *
+ * This function takes a desired format string and an E.164 formatted phone number,
+ * then formats the phone number according to the provided format. The format string
+ * uses 'x' characters to represent digits from the phone number.
+ *
+ * @param {Object} params - The parameters for formatting the phone number.
+ * @param {string} params.format - The desired format for the phone number. Example: `(xxx) xxx-xxxx`.
+ * @param {string} params.e164 - The E.164 formatted phone number to format. Example: `+12065551234`.
+ * @returns {string|null} The formatted phone number, or null if the E.164 number or format is not provided.
+ */
+export const formatPhoneNumber = ({ format, e164 }) => {
+  let formattedNumber = '';
+
+  if (e164 && format) {
+    // Remove the leading '+' and let the format handle it.
+    const strippedPhone = e164.replace(/\D/g, '');
+    let phoneIndex = strippedPhone.length - 1;
+
+    // Traverse backward so we can omit country code in some formats (like US).
+    for (let i = format.length; i >= 0; i--) {
+      if (format[i]) {
+        if (format[i].toLowerCase() === 'x' && strippedPhone[phoneIndex]) {
+          formattedNumber = strippedPhone[phoneIndex] + formattedNumber;
+          phoneIndex -= 1;
+        } else {
+          formattedNumber = format[i] + formattedNumber;
+        }
+      }
+    }
+  }
+
+  return formattedNumber || null;
+};

package/src/phoneFormats.js

@@ -0,0 +1,212 @@
+export const PHONE_FORMATS = {
+  1: '(xxx) xxx-xxxx', // United States
+  7: '+x xxx xxx-xx-xx', // Russia
+  20: '+xx x xxxxxxxx', // Egypt
+  27: '+xx xx xxx xxxx', // South Africa
+  30: '+xx xxx xxx xxxx', // Greece
+  31: '+xx xx xxx xxxx', // Netherlands
+  32: '+xx xxx xx xx xx', // Belgium
+  33: '+xx x xx xx xx xx', // France
+  34: '+xx xxx xx xx xx', // Spain
+  36: '+xx xx xxx xxxx', // Hungary
+  39: '+xx xxx xxx xxxx', // Italy
+  40: '+xx xxx xxx xxxx', // Romania
+  41: '+xx xx xxx xx xx', // Switzerland
+  43: '+xx xxx xxx xxxx', // Austria
+  44: '+xx xxxx xxxxxx', // United Kingdom
+  45: '+xx xx xx xx xx', // Denmark
+  46: '+xx xx xxx xx xx', // Sweden
+  47: '+xx xxx xx xxx', // Norway
+  48: '+xx xxx xxx xxx', // Poland
+  49: [
+    '+xx xx xxxxxx',
+    '+xx xx xxxxxxx',
+    '+xx xx xxxxxxxx',
+    '+xx xxx xxxxxxxx',
+  ], // Germany
+  51: '+xx xxx xxx xxx', // Peru
+  52: '+xx x xxxx xxxx', // Mexico
+  53: '+x xxx xxxx', // Cuba
+  54: '+xx xx xxxx xxxx', // Argentina
+  55: '+xx xx xxxx xxxx', // Brazil
+  56: '+xx x xxxx xxxx', // Chile
+  57: '+xx xxx xxx xxxx', // Colombia
+  58: '+xx xxx xxx xxxx', // Venezuela
+  60: '+xx xx xxx xxxx', // Malaysia
+  61: '+xx xxxx xxxx', // Australia
+  62: '+xx xxx xxx xxx', // Indonesia
+  63: '+xx xxx xxx xxxx', // Philippines
+  64: '+xx xxx xxx xxxx', // New Zealand
+  65: '+xx xxxx xxxx', // Singapore
+  66: '+xx xx xxx xxxx', // Thailand
+  81: '+xx xx xxxx xxxx', // Japan
+  82: '+xx xx xxx xxxx', // South Korea
+  84: '+xx xxx xxxx xxxx', // Vietnam
+  86: '+xx xxx xxxx xxxx', // China
+  90: '+xx xxx xxx xxxx', // Turkey
+  91: '+xx xx xxxx xxxx', // India
+  92: '+xx xxx xxx xxxx', // Pakistan
+  93: '+xx xx xxx xxxx', // Afghanistan
+  94: '+xx xx xxx xxxx', // Sri Lanka
+  95: '+xx xxx xxx xxxx', // Myanmar
+  98: '+xx xxx xxx xxxx', // Iran
+  211: '+xxx xxx xxxx', // South Sudan
+  212: '+xxx xx xx xx xx', // Morocco
+  213: '+xxx xx xx xx', // Algeria
+  216: '+xxx xx xxx', // Tunisia
+  218: '+xxx xx xxx xxx', // Libya
+  220: '+xxx xxx xxxx', // Gambia
+  221: '+xxx xxx xxx xxx', // Senegal
+  222: '+xxx xxx xxxx', // Mauritania
+  223: '+xxx xxx xxxx', // Mali
+  224: '+xxx xxx xxx xxx', // Guinea
+  225: '+xxx xx xx xx xx', // Ivory Coast
+  226: '+xxx xx xx xx xx', // Burkina Faso
+  227: '+xxx xx xx xx xx', // Niger
+  228: '+xxx xxx xxx xxx', // Togo
+  229: '+xxx xx xx xx xx', // Benin
+  230: '+xxx xxxx xxxx', // Mauritius
+  231: '+xxx xx xx xx xx', // Liberia
+  232: '+xxx xxx xxxx', // Sierra Leone
+  233: '+xxx xxx xxxx', // Ghana
+  234: '+xxx xxx xxxx xxxx', // Nigeria
+  235: '+xxx xx xx xx xx', // Chad
+  236: '+xxx xx xx xx xx', // Central African Republic
+  237: '+xxx xxxx xxxx', // Cameroon
+  238: '+xxx xxxx xxxx', // Cape Verde
+  239: '+xxx xxxx xxxx', // Sao Tome and Principe
+  240: '+xxx xxx xxxx xxxx', // Equatorial Guinea
+  241: '+xxx xxx xxxx xxxx', // Gabon
+  242: '+xxx xxx xxxx xxxx', // Republic of the Congo
+  243: '+xxx xxx xxxx xxxx', // Democratic Republic of the Congo
+  244: '+xxx xxx xxxx xxxx', // Angola
+  245: '+xxx xxx xxxx xxxx', // Guinea-Bissau
+  246: '+xxx xxx xxxx', // British Indian Ocean Territory
+  248: '+xxx xxxx xxxx', // Seychelles
+  249: '+xxx xxx xxxx xxxx', // Sudan
+  250: '+xxx xxx xxxx xxxx', // Rwanda
+  251: '+xxx xxx xxxx xxxx', // Ethiopia
+  252: '+xxx xxx xxxx xxxx', // Somalia
+  253: '+xxx xxx xxxx xxxx', // Djibouti
+  254: '+xxx xxx xxxx xxxx', // Kenya
+  255: '+xxx xxx xxxx xxxx', // Tanzania
+  256: '+xxx xxx xxxx xxxx', // Uganda
+  257: '+xxx xx xx xx xx', // Burundi
+  258: '+xxx xxx xxxx xxxx', // Mozambique
+  260: '+xxx xxx xxxx xxxx', // Zambia
+  261: '+xxx xx xx xx xx', // Madagascar
+  263: '+xxx xxx xxxx xxxx', // Zimbabwe
+  264: '+xxx xxx xxxx xxxx', // Namibia
+  265: '+xxx xxx xxxx xxxx', // Malawi
+  266: '+xxx xx xx xx xx', // Lesotho
+  267: '+xxx xxx xxxx xxxx', // Botswana
+  268: '+xxx xx xx xx xx', // Eswatini
+  269: '+xxx xx xx xx xx', // Comoros
+  290: '+xxx xxxx xxxx', // Saint Helena
+  291: '+xxx xxx xxxx xxxx', // Eritrea
+  297: '+xxx xxxx xxxx', // Aruba
+  298: '+xxx xxx xxx', // Faroe Islands
+  299: '+xxx xxx xxx xxx', // Greenland
+  350: '+xxx xxx xxxx xxxx', // Gibraltar
+  351: '+xxx xxx xxxx xxxx', // Portugal
+  352: '+xxx xxx xxxx xxxx', // Luxembourg
+  353: '+xxx xxx xxxx xxxx', // Ireland
+  354: '+xxx xxx xxxx xxxx', // Iceland
+  355: '+xxx xxx xxxx xxxx', // Albania
+  356: '+xxx xx xx xx xx', // Malta
+  357: '+xxx xxx xxxx xxxx', // Cyprus
+  358: '+xxx xxx xxxx xxxx', // Finland
+  359: '+xxx xxx xxxx xxxx', // Bulgaria
+  370: '+xxx xxx xxxx xxxx', // Lithuania
+  371: '+xxx xxx xxxx xxxx', // Latvia
+  372: '+xxx xxx xxxx xxxx', // Estonia
+  373: '+xxx xxx xxxx xxxx', // Moldova
+  374: '+xxx xxx xxxx xxxx', // Armenia
+  375: '+xxx xxx xxxx xxxx', // Belarus
+  376: '+xxx xxx xxxx xxxx', // Andorra
+  377: '+xxx xxx xxxx xxxx', // Monaco
+  378: '+xxx xxx xxxx xxxx', // San Marino
+  379: '+xxx xxx xxxx xxxx', // Vatican
+  380: '+xxx xxx xxxx xxxx', // Ukraine
+  381: '+xxx xxx xxxx xxxx', // Serbia
+  382: '+xxx xxx xxxx xxxx', // Montenegro
+  383: '+xxx xxx xxxx xxxx', // Kosovo
+  385: '+xxx xxx xxxx xxxx', // Croatia
+  386: '+xxx xxx xxxx xxxx', // Slovenia
+  387: '+xxx xxx xxxx xxxx', // Bosnia and Herzegovina
+  389: '+xxx xxx xxxx xxxx', // North Macedonia
+  420: '+xxx xxx xxxx xxxx', // Czech Republic
+  421: '+xxx xxx xxxx xxxx', // Slovakia
+  423: '+xxx xxxx xxxx xxxx', // Liechtenstein
+  500: '+xxx xxxx xxxx', // Falkland Islands
+  501: '+xxx xxxx xxxx', // Belize
+  502: '+xxx xxxx xxxx', // Guatemala
+  503: '+xxx xxxx xxxx', // El Salvador
+  504: '+xxx xxxx xxxx', // Honduras
+  505: '+xxx xxxx xxxx', // Nicaragua
+  506: '+xxx xxxx xxxx', // Costa Rica
+  507: '+xxx xxxx xxxx', // Panama
+  508: '+xxx xxxx xxxx', // Saint Pierre and Miquelon
+  509: '+xxx xxxx xxxx', // Haiti
+  590: '+xxx xxxx xxxx', // Saint Martin
+  591: '+xxx xxx xxxx xxxx', // Bolivia
+  592: '+xxx xxxx xxxx', // Guyana
+  593: '+xxx xxx xxxx xxxx', // Ecuador
+  594: '+xxx xxxx xxxx', // French Guiana
+  595: '+xxx xxx xxxx xxxx', // Paraguay
+  596: '+xxx xxxx xxxx', // Martinique
+  597: '+xxx xxxx xxxx', // Suriname
+  598: '+xxx xxx xxxx xxxx', // Uruguay
+  599: '+xxx xxxx xxxx xxxx', // Curaçao
+  670: '+xxx xxxx xxxx', // East Timor
+  672: '+xxx xxxx xxxx', // Antarctica
+  673: '+xxx xxxx xxxx', // Brunei
+  674: '+xxx xxxx xxxx', // Nauru
+  675: '+xxx xxxx xxxx xxxx', // Papua New Guinea
+  676: '+xxx xxxx xxxx xxxx', // Tonga
+  677: '+xxx xxxx xxxx xxxx', // Solomon Islands
+  678: '+xxx xxxx xxxx xxxx', // Vanuatu
+  679: '+xxx xxxx xxxx xxxx', // Fiji
+  680: '+xxx xxxx xxxx xxxx', // Palau
+  681: '+xxx xxxx xxxx xxxx', // Wallis and Futuna
+  682: '+xxx xxxx xxxx xxxx', // Cook Islands
+  683: '+xxx xxxx xxxx xxxx', // Niue
+  685: '+xxx xxxx xxxx xxxx', // Samoa
+  686: '+xxx xxxx xxxx xxxx', // Kiribati
+  687: '+xxx xxxx xxxx xxxx', // New Caledonia
+  688: '+xxx xxxx xxxx xxxx', // Tuvalu
+  689: '+xxx xxxx xxxx xxxx', // French Polynesia
+  690: '+xxx xxxx xxxx xxxx', // Tokelau
+  691: '+xxx xxxx xxxx xxxx', // Micronesia
+  692: '+xxx xxxx xxxx xxxx', // Marshall Islands
+  850: '+xxx xxxx xxxx xxxx', // North Korea
+  852: '+xxx xxxx xxxx xxxx', // Hong Kong
+  853: '+xxx xxxx xxxx xxxx', // Macau
+  855: '+xxx xxx xxxx xxxx', // Cambodia
+  856: '+xxx xxxx xxxx xxxx', // Laos
+  880: '+xxx xxx xxxx xxxx', // Bangladesh
+  886: '+xxx xxxx xxxx xxxx', // Taiwan
+  960: '+xxx xxx xxxx xxxx', // Maldives
+  961: '+xxx xxx xxxx xxxx', // Lebanon
+  962: '+xxx xxxx xxxx xxxx', // Jordan
+  963: '+xxx xxxx xxxx xxxx', // Syria
+  964: '+xxx xxxx xxxx xxxx', // Iraq
+  965: '+xxx xxxx xxxx xxxx', // Kuwait
+  966: '+xxx xxxx xxxx xxxx', // Saudi Arabia
+  967: '+xxx xxxx xxxx xxxx', // Yemen
+  968: '+xxx xxxx xxxx xxxx', // Oman
+  970: '+xxx xxx xxxx xxxx', // Palestine
+  971: '+xxx xxx xxxx xxxx', // United Arab Emirates
+  972: '+xxx xxxx xxxx xxxx', // Israel
+  973: '+xxx xxxx xxxx xxxx', // Bahrain
+  974: '+xxx xxxx xxxx xxxx', // Qatar
+  975: '+xxx xxxx xxxx xxxx', // Bhutan
+  976: '+xxx xxx xxxx xxxx', // Mongolia
+  977: '+xxx xxxx xxxx xxxx', // Nepal
+  992: '+xxx xxxx xxxx xxxx', // Tajikistan
+  993: '+xxx xxx xxxx xxxx', // Turkmenistan
+  994: '+xxx xxx xxxx xxxx', // Azerbaijan
+  995: '+xxx xxxx xxxx xxxx', // Georgia
+  996: '+xxx xxxx xxxx xxxx', // Kyrgyzstan
+  998: '+xxx xxxx xxxx xxxx', // Uzbekistan
+};

package/vitest.config.js

@@ -0,0 +1,6 @@
+export default {
+  test: {
+    globals: true,
+    environment: 'node',
+  },
+};