@node-ts-cache/redis-storage 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Himmet Avsar
+
+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,99 @@
+# @node-ts-cache/redis-storage
+
+[![npm](https://img.shields.io/npm/v/@node-ts-cache/redis-storage.svg)](https://www.npmjs.org/package/@node-ts-cache/redis-storage)
+
+Redis storage adapter for [@node-ts-cache/core](https://www.npmjs.com/package/@node-ts-cache/core) using the legacy `redis` package (v3.x).
+
+> **Note:** For new projects, consider using [@node-ts-cache/ioredis-storage](https://www.npmjs.com/package/@node-ts-cache/ioredis-storage) which uses the modern `ioredis` client with additional features like compression and multi-operations.
+
+## Installation
+
+```bash
+npm install @node-ts-cache/core @node-ts-cache/redis-storage
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { Cache, ExpirationStrategy } from '@node-ts-cache/core';
+import RedisStorage from '@node-ts-cache/redis-storage';
+
+const storage = new RedisStorage({
+	host: 'localhost',
+	port: 6379
+});
+
+const strategy = new ExpirationStrategy(storage);
+
+class UserService {
+	@Cache(strategy, { ttl: 300 })
+	async getUser(id: string): Promise<User> {
+		return await db.users.findById(id);
+	}
+}
+```
+
+### With Authentication
+
+```typescript
+const storage = new RedisStorage({
+	host: 'redis.example.com',
+	port: 6379,
+	password: 'your-password',
+	db: 0
+});
+```
+
+### Direct API Usage
+
+```typescript
+const storage = new RedisStorage({ host: 'localhost', port: 6379 });
+const strategy = new ExpirationStrategy(storage);
+
+// Store a value
+await strategy.setItem('user:123', { name: 'John' }, { ttl: 60 });
+
+// Retrieve a value
+const user = await strategy.getItem<{ name: string }>('user:123');
+
+// Clear all cached items
+await strategy.clear();
+```
+
+## Constructor Options
+
+The constructor accepts [RedisClientOptions](https://github.com/redis/node-redis/tree/v3.1.2#options-object-properties) from the `redis` package:
+
+| Option     | Type     | Default       | Description                     |
+| ---------- | -------- | ------------- | ------------------------------- |
+| `host`     | `string` | `"127.0.0.1"` | Redis server hostname           |
+| `port`     | `number` | `6379`        | Redis server port               |
+| `password` | `string` | -             | Redis authentication password   |
+| `db`       | `number` | `0`           | Redis database number           |
+| `url`      | `string` | -             | Redis URL (overrides host/port) |
+
+## Interface
+
+```typescript
+interface IAsynchronousCacheType {
+	getItem<T>(key: string): Promise<T | undefined>;
+	setItem(key: string, content: any, options?: any): Promise<void>;
+	clear(): Promise<void>;
+}
+```
+
+## Dependencies
+
+- `redis` ^3.1.2 - Redis client for Node.js
+- `bluebird` 3.7.2 - Promise library for async operations
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Redis server
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { RedisStorage } from './redis.storage.js';
+export default RedisStorage;

package/dist/index.js

@@ -0,0 +1,3 @@
+import { RedisStorage } from './redis.storage.js';
+export default RedisStorage;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,eAAe,YAAY,CAAC"}

package/dist/redis.storage.d.ts

@@ -0,0 +1,11 @@
+import { IAsynchronousCacheType } from '@node-ts-cache/core';
+import * as Redis from 'redis';
+import { ClientOpts } from 'redis';
+export declare class RedisStorage implements IAsynchronousCacheType {
+    private redisOptions;
+    private client;
+    constructor(redisOptions: ClientOpts, redis?: typeof Redis);
+    getItem<T>(key: string): Promise<T | undefined>;
+    setItem<T = unknown>(key: string, content: T | undefined): Promise<void>;
+    clear(): Promise<void>;
+}

package/dist/redis.storage.js

@@ -0,0 +1,37 @@
+import Bluebird from 'bluebird';
+import * as Redis from 'redis';
+Bluebird.promisifyAll(Redis.RedisClient.prototype);
+Bluebird.promisifyAll(Redis.Multi.prototype);
+export class RedisStorage {
+    constructor(redisOptions, redis = Redis) {
+        this.redisOptions = redisOptions;
+        this.client = redis.createClient(this.redisOptions);
+    }
+    async getItem(key) {
+        const entry = await this.client.getAsync(key);
+        if (entry === null) {
+            return undefined;
+        }
+        // Try to parse as JSON, fallback to raw string
+        let parsedItem = entry;
+        try {
+            parsedItem = JSON.parse(entry);
+        }
+        catch (error) {
+            /** Not JSON, keep as string */
+        }
+        return parsedItem;
+    }
+    async setItem(key, content) {
+        if (content === undefined) {
+            await this.client.delAsync(key);
+            return;
+        }
+        const stringContent = typeof content === 'object' ? JSON.stringify(content) : String(content);
+        await this.client.setAsync(key, stringContent);
+    }
+    async clear() {
+        await this.client.flushdbAsync();
+    }
+}
+//# sourceMappingURL=redis.storage.js.map

package/dist/redis.storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.storage.js","sourceRoot":"","sources":["../src/redis.storage.ts"],"names":[],"mappings":"AAEA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;AACnD,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAE7C,MAAM,OAAO,YAAY;IAGxB,YAAoB,YAAwB,EAAE,KAAK,GAAG,KAAK;QAAvC,iBAAY,GAAZ,YAAY,CAAY;QAC3C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAiB,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,OAAO,CAAI,GAAW;QAClC,MAAM,KAAK,GAAkB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC7D,IAAI,KAAK,KAAK,IAAI,EAAE;YACnB,OAAO,SAAS,CAAC;SACjB;QACD,+CAA+C;QAC/C,IAAI,UAAU,GAAe,KAAK,CAAC;QACnC,IAAI;YACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAC;SACpC;QAAC,OAAO,KAAK,EAAE;YACf,+BAA+B;SAC/B;QACD,OAAO,UAA2B,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,OAAO,CAAc,GAAW,EAAE,OAAsB;QACpE,IAAI,OAAO,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAChC,OAAO;SACP;QACD,MAAM,aAAa,GAClB,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;IAClC,CAAC;CACD"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@node-ts-cache/redis-storage",
+  "version": "1.0.0",
+  "description": "Simple and extensible caching module supporting decorators",
+  "keywords": [
+    "node",
+    "nodejs",
+    "cache",
+    "typescript",
+    "ts",
+    "caching",
+    "memcache",
+    "memory-cache",
+    "redis-cache",
+    "redis",
+    "file-cache",
+    "node-cache",
+    "ts-cache"
+  ],
+  "homepage": "https://github.com/simllll/node-ts-cache/tree/master/storages/redis#readme",
+  "bugs": {
+    "url": "https://github.com/simllll/node-ts-cache/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/simllll/node-ts-cache.git"
+  },
+  "license": "MIT",
+  "author": "Simon Tretter <s.tretter@gmail.com>",
+  "contributors": [
+    "Himmet Avsar <avsar.himmet1@gmail.com>"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "bluebird": "3.7.2",
+    "redis": "^3.1.2",
+    "@node-ts-cache/core": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/bluebird": "^3.5.36",
+    "@types/proxyquire": "1.3.28",
+    "@types/redis": "^2.8.32",
+    "@types/sinon": "10.0.6",
+    "redis-mock": "^0.56.0",
+    "sinon": "12.0.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "c938eba762060f940a34bc192bec03bc76ea4017",
+  "scripts": {
+    "build": "tsc -p .",
+    "clean": "git clean -fdx src",
+    "dev": "tsc -p . -w",
+    "tdd": "mocha --loader=ts-node/esm -w",
+    "tdd-debug-brk": "mocha --loader=ts-node/esm --inspect-brk",
+    "test": "mocha --loader=ts-node/esm test/**/*.test.ts"
+  }
+}