ibantools 3.2.4 → 4.0.0

package/ChangeLog

@@ -1,6 +1,45 @@
+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
+	* Fixed issue when incorrectly showing GL and FO as SEPA countryes
+	* Fixed incorrect documentation for `composeIBAN`
+	* Updates list of supported Node.js versions
+	* Update dev dependencies
+
+2021-05-05 Daniel Friesen <d@danf.ca>
+  * Fixed `validateIBAN`'s handling of unsupported countries like US
+  * Added checksum validation for unsupported/unknown countries to `validateIBAN`
+
+2021-04-03  Saša Jovanić <sasa@simplify.ba>
+	* Coverage improved to 100%
+
+2021-04-03  Saša Jovanić <sasa@simplify.ba>
+	* Version 3.3.0
+	* Error codes for IBAN and BIC validation. Added `validateIBAN` and `validateBIC` methods that will return error codes.
+
+2021-04-03  Saša Jovanić <sasa@simplify.ba>
+	* Version 3.2.5
+	* (Dependabot) Bump y18n from 3.2.1 to 3.2.2
+
+2021-03-29  Xavier Alvarez
+	* Fix validation for Burkina Faso, Benin, Algeria and Mali
+
 2021-03-10  Saša Jovanić  <sasa@simplify.ba>
 	* Version 3.2.4
 	* Exported `countrySpecs` to restore a bit of compatibility broken in 3.2.3
+	* Updated development dependencies
+	* Documentation is now part of master branch
 
 2021-02-07  Saša Jovanić  <sasa@simplify.ba>
 	* Version 3.2.3

package/README.md

@@ -43,6 +43,12 @@ See [full documentation](http://simplify.github.io/ibantools) with examples on G
 const ibantools = require('ibantools');
 const iban = electronicFormatIBAN('NL91 ABNA 0517 1643 00'); // 'NL91ABNA0517164300'
 ibantools.isValidIBAN(iban);
+
+// If you want to know reason why IBAN is invalid
+ibantools.validateIBAN('NL91ABNA0517164300');
+// Returns { valid: false, errorCodes: [iban.ValidationErrorsIBAN.WrongIBANChecksum] }
+
+// Validate BIC
 ibantools.isValidBIC('ABNANL2A');
 ```
 

package/build/ibantools.d.ts

@@ -13,8 +13,34 @@
  * // returns false
  * ibantools.isValidIBAN("NL92ABNA0517164300");
  * ```
- */
+v */
 export declare function isValidIBAN(iban: string): boolean;
+/**
+ * IBAM validation errors
+ */
+export declare enum ValidationErrorsIBAN {
+    NoIBANProvided = 0,
+    NoIBANCountry = 1,
+    WrongBBANLength = 2,
+    WrongBBANFormat = 3,
+    ChecksumNotNumber = 4,
+    WrongIBANChecksum = 5
+}
+/**
+ * Interface for ValidateIBAN result
+ */
+export interface ValidateIBANResult {
+    errorCodes: ValidationErrorsIBAN[];
+    valid: boolean;
+}
+/**
+ * validateIBAN
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateIBAN("NL91 ABNA 0417 1643 00");
+ * ```
+ */
+export declare function validateIBAN(iban?: string): ValidateIBANResult;
 /**
  * Validate BBAN
  *
@@ -52,7 +78,7 @@ export interface ComposeIBANParams {
  *
  * ```
  * // returns NL91ABNA0417164300
- * ibantools.composeIBAN("NL", "ABNA0417164300");
+ * ibantools.composeIBAN({ countryCode: "NL", bban: "ABNA0417164300" });
  * ```
  */
 export declare function composeIBAN(params: ComposeIBANParams): string | null;
@@ -114,7 +140,7 @@ export declare function friendlyFormatIBAN(iban?: string, separator?: string): s
  *   let country = ibantools.getCountrySpecifications()[$(this).val()];
  *   // Add country code letters to IBAN form field
  *   $("input#iban").value($(this).val());
- *   // Add new value to "pattern" attribute to #iban input text field
+ *   // Add New value to "pattern" attribute to #iban input text field
  *   $("input#iban").attr("pattern", $(this).val() + "[0-9]{2}" + country.bban_regexp.slice(1).replace("$",""));
  * });
  * ```
@@ -138,6 +164,29 @@ export declare function getCountrySpecifications(): CountryMap;
  * ```
  */
 export declare function isValidBIC(bic: string): boolean;
