{"_id":"@cosmixclub/docsafe-br","name":"@cosmixclub/docsafe-br","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@cosmixclub/docsafe-br","version":"1.0.0","description":"Validação e formatação de CPF e CNPJ no padrão brasileiro","author":{"name":"Alex Custódio","email":"alex.cstd.contato@gmail.com"},"license":"MIT","main":"dist/index.js","keywords":["cpf","cnpj","validator","brazil","docsafe","formatação"],"homepage":"https://github.com/cosmixclub/docsafe-br","bugs":{"url":"https://github.com/cosmixclub/docsafe-br/issues"},"repository":{"type":"git","url":"git+https://github.com/cosmixclub/docsafe-br.git"},"type":"module","types":"./dist/index.d.ts","exports":{"./package.json":"./package.json",".":{"import":"./dist/index.js","default":"./dist/index.cjs"}},"devDependencies":{"@arethetypeswrong/cli":"^0.16.4","@changesets/cli":"^2.27.9","@trivago/prettier-plugin-sort-imports":"^4.3.0","@types/node":"^22.7.9","@typescript-eslint/eslint-plugin":"^8.11.0","@typescript-eslint/parser":"^8.11.0","@vercel/style-guide":"^6.0.0","commitizen":"^4.3.1","cz-conventional-changelog":"^3.3.0","eslint":"8.57.0","eslint-config-prettier":"^9.1.0","eslint-plugin-perfectionist":"^3.9.1","eslint-plugin-prettier":"^5.2.1","prettier":"^3.3.3","tsup":"^8.3.0","typescript":"^5.6.3"},"config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"scripts":{"ci":"pnpm build && pnpm check-format && pnpm check-exports","build":"tsup","lint":"eslint --fix .","format":"prettier --write .","check-format":"prettier --check .","commit":"git cz","check-exports":"attw --pack .","local-release":"changeset version && changeset publish"},"_id":"@cosmixclub/docsafe-br@1.0.0","_integrity":"sha512-0dJtf55GoLQObj8fPlvnrFoKs+EJms7GW10PdHcgCCjv0mlL/gxZXk6pHQj8A5MSuVZHwYR3n3+MwwtJck9mzw==","_resolved":"/tmp/703b6101cf78fb9460e625948ad74189/cosmixclub-docsafe-br-1.0.0.tgz","_from":"file:cosmixclub-docsafe-br-1.0.0.tgz","_nodeVersion":"18.19.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-0dJtf55GoLQObj8fPlvnrFoKs+EJms7GW10PdHcgCCjv0mlL/gxZXk6pHQj8A5MSuVZHwYR3n3+MwwtJck9mzw==","shasum":"3941495e6f1ebb5e4d1b0bcc1beefc63965deaf6","tarball":"https://registry.npmjs.org/@cosmixclub/docsafe-br/-/docsafe-br-1.0.0.tgz","fileCount":7,"unpackedSize":15344,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCwE+JPqX0xLB+Tz4voSxLlcGLuROwOzcqzI9e80XlBcwIhALnbIOjik02Zrj7FuILf1xSesO2PrJ5SDV8q8Dr1Hx48"}]},"_npmUser":{"name":"alex-custodio","email":"alex.scustod@gmail.com"},"directories":{},"maintainers":[{"name":"gepetojj","email":"nmjoaopedro22@gmail.com"},{"name":"alex-custodio","email":"alex.scustod@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docsafe-br_1.0.0_1740096282692_0.5069457683585552"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-21T00:04:42.627Z","1.0.0":"2025-02-21T00:04:42.900Z","modified":"2025-02-21T00:04:43.188Z"},"maintainers":[{"name":"gepetojj","email":"nmjoaopedro22@gmail.com"},{"name":"alex-custodio","email":"alex.scustod@gmail.com"}],"description":"Validação e formatação de CPF e CNPJ no padrão brasileiro","homepage":"https://github.com/cosmixclub/docsafe-br","keywords":["cpf","cnpj","validator","brazil","docsafe","formatação"],"repository":{"type":"git","url":"git+https://github.com/cosmixclub/docsafe-br.git"},"author":{"name":"Alex Custódio","email":"alex.cstd.contato@gmail.com"},"bugs":{"url":"https://github.com/cosmixclub/docsafe-br/issues"},"license":"MIT","readme":"## @cosmixclub/docsafe-br\r\n\r\nEste pacote fornece funções para **validação** e **formatação** de **CPF** e **CNPJ**, garantindo que os números estejam no formato correto e sejam válidos de acordo com as regras da **Receita Federal do Brasil**.\r\n\r\n### Índice\r\n\r\n-   [@cosmixclub/docsafe-br](#cosmixclubdocsafe-br)\r\n    -   [Índice](#índice)\r\n-   [Instalação](#instalação)\r\n-   [Uso](#uso)\r\n    -   [Validando um CPF](#validando-um-cpf)\r\n    -   [Validando um CNPJ](#validando-um-cnpj)\r\n    -   [Formatando um CPF](#formatando-um-cpf)\r\n    -   [Formatando um CNPJ](#formatando-um-cnpj)\r\n-   [API](#api)\r\n    -   [Funções de Validação](#funções-de-validação)\r\n        -   [`isValidCPF(cpf: string): boolean`](#isvalidcpfcpf-string-boolean)\r\n        -   [`isValidCNPJ(cnpj: string): boolean`](#isvalidcnpjcnpj-string-boolean)\r\n    -   [Funções de Formatação](#funções-de-formatação)\r\n        -   [`formatCPF(cpf: string): string`](#formatcpfcpf-string-string)\r\n        -   [`formatCNPJ(cnpj: string): string`](#formatcnpjcnpj-string-string)\r\n-   [Contribuição](#contribuição)\r\n\r\n## Instalação\r\n\r\n```bash\r\npnpm add @cosmixclub/docsafe-br\r\n```\r\n\r\nou\r\n\r\n```bash\r\nnpm install @cosmixclub/docsafe-br\r\n```\r\n\r\nou\r\n\r\n```bash\r\nyarn add @cosmixclub/docsafe-br\r\n```\r\n\r\n## Uso\r\n\r\n### Validando um CPF\r\n\r\nA função `isValidCPF` verifica se um CPF é válido de acordo com as regras da Receita Federal.\r\n\r\n```typescript\r\nimport { isValidCPF } from \"@cosmixclub/docsafe-br\";\r\n\r\nconsole.log(isValidCPF(\"123.456.789-09\")); // true\r\nconsole.log(isValidCPF(\"111.111.111-11\")); // false\r\n```\r\n\r\n### Validando um CNPJ\r\n\r\nA função `isValidCNPJ` verifica se um CNPJ é válido.\r\n\r\n```typescript\r\nimport { isValidCNPJ } from \"@cosmixclub/docsafe-br\";\r\n\r\nconsole.log(isValidCNPJ(\"12.345.678/0001-95\")); // true\r\nconsole.log(isValidCNPJ(\"11.111.111/0001-11\")); // false\r\n```\r\n\r\n### Formatando um CPF\r\n\r\nA função `formatCPF` transforma um CPF não formatado para o padrão `XXX.XXX.XXX-XX`.\r\n\r\n```typescript\r\nimport { formatCPF } from \"@cosmixclub/docsafe-br\";\r\n\r\nconsole.log(formatCPF(\"11144477735\")); // \"111.444.777-35\"\r\nconsole.log(formatCPF(\"123\")); // \"123\" (mantém se inválido)\r\n```\r\n\r\n### Formatando um CNPJ\r\n\r\nA função `formatCNPJ` transforma um CNPJ não formatado para o padrão `XX.XXX.XXX/XXXX-XX`.\r\n\r\n```typescript\r\nimport { formatCNPJ } from \"@cosmixclub/docsafe-br\";\r\n\r\nconsole.log(formatCNPJ(\"54550752000155\")); // \"54.550.752/0001-55\"\r\nconsole.log(formatCNPJ(\"123456\")); // \"123456\" (mantém se inválido)\r\n```\r\n\r\n## API\r\n\r\n### Funções de Validação\r\n\r\n#### `isValidCPF(cpf: string): boolean`\r\n\r\n-   **Parâmetro**: `cpf` - Uma string representando um CPF, com ou sem formatação.\r\n-   **Retorno**: `true` se o CPF for válido, `false` caso contrário.\r\n\r\n```typescript\r\nisValidCPF(\"123.456.789-09\"); // true\r\nisValidCPF(\"111.111.111-11\"); // false\r\n```\r\n\r\n#### `isValidCNPJ(cnpj: string): boolean`\r\n\r\n-   **Parâmetro**: `cnpj` - Uma string representando um CNPJ, com ou sem formatação.\r\n-   **Retorno**: `true` se o CNPJ for válido, `false` caso contrário.\r\n\r\n```typescript\r\nisValidCNPJ(\"12.345.678/0001-95\"); // true\r\nisValidCNPJ(\"11.111.111/0001-11\"); // false\r\n```\r\n\r\n### Funções de Formatação\r\n\r\n#### `formatCPF(cpf: string): string`\r\n\r\n-   **Parâmetro**: `cpf` - Uma string representando um CPF, com ou sem formatação.\r\n-   **Retorno**: O CPF formatado no padrão `XXX.XXX.XXX-XX`.\r\n\r\n```typescript\r\nformatCPF(\"11144477735\"); // \"111.444.777-35\"\r\nformatCPF(\"12345678900\"); // \"123.456.789-00\"\r\n```\r\n\r\n#### `formatCNPJ(cnpj: string): string`\r\n\r\n-   **Parâmetro**: `cnpj` - Uma string representando um CNPJ, com ou sem formatação.\r\n-   **Retorno**: O CNPJ formatado no padrão `XX.XXX.XXX/XXXX-XX`.\r\n\r\n```typescript\r\nformatCNPJ(\"54550752000155\"); // \"54.550.752/0001-55\"\r\nformatCNPJ(\"12345678000199\"); // \"12.345.678/0001-99\"\r\n```\r\n\r\n## Contribuição\r\n\r\n1. **Fork** este repositório.\r\n2. Crie uma **branch** para sua funcionalidade (`git checkout -b feature/nova-funcionalidade`).\r\n3. Faça o **commit** das alterações (`git commit -m \"Adiciona nova funcionalidade\"`).\r\n4. Envie para a branch (`git push origin feature/nova-funcionalidade`).\r\n5. Abra um **Pull Request**.\r\n\r\nSe encontrar algum **bug** ou tiver sugestões de melhorias, sinta-se à vontade para abrir uma **issue**!\r\n\r\n---\r\n\r\nEste pacote foi desenvolvido para ser **simples, eficiente e confiável** na **validação e formatação de CPF e CNPJ no Brasil**. 🚀🇧🇷\r\n","readmeFilename":"README.md"}