@magnet-cms/adapter-cache-redis 1.0.0

package/dist/index.cjs

@@ -0,0 +1,138 @@
+'use strict';
+
+var common = require('@magnet-cms/common');
+var Redis = require('ioredis');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var Redis__default = /*#__PURE__*/_interopDefault(Redis);
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var RedisCacheAdapter = class _RedisCacheAdapter extends common.CacheAdapter {
+  static {
+    __name(this, "RedisCacheAdapter");
+  }
+  name = "redis";
+  redis;
+  keyPrefix;
+  /** Environment variables used by this adapter */
+  static envVars = [
+    {
+      name: "CACHE_REDIS_URL",
+      required: false,
+      description: "Redis connection URL for cache (falls back to REDIS_URL)"
+    },
+    {
+      name: "REDIS_URL",
+      required: false,
+      description: "Generic Redis connection URL (fallback for CACHE_REDIS_URL)"
+    }
+  ];
+  constructor(config = {}) {
+    super();
+    this.keyPrefix = config.keyPrefix ?? "";
+    const url = config.url ?? process.env.CACHE_REDIS_URL ?? process.env.REDIS_URL;
+    if (url) {
+      this.redis = new Redis__default.default(url, {
+        lazyConnect: true
+      });
+    } else {
+      this.redis = new Redis__default.default({
+        host: config.host ?? "localhost",
+        port: config.port ?? 6379,
+        password: config.password,
+        db: config.db ?? 0,
+        lazyConnect: true
+      });
+    }
+    this.redis.on("error", () => {
+    });
+  }
+  /**
+  * Create a configured cache provider for MagnetModule.forRoot().
+  * Auto-resolves connection from CACHE_REDIS_URL or REDIS_URL env vars.
+  *
+  * @example
+  * ```typescript
+  * MagnetModule.forRoot([
+  *   RedisCacheAdapter.forRoot(),
+  *   // or with explicit config:
+  *   RedisCacheAdapter.forRoot({ url: 'redis://localhost:6379', keyPrefix: 'myapp:' }),
+  * ])
+  * ```
+  */
+  static forRoot(config = {}) {
+    return {
+      type: "cache",
+      adapter: new _RedisCacheAdapter(config),
+      envVars: _RedisCacheAdapter.envVars
+    };
+  }
+  async get(key) {
+    const raw = await this.redis.get(this.prefixKey(key));
+    if (raw === null) return null;
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  async set(key, value, ttl) {
+    const serialized = JSON.stringify(value);
+    const prefixed = this.prefixKey(key);
+    if (ttl !== void 0) {
+      await this.redis.set(prefixed, serialized, "EX", ttl);
+    } else {
+      await this.redis.set(prefixed, serialized);
+    }
+  }
+  async delete(key) {
+    await this.redis.del(this.prefixKey(key));
+  }
+  async deleteByPattern(pattern) {
+    await this.scanAndDelete(this.prefixKey(pattern));
+  }
+  async has(key) {
+    const count = await this.redis.exists(this.prefixKey(key));
+    return count > 0;
+  }
+  async clear() {
+    const pattern = this.keyPrefix ? `${this.keyPrefix}*` : "*";
+    await this.scanAndDelete(pattern);
+  }
+  async healthCheck() {
+    try {
+      await this.redis.ping();
+      return {
+        healthy: true
+      };
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      return {
+        healthy: false,
+        message
+      };
+    }
+  }
+  async dispose() {
+    await this.redis.quit();
+  }
+  prefixKey(key) {
+    return this.keyPrefix ? `${this.keyPrefix}${key}` : key;
+  }
+  /** SCAN-based deletion — safe for production (never uses KEYS) */
+  async scanAndDelete(pattern) {
+    let cursor = "0";
+    do {
+      const [nextCursor, keys] = await this.redis.scan(cursor, "MATCH", pattern, "COUNT", 100);
+      cursor = nextCursor;
+      if (keys.length > 0) {
+        await this.redis.del(...keys);
+      }
+    } while (cursor !== "0");
+  }
+};
+
+exports.CacheAdapter = RedisCacheAdapter;
+exports.RedisCacheAdapter = RedisCacheAdapter;

package/dist/index.d.cts

@@ -0,0 +1,64 @@
+import { CacheAdapter, EnvVarRequirement, CacheMagnetProvider, CacheHealthResult } from '@magnet-cms/common';
+
+interface RedisCacheAdapterConfig {
+    /** Redis connection URL (e.g., redis://localhost:6379). Takes precedence over host/port. */
+    url?: string;
+    /** Redis host (default: localhost) */
+    host?: string;
+    /** Redis port (default: 6379) */
+    port?: number;
+    /** Redis password */
+    password?: string;
+    /** Redis database index (default: 0) */
+    db?: number;
+    /** Key prefix for all cache entries (default: '') */
+    keyPrefix?: string;
+}
+/**
+ * Redis-based cache adapter using ioredis.
+ *
+ * Compatible with Redis 6+ and Dragonfly (Redis wire-compatible).
+ * Uses SCAN for safe pattern-based deletion (never KEYS in production).
+ *
+ * @example
+ * ```typescript
+ * MagnetModule.forRoot([
+ *   RedisCacheAdapter.forRoot({ url: process.env.REDIS_URL }),
+ * ])
+ * ```
+ */
+declare class RedisCacheAdapter extends CacheAdapter {
+    readonly name = "redis";
+    private readonly redis;
+    private readonly keyPrefix;
+    /** Environment variables used by this adapter */
+    static readonly envVars: EnvVarRequirement[];
+    constructor(config?: RedisCacheAdapterConfig);
+    /**
+     * Create a configured cache provider for MagnetModule.forRoot().
+     * Auto-resolves connection from CACHE_REDIS_URL or REDIS_URL env vars.
+     *
+     * @example
+     * ```typescript
+     * MagnetModule.forRoot([
+     *   RedisCacheAdapter.forRoot(),
+     *   // or with explicit config:
+     *   RedisCacheAdapter.forRoot({ url: 'redis://localhost:6379', keyPrefix: 'myapp:' }),
+     * ])
+     * ```
+     */
+    static forRoot(config?: RedisCacheAdapterConfig): CacheMagnetProvider;
+    get<T>(key: string): Promise<T | null>;
+    set<T>(key: string, value: T, ttl?: number): Promise<void>;
+    delete(key: string): Promise<void>;
+    deleteByPattern(pattern: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    clear(): Promise<void>;
+    healthCheck(): Promise<CacheHealthResult>;
+    dispose(): Promise<void>;
+    private prefixKey;
+    /** SCAN-based deletion — safe for production (never uses KEYS) */
+    private scanAndDelete;
+}
+
+export { RedisCacheAdapter as CacheAdapter, RedisCacheAdapter, type RedisCacheAdapterConfig };

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import { CacheAdapter, EnvVarRequirement, CacheMagnetProvider, CacheHealthResult } from '@magnet-cms/common';
+
+interface RedisCacheAdapterConfig {
+    /** Redis connection URL (e.g., redis://localhost:6379). Takes precedence over host/port. */
+    url?: string;
+    /** Redis host (default: localhost) */
+    host?: string;
+    /** Redis port (default: 6379) */
+    port?: number;
+    /** Redis password */
+    password?: string;
+    /** Redis database index (default: 0) */
+    db?: number;
+    /** Key prefix for all cache entries (default: '') */
+    keyPrefix?: string;
+}
+/**
+ * Redis-based cache adapter using ioredis.
+ *
+ * Compatible with Redis 6+ and Dragonfly (Redis wire-compatible).
+ * Uses SCAN for safe pattern-based deletion (never KEYS in production).
+ *
+ * @example
+ * ```typescript
+ * MagnetModule.forRoot([
+ *   RedisCacheAdapter.forRoot({ url: process.env.REDIS_URL }),
+ * ])
+ * ```
+ */
+declare class RedisCacheAdapter extends CacheAdapter {
+    readonly name = "redis";
+    private readonly redis;
+    private readonly keyPrefix;
+    /** Environment variables used by this adapter */
+    static readonly envVars: EnvVarRequirement[];
+    constructor(config?: RedisCacheAdapterConfig);
+    /**
+     * Create a configured cache provider for MagnetModule.forRoot().
+     * Auto-resolves connection from CACHE_REDIS_URL or REDIS_URL env vars.
+     *
+     * @example
+     * ```typescript
+     * MagnetModule.forRoot([
+     *   RedisCacheAdapter.forRoot(),
+     *   // or with explicit config:
+     *   RedisCacheAdapter.forRoot({ url: 'redis://localhost:6379', keyPrefix: 'myapp:' }),
+     * ])
+     * ```
+     */
+    static forRoot(config?: RedisCacheAdapterConfig): CacheMagnetProvider;
+    get<T>(key: string): Promise<T | null>;
+    set<T>(key: string, value: T, ttl?: number): Promise<void>;
+    delete(key: string): Promise<void>;
+    deleteByPattern(pattern: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    clear(): Promise<void>;
+    healthCheck(): Promise<CacheHealthResult>;
+    dispose(): Promise<void>;
+    private prefixKey;
+    /** SCAN-based deletion — safe for production (never uses KEYS) */
+    private scanAndDelete;
+}
+
+export { RedisCacheAdapter as CacheAdapter, RedisCacheAdapter, type RedisCacheAdapterConfig };

package/dist/index.js

@@ -0,0 +1,131 @@
+import { CacheAdapter } from '@magnet-cms/common';
+import Redis from 'ioredis';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var RedisCacheAdapter = class _RedisCacheAdapter extends CacheAdapter {
+  static {
+    __name(this, "RedisCacheAdapter");
+  }
+  name = "redis";
+  redis;
+  keyPrefix;
+  /** Environment variables used by this adapter */
+  static envVars = [
+    {
+      name: "CACHE_REDIS_URL",
+      required: false,
+      description: "Redis connection URL for cache (falls back to REDIS_URL)"
+    },
+    {
+      name: "REDIS_URL",
+      required: false,
+      description: "Generic Redis connection URL (fallback for CACHE_REDIS_URL)"
+    }
+  ];
+  constructor(config = {}) {
+    super();
+    this.keyPrefix = config.keyPrefix ?? "";
+    const url = config.url ?? process.env.CACHE_REDIS_URL ?? process.env.REDIS_URL;
+    if (url) {
+      this.redis = new Redis(url, {
+        lazyConnect: true
+      });
+    } else {
+      this.redis = new Redis({
+        host: config.host ?? "localhost",
+        port: config.port ?? 6379,
+        password: config.password,
+        db: config.db ?? 0,
+        lazyConnect: true
+      });
+    }
+    this.redis.on("error", () => {
+    });
+  }
+  /**
+  * Create a configured cache provider for MagnetModule.forRoot().
+  * Auto-resolves connection from CACHE_REDIS_URL or REDIS_URL env vars.
+  *
+  * @example
+  * ```typescript
+  * MagnetModule.forRoot([
+  *   RedisCacheAdapter.forRoot(),
+  *   // or with explicit config:
+  *   RedisCacheAdapter.forRoot({ url: 'redis://localhost:6379', keyPrefix: 'myapp:' }),
+  * ])
+  * ```
+  */
+  static forRoot(config = {}) {
+    return {
+      type: "cache",
+      adapter: new _RedisCacheAdapter(config),
+      envVars: _RedisCacheAdapter.envVars
+    };
+  }
+  async get(key) {
+    const raw = await this.redis.get(this.prefixKey(key));
+    if (raw === null) return null;
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  async set(key, value, ttl) {
+    const serialized = JSON.stringify(value);
+    const prefixed = this.prefixKey(key);
+    if (ttl !== void 0) {
+      await this.redis.set(prefixed, serialized, "EX", ttl);
+    } else {
+      await this.redis.set(prefixed, serialized);
+    }
+  }
+  async delete(key) {
+    await this.redis.del(this.prefixKey(key));
+  }
+  async deleteByPattern(pattern) {
+    await this.scanAndDelete(this.prefixKey(pattern));
+  }
+  async has(key) {
+    const count = await this.redis.exists(this.prefixKey(key));
+    return count > 0;
+  }
+  async clear() {
+    const pattern = this.keyPrefix ? `${this.keyPrefix}*` : "*";
+    await this.scanAndDelete(pattern);
+  }
+  async healthCheck() {
+    try {
+      await this.redis.ping();
+      return {
+        healthy: true
+      };
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      return {
+        healthy: false,
+        message
+      };
+    }
+  }
+  async dispose() {
+    await this.redis.quit();
+  }
+  prefixKey(key) {
+    return this.keyPrefix ? `${this.keyPrefix}${key}` : key;
+  }
+  /** SCAN-based deletion — safe for production (never uses KEYS) */
+  async scanAndDelete(pattern) {
+    let cursor = "0";
+    do {
+      const [nextCursor, keys] = await this.redis.scan(cursor, "MATCH", pattern, "COUNT", 100);
+      cursor = nextCursor;
+      if (keys.length > 0) {
+        await this.redis.del(...keys);
+      }
+    } while (cursor !== "0");
+  }
+};
+
+export { RedisCacheAdapter as CacheAdapter, RedisCacheAdapter };

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@magnet-cms/adapter-cache-redis",
+  "version": "1.0.0",
+  "description": "Redis cache adapter for Magnet CMS",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build:dev": "tsup --watch",
+    "build": "tsup",
+    "check-types": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@magnet-cms/common": "workspace:*",
+    "@repo/biome": "workspace:*",
+    "@repo/tsup": "workspace:*",
+    "@repo/typescript-config": "workspace:*",
+    "ioredis": "^5.4.2"
+  },
+  "peerDependencies": {
+    "@magnet-cms/common": "^0.2.0",
+    "ioredis": "^5.0.0"
+  }
+}