feat(isTaxID): Add EU-UK TIN validation #1446

tplessas · 2020-09-22T15:26:04Z

Add support for the following locales: [ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-GB', 'en-IE', 'es-ES', 'et-EE', 'fi-FI', 'fr-BE', 'fr-FR', 'fr-LU', 'hr-HR', 'hu-HU', 'it-IT', 'lb-LU', 'lt-LT', 'lv-LV' 'mt-MT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-PT', 'ro-RO', 'sk-SK', 'sl-SI', 'sv-SE' ]
Add tests for locales
Add helper validation functions
Update isTaxID() readme description
Will close Contribute: Support for more locales to isTaxID #1423

Checklist

PR contains only changes related; no stray files, etc.
README updated (where applicable)
Tests written (where applicable)

* Added TIN validation for Austrian numbers * Added source of validation algorithms to header

* Refactored TIN unit tests to support more locales * Added unit tests for de-AT TINs * Added comments to isTaxID.js to explain behaviour of deAtCheck(tin)

* Added TIN validation for Greek numbers * Added relevant tests

* Added TIN validation for UK numbers * Added relevant tests

* Certain EU TINs might be entered with special characters which should not affect their validity/be omitted according to the specification. Such TINs are now sanitized before running checks in isTaxID(str, locale). * Removed en-GB validity check function (not needed, case already covered in isTaxID(str, locale). * Updated/simplified structure of regexes * Updated de-AT tests as some previously invalid TINs are now considered valid in line with the specification.

* Added TIN validation for Belgian numbers * Added relevant tests * Added local TIN names and validation scope (person/entity) to comments

* Countries with more than one locale should now have only one entry in the taxIdFormat and taxIdCheck objects, all others added as aliases below the objects. This should help avoid repetition. * Refactored nl-BE as alias to fr-BE * Renamed frNlBeCheck to frNlCheck to reflect changes.

* Added validation for French TINs * Added relevant tests

* Added validation for Cypriot TINs * Added relevant tests * Added tests for previously uncovered cases (calling isTaxID without a locale, frBeCheck invalid checksum)

* Added validation for Hungarian TINs * Added relevant tests * Refactored return statements to be one-liners where possible

Different locales might have specific needs wrt acceptable symbols in TINs- in some all are omitted during validation, while others only allow to skip a subset. A new object `sanitizeRegexes` has replaced the previous array, where locale-specific skippable symbol classes are to be placed. When all symbols can be omitted the new variable `allsymbols` is referenced. Aliases have also been added for the new object in line with the others and the isTaxID function checks for the locale's inclusion in `sanitizeRegexes`.

* Add TIN validation for German numbers * Add relevant tests

* Moved de-DE check digit calculation routine to new function `iso7064Check()` to be used for other conforming locales. * Add TIN validation for Croatian numbers * Add relevant tests * Refactor deDeCheck() to use iso7064Check()

* Add TIN validation for Bulgarian numbers * Add relevant tests

* Add TIN validation for Czech numbers * Add relevant tests

* Add validation for first digit of Greek TINs * Refactor el-GR tests * Add info for testable en-GB TINs

* Add TIN validation for Slovakian numbers * Add relevant tests

* Add TIN validation for Danish numbers * Add relevant tests

* Add TIN validation for Estonian numbers * Add relevant tests

* Add TIN validation for Lithuanian numbers (as alias of et-EE) * Add relevant tests

* Add TIN validation for Finnish numbers * Add relevant tests

* Add TIN validation for Italian numbers * Add relevant tests

* Add TIN validation for Irish numbers * Add relevant tests

* Add TIN validation for Latvian numbers * Add relevant tests

* Remove parseInt() calls in year extraction procedures of functions to improve performance and readability

* Add luhnCheck() to be used by conforming locale TINs * Refactor deAtCheck() to use luhnCheck()

* Add reverseMultiplyAndSum() to support new locale check functions

* Add TIN validation for Swedish numbers * Add relevant tests

* Add TIN validation for Dutch numbers * Add relevant tests * Refactor enIeCheck() to use reverseMultiplyAndSum()

* Add TIN validation for Portugese numbers * Add relevant tests

profnandaa · 2020-09-24T13:03:25Z

This is a great contribution, I'll review it this weekend. Thanks!

/cc. @tux-tn @ezkemboi -- please have a look too.

profnandaa

Really great work on this. LGTM for the most part, just a few comments here.

You can address that as I wait for @ezkemboi @tux-tn @rubiin to have a look.

profnandaa · 2020-10-09T08:10:17Z

src/lib/isTaxID.js

+  if (!isDate(date, 'YY/MM/DD')) { return false; }
+
+  /*
+   * Check validity of birth town registry number (codice catastale)


May be we separate this section as a different PR so that we give it more deliberation; but then allow the rest to land?

profnandaa · 2020-10-09T08:15:57Z

src/lib/isTaxID.js

+ * Called with an array of single-digit integers by locale-specific functions
+ * to validate TINs according to ISO 7064 (MOD 11, 10).
+ */
+function iso7064Check(digits) {


We can move these general-purpose algo checks (up to L118) into the src/lib/util/algorithms.js and export and re-use here and any other place in future.

agreed, will push both changes this weekend

Let me know once you are done with the changes.

firlus · 2020-10-19T08:08:41Z

I can confirm the functionality of the de-DE locale.
Implemented it as well (#1489) before seing that it already has been done.

* Remove codice catastale validation subroutine from it-IT (to be included in another upstream PR) for further review.

* General-purpose validation algorithms have benn moved to `src/lib/util/algoritms.js` to support further use. * Validation algorithms have been refactored to use strings as input * isTaxID has been refactored to use `algorithms.js`

tplessas · 2020-10-21T13:10:57Z

@profnandaa Both changes have been pushed- sorry for the delay, just moved to a new country. Also sorry for the force push- very bad habit of mine.

Algo checks now use strings as input in line with the rest of the project. I will open a new PR with the codice catastale procedure once this has been merged.

profnandaa · 2020-10-21T13:12:41Z

@tplessas -- no worries, thanks for sending in.

profnandaa

LGTM, thanks! 🎉

profnandaa · 2020-10-21T13:15:27Z

@rubiin @tux-tn or @ezkemboi -- kindly have a look at this, and we can land it soonest.

profnandaa · 2020-11-15T23:36:48Z

@tux-tn @ezkemboi -- if you can look at this one as first priority will be awesome. I don't want it to miss the November train.

ezkemboi · 2020-11-16T03:36:54Z

Alright. Taking a look at this one in the evening. Thanks.

…

On Mon, Nov 16, 2020 at 2:37 AM Anthony Nandaa ***@***.***> wrote: @tux-tn <https://github.com/tux-tn> @ezkemboi <https://github.com/ezkemboi> -- if you can look at this one as first priority will be awesome. I don't want it to miss the November train. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1446 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ALVWPH22VIHFTV3PNMVOVTTSQBQZZANCNFSM4RV5LGHQ> .

-- Regards, Ezrqn Kemboi. <http://www.ezrqnkemboi.dev> Software Engineer | Innovator | Open Source Enthusiast

profnandaa · 2020-11-19T01:52:36Z

@tplessas -- please resolve for conflict; @ezkemboi @tux-tn -- can check this as first priority since it was a huge diff. I would like to get this in in the weekend release.

ezkemboi · 2020-11-19T05:54:15Z

@profnandaa I have been busy a little but let me look at it by the end of tomorrow before you make a release on weekend.

tplessas · 2020-11-19T18:15:17Z

@profnandaa Conflict resolved.

profnandaa · 2020-11-19T20:42:12Z

@ez - no pressure, thanks!

On Thu, Nov 19, 2020 at 9:15 PM Theodoros Plessas ***@***.***> wrote: @profnandaa <https://github.com/profnandaa> Conflict resolved. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1446 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB7ZEKN3Y4HMP247LCC4JTSQVOEJANCNFSM4RV5LGHQ> .

-- Sent from a tiny device while on the move.

tux-tn

Huge work @tplessas ! Really good, nicely documented and structured.
I have just one question, should we keep the algorithms separated from the validator? Are they useful somewhere else than TaxID validation?

ezkemboi · 2020-11-20T16:02:01Z

Huge work @tplessas ! Really good, nicely documented and structured.
I have just one question, should we keep the algorithms separated from the validator? Are they useful somewhere else than TaxID validation?

It might be used in the future.

ezkemboi

We can land this @profnandaa. Looks good.
Thanks, @tplessas for the contribution.

profnandaa · 2020-11-23T02:33:24Z

Sure. I was actually the one that asked that we separate the algos just in case we reuse later, since they are general purpose.

-na

On Fri, Nov 20, 2020 at 7:04 PM Ezrqn Kemboi ***@***.***> wrote: ***@***.**** approved this pull request. We can land this @profnandaa <https://github.com/profnandaa>. Looks good. Thanks, @tplessas <https://github.com/tplessas> for the contribution. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1446 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB7ZEIZLICRL2TG6VU7BHDSQ2HPXANCNFSM4RV5LGHQ> .

-- Sent from a tiny device while on the move.

tplessas added 30 commits August 25, 2020 06:53

feat(isTaxID): Added de-AT locale

bd2916b

* Added TIN validation for Austrian numbers * Added source of validation algorithms to header

test(isTaxID): Added unit tests for de-AT TINs

c1f94b2

* Refactored TIN unit tests to support more locales * Added unit tests for de-AT TINs * Added comments to isTaxID.js to explain behaviour of deAtCheck(tin)

feat(isTaxID): Added el-GR locale

fc8415f

* Added TIN validation for Greek numbers * Added relevant tests

feat(isTaxID): Added en-GB locale

aafde10

* Added TIN validation for UK numbers * Added relevant tests

feat(isTaxID): Added fr/nl-BE locales

1ff1df1

* Added TIN validation for Belgian numbers * Added relevant tests * Added local TIN names and validation scope (person/entity) to comments

feat(isTaxID): Added fr-FR locale

da20851

* Added validation for French TINs * Added relevant tests

feat(isTaxID): Added el-CY locale

6f39782

* Added validation for Cypriot TINs * Added relevant tests * Added tests for previously uncovered cases (calling isTaxID without a locale, frBeCheck invalid checksum)

feat(isTaxID): Added hu-HU locale

77cf993

* Added validation for Hungarian TINs * Added relevant tests * Refactored return statements to be one-liners where possible

feat(isTaxID): Add de-DE locale

ab924d8

* Add TIN validation for German numbers * Add relevant tests

feat(isTaxID): Add hr-HR locale

59ddf52

* Moved de-DE check digit calculation routine to new function `iso7064Check()` to be used for other conforming locales. * Add TIN validation for Croatian numbers * Add relevant tests * Refactor deDeCheck() to use iso7064Check()

feat(isTaxID): Add bg-BG locale

237a46f

* Add TIN validation for Bulgarian numbers * Add relevant tests

feat(isTaxID): Add cs-CZ locale

cdf0ade

* Add TIN validation for Czech numbers * Add relevant tests

fix(isTaxID): Add el-GR first digit validation

afb51a9

* Add validation for first digit of Greek TINs * Refactor el-GR tests * Add info for testable en-GB TINs

feat(isTaxID): Add sk-SK locale

110b24b

* Add TIN validation for Slovakian numbers * Add relevant tests

feat(isTaxID): Add dk-DK locale

6c83200

* Add TIN validation for Danish numbers * Add relevant tests

feat(isTaxID): Add et-EE locale

2b3068f

* Add TIN validation for Estonian numbers * Add relevant tests

feat(isTaxID): Add lt-LT locale

f06637c

* Add TIN validation for Lithuanian numbers (as alias of et-EE) * Add relevant tests

feat(isTaxID): Add fi-FI locale

84b306f

* Add TIN validation for Finnish numbers * Add relevant tests

feat(isTaxID): Add it-IT locale

fa9dfd6

* Add TIN validation for Italian numbers * Add relevant tests

feat(isTaxID): Add en-IE locale

6e5ddf6

* Add TIN validation for Irish numbers * Add relevant tests

feat(isTaxID): Add lv-LV locale

606219a

* Add TIN validation for Latvian numbers * Add relevant tests

refactor(isTaxID): Remove unneeded parseInt() calls

66d1021

* Remove parseInt() calls in year extraction procedures of functions to improve performance and readability

refactor(isTaxID): Add Luhn validation function

77e67c5

* Add luhnCheck() to be used by conforming locale TINs * Refactor deAtCheck() to use luhnCheck()

refactor(isTaxID): Add reverse multiplication function

d4ac410

* Add reverseMultiplyAndSum() to support new locale check functions

feat(isTaxID): Add sv-SE locale

e786cc6

* Add TIN validation for Swedish numbers * Add relevant tests

feat(isTaxID): Add nl-NL locale

9142f5b

* Add TIN validation for Dutch numbers * Add relevant tests * Refactor enIeCheck() to use reverseMultiplyAndSum()

feat(isTaxID): Add pt-PT locale

f6ab3b2

* Add TIN validation for Portugese numbers * Add relevant tests

profnandaa added the 🕑 to-be-reviewed label Sep 24, 2020

profnandaa reviewed Oct 9, 2020

View reviewed changes

profnandaa added 🧹 needs-update For PRs that need to be updated before landing and removed 🕑 to-be-reviewed labels Oct 9, 2020

profnandaa mentioned this pull request Oct 19, 2020

feat(isTaxID): added de-DE locale #1489

Closed

3 tasks

remove(isTaxID): Remove codice catastale validation

b725ca3

* Remove codice catastale validation subroutine from it-IT (to be included in another upstream PR) for further review.

tplessas force-pushed the refactor-isTaxID branch from 713c7a9 to b725ca3 Compare October 19, 2020 21:24

refactor(isTaxID): Move helper validation algorithms

2df2d18

* General-purpose validation algorithms have benn moved to `src/lib/util/algoritms.js` to support further use. * Validation algorithms have been refactored to use strings as input * isTaxID has been refactored to use `algorithms.js`

profnandaa approved these changes Oct 21, 2020

View reviewed changes

profnandaa removed the 🧹 needs-update For PRs that need to be updated before landing label Oct 21, 2020

Merge branch 'master' into refactor-isTaxID

bc9ef38

tux-tn approved these changes Nov 20, 2020

View reviewed changes

ezkemboi approved these changes Nov 20, 2020

View reviewed changes

profnandaa merged commit dd99347 into validatorjs:master Nov 24, 2020

profnandaa mentioned this pull request Nov 29, 2020

release staging: Nov 2020 release notes #1535

Merged

This was referenced Mar 12, 2021

chore(deps): bump validator from 9.4.1 to 13.5.2 in /api-server Dman247/freeCodeCamp#185

Open

Bump validator from 13.1.17 to 13.5.2 razee-io/Razeedash-api#825

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(isTaxID): Add EU-UK TIN validation #1446

feat(isTaxID): Add EU-UK TIN validation #1446

tplessas commented Sep 22, 2020 •

edited

Loading

profnandaa commented Sep 24, 2020

profnandaa left a comment

profnandaa Oct 9, 2020

profnandaa Oct 9, 2020

tplessas Oct 9, 2020

profnandaa Oct 19, 2020

firlus commented Oct 19, 2020

tplessas commented Oct 21, 2020

profnandaa commented Oct 21, 2020

profnandaa left a comment

profnandaa commented Oct 21, 2020

profnandaa commented Nov 15, 2020

ezkemboi commented Nov 16, 2020 via email

profnandaa commented Nov 19, 2020

ezkemboi commented Nov 19, 2020

tplessas commented Nov 19, 2020

profnandaa commented Nov 19, 2020 via email

tux-tn left a comment

ezkemboi commented Nov 20, 2020

ezkemboi left a comment

profnandaa commented Nov 23, 2020 via email

feat(isTaxID): Add EU-UK TIN validation #1446

feat(isTaxID): Add EU-UK TIN validation #1446

Conversation

tplessas commented Sep 22, 2020 • edited Loading

Checklist

profnandaa commented Sep 24, 2020

profnandaa left a comment

Choose a reason for hiding this comment

profnandaa Oct 9, 2020

Choose a reason for hiding this comment

profnandaa Oct 9, 2020

Choose a reason for hiding this comment

tplessas Oct 9, 2020

Choose a reason for hiding this comment

profnandaa Oct 19, 2020

Choose a reason for hiding this comment

firlus commented Oct 19, 2020

tplessas commented Oct 21, 2020

profnandaa commented Oct 21, 2020

profnandaa left a comment

Choose a reason for hiding this comment

profnandaa commented Oct 21, 2020

profnandaa commented Nov 15, 2020

ezkemboi commented Nov 16, 2020 via email

profnandaa commented Nov 19, 2020

ezkemboi commented Nov 19, 2020

tplessas commented Nov 19, 2020

profnandaa commented Nov 19, 2020 via email

tux-tn left a comment

Choose a reason for hiding this comment

ezkemboi commented Nov 20, 2020

ezkemboi left a comment

Choose a reason for hiding this comment

profnandaa commented Nov 23, 2020 via email

tplessas commented Sep 22, 2020 •

edited

Loading