validation-br 1.0.0-c → 1.1.2

package/.eslintcache

@@ -1 +1 @@
-[{"D:\\Desenvolvimento\\Javascript\\Validation-BR\\boilerplate-jest-eslint-ts\\.eslintrc.js":"1"},{"size":2512,"mtime":1641739367275,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1mhu42l","D:\\Desenvolvimento\\Javascript\\Validation-BR\\boilerplate-jest-eslint-ts\\.eslintrc.js",[]]
+[{"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"},{"size":2512,"mtime":1641739367275,"results":"15","hashOfConfig":"16"},{"size":3670,"mtime":1641857909477,"results":"17","hashOfConfig":"18"},{"size":3665,"mtime":1641857909477,"results":"19","hashOfConfig":"18"},{"size":3860,"mtime":1641857909479,"results":"20","hashOfConfig":"18"},{"size":5663,"mtime":1641858240139,"results":"21","hashOfConfig":"18"},{"size":3185,"mtime":1641857909611,"results":"22","hashOfConfig":"18"},{"size":3855,"mtime":1641857909469,"results":"23","hashOfConfig":"18"},{"size":3038,"mtime":1641857909470,"results":"24","hashOfConfig":"18"},{"size":3933,"mtime":1641857909467,"results":"25","hashOfConfig":"18"},{"size":448,"mtime":1641854975529,"results":"26","hashOfConfig":"18"},{"size":3279,"mtime":1641854975529,"results":"27","hashOfConfig":"18"},{"size":4949,"mtime":1641857909475,"results":"28","hashOfConfig":"18"},{"size":5334,"mtime":1641858202329,"results":"29","hashOfConfig":"18"},{"size":3469,"mtime":1641858290806,"results":"30","hashOfConfig":"18"},{"filePath":"31","messages":"32","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1mhu42l",{"filePath":"33","messages":"34","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1oacsom",{"filePath":"35","messages":"36","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"37","messages":"38","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"39","messages":"40","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"41","messages":"42","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"43","messages":"44","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"45","messages":"46","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"47","messages":"48","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"49","messages":"50","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"51","messages":"52","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"53","messages":"54","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"55","messages":"56","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"57","messages":"58","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",[]]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "validation-br",
   "description": "Brazilian personal documents validation - cpf, cnpj, titulo, pis/pasep, cnh, renavam, processos judiciais, protocolo federal, código de rastreamento dos correios",
-  "version": "1.0.0-c",
+  "version": "1.1.2",
   "main": "dist/index.js",
   "types": "./dist/types.d.ts",
   "author": "Cláudio Medeiros <klawdyo@gmail.com>",

package/readme.md

@@ -1,8 +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 e Objetos registrados de Rastreamento dos Correios.
-
-Validation-BR também permite a criação de números fake das numerações acima para fins de teste de desenvolvimento, além de aplicação de máscaras e cálculo do dígito verificador.
+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.
 
 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.
 
@@ -71,6 +69,7 @@ cpf.validateOrFail('01234567890') // -> true
 - [isCNH](#isCNH-value-) - Validação do CNH
 - [isCPF](#isCPF-value-) - Validação do CPF
 - [isCNPJ](#isCNPJ-value-) - Validação do CNPJ
+- [isNUP17](#isNUP17-value-) - Validação de Número Unificado de Protocolo do Governo Federal
 - [isPostalCode](#isPostalCode-value-) - Validação de Objetos Registrados dos Correios
 - [isJudicialProcess](#isJudicialProcess-value-) - Validação de Números de Processos Judiciais
 - [isPIS](#isPIS-value-) - Validação de PIS, PASEP, NIS e NIT
@@ -167,31 +166,86 @@ cpf.dv('012345678') // -> '90'
 
 ### isJudicialProcess( `value` )
 
-Valida códigos PIS, PASEP, NIS e NIT, que usam o mesmo algoritmo. Aceita números com e sem pontos e traços.
+Valida números de processo da esfera judicial. Esta padronização foi adotada em 2010 e de lá para cá todos os processos judiciais abertos no país seguem o mesmo padrão, seja eleitoral, cível, militar etc.
+
+O número é composto por 6 partes:
+
+1. Número sequencial dado pelo órgão de registro, reiniciado a cada ano, com até 7 caracteres
+2. Dígito verificador com 2 caracteres
+3. Ano de registro com 4 caracteres
+4. Órgão do poder judiciário com 1 caractere, sendo eles:
+
+   - 1 - Supremo Tribunal Federal
+   - 2 - Conselho Nacional de Justiça
+   - 3 - Superior Tribunal de Justiça
+   - 4 - Justiça Federal
+   - 5 - Justiça do Trabalho
+   - 6 - Justiça Eleitoral
+   - 7 - Justiça Militar da União
+   - 8 - Justiça dos Estados e do Distrito Federal e Territórios
+   - 9 - Justiça Militar Estadual
+
+5. Tribunal do segmento do poder judiciário com 2 caracteres
+6. Código da unidade de origem do processo com 4 caracteres
 
 ```js
 // Importação somente da validação
 import { isJudicialProcess } from 'validation-br'
 // ou
 // Importação do submódulo
-import judicialProcess from 'validation-br/judicial-process'
+import judicialProcess from 'validation-br/judicialProcess'
+
+// Valida
+isJudicialProcess('20802520125150049') //-> true
+isJudicialProcess('0011006-07.2016.8.20.0100') //-> true
+isJudicialProcess('00110060720168200101') //-> false
+judicialProcess.validate('00110060720168200100') //-> true
+judicialProcess.validateOrFail('00110060720168200100') //-> true
+
+// Número fake com e sem máscara
+judicialProcess.fake() // -> 00110060720168200100
+judicialProcess.fake(true) // -> 0011006-07.2016.8.20.0100
+
+// Aplica uma máscara
+judicialProcess.mask('00110060720168200100') // -> 0011006-07.2016.8.20.0100
+
+// Calcula o DV.
+// Obs.: Antes do cálculo, é necessário que o número do processo não possua o dígito verificador para que o resultado seja correto. Isso é necessário pois o DV fica no meio da numeração, na posição 8 e 9.
+judicialProcess.dv('001100620168200100') // -> '07'
+```
+
+### isNUP17( `value` )
+
+Válida um Número Unificado de Protocolo de 17 dígitos. Esta numeração é usada pelo Governo Federal como forma única de numerar processos em todas os órgãos do executivo.
+
+1. Os primeiros 5 dígitos correspondem código do órgão
+2. Os dígitos de 6 a 11 são um número sequencial dado pelo órgão em questão e é reiniciado a cada ano
+3. Os dígitos 12 a 15 representam o ano de registro do protocolo
+4. Os caracteres 16 a 17 são o dígito verificador
+
+```js
+// Importação somente da validação
+import { isNUP17 } from 'validation-br'
+// ou
+// Importação do submódulo
+import nup from 'validation-br/nup17'
 
 // Valida
-isJudicialProcess('71282677380') //-> true
-isJudicialProcess('237.95126.95-5') //-> true
-isJudicialProcess('500.12973.80-1') //-> false
-judicialProcess.validate('71282677380') //-> true
-judicialProcess.validateOrFail('71282677380') //-> true
+isNUP17('23037001462202165') //-> true
+isNUP17('23037.001462/2021-65') //-> true
+isNUP17('23037.001462/2021-66') //-> false
+nup.validate('23037.001462/2021-65') //-> true
+nup.validateOrFail('23037.001462/2021-65') //-> true
 
 // Número fake com e sem máscara
-judicialProcess.fake() // -> 71282677380
-judicialProcess.fake(true) // -> 712.82677.38-0
+nup.fake() // -> 71282677380
+nup.fake(true) // -> 712.82677.38-0
 
 // Aplica uma máscara
-judicialProcess.mask('71282677380') // -> 712.82677.38-0
+nup.mask('23037001462202165') // -> 23037.001462/2021-65
 
 // Calcula o DV
-judicialProcess.dv('7128267738') // -> '0'
+nup.dv('230370014622021') // -> '65'
 ```
 
 ### isPIS( `value` )
@@ -237,7 +291,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 postalCode from 'validation-br/postal-code'
+import postalCode from 'validation-br/postalCode'
 
 // Valida
 isPostalCode('PN718252423BR') //-> true
@@ -296,7 +350,7 @@ Valida um título eleitoral
 import { isTituloEleitor } from 'validation-br'
 // ou
 // Importação do submódulo
-import titulo from 'validation-br/titulo'
+import titulo from 'validation-br/tituloEleitor'
 
 // Valida
 isTituloEleitor('743650641660') //-> true
@@ -316,12 +370,14 @@ titulo.mask('525028881694') // -> 5250.2888.1694
 titulo.dv('5250288816') // -> '94'
 ```
 
-# Tests
+# Testes
 
-![image](https://user-images.githubusercontent.com/100168/148705528-7c810b3c-851a-49c4-bc08-f9631498d526.png)
+![Testes](https://user-images.githubusercontent.com/100168/148857050-df40e291-a13d-4643-b64d-6603cf0a06f1.png)
 
 # Changelog
 
+- **10/01/2022**:
+  - 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
 - **08/01/2022**:
@@ -340,3 +396,4 @@ titulo.dv('5250288816') // -> '94'
 - [Diferença entre PIS, PASEP, NIS e NIT](https://www.jornalcontabil.com.br/entenda-de-uma-vez-a-diferenca-entre-pis-pasep-nit-e-nis/#:~:text=NIS%20%E2%80%93%20N%C3%BAmero%20de%20Identifica%C3%A7%C3%A3o%20Social,do%20Patrim%C3%B4nio%20do%20Servidor%20P%C3%BAblico)
 - [Documentação Oficial de Numeração de Processos Judiciais](https://juslaboris.tst.jus.br/bitstream/handle/20.500.12178/30318/2008_res0065_cnj_rep01.pdf?sequence=2)
 - [Cálculos de DV](http://ghiorzi.org/DVnew.htm)
+- [Cálculo do NUP17](https://www.gov.br/compras/pt-br/acesso-a-informacao/legislacao/portarias/portaria-interministerial-no-11-de-25-de-novembro-de-2019)