react-api-call-optimizer 0.0.0 → 0.1.1

package/README.md

@@ -1,18 +1,9 @@
-# React + Vite
+# react-api-call-optimizer
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+**A lightweight React hook to optimize API calls with caching, retries, throttling, and polling.**
 
-Currently, two official plugins are available:
+## Installation
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## React Compiler
-
-The React Compiler is enabled on this template. See [this documentation](https://react.dev/learn/react-compiler) for more information.
-
-Note: This will impact Vite dev & build performances.
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
+```bash
+npm install react-api-call-optimizer
+```

package/dist/api-optimizer.es.js

@@ -1,46 +1,63 @@
-import { useState as o, useRef as w, useEffect as x } from "react";
-const a = {}, n = {};
-function A(t, f, p = {}) {
-  const { retries: m = 0, cacheTime: D = 3e5, throttleTime: d = 0 } = p, [g, s] = o(null), [T, r] = o(!0), [C, c] = o(null), u = w(0), h = w(0);
-  return x(() => {
-    let i = !1;
-    async function E() {
-      r(!0), c(null);
-      const l = Date.now();
-      if (!(d && l - h.current < d)) {
-        if (h.current = l, a[t] && l - a[t].timestamp < D) {
-          s(a[t].data), r(!1);
-          return;
-        }
-        if (n[t]) {
-          try {
-            const e = await n[t];
-            if (i) return;
-            s(e), r(!1);
-          } catch (e) {
-            c(e), r(!1);
-          }
-          return;
-        }
-        n[t] = (async () => {
-          for (; u.current <= m; )
-            try {
-              const e = await f();
-              return i ? void 0 : (a[t] = { timestamp: Date.now(), data: e }, s(e), r(!1), delete n[t], e);
-            } catch (e) {
-              if (u.current += 1, u.current > m) {
-                c(e), r(!1), delete n[t];
-                return;
-              }
-            }
-        })(), await n[t];
+import { useState as d, useRef as y, useCallback as O } from "react";
+const n = {}, a = {};
+let u = {
+  cacheTime: 3e5,
+  // 5 min
+  retries: 0,
+  throttleTime: 0,
+  debug: !1
+};
+const k = (c) => Array.isArray(c) ? JSON.stringify(c) : c;
+function R(c, p, T = {}) {
+  const {
+    retries: l = u.retries,
+    cacheTime: A = u.cacheTime,
+    throttleTime: f = u.throttleTime,
+    debug: r = u.debug
+  } = T, e = k(c), [$, h] = d(
+    () => n[e] ? n[e].data : null
+  ), [b, o] = d(!1), [z, m] = d(null), i = y(0), w = y(0), s = y(null), C = O(() => {
+    r && console.log(`[API Optimizer] Cache cleared for key: ${e}`), delete n[e];
+  }, [e, r]), I = O(async () => {
+    o(!0), m(null);
+    const g = Date.now();
+    if (f && g - w.current < f) {
+      r && console.log(`[API Optimizer] Throttled request for key: ${e}`);
+      return;
+    }
+    if (w.current = g, n[e] && g - n[e].timestamp < A)
+      return r && console.log(`[API Optimizer] Cache hit for key: ${e}`), h(n[e].data), o(!1), n[e].data;
+    if (a[e]) {
+      r && console.log(
+        `[API Optimizer] Awaiting inflight request for key: ${e}`
+      );
+      try {
+        const t = await a[e];
+        return h(t), o(!1), t;
+      } catch (t) {
+        m(t), o(!1);
+        return;
       }
     }
-    return E(), () => {
-      i = !0;
-    };
-  }, [t, f]), { data: g, loading: T, error: C };
+    s.current && s.current.abort(), s.current = new AbortController();
+    const P = s.current.signal;
+    return a[e] = (async () => {
+      for (; i.current <= l; )
+        try {
+          const t = await p({ signal: P });
+          return n[e] = { timestamp: Date.now(), data: t }, h(t), o(!1), delete a[e], r && console.log(`[API Optimizer] Fetched and cached key: ${e}`), i.current = 0, t;
+        } catch (t) {
+          if (i.current += 1, r && console.log(
+            `[API Optimizer] Retry ${i.current}/${l} for key: ${e}`
+          ), i.current > l) {
+            m(t), o(!1), delete a[e];
+            return;
+          }
+        }
+    })(), await a[e];
+  }, [e, p, A, f, l, r]);
+  return { data: $, loading: b, error: z, refetch: I, clearCache: C };
 }
 export {
-  A as useApiOptimizer
+  R as useApiOptimizer
 };

package/dist/api-optimizer.umd.js

@@ -1 +1 @@
-(function(r,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("react")):typeof define=="function"&&define.amd?define(["exports","react"],t):(r=typeof globalThis<"u"?globalThis:r||self,t(r.ApiOptimizer={},r.React))})(this,(function(r,t){"use strict";const u={},i={};function w(e,d,T={}){const{retries:p=0,cacheTime:S=3e5,throttleTime:m=0}=T,[g,a]=t.useState(null),[D,s]=t.useState(!0),[O,o]=t.useState(null),c=t.useRef(0),h=t.useRef(0);return t.useEffect(()=>{let f=!1;async function z(){s(!0),o(null);const l=Date.now();if(!(m&&l-h.current<m)){if(h.current=l,u[e]&&l-u[e].timestamp<S){a(u[e].data),s(!1);return}if(i[e]){try{const n=await i[e];if(f)return;a(n),s(!1)}catch(n){o(n),s(!1)}return}i[e]=(async()=>{for(;c.current<=p;)try{const n=await d();return f?void 0:(u[e]={timestamp:Date.now(),data:n},a(n),s(!1),delete i[e],n)}catch(n){if(c.current+=1,c.current>p){o(n),s(!1),delete i[e];return}}})(),await i[e]}}return z(),()=>{f=!0}},[e,d]),{data:g,loading:D,error:O}}r.useApiOptimizer=w,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})}));
+(function(o,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("react")):typeof define=="function"&&define.amd?define(["exports","react"],t):(o=typeof globalThis<"u"?globalThis:o||self,t(o.ApiOptimizer={},o.React))})(this,(function(o,t){"use strict";const n={},s={};let u={cacheTime:3e5,retries:0,throttleTime:0,debug:!1};const T=l=>Array.isArray(l)?JSON.stringify(l):l;function b(l,y,w={}){const{retries:f=u.retries,cacheTime:A=u.cacheTime,throttleTime:h=u.throttleTime,debug:i=u.debug}=w,e=T(l),[z,m]=t.useState(()=>n[e]?n[e].data:null),[C,c]=t.useState(!1),[$,p]=t.useState(null),a=t.useRef(0),O=t.useRef(0),d=t.useRef(null),P=t.useCallback(()=>{i&&console.log(`[API Optimizer] Cache cleared for key: ${e}`),delete n[e]},[e,i]),k=t.useCallback(async()=>{c(!0),p(null);const g=Date.now();if(h&&g-O.current<h){i&&console.log(`[API Optimizer] Throttled request for key: ${e}`);return}if(O.current=g,n[e]&&g-n[e].timestamp<A)return i&&console.log(`[API Optimizer] Cache hit for key: ${e}`),m(n[e].data),c(!1),n[e].data;if(s[e]){i&&console.log(`[API Optimizer] Awaiting inflight request for key: ${e}`);try{const r=await s[e];return m(r),c(!1),r}catch(r){p(r),c(!1);return}}d.current&&d.current.abort(),d.current=new AbortController;const I=d.current.signal;return s[e]=(async()=>{for(;a.current<=f;)try{const r=await y({signal:I});return n[e]={timestamp:Date.now(),data:r},m(r),c(!1),delete s[e],i&&console.log(`[API Optimizer] Fetched and cached key: ${e}`),a.current=0,r}catch(r){if(a.current+=1,i&&console.log(`[API Optimizer] Retry ${a.current}/${f} for key: ${e}`),a.current>f){p(r),c(!1),delete s[e];return}}})(),await s[e]},[e,y,A,h,f,i]);return{data:z,loading:C,error:$,refetch:k,clearCache:P}}o.useApiOptimizer=b,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-api-call-optimizer",                  
-  "version": "0.0.0",                   
+  "version": "0.1.1",                   
   "description": "A React hook to optimize API calls",
   "main": "dist/api-optimizer.umd.js", 
   "module": "dist/api-optimizer.es.js",