@eusilvio/cep-lookup 1.2.1 → 1.2.2

package/dist/index.js

@@ -0,0 +1,147 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CepLookup: () => CepLookup,
+  InMemoryCache: () => InMemoryCache,
+  lookupCep: () => lookupCep
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/cache/index.ts
+var InMemoryCache = class {
+  constructor() {
+    this.cache = /* @__PURE__ */ new Map();
+  }
+  /**
+   * @method get
+   * @description Retrieves an address from the cache.
+   * @param {string} key - The CEP to look up.
+   * @returns {Address | undefined} The cached address or undefined if not found.
+   */
+  get(key) {
+    return this.cache.get(key);
+  }
+  /**
+   * @method set
+   * @description Stores an address in the cache.
+   * @param {string} key - The CEP to use as the cache key.
+   * @param {Address} value - The address to store.
+   */
+  set(key, value) {
+    this.cache.set(key, value);
+  }
+  /**
+   * @method clear
+   * @description Clears the entire cache.
+   */
+  clear() {
+    this.cache.clear();
+  }
+};
+
+// src/index.ts
+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;
+}
+var CepLookup = class {
+  /**
+   * @constructor
+   * @param {CepLookupOptions} options - The options for initializing the CepLookup instance.
+   */
+  constructor(options) {
+    this.providers = options.providers;
+    this.fetcher = options.fetcher || (async (url, signal) => {
+      const response = await fetch(url, { signal });
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+      return response.json();
+    });
+    this.cache = options.cache;
+  }
+  /**
+   * @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);
+    if (this.cache) {
+      const cachedAddress = this.cache.get(cleanedCep);
+      if (cachedAddress) {
+        return Promise.resolve(mapper ? mapper(cachedAddress) : cachedAddress);
+      }
+    }
+    const controller = new AbortController();
+    const { signal } = controller;
+    const promises = this.providers.map((provider) => {
+      const url = provider.buildUrl(cleanedCep);
+      const timeoutPromise = new Promise((resolve, reject) => {
+        let timeoutId;
+        const onAbort = () => {
+          clearTimeout(timeoutId);
+          reject(new DOMException("Aborted", "AbortError"));
+        };
+        if (provider.timeout) {
+          timeoutId = setTimeout(() => {
+            signal.removeEventListener("abort", onAbort);
+            reject(new Error(`Timeout from ${provider.name}`));
+          }, provider.timeout);
+          signal.addEventListener("abort", onAbort, { once: true });
+        } else {
+          signal.addEventListener("abort", onAbort, { once: true });
+        }
+      });
+      const fetchPromise = this.fetcher(url, signal).then((response) => provider.transform(response)).then((address) => {
+        if (this.cache) {
+          this.cache.set(cleanedCep, address);
+        }
+        return mapper ? mapper(address) : address;
+      });
+      return Promise.race([fetchPromise, timeoutPromise]);
+    });
+    try {
+      return await Promise.any(promises);
+    } finally {
+      controller.abort();
+    }
+  }
+};
+function lookupCep(options) {
+  const { cep, providers, fetcher, mapper, cache } = options;
+  const cepLookup = new CepLookup({ providers, fetcher, cache });
+  return cepLookup.lookup(cep, mapper);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CepLookup,
+  InMemoryCache,
+  lookupCep
+});

package/dist/providers/index.js

@@ -0,0 +1,84 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/providers/index.ts
+var providers_exports = {};
+__export(providers_exports, {
+  apicepProvider: () => apicepProvider,
+  brasilApiProvider: () => brasilApiProvider,
+  viaCepProvider: () => viaCepProvider
+});
+module.exports = __toCommonJS(providers_exports);
+
+// src/providers/viacep.ts
+var 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"
+    };
+  }
+};
+
+// src/providers/brasil-api.ts
+var 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"
+    };
+  }
+};
+
+// src/providers/apicep.ts
+var 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"
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  apicepProvider,
+  brasilApiProvider,
+  viaCepProvider
+});

package/package.json

@@ -1,21 +1,12 @@
 {
   "name": "@eusilvio/cep-lookup",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A modern, flexible, and agnostic CEP lookup library written in TypeScript.",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/index.d.ts"
-    },
-    "./providers": {
-      "import": "./dist/esm/providers/index.js",
-      "require": "./dist/cjs/providers/index.js",
-      "types": "./dist/providers/index.d.ts"
-    }
+    ".": "./dist/index.js",
+    "./providers": "./dist/providers/index.js"
   },
   "sideEffects": false,
   "files": [
@@ -26,11 +17,8 @@
   },
   "scripts": {
     "clean": "rm -rf dist",
-    "type:check": "tsc --noEmit",
-    "build": "npm run clean && npm run type:check && npm run build:types && npm run build:esm && npm run build:cjs",
-    "build:types": "tsc --emitDeclarationOnly --outDir dist --rootDir src",
-    "build:esm": "esbuild src/index.ts --outdir=dist/esm --format=esm --platform=neutral --minify && esbuild src/providers/*.ts --outdir=dist/esm/providers --format=esm --platform=neutral --minify",
-    "build:cjs": "esbuild src/index.ts --outdir=dist/cjs --format=cjs --platform=node --minify && esbuild src/providers/*.ts --outdir=dist/cjs/providers --format=cjs --platform=node --minify",
+    "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"
   },
   "keywords": [

package/dist/cjs/index.js

@@ -1 +0,0 @@
-"use strict";var p=Object.defineProperty;var C=Object.getOwnPropertyDescriptor;var k=Object.getOwnPropertyNames;var P=Object.prototype.hasOwnProperty;var g=(o,e)=>{for(var r in e)p(o,r,{get:e[r],enumerable:!0})},A=(o,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of k(e))!P.call(o,t)&&t!==r&&p(o,t,{get:()=>e[t],enumerable:!(n=C(e,t))||n.enumerable});return o};var b=o=>A(p({},"__esModule",{value:!0}),o);var y={};g(y,{Address:()=>s.Address,Cache:()=>h.Cache,CepLookup:()=>f,CepLookupOptions:()=>s.CepLookupOptions,Fetcher:()=>s.Fetcher,InMemoryCache:()=>h.InMemoryCache,Provider:()=>s.Provider,lookupCep:()=>L});module.exports=b(y);var s=require("./types"),h=require("./cache");function E(o){const e=o.replace(/\D/g,"");if(e.length!==8)throw new Error("Invalid CEP. It must have 8 digits.");return e}class f{constructor(e){this.providers=e.providers,this.fetcher=e.fetcher||(async(r,n)=>{const t=await fetch(r,{signal:n});if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return t.json()}),this.cache=e.cache}async lookup(e,r){const n=E(e);if(this.cache){const c=this.cache.get(n);if(c)return Promise.resolve(r?r(c):c)}const t=new AbortController,{signal:i}=t,d=this.providers.map(c=>{const v=c.buildUrl(n),T=new Promise((a,m)=>{let l;const u=()=>{clearTimeout(l),m(new DOMException("Aborted","AbortError"))};c.timeout?(l=setTimeout(()=>{i.removeEventListener("abort",u),m(new Error(`Timeout from ${c.name}`))},c.timeout),i.addEventListener("abort",u,{once:!0})):i.addEventListener("abort",u,{once:!0})}),w=this.fetcher(v,i).then(a=>c.transform(a)).then(a=>(this.cache&&this.cache.set(n,a),r?r(a):a));return Promise.race([w,T])});try{return await Promise.any(d)}finally{t.abort()}}}function L(o){const{cep:e,providers:r,fetcher:n,mapper:t,cache:i}=o;return new f({providers:r,fetcher:n,cache:i}).lookup(e,t)}0&&(module.exports={Address,Cache,CepLookup,CepLookupOptions,Fetcher,InMemoryCache,Provider,lookupCep});

package/dist/cjs/providers/apicep.js

@@ -1 +0,0 @@
-"use strict";var e=Object.defineProperty;var o=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var p=Object.prototype.hasOwnProperty;var s=(i,r)=>{for(var d in r)e(i,d,{get:r[d],enumerable:!0})},m=(i,r,d,c)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of a(r))!p.call(i,t)&&t!==d&&e(i,t,{get:()=>r[t],enumerable:!(c=o(r,t))||c.enumerable});return i};var n=i=>m(e({},"__esModule",{value:!0}),i);var v={};s(v,{apicepProvider:()=>P});module.exports=n(v);const P={name:"ApiCEP",buildUrl:i=>`https://cdn.apicep.com/file/apicep/${i}.json`,transform:i=>({cep:i.code,state:i.state,city:i.city,neighborhood:i.district,street:i.address,service:"ApiCEP"})};0&&(module.exports={apicepProvider});

package/dist/cjs/providers/brasil-api.js

@@ -1 +0,0 @@
-"use strict";var a=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var b=(r,i)=>{for(var e in i)a(r,e,{get:i[e],enumerable:!0})},l=(r,i,e,o)=>{if(i&&typeof i=="object"||typeof i=="function")for(let t of s(i))!c.call(r,t)&&t!==e&&a(r,t,{get:()=>i[t],enumerable:!(o=d(i,t))||o.enumerable});return r};var h=r=>l(a({},"__esModule",{value:!0}),r);var p={};b(p,{brasilApiProvider:()=>m});module.exports=h(p);const m={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"})};0&&(module.exports={brasilApiProvider});

package/dist/cjs/providers/index.js

@@ -1 +0,0 @@
-"use strict";var a=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var t=(f,r,p,x)=>{if(r&&typeof r=="object"||typeof r=="function")for(let m of c(r))!d.call(f,m)&&m!==p&&a(f,m,{get:()=>r[m],enumerable:!(x=b(r,m))||x.enumerable});return f},e=(f,r,p)=>(t(f,r,"default"),p&&t(p,r,"default"));var g=f=>t(a({},"__esModule",{value:!0}),f);var o={};module.exports=g(o);e(o,require("./viacep"),module.exports);e(o,require("./brasil-api"),module.exports);e(o,require("./apicep"),module.exports);0&&(module.exports={...require("./viacep"),...require("./brasil-api"),...require("./apicep")});

package/dist/cjs/providers/viacep.js

@@ -1 +0,0 @@
-"use strict";var d=Object.defineProperty;var e=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var n=Object.prototype.hasOwnProperty;var v=(r,o)=>{for(var t in o)d(r,t,{get:o[t],enumerable:!0})},P=(r,o,t,a)=>{if(o&&typeof o=="object"||typeof o=="function")for(let i of c(o))!n.call(r,i)&&i!==t&&d(r,i,{get:()=>o[i],enumerable:!(a=e(o,i))||a.enumerable});return r};var f=r=>P(d({},"__esModule",{value:!0}),r);var m={};v(m,{viaCepProvider:()=>l});module.exports=f(m);const l={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"}}};0&&(module.exports={viaCepProvider});

package/dist/esm/index.js

@@ -1 +0,0 @@
-import{Address as f,Fetcher as v,Provider as T,CepLookupOptions as w}from"./types";import{Cache as C,InMemoryCache as k}from"./cache";function P(i){const e=i.replace(/\D/g,"");if(e.length!==8)throw new Error("Invalid CEP. It must have 8 digits.");return e}class g{constructor(e){this.providers=e.providers,this.fetcher=e.fetcher||(async(r,s)=>{const o=await fetch(r,{signal:s});if(!o.ok)throw new Error(`HTTP error! status: ${o.status}`);return o.json()}),this.cache=e.cache}async lookup(e,r){const s=P(e);if(this.cache){const t=this.cache.get(s);if(t)return Promise.resolve(r?r(t):t)}const o=new AbortController,{signal:n}=o,h=this.providers.map(t=>{const d=t.buildUrl(s),m=new Promise((c,u)=>{let p;const a=()=>{clearTimeout(p),u(new DOMException("Aborted","AbortError"))};t.timeout?(p=setTimeout(()=>{n.removeEventListener("abort",a),u(new Error(`Timeout from ${t.name}`))},t.timeout),n.addEventListener("abort",a,{once:!0})):n.addEventListener("abort",a,{once:!0})}),l=this.fetcher(d,n).then(c=>t.transform(c)).then(c=>(this.cache&&this.cache.set(s,c),r?r(c):c));return Promise.race([l,m])});try{return await Promise.any(h)}finally{o.abort()}}}function E(i){const{cep:e,providers:r,fetcher:s,mapper:o,cache:n}=i;return new g({providers:r,fetcher:s,cache:n}).lookup(e,o)}export{f as Address,C as Cache,g as CepLookup,w as CepLookupOptions,v as Fetcher,k as InMemoryCache,T as Provider,E as lookupCep};

package/dist/esm/providers/apicep.js

@@ -1 +0,0 @@
-const e={name:"ApiCEP",buildUrl:i=>`https://cdn.apicep.com/file/apicep/${i}.json`,transform:i=>({cep:i.code,state:i.state,city:i.city,neighborhood:i.district,street:i.address,service:"ApiCEP"})};export{e as apicepProvider};

package/dist/esm/providers/brasil-api.js

@@ -1 +0,0 @@
-const a={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"})};export{a as brasilApiProvider};

package/dist/esm/providers/index.js

@@ -1 +0,0 @@
-export*from"./viacep";export*from"./brasil-api";export*from"./apicep";

package/dist/esm/providers/viacep.js

@@ -1 +0,0 @@
-const d={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"}}};export{d as viaCepProvider};