@naman_deep_singh/cache 1.1.0

package/dist/cjs/adapters/redis/RedisCache.d.ts

@@ -0,0 +1,67 @@
+import type { RedisCacheConfig, HealthCheckResponse } from '../../types';
+import { BaseCache } from '../../core/BaseCache';
+/**
+ * Redis cache adapter
+ */
+export declare class RedisCache<T = unknown> extends BaseCache<T> {
+    private redisConfig;
+    private client;
+    private isConnected;
+    constructor(redisConfig: RedisCacheConfig);
+    /**
+     * Connect to Redis
+     */
+    connect(): Promise<void>;
+    /**
+     * Ensure client is connected
+     */
+    private ensureConnected;
+    /**
+     * Get a value from Redis
+     */
+    get(key: string): Promise<T | null>;
+    /**
+     * Set a value in Redis
+     */
+    set(key: string, value: T, ttl?: number): Promise<void>;
+    /**
+     * Delete a key from Redis
+     */
+    delete(key: string): Promise<boolean>;
+    /**
+     * Check if key exists
+     */
+    exists(key: string): Promise<boolean>;
+    /**
+     * Clear all keys with current namespace
+     */
+    clear(): Promise<void>;
+    /**
+     * Get multiple values at once
+     */
+    getMultiple(keys: string[]): Promise<Record<string, T | null>>;
+    /**
+     * Set multiple values at once
+     */
+    setMultiple(data: Record<string, T>, ttl?: number): Promise<void>;
+    /**
+     * Delete multiple keys at once
+     */
+    deleteMultiple(keys: string[]): Promise<number>;
+    /**
+     * Increment a numeric value
+     */
+    increment(key: string, amount?: number): Promise<number>;
+    /**
+     * Decrement a numeric value
+     */
+    decrement(key: string, amount?: number): Promise<number>;
+    /**
+     * Check if Redis is alive
+     */
+    isAlive(): Promise<HealthCheckResponse>;
+    /**
+     * Close Redis connection
+     */
+    close(): Promise<void>;
+}

