@rapidrest/core 2.0.0 → 3.0.0

package/dist/lib/MemoryStore.js

@@ -15,8 +15,7 @@ import { Destroy } from "./decorators/ObjectDecorators.js";
 /** How often the sweep interval reclaims expired, never-reloaded sessions. */
 const SWEEP_INTERVAL_MS = 60000;
 /**
- * Implements a simple key-value storage system in-memory for storing temporary records with a specified
- * lifetime (TTL) and size.
+ * Implements a SimpleStore storage system that uses a local in-memory storage map.
  *
  * @author Jean-Philippe Steinmetz
  */
@@ -46,7 +45,7 @@ export class MemoryStore {
         }
         return entry.data;
     }
-    save(id, data, ttlSeconds = this.defaultTTL) {
+    save(id, data, ttl = this.defaultTTL) {
         if (!this.entries.has(id) && this.entries.size >= this.maxSize) {
             // Reclaim space by sweeping expired entries first, then evicting the oldest surviving entries
             this.sweep();
@@ -59,7 +58,7 @@ export class MemoryStore {
         // at its original (oldest) position and `evictOldest()` would evict it ahead of a genuinely idle entry
         // inserted later.
         this.entries.delete(id);
-        this.entries.set(id, { data, expiresAt: Date.now() + ttlSeconds * 1000 });
+        this.entries.set(id, { data, expiresAt: Date.now() + ttl * 1000 });
     }
     delete(id) {
         this.entries.delete(id);

package/dist/lib/MemoryStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"MemoryStore.js","sourceRoot":"","sources":["../../src/MemoryStore.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAE3D,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,KAAM,CAAC;AAOjC;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAWpB;QAVA,2CAA2C;QACpC,eAAU,GAAW,EAAE,CAAC;QAErB,YAAO,GAAkC,IAAI,GAAG,EAAE,CAAC;QAE7D,8CAA8C;QACvC,YAAO,GAAW,KAAK,CAAC;QAK3B,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC;IAC9B,CAAC;IAED,4FAA4F;IAErF,OAAO;QACV,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAEM,IAAI,CAAC,EAAU;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,2CAA2C;QAC3C,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC;IACtB,CAAC;IAEM,IAAI,CAAC,EAAU,EAAE,IAAyB,EAAE,aAAqB,IAAI,CAAC,UAAU;QACnF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7D,8FAA8F;YAC9F,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAChE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;QACD,uGAAuG;QACvG,0GAA0G;QAC1G,uGAAuG;QACvG,kBAAkB;QAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,EAAU;QACpB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG;gBAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;CACJ;AA7CU;IADN,OAAO;;;;0CAGP"}
+{"version":3,"file":"MemoryStore.js","sourceRoot":"","sources":["../../src/MemoryStore.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAG3D,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,KAAM,CAAC;AAEjC;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAWpB;QAVA,2CAA2C;QACpC,eAAU,GAAW,EAAE,CAAC;QAErB,YAAO,GAAqC,IAAI,GAAG,EAAE,CAAC;QAEhE,8CAA8C;QACvC,YAAO,GAAW,KAAK,CAAC;QAK3B,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC;IAC9B,CAAC;IAED,4FAA4F;IAErF,OAAO;QACV,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAEM,IAAI,CAAC,EAAU;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,2CAA2C;QAC3C,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC;IACtB,CAAC;IAEM,IAAI,CAAC,EAAU,EAAE,IAAuB,EAAE,MAAc,IAAI,CAAC,UAAU;QAC1E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7D,8FAA8F;YAC9F,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAChE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;QACD,uGAAuG;QACvG,0GAA0G;QAC1G,uGAAuG;QACvG,kBAAkB;QAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,EAAU;QACpB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG;gBAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;CACJ;AA7CU;IADN,OAAO;;;;0CAGP"}

package/dist/lib/RedisStore.js

@@ -0,0 +1,129 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+import { CacheUtils } from "./CacheUtils.js";
+import { Destroy } from "./decorators/ObjectDecorators.js";
+/** How often the sweep interval reclaims expired, never-reloaded sessions. */
+const SWEEP_INTERVAL_MS = 60000;
+/**
+ * Implements a SimpleStore storage system that combines a local in-memory store optionally backed by Redis. When
+ * no Redis client is given, the store behaves as a plain in-memory store (equivalent to `MemoryStore`).
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class RedisStore {
+    /**
+     * @param client The Redis client to back this store with. When omitted, the store operates purely in-memory.
+     */
+    constructor(client) {
+        /** The default record TTL (in seconds). */
+        this.defaultTTL = 60;
+        this.entries = new Map();
+        /** The maximum number of records to store. */
+        this.maxSize = 10000;
+        this.client = client;
+        this.sweepTimer = setInterval(() => this.sweep(), SWEEP_INTERVAL_MS);
+        this.sweepTimer.unref?.();
+    }
+    destroy() {
+        clearInterval(this.sweepTimer);
+    }
+    async load(id) {
+        const entry = this.entries.get(id);
+        if (entry) {
+            // If the local copy hasn't expired, it's safe to serve directly.
+            if (entry.expiresAt > Date.now()) {
+                return entry.data;
+            }
+            // The local copy has expired, but Redis is the source of truth: another process may have renewed
+            // the entry (longer TTL) since we cached it here. Drop the stale local copy and fall through to
+            // check Redis instead of reporting "not found" based on local state alone.
+            this.entries.delete(id);
+        }
+        // Without a Redis client, this is a pure in-memory store: a local miss/expiry is a real miss.
+        if (!this.client) {
+            return undefined;
+        }
+        // The entry wasn't found locally. Try retrieving from redis.
+        // We'll also grab the ttl so we can add it to our local map.
+        const result = await this.client
+            .multi([
+            ["get", id],
+            ["ttl", id],
+        ])
+            .exec();
+        if (!result) {
+            return undefined;
+        }
+        const data = result[0][1] ? result[0][1] : undefined;
+        const ttl = result[1][1] ?? undefined;
+        if (!data) {
+            return undefined;
+        }
+        // Store the entry in our in-memory map for faster retrieval in the future. Bound the local map the same
+        // way save() does — otherwise repeated load()s of distinct ids that already exist in Redis (a normal
+        // read path) would grow the local map without limit, regardless of maxSize.
+        if (!this.entries.has(id) && this.entries.size >= this.maxSize) {
+            this.sweep();
+            while (this.entries.size >= this.maxSize && this.entries.size > 0) {
+                CacheUtils.evictOldest(this.entries);
+            }
+        }
+        const newEntry = {
+            data: JSON.parse(data),
+            expiresAt: Date.now() + ttl * 1000,
+        };
+        this.entries.set(id, newEntry);
+        return newEntry.data;
+    }
+    async save(id, data, ttl = this.defaultTTL) {
+        // Write to Redis first (when configured): if it fails (bad connection, etc.), the local cache is left
+        // untouched instead of reporting a "saved" value locally that never made it to the shared store other
+        // instances read from.
+        if (this.client) {
+            await this.client.setex(id, ttl, JSON.stringify(data));
+        }
+        if (!this.entries.has(id) && this.entries.size >= this.maxSize) {
+            // Reclaim space by sweeping expired entries first, then evicting the oldest surviving entries
+            this.sweep();
+            while (this.entries.size >= this.maxSize && this.entries.size > 0) {
+                CacheUtils.evictOldest(this.entries);
+            }
+        }
+        // Delete before re-inserting so a renewed entry moves to the end of the Map's iteration order. A `Map`
+        // does not reorder on `set()` of an already-present key, so without this, an actively-renewed entry stays
+        // at its original (oldest) position and `evictOldest()` would evict it ahead of a genuinely idle entry
+        // inserted later.
+        this.entries.delete(id);
+        this.entries.set(id, { data, expiresAt: Date.now() + ttl * 1000 });
+    }
+    async delete(id) {
+        this.entries.delete(id);
+        if (this.client) {
+            await this.client.del(id);
+        }
+    }
+    sweep() {
+        const now = Date.now();
+        for (const [sessionId, entry] of this.entries.entries()) {
+            if (entry.expiresAt <= now)
+                this.entries.delete(sessionId);
+        }
+    }
+}
+__decorate([
+    Destroy,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], RedisStore.prototype, "destroy", null);
+//# sourceMappingURL=RedisStore.js.map

package/dist/lib/RedisStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisStore.js","sourceRoot":"","sources":["../../src/RedisStore.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAI3D,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,KAAM,CAAC;AAEjC;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IAanB;;OAEG;IACH,YAAY,MAAsB;QAblC,2CAA2C;QACpC,eAAU,GAAW,EAAE,CAAC;QAErB,YAAO,GAAqC,IAAI,GAAG,EAAE,CAAC;QAEhE,8CAA8C;QACvC,YAAO,GAAW,KAAK,CAAC;QAQ3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC;IAC9B,CAAC;IAGM,OAAO;QACV,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,EAAU;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,KAAK,EAAE,CAAC;YACR,iEAAiE;YACjE,IAAI,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC,IAAI,CAAC;YACtB,CAAC;YAED,iGAAiG;YACjG,gGAAgG;YAChG,2EAA2E;YAC3E,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5B,CAAC;QAED,8FAA8F;QAC9F,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,6DAA6D;QAC7D,6DAA6D;QAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM;aAC3B,KAAK,CAAC;YACH,CAAC,KAAK,EAAE,EAAE,CAAC;YACX,CAAC,KAAK,EAAE,EAAE,CAAC;SACd,CAAC;aACD,IAAI,EAAE,CAAC;QACZ,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrD,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;QACtC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,wGAAwG;QACxG,qGAAqG;QACrG,4EAA4E;QAC5E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7D,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAChE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAwB;YAClC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC;YAChC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAI,GAAc,GAAG,IAAI;SACjD,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAE/B,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,IAAuB,EAAE,MAAc,IAAI,CAAC,UAAU;QAChF,sGAAsG;QACtG,sGAAsG;QACtG,uBAAuB;QACvB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7D,8FAA8F;YAC9F,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAChE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;QAED,uGAAuG;QACvG,0GAA0G;QAC1G,uGAAuG;QACvG,kBAAkB;QAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAAU;QAC1B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,KAAK;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG;gBAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;CACJ;AAjGU;IADN,OAAO;;;;yCAGP"}

package/dist/lib/SimpleStore.js

@@ -0,0 +1,5 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+export {};
+//# sourceMappingURL=SimpleStore.js.map

package/dist/lib/SimpleStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleStore.js","sourceRoot":"","sources":["../../src/SimpleStore.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,+EAA+E"}

package/dist/types/MemoryStore.d.ts

@@ -1,25 +1,21 @@
-export interface MemoryStoreEntry {
-    data: Record<string, any>;
-    expiresAt: number;
-}
+import { MemoryStoreEntry, SimpleStore } from "./SimpleStore.js";
 /**
- * Implements a simple key-value storage system in-memory for storing temporary records with a specified
- * lifetime (TTL) and size.
+ * Implements a SimpleStore storage system that uses a local in-memory storage map.
  *
  * @author Jean-Philippe Steinmetz
  */
-export declare class MemoryStore {
+export declare class MemoryStore<T> implements SimpleStore<T> {
     /** The default record TTL (in seconds). */
     defaultTTL: number;
-    protected entries: Map<string, MemoryStoreEntry>;
+    protected entries: Map<string, MemoryStoreEntry<T>>;
     /** The maximum number of records to store. */
     maxSize: number;
     private sweepTimer;
     constructor();
     /** Stops the background sweep timer. Call when the owning `SessionManager` is destroyed. */
     destroy(): void;
-    load(id: string): Record<string, any> | undefined;
-    save(id: string, data: Record<string, any>, ttlSeconds?: number): void;
+    load(id: string): Record<string, T> | undefined;
+    save(id: string, data: Record<string, T>, ttl?: number): void;
     delete(id: string): void;
     private sweep;
 }

package/dist/types/RedisStore.d.ts

@@ -0,0 +1,26 @@
+import { MemoryStoreEntry, SimpleStore } from "./SimpleStore.js";
+import type * as ioredis from "ioredis";
+/**
+ * Implements a SimpleStore storage system that combines a local in-memory store optionally backed by Redis. When
+ * no Redis client is given, the store behaves as a plain in-memory store (equivalent to `MemoryStore`).
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class RedisStore<T> implements SimpleStore<T> {
+    client?: ioredis.Redis;
+    /** The default record TTL (in seconds). */
+    defaultTTL: number;
+    protected entries: Map<string, MemoryStoreEntry<T>>;
+    /** The maximum number of records to store. */
+    maxSize: number;
+    private sweepTimer;
+    /**
+     * @param client The Redis client to back this store with. When omitted, the store operates purely in-memory.
+     */
+    constructor(client?: ioredis.Redis);
+    destroy(): void;
+    load(id: string): Promise<Record<string, T> | undefined>;
+    save(id: string, data: Record<string, T>, ttl?: number): Promise<void>;
+    delete(id: string): Promise<void>;
+    private sweep;
+}

package/dist/types/SimpleStore.d.ts

@@ -0,0 +1,33 @@
+export interface MemoryStoreEntry<T> {
+    data: Record<string, T>;
+    expiresAt: number;
+}
+/**
+ * Defines an interface for a simple key-value storage system that stores temporary records with a specified
+ * lifetime (TTL) and size.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export interface SimpleStore<T> {
+    /** The default record TTL (in seconds). */
+    defaultTTL: number;
+    /** The maximum number of records to store. */
+    maxSize: number;
+    /**
+     * Deletes the record with the given id.
+     * @param id The id of the record to delete.
+     */
+    delete(id: string): Promise<void> | void;
+    /**
+     * Retrieves the record with the given id.
+     * @param id The id of the record to retrieve.
+     */
+    load(id: string): Promise<Record<string, T> | undefined> | Record<string, T> | undefined;
+    /**
+     * Stores the record with the given id for the specified TTL.
+     * @param id The id of the record to retrieve.
+     * @param data The record to store.
+     * @param ttl The number of seconds that the record will be stored.
+     */
+    save(id: string, data: Record<string, T>, ttl: number): Promise<void> | void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rapidrest/core",
-    "version": "2.0.0",
+    "version": "3.0.0",
     "description": "A collection of common utilities and core functionality for rapidly building RESTful applications.",
     "repository": "https://github.com/rapidrest/core.git",
     "author": "RapidREST <rapidrests@gmail.com>",
@@ -34,6 +34,7 @@
     },
     "peerDependencies": {
         "axios": "1.x",
+        "ioredis": "6.x",
         "reflect-metadata": "0.2.x",
         "winston": "3.x",
         "winston-transport": "4.x"
@@ -58,6 +59,7 @@
         "eslint-config-prettier": "^10.1.8",
         "eslint-plugin-import": "^2.32.0",
         "eslint-plugin-jsdoc": "^63.0.2",
+        "ioredis": "^6.0.0",
         "mkdirp": "^3.0.1",
         "nconf": "^0.13.0",
         "nock": "^14.0.15",