+/**
+ * BIC validation errors
+ */
+export declare enum ValidationErrorsBIC {
+    NoBICProvided = 0,
+    NoBICCountry = 1,
+    WrongBICFormat = 2
+}
+/**
+ * Interface for ValidateBIC result
+ */
+export interface ValidateBICResult {
+    errorCodes: ValidationErrorsBIC[];
+    valid: boolean;
+}
+/**
+ * validateBIC
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateBIC("NEDSZAJJXXX");
+ * ```
+ */
+export declare function validateBIC(bic?: string): ValidateBICResult;
 /**
  * Interface for ExtractBIC result
  */
@@ -178,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,16 +5,16 @@
  * 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.2.4
+ * @version 4.0.0
  * @license MPL-2.0
  * @preferred
  */
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.countrySpecs = exports.extractBIC = exports.isValidBIC = exports.getCountrySpecifications = exports.friendlyFormatIBAN = exports.electronicFormatIBAN = exports.extractIBAN = exports.composeIBAN = exports.isSEPACountry = exports.isValidBBAN = exports.isValidIBAN = void 0;
+exports.countrySpecs = exports.extractBIC = exports.validateBIC = exports.ValidationErrorsBIC = exports.isValidBIC = exports.getCountrySpecifications = exports.friendlyFormatIBAN = exports.electronicFormatIBAN = exports.extractIBAN = exports.composeIBAN = exports.isSEPACountry = exports.isValidBBAN = exports.validateIBAN = exports.ValidationErrorsIBAN = exports.isValidIBAN = void 0;
 /**
  * Validate IBAN
  * ```
@@ -25,7 +25,7 @@ exports.countrySpecs = exports.extractBIC = exports.isValidBIC = exports.getCoun
  * // returns false
  * ibantools.isValidIBAN("NL92ABNA0517164300");
  * ```
- */
+v */
 function isValidIBAN(iban) {
     if (iban !== undefined && iban !== null) {
         var reg = new RegExp('^[0-9]{2}$', '');
@@ -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;
         }
@@ -44,6 +44,58 @@ function isValidIBAN(iban) {
     return false;
 }
 exports.isValidIBAN = isValidIBAN;
+/**
+ * IBAM validation errors
+ */
+var ValidationErrorsIBAN;
+(function (ValidationErrorsIBAN) {
+    ValidationErrorsIBAN[ValidationErrorsIBAN["NoIBANProvided"] = 0] = "NoIBANProvided";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["NoIBANCountry"] = 1] = "NoIBANCountry";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongBBANLength"] = 2] = "WrongBBANLength";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongBBANFormat"] = 3] = "WrongBBANFormat";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["ChecksumNotNumber"] = 4] = "ChecksumNotNumber";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongIBANChecksum"] = 5] = "WrongIBANChecksum";
+})(ValidationErrorsIBAN = exports.ValidationErrorsIBAN || (exports.ValidationErrorsIBAN = {}));
+/**
+ * validateIBAN
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateIBAN("NL91 ABNA 0417 1643 00");
+ * ```
+ */
+function validateIBAN(iban) {
+    var result = { errorCodes: [], valid: true };
+    if (iban !== undefined && iban !== null && iban !== '') {
+        var spec = exports.countrySpecs[iban.slice(0, 2)];
+        if (!spec || !(spec.bban_regexp || spec.chars)) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.NoIBANCountry);
+        }
+        if (spec && spec.chars && spec.chars !== iban.length) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongBBANLength);
+        }
+        if (spec && spec.bban_regexp && !isValidBBAN(iban.slice(4), iban.slice(0, 2))) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongBBANFormat);
+        }
+        var reg = new RegExp('^[0-9]{2}$', '');
+        if (!reg.test(iban.slice(2, 4))) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.ChecksumNotNumber);
+        }
+        if (!isValidIBANChecksum(iban)) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongIBANChecksum);
+        }
+    }
+    else {
+        result.valid = false;
+        result.errorCodes.push(ValidationErrorsIBAN.NoIBANProvided);
+    }
+    return result;
+}
+exports.validateIBAN = validateIBAN;
 /**
  * Validate BBAN
  *
@@ -67,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;
         }
     }
@@ -99,7 +154,7 @@ exports.isSEPACountry = isSEPACountry;
  *
  * ```
  * // returns NL91ABNA0417164300
- * ibantools.composeIBAN("NL", "ABNA0417164300");
+ * ibantools.composeIBAN({ countryCode: "NL", bban: "ABNA0417164300" });
  * ```
  */
 function composeIBAN(params) {
@@ -189,6 +244,7 @@ function friendlyFormatIBAN(iban, separator) {
         separator = ' ';
     }
     var electronic_iban = electronicFormatIBAN(iban);
+    /* istanbul ignore if */
     if (electronic_iban === null) {
         return null;
     }
@@ -260,7 +316,7 @@ function mod9710(iban) {
  *   let country = ibantools.getCountrySpecifications()[$(this).val()];
  *   // Add country code letters to IBAN form field
  *   $("input#iban").value($(this).val());
- *   // Add new value to "pattern" attribute to #iban input text field
+ *   // Add New value to "pattern" attribute to #iban input text field
  *   $("input#iban").attr("pattern", $(this).val() + "[0-9]{2}" + country.bban_regexp.slice(1).replace("$",""));
  * });
  * ```
@@ -305,6 +361,45 @@ function isValidBIC(bic) {
     return reg.test(bic) && spec !== undefined;
 }
 exports.isValidBIC = isValidBIC;
+/**
+ * BIC validation errors
+ */
+var ValidationErrorsBIC;
+(function (ValidationErrorsBIC) {
+    ValidationErrorsBIC[ValidationErrorsBIC["NoBICProvided"] = 0] = "NoBICProvided";
+    ValidationErrorsBIC[ValidationErrorsBIC["NoBICCountry"] = 1] = "NoBICCountry";
+    ValidationErrorsBIC[ValidationErrorsBIC["WrongBICFormat"] = 2] = "WrongBICFormat";
+})(ValidationErrorsBIC = exports.ValidationErrorsBIC || (exports.ValidationErrorsBIC = {}));
+/**
+ * validateBIC
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateBIC("NEDSZAJJXXX");
+ * ```
+ */
+function validateBIC(bic) {
+    var result = { errorCodes: [], valid: true };
+    if (bic !== undefined && bic !== null && bic !== '') {
+        var spec = exports.countrySpecs[bic.toUpperCase().slice(4, 6)];
+        if (spec === undefined) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsBIC.NoBICCountry);
+        }
+        else {
+            var reg = new RegExp('^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$', '');
+            if (!reg.test(bic)) {
+                result.valid = false;
+                result.errorCodes.push(ValidationErrorsBIC.WrongBICFormat);
+            }
+        }
+    }
+    else {
+        result.valid = false;
+        result.errorCodes.push(ValidationErrorsBIC.NoBICProvided);
+    }
+    return result;
+}
+exports.validateBIC = validateBIC;
 /**
  * extractBIC
  * ```
@@ -329,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
  */
