@eusilvio/cep-lookup 1.0.1 → 1.0.3

package/LICENSE

@@ -0,0 +1,67 @@
+# Project License
+
+This project was developed with the philosophy that knowledge and tools should be accessible to all. I believe that by sharing our work freely, we can empower other creators to build incredible things.
+
+That's why I chose the MIT License for this project. In simple terms, this means you have complete freedom to use, modify, and distribute this code, even for commercial purposes, with a single condition: you must keep the original copyright and license notice included.
+
+Thank you for your interest and contributions!
+
+---
+
+# Licença do Projeto
+
+Este projeto foi desenvolvido com a filosofia de que o conhecimento e as ferramentas devem ser acessíveis a todos. Acredito que, ao compartilhar nosso trabalho livremente, podemos capacitar outros criadores a construir coisas incríveis.
+
+Por isso, escolhi a Licença MIT para este projeto. Em termos simples, isso significa que você tem total liberdade para usar, modificar e distribuir este código, até mesmo para fins comerciais, com uma única condição: mantenha o aviso de licença e copyright originais.
+
+Agradecemos o seu interesse e contribuição!
+
+---
+
+### MIT License
+
+Copyright (c) 2025 Silvio Campos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+### Tradução para Português (Apenas para referência)
+
+_Aviso: Esta é uma tradução não oficial e serve apenas para facilitar o entendimento. A versão em inglês é a que possui validade legal._
+
+Copyright (c) 2025 Silvio Campos
+
+É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia
+deste software e dos arquivos de documentação associados (o "Software"), para negociar
+o Software sem restrições, incluindo, sem limitação, os direitos
+de usar, copiar, modificar, mesclar, publicar, distribuir, sublicenciar e/ou vender
+cópias do Software, e permitir que as pessoas a quem o Software é
+fornecido o façam, sujeito às seguintes condições:
+
+O aviso de copyright acima e este aviso de permissão devem ser incluídos em todas as
+cópias ou partes substanciais do Software.
+
+O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU
+IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO,
+ADEQUAÇÃO A UM FIM ESPECÍFICO E NÃO VIOLAÇÃO. EM NENHUMA CIRCUNSTÂNCIA OS
+AUTORES OU TITULARES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER REIVINDICAÇÃO, DANOS OU OUTRA
+RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ILÍCITO CIVIL OU DE OUTRA FORMA, DECORRENTE DE,
+FORA DE OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO
+SOFTWARE.

package/README.md

