@devbro/neko-cache 0.1.4 → 0.1.6

package/dist/providers/MemoryCacheProvider.mjs

@@ -12,10 +12,17 @@ class MemoryCacheProvider {
     // 10 minutes
   };
   cleanupTimer;
+  /**
+   * Creates a new MemoryCacheProvider instance.
+   * @param config - Configuration options for the cache
+   */
   constructor(config = {}) {
     this.config = { ...this.config, ...config };
     this.startCleanupTimer();
   }
+  /**
+   * Starts the automatic cleanup timer for expired entries.
+   */
   startCleanupTimer() {
     if (this.config.cleanupInterval > 0) {
       this.cleanupTimer = setInterval(() => {
@@ -23,12 +30,18 @@ class MemoryCacheProvider {
       }, this.config.cleanupInterval * 1e3);
     }
   }
+  /**
+   * Stops the automatic cleanup timer.
+   */
   stopCleanupTimer() {
     if (this.cleanupTimer) {
       clearInterval(this.cleanupTimer);
       this.cleanupTimer = void 0;
     }
   }
+  /**
+   * Removes all expired entries from the cache.
+   */
   cleanupExpiredEntries() {
     const now = Date.now();
     for (const [key, item] of this.cache.entries()) {
@@ -37,6 +50,9 @@ class MemoryCacheProvider {
       }
     }
   }
+  /**
+   * Evicts the least recently used item if cache size exceeds maximum.
+   */
   evictLRU() {
     if (this.cache.size <= this.config.maxSize) {
       return;
@@ -53,6 +69,11 @@ class MemoryCacheProvider {
       this.cache.delete(oldestKey);
     }
   }
+  /**
+   * Retrieves a value from the cache.
+   * @param key - The cache key
+   * @returns The cached value or undefined if not found or expired
+   */
   async get(key) {
     const item = this.cache.get(key);
     if (!item) {
@@ -65,6 +86,12 @@ class MemoryCacheProvider {
     item.lastAccessed = Date.now();
     return item.value;
   }
+  /**
+   * Stores a value in the cache.
+   * @param key - The cache key
+   * @param value - The value to cache
+   * @param ttl - Time to live in seconds (optional)
+   */
   async put(key, value, ttl) {
     const now = Date.now();
     const effectiveTTL = ttl ?? this.config.defaultTTL;
@@ -77,9 +104,18 @@ class MemoryCacheProvider {
     this.cache.set(key, item);
     this.evictLRU();
   }
+  /**
+   * Deletes a value from the cache.
+   * @param key - The cache key to delete
+   */
   async delete(key) {
     this.cache.delete(key);
   }
+  /**
+   * Checks if a key exists in the cache and has not expired.
+   * @param key - The cache key to check
+   * @returns True if the key exists and is not expired, false otherwise
+   */
   async has(key) {
     const item = this.cache.get(key);
     if (!item) {
@@ -91,6 +127,13 @@ class MemoryCacheProvider {
     }
     return true;
   }
+  /**
+   * Increments a numeric value in the cache atomically.
+   * If the key doesn't exist or is expired, it starts from 0.
+   * @param key - The cache key to increment
+   * @param amount - The amount to increment by (default: 1)
+   * @returns The new value after incrementing
+   */
   async increment(key, amount = 1) {
     const item = this.cache.get(key);
     const now = Date.now();

package/dist/providers/MemoryCacheProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/providers/MemoryCacheProvider.mts"],"sourcesContent":["import { JSONObject, JSONValue } from '@devbro/neko-helper';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\n\nexport interface MemoryCacheConfig {\n  maxSize?: number;\n  defaultTTL?: number;\n  cleanupInterval?: number;\n}\n\ninterface CacheItem {\n  value: any;\n  expiresAt?: number;\n  createdAt: number;\n  lastAccessed: number;\n}\n\nexport class MemoryCacheProvider implements CacheProviderInterface {\n  private cache = new Map<string, CacheItem>();\n  private config: MemoryCacheConfig = {\n    maxSize: 1000,\n    defaultTTL: 3600,\n    cleanupInterval: 600, // 10 minutes\n  };\n\n  private cleanupTimer?: NodeJS.Timeout;\n\n  constructor(config: MemoryCacheConfig = {}) {\n    this.config = { ...this.config, ...config };\n\n    this.startCleanupTimer();\n  }\n\n  private startCleanupTimer(): void {\n    if (this.config.cleanupInterval! > 0) {\n      this.cleanupTimer = setInterval(() => {\n        this.cleanupExpiredEntries();\n      }, this.config.cleanupInterval! * 1000);\n    }\n  }\n\n  private stopCleanupTimer(): void {\n    if (this.cleanupTimer) {\n      clearInterval(this.cleanupTimer);\n      this.cleanupTimer = undefined;\n    }\n  }\n\n  private cleanupExpiredEntries(): void {\n    const now = Date.now();\n\n    for (const [key, item] of this.cache.entries()) {\n      if (item.expiresAt && item.expiresAt < now) {\n        this.cache.delete(key);\n      }\n    }\n  }\n\n  private evictLRU(): void {\n    if (this.cache.size <= this.config.maxSize!) {\n      return;\n    }\n\n    // Find the least recently accessed item\n    let oldestKey: string | null = null;\n    let oldestTime = Date.now();\n\n    for (const [key, item] of this.cache.entries()) {\n      if (item.lastAccessed < oldestTime) {\n        oldestTime = item.lastAccessed;\n        oldestKey = key;\n      }\n    }\n\n    if (oldestKey) {\n      this.cache.delete(oldestKey);\n    }\n  }\n\n  async get(key: string): Promise<JSONObject | JSONValue | undefined> {\n    const item = this.cache.get(key);\n\n    if (!item) {\n      return undefined;\n    }\n\n    // Check if item has expired\n    if (item.expiresAt && item.expiresAt < Date.now()) {\n      this.cache.delete(key);\n      return undefined;\n    }\n\n    // Update last accessed time for LRU\n    item.lastAccessed = Date.now();\n\n    return item.value;\n  }\n\n  async put(key: string, value: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    const now = Date.now();\n    const effectiveTTL = ttl ?? this.config.defaultTTL!;\n\n    const item: CacheItem = {\n      value,\n      createdAt: now,\n      lastAccessed: now,\n      expiresAt: effectiveTTL > 0 ? now + effectiveTTL * 1000 : undefined,\n    };\n\n    this.cache.set(key, item);\n\n    // Evict items if we exceed maxSize\n    this.evictLRU();\n  }\n\n  async delete(key: string): Promise<void> {\n    this.cache.delete(key);\n  }\n\n  async has(key: string): Promise<boolean> {\n    const item = this.cache.get(key);\n\n    if (!item) {\n      return false;\n    }\n\n    // Check if item has expired\n    if (item.expiresAt && item.expiresAt < Date.now()) {\n      this.cache.delete(key);\n      return false;\n    }\n\n    return true;\n  }\n\n  async increment(key: string, amount: number = 1): Promise<number> {\n    const item = this.cache.get(key);\n    const now = Date.now();\n\n    let currentValue = 0;\n\n    // Check if item exists and is not expired\n    if (item) {\n      if (item.expiresAt && item.expiresAt < now) {\n        this.cache.delete(key);\n      } else {\n        // Get current value, ensure it's a number\n        currentValue = typeof item.value === 'number' ? item.value : 0;\n      }\n    }\n\n    // Calculate new value\n    const newValue = currentValue + amount;\n\n    // Store the new value with the same TTL if it existed\n    const newItem: CacheItem = {\n      value: newValue,\n      createdAt: item?.createdAt ?? now,\n      lastAccessed: now,\n      expiresAt: item?.expiresAt,\n    };\n\n    this.cache.set(key, newItem);\n\n    return newValue;\n  }\n}\n"],"mappings":";;AAgBO,MAAM,oBAAsD;AAAA,EAhBnE,OAgBmE;AAAA;AAAA;AAAA,EACzD,QAAQ,oBAAI,IAAuB;AAAA,EACnC,SAA4B;AAAA,IAClC,SAAS;AAAA,IACT,YAAY;AAAA,IACZ,iBAAiB;AAAA;AAAA,EACnB;AAAA,EAEQ;AAAA,EAER,YAAY,SAA4B,CAAC,GAAG;AAC1C,SAAK,SAAS,EAAE,GAAG,KAAK,QAAQ,GAAG,OAAO;AAE1C,SAAK,kBAAkB;AAAA,EACzB;AAAA,EAEQ,oBAA0B;AAChC,QAAI,KAAK,OAAO,kBAAmB,GAAG;AACpC,WAAK,eAAe,YAAY,MAAM;AACpC,aAAK,sBAAsB;AAAA,MAC7B,GAAG,KAAK,OAAO,kBAAmB,GAAI;AAAA,IACxC;AAAA,EACF;AAAA,EAEQ,mBAAyB;AAC/B,QAAI,KAAK,cAAc;AACrB,oBAAc,KAAK,YAAY;AAC/B,WAAK,eAAe;AAAA,IACtB;AAAA,EACF;AAAA,EAEQ,wBAA8B;AACpC,UAAM,MAAM,KAAK,IAAI;AAErB,eAAW,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC9C,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,aAAK,MAAM,OAAO,GAAG;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,WAAiB;AACvB,QAAI,KAAK,MAAM,QAAQ,KAAK,OAAO,SAAU;AAC3C;AAAA,IACF;AAGA,QAAI,YAA2B;AAC/B,QAAI,aAAa,KAAK,IAAI;AAE1B,eAAW,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC9C,UAAI,KAAK,eAAe,YAAY;AAClC,qBAAa,KAAK;AAClB,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,QAAI,WAAW;AACb,WAAK,MAAM,OAAO,SAAS;AAAA,IAC7B;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,KAA0D;AAClE,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAE/B,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAGA,QAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,WAAK,MAAM,OAAO,GAAG;AACrB,aAAO;AAAA,IACT;AAGA,SAAK,eAAe,KAAK,IAAI;AAE7B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,eAAe,OAAO,KAAK,OAAO;AAExC,UAAM,OAAkB;AAAA,MACtB;AAAA,MACA,WAAW;AAAA,MACX,cAAc;AAAA,MACd,WAAW,eAAe,IAAI,MAAM,eAAe,MAAO;AAAA,IAC5D;AAEA,SAAK,MAAM,IAAI,KAAK,IAAI;AAGxB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAM,OAAO,KAA4B;AACvC,SAAK,MAAM,OAAO,GAAG;AAAA,EACvB;AAAA,EAEA,MAAM,IAAI,KAA+B;AACvC,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAE/B,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAGA,QAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,WAAK,MAAM,OAAO,GAAG;AACrB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAC/B,UAAM,MAAM,KAAK,IAAI;AAErB,QAAI,eAAe;AAGnB,QAAI,MAAM;AACR,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,aAAK,MAAM,OAAO,GAAG;AAAA,MACvB,OAAO;AAEL,uBAAe,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ;AAAA,MAC/D;AAAA,IACF;AAGA,UAAM,WAAW,eAAe;AAGhC,UAAM,UAAqB;AAAA,MACzB,OAAO;AAAA,MACP,WAAW,MAAM,aAAa;AAAA,MAC9B,cAAc;AAAA,MACd,WAAW,MAAM;AAAA,IACnB;AAEA,SAAK,MAAM,IAAI,KAAK,OAAO;AAE3B,WAAO;AAAA,EACT;AACF;","names":[]}
+{"version":3,"sources":["../../src/providers/MemoryCacheProvider.mts"],"sourcesContent":["import { JSONObject, JSONValue } from '@devbro/neko-helper';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\n\n/**\n * Configuration options for the in-memory cache provider.\n */\nexport type MemoryCacheConfig = {\n  /** Maximum number of items to store in cache (default: 1000) */\n  maxSize?: number;\n  /** Default time to live in seconds (default: 3600) */\n  defaultTTL?: number;\n  /** Interval in seconds to run cleanup of expired entries (default: 600) */\n  cleanupInterval?: number;\n};\n\n/**\n * Represents a cached item with metadata.\n */\ninterface CacheItem {\n  /** The cached value */\n  value: any;\n  /** Timestamp when the item expires (milliseconds since epoch) */\n  expiresAt?: number;\n  /** Timestamp when the item was created (milliseconds since epoch) */\n  createdAt: number;\n  /** Timestamp when the item was last accessed (milliseconds since epoch) */\n  lastAccessed: number;\n}\n\n/**\n * In-memory cache provider with LRU eviction and automatic cleanup.\n * Stores cache entries in memory with support for TTL and size limits.\n */\nexport class MemoryCacheProvider implements CacheProviderInterface {\n  private cache = new Map<string, CacheItem>();\n  private config: MemoryCacheConfig = {\n    maxSize: 1000,\n    defaultTTL: 3600,\n    cleanupInterval: 600, // 10 minutes\n  };\n\n  private cleanupTimer?: NodeJS.Timeout;\n\n  /**\n   * Creates a new MemoryCacheProvider instance.\n   * @param config - Configuration options for the cache\n   */\n  constructor(config: MemoryCacheConfig = {}) {\n    this.config = { ...this.config, ...config };\n\n    this.startCleanupTimer();\n  }\n\n  /**\n   * Starts the automatic cleanup timer for expired entries.\n   */\n  private startCleanupTimer(): void {\n    if (this.config.cleanupInterval! > 0) {\n      this.cleanupTimer = setInterval(() => {\n        this.cleanupExpiredEntries();\n      }, this.config.cleanupInterval! * 1000);\n    }\n  }\n\n  /**\n   * Stops the automatic cleanup timer.\n   */\n  private stopCleanupTimer(): void {\n    if (this.cleanupTimer) {\n      clearInterval(this.cleanupTimer);\n      this.cleanupTimer = undefined;\n    }\n  }\n\n  /**\n   * Removes all expired entries from the cache.\n   */\n  private cleanupExpiredEntries(): void {\n    const now = Date.now();\n\n    for (const [key, item] of this.cache.entries()) {\n      if (item.expiresAt && item.expiresAt < now) {\n        this.cache.delete(key);\n      }\n    }\n  }\n\n  /**\n   * Evicts the least recently used item if cache size exceeds maximum.\n   */\n  private evictLRU(): void {\n    if (this.cache.size <= this.config.maxSize!) {\n      return;\n    }\n\n    // Find the least recently accessed item\n    let oldestKey: string | null = null;\n    let oldestTime = Date.now();\n\n    for (const [key, item] of this.cache.entries()) {\n      if (item.lastAccessed < oldestTime) {\n        oldestTime = item.lastAccessed;\n        oldestKey = key;\n      }\n    }\n\n    if (oldestKey) {\n      this.cache.delete(oldestKey);\n    }\n  }\n\n  /**\n   * Retrieves a value from the cache.\n   * @param key - The cache key\n   * @returns The cached value or undefined if not found or expired\n   */\n  async get(key: string): Promise<JSONObject | JSONValue | undefined> {\n    const item = this.cache.get(key);\n\n    if (!item) {\n      return undefined;\n    }\n\n    // Check if item has expired\n    if (item.expiresAt && item.expiresAt < Date.now()) {\n      this.cache.delete(key);\n      return undefined;\n    }\n\n    // Update last accessed time for LRU\n    item.lastAccessed = Date.now();\n\n    return item.value;\n  }\n\n  /**\n   * Stores a value in the cache.\n   * @param key - The cache key\n   * @param value - The value to cache\n   * @param ttl - Time to live in seconds (optional)\n   */\n  async put(key: string, value: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    const now = Date.now();\n    const effectiveTTL = ttl ?? this.config.defaultTTL!;\n\n    const item: CacheItem = {\n      value,\n      createdAt: now,\n      lastAccessed: now,\n      expiresAt: effectiveTTL > 0 ? now + effectiveTTL * 1000 : undefined,\n    };\n\n    this.cache.set(key, item);\n\n    // Evict items if we exceed maxSize\n    this.evictLRU();\n  }\n\n  /**\n   * Deletes a value from the cache.\n   * @param key - The cache key to delete\n   */\n  async delete(key: string): Promise<void> {\n    this.cache.delete(key);\n  }\n\n  /**\n   * Checks if a key exists in the cache and has not expired.\n   * @param key - The cache key to check\n   * @returns True if the key exists and is not expired, false otherwise\n   */\n  async has(key: string): Promise<boolean> {\n    const item = this.cache.get(key);\n\n    if (!item) {\n      return false;\n    }\n\n    // Check if item has expired\n    if (item.expiresAt && item.expiresAt < Date.now()) {\n      this.cache.delete(key);\n      return false;\n    }\n\n    return true;\n  }\n\n  /**\n   * Increments a numeric value in the cache atomically.\n   * If the key doesn't exist or is expired, it starts from 0.\n   * @param key - The cache key to increment\n   * @param amount - The amount to increment by (default: 1)\n   * @returns The new value after incrementing\n   */\n  async increment(key: string, amount: number = 1): Promise<number> {\n    const item = this.cache.get(key);\n    const now = Date.now();\n\n    let currentValue = 0;\n\n    // Check if item exists and is not expired\n    if (item) {\n      if (item.expiresAt && item.expiresAt < now) {\n        this.cache.delete(key);\n      } else {\n        // Get current value, ensure it's a number\n        currentValue = typeof item.value === 'number' ? item.value : 0;\n      }\n    }\n\n    // Calculate new value\n    const newValue = currentValue + amount;\n\n    // Store the new value with the same TTL if it existed\n    const newItem: CacheItem = {\n      value: newValue,\n      createdAt: item?.createdAt ?? now,\n      lastAccessed: now,\n      expiresAt: item?.expiresAt,\n    };\n\n    this.cache.set(key, newItem);\n\n    return newValue;\n  }\n}\n"],"mappings":";;AAiCO,MAAM,oBAAsD;AAAA,EAjCnE,OAiCmE;AAAA;AAAA;AAAA,EACzD,QAAQ,oBAAI,IAAuB;AAAA,EACnC,SAA4B;AAAA,IAClC,SAAS;AAAA,IACT,YAAY;AAAA,IACZ,iBAAiB;AAAA;AAAA,EACnB;AAAA,EAEQ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,YAAY,SAA4B,CAAC,GAAG;AAC1C,SAAK,SAAS,EAAE,GAAG,KAAK,QAAQ,GAAG,OAAO;AAE1C,SAAK,kBAAkB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC,QAAI,KAAK,OAAO,kBAAmB,GAAG;AACpC,WAAK,eAAe,YAAY,MAAM;AACpC,aAAK,sBAAsB;AAAA,MAC7B,GAAG,KAAK,OAAO,kBAAmB,GAAI;AAAA,IACxC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,mBAAyB;AAC/B,QAAI,KAAK,cAAc;AACrB,oBAAc,KAAK,YAAY;AAC/B,WAAK,eAAe;AAAA,IACtB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,wBAA8B;AACpC,UAAM,MAAM,KAAK,IAAI;AAErB,eAAW,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC9C,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,aAAK,MAAM,OAAO,GAAG;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,WAAiB;AACvB,QAAI,KAAK,MAAM,QAAQ,KAAK,OAAO,SAAU;AAC3C;AAAA,IACF;AAGA,QAAI,YAA2B;AAC/B,QAAI,aAAa,KAAK,IAAI;AAE1B,eAAW,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC9C,UAAI,KAAK,eAAe,YAAY;AAClC,qBAAa,KAAK;AAClB,oBAAY;AAAA,MACd;AAAA,IACF;AAEA,QAAI,WAAW;AACb,WAAK,MAAM,OAAO,SAAS;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA0D;AAClE,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAE/B,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAGA,QAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,WAAK,MAAM,OAAO,GAAG;AACrB,aAAO;AAAA,IACT;AAGA,SAAK,eAAe,KAAK,IAAI;AAE7B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,eAAe,OAAO,KAAK,OAAO;AAExC,UAAM,OAAkB;AAAA,MACtB;AAAA,MACA,WAAW;AAAA,MACX,cAAc;AAAA,MACd,WAAW,eAAe,IAAI,MAAM,eAAe,MAAO;AAAA,IAC5D;AAEA,SAAK,MAAM,IAAI,KAAK,IAAI;AAGxB,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,KAA4B;AACvC,SAAK,MAAM,OAAO,GAAG;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA+B;AACvC,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAE/B,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAGA,QAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,WAAK,MAAM,OAAO,GAAG;AACrB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,OAAO,KAAK,MAAM,IAAI,GAAG;AAC/B,UAAM,MAAM,KAAK,IAAI;AAErB,QAAI,eAAe;AAGnB,QAAI,MAAM;AACR,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,aAAK,MAAM,OAAO,GAAG;AAAA,MACvB,OAAO;AAEL,uBAAe,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ;AAAA,MAC/D;AAAA,IACF;AAGA,UAAM,WAAW,eAAe;AAGhC,UAAM,UAAqB;AAAA,MACzB,OAAO;AAAA,MACP,WAAW,MAAM,aAAa;AAAA,MAC9B,cAAc;AAAA,MACd,WAAW,MAAM;AAAA,IACnB;AAEA,SAAK,MAAM,IAAI,KAAK,OAAO;AAE3B,WAAO;AAAA,EACT;AACF;","names":[]}

package/dist/providers/RedisCacheProvider.d.mts

@@ -2,18 +2,60 @@ import { RedisClientOptions } from 'redis';
 import { CacheProviderInterface } from '../CacheProviderInterface.mjs';
 import { JSONValue, JSONObject } from '@devbro/neko-helper';
 
+type RedisCacheProviderConfig = RedisClientOptions;
+/**
+ * Redis-based cache provider that stores cache entries in a Redis server.
+ * Provides distributed caching with automatic expiration support.
+ */
 declare class RedisCacheProvider implements CacheProviderInterface {
     private config;
     private client;
     private defaultTTL;
-    constructor(config: RedisClientOptions);
+    /**
+     * Creates a new RedisCacheProvider instance.
+     * @param config - Redis client configuration options
+     */
+    constructor(config: RedisCacheProviderConfig);
+    /**
+     * Creates a Redis client with the provided configuration.
+     * @returns A Redis client instance
+     */
     private createRedisClient;
+    /**
+     * Ensures the Redis client is connected before performing operations.
+     */
     private ensureConnection;
+    /**
+     * Retrieves a value from the cache.
+     * @param key - The cache key
+     * @returns The cached value or undefined if not found
+     */
     get(key: string): Promise<JSONValue | JSONObject | undefined>;
+    /**
+     * Stores a value in the cache.
+     * @param key - The cache key
+     * @param value - The value to cache
+     * @param ttl - Time to live in seconds (optional)
+     */
     put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void>;
+    /**
+     * Deletes a value from the cache.
+     * @param key - The cache key to delete
+     */
     delete(key: string): Promise<void>;
+    /**
+     * Checks if a key exists in the cache.
+     * @param key - The cache key to check
+     * @returns True if the key exists, false otherwise
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * Increments a numeric value in the cache atomically using Redis INCRBY.
+     * @param key - The cache key to increment
+     * @param amount - The amount to increment by (default: 1)
+     * @returns The new value after incrementing
+     */
     increment(key: string, amount?: number): Promise<number>;
 }
 
-export { RedisCacheProvider };
+export { RedisCacheProvider, type RedisCacheProviderConfig };

package/dist/providers/RedisCacheProvider.mjs

@@ -3,6 +3,10 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 import { createClient } from "redis";
 class RedisCacheProvider {
   // default TTL in seconds
+  /**
+   * Creates a new RedisCacheProvider instance.
+   * @param config - Redis client configuration options
+   */
   constructor(config) {
     this.config = config;
     this.client = this.createRedisClient();
@@ -13,15 +17,27 @@ class RedisCacheProvider {
   }
   client;
   defaultTTL = 3600;
+  /**
+   * Creates a Redis client with the provided configuration.
+   * @returns A Redis client instance
+   */
   createRedisClient() {
     let rc = createClient(this.config);
     return rc;
   }
+  /**
+   * Ensures the Redis client is connected before performing operations.
+   */
   async ensureConnection() {
     if (!this.client.isOpen) {
       await this.client.connect();
     }
   }
+  /**
+   * Retrieves a value from the cache.
+   * @param key - The cache key
+   * @returns The cached value or undefined if not found
+   */
   async get(key) {
     await this.ensureConnection();
     let rc = this.client.get(key);
@@ -32,6 +48,12 @@ class RedisCacheProvider {
       return JSON.parse(value);
     });
   }
+  /**
+   * Stores a value in the cache.
+   * @param key - The cache key
+   * @param value - The value to cache
+   * @param ttl - Time to live in seconds (optional)
+   */
   async put(key, value, ttl) {
     await this.ensureConnection();
     const serializedValue = JSON.stringify(value);
@@ -42,15 +64,30 @@ class RedisCacheProvider {
       await this.client.set(key, serializedValue);
     }
   }
+  /**
+   * Deletes a value from the cache.
+   * @param key - The cache key to delete
+   */
   async delete(key) {
     await this.ensureConnection();
     await this.client.del(key);
   }
+  /**
+   * Checks if a key exists in the cache.
+   * @param key - The cache key to check
+   * @returns True if the key exists, false otherwise
+   */
   async has(key) {
     await this.ensureConnection();
     const result = await this.client.exists(key);
     return result === 1;
   }
+  /**
+   * Increments a numeric value in the cache atomically using Redis INCRBY.
+   * @param key - The cache key to increment
+   * @param amount - The amount to increment by (default: 1)
+   * @returns The new value after incrementing
+   */
   async increment(key, amount = 1) {
     await this.ensureConnection();
     return await this.client.incrBy(key, amount);

package/dist/providers/RedisCacheProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/providers/RedisCacheProvider.mts"],"sourcesContent":["import { createClient, RedisClientOptions, RedisClientType } from 'redis';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\n\nexport class RedisCacheProvider implements CacheProviderInterface {\n  private client: RedisClientType;\n  private defaultTTL: number = 3600; // default TTL in seconds\n\n  constructor(private config: RedisClientOptions) {\n    this.client = this.createRedisClient();\n    this.client.connect();\n  }\n\n  private createRedisClient(): any {\n    let rc = createClient(this.config);\n    return rc;\n  }\n\n  private async ensureConnection(): Promise<void> {\n    if (!this.client.isOpen) {\n      await this.client.connect();\n    }\n  }\n\n  async get(key: string): Promise<JSONValue | JSONObject | undefined> {\n    await this.ensureConnection();\n    let rc = this.client.get(key);\n    return rc.then((value) => {\n      if (value === null || value === undefined) {\n        return undefined;\n      }\n      return JSON.parse(value);\n    });\n  }\n\n  async put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void> {\n    await this.ensureConnection();\n    const serializedValue = JSON.stringify(value);\n    ttl = ttl ?? this.defaultTTL;\n    if (ttl && ttl > 0) {\n      await this.client.setEx(key, ttl, serializedValue);\n    } else {\n      await this.client.set(key, serializedValue);\n    }\n  }\n\n  async delete(key: string): Promise<void> {\n    await this.ensureConnection();\n    await this.client.del(key);\n  }\n\n  async has(key: string): Promise<boolean> {\n    await this.ensureConnection();\n    const result = await this.client.exists(key);\n    return result === 1;\n  }\n\n  async increment(key: string, amount: number = 1): Promise<number> {\n    await this.ensureConnection();\n    // Redis INCRBY is atomic\n    return await this.client.incrBy(key, amount);\n  }\n}\n"],"mappings":";;AAAA,SAAS,oBAAyD;AAI3D,MAAM,mBAAqD;AAAA;AAAA,EAIhE,YAAoB,QAA4B;AAA5B;AAClB,SAAK,SAAS,KAAK,kBAAkB;AACrC,SAAK,OAAO,QAAQ;AAAA,EACtB;AAAA,EAXF,OAIkE;AAAA;AAAA;AAAA,EACxD;AAAA,EACA,aAAqB;AAAA,EAOrB,oBAAyB;AAC/B,QAAI,KAAK,aAAa,KAAK,MAAM;AACjC,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,mBAAkC;AAC9C,QAAI,CAAC,KAAK,OAAO,QAAQ;AACvB,YAAM,KAAK,OAAO,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,KAA0D;AAClE,UAAM,KAAK,iBAAiB;AAC5B,QAAI,KAAK,KAAK,OAAO,IAAI,GAAG;AAC5B,WAAO,GAAG,KAAK,CAAC,UAAU;AACxB,UAAI,UAAU,QAAQ,UAAU,QAAW;AACzC,eAAO;AAAA,MACT;AACA,aAAO,KAAK,MAAM,KAAK;AAAA,IACzB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,KAAK,iBAAiB;AAC5B,UAAM,kBAAkB,KAAK,UAAU,KAAK;AAC5C,UAAM,OAAO,KAAK;AAClB,QAAI,OAAO,MAAM,GAAG;AAClB,YAAM,KAAK,OAAO,MAAM,KAAK,KAAK,eAAe;AAAA,IACnD,OAAO;AACL,YAAM,KAAK,OAAO,IAAI,KAAK,eAAe;AAAA,IAC5C;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,KAA4B;AACvC,UAAM,KAAK,iBAAiB;AAC5B,UAAM,KAAK,OAAO,IAAI,GAAG;AAAA,EAC3B;AAAA,EAEA,MAAM,IAAI,KAA+B;AACvC,UAAM,KAAK,iBAAiB;AAC5B,UAAM,SAAS,MAAM,KAAK,OAAO,OAAO,GAAG;AAC3C,WAAO,WAAW;AAAA,EACpB;AAAA,EAEA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,KAAK,iBAAiB;AAE5B,WAAO,MAAM,KAAK,OAAO,OAAO,KAAK,MAAM;AAAA,EAC7C;AACF;","names":[]}
+{"version":3,"sources":["../../src/providers/RedisCacheProvider.mts"],"sourcesContent":["import { createClient, RedisClientOptions, RedisClientType } from 'redis';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\n\nexport type RedisCacheProviderConfig = RedisClientOptions;\n/**\n * Redis-based cache provider that stores cache entries in a Redis server.\n * Provides distributed caching with automatic expiration support.\n */\nexport class RedisCacheProvider implements CacheProviderInterface {\n  private client: RedisClientType;\n  private defaultTTL: number = 3600; // default TTL in seconds\n\n  /**\n   * Creates a new RedisCacheProvider instance.\n   * @param config - Redis client configuration options\n   */\n  constructor(private config: RedisCacheProviderConfig) {\n    this.client = this.createRedisClient();\n    this.client.connect();\n  }\n\n  /**\n   * Creates a Redis client with the provided configuration.\n   * @returns A Redis client instance\n   */\n  private createRedisClient(): any {\n    let rc = createClient(this.config);\n    return rc;\n  }\n\n  /**\n   * Ensures the Redis client is connected before performing operations.\n   */\n  private async ensureConnection(): Promise<void> {\n    if (!this.client.isOpen) {\n      await this.client.connect();\n    }\n  }\n\n  /**\n   * Retrieves a value from the cache.\n   * @param key - The cache key\n   * @returns The cached value or undefined if not found\n   */\n  async get(key: string): Promise<JSONValue | JSONObject | undefined> {\n    await this.ensureConnection();\n    let rc = this.client.get(key);\n    return rc.then((value) => {\n      if (value === null || value === undefined) {\n        return undefined;\n      }\n      return JSON.parse(value);\n    });\n  }\n\n  /**\n   * Stores a value in the cache.\n   * @param key - The cache key\n   * @param value - The value to cache\n   * @param ttl - Time to live in seconds (optional)\n   */\n  async put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void> {\n    await this.ensureConnection();\n    const serializedValue = JSON.stringify(value);\n    ttl = ttl ?? this.defaultTTL;\n    if (ttl && ttl > 0) {\n      await this.client.setEx(key, ttl, serializedValue);\n    } else {\n      await this.client.set(key, serializedValue);\n    }\n  }\n\n  /**\n   * Deletes a value from the cache.\n   * @param key - The cache key to delete\n   */\n  async delete(key: string): Promise<void> {\n    await this.ensureConnection();\n    await this.client.del(key);\n  }\n\n  /**\n   * Checks if a key exists in the cache.\n   * @param key - The cache key to check\n   * @returns True if the key exists, false otherwise\n   */\n  async has(key: string): Promise<boolean> {\n    await this.ensureConnection();\n    const result = await this.client.exists(key);\n    return result === 1;\n  }\n\n  /**\n   * Increments a numeric value in the cache atomically using Redis INCRBY.\n   * @param key - The cache key to increment\n   * @param amount - The amount to increment by (default: 1)\n   * @returns The new value after incrementing\n   */\n  async increment(key: string, amount: number = 1): Promise<number> {\n    await this.ensureConnection();\n    // Redis INCRBY is atomic\n    return await this.client.incrBy(key, amount);\n  }\n}\n"],"mappings":";;AAAA,SAAS,oBAAyD;AAS3D,MAAM,mBAAqD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhE,YAAoB,QAAkC;AAAlC;AAClB,SAAK,SAAS,KAAK,kBAAkB;AACrC,SAAK,OAAO,QAAQ;AAAA,EACtB;AAAA,EApBF,OASkE;AAAA;AAAA;AAAA,EACxD;AAAA,EACA,aAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAerB,oBAAyB;AAC/B,QAAI,KAAK,aAAa,KAAK,MAAM;AACjC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,mBAAkC;AAC9C,QAAI,CAAC,KAAK,OAAO,QAAQ;AACvB,YAAM,KAAK,OAAO,QAAQ;AAAA,IAC5B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA0D;AAClE,UAAM,KAAK,iBAAiB;AAC5B,QAAI,KAAK,KAAK,OAAO,IAAI,GAAG;AAC5B,WAAO,GAAG,KAAK,CAAC,UAAU;AACxB,UAAI,UAAU,QAAQ,UAAU,QAAW;AACzC,eAAO;AAAA,MACT;AACA,aAAO,KAAK,MAAM,KAAK;AAAA,IACzB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,KAAK,iBAAiB;AAC5B,UAAM,kBAAkB,KAAK,UAAU,KAAK;AAC5C,UAAM,OAAO,KAAK;AAClB,QAAI,OAAO,MAAM,GAAG;AAClB,YAAM,KAAK,OAAO,MAAM,KAAK,KAAK,eAAe;AAAA,IACnD,OAAO;AACL,YAAM,KAAK,OAAO,IAAI,KAAK,eAAe;AAAA,IAC5C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,KAA4B;AACvC,UAAM,KAAK,iBAAiB;AAC5B,UAAM,KAAK,OAAO,IAAI,GAAG;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA+B;AACvC,UAAM,KAAK,iBAAiB;AAC5B,UAAM,SAAS,MAAM,KAAK,OAAO,OAAO,GAAG;AAC3C,WAAO,WAAW;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,KAAK,iBAAiB;AAE5B,WAAO,MAAM,KAAK,OAAO,OAAO,KAAK,MAAM;AAAA,EAC7C;AACF;","names":[]}

package/dist/providers/index.d.mts

@@ -1,4 +1,4 @@
-export { RedisCacheProvider } from './RedisCacheProvider.mjs';
+export { RedisCacheProvider, RedisCacheProviderConfig } from './RedisCacheProvider.mjs';
 export { FileCacheConfig, FileCacheProvider } from './FileCacheProvider.mjs';
 export { MemoryCacheConfig, MemoryCacheProvider } from './MemoryCacheProvider.mjs';
 export { MemcacheCacheProvider, MemcachedConfig } from './MemcacheCacheProvider.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devbro/neko-cache",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "driver agnostic caching implementation",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -36,7 +36,7 @@
     "husky": "^9.1.7",
     "prettier": "^3.5.3",
     "tsup": "^8.0.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },
   "dependencies": {