Merge pull request #1120 from ing-bank/feat/not-country-iban

feat(input-iban): add IsNotCountryIBAN validator

.changeset/two-buses-glow.md

@@ -0,0 +1,5 @@
+---
+'@lion/input-iban': minor
+---
+
+add country blacklisting validator

packages/input-iban/README.md

@@ -8,7 +8,7 @@ Its purpose is to provide a way for users to fill in an IBAN (International Bank
 ```js script
 import { html } from 'lit-html';
 import { loadDefaultFeedbackMessages } from '@lion/validate-messages';
-import { IsCountryIBAN } from './src/validators.js';
+import { IsCountryIBAN, IsNotCountryIBAN } from './src/validators.js';
 
 import './lion-input-iban.js';
 
@@ -90,3 +90,27 @@ export const countryRestrictions = () => html`
   <small>Demo instructions: you can use NL20 INGB 0001 2345 67</small>
 `;
 ```
+
+### Blacklisted Country
+
+By default, we validate the input to ensure the IBAN is valid.
+To get the default feedback message for this default validator, use `loadDefaultFeedbackMessages` from `@lion/form-core`.
+
+In the example below, we show how to use an additional validator that blocks IBANs from certain countries.
+
+You can pass a single string value, or an array of strings.
+
+```js preview-story
+export const blacklistedCountry = () => html`
+  <lion-input-iban
+    .modelValue=${'DE89370400440532013000'}
+    .validators=${[new IsNotCountryIBAN(['RO', 'NL'])]}
+    name="iban"
+    label="IBAN"
+  ></lion-input-iban>
+  <br />
+  <small
+    >Demo instructions: Try <code>RO 89 RZBR 6997 3728 4864 5577</code> and watch it fail</small
+  >
+`;
+```

packages/input-iban/index.js

@@ -1,4 +1,4 @@
 export { LionInputIban } from './src/LionInputIban.js';
 export { formatIBAN } from './src/formatters.js';
 export { parseIBAN } from './src/parsers.js';
-export { IsIBAN, IsCountryIBAN } from './src/validators.js';
+export { IsIBAN, IsCountryIBAN, IsNotCountryIBAN } from './src/validators.js';

packages/input-iban/src/validators.js

@@ -1,7 +1,7 @@
 /* eslint-disable max-classes-per-file  */
 
 import { localize } from '@lion/localize';
-import { Validator } from '@lion/form-core';
+import { Unparseable, Validator } from '@lion/form-core';
 import { isValidIBAN } from 'ibantools';
 
 let loaded = false;
@@ -124,7 +124,7 @@ export class IsCountryIBAN extends IsIBAN {
   }
 
   /**
-   * @param {?} [value]
+   * @param {string} value
    * @returns {Boolean}
    */
   execute(value) {
@@ -150,6 +150,61 @@ export class IsCountryIBAN extends IsIBAN {
    */
   static async getMessage(data) {
     await loadTranslations();
-    return localize.msg('lion-validate+iban:error.IsCountryIBAN', data);
+    // If modelValue is Unparseable, the IsIBAN message is the more appropriate feedback
+    return data?.modelValue instanceof Unparseable
+      ? localize.msg('lion-validate+iban:error.IsIBAN', data)
+      : localize.msg('lion-validate+iban:error.IsCountryIBAN', data);
+  }
+}
+
+export class IsNotCountryIBAN extends IsIBAN {
+  static get validatorName() {
+    return 'IsNotCountryIBAN';
+  }
+
+  /**
+   * @param {string} value
+   * @returns {Boolean}
+   */
+  execute(value) {
+    let isInvalid = false;
+    const notIBAN = super.execute(value);
+
+    if (typeof this.param === 'string') {
+      if (value.slice(0, 2) === this.param) {
+        isInvalid = true;
+      }
+    } else if (Array.isArray(this.param)) {
+      isInvalid = this.param.some(country => value.slice(0, 2) === country);
+    }
+
+    if (notIBAN) {
+      isInvalid = true;
+    }
+    return isInvalid;
+  }
+
+  /**
+   * @param {object} [data]
+   * @param {*} [data.modelValue]
+   * @param {string} [data.fieldName]
+   * @param {*} [data.params]
+   * @param {string} [data.type]
+   * @param {Object.<string,?>} [data.config]
+   * @param {string} [data.name]
+   * @returns {Promise<string|Node>}
+   */
+  static async getMessage(data) {
+    await loadTranslations();
+    const _data = {
+      ...data,
+      userSuppliedCountryCode:
+        typeof data?.modelValue === 'string' ? data?.modelValue.slice(0, 2) : '',
+    };
+
+    // If modelValue is Unparseable, the IsIBAN message is the more appropriate feedback
+    return data?.modelValue instanceof Unparseable
+      ? localize.msg('lion-validate+iban:error.IsIBAN', _data)
+      : localize.msg('lion-validate+iban:error.IsNotCountryIBAN', _data);
   }
 }

packages/input-iban/test/validators.test.js

@@ -1,6 +1,6 @@
 import { expect } from '@open-wc/testing';
 
-import { IsIBAN, IsCountryIBAN } from '../src/validators.js';
+import { IsIBAN, IsCountryIBAN, IsNotCountryIBAN } from '../src/validators.js';
 
 import '../lion-input-iban.js';
 
@@ -9,6 +9,7 @@ describe('IBAN validation', () => {
     const validator = new IsIBAN();
     expect(validator.execute('NL17INGB0002822608')).to.be.false;
     expect(validator.execute('DE89370400440532013000')).to.be.false;
+    expect(validator.execute('foo')).to.be.true;
   });
 
   it('provides IsCountryIBAN to limit IBANs from specific countries', () => {
@@ -17,6 +18,29 @@ describe('IBAN validation', () => {
     expect(nlValidator.execute('NL17INGB0002822608')).to.be.false;
     expect(deValidator.execute('DE89370400440532013000')).to.be.false;
     expect(nlValidator.execute('DE89370400440532013000')).to.be.true;
-    expect(nlValidator.execute('foo')).to.be.true;
+    expect(deValidator.execute('NL17INGB0002822608')).to.be.true;
+  });
+
+  it('provides IsNotCountryIBAN to prevent IBANs from specific countries', () => {
+    const nlValidator = new IsNotCountryIBAN('NL');
+    const deValidator = new IsNotCountryIBAN('DE');
+    expect(nlValidator.execute('NL17INGB0002822608')).to.be.true;
+    expect(deValidator.execute('DE89370400440532013000')).to.be.true;
+    expect(nlValidator.execute('DE89370400440532013000')).to.be.false;
+    expect(deValidator.execute('NL17INGB0002822608')).to.be.false;
+  });
+
+  it('accepts an array for IsNotCountryIBAN to prevent IBANs from multiple countries', () => {
+    const nlValidator = new IsNotCountryIBAN(['NL', 'FR']);
+    const deValidator = new IsNotCountryIBAN(['DE', 'SK']);
+    expect(nlValidator.execute('NL17INGB0002822608')).to.be.true;
+    expect(nlValidator.execute('FR1420041010050500013M02606')).to.be.true;
+    expect(nlValidator.execute('DE89370400440532013000')).to.be.false;
+    expect(nlValidator.execute('SK3112000000198742637541')).to.be.false;
+
+    expect(deValidator.execute('NL17INGB0002822608')).to.be.false;
+    expect(deValidator.execute('FR1420041010050500013M02606')).to.be.false;
+    expect(deValidator.execute('DE89370400440532013000')).to.be.true;
+    expect(deValidator.execute('SK3112000000198742637541')).to.be.true;
   });
 });

packages/input-iban/translations/bg.js

@@ -16,5 +16,20 @@ export default {
       'RO {Румънски}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Австрийски}\n' +
+      'BE {Белгийски}\n' +
+      'CZ {Чешки}\n' +
+      'DE {Немски}\n' +
+      'ES {Испански}\n' +
+      'FR {Френски}\n' +
+      'HU {Унгарски}\n' +
+      'IT {Италиански}\n' +
+      'NL {Нидерландски}\n' +
+      'PL {Полски}\n' +
+      'RO {Румънски}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} не е позволено.',
   },
 };

packages/input-iban/translations/cs.js

@@ -16,5 +16,20 @@ export default {
       'RO {Rumun}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Rakušan}\n' +
+      'BE {Belgičan}\n' +
+      'CZ {Čech}\n' +
+      'DE {Němec}\n' +
+      'ES {Španěl}\n' +
+      'FR {Francouz}\n' +
+      'HU {Maďar}\n' +
+      'IT {Ital}\n' +
+      'NL {Holanďan}\n' +
+      'PL {Polák}\n' +
+      'RO {Rumun}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} není povoleno.',
   },
 };

