@eusilvio/cep-lookup-react 0.1.0 → 0.3.0

package/README.md

@@ -72,24 +72,23 @@ A React component that provides the `CepLookup` instance to its children.
 
 It accepts all options from `CepLookupOptions` as props:
 
-- `providers` (optional): `Provider[]` - An array of CEP providers. Defaults to `[viaCepProvider, brasilApiProvider, apicepProvider]`.
-- `cache` (optional): `Cache` - A cache instance (e.g., `new InMemoryCache()`). Defaults to a new `InMemoryCache` instance.
+- `providers` (optional): `Provider[]` - An array of CEP providers.
+- `cache` (optional): `Cache` - A cache instance. Defaults to a persistent `InMemoryCache`.
 - `rateLimit` (optional): `RateLimitOptions` - Options for rate limiting.
-- `fetcher` (optional): `Fetcher` - A custom fetch implementation.
+- `mapper` (optional): `(address: Address) => T` - A function to transform the address object globally.
+- `onSuccess` (optional): `(event) => void` - Callback triggered on successful lookups.
+- `onFailure` (optional): `(event) => void` - Callback triggered on lookup failures.
+- `onCacheHit` (optional): `(event) => void` - Callback triggered on cache hits.
 
-### `useCepLookup(cep: string, debounceTime?: number)`
+### `useCepLookup<T = Address>(cep: string, delay?: number)`
 
-A React hook that performs the CEP lookup.
+A React hook that performs the CEP lookup with built-in race condition protection.
 
 **Parameters**
 
 - `cep`: `string` - The CEP to look up.
-- `debounceTime` (optional): `number` - The debounce time in milliseconds before the lookup is triggered. Defaults to `500`.
+- `delay` (optional): `number` - The debounce delay in milliseconds. Defaults to `500`.
 
 **Returns**
 
-An object with the following properties:
-
-- `address`: `Address | null` - The found address object, or `null` if not found or not yet loaded.
-- `loading`: `boolean` - `true` when a lookup is in progress.
-- `error`: `Error | null` - An `Error` object if the lookup fails, otherwise `null`.
+An object with `address` (typed as `T`), `loading`, and `error`.

package/dist/CepProvider.d.ts

@@ -1,18 +1,18 @@
-import React, { ReactNode } from "react";
+import { ReactNode } from "react";
 import { Address, CepLookup, CepLookupOptions, EventMap } from "@eusilvio/cep-lookup";
