Update express handling and extend the express response object

Author: hirsch88

.env.example

@@ -1,21 +1,39 @@
-APP_NAME=qt-api
+#
+# APPLICATION
+#
+APP_NAME=express-typescript-boilerplate
 APP_ENV=local
 APP_HOST=http://localhost
 APP_PORT=3000
 
+#
+# LOGGING
+#
 DEBUG=app*,api*,core*
 LOG_LEVEL=debug
 LOG_ADAPTER=debug
 
-DB_CLIENT=pg
-DB_CONNECTION=postgres://root:root@localhost:5432/my_database
+#
+# DATABASE
+#
+# MySql
+DB_CLIENT=mysql
+DB_CONNECTION=mysql://root@localhost:3306/my_database
+
+# PostGres
+#DB_CLIENT=pg
+#DB_CONNECTION=postgres://root:root@localhost:5432/my_database
+
+# Knex
 DB_POOL_MIN=0
 DB_POOL_MAX=7
 DB_MIGRATION_DIR=./src/database/migrations
 DB_MIGRATION_TABLE=version
 DB_SEEDS_DIR=./src/database/seeds
 
-
+#
+# Auth0
+#
 AUTH0_HOST=https://w3tecch.auth0.com
 AUTH0_OAUTH=/oauth
 AUTH0_API=/api/v2

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "typescript.tsdk": "./node_modules/typescript/lib",
     "files.exclude": {
-        "src/**/*.js": true,
+        "src/**/*.js": false,
         "test/**/*.js": true
     },
     "vsicons.presets.angular": false,

package.json

@@ -20,7 +20,6 @@
     "db:migrate": "./node_modules/.bin/knex migrate:latest",
     "db:migrate:rollback": "./node_modules/.bin/knex migrate:rollback",
     "db:seed": "./node_modules/.bin/knex seed:run",
-    "db:clean": "./node_modules/.bin/ts-node ./src/console/CleanDatabaseCommand.ts",
     "db:refresh": "npm run db:drop && npm run db:migrate",
     "start": "node src/index.js"
   },
@@ -74,6 +73,7 @@
     "body-parser": "^1.17.1",
     "bookshelf": "^0.10.3",
     "bookshelf-camelcase": "^1.1.4",
+    "class-validator": "^0.7.0",
     "compression": "^1.6.2",
     "cors": "^2.8.1",
     "debug": "^2.6.0",

src/api/controllers/UserController.ts

@@ -1,10 +1,11 @@
 import { injectable, inject } from 'inversify';
-import { Controller, Get, RequestParam } from 'inversify-express-utils';
-import TYPES from '../../constants/types';
-import * as core from '../../core';
+import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response } from 'inversify-express-utils';
+import { my } from 'my-express';
+import { Log } from '../../core';
 import { UserService } from '../services';
+import TYPES from '../../constants/types';
 
-const log = new core.Log('api:ctrl.UserController');
+const log = new Log('api:ctrl.UserController');
 
 /**
  * UserController
@@ -13,23 +14,44 @@ const log = new core.Log('api:ctrl.UserController');
  * @class UserController
  */
 @injectable()
