express-memorize 1.0.0 → 1.3.0

package/dist/memorize.js

@@ -2,6 +2,53 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memorize = memorize;
 const MemorizeStore_1 = require("./MemorizeStore");
+/**
+ * Creates an in-memory cache for an Express application.
+ *
+ * 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.
+ *
+ * **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.
+ *
+ * @param options - Global configuration for the cache instance.
+ *
+ * @example Per-route middleware
+ * ```ts
+ * const cache = memorize({ ttl: 30_000 });
+ *
+ * app.get('/users', cache(), (req, res) => {
+ *   res.json({ data: users });
+ * });
+ * ```
+ *
+ * @example Global middleware
+ * ```ts
+ * const cache = memorize({ ttl: 60_000 });
+ * app.use(cache()); // caches all GET routes
+ * ```
+ *
+ * @example Cache invalidation
+ * ```ts
+ * const cache = memorize({ ttl: 30_000 });
+ *
+ * app.post('/users', (req, res) => {
+ *   users.push(req.body);
+ *   cache.delete('/users');
+ *   res.status(201).json(req.body);
+ * });
+ * ```
+ *
+ * @example Event hooks
+ * ```ts
+ * cache.on(MemorizeEventType.Set,    (e) => console.log('stored',  e.key));
+ * cache.on(MemorizeEventType.Delete, (e) => console.log('deleted', e.key));
+ * cache.on(MemorizeEventType.Expire, (e) => console.log('expired', e.key));
+ * cache.on(MemorizeEventType.Empty,  ()  => console.log('cache is empty'));
+ * ```
+ */
 function memorize(options = {}) {
     const { ttl } = options;
     const store = new MemorizeStore_1.MemorizeStore();
@@ -9,6 +56,10 @@ function memorize(options = {}) {
         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) {
@@ -33,6 +84,7 @@ function memorize(options = {}) {
     cache.get = (key) => store.get(key);
     cache.getAll = () => store.getAll();
     cache.delete = (key) => store.delete(key);
+    cache.deleteMatching = (pattern) => store.deleteMatching(pattern);
     cache.clear = () => store.clear();
     cache.on = store.on.bind(store);
     return cache;

package/dist/memorize.js.map

@@ -1 +1 @@
-{"version":3,"file":"memorize.js","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":";;AA4BA,4BAwCC;AAnED,mDAMyB;AAqBzB,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,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,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5C,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACpC,KAAK,CAAC,MAAM,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClD,KAAK,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAClC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAmB,CAAC;IAElD,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"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"}

package/dist/utils/globToRegex.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Converts a glob pattern to a `RegExp`.
+ *
+ * Glob rules:
+ * - `**` — matches any character sequence across path segments (crosses `/`).
+ * - `*`  — matches any character sequence within a single path segment (does not cross `/`).
+ * - `?`  — matches any single character except `/`.
+ *
+ * @internal
+ */
+export declare function globToRegex(pattern: string): RegExp;
+//# sourceMappingURL=globToRegex.d.ts.map

package/dist/utils/globToRegex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globToRegex.d.ts","sourceRoot":"","sources":["../../src/utils/globToRegex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAsBnD"}

package/dist/utils/globToRegex.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globToRegex = globToRegex;
+/**
+ * Converts a glob pattern to a `RegExp`.
+ *
+ * Glob rules:
+ * - `**` — matches any character sequence across path segments (crosses `/`).
+ * - `*`  — matches any character sequence within a single path segment (does not cross `/`).
+ * - `?`  — matches any single character except `/`.
+ *
+ * @internal
+ */
+function globToRegex(pattern) {
+    let result = '^';
+    let i = 0;
+    while (i < pattern.length) {
+        const ch = pattern[i];
+        if (ch === '*' && pattern[i + 1] === '*') {
+            result += '.*';
+            i += 2;
+            if (pattern[i] === '/')
+                i++;
+        }
+        else if (ch === '*') {
+            result += '[^/]*';
+            i++;
+        }
+        else if (ch === '?') {
+            result += '[^/]';
+            i++;
+        }
+        else {
+            result += ch.replace(/[.+^${}()|[\]\\]/g, '\\$&');
+            i++;
+        }
+    }
+    result += '$';
+    return new RegExp(result);
+}
+//# sourceMappingURL=globToRegex.js.map

package/dist/utils/globToRegex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globToRegex.js","sourceRoot":"","sources":["../../src/utils/globToRegex.ts"],"names":[],"mappings":";;AAUA,kCAsBC;AAhCD;;;;;;;;;GASG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,EAAE,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACzC,MAAM,IAAI,IAAI,CAAC;YACf,CAAC,IAAI,CAAC,CAAC;YACP,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG;gBAAE,CAAC,EAAE,CAAC;QAC9B,CAAC;aAAM,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,OAAO,CAAC;YAClB,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,MAAM,CAAC;YACjB,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,EAAE,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;YAClD,CAAC,EAAE,CAAC;QACN,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC;IACd,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC"}

package/package.json

@@ -1,28 +1,50 @@
 {
   "name": "express-memorize",
-  "version": "1.0.0",
-  "description": "Express.js in-memory cache middleware with TTL support",
+  "version": "1.3.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",
+  "homepage": "https://github.com/ElJijuna/express-memorize#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ElJijuna/express-memorize.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ElJijuna/express-memorize/issues"
+  },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
     "test": "jest",
     "test:watch": "jest --watch",
-    "prepublishOnly": "npm test && npm run build"
+    "prepublishOnly": "npm test && npm run build",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch"
   },
   "jest": {
     "preset": "ts-jest",
     "testEnvironment": "node",
-    "testMatch": ["**/__tests__/**/*.test.ts"],
+    "testMatch": [
+      "**/__tests__/**/*.test.ts"
+    ],
     "fakeTimers": {
       "enableGlobally": false
     }
   },
-  "keywords": ["express", "middleware", "cache", "memory", "ttl"],
+  "keywords": [
+    "express",
+    "middleware",
+    "cache",
+    "memory",
+    "ttl",
+    "in-memory",
+    "http-cache",
+    "expressjs"
+  ],
   "license": "MIT",
   "peerDependencies": {
     "express": ">=4.0.0"
@@ -33,6 +55,8 @@
     "@types/node": "^20.0.0",
     "jest": "^29.0.0",
     "ts-jest": "^29.0.0",
+    "typedoc": "^0.28.18",
+    "typedoc-material-theme": "^1.4.1",
     "typescript": "^5.0.0"
   }
 }