-export interface CepContextValue {
+export interface CepContextValue<T = Address> {
     instance: CepLookup;
-    mapper?: (address: Address) => any;
+    mapper?: (address: Address) => T;
     options: CepLookupOptions;
 }
-interface CepProviderProps extends Partial<CepLookupOptions> {
+interface CepProviderProps<T = Address> extends Partial<CepLookupOptions> {
     children: ReactNode;
-    mapper?: (address: Address) => any;
+    mapper?: (address: Address) => T;
     onSuccess?: (event: EventMap['success']) => void;
     onFailure?: (event: EventMap['failure']) => void;
     onCacheHit?: (event: EventMap['cache:hit']) => void;
 }
-export declare const CepProvider: React.FC<CepProviderProps>;
-export declare const useCepLookupInstance: () => CepContextValue;
+export declare const CepProvider: <T>({ children, mapper, onSuccess, onFailure, onCacheHit, ...options }: CepProviderProps<T>) => import("react/jsx-runtime").JSX.Element;
+export declare const useCepLookupInstance: () => CepContextValue<any>;
 export {};
 //# sourceMappingURL=CepProvider.d.ts.map

package/dist/CepProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CepProvider.d.ts","sourceRoot":"","sources":["../src/CepProvider.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAEZ,SAAS,EAIV,MAAM,OAAO,CAAC;AACf,OAAO,EACL,OAAO,EACP,SAAS,EACT,gBAAgB,EAEhB,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAS9B,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,GAAG,CAAC;IAEnC,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAQD,UAAU,gBAAiB,SAAQ,OAAO,CAAC,gBAAgB,CAAC;IAC1D,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,GAAG,CAAC;IAEnC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;IACjD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACrD;AAED,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,CA2DlD,CAAC;AAEF,eAAO,MAAM,oBAAoB,uBAOhC,CAAC"}
+{"version":3,"file":"CepProvider.d.ts","sourceRoot":"","sources":["../src/CepProvider.tsx"],"names":[],"mappings":"AAKA,OAAc,EAEZ,SAAS,EAIV,MAAM,OAAO,CAAC;AACf,OAAO,EACL,OAAO,EACP,SAAS,EACT,gBAAgB,EAEhB,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAU9B,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO;IAC1C,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,CAAC;IACjC,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAQD,UAAU,gBAAgB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,OAAO,CAAC,gBAAgB,CAAC;IACvE,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,CAAC;IAEjC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;IACjD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;IACjD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACrD;AAED,eAAO,MAAM,WAAW,GAAI,CAAC,EAAG,oEAO7B,gBAAgB,CAAC,CAAC,CAAC,4CAkDrB,CAAC;AAEF,eAAO,MAAM,oBAAoB,4BAOhC,CAAC"}

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var T=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var I=Object.prototype.hasOwnProperty;var M=(e,r)=>{for(var n in r)T(e,n,{get:r[n],enumerable:!0})},B=(e,r,n,t)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of b(r))!I.call(e,o)&&o!==n&&T(e,o,{get:()=>r[o],enumerable:!(t=A(r,o))||t.enumerable});return e};var O=e=>B(T({},"__esModule",{value:!0}),e);var D={};M(D,{CepProvider:()=>N,useBulkCepLookup:()=>j,useCepLookup:()=>V,useCepLookupInstance:()=>L});module.exports=O(D);var f=require("react");var k=require("@eusilvio/cep-lookup/providers"),l=require("react"),h=require("@eusilvio/cep-lookup"),R=require("react/jsx-runtime"),y=[k.viaCepProvider,k.brasilApiProvider,k.apicepProvider],E=new h.InMemoryCache,g=new h.CepLookup({providers:y,cache:E}),P=(0,l.createContext)({instance:g,options:{providers:y,cache:E}}),N=({children:e,mapper:r,onSuccess:n,onFailure:t,onCacheHit:o,...s})=>{let u=(0,l.useMemo)(()=>Object.keys(s).length?new h.CepLookup({providers:y,cache:E,...s}):g,[s]);(0,l.useEffect)(()=>(n&&u.on("success",n),t&&u.on("failure",t),o&&u.on("cache:hit",o),()=>{n&&u.off("success",n),t&&u.off("failure",t),o&&u.off("cache:hit",o)}),[u,n,t,o]);let p=(0,l.useMemo)(()=>({instance:u,mapper:r,options:{providers:y,cache:E,...s}}),[u,r,s]);return(0,R.jsx)(P.Provider,{value:p,children:e})},L=()=>{let e=(0,l.useContext)(P);if(!e)throw new Error("useCepLookupInstance must be used within a CepProvider");return e};var V=(e,r=500)=>{let[n,t]=(0,f.useState)(null),[o,s]=(0,f.useState)(null),[u,p]=(0,f.useState)(!1),{instance:v,mapper:d}=L(),i=(0,f.useRef)(null);return(0,f.useEffect)(()=>{let m=e.replace(/\D/g,"");return i.current&&clearTimeout(i.current),m.length===8?(p(!0),s(null),i.current=setTimeout(async()=>{try{let c=await v.lookup(m);t(d?d(c):c),s(null)}catch(c){s(c instanceof Error?c:new Error(String(c))),t(null)}finally{p(!1)}},r)):(t(null),s(null),p(!1)),()=>{i.current&&clearTimeout(i.current)}},[e,r,v,d]),{address:n,error:o,loading:u}};var a=require("react");var j=(e,r)=>{let[n,t]=(0,a.useState)([]),[o,s]=(0,a.useState)(!1),[u,p]=(0,a.useState)(null),{instance:v,mapper:d}=L(),i=(0,a.useRef)([]),m=(0,a.useCallback)(async()=>{if(!e||e.length===0){t([]),s(!1),p(null);return}let c=e.map(C=>C.replace(/\D/g,""));if(c.join(",")!==i.current.join(",")){i.current=c,s(!0),p(null);try{let w=(await v.lookupCeps(c,r?.concurrency)).map(x=>({...x,data:x.data&&d?d(x.data):x.data}));t(w)}catch(C){p(C instanceof Error?C:new Error(String(C))),t([])}finally{s(!1)}}},[e,r?.concurrency,v,d]);return(0,a.useEffect)(()=>{m()},[m]),{results:n,loading:o,error:u,refresh:m}};

