@tsed/socketio 7.0.0-beta.1 → 7.0.0-beta.4

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

@@ -0,0 +1,8 @@
+import SocketIO from "socket.io";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            socketIO: Partial<SocketIO.ServerOptions>;
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/socketio",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0-beta.4",
   "description": "Socket.io package for Ts.ED framework",
   "private": false,
   "keywords": [
@@ -12,6 +12,7 @@
   ],
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     "types": "./lib/types/index.d.ts",
@@ -20,41 +21,55 @@
     "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "yarn run build:esm && yarn run build:cjs",
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
     "build:cjs": "tsc --build tsconfig.compile.json",
     "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
     "start": "ts-node -r tsconfig-paths/register test/app/index.ts",
     "test": "cross-env NODE_ENV=test nyc mocha"
   },
   "dependencies": {
-    "tslib": "2.2.0"
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/common": "7.0.0-beta.1",
-    "@tsed/core": "7.0.0-beta.1",
-    "@tsed/di": "7.0.0-beta.1",
-    "@tsed/json-mapper": "7.0.0-beta.1",
-    "@tsed/openspec": "7.0.0-beta.1",
-    "@tsed/schema": "7.0.0-beta.1",
+    "@tsed/common": "7.0.0-beta.4",
+    "@tsed/core": "7.0.0-beta.4",
+    "@tsed/di": "7.0.0-beta.4",
+    "@tsed/json-mapper": "7.0.0-beta.4",
+    "@tsed/openspec": "7.0.0-beta.4",
+    "@tsed/platform-middlewares": "7.0.0-beta.4",
+    "@tsed/schema": "7.0.0-beta.4",
     "express": "^4.17.1",
-    "socket.io": "4.1.2",
+    "socket.io": "4.4.1",
     "socket.io-client": "^4.1.2"
   },
   "peerDependencies": {
-    "@tsed/common": "^7.0.0-beta.1",
-    "@tsed/core": "^7.0.0-beta.1",
-    "@tsed/di": "^7.0.0-beta.1",
-    "@tsed/json-mapper": "^7.0.0-beta.1",
-    "@tsed/logger": ">=6.0.0",
-    "@tsed/openspec": "^7.0.0-beta.1",
-    "@tsed/schema": "^7.0.0-beta.1",
+    "@tsed/di": "^7.0.0-beta.4",
+    "@tsed/json-mapper": "^7.0.0-beta.4",
+    "@tsed/logger": ">=6.1.1",
+    "@tsed/platform-middlewares": "^7.0.0-beta.4",
+    "@tsed/schema": "^7.0.0-beta.4",
     "socket.io": ">=4.0.0"
   },
+  "peerDependenciesMeta": {
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/platform-middlewares": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    }
+  },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/third-parties/socketio",
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/third-parties/socketio",
   "author": "Romain Lenzotti",
   "license": "MIT"
 }

package/readme.md

@@ -45,24 +45,20 @@ Then add the following configuration in your Server:
 import {Configuration} from "@tsed/common";
 import "@tsed/socketio"; // import socketio Ts.ED module
 import {resolve} from "path";
-const rootDir = resolve(__dirname)
 
 @Configuration({
-    rootDir,
-    socketIO: {
-        // ... see configuration
-    }
+  socketIO: {
+    // ... see configuration
+  }
 })
