@tsed/socketio-testing 7.0.0-beta.1 → 7.0.0-beta.12

package/lib/cjs/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./services/SocketClientService"), exports);
+tslib_1.__exportStar(require("./services/SocketClientService"), exports);
 //# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,8EAA+C","sourcesContent":["export * from \"./services/SocketClientService\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yEAA+C","sourcesContent":["export * from \"./services/SocketClientService\";\n"]}

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/cjs/services/SocketClientService.js

@@ -29,15 +29,15 @@ let SocketClientService = class SocketClientService {
         this.logger.debug("Socket.io clients closed...");
     }
 };
-(0, tslib_1.__decorate)([
+tslib_1.__decorate([
     (0, di_1.Configuration)(),
-    (0, tslib_1.__metadata)("design:type", Object)
+    tslib_1.__metadata("design:type", Object)
 ], SocketClientService.prototype, "settings", void 0);
-(0, tslib_1.__decorate)([
+tslib_1.__decorate([
     (0, common_1.Inject)(),
-    (0, tslib_1.__metadata)("design:type", common_1.Logger)
+    tslib_1.__metadata("design:type", common_1.Logger)
 ], SocketClientService.prototype, "logger", void 0);
-SocketClientService = (0, tslib_1.__decorate)([
+SocketClientService = tslib_1.__decorate([
     (0, di_1.Injectable)()
 ], SocketClientService);
 exports.SocketClientService = SocketClientService;

package/lib/cjs/services/SocketClientService.js.map

@@ -1 +1 @@
-{"version":3,"file":"SocketClientService.js","sourceRoot":"","sources":["../../../src/services/SocketClientService.ts"],"names":[],"mappings":";;;;AAAA,yCAAuD;AACvD,iCAAmD;AACnD,uDAA4C;AAG5C,IAAa,mBAAmB,GAAhC,MAAa,mBAAmB;IAAhC;QAOU,YAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;IA4BnD,CAAC;IA1BC,KAAK,CAAC,GAAG,CAAC,YAAoB,GAAG,EAAE,IAAa;QAC9C,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;SACrC;QAED,MAAM,EAAC,OAAO,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,UAAU,OAAO,IAAI,IAAI,GAAG,SAAS,EAAE,CAAC;QAEpD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,IAAA,qBAAE,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEnD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;CACF,CAAA;AAjCC;IADC,IAAA,kBAAa,GAAE;;qDACgB;AAGhC;IADC,IAAA,eAAM,GAAE;2CACO,eAAM;mDAAC;AALZ,mBAAmB;IAD/B,IAAA,eAAU,GAAE;GACA,mBAAmB,CAmC/B;AAnCY,kDAAmB","sourcesContent":["import {Inject, Logger, OnDestroy} from \"@tsed/common\";\nimport {Configuration, Injectable} from \"@tsed/di\";\nimport {io, Socket} from \"socket.io-client\";\n\n@Injectable()\nexport class SocketClientService implements OnDestroy {\n  @Configuration()\n  private settings: Configuration;\n\n  @Inject()\n  private logger: Logger;\n\n  private clients: Map<string, Socket> = new Map();\n\n  async get(namespace: string = \"/\", path?: string): Promise<Socket> {\n    if (this.clients.has(namespace)) {\n      return this.clients.get(namespace)!;\n    }\n\n    const {address, port} = this.settings.getHttpPort();\n    const uri = `http://${address}:${port}${namespace}`;\n\n    this.logger.info(\"Bind Socket.io client on:\", uri);\n    const client = io(uri, path ? {path} : undefined);\n\n    this.clients.set(namespace, client);\n\n    await new Promise((resolve) => {\n      client.on(\"connect\", resolve as any);\n    });\n\n    this.logger.debug(\"Socket.io client connected...\");\n\n    return client;\n  }\n\n  $onDestroy() {\n    this.clients.forEach((client) => client.close());\n    this.logger.debug(\"Socket.io clients closed...\");\n  }\n}\n"]}
+{"version":3,"file":"SocketClientService.js","sourceRoot":"","sources":["../../../src/services/SocketClientService.ts"],"names":[],"mappings":";;;;AAAA,yCAAuD;AACvD,iCAAmD;AACnD,uDAA4C;AAG5C,IAAa,mBAAmB,GAAhC,MAAa,mBAAmB;IAAhC;QAOU,YAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;IA4BnD,CAAC;IA1BC,KAAK,CAAC,GAAG,CAAC,YAAoB,GAAG,EAAE,IAAa;QAC9C,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;SACrC;QAED,MAAM,EAAC,OAAO,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,UAAU,OAAO,IAAI,IAAI,GAAG,SAAS,EAAE,CAAC;QAEpD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,IAAA,qBAAE,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEnD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;CACF,CAAA;AAjCC;IADC,IAAA,kBAAa,GAAE;;qDACgB;AAGhC;IADC,IAAA,eAAM,GAAE;sCACO,eAAM;mDAAC;AALZ,mBAAmB;IAD/B,IAAA,eAAU,GAAE;GACA,mBAAmB,CAmC/B;AAnCY,kDAAmB","sourcesContent":["import {Inject, Logger, OnDestroy} from \"@tsed/common\";\nimport {Configuration, Injectable} from \"@tsed/di\";\nimport {io, Socket} from \"socket.io-client\";\n\n@Injectable()\nexport class SocketClientService implements OnDestroy {\n  @Configuration()\n  private settings: Configuration;\n\n  @Inject()\n  private logger: Logger;\n\n  private clients: Map<string, Socket> = new Map();\n\n  async get(namespace: string = \"/\", path?: string): Promise<Socket> {\n    if (this.clients.has(namespace)) {\n      return this.clients.get(namespace)!;\n    }\n\n    const {address, port} = this.settings.getHttpPort();\n    const uri = `http://${address}:${port}${namespace}`;\n\n    this.logger.info(\"Bind Socket.io client on:\", uri);\n    const client = io(uri, path ? {path} : undefined);\n\n    this.clients.set(namespace, client);\n\n    await new Promise((resolve) => {\n      client.on(\"connect\", resolve as any);\n    });\n\n    this.logger.debug(\"Socket.io client connected...\");\n\n    return client;\n  }\n\n  $onDestroy() {\n    this.clients.forEach((client) => client.close());\n    this.logger.debug(\"Socket.io clients closed...\");\n  }\n}\n"]}

package/lib/esm/index.js

@@ -1,2 +1,2 @@
-export * from "./services/SocketClientService";
+export * from "./services/SocketClientService.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tsed/socketio-testing",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0-beta.12",
   "description": "Socket.io testing package for Ts.ED framework",
   "private": false,
   "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",
@@ -19,25 +20,28 @@
     "start": "ts-node -r tsconfig-paths/register test/app/index.ts"
   },
   "dependencies": {
-    "tslib": "2.2.0"
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/common": "7.0.0-beta.1",
-    "@tsed/di": "7.0.0-beta.1",
+    "@tsed/common": "7.0.0-beta.12",
+    "@tsed/di": "7.0.0-beta.12",
     "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/socketio": "^7.0.0-beta.1",
+    "@tsed/common": "^7.0.0-beta.12",
+    "@tsed/core": "^7.0.0-beta.12",
+    "@tsed/di": "^7.0.0-beta.12",
+    "@tsed/socketio": "^7.0.0-beta.12",
     "socket.io-client": "^4.0.1"
   },
   "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-testing",
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/third-parties/socketio-testing",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "beta"
+  }
 }

package/readme.md

@@ -11,7 +11,8 @@
 [![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![backers](https://opencollective.com/tsed/tiers/badge.svg)](https://opencollective.com/tsed)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
 
 </div>
 
@@ -44,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.
 
@@ -73,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) {}
 }
 ```
 
@@ -111,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
@@ -126,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";
+  }
 }
 ```
 
@@ -148,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);
+  }
 }
 ```
 
@@ -172,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
@@ -194,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;
+  }
 }
 ```
 
@@ -221,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`.
@@ -241,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"});
+  }
 }
 ```
 
@@ -260,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.
@@ -274,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;
+  }
 }
 ```
 
@@ -296,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"]
 }