@devbro/neko-cache 0.1.4 → 0.1.6

package/dist/providers/DisabledCacheProvider.d.mts

@@ -1,13 +1,47 @@
 import { CacheProviderInterface } from '../CacheProviderInterface.mjs';
 import { JSONValue, JSONObject } from '@devbro/neko-helper';
 
+/**
+ * A cache provider that disables caching entirely.
+ * All operations are no-ops, useful for testing or disabling cache in certain environments.
+ */
 declare class DisabledCacheProvider implements CacheProviderInterface {
     private config;
+    /**
+     * Creates a new DisabledCacheProvider instance.
+     * @param config - Configuration object (currently unused)
+     */
     constructor(config?: {});
+    /**
+     * Always returns undefined (no caching).
+     * @param key - The cache key
+     * @returns Always undefined
+     */
     get(key: string): Promise<JSONValue | JSONObject | undefined>;
+    /**
+     * Does nothing (no caching).
+     * @param key - The cache key
+     * @param value - The value to cache
+     * @param ttl - Time to live in seconds
+     */
     put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void>;
+    /**
+     * Does nothing (no caching).
+     * @param key - The cache key to delete
+     */
     delete(key: string): Promise<void>;
+    /**
+     * Always returns false (no caching).
+     * @param key - The cache key to check
+     * @returns Always false
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * Returns the increment amount as if starting from 0 (no caching).
+     * @param key - The cache key to increment
+     * @param amount - The amount to increment by (default: 1)
+     * @returns The increment amount
+     */
     increment(key: string, amount?: number): Promise<number>;
 }
 

package/dist/providers/DisabledCacheProvider.mjs