@@ -1,6 +1,7 @@
 # @eusilvio/cep-lookup
 
 [![NPM Version](https://img.shields.io/npm/v/@eusilvio/cep-lookup.svg)](https://www.npmjs.com/package/@eusilvio/cep-lookup)
+[![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/@eusilvio/cep-lookup)](https://www.npmjs.com/package/@eusilvio/cep-lookup)
 [![Build Status](https://img.shields.io/github/workflow/status/eusilvio/cep-lookup/CI)](https://github.com/eusilvio/cep-lookup/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

package/dist/index.js

@@ -1,76 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CepLookup = void 0;
-exports.lookupCep = lookupCep;
-/**
- * @function validateCep
- * @description Validates and cleans a CEP string. Removes non-digit characters and checks for an 8-digit length.
- * @param {string} cep - The CEP string to validate.
- * @returns {string} The cleaned, 8-digit CEP string.
- * @throws {Error} If the CEP is invalid (not 8 digits after cleaning).
- */
-function validateCep(cep) {
-    const cleanedCep = cep.replace(/\D/g, "");
-    if (cleanedCep.length !== 8) {
-        throw new Error("Invalid CEP. It must have 8 digits.");
-    }
-    return cleanedCep;
-}
-/**
- * @class CepLookup
- * @description A class for looking up Brazilian postal codes (CEPs) using multiple providers.
- * It queries multiple services simultaneously and returns the response from the fastest one.
- */
-class CepLookup {
-    /**
-     * @constructor
-     * @param {CepLookupOptions} options - The options for initializing the CepLookup instance.
-     */
-    constructor(options) {
-        this.providers = options.providers;
-        this.fetcher = options.fetcher || (async (url) => {
-            const response = await fetch(url);
-            if (!response.ok) {
-                throw new Error(`HTTP error! status: ${response.status}`);
-            }
-            return response.json();
-        });
-    }
-    /**
-     * @method lookup
-     * @description Looks up an address for a given CEP.
-     * @template T - The expected return type, defaults to `Address`.
-     * @param {string} cep - The CEP to be queried.
-     * @param {(address: Address) => T} [mapper] - An optional function to transform the `Address` object into a custom format `T`.
-     * @returns {Promise<T>} A Promise that resolves to the address in the default `Address` format or a custom format `T` if a mapper is provided.
-     * @throws {Error} If the CEP is invalid or if all providers fail to find the CEP.
-     */
-    async lookup(cep, mapper) {
-        const cleanedCep = validateCep(cep);
-        const promises = this.providers.map((provider) => {
-            const url = provider.buildUrl(cleanedCep);
-            return this.fetcher(url)
-                .then((response) => provider.transform(response))
-                .then((address) => (mapper ? mapper(address) : address));
-        });
-        return Promise.any(promises);
-    }
-}
-exports.CepLookup = CepLookup;
-/**
- * @function lookupCep
- * @description Backward-compatible function for looking up a CEP. Internally creates a `CepLookup` instance.
- * @template T - The expected return type, defaults to `Address`.
- * @param {object} options - Options for the lookup.
- * @param {string} options.cep - The CEP to be queried.
- * @param {Provider[]} options.providers - An array of `Provider` instances.
- * @param {Fetcher} [options.fetcher] - The `Fetcher` function. Defaults to global `fetch` if not provided.
- * @param {(address: Address) => T} [options.mapper] - An optional function to transform the `Address` object.
- * @returns {Promise<T>} A Promise that resolves to the address.
- * @throws {Error} If the CEP is invalid or if all providers fail.
- */
-function lookupCep(options) {
-    const { cep, providers, fetcher, mapper } = options;
-    const cepLookup = new CepLookup({ providers, fetcher });
-    return cepLookup.lookup(cep, mapper);
-}
+"use strict";var c=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var l=(e,r)=>{for(var s in r)c(e,s,{get:r[s],enumerable:!0})},f=(e,r,s,t)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of u(r))!h.call(e,o)&&o!==s&&c(e,o,{get:()=>r[o],enumerable:!(t=a(r,o))||t.enumerable});return e};var v=e=>f(c({},"__esModule",{value:!0}),e);var T={};l(T,{CepLookup:()=>p,lookupCep:()=>k});module.exports=v(T);function m(e){let r=e.replace(/\D/g,"");if(r.length!==8)throw new Error("Invalid CEP. It must have 8 digits.");return r}var p=class{constructor(r){this.providers=r.providers,this.fetcher=r.fetcher||(async s=>{let t=await fetch(s);if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return t.json()})}async lookup(r,s){let t=m(r),o=this.providers.map(i=>{let d=i.buildUrl(t);return this.fetcher(d).then(n=>i.transform(n)).then(n=>s?s(n):n)});return Promise.any(o)}};function k(e){let{cep:r,providers:s,fetcher:t,mapper:o}=e;return new p({providers:s,fetcher:t}).lookup(r,o)}0&&(module.exports={CepLookup,lookupCep});

package/dist/providers/index.js

@@ -1,19 +1 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./viacep"), exports);
-__exportStar(require("./brasil-api"), exports);
-__exportStar(require("./apicep"), exports);
+"use strict";var e=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var m=(r,t)=>{for(var o in t)e(r,o,{get:t[o],enumerable:!0})},p=(r,t,o,d)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of c(t))!s.call(r,i)&&i!==o&&e(r,i,{get:()=>t[i],enumerable:!(d=a(t,i))||d.enumerable});return r};var P=r=>p(e({},"__esModule",{value:!0}),r);var f={};m(f,{apicepProvider:()=>l,brasilApiProvider:()=>v,viaCepProvider:()=>n});module.exports=P(f);var n={name:"ViaCEP",buildUrl:r=>`https://viacep.com.br/ws/${r}/json/`,transform:r=>{if(r.erro)throw new Error("CEP not found");return{cep:r.cep,state:r.uf,city:r.localidade,neighborhood:r.bairro,street:r.logradouro,service:"ViaCEP"}}};var v={name:"BrasilAPI",buildUrl:r=>`https://brasilapi.com.br/api/cep/v1/${r}`,transform:r=>({cep:r.cep,state:r.state,city:r.city,neighborhood:r.neighborhood,street:r.street,service:"BrasilAPI"})};var l={name:"ApiCEP",buildUrl:r=>`https://cdn.apicep.com/file/apicep/${r}.json`,transform:r=>({cep:r.code,state:r.state,city:r.city,neighborhood:r.district,street:r.address,service:"ApiCEP"})};0&&(module.exports={apicepProvider,brasilApiProvider,viaCepProvider});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eusilvio/cep-lookup",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A modern, flexible, and agnostic CEP lookup library written in TypeScript.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,9 @@
     "./providers": "./dist/providers/index.js"
   },
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc --emitDeclarationOnly --outDir dist && esbuild src/index.ts src/providers/index.ts --outdir=dist --bundle --platform=node --format=cjs",
+    "build:prod": "npm run clean && tsc --emitDeclarationOnly --outDir dist && esbuild src/index.ts src/providers/index.ts --outdir=dist --bundle --platform=node --format=cjs --minify",
     "test": "jest",
     "example": "ts-node -r tsconfig-paths/register examples/example.ts",
     "custom-example": "ts-node -r tsconfig-paths/register examples/custom-provider-example.ts",
