house cleaning

Author: hirsch88

README.md

@@ -92,6 +92,7 @@ The route prefix is by default `/api/v1`, but you can change this in the .env.ex
 | **src/**                      | Source-Files |
 | **src/api/controllers/**      | REST-API - Controllers |
 | **src/api/exceptions/**       | Exceptions like 404 NotFound |
+| **src/api/listeners/**        | Event-Listeners |
 | **src/api/middlewares/**      | Express Middlewares like populateUser |
 | **src/api/models/**           | Bookshelf Models |
 | **src/api/repositories/**     | Repository Layer |

src/api/controllers/UserController.ts

@@ -1,10 +1,17 @@
+/**
+ * UserController
+ * ----------------------------------------
+ *
+ * This controller is in charge of the user resource and should
+ * provide all crud actions.
+ */
+
 import { inject, named } from 'inversify';
 import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response, Request } from 'inversify-express-utils';
 import { my } from 'my-express';
 import { UserService } from '../services/UserService';
 import { Types } from '../../constants/Types';
 import { Service, Middleware } from '../../constants/Targets';
-// import { authenticate, populateUser } from '../middlewares';
 import { AuthenticateMiddleware } from '../middlewares/AuthenticateMiddleware';
 import { PopulateUserMiddleware } from '../middlewares/PopulateUserMiddleware';
 import { ioc } from '../../core/IoC';
@@ -13,10 +20,7 @@ import { ioc } from '../../core/IoC';
 const authenticate = ioc.Container.getNamed<AuthenticateMiddleware>(Types.Middleware, Middleware.AuthenticateMiddleware);
 const populateUser = ioc.Container.getNamed<PopulateUserMiddleware>(Types.Middleware, Middleware.PopulateUserMiddleware);
 
-/**
- * UserController is in charge of the user resource and should
- * provide all crud actions.
- */
+
 @Controller('/user', authenticate.use)
 export class UserController {
 

src/api/models/User.ts

@@ -1,13 +1,12 @@
-import { Bookshelf } from '../../config/Database';
-import { Tables } from '../../constants/Tables';
-
 /**
  * User Model
- *
- * @export
- * @class User
- * @extends {Bookshelf.Model<User>}
+ * ------------------------------
  */
+
+import { Bookshelf } from '../../config/Database';
+import { Tables } from '../../constants/Tables';
+
+
 export class User extends Bookshelf.Model<User> {
 
     public static async fetchById(id: number): Promise<User> {

src/api/repositories/UserRepository.ts

@@ -1,3 +1,8 @@
+/**
+ * UserRepository
+ * ------------------------------
+ */
+
 import * as Bookshelf from 'bookshelf';
 import { inject, named } from 'inversify';
 import { Types } from '../../constants/Types';
@@ -6,12 +11,7 @@ import { User } from '../models/User';
 import { DatabaseException } from '../exceptions/DatabaseException';
 import { NotFoundException } from '../exceptions/NotFoundException';
 
-/**
- * UserRepository
- *
- * @export
- * @class UserRepository
- */
+
 export class UserRepository {
 
     constructor(

src/api/services/UserService.ts

@@ -1,3 +1,13 @@
+/**
+ * UserService
+ * ------------------------------
+ *
+ * This service is here to validate and call the repository layer for
+ * database actions. Furthermore you should throw events here if
+ * necessary.
+ *
+ */
+
 import * as Bookshelf from 'bookshelf';
 import { inject, named } from 'inversify';
 import { Core, Repository } from '../../constants/Targets';
@@ -13,16 +23,6 @@ import { User } from '../models/User';
 import { UserCreatedListener } from '../listeners/UserCreatedListener';
 
 
-/**
- * UserService
- * ------------------------------
- * This service is here to validate and call the repository layer for
- * database actions. Furthermore you should throw events here if
- * necessary.
- *
- * @export
- * @class UserService
- */
 export class UserService {
 
     public log: Log;