-export class Server {
-
-}
+export class Server {}
 ```
 
 ## Socket Service
 
 > Socket.IO allows you to “namespace” your sockets, which essentially means assigning different endpoints or paths.
-This is a useful feature to minimize the number of resources (TCP connections) and at the same time separate concerns within your application
- by introducing separation between communication channels. See [namespace documentation](https://socket.io/docs/rooms-and-namespaces/#).
+> This is a useful feature to minimize the number of resources (TCP connections) and at the same time separate concerns within your application
+> by introducing separation between communication channels. See [namespace documentation](https://socket.io/docs/rooms-and-namespaces/#).
 
 All Socket service work under a namespace and you can create one Socket service per namespace.
 
@@ -74,31 +70,24 @@ import {SocketService, IO, Nsp, Socket, SocketSession} from "@tsed/socketio";
 
 @SocketService("/my-namespace")
 export class MySocketService {
-
-    @Nsp nsp: SocketIO.Namespace; 
-    
-    @Nsp("/my-other-namespace") 
-    nspOther: SocketIO.Namespace; // communication between two namespace
-
-    constructor(@IO private io: SocketIO.Server) {}
-    /**
-     * Triggered the namespace is created
-     */
-    $onNamespaceInit(nsp: SocketIO.Namespace) {
-
-    }
-    /**
-     * Triggered when a new client connects to the Namespace.
-     */
-    $onConnection(@Socket socket: SocketIO.Socket, @SocketSession session: SocketSession) {
-
-    }
-    /**
-     * Triggered when a client disconnects from the Namespace.
-     */
-    $onDisconnect(@Socket socket: SocketIO.Socket) {
-
-    }
+  @Nsp nsp: SocketIO.Namespace;
+
+  @Nsp("/my-other-namespace")
+  nspOther: SocketIO.Namespace; // communication between two namespace
+
+  constructor(@IO private io: SocketIO.Server) {}
+  /**
+   * Triggered the namespace is created
+   */
+  $onNamespaceInit(nsp: SocketIO.Namespace) {}
+  /**
+   * Triggered when a new client connects to the Namespace.
+   */
+  $onConnection(@Socket socket: SocketIO.Socket, @SocketSession session: SocketSession) {}
+  /**
+   * Triggered when a client disconnects from the Namespace.
+   */
+  $onDisconnect(@Socket socket: SocketIO.Socket) {}
 }
 ```
 
@@ -112,13 +101,14 @@ import {SocketService, Nsp} from "@tsed/socketio";
 
 @SocketService()
 export class MySocketService {
-     @Nsp nsp: SocketIO.Namespace;
+  @Nsp nsp: SocketIO.Namespace;
 
-     helloAll() {
-         this.nsp.emit('hi', 'everyone!');
-     }
+  helloAll() {
+    this.nsp.emit("hi", "everyone!");
+  }
 }
 ```
+
 Then, you can inject your socket service into another Service, Controller, etc... as following:
 
 ```typescript
@@ -127,16 +117,13 @@ import {MySocketService} from "../services/MySocketService";
 
 @Controller("/")
 export class MyCtrl {
-   
-    constructor(private mySocketService: MySocketService) {
-         
-    }
-
-    @Get("/allo")
-    allo() {
-         this.mySocketService.helloAll(); 
-         return "is sent";
-    }
+  constructor(private mySocketService: MySocketService) {}
+
+  @Get("/allo")
+  allo() {
+    this.mySocketService.helloAll();
+    return "is sent";
+  }
 }
 ```
 
@@ -149,10 +136,10 @@ import {SocketService, Input, Emit, Args, Socket, Nsp} from "@tsed/socketio";
 
 @SocketService("/my-namespace")
 export class MySocketService {
-    @Input("eventName")
-    myMethod(@Args(0) userName: string, @Socket socket: SocketIO.Socket, @Nsp nsp: SocketIO.Namespace) {
-        console.log(userName);
-    }
+  @Input("eventName")
+  myMethod(@Args(0) userName: string, @Socket socket: SocketIO.Socket, @Nsp nsp: SocketIO.Namespace) {
+    console.log(userName);
+  }
 }
 ```
 
