@webority-technologies/mobile-core 0.0.9 → 0.0.11

package/lib/commonjs/phone/countries.js

@@ -0,0 +1,265 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PHONE_COUNTRY_NAMES = void 0;
+/**
+ * English display names for every country libphonenumber-js knows, keyed by
+ * ISO 3166-1 alpha-2. GENERATED by scripts/gen-phone-countries.mjs from Node's
+ * Intl.DisplayNames('en', { type: 'region' }) over getCountries() on 2026-09-14;
+ * '&' is written as 'and'. Re-run the script rather than editing by hand.
+ *
+ * Lives on its own import path (mobile-core/phone/countries) so an app that
+ * never opens a full country list does not carry these 245 strings in its
+ * bundle. Pair with getPhoneCountries() from the package root for the calling
+ * codes; a country picker that needs another language supplies its own names.
+ */
+const PHONE_COUNTRY_NAMES = exports.PHONE_COUNTRY_NAMES = {
+  AF: 'Afghanistan',
+  AX: 'Åland Islands',
+  AL: 'Albania',
+  DZ: 'Algeria',
+  AS: 'American Samoa',
+  AD: 'Andorra',
+  AO: 'Angola',
+  AI: 'Anguilla',
+  AG: 'Antigua and Barbuda',
+  AR: 'Argentina',
+  AM: 'Armenia',
+  AW: 'Aruba',
+  AC: 'Ascension Island',
+  AU: 'Australia',
+  AT: 'Austria',
+  AZ: 'Azerbaijan',
+  BS: 'Bahamas',
+  BH: 'Bahrain',
+  BD: 'Bangladesh',
+  BB: 'Barbados',
+  BY: 'Belarus',
+  BE: 'Belgium',
+  BZ: 'Belize',
+  BJ: 'Benin',
+  BM: 'Bermuda',
+  BT: 'Bhutan',
+  BO: 'Bolivia',
+  BA: 'Bosnia and Herzegovina',
+  BW: 'Botswana',
+  BR: 'Brazil',
+  IO: 'British Indian Ocean Territory',
+  VG: 'British Virgin Islands',
+  BN: 'Brunei',
+  BG: 'Bulgaria',
+  BF: 'Burkina Faso',
+  BI: 'Burundi',
+  KH: 'Cambodia',
+  CM: 'Cameroon',
+  CA: 'Canada',
+  CV: 'Cape Verde',
+  BQ: 'Caribbean Netherlands',
+  KY: 'Cayman Islands',
+  CF: 'Central African Republic',
+  TD: 'Chad',
+  CL: 'Chile',
+  CN: 'China',
+  CX: 'Christmas Island',
+  CC: 'Cocos (Keeling) Islands',
+  CO: 'Colombia',
+  KM: 'Comoros',
+  CG: 'Congo - Brazzaville',
+  CD: 'Congo - Kinshasa',
+  CK: 'Cook Islands',
+  CR: 'Costa Rica',
+  CI: 'Côte d’Ivoire',
+  HR: 'Croatia',
+  CU: 'Cuba',
+  CW: 'Curaçao',
+  CY: 'Cyprus',
+  CZ: 'Czechia',
+  DK: 'Denmark',
+  DJ: 'Djibouti',
+  DM: 'Dominica',
+  DO: 'Dominican Republic',
+  EC: 'Ecuador',
+  EG: 'Egypt',
+  SV: 'El Salvador',
+  GQ: 'Equatorial Guinea',
+  ER: 'Eritrea',
+  EE: 'Estonia',
+  SZ: 'Eswatini',
+  ET: 'Ethiopia',
+  FK: 'Falkland Islands',
+  FO: 'Faroe Islands',
+  FJ: 'Fiji',
+  FI: 'Finland',
+  FR: 'France',
+  GF: 'French Guiana',
+  PF: 'French Polynesia',
+  GA: 'Gabon',
+  GM: 'Gambia',
+  GE: 'Georgia',
+  DE: 'Germany',
+  GH: 'Ghana',
+  GI: 'Gibraltar',
+  GR: 'Greece',
+  GL: 'Greenland',
+  GD: 'Grenada',
+  GP: 'Guadeloupe',
+  GU: 'Guam',
+  GT: 'Guatemala',
+  GG: 'Guernsey',
+  GN: 'Guinea',
+  GW: 'Guinea-Bissau',
+  GY: 'Guyana',
+  HT: 'Haiti',
+  HN: 'Honduras',
+  HK: 'Hong Kong SAR China',
+  HU: 'Hungary',
+  IS: 'Iceland',
+  IN: 'India',
+  ID: 'Indonesia',
+  IR: 'Iran',
+  IQ: 'Iraq',
+  IE: 'Ireland',
+  IM: 'Isle of Man',
+  IL: 'Israel',
+  IT: 'Italy',
+  JM: 'Jamaica',
+  JP: 'Japan',
+  JE: 'Jersey',
+  JO: 'Jordan',
+  KZ: 'Kazakhstan',
+  KE: 'Kenya',
+  KI: 'Kiribati',
+  XK: 'Kosovo',
+  KW: 'Kuwait',
+  KG: 'Kyrgyzstan',
+  LA: 'Laos',
+  LV: 'Latvia',
+  LB: 'Lebanon',
+  LS: 'Lesotho',
+  LR: 'Liberia',
+  LY: 'Libya',
+  LI: 'Liechtenstein',
+  LT: 'Lithuania',
+  LU: 'Luxembourg',
+  MO: 'Macao SAR China',
+  MG: 'Madagascar',
+  MW: 'Malawi',
+  MY: 'Malaysia',
+  MV: 'Maldives',
+  ML: 'Mali',
+  MT: 'Malta',
+  MH: 'Marshall Islands',
+  MQ: 'Martinique',
+  MR: 'Mauritania',
+  MU: 'Mauritius',
+  YT: 'Mayotte',
+  MX: 'Mexico',
+  FM: 'Micronesia',
+  MD: 'Moldova',
+  MC: 'Monaco',
+  MN: 'Mongolia',
+  ME: 'Montenegro',
+  MS: 'Montserrat',
+  MA: 'Morocco',
+  MZ: 'Mozambique',
+  MM: 'Myanmar (Burma)',
+  NA: 'Namibia',
+  NR: 'Nauru',
+  NP: 'Nepal',
+  NL: 'Netherlands',
+  NC: 'New Caledonia',
+  NZ: 'New Zealand',
+  NI: 'Nicaragua',
+  NE: 'Niger',
+  NG: 'Nigeria',
+  NU: 'Niue',
+  NF: 'Norfolk Island',
+  KP: 'North Korea',
+  MK: 'North Macedonia',
+  MP: 'Northern Mariana Islands',
+  NO: 'Norway',
+  OM: 'Oman',
+  PK: 'Pakistan',
+  PW: 'Palau',
+  PS: 'Palestinian Territories',
+  PA: 'Panama',
+  PG: 'Papua New Guinea',
+  PY: 'Paraguay',
+  PE: 'Peru',
+  PH: 'Philippines',
+  PL: 'Poland',
+  PT: 'Portugal',
+  PR: 'Puerto Rico',
+  QA: 'Qatar',
+  RE: 'Réunion',
+  RO: 'Romania',
+  RU: 'Russia',
+  RW: 'Rwanda',
+  WS: 'Samoa',
+  SM: 'San Marino',
+  ST: 'São Tomé and Príncipe',
+  SA: 'Saudi Arabia',
+  SN: 'Senegal',
+  RS: 'Serbia',
+  SC: 'Seychelles',
+  SL: 'Sierra Leone',
+  SG: 'Singapore',
+  SX: 'Sint Maarten',
+  SK: 'Slovakia',
+  SI: 'Slovenia',
+  SB: 'Solomon Islands',
+  SO: 'Somalia',
+  ZA: 'South Africa',
+  KR: 'South Korea',
+  SS: 'South Sudan',
+  ES: 'Spain',
+  LK: 'Sri Lanka',
+  BL: 'St. Barthélemy',
+  SH: 'St. Helena',
+  KN: 'St. Kitts and Nevis',
+  LC: 'St. Lucia',
+  MF: 'St. Martin',
+  PM: 'St. Pierre and Miquelon',
+  VC: 'St. Vincent and Grenadines',
+  SD: 'Sudan',
+  SR: 'Suriname',
+  SJ: 'Svalbard and Jan Mayen',
+  SE: 'Sweden',
+  CH: 'Switzerland',
+  SY: 'Syria',
+  TW: 'Taiwan',
+  TJ: 'Tajikistan',
+  TZ: 'Tanzania',
+  TH: 'Thailand',
+  TL: 'Timor-Leste',
+  TG: 'Togo',
+  TK: 'Tokelau',
+  TO: 'Tonga',
+  TT: 'Trinidad and Tobago',
+  TA: 'Tristan da Cunha',
+  TN: 'Tunisia',
+  TR: 'Türkiye',
+  TM: 'Turkmenistan',
+  TC: 'Turks and Caicos Islands',
+  TV: 'Tuvalu',
+  VI: 'U.S. Virgin Islands',
+  UG: 'Uganda',
+  UA: 'Ukraine',
+  AE: 'United Arab Emirates',
+  GB: 'United Kingdom',
+  US: 'United States',
+  UY: 'Uruguay',
+  UZ: 'Uzbekistan',
+  VU: 'Vanuatu',
+  VA: 'Vatican City',
+  VE: 'Venezuela',
+  VN: 'Vietnam',
+  WF: 'Wallis and Futuna',
+  EH: 'Western Sahara',
+  YE: 'Yemen',
+  ZM: 'Zambia',
+  ZW: 'Zimbabwe'
+};
+//# sourceMappingURL=countries.js.map

