@teamvelix/cache-redis 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Velix Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# @velix/cache-redis
+
+Redis cache adapter for Velix — implements `ICacheAdapter` via [ioredis](https://github.com/redis/ioredis).
+
+## Installation
+
+```bash
+pnpm add @velix/cache-redis ioredis
+```
+
+## Usage
+
+```ts
+// velix.config.ts
+import { defineConfig } from 'velix';
+import { RedisCacheAdapter } from '@velix/cache-redis';
+
+export default defineConfig({
+  cache: {
+    adapter: new RedisCacheAdapter({
+      url: process.env.REDIS_URL ?? 'redis://localhost:6379',
+    }),
+  },
+});
+```
+
+## Configuration
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `url` | `string` | `'redis://localhost:6379'` | URL de connexion Redis |
+| `client` | `Redis` | — | Instance ioredis pré-configurée (prioritaire sur `url`) |
+| `keyPrefix` | `string` | `'velix:'` | Préfixe appliqué à toutes les clés |
+| `defaultTTL` | `number` | `undefined` | TTL par défaut en millisecondes |
+
+## Features
+
+- **TTL natif Redis** via la commande `PX` (précision milliseconde)
+- **Invalidation par tag** avec un Set Redis par tag, suppression **atomique** via script Lua
+- **Suppression par préfixe** via `SCAN` non-bloquant (ne jamais utiliser `KEYS` en prod)
+- **Clear sélectif** : supprime uniquement les clés `velix:*`, sans impacter les autres apps
+
+## Cache Tag Invalidation
+
+```ts
+import { VelixCache } from 'velix';
+import { RedisCacheAdapter } from '@velix/cache-redis';
+
+const cache = new VelixCache(new RedisCacheAdapter({ url: process.env.REDIS_URL }));
+
+// Stocker avec des tags
+await cache.unstable_cache(fetchProducts, ['products'], {
+  tags: ['products', 'featured'],
+  revalidate: 300, // 5 minutes
+})();
+
+// Invalider tous les produits (ex: après un webhook CMS)
+await cache.revalidateTag('products');
+```
+
+## Architecture
+
+Ce package est volontairement indépendant de `velix-core` pour permettre son utilisation
+dans des contextes non-Velix. Il expose sa propre copie de l'interface `ICacheAdapter`.
+
+```
+@velix/cache-redis
+├── src/
+│   ├── redis.adapter.ts  ← Implémentation principale
+│   ├── types.ts          ← Types exportés
+│   ├── index.ts          ← Point d'entrée
+│   └── lua/
+│       ├── delete-by-tag.lua     ← Script Lua atomique (référence)
+│       └── delete-by-prefix.lua  ← Script Lua (référence)
+```

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@teamvelix/cache-redis",
+  "version": "0.1.0",
+  "description": "Redis cache adapter for Velix — implements ICacheAdapter via ioredis",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "velix",
+    "cache",
+    "redis",
+    "ioredis"
+  ],
+  "author": "velixteam",
+  "license": "MIT",
+  "peerDependencies": {
+    "ioredis": ">=5.0.0"
+  },
+  "devDependencies": {
+    "ioredis": "^5.11.1",
+    "ioredis-mock": "^8.9.0",
+    "tsup": "^8.3.6",
+    "typescript": "^5.4.5",
+    "vitest": "^2.1.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}