intl-tel-input 27.3.1 → 28.0.0

package/dist/js/intlTelInput.mjs

@@ -1,4 +1,4 @@
-// src/js/data.ts
+// packages/core/src/js/data.ts
 var rawCountryData = [
   [
     "af",
@@ -1750,7 +1750,7 @@ var iso2Set = new Set(allCountries.map((c) => c.iso2));
 var isIso2 = (val) => iso2Set.has(val);
 var data_default = allCountries;
 
-// src/js/constants.ts
+// packages/core/src/js/constants.ts
 var EVENTS = {
   OPEN_COUNTRY_DROPDOWN: "open:countrydropdown",
   CLOSE_COUNTRY_DROPDOWN: "close:countrydropdown",
@@ -1796,10 +1796,6 @@ var TIMINGS = {
   HIDDEN_SEARCH_RESET_MS: 1e3,
   NEXT_TICK: 0
 };
-var SENTINELS = {
-  UNKNOWN_NUMBER_TYPE: -99,
-  UNKNOWN_VALIDATION_ERROR: -99
-};
 var LAYOUT = {
   NARROW_VIEWPORT_WIDTH: 500,
   // keep in sync with .iti__country-list CSS media query
@@ -1841,6 +1837,12 @@ var PLACEHOLDER_MODES = {
 var INITIAL_COUNTRY = {
   AUTO: "auto"
 };
+var NUMBER_FORMATS = [
+  "E164",
+  "INTERNATIONAL",
+  "NATIONAL",
+  "RFC3966"
+];
 var NUMBER_TYPES = [
   "FIXED_LINE",
   "MOBILE",
@@ -1855,11 +1857,21 @@ var NUMBER_TYPES = [
   "VOICEMAIL",
   "UNKNOWN"
 ];
-var NUMBER_TYPE_SET = new Set(NUMBER_TYPES);
+var VALIDATION_ERRORS = [
+  "IS_POSSIBLE",
+  "INVALID_COUNTRY_CODE",
+  "TOO_SHORT",
+  "TOO_LONG",
+  "IS_POSSIBLE_LOCAL_ONLY",
+  "INVALID_LENGTH"
+];
+var toEnumObject = (arr) => Object.fromEntries(arr.map((v) => [v, v]));
+var NUMBER_FORMAT = toEnumObject(NUMBER_FORMATS);
+var NUMBER_TYPE = toEnumObject(NUMBER_TYPES);
+var VALIDATION_ERROR = toEnumObject(VALIDATION_ERRORS);
 var DATA_KEYS = {
-  // e.g. <li data-country-code="us"> for country items in dropdown
-  // in the future, the value should be changed to "iso2", but this is a breaking change for another day
-  ISO2: "countryCode",
+  // e.g. <li data-iso2="us"> for country items in dropdown
+  ISO2: "iso2",
   DIAL_CODE: "dialCode",
   // e.g. <input data-intl-tel-input-id="0"> on the input element
   INSTANCE_ID: "intlTelInputId"
@@ -1876,7 +1888,7 @@ var ARIA = {
   MODAL: "aria-modal"
 };
 
-// src/js/i18n/en.ts
+// packages/core/src/js/i18n/en.ts
 var interfaceTranslations = {
   selectedCountryAriaLabel: "Change country for phone number, currently selected ${countryName} (${dialCode})",
   noCountrySelected: "Select country for phone number",
@@ -1896,7 +1908,7 @@ var interfaceTranslations = {
 };
 var en_default = interfaceTranslations;
 
-// src/js/core/options.ts
+// packages/core/src/js/core/options.ts
 var mediaQuery = (q) => typeof window !== "undefined" && typeof window.matchMedia === "function" && window.matchMedia(q).matches;
 var isNarrowViewport = () => mediaQuery(`(max-width: ${LAYOUT.NARROW_VIEWPORT_WIDTH}px)`);
 var computeDefaultUseFullscreenPopup = () => {
@@ -1911,7 +1923,7 @@ var defaults = {
   //* Whether or not to allow the dropdown.
   allowDropdown: true,
   //* The number type to enforce during validation.
-  allowedNumberTypes: ["MOBILE", "FIXED_LINE"],
+  allowedNumberTypes: [NUMBER_TYPE.MOBILE, NUMBER_TYPE.FIXED_LINE],
   //* Whether or not to allow extensions after the main number.
   allowNumberExtensions: false,
   // Allow alphanumeric "phonewords" (e.g. +1 800 FLOWERS) as valid numbers
@@ -1922,6 +1934,8 @@ var defaults = {
   containerClass: "",
   //* Locale for localising country names via Intl.DisplayNames.
   countryNameLocale: "en",
+  //* Override individual country names by iso2 code.
+  countryNameOverrides: {},
   //* The order of the countries in the dropdown. Defaults to alphabetical.
   countryOrder: null,
   //* Add a country search input at the top of the dropdown.
@@ -1955,17 +1969,17 @@ var defaults = {
   //* Display only these countries.
   onlyCountries: null,
   //* Number type to use for placeholders.
-  placeholderNumberType: "MOBILE",
+  placeholderNumberType: NUMBER_TYPE.MOBILE,
   //* Add custom classes to the search input element.
   searchInputClass: "",
   //* Display the international dial code next to the selected flag.
-  separateDialCode: false,
+  separateDialCode: true,
   //* When strictMode rejects a key (etc), play a short feedback animation
-  strictRejectAnimation: false,
+  strictRejectAnimation: true,
   //* Show flags - for both the selected country, and in the country dropdown
   showFlags: true,
   //* Only allow certain chars e.g. a plus followed by numeric digits, and cap at max valid length.
-  strictMode: false,
+  strictMode: true,
   //* Use full screen popup instead of dropdown for country list.
   useFullscreenPopup: computeDefaultUseFullscreenPopup()
 };
@@ -2109,6 +2123,13 @@ var validateOptions = (customOptions) => {
         }
         validatedOptions[key] = value;
         break;
+      case "countryNameOverrides":
+        if (value && !isPlainObject(value)) {
+          warnOption("countryNameOverrides", "an object", value);
+          break;
+        }
+        validatedOptions[key] = value;
+        break;
       case "initialCountry": {
         if (typeof value !== "string") {
           warnOption("initialCountry", "a string", value);
@@ -2127,8 +2148,8 @@ var validateOptions = (customOptions) => {
         break;
       }
       case "placeholderNumberType":
-        if (typeof value !== "string" || !NUMBER_TYPE_SET.has(value)) {
-          const validTypes = Array.from(NUMBER_TYPE_SET).join(", ");
+        if (typeof value !== "string" || !NUMBER_TYPES.includes(value)) {
+          const validTypes = NUMBER_TYPES.join(", ");
           warnOption("placeholderNumberType", `one of ${validTypes}`, value);
           break;
         }
@@ -2146,8 +2167,8 @@ var validateOptions = (customOptions) => {
           }
           let allValid = true;
           for (const v of value) {
-            if (typeof v !== "string" || !NUMBER_TYPE_SET.has(v)) {
-              const validTypes = Array.from(NUMBER_TYPE_SET).join(", ");
+            if (typeof v !== "string" || !NUMBER_TYPES.includes(v)) {
+              const validTypes = NUMBER_TYPES.join(", ");
               warnOption(
                 "allowedNumberTypes",
                 `an array of valid number types (${validTypes})`,
@@ -2209,11 +2230,11 @@ var applyOptionSideEffects = (o) => {
   o.i18n = { ...en_default, ...o.i18n };
 };
 
-// src/js/helpers/string.ts
+// packages/core/src/js/helpers/string.ts
 var getNumeric = (s) => s.replace(/\D/g, "");
 var normaliseString = (s = "") => s.normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase();
 
-// src/js/helpers/dom.ts
+// packages/core/src/js/helpers/dom.ts
 var buildClassNames = (flags) => Object.keys(flags).filter((k) => Boolean(flags[k])).join(" ");
 var createEl = (tagName, attrs, container) => {
   const el = document.createElement(tagName);
@@ -2228,7 +2249,7 @@ var createEl = (tagName, attrs, container) => {
   return el;
 };
 
-// src/js/core/icons.ts
+// packages/core/src/js/core/icons.ts
 var buildSearchIcon = () => `
   <svg class="iti__search-icon-svg" width="14" height="14" viewBox="0 0 24 24" focusable="false" ${ARIA.HIDDEN}="true">
     <circle cx="11" cy="11" r="7" />
@@ -2255,7 +2276,7 @@ var buildGlobeIcon = () => `
     <path d="m261 428-2-2-22-21a40 40 0 0 0-32-11h-1a37 37 0 0 0-18 8l-1 1-4 2-2 2-5 4c-9-3-36-31-47-44s-32-45-34-55l3-2a151 151 0 0 0 11-9v-1a39 39 0 0 0 5-48l-3-3-11-19-3-4-5-7h-1l-3-3-4-3-5-2a35 35 0 0 0-16-3h-5c-4 1-14 5-24 11l-4 2-4 3-4 2c-9 8-17 17-18 27a380 380 0 0 0 212 259h3c12 0 25-10 36-21l10-12 6-11a39 39 0 0 0-8-40"/>
   </svg>`;
 
-// src/js/core/countrySearch.ts
+// packages/core/src/js/core/countrySearch.ts
 var buildSearchTokens = (countries) => {
   const tokens = /* @__PURE__ */ new Map();
   for (const c of countries) {
@@ -2315,7 +2336,7 @@ var findFirstCountryStartingWith = (countries, searchTokens, query) => {
   return null;
 };
 
-// src/js/core/numerals.ts
+// packages/core/src/js/core/numerals.ts
 var Numerals = class _Numerals {
   #userNumeralSet;
   //* Stateless conversion of any Arabic-Indic / Persian digits to ASCII 0-9.
@@ -2373,7 +2394,7 @@ var Numerals = class _Numerals {
   }
 };
 
-// src/js/core/ui.ts
+// packages/core/src/js/core/ui.ts
 var UI = class _UI {
   // private
   #options;
@@ -3126,7 +3147,7 @@ var UI = class _UI {
     }
     if (iso2 && !this.#selectedListItemEl) {
       const newListItem = this.#countryListEl.querySelector(
-        `[data-country-code="${iso2}"]`
+        `[data-iso2="${iso2}"]`
       );
       if (newListItem) {
         newListItem.setAttribute(ARIA.SELECTED, "true");
@@ -3314,7 +3335,7 @@ var UI = class _UI {
   }
 };
 
-// src/js/data/country-data.ts
+// packages/core/src/js/data/country-data.ts
 var processAllCountries = (options) => {
   const { onlyCountries, excludeCountries } = options;
   if (onlyCountries?.length) {
@@ -3329,7 +3350,7 @@ var processAllCountries = (options) => {
   return [...data_default];
 };
 var generateCountryNames = (countries, options) => {
-  const { countryNameLocale, i18n } = options;
+  const { countryNameLocale, countryNameOverrides } = options;
   let displayNames;
   try {
     const hasDisplayNames = typeof Intl !== "undefined" && typeof Intl.DisplayNames === "function";
@@ -3345,7 +3366,7 @@ var generateCountryNames = (countries, options) => {
     displayNames = null;
   }
   for (const c of countries) {
-    c.name = i18n[c.iso2] || displayNames?.of(c.iso2.toUpperCase()) || "";
+    c.name = countryNameOverrides[c.iso2] || displayNames?.of(c.iso2.toUpperCase()) || "";
   }
 };
 var processDialCodes = (countries) => {
@@ -3414,7 +3435,7 @@ var sortCountries = (countries, options) => {
   });
 };
 
-// src/js/data/intl-regionless.ts
+// packages/core/src/js/data/intl-regionless.ts
 var regionlessDialCodes = /* @__PURE__ */ new Set([
   "800",
   "808",
@@ -3430,7 +3451,7 @@ var hasRegionlessDialCode = (number) => {
   return number.startsWith("+") && regionlessDialCodes.has(dialCode);
 };
 
-// src/js/format/formatting.ts
+// packages/core/src/js/format/formatting.ts
 var stripSeparateDialCode = (fullNumber, hasValidDialCode, separateDialCode, selectedCountryData) => {
   if (!separateDialCode || !hasValidDialCode) {
     return fullNumber;
@@ -3449,7 +3470,7 @@ var formatNumberAsYouType = (fullNumber, telInputValue, utils, selectedCountryDa
   return result;
 };
 
-// src/js/format/caret.ts
+// packages/core/src/js/format/caret.ts
 var computeNewCaretPosition = (relevantChars, formattedValue, prevCaretPos, isDeleteForwards) => {
   if (prevCaretPos === 0 && !isDeleteForwards) {
     return 0;
@@ -3469,7 +3490,7 @@ var computeNewCaretPosition = (relevantChars, formattedValue, prevCaretPos, isDe
   return formattedValue.length;
 };
 
-// src/js/data/nanp-regionless.ts
+// packages/core/src/js/data/nanp-regionless.ts
 var regionlessNanpAreaCodes = /* @__PURE__ */ new Set([
   "800",
   "822",
@@ -3498,7 +3519,7 @@ var isRegionlessNanp = (number) => {
   return false;
 };
 
-// src/js/intlTelInput.ts
+// packages/core/src/js/intlTelInput.ts
 var nextId = 0;
 var ensureUtils = (methodName) => {
   if (!intlTelInput.utils) {
@@ -3665,7 +3686,7 @@ var Iti = class _Iti {
     if (this.#utilsDeferred) {
       const { loadUtils } = this.#options;
       const doAttachUtils = () => {
-        intlTelInput.attachUtils(loadUtils)?.catch(() => {
+        intlTelInput.attachUtils(loadUtils).catch(() => {
         });
       };
       if (intlTelInput.documentReady()) {
@@ -3685,7 +3706,7 @@ var Iti = class _Iti {
     }
   }
   //* Perform the geo ip lookup.
-  #loadAutoCountry() {
+  async #loadAutoCountry() {
     if (intlTelInput.autoCountry) {
       this.#handleAutoCountryLoaded();
       return;
@@ -3696,19 +3717,18 @@ var Iti = class _Iti {
     }
     intlTelInput.startedLoadingAutoCountry = true;
     if (typeof this.#options.geoIpLookup === "function") {
-      const successCallback = (iso2 = "") => {
-        const iso2Lower = iso2.toLowerCase();
-        if (isIso2(iso2Lower)) {
-          intlTelInput.autoCountry = iso2Lower;
-          setTimeout(() => _Iti.forEachInstance("handleAutoCountryLoaded"));
-        } else {
+      try {
+        const iso2 = await this.#options.geoIpLookup();
+        const iso2Lower = typeof iso2 === "string" ? iso2.toLowerCase() : "";
+        if (!isIso2(iso2Lower)) {
           _Iti.forEachInstance("handleAutoCountryFailure");
+          return;
         }
-      };
-      const failureCallback = () => {
+        intlTelInput.autoCountry = iso2Lower;
+        setTimeout(() => _Iti.forEachInstance("handleAutoCountryLoaded"));
+      } catch {
         _Iti.forEachInstance("handleAutoCountryFailure");
-      };
-      this.#options.geoIpLookup(successCallback, failureCallback);
+      }
     }
   }
   #openDropdownWithPlus() {
@@ -4023,8 +4043,7 @@ var Iti = class _Iti {
     if (formatOnDisplay && intlTelInput.utils && this.#selectedCountry) {
       const isRegionless = hasRegionlessDialCode(fullNumber);
       const useNational = nationalMode && !isRegionless || !number.startsWith("+") && !separateDialCode;
-      const { NATIONAL, INTERNATIONAL } = intlTelInput.utils.numberFormat;
-      const format = useNational ? NATIONAL : INTERNATIONAL;
+      const format = useNational ? NUMBER_FORMAT.NATIONAL : NUMBER_FORMAT.INTERNATIONAL;
       number = intlTelInput.utils.formatNumber(
         number,
         this.#selectedCountry?.iso2,
@@ -4144,11 +4163,10 @@ var Iti = class _Iti {
       this.#maxCoreNumberLength = null;
       return;
     }
-    const numberType = intlTelInput.utils.numberType[placeholderNumberType];
     let exampleNumber = intlTelInput.utils.getExampleNumber(
       iso2,
       false,
-      numberType,
+      placeholderNumberType,
       true
     );
     let validNumber = exampleNumber;
@@ -4178,11 +4196,10 @@ var Iti = class _Iti {
     if (!intlTelInput.utils || !shouldSetPlaceholder) {
       return;
     }
-    const numberType = intlTelInput.utils.numberType[placeholderNumberType];
     let placeholder = this.#selectedCountry ? intlTelInput.utils.getExampleNumber(
       this.#selectedCountry.iso2,
       nationalMode,
-      numberType
+      placeholderNumberType
     ) : "";
     placeholder = this.#prepareNumberForInput(placeholder);
     if (typeof customPlaceholder === "function") {
@@ -4292,19 +4309,9 @@ var Iti = class _Iti {
     );
     return this.#truncateToMaxLength(number);
   }
-  //* Return only the public-facing subset of the selected country data.
-  #getPublicCountryData() {
-    const d = this.#selectedCountry;
-    if (!d) {
-      return null;
-    }
-    const { iso2, dialCode, name } = d;
-    return { iso2, dialCode, name };
-  }
   //* Dispatch the 'countrychange' event.
   #dispatchCountryChangeEvent() {
-    const countryData = this.#getPublicCountryData();
-    this.#dispatchEvent(EVENTS.COUNTRY_CHANGE, countryData);
+    this.#dispatchEvent(EVENTS.COUNTRY_CHANGE, this.#selectedCountry ?? null);
   }
   //**************************
   //*  INTERNAL METHODS
@@ -4395,7 +4402,7 @@ var Iti = class _Iti {
       this.#selectedCountry?.iso2
     );
   }
-  //* Format the number to the given format.
+  //* Format the number to the given format (defaults to "E164").
   getNumber(format) {
     if (!this.#isActive) {
       return "";
@@ -4410,10 +4417,10 @@ var Iti = class _Iti {
     );
     return this.#numerals.denormalise(formattedNumber);
   }
-  //* Get the type of the entered number e.g. landline/mobile.
+  //* Get the type of the entered number e.g. "FIXED_LINE" / "MOBILE", or null if it can't be determined / instance is destroyed.
   getNumberType() {
     if (!this.#isActive) {
-      return SENTINELS.UNKNOWN_NUMBER_TYPE;
+      return null;
     }
     ensureUtils("getNumberType");
     return intlTelInput.utils.getNumberType(
@@ -4423,12 +4430,12 @@ var Iti = class _Iti {
   }
   //* Get the country data for the currently selected country.
   getSelectedCountryData() {
-    return this.#getPublicCountryData();
+    return this.#selectedCountry ?? null;
   }
-  //* Get the validation error.
+  //* Get the validation error e.g. "TOO_SHORT" / "TOO_LONG", or null if it can't be determined / instance is destroyed.
   getValidationError() {
     if (!this.#isActive) {
-      return SENTINELS.UNKNOWN_VALIDATION_ERROR;
+      return null;
     }
     ensureUtils("getValidationError");
     const iso2 = this.#selectedCountry?.iso2;
@@ -4577,39 +4584,31 @@ var Iti = class _Iti {
     });
   }
 };
-var attachUtils = (source) => {
-  if (!intlTelInput.utils && !intlTelInput.startedLoadingUtils) {
-    let loadCall;
-    if (typeof source === "function") {
-      try {
-        loadCall = Promise.resolve(source());
-      } catch (error) {
-        return Promise.reject(error);
-      }
-    } else {
-      return Promise.reject(
-        new TypeError(
-          `The argument passed to attachUtils must be a function that returns a promise for the utils module, not ${typeof source}`
-        )
+var attachUtils = async (source) => {
+  if (intlTelInput.utils || intlTelInput.startedLoadingUtils) {
+    return null;
+  }
+  if (typeof source !== "function") {
+    throw new TypeError(
+      `The argument passed to attachUtils must be a function that returns a promise for the utils module, not ${typeof source}`
+    );
+  }
+  intlTelInput.startedLoadingUtils = true;
+  try {
+    const module = await source();
+    const utils = module?.default;
+    if (!utils || typeof utils !== "object") {
+      throw new TypeError(
+        "The loader function passed to attachUtils did not resolve to a module object with utils as its default export."
       );
     }
-    intlTelInput.startedLoadingUtils = true;
-    return loadCall.then((module) => {
-      const utils = module?.default;
-      if (!utils || typeof utils !== "object") {
-        throw new TypeError(
-          "The loader function passed to attachUtils did not resolve to a module object with utils as its default export."
-        );
-      }
-      intlTelInput.utils = utils;
-      Iti.forEachInstance("handleUtilsLoaded");
-      return true;
-    }).catch((error) => {
-      Iti.forEachInstance("handleUtilsFailure", error);
-      throw error;
-    });
+    intlTelInput.utils = utils;
+    Iti.forEachInstance("handleUtilsLoaded");
+    return true;
+  } catch (error) {
+    Iti.forEachInstance("handleUtilsFailure", error);
+    throw error;
   }
-  return null;
 };
 var intlTelInput = Object.assign(
   (input, options) => {
@@ -4634,11 +4633,17 @@ var intlTelInput = Object.assign(
     attachUtils,
     startedLoadingUtils: false,
     startedLoadingAutoCountry: false,
-    version: "27.3.1"
+    version: "28.0.0",
+    NUMBER_FORMAT,
+    NUMBER_TYPE,
+    VALIDATION_ERROR
   }
 );
 var intlTelInput_default = intlTelInput;
 export {
   Iti,
+  NUMBER_FORMAT,
+  NUMBER_TYPE,
+  VALIDATION_ERROR,
   intlTelInput_default as default
 };