@sebspark/promise-cache 0.2.0 → 0.2.2

package/dist/index.d.mts

@@ -1,5 +1,26 @@
-declare class PromiseCache<T, U> {
-    private cache;
+type GetType<T> = {
+    value: T;
+    ttl: number;
+    timestamp: number;
+};
+type SetParams<T> = {
+    value: T;
+    timestamp: number;
+    ttl: number;
+};
+declare class Persistor {
+    private client;
+    status: 'connected' | 'disconnected';
+    constructor();
+    connect(): Promise<void>;
+    size(): Promise<number>;
+    get<T>(key: string): Promise<GetType<T> | null>;
+    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
+    delete(key: string): Promise<void>;
+}
+
+declare class PromiseCache<U> {
+    persistor: Persistor;
     private readonly caseSensitive;
     private readonly ttl;
     /**
@@ -12,7 +33,14 @@ declare class PromiseCache<T, U> {
      * Cache size.
      * @returns The number of entries in the cache.
      */
-    size(): number;
+    size(): Promise<number>;
+    /**
+     * Set a value in the cache.
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttlInSeconds Time to live in seconds.
+     */
+    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
     /**
      * A simple promise cache wrapper.
      * @param key Cache key.

package/dist/index.d.ts

@@ -1,5 +1,26 @@
-declare class PromiseCache<T, U> {
-    private cache;
+type GetType<T> = {
+    value: T;
+    ttl: number;
+    timestamp: number;
+};
+type SetParams<T> = {
+    value: T;
+    timestamp: number;
+    ttl: number;
+};
+declare class Persistor {
+    private client;
+    status: 'connected' | 'disconnected';
+    constructor();
+    connect(): Promise<void>;
+    size(): Promise<number>;
+    get<T>(key: string): Promise<GetType<T> | null>;
+    set<T>(key: string, { value, timestamp, ttl }: SetParams<T>): Promise<void>;
+    delete(key: string): Promise<void>;
+}
+
+declare class PromiseCache<U> {
+    persistor: Persistor;
     private readonly caseSensitive;
     private readonly ttl;
     /**
@@ -12,7 +33,14 @@ declare class PromiseCache<T, U> {
      * Cache size.
      * @returns The number of entries in the cache.
      */
-    size(): number;
+    size(): Promise<number>;
+    /**
+     * Set a value in the cache.
+     * @param key Cache key.
+     * @param value Cache value.
+     * @param ttlInSeconds Time to live in seconds.
+     */
+    override<U>(key: string, value: U, ttlInSeconds?: number): Promise<void>;
     /**
      * A simple promise cache wrapper.
      * @param key Cache key.

package/dist/index.js

@@ -24,9 +24,93 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/persistor.ts
+var import_redis = require("redis");
+var REDIS_HOST = process.env.REDIS_HOST || "127.0.0.1";
+var REDIS_PORT = process.env.REDIS_PORT || 6379;
+var REDIS_URL = `redis://${REDIS_HOST}:${REDIS_PORT}`;
+var Persistor = class {
+  client;
+  status = "disconnected";
+  constructor() {
+    this.connect();
+  }
+  async connect() {
+    try {
+      this.client = await (0, import_redis.createClient)({ url: REDIS_URL });
+      this.client.on("error", (err) => {
+        console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err);
+        this.status = "disconnected";
+      });
+      this.client.connect();
+      await new Promise((resolve, reject) => {
+        if (!this.client) {
+          reject("Client not initialized");
+          return;
+        }
+        this.client.on("connect", () => {
+          console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`);
+          this.status = "connected";
+          resolve(true);
+        });
+      });
+    } catch (err) {
+      console.error(`\u274C REDIS | Connection Error | ${REDIS_URL}`, err);
+      this.status = "disconnected";
+    }
+  }
+  async size() {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    return await this.client.DBSIZE();
+  }
+  async get(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const result = await this.client.get(key);
+      if (!result) {
+        return null;
+      }
+      return JSON.parse(result);
+    } catch (error) {
+      console.error(`Error getting data from redis: ${error}`);
+      throw error;
+    }
+  }
+  async set(key, { value, timestamp, ttl }) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const serializedData = JSON.stringify({ value, ttl, timestamp });
+      await this.client.set(key, serializedData, {
+        EX: ttl / 1e3
+      });
+    } catch (error) {
+      console.error(`Error setting data in redis: ${error}`);
+      throw error;
+    }
+  }
+  async delete(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      await this.client.del(key);
+    } catch (error) {
+      console.error(`Error deleting data from redis: ${error}`);
+      throw error;
+    }
+  }
+};
+var persistor = new Persistor();
+
 // src/promiseCache.ts
 var PromiseCache = class {
-  cache;
+  persistor;
   caseSensitive;
   ttl;
   // Time to live in milliseconds.
@@ -36,7 +120,7 @@ var PromiseCache = class {
    * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
    */
   constructor(ttlInSeconds, caseSensitive = false) {
-    this.cache = /* @__PURE__ */ new Map();
+    this.persistor = persistor;
     this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
@@ -44,8 +128,23 @@ var PromiseCache = class {
    * Cache size.
    * @returns The number of entries in the cache.
    */
-  size() {
-    return this.cache.size;
+  async size() {
+    return await this.persistor.size();
+  }
+  /**
+   * Set a value in the cache.
+   * @param key Cache key.
+   * @param value Cache value.
+   * @param ttlInSeconds Time to live in seconds.
+   */
+  async override(key, value, ttlInSeconds) {
+    const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
+    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    await this.persistor.set(effectiveKey, {
+      value,
+      timestamp: Date.now(),
+      ttl: effectiveTTL
+    });
   }
   /**
    * A simple promise cache wrapper.
@@ -58,7 +157,7 @@ var PromiseCache = class {
     const now = Date.now();
     const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
     const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
-    const cached = this.cache.get(effectiveKey);
+    const cached = await this.persistor.get(effectiveKey);
     if (cached) {
       if (cached.ttl !== effectiveTTL) {
         console.error(
@@ -68,14 +167,11 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(effectiveKey, {
+    this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,
       ttl: effectiveTTL
     });
-    setTimeout(() => {
-      this.cache.delete(effectiveKey);
-    }, effectiveTTL);
     return response;
   }
 };

package/dist/index.mjs

@@ -1,6 +1,90 @@
+// src/persistor.ts
+import { createClient } from "redis";
+var REDIS_HOST = process.env.REDIS_HOST || "127.0.0.1";
+var REDIS_PORT = process.env.REDIS_PORT || 6379;
+var REDIS_URL = `redis://${REDIS_HOST}:${REDIS_PORT}`;
+var Persistor = class {
+  client;
+  status = "disconnected";
+  constructor() {
+    this.connect();
+  }
+  async connect() {
+    try {
+      this.client = await createClient({ url: REDIS_URL });
+      this.client.on("error", (err) => {
+        console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err);
+        this.status = "disconnected";
+      });
+      this.client.connect();
+      await new Promise((resolve, reject) => {
+        if (!this.client) {
+          reject("Client not initialized");
+          return;
+        }
+        this.client.on("connect", () => {
+          console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`);
+          this.status = "connected";
+          resolve(true);
+        });
+      });
+    } catch (err) {
+      console.error(`\u274C REDIS | Connection Error | ${REDIS_URL}`, err);
+      this.status = "disconnected";
+    }
+  }
+  async size() {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    return await this.client.DBSIZE();
+  }
+  async get(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const result = await this.client.get(key);
+      if (!result) {
+        return null;
+      }
+      return JSON.parse(result);
+    } catch (error) {
+      console.error(`Error getting data from redis: ${error}`);
+      throw error;
+    }
+  }
+  async set(key, { value, timestamp, ttl }) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const serializedData = JSON.stringify({ value, ttl, timestamp });
+      await this.client.set(key, serializedData, {
+        EX: ttl / 1e3
+      });
+    } catch (error) {
+      console.error(`Error setting data in redis: ${error}`);
+      throw error;
+    }
+  }
+  async delete(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      await this.client.del(key);
+    } catch (error) {
+      console.error(`Error deleting data from redis: ${error}`);
+      throw error;
+    }
+  }
+};
+var persistor = new Persistor();
+
 // src/promiseCache.ts
 var PromiseCache = class {
-  cache;
+  persistor;
   caseSensitive;
   ttl;
   // Time to live in milliseconds.
@@ -10,7 +94,7 @@ var PromiseCache = class {
    * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
    */
   constructor(ttlInSeconds, caseSensitive = false) {
-    this.cache = /* @__PURE__ */ new Map();
+    this.persistor = persistor;
     this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
@@ -18,8 +102,23 @@ var PromiseCache = class {
    * Cache size.
    * @returns The number of entries in the cache.
    */
-  size() {
-    return this.cache.size;
+  async size() {
+    return await this.persistor.size();
+  }
+  /**
+   * Set a value in the cache.
+   * @param key Cache key.
+   * @param value Cache value.
+   * @param ttlInSeconds Time to live in seconds.
+   */
+  async override(key, value, ttlInSeconds) {
+    const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
+    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    await this.persistor.set(effectiveKey, {
+      value,
+      timestamp: Date.now(),
+      ttl: effectiveTTL
+    });
   }
   /**
    * A simple promise cache wrapper.
@@ -32,7 +131,7 @@ var PromiseCache = class {
     const now = Date.now();
     const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
     const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
-    const cached = this.cache.get(effectiveKey);
+    const cached = await this.persistor.get(effectiveKey);
     if (cached) {
       if (cached.ttl !== effectiveTTL) {
         console.error(
@@ -42,14 +141,11 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(effectiveKey, {
+    this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,
       ttl: effectiveTTL
     });
-    setTimeout(() => {
-      this.cache.delete(effectiveKey);
-    }, effectiveTTL);
     return response;
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -15,5 +15,8 @@
   },
   "devDependencies": {
     "tsconfig": "*"
+  },
+  "dependencies": {
+    "redis": "^4.6.13"
   }
 }