Skip to content

Commit 3c771e8

Browse files
mschunkemschunke
authored
feat(pt-BR): tax id, passport and license plates (#1613)
* feat(pt-BR): tax id, passport and license plates * delete compiled files * fix(tests): tests now covering 100% of code * fix(licenseplate): removed license plate pt-br * fix(readme): removed license plate changes
1 parent 418df05 commit 3c771e8

4 files changed

Lines changed: 120 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Validator | Description
143143
**isMultibyte(str)** | check if the string contains one or more multibyte chars.
144144
**isNumeric(str [, options])** | check if the string contains only numbers.<br/><br/>`options` is an object which defaults to `{no_symbols: false}` it also has locale as an option. If `no_symbols` is true, the validator will reject numeric strings that feature a symbol (e.g. `+`, `-`, or `.`).<br/><br/>`locale` determine the decimal separator and is one of `['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-FR', 'fr-CA', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']`.
145145
**isOctal(str)** | check if the string is a valid octal number.
146-
**isPassportNumber(str, countryCode)** | check if the string is a valid passport number.<br/><br/>(countryCode is one of `[ 'AM', 'AR', 'AT', 'AU', 'BE', 'BG', 'BY', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE' 'IN', 'IS', 'IT', 'JP', 'KR', 'LT', 'LU', 'LV', 'LY', 'MT', 'NL', 'PO', 'PT', 'RO', 'RU', 'SE', 'SL', 'SK', 'TR', 'UA', 'US' ]`.
146+
**isPassportNumber(str, countryCode)** | check if the string is a valid passport number.<br/><br/>(countryCode is one of `[ 'AM', 'AR', 'AT', 'AU', 'BE', 'BG', 'BY', 'BR', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE' 'IN', 'IS', 'IT', 'JP', 'KR', 'LT', 'LU', 'LV', 'LY', 'MT', 'NL', 'PO', 'PT', 'RO', 'RU', 'SE', 'SL', 'SK', 'TR', 'UA', 'US' ]`.
147147
**isPort(str)** | check if the string is a valid port number.
148148
**isPostalCode(str, locale)** | check if the string is a postal code,<br/><br/>(locale is one of `[ 'AD', 'AT', 'AU', 'AZ', 'BE', 'BG', 'BR', 'BY', 'CA', 'CH', 'CN', 'CZ', 'DE', 'DK', 'DO', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HT', 'HU', 'ID', 'IE' 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'LI', 'LT', 'LU', 'LV', 'MT', 'MX', 'MY', 'NL', 'NO', 'NP', 'NZ', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SG', 'SI', 'TH', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM' ]` OR 'any'. If 'any' is used, function will check if any of the locals match. Locale list is `validator.isPostalCodeLocales`.).
149149
**isRFC3339(str)** | check if the string is a valid [RFC 3339](https://tools.ietf.org/html/rfc3339) date.
@@ -153,7 +153,7 @@ Validator | Description
153153
**isUppercase(str)** | check if the string is uppercase.
154154
**isSlug** | Check if the string is of type slug. `Options` allow a single hyphen between string. e.g. [`cn-cn`, `cn-c-c`]
155155
**isStrongPassword(str [, options])** | Check if a password is strong or not. Allows for custom requirements or scoring rules. If `returnScore` is true, then the function returns an integer score for the password rather than a boolean.<br/>Default options: <br/>`{ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1, returnScore: false, pointsPerUnique: 1, pointsPerRepeat: 0.5, pointsForContainingLower: 10, pointsForContainingUpper: 10, pointsForContainingNumber: 10, pointsForContainingSymbol: 10 }`
156-
**isTaxID(str, locale)** | Check if the given value is a valid Tax Identification Number. Default locale is `en-US`.<br/><br/>More info about exact TIN support can be found in `src/lib/isTaxID.js`<br/><br/>Supported locales: `[ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-GB', 'en-IE', 'en-US', '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' ]`
156+
**isTaxID(str, locale)** | Check if the given value is a valid Tax Identification Number. Default locale is `en-US`.<br/><br/>More info about exact TIN support can be found in `src/lib/isTaxID.js`<br/><br/>Supported locales: `[ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-GB', 'en-IE', 'en-US', '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-BR', 'pt-PT', 'ro-RO', 'sk-SK', 'sl-SI', 'sv-SE' ]`
157157
**isURL(str [, options])** | check if the string is an URL.<br/><br/>`options` is an object which defaults to `{ protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_valid_protocol: true, allow_underscores: false, host_whitelist: false, host_blacklist: false, allow_trailing_dot: false, allow_protocol_relative_urls: false, disallow_auth: false }`.<br/><br/>require_protocol - if set as true isURL will return false if protocol is not present in the URL.<br/>require_valid_protocol - isURL will check if the URL's protocol is present in the protocols option.<br/>protocols - valid protocols can be modified with this option.<br/>require_host - if set as false isURL will not check if host is present in the URL.<br/>require_port - if set as true isURL will check if port is present in the URL.<br/>allow_protocol_relative_urls - if set as true protocol relative URLs will be allowed.<br/>validate_length - if set as false isURL will skip string length validation (2083 characters is IE max URL length).
158158
**isUUID(str [, version])** | check if the string is a UUID (version 3, 4 or 5).
159159
**isVariableWidth(str)** | check if the string contains a mixture of full and half-width chars.

‎src/lib/isPassportNumber.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ const passportRegexByCountryCode = {
1313
AU: /^[A-Z]\d{7}$/, // AUSTRALIA
1414
BE: /^[A-Z]{2}\d{6}$/, // BELGIUM
1515
BG: /^\d{9}$/, // BULGARIA
16+
BR: /^[A-Z]{2}\d{6}$/, // BRAZIL
1617
BY: /^[A-Z]{2}\d{7}$/, // BELARUS
1718
CA: /^[A-Z]{2}\d{6}$/, // CANADA
1819
CH: /^[A-Z]\d{7}$/, // SWITZERLAND

‎src/lib/isTaxID.js‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -852,6 +852,93 @@ function plPlCheck(tin) {
852852
return checksum === parseInt(tin[10], 10);
853853
}
854854

855+
/*
856+
* pt-BR validation function
857+
* (Cadastro de Pessoas Físicas (CPF, persons)
858+
* Cadastro Nacional de Pessoas Jurídicas (CNPJ, entities)
859+
* Both inputs will be validated
860+
*/
861+
862+
function ptBrCheck(tin) {
863+
tin = tin.replace(/[^\d]+/g, '');
864+
if (tin === '') return false;
865+
866+
if (tin.length === 11) {
867+
let sum;
868+
let ramainder;
869+
sum = 0;
870+
tin = tin.replace(/[^\d]+/g, '');
871+
872+
if ( // Reject known invalid CPFs
873+
tin === '11111111111' ||
874+
tin === '22222222222' ||
875+
tin === '33333333333' ||
876+
tin === '44444444444' ||
877+
tin === '55555555555' ||
878+
tin === '66666666666' ||
879+
tin === '77777777777' ||
880+
tin === '88888888888' ||
881+
tin === '99999999999' ||
882+
tin === '00000000000'
883+
) return false;
884+
885+
for (let i = 1; i <= 9; i++) sum += parseInt(tin.substring(i - 1, i), 10) * (11 - i);
886+
ramainder = (sum * 10) % 11;
887+
if ((ramainder === 10) || (ramainder === 11)) ramainder = 0;
888+
if (ramainder !== parseInt(tin.substring(9, 10), 10)) return false;
889+
sum = 0;
890+
891+
for (let i = 1; i <= 10; i++) sum += parseInt(tin.substring(i - 1, i), 10) * (12 - i);
892+
ramainder = (sum * 10) % 11;
893+
if ((ramainder === 10) || (ramainder === 11)) ramainder = 0;
894+
if (ramainder !== parseInt(tin.substring(10, 11), 10)) return false;
895+
896+
return true;
897+
}
898+
899+
if (tin.length !== 14) { return false; }
900+
901+
if ( // Reject know invalid CNPJs
902+
tin === '00000000000000' ||
903+
tin === '11111111111111' ||
904+
tin === '22222222222222' ||
905+
tin === '33333333333333' ||
906+
tin === '44444444444444' ||
907+
tin === '55555555555555' ||
908+
tin === '66666666666666' ||
909+
tin === '77777777777777' ||
910+
tin === '88888888888888' ||
911+
tin === '99999999999999') { return false; }
912+
913+
let length = tin.length - 2;
914+
let identifiers = tin.substring(0, length);
915+
let verificators = tin.substring(length);
916+
let sum = 0;
917+
let pos = length - 7;
918+
919+
for (let i = length; i >= 1; i--) {
920+
sum += identifiers.charAt(length - i) * pos;
921+
pos -= 1;
922+
if (pos < 2) { pos = 9; }
923+
}
924+
let result = sum % 11 < 2 ? 0 : 11 - (sum % 11);
925+
if (result !== parseInt(verificators.charAt(0), 10)) { return false; }
926+
927+
length += 1;
928+
identifiers = tin.substring(0, length);
929+
sum = 0;
930+
pos = length - 7;
931+
for (let i = length; i >= 1; i--) {
932+
sum += identifiers.charAt(length - i) * pos;
933+
pos -= 1;
934+
if (pos < 2) { pos = 9; }
935+
}
936+
result = sum % 11 < 2 ? 0 : 11 - (sum % 11);
937+
if (result !== parseInt(verificators.charAt(1), 10)) { return false; }
938+
939+
return true;
940+
}
941+
855942
/*
856943
* pt-PT validation function
857944
* (Número de identificação fiscal (NIF), persons/entities)
@@ -1039,6 +1126,7 @@ const taxIdFormat = {
10391126
'mt-MT': /^\d{3,7}[APMGLHBZ]$|^([1-8])\1\d{7}$/i,
10401127
'nl-NL': /^\d{9}$/,
10411128
'pl-PL': /^\d{10,11}$/,
1129+
'pt-BR': /^\d{11,14}$/,
10421130
'pt-PT': /^\d{9}$/,
10431131
'ro-RO': /^\d{13}$/,
10441132
'sk-SK': /^\d{6}\/{0,1}\d{3,4}$/,
@@ -1076,6 +1164,7 @@ const taxIdCheck = {
10761164
'mt-MT': mtMtCheck,
10771165
'nl-NL': nlNlCheck,
10781166
'pl-PL': plPlCheck,
1167+
'pt-BR': ptBrCheck,
10791168
'pt-PT': ptPtCheck,
10801169
'ro-RO': roRoCheck,
10811170
'sk-SK': skSkCheck,

‎test/validators.js‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2289,6 +2289,18 @@ describe('Validators', () => {
22892289
],
22902290
});
22912291

2292+
test({
2293+
validator: 'isPassportNumber',
2294+
args: ['BR'],
2295+
valid: [
2296+
'FZ973689',
2297+
'GH231233',
2298+
],
2299+
invalid: [
2300+
'ABX29332',
2301+
],
2302+
});
2303+
22922304
test({
22932305
validator: 'isPassportNumber',
22942306
args: ['BY'],
@@ -9965,6 +9977,22 @@ describe('Validators', () => {
99659977
'2234567855',
99669978
'02223013623'],
99679979
});
9980+
test({
9981+
validator: 'isTaxID',
9982+
args: ['pt-BR'],
9983+
valid: [
9984+
'35161990910',
9985+
'74407265027',
9986+
'05423994000172',
9987+
'11867044000130'],
9988+
invalid: [
9989+
'170.691.440-72',
9990+
'01494282042',
9991+
'11111111111',
9992+
'94.592.973/0001-82',
9993+
'28592361000192',
9994+
'11111111111111'],
9995+
});
99689996
test({
99699997
validator: 'isTaxID',
99709998
args: ['pt-PT'],

0 commit comments

Comments
 (0)