package/dist/index.mjs

@@ -0,0 +1 @@
+import{useEffect as O,useState as h,useRef as N}from"react";import{apicepProvider as P,brasilApiProvider as R,viaCepProvider as w}from"@eusilvio/cep-lookup/providers";import{createContext as A,useContext as b,useEffect as I,useMemo as x}from"react";import{CepLookup as y,InMemoryCache as M}from"@eusilvio/cep-lookup";import{jsx as B}from"react/jsx-runtime";var C=[w,R,P],k=new M,E=new y({providers:C,cache:k}),T=A({instance:E,options:{providers:C,cache:k}}),X=({children:o,mapper:a,onSuccess:s,onFailure:r,onCacheHit:u,...e})=>{let t=x(()=>Object.keys(e).length?new y({providers:C,cache:k,...e}):E,[e]);I(()=>(s&&t.on("success",s),r&&t.on("failure",r),u&&t.on("cache:hit",u),()=>{s&&t.off("success",s),r&&t.off("failure",r),u&&t.off("cache:hit",u)}),[t,s,r,u]);let c=x(()=>({instance:t,mapper:a,options:{providers:C,cache:k,...e}}),[t,a,e]);return B(T.Provider,{value:c,children:o})},v=()=>{let o=b(T);if(!o)throw new Error("useCepLookupInstance must be used within a CepProvider");return o};var F=(o,a=500)=>{let[s,r]=h(null),[u,e]=h(null),[t,c]=h(!1),{instance:d,mapper:l}=v(),p=N(null);return O(()=>{let i=o.replace(/\D/g,"");return p.current&&clearTimeout(p.current),i.length===8?(c(!0),e(null),p.current=setTimeout(async()=>{try{let n=await d.lookup(i);r(l?l(n):n),e(null)}catch(n){e(n instanceof Error?n:new Error(String(n))),r(null)}finally{c(!1)}},a)):(r(null),e(null),c(!1)),()=>{p.current&&clearTimeout(p.current)}},[o,a,d,l]),{address:s,error:u,loading:t}};import{useState as L,useEffect as V,useCallback as j,useRef as D}from"react";var te=(o,a)=>{let[s,r]=L([]),[u,e]=L(!1),[t,c]=L(null),{instance:d,mapper:l}=v(),p=D([]),i=j(async()=>{if(!o||o.length===0){r([]),e(!1),c(null);return}let n=o.map(f=>f.replace(/\D/g,""));if(n.join(",")!==p.current.join(",")){p.current=n,e(!0),c(null);try{let g=(await d.lookupCeps(n,a?.concurrency)).map(m=>({...m,data:m.data&&l?l(m.data):m.data}));r(g)}catch(f){c(f instanceof Error?f:new Error(String(f))),r([])}finally{e(!1)}}},[o,a?.concurrency,d,l]);return V(()=>{i()},[i]),{results:s,loading:u,error:t,refresh:i}};export{X as CepProvider,te as useBulkCepLookup,F as useCepLookup,v as useCepLookupInstance};

package/dist/useBulkCepLookup.d.ts

@@ -1,10 +1,10 @@
 import { BulkCepResult } from '@eusilvio/cep-lookup';
