@eggjs/redis 3.1.0 → 4.0.0-beta.27

package/README.md

@@ -1,8 +1,6 @@
 # @eggjs/redis
 
 [![NPM version][npm-image]][npm-url]
-[![Node.js CI](https://github.com/eggjs/redis/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/redis/actions/workflows/nodejs.yml)
-[![Test coverage][codecov-image]][codecov-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
 [![Node.js Version](https://img.shields.io/node/v/@eggjs/redis.svg?style=flat)](https://nodejs.org/en/download/)
@@ -11,8 +9,6 @@
 
 [npm-image]: https://img.shields.io/npm/v/@eggjs/redis.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@eggjs/redis
-[codecov-image]: https://codecov.io/gh/eggjs/redis/branch/master/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/eggjs/redis
 [snyk-image]: https://snyk.io/test/npm/@eggjs/redis/badge.svg?style=flat-square
 [snyk-url]: https://snyk.io/test/npm/@eggjs/redis
 [download-image]: https://img.shields.io/npm/dm/@eggjs/redis.svg?style=flat-square
@@ -20,6 +16,10 @@
 
 Valkey / Redis client (support [redis protocol](https://redis.io/docs/latest/develop/reference/protocol-spec/)) based on iovalkey for egg framework
 
+## Version Notes
+
+`@eggjs/redis` only supports `egg@4` now, if you are using `egg@3` or `egg@2`, you should use [`egg-redis`](https://github.com/eggjs/redis/tree/2.x).
+
 ## Install
 
 ```bash
@@ -33,57 +33,70 @@ If you want to know specific usage, you should refer to the document of [ioredis
 
 ## Configuration
 
-Change `${app_root}/config/plugin.js` to enable redis plugin:
+Change `${app_root}/config/plugin.ts` to enable redis plugin:
 
-```js
-exports.redis = {
-  enable: true,
-  package: '@eggjs/redis',
+```ts
+export default {
+  redis: {
+    enable: true,
+    package: '@eggjs/redis',
+  },
 };
 ```
 
-Configure redis information in `${app_root}/config/config.default.js`:
+Configure redis information in `${app_root}/config/config.default.ts`:
 
 **Single Client**
 
-```javascript
-config.redis = {
-  client: {
-    port: 6379, // Redis port
-    host: '127.0.0.1', // Redis host
-    password: 'auth',
-    db: 0,
-  },
-};
-```
-
-**Multi Clients**
+```ts
+import { defineConfig } from 'egg';
 
-```javascript
-config.redis = {
-  clients: {
-    foo: {
-      // instanceName. See below
+export default defineConfig({
+  redis: {
+    client: {
       port: 6379, // Redis port
       host: '127.0.0.1', // Redis host
       password: 'auth',
       db: 0,
     },
-    bar: {
-      port: 6379,
-      host: '127.0.0.1',
-      password: 'auth',
-      db: 1,
+  },
+});
+```
+
+**Multi Clients**
+
+```ts
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  redis: {
+    clients: {
+      foo: {
+        // instanceName. See below
+        port: 6379, // Redis port
+        host: '127.0.0.1', // Redis host
+        password: 'auth',
+        db: 0,
+      },
+      bar: {
+        port: 6379,
+        host: '127.0.0.1',
+        password: 'auth',
+        db: 1,
+      },
     },
   },
-};
+});
 ```
 
 **Sentinel**
 
-```javascript
-config.redis = {
-  client: {
+```ts
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  redis: {
+    client: {
     // Sentinel instances
     sentinels: [
       {
@@ -123,71 +136,78 @@ See [ioredis API Documentation](https://github.com/redis/ioredis#basic-usage) fo
 `@eggjs/redis` using `ioredis@5` now, if you want to use other version of iovalkey or ioredis,
 you can pass the instance by `config.redis.Redis`:
 
-```js
-// config/config.default.js
-config.redis = {
-  Redis: require('ioredis'), // customize ioredis version, only set when you needed
-  client: {
-    port: 6379, // Redis port
-    host: '127.0.0.1', // Redis host
-    password: 'auth',
-    db: 0,
+```ts
+// config/config.default.ts
+
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  redis: {
+    Redis: require('ioredis'), // customize ioredis version, only set when you needed
+    client: {
+      port: 6379, // Redis port
+      host: '127.0.0.1', // Redis host
+      password: 'auth',
+      db: 0,
+    },
   },
-};
+});
 ```
 
 **weakDependent**
 
-```javascript
-config.redis = {
-  client: {
-    port: 6379, // Redis port
-    host: '127.0.0.1', // Redis host
-    password: 'auth',
-    db: 0,
-    weakDependent: true, // the redis instance won't block app start
+```ts
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  redis: {
+    client: {
+      port: 6379, // Redis port
+      host: '127.0.0.1', // Redis host
+      password: 'auth',
+      db: 0,
+      weakDependent: true, // the redis instance won't block app start
+    },
   },
-};
+});
 ```
 
 ## Usage
 
 In controller, you can use `app.redis` to get the redis instance, check [ioredis](https://github.com/redis/ioredis#basic-usage) to see how to use.
 
-```js
-// app/controller/home.js
-
-module.exports = app => {
-  return class HomeController extends app.Controller {
-    async index() {
-      const { ctx, app } = this;
-      // set
-      await app.redis.set('foo', 'bar');
-      // get
-      ctx.body = await app.redis.get('foo');
-    }
-  };
-};
+```ts
+// app/controller/home.ts
+
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  async index() {
+    const { ctx, app } = this;
+    // set
+    await app.redis.set('foo', 'bar');
+    // get
+    ctx.body = await app.redis.get('foo');
+  }
+}
 ```
 
 ### Multi Clients
 
 If your Configure with multi clients, you can use `app.redis.get(instanceName)` to get the specific redis instance and use it like above.
 
-```js
-// app/controller/home.js
-
-module.exports = app => {
-  return class HomeController extends app.Controller {
-    async index() {
-      const { ctx, app } = this;
-      // set
-      await app.redis.get('instance1').set('foo', 'bar');
-      // get
-      ctx.body = await app.redis.get('instance1').get('foo');
-    }
-  };
-};
+```ts
+// app/controller/home.ts
+
+export default class HomeController extends Controller {
+  async index() {
+    const { ctx, app } = this;
+    // set
+    await app.redis.getSingletonInstance('instance1').set('foo', 'bar');
+    // get
+    ctx.body = await app.redis.getSingletonInstance('instance1').get('foo');
+  }
+}
 ```
 
 ### Clients Depend on Redis Cluster
@@ -196,42 +216,46 @@ Before you start to use Redis Cluster, please checkout the [document](https://re
 
 In controller, you also can use `app.redis` to get the redis instance based on Redis Cluster.
 
-```js
-// app/config/config.default.js
-exports.redis = {
-  client: {
-    cluster: true,
-    nodes: [
-      {
-        host: '127.0.0.1',
-        port: '6379',
-        family: 'user',
-        password: 'password',
-        db: 'db',
-      },
-      {
-        host: '127.0.0.1',
-        port: '6380',
-        family: 'user',
-        password: 'password',
-        db: 'db',
-      },
-    ],
+```ts
+// app/config/config.default.ts
+import { defineConfig } from 'egg';
+
+export default defineConfig({
+  redis: {
+    client: {
+      cluster: true,
+      nodes: [
+        {
+          host: '127.0.0.1',
+          port: '6379',
+          family: 'user',
+          password: 'password',
+          db: 'db',
+        },
+        {
+          host: '127.0.0.1',
+          port: '6380',
+          family: 'user',
+          password: 'password',
+          db: 'db',
+        },
+      ],
+    },
   },
-};
-
-// app/controller/home.js
-module.exports = app => {
-  return class HomeController extends app.Controller {
-    async index() {
-      const { ctx, app } = this;
-      // set
-      await app.redis.set('foo', 'bar');
-      // get
-      ctx.body = await app.redis.get('foo');
-    }
-  };
-};
+});
+
+// app/controller/home.ts
+import { Controller } from 'egg';
+
+export default class HomeController extends Controller {
+  async index() {
+    const { ctx, app } = this;
+    // set
+    await app.redis.set('foo', 'bar');
+    // get
+    ctx.body = await app.redis.get('foo');
+  }
+}
 ```
 
 ## For the local dev
@@ -245,7 +269,7 @@ docker compose -f docker-compose.yml up -d
 Run the unit tests
 
 ```bash
-npm test
+pnpm test
 ```
 
 Stop test redis service
@@ -264,6 +288,6 @@ Please open an issue [here](https://github.com/eggjs/egg/issues).
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/redis)](https://github.com/eggjs/redis/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).

package/dist/agent.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.ts';
+export default RedisBoot;

package/dist/agent.js

@@ -0,0 +1,3 @@
+import { RedisBoot } from "./lib/redis.js";
+export default RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRTNDLGVBQWUsU0FBUyxDQUFDIn0=

package/dist/app.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.ts';
+export default RedisBoot;

package/dist/app.js

@@ -0,0 +1,3 @@
+import { RedisBoot } from "./lib/redis.js";
+export default RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFFM0MsZUFBZSxTQUFTLENBQUMifQ==

package/dist/{esm/config → config}/config.default.js

@@ -50,4 +50,4 @@ export default {
         // },
     },
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQTJEQSxlQUFlO0lBQ2IsS0FBSyxFQUFFO1FBQ0wsT0FBTyxFQUFFLEVBQUU7UUFDWCxHQUFHLEVBQUUsSUFBSTtRQUNULEtBQUssRUFBRSxLQUFLO1FBQ1osa0JBQWtCLEVBQUUsSUFBSTtRQUN4QixlQUFlO1FBQ2YsWUFBWTtRQUNaLGtCQUFrQjtRQUNsQixrQkFBa0I7UUFDbEIsb0JBQW9CO1FBQ3BCLDBCQUEwQjtRQUMxQixjQUFjO1FBQ2QsS0FBSztRQUNMLEVBQUU7UUFDRixnQkFBZ0I7UUFDaEIsWUFBWTtRQUNaLG1CQUFtQjtRQUNuQixjQUFjO1FBQ2Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixTQUFTO1FBQ1Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsTUFBTTtRQUNOLEVBQUU7UUFDRixjQUFjO1FBQ2QsYUFBYTtRQUNiLGlCQUFpQjtRQUNqQixvQkFBb0I7UUFDcEIsb0JBQW9CO1FBQ3BCLHNCQUFzQjtRQUN0Qiw0QkFBNEI7UUFDNUIsZ0JBQWdCO1FBQ2hCLE9BQU87UUFDUCxpQkFBaUI7UUFDakIsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsS0FBSztLQUNTO0NBQ2pCLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQTJEQSxlQUFlO0lBQ2IsS0FBSyxFQUFFO1FBQ0wsT0FBTyxFQUFFLEVBQUU7UUFDWCxHQUFHLEVBQUUsSUFBSTtRQUNULEtBQUssRUFBRSxLQUFLO1FBQ1osa0JBQWtCLEVBQUUsSUFBSTtRQUN4QixlQUFlO1FBQ2YsWUFBWTtRQUNaLGtCQUFrQjtRQUNsQixrQkFBa0I7UUFDbEIsb0JBQW9CO1FBQ3BCLDBCQUEwQjtRQUMxQixjQUFjO1FBQ2QsS0FBSztRQUNMLEVBQUU7UUFDRixnQkFBZ0I7UUFDaEIsWUFBWTtRQUNaLG1CQUFtQjtRQUNuQixjQUFjO1FBQ2Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixTQUFTO1FBQ1Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsTUFBTTtRQUNOLEVBQUU7UUFDRixjQUFjO1FBQ2QsYUFBYTtRQUNiLGlCQUFpQjtRQUNqQixvQkFBb0I7UUFDcEIsb0JBQW9CO1FBQ3BCLHNCQUFzQjtRQUN0Qiw0QkFBNEI7UUFDNUIsZ0JBQWdCO1FBQ2hCLE9BQU87UUFDUCxpQkFBaUI7UUFDakIsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsS0FBSztLQUNTO0NBQ2pCLENBQUMifQ==

package/dist/index.d.ts

@@ -0,0 +1 @@
+import './types.ts';

package/dist/{esm/index.js → index.js}

@@ -1,2 +1,2 @@
-import './types.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==
+import "./types.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==

package/dist/{commonjs/lib → lib}/redis.d.ts

@@ -1,6 +1,6 @@
-import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+import type { ILifecycleBoot, EggApplicationCore } from 'egg';
 export declare class RedisBoot implements ILifecycleBoot {
     private readonly app;
-    constructor(app: EggCore);
+    constructor(app: EggApplicationCore);
     didLoad(): Promise<void>;
 }

package/dist/lib/redis.js

@@ -0,0 +1,76 @@
+import assert from 'node:assert';
+import { once } from 'node:events';
+import { Redis } from 'ioredis';
+export class RedisBoot {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async didLoad() {
+        const app = this.app;
+        if (app.type === 'application' && app.config.redis.app) {
+            app.addSingleton('redis', createClient);
+        }
+        else if (app.type === 'agent' && app.config.redis.agent) {
+            app.addSingleton('redis', createClient);
+        }
+    }
+}
+let count = 0;
+function createClient(options, app) {
+    const RedisClass = app.config.redis.Redis ?? Redis;
+    let client;
+    if ('cluster' in options && options.cluster === true) {
+        const config = options;
+        assert(config.nodes && config.nodes.length > 0, '[@eggjs/redis] cluster nodes configuration is required when use cluster redis');
+        for (const client of config.nodes) {
+            assert(client.host && client.port, `[@eggjs/redis] 'host: ${client.host}', 'port: ${client.port}' are required on config`);
+        }
+        app.coreLogger.info('[@eggjs/redis] cluster connecting');
+        client = new RedisClass.Cluster(config.nodes, config);
+    }
+    else if ('sentinels' in options && options.sentinels) {
+        const config = options;
+        assert(config.sentinels && config.sentinels.length > 0, '[@eggjs/redis] sentinels configuration is required when use redis sentinel');
+        for (const sentinel of config.sentinels) {
+            assert(sentinel.host && sentinel.port, `[@eggjs/redis] 'host: ${sentinel.host}', 'port: ${sentinel.port}' are required on config`);
+        }
+        const mask = config.password ? '***' : config.password;
+        assert(config.name && config.password !== undefined && config.db !== undefined, `[@eggjs/redis] 'name of master: ${config.name}', 'password: ${mask}', 'db: ${config.db}' are required on config`);
+        app.coreLogger.info('[@eggjs/redis] sentinel connecting start');
+        client = new RedisClass(config);
+    }
+    else {
+        const config = options;
+        const mask = config.password ? '***' : config.password;
+        assert((config.host && config.port && config.password !== undefined && config.db !== undefined) || config.path, `[@eggjs/redis] 'host: ${config.host}', 'port: ${config.port}', 'password: ${mask}', 'db: ${config.db}' or 'path:${config.path}' are required on config`);
+        if (config.host) {
+            app.coreLogger.info('[@eggjs/redis] server connecting redis://:***@%s:%s/%s', config.host, config.port, config.db);
+        }
+        else {
+            app.coreLogger.info('[@eggjs/redis] server connecting %s', config.path || config);
+        }
+        client = new RedisClass(config);
+    }
+    client.on('connect', () => {
+        app.coreLogger.info('[@eggjs/redis] client connect success');
+    });
+    client.on('error', err => {
+        app.coreLogger.error('[@eggjs/redis] client error: %s', err);
+        app.coreLogger.error(err);
+    });
+    const index = count++;
+    app.lifecycle.registerBeforeStart(async () => {
+        if ('weakDependent' in options && options.weakDependent) {
+            app.coreLogger.info(`[@eggjs/redis] instance[${index}] is weak dependent and won't block app start`);
+            client.once('ready', () => {
+                app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK`);
+            });
+            return;
+        }
+        await Promise.race([once(client, 'ready'), once(client, 'error')]);
+        app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK, client ready`);
+    }, `[@eggjs/redis] instance[${index}] start check`);
+    return client;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkaXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbGliL3JlZGlzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sTUFBTSxNQUFNLGFBQWEsQ0FBQztBQUNqQyxPQUFPLEVBQUUsSUFBSSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRW5DLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFLaEMsTUFBTSxPQUFPLFNBQVM7SUFDSCxHQUFHLENBQXFCO0lBRXpDLFlBQVksR0FBdUI7UUFDakMsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7SUFDakIsQ0FBQztJQUVELEtBQUssQ0FBQyxPQUFPO1FBQ1gsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQztRQUNyQixJQUFJLEdBQUcsQ0FBQyxJQUFJLEtBQUssYUFBYSxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBQ3ZELEdBQUcsQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQyxDQUFDO1FBQzFDLENBQUM7YUFBTSxJQUFJLEdBQUcsQ0FBQyxJQUFJLEtBQUssT0FBTyxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzFELEdBQUcsQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQyxDQUFDO1FBQzFDLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFFRCxJQUFJLEtBQUssR0FBRyxDQUFDLENBQUM7QUFDZCxTQUFTLFlBQVksQ0FBQyxPQUFpRCxFQUFFLEdBQXVCO0lBQzlGLE1BQU0sVUFBVSxHQUFHLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssSUFBSSxLQUFLLENBQUM7SUFDbkQsSUFBSSxNQUFNLENBQUM7SUFFWCxJQUFJLFNBQVMsSUFBSSxPQUFPLElBQUksT0FBTyxDQUFDLE9BQU8sS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUNyRCxNQUFNLE1BQU0sR0FBRyxPQUE4QixDQUFDO1FBQzlDLE1BQU0sQ0FDSixNQUFNLENBQUMsS0FBSyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBTSxHQUFHLENBQUMsRUFDdkMsK0VBQStFLENBQ2hGLENBQUM7UUFFRixLQUFLLE1BQU0sTUFBTSxJQUFJLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUNsQyxNQUFNLENBQ0osTUFBTSxDQUFDLElBQUksSUFBSSxNQUFNLENBQUMsSUFBSSxFQUMxQix5QkFBeUIsTUFBTSxDQUFDLElBQUksYUFBYSxNQUFNLENBQUMsSUFBSSwwQkFBMEIsQ0FDdkYsQ0FBQztRQUNKLENBQUM7UUFDRCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxtQ0FBbUMsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sR0FBRyxJQUFJLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztJQUN4RCxDQUFDO1NBQU0sSUFBSSxXQUFXLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUN2RCxNQUFNLE1BQU0sR0FBRyxPQUE2QixDQUFDO1FBQzdDLE1BQU0sQ0FDSixNQUFNLENBQUMsU0FBUyxJQUFJLE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBTSxHQUFHLENBQUMsRUFDL0MsNEVBQTRFLENBQzdFLENBQUM7UUFFRixLQUFLLE1BQU0sUUFBUSxJQUFJLE1BQU0sQ0FBQyxTQUFTLEVBQUUsQ0FBQztZQUN4QyxNQUFNLENBQ0osUUFBUSxDQUFDLElBQUksSUFBSSxRQUFRLENBQUMsSUFBSSxFQUM5Qix5QkFBeUIsUUFBUSxDQUFDLElBQUksYUFBYSxRQUFRLENBQUMsSUFBSSwwQkFBMEIsQ0FDM0YsQ0FBQztRQUNKLENBQUM7UUFFRCxNQUFNLElBQUksR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUM7UUFDdkQsTUFBTSxDQUNKLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxTQUFTLElBQUksTUFBTSxDQUFDLEVBQUUsS0FBSyxTQUFTLEVBQ3ZFLG1DQUFtQyxNQUFNLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxXQUFXLE1BQU0sQ0FBQyxFQUFFLDBCQUEwQixDQUNsSCxDQUFDO1FBRUYsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMENBQTBDLENBQUMsQ0FBQztRQUNoRSxNQUFNLEdBQUcsSUFBSSxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDbEMsQ0FBQztTQUFNLENBQUM7UUFDTixNQUFNLE1BQU0sR0FBRyxPQUE2QixDQUFDO1FBQzdDLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQztRQUN2RCxNQUFNLENBQ0osQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxTQUFTLElBQUksTUFBTSxDQUFDLEVBQUUsS0FBSyxTQUFTLENBQUMsSUFBSSxNQUFNLENBQUMsSUFBSSxFQUN2Ryx5QkFBeUIsTUFBTSxDQUFDLElBQUksYUFBYSxNQUFNLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxXQUFXLE1BQU0sQ0FBQyxFQUFFLGNBQWMsTUFBTSxDQUFDLElBQUksMEJBQTBCLENBQ3pKLENBQUM7UUFDRixJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUNoQixHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FDakIsd0RBQXdELEVBQ3hELE1BQU0sQ0FBQyxJQUFJLEVBQ1gsTUFBTSxDQUFDLElBQUksRUFDWCxNQUFNLENBQUMsRUFBRSxDQUNWLENBQUM7UUFDSixDQUFDO2FBQU0sQ0FBQztZQUNOLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHFDQUFxQyxFQUFFLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLENBQUM7UUFDcEYsQ0FBQztRQUVELE1BQU0sR0FBRyxJQUFJLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRUQsTUFBTSxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFO1FBQ3hCLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHVDQUF1QyxDQUFDLENBQUM7SUFDL0QsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsRUFBRTtRQUN2QixHQUFHLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxpQ0FBaUMsRUFBRSxHQUFHLENBQUMsQ0FBQztRQUM3RCxHQUFHLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUM1QixDQUFDLENBQUMsQ0FBQztJQUVILE1BQU0sS0FBSyxHQUFHLEtBQUssRUFBRSxDQUFDO0lBQ3RCLEdBQUcsQ0FBQyxTQUFTLENBQUMsbUJBQW1CLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDM0MsSUFBSSxlQUFlLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxhQUFhLEVBQUUsQ0FBQztZQUN4RCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQywyQkFBMkIsS0FBSywrQ0FBK0MsQ0FBQyxDQUFDO1lBQ3JHLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRTtnQkFDeEIsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEtBQUssYUFBYSxDQUFDLENBQUM7WUFDckUsQ0FBQyxDQUFDLENBQUM7WUFDSCxPQUFPO1FBQ1QsQ0FBQztRQUVELE1BQU0sT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLEVBQUUsSUFBSSxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbkUsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEtBQUssMkJBQTJCLENBQUMsQ0FBQztJQUNuRixDQUFDLEVBQUUsMkJBQTJCLEtBQUssZUFBZSxDQUFDLENBQUM7SUFFcEQsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyJ9

package/dist/types.d.ts

@@ -0,0 +1,14 @@
+import type { Singleton } from 'egg';
+import type { Redis } from 'ioredis';
+import type { RedisConfig } from './config/config.default.ts';
+declare module 'egg' {
+    interface EggAppConfig {
+        /**
+         * Redis plugin config
+         */
+        redis: RedisConfig;
+    }
+    interface EggApplicationCore {
+        redis: Redis & Singleton<Redis>;
+    }
+}

package/dist/{esm/types.js → types.js}

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/package.json

@@ -1,18 +1,26 @@
 {
   "name": "@eggjs/redis",
-  "version": "3.1.0",
-  "publishConfig": {
-    "access": "public"
-  },
+  "version": "4.0.0-beta.27",
   "description": "Valkey / Redis plugin for egg",
+  "type": "module",
   "eggPlugin": {
-    "name": "redis",
-    "exports": {
-      "import": "./dist/esm",
-      "require": "./dist/commonjs",
-      "typescript": "./src"
-    }
+    "name": "redis"
   },
+  "exports": {
+    ".": "./dist/index.js",
+    "./agent": "./dist/agent.js",
+    "./app": "./dist/app.js",
+    "./config/config.default": "./dist/config/config.default.js",
+    "./lib/redis": "./dist/lib/redis.js",
+    "./types": "./dist/types.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
   "keywords": [
     "egg",
     "eggPlugin",
@@ -21,84 +29,45 @@
     "Valkey",
     "database"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/eggjs/redis.git"
-  },
+  "license": "MIT",
+  "homepage": "https://github.com/eggjs/egg/tree/next/plugins/redis",
   "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/redis#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eggjs/egg.git",
+    "directory": "plugins/redis"
+  },
   "author": "jtyjty99999",
-  "license": "MIT",
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">= 22.18.0"
   },
   "dependencies": {
-    "@eggjs/core": "^6.4.1",
     "ioredis": "^5.4.2"
   },
+  "peerDependencies": {
+    "egg": "4.1.0-beta.27"
+  },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.4",
-    "@eggjs/bin": "7",
-    "@eggjs/mock": "^6.0.5",
-    "@eggjs/tsconfig": "1",
-    "@types/mocha": "10",
-    "@types/node": "22",
-    "egg": "4",
-    "husky": "^9.1.7",
-    "lint-staged": "^15.5.0",
-    "oxlint": "^0.16.2",
-    "prettier": "^3.5.3",
-    "rimraf": "6",
-    "snap-shot-it": "^7.9.10",
-    "tshy": "3",
-    "tshy-after": "1",
-    "typescript": "5"
+    "@types/node": "^24.6.2",
+    "detect-port": "^2.1.0",
+    "oxlint": "^1.19.0",
+    "rimraf": "^6.0.1",
+    "tsdown": "^0.15.4",
+    "typescript": "^5.9.3",
+    "vitest": "4.0.0-beta.16",
+    "@eggjs/mock": "7.0.0-beta.27",
+    "@eggjs/tsconfig": "3.1.0-beta.27",
+    "egg": "4.1.0-beta.27"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "lint": "oxlint",
-    "pretest": "npm run clean && npm run lint -- --fix",
-    "test": "egg-bin test",
-    "preci": "npm run clean &&  npm run lint",
-    "ci": "egg-bin cov",
-    "postci": "npm run prepublishOnly && npm run clean",
-    "clean": "rimraf dist",
-    "prepublishOnly": "tshy && tshy-after && attw --pack",
-    "prepare": "husky"
-  },
-  "lint-staged": {
-    "*": "prettier --write --ignore-unknown --cache",
-    "*.{ts,js,json,md,yml}": [
-      "prettier --ignore-unknown --write",
-      "oxlint --fix"
-    ]
-  },
-  "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "types": "./dist/commonjs/index.d.ts",
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js"
-}
+    "build": "tsdown && rimraf dist *.tsbuildinfo && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --type-aware",
+    "test": "vitest run"
+  }
+}