@eusilvio/cep-lookup-react 0.3.2 → 0.4.1

package/README.md

@@ -12,6 +12,12 @@ npm install @eusilvio/cep-lookup @eusilvio/cep-lookup-react react
 yarn add @eusilvio/cep-lookup @eusilvio/cep-lookup-react react
 ```
 
+## Compatibility
+
+- React: `>= 16.8`
+- Node.js (for tooling/tests): `20.x`, `22.x`, `24.x`
+- Support policy: [SUPPORT.md](../../SUPPORT.md)
+
 ## Basic Usage
 
 Wrap your application or component tree with the `CepProvider` and use the `useCepLookup` hook anywhere inside it.
@@ -91,4 +97,11 @@ A React hook that performs the CEP lookup with built-in race condition protectio
 
 **Returns**
 
-An object with `address` (typed as `T`), `loading`, and `error`.
+An object with `address` (typed as `T`), `loading`, `error`, and `warmup`.
+
+- `warmup`: `() => Promise<void>` - Function to trigger provider ranking optimization. Best used on `onFocus` events.
+
+## Community
+
+- Contributing guide: [CONTRIBUTING.md](../../CONTRIBUTING.md)
+- Code of conduct: [CODE_OF_CONDUCT.md](../../CODE_OF_CONDUCT.md)

package/dist/CepProvider.d.ts

@@ -12,7 +12,7 @@ interface CepProviderProps<T = Address> extends Partial<CepLookupOptions> {
     onFailure?: (event: EventMap['failure']) => void;
     onCacheHit?: (event: EventMap['cache:hit']) => void;
 }
-export declare const CepProvider: <T>({ children, mapper, onSuccess, onFailure, onCacheHit, ...options }: CepProviderProps<T>) => import("react/jsx-runtime").JSX.Element;
+export declare const CepProvider: <T>({ children, mapper, onSuccess, onFailure, onCacheHit, providers, cache, rateLimit, staggerDelay, fetcher, }: 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,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"}
+{"version":3,"file":"CepProvider.d.ts","sourceRoot":"","sources":["../src/CepProvider.tsx"],"names":[],"mappings":"AAMA,OAAc,EAEZ,SAAS,EAKV,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,6GAW7B,gBAAgB,CAAC,CAAC,CAAC,4CAmDrB,CAAC;AAEF,eAAO,MAAM,oBAAoB,4BAOhC,CAAC"}

package/dist/index.cjs

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

package/dist/index.mjs

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

package/dist/useBulkCepLookup.d.ts

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

package/dist/useBulkCepLookup.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"useBulkCepLookup.d.ts","sourceRoot":"","sources":["../src/useBulkCepLookup.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAG9D,eAAO,MAAM,gBAAgB,GAAI,CAAC,GAAG,OAAO,EAC1C,MAAM,MAAM,EAAE,EACd,UAAU;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;CA2DnC,CAAC"}

package/dist/useCepLookup.d.ts

@@ -3,5 +3,6 @@ export declare const useCepLookup: <T = Address>(cep: string, delay?: number) =>
     address: T | null;
     error: Error | null;
     loading: boolean;
+    warmup: () => Promise<import("@eusilvio/cep-lookup").Provider[]>;
 };
 //# 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":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,eAAO,MAAM,YAAY,GAAI,CAAC,GAAG,OAAO,EAAE,KAAK,MAAM,EAAE,cAAW;;;;CAmDjE,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;;;;;CAsDjE,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eusilvio/cep-lookup-react",
-  "version": "0.3.2",
-  "description": "React hook for cep-lookup.",
+  "version": "0.4.1",
+  "description": "React hooks and provider for @eusilvio/cep-lookup",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -12,7 +12,7 @@
     }
   },
   "peerDependencies": {
-    "@eusilvio/cep-lookup": "^2.3.2",
+    "@eusilvio/cep-lookup": "^2.5.1",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
   },