Update inversify and adjust naming of all annotations

hirsch88 · hirsch88 · commit becf33ace0f7 · 2017-07-11T20:21:27.000+02:00
diff --git a/package.json b/package.json
@@ -103,8 +103,8 @@
     "handlebars": "^4.0.10",
     "helmet": "^3.6.1",
     "inquirer": "^3.2.0",
-    "inversify": "^4.1.1",
-    "inversify-express-utils": "^3.5.1",
+    "inversify": "^4.2.0",
+    "inversify-express-utils": "^4.0.0",
     "jsonwebtoken": "^7.4.1",
     "knex": "^0.12.0",
     "lodash": "^4.17.4",
diff --git a/src/api/controllers/UserController.ts b/src/api/controllers/UserController.ts
@@ -7,7 +7,7 @@
  */
 
 import { inject, named } from 'inversify';
-import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response, Request } from 'inversify-express-utils';
+import { controller, httpGet, httpPost, httpPut, httpDelete, response, request, requestBody, requestParam } from 'inversify-express-utils';
 import { app } from '../../app';
 import { Types, Targets } from '../../constants';
 import { UserService } from '../services/UserService';
@@ -17,42 +17,42 @@ const populateUser = app.IoC.getNamed<interfaces.Middleware>(Types.Middleware, T
 const authenticate = app.IoC.getNamed<interfaces.Middleware>(Types.Middleware, Targets.Middleware.AuthenticateMiddleware);
 
 
-@Controller('/users', authenticate.use)
+@controller('/users', authenticate.use)
 export class UserController {
 
     constructor( @inject(Types.Service) @named(Targets.Service.UserService) private userService: UserService) { }
 
-    @Get('/')
-    public async findAll( @Response() res: myExpress.Response): Promise<any> {
+    @httpGet('/')
+    public async findAll( @response() res: myExpress.Response): Promise<any> {
         const users = await this.userService.findAll();
         return res.found(users.toJSON());
     }
 
-    @Post('/')
-    public async create( @Response() res: myExpress.Response, @RequestBody() body: any): Promise<any> {
+    @httpPost('/')
+    public async create( @response() res: myExpress.Response, @requestBody() body: any): Promise<any> {
         const user = await this.userService.create(body);
         return res.created(user.toJSON());
     }
 
-    @Get('/me', populateUser.use)
-    public async findMe( @Request() req: myExpress.Request, @Response() res: myExpress.Response): Promise<any> {
+    @httpGet('/me', populateUser.use)
+    public async findMe( @request() req: myExpress.Request, @response() res: myExpress.Response): Promise<any> {
         return res.found(req.user);
     }
 
-    @Get('/:id')
-    public async findOne( @Response() res: myExpress.Response, @RequestParam('id') id: string): Promise<any> {
+    @httpGet('/:id')
+    public async findOne( @response() res: myExpress.Response, @requestParam('id') id: string): Promise<any> {
         const user = await this.userService.findOne(parseInt(id, 10));
         return res.found(user.toJSON());
     }
 
-    @Put('/:id')
-    public async update( @Response() res: myExpress.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
+    @httpPut('/:id')
+    public async update( @response() res: myExpress.Response, @requestParam('id') id: string, @requestBody() body: any): Promise<any> {
         const user = await this.userService.update(parseInt(id, 10), body);
         return res.updated(user.toJSON());
     }
 
-    @Delete('/:id')
-    public async destroy( @Response() res: myExpress.Response, @RequestParam('id') id: string): Promise<any> {
+    @httpDelete('/:id')
+    public async destroy( @response() res: myExpress.Response, @requestParam('id') id: string): Promise<any> {
         await this.userService.destroy(parseInt(id, 10));
         return res.destroyed();
     }
diff --git a/src/api/services/UserService.ts b/src/api/services/UserService.ts
@@ -12,7 +12,7 @@ import { inject, named } from 'inversify';
 import { Types, Core, Targets } from '../../constants';
 import { Logger as LoggerType } from '../../core/Logger';
 import { EventEmitter } from '../../core/api/events';
-import { Validate, Request } from '../../core/api/Validate';
+import { validate, request } from '../../core/api/Validate';
 import { NotFoundException } from '../exceptions/NotFoundException';
 import { UserCreateRequest } from '../requests/user/UserCreateRequest';
 import { UserUpdateRequest } from '../requests/user/UserUpdateRequest';
@@ -77,8 +77,8 @@ export class UserService {
      * @param {*} data is the json body of the request
      * @returns {Promise<User>}
      */
-    @Validate()
-    public async create( @Request(UserCreateRequest) data: any): Promise<User> {
+    @validate()
+    public async create( @request(UserCreateRequest) data: any): Promise<User> {
         // If the request body was valid we will create the user
         const user = await this.userRepo.create(data);
         this.events.emit(UserCreatedListener.Event, user.toJSON());
@@ -93,8 +93,8 @@ export class UserService {
      * @param {*} newUser is the json body of the request
      * @returns {Promise<User>}
      */
-    @Validate()
-    public async update(id: number, @Request(UserUpdateRequest) newUser: any): Promise<User> {
+    @validate()
+    public async update(id: number, @request(UserUpdateRequest) newUser: any): Promise<User> {
         // Find or fail
         const user = await this.findOne(id);
         // Set new values
diff --git a/src/console/templates/controller.hbs b/src/console/templates/controller.hbs
@@ -1,11 +1,11 @@
 {{#if isResourceTemplate}}
 import { inject, named } from 'inversify';
-import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response } from 'inversify-express-utils';
+import { controller, httpGet, httpPost, httpPut, httpDelete, response, request, requestBody, requestParam } from 'inversify-express-utils';
 import { Types, Targets } from '../../{{deepness}}constants';
 import { app } from '../../{{deepness}}app';
 import { {{name.capitalize}}Service } from '../{{deepness}}services/{{name.capitalize}}Service';
 {{else}}
-import { Controller } from 'inversify-express-utils';
+import { controller } from 'inversify-express-utils';
 import { app } from '../../{{deepness}}app';
 import { Types, Targets } from '../../{{deepness}}constants';
 {{/if}}
@@ -14,37 +14,37 @@ import { Types, Targets } from '../../{{deepness}}constants';
 const authenticate = app.IoC.getNamed<interfaces.Middleware>(Types.Middleware, Targets.Middleware.AuthenticateMiddleware);
 
 
-@Controller('/{{name.pluralize}}', authenticate.use)
+@controller('/{{name.pluralize}}', authenticate.use)
 export class {{name.capitalize}}Controller {
 
     {{#if isResourceTemplate}}constructor( @inject(Types.Service) @named(Targets.Service.{{name.capitalize}}Service) private {{name.camelCase}}Service: {{name.capitalize}}Service) { }
 
-    @Get('/')
-    public async findAll( @Response() res: myExpress.Response): Promise<any> {
+    @httpGet('/')
+    public async findAll( @response() res: myExpress.Response): Promise<any> {
         const {{name.camelCase}}s = await this.{{name.camelCase}}Service.findAll();
         return res.found({{name.camelCase}}s.toJSON());
     }
 
-    @Post('/')
-    public async create( @Response() res: myExpress.Response, @RequestBody() body: any): Promise<any> {
+    @httpPost('/')
+    public async create( @response() res: myExpress.Response, @requestBody() body: any): Promise<any> {
         const {{name.camelCase}} = await this.{{name.camelCase}}Service.create(body);
         return res.created({{name.camelCase}}.toJSON());
     }
 
-    @Get('/:id')
-    public async findOne( @Response() res: myExpress.Response, @RequestParam('id') id: string): Promise<any> {
+    @httpGet('/:id')
+    public async findOne( @response() res: myExpress.Response, @requestParam('id') id: string): Promise<any> {
         const {{name.camelCase}} = await this.{{name.camelCase}}Service.findOne(parseInt(id, 10));
         return res.found({{name.camelCase}}.toJSON());
     }
 
-    @Put('/:id')
-    public async update( @Response() res: myExpress.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
+    @httpPut('/:id')
+    public async update( @response() res: myExpress.Response, @requestParam('id') id: string, @requestBody() body: any): Promise<any> {
         const {{name.camelCase}} = await this.{{name.camelCase}}Service.update(parseInt(id, 10), body);
         return res.updated({{name.camelCase}}.toJSON());
     }
 
-    @Delete('/:id')
-    public async destroy( @Response() res: myExpress.Response, @RequestParam('id') id: string): Promise<any> {
+    @httpDelete('/:id')
+    public async destroy( @response() res: myExpress.Response, @requestParam('id') id: string): Promise<any> {
         await this.{{name.camelCase}}Service.destroy(parseInt(id, 10));
         return res.destroyed();
     }{{/if}}
diff --git a/src/core/api/Validate.ts b/src/core/api/Validate.ts
@@ -24,10 +24,10 @@ interface RequestParameter {
  *
  * @param request
  */
-export const Request = (request: typeof RequestBody) => (target: object, propertyKey: string | symbol, parameterIndex: number): any => {
+export const request = (requestBody: typeof RequestBody) => (target: object, propertyKey: string | symbol, parameterIndex: number): any => {
     const existingRequestParameters: RequestParameter[] = Reflect.getOwnMetadata(requestMetadataKey, target, propertyKey) || [];
     existingRequestParameters.push({
-        request,
+        request: requestBody,
         index: parameterIndex
     });
     Reflect.defineMetadata(requestMetadataKey, existingRequestParameters, target, propertyKey);
@@ -40,14 +40,14 @@ export const Request = (request: typeof RequestBody) => (target: object, propert
  * @param propertyName
  * @param descriptor
  */
-export const Validate = () => (target: any, propertyName: string, descriptor: TypedPropertyDescriptor<any>): any => {
+export const validate = () => (target: any, propertyName: string, descriptor: TypedPropertyDescriptor<any>): any => {
     const method = descriptor.value;
     descriptor.value = async function(...args: any[]): Promise<any> {
         const requestParameters: RequestParameter[] = Reflect.getOwnMetadata(requestMetadataKey, target, propertyName);
         if (requestParameters.length > 0) {
             for (const requestParameter of requestParameters) {
-                const request = new requestParameter.request(args[requestParameter.index]);
-                await request.validate();
+                const requestBody = new requestParameter.request(args[requestParameter.index]);
+                await requestBody.validate();
             }
         }
         return method && method.apply(this, args);
diff --git a/yarn.lock b/yarn.lock
@@ -1208,13 +1208,13 @@ debug@2.3.3:
   dependencies:
     ms "0.7.2"
 
-debug@2.6.7, debug@^2.1.3:
+debug@2.6.7:
   version "2.6.7"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.7.tgz#92bad1f6d05bbb6bba22cca88bcd0ec894c2861e"
   dependencies:
     ms "2.0.0"
 
-debug@2.6.8, debug@^2.1.1, debug@^2.2.0, debug@^2.6.3:
+debug@2.6.8, debug@^2.1.1, debug@^2.1.3, debug@^2.2.0, debug@^2.6.3:
   version "2.6.8"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.8.tgz#e731531ca2ede27d188222427da17821d68ff4fc"
   dependencies:
@@ -2119,15 +2119,15 @@ invariant@^2.2.0:
   dependencies:
     loose-envify "^1.0.0"
 
-inversify-express-utils@^3.5.1:
-  version "3.5.2"
-  resolved "https://registry.yarnpkg.com/inversify-express-utils/-/inversify-express-utils-3.5.2.tgz#b5db32ab013f5711cb634e3c7ad762c1a9121ffb"
+inversify-express-utils@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/inversify-express-utils/-/inversify-express-utils-4.0.0.tgz#1fd5f95e9eb6ee8cd053f54083868f532e93b90a"
   dependencies:
     express "^4.14.1"
 
-inversify@^4.1.1:
-  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/inversify/-/inversify-4.1.1.tgz#a95edb34ae082bb1175336d51dcd5f011134c625"
+inversify@^4.2.0:
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/inversify/-/inversify-4.2.0.tgz#71966a5005b1ef735ba2709e66c5b5f7765087e3"
 
 invert-kv@^1.0.0:
   version "1.0.0"
@@ -3861,11 +3861,11 @@ rx-lite@*, rx-lite@^4.0.8:
   version "4.0.8"
   resolved "https://registry.yarnpkg.com/rx-lite/-/rx-lite-4.0.8.tgz#0b1e11af8bc44836f04a6407e92da42467b79444"
 
-safe-buffer@5.0.1, safe-buffer@^5.0.1:
+safe-buffer@5.0.1:
   version "5.0.1"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.0.1.tgz#d263ca54696cd8a306b5ca6551e92de57918fbe7"
 
-safe-buffer@5.1.1:
+safe-buffer@5.1.1, safe-buffer@^5.0.1:
   version "5.1.1"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.1.tgz#893312af69b2123def71f57889001671eeb2c853"
 
@@ -4121,14 +4121,7 @@ string-width@^1.0.1, string-width@^1.0.2:
     is-fullwidth-code-point "^1.0.0"
     strip-ansi "^3.0.0"
 
-string-width@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.0.0.tgz#635c5436cc72a6e0c387ceca278d4e2eec52687e"
-  dependencies:
-    is-fullwidth-code-point "^2.0.0"
-    strip-ansi "^3.0.0"
-
-string-width@^2.1.0:
+string-width@^2.0.0, string-width@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.0.tgz#030664561fc146c9423ec7d978fe2457437fe6d0"
   dependencies:
