br-id

Gerador e Validador de CPF e CNPJ Brasileiros

Pequena biblioteca TypeScript para criação e validação de identificadores nacionais (CPF e CNPJ) de forma simples, confiável e formatada — ideal para testes, mocks ou validação de entrada de dados em aplicações brasileiras.

🚀 Recursos

• ✅ Geração de CPFs e CNPJs válidos (com dígitos verificadores corretos)
• 🧾 Validação completa com mensagens de erro descritivas
• 🧩 Opção de formatação automática (000.000.000-00 / 00.000.000/0000-00)
• 🗺️ Suporte a dígito regional do CPF com base em UFs brasileiras

📦 Instalação

npm install @devmaggioni/br-id
# ou
yarn add @devmaggioni/br-id

🧠 Uso

import { CPF, CNPJ } from "@devmaggioni/br-id";

// Criar CPF formatado para o estado de Santa Catarina
const cpf = CPF.create({ format: true, uf: "SC" });
// -> "123.456.789-09"

// Validar um CPF
const result = CPF.validate("123.456.789-09");
// -> { valid: true }

// Criar CNPJ formatado
const cnpj = CNPJ.create({ format: true });
// -> "12.345.678/0001-95"

// Validar CNPJ
const valid = CNPJ.validate("12.345.678/0001-95");
// -> { valid: true }

⚙️ API

CPF

• CPF.create({ format?: boolean, uf?: TUF }) Gera um CPF válido, opcionalmente formatado e com dígito regional correspondente a uma UF.
• CPF.validate(cpf: string) Valida um CPF e retorna { valid: boolean, issue?: string }.

CNPJ

• CNPJ.create({ format?: boolean }) Gera um CNPJ válido, opcionalmente formatado.
• CNPJ.validate(cnpj: string) Valida um CNPJ e retorna { valid: boolean, issue?: string }.

🧩 Tipos

O tipo TUF representa as Unidades Federativas brasileiras suportadas:

type TUF = "AC" | "AL" | "AP" | "AM" | "BA" | "CE" | "DF" | "ES" | ... | "SC" | "SP" | "TO";

📄 Licença

MIT © Gabriel Maggioni