express-memorize 1.0.0 → 1.2.0

package/dist/domain/Memorize.d.ts

@@ -0,0 +1,123 @@
+import { RequestHandler } from 'express';
+import { CacheInfo } from './CacheInfo';
+import { MemorizeCallOptions } from './MemorizeCallOptions';
+import { MemorizeEventType } from './MemorizeEventType';
+import { MemorizeSetEvent } from './MemorizeSetEvent';
+import { MemorizeDeleteEvent } from './MemorizeDeleteEvent';
+import { MemorizeExpireEvent } from './MemorizeExpireEvent';
+import { MemorizeEmptyEvent } from './MemorizeEmptyEvent';
+/**
+ * The cache instance returned by {@link memorize}.
+ *
+ * It is both a callable that produces Express middleware **and** a namespace for
+ * cache management methods and event hooks. All middleware created from the same
+ * `Memorize` instance share a single underlying store.
+ *
+ * @example
+ * ```ts
+ * const cache = memorize({ ttl: 30_000 });
+ *
+ * // Per-route middleware
+ * app.get('/users', cache(), handler);
+ *
+ * // Global middleware — caches every GET route automatically
+ * app.use(cache());
+ *
+ * // Cache management
+ * cache.delete('/users');
+ * cache.clear();
+ * ```
+ */
+export interface Memorize {
+    /**
+     * Returns an Express `RequestHandler` that caches `GET` responses with a `2xx`
+     * status code.
+     *
+     * - On a **cache miss** the request proceeds normally. The response is intercepted
+     *   and stored after being sent. Sets `X-Cache: MISS`.
+     * - On a **cache hit** the stored response is returned immediately without calling
+     *   downstream handlers. Sets `X-Cache: HIT`.
+     * - Non-`GET` requests are forwarded to `next()` unchanged.
+     *
+     * @param options - Optional per-route options (e.g. TTL override).
+     *
+     * @example
+     * ```ts
+     * app.get('/users',    cache(),               handler); // global TTL
+     * app.get('/products', cache({ ttl: 5_000 }), handler); // 5-second override
+     * app.use(cache());                                      // global middleware
+     * ```
+     */
+    (options?: MemorizeCallOptions): RequestHandler;
+    /**
+     * Returns the {@link CacheInfo} for a specific cache key, or `null` if the key
+     * does not exist or has expired.
+     *
+     * @param key - The full request URL used as the cache key (e.g. `/users?page=1`).
+     *
+     * @example
+     * ```ts
+     * const info = cache.get('/users');
+     * if (info) console.log(`expires in ${info.remainingTtl}ms`);
+     * ```
+     */
+    get(key: string): CacheInfo | null;
+    /**
+     * Returns all active (non-expired) cache entries as a plain object keyed by URL.
+     *
+     * @example
+     * ```ts
+     * console.log(Object.keys(cache.getAll())); // ['/users', '/products']
+     * ```
+     */
+    getAll(): Record<string, CacheInfo>;
+    /**
+     * Removes a single entry from the cache and emits a {@link MemorizeEventType.Delete} event.
+     *
+     * @param key - The full request URL to invalidate.
+     * @returns `true` if the entry existed and was removed, `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * app.post('/users', (req, res) => {
+     *   users.push(req.body);
+     *   cache.delete('/users');
+     *   res.status(201).json(req.body);
+     * });
+     * ```
+     */
+    delete(key: string): boolean;
+    /**
+     * Removes **all** entries from the cache and emits a {@link MemorizeEventType.Delete}
+     * event for each.
+     *
+     * @example
+     * ```ts
+     * cache.clear();
+     * ```
+     */
+    clear(): void;
+    /**
+     * Registers a listener for cache events.
+     *
+     * | Event | When |
+     * |-------|------|
+     * | `MemorizeEventType.Set` | A response is stored |
+     * | `MemorizeEventType.Delete` | An entry is removed via `delete()` or `clear()` |
+     * | `MemorizeEventType.Expire` | An entry's TTL elapses |
+     * | `MemorizeEventType.Empty` | The last entry is removed, cache is now empty |
+     *
+     * @example
+     * ```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'));
+     * ```
+     */
+    on(event: MemorizeEventType.Set, handler: (e: MemorizeSetEvent) => void): void;
+    on(event: MemorizeEventType.Delete, handler: (e: MemorizeDeleteEvent) => void): void;
+    on(event: MemorizeEventType.Expire, handler: (e: MemorizeExpireEvent) => void): void;
+    on(event: MemorizeEventType.Empty, handler: (e: MemorizeEmptyEvent) => void): void;
+}
+//# sourceMappingURL=Memorize.d.ts.map

