@tsed/socketio 7.32.0 → 7.33.0

package/lib/types/class/SocketHandlersBuilder.d.ts

@@ -26,7 +26,7 @@ export declare class SocketHandlersBuilder {
      * @param {Namespace} nsp
      */
     onConnection(socket: Socket, nsp: Namespace): void;
-    onDisconnect(socket: Socket, nsp: Namespace): void;
+    onDisconnect(socket: Socket, nsp: Namespace, reason?: string): void;
     /**
      *
      * @param {Socket} socket

package/lib/types/decorators/reason.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Inject the disconnection reason into the decorated parameter.
+ *
+ * This decorator is used in conjunction with the `$onDisconnect` event handler to handle disconnection reasons in SocketIO services.
+ * It allows you to access the reason for the disconnection in your method implementation. For details please refer to the [Socket.io documentation](https://socket.io/docs/v4/server-api/#event-disconnect).
+ *
+ * @example
+ * ```typescript
+ * @SocketService("/nsp")
+ * export class MyWS {
+ *   public async $onDisconnect(
+ *     @Reason reason: string = ''
+ *   ) {
+ *      // your implementation
+ *   }
+ * }
+ * ```
+ *
+ * @experimental This decorator is experimental and may change or be removed in future versions.
+ * @param target
+ * @param {string} propertyKey
+ * @param {number} index
+ * @decorator
+ */
+export declare function Reason(target: unknown, propertyKey: string, index: number): void;

package/lib/types/index.d.ts

@@ -15,6 +15,7 @@ export * from "./decorators/inputAndBroadcastOthers";
 export * from "./decorators/inputAndEmit";
 export * from "./decorators/io";
 export * from "./decorators/nsp";
+export * from "./decorators/reason";
 export * from "./decorators/socket";
 export * from "./decorators/socketErr";
 export * from "./decorators/socketEventName";

package/lib/types/interfaces/SocketFilters.d.ts

@@ -8,5 +8,6 @@ export declare enum SocketFilters {
     NSP = "nsp",
     SESSION = "session",
     ERR = "error",
-    SOCKET_NSP = "socket_nsp"
+    SOCKET_NSP = "socket_nsp",
+    REASON = "reason"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/socketio",
-  "version": "7.32.0",
+  "version": "7.33.0",
   "description": "Socket.io package for Ts.ED framework",
   "private": false,
   "keywords": [
@@ -33,27 +33,27 @@
     "tslib": "2.5.0"
   },
   "devDependencies": {
-    "@tsed/common": "7.32.0",
-    "@tsed/core": "7.32.0",
-    "@tsed/di": "7.32.0",
-    "@tsed/eslint": "7.32.0",
-    "@tsed/json-mapper": "7.32.0",
-    "@tsed/openspec": "7.32.0",
-    "@tsed/platform-middlewares": "7.32.0",
-    "@tsed/schema": "7.32.0",
-    "@tsed/socketio-testing": "7.32.0",
-    "@tsed/typescript": "7.32.0",
+    "@tsed/common": "7.33.0",
+    "@tsed/core": "7.33.0",
+    "@tsed/di": "7.33.0",
+    "@tsed/eslint": "7.33.0",
+    "@tsed/json-mapper": "7.33.0",
+    "@tsed/openspec": "7.33.0",
+    "@tsed/platform-middlewares": "7.33.0",
+    "@tsed/schema": "7.33.0",
+    "@tsed/socketio-testing": "7.33.0",
+    "@tsed/typescript": "7.33.0",
     "eslint": "^8.12.0",
     "express": "^4.17.1",
     "socket.io": "4.4.1",
     "socket.io-client": "^4.1.2"
   },
   "peerDependencies": {
-    "@tsed/di": "^7.32.0",
-    "@tsed/json-mapper": "^7.32.0",
+    "@tsed/di": "^7.33.0",
+    "@tsed/json-mapper": "^7.33.0",
     "@tsed/logger": ">=6.2.2",
-    "@tsed/platform-middlewares": "^7.32.0",
-    "@tsed/schema": "^7.32.0",
+    "@tsed/platform-middlewares": "^7.33.0",
+    "@tsed/schema": "^7.33.0",
     "socket.io": ">=4.0.0"
   },
   "peerDependenciesMeta": {

package/readme.md

@@ -67,7 +67,7 @@ Example:
 
 ```typescript
 import * as SocketIO from "socket.io";
-import {SocketService, IO, Nsp, Socket, SocketSession} from "@tsed/socketio";
+import {SocketService, IO, Nsp, Socket, SocketSession, Reason} from "@tsed/socketio";
 
 @SocketService("/my-namespace")
 export class MySocketService {
@@ -88,7 +88,7 @@ export class MySocketService {
   /**
    * Triggered when a client disconnects from the Namespace.
    */
-  $onDisconnect(@Socket socket: SocketIO.Socket) {}
+  $onDisconnect(@Socket socket: SocketIO.Socket, @Reason reason: string) {}
 }
 ```