@webority-technologies/mobile-core 0.0.9 → 0.0.11

package/lib/commonjs/formatters/index.js

@@ -3,12 +3,30 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "AsYouType", {
+  enumerable: true,
+  get: function () {
+    return _phone.AsYouType;
+  }
+});
 Object.defineProperty(exports, "addDays", {
   enumerable: true,
   get: function () {
     return _dateMath.addDays;
   }
 });
+Object.defineProperty(exports, "clampNationalNumber", {
+  enumerable: true,
+  get: function () {
+    return _phone.clampNationalNumber;
+  }
+});
+Object.defineProperty(exports, "countryFlagEmoji", {
+  enumerable: true,
+  get: function () {
+    return _phone.countryFlagEmoji;
+  }
+});
 Object.defineProperty(exports, "detectPhoneCountry", {
   enumerable: true,
   get: function () {
@@ -81,6 +99,12 @@ Object.defineProperty(exports, "formatPhone", {
     return _phone.formatPhone;
   }
 });
+Object.defineProperty(exports, "formatPhoneAsTyped", {
+  enumerable: true,
+  get: function () {
+    return _phone.formatPhoneAsTyped;
+  }
+});
 Object.defineProperty(exports, "formatRelativeTime", {
   enumerable: true,
   get: function () {
@@ -111,12 +135,30 @@ Object.defineProperty(exports, "formatTimeInZone", {
     return _dateMath.formatTimeInZone;
   }
 });
+Object.defineProperty(exports, "getCountries", {
+  enumerable: true,
+  get: function () {
+    return _phone.getCountries;
+  }
+});
+Object.defineProperty(exports, "getCountryCallingCode", {
+  enumerable: true,
+  get: function () {
+    return _phone.getCountryCallingCode;
+  }
+});
 Object.defineProperty(exports, "getInitials", {
   enumerable: true,
   get: function () {
     return _initials.getInitials;
   }
 });
+Object.defineProperty(exports, "getPhoneCountries", {
+  enumerable: true,
+  get: function () {
+    return _phone.getPhoneCountries;
+  }
+});
 Object.defineProperty(exports, "isDateAfter", {
   enumerable: true,
   get: function () {
@@ -135,12 +177,30 @@ Object.defineProperty(exports, "isSameDay", {
     return _dateMath.isSameDay;
   }
 });
+Object.defineProperty(exports, "isSupportedCountry", {
+  enumerable: true,
+  get: function () {
+    return _phone.isSupportedCountry;
+  }
+});
+Object.defineProperty(exports, "isValidNationalNumber", {
+  enumerable: true,
+  get: function () {
+    return _phone.isValidNationalNumber;
+  }
+});
 Object.defineProperty(exports, "isValidPhoneNumber", {
   enumerable: true,
   get: function () {
     return _phone.isValidPhoneNumber;
   }
 });
+Object.defineProperty(exports, "maxNationalNumberLength", {
+  enumerable: true,
+  get: function () {
+    return _phone.maxNationalNumberLength;
+  }
+});
 Object.defineProperty(exports, "normalizePhone", {
   enumerable: true,
   get: function () {
@@ -159,12 +219,24 @@ Object.defineProperty(exports, "parsePhoneNumberFromString", {
     return _phone.parsePhoneNumberFromString;
   }
 });
+Object.defineProperty(exports, "splitPhoneNumber", {
+  enumerable: true,
+  get: function () {
+    return _phone.splitPhoneNumber;
+  }
+});
 Object.defineProperty(exports, "startOfDay", {
   enumerable: true,
   get: function () {
     return _dateMath.startOfDay;
   }
 });
+Object.defineProperty(exports, "validatePhoneNumberLength", {
+  enumerable: true,
+  get: function () {
+    return _phone.validatePhoneNumberLength;
+  }
+});
 var _currency = require("./currency.js");
 var _date = require("./date.js");
 var _dateMath = require("./dateMath.js");

package/lib/commonjs/formatters/phone.js

@@ -3,15 +3,42 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.detectPhoneCountry = void 0;
+Object.defineProperty(exports, "AsYouType", {
+  enumerable: true,
+  get: function () {
+    return _max.AsYouType;
+  }
+});
+exports.detectPhoneCountry = exports.countryFlagEmoji = exports.clampNationalNumber = void 0;
 exports.formatPhone = formatPhone;
+exports.formatPhoneAsTyped = void 0;
+Object.defineProperty(exports, "getCountries", {
+  enumerable: true,
+  get: function () {
+    return _max.getCountries;
+  }
+});
+Object.defineProperty(exports, "getCountryCallingCode", {
+  enumerable: true,
+  get: function () {
+    return _max.getCountryCallingCode;
+  }
+});
+exports.getPhoneCountries = void 0;
+Object.defineProperty(exports, "isSupportedCountry", {
+  enumerable: true,
+  get: function () {
+    return _max.isSupportedCountry;
+  }
+});
+exports.isValidNationalNumber = void 0;
 Object.defineProperty(exports, "isValidPhoneNumber", {
   enumerable: true,
   get: function () {
     return _max.isValidPhoneNumber;
   }
 });
-exports.normalizePhone = void 0;
+exports.normalizePhone = exports.maxNationalNumberLength = void 0;
 Object.defineProperty(exports, "parsePhoneNumber", {
   enumerable: true,
   get: function () {
@@ -24,7 +51,17 @@ Object.defineProperty(exports, "parsePhoneNumberFromString", {
     return _max.parsePhoneNumberFromString;
   }
 });
+exports.splitPhoneNumber = void 0;
+Object.defineProperty(exports, "validatePhoneNumberLength", {
+  enumerable: true,
+  get: function () {
+    return _max.validatePhoneNumberLength;
+  }
+});
+var _core = require("libphonenumber-js/core");
 var _max = require("libphonenumber-js/max");
+var _metadataMax = _interopRequireDefault(require("libphonenumber-js/metadata.max.json"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
  * The bare 'libphonenumber-js' entry point actually resolves to the library's
  * OWN slimmed-down min/ metadata internally, not its full data - './max' is
@@ -33,6 +70,10 @@ var _max = require("libphonenumber-js/max");
  * variant wins throughout this file, not just for validation.
  */
 
+// `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).
+
 /**
  * Re-exported under our own name rather than importing CountryCode directly
  * everywhere, so a future need to diverge (or re-narrow) has one place to do
@@ -147,4 +188,182 @@ 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.
+ */
+const splitPhoneNumber = (input, defaultCountry) => {
+  const normalized = normalizePhone(input);
+  if (!normalized || onlyDigits(normalized).length === 0) {
+    return null;
+  }
+  const parsed = normalized.startsWith('+') ? (0, _max.parsePhoneNumberFromString)(normalized) : defaultCountry ? (0, _max.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.
+ */
+exports.splitPhoneNumber = splitPhoneNumber;
+const clampNationalNumber = (nationalDigits, country) => {
+  let digits = onlyDigits(nationalDigits);
+  while (digits.length > 0 && (0, _max.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.
+exports.clampNationalNumber = clampNationalNumber;
+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.
+ */
+const maxNationalNumberLength = (country, kind = 'any') => {
+  const metadata = new _core.Metadata(_metadataMax.default);
+  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.
+exports.maxNationalNumberLength = maxNationalNumberLength;
+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.
+ */
+const formatPhoneAsTyped = (nationalDigits, country) => {
+  const digits = clampNationalNumber(nationalDigits, country);
+  if (!digits) {
+    return '';
+  }
+  const national = new _max.AsYouType(country).input(digits);
+  if (national !== digits) {
+    return national;
+  }
+  const prefix = `+${(0, _max.getCountryCallingCode)(country)}`;
+  const international = new _max.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.
+ */
+exports.formatPhoneAsTyped = formatPhoneAsTyped;
+const isValidNationalNumber = (nationalDigits, country, kind = 'any') => {
+  const digits = onlyDigits(nationalDigits);
+  if (!digits) {
+    return false;
+  }
+  const parsed = (0, _max.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.)
+ */
+exports.isValidNationalNumber = isValidNationalNumber;
+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. */
+exports.countryFlagEmoji = countryFlagEmoji;
+/**
+ * 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.
+ */
+const getPhoneCountries = () => (0, _max.getCountries)().map(iso => ({
+  iso,
+  callingCode: (0, _max.getCountryCallingCode)(iso)
+}));
+exports.getPhoneCountries = getPhoneCountries;
 //# sourceMappingURL=phone.js.map

package/lib/commonjs/index.js

@@ -9,6 +9,12 @@ Object.defineProperty(exports, "ACCESS_TOKEN_KEY", {
     return _authStore.ACCESS_TOKEN_KEY;
   }
 });
+Object.defineProperty(exports, "AsYouType", {
+  enumerable: true,
+  get: function () {
+    return _index3.AsYouType;
+  }
+});
 Object.defineProperty(exports, "DeepLink", {
   enumerable: true,
   get: function () {
@@ -75,12 +81,24 @@ Object.defineProperty(exports, "buildCurl", {
     return _curl.buildCurl;
   }
 });
+Object.defineProperty(exports, "clampNationalNumber", {
+  enumerable: true,
+  get: function () {
+    return _index3.clampNationalNumber;
+  }
+});
 Object.defineProperty(exports, "configureLogger", {
   enumerable: true,
   get: function () {
     return _index4.configureLogger;
   }
 });
+Object.defineProperty(exports, "countryFlagEmoji", {
+  enumerable: true,
+  get: function () {
+    return _index3.countryFlagEmoji;
+  }
+});
 Object.defineProperty(exports, "decodeJWT", {
   enumerable: true,
   get: function () {
@@ -159,6 +177,12 @@ Object.defineProperty(exports, "formatPhone", {
     return _index3.formatPhone;
   }
 });
+Object.defineProperty(exports, "formatPhoneAsTyped", {
+  enumerable: true,
+  get: function () {
+    return _index3.formatPhoneAsTyped;
+  }
+});
 Object.defineProperty(exports, "formatRelativeTime", {
   enumerable: true,
   get: function () {
@@ -201,6 +225,18 @@ Object.defineProperty(exports, "getConfigValue", {
     return _index.getConfigValue;
   }
 });
+Object.defineProperty(exports, "getCountries", {
+  enumerable: true,
+  get: function () {
+    return _index3.getCountries;
+  }
+});
+Object.defineProperty(exports, "getCountryCallingCode", {
+  enumerable: true,
+  get: function () {
+    return _index3.getCountryCallingCode;
+  }
+});
 Object.defineProperty(exports, "getDeviceContext", {
   enumerable: true,
   get: function () {
@@ -225,6 +261,12 @@ Object.defineProperty(exports, "getNetworkStatus", {
     return _index5.getNetworkStatus;
   }
 });
+Object.defineProperty(exports, "getPhoneCountries", {
+  enumerable: true,
+  get: function () {
+    return _index3.getPhoneCountries;
+  }
+});
 Object.defineProperty(exports, "getToken", {
   enumerable: true,
   get: function () {
@@ -381,12 +423,24 @@ Object.defineProperty(exports, "isStrongPassword", {
     return _index7.isStrongPassword;
   }
 });
+Object.defineProperty(exports, "isSupportedCountry", {
+  enumerable: true,
+  get: function () {
+    return _index3.isSupportedCountry;
+  }
+});
 Object.defineProperty(exports, "isUrl", {
   enumerable: true,
   get: function () {
     return _index7.isUrl;
   }
 });
+Object.defineProperty(exports, "isValidNationalNumber", {
+  enumerable: true,
+  get: function () {
+    return _index3.isValidNationalNumber;
+  }
+});
 Object.defineProperty(exports, "isValidPhoneNumber", {
   enumerable: true,
   get: function () {
@@ -405,6 +459,12 @@ Object.defineProperty(exports, "maxLength", {
     return _index7.maxLength;
   }
 });
+Object.defineProperty(exports, "maxNationalNumberLength", {
+  enumerable: true,
+  get: function () {
+    return _index3.maxNationalNumberLength;
+  }
+});
 Object.defineProperty(exports, "minLength", {
   enumerable: true,
   get: function () {
@@ -501,6 +561,12 @@ Object.defineProperty(exports, "setStorageImplementation", {
     return _index6.setStorageImplementation;
   }
 });
+Object.defineProperty(exports, "splitPhoneNumber", {
+  enumerable: true,
+  get: function () {
+    return _index3.splitPhoneNumber;
+  }
+});
 Object.defineProperty(exports, "startOfDay", {
   enumerable: true,
   get: function () {
@@ -537,6 +603,12 @@ Object.defineProperty(exports, "userClient", {
     return _userClient.default;
   }
 });
+Object.defineProperty(exports, "validatePhoneNumberLength", {
+  enumerable: true,
+  get: function () {
+    return _index3.validatePhoneNumberLength;
+  }
+});
 var _curl = require("./api/curl.js");
 var _publicClient = _interopRequireDefault(require("./api/publicClient.js"));
 var _retry = require("./api/retry.js");