feat(isPassportNumber): add isPassportNumber validator (#1250)

* feat: implement isPassportNumber validator * normalize str by cleaning spaces and converting to UPPERCASE * style: function docs, helper comments * remove unrelated changes closes #1218
validatorjs · Feb 17, 2020 · 9836c29 · 9836c29
1 parent 4f74f79
commit 9836c29
Show file tree

Hide file tree

Showing 8 changed files with 807 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -140,6 +140,7 @@ Validator                               | Description
 **isMultibyte(str)**                    | check if the string contains one or more multibyte chars.
 **isNumeric(str [, options])**                      | check if the string contains only numbers.<br/><br/>`options` is an object which defaults to `{no_symbols: false}`. If `no_symbols` is true, the validator will reject numeric strings that feature a symbol (e.g. `+`, `-`, or `.`).
 **isOctal(str)**                        | check if the string is a valid octal number.
+**isPassportNumber(str, countryCode)    | check if the string is a valid passport number relative to a specific country code.
 **isPort(str)**                         | check if the string is a valid port number.
 **isPostalCode(str, locale)**           | check if the string is a postal code,<br/><br/>(locale is one of `[ 'AD', 'AT', 'AU', 'BE', 'BG', 'BR', 'CA', 'CH', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'ID', 'IE' 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'LI', 'LT', 'LU', 'LV', 'MT', 'MX', 'NL', 'NO', 'NZ', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SI', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM' ]` OR 'any'. If 'any' is used, function will check if any of the locals match. Locale list is `validator.isPostalCodeLocales`.).
 **isSemVer(str)**                       | check if the string is a Semantic Versioning Specification (SemVer).

diff --git a/index.js b/index.js
@@ -35,12 +35,16 @@ var _isFQDN = _interopRequireDefault(require("./lib/isFQDN"));
 
 var _isBoolean = _interopRequireDefault(require("./lib/isBoolean"));
 
+var _isLocale = _interopRequireDefault(require("./lib/isLocale"));
+
 var _isAlpha = _interopRequireWildcard(require("./lib/isAlpha"));
 
 var _isAlphanumeric = _interopRequireWildcard(require("./lib/isAlphanumeric"));
 
 var _isNumeric = _interopRequireDefault(require("./lib/isNumeric"));
 
+var _isPassportNumber = _interopRequireDefault(require("./lib/isPassportNumber"));
+
 var _isPort = _interopRequireDefault(require("./lib/isPort"));
 
 var _isLowercase = _interopRequireDefault(require("./lib/isLowercase"));
@@ -201,6 +205,7 @@ var validator = {
   isAlphanumeric: _isAlphanumeric.default,
   isAlphanumericLocales: _isAlphanumeric.locales,
   isNumeric: _isNumeric.default,
+  isPassportNumber: _isPassportNumber.default,
   isPort: _isPort.default,
   isLowercase: _isLowercase.default,
   isUppercase: _isUppercase.default,
@@ -227,6 +232,7 @@ var validator = {
   isJSON: _isJSON.default,
   isEmpty: _isEmpty.default,
   isLength: _isLength.default,
+  isLocale: _isLocale.default,
   isByteLength: _isByteLength.default,
   isUUID: _isUUID.default,
   isMongoId: _isMongoId.default,

diff --git a/lib/isPassportNumber.js b/lib/isPassportNumber.js
@@ -0,0 +1,112 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = isPassportNumber;
+
+/**
+ * Reference:
+ * https://en.wikipedia.org/ -- Wikipedia
+ * https://docs.microsoft.com/en-us/microsoft-365/compliance/eu-passport-number -- EU Passport Number
+ * https://countrycode.org/ -- Country Codes
+ */
+var passportRegexByCountryCode = {
+  AM: /^[A-Z]{2}\d{7}$/,
+  // ARMENIA
+  AR: /^[A-Z]{3}\d{6}$/,
+  // ARGENTINA
+  AT: /^[A-Z]\d{7}$/,
+  // AUSTRIA
+  AU: /^[A-Z]\d{7}$/,
+  // AUSTRALIA
+  BE: /^[A-Z]{2}\d{6}$/,
+  // BELGIUM
+  BG: /^\d{9}$/,
+  // BULGARIA
+  CA: /^[A-Z]{2}\d{6}$/,
+  // CANADA
+  CH: /^[A-Z]\d{7}$/,
+  // SWITZERLAND
+  CN: /^[GE]\d{8}$/,
+  // CHINA [G=Ordinary, E=Electronic] followed by 8-digits
+  CY: /^[A-Z](\d{6}|\d{8})$/,
+  // CYPRUS
+  CZ: /^\d{8}$/,
+  // CZECH REPUBLIC
+  DE: /^[CFGHJKLMNPRTVWXYZ0-9]{9}$/,
+  // GERMANY
+  DK: /^\d{9}$/,
+  // DENMARK
+  EE: /^([A-Z]\d{7}|[A-Z]{2}\d{7})$/,
+  // ESTONIA (K followed by 7-digits), e-passports have 2 UPPERCASE followed by 7 digits
+  ES: /^[A-Z0-9]{2}([A-Z0-9]?)\d{6}$/,
+  // SPAIN
+  FI: /^[A-Z]{2}\d{7}$/,
+  // FINLAND
+  FR: /^\d{2}[A-Z]{2}\d{5}$/,
+  // FRANCE
+  GB: /^\d{9}$/,
+  // UNITED KINGDOM
+  GR: /^[A-Z]{2}\d{7}$/,
+  // GREECE
+  HR: /^\d{9}$/,
+  // CROATIA
+  HU: /^[A-Z]{2}(\d{6}|\d{7})$/,
+  // HUNGARY
+  IE: /^[A-Z0-9]{2}\d{7}$/,
+  // IRELAND
+  IS: /^(A)\d{7}$/,
+  // ICELAND
+  IT: /^[A-Z0-9]{2}\d{7}$/,
+  // ITALY
+  JP: /^[A-Z]{2}\d{7}$/,
+  // JAPAN
+  KR: /^[MS]\d{8}$/,
+  // SOUTH KOREA, REPUBLIC OF KOREA, [S=PS Passports, M=PM Passports]
+  LT: /^[A-Z0-9]{8}$/,
+  // LITHUANIA
+  LU: /^[A-Z0-9]{8}$/,
+  // LUXEMBURG
+  LV: /^[A-Z0-9]{2}\d{7}$/,
+  // LATVIA
+  MT: /^\d{7}$/,
+  // MALTA
+  NL: /^[A-Z]{2}[A-Z0-9]{6}\d$/,
+  // NETHERLANDS
+  PO: /^[A-Z]{2}\d{7}$/,
+  // POLAND
+  PT: /^[A-Z]\d{6}$/,
+  // PORTUGAL
+  RO: /^\d{8,9}$/,
+  // ROMANIA
+  SE: /^\d{8}$/,
+  // SWEDEN
+  SL: /^(P)[A-Z]\d{7}$/,
+  // SLOVANIA
+  SK: /^[0-9A-Z]\d{7}$/,
+  // SLOVAKIA
+  TR: /^[A-Z]\d{8}$/,
+  // TURKEY
+  UA: /^[A-Z]{2}\d{6}$/,
+  // UKRAINE
+  US: /^\d{9}$/ // UNITED STATES
+
+};
+/**
+ * Check if str is a valid passport number
+ * relative to provided ISO Country Code.
+ *
+ * @param {string} str
+ * @param {string} countryCode
+ * @return {boolean}
+ */
+
+function isPassportNumber(str, countryCode) {
+  /** Remove All Whitespaces, Convert to UPPERCASE */
+  var normalizedStr = str.replace(/\s/g, '').toUpperCase();
+  return countryCode.toUpperCase() in passportRegexByCountryCode && passportRegexByCountryCode[countryCode].test(normalizedStr);
+}
+
+module.exports = exports.default;
+module.exports.default = exports.default;
diff --git a/src/index.js b/src/index.js
@@ -19,6 +19,7 @@ import isLocale from './lib/isLocale';
 import isAlpha, { locales as isAlphaLocales } from './lib/isAlpha';
 import isAlphanumeric, { locales as isAlphanumericLocales } from './lib/isAlphanumeric';
 import isNumeric from './lib/isNumeric';
+import isPassportNumber from './lib/isPassportNumber';
 import isPort from './lib/isPort';
 import isLowercase from './lib/isLowercase';
 import isUppercase from './lib/isUppercase';
@@ -134,6 +135,7 @@ const validator = {
   isAlphanumeric,
   isAlphanumericLocales,
   isNumeric,
+  isPassportNumber,
   isPort,
   isLowercase,
   isUppercase,

diff --git a/src/lib/isPassportNumber.js b/src/lib/isPassportNumber.js
@@ -0,0 +1,64 @@
+/**
+ * Reference:
+ * https://en.wikipedia.org/ -- Wikipedia
+ * https://docs.microsoft.com/en-us/microsoft-365/compliance/eu-passport-number -- EU Passport Number
+ * https://countrycode.org/ -- Country Codes
+ */
+const passportRegexByCountryCode = {
+  AM: /^[A-Z]{2}\d{7}$/, // ARMENIA
+  AR: /^[A-Z]{3}\d{6}$/, // ARGENTINA
+  AT: /^[A-Z]\d{7}$/, // AUSTRIA
+  AU: /^[A-Z]\d{7}$/, // AUSTRALIA
+  BE: /^[A-Z]{2}\d{6}$/, // BELGIUM
+  BG: /^\d{9}$/, // BULGARIA
+  CA: /^[A-Z]{2}\d{6}$/, // CANADA
+  CH: /^[A-Z]\d{7}$/, // SWITZERLAND
+  CN: /^[GE]\d{8}$/, // CHINA [G=Ordinary, E=Electronic] followed by 8-digits
+  CY: /^[A-Z](\d{6}|\d{8})$/, // CYPRUS
+  CZ: /^\d{8}$/, // CZECH REPUBLIC
+  DE: /^[CFGHJKLMNPRTVWXYZ0-9]{9}$/, // GERMANY
+  DK: /^\d{9}$/, // DENMARK
+  EE: /^([A-Z]\d{7}|[A-Z]{2}\d{7})$/, // ESTONIA (K followed by 7-digits), e-passports have 2 UPPERCASE followed by 7 digits
+  ES: /^[A-Z0-9]{2}([A-Z0-9]?)\d{6}$/, // SPAIN
+  FI: /^[A-Z]{2}\d{7}$/, // FINLAND
+  FR: /^\d{2}[A-Z]{2}\d{5}$/, // FRANCE
+  GB: /^\d{9}$/, // UNITED KINGDOM
+  GR: /^[A-Z]{2}\d{7}$/, // GREECE
+  HR: /^\d{9}$/, // CROATIA
+  HU: /^[A-Z]{2}(\d{6}|\d{7})$/, // HUNGARY
+  IE: /^[A-Z0-9]{2}\d{7}$/, // IRELAND
+  IS: /^(A)\d{7}$/, // ICELAND
+  IT: /^[A-Z0-9]{2}\d{7}$/, // ITALY
+  JP: /^[A-Z]{2}\d{7}$/, // JAPAN
+  KR: /^[MS]\d{8}$/, // SOUTH KOREA, REPUBLIC OF KOREA, [S=PS Passports, M=PM Passports]
+  LT: /^[A-Z0-9]{8}$/, // LITHUANIA
+  LU: /^[A-Z0-9]{8}$/, // LUXEMBURG
+  LV: /^[A-Z0-9]{2}\d{7}$/, // LATVIA
+  MT: /^\d{7}$/, // MALTA
+  NL: /^[A-Z]{2}[A-Z0-9]{6}\d$/, // NETHERLANDS
+  PO: /^[A-Z]{2}\d{7}$/, // POLAND
+  PT: /^[A-Z]\d{6}$/, // PORTUGAL
+  RO: /^\d{8,9}$/, // ROMANIA
+  SE: /^\d{8}$/, // SWEDEN
+  SL: /^(P)[A-Z]\d{7}$/, // SLOVANIA
+  SK: /^[0-9A-Z]\d{7}$/, // SLOVAKIA
+  TR: /^[A-Z]\d{8}$/, // TURKEY
+  UA: /^[A-Z]{2}\d{6}$/, // UKRAINE
+  US: /^\d{9}$/, // UNITED STATES
+};
+
+/**
+ * Check if str is a valid passport number
+ * relative to provided ISO Country Code.
+ *
+ * @param {string} str
+ * @param {string} countryCode
+ * @return {boolean}
+ */
+export default function isPassportNumber(str, countryCode) {
+  /** Remove All Whitespaces, Convert to UPPERCASE */
+  const normalizedStr = str.replace(/\s/g, '').toUpperCase();
+
+  return (countryCode.toUpperCase() in passportRegexByCountryCode) &&
+    passportRegexByCountryCode[countryCode].test(normalizedStr);
+}