express-memorize 1.3.0 → 1.5.0

package/dist/memorize.d.ts

@@ -3,37 +3,40 @@ import { MemorizeOptions } from './domain/MemorizeOptions';
 import { MemorizeCallOptions } from './domain/MemorizeCallOptions';
 export type { Memorize, MemorizeOptions, MemorizeCallOptions };
 /**
- * Creates an in-memory cache for an Express application.
+ * Creates an in-memory cache instance.
  *
- * Returns a {@link Memorize} instance that can be used as per-route middleware,
- * a global `app.use()` middleware, or a cache management API — all sharing the
- * same underlying store.
+ * Returns a {@link Memorize} instance that can be used as Express middleware,
+ * as a direct service-level cache, or as a cache management API — all sharing
+ * the same underlying store.
  *
- * **Only `GET` requests are cached.** Responses are cached only when the HTTP
- * status code is in the `2xx` range. The cache key is `req.originalUrl`, which
- * includes the query string.
+ * **HTTP middleware:** Only `GET` requests with a `2xx` status code are cached.
+ * The cache key is `req.originalUrl`, which includes the query string.
+ *
+ * **Direct cache:** Use {@link Memorize.set}, {@link Memorize.getValue}, and
+ * {@link Memorize.remember} to cache arbitrary values from services, workers,
+ * or any non-HTTP code.
  *
  * @param options - Global configuration for the cache instance.
  *
- * @example Per-route middleware
+ * @example Express middleware
  * ```ts
  * const cache = memorize({ ttl: 30_000 });
  *
- * app.get('/users', cache(), (req, res) => {
- *   res.json({ data: users });
- * });
+ * app.get('/users', cache.express(), handler);
+ * app.get('/users', cache(), handler);           // backwards-compatible alias
  * ```
  *
- * @example Global middleware
+ * @example Service-level caching
  * ```ts
- * const cache = memorize({ ttl: 60_000 });
- * app.use(cache()); // caches all GET routes
+ * const cache = memorize({ ttl: 30_000 });
+ *
+ * const users = await cache.remember('users:list', () => userService.findAll());
+ * cache.set('config', appConfig);
+ * const config = cache.getValue<AppConfig>('config');
  * ```
  *
  * @example Cache invalidation
  * ```ts
- * const cache = memorize({ ttl: 30_000 });
- *
  * app.post('/users', (req, res) => {
  *   users.push(req.body);
  *   cache.delete('/users');

package/dist/memorize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memorize.d.ts","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,QAAQ,CA8ChE"}
+{"version":3,"file":"memorize.d.ts","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAGnE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,QAAQ,CA6ChE"}

package/dist/memorize.js

@@ -2,38 +2,42 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memorize = memorize;
 const MemorizeStore_1 = require("./MemorizeStore");
+const express_1 = require("./adapters/express");
 /**
- * Creates an in-memory cache for an Express application.
+ * Creates an in-memory cache instance.
  *
- * Returns a {@link Memorize} instance that can be used as per-route middleware,
- * a global `app.use()` middleware, or a cache management API — all sharing the
- * same underlying store.
+ * Returns a {@link Memorize} instance that can be used as Express middleware,
+ * as a direct service-level cache, or as a cache management API — all sharing
+ * the same underlying store.
  *
- * **Only `GET` requests are cached.** Responses are cached only when the HTTP
- * status code is in the `2xx` range. The cache key is `req.originalUrl`, which
- * includes the query string.
+ * **HTTP middleware:** Only `GET` requests with a `2xx` status code are cached.
+ * The cache key is `req.originalUrl`, which includes the query string.
+ *
+ * **Direct cache:** Use {@link Memorize.set}, {@link Memorize.getValue}, and
+ * {@link Memorize.remember} to cache arbitrary values from services, workers,
+ * or any non-HTTP code.
  *
  * @param options - Global configuration for the cache instance.
  *
- * @example Per-route middleware
+ * @example Express middleware
  * ```ts
  * const cache = memorize({ ttl: 30_000 });
  *
- * app.get('/users', cache(), (req, res) => {
- *   res.json({ data: users });
- * });
+ * app.get('/users', cache.express(), handler);
+ * app.get('/users', cache(), handler);           // backwards-compatible alias
  * ```
  *
- * @example Global middleware
+ * @example Service-level caching
  * ```ts
- * const cache = memorize({ ttl: 60_000 });
- * app.use(cache()); // caches all GET routes
+ * const cache = memorize({ ttl: 30_000 });
+ *
+ * const users = await cache.remember('users:list', () => userService.findAll());
+ * cache.set('config', appConfig);
+ * const config = cache.getValue<AppConfig>('config');
  * ```
  *
  * @example Cache invalidation
  * ```ts
- * const cache = memorize({ ttl: 30_000 });
- *
  * app.post('/users', (req, res) => {
  *   users.push(req.body);
  *   cache.delete('/users');
@@ -50,36 +54,34 @@ const MemorizeStore_1 = require("./MemorizeStore");
  * ```
  */
 function memorize(options = {}) {
-    const { ttl } = options;
-    const store = new MemorizeStore_1.MemorizeStore();
+    const { ttl, maxEntries } = options;
+    const store = new MemorizeStore_1.MemorizeStore(maxEntries);
+    const expressMiddleware = (0, express_1.createExpressMiddleware)(store, ttl);
     const cache = function (callOptions) {
-        var _a;
-        const effectiveTtl = (_a = callOptions === null || callOptions === void 0 ? void 0 : callOptions.ttl) !== null && _a !== void 0 ? _a : ttl;
-        return function (req, res, next) {
-            if (req.method !== 'GET' || (callOptions === null || callOptions === void 0 ? void 0 : callOptions.noCache)) {
-                next();
-                return;
-            }
-            const key = req.originalUrl;
-            const cached = store.getRaw(key);
-            if (cached) {
-                res.setHeader('X-Cache', 'HIT');
-                res.setHeader('Content-Type', cached.contentType);
-                res.status(cached.statusCode).send(cached.body);
-                return;
-            }
-            const originalSend = res.send.bind(res);
-            res.send = function (body) {
-                var _a;
-                if (res.statusCode >= 200 && res.statusCode < 300) {
-                    const contentType = (_a = res.getHeader('Content-Type')) !== null && _a !== void 0 ? _a : 'application/octet-stream';
-                    store.set(key, { body, statusCode: res.statusCode, contentType }, effectiveTtl);
-                }
-                res.setHeader('X-Cache', 'MISS');
-                return originalSend(body);
-            };
-            next();
-        };
+        return expressMiddleware(callOptions);
+    };
+    cache.express = (callOptions) => expressMiddleware(callOptions);
+    cache.set = (key, value, entryTtl) => {
+        store.set(key, { body: JSON.stringify(value), statusCode: 200, contentType: 'application/json' }, entryTtl !== null && entryTtl !== void 0 ? entryTtl : ttl);
+    };
+    cache.getValue = (key) => {
+        const info = store.get(key);
+        if (!info)
+            return undefined;
+        try {
+            return JSON.parse(info.body);
+        }
+        catch (_a) {
+            return undefined;
+        }
+    };
+    cache.remember = async (key, factory, rememberTtl) => {
+        const existing = cache.getValue(key);
+        if (existing !== undefined)
+            return existing;
+        const value = await factory();
+        cache.set(key, value, rememberTtl);
+        return value;
     };
     cache.get = (key) => store.get(key);
     cache.getAll = () => store.getAll();
@@ -87,6 +89,10 @@ function memorize(options = {}) {
     cache.deleteMatching = (pattern) => store.deleteMatching(pattern);
     cache.clear = () => store.clear();
     cache.on = store.on.bind(store);
+    cache.size = () => store.size();
+    cache.byteSize = () => store.byteSize();
+    cache.getStats = () => store.getStats();
+    cache._store = store;
     return cache;
 }
 //# sourceMappingURL=memorize.js.map

package/dist/memorize.js.map

@@ -1 +1 @@
-{"version":3,"file":"memorize.js","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":";;AAuDA,4BA8CC;AApGD,mDAAgD;AAOhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,SAAgB,QAAQ,CAAC,UAA2B,EAAE;IACpD,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,MAAM,KAAK,GAAG,IAAI,6BAAa,EAAE,CAAC;IAElC,MAAM,KAAK,GAAG,UAAU,WAAiC;;QACvD,MAAM,YAAY,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,mCAAI,GAAG,CAAC;QAE7C,OAAO,UAAU,GAAY,EAAE,GAAa,EAAE,IAAkB;YAC9D,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,KAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAA,EAAE,CAAC;gBACjD,IAAI,EAAE,CAAC;gBACP,OAAO;YACT,CAAC;YAED,MAAM,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC;YAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEjC,IAAI,MAAM,EAAE,CAAC;gBACX,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAChC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;gBAClD,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAChD,OAAO;YACT,CAAC;YAED,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiC,CAAC;YAExE,GAAG,CAAC,IAAI,GAAG,UAAU,IAAc;;gBACjC,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;oBAClD,MAAM,WAAW,GAAG,MAAC,GAAG,CAAC,SAAS,CAAC,cAAc,CAAY,mCAAI,0BAA0B,CAAC;oBAC5F,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,YAAY,CAAC,CAAC;gBAClF,CAAC;gBACD,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;gBACjC,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC,CAAC;YAEF,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAa,CAAC;IAEd,KAAK,CAAC,GAAG,GAAc,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvD,KAAK,CAAC,MAAM,GAAW,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5C,KAAK,CAAC,MAAM,GAAW,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1D,KAAK,CAAC,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC1E,KAAK,CAAC,KAAK,GAAY,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC3C,KAAK,CAAC,EAAE,GAAe,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAmB,CAAC;IAE9D,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"memorize.js","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":";;AA0DA,4BA6CC;AAvGD,mDAAgD;AAIhD,gDAA6D;AAI7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,SAAgB,QAAQ,CAAC,UAA2B,EAAE;IACpD,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACpC,MAAM,KAAK,GAAG,IAAI,6BAAa,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,iBAAiB,GAAG,IAAA,iCAAuB,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE9D,MAAM,KAAK,GAAG,UAAU,WAAiC;QACvD,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACxC,CAAa,CAAC;IAEd,KAAK,CAAC,OAAO,GAAG,CAAC,WAAiC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAEtF,KAAK,CAAC,GAAG,GAAG,CAAI,GAAW,EAAE,KAAQ,EAAE,QAAiB,EAAQ,EAAE;QAChE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,GAAG,CAAC,CAAC;IACrH,CAAC,CAAC;IAEF,KAAK,CAAC,QAAQ,GAAG,CAAI,GAAW,EAAiB,EAAE;QACjD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAc,CAAM,CAAC;QAC9C,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC,CAAC;IAEF,KAAK,CAAC,QAAQ,GAAG,KAAK,EAAK,GAAW,EAAE,OAA6B,EAAE,WAAoB,EAAc,EAAE;QACzG,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAI,GAAG,CAAC,CAAC;QACxC,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC;QAC5C,MAAM,KAAK,GAAG,MAAM,OAAO,EAAE,CAAC;QAC9B,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,KAAK,CAAC,GAAG,GAAc,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvD,KAAK,CAAC,MAAM,GAAW,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5C,KAAK,CAAC,MAAM,GAAW,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1D,KAAK,CAAC,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC1E,KAAK,CAAC,KAAK,GAAY,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC3C,KAAK,CAAC,EAAE,GAAe,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAmB,CAAC;IAC9D,KAAK,CAAC,IAAI,GAAa,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1C,KAAK,CAAC,QAAQ,GAAS,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC9C,KAAK,CAAC,QAAQ,GAAS,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC9C,KAAK,CAAC,MAAM,GAAW,KAAK,CAAC;IAE7B,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,9 +1,32 @@
 {
   "name": "express-memorize",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "In-memory cache middleware for Express.js. Caches GET responses with optional TTL — zero dependencies, fully typed.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./express": {
+      "types": "./dist/adapters/express.d.ts",
+      "default": "./dist/adapters/express.js"
+    },
+    "./hono": {
+      "types": "./dist/adapters/hono.d.ts",
+      "default": "./dist/adapters/hono.js"
+    },
+    "./nestjs": {
+      "types": "./dist/adapters/nestjs.d.ts",
+      "default": "./dist/adapters/nestjs.js"
+    },
+    "./fetch": {
+      "types": "./dist/adapters/fetch.d.ts",
+      "default": "./dist/adapters/fetch.js"
+    }
+  },
   "homepage": "https://github.com/ElJijuna/express-memorize#readme",
   "repository": {
     "type": "git",
@@ -25,16 +48,6 @@
     "docs": "typedoc",
     "docs:watch": "typedoc --watch"
   },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node",
-    "testMatch": [
-      "**/__tests__/**/*.test.ts"
-    ],
-    "fakeTimers": {
-      "enableGlobally": false
-    }
-  },
   "keywords": [
     "express",
     "middleware",
@@ -47,16 +60,41 @@
   ],
   "license": "MIT",
   "peerDependencies": {
-    "express": ">=4.0.0"
+    "@nestjs/common": ">=9.0.0",
+    "@nestjs/core": ">=9.0.0",
+    "express": ">=4.0.0",
+    "hono": ">=4.0.0",
+    "rxjs": ">=7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": true
+    },
+    "@nestjs/core": {
+      "optional": true
+    },
+    "hono": {
+      "optional": true
+    },
+    "rxjs": {
+      "optional": true
+    }
   },
   "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
     "@types/express": "^4.17.21",
     "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
+    "hono": "^4.12.16",
     "jest": "^29.0.0",
+    "semantic-release": "^24.2.9",
     "ts-jest": "^29.0.0",
     "typedoc": "^0.28.18",
     "typedoc-material-theme": "^1.4.1",
     "typescript": "^5.0.0"
+  },
+  "author": "pilmee <pilmee@gmail.com> (https://github.com/ElJijuna)",
+  "publishConfig": {
+    "access": "public"
   }
 }