libphonenumber-js
Version:
A simpler (and smaller) rewrite of Google Android's libphonenumber library in javascript
613 lines (538 loc) • 21.7 kB
JavaScript
"use strict";
var _metadataMin = _interopRequireDefault(require("../metadata.min.json"));
var _parse = _interopRequireDefault(require("./parse.js"));
var _metadata = _interopRequireDefault(require("./metadata.js"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function parseNumber() {
for (var _len = arguments.length, parameters = new Array(_len), _key = 0; _key < _len; _key++) {
parameters[_key] = arguments[_key];
}
if (parameters.length < 2) {
// `options` parameter.
parameters.push(undefined);
} // Convert default country argument to an `options` object.
if (typeof parameters[1] === 'string') {
parameters[1] = _objectSpread(_objectSpread({}, parameters[2]), {}, {
defaultCountry: parameters[1]
});
}
if (parameters[2]) {
parameters[2] = _metadataMin["default"];
} else {
parameters.push(_metadataMin["default"]);
}
return _parse["default"].apply(this, parameters);
}
var USE_NON_GEOGRAPHIC_COUNTRY_CODE = false;
describe('parse', function () {
it('should not parse invalid phone numbers', function () {
// Too short.
parseNumber('+7 (800) 55-35-35').should.deep.equal({}); // Too long.
parseNumber('+7 (800) 55-35-35-55').should.deep.equal({});
parseNumber('+7 (800) 55-35-35', 'US').should.deep.equal({});
parseNumber('(800) 55 35 35', {
defaultCountry: 'RU'
}).should.deep.equal({});
parseNumber('+1 187 215 5230', 'US').should.deep.equal({});
parseNumber('911231231', 'BE').should.deep.equal({});
});
it('should parse valid phone numbers', function () {
// Instant loans
// https://www.youtube.com/watch?v=6e1pMrYH5jI
//
// Restrict to RU
parseNumber('Phone: 8 (800) 555 35 35.', 'RU').should.deep.equal({
country: 'RU',
phone: '8005553535'
}); // International format
parseNumber('Phone: +7 (800) 555-35-35.').should.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
parseNumber('(800) 555 35 35', 'RU').should.deep.equal({
country: 'RU',
phone: '8005553535'
}); // Default to RU
parseNumber('8 (800) 555 35 35', {
defaultCountry: 'RU'
}).should.deep.equal({
country: 'RU',
phone: '8005553535'
}); // Gangster partyline
parseNumber('+1-213-373-4253').should.deep.equal({
country: 'US',
phone: '2133734253'
}); // Switzerland (just in case)
parseNumber('044 668 18 00', 'CH').should.deep.equal({
country: 'CH',
phone: '446681800'
}); // China, Beijing
parseNumber('010-852644821', 'CN').should.deep.equal({
country: 'CN',
phone: '10852644821'
}); // France
parseNumber('+33169454850').should.deep.equal({
country: 'FR',
phone: '169454850'
}); // UK (Jersey)
parseNumber('+44 7700 300000').should.deep.equal({
country: 'JE',
phone: '7700300000'
}); // KZ
parseNumber('+7 702 211 1111').should.deep.equal({
country: 'KZ',
phone: '7022111111'
}); // Brazil
parseNumber('11987654321', 'BR').should.deep.equal({
country: 'BR',
phone: '11987654321'
}); // Long country phone code.
parseNumber('+212659777777').should.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.
parseNumber('07624369230', 'GB').should.deep.equal({
country: 'IM',
phone: '7624369230'
});
});
it('should parse possible numbers', function () {
// Invalid phone number for a given country.
parseNumber('1112223344', 'RU', {
extended: true
}).should.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.
parseNumber('+71112223344').should.deep.equal({});
parseNumber('+71112223344', {
extended: true
}).should.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.
parseNumber('+33011222333', {
extended: true
}).should.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.
parseNumber('+7 (800) 55-35-35', {
extended: true
}).should.deep.equal({
country: 'RU',
countryCallingCode: '7',
phone: '800553535',
carrierCode: undefined,
ext: undefined,
valid: false,
possible: false
}); // Too long.
parseNumber('+1 213 37342530', {
extended: true
}).should.deep.equal({
country: undefined,
countryCallingCode: '1',
phone: '21337342530',
carrierCode: undefined,
ext: undefined,
valid: false,
possible: false
}); // No national number to be parsed.
parseNumber('+996', {
extended: true
}).should.deep.equal({// countryCallingCode : '996'
}); // Valid number.
parseNumber('+78005553535', {
extended: true
}).should.deep.equal({
country: 'RU',
countryCallingCode: '7',
phone: '8005553535',
carrierCode: undefined,
ext: undefined,
valid: true,
possible: true
}); // https://github.com/catamphetamine/libphonenumber-js/issues/211
parseNumber('+966', {
extended: true
}).should.deep.equal({});
parseNumber('+9664', {
extended: true
}).should.deep.equal({});
parseNumber('+96645', {
extended: true
}).should.deep.equal({
carrierCode: undefined,
phone: '45',
ext: undefined,
country: 'SA',
countryCallingCode: '966',
possible: false,
valid: false
});
});
it('should parse non-European digits', function () {
parseNumber('+١٢١٢٢٣٢٣٢٣٢').should.deep.equal({
country: 'US',
phone: '2122323232'
});
});
it('should work in edge cases', function () {
var thrower; // No input
parseNumber('').should.deep.equal({}); // No country phone code
parseNumber('+').should.deep.equal({}); // No country at all (non international number and no explicit country code)
parseNumber('123').should.deep.equal({}); // No country metadata for this `require` country code
thrower = function thrower() {
return parseNumber('123', 'ZZ');
};
thrower.should["throw"]('Unknown country'); // No country metadata for this `default` country code
thrower = function thrower() {
return parseNumber('123', {
defaultCountry: 'ZZ'
});
};
thrower.should["throw"]('Unknown country'); // Invalid country phone code
parseNumber('+210').should.deep.equal({}); // Invalid country phone code (extended parsing mode)
parseNumber('+210', {
extended: true
}).should.deep.equal({}); // Too short of a number.
parseNumber('1', 'US', {
extended: true
}).should.deep.equal({}); // Too long of a number.
parseNumber('1111111111111111111', 'RU', {
extended: true
}).should.deep.equal({}); // Not a number.
parseNumber('abcdefg', 'US', {
extended: true
}).should.deep.equal({}); // Country phone code beginning with a '0'
parseNumber('+0123').should.deep.equal({}); // Barbados NANPA phone number
parseNumber('+12460000000').should.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
parseNumber('2', 'US').should.deep.equal({}); // National (significant) number too long
parseNumber('222222222222222222', 'US').should.deep.equal({}); // No `national_prefix_for_parsing`
parseNumber('41111', 'AC').should.deep.equal({
country: 'AC',
phone: '41111'
}); // https://github.com/catamphetamine/libphonenumber-js/issues/235
// `matchesEntirely()` bug fix.
parseNumber('+4915784846111').should.deep.equal({
country: 'DE',
phone: '15784846111'
}); // No metadata
thrower = function thrower() {
return (0, _parse["default"])('');
};
thrower.should["throw"]('`metadata` argument not passed'); // // Numerical `value`
// thrower = () => parseNumber(2141111111, 'US')
// thrower.should.throw('A text for parsing must be a string.')
// Input string too long.
parseNumber('8005553535 ', 'RU').should.deep.equal({});
});
it('should parse phone number extensions', function () {
// "ext"
parseNumber('2134567890 ext 123', 'US').should.deep.equal({
country: 'US',
phone: '2134567890',
ext: '123'
}); // "ext."
parseNumber('+12134567890 ext. 12345', 'US').should.deep.equal({
country: 'US',
phone: '2134567890',
ext: '12345'
}); // "доб."
parseNumber('+78005553535 доб. 1234', 'RU').should.deep.equal({
country: 'RU',
phone: '8005553535',
ext: '1234'
}); // "#"
parseNumber('+12134567890#1234').should.deep.equal({
country: 'US',
phone: '2134567890',
ext: '1234'
}); // "x"
parseNumber('+78005553535 x1234').should.deep.equal({
country: 'RU',
phone: '8005553535',
ext: '1234'
}); // Not a valid extension
parseNumber('2134567890 ext. abc', 'US').should.deep.equal({
country: 'US',
phone: '2134567890'
});
});
it('should parse RFC 3966 phone numbers', function () {
parseNumber('tel:+78005553535;ext=123').should.deep.equal({
country: 'RU',
phone: '8005553535',
ext: '123'
}); // Should parse "visual separators".
parseNumber('tel:+7(800)555-35.35;ext=123').should.deep.equal({
country: 'RU',
phone: '8005553535',
ext: '123'
}); // Invalid number.
parseNumber('tel:+7x8005553535;ext=123').should.deep.equal({});
});
it('should parse invalid international numbers even if they are invalid', function () {
parseNumber('+7(8)8005553535', 'RU').should.deep.equal({
country: 'RU',
phone: '8005553535'
});
});
it('should parse carrier codes', function () {
parseNumber('0 15 21 5555-5555', 'BR', {
extended: true
}).should.deep.equal({
country: 'BR',
countryCallingCode: '55',
phone: '2155555555',
carrierCode: '15',
ext: undefined,
valid: true,
possible: true
});
});
it('should parse IDD prefixes', function () {
parseNumber('011 61 2 3456 7890', 'US').should.deep.equal({
phone: '234567890',
country: 'AU'
});
parseNumber('011 61 2 3456 7890', 'FR').should.deep.equal({});
parseNumber('00 61 2 3456 7890', 'US').should.deep.equal({});
parseNumber('810 61 2 3456 7890', 'RU').should.deep.equal({
phone: '234567890',
country: 'AU'
});
});
it('should work with v2 API', function () {
parseNumber('+99989160151539');
});
it('should work with Argentina numbers', function () {
// The same mobile number is written differently
// in different formats in Argentina:
// `9` gets prepended in international format.
parseNumber('+54 9 3435 55 1212').should.deep.equal({
country: 'AR',
phone: '93435551212'
});
parseNumber('0343 15-555-1212', 'AR').should.deep.equal({
country: 'AR',
phone: '93435551212'
});
});
it('should work with Mexico numbers', function () {
// Fixed line.
parseNumber('+52 449 978 0001').should.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'
// })
parseNumber('(449)978-0001', 'MX').should.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'
// })
parseNumber('+52 33 1234-5678', 'MX').should.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', function () {
parseNumber('+870773111632').should.deep.equal(USE_NON_GEOGRAPHIC_COUNTRY_CODE ? {
country: '001',
phone: '773111632'
} : {});
});
it('should parse non-geographic numbering plan phone numbers (default country code)', function () {
parseNumber('773111632', {
defaultCallingCode: '870'
}).should.deep.equal(USE_NON_GEOGRAPHIC_COUNTRY_CODE ? {
country: '001',
phone: '773111632'
} : {});
});
it('should parse non-geographic numbering plan phone numbers (extended)', function () {
parseNumber('+870773111632', {
extended: true
}).should.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)', function () {
parseNumber('773111632', {
defaultCallingCode: '870',
extended: true
}).should.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', function () {
expect(function () {
return 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"', function () {
parseNumber('88005553535', {
defaultCallingCode: '7'
}).should.deep.equal({
country: 'RU',
phone: '8005553535'
});
});
it('should correctly parse numbers starting with the same digit as the national prefix', function () {
// https://github.com/catamphetamine/libphonenumber-js/issues/373
// `BY`'s `national_prefix` is `8`.
parseNumber('+37582004910060').should.deep.equal({
country: 'BY',
phone: '82004910060'
});
});
it('should autocorrect numbers without a leading +', function () {
// https://github.com/catamphetamine/libphonenumber-js/issues/376
parseNumber('375447521111', 'BY').should.deep.equal({
country: 'BY',
phone: '447521111'
}); // https://github.com/catamphetamine/libphonenumber-js/issues/316
parseNumber('33612902554', 'FR').should.deep.equal({
country: 'FR',
phone: '612902554'
}); // https://github.com/catamphetamine/libphonenumber-js/issues/375
parseNumber('61438331999', 'AU').should.deep.equal({
country: 'AU',
phone: '438331999'
}); // A case when `49` is a country calling code of a number without a leading `+`.
parseNumber('4930123456', 'DE').should.deep.equal({
country: 'DE',
phone: '30123456'
}); // A case when `49` is a valid area code.
parseNumber('4951234567890', 'DE').should.deep.equal({
country: 'DE',
phone: '4951234567890'
});
});
it('should parse extensions (long extensions with explicitl abels)', function () {
// Test lower and upper limits of extension lengths for each type of label.
// Firstly, when in RFC format: PhoneNumberUtil.extLimitAfterExplicitLabel
parseNumber('33316005 ext 0', 'NZ').ext.should.equal('0');
parseNumber('33316005 ext 01234567890123456789', 'NZ').ext.should.equal('01234567890123456789'); // Extension too long.
expect(parseNumber('33316005 ext 012345678901234567890', 'NZ').ext).to.be.undefined; // Explicit extension label.
parseNumber('03 3316005ext:1', 'NZ').ext.should.equal('1');
parseNumber('03 3316005 xtn:12345678901234567890', 'NZ').ext.should.equal('12345678901234567890');
parseNumber('03 3316005 extension\t12345678901234567890', 'NZ').ext.should.equal('12345678901234567890');
parseNumber('03 3316005 xtensio:12345678901234567890', 'NZ').ext.should.equal('12345678901234567890');
parseNumber('03 3316005 xtensión, 12345678901234567890#', 'NZ').ext.should.equal('12345678901234567890');
parseNumber('03 3316005extension.12345678901234567890', 'NZ').ext.should.equal('12345678901234567890');
parseNumber('03 3316005 доб:12345678901234567890', 'NZ').ext.should.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)', function () {
parseNumber('+12679000000,,123456789012345#').ext.should.equal('123456789012345');
parseNumber('+12679000000;123456789012345#').ext.should.equal('123456789012345');
parseNumber('+442034000000,,123456789#').ext.should.equal('123456789'); // Extension too long.
expect(parseNumber('+12679000000,,1234567890123456#').ext).to.be.undefined;
});
it('should parse extensions (short extensions with ambiguous characters)', function () {
parseNumber('03 3316005 x 123456789', 'NZ').ext.should.equal('123456789');
parseNumber('03 3316005 x. 123456789', 'NZ').ext.should.equal('123456789');
parseNumber('03 3316005 #123456789#', 'NZ').ext.should.equal('123456789');
parseNumber('03 3316005 ~ 123456789', 'NZ').ext.should.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)', function () {
parseNumber('+1123-456-7890 666666#', {
v2: true
}).ext.should.equal('666666');
parseNumber('+11234567890-6#', {
v2: true
}).ext.should.equal('6'); // Extension too long.
expect(function () {
return parseNumber('+1123-456-7890 7777777#', {
v2: true
});
}).to["throw"]('NOT_A_NUMBER');
});
it('should not choose `defaultCountry` over the "main" one when both the `defaultCountry` and the "main" one match the phone number', function () {
// This phone number matches both US and CA because they have the same
// regular expression for some weird reason.
// https://gitlab.com/catamphetamine/libphonenumber-js/-/issues/103
var phoneNumber = parseNumber('8004001000', {
defaultCountry: 'CA',
v2: true
});
phoneNumber.country.should.not.equal('CA');
phoneNumber.country.should.equal('US'); // This phone number is specific to CA.
var phoneNumber2 = parseNumber('4389999999', {
defaultCountry: 'US',
v2: true
});
phoneNumber2.country.should.equal('CA');
});
});
//# sourceMappingURL=parse.test.js.map