packages/input-iban/translations/de.js

@@ -16,5 +16,20 @@ export default {
       'RO {Rumänisch}\n' +
       'other {{params}}\n' +
       '} {fieldName} ein.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Österreichisch}\n' +
+      'BE {Belgisch}\n' +
+      'CZ {Tschechisch}\n' +
+      'DE {Deutsch}\n' +
+      'ES {Spanisch}\n' +
+      'FR {Französisch}\n' +
+      'HU {Ungarisch}\n' +
+      'IT {Italienisch}\n' +
+      'NL {Niederländisch}\n' +
+      'PL {Polnisch}\n' +
+      'RO {Rumänisch}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} ist nicht erlaubt.',
   },
 };

packages/input-iban/translations/en.js

@@ -16,5 +16,20 @@ export default {
       'RO {Romanian}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Austrian}\n' +
+      'BE {Belgian}\n' +
+      'CZ {Czech}\n' +
+      'DE {German}\n' +
+      'ES {Spanish}\n' +
+      'FR {French}\n' +
+      'HU {Hungarian}\n' +
+      'IT {Italian}\n' +
+      'NL {Dutch}\n' +
+      'PL {Polish}\n' +
+      'RO {Romanian}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} is not allowed.',
   },
 };

packages/input-iban/translations/es.js