@@ -173,13 +160,14 @@ import {SocketService, Input, Emit, Args, Socket, Nsp} from "@tsed/socketio";
 
 @SocketService("/my-namespace")
 export class MySocketService {
-    @Input("eventName")
-    @Emit("responseEventName") // or Broadcast or BroadcastOthers
-    async myMethod(@Args(0) userName: string, @Socket socket: SocketIO.Socket) {
-        return "Message " + userName;
-    }
+  @Input("eventName")
+  @Emit("responseEventName") // or Broadcast or BroadcastOthers
+  async myMethod(@Args(0) userName: string, @Socket socket: SocketIO.Socket) {
+    return "Message " + userName;
+  }
 }
 ```
+
 > The method accept a promise as returned value.
 
 ::: warning
@@ -195,17 +183,16 @@ import {SocketService, Input, Emit, Args, SocketSession} from "@tsed/socketio";
 
 @SocketService("/my-namespace")
 export class MySocketService {
-    @Input("eventName")
-    @Emit("responseEventName") // or Broadcast or BroadcastOthers
-    async myMethod(@Args(0) userName: string, @SocketSession session: SocketSession) {
+  @Input("eventName")
+  @Emit("responseEventName") // or Broadcast or BroadcastOthers
+  async myMethod(@Args(0) userName: string, @SocketSession session: SocketSession) {
+    const user = session.get("user") || {};
+    user.name = userName;
 
-        const user = session.get("user") || {}
-        user.name = userName;
+    session.set("user", user);
 
-        session.set("user", user);
-
-        return user;
-    }
+    return user;
+  }
 }
 ```
 
@@ -222,16 +209,16 @@ import {User} from "../models/User";
 
 @SocketMiddleware()
 export class UserConverterSocketMiddleware {
-    async use(@Args() args: any[]) {
-        
-        let [user] = args;
-        // update Arguments
-        user = deserialize(user, {type: User});
-
-        return [user];
-    }
+  async use(@Args() args: any[]) {
+    let [user] = args;
+    // update Arguments
+    user = deserialize(user, {type: User});
+
+    return [user];
+  }
 }
 ```
+
 > The user instance will be forwarded to the next middleware and to your decorated method.
 
 You can also declare a middleware to handle an error with `@SocketMiddlewareError`.
@@ -242,10 +229,10 @@ import {SocketMiddlewareError, SocketErr, Socket} from "@tsed/socketio";
 
 @SocketMiddlewareError()
 export class ErrorHandlerSocketMiddleware {
-    async use(@SocketErr err: any, @Socket socket: SocketIO.Socket) {
-        console.error(err);
-        socket.emit("error", {message: "An error has occured"})
-    }
+  async use(@SocketErr err: any, @Socket socket: SocketIO.Socket) {
+    console.error(err);
+    socket.emit("error", {message: "An error has occured"});
+  }
 }
 ```
 
@@ -261,7 +248,7 @@ The call sequences is the following for each event request:
 - Middlewares attached with `@SocketUseBefore` on method,
 - The method,
 - Send response if the method is decorated with `@Emit`, `@Broadcast` or `@BroadcastOther`,
-- Middlewares attached with `@SocketUseAfter` on method, 
+- Middlewares attached with `@SocketUseAfter` on method,
 - Middlewares attached with `@SocketUseAfter` on class.
 
 Middlewares chain use the `Promise` to run it. If one of this middlewares/method emit an error, the first middleware error will be called.
