@commandkit/redis 0.1.0 → 0.1.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2024 Avraj Sahota
+Copyright 2025 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.
 

package/README.md

@@ -10,15 +10,25 @@ npm install @commandkit/redis
 
 ## Usage
 
+This package provides a commandkit plugin that automatically registers the cache provider with the commandkit instance.
+
 ```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(),
+import { redis } from '@commandkit/redis';
+
+export default defineConfig({
+  plugins: [redis()],
 });
+```
+
+Now the cache functions such as the following will be cached in Redis:
+
+```ts
+async function getCachedData() {
+  'use cache';
+
+  // imaginary database function
+  const data = await getFromDatabase('something');
+
+  return data;
+}
 ```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Redis, type RedisOptions } from 'ioredis';
-import { CacheProvider } from 'commandkit';
+import { CacheProvider, CommandKitPluginRuntime, RuntimePlugin } from 'commandkit';
 export type Awaitable<T> = T | Promise<T>;
 export type SerializeFunction = (value: any) => Awaitable<string>;
 export type DeserializeFunction = (value: string) => Awaitable<any>;
@@ -72,3 +72,8 @@ export declare class RedisCache extends CacheProvider {
      */
     expire(key: string, ttl: number): Promise<void>;
 }
+export declare class RedisPlugin extends RuntimePlugin<RedisOptions> {
+    readonly name = "RedisPlugin";
+    activate(ctx: CommandKitPluginRuntime): Promise<void>;
+}
+export declare function redis(options?: RedisOptions): RedisPlugin;

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisCache = void 0;
+exports.RedisPlugin = exports.RedisCache = void 0;
+exports.redis = redis;
 const ioredis_1 = require("ioredis");
 const commandkit_1 = require("commandkit");
 /**
@@ -81,4 +82,17 @@ class RedisCache extends commandkit_1.CacheProvider {
     }
 }
 exports.RedisCache = RedisCache;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUNBQW1EO0FBQ25ELDJDQUEyQztBQU0zQzs7Ozs7OztHQU9HO0FBQ0gsTUFBYSxVQUFXLFNBQVEsMEJBQWE7SUE2QjNDLFlBQW1CLEtBQTRCO1FBQzdDLEtBQUssRUFBRSxDQUFDO1FBRVIsSUFBSSxLQUFLLFlBQVksZUFBSyxFQUFFLENBQUM7WUFDM0IsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7UUFDckIsQ0FBQzthQUFNLENBQUM7WUFDTixJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksZUFBSyxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUMsQ0FBQztRQUN0QyxDQUFDO1FBRUQsSUFBSSxDQUFDLFNBQVMsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDO1FBQ2hDLElBQUksQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNoQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLEtBQUssQ0FBQyxHQUFHLENBQUksR0FBVztRQUM3QixNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBRXhDLElBQUksS0FBSyxLQUFLLElBQUksRUFBRSxDQUFDO1lBQ25CLE9BQU8sU0FBUyxDQUFDO1FBQ25CLENBQUM7UUFFRCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFNLENBQUM7SUFDaEMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksS0FBSyxDQUFDLEdBQUcsQ0FBSSxHQUFXLEVBQUUsS0FBUSxFQUFFLEdBQVk7UUFDckQsTUFBTSxVQUFVLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBRS9DLElBQUksT0FBTyxHQUFHLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDNUIsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsVUFBVSxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQztRQUNuRCxDQUFDO2FBQU0sQ0FBQztZQUNOLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBQ3hDLENBQUM7SUFDSCxDQUFDO0lBRUQ7O09BRUc7SUFDSSxLQUFLLENBQUMsS0FBSztRQUNoQixNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDOUIsQ0FBQztJQUVEOzs7T0FHRztJQUNJLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBVztRQUM3QixNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksS0FBSyxDQUFDLE1BQU0sQ0FBQyxHQUFXO1FBQzdCLE9BQU8sT0FBTyxDQUFDLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUMvQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBVyxFQUFFLEdBQVc7UUFDMUMsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDckMsQ0FBQztDQUNGO0FBekdELGdDQXlHQyJ9
+class RedisPlugin extends commandkit_1.RuntimePlugin {
+    constructor() {
+        super(...arguments);
+        this.name = 'RedisPlugin';
+    }
+    async activate(ctx) {
+        ctx.commandkit.setCacheProvider(new RedisCache(this.options));
+    }
+}
+exports.RedisPlugin = RedisPlugin;
+function redis(options) {
+    return new RedisPlugin(options ?? {});
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBc0lBLHNCQUVDO0FBeElELHFDQUFtRDtBQUNuRCwyQ0FJb0I7QUFNcEI7Ozs7Ozs7R0FPRztBQUNILE1BQWEsVUFBVyxTQUFRLDBCQUFhO0lBNkIzQyxZQUFtQixLQUE0QjtRQUM3QyxLQUFLLEVBQUUsQ0FBQztRQUVSLElBQUksS0FBSyxZQUFZLGVBQUssRUFBRSxDQUFDO1lBQzNCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO1FBQ3JCLENBQUM7YUFBTSxDQUFDO1lBQ04sSUFBSSxDQUFDLEtBQUssR0FBRyxJQUFJLGVBQUssQ0FBQyxLQUFLLElBQUksRUFBRSxDQUFDLENBQUM7UUFDdEMsQ0FBQztRQUVELElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQztRQUNoQyxJQUFJLENBQUMsV0FBVyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUM7SUFDaEMsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxLQUFLLENBQUMsR0FBRyxDQUFJLEdBQVc7UUFDN0IsTUFBTSxLQUFLLEdBQUcsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUV4QyxJQUFJLEtBQUssS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUNuQixPQUFPLFNBQVMsQ0FBQztRQUNuQixDQUFDO1FBRUQsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBTSxDQUFDO0lBQ2hDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLEtBQUssQ0FBQyxHQUFHLENBQUksR0FBVyxFQUFFLEtBQVEsRUFBRSxHQUFZO1FBQ3JELE1BQU0sVUFBVSxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUUvQyxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQzVCLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLFVBQVUsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUM7UUFDbkQsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsQ0FBQztRQUN4QyxDQUFDO0lBQ0gsQ0FBQztJQUVEOztPQUVHO0lBQ0ksS0FBSyxDQUFDLEtBQUs7UUFDaEIsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBQzlCLENBQUM7SUFFRDs7O09BR0c7SUFDSSxLQUFLLENBQUMsTUFBTSxDQUFDLEdBQVc7UUFDN0IsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUM1QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLEtBQUssQ0FBQyxNQUFNLENBQUMsR0FBVztRQUM3QixPQUFPLE9BQU8sQ0FBQyxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7SUFDL0MsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxLQUFLLENBQUMsTUFBTSxDQUFDLEdBQVcsRUFBRSxHQUFXO1FBQzFDLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ3JDLENBQUM7Q0FDRjtBQXpHRCxnQ0F5R0M7QUFFRCxNQUFhLFdBQVksU0FBUSwwQkFBMkI7SUFBNUQ7O1FBQ2tCLFNBQUksR0FBRyxhQUFhLENBQUM7SUFLdkMsQ0FBQztJQUhRLEtBQUssQ0FBQyxRQUFRLENBQUMsR0FBNEI7UUFDaEQsR0FBRyxDQUFDLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLFVBQVUsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUNoRSxDQUFDO0NBQ0Y7QUFORCxrQ0FNQztBQUVELFNBQWdCLEtBQUssQ0FBQyxPQUFzQjtJQUMxQyxPQUFPLElBQUksV0FBVyxDQUFDLE9BQU8sSUFBSSxFQUFFLENBQUMsQ0FBQztBQUN4QyxDQUFDIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commandkit/redis",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Redis cache provider for CommandKit",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,10 +27,11 @@
   },
   "devDependencies": {
     "typescript": "^5.7.3",
-    "commandkit": "0.1.11",
-    "tsconfig": "0.0.0"
+    "tsconfig": "0.0.0",
+    "commandkit": "0.1.11"
   },
   "scripts": {
+    "lint": "tsc --noEmit",
     "build": "tsc"
   }
 }