@sebspark/promise-cache 3.7.0 → 3.9.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { RedisClientOptions, createClient, SetOptions } from 'redis';
+import { createClient, RedisClientOptions, SetOptions } from 'redis';
 export { RedisClientOptions } from 'redis';
 import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
@@ -353,7 +353,13 @@ interface IPersistor {
      * @returns Resolves to the number of elements removed.
      */
     zRem: (key: string, members: string | string[]) => Promise<number>;
+    isReady: boolean;
+    isOpen: boolean;
+    connect: () => Promise<IPersistor>;
+    once: (event: IPersistorEvent, cb: EventCallback) => IPersistor;
 }
+type IPersistorEvent = 'ready' | 'connect' | 'reconnecting';
+type EventCallback = () => void;
 /**
  * Interface for executing multiple storage commands in a batch operation.
  * All commands are queued and executed when `exec()` is called.
@@ -590,6 +596,10 @@ declare class InMemoryPersistor implements IPersistor {
      * Initializes an empty store, expiration map, and TTL tracker.
      */
     constructor();
+    connect(): Promise<this>;
+    get isReady(): boolean;
+    get isOpen(): boolean;
+    once(): this;
     /**
      * Stores a key-value pair with optional expiration settings.
      * If an expiration is provided (`EX`, `PX`, `EXAT`, `PXAT`), the key is automatically removed when TTL expires.
@@ -875,7 +885,7 @@ declare namespace time {
 }
 
 declare const serialize: <T>(data: T) => string;
-declare const deserialize: <T>(serialized: string) => T;
+declare const deserialize: <T>(serialized: string | null) => T | null;
 
 declare const serializer_deserialize: typeof deserialize;
 declare const serializer_serialize: typeof serialize;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { RedisClientOptions, createClient, SetOptions } from 'redis';
+import { createClient, RedisClientOptions, SetOptions } from 'redis';
 export { RedisClientOptions } from 'redis';
 import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
@@ -353,7 +353,13 @@ interface IPersistor {
      * @returns Resolves to the number of elements removed.
      */
     zRem: (key: string, members: string | string[]) => Promise<number>;
+    isReady: boolean;
+    isOpen: boolean;
+    connect: () => Promise<IPersistor>;
+    once: (event: IPersistorEvent, cb: EventCallback) => IPersistor;
 }
+type IPersistorEvent = 'ready' | 'connect' | 'reconnecting';
+type EventCallback = () => void;
 /**
  * Interface for executing multiple storage commands in a batch operation.
  * All commands are queued and executed when `exec()` is called.
@@ -590,6 +596,10 @@ declare class InMemoryPersistor implements IPersistor {
      * Initializes an empty store, expiration map, and TTL tracker.
      */
     constructor();
+    connect(): Promise<this>;
+    get isReady(): boolean;
+    get isOpen(): boolean;
+    once(): this;
     /**
      * Stores a key-value pair with optional expiration settings.
      * If an expiration is provided (`EX`, `PX`, `EXAT`, `PXAT`), the key is automatically removed when TTL expires.
@@ -875,7 +885,7 @@ declare namespace time {
 }
 
 declare const serialize: <T>(data: T) => string;
-declare const deserialize: <T>(serialized: string) => T;
+declare const deserialize: <T>(serialized: string | null) => T | null;
 
 declare const serializer_deserialize: typeof deserialize;
 declare const serializer_serialize: typeof serialize;

package/dist/index.js

@@ -409,12 +409,14 @@ var createCache = (persistor, prefix) => {
         }
         const resultPromise = (async () => {
           try {
-            const cached = await persistor.get(key);
+            await ensurePersistorIsReady(persistor);
+            const cached = deserialize(await persistor.get(key));
             if (cached !== null) {
-              return deserialize(cached);
+              return cached;
             }
             const result = await delegate(...args);
             const expiry = typeof options.expiry === "function" ? options.expiry(args, result) : options.expiry;
+            await ensurePersistorIsReady(persistor);
             const serialized = serialize(result);
             const setOptions = toSetOptions(expiry);
             await persistor.set(key, serialized, setOptions);
@@ -430,6 +432,28 @@ var createCache = (persistor, prefix) => {
   };
   return cache;
 };
+var ensurePersistorIsReady = async (persistor) => {
+  if (persistor.isReady) {
+    return;
+  }
+  if (persistor.isOpen) {
+    await new Promise((resolve) => {
+      if (persistor.isReady) return resolve();
+      persistor.once("ready", resolve);
+      return;
+    });
+  }
+  try {
+    await persistor.connect();
+  } catch (err) {
+    if (err.message === "Socket already opened") {
+      await new Promise((resolve) => {
+        if (persistor.isReady) return resolve();
+        persistor.once("ready", resolve);
+      });
+    }
+  }
+};
 
 // src/inMemoryPersistor.ts
 var InMemoryPersistor = class {
@@ -459,6 +483,18 @@ var InMemoryPersistor = class {
     this.expirations = /* @__PURE__ */ new Map();
     this.expiryTimestamps = /* @__PURE__ */ new Map();
   }
