validation-br 1.4.2 → 1.4.5

package/dist/utils.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.randomLetter = exports.applyMask = exports.removeFromPosition = exports.insertAtPosition = exports.clearValue = exports.fakeNumber = exports.sumElementsByMultipliers = exports.invalidListGenerator = exports.sumToDV = void 0;
+const ValidationBRError_1 = __importDefault(require("./data/ValidationBRError"));
 /**
  * Calcula o DV verificador a partir das regras do MOD11:
  * O valor da soma é dividido por 11. O resultado é o resto da divisão. Caso o resto seja
@@ -84,11 +88,28 @@ exports.fakeNumber = fakeNumber;
  * @param {Number} length Tamanho exato. Se for null, só retira os caracteres não-numéricos
  * @returns {String} Número com o tamanho exato
  */
-function clearValue(value, length = null) {
-    const clearedValue = String(value).replace(/([/.-]+)/gi, '');
-    if (!length || clearedValue.length === length)
-        return clearedValue;
-    return clearedValue.padStart(length, '0').substring(0, length);
+function clearValue(value, length = null, options) {
+    let clearedValue = String(value).replace(/([/.-]+)/gi, '');
+    if (options) {
+        if (options.rejectEmpty === true && clearedValue.length === 0) {
+            throw ValidationBRError_1.default.EMPTY_VALUE;
+        }
+        if (options.rejectHigherLength === true && length && clearedValue.length > length) {
+            throw ValidationBRError_1.default.MAX_LEN_EXCEDEED;
+        }
+        if (options.rejectEqualSequence === true && length) {
+            const invalidList = invalidListGenerator(length);
+            if (invalidList.includes(clearedValue)) {
+                throw ValidationBRError_1.default.SEQUENCE_REPEATED;
+            }
+        }
+        // if (!length || clearedValue.length === length) return clearedValue
+        if (length && options.fillZerosAtLeft)
+            clearedValue = clearedValue.padStart(length, '0');
+        if (length && options.trimAtRight)
+            clearedValue = clearedValue.substring(0, length);
+    }
+    return clearedValue;
 }
 exports.clearValue = clearValue;
 /**
@@ -142,7 +163,7 @@ exports.removeFromPosition = removeFromPosition;
  */
 function applyMask(value, mask) {
     const maskLen = clearValue(mask).length;
-    let masked = clearValue(value, maskLen);
+    let masked = clearValue(value, maskLen, { fillZerosAtLeft: true, trimAtRight: true });
     const specialChars = ['/', '-', '.', '(', ')', ' '];
     for (let position = 0; position < mask.length; position += 1) {
         const current = mask[position];

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AAC3C,CAAC;AAFD,0BAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,oDAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CAAC,KAAa,EAAE,UAA6B;IACnF,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3F,OAAO,UAAU,CAAC,MAAM,CACtB,CAAC,IAAY,EAAE,IAAS,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAC7E,CAAC,CACF,CAAA;AACH,CAAC;AAPD,4DAOC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,MAAc,EAAE,cAAuB,KAAK;IACrE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,CAAA;IAEtD,IAAI,WAAW;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE3D,OAAO,CAAC,KAAK,CAAA;AACf,CAAC;AAND,gCAMC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,UAAU,CAAC,KAAsB,EAAE,SAAwB,IAAI;IAC7E,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;IAE5D,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,KAAK,MAAM;QAAE,OAAO,YAAY,CAAA;IAElE,OAAO,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;AAChE,CAAC;AAND,gCAMC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,gBAAgB,CAAC,KAAa,EAAE,WAAmB,EAAE,QAAgB;IACnF,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAA;AACpF,CAAC;AAFD,4CAEC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAChC,KAAa,EACb,aAAqB,EACrB,WAAmB;IAEnB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAC3E,CAAC;AAND,gDAMC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAC,KAAsB,EAAE,IAAY;IAC5D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;IACvC,IAAI,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACvC,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAEnD,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,EAAE;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9B,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;KACzF;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAXD,8BAWC;AAED;;;;;;;;;GASG;AACH,SAAgB,YAAY;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;IAC9C,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AACtC,CAAC;AAHD,oCAGC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,iFAAwD;AAExD;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AAC3C,CAAC;AAFD,0BAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,oDAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CAAC,KAAa,EAAE,UAA6B;IACnF,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3F,OAAO,UAAU,CAAC,MAAM,CACtB,CAAC,IAAY,EAAE,IAAS,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAC7E,CAAC,CACF,CAAA;AACH,CAAC;AAPD,4DAOC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,MAAc,EAAE,cAAuB,KAAK;IACrE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,CAAA;IAEtD,IAAI,WAAW;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE3D,OAAO,CAAC,KAAK,CAAA;AACf,CAAC;AAND,gCAMC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,UAAU,CACxB,KAAsB,EACtB,SAAwB,IAAI,EAC5B,OAA2B;IAE3B,IAAI,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;IAE1D,IAAI,OAAO,EAAE;QACX,IAAI,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7D,MAAM,2BAAiB,CAAC,WAAW,CAAA;SACpC;QAED,IAAI,OAAO,CAAC,kBAAkB,KAAK,IAAI,IAAI,MAAM,IAAI,YAAY,CAAC,MAAM,GAAG,MAAM,EAAE;YACjF,MAAM,2BAAiB,CAAC,gBAAgB,CAAA;SACzC;QAED,IAAI,OAAO,CAAC,mBAAmB,KAAK,IAAI,IAAI,MAAM,EAAE;YAClD,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAA;YAChD,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;gBACtC,MAAM,2BAAiB,CAAC,iBAAiB,CAAA;aAC1C;SACF;QAED,qEAAqE;QAErE,IAAI,MAAM,IAAI,OAAO,CAAC,eAAe;YAAE,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACxF,IAAI,MAAM,IAAI,OAAO,CAAC,WAAW;YAAE,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;KACpF;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AA9BD,gCA8BC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,gBAAgB,CAAC,KAAa,EAAE,WAAmB,EAAE,QAAgB;IACnF,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAA;AACpF,CAAC;AAFD,4CAEC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAChC,KAAa,EACb,aAAqB,EACrB,WAAmB;IAEnB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAC3E,CAAC;AAND,gDAMC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAC,KAAsB,EAAE,IAAY;IAC5D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;IACvC,IAAI,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAA;IACrF,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAEnD,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC,EAAE;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9B,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;KACzF;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAXD,8BAWC;AAED;;;;;;;;;GASG;AACH,SAAgB,YAAY;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;IAC9C,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;AACtC,CAAC;AAHD,oCAGC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "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.4.2",
+  "version": "1.4.5",
   "main": "dist/index.js",
-  "types": "./dist/types.d.ts",
+  "types": "./dist/index.d.ts",
   "author": "Cláudio Medeiros <klawdyo@gmail.com>",
   "license": "MIT",
   "scripts": {

package/readme.md

@@ -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
@@ -132,7 +131,7 @@ Valida um CNPJ
 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'
 
@@ -163,7 +162,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 +213,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 +250,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 +281,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 +317,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 +349,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 +380,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,10 +406,23 @@ titulo.dv('5250288816') // -> '94'
 
 Todos os testes passando com 100% de cobertura
 
-![Testes](https://user-images.githubusercontent.com/100168/193415244-22fea27a-2a50-42bc-ab71-d21fdc7e465b.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 12, 14, 16, 18 e 20 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
 
+- **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

package/tsconfig.json

@@ -20,5 +20,6 @@
       "*": ["node_modules/*"]
     }
   },
+  "exclude": ["./tsconfig.json"],
   "include": ["./src/**/*"]
 }