@nestjs-redis/socket.io-adapter 1.0.0 → 1.1.1-0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-redis/socket.io-adapter",
-  "version": "1.0.0",
+  "version": "1.1.1-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",
@@ -32,7 +32,10 @@
     "!**/*.tsbuildinfo"
   ],
   "nx": {
-    "name": "socket.io-adapter"
+    "name": "socket.io-adapter",
+    "tags": [
+      "type:lib"
+    ]
   },
   "dependencies": {
     "@nestjs/platform-socket.io": "^11.1.6",

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './lib/exceptions';
-export * from './lib/redis-io.adapter';
-export * from './lib/setup-redis-adapter';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"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/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/exceptions"), exports);
-tslib_1.__exportStar(require("./lib/redis-io.adapter"), exports);
-tslib_1.__exportStar(require("./lib/setup-redis-adapter"), exports);

package/dist/lib/exceptions.d.ts

@@ -1,7 +0,0 @@
-export declare class RedisClientNotFoundException extends Error {
-    constructor(redisToken?: string);
-}
-export declare class RedisAdapterAlreadySetUpException extends Error {
-    constructor();
-}
-//# sourceMappingURL=exceptions.d.ts.map

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

@@ -1 +0,0 @@
-{"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/exceptions.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisAdapterAlreadySetUpException = exports.RedisClientNotFoundException = void 0;
-class RedisClientNotFoundException extends Error {
-    constructor(redisToken) {
-        const baseMessage = `Redis client not found. Please ensure that the Redis client is properly configured and provided in the application context.
-
-Most common solution:
-Import and configure RedisModule in your app.module.ts:`;
-        const configExample = redisToken
-            ? `  RedisModule.forRoot({
-    connectionName: '${redisToken}', // <-- connection name 
-    options: { url: process.env['REDIS_URL'] },
-  }),`
-            : `  RedisModule.forRoot({
-    options: { url: process.env['REDIS_URL'] },
-  }),`;
-        const troubleshooting = `
-
-Make sure you have:
-1. RedisModule imported in your module`;
-        super(baseMessage + '\n\n' + configExample + troubleshooting);
-        this.name = 'RedisClientNotFoundException';
-        if (redisToken) {
-            this.message += `\n\nRequired connection name: ${redisToken}`;
-        }
-        this.message += `\n`;
-    }
-}
-exports.RedisClientNotFoundException = RedisClientNotFoundException;
-class RedisAdapterAlreadySetUpException extends Error {
-    constructor() {
-        super('Redis adapter is already set up for this application instance.');
-        this.name = 'RedisAdapterAlreadySetUpException';
-    }
-}
-exports.RedisAdapterAlreadySetUpException = RedisAdapterAlreadySetUpException;

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

@@ -1,9 +0,0 @@
-import type { INestApplication, WebSocketAdapter } from '@nestjs/common';
-import type { RedisClientType } from 'redis';
-export interface RedisIoAdapterInstance extends WebSocketAdapter {
-    connectToRedis(redisClient: RedisClientType): Promise<void>;
-    createIOServer(port: number, options?: unknown): unknown;
-}
-export type RedisIoAdapterConstructor = new (app: INestApplication) => RedisIoAdapterInstance;
-export declare function getIoAdapterCls(): Promise<RedisIoAdapterConstructor>;
-//# sourceMappingURL=redis-io.adapter.d.ts.map

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

@@ -1 +0,0 @@
-{"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/redis-io.adapter.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIoAdapterCls = getIoAdapterCls;
-async function getIoAdapterCls() {
-    const { IoAdapter } = await import('@nestjs/platform-socket.io');
-    const { createAdapter } = await import('@socket.io/redis-adapter');
-    class RedisIoAdapter extends IoAdapter {
-        async connectToRedis(redisClient) {
-            this.pubClient = redisClient;
-            this.subClient = this.pubClient.duplicate();
-            await this.subClient.connect();
-            this.adapterConstructor = createAdapter(this.pubClient, this.subClient);
-        }
-        createIOServer(port, options) {
-            const server = super.createIOServer(port, options);
-            server.adapter(this.adapterConstructor);
-            return server;
-        }
-        async close(server) {
-            super.close(server);
-            if (this.subClient) {
-                await this.subClient.quit();
-            }
-        }
-    }
-    return RedisIoAdapter;
-}

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

@@ -1,11 +0,0 @@
-import type { INestApplication } from '@nestjs/common';
-/**
- * Sets up the Redis adapter for a NestJS application.
- *
- * @param app - The NestJS application instance
- * @param redisToken - Optional Redis client token for named connections
- * @returns A promise that resolves when the adapter is set up
- * @throws RedisClientNotFoundException if the Redis client is not found
- */
-export declare function setupRedisAdapter(app: INestApplication, redisToken?: string): Promise<void>;
-//# sourceMappingURL=setup-redis-adapter.d.ts.map

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

@@ -1 +0,0 @@
-{"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/dist/lib/setup-redis-adapter.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupRedisAdapter = setupRedisAdapter;
-const core_1 = require("@nestjs/core");
-const exceptions_1 = require("@nestjs/core/errors/exceptions");
-const exceptions_2 = require("./exceptions");
-const redis_io_adapter_1 = require("./redis-io.adapter");
-const appSet = new Set();
-/**
- * Sets up the Redis adapter for a NestJS application.
- *
- * @param app - The NestJS application instance
- * @param redisToken - Optional Redis client token for named connections
- * @returns A promise that resolves when the adapter is set up
- * @throws RedisClientNotFoundException if the Redis client is not found
- */
-async function setupRedisAdapter(app, redisToken) {
-    if (appSet.has(app)) {
-        throw new exceptions_2.RedisAdapterAlreadySetUpException();
-    }
-    appSet.add(app);
-    const cls = await (0, redis_io_adapter_1.getIoAdapterCls)();
-    const redisIoAdapter = new cls(app);
-    try {
-        const moduleRef = app.get(core_1.ModuleRef);
-        const redisClient = moduleRef.get(RedisToken(redisToken), {
-            strict: false,
-        });
-        await redisIoAdapter.connectToRedis(redisClient);
-        app.useWebSocketAdapter(redisIoAdapter);
-    }
-    catch (error) {
-        if (error instanceof exceptions_1.UnknownElementException) {
-            throw new exceptions_2.RedisClientNotFoundException(redisToken);
-        }
-        throw error;
-    }
-}
-/**
- * Creates a Redis client injection token.
- *
- * @param connectionName - Optional connection name
- * @returns Injection token for the Redis client
- * @publicApi
- */
-function RedisToken(connectionName) {
-    if (connectionName) {
-        return `REDIS_CLIENT_${connectionName.toUpperCase()}`;
-    }
-    return 'REDIS_CLIENT';
-}