TsExpressDecorators

Build your TypeScript v2 application with Express decorators ! Support ES5 and ES6.

Features

Define class as Controller,
Define class as Service,
Define root path for an entire controller,
Define as sub-route path for a method,
Define routes on GET, POST, PUT, DELETE and HEAD verbs,
Define middlewares on routes,
Define required parameters,
Inject data from query string, path parameters, entire body, cookies or header,
Inject Request, Response, Next object from Express request,
IoC services,
Testing (alpha).

Installation

You can get the latest release using npm:

$ npm install --save ts-express-decorators express@4

Important! TsExpressDecorators requires Node >= 4, Express >= 4, TypeScript >= 2.0 and the experimentalDecorators, emitDecoratorMetadata, types and lib compilation options in your tsconfig.json file.

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["es6", "dom"],
    "types": ["reflect-metadata"],
    "module": "commonjs",
    "moduleResolution": "node",
    "experimentalDecorators":true,
    "emitDecoratorMetadata": true,
    "sourceMap": true,
    "declaration": false
  },
  "exclude": [
    "node_modules"
  ]
}

Quick start

Create your express server

TsExpressDecorators provide a ServerLoad class to configure your express quickly. Just create a server.ts in your root project, declare a new Server class that extends ServerLoader.

import * as Express from "express";
import {ServerLoader, IServerLifecycle} from "ts-express-decorators";
import Path = require("path");

export class Server extends ServerLoader implements IServerLifecycle {
    /**
     * In your constructor set the global endpoint and configure the folder to scan the controllers.
     * You can start the http and https server.
     */
    constructor() {
        super();

        const appPath: string = Path.resolve(__dirname);
        
        this.setEndpoint("/rest")                       // Declare your endpoint
            .scan(appPath + "/controllers/**/**.js")    // Declare the directory that contains your controllers
            .createHttpServer(8000)
            .createHttpsServer({
                port: 8080
            });

    }

    /**
     * This method let you configure the middleware required by your application to works.
     * @returns {Server}
     */
    $onMountingMiddlewares(): void|Promise<any> {
    
        const morgan = require('morgan'),
            cookieParser = require('cookie-parser'),
            bodyParser = require('body-parser'),
            compress = require('compression'),
            methodOverride = require('method-override');


        this
            .use(morgan('dev'))
            .use(ServerLoader.AcceptMime("application/json"))

            .use(cookieParser())
            .use(compress({}))
            .use(methodOverride())
            .use(bodyParser.json())
            .use(bodyParser.urlencoded({
                extended: true
            }));

        return null;
    }

    public $onReady(){
        console.log('Server started...');
    }
   
    public $onServerInitError(err){
        console.error(err);
    }

    static Initialize = (): Promise<any> => new Server().start();
    
}

Server.Initialize();

Create your first controller

Create a new calendarCtrl.ts in your controllers directory configured previously with ServerLoader.scan(). All controllers declared with @Controller decorators is considered as an Express router. An Express router require a path (here, the path is /calendars) to expose an url on your server. More precisely, it is a part of path, and entire exposed url depend on the Server configuration (see ServerLoader.setEndpoint()) and the controllers dependencies. In this case, we haven't a dependencies and the root endpoint is set to /rest. So the controller's url will be http://host/rest/calendars.

import {Controller, Get} from "ts-express-decorators";
import * as Express from "express";

interface ICalendar{
    id: string;
    name: string;
}

@Controller("/calendars")
export class CalendarCtrl {

    /**
     * Example of classic call. Use `@Get` for routing a request to your method.
     * In this case, this route "/calendars/:id" are mounted on the "rest/" path.
     *
     * By default, the response is sent with status 200 and is serialized in JSON.
     *
     * @param request
     * @param response
     * @returns {{id: any, name: string}}
     */
    @Get("/:id")
    public get(request: Express.Request, response: Express.Response): ICalendar {

        return <ICalendar> {id: request.params.id, name: "test"};
    }

    @Get("")
    @ResponseView("calendars/index") // Render "calendars/index" file using Express.Response.render internal
    public get(request: Express.Request, response: Express.Response): Array<ICalendar> {

        return [<ICalendar> {id: '1', name: "test"}];
    }
    
    @Authenticated()
    @BodyParamsRequired("calendar.name")  // Throw Bad Request (400) if the request.body.calendar.name isn't provided 
    @Post("/")
    public post(
        @BodyParams("calendar") calendar: ICalendar
    ): Promise<ICalendar> {
    
        return new Promise((resolve: Function, reject: Function) => {
        
            calendar.id = 1;
            
            resolve(calendar);
            
        });
    }
    
    @Authenticated()
    @Delete("/")
    public post(
        @BodyParams("calendar.id") @Required() id: string 
    ): Promise<ICalendar> {
    
        return new Promise((resolve: Function, reject: Function) => {
        
            calendar.id = id;
            
            resolve(calendar);
            
        });
    }
}

To test your method, just run your server.ts and send a http request on /rest/calendars/1.

Note : Decorators @Get support dynamic pathParams (see /:id) and RegExp like Express API.

Wiki

Decorators references

Class decorators

@Controller(route: string, ...ctrlsNamesDependencies?: string[]) : Declare a new controller with his Rest path.
@Service() : Declare a new Service that can be injected in other Service or Controller.

Method decorators

@All(route): Intercept all request for a given route.
@Get(route): Intercept request with GET http verb for a given route.
@Post(route): Intercept request with POST http verb for a given route.
@Put(route): Intercept request with PUT http verb for a given route.
@Delete(route): Intercept request with DELETE http verb for a given route.
@Head(route): Intercept request with HEAD http verb for a given route.
@Patch(route): Intercept request with PATCH http verb for a given route.
@Authenticated(): Call the Server.isAuthenticated method to check if the user is authenticated.
@Use(...middlewares: any[]): Set a custom middleware.
@ResponseView(viewPath: string): Render viewPath file using the method return data

Parameter Decorators

@Response(): Express.Response service.
@RequestService(): Express.Request service.
@Next(): Express.NextFunction service.
@PathParams(expression: string): Get a parameters on Express.Request.params attribut.
@BodyParams(expression: string): Get a parameters on Express.Request.body attribut.
@CookiesParams(expression: string): Get a parameters on Express.Request.cookies attribut.
@QueryParams(expression: string): Get a parameters on Express.Request.query attribut.
@Required(): Set a required flag on parameters.

Contributors

CHANGELOG

v1.3.0-3

Add @ResponseView() decorators,
Add Converters class to serialize and deserialize JSON (alpha feature)

v1.2.0

Remove Bluebird and use native Promise. Breaking change are possible if you use v1.1.0 of ts-express-decorators. Just, replace Bluebird reference in your Server.ts or install Bluebird and @types/bluebird depedencies.
Improve package.json configuration. Now, IDE like webstorm can auto discovered the exposed decorators.
Implement Lifecycle hooks.
Change testing module. See documentation (https://github.com/Romakita/ts-express-decorators/wiki/Testing).

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

huanghjb/ts-express-decorators