package/dist/domain/Memorize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Memorize.d.ts","sourceRoot":"","sources":["../../src/domain/Memorize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC;IAEhD;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEnC;;;;;;;OAOG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEpC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7B;;;;;;;;OAQG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;;;;;;;;;;OAiBG;IACH,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,GAAG,EAAK,OAAO,EAAE,CAAC,CAAC,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI,CAAC;IAClF,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI,CAAC;IACrF,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI,CAAC;IACrF,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,KAAK,EAAG,OAAO,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,GAAG,IAAI,CAAC;CACrF"}

package/dist/domain/Memorize.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Memorize.js.map

package/dist/domain/Memorize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Memorize.js","sourceRoot":"","sources":["../../src/domain/Memorize.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeCallOptions.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Options passed when invoking `cache()` to create a route-level middleware.
+ *
+ * @example
+ * ```ts
+ * // This route uses a 10-second TTL instead of the global 60-second TTL.
+ * app.get('/products', cache({ ttl: 10_000 }), handler);
+ * ```
+ */
+export interface MemorizeCallOptions {
+    /**
+     * Time-to-live override for this specific route, in milliseconds.
+     * Takes precedence over the global `ttl` set in {@link MemorizeOptions}.
+     * Pass `0` or omit to fall back to the global TTL.
+     */
+    ttl?: number;
+}
+//# sourceMappingURL=MemorizeCallOptions.d.ts.map

package/dist/domain/MemorizeCallOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeCallOptions.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeCallOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}

package/dist/domain/MemorizeCallOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeCallOptions.js.map

package/dist/domain/MemorizeCallOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeCallOptions.js","sourceRoot":"","sources":["../../src/domain/MemorizeCallOptions.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeDeleteEvent.d.ts

@@ -0,0 +1,18 @@
+import { MemorizeEventType } from './MemorizeEventType';
+/**
+ * Emitted when a cache entry is manually removed via {@link Memorize.delete} or
+ * {@link Memorize.clear}.
+ *
+ * @example
+ * ```ts
+ * cache.on(MemorizeEventType.Delete, (e) => {
+ *   console.log(`deleted ${e.key}`);
+ * });
+ * ```
+ */
+export interface MemorizeDeleteEvent {
+    type: MemorizeEventType.Delete;
+    /** The cache key that was removed. */
+    key: string;
+}
+//# sourceMappingURL=MemorizeDeleteEvent.d.ts.map

package/dist/domain/MemorizeDeleteEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeDeleteEvent.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeDeleteEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC;IAC/B,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/domain/MemorizeDeleteEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeDeleteEvent.js.map

package/dist/domain/MemorizeDeleteEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeDeleteEvent.js","sourceRoot":"","sources":["../../src/domain/MemorizeDeleteEvent.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeEmptyEvent.d.ts

@@ -0,0 +1,16 @@
+import { MemorizeEventType } from './MemorizeEventType';
+/**
+ * Emitted when the last entry is removed from the cache, leaving it empty.
+ * Triggered after a `delete` or `expire` eviction.
+ *
+ * @example
+ * ```ts
+ * cache.on(MemorizeEventType.Empty, () => {
+ *   console.log('cache is now empty');
+ * });
+ * ```
+ */
+export interface MemorizeEmptyEvent {
+    type: MemorizeEventType.Empty;
+}
+//# sourceMappingURL=MemorizeEmptyEvent.d.ts.map

