ibantools 4.1.6 → 4.2.0

package/README.md

@@ -86,6 +86,18 @@ If you are using tools that support `jsnext`, like a [rollup](https://github.com
 
 Install library/module using npm. Package bundles type definitions and if you are on TypeScript 2.0 or above `tsc` will access those automatically. If not, check your `tsconfig.json` file.
 
+### Extension
+
+Country specifications can be extended with national BBAN validations by calling `setCountryBBANValidation`.
+
+For example, to fully syntactically check German IBAN, you can install [IBANTools-Germany](https://github.com/baumerdev/ibantools-germany) and add this with
+
+```
+const ibantools = require('ibantools');
+const ibantoolsGermany = require("ibantools-germany");
+ibantools.setCountryBBANValidation("DE", ibantoolsGermany.isValidBBAN);
+```
+
 ## Contributing
 
 This project adheres to the Contributor Covenant [code of conduct](https://github.com/Simplify/ibantools/blob/master/.github/CODE_OF_CONDUCT.md).

package/build/ibantools.d.ts

@@ -224,6 +224,8 @@ export interface CountryMap {
 }
 /**
  * Interface for IBAN Country Specification
+ *
+ * @ignore
  */
 interface CountrySpecInternal {
     chars?: number;
@@ -238,6 +240,13 @@ interface CountrySpecInternal {
 interface CountryMapInternal {
     [code: string]: CountrySpecInternal;
 }
+/**
+ * Set custom BBAN validation function for country.
+ *
+ * If `bban_validation_func` already exists for the corresponding country,
+ * it will be overwritten.
+ */
+export declare const setCountryBBANValidation: (country: string, func: (bban: string) => boolean) => boolean;
 /**
  * Country specifications
  */

package/build/ibantools.js

@@ -8,13 +8,13 @@
  * @package Documentation
  * @author Saša Jovanić
  * @module ibantools
- * @version 4.1.6
+ * @version 4.2.0
  * @license MPL-2.0
  * @preferred
  */
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.countrySpecs = exports.setCountryBBANValidation = 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
  * ```
@@ -567,11 +567,11 @@ var checkCroatianBBAN = function (bban) {
     return checkMod1110(bankBranch, controlBankBranch) && checkMod1110(account, controlAccount);
 };
 /**
- * Czech (CZ) BBAN check
+ * Czech (CZ) and Slowak (SK) BBAN check
  *
  * @ignore
  */
-var checkCzechBBAN = function (bban) {
+var checkCzechAndSlovakBBAN = function (bban) {
     var weightsPrefix = [10, 5, 8, 4, 2, 1];
     var weightsSuffix = [6, 3, 7, 9, 10, 5, 8, 4, 2, 1];
     var controlPrefix = parseInt(bban.charAt(9), 10);
@@ -744,6 +744,20 @@ var checkHungarianBBAN = function (bban) {
         return controlDigitAccount === (remainder_2 === 0 ? 0 : 10 - remainder_2);
     }
 };
+/**
+ * Set custom BBAN validation function for country.
+ *
+ * If `bban_validation_func` already exists for the corresponding country,
+ * it will be overwritten.
+ */
+var setCountryBBANValidation = function (country, func) {
+    if (typeof exports.countrySpecs[country] === 'undefined') {
+        return false;
+    }
+    exports.countrySpecs[country].bban_validation_func = func;
+    return true;
+};
+exports.setCountryBBANValidation = setCountryBBANValidation;
 /**
  * Country specifications
  */
@@ -892,7 +906,7 @@ exports.countrySpecs = {
     CZ: {
         chars: 24,
         bban_regexp: '^[0-9]{20}$',
-        bban_validation_func: checkCzechBBAN,
+        bban_validation_func: checkCzechAndSlovakBBAN,
         IBANRegistry: true,
         SEPA: true,
     },
@@ -1318,7 +1332,13 @@ exports.countrySpecs = {
         SEPA: true,
     },
     SJ: {},
-    SK: { chars: 24, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
+    SK: {
+        chars: 24,
+        bban_regexp: '^[0-9]{20}$',
+        bban_validation_func: checkCzechAndSlovakBBAN,
+        IBANRegistry: true,
+        SEPA: true,
+    },
     SL: {},
     SM: {
         chars: 27,

package/jsnext/ibantools.js

@@ -8,7 +8,7 @@
  * @package Documentation
  * @author Saša Jovanić
  * @module ibantools
- * @version 4.1.6
+ * @version 4.2.0
  * @license MPL-2.0
  * @preferred
  */
@@ -553,11 +553,11 @@ var checkCroatianBBAN = function (bban) {
     return checkMod1110(bankBranch, controlBankBranch) && checkMod1110(account, controlAccount);
 };
 /**
- * Czech (CZ) BBAN check
+ * Czech (CZ) and Slowak (SK) BBAN check
  *
  * @ignore
  */
-var checkCzechBBAN = function (bban) {
+var checkCzechAndSlovakBBAN = function (bban) {
     var weightsPrefix = [10, 5, 8, 4, 2, 1];
     var weightsSuffix = [6, 3, 7, 9, 10, 5, 8, 4, 2, 1];
     var controlPrefix = parseInt(bban.charAt(9), 10);
@@ -730,6 +730,19 @@ var checkHungarianBBAN = function (bban) {
         return controlDigitAccount === (remainder_2 === 0 ? 0 : 10 - remainder_2);
     }
 };
+/**
+ * Set custom BBAN validation function for country.
+ *
+ * If `bban_validation_func` already exists for the corresponding country,
+ * it will be overwritten.
+ */
+export var setCountryBBANValidation = function (country, func) {
+    if (typeof countrySpecs[country] === 'undefined') {
+        return false;
+    }
+    countrySpecs[country].bban_validation_func = func;
+    return true;
+};
 /**
  * Country specifications
  */
@@ -878,7 +891,7 @@ export var countrySpecs = {
     CZ: {
         chars: 24,
         bban_regexp: '^[0-9]{20}$',
-        bban_validation_func: checkCzechBBAN,
+        bban_validation_func: checkCzechAndSlovakBBAN,
         IBANRegistry: true,
         SEPA: true,
     },
@@ -1304,7 +1317,13 @@ export var countrySpecs = {
         SEPA: true,
     },
     SJ: {},
-    SK: { chars: 24, bban_regexp: '^[0-9]{20}$', IBANRegistry: true, SEPA: true },
+    SK: {
+        chars: 24,
+        bban_regexp: '^[0-9]{20}$',
+        bban_validation_func: checkCzechAndSlovakBBAN,
+        IBANRegistry: true,
+        SEPA: true,
+    },
     SL: {},
     SM: {
         chars: 27,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibantools",
-  "version": "4.1.6",
+  "version": "4.2.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,12 +50,12 @@
   },
   "license": "MPL-2.0",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.28.4",
-    "@typescript-eslint/parser": "^4.28.4",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "chai": "^4.3.4",
     "coveralls": "^3.1.1",
     "docdash": "^1.2.0",
-    "eslint": "^7.31.0",
+    "eslint": "^8.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "gulp": "^4.0.2",