@@ -28,7 +30,7 @@
     "address",
     "correios"
   ],
-  "author": "",
+  "author": "Silvio Campos",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -40,6 +42,7 @@
   "homepage": "https://github.com/eusilvio/cep-lookup#readme",
   "devDependencies": {
     "@types/jest": "^30.0.0",
+    "esbuild": "^0.20.2",
     "jest": "^30.1.3",
     "ts-jest": "^29.4.4",
     "ts-node": "^10.9.2",

package/dist/providers/apicep.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apicepProvider = void 0;
-/**
- * @const {Provider} apicepProvider
- * @description Provider for the ApiCEP service.
- * @property {string} name - "ApiCEP".
- * @property {(cep: string) => string} buildUrl - Constructs the URL for ApiCEP.
- * @property {(response: any) => Address} transform - Transforms ApiCEP's response into a standardized `Address` object.
- */
-exports.apicepProvider = {
-    name: "ApiCEP",
-    buildUrl: (cep) => `https://cdn.apicep.com/file/apicep/${cep}.json`,
-    transform: (response) => {
-        return {
-            cep: response.code,
-            state: response.state,
-            city: response.city,
-            neighborhood: response.district,
-            street: response.address,
-            service: "ApiCEP",
-        };
-    },
-};

package/dist/providers/brasil-api.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.brasilApiProvider = void 0;
-/**
- * @const {Provider} brasilApiProvider
- * @description Provider for the BrasilAPI service.
- * @property {string} name - "BrasilAPI".
- * @property {(cep: string) => string} buildUrl - Constructs the URL for BrasilAPI.
- * @property {(response: any) => Address} transform - Transforms BrasilAPI's response into a standardized `Address` object.
- */
-exports.brasilApiProvider = {
-    name: "BrasilAPI",
-    buildUrl: (cep) => `https://brasilapi.com.br/api/cep/v1/${cep}`,
-    transform: (response) => {
-        return {
-            cep: response.cep,
-            state: response.state,
-            city: response.city,
-            neighborhood: response.neighborhood,
-            street: response.street,
-            service: "BrasilAPI",
-        };
-    },
-};

package/dist/providers/viacep.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.viaCepProvider = void 0;
-/**
- * @const {Provider} viaCepProvider
- * @description Provider for the ViaCEP service.
- * @property {string} name - "ViaCEP".
- * @property {(cep: string) => string} buildUrl - Constructs the URL for ViaCEP API.
- * @property {(response: any) => Address} transform - Transforms ViaCEP's response into a standardized `Address` object.
- * @throws {Error} If ViaCEP response indicates an error (e.g., CEP not found).
- */
-exports.viaCepProvider = {
-    name: "ViaCEP",
-    buildUrl: (cep) => `https://viacep.com.br/ws/${cep}/json/`,
-    transform: (response) => {
-        if (response.erro) {
-            throw new Error("CEP not found");
-        }
-        return {
-            cep: response.cep,
-            state: response.uf,
-            city: response.localidade,
-            neighborhood: response.bairro,
-            street: response.logradouro,
-            service: "ViaCEP",
-        };
-    },
-};

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });