Merge branch 'release/2.0.0-beta.3'

hirsch88 · hirsch88 · commit e89f11572cfc · 2017-09-22T20:22:59.000+02:00
diff --git a/.env.example b/.env.example
@@ -1,43 +1,43 @@
 #
 # APPLICATION
 #
-APP_NAME=express-typescript-boilerplate
-APP_ENV=local
-APP_HOST=http://localhost
-APP_URL_PREFIX=/api
+APP_NAME="express-typescript-boilerplate"
+APP_ENV="local"
+APP_HOST="http://localhost"
+APP_URL_PREFIX="/api"
 APP_PORT=3000
 
 #
 # LOGGING
 #
-LOG_LEVEL=debug
-LOG_ADAPTER=winston
+LOG_LEVEL="debug"
+LOG_ADAPTER="winston"
 
 #
 # API Info
 #
 API_INFO_ENABLED=true
-API_INFO_ROUTE=/info
+API_INFO_ROUTE="/info"
 
 #
 # Swagger Documentation
 #
 SWAGGER_ENABLED=true
-SWAGGER_ROUTE=/docs
-SWAGGER_FILE=/src/api/swagger.json
+SWAGGER_ROUTE="/docs"
+SWAGGER_FILE="/src/api/swagger.json"
 
 #
 # Monitor
 #
 MONITOR_ENABLED=true
-MONITOR_ROUTE=/status
+MONITOR_ROUTE="/status"
 
 #
 # DATABASE
 #
 # MySql
-DB_CLIENT=mysql
-DB_CONNECTION=mysql://root@localhost:3306/my_database
+DB_CLIENT="mysql"
+DB_CONNECTION="mysql://root@localhost:3306/my_database"
 
 # PostGres
 #DB_CLIENT=pg
@@ -46,12 +46,12 @@ DB_CONNECTION=mysql://root@localhost:3306/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
+DB_MIGRATION_DIR="./src/database/migrations"
+DB_MIGRATION_TABLE="version"
+DB_SEEDS_DIR="./src/database/seeds"
 
 #
 # Auth0
 #
-# AUTH0_HOST=https://w3tecch.auth0.com
-AUTH0_HOST=http://localhost:3333
+# AUTH0_HOST="https://w3tecch.auth0.com"
+AUTH0_HOST="http://localhost:3333"
diff --git a/.travis.yml b/.travis.yml
@@ -5,5 +5,6 @@ install:
   - yarn install
 scripts:
   - npm test
