@sebspark/promise-cache 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -1,5 +1,26 @@
+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> {
-    private cache;
+    persistor: Persistor;
     private readonly caseSensitive;
     private readonly ttl;
     /**
@@ -13,6 +34,18 @@ declare class PromiseCache<U> {
      * @returns The number of entries in the cache.
      */
     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>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     */
+    find<U>(key: string): Promise<U | null>;
     /**
      * A simple promise cache wrapper.
      * @param key Cache key.
@@ -23,4 +56,17 @@ declare class PromiseCache<U> {
     wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
 }
 
-export { PromiseCache };
+declare class MockedRedis {
+    client: Map<any, any>;
+    get(key: string): any;
+    set(key: string, value: string, options?: {
+        EX: number;
+    }): void;
+    clear(): void;
+    DBSIZE(): Promise<number>;
+    on(event: string, callback: () => void): this;
+    connect(): Promise<this>;
+}
+declare const createClient: () => MockedRedis;
+
+export { PromiseCache, createClient };

package/dist/index.d.ts

@@ -1,5 +1,26 @@
+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> {
-    private cache;
+    persistor: Persistor;
     private readonly caseSensitive;
     private readonly ttl;
     /**
@@ -13,6 +34,18 @@ declare class PromiseCache<U> {
      * @returns The number of entries in the cache.
      */
     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>;
+    /**
+     * Get a value from the cache.
+     * @param key Cache key.
+     */
+    find<U>(key: string): Promise<U | null>;
     /**
      * A simple promise cache wrapper.
      * @param key Cache key.
@@ -23,4 +56,17 @@ declare class PromiseCache<U> {
     wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
 }
 
-export { PromiseCache };
+declare class MockedRedis {
+    client: Map<any, any>;
+    get(key: string): any;
+    set(key: string, value: string, options?: {
+        EX: number;
+    }): void;
+    clear(): void;
+    DBSIZE(): Promise<number>;
+    on(event: string, callback: () => void): this;
+    connect(): Promise<this>;
+}
+declare const createClient: () => MockedRedis;
+
+export { PromiseCache, createClient };

package/dist/index.js

@@ -20,25 +20,45 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  PromiseCache: () => PromiseCache
+  PromiseCache: () => PromiseCache,
+  createClient: () => createClient2
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/persistor.ts
 var import_redis = require("redis");
-var REDIS_HOST = process.env.REDIS_HOST || "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.client = (0, import_redis.createClient)({ url: REDIS_URL }).on(
-      "error",
-      (err) => console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err)
-    ).on(
-      "connect",
-      () => console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`)
-    );
+    this.connect();
+  }
+  async connect() {
+    try {
+      this.client = (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) {
@@ -91,7 +111,7 @@ var persistor = new Persistor();
 
 // src/promiseCache.ts
 var PromiseCache = class {
-  cache;
+  persistor;
   caseSensitive;
   ttl;
   // Time to live in milliseconds.
@@ -101,7 +121,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 = persistor;
+    this.persistor = persistor;
     this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
@@ -110,7 +130,30 @@ var PromiseCache = class {
    * @returns The number of entries in the cache.
    */
   async size() {
-    return await this.cache.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
+    });
+  }
+  /**
+   * Get a value from the cache.
+   * @param key Cache key.
+   */
+  async find(key) {
+    const result = await this.persistor.get(key);
+    return (result == null ? void 0 : result.value) ?? null;
   }
   /**
    * A simple promise cache wrapper.
@@ -123,7 +166,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 = await this.cache.get(effectiveKey);
+    const cached = await this.persistor.get(effectiveKey);
     if (cached) {
       if (cached.ttl !== effectiveTTL) {
         console.error(
@@ -133,7 +176,7 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(effectiveKey, {
+    this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,
       ttl: effectiveTTL
@@ -141,7 +184,41 @@ var PromiseCache = class {
     return response;
   }
 };
+
+// src/test/mockedRedis.ts
+var MockedRedis = class {
+  client = /* @__PURE__ */ new Map();
+  get(key) {
+    return this.client.get(key);
+  }
+  set(key, value, options) {
+    this.client.set(key, value);
+    if (options == null ? void 0 : options.EX) {
+      setTimeout(() => {
+        this.client.delete(key);
+      }, options.EX / 1e3);
+    }
+  }
+  clear() {
+    this.client.clear();
+  }
+  async DBSIZE() {
+    return Promise.resolve(this.client.size);
+  }
+  // Fake connection to fake server
+  on(event, callback) {
+    if (event === "connect") {
+      callback();
+    }
+    return this;
+  }
+  connect() {
+    return Promise.resolve(this);
+  }
+};
+var createClient2 = () => new MockedRedis();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  PromiseCache
+  PromiseCache,
+  createClient
 });

package/dist/index.mjs

@@ -1,18 +1,37 @@
 // src/persistor.ts
 import { createClient } from "redis";
-var REDIS_HOST = process.env.REDIS_HOST || "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.client = createClient({ url: REDIS_URL }).on(
-      "error",
-      (err) => console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err)
-    ).on(
-      "connect",
-      () => console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`)
-    );
+    this.connect();
+  }
+  async connect() {
+    try {
+      this.client = 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) {
@@ -65,7 +84,7 @@ var persistor = new Persistor();
 
 // src/promiseCache.ts
 var PromiseCache = class {
-  cache;
+  persistor;
   caseSensitive;
   ttl;
   // Time to live in milliseconds.
@@ -75,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 = persistor;
+    this.persistor = persistor;
     this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
@@ -84,7 +103,30 @@ var PromiseCache = class {
    * @returns The number of entries in the cache.
    */
   async size() {
-    return await this.cache.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
+    });
+  }
+  /**
+   * Get a value from the cache.
+   * @param key Cache key.
+   */
+  async find(key) {
+    const result = await this.persistor.get(key);
+    return (result == null ? void 0 : result.value) ?? null;
   }
   /**
    * A simple promise cache wrapper.
@@ -97,7 +139,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 = await this.cache.get(effectiveKey);
+    const cached = await this.persistor.get(effectiveKey);
     if (cached) {
       if (cached.ttl !== effectiveTTL) {
         console.error(
@@ -107,7 +149,7 @@ var PromiseCache = class {
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(effectiveKey, {
+    this.persistor.set(effectiveKey, {
       value: response,
       timestamp: now,
       ttl: effectiveTTL
@@ -115,6 +157,40 @@ var PromiseCache = class {
     return response;
   }
 };
+
+// src/test/mockedRedis.ts
+var MockedRedis = class {
+  client = /* @__PURE__ */ new Map();
+  get(key) {
+    return this.client.get(key);
+  }
+  set(key, value, options) {
+    this.client.set(key, value);
+    if (options == null ? void 0 : options.EX) {
+      setTimeout(() => {
+        this.client.delete(key);
+      }, options.EX / 1e3);
+    }
+  }
+  clear() {
+    this.client.clear();
+  }
+  async DBSIZE() {
+    return Promise.resolve(this.client.size);
+  }
+  // Fake connection to fake server
+  on(event, callback) {
+    if (event === "connect") {
+      callback();
+    }
+    return this;
+  }
+  connect() {
+    return Promise.resolve(this);
+  }
+};
+var createClient2 = () => new MockedRedis();
 export {
-  PromiseCache
+  PromiseCache,
+  createClient2 as createClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",