matchPhoneNumberStringAgainstPhoneNumber.js 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. import parsePhoneNumber from '../parsePhoneNumber.js'
  2. /**
  3. * Matches a phone number object against a phone number string.
  4. * @param {string} phoneNumberString
  5. * @param {PhoneNumber} phoneNumber
  6. * @param {object} metadata — Metadata JSON
  7. * @return {'INVALID_NUMBER'|'NO_MATCH'|'SHORT_NSN_MATCH'|'NSN_MATCH'|'EXACT_MATCH'}
  8. */
  9. export default function matchPhoneNumberStringAgainstPhoneNumber(phoneNumberString, phoneNumber, metadata) {
  10. // Parse `phoneNumberString`.
  11. let phoneNumberStringContainsCallingCode = true
  12. let parsedPhoneNumber = parsePhoneNumber(phoneNumberString, metadata)
  13. if (!parsedPhoneNumber) {
  14. // If `phoneNumberString` didn't contain a country calling code
  15. // then substitute it with the `phoneNumber`'s country calling code.
  16. phoneNumberStringContainsCallingCode = false
  17. parsedPhoneNumber = parsePhoneNumber(phoneNumberString, { defaultCallingCode: phoneNumber.countryCallingCode }, metadata)
  18. }
  19. if (!parsedPhoneNumber) {
  20. return 'INVALID_NUMBER'
  21. }
  22. // Check that the extensions match.
  23. if (phoneNumber.ext) {
  24. if (parsedPhoneNumber.ext !== phoneNumber.ext) {
  25. return 'NO_MATCH'
  26. }
  27. } else {
  28. if (parsedPhoneNumber.ext) {
  29. return 'NO_MATCH'
  30. }
  31. }
  32. // Check that country calling codes match.
  33. if (phoneNumberStringContainsCallingCode) {
  34. if (phoneNumber.countryCallingCode !== parsedPhoneNumber.countryCallingCode) {
  35. return 'NO_MATCH'
  36. }
  37. }
  38. // Check if the whole numbers match.
  39. if (phoneNumber.number === parsedPhoneNumber.number) {
  40. if (phoneNumberStringContainsCallingCode) {
  41. return 'EXACT_MATCH'
  42. } else {
  43. return 'NSN_MATCH'
  44. }
  45. }
  46. // Check if one national number is a "suffix" of the other.
  47. if (
  48. phoneNumber.nationalNumber.indexOf(parsedPhoneNumber.nationalNumber) === 0 ||
  49. parsedPhoneNumber.nationalNumber.indexOf(phoneNumber.nationalNumber) === 0
  50. ) {
  51. // "A SHORT_NSN_MATCH occurs if there is a difference because of the
  52. // presence or absence of an 'Italian leading zero', the presence or
  53. // absence of an extension, or one NSN being a shorter variant of the
  54. // other."
  55. return 'SHORT_NSN_MATCH'
  56. }
  57. return 'NO_MATCH'
  58. }