react-api-call-optimizer 0.0.0 → 0.1.0

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,50 @@
-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;
+import { useState as w, useRef as p, useCallback as E, useEffect as x } from "react";
+const c = {}, n = {};
+function L(t, g, D = {}) {
+  const {
+    retries: s = 0,
+    cacheTime: v = 3e5,
+    // 5 min cache
+    throttleTime: l = 0,
+    refreshInterval: o = 0
+    // auto refetch
+  } = D, [I, u] = w(null), [T, r] = w(!0), [b, i] = w(null), f = p(0), C = p(0), m = p(null), a = E(async () => {
+    r(!0), i(null);
+    const h = Date.now();
+    if (!(l && h - C.current < l)) {
+      if (C.current = h, c[t] && h - c[t].timestamp < v) {
+        u(c[t].data), r(!1);
+        return;
+      }
+      if (n[t]) {
+        try {
+          const e = await n[t];
+          u(e), r(!1);
+        } catch (e) {
+          i(e), r(!1);
         }
-        if (n[t]) {
+        return;
+      }
+      n[t] = (async () => {
+        for (; f.current <= s; )
           try {
-            const e = await n[t];
-            if (i) return;
-            s(e), r(!1);
+            const A = new AbortController().signal, d = await g({ signal: A });
+            return c[t] = { timestamp: Date.now(), data: d }, u(d), r(!1), delete n[t], d;
           } 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;
-              }
+            if (f.current += 1, f.current > s) {
+              i(e), r(!1), delete n[t];
+              return;
             }
-        })(), await n[t];
-      }
+          }
+      })(), await n[t];
     }
-    return E(), () => {
-      i = !0;
-    };
-  }, [t, f]), { data: g, loading: T, error: C };
+  }, [t, g, s, v, l]);
+  return x(() => (a(), o > 0 && (m.current = setInterval(() => {
+    a();
+  }, o)), () => {
+    m.current && clearInterval(m.current);
+  }), [a, o]), { data: I, loading: T, error: b, refetch: a };
 }
 export {
-  A as useApiOptimizer
+  L 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(n,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react")):typeof define=="function"&&define.amd?define(["exports","react"],e):(n=typeof globalThis<"u"?globalThis:n||self,e(n.ApiOptimizer={},n.React))})(this,(function(n,e){"use strict";const u={},r={};function S(t,g,b={}){const{retries:a=0,cacheTime:T=3e5,throttleTime:l=0,refreshInterval:c=0}=b,[A,f]=e.useState(null),[C,s]=e.useState(!0),[D,d]=e.useState(null),p=e.useRef(0),v=e.useRef(0),m=e.useRef(null),o=e.useCallback(async()=>{s(!0),d(null);const h=Date.now();if(!(l&&h-v.current<l)){if(v.current=h,u[t]&&h-u[t].timestamp<T){f(u[t].data),s(!1);return}if(r[t]){try{const i=await r[t];f(i),s(!1)}catch(i){d(i),s(!1)}return}r[t]=(async()=>{for(;p.current<=a;)try{const I=new AbortController().signal,w=await g({signal:I});return u[t]={timestamp:Date.now(),data:w},f(w),s(!1),delete r[t],w}catch(i){if(p.current+=1,p.current>a){d(i),s(!1),delete r[t];return}}})(),await r[t]}},[t,g,a,T,l]);return e.useEffect(()=>(o(),c>0&&(m.current=setInterval(()=>{o()},c)),()=>{m.current&&clearInterval(m.current)}),[o,c]),{data:A,loading:C,error:D,refetch:o}}n.useApiOptimizer=S,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));

package/package.json

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