@commandkit/redis 0.1.0

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2024 Avraj Sahota
+
+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.
+
+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,24 @@
+# `@commandkit/redis`
+
+Redis cache provider for CommandKit.
+
+## Installation
+
+```sh
+npm install @commandkit/redis
+```
+
+## Usage
+
+```js
+import { CommandKit } from 'commandkit';
+import { RedisCache } from '@commandkit/redis';
+
+new CommandKit({
+  client,
+  commandsPath,
+  eventsPath,
+  // uses default redis connection options (ioredis package)
+  cacheProvider: new RedisCache(),
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+import { Redis, type RedisOptions } from 'ioredis';
+import { CacheProvider } from 'commandkit';
+export type Awaitable<T> = T | Promise<T>;
+export type SerializeFunction = (value: any) => Awaitable<string>;
+export type DeserializeFunction = (value: string) => Awaitable<any>;
+/**
+ * A cache provider that uses Redis as the cache store.
+ * @example const redisCache = new RedisCache();
+ * new CommandKit({
+ *  ...
+ *  cacheProvider: redisCache,
+ * });
+ */
+export declare class RedisCache extends CacheProvider {
+    protected redis: Redis;
+    /**
+     * Serialize function used to serialize values before storing them in the cache.
+     * By default, it uses `JSON.stringify`.
+     */
+    serialize: SerializeFunction;
+    /**
+     * Deserialize function used to deserialize values before returning them from the cache.
+     * By default, it uses `JSON.parse`.
+     */
+    deserialize: DeserializeFunction;
+    /**
+     * Create a new RedisCache instance.
+     */
+    constructor();
+    /**
+     * Create a new RedisCache instance with the provided Redis client.
+     * @param redis The Redis client to use.
+     */
+    constructor(redis: Redis);
+    /**
+     * Create a new RedisCache instance with the provided Redis options.
+     * @param redis The Redis client to use.
+     */
+    constructor(redis: RedisOptions);
+    /**
+     * Retrieve a value from the cache.
+     * @param key The key to retrieve the value for.
+     * @returns The value stored in the cache, or `undefined` if it does not exist.
+     */
+    get<T>(key: string): Promise<T | undefined>;
+    /**
+     * Store a value in the cache.
+     * @param key The key to store the value under.
+     * @param value The value to store in the cache.
+     * @param ttl The time-to-live for the cache entry in milliseconds.
+     */
+    set<T>(key: string, value: T, ttl?: number): Promise<void>;
+    /**
+     * Clear all entries from the cache.
+     */
+    clear(): Promise<void>;
+    /**
+     * Delete a value from the cache.
+     * @param key The key to delete the value for.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Check if a value exists in the cache.
+     * @param key The key to check for.
+     * @returns True if the key exists in the cache, false otherwise.
+     */
+    exists(key: string): Promise<boolean>;
+    /**
+     * Set the time-to-live for a cache entry.
+     * @param key The key to set the time-to-live for.
+     * @param ttl The time-to-live value in milliseconds.
+     */
+    expire(key: string, ttl: number): Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCache = void 0;
+const ioredis_1 = require("ioredis");
+const commandkit_1 = require("commandkit");
+/**
+ * A cache provider that uses Redis as the cache store.
+ * @example const redisCache = new RedisCache();
+ * new CommandKit({
+ *  ...
+ *  cacheProvider: redisCache,
+ * });
+ */
+class RedisCache extends commandkit_1.CacheProvider {
+    constructor(redis) {
+        super();
+        if (redis instanceof ioredis_1.Redis) {
+            this.redis = redis;
+        }
+        else {
+            this.redis = new ioredis_1.Redis(redis ?? {});
+        }
+        this.serialize = JSON.stringify;
+        this.deserialize = JSON.parse;
+    }
+    /**
+     * Retrieve a value from the cache.
+     * @param key The key to retrieve the value for.
+     * @returns The value stored in the cache, or `undefined` if it does not exist.
+     */
+    async get(key) {
+        const value = await this.redis.get(key);
+        if (value === null) {
+            return undefined;
+        }
+        return JSON.parse(value);
+    }
+    /**
+     * Store a value in the cache.
+     * @param key The key to store the value under.
+     * @param value The value to store in the cache.
+     * @param ttl The time-to-live for the cache entry in milliseconds.
+     */
+    async set(key, value, ttl) {
+        const serialized = await this.serialize(value);
+        if (typeof ttl === 'number') {
+            await this.redis.set(key, serialized, 'PX', ttl);
+        }
+        else {
+            await this.redis.set(key, serialized);
+        }
+    }
+    /**
+     * Clear all entries from the cache.
+     */
+    async clear() {
+        await this.redis.flushall();
+    }
+    /**
+     * Delete a value from the cache.
+     * @param key The key to delete the value for.
+     */
+    async delete(key) {
+        await this.redis.del(key);
+    }
+    /**
+     * Check if a value exists in the cache.
+     * @param key The key to check for.
+     * @returns True if the key exists in the cache, false otherwise.
+     */
+    async exists(key) {
+        return Boolean(await this.redis.exists(key));
+    }
+    /**
+     * Set the time-to-live for a cache entry.
+     * @param key The key to set the time-to-live for.
+     * @param ttl The time-to-live value in milliseconds.
+     */
+    async expire(key, ttl) {
+        await this.redis.pexpire(key, ttl);
+    }
+}
+exports.RedisCache = RedisCache;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUNBQW1EO0FBQ25ELDJDQUEyQztBQU0zQzs7Ozs7OztHQU9HO0FBQ0gsTUFBYSxVQUFXLFNBQVEsMEJBQWE7SUE2QjNDLFlBQW1CLEtBQTRCO1FBQzdDLEtBQUssRUFBRSxDQUFDO1FBRVIsSUFBSSxLQUFLLFlBQVksZUFBSyxFQUFFLENBQUM7WUFDM0IsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7UUFDckIsQ0FBQzthQUFNLENBQUM7WUFDTixJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksZUFBSyxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUMsQ0FBQztRQUN0QyxDQUFDO1FBRUQsSUFBSSxDQUFDLFNBQVMsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDO1FBQ2hDLElBQUksQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNoQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLEtBQUssQ0FBQyxHQUFHLENBQUksR0FBVztRQUM3QixNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBRXhDLElBQUksS0FBSyxLQUFLLElBQUksRUFBRSxDQUFDO1lBQ25CLE9BQU8sU0FBUyxDQUFDO1FBQ25CLENBQUM7UUFFRCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFNLENBQUM7SUFDaEMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksS0FBSyxDQUFDLEdBQUcsQ0FBSSxHQUFXLEVBQUUsS0FBUSxFQUFFLEdBQVk7UUFDckQsTUFBTSxVQUFVLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBRS9DLElBQUksT0FBTyxHQUFHLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDNUIsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsVUFBVSxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQztRQUNuRCxDQUFDO2FBQU0sQ0FBQztZQUNOLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBQ3hDLENBQUM7SUFDSCxDQUFDO0lBRUQ7O09BRUc7SUFDSSxLQUFLLENBQUMsS0FBSztRQUNoQixNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDOUIsQ0FBQztJQUVEOzs7T0FHRztJQUNJLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBVztRQUM3QixNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksS0FBSyxDQUFDLE1BQU0sQ0FBQyxHQUFXO1FBQzdCLE9BQU8sT0FBTyxDQUFDLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUMvQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBVyxFQUFFLEdBQVc7UUFDMUMsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDckMsQ0FBQztDQUNGO0FBekdELGdDQXlHQyJ9

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@commandkit/redis",
+  "version": "0.1.0",
+  "description": "Redis cache provider for CommandKit",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/underctrl-io/commandkit.git"
+  },
+  "keywords": [
+    "commandkit",
+    "redis",
+    "cache"
+  ],
+  "author": "twilight <hello@twlite.dev>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/underctrl-io/commandkit/issues"
+  },
+  "homepage": "https://github.com/underctrl-io/commandkit#readme",
+  "dependencies": {
+    "ioredis": "^5.4.2"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "commandkit": "0.1.11",
+    "tsconfig": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsc"
+  }
+}