@payloadcms/kv-redis 0.0.1-beta.0

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2024 Payload CMS, Inc. <info@payloadcms.com>
+
+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,33 @@
+# Redis KV Adapter for Payload (beta)
+
+This package provides a way to use [Redis](https://redis.io) as a KV adapter with Payload.
+
+## Installation
+
+```sh
+pnpm add @payloadcms/kv-redis
+```
+
+## Usage
+
+```ts
+import { redisKVAdapter } from '@payloadcms/kv-redis'
+
+export default buildConfig({
+  collections: [Media],
+  kv: redisKVAdapter({
+    // Redis connection URL. Defaults to process.env.REDIS_URL
+    redisURL: 'redis://localhost:6379',
+    // Optional prefix for Redis keys to isolate the store. Defaults to 'payload-kv'
+    keyPrefix: 'kv-storage',
+  }),
+})
+```
+
+Then you can access the KV storage using `payload.kv`:
+
+```ts
+await payload.kv.set('key', { value: 1 })
+const data = await payload.kv.get('key')
+payload.logger.info(data)
+```

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { KVAdapter, KVAdapterResult, KVStoreValue } from 'payload';
+import { Redis } from 'ioredis';
+export declare class RedisKVAdapter implements KVAdapter {
+    readonly keyPrefix: string;
+    redisClient: Redis;
+    constructor(keyPrefix: string, redisURL: string);
+    clear(): Promise<void>;
+    delete(key: string): Promise<void>;
+    get(key: string): Promise<KVStoreValue | null>;
+    has(key: string): Promise<boolean>;
+    keys(): Promise<string[]>;
+    set(key: string, data: KVStoreValue): Promise<void>;
+}
+export type RedisKVAdapterOptions = {
+    /**
+     * Optional prefix for Redis keys to isolate the store
+     *
+     * @default 'payload-kv:'
+     */
+    keyPrefix?: string;
+    /** Redis connection URL (e.g., 'redis://localhost:6379'). Defaults to process.env.REDIS_URL */
+    redisURL?: string;
+};
+export declare const redisKVAdapter: (options?: RedisKVAdapterOptions) => KVAdapterResult;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEvE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,qBAAa,cAAe,YAAW,SAAS;IAI5C,QAAQ,CAAC,SAAS,EAAE,MAAM;IAH5B,WAAW,EAAE,KAAK,CAAA;gBAGP,SAAS,EAAE,MAAM,EAC1B,QAAQ,EAAE,MAAM;IAKZ,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQtB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAU9C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKlC,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAUzB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1D;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,cAAc,aAAa,qBAAqB,KAAQ,eAWpE,CAAA"}

package/dist/index.js

@@ -0,0 +1,51 @@
+import { Redis } from 'ioredis';
+export class RedisKVAdapter {
+    keyPrefix;
+    redisClient;
+    constructor(keyPrefix, redisURL){
+        this.keyPrefix = keyPrefix;
+        this.redisClient = new Redis(redisURL);
+    }
+    async clear() {
+        const keys = await this.redisClient.keys(`${this.keyPrefix}*`);
+        if (keys.length > 0) {
+            await this.redisClient.del(keys);
+        }
+    }
+    async delete(key) {
+        await this.redisClient.del(`${this.keyPrefix}${key}`);
+    }
+    async get(key) {
+        const data = await this.redisClient.get(`${this.keyPrefix}${key}`);
+        if (data === null) {
+            return data;
+        }
+        return JSON.parse(data);
+    }
+    async has(key) {
+        const exists = await this.redisClient.exists(`${this.keyPrefix}${key}`);
+        return exists === 1;
+    }
+    async keys() {
+        const prefixedKeys = await this.redisClient.keys(`${this.keyPrefix}*`);
+        if (this.keyPrefix) {
+            return prefixedKeys.map((key)=>key.replace(this.keyPrefix, ''));
+        }
+        return prefixedKeys;
+    }
+    async set(key, data) {
+        await this.redisClient.set(`${this.keyPrefix}${key}`, JSON.stringify(data));
+    }
+}
+export const redisKVAdapter = (options = {})=>{
+    const keyPrefix = options.keyPrefix ?? 'payload-kv:';
+    const redisURL = options.redisURL ?? process.env.REDIS_URL;
+    if (!redisURL) {
+        throw new Error('redisURL or REDIS_URL env variable is required');
+    }
+    return {
+        init: ()=>new RedisKVAdapter(keyPrefix, redisURL)
+    };
+};
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { KVAdapter, KVAdapterResult, KVStoreValue } from 'payload'\n\nimport { Redis } from 'ioredis'\n\nexport class RedisKVAdapter implements KVAdapter {\n  redisClient: Redis\n\n  constructor(\n    readonly keyPrefix: string,\n    redisURL: string,\n  ) {\n    this.redisClient = new Redis(redisURL)\n  }\n\n  async clear(): Promise<void> {\n    const keys = await this.redisClient.keys(`${this.keyPrefix}*`)\n\n    if (keys.length > 0) {\n      await this.redisClient.del(keys)\n    }\n  }\n\n  async delete(key: string): Promise<void> {\n    await this.redisClient.del(`${this.keyPrefix}${key}`)\n  }\n\n  async get(key: string): Promise<KVStoreValue | null> {\n    const data = await this.redisClient.get(`${this.keyPrefix}${key}`)\n\n    if (data === null) {\n      return data\n    }\n\n    return JSON.parse(data)\n  }\n\n  async has(key: string): Promise<boolean> {\n    const exists = await this.redisClient.exists(`${this.keyPrefix}${key}`)\n    return exists === 1\n  }\n\n  async keys(): Promise<string[]> {\n    const prefixedKeys = await this.redisClient.keys(`${this.keyPrefix}*`)\n\n    if (this.keyPrefix) {\n      return prefixedKeys.map((key) => key.replace(this.keyPrefix, ''))\n    }\n\n    return prefixedKeys\n  }\n\n  async set(key: string, data: KVStoreValue): Promise<void> {\n    await this.redisClient.set(`${this.keyPrefix}${key}`, JSON.stringify(data))\n  }\n}\n\nexport type RedisKVAdapterOptions = {\n  /**\n   * Optional prefix for Redis keys to isolate the store\n   *\n   * @default 'payload-kv:'\n   */\n  keyPrefix?: string\n  /** Redis connection URL (e.g., 'redis://localhost:6379'). Defaults to process.env.REDIS_URL */\n  redisURL?: string\n}\n\nexport const redisKVAdapter = (options: RedisKVAdapterOptions = {}): KVAdapterResult => {\n  const keyPrefix = options.keyPrefix ?? 'payload-kv:'\n  const redisURL = options.redisURL ?? process.env.REDIS_URL\n\n  if (!redisURL) {\n    throw new Error('redisURL or REDIS_URL env variable is required')\n  }\n\n  return {\n    init: () => new RedisKVAdapter(keyPrefix, redisURL),\n  }\n}\n"],"names":["Redis","RedisKVAdapter","redisClient","constructor","keyPrefix","redisURL","clear","keys","length","del","delete","key","get","data","JSON","parse","has","exists","prefixedKeys","map","replace","set","stringify","redisKVAdapter","options","process","env","REDIS_URL","Error","init"],"mappings":"AAEA,SAASA,KAAK,QAAQ,UAAS;AAE/B,OAAO,MAAMC;;IACXC,YAAkB;IAElBC,YACE,AAASC,SAAiB,EAC1BC,QAAgB,CAChB;aAFSD,YAAAA;QAGT,IAAI,CAACF,WAAW,GAAG,IAAIF,MAAMK;IAC/B;IAEA,MAAMC,QAAuB;QAC3B,MAAMC,OAAO,MAAM,IAAI,CAACL,WAAW,CAACK,IAAI,CAAC,GAAG,IAAI,CAACH,SAAS,CAAC,CAAC,CAAC;QAE7D,IAAIG,KAAKC,MAAM,GAAG,GAAG;YACnB,MAAM,IAAI,CAACN,WAAW,CAACO,GAAG,CAACF;QAC7B;IACF;IAEA,MAAMG,OAAOC,GAAW,EAAiB;QACvC,MAAM,IAAI,CAACT,WAAW,CAACO,GAAG,CAAC,GAAG,IAAI,CAACL,SAAS,GAAGO,KAAK;IACtD;IAEA,MAAMC,IAAID,GAAW,EAAgC;QACnD,MAAME,OAAO,MAAM,IAAI,CAACX,WAAW,CAACU,GAAG,CAAC,GAAG,IAAI,CAACR,SAAS,GAAGO,KAAK;QAEjE,IAAIE,SAAS,MAAM;YACjB,OAAOA;QACT;QAEA,OAAOC,KAAKC,KAAK,CAACF;IACpB;IAEA,MAAMG,IAAIL,GAAW,EAAoB;QACvC,MAAMM,SAAS,MAAM,IAAI,CAACf,WAAW,CAACe,MAAM,CAAC,GAAG,IAAI,CAACb,SAAS,GAAGO,KAAK;QACtE,OAAOM,WAAW;IACpB;IAEA,MAAMV,OAA0B;QAC9B,MAAMW,eAAe,MAAM,IAAI,CAAChB,WAAW,CAACK,IAAI,CAAC,GAAG,IAAI,CAACH,SAAS,CAAC,CAAC,CAAC;QAErE,IAAI,IAAI,CAACA,SAAS,EAAE;YAClB,OAAOc,aAAaC,GAAG,CAAC,CAACR,MAAQA,IAAIS,OAAO,CAAC,IAAI,CAAChB,SAAS,EAAE;QAC/D;QAEA,OAAOc;IACT;IAEA,MAAMG,IAAIV,GAAW,EAAEE,IAAkB,EAAiB;QACxD,MAAM,IAAI,CAACX,WAAW,CAACmB,GAAG,CAAC,GAAG,IAAI,CAACjB,SAAS,GAAGO,KAAK,EAAEG,KAAKQ,SAAS,CAACT;IACvE;AACF;AAaA,OAAO,MAAMU,iBAAiB,CAACC,UAAiC,CAAC,CAAC;IAChE,MAAMpB,YAAYoB,QAAQpB,SAAS,IAAI;IACvC,MAAMC,WAAWmB,QAAQnB,QAAQ,IAAIoB,QAAQC,GAAG,CAACC,SAAS;IAE1D,IAAI,CAACtB,UAAU;QACb,MAAM,IAAIuB,MAAM;IAClB;IAEA,OAAO;QACLC,MAAM,IAAM,IAAI5B,eAAeG,WAAWC;IAC5C;AACF,EAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@payloadcms/kv-redis",
+  "version": "0.0.1-beta.0",
+  "description": "Redis KV adapter for Payload",
+  "homepage": "https://payloadcms.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/kv-redis"
+  },
+  "license": "MIT",
+  "author": "Payload <dev@payloadcms.com> (https://payloadcms.com)",
+  "maintainers": [
+    {
+      "name": "Payload",
+      "email": "info@payloadcms.com",
+      "url": "https://payloadcms.com"
+    }
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "ioredis": "^5.4.1"
+  },
+  "devDependencies": {
+    "payload": "3.61.1"
+  },
+  "peerDependencies": {
+    "payload": "3.61.1"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0"
+  },
+  "scripts": {
+    "build": "pnpm build:types && pnpm build:swc",
+    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "clean": "rimraf {dist,*.tsbuildinfo}",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}