@@ -337,6 +497,7 @@ exports.countrySpecs = {
         chars: 24,
         bban_regexp: '^[0-9]{8}[A-Z0-9]{12}$',
         IBANRegistry: true,
+        SEPA: true,
     },
     AE: {
         chars: 23,
@@ -381,13 +542,14 @@ exports.countrySpecs = {
     BD: {},
     BE: { chars: 16, bban_regexp: '^[0-9]{12}$', IBANRegistry: true, SEPA: true },
     BF: {
-        chars: 27,
-        bban_regexp: '^[0-9]{23}$',
+        chars: 28,
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     BG: {
         chars: 22,
         bban_regexp: '^[A-Z]{4}[0-9]{6}[A-Z0-9]{8}$',
         IBANRegistry: true,
+        SEPA: true,
     },
     BH: {
         chars: 22,
@@ -395,12 +557,12 @@ exports.countrySpecs = {
         IBANRegistry: true,
     },
     BI: {
-        chars: 16,
-        bban_regexp: '^[0-9]{12}$',
+        chars: 27,
+        bban_regexp: '^[0-9]{23}$',
     },
     BJ: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     BL: {
         chars: 27,
@@ -484,21 +646,21 @@ exports.countrySpecs = {
         IBANRegistry: true,
     },
     DZ: {
-        chars: 24,
-        bban_regexp: '^[0-9]{20}$',
+        chars: 26,
+        bban_regexp: '^[0-9]{22}$',
     },
     EC: {},
     EE: { chars: 20, bban_regexp: '^[0-9]{16}$', IBANRegistry: true, SEPA: true },
     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: {},
     FK: {},
     FM: {},
-    FO: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
+    FO: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true },
     FR: {
         chars: 27,
         bban_regexp: '^[0-9]{10}[A-Z0-9]{11}[0-9]{2}$',
@@ -534,7 +696,7 @@ exports.countrySpecs = {
         IBANRegistry: true,
         SEPA: true,
     },
-    GL: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
+    GL: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true },
     GM: {},
     GN: {},
     GP: {
@@ -709,7 +871,7 @@ exports.countrySpecs = {
     },
     ML: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     MM: {},
     MN: {},
@@ -767,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: {},
@@ -787,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}$',
@@ -853,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.2.4
+ * @version 4.0.0
  * @license MPL-2.0
  * @preferred
  */
@@ -23,7 +23,7 @@
  * // returns false
  * ibantools.isValidIBAN("NL92ABNA0517164300");
  * ```
- */
+v */
 export function isValidIBAN(iban) {
     if (iban !== undefined && iban !== null) {
         var reg = new RegExp('^[0-9]{2}$', '');
@@ -34,13 +34,64 @@ 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;
         }
     }
     return false;
 }
+/**
+ * IBAM validation errors
+ */
+export var ValidationErrorsIBAN;
+(function (ValidationErrorsIBAN) {
+    ValidationErrorsIBAN[ValidationErrorsIBAN["NoIBANProvided"] = 0] = "NoIBANProvided";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["NoIBANCountry"] = 1] = "NoIBANCountry";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongBBANLength"] = 2] = "WrongBBANLength";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongBBANFormat"] = 3] = "WrongBBANFormat";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["ChecksumNotNumber"] = 4] = "ChecksumNotNumber";
+    ValidationErrorsIBAN[ValidationErrorsIBAN["WrongIBANChecksum"] = 5] = "WrongIBANChecksum";
+})(ValidationErrorsIBAN || (ValidationErrorsIBAN = {}));
+/**
+ * validateIBAN
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateIBAN("NL91 ABNA 0417 1643 00");
+ * ```
+ */
+export function validateIBAN(iban) {
+    var result = { errorCodes: [], valid: true };
+    if (iban !== undefined && iban !== null && iban !== '') {
+        var spec = countrySpecs[iban.slice(0, 2)];
+        if (!spec || !(spec.bban_regexp || spec.chars)) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.NoIBANCountry);
+        }
+        if (spec && spec.chars && spec.chars !== iban.length) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongBBANLength);
+        }
+        if (spec && spec.bban_regexp && !isValidBBAN(iban.slice(4), iban.slice(0, 2))) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongBBANFormat);
+        }
+        var reg = new RegExp('^[0-9]{2}$', '');
+        if (!reg.test(iban.slice(2, 4))) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.ChecksumNotNumber);
+        }
+        if (!isValidIBANChecksum(iban)) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsIBAN.WrongIBANChecksum);
+        }
+    }
+    else {
+        result.valid = false;
+        result.errorCodes.push(ValidationErrorsIBAN.NoIBANProvided);
+    }
+    return result;
+}
 /**
  * Validate BBAN
  *
@@ -64,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;
         }
     }
@@ -94,7 +148,7 @@ export function isSEPACountry(countryCode) {
  *
  * ```
  * // returns NL91ABNA0417164300
- * ibantools.composeIBAN("NL", "ABNA0417164300");
+ * ibantools.composeIBAN({ countryCode: "NL", bban: "ABNA0417164300" });
  * ```
  */
 export function composeIBAN(params) {
@@ -181,6 +235,7 @@ export function friendlyFormatIBAN(iban, separator) {
         separator = ' ';
     }
     var electronic_iban = electronicFormatIBAN(iban);
+    /* istanbul ignore if */
     if (electronic_iban === null) {
         return null;
     }
@@ -251,7 +306,7 @@ function mod9710(iban) {
  *   let country = ibantools.getCountrySpecifications()[$(this).val()];
  *   // Add country code letters to IBAN form field
  *   $("input#iban").value($(this).val());
- *   // Add new value to "pattern" attribute to #iban input text field
+ *   // Add New value to "pattern" attribute to #iban input text field
  *   $("input#iban").attr("pattern", $(this).val() + "[0-9]{2}" + country.bban_regexp.slice(1).replace("$",""));
  * });
  * ```
@@ -294,6 +349,44 @@ export function isValidBIC(bic) {
     var spec = countrySpecs[bic.toUpperCase().slice(4, 6)];
     return reg.test(bic) && spec !== undefined;
 }
+/**
+ * BIC validation errors
+ */
+export var ValidationErrorsBIC;
+(function (ValidationErrorsBIC) {
+    ValidationErrorsBIC[ValidationErrorsBIC["NoBICProvided"] = 0] = "NoBICProvided";
+    ValidationErrorsBIC[ValidationErrorsBIC["NoBICCountry"] = 1] = "NoBICCountry";
+    ValidationErrorsBIC[ValidationErrorsBIC["WrongBICFormat"] = 2] = "WrongBICFormat";
+})(ValidationErrorsBIC || (ValidationErrorsBIC = {}));
+/**
+ * validateBIC
+ * ```
+ * // returns {errorCodes: [], valid: true}
+ * ibantools.validateBIC("NEDSZAJJXXX");
+ * ```
+ */
+export function validateBIC(bic) {
+    var result = { errorCodes: [], valid: true };
+    if (bic !== undefined && bic !== null && bic !== '') {
+        var spec = countrySpecs[bic.toUpperCase().slice(4, 6)];
+        if (spec === undefined) {
+            result.valid = false;
+            result.errorCodes.push(ValidationErrorsBIC.NoBICCountry);
+        }
+        else {
+            var reg = new RegExp('^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?$', '');
+            if (!reg.test(bic)) {
+                result.valid = false;
+                result.errorCodes.push(ValidationErrorsBIC.WrongBICFormat);
+            }
+        }
+    }
+    else {
+        result.valid = false;
+        result.errorCodes.push(ValidationErrorsBIC.NoBICProvided);
+    }
+    return result;
+}
 /**
  * extractBIC
  * ```
