libphonenumber-js
Version:
A simpler (and smaller) rewrite of Google Android's libphonenumber library in javascript
530 lines (451 loc) • 19.1 kB
JavaScript
import metadata from '../../metadata.min.json' with { type: 'json' }
import _parseNumber from './parse.js'
import Metadata from '../metadata.js'
function parseNumber(...parameters) {
parameters.push(metadata)
return _parseNumber.apply(this, parameters)
}
const USE_NON_GEOGRAPHIC_COUNTRY_CODE = false
describe('parse', () => {
it('should not parse invalid phone numbers', () => {
// Too short.
expect(parseNumber('+7 (800) 55-35-35')).to.deep.equal({})
// Too long.
expect(parseNumber('+7 (800) 55-35-35-55')).to.deep.equal({})
expect(parseNumber('+7 (800) 55-35-35', 'US')).to.deep.equal({})
expect(parseNumber('(800) 55 35 35', { defaultCountry: 'RU' })).to.deep.equal({})
expect(parseNumber('+1 187 215 5230', 'US')).to.deep.equal({})
expect(parseNumber('911231231', 'BE')).to.deep.equal({})
})
it('should parse valid phone numbers', () => {
// Instant loans
// https://www.youtube.com/watch?v=6e1pMrYH5jI
//
// Restrict to RU
expect(parseNumber('Phone: 8 (800) 555 35 35.', 'RU')).to.deep.equal({ country: 'RU', phone: '8005553535' })
// International format
expect(parseNumber('Phone: +7 (800) 555-35-35.')).to.deep.equal({ country: 'RU', phone: '8005553535' })
// // Restrict to US, but not a US country phone code supplied
// parseNumber('+7 (800) 555-35-35', 'US').should.deep.equal({})
// Restrict to RU
expect(parseNumber('(800) 555 35 35', 'RU')).to.deep.equal({ country: 'RU', phone: '8005553535' })
// Default to RU
expect(parseNumber('8 (800) 555 35 35', { defaultCountry: 'RU' })).to.deep.equal({ country: 'RU', phone: '8005553535' })
// Gangster partyline
expect(parseNumber('+1-213-373-4253')).to.deep.equal({ country: 'US', phone: '2133734253' })
// Switzerland (just in case)
expect(parseNumber('044 668 18 00', 'CH')).to.deep.equal({ country: 'CH', phone: '446681800' })
// China, Beijing
expect(parseNumber('010-852644821', 'CN')).to.deep.equal({ country: 'CN', phone: '10852644821' })
// France
expect(parseNumber('+33169454850')).to.deep.equal({ country: 'FR', phone: '169454850' })
// UK (Jersey)
expect(parseNumber('+44 7700 300000')).to.deep.equal({ country: 'JE', phone: '7700300000' })
// KZ
expect(parseNumber('+7 702 211 1111')).to.deep.equal({ country: 'KZ', phone: '7022111111' })
// Brazil
expect(parseNumber('11987654321', 'BR')).to.deep.equal({ country: 'BR', phone: '11987654321' })
// Long country phone code.
expect(parseNumber('+212659777777')).to.deep.equal({ country: 'MA', phone: '659777777' })
// No country could be derived.
// parseNumber('+212569887076').should.deep.equal({ countryPhoneCode: '212', phone: '569887076' })
// GB. Moible numbers starting 07624* are Isle of Man.
expect(parseNumber('07624369230', 'GB')).to.deep.equal({ country: 'IM', phone: '7624369230' })
})
it('should parse possible numbers', () => {
// Invalid phone number for a given country.
expect(parseNumber('1112223344', 'RU', { extended: true })).to.deep.equal({
country : 'RU',
countryCallingCode : '7',
phone : '1112223344',
carrierCode : undefined,
ext : undefined,
valid : false,
possible : true
})
// International phone number.
// Several countries with the same country phone code.
expect(parseNumber('+71112223344')).to.deep.equal({})
expect(parseNumber('+71112223344', { extended: true })).to.deep.equal({
country : undefined,
countryCallingCode : '7',
phone : '1112223344',
carrierCode : undefined,
ext : undefined,
valid : false,
possible : true
})
// International phone number.
// Single country with the given country phone code.
expect(parseNumber('+33011222333', { extended: true })).to.deep.equal({
country : 'FR',
countryCallingCode : '33',
phone : '011222333',
carrierCode : undefined,
ext : undefined,
valid : false,
possible : true
})
// Too short.
// Won't strip national prefix `8` because otherwise the number would be too short.
expect(parseNumber('+7 (800) 55-35-35', { extended: true })).to.deep.equal({
country : undefined,
countryCallingCode : '7',
phone : '800553535',
carrierCode : undefined,
ext : undefined,
valid : false,
possible : false
})
// Too long.
expect(parseNumber('+1 213 37342530', { extended: true })).to.deep.equal({
country : undefined,
countryCallingCode : '1',
phone : '21337342530',
carrierCode : undefined,
ext : undefined,
valid : false,
possible : false
})
// No national number to be parsed.
expect(parseNumber('+996', { extended: true })).to.deep.equal({
// countryCallingCode : '996'
})
// Valid number.
expect(parseNumber('+78005553535', { extended: true })).to.deep.equal({
country : 'RU',
countryCallingCode : '7',
phone : '8005553535',
carrierCode : undefined,
ext : undefined,
valid : true,
possible : true
})
// https://github.com/catamphetamine/libphonenumber-js/issues/211
expect(parseNumber('+966', { extended: true })).to.deep.equal({})
expect(parseNumber('+9664', { extended: true })).to.deep.equal({})
expect(parseNumber('+96645', { extended: true })).to.deep.equal({
carrierCode : undefined,
phone : '45',
ext : undefined,
country : 'SA',
countryCallingCode : '966',
possible : false,
valid : false
})
})
it('should parse non-European digits', () => {
expect(parseNumber('+١٢١٢٢٣٢٣٢٣٢')).to.deep.equal({ country: 'US', phone: '2122323232' })
})
it('should work in edge cases', () => {
let thrower
// No input
expect(parseNumber('')).to.deep.equal({})
// No country phone code
expect(parseNumber('+')).to.deep.equal({})
// No country at all (non international number and no explicit country code)
expect(parseNumber('123')).to.deep.equal({})
// No country metadata for this `require` country code
thrower = () => parseNumber('123', 'ZZ')
expect(thrower).to.throw('Unknown country')
// No country metadata for this `default` country code
thrower = () => parseNumber('123', { defaultCountry: 'ZZ' })
expect(thrower).to.throw('Unknown country')
// Invalid country phone code
expect(parseNumber('+210')).to.deep.equal({})
// Invalid country phone code (extended parsing mode)
expect(parseNumber('+210', { extended: true })).to.deep.equal({})
// Too short of a number.
expect(parseNumber('1', 'US', { extended: true })).to.deep.equal({})
// Too long of a number.
expect(parseNumber('1111111111111111111', 'RU', { extended: true })).to.deep.equal({})
// Not a number.
expect(parseNumber('abcdefg', 'US', { extended: true })).to.deep.equal({})
// Country phone code beginning with a '0'
expect(parseNumber('+0123')).to.deep.equal({})
// Barbados NANPA phone number
expect(parseNumber('+12460000000')).to.deep.equal({ country: 'BB', phone: '2460000000' })
// // A case when country (restricted to) is not equal
// // to the one parsed out of an international number.
// parseNumber('+1-213-373-4253', 'RU').should.deep.equal({})
// National (significant) number too short
expect(parseNumber('2', 'US')).to.deep.equal({})
// National (significant) number too long
expect(parseNumber('222222222222222222', 'US')).to.deep.equal({})
// No `national_prefix_for_parsing`
expect(parseNumber('41111', 'AC')).to.deep.equal({ country: 'AC', phone: '41111'})
// https://github.com/catamphetamine/libphonenumber-js/issues/235
// `matchesEntirely()` bug fix.
expect(parseNumber('+4915784846111')).to.deep.equal({ country: 'DE', phone: '15784846111' })
// No metadata
thrower = () => _parseNumber('')
expect(thrower).to.throw('`metadata` argument not passed')
// Numerical `value`
thrower = () => parseNumber(2141111111, 'US')
expect(thrower).to.throw('A text for parsing must be a string.')
// Input string too long.
expect(
parseNumber('8005553535 ', 'RU')
).to.deep.equal({})
})
it('should parse phone number extensions', () => {
// "ext"
expect(parseNumber('2134567890 ext 123', 'US')).to.deep.equal({
country : 'US',
phone : '2134567890',
ext : '123'
})
// "ext."
expect(parseNumber('+12134567890 ext. 12345', 'US')).to.deep.equal({
country : 'US',
phone : '2134567890',
ext : '12345'
})
// "доб."
expect(parseNumber('+78005553535 доб. 1234', 'RU')).to.deep.equal({
country : 'RU',
phone : '8005553535',
ext : '1234'
})
// "#"
expect(parseNumber('+12134567890#1234')).to.deep.equal({
country : 'US',
phone : '2134567890',
ext : '1234'
})
// "x"
expect(parseNumber('+78005553535 x1234')).to.deep.equal({
country : 'RU',
phone : '8005553535',
ext : '1234'
})
// Not a valid extension
expect(parseNumber('2134567890 ext. abc', 'US')).to.deep.equal({
country : 'US',
phone : '2134567890'
})
})
it('should parse RFC 3966 phone numbers', () => {
expect(parseNumber('tel:+78005553535;ext=123')).to.deep.equal({
country : 'RU',
phone : '8005553535',
ext : '123'
})
// Should parse "visual separators".
expect(parseNumber('tel:+7(800)555-35.35;ext=123')).to.deep.equal({
country : 'RU',
phone : '8005553535',
ext : '123'
})
// Invalid number.
expect(parseNumber('tel:+7x8005553535;ext=123')).to.deep.equal({})
})
it('should parse invalid international numbers even if they are invalid', () => {
expect(parseNumber('+7(8)8005553535', 'RU')).to.deep.equal({
country : 'RU',
phone : '8005553535'
})
})
it('should parse carrier codes', () => {
expect(parseNumber('0 15 21 5555-5555', 'BR', { extended: true })).to.deep.equal({
country : 'BR',
countryCallingCode : '55',
phone : '2155555555',
carrierCode : '15',
ext : undefined,
valid : true,
possible : true
})
})
it('should parse IDD prefixes', () => {
expect(parseNumber('011 61 2 3456 7890', 'US')).to.deep.equal({
phone : '234567890',
country : 'AU'
})
expect(parseNumber('011 61 2 3456 7890', 'FR')).to.deep.equal({})
expect(parseNumber('00 61 2 3456 7890', 'US')).to.deep.equal({})
expect(parseNumber('810 61 2 3456 7890', 'RU')).to.deep.equal({
phone : '234567890',
country : 'AU'
})
})
it('should work with v2 API', () => {
parseNumber('+99989160151539')
})
it('should work with Argentina numbers', () => {
// The same mobile number is written differently
// in different formats in Argentina:
// `9` gets prepended in international format.
expect(parseNumber('+54 9 3435 55 1212')).to.deep.equal({
country: 'AR',
phone: '93435551212'
})
expect(parseNumber('0343 15-555-1212', 'AR')).to.deep.equal({
country: 'AR',
phone: '93435551212'
})
})
it('should work with Mexico numbers', () => {
// Fixed line.
expect(parseNumber('+52 449 978 0001')).to.deep.equal({
country: 'MX',
phone: '4499780001'
})
// "Dialling tokens 01, 02, 044, 045 and 1 are removed as they are
// no longer valid since August 2019."
//
// parseNumber('01 (449)978-0001', 'MX').should.deep.equal({
// country: 'MX',
// phone: '4499780001'
// })
expect(parseNumber('(449)978-0001', 'MX')).to.deep.equal({
country: 'MX',
phone: '4499780001'
})
// "Dialling tokens 01, 02, 044, 045 and 1 are removed as they are
// no longer valid since August 2019."
//
// // Mobile.
// // `1` is prepended before area code to mobile numbers in international format.
// parseNumber('+52 1 33 1234-5678', 'MX').should.deep.equal({
// country: 'MX',
// phone: '3312345678'
// })
expect(parseNumber('+52 33 1234-5678', 'MX')).to.deep.equal({
country: 'MX',
phone: '3312345678'
})
// "Dialling tokens 01, 02, 044, 045 and 1 are removed as they are
// no longer valid since August 2019."
//
// parseNumber('044 (33) 1234-5678', 'MX').should.deep.equal({
// country: 'MX',
// phone: '3312345678'
// })
// parseNumber('045 33 1234-5678', 'MX').should.deep.equal({
// country: 'MX',
// phone: '3312345678'
// })
})
it('should parse non-geographic numbering plan phone numbers', () => {
expect(parseNumber('+870773111632')).to.deep.equal(USE_NON_GEOGRAPHIC_COUNTRY_CODE ?
{
country: '001',
phone: '773111632'
} :
{})
})
it('should parse non-geographic numbering plan phone numbers (default country code)', () => {
expect(parseNumber('773111632', { defaultCallingCode: '870' })).to.deep.equal(USE_NON_GEOGRAPHIC_COUNTRY_CODE ?
{
country: '001',
phone: '773111632'
} :
{})
})
it('should parse non-geographic numbering plan phone numbers (extended)', () => {
expect(parseNumber('+870773111632', { extended: true })).to.deep.equal({
country: USE_NON_GEOGRAPHIC_COUNTRY_CODE ? '001' : undefined,
countryCallingCode: '870',
phone: '773111632',
carrierCode: undefined,
ext: undefined,
possible: true,
valid: true
})
})
it('should parse non-geographic numbering plan phone numbers (default country code) (extended)', () => {
expect(parseNumber('773111632', { defaultCallingCode: '870', extended: true })).to.deep.equal({
country: USE_NON_GEOGRAPHIC_COUNTRY_CODE ? '001' : undefined,
countryCallingCode: '870',
phone: '773111632',
carrierCode: undefined,
ext: undefined,
possible: true,
valid: true
})
})
it('shouldn\'t crash when invalid `defaultCallingCode` is passed', () => {
expect(() => parseNumber('773111632', { defaultCallingCode: '999' })).to.throw('Unknown calling code')
})
it('shouldn\'t set `country` when there\'s no `defaultCountry` and `defaultCallingCode` is not of a "non-geographic entity"', () => {
expect(parseNumber('88005553535', { defaultCallingCode: '7' })).to.deep.equal({
country: 'RU',
phone: '8005553535'
})
})
it('should correctly parse numbers starting with the same digit as the national prefix', () => {
// https://github.com/catamphetamine/libphonenumber-js/issues/373
// `BY`'s `national_prefix` is `8`.
expect(parseNumber('+37582004910060')).to.deep.equal({
country: 'BY',
phone: '82004910060'
});
})
it('should autocorrect numbers without a leading +', () => {
// https://github.com/catamphetamine/libphonenumber-js/issues/376
expect(parseNumber('375447521111', 'BY')).to.deep.equal({
country: 'BY',
phone: '447521111'
});
// https://github.com/catamphetamine/libphonenumber-js/issues/316
expect(parseNumber('33612902554', 'FR')).to.deep.equal({
country: 'FR',
phone: '612902554'
});
// https://github.com/catamphetamine/libphonenumber-js/issues/375
expect(parseNumber('61438331999', 'AU')).to.deep.equal({
country: 'AU',
phone: '438331999'
});
// A case when `49` is a country calling code of a number without a leading `+`.
expect(parseNumber('4930123456', 'DE')).to.deep.equal({
country: 'DE',
phone: '30123456'
});
// A case when `49` is a valid area code.
expect(parseNumber('4951234567890', 'DE')).to.deep.equal({
country: 'DE',
phone: '4951234567890'
});
})
it('should parse extensions (long extensions with explicitl abels)', () => {
// Test lower and upper limits of extension lengths for each type of label.
// Firstly, when in RFC format: PhoneNumberUtil.extLimitAfterExplicitLabel
expect(parseNumber('33316005 ext 0', 'NZ').ext).to.equal('0')
expect(parseNumber('33316005 ext 01234567890123456789', 'NZ').ext).to.equal('01234567890123456789')
// Extension too long.
expect(parseNumber('33316005 ext 012345678901234567890', 'NZ').ext).to.be.undefined
// Explicit extension label.
expect(parseNumber('03 3316005ext:1', 'NZ').ext).to.equal('1')
expect(parseNumber('03 3316005 xtn:12345678901234567890', 'NZ').ext).to.equal('12345678901234567890')
expect(parseNumber('03 3316005 extension\t12345678901234567890', 'NZ').ext).to.equal('12345678901234567890')
expect(parseNumber('03 3316005 xtensio:12345678901234567890', 'NZ').ext).to.equal('12345678901234567890')
expect(parseNumber('03 3316005 xtensión, 12345678901234567890#', 'NZ').ext).to.equal('12345678901234567890')
expect(parseNumber('03 3316005extension.12345678901234567890', 'NZ').ext).to.equal('12345678901234567890')
expect(parseNumber('03 3316005 доб:12345678901234567890', 'NZ').ext).to.equal('12345678901234567890')
// Extension too long.
expect(parseNumber('03 3316005 extension 123456789012345678901', 'NZ').ext).to.be.undefined
})
it('should parse extensions (long extensions with auto dialling labels)', () => {
expect(parseNumber('+12679000000,,123456789012345#').ext).to.equal('123456789012345')
expect(parseNumber('+12679000000;123456789012345#').ext).to.equal('123456789012345')
expect(parseNumber('+442034000000,,123456789#').ext).to.equal('123456789')
// Extension too long.
expect(parseNumber('+12679000000,,1234567890123456#').ext).to.be.undefined
})
it('should parse extensions (short extensions with ambiguous characters)', () => {
expect(parseNumber('03 3316005 x 123456789', 'NZ').ext).to.equal('123456789')
expect(parseNumber('03 3316005 x. 123456789', 'NZ').ext).to.equal('123456789')
expect(parseNumber('03 3316005 #123456789#', 'NZ').ext).to.equal('123456789')
expect(parseNumber('03 3316005 ~ 123456789', 'NZ').ext).to.equal('123456789')
// Extension too long.
expect(parseNumber('03 3316005 ~ 1234567890', 'NZ').ext).to.be.undefined
})
it('should parse extensions (short extensions when not sure of label)', () => {
expect(parseNumber('+1123-456-7890 666666#', { v2: true }).ext).to.equal('666666')
expect(parseNumber('+11234567890-6#', { v2: true }).ext).to.equal('6')
// Extension too long.
expect(() => parseNumber('+1123-456-7890 7777777#', { v2: true })).to.throw('NOT_A_NUMBER')
})
})