@@ -16,5 +16,20 @@ export default {
       'RO {Rumano}\n' +
       'other {{params}}\n' +
       '}.',
+    IsNotCountryIBAN:
+      '{fieldName} {userSuppliedCountryCode, select,\n' +
+      'AT {Austriaco}\n' +
+      'BE {Belga}\n' +
+      'CZ {Checo}\n' +
+      'DE {Alemán}\n' +
+      'ES {Español}\n' +
+      'FR {Francés}\n' +
+      'HU {Húngaro}\n' +
+      'IT {Italiano}\n' +
+      'NL {Neerlandés}\n' +
+      'PL {Polaco}\n' +
+      'RO {Rumano}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} no se permite.',
   },
 };

packages/input-iban/translations/fr.js

@@ -16,5 +16,20 @@ export default {
       'RO {roumain}\n' +
       'other {{params}}\n' +
       '} valide.',
+    IsNotCountryIBAN:
+      '{fieldName} {userSuppliedCountryCode, select,\n' +
+      'AT {autrichien}\n' +
+      'BE {belge}\n' +
+      'CZ {tchèque}\n' +
+      'DE {allemand}\n' +
+      'ES {espagnol}\n' +
+      'FR {français}\n' +
+      'HU {hongrois}\n' +
+      'IT {italien}\n' +
+      'NL {néerlandais}\n' +
+      'PL {polonais}\n' +
+      'RO {roumain}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      "} n'est pas autorisé.",
   },
 };

packages/input-iban/translations/hu.js

@@ -16,5 +16,20 @@ export default {
       'RO {Román}\n' +
       'other {{params}}\n' +
       '} {fieldName} értéket.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Osztrák}\n' +
+      'BE {Belga}\n' +
+      'CZ {Cseh}\n' +
+      'DE {Német}\n' +
+      'ES {Spanyol}\n' +
+      'FR {Francia}\n' +
+      'HU {Magyar}\n' +
+      'IT {Olasz}\n' +
+      'NL {Holland}\n' +
+      'PL {Lengyel}\n' +
+      'RO {Román}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} nem engedélyezett.',
   },
 };

packages/input-iban/translations/it.js

@@ -16,5 +16,20 @@ export default {
       'RO {Rumeno}\n' +
       'other {{params}}\n' +
       '}.',
+    IsNotCountryIBAN:
+      '{fieldName} {userSuppliedCountryCode, select,\n' +
+      'AT {Austriaco}\n' +
+      'BE {Belga}\n' +
+      'CZ {Ceco}\n' +
+      'DE {Tedesco}\n' +
+      'ES {Spagnolo}\n' +
+      'FR {Francese}\n' +
+      'HU {Ungherese}\n' +
+      'IT {Italiano}\n' +
+      'NL {Olandese}\n' +
+      'PL {Polacco}\n' +
+      'RO {Rumeno}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} non è permesso.',
   },
 };

packages/input-iban/translations/nl.js

@@ -16,5 +16,20 @@ export default {
       'RO {Roemeense}\n' +
       'other {{params}}\n' +
       '} {fieldName} in.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Oostenrijkse}\n' +
+      'BE {Belgische}\n' +
+      'CZ {Tsjechische}\n' +
+      'DE {Duitse}\n' +
+      'ES {Spaanse}\n' +
+      'FR {Franse}\n' +
+      'HU {Hongaarse}\n' +
+      'IT {Italiaanse}\n' +
+      'NL {Nederlandse}\n' +
+      'PL {Poolse}\n' +
+      'RO {Roemeense}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} is niet toegestaan.',
   },
 };