package/dist/domain/MemorizeEmptyEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEmptyEvent.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeEmptyEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC;CAC/B"}

package/dist/domain/MemorizeEmptyEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeEmptyEvent.js.map

package/dist/domain/MemorizeEmptyEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEmptyEvent.js","sourceRoot":"","sources":["../../src/domain/MemorizeEmptyEvent.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeEvent.d.ts

@@ -0,0 +1,7 @@
+import { MemorizeSetEvent } from './MemorizeSetEvent';
+import { MemorizeDeleteEvent } from './MemorizeDeleteEvent';
+import { MemorizeExpireEvent } from './MemorizeExpireEvent';
+import { MemorizeEmptyEvent } from './MemorizeEmptyEvent';
+/** Union of all possible cache events. */
+export type MemorizeEvent = MemorizeSetEvent | MemorizeDeleteEvent | MemorizeExpireEvent | MemorizeEmptyEvent;
+//# sourceMappingURL=MemorizeEvent.d.ts.map

package/dist/domain/MemorizeEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEvent.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,0CAA0C;AAC1C,MAAM,MAAM,aAAa,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,mBAAmB,GACnB,kBAAkB,CAAC"}

package/dist/domain/MemorizeEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeEvent.js.map

package/dist/domain/MemorizeEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEvent.js","sourceRoot":"","sources":["../../src/domain/MemorizeEvent.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeEventType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Enum of all supported cache event types.
+ *
+ * @example
+ * ```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'));
+ * ```
+ */
+export declare enum MemorizeEventType {
+    /** Fired when a response is stored in the cache. */
+    Set = "set",
+    /** Fired when an entry is manually removed via `delete()` or `clear()`. */
+    Delete = "delete",
+    /** Fired when an entry is automatically removed after its TTL elapses. */
+    Expire = "expire",
+    /** Fired when the last entry is removed, leaving the cache empty. */
+    Empty = "empty"
+}
+//# sourceMappingURL=MemorizeEventType.d.ts.map

package/dist/domain/MemorizeEventType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEventType.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeEventType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,oBAAY,iBAAiB;IAC3B,oDAAoD;IACpD,GAAG,QAAQ;IACX,2EAA2E;IAC3E,MAAM,WAAW;IACjB,0EAA0E;IAC1E,MAAM,WAAW;IACjB,qEAAqE;IACrE,KAAK,UAAU;CAChB"}

package/dist/domain/MemorizeEventType.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemorizeEventType = void 0;
+/**
+ * Enum of all supported cache event types.
+ *
+ * @example
+ * ```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'));
+ * ```
+ */
+var MemorizeEventType;
+(function (MemorizeEventType) {
+    /** Fired when a response is stored in the cache. */
+    MemorizeEventType["Set"] = "set";
+    /** Fired when an entry is manually removed via `delete()` or `clear()`. */
+    MemorizeEventType["Delete"] = "delete";
+    /** Fired when an entry is automatically removed after its TTL elapses. */
+    MemorizeEventType["Expire"] = "expire";
+    /** Fired when the last entry is removed, leaving the cache empty. */
+    MemorizeEventType["Empty"] = "empty";
+})(MemorizeEventType || (exports.MemorizeEventType = MemorizeEventType = {}));
+//# sourceMappingURL=MemorizeEventType.js.map

package/dist/domain/MemorizeEventType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeEventType.js","sourceRoot":"","sources":["../../src/domain/MemorizeEventType.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,oDAAoD;IACpD,gCAAW,CAAA;IACX,2EAA2E;IAC3E,sCAAiB,CAAA;IACjB,0EAA0E;IAC1E,sCAAiB,CAAA;IACjB,qEAAqE;IACrE,oCAAe,CAAA;AACjB,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B"}

package/dist/domain/MemorizeExpireEvent.d.ts

