validation-br 0.8.3 → 1.0.0-b

package/src/judicialProcess.ts

@@ -0,0 +1,167 @@
+/**
+ * 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

package/src/pisPasep.test.ts

@@ -0,0 +1,124 @@
+import isPIS, { dv, fake, mask, validate, validateOrFail } from './pisPasep'
+
+describe('PIS', () => {
+  test('isPIS() - Números válidos', () => {
+    const list = [
+      // string
+      '71282677380',
+      '23795126955',
+      // integer
+      50012973803,
+      27890141144,
+      // masked
+      '268.27649.96-0',
+      '613.01862.91-7',
+    ]
+
+    list.forEach((pis) => {
+      expect(isPIS(pis)).toBeTruthy()
+    })
+  })
+
+  test('validate() - Números válidos', () => {
+    const list = [
+      // string
+      '71282677380',
+      '23795126955',
+      // integer
+      50012973803,
+      27890141144,
+      // masked
+      '268.27649.96-0',
+      '613.01862.91-7',
+    ]
+
+    list.forEach((pis) => {
+      expect(validate(pis)).toBeTruthy()
+    })
+  })
+
+  test('validate() - Números inválidos', () => {
+    const list = [
+      '712.82677.38-2',
+      '237.95126.95-4',
+      '500.12973.80-1',
+      '278.90141.14-9',
+      '268.27649.96-2',
+      '613.01862.91-4',
+      '111.11111.11-1',
+    ]
+
+    list.forEach((pis) => {
+      expect(validate(pis)).toBeFalsy()
+    })
+  })
+
+  test('validateOrFail() - Números inválidos', () => {
+    const list = [
+      '712.82677.38-2',
+      '237.95126.95-4',
+      '500.12973.80-1',
+      '278.90141.14-9',
+      '268.27649.96-2',
+      '613.01862.91-4',
+      '111.11111.11-1',
+    ]
+
+    list.forEach((pis) => {
+      expect(() => validateOrFail(pis)).toThrow()
+    })
+  })
+
+  test('Parâmetro não informado', () => {
+    expect(isPIS('')).toBeFalsy()
+    expect(validate('')).toBeFalsy()
+    expect(() => validateOrFail('')).toThrow()
+    expect(() => dv('')).toThrow()
+  })
+
+  test('fake() - Gera fakes sem máscara', () => {
+    for (let i = 0; i < 5; i += 1) {
+      const pis = fake()
+      expect(validate(pis)).toBeTruthy()
+      expect(pis).toHaveLength(11)
+    }
+  })
+
+  test('fake() - Gera fakes com máscara', () => {
+    for (let i = 0; i < 5; i += 1) {
+      const pis = fake(true)
+      expect(validate(pis)).toBeTruthy()
+      expect(pis).toHaveLength(14)
+    }
+  })
+
+  test('dv() - Verificando se o DV gerado está correto', () => {
+    const list = [
+      { num: '7128267738', expected: '0' },
+      { num: 2379512695, expected: '5' },
+      { num: '5001297380', expected: '3' },
+    ]
+
+    list.forEach((item) => {
+      const calcDv = dv(item.num)
+
+      expect(calcDv).toBe(item.expected)
+      expect(typeof calcDv).toBe('string')
+    })
+  })
+
+  test('mask() - Testando se a máscara foi gerada corretamente', () => {
+    const list = [
+      { num: '71282677380', expected: '712.82677.38-0' },
+      { num: 23795126955, expected: '237.95126.95-5' },
+      { num: '50012973803', expected: '500.12973.80-3' },
+    ]
+
+    list.forEach((item) => {
+      const masked = mask(item.num)
+
+      expect(masked).toBe(item.expected)
+      expect(masked).toHaveLength(14)
+    })
+  })
+})

package/src/pisPasep.ts

@@ -0,0 +1,128 @@
+/**
+ * isPIS()
+ * Calcula se um código de PIS/PASEP/NIS/NIT no formato 268.27649.96-0 é válido. Não
+ * valida o formato, portanto, 26827649960 é equivalente a 268.27649.96-0 para efeitos
+ * desta validação.
+ *
+ * @doc
+ * - O número de PIS deve possuir 11 caracteres
+ *
+ * - Os caracteres de 1 a 10 são a numeração documento
+ *
+ * - O caractere 11 é o dígito verificador.
+ *
+ * 1) Partes do número
+ *  _______________________________________________
+ * |  Número                                 | D V |
+ * |  2   6   8 . 2   7   6   4   9 . 9   6  -  0  |
+ * |_________________________________________|_____|
+ *
+ * 2) Cálculo do DV.
+ *
+ *  - Soma-se o produto das algarismos 3 a 10 pelos números 3, 2, 9, 8, 7, 6, 5, 4, 3, 2
+ *
+ *    2   6   8   2   7   6   4   9   9   6
+ *    x   x   x   x   x   x   x   x   x   x
+ *    3   2   9   8   7   6   5   4   3   2
+ * =  6 +12 +72 +16 +49 +12 +20 +36 +27 +12  =  234
+ *
+ *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
+ *    234 / 11 tem resto 3. 11 - 3 = 8. DV1 é 8.
+ *    Obs.: Caso o cálculo de DV1 retorne 0, o resultado será 5.
+ *          Caso retorne 1, o resto será 0
+ *
+ *
+ *
+ *
+ * Fonte: http://www.macoratti.net/alg_pis.htm
+ *
+ * @param {String} value Objeto postal no formato 268.27649.96-0
+ * @returns {Boolean}
+ */
+
+import {
+  invalidListGenerator,
+  sumElementsByMultipliers,
+  sumToDV,
+  clearValue,
+  fakeNumber,
+  applyMask,
+} from './utils'
+
+/**
+ * dv()
+ * Calcula o dígito verificador
+ *
+ * @param {Number|String} value
+ * @returns {String}
+ */
+export const dv = (value: string | number): string => {
+  if (!value) throw new Error('PIS não informado')
+
+  const pis = clearValue(value, 10)
+
+  const invalidList = invalidListGenerator(10)
+  if (invalidList.includes(pis)) {
+    throw new Error('PIS não pode ser uma sequência de números iguais')
+  }
+
+  const sum = sumElementsByMultipliers(pis, [3, 2, 9, 8, 7, 6, 5, 4, 3, 2])
+
+  return String(sumToDV(sum))
+}
+
+/**
+ * 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.00000.00-0')
+
+/**
+ * fake()
+ * Gera um número válido
+ *
+ * @returns {String}
+ */
+export const fake = (withMask: boolean = false): string => {
+  const num = fakeNumber(10, true)
+
+  const pis = `${num}${dv(num)}`
+
+  if (withMask) return mask(pis)
+  return pis
+}
+
+/**
+ * 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 pis = clearValue(value, 11)
+
+  if (dv(pis) !== pis.substring(10, 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

package/src/postalCode.test.ts

@@ -0,0 +1,132 @@
+import isPostalCode, { dv, fake, mask, validate, validateOrFail } from './postalCode'
+
+describe('PostalCode', () => {
+  test('isPostalCode() - Números válidos', () => {
+    const list = [
+      'PN718252423BR',
+      'PO925539762BR',
+      'JT194690698BR',
+      'SV143851674BR',
+      'RG727348650CN',
+      'RY747622885CN',
+      'RY728187035CN',
+      'RH940629235CN',
+      'RY686586175CN',
+      'RY648001205CN',
+      'UJ776469464CN',
+      'LZ667841882CN',
+      'RS737783818NL',
+    ]
+
+    list.forEach((postalCode) => {
+      expect(isPostalCode(postalCode)).toBeTruthy()
+    })
+  })
+
+  test('validate() - Números válidos', () => {
+    const list = [
+      'PN718252423BR',
+      'PO925539762BR',
+      'JT194690698BR',
+      'SV143851674BR',
+      'RG727348650CN',
+      'RY747622885CN',
+      'RY728187035CN',
+      'RH940629235CN',
+      'RY686586175CN',
+      'RY648001205CN',
+      'UJ776469464CN',
+      'LZ667841882CN',
+      'RS737783818NL',
+    ]
+
+    list.forEach((postalCode) => {
+      expect(validate(postalCode)).toBeTruthy()
+    })
+  })
+
+  test('validate() - Números inválidos', () => {
+    const list = [
+      'PO925524762BR',
+      'JT194624698BR',
+      'SV143824674BR',
+      'RG727324650CN',
+      'RY747624885CN',
+      'RY728114035CN',
+    ]
+
+    list.forEach((postalCode) => {
+      expect(validate(postalCode)).toBeFalsy()
+    })
+  })
+
+  test('validateOrFail() - Números inválidos', () => {
+    const list = [
+      'PO925524762BR',
+      'JT194624698BR',
+      'SV143824674BR',
+      'RG727324650CN',
+      'RY747624885CN',
+      'RY728114035CN',
+    ]
+
+    list.forEach((postalCode) => {
+      expect(() => validateOrFail(postalCode)).toThrow()
+    })
+  })
+
+  test('Parâmetro não informado', () => {
+    expect(isPostalCode('')).toBeFalsy()
+    expect(validate('')).toBeFalsy()
+    expect(() => validateOrFail('')).toThrow()
+    expect(() => dv('')).toThrow()
+  })
+
+  test('fake() - Gera fakes sem máscara', () => {
+    for (let i = 0; i < 5; i += 1) {
+      const postalCode = fake()
+
+      expect(validate(postalCode)).toBeTruthy()
+      expect(postalCode).toHaveLength(13)
+    }
+  })
+
+  test('fake() - Gera fakes com máscara', () => {
+    for (let i = 0; i < 5; i += 1) {
+      const postalCode = fake(true)
+
+      expect(validate(postalCode)).toBeTruthy()
+      expect(postalCode).toHaveLength(13)
+    }
+  })
+
+  test('dv() - Verificando se o DV gerado está correto', () => {
+    const list = [
+      { num: 'PN718252423BR', expected: '3' },
+      { num: 'PO925539762BR', expected: '2' },
+      { num: 'JT194690698BR', expected: '8' },
+    ]
+
+    list.forEach((item) => {
+      const calcDv = dv(item.num)
+
+      expect(calcDv).toBe(item.expected)
+      expect(typeof calcDv).toBe('string')
+    })
+  })
+
+  test('mask() - Testando se a máscara foi gerada corretamente', () => {
+    const list = [
+      { num: 'pn718252423br', expected: 'PN718252423BR' },
+      { num: 'po925539762br', expected: 'PO925539762BR' },
+      { num: 'jt194690698br', expected: 'JT194690698BR' },
+    ]
+
+    list.forEach((item) => {
+      const masked = mask(item.num)
+
+      expect(masked).toBe(item.expected)
+      expect(masked).toHaveLength(13)
+    })
+  })
+})

package/src/postalCode.ts

@@ -0,0 +1,164 @@
+/**
+ * isPostalCode()
+ * Calcula se um código de rastreamento postal no formato JT194690698BR é válido.
+ *
+ * @doc
+ * - O número de registro postal deve possuir 13 caracters no formato JT194690698BR.
+ *
+ * - Os caracteres 1 e 2 informam o tipo do objeto. Ex.: SX é Sedex, RC é carta registrada etc.
+ *
+ * - Os caracteres de 3 a 10 são a numeração sequencial do tipo do objeto.
+ *
+ * - O caractere 11 é o dígito verificador.
+ *
+ * - Os caracteres 12 e 13 representa o código do País de onde a postagem partiu.
+ *
+ * 1) Partes do número
+ *  ______ ___________________________ ______ _______
+ * | Tipo | Número                    |  DV  |  País |
+ * | J T    1  9  4  6  9  0  6  9       8      B R  |
+ * |______|___________________________|______|_______|
+ *
+ * 2) Cálculo do DV.
+ *
+ *  - Soma-se o produto das algarismos 3 a 10 pelos números 8, 6, 4, 2, 3, 5, 9, 7
+ *
+ *    1   9   4   6   9   0   6   9
+ *    x   x   x   x   x   x   x   x
+ *    8   6   4   2   3   5   9   7
+ * =  8 +54 +16 +12 +18  +0 +54 +63 = 234
+ *
+ *  - O somatório encontrado é dividido por 11 e o resultado é subtraído de 11
+ *    234 / 11 tem resto 3. 11 - 3 = 8. DV1 é 8.
+ *    Obs.: Caso o cálculo de DV1 retorne 0, o resultado será 5.
+ *          Caso retorne 1, o resto será 0
+ *
+ *
+ *
+ *
+ * Fonte:
+ *
+ * @param {String} value Objeto postal no formato JT194690698BR
+ * @returns {Boolean}
+ */
+
+import { sumElementsByMultipliers, clearValue, fakeNumber } from './utils'
+
+/**
+ * dv()
+ * Calcula o dígito verificador
+ *
+ * @param {Number|String} value
+ * @returns {String}
+ */
+export const dv = (value: string | number): string => {
+  if (!value) throw new Error('PIS não informado')
+
+  const postalCode = clearValue(value, 8)
+
+  const sum = sumElementsByMultipliers(postalCode, [8, 6, 4, 2, 3, 5, 9, 7])
+
+  const rest = sum % 11
+  // const specificities = { 0: { dv: 5 }, 1: { dv: 0 } }
+
+  const specificities = [
+    { rest: 0, dv: 5 },
+    { rest: 1, dv: 0 },
+  ]
+
+  const specifity = specificities.find((item) => item.rest === rest)
+
+  const DV = specifity ? specifity.dv : 11 - rest
+
+  return String(DV)
+}
+
+/**
+ * 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 => String(value).toLocaleUpperCase()
+
+/**
+ * fake()
+ * Gera um número válido
+ *
+ * @returns {String}
+ */
+export const fake = (withMask: boolean = false): string => {
+  const num = fakeNumber(8, true)
+
+  const randLetter = (): string =>
+    [
+      'A',
+      'B',
+      'C',
+      'D',
+      'E',
+      'F',
+      'G',
+      'H',
+      'I',
+      'J',
+      'K',
+      'L',
+      'M',
+      'N',
+      'O',
+      'P',
+      'Q',
+      'R',
+      'S',
+      'T',
+      'U',
+      'V',
+      'W',
+      'X',
+      'Y',
+      'Z',
+    ][+(Math.random() * 25).toFixed(0)]
+
+  const postalCode = `${randLetter()}${randLetter()}${num}${dv(num)}BR`
+
+  if (withMask) return mask(postalCode)
+  return postalCode
+}
+
+/**
+ * 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 postalCode = clearValue(value, 9)
+
+  if (!/^[a-z]{2}([\d]{9})[a-z]{2}$/gi.test(String(value))) {
+    throw new Error('O número não está no formato "XX000000000XX"')
+  }
+
+  if (dv(value) !== postalCode.substring(8, 9)) {
+    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