validation-br 1.0.0-b → 1.2.0-rc2

package/{src/cpf.ts → dist/cpf.d.ts}

@@ -1,150 +1,99 @@
-/**
- * isCPF()
- * Calcula se um CPF é válido
- *
- * @doc
- * CPF deve possuir 11 dígitos.
- *
- * - Os caracteres 1 a 8 são números sequenciais definidos pela Receita Federal
- *
- * - O caractere 9 refere-se à região fiscal emissora do documento
- *    1 – DF, GO, MS, MT e TO
- *    2 – AC, AM, AP, PA, RO e RR
- *    3 – CE, MA e PI
- *    4 – AL, PB, PE, RN
- *    5 – BA e SE
- *    6 – MG
- *    7 – ES e RJ
- *    8 – SP
- *    9 – PR e SC
- *    0 – RS
- *
- * - Os caracteres 10 e 11 são dígitos verificadores.
- *
- * 1) Partes do número
- * ------------------------------------------------
- * | Número                       | R |  DV  |
- *  2   8   0 . 0   1   2 . 3   8   9 - 3   8
- *
- * 2) Cálculo do primeiro DV.
- *
- *  - Soma-se o produto das algarismos 1 a 9 pelos números 10, 9, 8, 7, 6, 5, 4, 3, 2
- *
- *    2   8   0   0   1   2   3   8   9
- *    x   x   x   x   x   x   x   x   x
- *   10   9   8   7   6   5   4   3   2
- * = 20 +72  +0  +0  +6 +10 +12 +24 +18 = 162
- *
- *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
- *    162 / 11 tem resto 8. 11 - 8 = 3. DV1 é 3.
- *    Obs.: Caso o cálculo de DV1 retorne 10, o resultado será 0.
- *
- * 3) Cálculo do segundo DV.
- *
- *  - Soma-se o produto das algarismos 1 a 10 pelos números 11, 10, 9, 8, 7, 6, 5, 4, 3, 2
- *
- *    2   8   0   0   1   2   3   8   9   3
- *    x   x   x   x   x   x   x   x   x   x
- *   11  10   9   8   7   6   5   4   3   2
- * = 22 +80  +0  +0  +7 +12 +15 +32 +27 = 201
- *
- *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
- *    201 / 11 tem resto 3. 11 - 3 = 8. DV2 é 8.
- *    Obs.: Caso o cálculo de DV2 retorne 10, o resultado será 0.
- *
- * Fonte: http://clubes.obmep.org.br/blog/a-matematica-nos-documentos-cpf/
- *
- * @param {String} value Título eleitoral
- * @returns {Boolean}
- */
-
-import {
-  invalidListGenerator,
-  sumElementsByMultipliers,
-  sumToDV,
-  clearValue,
-  fakeNumber,
-  applyMask,
-} from './utils'
-
-/**
- * dv()
- * Calcula o dígito verificador de um CPF
- *
- * @param {Number|String} value
- * @returns {String}
- */
-export const dv = (value: string | number): string => {
-  if (!value) throw new Error('CPF não informado')
-
-  const cpf = clearValue(value, 9)
-
-  const invalidList = invalidListGenerator(9)
-  if (invalidList.includes(cpf)) {
-    throw new Error('CPF não pode ser uma sequência de números iguais')
-  }
-
-  const sum1 = sumElementsByMultipliers(cpf, [10, 9, 8, 7, 6, 5, 4, 3, 2])
-  const dv1 = sumToDV(sum1)
-
-  const sum2 = sumElementsByMultipliers(cpf + dv1, [11, 10, 9, 8, 7, 6, 5, 4, 3, 2])
-  const dv2 = sumToDV(sum2)
-
-  return `${dv1}${dv2}`
-}
-
-/**
- * Aplica uma máscara ao número informado
- *
- * @param {String} value Número de Processo
- * @returns {String} Valor com a máscara
- */
-export const mask = (value: string | number): string => applyMask(value, '000.000.000-00')
-
-/**
- * fake()
- * Gera um número válido
- *
- * @returns {String}
- */
-export const fake = (withMask: boolean = false): string => {
-  const num = fakeNumber(9, true)
-
-  const cpf = `${num}${dv(num)}`
-
-  if (withMask) return mask(cpf)
-  return cpf
-}
-
-/**
- * validateOrFail()
- * Valida se um número de processo está correto e
- * retorna uma exceção se não estiver
- *
- * @returns {Boolean}
- */
-export const validateOrFail = (value: string | number): boolean => {
-  const cpf = clearValue(value, 11)
-
-  if (dv(cpf) !== cpf.substring(9, 11)) {
-    throw new Error('Dígito verificador inválido')
-  }
-
-  return true
-}
-
-/**
- * validate()
- * Valida se um número de processo está correto
- *
- * @returns {Boolean}
- */
-export const validate = (value: string | number): boolean => {
-  try {
-    return validateOrFail(value)
-  } catch (error) {
-    return false
-  }
-}
-
-export default validate
+/**
+ * isCPF()
+ * Calcula se um CPF é válido
+ *
+ * @doc
+ * CPF deve possuir 11 dígitos.
+ *
+ * - Os caracteres 1 a 8 são números sequenciais definidos pela Receita Federal
+ *
+ * - O caractere 9 refere-se à região fiscal emissora do documento
+ *    1 – DF, GO, MS, MT e TO
+ *    2 – AC, AM, AP, PA, RO e RR
+ *    3 – CE, MA e PI
+ *    4 – AL, PB, PE, RN
+ *    5 – BA e SE
+ *    6 – MG
+ *    7 – ES e RJ
+ *    8 – SP
+ *    9 – PR e SC
+ *    0 – RS
+ *
+ * - Os caracteres 10 e 11 são dígitos verificadores.
+ *
+ * 1) Partes do número
+ * ------------------------------------------------
+ * | Número                       | R |  DV  |
+ *  2   8   0 . 0   1   2 . 3   8   9 - 3   8
+ *
+ * 2) Cálculo do primeiro DV.
+ *
+ *  - Soma-se o produto das algarismos 1 a 9 pelos números 10, 9, 8, 7, 6, 5, 4, 3, 2
+ *
+ *    2   8   0   0   1   2   3   8   9
+ *    x   x   x   x   x   x   x   x   x
+ *   10   9   8   7   6   5   4   3   2
+ * = 20 +72  +0  +0  +6 +10 +12 +24 +18 = 162
+ *
+ *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
+ *    162 / 11 tem resto 8. 11 - 8 = 3. DV1 é 3.
+ *    Obs.: Caso o cálculo de DV1 retorne 10, o resultado será 0.
+ *
+ * 3) Cálculo do segundo DV.
+ *
+ *  - Soma-se o produto das algarismos 1 a 10 pelos números 11, 10, 9, 8, 7, 6, 5, 4, 3, 2
+ *
+ *    2   8   0   0   1   2   3   8   9   3
+ *    x   x   x   x   x   x   x   x   x   x
+ *   11  10   9   8   7   6   5   4   3   2
+ * = 22 +80  +0  +0  +7 +12 +15 +32 +27 = 201
+ *
+ *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
+ *    201 / 11 tem resto 3. 11 - 3 = 8. DV2 é 8.
+ *    Obs.: Caso o cálculo de DV2 retorne 10, o resultado será 0.
+ *
+ * Fonte: http://clubes.obmep.org.br/blog/a-matematica-nos-documentos-cpf/
+ *
+ * @param {String} value Título eleitoral
+ * @returns {Boolean}
+ */
+/**
+ * dv()
+ * Calcula o dígito verificador
+ *
+ * @param {Number|String} value
+ * @returns {String}
+ */
+export declare const dv: (value: string | number) => string;
+/**
+ * Aplica uma máscara ao número informado
+ *
+ * @param {String} value Número de Processo
+ * @returns {String} Valor com a máscara
+ */
+export declare const mask: (value: string | number) => string;
+/**
+ * fake()
+ * Gera um número válido
+ *
+ * @returns {String}
+ */
+export declare const fake: (withMask?: boolean) => string;
+/**
+ * validateOrFail()
+ * Valida se um número é válido e
+ * retorna uma exceção se não estiver
+ *
+ * @param {String|Number} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validateOrFail: (value: string | number) => boolean;
+/**
+ * validate()
+ * Valida se um número é válido
+ *
+ * @param {String|Number} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validate: (value: string | number) => boolean;
+export default validate;

package/dist/cpf.js

@@ -63,18 +63,18 @@ exports.validate = exports.validateOrFail = exports.fake = exports.mask = export
 const utils_1 = require("./utils");
 /**
  * dv()
- * Calcula o dígito verificador de um CPF
+ * Calcula o dígito verificador
  *
  * @param {Number|String} value
  * @returns {String}
  */
 exports.dv = (value) => {
     if (!value)
-        throw new Error('CPF não informado');
+        throw new Error('Número não informado');
     const cpf = utils_1.clearValue(value, 9);
     const invalidList = utils_1.invalidListGenerator(9);
     if (invalidList.includes(cpf)) {
-        throw new Error('CPF não pode ser uma sequência de números iguais');
+        throw new Error('Número não pode ser uma sequência de números iguais');
     }
     const sum1 = utils_1.sumElementsByMultipliers(cpf, [10, 9, 8, 7, 6, 5, 4, 3, 2]);
     const dv1 = utils_1.sumToDV(sum1);
@@ -104,9 +104,10 @@ exports.fake = (withMask = false) => {
 };
 /**
  * validateOrFail()
- * Valida se um número de processo está correto e
+ * Valida se um número é válido e
  * retorna uma exceção se não estiver
  *
+ * @param {String|Number} value Número a ser validado
  * @returns {Boolean}
  */
 exports.validateOrFail = (value) => {
@@ -118,8 +119,9 @@ exports.validateOrFail = (value) => {
 };
 /**
  * validate()
- * Valida se um número de processo está correto
+ * Valida se um número é válido
  *
+ * @param {String|Number} value Número a ser validado
  * @returns {Boolean}
  */
 exports.validate = (value) => {

package/dist/cpf.js.map

@@ -1 +1 @@
-{"version":3,"file":"cpf.js","sourceRoot":"","sources":["../src/cpf.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;;;AAEH,mCAOgB;AAEhB;;;;;;GAMG;AACU,QAAA,EAAE,GAAG,CAAC,KAAsB,EAAU,EAAE;IACnD,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAEhD,MAAM,GAAG,GAAG,kBAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAEhC,MAAM,WAAW,GAAG,4BAAoB,CAAC,CAAC,CAAC,CAAA;IAC3C,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;KACpE;IAED,MAAM,IAAI,GAAG,gCAAwB,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACxE,MAAM,GAAG,GAAG,eAAO,CAAC,IAAI,CAAC,CAAA;IAEzB,MAAM,IAAI,GAAG,gCAAwB,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAClF,MAAM,GAAG,GAAG,eAAO,CAAC,IAAI,CAAC,CAAA;IAEzB,OAAO,GAAG,GAAG,GAAG,GAAG,EAAE,CAAA;AACvB,CAAC,CAAA;AAED;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,KAAsB,EAAU,EAAE,CAAC,iBAAS,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;AAE1F;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,WAAoB,KAAK,EAAU,EAAE;IACxD,MAAM,GAAG,GAAG,kBAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAE/B,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,UAAE,CAAC,GAAG,CAAC,EAAE,CAAA;IAE9B,IAAI,QAAQ;QAAE,OAAO,YAAI,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;;;;GAMG;AACU,QAAA,cAAc,GAAG,CAAC,KAAsB,EAAW,EAAE;IAChE,MAAM,GAAG,GAAG,kBAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IAEjC,IAAI,UAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;KAC/C;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,CAAC,KAAsB,EAAW,EAAE;IAC1D,IAAI;QACF,OAAO,sBAAc,CAAC,KAAK,CAAC,CAAA;KAC7B;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,kBAAe,gBAAQ,CAAA"}
+{"version":3,"file":"cpf.js","sourceRoot":"","sources":["../src/cpf.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;;;AAEH,mCAOgB;AAEhB;;;;;;GAMG;AACU,QAAA,EAAE,GAAG,CAAC,KAAsB,EAAU,EAAE;IACnD,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IAEnD,MAAM,GAAG,GAAG,kBAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAEhC,MAAM,WAAW,GAAG,4BAAoB,CAAC,CAAC,CAAC,CAAA;IAC3C,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;KACvE;IAED,MAAM,IAAI,GAAG,gCAAwB,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACxE,MAAM,GAAG,GAAG,eAAO,CAAC,IAAI,CAAC,CAAA;IAEzB,MAAM,IAAI,GAAG,gCAAwB,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAClF,MAAM,GAAG,GAAG,eAAO,CAAC,IAAI,CAAC,CAAA;IAEzB,OAAO,GAAG,GAAG,GAAG,GAAG,EAAE,CAAA;AACvB,CAAC,CAAA;AAED;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,KAAsB,EAAU,EAAE,CAAC,iBAAS,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;AAE1F;;;;;GAKG;AACU,QAAA,IAAI,GAAG,CAAC,WAAoB,KAAK,EAAU,EAAE;IACxD,MAAM,GAAG,GAAG,kBAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAE/B,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,UAAE,CAAC,GAAG,CAAC,EAAE,CAAA;IAE9B,IAAI,QAAQ;QAAE,OAAO,YAAI,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;;;;;GAOG;AACU,QAAA,cAAc,GAAG,CAAC,KAAsB,EAAW,EAAE;IAChE,MAAM,GAAG,GAAG,kBAAU,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IAEjC,IAAI,UAAE,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;KAC/C;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;;GAMG;AACU,QAAA,QAAQ,GAAG,CAAC,KAAsB,EAAW,EAAE;IAC1D,IAAI;QACF,OAAO,sBAAc,CAAC,KAAK,CAAC,CAAA;KAC7B;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAA;KACb;AACH,CAAC,CAAA;AAED,kBAAe,gBAAQ,CAAA"}

package/dist/cpf.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    isCNH: (value: string | number) => boolean;
+    isCNPJ: (value: string | number) => boolean;
+    isCPF: (value: string | number) => boolean;
+    isJudicialProcess: (value: string) => boolean;
+    isPIS: (value: string | number) => boolean;
+    isPostalCode: (value: string) => boolean;
+    isRenavam: (value: string | number) => boolean;
+    isTituloEleitor: (value: string | number) => boolean;
+    isNUP17: (value: string) => boolean;
+};
+export default _default;

package/dist/index.js

@@ -7,6 +7,7 @@ const cnh_1 = __importDefault(require("./cnh"));
 const cnpj_1 = __importDefault(require("./cnpj"));
 const cpf_1 = __importDefault(require("./cpf"));
 const judicialProcess_1 = __importDefault(require("./judicialProcess"));
+const nup17_1 = __importDefault(require("./nup17"));
 const pisPasep_1 = __importDefault(require("./pisPasep"));
 const postalCode_1 = __importDefault(require("./postalCode"));
 const renavam_1 = __importDefault(require("./renavam"));
@@ -20,5 +21,6 @@ exports.default = {
     isPostalCode: postalCode_1.default,
     isRenavam: renavam_1.default,
     isTituloEleitor: tituloEleitor_1.default,
+    isNUP17: nup17_1.default,
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,gDAAyB;AACzB,kDAA2B;AAC3B,gDAAyB;AACzB,wEAAiD;AACjD,0DAA8B;AAC9B,8DAAuC;AACvC,wDAAiC;AACjC,oEAA6C;AAE7C,kBAAe;IACb,KAAK,EAAL,aAAK;IACL,MAAM,EAAN,cAAM;IACN,KAAK,EAAL,aAAK;IACL,iBAAiB,EAAjB,yBAAiB;IACjB,KAAK,EAAL,kBAAK;IACL,YAAY,EAAZ,oBAAY;IACZ,SAAS,EAAT,iBAAS;IACT,eAAe,EAAf,uBAAe;CAChB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,gDAAyB;AACzB,kDAA2B;AAC3B,gDAAyB;AACzB,wEAAiD;AACjD,oDAA6B;AAC7B,0DAA8B;AAC9B,8DAAuC;AACvC,wDAAiC;AACjC,oEAA6C;AAE7C,kBAAe;IACb,KAAK,EAAL,aAAK;IACL,MAAM,EAAN,cAAM;IACN,KAAK,EAAL,aAAK;IACL,iBAAiB,EAAjB,yBAAiB;IACjB,KAAK,EAAL,kBAAK;IACL,YAAY,EAAZ,oBAAY;IACZ,SAAS,EAAT,iBAAS;IACT,eAAe,EAAf,uBAAe;IACf,OAAO,EAAP,eAAO;CACR,CAAA"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/{src/judicialProcess.ts → dist/judicialProcess.d.ts}

@@ -1,167 +1,114 @@
-/**
- * judicialProcess
- * Valida, mascara e cria números de processos judiciais
- *
- * @link
- * https://juslaboris.tst.jus.br/bitstream/handle/20.500.12178/30318/2008_res0065_cnj_rep01.pdf?sequence=2
- * http://ghiorzi.org/DVnew.htm#f
- *
- * @doc
- * Os  números de processos judiciais são usados a partir de 2010 para unificar a
- * numeração de processos no Brasil e são usados em todos os tribunais.
- *
- * O número do processo, sem os caracteres especiais, devem possuir até 20 números
- * e deve seguir o padrão abaixo:
- *
- * 1) Partes do número
- *  0002080-25.2012.5.15.0049
- *  NNNNNNN-DD.AAAA.J.TR.OOOO
- * |______|__|____|_|__|____|
- *    |    |   |  | |   |----> Unidade de origem do processo com 4 caracteres
- *    |    |   |  | |--------> TR=Tribunal do segmento do poder judiciário com 2 caracteres
- *    |    |   |  |----------> J=Órgão do poder Judiciário com 1 caractere
- *    |    |   |-------------> Ano do ajuizamento do processo com 4 caracteres
- *    |    |-----------------> Dígito verificador com 2 caracteres
- *    |----------------------> Número sequencial do Processo, por unidade de
- *                             origem, reiniciado anualmente com 7 caracteres
- *
- * Órgãos do Poder Judiciário
- * 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
- *
- *
- * 2) Dígito Verificador
- *
- * O algoritmo usado para o cálculo do DV chama-se Módulo 97 de Base 10 (ISO 7064).
- *
- * Nota: O número do processo possui 20 caracteres e ultrapassa o tamanho máximo
- * do inteiro em javascript, impedindo que façamos o cálculo diretamente, desta
- * forma, será nacessária uma fatoração para que o resultado seja o correto.
- *
- * 2.1) Cálculo do DV
- * - Caso o DV seja conhecido, ele precisa ser removido do número e colocado
- * como "00" ao final. Caso não esteja incluso no número, adicione '00' ao final.
- *
- * Ex.: O processo "00020802520125150049", cujo dv é "25", será calculado como
- * "000208020125150049" e receberá "00" ao final. O número usado para o cálculo
- * do DV será "00020802012515004900"
- *
- * 2.2) Etapas de Cálculo
- *
- * 00020802012515004900
- *                   ↓↓
- *                   DV ao final como "00"
- *
- * - Aplicamos o MOD 97 aos caracteres de 0 a 7 para calcular a primeira parte
- * part1 = 0002080 % 97 = 43
- *
- * - Concatenamos part1 ao ano, órgão do poder judiciário e tribunal e aplicamos o MOD 97
- * para obtermos o valor da part2
- * part2 = ( part1 +''+ 2012 +''+ 5 +''+ 15 ) % 97 = 26
- *
- * - Concatemos part2 ao código do órgão de origem e ao "00" do final e aplicamos
- * o MOD 97 ao resultado
- * part3 = ( part2 + '0049' + '00') % 97 = 73
- *
- * - Subtraímos o resultado de 98
- * dv = 98 - 73 = 25
- *
- * O Dígito verificador é 25 e deve ser aplicado após o 7º caractere do número do processo
- *
- * Fonte: https://juslaboris.tst.jus.br/bitstream/handle/20.500.12178/30318/2008_res0065_cnj_rep01.pdf?sequence=2
- */
-
-import { clearValue, fakeNumber, applyMask, insertAtPosition, removeFromPosition } from './utils'
-
-/**
- *
- *
- */
-export const dv = (value: string): string => {
-  if (!value) throw new Error('Número do processo é obrigatório')
-  // if (typeof value !== 'string') throw new Error('Número do processo precisa ser string')
-
-  const judicialProcess = clearValue(value, 18)
-
-  const num = judicialProcess.substring(0, 7)
-  const yearAndCourt = judicialProcess.substring(7, 14)
-  const origin = judicialProcess.substring(14, 18)
-
-  return String(
-    98 - (Number(`${Number(`${Number(num) % 97}${yearAndCourt}`) % 97}${origin}00`) % 97),
-  ).padStart(2, '0')
-}
-
-/**
- * Aplica uma máscara ao número informado
- *
- * @param {String} value Número de Processo
- * @returns {String} Valor com a máscara
- */
-export const mask = (value: string | number): string =>
-  applyMask(value, '0000000-00.0000.0.00.0000')
-
-/**
- *
- *
- */
-export const fake = (withMask: boolean = false): string => {
-  const num = fakeNumber(7, true)
-  const year = new Date().getFullYear() - +fakeNumber(1)
-
-  const courte1 = fakeNumber(1, true) // Não pode ser '0'
-  const courte2 = fakeNumber(2, true)
-  const courte = `${courte1 === '0' || courte1 === '10' ? '1' : courte1}${courte2}`
-
-  const origin = fakeNumber(4, true)
-
-  const judicialProcess = `${num}${year}${courte}${origin}`
-  const digits = dv(judicialProcess)
-
-  const finalNumber = insertAtPosition(judicialProcess, digits, 7)
-
-  if (withMask) return mask(finalNumber)
-  return finalNumber
-}
-
-/**
- * validate()
- * Valida se um número de processo está correto
- *
- */
-export const validateOrFail = (value: string | number): boolean => {
-  const judicialProcess = clearValue(value, 20)
-  const processWithoutDV = removeFromPosition(judicialProcess, 7, 9)
-
-  if (processWithoutDV.substring(11, 12) === '0') {
-    throw new Error('Código do Órgão Judiciário não pode ser "0"')
-  }
-
-  if (dv(processWithoutDV) !== judicialProcess.substring(7, 9)) {
-    throw new Error('Dígito verificador inválido')
-  }
-
-  return true
-}
-
-/**
- * validate()
- * Valida se um número de processo está correto
- *
- */
-export const validate = (value: string | number): boolean => {
-  try {
-    return validateOrFail(value)
-  } catch (error) {
-    return false
-  }
-}
-
-export default validate
+/**
+ * judicialProcess
+ * Valida, mascara e cria números de processos judiciais
+ *
+ * @link
+ * https://juslaboris.tst.jus.br/bitstream/handle/20.500.12178/30318/2008_res0065_cnj_rep01.pdf?sequence=2
+ * http://ghiorzi.org/DVnew.htm#f
+ *
+ * @doc
+ * Os  números de processos judiciais são usados a partir de 2010 para unificar a
+ * numeração de processos no Brasil e são usados em todos os tribunais.
+ *
+ * O número do processo, sem os caracteres especiais, devem possuir até 20 números
+ * e deve seguir o padrão abaixo:
+ *
+ * 1) Partes do número
+ *  0002080-25.2012.5.15.0049
+ *  NNNNNNN-DD.AAAA.J.TR.OOOO
+ * |______|__|____|_|__|____|
+ *    |    |   |  | |   |----> Unidade de origem do processo com 4 caracteres
+ *    |    |   |  | |--------> TR=Tribunal do segmento do poder judiciário com 2 caracteres
+ *    |    |   |  |----------> J=Órgão do poder Judiciário com 1 caractere
+ *    |    |   |-------------> Ano do ajuizamento do processo com 4 caracteres
+ *    |    |-----------------> Dígito verificador com 2 caracteres
+ *    |----------------------> Número sequencial do Processo, por unidade de
+ *                             origem, reiniciado anualmente com 7 caracteres
+ *
+ * Órgãos do Poder Judiciário
+ * 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
+ *
+ *
+ * 2) Dígito Verificador
+ *
+ * O algoritmo usado para o cálculo do DV chama-se Módulo 97 de Base 10 (ISO 7064).
+ *
+ * Nota: O número do processo possui 20 caracteres e ultrapassa o tamanho máximo
+ * do inteiro em javascript, impedindo que façamos o cálculo diretamente, desta
+ * forma, será nacessária uma fatoração para que o resultado seja o correto.
+ *
+ * 2.1) Cálculo do DV
+ * - Caso o DV seja conhecido, ele precisa ser removido do número e colocado
+ * como "00" ao final. Caso não esteja incluso no número, adicione '00' ao final.
+ *
+ * Ex.: O processo "00020802520125150049", cujo dv é "25", será calculado como
+ * "000208020125150049" e receberá "00" ao final. O número usado para o cálculo
+ * do DV será "00020802012515004900"
+ *
+ * 2.2) Etapas de Cálculo
+ *
+ * 00020802012515004900
+ *                   ↓↓
+ *                   DV ao final como "00"
+ *
+ * - Aplicamos o MOD 97 aos caracteres de 0 a 7 para calcular a primeira parte
+ * part1 = 0002080 % 97 = 43
+ *
+ * - Concatenamos part1 ao ano, órgão do poder judiciário e tribunal e aplicamos o MOD 97
+ * para obtermos o valor da part2
+ * part2 = ( part1 +''+ 2012 +''+ 5 +''+ 15 ) % 97 = 26
+ *
+ * - Concatemos part2 ao código do órgão de origem e ao "00" do final e aplicamos
+ * o MOD 97 ao resultado
+ * part3 = ( part2 + '0049' + '00') % 97 = 73
+ *
+ * - Subtraímos o resultado de 98
+ * dv = 98 - 73 = 25
+ *
+ * O Dígito verificador é 25 e deve ser aplicado após o 7º caractere do número do processo
+ *
+ * Fonte: https://juslaboris.tst.jus.br/bitstream/handle/20.500.12178/30318/2008_res0065_cnj_rep01.pdf?sequence=2
+ */
+/**
+ *
+ *
+ */
+export declare const dv: (value: string) => string;
+/**
+ * Aplica uma máscara ao número informado
+ *
+ * @param {String} value Número de Processo
+ * @returns {String} Valor com a máscara
+ */
+export declare const mask: (value: string | number) => string;
+/**
+ *
+ *
+ */
+export declare const fake: (withMask?: boolean) => string;
+/**
+ * validateOrFail()
+ * Valida se um número é válido e
+ * retorna uma exceção se não estiver
+ *
+ * @param {String} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validateOrFail: (value: string) => boolean;
+/**
+ * validate()
+ * Valida se um número é válido
+ *
+ * @param {String} value Número a ser validado
+ * @returns {Boolean}
+ */
+export declare const validate: (value: string) => boolean;
+export default validate;