@@ -1,22 +1,52 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 class DisabledCacheProvider {
+  /**
+   * Creates a new DisabledCacheProvider instance.
+   * @param config - Configuration object (currently unused)
+   */
   constructor(config = {}) {
     this.config = config;
   }
   static {
     __name(this, "DisabledCacheProvider");
   }
+  /**
+   * Always returns undefined (no caching).
+   * @param key - The cache key
+   * @returns Always undefined
+   */
   async get(key) {
     return void 0;
   }
+  /**
+   * Does nothing (no caching).
+   * @param key - The cache key
+   * @param value - The value to cache
+   * @param ttl - Time to live in seconds
+   */
   async put(key, value, ttl) {
   }
+  /**
+   * Does nothing (no caching).
+   * @param key - The cache key to delete
+   */
   async delete(key) {
   }
+  /**
+   * Always returns false (no caching).
+   * @param key - The cache key to check
+   * @returns Always false
+   */
   async has(key) {
     return false;
   }
+  /**
+   * Returns the increment amount as if starting from 0 (no caching).
+   * @param key - The cache key to increment
+   * @param amount - The amount to increment by (default: 1)
+   * @returns The increment amount
+   */
   async increment(key, amount = 1) {
     return amount;
   }

package/dist/providers/DisabledCacheProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/providers/DisabledCacheProvider.mts"],"sourcesContent":["import { createClient, RedisClientOptions, RedisClientType } from 'redis';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\n\nexport class DisabledCacheProvider implements CacheProviderInterface {\n  constructor(private config = {}) {}\n\n  async get(key: string): Promise<JSONValue | JSONObject | undefined> {\n    return undefined;\n  }\n\n  async put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void> {}\n\n  async delete(key: string): Promise<void> {}\n\n  async has(key: string): Promise<boolean> {\n    return false;\n  }\n\n  async increment(key: string, amount: number = 1): Promise<number> {\n    // Disabled cache always returns the increment amount as if starting from 0\n    return amount;\n  }\n}\n"],"mappings":";;AAIO,MAAM,sBAAwD;AAAA,EACnE,YAAoB,SAAS,CAAC,GAAG;AAAb;AAAA,EAAc;AAAA,EALpC,OAIqE;AAAA;AAAA;AAAA,EAGnE,MAAM,IAAI,KAA0D;AAClE,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AAAA,EAAC;AAAA,EAEpF,MAAM,OAAO,KAA4B;AAAA,EAAC;AAAA,EAE1C,MAAM,IAAI,KAA+B;AACvC,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAEhE,WAAO;AAAA,EACT;AACF;","names":[]}
+{"version":3,"sources":["../../src/providers/DisabledCacheProvider.mts"],"sourcesContent":["import { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\n\n/**\n * A cache provider that disables caching entirely.\n * All operations are no-ops, useful for testing or disabling cache in certain environments.\n */\nexport class DisabledCacheProvider implements CacheProviderInterface {\n  /**\n   * Creates a new DisabledCacheProvider instance.\n   * @param config - Configuration object (currently unused)\n   */\n  constructor(private config = {}) {}\n\n  /**\n   * Always returns undefined (no caching).\n   * @param key - The cache key\n   * @returns Always undefined\n   */\n  async get(key: string): Promise<JSONValue | JSONObject | undefined> {\n    return undefined;\n  }\n\n  /**\n   * Does nothing (no caching).\n   * @param key - The cache key\n   * @param value - The value to cache\n   * @param ttl - Time to live in seconds\n   */\n  async put(key: string, value: JSONValue | JSONObject, ttl?: number): Promise<void> {}\n\n  /**\n   * Does nothing (no caching).\n   * @param key - The cache key to delete\n   */\n  async delete(key: string): Promise<void> {}\n\n  /**\n   * Always returns false (no caching).\n   * @param key - The cache key to check\n   * @returns Always false\n   */\n  async has(key: string): Promise<boolean> {\n    return false;\n  }\n\n  /**\n   * Returns the increment amount as if starting from 0 (no caching).\n   * @param key - The cache key to increment\n   * @param amount - The amount to increment by (default: 1)\n   * @returns The increment amount\n   */\n  async increment(key: string, amount: number = 1): Promise<number> {\n    // Disabled cache always returns the increment amount as if starting from 0\n    return amount;\n  }\n}\n"],"mappings":";;AAOO,MAAM,sBAAwD;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnE,YAAoB,SAAS,CAAC,GAAG;AAAb;AAAA,EAAc;AAAA,EAZpC,OAOqE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYnE,MAAM,IAAI,KAA0D;AAClE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMpF,MAAM,OAAO,KAA4B;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,MAAM,IAAI,KAA+B;AACvC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAEhE,WAAO;AAAA,EACT;AACF;","names":[]}

package/dist/providers/FileCacheProvider.d.mts

@@ -1,24 +1,83 @@
 import { CacheProviderInterface } from '../CacheProviderInterface.mjs';
 import { JSONObject, JSONValue } from '@devbro/neko-helper';
 
-interface FileCacheConfig {
+/**
+ * Configuration options for the file-based cache provider.
+ */
+type FileCacheConfig = {
+    /** Directory where cache files are stored (default: './cache') */
     cacheDirectory?: string;
+    /** Default time to live in milliseconds (default: 3600000) */
     defaultTTL?: number;
+    /** Interval in milliseconds for cleanup of expired entries (default: 300000) */
     cleanupInterval?: number;
-}
+};
+/**
+ * File-based cache provider that stores cache entries as JSON files.
+ * Provides persistent caching with automatic cleanup of expired entries.
+ */
 declare class FileCacheProvider implements CacheProviderInterface {
     private config;
     private cleanupTimer?;
+    /**
+     * Creates a new FileCacheProvider instance.
+     * @param config - Configuration options for the cache
+     */
     constructor(config?: FileCacheConfig);
+    /**
+     * Ensures the cache directory exists, creating it if necessary.
+     */
     private ensureCacheDirectory;
+    /**
+     * Starts the automatic cleanup timer for expired entries.
+     */
     private startCleanupTimer;
+    /**
+     * Stops the automatic cleanup timer.
+     */
     private stopCleanupTimer;
+    /**
+     * Generates a safe file path for the given cache key.
+     * @param key - The cache key
+     * @returns The full file path for the cache entry
+     */
     private getFilePath;
+    /**
+     * Removes all expired cache entries from the cache directory.
+     */
     private cleanupExpiredEntries;
+    /**
+     * Retrieves a value from the cache.
+     * @param key - The cache key
+     * @returns The cached value or undefined if not found or expired
+     */
     get(key: string): Promise<JSONObject | JSONValue | 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: JSONObject | JSONValue, 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 and has not expired.
+     * @param key - The cache key to check
+     * @returns True if the key exists and is not expired, false otherwise
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * Increments a numeric value in the cache atomically using file-based locking.
+     * 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
+     * @throws Error if lock cannot be acquired after maximum retries
+     */
     increment(key: string, amount?: number): Promise<number>;
 }
 

package/dist/providers/FileCacheProvider.mjs

@@ -12,11 +12,18 @@ class FileCacheProvider {
     cleanupInterval: 300 * 1e3
   };
   cleanupTimer;
+  /**
+   * Creates a new FileCacheProvider instance.
+   * @param config - Configuration options for the cache
+   */
   constructor(config = {}) {
     this.config = { ...this.config, ...config };
     this.ensureCacheDirectory();
     this.startCleanupTimer();
   }
+  /**
+   * Ensures the cache directory exists, creating it if necessary.
+   */
   async ensureCacheDirectory() {
     try {
       await fs.access(this.config.cacheDirectory);
@@ -24,6 +31,9 @@ class FileCacheProvider {
       await fs.mkdir(this.config.cacheDirectory, { recursive: true });
     }
   }
+  /**
+   * Starts the automatic cleanup timer for expired entries.
+   */
   startCleanupTimer() {
     if (this.config.cleanupInterval > 0) {
       this.cleanupTimer = setInterval(() => {
@@ -31,16 +41,27 @@ class FileCacheProvider {
       }, this.config.cleanupInterval);
     }
   }
+  /**
+   * Stops the automatic cleanup timer.
+   */
   stopCleanupTimer() {
     if (this.cleanupTimer) {
       clearInterval(this.cleanupTimer);
       this.cleanupTimer = void 0;
     }
   }
+  /**
+   * Generates a safe file path for the given cache key.
+   * @param key - The cache key
+   * @returns The full file path for the cache entry
+   */
   getFilePath(key) {
     const safeKey = key.replace(/[^a-z0-9]/gi, "_");
     return path.join(this.config.cacheDirectory, `${safeKey}.json`);
   }
+  /**
+   * Removes all expired cache entries from the cache directory.
+   */
   async cleanupExpiredEntries() {
     try {
       const files = await fs.readdir(this.config.cacheDirectory);
@@ -63,6 +84,11 @@ class FileCacheProvider {
     } catch (error) {
     }
   }
+  /**
+   * 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 filePath = this.getFilePath(key);
     try {
@@ -78,6 +104,12 @@ class FileCacheProvider {
       return void 0;
     }
   }
+  /**
+   * 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 filePath = this.getFilePath(key);
     const now = Date.now();
@@ -90,6 +122,10 @@ class FileCacheProvider {
     this.ensureCacheDirectory();
     await fs.writeFile(filePath, JSON.stringify(item), "utf-8");
   }
+  /**
+   * Deletes a value from the cache.
+   * @param key - The cache key to delete
+   */
   async delete(key) {
     const filePath = this.getFilePath(key);
     try {
@@ -97,10 +133,23 @@ class FileCacheProvider {
     } catch {
     }
   }
+  /**
+   * 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 value = await this.get(key);
     return value !== void 0;
   }
+  /**
+   * Increments a numeric value in the cache atomically using file-based locking.
+   * 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
+   * @throws Error if lock cannot be acquired after maximum retries
+   */
   async increment(key, amount = 1) {
     const filePath = this.getFilePath(key);
     const lockPath = `${filePath}.lock`;

package/dist/providers/FileCacheProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/providers/FileCacheProvider.mts"],"sourcesContent":["import * as fs from 'fs/promises';\nimport * as path from 'path';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONObject, JSONValue } from '@devbro/neko-helper';\n\nexport interface FileCacheConfig {\n  cacheDirectory?: string;\n  defaultTTL?: number;\n  cleanupInterval?: number;\n}\n\ninterface CacheItem {\n  value: any;\n  expiresAt?: number;\n  createdAt: number;\n}\n\nexport class FileCacheProvider implements CacheProviderInterface {\n  private config: FileCacheConfig = {\n    cacheDirectory: path.join(process.cwd(), 'cache'),\n    defaultTTL: 3600 * 1000,\n    cleanupInterval: 300 * 1000,\n  };\n\n  private cleanupTimer?: NodeJS.Timeout;\n\n  constructor(config: FileCacheConfig = {}) {\n    this.config = { ...this.config, ...config };\n\n    this.ensureCacheDirectory();\n    this.startCleanupTimer();\n  }\n\n  private async ensureCacheDirectory(): Promise<void> {\n    try {\n      await fs.access(this.config.cacheDirectory!);\n    } catch {\n      await fs.mkdir(this.config.cacheDirectory!, { recursive: true });\n    }\n  }\n\n  private startCleanupTimer(): void {\n    if (this.config.cleanupInterval! > 0) {\n      this.cleanupTimer = setInterval(() => {\n        this.cleanupExpiredEntries().catch(console.error);\n      }, this.config.cleanupInterval!);\n    }\n  }\n\n  private stopCleanupTimer(): void {\n    if (this.cleanupTimer) {\n      clearInterval(this.cleanupTimer);\n      this.cleanupTimer = undefined;\n    }\n  }\n\n  private getFilePath(key: string): string {\n    // Create a safe filename from the key\n    const safeKey = key.replace(/[^a-z0-9]/gi, '_');\n    return path.join(this.config.cacheDirectory!, `${safeKey}.json`);\n  }\n\n  private async cleanupExpiredEntries(): Promise<void> {\n    try {\n      const files = await fs.readdir(this.config.cacheDirectory!);\n      const now = Date.now();\n\n      for (const file of files) {\n        if (file.endsWith('.json')) {\n          const filePath = path.join(this.config.cacheDirectory!, file);\n          try {\n            const content = await fs.readFile(filePath, 'utf-8');\n            const item: CacheItem = JSON.parse(content);\n\n            if (item.expiresAt && item.expiresAt < now) {\n              await fs.unlink(filePath);\n            }\n          } catch {\n            // If file is corrupted, delete it\n            await fs.unlink(filePath).catch(() => {});\n          }\n        }\n      }\n    } catch (error) {\n      // Ignore cleanup errors\n    }\n  }\n\n  async get(key: string): Promise<JSONObject | JSONValue | undefined> {\n    const filePath = this.getFilePath(key);\n\n    try {\n      const content = await fs.readFile(filePath, 'utf-8');\n      const item: CacheItem = JSON.parse(content);\n\n      // Check if item has expired\n      if (item.expiresAt && item.expiresAt < Date.now()) {\n        await fs.unlink(filePath).catch(() => {});\n        return undefined;\n      }\n\n      return item.value;\n    } catch (error) {\n      return undefined;\n    }\n  }\n\n  async put(key: string, value: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    const filePath = this.getFilePath(key);\n    const now = Date.now();\n    const effectiveTTL = ttl ?? this.config.defaultTTL!;\n\n    const item: CacheItem = {\n      value,\n      createdAt: now,\n      expiresAt: effectiveTTL > 0 ? now + effectiveTTL * 1000 : undefined,\n    };\n\n    this.ensureCacheDirectory();\n    await fs.writeFile(filePath, JSON.stringify(item), 'utf-8');\n  }\n\n  async delete(key: string): Promise<void> {\n    const filePath = this.getFilePath(key);\n\n    try {\n      await fs.unlink(filePath);\n    } catch {\n      // File doesn't exist, that's fine\n    }\n  }\n\n  async has(key: string): Promise<boolean> {\n    const value = await this.get(key);\n    return value !== undefined;\n  }\n\n  async increment(key: string, amount: number = 1): Promise<number> {\n    const filePath = this.getFilePath(key);\n\n    // Use a lock file to ensure atomicity\n    const lockPath = `${filePath}.lock`;\n\n    // Simple file-based locking mechanism\n    let lockAcquired = false;\n    let retries = 0;\n    const maxRetries = 50;\n\n    while (!lockAcquired && retries < maxRetries) {\n      try {\n        // Try to create lock file exclusively\n        await fs.writeFile(lockPath, '', { flag: 'wx' });\n        lockAcquired = true;\n      } catch {\n        // Lock exists, wait a bit and retry\n        await new Promise((resolve) => setTimeout(resolve, 10));\n        retries++;\n      }\n    }\n\n    if (!lockAcquired) {\n      throw new Error('Failed to acquire lock for increment operation');\n    }\n\n    try {\n      let currentValue = 0;\n      let item: CacheItem | undefined;\n\n      // Read current value\n      try {\n        const content = await fs.readFile(filePath, 'utf-8');\n        const parsedItem = JSON.parse(content);\n\n        // Check if item has expired\n        if (parsedItem.expiresAt && parsedItem.expiresAt < Date.now()) {\n          item = undefined;\n        } else {\n          item = parsedItem;\n          currentValue = typeof parsedItem.value === 'number' ? parsedItem.value : 0;\n        }\n      } catch {\n        // File doesn't exist or is corrupted, start from 0\n      }\n\n      // Calculate new value\n      const newValue = currentValue + amount;\n\n      // Write back with same TTL if it existed\n      const now = Date.now();\n      const newItem: CacheItem = {\n        value: newValue,\n        createdAt: item?.createdAt ?? now,\n        expiresAt: item?.expiresAt,\n      };\n\n      await fs.writeFile(filePath, JSON.stringify(newItem), 'utf-8');\n\n      return newValue;\n    } finally {\n      // Release lock\n      try {\n        await fs.unlink(lockPath);\n      } catch {\n        // Ignore errors when removing lock file\n      }\n    }\n  }\n}\n"],"mappings":";;AAAA,YAAY,QAAQ;AACpB,YAAY,UAAU;AAgBf,MAAM,kBAAoD;AAAA,EAjBjE,OAiBiE;AAAA;AAAA;AAAA,EACvD,SAA0B;AAAA,IAChC,gBAAgB,KAAK,KAAK,QAAQ,IAAI,GAAG,OAAO;AAAA,IAChD,YAAY,OAAO;AAAA,IACnB,iBAAiB,MAAM;AAAA,EACzB;AAAA,EAEQ;AAAA,EAER,YAAY,SAA0B,CAAC,GAAG;AACxC,SAAK,SAAS,EAAE,GAAG,KAAK,QAAQ,GAAG,OAAO;AAE1C,SAAK,qBAAqB;AAC1B,SAAK,kBAAkB;AAAA,EACzB;AAAA,EAEA,MAAc,uBAAsC;AAClD,QAAI;AACF,YAAM,GAAG,OAAO,KAAK,OAAO,cAAe;AAAA,IAC7C,QAAQ;AACN,YAAM,GAAG,MAAM,KAAK,OAAO,gBAAiB,EAAE,WAAW,KAAK,CAAC;AAAA,IACjE;AAAA,EACF;AAAA,EAEQ,oBAA0B;AAChC,QAAI,KAAK,OAAO,kBAAmB,GAAG;AACpC,WAAK,eAAe,YAAY,MAAM;AACpC,aAAK,sBAAsB,EAAE,MAAM,QAAQ,KAAK;AAAA,MAClD,GAAG,KAAK,OAAO,eAAgB;AAAA,IACjC;AAAA,EACF;AAAA,EAEQ,mBAAyB;AAC/B,QAAI,KAAK,cAAc;AACrB,oBAAc,KAAK,YAAY;AAC/B,WAAK,eAAe;AAAA,IACtB;AAAA,EACF;AAAA,EAEQ,YAAY,KAAqB;AAEvC,UAAM,UAAU,IAAI,QAAQ,eAAe,GAAG;AAC9C,WAAO,KAAK,KAAK,KAAK,OAAO,gBAAiB,GAAG,OAAO,OAAO;AAAA,EACjE;AAAA,EAEA,MAAc,wBAAuC;AACnD,QAAI;AACF,YAAM,QAAQ,MAAM,GAAG,QAAQ,KAAK,OAAO,cAAe;AAC1D,YAAM,MAAM,KAAK,IAAI;AAErB,iBAAW,QAAQ,OAAO;AACxB,YAAI,KAAK,SAAS,OAAO,GAAG;AAC1B,gBAAM,WAAW,KAAK,KAAK,KAAK,OAAO,gBAAiB,IAAI;AAC5D,cAAI;AACF,kBAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,kBAAM,OAAkB,KAAK,MAAM,OAAO;AAE1C,gBAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,oBAAM,GAAG,OAAO,QAAQ;AAAA,YAC1B;AAAA,UACF,QAAQ;AAEN,kBAAM,GAAG,OAAO,QAAQ,EAAE,MAAM,MAAM;AAAA,YAAC,CAAC;AAAA,UAC1C;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AAAA,IAEhB;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,KAA0D;AAClE,UAAM,WAAW,KAAK,YAAY,GAAG;AAErC,QAAI;AACF,YAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,YAAM,OAAkB,KAAK,MAAM,OAAO;AAG1C,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,cAAM,GAAG,OAAO,QAAQ,EAAE,MAAM,MAAM;AAAA,QAAC,CAAC;AACxC,eAAO;AAAA,MACT;AAEA,aAAO,KAAK;AAAA,IACd,SAAS,OAAO;AACd,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,WAAW,KAAK,YAAY,GAAG;AACrC,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,eAAe,OAAO,KAAK,OAAO;AAExC,UAAM,OAAkB;AAAA,MACtB;AAAA,MACA,WAAW;AAAA,MACX,WAAW,eAAe,IAAI,MAAM,eAAe,MAAO;AAAA,IAC5D;AAEA,SAAK,qBAAqB;AAC1B,UAAM,GAAG,UAAU,UAAU,KAAK,UAAU,IAAI,GAAG,OAAO;AAAA,EAC5D;AAAA,EAEA,MAAM,OAAO,KAA4B;AACvC,UAAM,WAAW,KAAK,YAAY,GAAG;AAErC,QAAI;AACF,YAAM,GAAG,OAAO,QAAQ;AAAA,IAC1B,QAAQ;AAAA,IAER;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,KAA+B;AACvC,UAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;AAChC,WAAO,UAAU;AAAA,EACnB;AAAA,EAEA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,WAAW,KAAK,YAAY,GAAG;AAGrC,UAAM,WAAW,GAAG,QAAQ;AAG5B,QAAI,eAAe;AACnB,QAAI,UAAU;AACd,UAAM,aAAa;AAEnB,WAAO,CAAC,gBAAgB,UAAU,YAAY;AAC5C,UAAI;AAEF,cAAM,GAAG,UAAU,UAAU,IAAI,EAAE,MAAM,KAAK,CAAC;AAC/C,uBAAe;AAAA,MACjB,QAAQ;AAEN,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,EAAE,CAAC;AACtD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAEA,QAAI;AACF,UAAI,eAAe;AACnB,UAAI;AAGJ,UAAI;AACF,cAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,cAAM,aAAa,KAAK,MAAM,OAAO;AAGrC,YAAI,WAAW,aAAa,WAAW,YAAY,KAAK,IAAI,GAAG;AAC7D,iBAAO;AAAA,QACT,OAAO;AACL,iBAAO;AACP,yBAAe,OAAO,WAAW,UAAU,WAAW,WAAW,QAAQ;AAAA,QAC3E;AAAA,MACF,QAAQ;AAAA,MAER;AAGA,YAAM,WAAW,eAAe;AAGhC,YAAM,MAAM,KAAK,IAAI;AACrB,YAAM,UAAqB;AAAA,QACzB,OAAO;AAAA,QACP,WAAW,MAAM,aAAa;AAAA,QAC9B,WAAW,MAAM;AAAA,MACnB;AAEA,YAAM,GAAG,UAAU,UAAU,KAAK,UAAU,OAAO,GAAG,OAAO;AAE7D,aAAO;AAAA,IACT,UAAE;AAEA,UAAI;AACF,cAAM,GAAG,OAAO,QAAQ;AAAA,MAC1B,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/providers/FileCacheProvider.mts"],"sourcesContent":["import * as fs from 'fs/promises';\nimport * as path from 'path';\nimport { CacheProviderInterface } from '../CacheProviderInterface.mjs';\nimport { JSONObject, JSONValue } from '@devbro/neko-helper';\n\n/**\n * Configuration options for the file-based cache provider.\n */\nexport type FileCacheConfig = {\n  /** Directory where cache files are stored (default: './cache') */\n  cacheDirectory?: string;\n  /** Default time to live in milliseconds (default: 3600000) */\n  defaultTTL?: number;\n  /** Interval in milliseconds for cleanup of expired entries (default: 300000) */\n  cleanupInterval?: number;\n};\n\n/**\n * Represents a cached item stored in a file.\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}\n\n/**\n * File-based cache provider that stores cache entries as JSON files.\n * Provides persistent caching with automatic cleanup of expired entries.\n */\nexport class FileCacheProvider implements CacheProviderInterface {\n  private config: FileCacheConfig = {\n    cacheDirectory: path.join(process.cwd(), 'cache'),\n    defaultTTL: 3600 * 1000,\n    cleanupInterval: 300 * 1000,\n  };\n\n  private cleanupTimer?: NodeJS.Timeout;\n\n  /**\n   * Creates a new FileCacheProvider instance.\n   * @param config - Configuration options for the cache\n   */\n  constructor(config: FileCacheConfig = {}) {\n    this.config = { ...this.config, ...config };\n\n    this.ensureCacheDirectory();\n    this.startCleanupTimer();\n  }\n\n  /**\n   * Ensures the cache directory exists, creating it if necessary.\n   */\n  private async ensureCacheDirectory(): Promise<void> {\n    try {\n      await fs.access(this.config.cacheDirectory!);\n    } catch {\n      await fs.mkdir(this.config.cacheDirectory!, { recursive: true });\n    }\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().catch(console.error);\n      }, this.config.cleanupInterval!);\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   * Generates a safe file path for the given cache key.\n   * @param key - The cache key\n   * @returns The full file path for the cache entry\n   */\n  private getFilePath(key: string): string {\n    // Create a safe filename from the key\n    const safeKey = key.replace(/[^a-z0-9]/gi, '_');\n    return path.join(this.config.cacheDirectory!, `${safeKey}.json`);\n  }\n\n  /**\n   * Removes all expired cache entries from the cache directory.\n   */\n  private async cleanupExpiredEntries(): Promise<void> {\n    try {\n      const files = await fs.readdir(this.config.cacheDirectory!);\n      const now = Date.now();\n\n      for (const file of files) {\n        if (file.endsWith('.json')) {\n          const filePath = path.join(this.config.cacheDirectory!, file);\n          try {\n            const content = await fs.readFile(filePath, 'utf-8');\n            const item: CacheItem = JSON.parse(content);\n\n            if (item.expiresAt && item.expiresAt < now) {\n              await fs.unlink(filePath);\n            }\n          } catch {\n            // If file is corrupted, delete it\n            await fs.unlink(filePath).catch(() => {});\n          }\n        }\n      }\n    } catch (error) {\n      // Ignore cleanup errors\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 filePath = this.getFilePath(key);\n\n    try {\n      const content = await fs.readFile(filePath, 'utf-8');\n      const item: CacheItem = JSON.parse(content);\n\n      // Check if item has expired\n      if (item.expiresAt && item.expiresAt < Date.now()) {\n        await fs.unlink(filePath).catch(() => {});\n        return undefined;\n      }\n\n      return item.value;\n    } catch (error) {\n      return undefined;\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: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    const filePath = this.getFilePath(key);\n    const now = Date.now();\n    const effectiveTTL = ttl ?? this.config.defaultTTL!;\n\n    const item: CacheItem = {\n      value,\n      createdAt: now,\n      expiresAt: effectiveTTL > 0 ? now + effectiveTTL * 1000 : undefined,\n    };\n\n    this.ensureCacheDirectory();\n    await fs.writeFile(filePath, JSON.stringify(item), 'utf-8');\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    const filePath = this.getFilePath(key);\n\n    try {\n      await fs.unlink(filePath);\n    } catch {\n      // File doesn't exist, that's fine\n    }\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 value = await this.get(key);\n    return value !== undefined;\n  }\n\n  /**\n   * Increments a numeric value in the cache atomically using file-based locking.\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   * @throws Error if lock cannot be acquired after maximum retries\n   */\n  async increment(key: string, amount: number = 1): Promise<number> {\n    const filePath = this.getFilePath(key);\n\n    // Use a lock file to ensure atomicity\n    const lockPath = `${filePath}.lock`;\n\n    // Simple file-based locking mechanism\n    let lockAcquired = false;\n    let retries = 0;\n    const maxRetries = 50;\n\n    while (!lockAcquired && retries < maxRetries) {\n      try {\n        // Try to create lock file exclusively\n        await fs.writeFile(lockPath, '', { flag: 'wx' });\n        lockAcquired = true;\n      } catch {\n        // Lock exists, wait a bit and retry\n        await new Promise((resolve) => setTimeout(resolve, 10));\n        retries++;\n      }\n    }\n\n    if (!lockAcquired) {\n      throw new Error('Failed to acquire lock for increment operation');\n    }\n\n    try {\n      let currentValue = 0;\n      let item: CacheItem | undefined;\n\n      // Read current value\n      try {\n        const content = await fs.readFile(filePath, 'utf-8');\n        const parsedItem = JSON.parse(content);\n\n        // Check if item has expired\n        if (parsedItem.expiresAt && parsedItem.expiresAt < Date.now()) {\n          item = undefined;\n        } else {\n          item = parsedItem;\n          currentValue = typeof parsedItem.value === 'number' ? parsedItem.value : 0;\n        }\n      } catch {\n        // File doesn't exist or is corrupted, start from 0\n      }\n\n      // Calculate new value\n      const newValue = currentValue + amount;\n\n      // Write back with same TTL if it existed\n      const now = Date.now();\n      const newItem: CacheItem = {\n        value: newValue,\n        createdAt: item?.createdAt ?? now,\n        expiresAt: item?.expiresAt,\n      };\n\n      await fs.writeFile(filePath, JSON.stringify(newItem), 'utf-8');\n\n      return newValue;\n    } finally {\n      // Release lock\n      try {\n        await fs.unlink(lockPath);\n      } catch {\n        // Ignore errors when removing lock file\n      }\n    }\n  }\n}\n"],"mappings":";;AAAA,YAAY,QAAQ;AACpB,YAAY,UAAU;AAgCf,MAAM,kBAAoD;AAAA,EAjCjE,OAiCiE;AAAA;AAAA;AAAA,EACvD,SAA0B;AAAA,IAChC,gBAAgB,KAAK,KAAK,QAAQ,IAAI,GAAG,OAAO;AAAA,IAChD,YAAY,OAAO;AAAA,IACnB,iBAAiB,MAAM;AAAA,EACzB;AAAA,EAEQ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,YAAY,SAA0B,CAAC,GAAG;AACxC,SAAK,SAAS,EAAE,GAAG,KAAK,QAAQ,GAAG,OAAO;AAE1C,SAAK,qBAAqB;AAC1B,SAAK,kBAAkB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,uBAAsC;AAClD,QAAI;AACF,YAAM,GAAG,OAAO,KAAK,OAAO,cAAe;AAAA,IAC7C,QAAQ;AACN,YAAM,GAAG,MAAM,KAAK,OAAO,gBAAiB,EAAE,WAAW,KAAK,CAAC;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC,QAAI,KAAK,OAAO,kBAAmB,GAAG;AACpC,WAAK,eAAe,YAAY,MAAM;AACpC,aAAK,sBAAsB,EAAE,MAAM,QAAQ,KAAK;AAAA,MAClD,GAAG,KAAK,OAAO,eAAgB;AAAA,IACjC;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;AAAA;AAAA,EAOQ,YAAY,KAAqB;AAEvC,UAAM,UAAU,IAAI,QAAQ,eAAe,GAAG;AAC9C,WAAO,KAAK,KAAK,KAAK,OAAO,gBAAiB,GAAG,OAAO,OAAO;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,wBAAuC;AACnD,QAAI;AACF,YAAM,QAAQ,MAAM,GAAG,QAAQ,KAAK,OAAO,cAAe;AAC1D,YAAM,MAAM,KAAK,IAAI;AAErB,iBAAW,QAAQ,OAAO;AACxB,YAAI,KAAK,SAAS,OAAO,GAAG;AAC1B,gBAAM,WAAW,KAAK,KAAK,KAAK,OAAO,gBAAiB,IAAI;AAC5D,cAAI;AACF,kBAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,kBAAM,OAAkB,KAAK,MAAM,OAAO;AAE1C,gBAAI,KAAK,aAAa,KAAK,YAAY,KAAK;AAC1C,oBAAM,GAAG,OAAO,QAAQ;AAAA,YAC1B;AAAA,UACF,QAAQ;AAEN,kBAAM,GAAG,OAAO,QAAQ,EAAE,MAAM,MAAM;AAAA,YAAC,CAAC;AAAA,UAC1C;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AAAA,IAEhB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA0D;AAClE,UAAM,WAAW,KAAK,YAAY,GAAG;AAErC,QAAI;AACF,YAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,YAAM,OAAkB,KAAK,MAAM,OAAO;AAG1C,UAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;AACjD,cAAM,GAAG,OAAO,QAAQ,EAAE,MAAM,MAAM;AAAA,QAAC,CAAC;AACxC,eAAO;AAAA,MACT;AAEA,aAAO,KAAK;AAAA,IACd,SAAS,OAAO;AACd,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,UAAM,WAAW,KAAK,YAAY,GAAG;AACrC,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,eAAe,OAAO,KAAK,OAAO;AAExC,UAAM,OAAkB;AAAA,MACtB;AAAA,MACA,WAAW;AAAA,MACX,WAAW,eAAe,IAAI,MAAM,eAAe,MAAO;AAAA,IAC5D;AAEA,SAAK,qBAAqB;AAC1B,UAAM,GAAG,UAAU,UAAU,KAAK,UAAU,IAAI,GAAG,OAAO;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,KAA4B;AACvC,UAAM,WAAW,KAAK,YAAY,GAAG;AAErC,QAAI;AACF,YAAM,GAAG,OAAO,QAAQ;AAAA,IAC1B,QAAQ;AAAA,IAER;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA+B;AACvC,UAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;AAChC,WAAO,UAAU;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,UAAM,WAAW,KAAK,YAAY,GAAG;AAGrC,UAAM,WAAW,GAAG,QAAQ;AAG5B,QAAI,eAAe;AACnB,QAAI,UAAU;AACd,UAAM,aAAa;AAEnB,WAAO,CAAC,gBAAgB,UAAU,YAAY;AAC5C,UAAI;AAEF,cAAM,GAAG,UAAU,UAAU,IAAI,EAAE,MAAM,KAAK,CAAC;AAC/C,uBAAe;AAAA,MACjB,QAAQ;AAEN,cAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,EAAE,CAAC;AACtD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AAEA,QAAI;AACF,UAAI,eAAe;AACnB,UAAI;AAGJ,UAAI;AACF,cAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,cAAM,aAAa,KAAK,MAAM,OAAO;AAGrC,YAAI,WAAW,aAAa,WAAW,YAAY,KAAK,IAAI,GAAG;AAC7D,iBAAO;AAAA,QACT,OAAO;AACL,iBAAO;AACP,yBAAe,OAAO,WAAW,UAAU,WAAW,WAAW,QAAQ;AAAA,QAC3E;AAAA,MACF,QAAQ;AAAA,MAER;AAGA,YAAM,WAAW,eAAe;AAGhC,YAAM,MAAM,KAAK,IAAI;AACrB,YAAM,UAAqB;AAAA,QACzB,OAAO;AAAA,QACP,WAAW,MAAM,aAAa;AAAA,QAC9B,WAAW,MAAM;AAAA,MACnB;AAEA,YAAM,GAAG,UAAU,UAAU,KAAK,UAAU,OAAO,GAAG,OAAO;AAE7D,aAAO;AAAA,IACT,UAAE;AAEA,UAAI;AACF,cAAM,GAAG,OAAO,QAAQ;AAAA,MAC1B,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/providers/MemcacheCacheProvider.d.mts

@@ -2,19 +2,59 @@ import { CacheProviderInterface } from '../CacheProviderInterface.mjs';
 import { JSONValue, JSONObject } from '@devbro/neko-helper';
 import Memcached from 'memcached';
 
-interface MemcachedConfig {
+/**
+ * Configuration options for the Memcached cache provider.
+ */
+type MemcachedConfig = {
+    /** Memcached server location(s) */
     location?: Memcached.Location;
+    /** Additional Memcached options */
     options?: Memcached.options;
-}
+};
+/**
+ * Memcached-based cache provider that stores cache entries in a Memcached server.
+ * Provides distributed caching with automatic serialization and expiration.
+ */
 declare class MemcacheCacheProvider implements CacheProviderInterface {
     private config;
     private client;
     private defaultTTL;
+    /**
+     * Creates a new MemcacheCacheProvider instance.
+     * @param config - Memcached configuration options
+     */
     constructor(config?: MemcachedConfig);
+    /**
+     * 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: JSONObject | JSONValue, 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 Memcached's native increment.
+     * If the key doesn't exist, it is initialized with the increment amount.
+     * @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>;
 }
 

package/dist/providers/MemcacheCacheProvider.mjs

@@ -3,6 +3,10 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 import Memcached from "memcached";
 class MemcacheCacheProvider {
   // default TTL in seconds
+  /**
+   * Creates a new MemcacheCacheProvider instance.
+   * @param config - Memcached configuration options
+   */
   constructor(config = {}) {
     this.config = config;
     this.client = new Memcached(config.location || "localhost:11211", config.options || {});
@@ -12,6 +16,11 @@ class MemcacheCacheProvider {
   }
   client;
   defaultTTL = 3600;
+  /**
+   * Retrieves a value from the cache.
+   * @param key - The cache key
+   * @returns The cached value or undefined if not found
+   */
   async get(key) {
     return new Promise((resolve, reject) => {
       this.client.get(key, (err, data) => {
@@ -31,6 +40,12 @@ class MemcacheCacheProvider {
       });
     });
   }
+  /**
+   * 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) {
     return new Promise((resolve, reject) => {
       const serializedValue = JSON.stringify(value);
@@ -44,6 +59,10 @@ class MemcacheCacheProvider {
       });
     });
   }
+  /**
+   * Deletes a value from the cache.
+   * @param key - The cache key to delete
+   */
   async delete(key) {
     return new Promise((resolve, reject) => {
       this.client.del(key, (err) => {
@@ -55,6 +74,11 @@ class MemcacheCacheProvider {
       });
     });
   }
+  /**
+   * 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) {
     return new Promise((resolve, reject) => {
       this.client.get(key, (err, data) => {
@@ -66,6 +90,13 @@ class MemcacheCacheProvider {
       });
     });
   }
+  /**
+   * Increments a numeric value in the cache atomically using Memcached's native increment.
+   * If the key doesn't exist, it is initialized with the increment amount.
+   * @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) {
     return new Promise((resolve, reject) => {
       this.client.incr(key, amount, (err, result) => {

package/dist/providers/MemcacheCacheProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/providers/MemcacheCacheProvider.mts"],"sourcesContent":["import { CacheProviderInterface } from '@/CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\nimport Memcached from 'memcached';\n\nexport interface MemcachedConfig {\n  location?: Memcached.Location;\n  options?: Memcached.options;\n}\n\nexport class MemcacheCacheProvider implements CacheProviderInterface {\n  private client: Memcached;\n  private defaultTTL: number = 3600; // default TTL in seconds\n\n  constructor(private config: MemcachedConfig = {}) {\n    this.client = new Memcached(config.location || 'localhost:11211', config.options || {});\n  }\n\n  async get(key: string): Promise<JSONValue | JSONObject | undefined> {\n    return new Promise((resolve, reject) => {\n      this.client.get(key, (err: Error | undefined, data: any) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n\n        if (data === undefined || data === null) {\n          resolve(undefined);\n          return;\n        }\n\n        try {\n          // Memcached automatically handles JSON serialization/deserialization\n          // but we need to ensure we return the correct type\n          resolve(typeof data === 'string' ? JSON.parse(data) : data);\n        } catch (parseErr) {\n          // If parsing fails, return the raw value\n          resolve(data);\n        }\n      });\n    });\n  }\n\n  async put(key: string, value: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const serializedValue = JSON.stringify(value);\n      const finalTTL = ttl ?? this.defaultTTL;\n\n      this.client.set(key, serializedValue, finalTTL, (err: Error | undefined) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\n    });\n  }\n\n  async delete(key: string): Promise<void> {\n    return new Promise((resolve, reject) => {\n      this.client.del(key, (err: Error | undefined) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\n    });\n  }\n\n  async has(key: string): Promise<boolean> {\n    return new Promise((resolve, reject) => {\n      this.client.get(key, (err: Error | undefined, data: any) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve(data !== undefined && data !== null);\n      });\n    });\n  }\n\n  async increment(key: string, amount: number = 1): Promise<number> {\n    return new Promise((resolve, reject) => {\n      // Memcached incr are atomic operations\n      this.client.incr(key, amount, (err: any, result: number | boolean) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n\n        // If key doesn't exist, result will be false\n        if (result === false) {\n          // Initialize the key with the amount value\n          this.client.set(key, amount.toString(), this.defaultTTL, (setErr: Error | undefined) => {\n            if (setErr) {\n              reject(setErr);\n              return;\n            }\n            resolve(amount);\n          });\n        } else {\n          resolve(result as number);\n        }\n      });\n    });\n  }\n}\n"],"mappings":";;AAEA,OAAO,eAAe;AAOf,MAAM,sBAAwD;AAAA;AAAA,EAInE,YAAoB,SAA0B,CAAC,GAAG;AAA9B;AAClB,SAAK,SAAS,IAAI,UAAU,OAAO,YAAY,mBAAmB,OAAO,WAAW,CAAC,CAAC;AAAA,EACxF;AAAA,EAfF,OASqE;AAAA;AAAA;AAAA,EAC3D;AAAA,EACA,aAAqB;AAAA,EAM7B,MAAM,IAAI,KAA0D;AAClE,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,KAAwB,SAAc;AAC1D,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AAEA,YAAI,SAAS,UAAa,SAAS,MAAM;AACvC,kBAAQ,MAAS;AACjB;AAAA,QACF;AAEA,YAAI;AAGF,kBAAQ,OAAO,SAAS,WAAW,KAAK,MAAM,IAAI,IAAI,IAAI;AAAA,QAC5D,SAAS,UAAU;AAEjB,kBAAQ,IAAI;AAAA,QACd;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,kBAAkB,KAAK,UAAU,KAAK;AAC5C,YAAM,WAAW,OAAO,KAAK;AAE7B,WAAK,OAAO,IAAI,KAAK,iBAAiB,UAAU,CAAC,QAA2B;AAC1E,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,OAAO,KAA4B;AACvC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,QAA2B;AAC/C,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,KAA+B;AACvC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,KAAwB,SAAc;AAC1D,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ,SAAS,UAAa,SAAS,IAAI;AAAA,MAC7C,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AAEtC,WAAK,OAAO,KAAK,KAAK,QAAQ,CAAC,KAAU,WAA6B;AACpE,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AAGA,YAAI,WAAW,OAAO;AAEpB,eAAK,OAAO,IAAI,KAAK,OAAO,SAAS,GAAG,KAAK,YAAY,CAAC,WAA8B;AACtF,gBAAI,QAAQ;AACV,qBAAO,MAAM;AACb;AAAA,YACF;AACA,oBAAQ,MAAM;AAAA,UAChB,CAAC;AAAA,QACH,OAAO;AACL,kBAAQ,MAAgB;AAAA,QAC1B;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;","names":[]}
+{"version":3,"sources":["../../src/providers/MemcacheCacheProvider.mts"],"sourcesContent":["import { CacheProviderInterface } from '@/CacheProviderInterface.mjs';\nimport { JSONValue, JSONObject } from '@devbro/neko-helper';\nimport Memcached from 'memcached';\n\n/**\n * Configuration options for the Memcached cache provider.\n */\nexport type MemcachedConfig = {\n  /** Memcached server location(s) */\n  location?: Memcached.Location;\n  /** Additional Memcached options */\n  options?: Memcached.options;\n};\n\n/**\n * Memcached-based cache provider that stores cache entries in a Memcached server.\n * Provides distributed caching with automatic serialization and expiration.\n */\nexport class MemcacheCacheProvider implements CacheProviderInterface {\n  private client: Memcached;\n  private defaultTTL: number = 3600; // default TTL in seconds\n\n  /**\n   * Creates a new MemcacheCacheProvider instance.\n   * @param config - Memcached configuration options\n   */\n  constructor(private config: MemcachedConfig = {}) {\n    this.client = new Memcached(config.location || 'localhost:11211', config.options || {});\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    return new Promise((resolve, reject) => {\n      this.client.get(key, (err: Error | undefined, data: any) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n\n        if (data === undefined || data === null) {\n          resolve(undefined);\n          return;\n        }\n\n        try {\n          // Memcached automatically handles JSON serialization/deserialization\n          // but we need to ensure we return the correct type\n          resolve(typeof data === 'string' ? JSON.parse(data) : data);\n        } catch (parseErr) {\n          // If parsing fails, return the raw value\n          resolve(data);\n        }\n      });\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: JSONObject | JSONValue, ttl?: number): Promise<void> {\n    return new Promise((resolve, reject) => {\n      const serializedValue = JSON.stringify(value);\n      const finalTTL = ttl ?? this.defaultTTL;\n\n      this.client.set(key, serializedValue, finalTTL, (err: Error | undefined) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\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    return new Promise((resolve, reject) => {\n      this.client.del(key, (err: Error | undefined) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\n    });\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    return new Promise((resolve, reject) => {\n      this.client.get(key, (err: Error | undefined, data: any) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve(data !== undefined && data !== null);\n      });\n    });\n  }\n\n  /**\n   * Increments a numeric value in the cache atomically using Memcached's native increment.\n   * If the key doesn't exist, it is initialized with the increment amount.\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    return new Promise((resolve, reject) => {\n      // Memcached incr are atomic operations\n      this.client.incr(key, amount, (err: any, result: number | boolean) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n\n        // If key doesn't exist, result will be false\n        if (result === false) {\n          // Initialize the key with the amount value\n          this.client.set(key, amount.toString(), this.defaultTTL, (setErr: Error | undefined) => {\n            if (setErr) {\n              reject(setErr);\n              return;\n            }\n            resolve(amount);\n          });\n        } else {\n          resolve(result as number);\n        }\n      });\n    });\n  }\n}\n"],"mappings":";;AAEA,OAAO,eAAe;AAgBf,MAAM,sBAAwD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnE,YAAoB,SAA0B,CAAC,GAAG;AAA9B;AAClB,SAAK,SAAS,IAAI,UAAU,OAAO,YAAY,mBAAmB,OAAO,WAAW,CAAC,CAAC;AAAA,EACxF;AAAA,EA5BF,OAkBqE;AAAA;AAAA;AAAA,EAC3D;AAAA,EACA,aAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAe7B,MAAM,IAAI,KAA0D;AAClE,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,KAAwB,SAAc;AAC1D,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AAEA,YAAI,SAAS,UAAa,SAAS,MAAM;AACvC,kBAAQ,MAAS;AACjB;AAAA,QACF;AAEA,YAAI;AAGF,kBAAQ,OAAO,SAAS,WAAW,KAAK,MAAM,IAAI,IAAI,IAAI;AAAA,QAC5D,SAAS,UAAU;AAEjB,kBAAQ,IAAI;AAAA,QACd;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAa,OAA+B,KAA6B;AACjF,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,kBAAkB,KAAK,UAAU,KAAK;AAC5C,YAAM,WAAW,OAAO,KAAK;AAE7B,WAAK,OAAO,IAAI,KAAK,iBAAiB,UAAU,CAAC,QAA2B;AAC1E,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,KAA4B;AACvC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,QAA2B;AAC/C,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,KAA+B;AACvC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,IAAI,KAAK,CAAC,KAAwB,SAAc;AAC1D,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AACA,gBAAQ,SAAS,UAAa,SAAS,IAAI;AAAA,MAC7C,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,UAAU,KAAa,SAAiB,GAAoB;AAChE,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AAEtC,WAAK,OAAO,KAAK,KAAK,QAAQ,CAAC,KAAU,WAA6B;AACpE,YAAI,KAAK;AACP,iBAAO,GAAG;AACV;AAAA,QACF;AAGA,YAAI,WAAW,OAAO;AAEpB,eAAK,OAAO,IAAI,KAAK,OAAO,SAAS,GAAG,KAAK,YAAY,CAAC,WAA8B;AACtF,gBAAI,QAAQ;AACV,qBAAO,MAAM;AACb;AAAA,YACF;AACA,oBAAQ,MAAM;AAAA,UAChB,CAAC;AAAA,QACH,OAAO;AACL,kBAAQ,MAAgB;AAAA,QAC1B;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;","names":[]}

package/dist/providers/MemoryCacheProvider.d.mts

@@ -1,24 +1,77 @@
 import { JSONObject, JSONValue } from '@devbro/neko-helper';
 import { CacheProviderInterface } from '../CacheProviderInterface.mjs';
 
-interface MemoryCacheConfig {
+/**
+ * Configuration options for the in-memory cache provider.
+ */
+type MemoryCacheConfig = {
+    /** Maximum number of items to store in cache (default: 1000) */
     maxSize?: number;
+    /** Default time to live in seconds (default: 3600) */
     defaultTTL?: number;
+    /** Interval in seconds to run cleanup of expired entries (default: 600) */
     cleanupInterval?: number;
-}
+};
+/**
+ * In-memory cache provider with LRU eviction and automatic cleanup.
+ * Stores cache entries in memory with support for TTL and size limits.
+ */
 declare class MemoryCacheProvider implements CacheProviderInterface {
     private cache;
     private config;
     private cleanupTimer?;
+    /**
+     * Creates a new MemoryCacheProvider instance.
+     * @param config - Configuration options for the cache
+     */
     constructor(config?: MemoryCacheConfig);
+    /**
+     * Starts the automatic cleanup timer for expired entries.
+     */
     private startCleanupTimer;
+    /**
+     * Stops the automatic cleanup timer.
+     */
     private stopCleanupTimer;
+    /**
+     * Removes all expired entries from the cache.
+     */
     private cleanupExpiredEntries;
+    /**
+     * Evicts the least recently used item if cache size exceeds maximum.
+     */
     private evictLRU;
+    /**
+     * Retrieves a value from the cache.
+     * @param key - The cache key
+     * @returns The cached value or undefined if not found or expired
+     */
     get(key: string): Promise<JSONObject | JSONValue | 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: JSONObject | JSONValue, 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 and has not expired.
+     * @param key - The cache key to check
+     * @returns True if the key exists and is not expired, false otherwise
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * 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
+     */
     increment(key: string, amount?: number): Promise<number>;
 }