{"analyzedAt":"2022-07-10T22:49:18.862Z","collected":{"metadata":{"name":"cep-address-finder","scope":"unscoped","version":"1.3.5","description":"Uma simples e poderosa biblioteca para pesquisa de endereços brasileiros.","keywords":["cep","zipcode","endereço","endereco","address","brasil","brazil"],"date":"2021-03-09T17:16:04.927Z","author":{"name":"Mateus Araujo"},"publisher":{"username":"mateus-araujo","email":"rb.mateus.araujo@gmail.com"},"maintainers":[{"username":"mateus-araujo","email":"rb.mateus.araujo@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/mateus-araujo/cep-address-finder.git"},"links":{"npm":"https://www.npmjs.com/package/cep-address-finder","homepage":"https://github.com/mateus-araujo/cep-address-finder","repository":"https://github.com/mateus-araujo/cep-address-finder","bugs":"https://github.com/mateus-araujo/cep-address-finder/issues"},"license":"ISC","dependencies":{"node-fetch":"^2.6.1","unfetch":"^4.2.0"},"devDependencies":{"@ampproject/rollup-plugin-closure-compiler":"^0.26.0","@babel/core":"^7.13.8","@babel/preset-env":"^7.13.9","@babel/preset-typescript":"^7.13.0","@rollup/plugin-typescript":"^8.2.0","@types/jest":"^26.0.20","@types/node-fetch":"^2.5.8","@typescript-eslint/eslint-plugin":"^4.16.1","@typescript-eslint/parser":"^4.16.1","babel-jest":"^26.6.3","eslint":"^7.21.0","eslint-config-prettier":"^8.1.0","eslint-config-standard":"^16.0.2","eslint-plugin-import":"^2.22.1","eslint-plugin-import-helpers":"^1.1.0","eslint-plugin-jest":"^24.1.5","eslint-plugin-node":"^11.1.0","eslint-plugin-prettier":"^3.3.1","eslint-plugin-promise":"^4.3.1","jest":"^26.6.3","prettier":"^2.2.1","rollup":"^2.40.0","rollup-plugin-dts":"^2.0.1","rollup-plugin-includepaths":"^0.2.4","rollup-plugin-node-resolve":"^5.2.0","rollup-plugin-replace":"^2.2.0","ts-node":"^9.1.1","tslib":"^2.1.0","typescript":"^4.2.3"},"releases":[{"from":"2022-06-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2022-04-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":1},{"from":"2022-01-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":1},{"from":"2021-07-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":1},{"from":"2020-07-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":12}],"hasTestScript":true,"hasSelectiveFiles":true,"readme":"<h1 align=\"center\">cep-address-finder</h1>\n\n<p align=\"center\">\n  <a href=\"https://github.com/mateus-araujo/cep-address-finder/actions?workflow=CI\">\n    <img src=\"https://github.com/mateus-araujo/cep-address-finder/workflows/CI/badge.svg\">\n  </a>\n  <a href=\"https://npm-stat.com/charts.html?package=cep-address-finder\">\n    <img src=\"https://img.shields.io/npm/dm/cep-address-finder.svg\">\n  </a>\n  <a href='https://coveralls.io/github/mateus-araujo/cep-address-finder?branch=main'><img src='https://coveralls.io/repos/github/mateus-araujo/cep-address-finder/badge.svg?branch=main' alt='Coverage Status' /></a>\n  <a href=\"https://www.npmjs.com/package/cep-address-finder\">\n    <img src=\"https://badge.fury.io/js/cep-address-finder.svg\">\n  </a>\n  <a href=\"http://standardjs.com/\">\n    <img src=\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg\">\n  </a>\n  <a href=\"https://snyk.io/test/github/mateus-araujo/cep-address-finder\">\n    <img src=\"https://snyk.io/test/github/mateus-araujo/cep-address-finder/badge.svg\" alt=\"Known Vulnerabilities\" data-canonical-src=\"https://snyk.io/test/github/mateus-araujo/cep-address-finder\" style=\"max-width:100%;\">\n  </a>\n</p>\n\nUma simples e poderosa biblioteca para pesquisa de endereços brasileiros.\n\n✅ Consulta de CEP\n\n✅ Busca de CEP a partir de um endereço sem CEP\n\n✅ Retorna outras informações adicionais e úteis de um endereço além do CEP, como bairro, e ddd\n\n✅ Utiliza base atualizada com requisições feitas a api ViaCEP\n\n✅ Leve, utiliza `node-fetch` no lado servidor e `unfetch` no lado cliente para fazer as requisições\n\n✅ Suporte Typescript\n\n✅ Tratamento de erros\n\n\n## Instalação\n\n#### npm\n\n```\n$ npm install --save cep-address-finder\n```\n\n#### yarn\n\n```\n$ yarn add cep-address-finder\n```\n\n\n## Como utilizar\n\n### Busca de CEP a partir de um endereço sem CEP\n\nCom a função `findAddress` é possível retornar um endereço completo, apenas com algumas informações básicas, como `state`, `city`, `street` e `number`. Além de uma lista de endereços do logradouro, retornada pelo ViaCEP.\n\nApenas `state` e `city` são obrigatórias, bem útil quando uma cidade tem apenas uma faixa de CEP.\n\nOu apenas `state`, `city` e `neighborhood`, também útil para regiões que possuam poucas faixas de CEP.\n\nOs atributos disponíveis no objeto enviado como parâmetro são: `state`, `city`, `street`, `number`, e `neighborhood`.\n\nQuanto mais parâmetros melhor a precisão.\n\n``` js\nimport { findAddress } from 'cep-address-finder'\n\n// Colocar dentro de uma função assíncrona, ou usar findAddress({...}).then(...)\nconst { addresses, selectedAddress } = await findAddress({\n    state: 'CE',\n    city: 'Fortaleza',\n    street: 'Pontes Vieira',\n    number: '993',\n})\n\n// console.log({ addresses, selectedAddress })\n//\n// {\n//     \"addresses\": [...], // Lista com endereços do logradouro\n//     \"selectedAddress\": { // Endereço selecionado da lista\n//         \"cep\": \"60135-237\",\n//         \"state\": \"CE\",\n//         \"city\": \"Fortaleza\",\n//         \"street\": \"Avenida Pontes Vieira\",\n//         \"neighborhood\": \"Dionísio Torres\",\n//         \"complement\": \"de 991 ao fim - lado ímpar\",\n//         \"ddd\": \"85\",\n//         \"gia\": \"\",\n//         \"ibge\": \"2304400\",\n//         \"siafi\": \"1389\"\n//     }\n// }\n```\n\nNo exemplo acima, foi encontrado o endereço com o CEP e complemento (`\"complement\": \"de 991 ao fim - lado ímpar\"`) correspondente ao número (`number: '993'`) que foi passado na função.\n\n### Consulta de CEP\n\nAlém da busca da função acima, é possível realizar a consulta padrão por um CEP.\n\n``` js\nimport { getAddressByCEP } from 'cep-address-finder'\n\n// Colocar dentro de uma função assíncrona, ou usar getAddressByCEP(...).then(...)\nconst address = await getAddressByCEP('60160-110')\n\n// console.log({ address })\n//\n// {\n//     \"address\": {\n//         \"cep\": \"60160-110\",\n//         \"state\": \"CE\",\n//         \"city\": \"Fortaleza\",\n//         \"street\": \"Rua Ana Bilhar\"\n//         \"neighborhood\": \"Meireles\",\n//         \"complement\": \"até 1298/1299\",\n//         \"ddd\": \"85\",\n//         \"gia\": \"\",\n//         \"ibge\": \"2304400\",\n//         \"siafi\": \"1389\",\n//     }\n// }\n```\n\n## Como contribuir\n\nO projeto está livre para abertura de PRs e issues.\n\nAlgumas **features** futuras:\n\n    ✅ Suporte a NodeJS (implementado a partir da versão 1.3.0).\n    ✅ Testes automatizados (implementados a partir da versão 1.3.3).\n\n * Integração a outros serviços de CEP, como Correios e WideNet.\n * Instalação com Bower.\n * Utilização no Browser usando CDN."},"npm":{"downloads":[{"from":"2022-07-09T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2022-07-03T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":12},{"from":"2022-06-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":75},{"from":"2022-04-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":345},{"from":"2022-01-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":690},{"from":"2021-07-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":1457}],"starsCount":0},"github":{"homepage":"https://www.npmjs.com/package/cep-address-finder","starsCount":7,"forksCount":0,"subscribersCount":1,"issues":{"count":10,"openCount":9,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":2,"7873200":0,"23619600":2,"70858800":6,"212576400":0},"isDisabled":false},"contributors":[{"username":"mateus-araujo","commitsCount":14}],"commits":[{"from":"2022-07-03T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2022-06-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2022-04-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2022-01-11T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0},{"from":"2021-07-10T00:00:00.000Z","to":"2022-07-10T00:00:00.000Z","count":0}],"statuses":[{"context":"coverage/coveralls","state":"success"},{"context":"Coveralls - node-15","state":"failure"},{"context":"Coveralls - node-14","state":"failure"},{"context":"Coveralls - node-12","state":"failure"},{"context":"Coveralls - node-10","state":"failure"}]},"source":{"files":{"readmeSize":4553,"testsSize":12810},"badges":[{"urls":{"original":"https://img.shields.io/npm/dm/cep-address-finder.svg","shields":"https://img.shields.io/npm/dm/cep-address-finder.svg","content":"https://img.shields.io/npm/dm/cep-address-finder.json"},"info":{"service":"npm","type":"downloads","modifiers":{"type":"dm"}}},{"urls":{"original":"https://coveralls.io/repos/github/mateus-araujo/cep-address-finder/badge.svg?branch=main%27","service":"https://coveralls.io/repos/github/mateus-araujo/cep-address-finder/badge.svg?branch=main'","shields":"https://img.shields.io/coveralls/mateus-araujo/cep-address-finder/main'.svg","content":"https://img.shields.io/coveralls/mateus-araujo/cep-address-finder/main'.json"},"info":{"service":"coveralls","type":"coverage","modifiers":{"branch":"main'"}}}],"linters":["editorconfig","eslint","prettier"],"coverage":0.95,"outdatedDependencies":{"node-fetch":{"required":"^2.6.1","stable":"3.2.6","latest":"4.0.0-beta.4"}}}},"evaluation":{"quality":{"carefulness":0.9199999999999999,"tests":0.7925,"health":0.75,"branding":0.3},"popularity":{"communityInterest":9,"downloadsCount":115,"downloadsAcceleration":-0.4125570776255708,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.6510223509389961,"detail":{"quality":0.9499724622480181,"popularity":0.04592091536973349,"maintenance":0.9998808339576686}}}