@@ -317,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
  */
@@ -325,6 +483,7 @@ export var countrySpecs = {
         chars: 24,
         bban_regexp: '^[0-9]{8}[A-Z0-9]{12}$',
         IBANRegistry: true,
+        SEPA: true,
     },
     AE: {
         chars: 23,
@@ -369,13 +528,14 @@ export var countrySpecs = {
     BD: {},
     BE: { chars: 16, bban_regexp: '^[0-9]{12}$', IBANRegistry: true, SEPA: true },
     BF: {
-        chars: 27,
-        bban_regexp: '^[0-9]{23}$',
+        chars: 28,
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     BG: {
         chars: 22,
         bban_regexp: '^[A-Z]{4}[0-9]{6}[A-Z0-9]{8}$',
         IBANRegistry: true,
+        SEPA: true,
     },
     BH: {
         chars: 22,
@@ -383,12 +543,12 @@ export var countrySpecs = {
         IBANRegistry: true,
     },
     BI: {
-        chars: 16,
-        bban_regexp: '^[0-9]{12}$',
+        chars: 27,
+        bban_regexp: '^[0-9]{23}$',
     },
     BJ: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     BL: {
         chars: 27,
@@ -472,21 +632,21 @@ export var countrySpecs = {
         IBANRegistry: true,
     },
     DZ: {
-        chars: 24,
-        bban_regexp: '^[0-9]{20}$',
+        chars: 26,
+        bban_regexp: '^[0-9]{22}$',
     },
     EC: {},
     EE: { chars: 20, bban_regexp: '^[0-9]{16}$', IBANRegistry: true, SEPA: true },
     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: {},
     FK: {},
     FM: {},
-    FO: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
+    FO: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true },
     FR: {
         chars: 27,
         bban_regexp: '^[0-9]{10}[A-Z0-9]{11}[0-9]{2}$',
@@ -522,7 +682,7 @@ export var countrySpecs = {
         IBANRegistry: true,
         SEPA: true,
     },
-    GL: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true, SEPA: true },
+    GL: { chars: 18, bban_regexp: '^[0-9]{14}$', IBANRegistry: true },
     GM: {},
     GN: {},
     GP: {
@@ -697,7 +857,7 @@ export var countrySpecs = {
     },
     ML: {
         chars: 28,
-        bban_regexp: '^[A-Z]{1}[0-9]{23}$',
+        bban_regexp: '^[A-Z0-9]{2}[0-9]{22}$',
     },
     MM: {},
     MN: {},
@@ -755,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: {},
@@ -775,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}$',
@@ -841,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.2.4",
+  "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",
@@ -50,33 +50,32 @@
   },
   "license": "MPL-2.0",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.7.0",
-    "@typescript-eslint/parser": "^4.7.0",
-    "chai": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.28.4",
+    "@typescript-eslint/parser": "^4.28.4",
+    "chai": "^4.3.4",
     "cheerio": "^0.22",
-    "coveralls": "^3.1.0",
+    "coveralls": "^3.1.1",
     "docdash": "^1.2.0",
-    "eslint": "^7.13.0",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-prettier": "^3.1.4",
+    "eslint": "^7.31.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
     "gulp": "^4.0.2",
-    "gulp-mocha": "^7.0",
+    "gulp-mocha": "^8.0",
     "gulp-rename": "^2.0",
     "gulp-shell": "^0.8.0",
-    "gulp-typedoc": "^2.2.5",
     "gulp-typescript": "^5.0",
-    "jasmine-core": "^3.6.0",
-    "karma": "^5.2.3",
+    "jasmine-core": "^3.8.0",
+    "karma": "^6.3.4",
     "karma-chrome-launcher": "^3.1",
     "karma-jasmine": "^4.0",
     "karma-requirejs": "^1.1",
     "merge2": "^1.4.1",
-    "mocha": "^8.2.0",
+    "mocha": "^9.0.2",
     "mocha-lcov-reporter": "^1.2.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.1.2",
+    "prettier": "^2.3.2",
     "requirejs": "^2.3.6",
-    "typedoc": "^0.17.0-3",
-    "typescript": "^4.0"
+    "typedoc": "^0.21.4",
+    "typescript": "^4.3.5"
   }
 }