+  async connect() {
+    return this;
+  }
+  get isReady() {
+    return true;
+  }
+  get isOpen() {
+    return true;
+  }
+  once() {
+    return this;
+  }
   /**
    * Stores a key-value pair with optional expiration settings.
    * If an expiration is provided (`EX`, `PX`, `EXAT`, `PXAT`), the key is automatically removed when TTL expires.
@@ -469,6 +505,12 @@ var InMemoryPersistor = class {
    * @returns {Promise<'OK' | null>} Resolves to `'OK'` on success, or `null` if a conditional set (`NX`) fails.
    */
   async set(key, value, options) {
+    if (options?.NX && this.store.has(key)) {
+      return null;
+    }
+    if (options?.XX && !this.store.has(key)) {
+      return null;
+    }
     this.store.set(key, value);
     if (options?.EX !== void 0) {
       this.setExpiration(key, options.EX * 1e3);

package/dist/index.mjs

@@ -390,12 +390,14 @@ var createCache = (persistor, prefix) => {
         }
         const resultPromise = (async () => {
           try {
-            const cached = await persistor.get(key);
+            await ensurePersistorIsReady(persistor);
+            const cached = deserialize(await persistor.get(key));
             if (cached !== null) {
-              return deserialize(cached);
+              return cached;
             }
             const result = await delegate(...args);
             const expiry = typeof options.expiry === "function" ? options.expiry(args, result) : options.expiry;
+            await ensurePersistorIsReady(persistor);
             const serialized = serialize(result);
             const setOptions = toSetOptions(expiry);
             await persistor.set(key, serialized, setOptions);
@@ -411,6 +413,28 @@ var createCache = (persistor, prefix) => {
   };
   return cache;
 };
+var ensurePersistorIsReady = async (persistor) => {
+  if (persistor.isReady) {
+    return;
+  }
+  if (persistor.isOpen) {
+    await new Promise((resolve) => {
+      if (persistor.isReady) return resolve();
+      persistor.once("ready", resolve);
+      return;
+    });
+  }
+  try {
+    await persistor.connect();
+  } catch (err) {
+    if (err.message === "Socket already opened") {
+      await new Promise((resolve) => {
+        if (persistor.isReady) return resolve();
+        persistor.once("ready", resolve);
+      });
+    }
+  }
+};
 
 // src/inMemoryPersistor.ts
 var InMemoryPersistor = class {
@@ -440,6 +464,18 @@ var InMemoryPersistor = class {
     this.expirations = /* @__PURE__ */ new Map();
     this.expiryTimestamps = /* @__PURE__ */ new Map();
   }
+  async connect() {
+    return this;
+  }
+  get isReady() {
+    return true;
+  }
+  get isOpen() {
+    return true;
+  }
+  once() {
+    return this;
+  }
   /**
    * Stores a key-value pair with optional expiration settings.
    * If an expiration is provided (`EX`, `PX`, `EXAT`, `PXAT`), the key is automatically removed when TTL expires.
@@ -450,6 +486,12 @@ var InMemoryPersistor = class {
    * @returns {Promise<'OK' | null>} Resolves to `'OK'` on success, or `null` if a conditional set (`NX`) fails.
    */
   async set(key, value, options) {
+    if (options?.NX && this.store.has(key)) {
+      return null;
+    }
+    if (options?.XX && !this.store.has(key)) {
+      return null;
+    }
     this.store.set(key, value);
     if (options?.EX !== void 0) {
       this.setExpiration(key, options.EX * 1e3);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "3.7.0",
+  "version": "3.9.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -17,8 +17,8 @@
     "typecheck": "vitest --typecheck.only --passWithNoTests"
   },
   "devDependencies": {
-    "@testcontainers/redis": "^10.17.2",
-    "testcontainers": "^10.17.2",
+    "@testcontainers/redis": "^10.18.0",
+    "testcontainers": "^10.18.0",
     "tsconfig": "*"
   },
   "dependencies": {