@resolid/cache-redis 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, Resolid Tech
+
+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,43 @@
+# Redis Cache store for @resolid/cache
+
+![GitHub License](https://img.shields.io/github/license/resolid/framework)
+![NPM Version](https://img.shields.io/npm/v/%40resolid/cache-redis)
+
+<b>[Documentation](https://www.resolid.tech/docs/cache)</b> | [Framework Bundle](https://github.com/resolid/framework)
+
+Redis store for @resolid/cache
+
+## Features
+
+- Built on top of @redis/client.
+- TTL is handled directly by Redis.
+- Supports Redis Clusters.
+- Url connection string support or pass in your Redis Options
+
+## Installation
+
+```shell
+pnpm add @resolid/cache @resolid/cache-redis
+# or
+npm install @resolid/cache @resolid/cache-redis
+# or
+yarn add @resolid/cache @resolid/cache-redis
+# or
+bun add @resolid/cache @resolid/cache-redis
+```
+
+## Usage
+
+```ts
+import { Cacher } from "@resolid/cache";
+import { RedisCache } from "@resolid/cache-redis";
+
+const cache = new Cacher({
+  store: new RedisCache("redis://user:pass@localhost:6379"),
+  defaultTtl: 1000,
+});
+```
+
+## License
+
+MIT License (MIT). Please see [LICENSE](./LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,34 @@
+import { RedisClientOptions, RedisClusterOptions, RedisSentinelOptions } from "@redis/client";
+import { CacheStore } from "@resolid/cache/stores";
+
+//#region src/index.d.ts
+type RedisCacheOptions = {
+  namespace?: string;
+  connectionTimeout?: number | null;
+  clearBatchSize?: number;
+  forceClose?: boolean;
+};
+declare class RedisCache implements CacheStore {
+  private readonly _client;
+  private readonly _options;
+  private readonly _isCluster;
+  private _connectPromise?;
+  constructor(connect?: string | RedisClientOptions | RedisClusterOptions | RedisSentinelOptions, options?: RedisCacheOptions);
+  private _resolve;
+  private _connect;
+  private _getClient;
+  private _getMasterNodes;
+  private _getSlotMap;
+  private _getSlotMaster;
+  has(key: string): Promise<boolean>;
+  get(key: string): Promise<string | undefined>;
+  getMultiple(keys: string[]): Promise<(string | undefined)[]>;
+  set(key: string, value: string, ttl?: number): Promise<boolean>;
+  setMultiple(values: Record<string, string>, ttl?: number): Promise<boolean>;
+  del(key: string): Promise<boolean>;
+  delMultiple(keys: string[]): Promise<boolean>;
+  clear(): Promise<boolean>;
+  dispose(): Promise<void>;
+}
+//#endregion
+export { RedisCache, RedisCacheOptions };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{createClient as e,createCluster as t,createSentinel as n}from"@redis/client";import r from"cluster-key-slot";var i=class{_client;_options;_isCluster=!1;_connectPromise;constructor(r,i){let a={reconnectStrategy:e=>Math.min(2**e*100,2e3)+(Math.random()-.5)*100};r&&typeof r==`object`?`sentinelRootNodes`in r?this._client=n(r):`rootNodes`in r?(this._client=t({...r,defaults:{...r.defaults,socket:{...r.defaults?.socket,...a}}}),this._isCluster=!0):this._client=e({...r,socket:{...r.socket,...a}}):this._client=e({url:r,socket:a}),this._options={namespace:`rs`,forceClose:!1,connectionTimeout:null,clearBatchSize:1e3,...i}}_resolve(e){return`${this._options.namespace}::${e}`}async _connect(){try{if(this._options.connectionTimeout==null)await this._client.connect();else{let e=this._client.connect(),t;try{await Promise.race([e,new Promise((e,n)=>{t=setTimeout(()=>{n(Error(`Redis timed out after ${this._options.connectionTimeout}ms`))},this._options.connectionTimeout)})])}finally{t&&clearTimeout(t)}}}catch(e){throw await this._client.destroy(),e}}async _getClient(){return this._client.isOpen?this._client:(this._connectPromise??=this._connect().finally(()=>{this._connectPromise=void 0}),await this._connectPromise,this._client)}async _getMasterNodes(){let e=await this._getClient();if(this._isCluster){let t=e,n=t.masters.map(async e=>t.nodeClient(e));return Promise.all(n)}return[e]}_getSlotMap(e){let t=new Map;if(this._isCluster)for(let n of e){let e=r(n),i=t.get(e)??[];i.push(n),t.set(e,i)}else t.set(0,e);return t}async _getSlotMaster(e){let t=await this._getClient();if(this._isCluster){let n=t;return await n.nodeClient(n.slots[e].master)}return t}async has(e){let t=await this._getClient();try{return await t.exists(this._resolve(e))===1}catch{return!1}}async get(e){let t=await this._getClient();try{let n=await t.get(this._resolve(e));return n===null?void 0:n}catch{return}}async getMultiple(e){if(e.length===0)return[];let t=e.map(e=>this._resolve(e));try{if(this._isCluster){let e=new Map;return await Promise.all(Array.from(this._getSlotMap(t),async([t,n])=>{let r=await(await this._getSlotMaster(t)).mGet(n);for(let[t,i]of r.entries())e.set(n[t],i??void 0)})),t.map(t=>e.get(t))}return(await(await this._getClient()).mGet(t)).map(e=>e??void 0)}catch{return Array(e.length).fill(void 0)}}async set(e,t,n){let r=await this._getClient();try{return n?await r.set(this._resolve(e),t,{expiration:{type:`PX`,value:n}}):await r.set(this._resolve(e),t),!0}catch{return!1}}async setMultiple(e,t){try{if(this._isCluster){let n=new Map;for(let[t,i]of Object.entries(e)){let e=this._resolve(t),a=r(e),o=n.get(a)??{};o[e]=i,n.set(a,o)}await Promise.all(Array.from(n.entries(),async([e,n])=>{let r=(await this._getSlotMaster(e)).multi();for(let[e,i]of Object.entries(n))t?r.set(e,i,{expiration:{type:`PX`,value:t}}):r.set(e,i);await r.exec()}))}else{let n=(await this._getClient()).multi();for(let[r,i]of Object.entries(e))t?n.set(this._resolve(r),i,{expiration:{type:`PX`,value:t}}):n.set(this._resolve(r),i);await n.exec()}return!0}catch{return!1}}async del(e){let t=await this._getClient();try{return await t.del(this._resolve(e))>0}catch{return!1}}async delMultiple(e){if(e.length===0)return!0;let t=e.map(e=>this._resolve(e));try{return this._isCluster?await Promise.all(Array.from(this._getSlotMap(t),async([e,t])=>{let n=(await this._getSlotMaster(e)).multi();for(let e of t)n.del(e);await n.exec()})):await(await this._getClient()).del(t),!0}catch{return!1}}async clear(){try{let e=await this._getMasterNodes();return await Promise.all(e.map(async e=>{let t=`0`,n=this._options.clearBatchSize,r=this._resolve(`*`);do{let i=await e.scan(t,{MATCH:r,COUNT:n,TYPE:`string`});t=i.cursor.toString(),i.keys.length>0&&await Promise.all(Array.from(this._getSlotMap(i.keys).entries(),async([e,t])=>{await(await this._getSlotMaster(e)).del(t)}))}while(t!==`0`)})),!0}catch{return!1}}async dispose(){this._client.isOpen&&(this._options.forceClose?await this._client.destroy():await this._client.close())}};export{i as RedisCache};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@resolid/cache-redis",
+  "version": "1.0.0",
+  "private": false,
+  "description": "Redis Cache store for @resolid/cache",
+  "keywords": [
+    "cache",
+    "cache manager",
+    "redis",
+    "resolid"
+  ],
+  "homepage": "https://www.resolid.tech",
+  "license": "MIT",
+  "author": {
+    "name": "Huijie Wei",
+    "email": "hello@resolid.tech"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/resolid/framework.git",
+    "directory": "packages/cache-redis"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "oxlint",
+    "test": "vitest run --reporter=hanging-process",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@redis/client": "^5.12.1",
+    "cluster-key-slot": "^1.1.2"
+  },
+  "devDependencies": {
+    "@resolid/utils": "^1.3.8",
+    "tsdown": "^0.22.0"
+  },
+  "peerDependencies": {
+    "@resolid/cache": "workspace:^"
+  },
+  "engines": {
+    "node": "^22.13.0 || >=24"
+  }
+}