+  - npm run build
 notifications:
   email: false
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Express Typescript Boilerplate
-[![Dependency Status](https://david-dm.org/w3tecch/express-typescript-boilerplate/status.svg?style=flat)](https://david-dm.org/w3tecch/express-typescript-boilerplate) [![Build Status](https://travis-ci.org/w3tecch/express-typescript-boilerplate.svg?branch=master)](https://travis-ci.org/w3tecch/express-typescript-boilerplate)
+[![Dependency Status](https://david-dm.org/w3tecch/express-typescript-boilerplate/status.svg?style=flat)](https://david-dm.org/w3tecch/express-typescript-boilerplate)
+[![Build Status](https://travis-ci.org/w3tecch/express-typescript-boilerplate.svg?branch=master)](https://travis-ci.org/w3tecch/express-typescript-boilerplate)
+[![Build status](https://ci.appveyor.com/api/projects/status/f8e7jdm8v58hcwpq/branch/master?svg=true&passingText=Windows%20passing&pendingText=Windows%20pending&failingText=Windows%20failing)](https://ci.appveyor.com/project/dweber019/express-typescript-boilerplate/branch/master)
 
 > A delightful way to building a RESTful API with NodeJs & TypeScript.
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -0,0 +1,12 @@
+environment:
+  nodejs_version: "7"
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - yarn install
+
+build_script:
+  - npm run build
+
+test_script:
+  - npm test
diff --git a/favicon.ico b/favicon.ico
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "express-typescript-boilerplate",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
   "main": "src/app.ts",
   "scripts": {
@@ -34,9 +34,6 @@
     "ts-node:fast": "./node_modules/.bin/ts-node -F"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
-  "engines": {
-    "node": "^7.7.3"
-  },
   "keywords": [
     "NodeJS",
     "TypeScript",
diff --git a/src/console/UpdateTargetsCommand.ts b/src/console/UpdateTargetsCommand.ts
@@ -5,6 +5,7 @@
  * This script reads all the api files and generate the
  * needed ioc targets file.
  */
+import * as path from 'path';
 import * as _ from 'lodash';
 import * as glob from 'glob';
 import * as handlebars from 'handlebars';
@@ -40,40 +41,40 @@ export class UpdateTargetsCommand extends AbstractCommand {
             return json.replace(/\"([^(\")"]+)\":/g, '$1:').replace(/"/g, '\'');
         });
 
-        const path = __dirname.replace('console', 'constants') + `/${this.targetFile}`;
-        await existsFile(path, true);
-        await writeTemplate(this.template, path, context);
+        const filepath = path.join(__dirname.replace('console', 'constants'), this.targetFile);
+        await existsFile(filepath, true);
+        await writeTemplate(this.template, filepath, context);
 
     }
 
     private async getFiles(): Promise<string[]> {
         return new Promise<string[]>((resolve, reject) => {
-            const path = __dirname.replace('console', 'api');
-            glob(`${path}/**/*.ts`, (err: any, files: string[]) => {
+            const filepath = path.normalize(__dirname.replace('console', 'api'));
+            glob(`${path.join(filepath, '**', '*.ts')}`, (err: any, files: string[]) => {
                 if (err) {
                     return reject(err);
                 }
                 files = files
-                    .map((f) => f.replace(path + '/', ''))
+                    .map(f => path.normalize(f))
+                    .map((f) => f.replace(filepath + path.sep, ''))
                     .map((f) => f.replace('.ts', ''));
-
                 resolve(files);
             });
         });
     }
 
     private divideFilePath(filePath: string): any {
-        const fs = filePath.split('/');
+        const fs = filePath.split(path.sep);
         const key = fs[0];
         fs.splice(0, 1);
         return {
             key,
-            path: fs.join('/')
+            path: fs.join(path.sep)
         };
     }
 
     private parseFilePath(filePath: string): any {
-        if (filePath.indexOf('/') !== -1) {
+        if (filePath.indexOf(path.sep) !== -1) {
             const obj = this.divideFilePath(filePath);
             return {
                 [obj.key]: this.parseFilePath(obj.path)
diff --git a/src/console/lib/AbstractMakeCommand.ts b/src/console/lib/AbstractMakeCommand.ts
@@ -76,7 +76,7 @@ export class AbstractMakeCommand {
         return (name: string) => {
             let ns = name.split('/');
             ns = ns.map((v) => _.camelCase(v));
-            ns[ns.length - 1] = _.capitalize(ns[ns.length - 1]);
+            ns[ns.length - 1] = _.upperFirst(ns[ns.length - 1]);
             return (ns.join('/')) + prefix + suffix;
         };
     }
diff --git a/src/console/lib/console.ts b/src/console/lib/console.ts
@@ -15,7 +15,6 @@ import * as path from 'path';
 import * as commander from 'commander';
 import * as figlet from 'figlet';
 import * as chalk from 'chalk';
-import { isWindows } from './../../core/helpers/Path';
 
 // It also loads the .env file into the 'process.env' variable.
 import { config } from 'dotenv';
@@ -39,7 +38,7 @@ figlet('console', (error: any, data: any) => {
             .filter(m => m.search(/\/lib/g) <= 0)
             .map(m => ({
                 path: m,
-                name: m.replace((isWindows() ? __dirname.replace(/\\/g, '/') : __dirname).replace('/lib', ''), '').replace('.ts', '').substring(1)
+                name: m.replace(__dirname.split(path.sep).join('/').replace('/lib', ''), '').replace('.ts', '').substring(1)
             }));
 
         const commands = files.map(f => require(f.path)[f.name]);
diff --git a/src/console/lib/utils.ts b/src/console/lib/utils.ts
@@ -46,15 +46,15 @@ export const existsFile = async (filePath: string, stop: boolean = false, isTest
         fs.exists(filePath, async (exists) => {
 
             if (exists) {
-                let fileName = filePath.split('/src/')[1];
+                let fileName = filePath.split(path.normalize('/src/'))[1];
                 if (isTest) {
-                    fileName = filePath.split('/test/')[1];
+                    fileName = filePath.split(path.normalize('/test/'))[1];
                 }
                 const answer = await prompt([
                     {
                         type: 'confirm',
                         name: 'override',
-                        message: `Override "${isTest ? 'test' : 'src'}/${fileName}"?`,
+                        message: `Override "${path.join(isTest ? 'test' : 'src', fileName)}"?`,
                         default: true
                     }
                 ]);
diff --git a/src/console/templates/controller.hbs b/src/console/templates/controller.hbs
@@ -1,6 +1,6 @@
 {{#if isResourceTemplate}}
 import { inject, named } from 'inversify';
-import { controller, httpGet, httpPost, httpPut, httpDelete, response, request, requestBody, requestParam } from 'inversify-express-utils';
+import { controller, httpGet, httpPost, httpPut, httpDelete, response, 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';
diff --git a/src/console/templates/model.hbs b/src/console/templates/model.hbs
@@ -18,4 +18,11 @@ export class {{name.capitalize}} extends Bookshelf.Model<{{name.capitalize}}> {
     public set {{name.capitalize}}(value: {{type.script}}) { this.set('{{name.camelCase}}', value); }
     {{/each}}
 
+    {{#if hasTimestamps}}
+    public get UpdatedAt(): Date { return this.get('updatedAt'); }
+    public set UpdatedAt(value: Date) { this.set('updatedAt', value); }
+
+    public get CreatedAt(): Date { return this.get('createdAt'); }
+    public set CreatedAt(value: Date) { this.set('createdAt', value); }
+    {{/if}}
 }
diff --git a/src/console/templates/resource.hbs b/src/console/templates/resource.hbs
@@ -1,9 +1,14 @@
 declare module 'resources' {
 
     interface {{name.capitalize}} {
+        id: int;
         {{#each properties}}
         {{name.camelCase}}: {{type.script}};
         {{/each}}
+        {{#if hasTimestamps}}
+        createdAt: Date;
+        updatedAt: Date;
+        {{/if}}
     }
 
 }
diff --git a/src/console/templates/service.hbs b/src/console/templates/service.hbs
@@ -8,7 +8,7 @@ import { Types, Core } from '../../{{deepness}}constants';
 {{/unless}}
 {{#if isResourceTemplate}}
 import { Types, Core, Targets } from '../../{{deepness}}constants';
-import { Validate, Request } from '../../{{deepness}}core/api/Validate';
+import { validate, request } from '../../{{deepness}}core/api/Validate';
 import { NotFoundException } from '../{{deepness}}exceptions/NotFoundException';
 import { {{name.capitalize}}Repository } from '../{{deepness}}repositories/{{name.capitalize}}Repository';
 import { {{name.capitalize}} } from '../{{deepness}}models/{{name.capitalize}}';
@@ -41,15 +41,15 @@ export class {{name.capitalize}}Service {
         return {{name.camelCase}};
     }
 
-    @Validate()
-    public async create( @Request({{name.capitalize}}CreateRequest) body: any): Promise<{{name.capitalize}}> {
+    @validate()
+    public async create( @request({{name.capitalize}}CreateRequest) body: any): Promise<{{name.capitalize}}> {
         // If the request body was valid we will create the {{name.camelCase}}
         const {{name.camelCase}} = await this.{{name.camelCase}}Repo.create(body);
         return {{name.camelCase}};
     }
 
-    @Validate()
-    public async update(id: number, @Request({{name.capitalize}}UpdateRequest) body: any): Promise<{{name.capitalize}}> {
+    @validate()
+    public async update(id: number, @request({{name.capitalize}}UpdateRequest) body: any): Promise<{{name.capitalize}}> {
         // Find or fail
         const {{name.camelCase}} = await this.findOne(id);
 
diff --git a/src/core/IoC.ts b/src/core/IoC.ts
@@ -13,7 +13,6 @@ import { Types, Core, Targets } from '../constants';
 import { events, EventEmitter } from './api/events';
 import { Logger } from './Logger';
 import { IocConfig } from '../config/IocConfig';
-import { getFolderWrapping } from './helpers/Path';
 
 
 export class IoC {
@@ -185,13 +184,13 @@ export class IoC {
     }
 
     private getBasePath(): string {
-        const baseFolder = __dirname.indexOf(getFolderWrapping('src')) >= 0 ? getFolderWrapping('src') : getFolderWrapping('dist');
+        const baseFolder = __dirname.indexOf(`${path.sep}src${path.sep}`) >= 0 ? `${path.sep}src${path.sep}` : `${path.sep}dist${path.sep}`;
         const baseRoot = __dirname.substring(0, __dirname.indexOf(baseFolder));
         return path.join(baseRoot, baseFolder, 'api');
     }
 
     private getFiles(filePath: string, done: (files: any[]) => void): void {
-        const isTypeScript = __dirname.indexOf(getFolderWrapping('src')) >= 0;
+        const isTypeScript = __dirname.indexOf(`${path.sep}src${path.sep}`) >= 0;
         if (!isTypeScript) {
             filePath = filePath.replace('.ts', '.js');
         }
diff --git a/src/core/Logger.ts b/src/core/Logger.ts
@@ -1,4 +1,4 @@
-import { getFolderWrapping, isWindows } from './helpers/Path';
+import * as path from 'path';
 
 /**
  * core.log.Log
@@ -31,17 +31,16 @@ export class Logger {
     private static Adapter: interfaces.LoggerAdapterConstructor;
     private static Adapters: Map<string, interfaces.LoggerAdapterConstructor> = new Map();
 
-    private static parsePathToScope(path: string): string {
-        const pathDelimiter = isWindows() ? '\\' : '/';
-        if (path.indexOf(pathDelimiter) >= 0) {
-            path = path.replace(process.cwd(), '');
-            path = path.replace(getFolderWrapping('src'), '');
-            path = path.replace(getFolderWrapping('dist'), '');
-            path = path.replace('.ts', '');
-            path = path.replace('.js', '');
-            path = path.replace(/\//g, ':');
+    private static parsePathToScope(filepath: string): string {
+        if (filepath.indexOf(path.sep) >= 0) {
+            filepath = filepath.replace(process.cwd(), '');
+            filepath = filepath.replace(`${path.sep}src${path.sep}`, '');
+            filepath = filepath.replace(`${path.sep}dist${path.sep}`, '');
+            filepath = filepath.replace('.ts', '');
+            filepath = filepath.replace('.js', '');
+            filepath = filepath.replace(path.sep, ':');
         }
-        return path;
+        return filepath;
     }
 
     private scope: string;
diff --git a/src/core/SwaggerUI.ts b/src/core/SwaggerUI.ts
@@ -2,7 +2,6 @@ import * as express from 'express';
 import * as path from 'path';
 import * as swaggerUi from 'swagger-ui-express';
 import { Environment } from './helpers/Environment';
-import { getFolderWrapping } from './helpers/Path';
 
 
 export class SwaggerUI {
@@ -13,7 +12,7 @@ export class SwaggerUI {
 
     public setup(app: express.Application): void {
         if (Environment.isTruthy(process.env.SWAGGER_ENABLED)) {
-            const baseFolder = __dirname.indexOf(getFolderWrapping('src')) >= 0 ? getFolderWrapping('src') : getFolderWrapping('dist');
+            const baseFolder = __dirname.indexOf(`${path.sep}src${path.sep}`) >= 0 ? `${path.sep}src${path.sep}` : `${path.sep}dist${path.sep}`;
             const basePath = __dirname.substring(0, __dirname.indexOf(baseFolder));
             const swaggerFile = require(path.join(basePath, process.env.SWAGGER_FILE));
             const packageJson = require(path.join(basePath, 'package.json'));
diff --git a/src/core/helpers/Path.ts b/src/core/helpers/Path.ts

Original file line number	Diff line number	Diff line change
`@@ -1,43 +1,43 @@`
`1`	`1`	`#`
`2`	`2`	`# APPLICATION`
`3`	`3`	`#`
`4`		`-APP_NAME=express-typescript-boilerplate`
`5`		`-APP_ENV=local`
`6`		`-APP_HOST=http://localhost`
`7`		`-APP_URL_PREFIX=/api`
	`4`	`+APP_NAME="express-typescript-boilerplate"`
	`5`	`+APP_ENV="local"`
	`6`	`+APP_HOST="http://localhost"`
	`7`	`+APP_URL_PREFIX="/api"`
`8`	`8`	`APP_PORT=3000`
`9`	`9`
`10`	`10`	`#`
`11`	`11`	`# LOGGING`
`12`	`12`	`#`
`13`		`-LOG_LEVEL=debug`
`14`		`-LOG_ADAPTER=winston`
	`13`	`+LOG_LEVEL="debug"`
	`14`	`+LOG_ADAPTER="winston"`
`15`	`15`
`16`	`16`	`#`
`17`	`17`	`# API Info`
`18`	`18`	`#`
`19`	`19`	`API_INFO_ENABLED=true`
`20`		`-API_INFO_ROUTE=/info`
	`20`	`+API_INFO_ROUTE="/info"`
`21`	`21`
`22`	`22`	`#`
`23`	`23`	`# Swagger Documentation`
`24`	`24`	`#`
`25`	`25`	`SWAGGER_ENABLED=true`
`26`		`-SWAGGER_ROUTE=/docs`
`27`		`-SWAGGER_FILE=/src/api/swagger.json`
	`26`	`+SWAGGER_ROUTE="/docs"`
	`27`	`+SWAGGER_FILE="/src/api/swagger.json"`
`28`	`28`
`29`	`29`	`#`
`30`	`30`	`# Monitor`
`31`	`31`	`#`
`32`	`32`	`MONITOR_ENABLED=true`
`33`		`-MONITOR_ROUTE=/status`
	`33`	`+MONITOR_ROUTE="/status"`
`34`	`34`
`35`	`35`	`#`
`36`	`36`	`# DATABASE`
`37`	`37`	`#`
`38`	`38`	`# MySql`
`39`		`-DB_CLIENT=mysql`
`40`		`-DB_CONNECTION=mysql://root@localhost:3306/my_database`
	`39`	`+DB_CLIENT="mysql"`
	`40`	`+DB_CONNECTION="mysql://root@localhost:3306/my_database"`
`41`	`41`
`42`	`42`	`# PostGres`
`43`	`43`	`#DB_CLIENT=pg`
`@@ -46,12 +46,12 @@ DB_CONNECTION=mysql://root@localhost:3306/my_database`
`46`	`46`	`# Knex`
`47`	`47`	`DB_POOL_MIN=0`
`48`	`48`	`DB_POOL_MAX=7`
`49`		`-DB_MIGRATION_DIR=./src/database/migrations`
`50`		`-DB_MIGRATION_TABLE=version`
`51`		`-DB_SEEDS_DIR=./src/database/seeds`
	`49`	`+DB_MIGRATION_DIR="./src/database/migrations"`
	`50`	`+DB_MIGRATION_TABLE="version"`
	`51`	`+DB_SEEDS_DIR="./src/database/seeds"`
`52`	`52`
`53`	`53`	`#`
`54`	`54`	`# Auth0`
`55`	`55`	`#`
`56`		`-# AUTH0_HOST=https://w3tecch.auth0.com`
`57`		`-AUTH0_HOST=http://localhost:3333`
	`56`	`+# AUTH0_HOST="https://w3tecch.auth0.com"`
	`57`	`+AUTH0_HOST="http://localhost:3333"`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ export class AbstractMakeCommand {`
`76`	`76`	`return (name: string) => {`
`77`	`77`	`let ns = name.split('/');`
`78`	`78`	`ns = ns.map((v) => _.camelCase(v));`
`79`		`- ns[ns.length - 1] = _.capitalize(ns[ns.length - 1]);`
	`79`	`+ ns[ns.length - 1] = _.upperFirst(ns[ns.length - 1]);`
`80`	`80`	`return (ns.join('/')) + prefix + suffix;`
`81`	`81`	`};`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,15 +46,15 @@ export const existsFile = async (filePath: string, stop: boolean = false, isTest`
`46`	`46`	`fs.exists(filePath, async (exists) => {`
`47`	`47`
`48`	`48`	`if (exists) {`
`49`		`- let fileName = filePath.split('/src/')[1];`
	`49`	`+ let fileName = filePath.split(path.normalize('/src/'))[1];`
`50`	`50`	`if (isTest) {`
`51`		`- fileName = filePath.split('/test/')[1];`
	`51`	`+ fileName = filePath.split(path.normalize('/test/'))[1];`
`52`	`52`	`}`
`53`	`53`	`const answer = await prompt([`
`54`	`54`	`{`
`55`	`55`	`type: 'confirm',`
`56`	`56`	`name: 'override',`
`57`		- message: `Override "${isTest ? 'test' : 'src'}/${fileName}"?`,
	`57`	+ message: `Override "${path.join(isTest ? 'test' : 'src', fileName)}"?`,
`58`	`58`	`default: true`
`59`	`59`	`}`
`60`	`60`	`]);`