Merge pull request nestjs#19 from kamilmysliwiec/master-final

Update to final version

Author: kamilmysliwiec

.gitignore

@@ -4,6 +4,7 @@
 # IDE
 /.idea
 /.awcache
+/.vscode
 
 # misc
 npm-debug.log

CHANGELOG.md

@@ -1,17 +1,98 @@
+## 1.0.0 (Final - 01.05.2017)
+
+- Added **Gateway Middlewares** support:
+
+```
+@WebSocketGateway({
+    port: 2000,
+    middlewares: [ChatMiddleware],
+})
+```
+Gateway Middleware example:
+```
+@Middleware()
+export class ChatMiddleware implements GatewayMiddleware {
+    public resolve(): (socket, next) => void {
+        return (socket, next) => {
+            console.log('Authorization...');
+            next();
+        };
+    }
+}
+```
+
+- New Gateway lifecycle interfaces `OnGatewayInit`, `OnGatewayConnection`, `OnGatewayDisconnect`
+- `@SubscribeMessage()` now accepts also plain strings:
+
+```
+@SubscribeMessage('event')
+```
+
+- `@Controller()` now accepts also plain strings: 
+
+```
+@Controller('users')
+```
+
+- `HttpStatus` (`HttpStatus.OK` etc.) enumerator
+- **Route params decorators** support 
+
+```
+Request: () => ParameterDecorator
+Response: () => ParameterDecorator
+Next: () => ParameterDecorator
+Query: (property?: string) => ParameterDecorator
+Body: (property?: string) => ParameterDecorator
+Param: (property?: string) => ParameterDecorator
+Session: () => ParameterDecorator
+Headers: (property?: string) => ParameterDecorator
+```
+
+- `MiddlewaresBuilder` -> `MiddlewaresConsumer`
+- **Exception Filters** support
+
+```
+@ExceptionFilters(CustomExceptionFilter, NextExceptionFilter)
+export class UsersController {}
+```
+Exception filter example:
+
+```
+export class CustomException {}
+
+@Catch(CustomException)
+export class CustomExceptionFilter implements ExceptionFilter {
+    public catch(exception, response) {
+        response.status(500).json({
+            message: 'Custom exception message.',
+        });
+    }
+}
+```
+- Module injection support:
+
+```
+export class UsersController {
+    constructor(private module: UsersModule) {}
+}
+```
+
+- `ModuleRef` support
+
 ## 1.0.0-RC7 (08.04.2017)
 
 - MiddlewareBuilder: `use()` deprecated, use `apply()` instead
 - MiddlewareBuilder: new `apply()` method
 
 ## 1.0.0-RC4 (08.04.2017)
 
-- Support for @Post, @Get, @Delete, @Put, @All decorators
+- Support for `@Post`, `@Get`, `@Delete`, `@Put`, `@All` decorators
 - Added ability to pass data to middleware metatypes
 
 ## 1.0.0-BETA-1 (23.03.2017)
 
-- @Inject -> @Dependencies
-- @Inject decorator for custom constructor parameters
+- `@Inject` -> `@Dependencies`
+- `@Inject` decorator for custom constructor parameters
 - Custom providers support (useClass, useValue, useFactory)
 
 ## 1.0.0-ALPHA-23 (19.03.2017)
@@ -20,6 +101,6 @@
 - NestRunner -> NestFactory
 - Simplify application initialization & configuration
 - Added abillity to pass custom express instance
-- @Inject decorator for ES6+
+- `@Inject` decorator for ES6+
 - SocketGateway -> WebSocketGateway
 - GatewayServer -> WebSocketServer

Readme.md

@@ -54,9 +54,8 @@ We want to create scalable, modern and easy to maintain applications. Nest helps
 Nest is very much still a work in progress. There is still some things to finish:
 
 - Examples(!)
-- Exception filters
 - Validation helpers
-- Gateways middleware
+- More test utilities
 - and more...
 
 ## People

example/math/modules/math.controller.ts

@@ -1,4 +1,4 @@
-import { Controller } from '../../../src/common/utils/controller.decorator';
+import { Controller } from '../../../src/common/utils/decorators/controller.decorator';
 import { MessagePattern } from '../../../src/microservices/utils/pattern.decorator';
 
 @Controller()

example/math/modules/microservice.module.ts

