@nestjs-redis/socket.io-adapter 0.13.4 → 1.0.0

package/README.md

@@ -24,26 +24,18 @@ Redis-powered Socket.IO adapter for NestJS
 
 ## Installation
 
-### Recommended: Install the complete toolkit
-
 ```bash
-npm install @nestjs-redis/kit redis
+npm install @nestjs-redis/socket.io-adapter @nestjs-redis/client redis
 ```
 
-### Alternative: Install socket.io-adapter package only
-
-```bash
-npm install @nestjs-redis/socket.io-adapter redis
-```
+The recommended approach is to use `RedisModule` from `@nestjs-redis/client` so Redis connections are lifecycle-managed by Nest (connect/disconnect with your app). Alternatively, you can pass your own Redis client (e.g. created with `createClient()` from `redis`) and manage its lifecycle yourself.
 
 ## Quick Start
 
-> **Note**: Examples use `@nestjs-redis/kit` imports (recommended). If you installed only this package, import from `@nestjs-redis/socket.io-adapter` and `@nestjs-redis/client` instead.
-
 ```typescript
 // app.module.ts
 import { Module } from '@nestjs/common';
-import { RedisModule } from '@nestjs-redis/kit';
+import { RedisModule } from '@nestjs-redis/client';
 
 @Module({
   imports: [
@@ -58,7 +50,7 @@ export class AppModule {}
 ```typescript
 // main.ts
 import { NestFactory } from '@nestjs/core';
-import { setupRedisAdapter } from '@nestjs-redis/kit';
+import { setupRedisAdapter } from '@nestjs-redis/socket.io-adapter';
 import { AppModule } from './app.module';
 
 async function bootstrap() {

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC"}

package/dist/lib/exceptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../src/lib/exceptions.ts"],"names":[],"mappings":"AAAA,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,UAAU,CAAC,EAAE,MAAM;CA6BhC;AAED,qBAAa,iCAAkC,SAAQ,KAAK;;CAK3D"}

package/dist/lib/redis-io.adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-io.adapter.d.ts","sourceRoot":"","sources":["../../src/lib/redis-io.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,cAAc,CAAC,WAAW,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC1D;AAED,MAAM,MAAM,yBAAyB,GAAG,KACtC,GAAG,EAAE,gBAAgB,KAClB,sBAAsB,CAAC;AAE5B,wBAAsB,eAAe,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAmC1E"}

package/dist/lib/setup-redis-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-redis-adapter.d.ts","sourceRoot":"","sources":["../../src/lib/setup-redis-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAWvD;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,gBAAgB,EACrB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAuBf"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-redis/socket.io-adapter",
-  "version": "0.13.4",
+  "version": "1.0.0",
   "license": "MIT",
   "author": "Saba Pochkhua <saba.pochkhua@gmail.com> (https://github.com/CSenshi)",
   "description": "Redis-powered Socket.IO adapter for NestJS enabling scalable WebSocket connections",
@@ -15,42 +15,24 @@
     "node-redis"
   ],
   "homepage": "https://github.com/CSenshi/nestjs-redis/tree/main/packages/socket.io-adapter",
-  "main": "./src/index.js",
-  "module": "./src/index.js",
-  "types": "./src/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "development": "./src/index.ts",
-      "types": "./src/index.d.ts",
-      "import": "./src/index.js",
-      "default": "./src/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     }
   },
   "files": [
-    "src",
+    "dist",
     "!**/*.tsbuildinfo"
   ],
   "nx": {
-    "name": "socket.io-adapter",
-    "targets": {
-      "build": {
-        "executor": "@nx/js:tsc",
-        "outputs": [
-          "{options.outputPath}"
-        ],
-        "options": {
-          "outputPath": "dist/packages/socket.io-adapter",
-          "tsConfig": "packages/socket.io-adapter/tsconfig.lib.json",
-          "packageJson": "packages/socket.io-adapter/package.json",
-          "main": "packages/socket.io-adapter/src/index.ts",
-          "assets": [
-            "packages/socket.io-adapter/*.md",
-            "LICENSE"
-          ]
-        }
-      }
-    }
+    "name": "socket.io-adapter"
   },
   "dependencies": {
     "@nestjs/platform-socket.io": "^11.1.6",
@@ -75,6 +57,5 @@
     "type": "git",
     "url": "https://github.com/CSenshi/nestjs-redis",
     "directory": "packages/socket.io-adapter"
-  },
-  "type": "commonjs"
+  }
 }

package/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/socket.io-adapter/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC"}

package/src/lib/exceptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../../../../packages/socket.io-adapter/src/lib/exceptions.ts"],"names":[],"mappings":"AAAA,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,UAAU,CAAC,EAAE,MAAM;CA6BhC;AAED,qBAAa,iCAAkC,SAAQ,KAAK;;CAK3D"}

package/src/lib/redis-io.adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis-io.adapter.d.ts","sourceRoot":"","sources":["../../../../../packages/socket.io-adapter/src/lib/redis-io.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,cAAc,CAAC,WAAW,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC1D;AAED,MAAM,MAAM,yBAAyB,GAAG,KACtC,GAAG,EAAE,gBAAgB,KAClB,sBAAsB,CAAC;AAE5B,wBAAsB,eAAe,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAmC1E"}

package/src/lib/setup-redis-adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup-redis-adapter.d.ts","sourceRoot":"","sources":["../../../../../packages/socket.io-adapter/src/lib/setup-redis-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAWvD;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,gBAAgB,EACrB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAuBf"}