-@Controller('/users')
+@Controller('/v1/user')
 export class UserController {
 
     constructor( @inject(TYPES.UserService) private userService: UserService) { }
 
     @Get('/')
-    public async findAll(): Promise<any> {
+    public async findAll( @Response() res: my.Response): Promise<any> {
         log.debug('findAll');
         const users = await this.userService.findAll();
-        return users.toJSON();
+        return res.found(users.toJSON());
     }
 
     @Get('/:id')
-    public async findOne( @RequestParam('id') id: string): Promise<any> {
+    public async findOne( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
         log.debug('findOne ', id);
         const user = await this.userService.findOne(parseInt(id, 10));
-        return user.toJSON();
+        return res.found(user.toJSON());
+    }
+
+    @Post('/')
+    public async create( @Response() res: my.Response, @RequestBody() body: any): Promise<any> {
+        log.debug('create ', body);
+        const user = await this.userService.create(body);
+        return res.created(user.toJSON());
+    }
+
+    @Put('/:id')
+    public async update( @Response() res: my.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
+        log.debug('update ', body);
+        const user = await this.userService.update(parseInt(id, 10), body);
+        return res.updated(user.toJSON());
+    }
+
+    @Delete('/:id')
+    public async destroy( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
+        log.debug('destroy ', id);
+        await this.userService.destroy(parseInt(id, 10));
+        return res.destroyed();
     }
 
 }

src/api/exceptions/DatabaseException.ts

@@ -0,0 +1,11 @@
+import { Exception } from '../../core/api/Exception';
+
+
+export class DatabaseException extends Exception {
+    constructor(text: string, error: any) {
+        let value: string = error.stack.split('\n')[0];
+        super(400, text, [
+            value.substring(7)
+        ]);
+    }
+}

src/api/exceptions/NotFoundException.ts

@@ -1,7 +1,7 @@
-import * as core from '../../core';
+import { Exception } from '../../core/api/Exception';
 
 
-export class NotFoundException extends core.Exception {
+export class NotFoundException extends Exception {
     constructor(id?: number | string) {
         super(404, `Entity with identifier ${id} does not exist`);
     }

src/api/exceptions/ValidationException.ts

@@ -0,0 +1,12 @@
+import { Exception } from '../../core/api/Exception';
+
+
+export class ValidationException extends Exception {
+    constructor(text: string, errors: any) {
+        const info = errors.map((e) => ({
+            property: e.property,
+            constraints: e.constraints
+        }));
+        super(400, text, info);
+    }
+}

src/api/exceptions/index.ts

@@ -1 +1,3 @@
+export * from './DatabaseException';
 export * from './NotFoundException';
+export * from './ValidationException';

src/api/models/User.ts

@@ -23,9 +23,6 @@ export class User extends core.Bookshelf.Model<User> {
     public get Email(): string { return this.get('email'); }
     public set Email(value: string) { this.set({ id: value }); };
 
-    public get Picture(): string { return this.get('picture'); }
-    public set Picture(value: string) { this.set({ id: value }); };
-
     public get UpdatedAt(): Date { return this.get('updatedAt'); }
     public set UpdatedAt(value: Date) { this.set({ id: value }); };
 

src/api/repositories/UserRepository.ts

@@ -1,23 +1,56 @@
 import * as Bookshelf from 'bookshelf';
-import * as models from '../models';
-// import { injectable } from 'inversify';
+import { User } from '../models';
+import { DatabaseException, NotFoundException } from '../exceptions';
 
 /**
  * UserRepository
  *
  * @export
  * @class UserRepository
  */
-// @injectable()
 export class UserRepository {
 
-    public static async findAll(): Promise<Bookshelf.Collection<models.User>> {
-        const users = await models.User.fetchAll();
-        return <Bookshelf.Collection<models.User>>users;
+    public static async findAll(): Promise<Bookshelf.Collection<User>> {
+        const users = await User.fetchAll();
+        return <Bookshelf.Collection<User>>users;
     }
 
-    public static async findOne(id: number): Promise<models.User> {
-        return models.User.fetchById(id);
+    public static async findOne(id: number): Promise<User> {
+        return User.fetchById(id);
+    }
+
+    public static async create(data: any): Promise<User> {
+        const user = User.forge<User>(data);
+        try {
+            return await user.save();
+        } catch (error) {
+            throw new DatabaseException('Could not create the user!', error);
+        }
+    }
+
+    public static async update(id: number, data: any): Promise<User> {
+        const user = User.forge<User>({ id: id });
+        try {
+            return await user.save(data, { patch: true });
+        } catch (error) {
+            throw new DatabaseException('Could not update the user!', error);
+        }
+    }
+
+    public static async destroy(id: number): Promise<void> {
+        let user = User.forge<User>({ id: id });
+        try {
+            user = await user.fetch({ require: true });
+        } catch (error) {
+            throw new NotFoundException(id);
+        }
+
+        try {
+            await user.destroy();
+            return;
+        } catch (error) {
+            throw new DatabaseException('Could not delete the user!', error);
+        }
     }
 
 }