ibantools 3.3.1 → 4.0.0

package/ChangeLog

@@ -1,3 +1,14 @@
+2021-11-17  Saša Jovanić <sasa@simplify.ba>
+	* Version 4.0.0
+	* Fixed Senegal (SN) regular expression
+	* Updated Burundi (BI) specification
+	* Added Spain (ES) extra BBAN validation
+	* Added Poland (PL) extra BBAN validation
+	* Added test to check for extra BBAN validation function
+
+2021-09-30  Simen Mailund Svendsen <simen.m.s@hotmail.com>
+	* Fix invalid norwegian BBANS (failing MOD11 check) being incorrectly returned as valid
+
 2021-07-24  Saša Jovanić <sasa@simplify.ba>
 	* Version 3.3.1
 	* Fixed issue not showing AD and BG as SEPA countries

package/build/ibantools.d.ts

@@ -227,6 +227,7 @@ export interface CountryMap {
 interface CountrySpecInternal {
     chars?: number;
     bban_regexp?: string;
+    bban_validation_func?: (bban: string) => boolean;
     IBANRegistry?: boolean;
     SEPA?: boolean;
 }

package/build/ibantools.js

@@ -5,10 +5,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 /**
  * Validation, extraction and creation of IBAN, BBAN, BIC/SWIFT numbers plus some other helpful stuff
- * @packageDocumentation
+ * @package Documentation
  * @author Saša Jovanić
  * @module ibantools
- * @version 3.3.1
+ * @version 4.0.0
  * @license MPL-2.0
  * @preferred
  */
@@ -36,7 +36,7 @@ function isValidIBAN(iban) {
             spec.chars &&
             spec.chars === iban.length &&
             reg.test(iban.slice(2, 4)) &&
-            checkFormatBBAN(iban.slice(4), spec.bban_regexp) &&
+            isValidBBAN(iban.slice(4), iban.slice(0, 2)) &&
             isValidIBANChecksum(iban)) {
             return true;
         }
@@ -75,7 +75,7 @@ function validateIBAN(iban) {
             result.valid = false;
             result.errorCodes.push(ValidationErrorsIBAN.WrongBBANLength);
         }
-        if (spec && spec.bban_regexp && !checkFormatBBAN(iban.slice(4), spec.bban_regexp)) {
+        if (spec && spec.bban_regexp && !isValidBBAN(iban.slice(4), iban.slice(0, 2))) {
             result.valid = false;
             result.errorCodes.push(ValidationErrorsIBAN.WrongBBANFormat);
         }
@@ -119,6 +119,9 @@ function isValidBBAN(bban, countryCode) {
             spec.chars !== null &&
             spec.chars - 4 === bban.length &&
             checkFormatBBAN(bban, spec.bban_regexp)) {
+            if (spec.bban_validation_func) {
+                return spec.bban_validation_func(bban.replace(/[\s.]+/g, ''));
+            }
             return true;
         }
     }
@@ -421,6 +424,71 @@ function extractBIC(inputBic) {
     return result;
 }
 exports.extractBIC = extractBIC;
+/**
+ * Used for Norway BBAN check
+ *
+ * @ignore
+ */
+var checkNorwayBBAN = function (bban) {
+    var weights = [5, 4, 3, 2, 7, 6, 5, 4, 3, 2];
+    var bbanWithoutSpacesAndPeriods = bban.replace(/[\s.]+/g, '');
+    if (bbanWithoutSpacesAndPeriods.length !== 11) {
+        return false;
+    }
+    else {
+        var controlDigit = parseInt(bbanWithoutSpacesAndPeriods.charAt(10), 10);
+        var bbanWithoutControlDigit = bbanWithoutSpacesAndPeriods.substring(0, 10);
+        var sum = 0;
+        for (var index = 0; index < 10; index++) {
+            sum += parseInt(bbanWithoutControlDigit.charAt(index), 10) * weights[index];
+        }
+        var remainder = sum % 11;
+        return controlDigit === (remainder === 0 ? 0 : 11 - remainder);
+    }
+};
+/**
+ * Used for Poland BBAN check
+ *
+ * @ignore
+ */
+var checkPolandBBAN = function (bban) {
+    var weights = [3, 9, 7, 1, 3, 9, 7];
+    var controlDigit = parseInt(bban.charAt(7), 10);
+    var toCheck = bban.substring(0, 7);
+    var sum = 0;
+    for (var index = 0; index < 7; index++) {
+        sum += parseInt(toCheck.charAt(index), 10) * weights[index];
+    }
+    var remainder = sum % 10;
+    return controlDigit === (remainder === 0 ? 0 : 10 - remainder);
+};
+/**
+ * Spain (ES) BBAN check
+ *
+ * @ignore
+ */
+var checkSpainBBAN = function (bban) {
+    var weightsBankBranch = [4, 8, 5, 10, 9, 7, 3, 6];
+    var weightsAccount = [1, 2, 4, 8, 5, 10, 9, 7, 3, 6];
+    var controlBankBranch = parseInt(bban.charAt(8), 10);
+    var controlAccount = parseInt(bban.charAt(9), 10);
+    var bankBranch = bban.substring(0, 8);
+    var account = bban.substring(10, 20);
+    var sum = 0;
+    for (var index = 0; index < 8; index++) {
+        sum += parseInt(bankBranch.charAt(index), 10) * weightsBankBranch[index];
+    }
+    var remainder = sum % 11;
+    if (controlBankBranch !== (remainder === 0 ? 0 : 11 - remainder)) {
+        return false;
+    }
+    sum = 0;
+    for (var index = 0; index < 10; index++) {
+        sum += parseInt(account.charAt(index), 10) * weightsAccount[index];
+    }
+    remainder = sum % 11;
+    return controlAccount === (remainder === 0 ? 0 : 11 - remainder);
+};
 /**
  * Country specifications
  */
@@ -489,8 +557,8 @@ exports.countrySpecs = {
         IBANRegistry: true,
     },
     BI: {
-        chars: 16,
-        bban_regexp: '^[0-9]{12}$',
+        chars: 27,
+        bban_regexp: '^[0-9]{23}$',
     },
     BJ: {
         chars: 28,
@@ -586,7 +654,7 @@ exports.countrySpecs = {
     EG: { chars: 29, bban_regexp: '^[0-9]{25}', IBANRegistry: true },
     EH: {},
     ER: {},
-    ES: { chars: 24, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
+    ES: { chars: 24, bban_validation_func: checkSpainBBAN, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
     ET: {},
     FI: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
     FJ: {},
@@ -861,7 +929,7 @@ exports.countrySpecs = {
         IBANRegistry: true,
         SEPA: true,
     },
-    NO: { chars: 15, bban_regexp: '^[0-9]{11}$', IBANRegistry: true, SEPA: true },
+    NO: { chars: 15, bban_regexp: '^[0-9]{11}$', bban_validation_func: checkNorwayBBAN, IBANRegistry: true, SEPA: true },
     NP: {},
     NR: {},
     NU: {},
@@ -881,7 +949,7 @@ exports.countrySpecs = {
         bban_regexp: '^[A-Z0-9]{4}[0-9]{16}$',
         IBANRegistry: true,
     },
-    PL: { chars: 28, bban_regexp: '^[0-9]{24}$', IBANRegistry: true, SEPA: true },
+    PL: { chars: 28, bban_validation_func: checkPolandBBAN, bban_regexp: '^[0-9]{24}$', IBANRegistry: true, SEPA: true },
     PM: {
         chars: 27,
         bban_regexp: '^[0-9]{10}[A-Z0-9]{11}[0-9]{2}$',
@@ -947,7 +1015,7 @@ exports.countrySpecs = {
     },
     SN: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z]{2}[0-9]{22}$',
     },
     SO: {},
     SR: {},

package/jsnext/ibantools.js

@@ -5,10 +5,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 /**
  * Validation, extraction and creation of IBAN, BBAN, BIC/SWIFT numbers plus some other helpful stuff
- * @packageDocumentation
+ * @package Documentation
  * @author Saša Jovanić
  * @module ibantools
- * @version 3.3.1
+ * @version 4.0.0
  * @license MPL-2.0
  * @preferred
  */
@@ -34,7 +34,7 @@ export function isValidIBAN(iban) {
             spec.chars &&
             spec.chars === iban.length &&
             reg.test(iban.slice(2, 4)) &&
-            checkFormatBBAN(iban.slice(4), spec.bban_regexp) &&
+            isValidBBAN(iban.slice(4), iban.slice(0, 2)) &&
             isValidIBANChecksum(iban)) {
             return true;
         }
@@ -72,7 +72,7 @@ export function validateIBAN(iban) {
             result.valid = false;
             result.errorCodes.push(ValidationErrorsIBAN.WrongBBANLength);
         }
-        if (spec && spec.bban_regexp && !checkFormatBBAN(iban.slice(4), spec.bban_regexp)) {
+        if (spec && spec.bban_regexp && !isValidBBAN(iban.slice(4), iban.slice(0, 2))) {
             result.valid = false;
             result.errorCodes.push(ValidationErrorsIBAN.WrongBBANFormat);
         }
@@ -115,6 +115,9 @@ export function isValidBBAN(bban, countryCode) {
             spec.chars !== null &&
             spec.chars - 4 === bban.length &&
             checkFormatBBAN(bban, spec.bban_regexp)) {
+            if (spec.bban_validation_func) {
+                return spec.bban_validation_func(bban.replace(/[\s.]+/g, ''));
+            }
             return true;
         }
     }
@@ -407,6 +410,71 @@ export function extractBIC(inputBic) {
     }
     return result;
 }
+/**
+ * Used for Norway BBAN check
+ *
+ * @ignore
+ */
+var checkNorwayBBAN = function (bban) {
+    var weights = [5, 4, 3, 2, 7, 6, 5, 4, 3, 2];
+    var bbanWithoutSpacesAndPeriods = bban.replace(/[\s.]+/g, '');
+    if (bbanWithoutSpacesAndPeriods.length !== 11) {
+        return false;
+    }
+    else {
+        var controlDigit = parseInt(bbanWithoutSpacesAndPeriods.charAt(10), 10);
+        var bbanWithoutControlDigit = bbanWithoutSpacesAndPeriods.substring(0, 10);
+        var sum = 0;
+        for (var index = 0; index < 10; index++) {
+            sum += parseInt(bbanWithoutControlDigit.charAt(index), 10) * weights[index];
+        }
+        var remainder = sum % 11;
+        return controlDigit === (remainder === 0 ? 0 : 11 - remainder);
+    }
+};
+/**
+ * Used for Poland BBAN check
+ *
+ * @ignore
+ */
+var checkPolandBBAN = function (bban) {
+    var weights = [3, 9, 7, 1, 3, 9, 7];
+    var controlDigit = parseInt(bban.charAt(7), 10);
+    var toCheck = bban.substring(0, 7);
+    var sum = 0;
+    for (var index = 0; index < 7; index++) {
+        sum += parseInt(toCheck.charAt(index), 10) * weights[index];
+    }
+    var remainder = sum % 10;
+    return controlDigit === (remainder === 0 ? 0 : 10 - remainder);
+};
+/**
+ * Spain (ES) BBAN check
+ *
+ * @ignore
+ */
+var checkSpainBBAN = function (bban) {
+    var weightsBankBranch = [4, 8, 5, 10, 9, 7, 3, 6];
+    var weightsAccount = [1, 2, 4, 8, 5, 10, 9, 7, 3, 6];
+    var controlBankBranch = parseInt(bban.charAt(8), 10);
+    var controlAccount = parseInt(bban.charAt(9), 10);
+    var bankBranch = bban.substring(0, 8);
+    var account = bban.substring(10, 20);
+    var sum = 0;
+    for (var index = 0; index < 8; index++) {
+        sum += parseInt(bankBranch.charAt(index), 10) * weightsBankBranch[index];
+    }
+    var remainder = sum % 11;
+    if (controlBankBranch !== (remainder === 0 ? 0 : 11 - remainder)) {
+        return false;
+    }
+    sum = 0;
+    for (var index = 0; index < 10; index++) {
+        sum += parseInt(account.charAt(index), 10) * weightsAccount[index];
+    }
+    remainder = sum % 11;
+    return controlAccount === (remainder === 0 ? 0 : 11 - remainder);
+};
 /**
  * Country specifications
  */
@@ -475,8 +543,8 @@ export var countrySpecs = {
         IBANRegistry: true,
     },
     BI: {
-        chars: 16,
-        bban_regexp: '^[0-9]{12}$',
+        chars: 27,
+        bban_regexp: '^[0-9]{23}$',
     },
     BJ: {
         chars: 28,
@@ -572,7 +640,7 @@ export var countrySpecs = {
     EG: { chars: 29, bban_regexp: '^[0-9]{25}', IBANRegistry: true },
     EH: {},
     ER: {},
-    ES: { chars: 24, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
+    ES: { chars: 24, bban_validation_func: checkSpainBBAN, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
     ET: {},
     FI: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
     FJ: {},
@@ -847,7 +915,7 @@ export var countrySpecs = {
         IBANRegistry: true,
         SEPA: true,
     },
-    NO: { chars: 15, bban_regexp: '^[0-9]{11}$', IBANRegistry: true, SEPA: true },
+    NO: { chars: 15, bban_regexp: '^[0-9]{11}$', bban_validation_func: checkNorwayBBAN, IBANRegistry: true, SEPA: true },
     NP: {},
     NR: {},
     NU: {},
@@ -867,7 +935,7 @@ export var countrySpecs = {
         bban_regexp: '^[A-Z0-9]{4}[0-9]{16}$',
         IBANRegistry: true,
     },
-    PL: { chars: 28, bban_regexp: '^[0-9]{24}$', IBANRegistry: true, SEPA: true },
+    PL: { chars: 28, bban_validation_func: checkPolandBBAN, bban_regexp: '^[0-9]{24}$', IBANRegistry: true, SEPA: true },
     PM: {
         chars: 27,
         bban_regexp: '^[0-9]{10}[A-Z0-9]{11}[0-9]{2}$',
@@ -933,7 +1001,7 @@ export var countrySpecs = {
     },
     SN: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z]{2}[0-9]{22}$',
     },
     SO: {},
     SR: {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibantools",
-  "version": "3.3.1",
+  "version": "4.0.0",
   "description": "Validation, extraction and creation of IBAN, BBAN, BIC/SWIFT numbers plus some other helpful stuff like ISO 3136-1 alpha 2 country list",
   "keywords": [
     "IBAN",