package/lib/module/formatters/index.js

@@ -5,5 +5,5 @@ export { formatDate, formatDateTime, formatRelativeTime, formatTime } from "./da
 export { addDays, diffMs, formatDateDDMMMYYYY, formatDateISO, formatDatePattern, formatTime12h, formatTimeInWindowsZone, formatTimeInZone, isDateAfter, isDateBefore, isSameDay, startOfDay } from "./dateMath.js";
 export { getInitials } from "./initials.js";
 export { formatCompactNumber, formatNumber, formatPercent } from "./number.js";
-export { detectPhoneCountry, formatPhone, isValidPhoneNumber, normalizePhone, parsePhoneNumber, parsePhoneNumberFromString } from "./phone.js";
+export { AsYouType, clampNationalNumber, countryFlagEmoji, detectPhoneCountry, formatPhone, formatPhoneAsTyped, getCountries, getCountryCallingCode, getPhoneCountries, isSupportedCountry, isValidNationalNumber, isValidPhoneNumber, maxNationalNumberLength, normalizePhone, parsePhoneNumber, parsePhoneNumberFromString, splitPhoneNumber, validatePhoneNumberLength } from "./phone.js";
 //# sourceMappingURL=index.js.map

package/lib/module/formatters/phone.js

@@ -7,8 +7,13 @@
  * module exists is validation and formatting accuracy, the more accurate
  * variant wins throughout this file, not just for validation.
  */
