{"_id":"@brasil-interface/sdks","_rev":"7-2c3c4ab35d374ca384b78304fdf431d4","name":"@brasil-interface/sdks","dist-tags":{"latest":"1.3.0-alpha.6"},"versions":{"1.3.0-alpha.0":{"name":"@brasil-interface/sdks","version":"1.3.0-alpha.0","keywords":["brasil","interface","sdk","cep-aberto","cep","Acre","Alagoas","Amapá","Amazonas","Bahia","Ceará","Distrito Federal","Espírito Santo","Goiás","Maranhão","Mato Grosso","Mato Grosso do Sul","Minas Gerais","Pará","Paraíba","Paraná","Pernambuco","Piauí","Rio de Janeiro","Rio Grande do Norte","Rio Grande do Sul","Rondônia","Roraima","Santa Catarina","São Paulo","Sergipe","Tocantins"],"author":{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"},"license":"MIT","_id":"@brasil-interface/sdks@1.3.0-alpha.0","maintainers":[{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"}],"contributors":[{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"}],"homepage":"https://github.com/pietrobondioli/brasil-interface#readme","bugs":{"url":"https://github.com/pietrobondioli/brasil-interface/issues"},"dist":{"shasum":"4924c613a6bdd2eaa29e05b2f7ed5ef5dec7d011","tarball":"https://registry.npmjs.org/@brasil-interface/sdks/-/sdks-1.3.0-alpha.0.tgz","fileCount":12,"integrity":"sha512-0QxhsjqHTfzoR/2mzuRNIv8gvhjg+dMePF1mmGXFoBhoAsDsYeqM9ILXhGSZwfVRNkkh3QrchGa4m8esGXYkzw==","signatures":[{"sig":"MEUCIQC+h57Lm1EH0ELC1RHMZu+kEkNAdpbYxi3wjTq1s8uh2wIgO1Jy3l4qCniqz5NRjzz2N7VDHmIPZsmvqCH+OhrQEaQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20532},"main":"./dist/@brasil-interface/sdks.umd.js","types":"./dist/index.d.ts","module":"./dist/@brasil-interface/sdks.es.js","exports":{".":{"import":"./dist/@brasil-interface/sdks.es.js","require":"./dist/@brasil-interface/sdks.umd.js"}},"gitHead":"107ef996f1f7b995896e77a9634c7b6c15fc0679","scripts":{"test":"jest --coverage --passWithNoTests","build":"yarn run clean && vite build","clean":"rimraf dist"},"_npmUser":{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"},"repository":{"url":"git+https://github.com/pietrobondioli/brasil-interface.git","type":"git"},"_npmVersion":"lerna/7.3.0/node@v18.12.1+x64 (linux)","description":"## Sumário","directories":{},"_nodeVersion":"18.12.1","dependencies":{"@brasil-interface/utils":"^1.2.0-alpha.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.4","vite":"^4.4.9","rimraf":"^5.0.1","ts-jest":"^29.1.1","typescript":"^5.2.2","@types/jest":"^29.5.4","@types/node":"^20.6.2","tsconfig-paths":"^4.2.0","vite-plugin-dts":"^3.5.3"},"_npmOperationalInternal":{"tmp":"tmp/sdks_1.3.0-alpha.0_1697161705577_0.4878444256443537","host":"s3://npm-registry-packages"}},"1.2.1-alpha.0":{"name":"@brasil-interface/sdks","version":"1.2.1-alpha.0","keywords":["brasil","interface","sdk","cep-aberto","cep","Acre","Alagoas","Amapá","Amazonas","Bahia","Ceará","Distrito Federal","Espírito Santo","Goiás","Maranhão","Mato Grosso","Mato Grosso do Sul","Minas Gerais","Pará","Paraíba","Paraná","Pernambuco","Piauí","Rio de Janeiro","Rio Grande do Norte","Rio Grande do Sul","Rondônia","Roraima","Santa Catarina","São Paulo","Sergipe","Tocantins"],"author":{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"},"license":"MIT","_id":"@brasil-interface/sdks@1.2.1-alpha.0","maintainers":[{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"}],"contributors":[{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"}],"homepage":"https://github.com/pietrobondioli/brasil-interface#readme","bugs":{"url":"https://github.com/pietrobondioli/brasil-interface/issues"},"dist":{"shasum":"ef4c59615ba5752f219bd5253cefd386fd3ab9c0","tarball":"https://registry.npmjs.org/@brasil-interface/sdks/-/sdks-1.2.1-alpha.0.tgz","fileCount":84,"integrity":"sha512-DzO6W/5GTDCIk6IT0hItysapCmrLYMsIRAHuVLXrf4vonglLNCAus2Mi2dxoGoLKZ1w4oYTUJ6Khrfg1ez4RAg==","signatures":[{"sig":"MEUCICADftBijvIQTfI0ipk4Ub8ooe046oNbGQUPsynNa1VbAiEAlotMsb5sjEH4aiHnN3fp4q9eZ2rCDBmc4citAVXzZK8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":141380},"main":"./dist/@brasil-interface/sdks.umd.js","types":"./dist/index.d.ts","module":"./dist/@brasil-interface/sdks.es.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/@brasil-interface/sdks.es.js","require":"./dist/@brasil-interface/sdks.umd.js"}},"gitHead":"fcd5c84a8098caecb292b2399cf033d5cdb346c6","scripts":{"test":"jest --coverage --passWithNoTests","build":"yarn run clean && vite build","clean":"rimraf dist"},"_npmUser":{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"},"repository":{"url":"git+https://github.com/pietrobondioli/brasil-interface.git","type":"git"},"_npmVersion":"10.7.0","description":"## Sumário","directories":{},"_nodeVersion":"20.14.0","dependencies":{"@brasil-interface/utils":"^1.2.1-alpha.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.6.4","vite":"^4.4.9","rimraf":"^5.0.1","ts-jest":"^29.1.1","typescript":"^5.2.2","@types/jest":"^29.5.4","@types/node":"^20.6.2","tsconfig-paths":"^4.2.0","vite-plugin-dts":"^3.5.3"},"_npmOperationalInternal":{"tmp":"tmp/sdks_1.2.1-alpha.0_1725602767445_0.37164920375419386","host":"s3://npm-registry-packages"}},"1.3.0-alpha.6":{"name":"@brasil-interface/sdks","version":"1.3.0-alpha.6","description":"## Sumário","license":"MIT","author":{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"},"contributors":[{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"}],"homepage":"https://github.com/pietrobondioli/brasil-interface#readme","main":"./dist/@brasil-interface/sdks.umd.js","module":"./dist/@brasil-interface/sdks.es.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/@brasil-interface/sdks.es.js","require":"./dist/@brasil-interface/sdks.umd.js","types":"./dist/index.d.ts"}},"publishConfig":{"access":"public"},"repository":{"type":"git","url":"https://github.com/pietrobondioli/brasil-interface.git"},"scripts":{"clean":"rimraf dist","build":"yarn run clean && vite build","test":"jest --coverage --passWithNoTests"},"devDependencies":{"@types/jest":"^29.5.4","@types/node":"^20.6.2","jest":"^29.6.4","rimraf":"^5.0.1","ts-jest":"^29.1.1","tsconfig-paths":"^4.2.0","typescript":"^5.2.2","vite":"^4.4.9","vite-plugin-dts":"^3.5.3"},"dependencies":{"@brasil-interface/utils":"^1.3.0-alpha.6"},"keywords":["brasil","interface","sdk","cep-aberto","cep","Acre","Alagoas","Amapá","Amazonas","Bahia","Ceará","Distrito Federal","Espírito Santo","Goiás","Maranhão","Mato Grosso","Mato Grosso do Sul","Minas Gerais","Pará","Paraíba","Paraná","Pernambuco","Piauí","Rio de Janeiro","Rio Grande do Norte","Rio Grande do Sul","Rondônia","Roraima","Santa Catarina","São Paulo","Sergipe","Tocantins"],"_id":"@brasil-interface/sdks@1.3.0-alpha.6","dist":{"shasum":"39693d853d3b1cfb8dcfe01f191d73a6dfe1a211","integrity":"sha512-AWw7DxqnO+LnbkVzKi5wqFfZu3l9xOh2XVBTwDquH//P5P3foRA/j5uqJONHW5h2Ko2Akn+OeqjmYfqHJVqMDw==","tarball":"https://registry.npmjs.org/@brasil-interface/sdks/-/sdks-1.3.0-alpha.6.tgz","fileCount":20,"unpackedSize":20700,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGYMmK+XhMlWeuEiD4yaT9HfRkSQBvvso5AW/40qxIddAiEA+UbMd+B3JUYbw9IAleJJJ6qwpZMxnN8dDjZkZrN8oH0="}]},"_npmUser":{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"},"directories":{},"maintainers":[{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdks_1.3.0-alpha.6_1747528564114_0.5483238470162748"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-13T01:48:25.483Z","modified":"2025-05-18T00:36:04.509Z","0.2.0":"2023-10-10T00:38:19.184Z","1.0.0-alpha.0":"2023-10-10T00:57:38.275Z","1.3.0-alpha.0":"2023-10-13T01:48:25.797Z","1.2.1-alpha.0":"2024-09-06T06:06:07.587Z","1.3.0-alpha.6":"2025-05-18T00:36:04.312Z"},"author":{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"},"license":"MIT","homepage":"https://github.com/pietrobondioli/brasil-interface#readme","keywords":["brasil","interface","sdk","cep-aberto","cep","Acre","Alagoas","Amapá","Amazonas","Bahia","Ceará","Distrito Federal","Espírito Santo","Goiás","Maranhão","Mato Grosso","Mato Grosso do Sul","Minas Gerais","Pará","Paraíba","Paraná","Pernambuco","Piauí","Rio de Janeiro","Rio Grande do Norte","Rio Grande do Sul","Rondônia","Roraima","Santa Catarina","São Paulo","Sergipe","Tocantins"],"repository":{"type":"git","url":"https://github.com/pietrobondioli/brasil-interface.git"},"description":"## Sumário","contributors":[{"name":"Pietro Bondioli","email":"dev@pietrobondioli.com.br"}],"maintainers":[{"name":"pietrobondioli","email":"email@pietrobondioli.com.br"}],"readme":"# Brasil Interface - Sdks\n\n## Sumário\n\n- [Brasil Interface - Sdks](#brasil-interface---sdks)\n  - [Sumário](#sumário)\n  - [Descrição](#descrição)\n    - [Notas](#notas)\n  - [Instalação](#instalação)\n  - [Como usar](#como-usar)\n    - [CepAberto](#cepaberto)\n      - [Buscar endereço por CEP](#buscar-endereço-por-cep)\n      - [Buscar endereço por coordenadas](#buscar-endereço-por-coordenadas)\n      - [Buscar endereço por nome da cidade/estado/rua/bairro](#buscar-endereço-por-nome-da-cidadeestadoruabairro)\n      - [Buscar lista de cidades por estado](#buscar-lista-de-cidades-por-estado)\n      - [Atualizar CEPs pelo número](#atualizar-ceps-pelo-número)\n  - [Como contribuir](#como-contribuir)\n  - [Contribuidores](#contribuidores)\n  - [Autor](#autor)\n  - [Licença](#licença)\n\n## Descrição\n\nEssa lib tem como propósito facilitar a vida de desenvolvedores brasileiros que precisam acessar dados de APIs abertas existentes no Brasil. A lib conta com uma classe para cada API, tendo esta classe métodos que referencia os endpoints da API, assim como as tipagens para cada um dos métodos.\n\n### Notas\n\n- Qualquer API listada aqui está sujeita a limitações e regras que não são de responsabilidade desta lib, para mais informações sobre as limitações e regras de cada API, consulte a documentação oficial da mesma.\n- Os sites e repositorios oficiais de cada API estão listados abaixo, para mais informações sobre cada uma delas, consulte a documentação oficial da mesma.\n- Esta lib não tem como propósito substituir a documentação oficial de cada API, mas sim facilitar o acesso a mesma.\n- A lib funciona tanto no browser quanto no node.\n\n## Instalação\n\n```bash\nyarn add @brasil-interface/sdks\n```\n\nou\n\n```bash\nnpm install @brasil-interface/sdks\n```\n\nou\n\n```bash\npnpm install @brasil-interface/sdks\n```\n\n## Como usar\n\n### CepAberto\n\nA documentação oficial da API pode ser encontrada [aqui](https://cepaberto.com/). Para usar a API é necessário criar uma conta e gerar um token de acesso, para mais informações sobre seu token de acesso, acesse [este link](https://cepaberto.com/api_key).\n\n#### Buscar endereço por CEP\n\nDado um CEP, retorna um objeto com as informações do endereço.\n\n```ts\nimport { CepAbertoAPI } from '@brasil-interface/sdks';\n\nconst cepAberto = new CepAbertoAPI('token');\n\nasync function main() {\n    const endereco = await cepAberto.getCepByNumber('01001000');\n\n    console.log(endereco); // { cep: '01001-000', logradouro: 'Praça da Sé', complemento: 'lado ímpar', bairro: 'Sé', cidade: { ddd: '11', ibge: '3550308', nome: 'São Paulo' }, estado: { sigla: 'SP' }, altitude: 799.3333333333334, latitude: -23.550519, longitude: -46.633309 }\n}\n```\n\n#### Buscar endereço por coordenadas\n\nDadas as coordenadas de latitude e longitude, retorna um objeto com as informações do endereço.\n\n```ts\nimport { CepAbertoAPI } from '@brasil-interface/sdks';\n\nconst cepAberto = new CepAbertoAPI('token');\n\nasync function main() {\n    const endereco = await cepAberto.getCepByCoordinates(-23.550519, -46.633309);\n\n    console.log(endereco); // { cep: '01001-000', logradouro: 'Praça da Sé', complemento: 'lado ímpar', bairro: 'Sé', cidade: { ddd: '11', ibge: '3550308', nome: 'São Paulo' }, estado: { sigla: 'SP' }, altitude: 799.3333333333334, latitude: -23.550519, longitude: -46.633309 }\n}\n```\n\n#### Buscar endereço por nome da cidade/estado/rua/bairro\n\nDado o nome da cidade, estado, rua e bairro, retorna um objeto com as informações do endereço. A rua e bairro são opcionais.\n\n```ts\nimport { CepAbertoAPI } from '@brasil-interface/sdks';\n\nconst cepAberto = new CepAbertoAPI('token');\n\nasync function main() {\n    const endereco = await cepAberto.getCepByAddress('SP', 'São Paulo', 'Rua João Ramalho', 'Perdizes');\n\n    console.log(endereco); // { cep: '05008-010', logradouro: 'Rua João Ramalho', complemento: 'até 999/1000', bairro: 'Perdizes', cidade: { ddd: '11', ibge: '3550308', nome: 'São Paulo' }, estado: { sigla: 'SP' }, altitude: 661.3333333333334, latitude: -23.537583, longitude: -46.680511 }\n}\n```\n\n#### Buscar lista de cidades por estado\n\nDado o nome do estado, retorna um array com as cidades do estado. O nome do estado deve ser a sigla do estado em caixa alta.\n\n```ts\nimport { CepAbertoAPI } from '@brasil-interface/sdks';\n\nconst cepAberto = new CepAbertoAPI('token');\n\nasync function main() {\n  const cidades = await cepAberto.getCitiesByState('SP');\n\n  console.log(cidades) // [{ nome: \"Adamantina\" }, { nome: \"Adolfo\" }, { nome: \"Aguaí\" }, { nome: \"Águas da Prata\" }, ...]\n}\n```\n\n#### Atualizar CEPs pelo número\n\nSe você possui uma lista de CEPs e deseja atualizar os dados deles, você pode usar este método para atualizar os dados de todos os CEPs de uma vez. O método retorna um array com os CEPs que foram atualizados.\n\n```ts\nimport { CepAbertoAPI } from '@brasil-interface/sdks';\n\nconst cepAberto = new CepAbertoAPI('token');\n\nasync function main() {\n  const cepsAtualizados = await cepAberto.updateCeps([\"01001-000\", \"01002-000\", \"01003-000\"]);\n\n  console.log(cepsAtualizados) // [\"01001-000\", \"01002-000\"]\n}\n```\n\n## Como contribuir\n\nLeia o arquivo [CONTRIBUTING.md](https://github.com/pietrobondioli/brasil-interface/blob/main/CONTRIBUTING.md) no repositório principal.\n\n## Contribuidores\n\n- [Pietro Bondioli](https://github.com/pietrobondioli)\n\n## Autor\n\n- [Pietro Bondioli](https://github.com/pietrobondioli)\n\n## Licença\n\n[MIT](https://github.com/pietrobondioli/brasil-interface/blob/main/LICENSE.md)\n","readmeFilename":"README.md"}