package/dist/cjs/adapters/redis/RedisCache.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCache = void 0;
+const redis_1 = require("redis");
+const BaseCache_1 = require("../../core/BaseCache");
+const errors_1 = require("../../errors");
+/**
+ * Redis cache adapter
+ */
+class RedisCache extends BaseCache_1.BaseCache {
+    constructor(redisConfig) {
+        super(redisConfig);
+        this.redisConfig = redisConfig;
+        this.client = null;
+        this.isConnected = false;
+    }
+    /**
+     * Connect to Redis
+     */
+    async connect() {
+        try {
+            const options = {
+                host: this.redisConfig.host ?? 'localhost',
+                port: this.redisConfig.port ?? 6379,
+                db: this.redisConfig.db ?? 0
+            };
+            if (this.redisConfig.username) {
+                options.username = this.redisConfig.username;
+            }
+            if (this.redisConfig.password) {
+                options.password = this.redisConfig.password;
+            }
+            if (this.redisConfig.tls) {
+                options.tls = true;
+            }
+            this.client = (0, redis_1.createClient)(options);
+            this.client.on('error', (err) => {
+                this.isConnected = false;
+                console.error('Redis connection error:', err);
+            });
+            this.client.on('connect', () => {
+                this.isConnected = true;
+            });
+            await this.client.connect();
+            this.isConnected = true;
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to connect to Redis', 'REDIS_CONNECTION_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Ensure client is connected
+     */
+    async ensureConnected() {
+        if (!this.client) {
+            await this.connect();
+        }
+    }
+    /**
+     * Get a value from Redis
+     */
+    async get(key) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            const value = await this.client.get(fullKey);
+            if (value === null) {
+                this.recordMiss();
+                return null;
+            }
+            this.recordHit();
+            return this.deserialize(value);
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to get key "${key}" from Redis`, 'REDIS_GET_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Set a value in Redis
+     */
+    async set(key, value, ttl) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            const serialized = this.serialize(value);
+            const expiry = ttl ?? this.ttl;
+            if (expiry > 0) {
+                await this.client.setEx(fullKey, expiry, serialized);
+            }
+            else {
+                await this.client.set(fullKey, serialized);
+            }
+            this.recordSet();
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to set key "${key}" in Redis`, 'REDIS_SET_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Delete a key from Redis
+     */
+    async delete(key) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            const result = await this.client.del(fullKey);
+            this.recordDelete();
+            return result > 0;
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to delete key "${key}" from Redis`, 'REDIS_DELETE_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Check if key exists
+     */
+    async exists(key) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            const result = await this.client.exists(fullKey);
+            return result > 0;
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to check existence of key "${key}" in Redis`, 'REDIS_EXISTS_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Clear all keys with current namespace
+     */
+    async clear() {
+        try {
+            await this.ensureConnected();
+            if (this.namespace) {
+                // Clear only keys with the current namespace
+                const pattern = `${this.namespace}*`;
+                const keys = await this.client.keys(pattern);
+                if (keys.length > 0) {
+                    await this.client.del(keys);
+                }
+            }
+            else {
+                // Clear all keys
+                await this.client.flushDb();
+            }
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to clear Redis cache', 'REDIS_CLEAR_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Get multiple values at once
+     */
+    async getMultiple(keys) {
+        try {
+            await this.ensureConnected();
+            const fullKeys = keys.map(k => this.buildKey(k));
+            const values = await this.client.mGet(fullKeys);
+            const result = {};
+            keys.forEach((key, index) => {
+                const value = values[index];
+                if (value === null) {
+                    this.recordMiss();
+                    result[key] = null;
+                }
+                else {
+                    this.recordHit();
+                    result[key] = this.deserialize(value);
+                }
+            });
+            return result;
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to get multiple keys from Redis', 'REDIS_GET_MULTIPLE_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Set multiple values at once
+     */
+    async setMultiple(data, ttl) {
+        try {
+            await this.ensureConnected();
+            const expiry = ttl ?? this.ttl;
+            if (expiry > 0) {
+                // Use pipeline for batch operations with TTL
+                const pipeline = this.client.multi();
+                for (const [key, value] of Object.entries(data)) {
+                    const fullKey = this.buildKey(key);
+                    const serialized = this.serialize(value);
+                    pipeline.setEx(fullKey, expiry, serialized);
+                }
+                await pipeline.exec();
+            }
+            else {
+                // Use mSet for batch operations without TTL
+                const flatData = {};
+                for (const [key, value] of Object.entries(data)) {
+                    const fullKey = this.buildKey(key);
+                    flatData[fullKey] = this.serialize(value);
+                }
+                await this.client.mSet(flatData);
+            }
+            this.stats.sets += Object.keys(data).length;
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to set multiple keys in Redis', 'REDIS_SET_MULTIPLE_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Delete multiple keys at once
+     */
+    async deleteMultiple(keys) {
+        try {
+            await this.ensureConnected();
+            const fullKeys = keys.map(k => this.buildKey(k));
+            const result = await this.client.del(fullKeys);
+            this.stats.deletes += result;
+            return result;
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to delete multiple keys from Redis', 'REDIS_DELETE_MULTIPLE_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Increment a numeric value
+     */
+    async increment(key, amount = 1) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            return await this.client.incrBy(fullKey, amount);
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to increment key "${key}" in Redis`, 'REDIS_INCREMENT_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Decrement a numeric value
+     */
+    async decrement(key, amount = 1) {
+        try {
+            await this.ensureConnected();
+            const fullKey = this.buildKey(key);
+            return await this.client.decrBy(fullKey, amount);
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to decrement key "${key}" in Redis`, 'REDIS_DECREMENT_ERROR', 'redis', err);
+        }
+    }
+    /**
+     * Check if Redis is alive
+     */
+    async isAlive() {
+        try {
+            await this.ensureConnected();
+            await this.client.ping();
+            return {
+                isAlive: true,
+                adapter: 'redis',
+                timestamp: new Date()
+            };
+        }
+        catch (err) {
+            return {
+                isAlive: false,
+                adapter: 'redis',
+                timestamp: new Date(),
+                error: err.message
+            };
+        }
+    }
+    /**
+     * Close Redis connection
+     */
+    async close() {
+        try {
+            if (this.client && this.isConnected) {
+                await this.client.quit();
+                this.isConnected = false;
+                this.client = null;
+            }
+        }
+        catch (err) {
+            throw new errors_1.CacheError('Failed to close Redis connection', 'REDIS_CLOSE_ERROR', 'redis', err);
+        }
+    }
+}
+exports.RedisCache = RedisCache;

package/dist/cjs/adapters/redis/index.d.ts

@@ -0,0 +1 @@
+export { RedisCache } from './RedisCache';

package/dist/cjs/adapters/redis/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCache = void 0;
+var RedisCache_1 = require("./RedisCache");
+Object.defineProperty(exports, "RedisCache", { enumerable: true, get: function () { return RedisCache_1.RedisCache; } });

package/dist/cjs/core/BaseCache.d.ts

@@ -0,0 +1,78 @@
+import type { CacheConfig, CacheStats, HealthCheckResponse, BatchResult } from '../types';
+import type { ICache } from './interfaces';
+/**
+ * Abstract base class for all cache adapters
+ */
+export declare abstract class BaseCache<T = unknown> implements ICache<T> {
+    protected config: CacheConfig;
+    protected readonly namespace: string;
+    protected readonly ttl: number;
+    protected stats: CacheStats;
+    constructor(config: CacheConfig);
+    /**
+     * Build full key with namespace prefix
+     */
+    protected buildKey(key: string): string;
+    /**
+     * Deserialize string to object
+     */
+    protected deserialize(data: string): T;
+    /**
+     * Serialize object to string
+     */
+    protected serialize(value: T): string;
+    /**
+     * Track cache hit
+     */
+    protected recordHit(): void;
+    /**
+     * Track cache miss
+     */
+    protected recordMiss(): void;
+    /**
+     * Track cache set
+     */
+    protected recordSet(): void;
+    /**
+     * Track cache delete
+     */
+    protected recordDelete(): void;
+    /**
+     * Reset statistics
+     */
+    protected resetStats(): void;
+    /**
+     * Get cache statistics
+     */
+    getStats(): Promise<CacheStats>;
+    /**
+     * Abstract methods - must be implemented by subclasses
+     */
+    abstract get(key: string): Promise<T | null>;
+    abstract set(key: string, value: T, ttl?: number): Promise<void>;
+    abstract delete(key: string): Promise<boolean>;
+    abstract exists(key: string): Promise<boolean>;
+    abstract clear(): Promise<void>;
+    abstract isAlive(): Promise<HealthCheckResponse>;
+    abstract close(): Promise<void>;
+    /**
+     * Default implementation for getMultiple
+     */
+    getMultiple(keys: string[]): Promise<BatchResult<T>>;
+    /**
+     * Default implementation for setMultiple
+     */
+    setMultiple(data: Record<string, T>, ttl?: number): Promise<void>;
+    /**
+     * Default implementation for deleteMultiple
+     */
+    deleteMultiple(keys: string[]): Promise<number>;
+    /**
+     * Default implementation for increment
+     */
+    increment(key: string, amount?: number): Promise<number>;
+    /**
+     * Default implementation for decrement
+     */
+    decrement(key: string, amount?: number): Promise<number>;
+}

package/dist/cjs/core/BaseCache.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCache = void 0;
+const errors_1 = require("../errors");
+/**
+ * Abstract base class for all cache adapters
+ */
+class BaseCache {
+    constructor(config) {
+        this.config = config;
+        this.stats = {
+            hits: 0,
+            misses: 0,
+            sets: 0,
+            deletes: 0
+        };
+        this.namespace = config.namespace ? `${config.namespace}:` : '';
+        this.ttl = config.ttl ?? 3600; // 1 hour default
+    }
+    /**
+     * Build full key with namespace prefix
+     */
+    buildKey(key) {
+        return `${this.namespace}${key}`;
+    }
+    /**
+     * Deserialize string to object
+     */
+    deserialize(data) {
+        try {
+            return JSON.parse(data);
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to deserialize cache value for key`, 'DESERIALIZE_ERROR', this.config.adapter, err);
+        }
+    }
+    /**
+     * Serialize object to string
+     */
+    serialize(value) {
+        try {
+            return JSON.stringify(value);
+        }
+        catch (err) {
+            throw new errors_1.CacheError(`Failed to serialize cache value`, 'SERIALIZE_ERROR', this.config.adapter, err);
+        }
+    }
+    /**
+     * Track cache hit
+     */
+    recordHit() {
+        this.stats.hits++;
+    }
+    /**
+     * Track cache miss
+     */
+    recordMiss() {
+        this.stats.misses++;
+    }
+    /**
+     * Track cache set
+     */
+    recordSet() {
+        this.stats.sets++;
+    }
+    /**
+     * Track cache delete
+     */
+    recordDelete() {
+        this.stats.deletes++;
+    }
+    /**
+     * Reset statistics
+     */
+    resetStats() {
+        this.stats = {
+            hits: 0,
+            misses: 0,
+            sets: 0,
+            deletes: 0
+        };
+    }
+    /**
+     * Get cache statistics
+     */
+    async getStats() {
+        return { ...this.stats };
+    }
+    /**
+     * Default implementation for getMultiple
+     */
+    async getMultiple(keys) {
+        const result = {};
+        for (const key of keys) {
+            result[key] = await this.get(key);
+        }
+        return result;
+    }
+    /**
+     * Default implementation for setMultiple
+     */
+    async setMultiple(data, ttl) {
+        for (const [key, value] of Object.entries(data)) {
+            await this.set(key, value, ttl);
+        }
+    }
+    /**
+     * Default implementation for deleteMultiple
+     */
+    async deleteMultiple(keys) {
+        let count = 0;
+        for (const key of keys) {
+            const deleted = await this.delete(key);
+            if (deleted)
+                count++;
+        }
+        return count;
+    }
+    /**
+     * Default implementation for increment
+     */
+    async increment(key, amount = 1) {
+        const current = await this.get(key);
+        const value = (typeof current === 'number' ? current : 0) + amount;
+        await this.set(key, value);
+        return value;
+    }
+    /**
+     * Default implementation for decrement
+     */
+    async decrement(key, amount = 1) {
+        const current = await this.get(key);
+        const value = (typeof current === 'number' ? current : 0) - amount;
+        await this.set(key, value);
+        return value;
+    }
+}
+exports.BaseCache = BaseCache;

package/dist/cjs/core/factory.d.ts

@@ -0,0 +1,16 @@
+import type { CacheConfig } from '../types';
+import type { ICache } from './interfaces';
+/**
+ * Factory for creating cache instances
+ */
+export declare class CacheFactory {
+    /**
+     * Create a cache instance based on configuration
+     */
+    static create<T = unknown>(config: CacheConfig): ICache<T>;
+    /**
+     * Create a cache with fallback support
+     * If primary adapter fails to connect, falls back to memory cache
+     */
+    static createWithFallback<T = unknown>(config: CacheConfig): Promise<ICache<T>>;
+}

package/dist/cjs/core/factory.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheFactory = void 0;
+const redis_1 = require("../adapters/redis");
+const memcache_1 = require("../adapters/memcache");
+const memory_1 = require("../adapters/memory");
+const errors_1 = require("../errors");
+/**
+ * Factory for creating cache instances
+ */
+class CacheFactory {
+    /**
+     * Create a cache instance based on configuration
+     */
+    static create(config) {
+        switch (config.adapter) {
+            case 'redis':
+                return new redis_1.RedisCache(config);
+            case 'memcache':
+                return new memcache_1.MemcacheCache(config);
+            case 'memory':
+                return new memory_1.MemoryCache(config);
+            default:
+                throw new errors_1.CacheError(`Unknown cache adapter: ${config.adapter}`, 'UNKNOWN_ADAPTER');
+        }
+    }
+    /**
+     * Create a cache with fallback support
+     * If primary adapter fails to connect, falls back to memory cache
+     */
+    static async createWithFallback(config) {
+        const cache = this.create(config);
+        // Check if primary cache is alive
+        const health = await cache.isAlive();
+        if (health.isAlive) {
+            return cache;
+        }
+        // If primary cache failed and fallback is enabled, use memory cache
+        if (config.fallback !== false) {
+            console.warn(`Failed to connect to ${config.adapter} cache, falling back to memory cache`);
+            return new memory_1.MemoryCache({
+                adapter: 'memory',
+                namespace: config.namespace,
+                ttl: config.ttl
+            });
+        }
+        // No fallback, throw error
+        throw new errors_1.CacheError(`Failed to initialize ${config.adapter} cache and fallback is disabled`, 'CACHE_INIT_ERROR');
+    }
+}
+exports.CacheFactory = CacheFactory;