@tsed/socketio 7.33.4 → 7.34.1

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

@@ -6,7 +6,7 @@ import { Namespace, Socket } from "socket.io";
 export declare class SocketHandlersBuilder {
     private provider;
     private injector;
-    private socketProviderMetadata;
+    private readonly socketProviderMetadata;
     constructor(provider: Provider, injector: InjectorService);
     /**
      *
@@ -27,16 +27,6 @@ export declare class SocketHandlersBuilder {
      */
     onConnection(socket: Socket, nsp: Namespace): Promise<void>;
     onDisconnect(socket: Socket, nsp: Namespace, reason?: string): Promise<void>;
-    /**
-     *
-     * @param {Socket} socket
-     */
-    private createSession;
-    /**
-     *
-     * @param {Socket} socket
-     */
-    private destroySession;
     private buildHandlers;
     private runQueue;
     private deserialize;

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

@@ -0,0 +1,23 @@
+/**
+ * Represents session data associated with a socket connection, providing a compatibility layer with Ts.ED v7 by wrapping a `socket.data` which is used to archive recoverability and resiliency to a `Map` instance.
+ *
+ * This class implements the `Map<string, unknown>` interface and provides methods and properties to manage and manipulate session data.
+ *
+ * @internal This class is designed for internal use.
+ */
+export declare class SocketSessionData extends Map<string, unknown> {
+    #private;
+    get size(): number;
+    static get [Symbol.species](): MapConstructor;
+    constructor(data: Record<string, unknown>);
+    [Symbol.iterator](): IterableIterator<[string, unknown]>;
+    clear(): void;
+    delete(key: string): boolean;
+    entries(): IterableIterator<[string, unknown]>;
+    forEach(callbackfn: (value: unknown, key: string, map: Map<string, unknown>) => void, thisArg?: any): void;
+    get(key: string): unknown | undefined;
+    has(key: string): boolean;
+    keys(): IterableIterator<string>;
+    set(key: string, value: unknown): this;
+    values(): IterableIterator<unknown>;
+}

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

@@ -1,6 +1,6 @@
 export type SocketSession = Map<string, any>;
 /**
- * Inject the Socket instance in the decorated parameter.
+ * Inject the socket session data in the decorated parameter.
  *
  * ### Example
  *
@@ -9,7 +9,7 @@ export type SocketSession = Map<string, any>;
  * export class MyWS {
  *
  *   @Input("event")
- *   myMethod(@SocketSession session: Map) {
+ *   myMethod(@SocketSession session: SocketSession) {
  *     console.log(session);
  *   }
  * }
@@ -20,4 +20,25 @@ export type SocketSession = Map<string, any>;
  * @param {number} index
  * @decorator
  */
-export declare function SocketSession(target: any, propertyKey: string, index: number): any;
+export declare function SocketSession(target: any, propertyKey: string, index: number): void;
+/**
+ * Inject the raw `socket.data` in the decorated parameter.
+ *
+ * @example
+ * ```typescript
+ * @SocketService("/nsp")
+ * export class MyWS {
+ *
+ *   @Input("event")
+ *   myMethod(@RawSocketSession session: Record<string, unknown>) {
+ *     console.log(session);
+ *   }
+ * }
+ * ```
+ *
+ * @param target
+ * @param {string} propertyKey
+ * @param {number} index
+ * @constructor
+ */
+export declare function RawSocketSession(target: any, propertyKey: string, index: number): void;

package/lib/types/index.d.ts

@@ -4,6 +4,7 @@
 export * from "./SocketIOModule";
 export * from "./class/SocketHandlersBuilder";
 export * from "./class/SocketProviderMetadata";
+export * from "./class/SocketSessionData";
 export * from "./constants/constants";
 export * from "./decorators/args";
 export * from "./decorators/broadcast";
@@ -36,6 +37,5 @@ export * from "./interfaces/SocketParamMetadata";
 export * from "./interfaces/SocketProviderTypes";
 export * from "./interfaces/SocketReturnsTypes";
 export * from "./interfaces/interfaces";
-export * from "./registries/NspSessionRegistry";
 export * from "./services/SocketIOServer";
 export * from "./services/SocketIOService";

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

@@ -7,6 +7,7 @@ export declare enum SocketFilters {
     EVENT_NAME = "eventName",
     NSP = "nsp",
     SESSION = "session",
+    RAW_SESSION = "raw_session",
     ERR = "error",
     SOCKET_NSP = "socket_nsp",
     REASON = "reason"

package/package.json

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

package/readme.md

@@ -197,6 +197,33 @@ export class MySocketService {
 }
 ```
 
+The session represents an arbitrary object that facilitates the storage of session data, allowing the sharing of information between Socket.IO servers.
+
+In the event of an unexpected disconnection (i.e., when the socket is not manually disconnected using `socket.disconnect()`), the server will store the session of the socket. Upon reconnection, the server will make an attempt to restore the previous session.
+
+To enable this behavior, you need to configure the [Connection state recovery](https://socket.io/docs/v4/connection-state-recovery) as follows:
+
+```ts
+import {Configuration} from "@tsed/di";
+import "@tsed/platform-express";
+import "@tsed/socketio";
+
+@Configuration({
+  socketIO: {
+    // ... see configuration
+    connectionStateRecovery: {
+      // the backup duration of the sessions and the packets
+      maxDisconnectionDuration: 2 * 60 * 1000,
+      // whether to skip middlewares upon successful recovery
+      skipMiddlewares: true
+    }
+  }
+})
+export class Server {}
+```
+
+> By default, Ts.ED uses the built-in in-memory adapter for session management. However, for production environments, it is recommended to use [the persistent adapters](https://socket.io/docs/v4/connection-state-recovery#compatibility-with-existing-adapters) to enhance reliability.
+
 ### Middlewares
 
 A middleware can be also used on a `SocketService` either on a class or on a method.
@@ -258,6 +285,7 @@ Middlewares chain use the `Promise` to run it. If one of this middlewares/method
 import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args, SocketSession} from "@tsed/socketio";
 import {UserConverterSocketMiddleware, ErrorHandlerSocketMiddleware} from "../middlewares";
 import {User} from "../models/User";
+import {SocketSessionData} from "@tsed/socketio/lib/cjs";
 
 @SocketService("/my-namespace")
 @SocketUseBefore(UserConverterSocketMiddleware) // global version
@@ -267,7 +295,7 @@ export class MySocketService {
   @Emit("responseEventName") // or Broadcast or BroadcastOthers
   @SocketUseBefore(UserConverterSocketMiddleware)
   @SocketUseAfter(ErrorHandlerSocketMiddleware)
-  async myMethod(@Args(0) userName: User) {
+  async myMethod(@Args(0) userName: User, @SocketSessionData session: SocketSessionData) {
     const user = session.get("user") || {};
     user.name = userName;
 

package/lib/cjs/registries/NspSessionRegistry.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNspSession = void 0;
-/**
- *
- * @type {Map<any, any>}
- */
-const SESSIONS = new Map();
-function getNspSession(namespace = "/") {
-    if (!SESSIONS.has(namespace)) {
-        SESSIONS.set(namespace, new Map());
-    }
-    return SESSIONS.get(namespace);
-}
-exports.getNspSession = getNspSession;
-//# sourceMappingURL=NspSessionRegistry.js.map

package/lib/cjs/registries/NspSessionRegistry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NspSessionRegistry.js","sourceRoot":"","sources":["../../../src/registries/NspSessionRegistry.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAM,QAAQ,GAA2C,IAAI,GAAG,EAAE,CAAC;AAEnE,SAAgB,aAAa,CAAC,YAA6B,GAAG;IAC5D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAC5B,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;KACpC;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC;AAND,sCAMC"}

package/lib/esm/registries/NspSessionRegistry.js

@@ -1,12 +0,0 @@
-/**
- *
- * @type {Map<any, any>}
- */
-const SESSIONS = new Map();
-export function getNspSession(namespace = "/") {
-    if (!SESSIONS.has(namespace)) {
-        SESSIONS.set(namespace, new Map());
-    }
-    return SESSIONS.get(namespace);
-}
-//# sourceMappingURL=NspSessionRegistry.js.map

package/lib/esm/registries/NspSessionRegistry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NspSessionRegistry.js","sourceRoot":"","sources":["../../../src/registries/NspSessionRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,QAAQ,GAA2C,IAAI,GAAG,EAAE,CAAC;AAEnE,MAAM,UAAU,aAAa,CAAC,YAA6B,GAAG;IAC5D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAC5B,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;KACpC;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC"}

package/lib/types/registries/NspSessionRegistry.d.ts

@@ -1 +0,0 @@
-export declare function getNspSession(namespace?: string | RegExp): Map<string, any> | undefined;