Skip to content

Commit a4ae257

Browse files
chrisochriso
authored
Merge pull request #734 from IamNguele/isiso3166-1-alpha2
Add ISO-3166-1 alpha-2 country validation
2 parents eca753f + c42f5a8 commit a4ae257

File tree

7 files changed

+104
-0
lines changed

7 files changed

+104
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Validator | Description
8989
**isISSN(str [, options])** | check if the string is an [ISSN](https://en.wikipedia.org/wiki/International_Standard_Serial_Number).<br/><br/>`options` is an object which defaults to `{ case_sensitive: false, require_hyphen: false }`. If `case_sensitive` is true, ISSNs with a lowercase `'x'` as the check digit are rejected.
9090
**isISIN(str)** | check if the string is an [ISIN][ISIN] (stock/security identifier).
9191
**isISO8601(str)** | check if the string is a valid [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date.
92+
**isISO8601(str)** | check if the string is a valid [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) officially assigned country code.
9293
**isISRC(str)** | check if the string is a [ISRC](https://en.wikipedia.org/wiki/International_Standard_Recording_Code).
9394
**isIn(str, values)** | check if the string is in a array of allowed values.
9495
**isInt(str [, options])** | check if the string is an integer.<br/><br/>`options` is an object which can contain the keys `min` and/or `max` to check the integer is within boundaries (e.g. `{ min: 10, max: 99 }`). `options` can also contain the key `allow_leading_zeroes`, which when set to false will disallow integer values with leading zeroes (e.g. `{ allow_leading_zeroes: false }`). Finally, `options` can contain the keys `gt` and/or `lt` which will enforce integers being greater than or less than, respectively, the value provided (e.g. `{gt: 1, lt: 4}` for a number between 1 and 4).

‎index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,10 @@ var _isISO = require('./lib/isISO8601');
204204

205205
var _isISO2 = _interopRequireDefault(_isISO);
206206

207+
var _isISO31661Alpha = require('./lib/isISO31661Alpha2');
208+
209+
var _isISO31661Alpha2 = _interopRequireDefault(_isISO31661Alpha);
210+
207211
var _isBase = require('./lib/isBase64');
208212

209213
var _isBase2 = _interopRequireDefault(_isBase);
@@ -321,6 +325,7 @@ var validator = {
321325
isPostalCode: _isPostalCode2.default,
322326
isCurrency: _isCurrency2.default,
323327
isISO8601: _isISO2.default,
328+
isISO31661Alpha2: _isISO31661Alpha2.default,
324329
isBase64: _isBase2.default,
325330
isDataURI: _isDataURI2.default,
326331
isLatLong: _isLatLong2.default,

‎lib/isISO31661Alpha2.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
'use strict';
2+
3+
Object.defineProperty(exports, "__esModule", {
4+
value: true
5+
});
6+
exports.default = isISO31661Alpha2;
7+
8+
var _assertString = require('./util/assertString');
9+
10+
var _assertString2 = _interopRequireDefault(_assertString);
11+
12+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
13+
14+
// from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
15+
var validISO31661Alpha2CountriesCodes = ['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW'];
16+
17+
function isISO31661Alpha2(str) {
18+
(0, _assertString2.default)(str);
19+
return validISO31661Alpha2CountriesCodes.includes(str.toUpperCase());
20+
}
21+
module.exports = exports['default'];

‎src/index.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ import isMobilePhone from './lib/isMobilePhone';
6666
import isCurrency from './lib/isCurrency';
6767

6868
import isISO8601 from './lib/isISO8601';
69+
import isISO31661Alpha2 from './lib/isISO31661Alpha2';
6970

7071
import isBase64 from './lib/isBase64';
7172
import isDataURI from './lib/isDataURI';
@@ -142,6 +143,7 @@ const validator = {
142143
isPostalCode,
143144
isCurrency,
144145
isISO8601,
146+
isISO31661Alpha2,
145147
isBase64,
146148
isDataURI,
147149
isLatLong,

‎src/lib/isISO31661Alpha2.js

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import assertString from './util/assertString';
2+
3+
// from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
4+
const validISO31661Alpha2CountriesCodes = [
5+
'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ',
6+
'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ',
7+
'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ',
8+
'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ',
9+
'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET',
10+
'FI', 'FJ', 'FK', 'FM', 'FO', 'FR',
11+
'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY',
12+
'HK', 'HM', 'HN', 'HR', 'HT', 'HU',
13+
'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT',
14+
'JE', 'JM', 'JO', 'JP',
15+
'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ',
16+
'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY',
17+
'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ',
18+
'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ',
19+
'OM',
20+
'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY',
21+
'QA',
22+
'RE', 'RO', 'RS', 'RU', 'RW',
23+
'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ',
24+
'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ',
25+
'UA', 'UG', 'UM', 'US', 'UY', 'UZ',
26+
'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU',
27+
'WF', 'WS',
28+
'YE', 'YT',
29+
'ZA', 'ZM', 'ZW',
30+
];
31+
32+
export default function isISO31661Alpha2(str) {
33+
assertString(str);
34+
return validISO31661Alpha2CountriesCodes.includes(str.toUpperCase());
35+
}

‎test/validators.js

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4793,6 +4793,37 @@ describe('Validators', function () {
47934793
});
47944794
});
47954795

4796+
it('should validate ISO 3166-1 alpha 2 country codes', function () {
4797+
// from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
4798+
test({
4799+
validator: 'isISO31661Alpha2',
4800+
valid: [
4801+
'FR',
4802+
'fR',
4803+
'GB',
4804+
'PT',
4805+
'CM',
4806+
'JP',
4807+
'PM',
4808+
'ZW',
4809+
'MM',
4810+
'cc',
4811+
'GG',
4812+
],
4813+
invalid: [
4814+
'',
4815+
'FRA',
4816+
'AA',
4817+
'PI',
4818+
'RP',
4819+
'WV',
4820+
'WL',
4821+
'UK',
4822+
'ZZ',
4823+
],
4824+
});
4825+
});
4826+
47964827
it('should validate whitelisted characters', function () {
47974828
test({
47984829
validator: 'isWhitelisted',

‎validator.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,6 +1125,14 @@ function isISO8601(str) {
11251125
return iso8601.test(str);
11261126
}
11271127

1128+
// from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
1129+
var validISO31661Alpha2CountriesCodes = ['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW'];
1130+
1131+
function isISO31661Alpha2(str) {
1132+
assertString(str);
1133+
return validISO31661Alpha2CountriesCodes.includes(str.toUpperCase());
1134+
}
1135+
11281136
var notBase64 = /[^A-Z0-9+\/=]/i;
11291137

11301138
function isBase64(str) {
@@ -1446,6 +1454,7 @@ var validator = {
14461454
isPostalCode: isPostalCode,
14471455
isCurrency: isCurrency,
14481456
isISO8601: isISO8601,
1457+
isISO31661Alpha2: isISO31661Alpha2,
14491458
isBase64: isBase64,
14501459
isDataURI: isDataURI,
14511460
isLatLong: isLatLong,

0 commit comments

Comments
 (0)