@nowarajs/elysia-cache 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,24 +1,19 @@
 
-## v1.2.0
+## v1.2.2
 
-[compare changes](https://github.com/NowaraJS/elysia-cache/compare/v1.1.0...v1.2.0)
+[compare changes](https://github.com/NowaraJS/elysia-cache/compare/v1.2.1...v1.2.2)
 
-### 🚀 Enhancements
+### 🧹 Refactors
 
-- **🚀:** [Add cache exports to index files] ([48995cd](https://github.com/NowaraJS/elysia-cache/commit/48995cd))
-
-### 🔧 Fixes
-
-- **🔧:** [Simplify cache response handling] ([86a502e](https://github.com/NowaraJS/elysia-cache/commit/86a502e))
+- **🧹:** [Refactor caching mechanism for improved readability] ## Refactoring - Simplified state management for cache routes. - Removed unnecessary variables and streamlined cache retrieval logic. - Enhanced clarity in cache handling by restructuring code flow. ([04deea2](https://github.com/NowaraJS/elysia-cache/commit/04deea2))
 
 ### 📖 Documentation
 
-- **📖:** [Update CHANGELOG for version 1.1.0 release] ## Documentation Changes - Removed outdated entries from the CHANGELOG.md for version 1.1.0. - Cleared previous enhancements, documentation updates, types, chores, tests, and CI changes to reflect a clean slate for future updates. ([cdcbffe](https://github.com/NowaraJS/elysia-cache/commit/cdcbffe))
+- **📖:** [Remove outdated v1.2.1 section from CHANGELOG] ([e903bcf](https://github.com/NowaraJS/elysia-cache/commit/e903bcf))
 
-### 📦 Build
+### 🌊 Types
 
-- **📦:** [Remove enums entrypoint from build configuration] ## Refactoring - Removed the entrypoint for enums from the Bun build configuration. ([ebd84b6](https://github.com/NowaraJS/elysia-cache/commit/ebd84b6))
-- **📦:** [Remove enums entrypoint from package exports] ## Build Changes - Removed the "./enums" entrypoint from the package exports. ([efb87e5](https://github.com/NowaraJS/elysia-cache/commit/efb87e5))
+- **🌊:** [Add CacheItem interface for caching mechanism] ([a7b46be](https://github.com/NowaraJS/elysia-cache/commit/a7b46be))
 
 ### ❤️ Contributors
 

package/dist/cache.d.ts

@@ -1,11 +1,11 @@
 import { Elysia } from 'elysia';
 import { MemoryStore } from '@nowarajs/kv-store/memory';
 import type { CacheOptions } from './types/cacheOptions';
-export declare const cache: ({ defaultTtl, prefix, storage }?: CacheOptions) => Elysia<"", {
+export declare const cache: ({ defaultTtl, prefix, store }?: CacheOptions) => Elysia<"", {
     decorator: {};
     store: {
         kvStore: import("@nowarajs/kv-store/types").KvStore | MemoryStore;
-        _cacheKey: string;
+        _cachedRoutes: Set<string>;
     };
     derive: {};
     resolve: {};
@@ -20,7 +20,7 @@ export declare const cache: ({ defaultTtl, prefix, storage }?: CacheOptions) =>
     }>;
     macroFn: {
         readonly isCached: (enable: boolean | number) => {
-            afterHandle({ set, response, store }: {
+            afterHandle({ set, response, store, request }: {
                 body: unknown;
                 query: Record<string, string>;
                 params: Record<string, string>;
@@ -39,7 +39,7 @@ export declare const cache: ({ defaultTtl, prefix, storage }?: CacheOptions) =>
                 request: Request;
                 store: {
                     kvStore: import("@nowarajs/kv-store/types").KvStore | MemoryStore;
-                    _cacheKey: string;
+                    _cachedRoutes: Set<string>;
                 };
                 status: <const Code extends number | keyof import("elysia").StatusMap, const T = Code extends 301 | 302 | 303 | 307 | 308 | 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 300 | 304 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 ? {
                     readonly 100: "Continue";

package/dist/index.js

@@ -9,30 +9,50 @@ import { MemoryStore } from "@nowarajs/kv-store/memory";
 var cache = ({
   defaultTtl = 60,
   prefix = "",
-  storage = ":memory:"
-} = {}) => new Elysia().state("kvStore", storage === ":memory:" ? new MemoryStore : storage).state("_cacheKey", "").onRequest(async ({ request, store, set }) => {
-  const cacheKey = await generateCacheKey(request.clone());
-  const cachedResponse = await store.kvStore.get(`${prefix}${cacheKey}`);
-  store._cacheKey = cacheKey;
-  if (cachedResponse) {
-    set.headers["Cache-Control"] = `max-age=${defaultTtl}, public`;
-    set.headers["X-Cache"] = "HIT";
-    set.headers["ETag"] = `"${prefix}${cacheKey}"`;
-    return cachedResponse;
+  store = ":memory:"
+} = {}) => new Elysia().state({
+  kvStore: store === ":memory:" ? new MemoryStore : store
+}).state({
+  _cachedRoutes: new Set
+}).onRequest(async ({ request, store: store2, set }) => {
+  const sanitizeUrl = new URL(request.url).pathname;
+  if (store2._cachedRoutes.has(`${request.method}:${sanitizeUrl}`)) {
+    const cacheKey = await generateCacheKey(request.clone());
+    const cachedData = await store2.kvStore.get(`${prefix}${cacheKey}`);
+    if (cachedData && typeof cachedData === "object" && "response" in cachedData && "metadata" in cachedData) {
+      const { response, metadata } = cachedData;
+      set.headers["cache-control"] = `max-age=${defaultTtl}, public`;
+      set.headers["x-cache"] = "HIT";
+      set.headers["etag"] = `"${prefix}${cacheKey}"`;
+      set.headers["expires"] = new Date(Date.now() + defaultTtl * 1000).toUTCString();
+      set.headers["last-modified"] = metadata.createdAt;
+      return response;
+    }
+    set.headers["x-cache"] = "MISS";
   }
   return;
 }).macro({
   isCached: (enable) => {
     const ttl = typeof enable === "number" ? enable : enable ? defaultTtl : 0;
     return {
-      async afterHandle({ set, response, store }) {
-        const cacheKey = store._cacheKey;
+      async afterHandle({ set, response, store: store2, request }) {
+        const sanitizeUrl = new URL(request.url).pathname;
+        if (!store2._cachedRoutes.has(`${request.method}:${sanitizeUrl}`))
+          store2._cachedRoutes.add(`${request.method}:${sanitizeUrl}`);
+        const cacheKey = await generateCacheKey(request.clone());
         const now = new Date;
-        set.headers["Cache-Control"] = `max-age=${ttl}, public`;
-        set.headers["ETag"] = `"${prefix}${cacheKey}"`;
-        set.headers["Last-Modified"] = now.toUTCString();
-        set.headers["Expires"] = new Date(now.getTime() + ttl * 1000).toUTCString();
-        await store.kvStore.set(`${prefix}${cacheKey}`, response, ttl);
+        set.headers["cache-control"] = `max-age=${ttl}, public`;
+        set.headers["etag"] = `"${prefix}${cacheKey}"`;
+        set.headers["last-modified"] = now.toUTCString();
+        set.headers["expires"] = new Date(now.getTime() + ttl * 1000).toUTCString();
+        const cacheData = {
+          response,
+          metadata: {
+            createdAt: now.toUTCString(),
+            ttl
+          }
+        };
+        await store2.kvStore.set(`${prefix}${cacheKey}`, cacheData, ttl);
       }
     };
   }

package/dist/types/cacheItem.d.ts

@@ -0,0 +1,7 @@
+export interface CacheItem {
+    response: unknown;
+    metadata: {
+        createdAt: string;
+        ttl: number;
+    };
+}

package/dist/types/cacheOptions.d.ts

@@ -17,5 +17,5 @@ export interface CacheOptions {
      *
      * @defaultValue ':memory:'
      */
-    storage?: ':memory:' | KvStore;
+    store?: ':memory:' | KvStore;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nowarajs/elysia-cache",
-	"version": "1.2.0",
+	"version": "1.2.2",
 	"author": "NowaraJS",
 	"description": "A template to create a bun package.",
 	"type": "module",