-export declare const useBulkCepLookup: (ceps: string[], options?: {
+export declare const useBulkCepLookup: <T = any>(ceps: string[], options?: {
     concurrency?: number;
 }) => {
     results: BulkCepResult[];
     loading: boolean;
-    error: Error;
-    performBulkLookup: () => Promise<void>;
+    error: Error | null;
+    refresh: () => Promise<void>;
 };
 //# sourceMappingURL=useBulkCepLookup.d.ts.map

package/dist/useBulkCepLookup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useBulkCepLookup.d.ts","sourceRoot":"","sources":["../src/useBulkCepLookup.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,aAAa,EAAoB,MAAM,sBAAsB,CAAC;AAGnF,eAAO,MAAM,gBAAgB,GAC3B,MAAM,MAAM,EAAE,EACd,UAAU;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;CAgDnC,CAAC"}
+{"version":3,"file":"useBulkCepLookup.d.ts","sourceRoot":"","sources":["../src/useBulkCepLookup.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,eAAO,MAAM,gBAAgB,GAAI,CAAC,GAAG,GAAG,EACtC,MAAM,MAAM,EAAE,EACd,UAAU;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;CAgDnC,CAAC"}

package/dist/useCepLookup.d.ts

@@ -1,6 +1,7 @@
-export declare const useCepLookup: (cep: string, debounceTime?: number) => {
-    address: any;
-    error: Error;
+import { Address } from "@eusilvio/cep-lookup";
+export declare const useCepLookup: <T = Address>(cep: string, delay?: number) => {
+    address: T | null;
+    error: Error | null;
     loading: boolean;
 };
 //# sourceMappingURL=useCepLookup.d.ts.map

package/dist/useCepLookup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCepLookup.d.ts","sourceRoot":"","sources":["../src/useCepLookup.ts"],"names":[],"mappings":"AAkBA,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,EAAE,qBAAkB;;;;CAmC3D,CAAC"}
+{"version":3,"file":"useCepLookup.d.ts","sourceRoot":"","sources":["../src/useCepLookup.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,eAAO,MAAM,YAAY,GAAI,CAAC,GAAG,OAAO,EAAE,KAAK,MAAM,EAAE,cAAW;;;;CAmDjE,CAAC"}

package/package.json

@@ -1,47 +1,49 @@
 {
   "name": "@eusilvio/cep-lookup-react",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "React hook for cep-lookup.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "clean": "rm -rf dist && rm tsconfig.tsbuildinfo",
-    "build": "npm run clean && tsc --build && esbuild src/index.ts --bundle --platform=neutral --format=cjs --outdir=dist --minify --external:react --external:@eusilvio/cep-lookup",
-    "test": "jest"
-  },
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
   },
   "peerDependencies": {
-    "@eusilvio/cep-lookup": "^2.0.1",
+    "@eusilvio/cep-lookup": "^2.3.0",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
   },
   "files": [
     "dist"
   ],
+  "scripts": {
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "build": "npm run clean && tsc --build && esbuild src/index.ts --bundle --platform=neutral --format=cjs --outdir=dist --out-extension:.js=.cjs --minify --external:react --external:@eusilvio/cep-lookup && esbuild src/index.ts --bundle --platform=neutral --format=esm --outdir=dist --out-extension:.js=.mjs --minify --external:react --external:@eusilvio/cep-lookup",
+    "test": "jest --passWithNoTests"
+  },
   "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^15.0.7",
+    "@types/jest": "^30.0.0",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
+    "esbuild": "^0.27.2",
     "jest": "^30.1.3",
-    "ts-jest": "^29.4.4",
-    "@types/jest": "^30.0.0",
     "jest-environment-jsdom": "^29.7.0",
-    "@testing-library/react": "^15.0.7",
-    "@testing-library/jest-dom": "^6.9.1",
-    "esbuild": "^0.20.2"
+    "ts-jest": "^29.4.4"
   },
   "license": "MIT",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/eusilvio/cep-lookup.git"
+    "url": "https://github.com/eusilvio/cep-lookup.git",
+    "directory": "packages/cep-lookup-react"
   },
   "bugs": {
     "url": "https://github.com/eusilvio/cep-lookup/issues"

package/dist/index.js

@@ -1 +0,0 @@
-var x=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var I=Object.getOwnPropertyNames;var A=Object.prototype.hasOwnProperty;var M=(e,t)=>{for(var o in t)x(e,o,{get:t[o],enumerable:!0})},O=(e,t,o,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of I(t))!A.call(e,n)&&n!==o&&x(e,n,{get:()=>t[n],enumerable:!(r=b(t,n))||r.enumerable});return e};var B=e=>O(x({},"__esModule",{value:!0}),e);var F={};M(F,{CepProvider:()=>N,useBulkCepLookup:()=>D,useCepLookup:()=>V,useCepLookupInstance:()=>L});module.exports=B(F);var f=require("react");var v=require("@eusilvio/cep-lookup/providers"),p=require("react"),d=require("@eusilvio/cep-lookup"),w=require("react/jsx-runtime"),y=[v.viaCepProvider,v.brasilApiProvider,v.apicepProvider],P=new d.CepLookup({providers:y,cache:new d.InMemoryCache}),g=(0,p.createContext)({instance:P,options:{providers:y,cache:new d.InMemoryCache}}),N=({children:e,mapper:t,onSuccess:o,onFailure:r,onCacheHit:n,...s})=>{let a=(0,p.useMemo)(()=>Object.keys(s).length?new d.CepLookup({providers:y,cache:new d.InMemoryCache,...s}):P,[s]);(0,p.useEffect)(()=>(o&&a.on("success",o),r&&a.on("failure",r),n&&a.on("cache:hit",n),()=>{o&&a.off("success",o),r&&a.off("failure",r),n&&a.off("cache:hit",n)}),[a,o,r,n]);let c=(0,p.useMemo)(()=>({instance:a,mapper:t,options:{providers:y,cache:new d.InMemoryCache,...s}}),[a,t,s]);return(0,w.jsx)(g.Provider,{value:c,children:e})},L=()=>{let e=(0,p.useContext)(g);if(!e)throw new Error("useCepLookupInstance must be used within a CepProvider");return e};function T(e,t){let o;return(...r)=>new Promise(n=>{o&&clearTimeout(o),o=setTimeout(()=>n(e(...r)),t)})}var V=(e,t=500)=>{let[o,r]=(0,f.useState)(null),[n,s]=(0,f.useState)(null),[a,c]=(0,f.useState)(!1),{instance:h,mapper:C}=L(),u=(0,f.useCallback)(T(async i=>{c(!0),s(null);try{let l=await h.lookup(i);r(C?C(l):l)}catch(l){s(l),r(null)}finally{c(!1)}},t),[t,h,C]);return(0,f.useEffect)(()=>{let i=e.replace(/\D/g,"");i.length===8?u(i):(r(null),s(null))},[e,u]),{address:o,error:n,loading:a}};var m=require("react"),E=require("@eusilvio/cep-lookup");var D=(e,t)=>{let[o,r]=(0,m.useState)([]),[n,s]=(0,m.useState)(!1),[a,c]=(0,m.useState)(null),{instance:h,mapper:C,options:u}=L(),i=(0,m.useCallback)(async()=>{if(!e||e.length===0){r([]),s(!1),c(null);return}s(!0),c(null);try{let l=e.map(k=>k.replace(/\D/g,"")),R=(await(0,E.lookupCeps)({ceps:l,providers:u.providers,cache:u.cache,fetcher:u.fetcher,rateLimit:u.rateLimit,concurrency:t?.concurrency})).map(k=>({...k,data:k.data&&C?C(k.data):k.data}));r(R)}catch(l){c(l),r([])}finally{s(!1)}},[e,t,h,C,u]);return(0,m.useEffect)(()=>{i()},[i]),{results:o,loading:n,error:a,performBulkLookup:i}};