add new core structure

Author: hirsch88

package.json

@@ -2,7 +2,7 @@
   "name": "express-typescript-boilerplate",
   "version": "1.7.0",
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
-  "main": "src/index.ts",
+  "main": "src/app.ts",
   "scripts": {
     "test": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit",
     "test:pretty": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --verbose",
@@ -24,7 +24,7 @@
     "console:dev": "./node_modules/.bin/ts-node ./src/console/commander.ts",
     "console:help": "./node_modules/.bin/ts-node --fast ./src/console/commander.ts --help",
     "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json' --watch '.env'",
-    "start": "node dist/index.js"
+    "start": "node dist/app.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
   "engines": {
@@ -57,6 +57,7 @@
     "@types/bluebird": "^3.5.4",
     "@types/body-parser": "^1.16.3",
     "@types/bookshelf": "^0.9.1",
+    "@types/chalk": "^0.4.31",
     "@types/commander": "^2.9.0",
     "@types/cors": "^2.8.1",
     "@types/debug": "0.0.29",
@@ -82,6 +83,7 @@
     "body-parser": "^1.17.2",
     "bookshelf": "^0.10.3",
     "bookshelf-camelcase": "^1.1.4",
+    "chalk": "^1.1.3",
     "class-validator": "^0.7.0",
     "commander": "^2.9.0",
     "compression": "^1.6.2",
@@ -92,6 +94,7 @@
     "express": "^4.15.3",
     "express-status-monitor": "^0.1.9",
     "faker": "^4.1.0",
+    "figlet": "^1.2.0",
     "glob": "^7.1.2",
     "handlebars": "^4.0.10",
     "helmet": "^3.6.1",

src/api/controllers/UserController.ts

@@ -11,17 +11,17 @@ import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response
 import { myExpress } from 'my-express';
 import { UserService } from '../services/UserService';
 import { Types } from '../../constants/Types';
-import { Service, Middleware } from '../../constants/Targets';
-import { AuthenticateMiddleware } from '../middlewares/AuthenticateMiddleware';
-import { PopulateUserMiddleware } from '../middlewares/PopulateUserMiddleware';
-import { ioc } from '../../core/IoC';
+import { Service } from '../../constants/Targets';
+// import { AuthenticateMiddleware } from '../middlewares/AuthenticateMiddleware';
+// import { PopulateUserMiddleware } from '../middlewares/PopulateUserMiddleware';
+// import { ioc } from '../../core/IoC';
 
 // Get middlewares
-const authenticate = ioc.Container.getNamed<AuthenticateMiddleware>(Types.Middleware, Middleware.AuthenticateMiddleware);
-const populateUser = ioc.Container.getNamed<PopulateUserMiddleware>(Types.Middleware, Middleware.PopulateUserMiddleware);
+// const authenticate = ioc.Container.getNamed<AuthenticateMiddleware>(Types.Middleware, Middleware.AuthenticateMiddleware);
+// const populateUser = ioc.Container.getNamed<PopulateUserMiddleware>(Types.Middleware, Middleware.PopulateUserMiddleware);
 
-
-@Controller('/users', authenticate.use)
+// authenticate.use
+@Controller('/users')
 export class UserController {
 
     constructor( @inject(Types.Service) @named(Service.UserService) private userService: UserService) { }
@@ -38,7 +38,8 @@ export class UserController {
         return res.created(user.toJSON());
     }
 
-    @Get('/me', populateUser.use)
+    // populateUser.use
+    @Get('/me')
     public async findMe( @Request() req: myExpress.Request, @Response() res: myExpress.Response): Promise<any> {
         return res.found(req.user);
     }

src/api/middlewares/AuthenticateMiddleware.ts

@@ -19,7 +19,6 @@ export class AuthenticateMiddleware {
         this.log = new Logger('api:middleware:AuthenticateMiddleware');
     }
 
-
     public use = (req: myExpress.Request, res: myExpress.Response, next: myExpress.NextFunction): void => {
         const token = this.getToken(req);
 

src/api/middlewares/PopulateUserMiddleware.ts

@@ -18,7 +18,6 @@ export class PopulateUserMiddleware {
         this.log = new Logger('api:middleware:PopulateUserMiddleware');
     }
 
-
     public use = (req: myExpress.Request, res: myExpress.Response, next: myExpress.NextFunction): void => {
         // Check if the authenticate middleware was successful
         if (!req.tokeninfo || !req.tokeninfo.user_id) {

src/app.ts

@@ -1,56 +1,34 @@
 /**
- * APPLICATION CONFIGURATION
+ * EXPRESS TYPESCRIPT BOILERPLATE
  * ----------------------------------------
  *
- * This is the place to add any other express module and register
- * all your custom middlewares and routes.
+ * Gery Hirscheld<@hirsch88>
+ *
+ * This is a boilerplate for Node.js Application written in TypeScript.
+ * The basic layer of this app is express. For further information visit
+ * the 'README.md' file.
+ *
+ * It is very important the '/core' module is loaded first, because this
+ * module loads all essentials third-party-libs and our configs we need.
+ *
+ * To add express modules go to the 'app.ts' file. All the IOC registrations
+ * are in the 'container.ts' file.
  */
 
-import * as path from 'path';
-import * as cors from 'cors';
-import * as morgan from 'morgan';
-import * as helmet from 'helmet';
-import * as express from 'express';
-import * as favicon from 'serve-favicon';
-import * as bodyParser from 'body-parser';
-import * as compression from 'compression';
-import { bootstrap } from './core/Bootstrap';
-import { Log } from './core/log';
-
-
-bootstrap.configureExpress((app: express.Application) => app
-
-    // Enabling the cors headers
-    .options('*', cors())
-    .use(cors())
-
-    // Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
-    .use(helmet())
-    .use(helmet.noCache())
-    .use(helmet.hsts({
-        maxAge: 31536000,
-        includeSubdomains: true
-    }))
+// Helps to add metadata to classes with annotations
+import 'reflect-metadata';
 
-    // Compress response bodies for all request that traverse through the middleware
-    .use(compression())
+// Defines the main dependencies and returns the
+// bootstrap instance to get the server started.
+import { App } from './core/App';
+import { CustomConfig } from './config/CustomConfig';
 
-    // Parse incoming request bodies in a middleware before your handlers, available under the req.body property.
-    .use(bodyParser.json())
-    .use(bodyParser.urlencoded({
-        extended: true
-    }))
+export const app = new App([
 
-    // Serve static filles like images from the public folder
-    .use(express.static(path.join(__dirname, 'public'), { maxAge: 31557600000 }))
+    // Here you can add more custom configurations
+    new CustomConfig()
 
-    // A favicon is a visual cue that client software, like browsers, use to identify a site
-    .use(favicon(path.join(__dirname, 'public', 'favicon.ico')))
+]);
 
-    // HTTP request logger middleware for node.js
-    .use(morgan('dev', {
-        stream: {
-            write: Log.info
-        }
-    }))
-);
+// Launch the server with all his awesome features.
+app.main();

src/config/AppConfig.ts

@@ -0,0 +1,58 @@
+/**
+ * APPLICATION CONFIGURATION
+ * ----------------------------------------
+ *
+ * This is the place to add any other express module and register
+ * all your custom middlewares and routes.
+ */
+
+import * as path from 'path';
+import * as cors from 'cors';
+import * as morgan from 'morgan';
+import * as helmet from 'helmet';
+import * as express from 'express';
+import * as favicon from 'serve-favicon';
+import * as bodyParser from 'body-parser';
+import * as compression from 'compression';
+import { Log } from '../core/log';
+import { App, Configurable } from '../core/App';
+
+
+export class AppConfig implements Configurable {
+    public configure(app: App): void {
+        app.Express
+            // Enabling the cors headers
+            .options('*', cors())
+            .use(cors())
+
+            // Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
+            .use(helmet())
+            .use(helmet.noCache())
+            .use(helmet.hsts({
+                maxAge: 31536000,
+                includeSubdomains: true
+            }))
+
+            // Compress response bodies for all request that traverse through the middleware
+            .use(compression())
+
+            // Parse incoming request bodies in a middleware before your handlers, available under the req.body property.
+            .use(bodyParser.json())
+            .use(bodyParser.urlencoded({
+                extended: true
+            }))
+
+            // Serve static filles like images from the public folder
+            .use(express.static(path.join(__dirname, '..', 'public'), { maxAge: 31557600000 }))
+
+            // A favicon is a visual cue that client software, like browsers, use to identify a site
+            .use(favicon(path.join(__dirname, '..', 'public', 'favicon.ico')))
+
+            // HTTP request logger middleware for node.js
+            .use(morgan('dev', {
+                stream: {
+                    write: Log.info
+                }
+            }));
+    }
+}

src/config/CustomConfig.ts

@@ -0,0 +1,20 @@
+/**
+ * config.Custom
+ * ------------------------------------
+ *
+ * Define all log adapters for this application and chose one.
+ */
+
+import { Log } from '../core/log';
+import { App, Configurable } from '../core/App';
+
+
+export class CustomConfig implements Configurable {
+
+    private log = new Log('config:CustomConfig');
+
+    public configure(app: App): void {
+        this.log.debug('configuring', app.Express.get('port'));
+    }
+}
+

src/config/Database.ts

@@ -10,15 +10,14 @@
 
 import * as knex from 'knex';
 import * as bookshelf from 'bookshelf';
-import { Environment } from '../core/Environment';
 
 
 export const Knex = (): knex => knex({
-    client: Environment.get<string>('DB_CLIENT'),
-    connection: Environment.get<string>('DB_CONNECTION'),
+    client: process.env.DB_CLIENT,
+    connection: process.env.DB_CONNECTION,
     pool: {
-        min: Environment.get<number>('DB_POOL_MIN'),
-        max: Environment.get<number>('DB_POOL_MAX')
+        min: parseInt(process.env.DB_POOL_MIN, 10),
+        max: parseInt(process.env.DB_POOL_MAX, 10)
     }
 });
 

src/config/IocConfig.ts

@@ -0,0 +1,47 @@
+/**
+ * IOC - CONTAINER
+ * ----------------------------------------
+ *
+ * Bind every controller and service to the ioc container. All controllers
+ * will then be bonded to the express structure with their defined routes.
+ */
+
+// import { Container, decorate, injectable } from 'inversify';
+import { IoC } from '../core/IoC';
+// import { Types } from '../constants/Types';
+
+// import * as request from 'request';
+
+
+export class IocConfig {
+    public configure(ioc: IoC): void {
+        // /**
+        //  * Here you can bind all your third-party libraries like
+        //  * request, lodash and so on. Those will be bound before
+        //  * everything else.
+        //  */
+        // ioc.configureLib((container: Container) => {
+
+        //     decorate(injectable(), request);
+
+        //     container
+        //         .bind<any>(Types.Lib)
+        //         .toConstantValue(request)
+        //         .whenTargetNamed('request');
+
+        //     return container;
+        // });
+
+        // /**
+        //  * Bind custom classes here. This will be bound at the end
+        //  */
+        // ioc.configure((container: Container) => {
+
+        //     // Add your custom class here
+
+        //     return container;
+        // });
+    }
+}
+
+