@@ -1,4 +1,4 @@
-import { Module } from '../../../src/common/utils/module.decorator';
+import { Module } from '../../../src/common/utils/decorators/module.decorator';
 import { MathController } from './math.controller';
 
 @Module({

example/modules/app.module.ts

@@ -4,6 +4,6 @@ import { ClientController } from './client/client.controller';
 
 @Module({
     modules: [ UsersModule ],
-    controllers: [ ClientController ]
+    controllers: [ ClientController ],
 })
 export class ApplicationModule {}

example/modules/client/client.controller.ts

@@ -1,19 +1,20 @@
-import { Controller } from '../../../src/common/utils/controller.decorator';
+import { Controller } from '../../../src/common/utils/decorators/controller.decorator';
 import { Client } from '../../../src/microservices/utils/client.decorator';
-import { RequestMapping } from '../../../src/common/utils/request-mapping.decorator';
+import { RequestMapping } from '../../../src/common/utils/decorators/request-mapping.decorator';
 import { ClientProxy } from '../../../src/microservices/client/client-proxy';
 import { Observable } from 'rxjs';
 import { Transport } from '../../../src/common/enums/transport.enum';
 import 'rxjs/add/operator/catch';
 
+const MicroserviceClient = { transport: Transport.TCP, port: 5667 };
+
 @Controller()
 export class ClientController {
-
-    @Client({ transport: Transport.TCP, port: 5667 })
-    client: ClientProxy;
+    @Client(MicroserviceClient)
+    public client: ClientProxy;
 
     @RequestMapping({ path: 'client' })
-    sendMessage(req, res) {
+    public sendMessage(req, res) {
         const pattern = { command: 'add' };
         const data = [ 1, 2, 3, 4, 5 ];
 

example/modules/shared/shared.module.ts

@@ -1,8 +1,8 @@
-import { Module } from '../../../src/common/utils/module.decorator';
+import { Module } from '../../../src/common/utils/decorators/module.decorator';
 import { ChatGateway } from '../users/chat.gateway';
 
 @Module({
     components: [ ChatGateway ],
-    exports: [ ChatGateway ]
+    exports: [ ChatGateway ],
 })
 export class SharedModule {}

example/modules/users/auth.middleware.ts

@@ -7,18 +7,17 @@ import { NestMiddleware } from '../../../src/core/middlewares/interfaces/nest-mi
 export class AuthMiddleware implements NestMiddleware {
     constructor(private usersService: UsersService) {}
 
-    resolve() {
+    public resolve() {
         return (req, res, next) => {
-            const userName = req.headers['x-access-token'];
+            const username = req.headers['x-access-token'];
             const users = this.usersService.getUsers();
-
-            const user = users.find((user) => user.name === userName);
+            const user = users.find(({ name }) => name === username);
             if (!user) {
                 throw new HttpException('User not found.', 401);
             }
             req.user = user;
             next();
-        }
+        };
     }
 
 }

example/modules/users/chat.gateway.ts

@@ -1,21 +1,21 @@
 import { WebSocketGateway } from '../../../src/websockets/utils/socket-gateway.decorator';
 import { SubscribeMessage } from '../../../src/websockets/utils/subscribe-message.decorator';
-import { Subject } from 'rxjs/Subject';
 import { WebSocketServer } from '../../../src/websockets/utils/gateway-server.decorator';
+import { OnGatewayInit, OnGatewayConnection } from '../../../src/websockets/index';
+import { ChatMiddleware } from './chat.middleware';
 
-@WebSocketGateway({ port: 2000 })
-export class ChatGateway {
-    private msg$ = new Subject<any>();
+@WebSocketGateway({
+    port: 2000,
+    middlewares: [ ChatMiddleware ],
+})
+export class ChatGateway implements OnGatewayInit, OnGatewayConnection {
+    @WebSocketServer() private server;
 
-    @WebSocketServer() server;
+    public afterInit(server) {}
+    public handleConnection(client) {}
 
-    get msgStream() {
-        return this.msg$.asObservable();
+    @SubscribeMessage('event')
+    public onMessage(client, data) {
+        client.emit('event', data);
     }
-
-    @SubscribeMessage({ value: 'message' })
-    onMessage(client, data) {
-        this.msg$.next({ client, data });
-    }
-
 }