klaim 1.2.33 → 1.4.0

package/README.md

@@ -15,6 +15,7 @@ experience.
     - [Request Handling](#request-handling)
     - [Middleware Usage](#middleware-usage)
     - [Hook Subscription](#hook-subscription)
+    - [Caching Requests](#caching-requests)
 - [Links](#-links)
 - [Contributing](#-contributing)
 - [License](#-license)
@@ -27,6 +28,7 @@ experience.
 - **Lightweight**: Minimal footprint for fast load times and minimal performance impact.
 - **Middleware Support**: Easily add middleware to modify requests and responses (`before` and `after`).
 - **Hook System**: Subscribe to hooks to monitor and react to specific events.
+- **Caching**: Enable caching on requests to reduce network load and improve performance.
 - **TypeScript Support**: Fully typed for enhanced code quality and developer experience.
 
 ## 📥 Installation
@@ -140,6 +142,43 @@ Hook.subscribe("hello.getFirstTodo", ({url}) => {
 });
 ```
 
+### Caching Requests
+
+Enable caching on requests to reduce network load and improve performance. By default, the cache duration is 20 seconds,
+but you can specify a custom duration in seconds.
+
+#### Caching Individual Routes
+
+You can enable caching on individual routes:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Get a list of todos with default cache duration (20 seconds)
+    Route.get<Todo[]>("listTodos", "todos").withCache();
+
+    // Get a specific todo by id with custom cache duration (300 seconds)
+    Route.get<Todo>("getTodo", "todos/[id]").withCache(300);
+
+    // Add a new todo (no cache)
+    Route.post<Todo>("addTodo", "todos");
+});
+```
+
+Now, when making requests, the caching feature will be applied.
+
+#### Caching the Entire API
+
+You can also enable caching for all routes defined within an API:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Define routes for the API
+    Route.get<Todo[]>("listTodos", "todos");
+    Route.get<Todo>("getTodo", "todos/[id]");
+    Route.post<Todo>("addTodo", "todos");
+}).withCache(); // Enable default cache duration (20 seconds) for all routes
+```
+
 ## 🔗 Links
 
 - [NPM](https://www.npmjs.com/package/klaim)

package/deno.json

@@ -1,38 +1,38 @@
-{
-    "name": "@antharuu/klaim",
-    "version": "1.2.33",
-    "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/antharuu/klaim.git"
-    },
-    "keywords": [
-        "typescript",
-        "api",
-        "request",
-        "user experience",
-        "optimization",
-        "lightweight"
-    ],
-    "author": "antharuu",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/antharuu/klaim/issues"
-    },
-    "homepage": "https://github.com/antharuu/klaim#readme",
-    "main": "dist/klaim.cjs.js",
-    "module": "dist/klaim.es.js",
-    "types": "dist/index.d.ts",
-    "exports": "./mod.ts",
-    "scripts": {
-        "build": "vite build",
-        "dev": "vite build --watch",
-        "test": "vitest",
-        "lint": "eslint src",
-        "lint:fix": "eslint src **/*.ts --fix",
-        "release": "dotenv release-it --"
-    },
-    "peerDependencies": {
-        "typescript": "^5.5.3"
-    }
-}
+{
+    "name": "@antharuu/klaim",
+    "version": "1.4.0",
+    "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/antharuu/klaim.git"
+    },
+    "keywords": [
+        "typescript",
+        "api",
+        "request",
+        "user experience",
+        "optimization",
+        "lightweight"
+    ],
+    "author": "antharuu",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/antharuu/klaim/issues"
+    },
+    "homepage": "https://github.com/antharuu/klaim#readme",
+    "main": "dist/klaim.cjs.js",
+    "module": "dist/klaim.es.js",
+    "types": "dist/index.d.ts",
+    "exports": "./mod.ts",
+    "scripts": {
+        "build": "vite build",
+        "dev": "vite build --watch",
+        "test": "vitest",
+        "lint": "eslint src",
+        "lint:fix": "eslint src **/*.ts --fix",
+        "release": "dotenv release-it --"
+    },
+    "peerDependencies": {
+        "typescript": "^5.5.3"
+    }
+}

package/dist/klaim.cjs

@@ -1 +1 @@
-"use strict";var $=Object.defineProperty;var k=(a,t,e)=>t in a?$(a,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):a[t]=e;var i=(a,t,e)=>k(a,typeof t!="symbol"?t+"":t,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function d(a){return a.trim().replace(/^\/|\/$/g,"")}function A(a){return a.replace(/([-_][a-z])/gi,t=>t.toUpperCase().replace("-","").replace("_","")).replace(/(^\w)/,t=>t.toLowerCase())}class p{static subscribe(t,e){this._callbacks.set(t,e)}static run(t){const e=this._callbacks.get(t);e&&e()}}i(p,"_callbacks",new Map);var g=(a=>(a.GET="GET",a.POST="POST",a.PUT="PUT",a.DELETE="DELETE",a.PATCH="PATCH",a.OPTIONS="OPTIONS",a))(g||{});class h{constructor(t,e,n,r="GET"){i(this,"api","undefined");i(this,"name");i(this,"url");i(this,"method");i(this,"headers");i(this,"arguments",new Set);i(this,"callbacks",{before:null,after:null});this.name=A(t),this.name!==t&&console.warn(`Route name "${t}" has been camelCased to "${this.name}"`),this.url=d(e),this.headers=n||{},this.method=r,this.detectArguments()}static createRoute(t,e,n,r){const s=new h(t,e,n,r);return o.i.registerRoute(s),s}static get(t,e,n={}){return this.createRoute(t,e,n,"GET")}static post(t,e,n){return this.createRoute(t,e,n,"POST")}static put(t,e,n){return this.createRoute(t,e,n,"PUT")}static delete(t,e,n){return this.createRoute(t,e,n,"DELETE")}static patch(t,e,n){return this.createRoute(t,e,n,"PATCH")}static options(t,e,n){return this.createRoute(t,e,n,"OPTIONS")}before(t){return this.callbacks.before=t,this}after(t){return this.callbacks.after=t,this}detectArguments(){const t=this.url.match(/\[([^\]]+)]/g);t&&t.forEach(e=>{const n=e.replace(/\[|]/g,"");this.arguments.add(n)})}}const l={};async function O(a,t,e={},n={}){let r=_(`${a.url}/${t.url}`,t,e),s={};n&&t.method!==g.GET&&(s.body=JSON.stringify(n)),s.headers={"Content-Type":"application/json",...a.headers,...t.headers},s.method=t.method;const{beforeRoute:u,beforeApi:w,beforeUrl:T,beforeConfig:b}=y({route:t,api:a,url:r,config:s});r=T,s=b,a=o.updateApi(w),t=o.updateRoute(u);const m=await fetch(r,s),{afterRoute:E,afterApi:P,afterData:C}=S({route:t,api:a,response:m,data:await m.json()});return o.updateApi(P),o.updateRoute(E),p.run(`${a.name}.${t.name}`),C}function _(a,t,e){let n=a;return t.arguments.forEach(r=>{if(e[r]===void 0)throw new Error(`Argument ${r} is missing`);n=n.replace(`[${r}]`,e[r])}),n}function y({route:a,api:t,url:e,config:n}){var s,u;const r=(u=(s=a.callbacks).before)==null?void 0:u.call(s,{route:a,api:t,url:e,config:n});return{beforeRoute:(r==null?void 0:r.route)||a,beforeApi:(r==null?void 0:r.api)||t,beforeUrl:(r==null?void 0:r.url)||e,beforeConfig:(r==null?void 0:r.config)||n}}function S({route:a,api:t,response:e,data:n}){var s,u;const r=(u=(s=a.callbacks).after)==null?void 0:u.call(s,{route:a,api:t,response:e,data:n});return{afterRoute:(r==null?void 0:r.route)||a,afterApi:(r==null?void 0:r.api)||t,afterResponse:(r==null?void 0:r.response)||e,afterData:(r==null?void 0:r.data)||n}}const c=class c{constructor(){i(this,"_apis",new Map);i(this,"_currentApi",null)}static get i(){return c._instance||(c._instance=new c),c._instance}registerApi(t){this._apis.set(t.name,t),l[t.name]={}}setCurrent(t){const e=this._apis.get(t);if(!e)throw new Error(`API ${t} not found`);this._currentApi=e}clearCurrent(){this._currentApi=null}registerRoute(t){if(!this._currentApi)throw new Error("No current API set, use Route only inside Api.create callback");t.api=this._currentApi.name,this._currentApi.routes.set(t.name,t),this.addToKlaimRoute(t.api,t)}getApi(t){return this._apis.get(t)}getRoute(t,e){const n=this._apis.get(t);if(!n)throw new Error(`API ${t} not found`);return n.routes.get(e)}static updateApi(t){return c.i._apis.has(t.name)||c.i.registerApi(t),c.i._apis.set(t.name,t),t}static updateRoute(t){const e=c.i._apis.get(t.api);if(!e)throw new Error(`API ${t.api} not found`);return e.routes.set(t.name,t),t}addToKlaimRoute(t,e){l[t][e.name]=async(n={},r={})=>{const s=c.i._apis.get(t);if(!s)throw new Error(`API ${e.api} not found`);return O(s,e,n,r)}}};i(c,"_instance");let o=c;class f{constructor(t,e,n){i(this,"name");i(this,"url");i(this,"headers");i(this,"routes",new Map);this.name=t,this.url=d(e),this.headers=n||{}}static create(t,e,n,r={}){const s=A(t);s!==t&&console.warn(`API name "${t}" has been camelCased to "${s}"`);const u=new f(s,e,r);return o.i.registerApi(u),o.i.setCurrent(s),n(),o.i.clearCurrent(),u}}exports.Api=f;exports.Hook=p;exports.Klaim=l;exports.Registry=o;exports.Route=h;
+"use strict";var O=Object.defineProperty;var _=(n,t,e)=>t in n?O(n,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):n[t]=e;var i=(n,t,e)=>_(n,typeof t!="symbol"?t+"":t,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function m(n){return n.trim().replace(/^\/|\/$/g,"")}function A(n){return n.replace(/([-_][a-z])/gi,t=>t.toUpperCase().replace("-","").replace("_","")).replace(/(^\w)/,t=>t.toLowerCase())}const u=class u{constructor(){i(this,"cache");this.cache=new Map}static get i(){return u._instance||(u._instance=new u),u._instance}set(t,e,r){const a=Date.now()+r;this.cache.set(t,{data:e,expiry:a})}has(t){const e=this.cache.get(t);return e?Date.now()>e.expiry?(this.cache.delete(t),!1):!0:!1}get(t){return this.has(t)?this.cache.get(t).data:null}};i(u,"_instance");let l=u;function k(n){let r=2166136261;for(let s=0;s<n.length;s++)r^=n.charCodeAt(s),r*=16777619;let a=(r>>>0).toString(16).padStart(8,"0");for(;a.length<32;)r^=a.charCodeAt(a.length%a.length),r*=16777619,a+=(r>>>0).toString(16).padStart(8,"0");return a.substring(0,32)}async function I(n,t,e){const r=`${n.toString()}${JSON.stringify(t)}`,a=k(r);if(l.i.has(a))return l.i.get(a);const c=await(await fetch(n,t)).json();return l.i.set(a,c,e),c}class g{static subscribe(t,e){this._callbacks.set(t,e)}static run(t){const e=this._callbacks.get(t);e&&e()}}i(g,"_callbacks",new Map);var b=(n=>(n.GET="GET",n.POST="POST",n.PUT="PUT",n.DELETE="DELETE",n.PATCH="PATCH",n.OPTIONS="OPTIONS",n))(b||{});class d{constructor(t,e,r,a="GET"){i(this,"api","undefined");i(this,"name");i(this,"url");i(this,"method");i(this,"headers");i(this,"arguments",new Set);i(this,"callbacks",{before:null,after:null});this.name=A(t),this.name!==t&&console.warn(`Route name "${t}" has been camelCased to "${this.name}"`),this.url=m(e),this.headers=r||{},this.method=a,this.detectArguments()}static createRoute(t,e,r,a){const s=new d(t,e,r,a);return h.i.registerRoute(s),s}static get(t,e,r={}){return this.createRoute(t,e,r,"GET")}static post(t,e,r){return this.createRoute(t,e,r,"POST")}static put(t,e,r){return this.createRoute(t,e,r,"PUT")}static delete(t,e,r){return this.createRoute(t,e,r,"DELETE")}static patch(t,e,r){return this.createRoute(t,e,r,"PATCH")}static options(t,e,r){return this.createRoute(t,e,r,"OPTIONS")}before(t){return this.callbacks.before=t,this}after(t){return this.callbacks.after=t,this}detectArguments(){const t=this.url.match(/\[([^\]]+)]/g);t&&t.forEach(e=>{const r=e.replace(/\[|]/g,"");this.arguments.add(r)})}withCache(t=20){return this.cache=t,this}}const f={};async function U(n,t,e={},r={}){let a=D(`${n.url}/${t.url}`,t,e),s={};r&&t.method!==b.GET&&(s.body=JSON.stringify(r)),s.headers={"Content-Type":"application/json",...n.headers,...t.headers},s.method=t.method;const{beforeRoute:c,beforeApi:T,beforeUrl:E,beforeConfig:C}=H({route:t,api:n,url:a,config:s});a=E,s=C,n=h.updateApi(T),t=h.updateRoute(c);const P=n.cache||t.cache;let p;P?p=await I(a,s,n.cache):p=await(await fetch(a,s)).json();const{afterRoute:S,afterApi:$,afterData:y}=N({route:t,api:n,response:p,data:p});return h.updateApi($),h.updateRoute(S),g.run(`${n.name}.${t.name}`),y}function D(n,t,e){let r=n;return t.arguments.forEach(a=>{if(e[a]===void 0)throw new Error(`Argument ${a} is missing`);r=r.replace(`[${a}]`,e[a])}),r}function H({route:n,api:t,url:e,config:r}){var s,c;const a=(c=(s=n.callbacks).before)==null?void 0:c.call(s,{route:n,api:t,url:e,config:r});return{beforeRoute:(a==null?void 0:a.route)||n,beforeApi:(a==null?void 0:a.api)||t,beforeUrl:(a==null?void 0:a.url)||e,beforeConfig:(a==null?void 0:a.config)||r}}function N({route:n,api:t,response:e,data:r}){var s,c;const a=(c=(s=n.callbacks).after)==null?void 0:c.call(s,{route:n,api:t,response:e,data:r});return{afterRoute:(a==null?void 0:a.route)||n,afterApi:(a==null?void 0:a.api)||t,afterResponse:(a==null?void 0:a.response)||e,afterData:(a==null?void 0:a.data)||r}}const o=class o{constructor(){i(this,"_apis",new Map);i(this,"_currentApi",null)}static get i(){return o._instance||(o._instance=new o),o._instance}registerApi(t){this._apis.set(t.name,t),f[t.name]={}}setCurrent(t){const e=this._apis.get(t);if(!e)throw new Error(`API ${t} not found`);this._currentApi=e}clearCurrent(){this._currentApi=null}registerRoute(t){if(!this._currentApi)throw new Error("No current API set, use Route only inside Api.create callback");t.api=this._currentApi.name,this._currentApi.routes.set(t.name,t),this.addToKlaimRoute(t.api,t)}getApi(t){return this._apis.get(t)}getRoute(t,e){const r=this._apis.get(t);if(!r)throw new Error(`API ${t} not found`);return r.routes.get(e)}static updateApi(t){return o.i._apis.has(t.name)||o.i.registerApi(t),o.i._apis.set(t.name,t),t}static updateRoute(t){const e=o.i._apis.get(t.api);if(!e)throw new Error(`API ${t.api} not found`);return e.routes.set(t.name,t),t}addToKlaimRoute(t,e){f[t][e.name]=async(r={},a={})=>{const s=o.i._apis.get(t);if(!s)throw new Error(`API ${e.api} not found`);return U(s,e,r,a)}}};i(o,"_instance");let h=o;class w{constructor(t,e,r={}){i(this,"name");i(this,"url");i(this,"headers");i(this,"routes",new Map);i(this,"cache",!1);this.name=t,this.url=m(e),this.headers=r}static create(t,e,r,a={}){const s=A(t);s!==t&&console.warn(`API name "${t}" has been camelCased to "${s}"`);const c=new w(s,e,a);return h.i.registerApi(c),h.i.setCurrent(s),r(),h.i.clearCurrent(),c}withCache(t=20){return this.cache=t,this}}exports.Api=w;exports.Hook=g;exports.Klaim=f;exports.Registry=h;exports.Route=d;

package/dist/klaim.es.js

@@ -1,13 +1,78 @@
-var $ = Object.defineProperty;
-var _ = (a, t, e) => t in a ? $(a, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : a[t] = e;
-var i = (a, t, e) => _(a, typeof t != "symbol" ? t + "" : t, e);
-function h(a) {
-  return a.trim().replace(/^\/|\/$/g, "");
+var y = Object.defineProperty;
+var _ = (r, t, e) => t in r ? y(r, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : r[t] = e;
+var i = (r, t, e) => _(r, typeof t != "symbol" ? t + "" : t, e);
+function d(r) {
+  return r.trim().replace(/^\/|\/$/g, "");
 }
-function f(a) {
-  return a.replace(/([-_][a-z])/gi, (t) => t.toUpperCase().replace("-", "").replace("_", "")).replace(/(^\w)/, (t) => t.toLowerCase());
+function g(r) {
+  return r.replace(/([-_][a-z])/gi, (t) => t.toUpperCase().replace("-", "").replace("_", "")).replace(/(^\w)/, (t) => t.toLowerCase());
 }
-class m {
+const u = class u {
+  /**
+   * Private constructor to prevent instantiation from outside the class.
+   */
+  constructor() {
+    i(this, "cache");
+    this.cache = /* @__PURE__ */ new Map();
+  }
+  /**
+   * Provides access to the singleton instance of the class.
+   *
+   * @returns The singleton instance of Cache.
+   */
+  static get i() {
+    return u._instance || (u._instance = new u()), u._instance;
+  }
+  /**
+   * Sets the cache for a specific key.
+   *
+   * @param key The key to cache the value under.
+   * @param value The value to be cached.
+   * @param ttl Time to live in milliseconds.
+   */
+  set(t, e, n) {
+    const a = Date.now() + n;
+    this.cache.set(t, { data: e, expiry: a });
+  }
+  /**
+   * Checks if the cache has a valid entry for the given key.
+   *
+   * @param key The key to check in the cache.
+   * @returns True if a valid cache entry exists, otherwise false.
+   */
+  has(t) {
+    const e = this.cache.get(t);
+    return e ? Date.now() > e.expiry ? (this.cache.delete(t), !1) : !0 : !1;
+  }
+  /**
+   * Gets the cached value for the given key.
+   *
+   * @param key The key to retrieve from the cache.
+   * @returns The cached value or null if not found or expired.
+   */
+  get(t) {
+    return this.has(t) ? this.cache.get(t).data : null;
+  }
+};
+i(u, "_instance");
+let l = u;
+function k(r) {
+  let n = 2166136261;
+  for (let s = 0; s < r.length; s++)
+    n ^= r.charCodeAt(s), n *= 16777619;
+  let a = (n >>> 0).toString(16).padStart(8, "0");
+  for (; a.length < 32; )
+    n ^= a.charCodeAt(a.length % a.length), n *= 16777619, a += (n >>> 0).toString(16).padStart(8, "0");
+  return a.substring(0, 32);
+}
+async function I(r, t, e) {
+  const n = `${r.toString()}${JSON.stringify(t)}`, a = k(n);
+  if (l.i.has(a))
+    return l.i.get(a);
+  const c = await (await fetch(r, t)).json();
+  return l.i.set(a, c, e), c;
+}
+class w {
   /**
    * Subscribes to the hook
    *
@@ -27,8 +92,8 @@ class m {
     e && e();
   }
 }
-i(m, "_callbacks", /* @__PURE__ */ new Map());
-var d = /* @__PURE__ */ ((a) => (a.GET = "GET", a.POST = "POST", a.PUT = "PUT", a.DELETE = "DELETE", a.PATCH = "PATCH", a.OPTIONS = "OPTIONS", a))(d || {});
+i(w, "_callbacks", /* @__PURE__ */ new Map());
+var m = /* @__PURE__ */ ((r) => (r.GET = "GET", r.POST = "POST", r.PUT = "PUT", r.DELETE = "DELETE", r.PATCH = "PATCH", r.OPTIONS = "OPTIONS", r))(m || {});
 class A {
   /**
    * Constructor
@@ -38,7 +103,7 @@ class A {
    * @param headers - The headers to be sent with the request
    * @param method - The HTTP method of the route
    */
-  constructor(t, e, n, r = "GET") {
+  constructor(t, e, n, a = "GET") {
     i(this, "api", "undefined");
     i(this, "name");
     i(this, "url");
@@ -55,7 +120,7 @@ class A {
        */
       after: null
     });
-    this.name = f(t), this.name !== t && console.warn(`Route name "${t}" has been camelCased to "${this.name}"`), this.url = h(e), this.headers = n || {}, this.method = r, this.detectArguments();
+    this.name = g(t), this.name !== t && console.warn(`Route name "${t}" has been camelCased to "${this.name}"`), this.url = d(e), this.headers = n || {}, this.method = a, this.detectArguments();
   }
   /**
    * Creates a new route
@@ -66,9 +131,9 @@ class A {
    * @param method - The HTTP method of the route
    * @returns The new route
    */
-  static createRoute(t, e, n, r) {
-    const s = new A(t, e, n, r);
-    return u.i.registerRoute(s), s;
+  static createRoute(t, e, n, a) {
+    const s = new A(t, e, n, a);
+    return h.i.registerRoute(s), s;
   }
   /**
    * Creates a new route with the GET method
@@ -200,58 +265,70 @@ class A {
       this.arguments.add(n);
     });
   }
+  /**
+   * Enables caching for the Route
+   *
+   * @param duration - The duration to cache the response for seconds (default: 20)
+   * @returns The Route
+   */
+  withCache(t = 20) {
+    return this.cache = t, this;
+  }
 }
-const p = {};
-async function k(a, t, e = {}, n = {}) {
-  let r = O(`${a.url}/${t.url}`, t, e), s = {};
-  n && t.method !== d.GET && (s.body = JSON.stringify(n)), s.headers = {
+const f = {};
+async function U(r, t, e = {}, n = {}) {
+  let a = D(`${r.url}/${t.url}`, t, e), s = {};
+  n && t.method !== m.GET && (s.body = JSON.stringify(n)), s.headers = {
     "Content-Type": "application/json",
-    ...a.headers,
+    ...r.headers,
     ...t.headers
   }, s.method = t.method;
   const {
-    beforeRoute: o,
-    beforeApi: g,
-    beforeUrl: T,
-    beforeConfig: E
-  } = I({ route: t, api: a, url: r, config: s });
-  r = T, s = E, a = u.updateApi(g), t = u.updateRoute(o);
-  const l = await fetch(r, s), {
-    afterRoute: b,
-    afterApi: P,
-    afterData: C
-  } = S({ route: t, api: a, response: l, data: await l.json() });
-  return u.updateApi(P), u.updateRoute(b), m.run(`${a.name}.${t.name}`), C;
+    beforeRoute: c,
+    beforeApi: T,
+    beforeUrl: b,
+    beforeConfig: C
+  } = H({ route: t, api: r, url: a, config: s });
+  a = b, s = C, r = h.updateApi(T), t = h.updateRoute(c);
+  const P = r.cache || t.cache;
+  let p;
+  P ? p = await I(a, s, r.cache) : p = await (await fetch(a, s)).json();
+  const {
+    afterRoute: $,
+    afterApi: S,
+    afterData: O
+  } = N({ route: t, api: r, response: p, data: p });
+  return h.updateApi(S), h.updateRoute($), w.run(`${r.name}.${t.name}`), O;
 }
-function O(a, t, e) {
-  let n = a;
-  return t.arguments.forEach((r) => {
-    if (e[r] === void 0)
-      throw new Error(`Argument ${r} is missing`);
-    n = n.replace(`[${r}]`, e[r]);
+function D(r, t, e) {
+  let n = r;
+  return t.arguments.forEach((a) => {
+    if (e[a] === void 0)
+      throw new Error(`Argument ${a} is missing`);
+    n = n.replace(`[${a}]`, e[a]);
   }), n;
 }
-function I({ route: a, api: t, url: e, config: n }) {
-  var s, o;
-  const r = (o = (s = a.callbacks).before) == null ? void 0 : o.call(s, { route: a, api: t, url: e, config: n });
+function H({ route: r, api: t, url: e, config: n }) {
+  var s, c;
+  const a = (c = (s = r.callbacks).before) == null ? void 0 : c.call(s, { route: r, api: t, url: e, config: n });
   return {
-    beforeRoute: (r == null ? void 0 : r.route) || a,
-    beforeApi: (r == null ? void 0 : r.api) || t,
-    beforeUrl: (r == null ? void 0 : r.url) || e,
-    beforeConfig: (r == null ? void 0 : r.config) || n
+    beforeRoute: (a == null ? void 0 : a.route) || r,
+    beforeApi: (a == null ? void 0 : a.api) || t,
+    beforeUrl: (a == null ? void 0 : a.url) || e,
+    beforeConfig: (a == null ? void 0 : a.config) || n
   };
 }
-function S({ route: a, api: t, response: e, data: n }) {
-  var s, o;
-  const r = (o = (s = a.callbacks).after) == null ? void 0 : o.call(s, { route: a, api: t, response: e, data: n });
+function N({ route: r, api: t, response: e, data: n }) {
+  var s, c;
+  const a = (c = (s = r.callbacks).after) == null ? void 0 : c.call(s, { route: r, api: t, response: e, data: n });
   return {
-    afterRoute: (r == null ? void 0 : r.route) || a,
-    afterApi: (r == null ? void 0 : r.api) || t,
-    afterResponse: (r == null ? void 0 : r.response) || e,
-    afterData: (r == null ? void 0 : r.data) || n
+    afterRoute: (a == null ? void 0 : a.route) || r,
+    afterApi: (a == null ? void 0 : a.api) || t,
+    afterResponse: (a == null ? void 0 : a.response) || e,
+    afterData: (a == null ? void 0 : a.data) || n
   };
 }
-const c = class c {
+const o = class o {
   /**
    * Constructor
    */
@@ -265,7 +342,7 @@ const c = class c {
    * @returns The singleton instance
    */
   static get i() {
-    return c._instance || (c._instance = new c()), c._instance;
+    return o._instance || (o._instance = new o()), o._instance;
   }
   /**
    * Registers an API
@@ -273,7 +350,7 @@ const c = class c {
    * @param api - The API to register
    */
   registerApi(t) {
-    this._apis.set(t.name, t), p[t.name] = {};
+    this._apis.set(t.name, t), f[t.name] = {};
   }
   /**
    * Sets the current API
@@ -331,7 +408,7 @@ const c = class c {
    * @returns The updated API
    */
   static updateApi(t) {
-    return c.i._apis.has(t.name) || c.i.registerApi(t), c.i._apis.set(t.name, t), t;
+    return o.i._apis.has(t.name) || o.i.registerApi(t), o.i._apis.set(t.name, t), t;
   }
   /**
    * Updates a route
@@ -340,7 +417,7 @@ const c = class c {
    * @returns The updated route
    */
   static updateRoute(t) {
-    const e = c.i._apis.get(t.api);
+    const e = o.i._apis.get(t.api);
     if (!e)
       throw new Error(`API ${t.api} not found`);
     return e.routes.set(t.name, t), t;
@@ -352,17 +429,17 @@ const c = class c {
    * @param route - The route to add
    */
   addToKlaimRoute(t, e) {
-    p[t][e.name] = async (n = {}, r = {}) => {
-      const s = c.i._apis.get(t);
+    f[t][e.name] = async (n = {}, a = {}) => {
+      const s = o.i._apis.get(t);
       if (!s)
         throw new Error(`API ${e.api} not found`);
-      return k(s, e, n, r);
+      return U(s, e, n, a);
     };
   }
 };
-i(c, "_instance");
-let u = c;
-class w {
+i(o, "_instance");
+let h = o;
+class E {
   /**
    * Constructor
    *
@@ -370,12 +447,13 @@ class w {
    * @param url - The base URL of the API
    * @param headers - The headers to be sent with each request
    */
-  constructor(t, e, n) {
+  constructor(t, e, n = {}) {
     i(this, "name");
     i(this, "url");
     i(this, "headers");
     i(this, "routes", /* @__PURE__ */ new Map());
-    this.name = t, this.url = h(e), this.headers = n || {};
+    i(this, "cache", !1);
+    this.name = t, this.url = d(e), this.headers = n;
   }
   /**
    * Creates a new API
@@ -386,17 +464,26 @@ class w {
    * @param headers - The headers to be sent with each request
    * @returns The new API
    */
-  static create(t, e, n, r = {}) {
-    const s = f(t);
+  static create(t, e, n, a = {}) {
+    const s = g(t);
     s !== t && console.warn(`API name "${t}" has been camelCased to "${s}"`);
-    const o = new w(s, e, r);
-    return u.i.registerApi(o), u.i.setCurrent(s), n(), u.i.clearCurrent(), o;
+    const c = new E(s, e, a);
+    return h.i.registerApi(c), h.i.setCurrent(s), n(), h.i.clearCurrent(), c;
+  }
+  /**
+   * Enables caching for the API
+   *
+   * @param duration - The duration to cache the response for seconds (default: 20)
+   * @returns The API
+   */
+  withCache(t = 20) {
+    return this.cache = t, this;
   }
 }
 export {
-  w as Api,
-  m as Hook,
-  p as Klaim,
-  u as Registry,
+  E as Api,
+  w as Hook,
+  f as Klaim,
+  h as Registry,
   A as Route
 };

package/dist/klaim.umd.js

@@ -1 +1 @@
-(function(s,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(s=typeof globalThis<"u"?globalThis:s||self,o(s.klaim={}))})(this,function(s){"use strict";var S=Object.defineProperty;var I=(s,o,h)=>o in s?S(s,o,{enumerable:!0,configurable:!0,writable:!0,value:h}):s[o]=h;var c=(s,o,h)=>I(s,typeof o!="symbol"?o+"":o,h);function o(i){return i.trim().replace(/^\/|\/$/g,"")}function h(i){return i.replace(/([-_][a-z])/gi,t=>t.toUpperCase().replace("-","").replace("_","")).replace(/(^\w)/,t=>t.toLowerCase())}class f{static subscribe(t,e){this._callbacks.set(t,e)}static run(t){const e=this._callbacks.get(t);e&&e()}}c(f,"_callbacks",new Map);var g=(i=>(i.GET="GET",i.POST="POST",i.PUT="PUT",i.DELETE="DELETE",i.PATCH="PATCH",i.OPTIONS="OPTIONS",i))(g||{});class d{constructor(t,e,r,n="GET"){c(this,"api","undefined");c(this,"name");c(this,"url");c(this,"method");c(this,"headers");c(this,"arguments",new Set);c(this,"callbacks",{before:null,after:null});this.name=h(t),this.name!==t&&console.warn(`Route name "${t}" has been camelCased to "${this.name}"`),this.url=o(e),this.headers=r||{},this.method=n,this.detectArguments()}static createRoute(t,e,r,n){const a=new d(t,e,r,n);return l.i.registerRoute(a),a}static get(t,e,r={}){return this.createRoute(t,e,r,"GET")}static post(t,e,r){return this.createRoute(t,e,r,"POST")}static put(t,e,r){return this.createRoute(t,e,r,"PUT")}static delete(t,e,r){return this.createRoute(t,e,r,"DELETE")}static patch(t,e,r){return this.createRoute(t,e,r,"PATCH")}static options(t,e,r){return this.createRoute(t,e,r,"OPTIONS")}before(t){return this.callbacks.before=t,this}after(t){return this.callbacks.after=t,this}detectArguments(){const t=this.url.match(/\[([^\]]+)]/g);t&&t.forEach(e=>{const r=e.replace(/\[|]/g,"");this.arguments.add(r)})}}const m={};async function T(i,t,e={},r={}){let n=b(`${i.url}/${t.url}`,t,e),a={};r&&t.method!==g.GET&&(a.body=JSON.stringify(r)),a.headers={"Content-Type":"application/json",...i.headers,...t.headers},a.method=t.method;const{beforeRoute:p,beforeApi:C,beforeUrl:$,beforeConfig:k}=E({route:t,api:i,url:n,config:a});n=$,a=k,i=l.updateApi(C),t=l.updateRoute(p);const w=await fetch(n,a),{afterRoute:y,afterApi:O,afterData:_}=P({route:t,api:i,response:w,data:await w.json()});return l.updateApi(O),l.updateRoute(y),f.run(`${i.name}.${t.name}`),_}function b(i,t,e){let r=i;return t.arguments.forEach(n=>{if(e[n]===void 0)throw new Error(`Argument ${n} is missing`);r=r.replace(`[${n}]`,e[n])}),r}function E({route:i,api:t,url:e,config:r}){var a,p;const n=(p=(a=i.callbacks).before)==null?void 0:p.call(a,{route:i,api:t,url:e,config:r});return{beforeRoute:(n==null?void 0:n.route)||i,beforeApi:(n==null?void 0:n.api)||t,beforeUrl:(n==null?void 0:n.url)||e,beforeConfig:(n==null?void 0:n.config)||r}}function P({route:i,api:t,response:e,data:r}){var a,p;const n=(p=(a=i.callbacks).after)==null?void 0:p.call(a,{route:i,api:t,response:e,data:r});return{afterRoute:(n==null?void 0:n.route)||i,afterApi:(n==null?void 0:n.api)||t,afterResponse:(n==null?void 0:n.response)||e,afterData:(n==null?void 0:n.data)||r}}const u=class u{constructor(){c(this,"_apis",new Map);c(this,"_currentApi",null)}static get i(){return u._instance||(u._instance=new u),u._instance}registerApi(t){this._apis.set(t.name,t),m[t.name]={}}setCurrent(t){const e=this._apis.get(t);if(!e)throw new Error(`API ${t} not found`);this._currentApi=e}clearCurrent(){this._currentApi=null}registerRoute(t){if(!this._currentApi)throw new Error("No current API set, use Route only inside Api.create callback");t.api=this._currentApi.name,this._currentApi.routes.set(t.name,t),this.addToKlaimRoute(t.api,t)}getApi(t){return this._apis.get(t)}getRoute(t,e){const r=this._apis.get(t);if(!r)throw new Error(`API ${t} not found`);return r.routes.get(e)}static updateApi(t){return u.i._apis.has(t.name)||u.i.registerApi(t),u.i._apis.set(t.name,t),t}static updateRoute(t){const e=u.i._apis.get(t.api);if(!e)throw new Error(`API ${t.api} not found`);return e.routes.set(t.name,t),t}addToKlaimRoute(t,e){m[t][e.name]=async(r={},n={})=>{const a=u.i._apis.get(t);if(!a)throw new Error(`API ${e.api} not found`);return T(a,e,r,n)}}};c(u,"_instance");let l=u;class A{constructor(t,e,r){c(this,"name");c(this,"url");c(this,"headers");c(this,"routes",new Map);this.name=t,this.url=o(e),this.headers=r||{}}static create(t,e,r,n={}){const a=h(t);a!==t&&console.warn(`API name "${t}" has been camelCased to "${a}"`);const p=new A(a,e,n);return l.i.registerApi(p),l.i.setCurrent(a),r(),l.i.clearCurrent(),p}}s.Api=A,s.Hook=f,s.Klaim=m,s.Registry=l,s.Route=d,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});
+(function(c,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(c=typeof globalThis<"u"?globalThis:c||self,o(c.klaim={}))})(this,function(c){"use strict";var j=Object.defineProperty;var N=(c,o,p)=>o in c?j(c,o,{enumerable:!0,configurable:!0,writable:!0,value:p}):c[o]=p;var s=(c,o,p)=>N(c,typeof o!="symbol"?o+"":o,p);function o(r){return r.trim().replace(/^\/|\/$/g,"")}function p(r){return r.replace(/([-_][a-z])/gi,t=>t.toUpperCase().replace("-","").replace("_","")).replace(/(^\w)/,t=>t.toLowerCase())}const f=class f{constructor(){s(this,"cache");this.cache=new Map}static get i(){return f._instance||(f._instance=new f),f._instance}set(t,e,a){const n=Date.now()+a;this.cache.set(t,{data:e,expiry:n})}has(t){const e=this.cache.get(t);return e?Date.now()>e.expiry?(this.cache.delete(t),!1):!0:!1}get(t){return this.has(t)?this.cache.get(t).data:null}};s(f,"_instance");let d=f;function E(r){let a=2166136261;for(let i=0;i<r.length;i++)a^=r.charCodeAt(i),a*=16777619;let n=(a>>>0).toString(16).padStart(8,"0");for(;n.length<32;)a^=n.charCodeAt(n.length%n.length),a*=16777619,n+=(a>>>0).toString(16).padStart(8,"0");return n.substring(0,32)}async function C(r,t,e){const a=`${r.toString()}${JSON.stringify(t)}`,n=E(a);if(d.i.has(n))return d.i.get(n);const h=await(await fetch(r,t)).json();return d.i.set(n,h,e),h}class m{static subscribe(t,e){this._callbacks.set(t,e)}static run(t){const e=this._callbacks.get(t);e&&e()}}s(m,"_callbacks",new Map);var b=(r=>(r.GET="GET",r.POST="POST",r.PUT="PUT",r.DELETE="DELETE",r.PATCH="PATCH",r.OPTIONS="OPTIONS",r))(b||{});class w{constructor(t,e,a,n="GET"){s(this,"api","undefined");s(this,"name");s(this,"url");s(this,"method");s(this,"headers");s(this,"arguments",new Set);s(this,"callbacks",{before:null,after:null});this.name=p(t),this.name!==t&&console.warn(`Route name "${t}" has been camelCased to "${this.name}"`),this.url=o(e),this.headers=a||{},this.method=n,this.detectArguments()}static createRoute(t,e,a,n){const i=new w(t,e,a,n);return l.i.registerRoute(i),i}static get(t,e,a={}){return this.createRoute(t,e,a,"GET")}static post(t,e,a){return this.createRoute(t,e,a,"POST")}static put(t,e,a){return this.createRoute(t,e,a,"PUT")}static delete(t,e,a){return this.createRoute(t,e,a,"DELETE")}static patch(t,e,a){return this.createRoute(t,e,a,"PATCH")}static options(t,e,a){return this.createRoute(t,e,a,"OPTIONS")}before(t){return this.callbacks.before=t,this}after(t){return this.callbacks.after=t,this}detectArguments(){const t=this.url.match(/\[([^\]]+)]/g);t&&t.forEach(e=>{const a=e.replace(/\[|]/g,"");this.arguments.add(a)})}withCache(t=20){return this.cache=t,this}}const A={};async function P(r,t,e={},a={}){let n=S(`${r.url}/${t.url}`,t,e),i={};a&&t.method!==b.GET&&(i.body=JSON.stringify(a)),i.headers={"Content-Type":"application/json",...r.headers,...t.headers},i.method=t.method;const{beforeRoute:h,beforeApi:O,beforeUrl:k,beforeConfig:_}=$({route:t,api:r,url:n,config:i});n=k,i=_,r=l.updateApi(O),t=l.updateRoute(h);const I=r.cache||t.cache;let g;I?g=await C(n,i,r.cache):g=await(await fetch(n,i)).json();const{afterRoute:U,afterApi:D,afterData:H}=y({route:t,api:r,response:g,data:g});return l.updateApi(D),l.updateRoute(U),m.run(`${r.name}.${t.name}`),H}function S(r,t,e){let a=r;return t.arguments.forEach(n=>{if(e[n]===void 0)throw new Error(`Argument ${n} is missing`);a=a.replace(`[${n}]`,e[n])}),a}function $({route:r,api:t,url:e,config:a}){var i,h;const n=(h=(i=r.callbacks).before)==null?void 0:h.call(i,{route:r,api:t,url:e,config:a});return{beforeRoute:(n==null?void 0:n.route)||r,beforeApi:(n==null?void 0:n.api)||t,beforeUrl:(n==null?void 0:n.url)||e,beforeConfig:(n==null?void 0:n.config)||a}}function y({route:r,api:t,response:e,data:a}){var i,h;const n=(h=(i=r.callbacks).after)==null?void 0:h.call(i,{route:r,api:t,response:e,data:a});return{afterRoute:(n==null?void 0:n.route)||r,afterApi:(n==null?void 0:n.api)||t,afterResponse:(n==null?void 0:n.response)||e,afterData:(n==null?void 0:n.data)||a}}const u=class u{constructor(){s(this,"_apis",new Map);s(this,"_currentApi",null)}static get i(){return u._instance||(u._instance=new u),u._instance}registerApi(t){this._apis.set(t.name,t),A[t.name]={}}setCurrent(t){const e=this._apis.get(t);if(!e)throw new Error(`API ${t} not found`);this._currentApi=e}clearCurrent(){this._currentApi=null}registerRoute(t){if(!this._currentApi)throw new Error("No current API set, use Route only inside Api.create callback");t.api=this._currentApi.name,this._currentApi.routes.set(t.name,t),this.addToKlaimRoute(t.api,t)}getApi(t){return this._apis.get(t)}getRoute(t,e){const a=this._apis.get(t);if(!a)throw new Error(`API ${t} not found`);return a.routes.get(e)}static updateApi(t){return u.i._apis.has(t.name)||u.i.registerApi(t),u.i._apis.set(t.name,t),t}static updateRoute(t){const e=u.i._apis.get(t.api);if(!e)throw new Error(`API ${t.api} not found`);return e.routes.set(t.name,t),t}addToKlaimRoute(t,e){A[t][e.name]=async(a={},n={})=>{const i=u.i._apis.get(t);if(!i)throw new Error(`API ${e.api} not found`);return P(i,e,a,n)}}};s(u,"_instance");let l=u;class T{constructor(t,e,a={}){s(this,"name");s(this,"url");s(this,"headers");s(this,"routes",new Map);s(this,"cache",!1);this.name=t,this.url=o(e),this.headers=a}static create(t,e,a,n={}){const i=p(t);i!==t&&console.warn(`API name "${t}" has been camelCased to "${i}"`);const h=new T(i,e,n);return l.i.registerApi(h),l.i.setCurrent(i),a(),l.i.clearCurrent(),h}withCache(t=20){return this.cache=t,this}}c.Api=T,c.Hook=m,c.Klaim=A,c.Registry=l,c.Route=w,Object.defineProperty(c,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -20,7 +20,7 @@
     },
     "homepage": "https://github.com/antharuu/klaim#readme",
     "type": "module",
-    "version": "1.2.33",
+    "version": "1.4.0",
     "main": "dist/klaim.cjs.js",
     "module": "dist/klaim.es.js",
     "types": "dist/index.d.ts",
@@ -28,6 +28,8 @@
         "build": "vite build",
         "dev": "vite build --watch",
         "test": "vitest",
+        "test:ui": "vitest --ui --coverage.enabled=true",
+        "test:cover": "vitest --coverage",
         "lint": "eslint src",
         "lint:fix": "eslint src **/*.ts --fix",
         "release": "dotenv release-it -- patch --config release-it.config.cjs --ci",
@@ -41,14 +43,15 @@
         "@types/eslint__js": "^8.42.3",
         "@types/node": "^20.14.9",
         "@vitest/coverage-v8": "^1.6.0",
+        "@vitest/ui": "^1.6.0",
         "dotenv-cli": "^7.4.2",
         "eslint": "^9.6.0",
         "eslint-plugin-jsdoc": "^48.5.0",
-        "eslint-plugin-simple-import-sort": "^12.1.0",
+        "eslint-plugin-simple-import-sort": "^12.1.1",
         "jsdom": "^24.1.0",
         "release-it": "^17.4.1",
         "typescript-eslint": "^7.15.0",
-        "vite": "^5.3.2",
+        "vite": "^5.3.3",
         "vitest": "^1.6.0"
     },
     "peerDependencies": {

package/src/core/Api.ts

@@ -9,6 +9,9 @@ interface IApi {
     url: string;
     headers: IHeaders;
     routes: Map<string, Route>;
+    cache: false | number;
+
+    withCache: (duration?: number) => this;
 }
 
 export type IApiCallback = () => void;
@@ -26,6 +29,8 @@ export class Api implements IApi {
 
     public routes: Map<string, Route> = new Map<string, Route>();
 
+    public cache: false | number = false;
+
     /**
      * Constructor
      *
@@ -33,10 +38,10 @@ export class Api implements IApi {
      * @param url - The base URL of the API
      * @param headers - The headers to be sent with each request
      */
-    private constructor (name: string, url: string, headers: IHeaders) {
+    private constructor (name: string, url: string, headers: IHeaders = {}) {
         this.name = name;
         this.url = cleanUrl(url);
-        this.headers = headers || {};
+        this.headers = headers;
     }
 
     /**
@@ -48,7 +53,12 @@ export class Api implements IApi {
      * @param headers - The headers to be sent with each request
      * @returns The new API
      */
-    public static create (name: string, url: string, callback: IApiCallback, headers: IHeaders = {}): Api {
+    public static create (
+        name: string,
+        url: string,
+        callback: IApiCallback,
+        headers: IHeaders = {}
+    ): Api {
         const newName = toCamelCase(name);
         if (newName !== name) {
             console.warn(`API name "${name}" has been camelCased to "${newName}"`);
@@ -60,4 +70,15 @@ export class Api implements IApi {
         Registry.i.clearCurrent();
         return api;
     }
+
+    /**
+     * Enables caching for the API
+     *
+     * @param duration - The duration to cache the response for seconds (default: 20)
+     * @returns The API
+     */
+    public withCache (duration = 20): this {
+        this.cache = duration;
+        return this;
+    }
 }