-import { parsePhoneNumberFromString } from 'libphonenumber-js/max';
-export { isValidPhoneNumber, parsePhoneNumber, parsePhoneNumberFromString } from 'libphonenumber-js/max';
+import { Metadata } from 'libphonenumber-js/core';
+import { AsYouType, getCountries, getCountryCallingCode, parsePhoneNumberFromString, validatePhoneNumberLength } from 'libphonenumber-js/max';
+// `Metadata` comes from the core entry with the max data passed in by hand:
+// the max entry exports it in its ESM build only, and the CommonJS build jest
+// and node resolve has no `Metadata` at all (libphonenumber-js 1.13.12).
+import phoneMetadata from 'libphonenumber-js/metadata.max.json';
+export { AsYouType, getCountries, getCountryCallingCode, isSupportedCountry, isValidPhoneNumber, parsePhoneNumber, parsePhoneNumberFromString, validatePhoneNumberLength } from 'libphonenumber-js/max';
 
 /**
  * Re-exported under our own name rather than importing CountryCode directly
@@ -122,4 +127,176 @@ export function formatPhone(input, arg) {
   }
   return fallbackRest.startsWith('+') ? bestEffortGroup(fallbackRest.slice(1)) : fallbackRest.replace(/(.{4})(?=.)/g, '$1 ').trim();
 }
+
+// ---------------------------------------------------------------------------
+// Structured-value helpers. These back PhoneNumberInput in mobile-ui, and are
+// exported so an app's own form and API code validates with the same rules
+// the field shows on screen, rather than a second regex table.
+// ---------------------------------------------------------------------------
+
+/** Country calling code + national digits, the way a phone field stores them. */
+
+/**
+ * Which kinds of number count as valid. `'any'` is libphonenumber's own
+ * answer (a fixed line passes). `'mobile'` narrows to MOBILE and
+ * FIXED_LINE_OR_MOBILE, which is what an OTP or WhatsApp field wants: in India
+ * a 10-digit number starting with 1 to 5 is a real fixed line and passes
+ * `'any'`, but no SMS will ever reach it.
+ */
+
+const onlyDigits = input => input.replace(/\D/g, '');
+
+/**
+ * Split a typed or pasted number into calling code + national digits.
+ * `'+919876543210'` resolves to IN / 91 / 9876543210 from its own prefix; a
+ * bare `'9876543210'` needs `defaultCountry` to resolve at all. Returns null
+ * when the input has no digits or no country can be told. A shared calling
+ * code (`+1` for US and CA) resolves to the country whose area code matches,
+ * which is why the country comes back as part of the answer rather than being
+ * looked up again from the code.
+ */
+export const splitPhoneNumber = (input, defaultCountry) => {
+  const normalized = normalizePhone(input);
+  if (!normalized || onlyDigits(normalized).length === 0) {
+    return null;
+  }
+  const parsed = normalized.startsWith('+') ? parsePhoneNumberFromString(normalized) : defaultCountry ? parsePhoneNumberFromString(normalized, defaultCountry) : undefined;
+  if (!parsed) {
+    return null;
+  }
+  return {
+    country: parsed.country ?? null,
+    callingCode: parsed.countryCallingCode,
+    nationalNumber: parsed.nationalNumber
+  };
+};
+
+/**
+ * Cut national digits that run past the longest number the country's plan
+ * allows, so a field stops accepting the impossible without a per-country
+ * length table. This is the PLAN's ceiling, not a mobile number's: India runs
+ * to 13 digits (toll-free 1800 numbers), the US to 10, Germany to 15. A field
+ * that should stop where a subscriber's number ends asks
+ * `maxNationalNumberLength` instead. Digits within range, including a number
+ * still too short, pass through untouched.
+ */
+export const clampNationalNumber = (nationalDigits, country) => {
+  let digits = onlyDigits(nationalDigits);
+  while (digits.length > 0 && validatePhoneNumberLength(digits, country) === 'TOO_LONG') {
+    digits = digits.slice(0, -1);
+  }
+  return digits;
+};
+
+// The number types a person types into a phone field. Toll-free, premium,
+// shared-cost and pager ranges are what push a plan's ceiling past them.
+const SUBSCRIBER_TYPES = {
+  any: ['MOBILE', 'FIXED_LINE'],
+  mobile: ['MOBILE']
+};
+
+// libphonenumber-js types `numberingPlan` without its per-type accessor; the
+// runtime object has it, and a type with no lengths of its own answers with the
+// plan's.
+
+/**
+ * The most national digits a subscriber's number can have in a country, so a
+ * field can refuse the next digit as it is typed rather than trimming after.
+ * `'any'` (default) covers mobile and fixed lines, `'mobile'` mobiles only: India
+ * is 10 either way (its plan's 13 belongs to toll-free numbers), Germany is 15
+ * for `'any'` and 11 for `'mobile'`, the UAE 9. A country whose metadata lists
+ * no lengths by type falls back to the plan's longest number.
+ */
+export const maxNationalNumberLength = (country, kind = 'any') => {
+  const metadata = new Metadata(phoneMetadata);
+  metadata.selectNumberingPlan(country);
+  const plan = metadata.numberingPlan;
+  if (!plan) {
+    return E164_MAX_NATIONAL_DIGITS;
+  }
+  const byType = SUBSCRIBER_TYPES[kind].flatMap(type => plan.type(type)?.possibleLengths() ?? []);
+  return Math.max(...(byType.length > 0 ? byType : plan.possibleLengths()));
+};
+
+// E.164 allows 15 digits in total; a national number can never exceed it.
+const E164_MAX_NATIONAL_DIGITS = 15;
+
+/**
+ * National digits grouped the way the country writes them, updated on every
+ * keystroke: `'98765'` for IN is `'98765'`, `'9876543210'` is `'98765 43210'`,
+ * `'2025550123'` for US is `'(202) 555-0123'`. Output is for display only; the
+ * digits are what a value stores. Digits past the plan's longest possible
+ * number are dropped first, so an overflowing paste never formats as a longer
+ * number; digits that fit no pattern come back ungrouped rather than forced
+ * into a shape.
+ *
+ * Countries that write a leading 0 (the UAE, the UK, Australia, Saudi Arabia)
+ * only group in national mode when that 0 is typed, and a value never holds
+ * it. When national mode hands the digits back untouched, the grouping comes
+ * from the international form with the calling code removed: `'501234567'`
+ * for AE is `'50 123 4567'`. Countries that group nationally are unaffected.
+ */
+export const formatPhoneAsTyped = (nationalDigits, country) => {
+  const digits = clampNationalNumber(nationalDigits, country);
+  if (!digits) {
+    return '';
+  }
+  const national = new AsYouType(country).input(digits);
+  if (national !== digits) {
+    return national;
+  }
+  const prefix = `+${getCountryCallingCode(country)}`;
+  const international = new AsYouType().input(`${prefix}${digits}`);
+  return international.startsWith(prefix) ? international.slice(prefix.length).trimStart() || digits : digits;
+};
+
+/**
+ * Whether national digits form a real number for the country, by the
+ * country's own numbering plan rather than a length check. `kind: 'mobile'`
+ * additionally rejects fixed lines; a number whose type the metadata cannot
+ * tell is accepted, since the metadata, not the number, is what is missing.
+ */
+export const isValidNationalNumber = (nationalDigits, country, kind = 'any') => {
+  const digits = onlyDigits(nationalDigits);
+  if (!digits) {
+    return false;
+  }
+  const parsed = parsePhoneNumberFromString(digits, country);
+  if (!parsed?.isValid()) {
+    return false;
+  }
+  if (kind === 'any') {
+    return true;
+  }
+  const type = parsed.getType();
+  return type === undefined || type === 'MOBILE' || type === 'FIXED_LINE_OR_MOBILE';
+};
+
+/**
+ * The flag as an emoji built from the ISO code's two regional-indicator
+ * letters, so no font asset ships with the library: iOS and Android both draw
+ * these from the system font. An unknown or malformed code returns ''. (Windows
+ * browsers render the two letters instead of a flag; that is the platform, not
+ * the code.)
+ */
+export const countryFlagEmoji = iso => {
+  const code = iso.trim().toUpperCase();
+  if (!/^[A-Z]{2}$/.test(code)) {
+    return '';
+  }
+  return String.fromCodePoint(0x1f1e6 + code.charCodeAt(0) - 65, 0x1f1e6 + code.charCodeAt(1) - 65);
+};
+
+/** Calling code + ISO for one country, the shape a country picker lists. */
+
+/**
+ * Every country libphonenumber-js knows, with its calling code, in metadata
+ * order. Names are deliberately not here: they are display data, in one
+ * language, and live on their own import path (`mobile-core/phone/countries`)
+ * so an app that never opens a full country list does not carry them.
+ */
+export const getPhoneCountries = () => getCountries().map(iso => ({
+  iso,
+  callingCode: getCountryCallingCode(iso)
+}));
 //# sourceMappingURL=phone.js.map