@@ -0,0 +1,17 @@
+import { MemorizeEventType } from './MemorizeEventType';
+/**
+ * Emitted when a cache entry is automatically removed after its TTL elapses.
+ *
+ * @example
+ * ```ts
+ * cache.on(MemorizeEventType.Expire, (e) => {
+ *   console.log(`expired ${e.key}`);
+ * });
+ * ```
+ */
+export interface MemorizeExpireEvent {
+    type: MemorizeEventType.Expire;
+    /** The cache key that expired. */
+    key: string;
+}
+//# sourceMappingURL=MemorizeExpireEvent.d.ts.map

package/dist/domain/MemorizeExpireEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeExpireEvent.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeExpireEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC;IAC/B,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/domain/MemorizeExpireEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeExpireEvent.js.map

package/dist/domain/MemorizeExpireEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeExpireEvent.js","sourceRoot":"","sources":["../../src/domain/MemorizeExpireEvent.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeOptions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Options passed to the {@link memorize} factory.
+ *
+ * @example
+ * ```ts
+ * const cache = memorize({ ttl: 60_000 }); // cache entries live for 60 seconds
+ * ```
+ */
+export interface MemorizeOptions {
+    /**
+     * Default time-to-live for every cached entry, in milliseconds.
+     * Omit to cache indefinitely. Can be overridden per-route via {@link MemorizeCallOptions}.
+     */
+    ttl?: number;
+}
+//# sourceMappingURL=MemorizeOptions.d.ts.map

package/dist/domain/MemorizeOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeOptions.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}

package/dist/domain/MemorizeOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeOptions.js.map

package/dist/domain/MemorizeOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeOptions.js","sourceRoot":"","sources":["../../src/domain/MemorizeOptions.ts"],"names":[],"mappings":""}

package/dist/domain/MemorizeSetEvent.d.ts

@@ -0,0 +1,25 @@
+import { MemorizeEventType } from './MemorizeEventType';
+/**
+ * Emitted when a new response is stored in the cache.
+ *
+ * @example
+ * ```ts
+ * cache.on(MemorizeEventType.Set, (e) => {
+ *   console.log(`stored ${e.key} — status ${e.statusCode}`);
+ * });
+ * ```
+ */
+export interface MemorizeSetEvent {
+    type: MemorizeEventType.Set;
+    /** The cache key (full request URL). */
+    key: string;
+    /** The stored response body. */
+    body: unknown;
+    /** HTTP status code of the stored response. */
+    statusCode: number;
+    /** `Content-Type` header value of the stored response. */
+    contentType: string;
+    /** Expiry timestamp in ms, or `null` if no TTL was set. */
+    expiresAt: number | null;
+}
+//# sourceMappingURL=MemorizeSetEvent.d.ts.map

package/dist/domain/MemorizeSetEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeSetEvent.d.ts","sourceRoot":"","sources":["../../src/domain/MemorizeSetEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,iBAAiB,CAAC,GAAG,CAAC;IAC5B,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B"}

package/dist/domain/MemorizeSetEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MemorizeSetEvent.js.map

package/dist/domain/MemorizeSetEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemorizeSetEvent.js","sourceRoot":"","sources":["../../src/domain/MemorizeSetEvent.ts"],"names":[],"mappings":""}

package/dist/domain/index.d.ts

@@ -0,0 +1,12 @@
+export type { CacheEntry } from './CacheEntry';
+export type { CacheInfo } from './CacheInfo';
+export { MemorizeEventType } from './MemorizeEventType';
+export type { MemorizeEvent } from './MemorizeEvent';
+export type { MemorizeSetEvent } from './MemorizeSetEvent';
+export type { MemorizeDeleteEvent } from './MemorizeDeleteEvent';
+export type { MemorizeExpireEvent } from './MemorizeExpireEvent';
+export type { MemorizeEmptyEvent } from './MemorizeEmptyEvent';
+export type { MemorizeOptions } from './MemorizeOptions';
+export type { MemorizeCallOptions } from './MemorizeCallOptions';
+export type { Memorize } from './Memorize';
+//# sourceMappingURL=index.d.ts.map