@@ -275,20 +262,18 @@ import {User} from "../models/User";
 @SocketUseBefore(UserConverterSocketMiddleware) // global version
 @SocketUseAfter(ErrorHandlerSocketMiddleware)
 export class MySocketService {
-    
-    @Input("eventName")
-    @Emit("responseEventName") // or Broadcast or BroadcastOthers
-    @SocketUseBefore(UserConverterSocketMiddleware)
-    @SocketUseAfter(ErrorHandlerSocketMiddleware)
-    async myMethod(@Args(0) userName: User) {
-
-        const user = session.get("user") || {}
-        user.name = userName;
-
-        session.set("user", user);
-
-        return user;
-    }
+  @Input("eventName")
+  @Emit("responseEventName") // or Broadcast or BroadcastOthers
+  @SocketUseBefore(UserConverterSocketMiddleware)
+  @SocketUseAfter(ErrorHandlerSocketMiddleware)
+  async myMethod(@Args(0) userName: User) {
+    const user = session.get("user") || {};
+    user.name = userName;
+
+    session.set("user", user);
+
+    return user;
+  }
 }
 ```
 
@@ -297,18 +282,17 @@ export class MySocketService {
 See our documentation https://tsed.io/#/api/index
 
 ## Contributors
+
 Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
 
 <a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
 
-
 ## Backers
 
 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
 
 <a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
 
-
 ## Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]

package/tsconfig.compile.esm.json

@@ -8,16 +8,5 @@
     "declaration": true,
     "declarationDir": "./lib/types"
   },
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js"
-  ]
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
 }

package/lib/cjs/constants/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/constants/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,4BAA4B,GAAG,eAAe,CAAC","sourcesContent":["export const PROVIDER_TYPE_SOCKET_SERVICE = \"socketService\";\n"]}

package/lib/cjs/interfaces/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./SocketHandlerMetadata"), exports);
-(0, tslib_1.__exportStar)(require("./SocketParamMetadata"), exports);
-(0, tslib_1.__exportStar)(require("./SocketProviderTypes"), exports);
-(0, tslib_1.__exportStar)(require("./OnNamespaceInit"), exports);
-(0, tslib_1.__exportStar)(require("./SocketFilters"), exports);
-(0, tslib_1.__exportStar)(require("./SocketReturnsTypes"), exports);
-(0, tslib_1.__exportStar)(require("./SocketInjectableNsp"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/interfaces/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":";;;AAUA,uEAAwC;AACxC,qEAAsC;AACtC,qEAAsC;AACtC,iEAAkC;AAClC,+DAAgC;AAChC,oEAAqC;AACrC,qEAAsC","sourcesContent":["import SocketIO from \"socket.io\";\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      socketIO: Partial<SocketIO.ServerOptions>;\n    }\n  }\n}\n\nexport * from \"./SocketHandlerMetadata\";\nexport * from \"./SocketParamMetadata\";\nexport * from \"./SocketProviderTypes\";\nexport * from \"./OnNamespaceInit\";\nexport * from \"./SocketFilters\";\nexport * from \"./SocketReturnsTypes\";\nexport * from \"./SocketInjectableNsp\";\n"]}

package/lib/esm/constants/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/constants/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,4BAA4B,GAAG,eAAe,CAAC","sourcesContent":["export const PROVIDER_TYPE_SOCKET_SERVICE = \"socketService\";\n"]}

package/lib/esm/interfaces/index.js

@@ -1,8 +0,0 @@
-export * from "./SocketHandlerMetadata";
-export * from "./SocketParamMetadata";
-export * from "./SocketProviderTypes";
-export * from "./OnNamespaceInit";
-export * from "./SocketFilters";
-export * from "./SocketReturnsTypes";
-export * from "./SocketInjectableNsp";
-//# sourceMappingURL=index.js.map

package/lib/esm/interfaces/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"AAUA,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC","sourcesContent":["import SocketIO from \"socket.io\";\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      socketIO: Partial<SocketIO.ServerOptions>;\n    }\n  }\n}\n\nexport * from \"./SocketHandlerMetadata\";\nexport * from \"./SocketParamMetadata\";\nexport * from \"./SocketProviderTypes\";\nexport * from \"./OnNamespaceInit\";\nexport * from \"./SocketFilters\";\nexport * from \"./SocketReturnsTypes\";\nexport * from \"./SocketInjectableNsp\";\n"]}

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

@@ -1,15 +0,0 @@
-import SocketIO from "socket.io";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            socketIO: Partial<SocketIO.ServerOptions>;
-        }
-    }
-}
-export * from "./SocketHandlerMetadata";
-export * from "./SocketParamMetadata";
-export * from "./SocketProviderTypes";
-export * from "./OnNamespaceInit";
-export * from "./SocketFilters";
-export * from "./SocketReturnsTypes";
-export * from "./SocketInjectableNsp";