package/lib/module/index.js

@@ -14,6 +14,10 @@
  *   @webority-technologies/mobile-core/download     a filesystem module
  *   @webority-technologies/mobile-core/smsRetriever Android only, own TurboModule
  *
+ * One more path is separate for size, not for a native package:
+ *
+ *   @webority-technologies/mobile-core/phone/countries  245 English country names
+ *
  * react-native-keychain is the exception and is a REQUIRED peer: the HTTP client
  * reads the bearer token, so it is reachable from the main barrel by design.
  */
@@ -30,7 +34,7 @@ export { getConfig, getConfigValue, resetConfig, setConfig } from "./config/inde
 // Deep links
 export { DeepLink, parseDeepLink, useDeepLink } from "./deepLink/index.js";
 // Formatters
-export { addDays, detectPhoneCountry, diffMs, formatCompactNumber, formatCurrency, formatDate, formatDateDDMMMYYYY, formatDateISO, formatDatePattern, formatDateTime, formatNumber, formatPercent, formatPhone, formatRelativeTime, formatTime, formatTime12h, formatTimeInWindowsZone, formatTimeInZone, getInitials, isDateAfter, isDateBefore, isSameDay, isValidPhoneNumber, normalizePhone, parsePhoneNumber, parsePhoneNumberFromString, startOfDay } from "./formatters/index.js";
+export { AsYouType, addDays, clampNationalNumber, countryFlagEmoji, detectPhoneCountry, diffMs, formatCompactNumber, formatCurrency, formatDate, formatDateDDMMMYYYY, formatDateISO, formatDatePattern, formatDateTime, formatNumber, formatPercent, formatPhone, formatPhoneAsTyped, formatRelativeTime, formatTime, formatTime12h, formatTimeInWindowsZone, formatTimeInZone, getCountries, getCountryCallingCode, getInitials, getPhoneCountries, isDateAfter, isDateBefore, isSameDay, isSupportedCountry, isValidNationalNumber, isValidPhoneNumber, maxNationalNumberLength, normalizePhone, parsePhoneNumber, parsePhoneNumberFromString, splitPhoneNumber, startOfDay, validatePhoneNumberLength } from "./formatters/index.js";
 // Initialization
 export { initWebority } from "./initSDK.js";
 export { initUserAuth } from "./initUserAuth.js";