package/dist/domain/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/domain/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/domain/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemorizeEventType = void 0;
+var MemorizeEventType_1 = require("./MemorizeEventType");
+Object.defineProperty(exports, "MemorizeEventType", { enumerable: true, get: function () { return MemorizeEventType_1.MemorizeEventType; } });
+//# sourceMappingURL=index.js.map

package/dist/domain/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/domain/index.ts"],"names":[],"mappings":";;;AAEA,yDAAwD;AAA/C,sHAAA,iBAAiB,OAAA"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { memorize } from './memorize';
-export type { MemorizeOptions, MemorizeCallOptions, Memorize } from './memorize';
-export type { CacheEntry, CacheInfo, MemorizeEvent, MemorizeEventType, MemorizeSetEvent, MemorizeDeleteEvent, MemorizeExpireEvent, } from './MemorizeStore';
+export type { Memorize, MemorizeOptions, MemorizeCallOptions } from './memorize';
+export { MemorizeEventType } from './domain/MemorizeEventType';
+export type { CacheEntry, CacheInfo, MemorizeEvent, MemorizeSetEvent, MemorizeDeleteEvent, MemorizeExpireEvent, MemorizeEmptyEvent, } from './domain/index';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjF,YAAY,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,YAAY,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memorize = void 0;
+exports.MemorizeEventType = exports.memorize = void 0;
 var memorize_1 = require("./memorize");
 Object.defineProperty(exports, "memorize", { enumerable: true, get: function () { return memorize_1.memorize; } });
+var MemorizeEventType_1 = require("./domain/MemorizeEventType");
+Object.defineProperty(exports, "MemorizeEventType", { enumerable: true, get: function () { return MemorizeEventType_1.MemorizeEventType; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AAEjB,gEAA+D;AAAtD,sHAAA,iBAAiB,OAAA"}

package/dist/memorize.d.ts

@@ -1,20 +1,53 @@
-import { RequestHandler } from 'express';
-import { CacheInfo, MemorizeSetEvent, MemorizeDeleteEvent, MemorizeExpireEvent } from './MemorizeStore';
-export interface MemorizeOptions {
-    ttl?: number;
-}
-export interface MemorizeCallOptions {
-    ttl?: number;
-}
-export interface Memorize {
-    (options?: MemorizeCallOptions): RequestHandler;
-    get(key: string): CacheInfo | null;
-    getAll(): Record<string, CacheInfo>;
-    delete(key: string): boolean;
-    clear(): void;
-    on(event: 'set', handler: (e: MemorizeSetEvent) => void): void;
-    on(event: 'delete', handler: (e: MemorizeDeleteEvent) => void): void;
-    on(event: 'expire', handler: (e: MemorizeExpireEvent) => void): void;
-}
+import { Memorize } from './domain/Memorize';
+import { MemorizeOptions } from './domain/MemorizeOptions';
+import { MemorizeCallOptions } from './domain/MemorizeCallOptions';
+export type { Memorize, MemorizeOptions, MemorizeCallOptions };
+/**
+ * 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'));
+ * ```
+ */
 export declare function memorize(options?: MemorizeOptions): Memorize;
 //# sourceMappingURL=memorize.d.ts.map

package/dist/memorize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memorize.d.ts","sourceRoot":"","sources":["../src/memorize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,cAAc,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAEL,SAAS,EACT,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC;IAChD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACnC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,KAAK,IAAI,IAAI,CAAC;IACd,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI,CAAC;IAC/D,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI,CAAC;IACrE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,GAAG,IAAI,CAAC;CACtE;AAED,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,QAAQ,CAwChE"}
+{"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,CA6ChE"}

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') {
+                next();
+                return;
+            }
             const key = req.originalUrl;
             const cached = store.getRaw(key);
             if (cached) {

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,4BA6CC;AAnGD,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,EAAE,CAAC;gBACzB,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,GAAM,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/C,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,GAAI,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,GAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAmB,CAAC;IAEtD,OAAO,KAAK,CAAC;AACf,CAAC"}