validation-br 1.4.4 → 1.5.1

package/readme.md

@@ -1,6 +1,6 @@
 # validation-br
 
-Biblioteca de validação de documentos pessoais do Brasil com suporte a CPF, CNPJ, Título Eleitoral, PIS/PASEP, CNH. Também valida numerações de outros tipos de registros como RENAVAM, Processos Judiciais, Número de Protocolo do Governo Federal e Objetos registrados de Rastreamento dos Correios.
+Biblioteca de validação de documentos pessoais do Brasil com suporte a CPF, CNPJ (numérico e alfanumérico), Título Eleitoral, PIS/PASEP, CNH. Também valida numerações de outros tipos de registros como RENAVAM, Processos Judiciais, Número de Protocolo do Governo Federal e Objetos registrados de Rastreamento dos Correios.
 
 Validation-BR também permite criação de números fake para facilitar o desenvolvimento e testes, além de aplicar máscaras e calcular somente os dígitos verificadores.
 
@@ -88,7 +88,7 @@ Abaixo seguem alguns exemplos. Sinta-se convidado a adicionar a sua biblioteca f
 - [Vuelidate](https://github.com/klawdyo/validation-br/wiki/Vuelidate) - Usado para validação de estado no vuejs
 - [Class-Validator](https://github.com/klawdyo/validation-br/wiki/ClassValidator) - Usado em nest, typeorm E mais uma infinidade de frameworks
 - [Indicative](https://github.com/klawdyo/validation-br/wiki/Indicative) - Indicative é a biblioteca padrão de validação usada no Adonis.
-- [Joi](https://github.com/klawdyo/validation-br/wiki/Joi) - Joi é um validador de esquemas usado em aplicações node, react, vue etc. 
+- [Joi](https://github.com/klawdyo/validation-br/wiki/Joi) - Joi é um validador de esquemas usado em aplicações node, react, vue etc.
 - [Yup](https://github.com/klawdyo/validation-br/wiki/Yup) - Yup é usado para validar estado em aplicações react.
 
 ### isCNH( `value` )
@@ -100,11 +100,10 @@ Valida o documento da carteira nacional de habilitação.
 import { isCNH } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/cnh'
+import { validate, mask } from 'validation-br/dist/cnh'
 // ou
 import * as cnh from 'validation-br/dist/cnh'
 
-
 // Valida
 isCNH('69044271146') //-> true
 isCNH('62472927637') //-> true
@@ -127,12 +126,14 @@ cnh.dv('624729276') // -> '37'
 
 Valida um CNPJ
 
+> A partir da [Nota Técnica conjunta COCAD/SUARA/RFB nº 49 de 14 de maio de 2024](https://github.com/user-attachments/files/15851229/Nota.COCAD.SUARA.2024.05.49.CNPJ.Alfanumerico-1.pdf), os números de CNPJ poderão ser alfanuméricos. A alteração entra em uso em 2026.
+
 ```js
 // Importação somente da validação
 import { isCNPJ } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/cnpj'
+import { validate, mask } from 'validation-br/dist/cnpj'
 // ou
 import * as cnpj from 'validation-br/dist/cnpj'
 
@@ -146,6 +147,9 @@ cnpj.validateOrFail('99362238000180') //-> true
 // Número fake com e sem máscara
 cnpj.fake() // -> 55585709000198
 cnpj.fake(true) // -> 55.585.709/0001-98
+cnpj.fake({ withMask: true}) // -> 55.585.709/0001-98
+cnpj.fake({ withMask: true, alphanumeric: true}) // -> A1.222.333/0001-50
+cnpj.fake({ withMask: false, alphanumeric: true}) // -> A1222333/0001-50
 
 // Aplica uma máscara
 cnpj.mask('99362238000180') // -> 99.362.238/0001-80
@@ -163,7 +167,7 @@ Valida um CPF
 import { isCPF } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/cpf'
+import { validate, mask } from 'validation-br/dist/cpf'
 // ou
 import * as cpf from 'validation-br/dist/cpf'
 
@@ -214,7 +218,7 @@ O número é composto por 6 partes:
 import { isJudicialProcess } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/judicialProcess'
+import { validate, mask } from 'validation-br/dist/judicialProcess'
 // ou
 import * as judicialProcess from 'validation-br/dist/judicialProcess'
 
@@ -251,7 +255,7 @@ Válida um Número Unificado de Protocolo de 17 dígitos. Esta numeração é us
 import { isNUP17 } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/nup17'
+import { validate, mask } from 'validation-br/dist/nup17'
 // ou
 import * as nup from 'validation-br/dist/nup17'
 
@@ -282,7 +286,7 @@ Valida códigos PIS, PASEP, NIS e NIT, que usam o mesmo algoritmo. Aceita númer
 import { isPIS } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/pisPasep'
+import { validate, mask } from 'validation-br/dist/pisPasep'
 // ou
 import * as pis from 'validation-br/dist/pisPasep'
 
@@ -318,7 +322,7 @@ Valida um código de rastreamento de objetos postais no formato XX00000000DYY, o
 import { isPostalCode } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/postalCode'
+import { validate, mask } from 'validation-br/dist/postalCode'
 // ou
 import * as postalCode from 'validation-br/dist/postalCode'
 
@@ -350,7 +354,7 @@ Valida o número de um RENAVAM de 11 dígitos
 import { isRenavam } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/renavam'
+import { validate, mask } from 'validation-br/dist/renavam'
 // ou
 import * as renavam from 'validation-br/dist/renavam'
 
@@ -381,7 +385,7 @@ Valida um título eleitoral
 import { isTituloEleitor } from 'validation-br'
 // ou
 // Importação do submódulo
-import {validate, mask} from 'validation-br/dist/tituloEleitor'
+import { validate, mask } from 'validation-br/dist/tituloEleitor'
 // ou
 import * as titulo from 'validation-br/dist/tituloEleitor'
 
@@ -407,31 +411,42 @@ titulo.dv('5250288816') // -> '94'
 
 Todos os testes passando com 100% de cobertura
 
-![Testes passando com 100% de cobertura](https://user-images.githubusercontent.com/100168/210075927-e13d8fad-f252-40a5-ad04-326a3198c0cb.png)
+![Testes passando com 100% de cobertura](https://github.com/klawdyo/validation-br/assets/100168/bb83df1e-774c-4a92-bf83-7b451682264e)
+
+# Github Actions
 
+Github actions executados nas versões 18, 20 e 22 do Node.
 
+![Github actions executados nas versões 12, 14, 16, 18 e 20 do Node](https://github.com/klawdyo/validation-br/assets/100168/50f5b3c3-f1b0-46ac-a6b1-e31a366b27c7)
 
 # Changelog
 
-- **30/12/2022**: 
-   - 1.4.4 
-      - Correção de bug quando o documento válido tinha caracteres adicionais
-      - Refatoração de `clearValue()` para comportar configurações opcionais
+- **16/12/2023**:
+  - 1.5.0
+    - CNPJ alfanumérico 
+    - Removidos github actions dos node 12, 14 e 16 e acrescentado o 22
+- **16/12/2023**:
+  - 1.4.5
+    - Corrige o caminho da definição dos types. (Thanks @ishigami)
+- **30/12/2022**:
+  - 1.4.4
+    - Correção de bug quando o documento válido tinha caracteres adicionais
+    - Refatoração de `clearValue()` para comportar configurações opcionais
 - **01/10/2022**:
-   - 1.4.1
-      - Correção na importação principal dos módulos
-      - Refatoração do isJudicialProcess para permitir 100% de cobertura dos testes
-      - Inclusão de mais testes unitários para atingir 100% de cobertura
+  - 1.4.1
+    - Correção na importação principal dos módulos
+    - Refatoração do isJudicialProcess para permitir 100% de cobertura dos testes
+    - Inclusão de mais testes unitários para atingir 100% de cobertura
 - **10/01/2022**:
-   - 1.1.0 - Adicionado NUP17 - Número Unificado de Protocolo de 17 dígitos do Governo Federal
+  - 1.1.0 - Adicionado NUP17 - Número Unificado de Protocolo de 17 dígitos do Governo Federal
 - **09/01/2022**:
-   - 1.0.0 - Biblioteca convertida para Typescript e testes convertidos para Jest
+  - 1.0.0 - Biblioteca convertida para Typescript e testes convertidos para Jest
 - **08/01/2022**:
-   - 0.21.1 - Adicionadas as funções isRenavam e isJudicialProcess
+  - 0.21.1 - Adicionadas as funções isRenavam e isJudicialProcess
 - **16/09/2021**:
-   - 0.5.0 - Adicionadas as funções isCPF, isCNPJ e isTituloEleitor
-   - 0.7.0 - Adicionadas as funções isPostalCode e isCNH
-   - 0.8.0 - Adicionada a função isPIS
+  - 0.5.0 - Adicionadas as funções isCPF, isCNPJ e isTituloEleitor
+  - 0.7.0 - Adicionadas as funções isPostalCode e isCNH
+  - 0.8.0 - Adicionada a função isPIS
 
 # Referências
 

package/.eslintcache

@@ -1 +0,0 @@
-[{"D:\\Desenvolvimento\\Javascript\\Validation-BR\\boilerplate-jest-eslint-ts\\.eslintrc.js":"1","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnh.ts":"2","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnpj.ts":"3","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cpf.ts":"4","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\judicialProcess.ts":"5","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\pisPasep.ts":"6","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\postalCode.ts":"7","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\renavam.ts":"8","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\tituloEleitor.ts":"9","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\index.ts":"10","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\nup17.test.ts":"11","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\nup17.ts":"12","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\utils.ts":"13","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\judicialProcess.test.ts":"14","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\utils-randomLetter.test.ts":"15","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\jest.config.js":"16","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\index.test.ts":"17","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnh.test.ts":"18","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnpj.test.ts":"19","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cpf.test.ts":"20","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\pisPasep.test.ts":"21","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\postalCode.test.ts":"22","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\renavam.test.ts":"23","D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\tituloEleitor.test.ts":"24"},{"size":2512,"mtime":1641739367275,"results":"25","hashOfConfig":"26"},{"size":3670,"mtime":1641857909477,"results":"27","hashOfConfig":"28"},{"size":3665,"mtime":1641857909477,"results":"29","hashOfConfig":"28"},{"size":3860,"mtime":1641857909479,"results":"30","hashOfConfig":"28"},{"size":6137,"mtime":1664635131177,"results":"31","hashOfConfig":"32"},{"size":3185,"mtime":1641857909611,"results":"33","hashOfConfig":"28"},{"size":3625,"mtime":1642529307638,"results":"34","hashOfConfig":"28"},{"size":3038,"mtime":1641857909470,"results":"35","hashOfConfig":"28"},{"size":3933,"mtime":1641857909467,"results":"36","hashOfConfig":"28"},{"size":1233,"mtime":1664635827132,"results":"37","hashOfConfig":"32"},{"size":3363,"mtime":1664976574179,"results":"38","hashOfConfig":"32"},{"size":4949,"mtime":1641857909475,"results":"39","hashOfConfig":"28"},{"size":5373,"mtime":1642529564093,"results":"40","hashOfConfig":"28"},{"size":4302,"mtime":1664976550653,"results":"41","hashOfConfig":"32"},{"size":316,"mtime":1642529055968,"results":"42","hashOfConfig":"28"},{"size":357,"mtime":1664633645786,"results":"43","hashOfConfig":"32"},{"size":2418,"mtime":1664976269830,"results":"44","hashOfConfig":"32"},{"size":2813,"mtime":1664976462991,"results":"45","hashOfConfig":"32"},{"size":3400,"mtime":1664976508421,"results":"46","hashOfConfig":"32"},{"size":2995,"mtime":1664976550645,"results":"47","hashOfConfig":"32"},{"size":2947,"mtime":1664976598888,"results":"48","hashOfConfig":"32"},{"size":3297,"mtime":1664976676149,"results":"49","hashOfConfig":"32"},{"size":2907,"mtime":1664976689887,"results":"50","hashOfConfig":"32"},{"size":3305,"mtime":1664976705717,"results":"51","hashOfConfig":"32"},{"filePath":"52","messages":"53","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1mhu42l",{"filePath":"54","messages":"55","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1oacsom",{"filePath":"56","messages":"57","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"58","messages":"59","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"60","messages":"61","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1mffhgm",{"filePath":"62","messages":"63","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"64","messages":"65","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"66","messages":"67","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"68","messages":"69","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"70","messages":"71","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"72","messages":"73","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"74","messages":"75","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"76","messages":"77","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"78","messages":"79","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"80","messages":"81","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"82","messages":"83","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"84","messages":"85","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"86","messages":"87","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"88","messages":"89","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"90","messages":"91","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"92","messages":"93","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"94","messages":"95","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"96","messages":"97","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"98","messages":"99","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"D:\\Desenvolvimento\\Javascript\\Validation-BR\\boilerplate-jest-eslint-ts\\.eslintrc.js",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnh.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnpj.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cpf.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\judicialProcess.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\pisPasep.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\postalCode.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\renavam.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\tituloEleitor.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\index.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\nup17.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\nup17.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\utils.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\judicialProcess.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\utils-randomLetter.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\jest.config.js",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\index.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnh.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cnpj.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\cpf.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\pisPasep.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\postalCode.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\renavam.test.ts",[],"D:\\Desenvolvimento\\Javascript\\Validation-BR\\Lib\\src\\tituloEleitor.test.ts",[]]

package/.eslintignore

@@ -1,2 +0,0 @@
-dist
-node_modules