validation-br 0.5.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/documents/index.js +10 -1
  2. package/package.json +5 -5
  3. package/readme.md +123 -10
package/dist/documents/index.js CHANGED
@@ -6,9 +6,18 @@ var isCNPJ = require('./cnpj');
6
6
 
7
7
  var isTitulo = require('./titulo-eleitor');
8
8
 
9
+ var isPostalCode = require('./postal-code');
10
+
11
+ var isCNH = require('./cnh');
12
+
13
+ var isPIS = require('./pis-pasep');
14
+
9
15
  module.exports = {
10
16
  isCPF: isCPF,
11
17
  isCNPJ: isCNPJ,
12
- isTitulo: isTitulo
18
+ isTitulo: isTitulo,
19
+ isPostalCode: isPostalCode,
20
+ isCNH: isCNH,
21
+ isPIS: isPIS
13
22
  };
14
23
  //# sourceMappingURL=index.js.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "validation-br",
3
3
  "description": "Brazilian personal documents validation - cpf, cnpj, titulo, pis/pasep, cnh",
4
- "version": "0.5.0",
4
+ "version": "0.8.0",
5
5
  "scripts": {
6
6
  "test": "yarn build && cls && node tests | tap-spec",
7
7
  "build": "babel src --source-maps -d dist",
@@ -33,14 +33,14 @@
33
33
  "main": "index.js",
34
34
  "author": "Cláudio Medeiros",
35
35
  "repository": {
36
- "url": "https://github.com/klawdyo/brazilidation"
36
+ "url": "https://github.com/klawdyo/validation-br"
37
37
  },
38
38
  "bugs": {
39
- "url": "https://github.com/klawdyo/brazilidation/issues"
39
+ "url": "https://github.com/klawdyo/validation-br/issues"
40
40
  },
41
- "homepage": "https://github.com/klawdyo/brazilidation#readme",
41
+ "homepage": "https://github.com/klawdyo/validation-br#readme",
42
42
  "keywords": [
43
- "brazilidation",
43
+ "validation-br",
44
44
  "brazilian",
45
45
  "validation",
46
46
  "personal documents",
package/readme.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # validation-br
2
2
 
3
- Biblioteca de validação de documentos pessoais do Brasil com suporte a CPF, CNPJ, Título Eleitoral, PIS/PASEP, CNH, Inscrições Estaduais, Placas de veículos, CEPs e objetos registrados dos correios.
3
+ Biblioteca de validação de documentos pessoais do Brasil com suporte a CPF, CNPJ, Título Eleitoral, PIS/PASEP, CNH, e Objetos registrados de rastreamento dos Correios.
4
4
 
5
5
  ## Instalação
6
6
 
@@ -27,18 +27,18 @@ import { isCPF, isCNPJ } from ('validation-br');
27
27
 
28
28
  ```
29
29
 
30
- ## Métodos
30
+ ## Tabela de Conteúdo
31
31
 
32
- - [isCPF](#CPF) - Validação do CPF
33
- - [isCNPJ](#cnpj) - Validação do CNPJ
34
- - [isTitulo](#titulo) - Validação do Título de Eleitor
35
- - [isCNH](#cnpj) - Validação do CNH
36
- - [isPIS](#cnpj) - Validação do PIS
37
- - [isRegisteredObject](#cnpj) - Validação de Objetos Registrados dos Correios
32
+ - [isCPF](#isCPF) - Validação do CPF
33
+ - [isCNPJ](#isCNPJ) - Validação do CNPJ
34
+ - [isTitulo](#isTitulo) - Validação do Título de Eleitor
35
+ - [isCNH](#isCNH) - Validação do CNH
36
+ - [isPostaCode](#isPostaCode) - Validação de Objetos Registrados dos Correios
37
+ - [isPIS](#isPIS) - Validação de PIS, PASEP, NIS e NIT
38
38
 
39
- ### CPF
39
+ ### isCPF
40
40
 
41
- Descrição
41
+ Valida um CPF
42
42
 
43
43
  ```js
44
44
  // Importação
@@ -57,13 +57,126 @@ isCPF('01234567891')
57
57
  //-> false
58
58
  ```
59
59
 
60
+ ### isCNPJ
61
+
62
+ Valida um CNPJ
63
+
64
+ ```js
65
+ // Importação
66
+ import { isCNPJ } from ('validation-br');
67
+
68
+ // Valida
69
+ isCNPJ('73.797.980/0001-79')
70
+ //-> true
71
+
72
+ // Valida
73
+ isCNPJ('55585709000198')
74
+ //-> true
75
+
76
+ // Valida
77
+ isCNPJ('99362238000180')
78
+ //-> false
79
+ ```
80
+
81
+ ### isTitulo
82
+
83
+ Valida um título eleitoral
84
+
85
+ ```js
86
+ // Importação
87
+ import { isTitulo } from ('validation-br');
88
+
89
+ // Valida
90
+ isTitulo('743650641660')
91
+ //-> true
92
+
93
+ // Valida
94
+ isTitulo('525028881694')
95
+ //-> true
96
+
97
+ // Valida
98
+ isTitulo('153016161686')
99
+ //-> false
100
+ ```
101
+
102
+ ### isCNH
103
+
104
+ Valida o documento da carteira nacional de habilitação.
105
+
106
+ ```js
107
+ // Importação
108
+ import { isCNH } from ('validation-br');
109
+
110
+ // Valida
111
+ isCNH('69044271146')
112
+ //-> true
113
+
114
+ // Valida
115
+ isCNH('62472927637')
116
+ //-> true
117
+
118
+ // Valida
119
+ isCNH('46190476839')
120
+ //-> false
121
+ ```
122
+
123
+ ### isPostaCode
124
+
125
+ Valida um código de rastreamento de objetos postais no formato XX000000000YY, onde:
126
+
127
+ - XX: O código do objeto postal com 2 dígitos;
128
+ - 000000000: Número sequencial do objeto com 9 dígitos;
129
+ - YY: País de origem do objeto com 2 dígitos.
130
+
131
+ ```js
132
+ // Importação
133
+ import { isPostalCode } from ('validation-br');
134
+
135
+ // Valida
136
+ isPostalCode('PN718252423BR')
137
+ //-> true
138
+
139
+ // Valida
140
+ isPostalCode('RY728187035CN')
141
+ //-> true
142
+
143
+ // Valida
144
+ isPostalCode('JT194624698BR')
145
+ //-> false
146
+ ```
147
+
148
+ ### isPIS
149
+
150
+ Valida códigos PIS, PASEP, NIS e NIT, que usam o mesmo algoritmo. Aceita números com e sem pontos e traços.
151
+
152
+ ```js
153
+ // Importação
154
+ import { isPIS } from ('validation-br');
155
+
156
+ // Valida
157
+ isPIS('71282677380')
158
+ //-> true
159
+
160
+ // Valida
161
+ isPIS('237.95126.95-5')
162
+ //-> true
163
+
164
+ // Valida
165
+ isPIS('500.12973.80-1')
166
+ //-> false
167
+ ```
168
+
60
169
  ## Changelog
61
170
 
62
171
  - **16/09/2021**:
63
172
  - 0.5.0 - Adicionadas as funções isCPF, isCNPJ e isTitulo
173
+ - 0.7.0 - Adicionadas as funções isPostalCode e isCNH
174
+ - 0.8.0 - Adicionadas as funções isPIS
64
175
 
65
176
  ## Referências
66
177
 
67
178
  - [Cálculo do DV do CPF](http://clubes.obmep.org.br/blog/a-matematica-nos-documentos-cpf/)
68
179
  - [Cálculo do DV do CNPJ](http://www.macoratti.net/alg_cnpj.htm)
69
180
  - [Cálculo do DV do Título Eleitoral](http://clubes.obmep.org.br/blog/a-matematica-nos-documentos-titulo-de-eleitor/)
181
+ - [Cálculo do PIS](http://www.macoratti.net/alg_pis.htm)
182
+ - [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)