packages/input-iban/translations/pl.js

@@ -16,5 +16,20 @@ export default {
       'RO {Rumuński}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Austriacki}\n' +
+      'BE {Belgijski}\n' +
+      'CZ {Czeski}\n' +
+      'DE {Niemiecki}\n' +
+      'ES {Hiszpański}\n' +
+      'FR {Francuski}\n' +
+      'HU {Węgierski}\n' +
+      'IT {Włoski}\n' +
+      'NL {Holenderski}\n' +
+      'PL {Polski}\n' +
+      'RO {Rumuński}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} nie jest dozwolone.',
   },
 };

packages/input-iban/translations/ro.js

@@ -16,5 +16,20 @@ export default {
       'RO {românesc}\n' +
       'other {{params}}\n' +
       '} valid(ă).',
+    IsNotCountryIBAN:
+      '{fieldName} {userSuppliedCountryCode, select,\n' +
+      'AT {austriac}\n' +
+      'BE {belgian}\n' +
+      'CZ {ceh}\n' +
+      'DE {german}\n' +
+      'ES {spaniol}\n' +
+      'FR {francez}\n' +
+      'HU {maghiar}\n' +
+      'IT {italian}\n' +
+      'NL {olandez}\n' +
+      'PL {polonez}\n' +
+      'RO {românesc}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} nu este permis.',
   },
 };

packages/input-iban/translations/ru.js

@@ -16,5 +16,20 @@ export default {
       'RO {Румынский}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Австрийский}\n' +
+      'BE {Бельгийский}\n' +
+      'CZ {Чешский}\n' +
+      'DE {Немецкий}\n' +
+      'ES {Испанский}\n' +
+      'FR {Французский}\n' +
+      'HU {Венгерский}\n' +
+      'IT {Итальянский}\n' +
+      'NL {Нидерландский}\n' +
+      'PL {Польский}\n' +
+      'RO {Румынский}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} не допускается.',
   },
 };

packages/input-iban/translations/sk.js

@@ -16,5 +16,20 @@ export default {
       'RO {rumunský}\n' +
       'other {{params}}\n' +
       '} kód {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Rakúsky}\n' +
+      'BE {Belgický}\n' +
+      'CZ {Český}\n' +
+      'DE {Nemecký}\n' +
+      'ES {Španielsky}\n' +
+      'FR {Francúzsky}\n' +
+      'HU {Maďarský}\n' +
+      'IT {Taliansky}\n' +
+      'NL {Holandský}\n' +
+      'PL {Poľský}\n' +
+      'RO {Rumunský}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} nie je povolené.',
   },
 };

packages/input-iban/translations/uk.js

@@ -16,5 +16,20 @@ export default {
       'RO {румунська}\n' +
       'other {{params}}\n' +
       '} {fieldName}.',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {Австрійський}\n' +
+      'BE {Бельгійський}\n' +
+      'CZ {Чеський}\n' +
+      'DE {Німецький}\n' +
+      'ES {Iспанський}\n' +
+      'FR {Французький}\n' +
+      'HU {Угорський}\n' +
+      'IT {Iталійський}\n' +
+      'NL {Голландський}\n' +
+      'PL {Польський}\n' +
+      'RO {Румунська}\n' +
+      'other {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} не дозволено.',
   },
 };

packages/input-iban/translations/zh.js

@@ -16,5 +16,20 @@ export default {
       'RO {罗马尼亚}\n' +
       '另一个 {{params}}\n' +
       '} {fieldName}。',
+    IsNotCountryIBAN:
+      '{userSuppliedCountryCode, select,\n' +
+      'AT {奥}\n' +
+      'BE {比利时的}\n' +
+      'CZ {捷克}\n' +
+      'DE {德语}\n' +
+      'ES {西班牙语}\n' +
+      'FR {法国}\n' +
+      'HU {匈牙利}\n' +
+      'IT {意大利}\n' +
+      'NL {荷兰人}\n' +
+      'PL {抛光}\n' +
+      'RO {罗马尼亚}\n' +
+      '另一个 {{userSuppliedCountryCode}}\n' +
+      '} {fieldName} 不允許。',
   },
 };