Socket 2.0.0 (#43)

* feat(socket): Refactoring for 2.0.0

* chore(socket): Fixed empty middleware issue && adjusted example accordingly

* chore(socket): Small polishing, plus added WrapperClass option for IO Decorator

package.json

@@ -4,16 +4,15 @@
   "description": "node decorators",
   "main": "index.js",
   "scripts": {
-    "compile": "tsc"
+    "compile": "tsc",
+    "clean-tsc": "find . -name \"*.js\" -type f -not -path \"./node_modules/*\" -delete && find . -name \"*.js.map\" -type f -not -path \"./node_modules/*\" -delete && find . -name \"*.d.ts\" -type f -not -path \"./node_modules/*\" -not -path \"./types/*\" -delete"
   },
   "dependencies": {
     "co": "4.6.0",
-    "express": "4.14.0",
-    "socket.io": "1.7.2"
+    "express": "4.14.0"
   },
   "devDependencies": {
     "@types/express": "4.0.34",
-    "@types/socket.io": "1.4.27",
     "typescript": "2.1.1"
   },
   "keywords": [

playground/socket/index.ts

@@ -1,55 +1,32 @@
 import { listen } from 'socket.io';
 import {
-  Middleware,
-  GlobalMiddleware,
-  ServerMiddleware,
   Event,
+  attachControllers,
+  Controller,
+  Socket,
   Args,
-  bootstrapSocketIO,
-  Namespace,
-  Socket
+  IO,
+  Ack
 } from '@decorators/socket';
 
 const server = listen(3000);
 
-class SocketWrapper {
-  constructor(private socket: SocketIO.Socket) {}
-
-  log() {
-    console.log('Log');
+class Wrapper {
+  constructor(data: any) {
+    console.log('Wrapper');
   }
 }
 
-@ServerMiddleware((io, socket, next) => {
-  console.log('Global Server Middleware');
-  next();
-})
-@GlobalMiddleware((io, socket, packet, next) => {
-  console.log('Global socket middleware');
-  next();
-})
-@Middleware((io, socket, packet, next) => {
-  console.log('Controller based middleware');
-  next();
-})
-@Namespace('/messaging')
-class FirstController {
-
-  constructor(...args) {
-    console.log(args);
-  }
+@Controller('/')
+class MessagingController {
 
-  @Event('message', (io, socket, packet, next) => {
-    console.log('Message middleware');
-    next();
-  })
-  onMessage(@Args() message, @Socket(SocketWrapper) socket: SocketWrapper) {
-    socket.log();
-    console.log(`Message:  ${message}`);
+  @Event('message')
+  onMessage(@Args() message: string) {
+    console.log(
+      `Message: ${message}`
+    );
   }
 
 }
 
-bootstrapSocketIO(server, [
-  { provide: FirstController, deps: [1, 2, 3]}
-]);
+attachControllers(server, [ MessagingController ]);

playground/socket/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@decorators/playground-socket",
-  "version": "1.3.3",
+  "version": "2.0.0",
   "description": "node decorators",
   "main": "index.js",
   "dependencies": {
-    "@decorators/socket": "../../socket"
+    "@decorators/socket": "../../socket",
+    "@types/socket.io": "1.4.29"
   },
   "keywords": [
     "nodejs",

socket/CHANGELOG.md

@@ -1,3 +1,15 @@
+# Socket#2.0.0
+* Features
+  * Added wrap option for **@IO(WrapperClass?)** decorator, see **@Socket()** decorator for details
+* Renamed
+  * **@Callback()** to **@Ack()**
+  * **@GlobalMiddleware()** for socket global middleware to **@Middleware()**
+  * Renamed **@Namespace()** to **@Controller(namespace: string, middleware?: Function | Function[])**
+* Removed
+  * **@Middleware(middleware: Function | Function[])** - use Controller based middleware
+  * deprecated **bootstrapSocketIO(io: SocketIO.Server, Controllers)** -  Attaches controllers to IO server - use **attachControllers()** instead
+  * deprecated **attachControllerToSocket(io: SocketIO.Server, socket: SocketIO.Socket, Controllers)** -  Attaches controllers to Socket - use **attachControllersToSocket()** instead
+
 # Socket#1.4.0
 * Controller DI
 ```typescript
@@ -71,7 +83,7 @@ class SocketWrapper {
   * **bootstrapSocketIO(rootController: Controller)**
   ##### Class
   * **@Connect(serverOrPort: number | string | HttpServer, opts?: any)**
-  * **@Middleware(fn: Function)** 
+  * **@Middleware(fn: Function)**
   ##### Method
   * **@OnIO(event: string)**
   * **@OnConnect()**

socket/README.md

@@ -1,27 +1,16 @@
 ![Node Decorators](https://github.com/serhiisol/node-decorators/blob/master/decorators.png?raw=true)
 
-Project implements decorators for modern tools for NodeJS like:
-- [Socket.IO]
+Project implements decorators for [Socket.IO]
 
 ### Installation
 ```
 npm install @decorators/socket --save
 ```
 ### API
-#### Functions
-* **attachControllers(io: SocketIO.Server, Controller[] || Injectable[])** -  Attaches controllers to IO server
-* **attachControllersToSocket(io: SocketIO.Server, socket: SocketIO.Socket, Controller[] || Injectable[])** -  Attaches controllers to Socket
-where Injectable:
-```typescript
-{ provide: UserController, deps: [UserService] }
-```
 
-* **bootstrapSocketIO(io: SocketIO.Server, Controllers)** -  Attaches controllers to IO server - **_[deprecated, use attachControllers - will be removed in v2.0.0 of this library]_**
-* **attachControllerToSocket(io: SocketIO.Server, socket: SocketIO.Socket, Controllers)** -  Attaches controllers to Socket - **_[deprecated, use attachControllersToSocket - will be removed in v2.0.0 of this library]_**
-
 #### Decorators
 ##### Class
-* **@Namespace(namespace: string)** - registers controller for namespace
+* **@Controller(namespace?: string, middleware?: Function | Function[])** - registers controller for controller
 
 * **@ServerMiddleware(middleware: Function | Function[])** - registers global server (io) middleware
 ```typescript
@@ -32,9 +21,7 @@ function middleware(
 ) {}
 ```
 
-* **@GlobalMiddleware(middleware: Function | Function[]) => {})** - registers socket global middleware
-* **@Middleware(middleware: Function | Function[])** - registers controller-based middleware, 
-will handle only socket events registered in controller
+* **@Middleware(middleware: Function | Function[]) => {})** - registers socket global middleware
 ```typescript
 function middleware(
   io: SocketIO.Server | SocketIO.Namespace,
@@ -45,11 +32,11 @@ function middleware(
 ```
 
 ##### Method
-* **@GlobalEvent(event: string)** - register global event (**io.on**)
 * **@Connection()** - register **connection** listener (**io.on('connection', fn)**)
 * **@Disconnect()** - register disconnect socket event (**socket.on('disconnect', fn)**)
+* **@GlobalEvent(event: string)** - register global event (**io.on**)
 
-* **@Event(event: string, middleware || \[middleware\])** - register socket event (**socket.on**),
+* **@Event(event: string, middleware?: Function | Function[])** - register socket event (**socket.on**),
 where middleware is a function which accepts four parameters:
 ```typescript
 function middleware(
@@ -61,45 +48,60 @@ function middleware(
 ```
 
 ##### Parameter
-* **@IO()** - returns server itself
-* **@Socket(WrapperClass?: Class)** - returns socket, if **WrapperClass** provided, returns instance 
-of **WrapperClass**, passes **socket** as dependency into **WrapperClass**
+* **@IO(WrapperClass?: Class)** - returns server itself
+* **@Socket(WrapperClass?: Class)** - returns socket
+
+If **WrapperClass** provided, returns instance
+of **WrapperClass**, passes **socket** or **server** as dependency into **WrapperClass**
+
 ```typescript
 class SocketWrapper {
-  constructor(private socket: SocketIO.Socket) {}
+  constructor(private ioSock: SocketIO.Server|SocketIO.Namespace|SocketIO.Socket) {}
 }
 ```
-* **@Args()** - returns event arguments (excluding callback)(if it exists)
-* **@Callback()** - returns callback function (if it exists)
+
+* **@Args()** - returns event arguments (excluding callback, if it exists)
+* **@Ack()** - returns ack callback function (if it exists)
+
+#### Helper Functions
+* **attachControllers(io: SocketIO.Server, Controller[] || Injectable[])** -  Attaches controllers to IO server
+* **attachControllersToSocket(io: SocketIO.Server, socket: SocketIO.Socket, Controller[] || Injectable[])** -  Attaches controllers to Socket
+
+where Injectable:
+```typescript
+{ provide: UserController, deps: [UserService] }
+```
 
 ### Details
 #### Middleware
 The middleware order :
-* Global Server Middleware
-* Global Socket middleware
-* Controller based middleware
-* Event based middleware
-Additionally to this order depends on the order how you've registered appropriate types of middleware 
+* Global Server Middleware (**io.use(...)**)
+* Global Socket middleware (**socket.use(...)**)
+* Controller based middleware (**@Controller(...)**)
+* Event based middleware (**@Event(...)**)
+
+Additionally to this order depends on the order how you've registered appropriate types of middleware
 
 ### Quick Example:
 ```typescript
 import { listen } from 'socket.io';
-import { Event, Args, bootstrapSocketIO, Namespace } from '@decorators/socket';
+import { Event, Args, attachControllers, Controller } from '@decorators/socket';
 
 const server = listen(3000);
 
-@Namespace('/messaging')
+@Controller('/')
 class MessageController {
+
   @Event('message')
   onMessage(@Args() message) {
-    console.log(`Message:  ${message}`);
+    console.log(
+      `Message:  ${message}`
+    );
   }
+
 }
 
-bootstrapSocketIO(server, [ MessageController ]);
+attachControllers(server, [ MessageController ]);
 ```
 
-### License
-MIT
-
 [Socket.IO]:http://socket.io/

socket/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@decorators/socket",
-  "version": "1.4.0",
-  "description": "node decorators",
-  "main": "index.js",
+  "version": "2.0.0",
+  "description": "node decorators - decorators for socket.io library",
+  "main": "src/index.js",
   "dependencies": {
-    "socket.io": "1.7.2"
+    "socket.io": ">=1.7.3"
+  },
+  "devDependencies": {
+    "@types/socket.io": "1.4.29",
+    "typescript": "2.2.2"
   },
   "keywords": [
     "nodejs",