diff --git a/README.md b/README.md
index 2a34bc719..bb3163099 100644
--- a/README.md
+++ b/README.md
@@ -121,7 +121,7 @@ Validator | Description
**isHexadecimal(str)** | check if the string is a hexadecimal number.
**isHexColor(str)** | check if the string is a hexadecimal color.
**isHSL(str)** | check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on [CSS Colors Level 4 specification][CSS Colors Level 4 Specification].
Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: `hsl(200grad+.1%62%/1)`).
-**isIBAN(str)** | check if the string is an IBAN (International Bank Account Number).
+**isIBAN(str, [, options])** | check if the string is an IBAN (International Bank Account Number).
`options` is an object which accepts two attributes: `whitelist`: where you can restrict IBAN codes you want to receive data from and `blacklist`: where you can remove some of the countries from the current list. For both you can use an array with the following values `['AD','AE','AL','AT','AZ','BA','BE','BG','BH','BR','BY','CH','CR','CY','CZ','DE','DK','DO','EE','EG','ES','FI','FO','FR','GB','GE','GI','GL','GR','GT','HR','HU','IE','IL','IQ','IR','IS','IT','JO','KW','KZ','LB','LC','LI','LT','LU','LV','MC','MD','ME','MK','MR','MT','MU','MZ','NL','NO','PK','PL','PS','PT','QA','RO','RS','SA','SC','SE','SI','SK','SM','SV','TL','TN','TR','UA','VA','VG','XK']`.
**isIdentityCard(str [, locale])** | check if the string is a valid identity card code.
`locale` is one of `['LK', 'PL', 'ES', 'FI', 'IN', 'IT', 'IR', 'MZ', 'NO', 'TH', 'zh-TW', 'he-IL', 'ar-LY', 'ar-TN', 'zh-CN', 'zh-HK']` OR `'any'`. If 'any' is used, function will check if any of the locales match.
Defaults to 'any'.
**isIMEI(str [, options]))** | check if the string is a valid [IMEI number][IMEI]. IMEI should be of format `###############` or `##-######-######-#`.
`options` is an object which can contain the keys `allow_hyphens`. Defaults to first format. If `allow_hyphens` is set to true, the validator will validate the second format.
**isIn(str, values)** | check if the string is in an array of allowed values.
diff --git a/src/lib/isIBAN.js b/src/lib/isIBAN.js
index 535a95772..6d7fc22af 100644
--- a/src/lib/isIBAN.js
+++ b/src/lib/isIBAN.js
@@ -86,6 +86,25 @@ const ibanRegexThroughCountryCode = {
XK: /^(XK[0-9]{2})\d{16}$/,
};
+/**
+ * Check if the country codes passed are valid using the
+ * ibanRegexThroughCountryCode as a reference
+ *
+ * @param {array} countryCodeArray
+ * @return {boolean}
+ */
+
+function hasOnlyValidCountryCodes(countryCodeArray) {
+ const countryCodeArrayFilteredWithObjectIbanCode = countryCodeArray
+ .filter(countryCode => !(countryCode in ibanRegexThroughCountryCode));
+
+ if (countryCodeArrayFilteredWithObjectIbanCode.length > 0) {
+ return false;
+ }
+
+ return true;
+}
+
/**
* Check whether string has correct universal IBAN format
* The IBAN consists of up to 34 alphanumeric characters, as follows:
@@ -95,14 +114,37 @@ const ibanRegexThroughCountryCode = {
* NOTE: Permitted IBAN characters are: digits [0-9] and the 26 latin alphabetic [A-Z]
*
* @param {string} str - string under validation
+ * @param {object} options - object to pass the countries to be either whitelisted or blacklisted
* @return {boolean}
*/
-function hasValidIbanFormat(str) {
+function hasValidIbanFormat(str, options) {
// Strip white spaces and hyphens
const strippedStr = str.replace(/[\s\-]+/gi, '').toUpperCase();
const isoCountryCode = strippedStr.slice(0, 2).toUpperCase();
- return (isoCountryCode in ibanRegexThroughCountryCode) &&
+ const isoCountryCodeInIbanRegexCodeObject = isoCountryCode in ibanRegexThroughCountryCode;
+
+ if (options.whitelist) {
+ if (!hasOnlyValidCountryCodes(options.whitelist)) {
+ return false;
+ }
+
+ const isoCountryCodeInWhiteList = options.whitelist.includes(isoCountryCode);
+
+ if (!isoCountryCodeInWhiteList) {
+ return false;
+ }
+ }
+
+ if (options.blacklist) {
+ const isoCountryCodeInBlackList = options.blacklist.includes(isoCountryCode);
+
+ if (isoCountryCodeInBlackList) {
+ return false;
+ }
+ }
+
+ return (isoCountryCodeInIbanRegexCodeObject) &&
ibanRegexThroughCountryCode[isoCountryCode].test(strippedStr);
}
@@ -130,10 +172,10 @@ function hasValidIbanChecksum(str) {
return remainder === 1;
}
-export default function isIBAN(str) {
+export default function isIBAN(str, options = {}) {
assertString(str);
- return hasValidIbanFormat(str) && hasValidIbanChecksum(str);
+ return hasValidIbanFormat(str, options) && hasValidIbanChecksum(str);
}
export const locales = Object.keys(ibanRegexThroughCountryCode);
diff --git a/test/validators.test.js b/test/validators.test.js
index d0753def8..2da2f1ac4 100644
--- a/test/validators.test.js
+++ b/test/validators.test.js
@@ -5250,6 +5250,83 @@ describe('Validators', () => {
'FR763000600001123456!!๐คจ7890189@',
],
});
+ test({
+ validator: 'isIBAN',
+ args: [{ whitelist: ['DK', 'GB'] }],
+ valid: [
+ 'DK5000400440116243',
+ 'GB29NWBK60161331926819',
+ ],
+ invalid: [
+ 'BE71 0961 2345 6769',
+ 'FR76 3000 6000 0112 3456 7890 189',
+ 'DE91 1000 0000 0123 4567 89',
+ 'GR96 0810 0010 0000 0123 4567 890',
+ 'RO09 BCYP 0000 0012 3456 7890',
+ 'SA44 2000 0001 2345 6789 1234',
+ 'ES79 2100 0813 6101 2345 6789',
+ 'XX22YYY1234567890123',
+ 'FR14 2004 1010 0505 0001 3',
+ 'FR7630006000011234567890189@',
+ 'FR7630006000011234567890189๐
',
+ 'FR763000600001123456!!๐คจ7890189@',
+ ],
+ });
+ test({
+ validator: 'isIBAN',
+ args: [{ whitelist: ['XX', 'AA'] }],
+ invalid: [
+ 'DK5000400440116243',
+ 'GB29NWBK60161331926819',
+ 'BE71 0961 2345 6769',
+ 'FR76 3000 6000 0112 3456 7890 189',
+ 'DE91 1000 0000 0123 4567 89',
+ 'GR96 0810 0010 0000 0123 4567 890',
+ 'RO09 BCYP 0000 0012 3456 7890',
+ 'SA44 2000 0001 2345 6789 1234',
+ 'ES79 2100 0813 6101 2345 6789',
+ 'XX22YYY1234567890123',
+ 'FR14 2004 1010 0505 0001 3',
+ 'FR7630006000011234567890189@',
+ 'FR7630006000011234567890189๐
',
+ 'FR763000600001123456!!๐คจ7890189@',
+ ],
+ });
+ test({
+ validator: 'isIBAN',
+ args: [{ blacklist: ['IT'] }],
+ valid: [
+ 'SC52BAHL01031234567890123456USD',
+ 'LC14BOSL123456789012345678901234',
+ 'MT31MALT01100000000000000000123',
+ 'SV43ACAT00000000000000123123',
+ 'EG800002000156789012345180002',
+ 'BE71 0961 2345 6769',
+ 'FR76 3000 6000 0112 3456 7890 189',
+ 'DE91 1000 0000 0123 4567 89',
+ 'GR96 0810 0010 0000 0123 4567 890',
+ 'RO09 BCYP 0000 0012 3456 7890',
+ 'SA44 2000 0001 2345 6789 1234',
+ 'ES79 2100 0813 6101 2345 6789',
+ 'CH56 0483 5012 3456 7800 9',
+ 'GB98 MIDL 0700 9312 3456 78',
+ 'IL170108000000012612345',
+ 'JO71CBJO0000000000001234567890',
+ 'TR320010009999901234567890',
+ 'BR1500000000000010932840814P2',
+ 'LB92000700000000123123456123',
+ 'IR200170000000339545727003',
+ 'MZ97123412341234123412341',
+ ],
+ invalid: [
+ 'XX22YYY1234567890123',
+ 'FR14 2004 1010 0505 0001 3',
+ 'FR7630006000011234567890189@',
+ 'FR7630006000011234567890189๐
',
+ 'FR763000600001123456!!๐คจ7890189@',
+ 'IT60X0542811101000000123456',
+ ],
+ });
});
it('should validate BIC codes', () => {