ts-node-server [WIP]


ts-node-server is node framework for developing RESTful web services in Typescript.

It pulls together some of the best node libraries :

* Fastify : Fast and low overhead web framework, for Node.js

* Pino : Super fast, all natural JSON logger for Node.js

* Inversify : A powerful and lightweight inversion of control container for JavaScript & Node.js apps powered by TypeScript.

* Swagger UI : A collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

* MongoDB driver : Mongo DB Native NodeJS Driver

Features

$3

ts-node-server use decorators to build fastify routes.

``
@controller('/v1/users')
export class UserController {

@httpGet(':name')
public async get(@pathParam('name')name: string) {
}

@httpPost()
public async create(@queryParam('clone')clone: boolean) {
}
`

$3

ts-node-server use tipify to validate, serialize and deserialize. It ensures that no property can be accidentally exposed.

`
@jsonObject()
export class StellarSystem {

@jsonProperty('_id', ObjectIdConverter)
private _id?: string;

@jsonProperty('name')
private _name?: string;

@jsonProperty('planets', [Planet])
private _planets?: Planet[];
}
`

$3

ts-node-server use route decorators and tipify decorators to build a swagger configuration.

$3

ts-node-server imports fastify-metrics and exposes all your app metrics at /metrics.

$3

ts-node-server provides an healthcheck (/healthcheck). You can add more checks by extending Healthcheck class :

`
@injectable()
export class MongoHealthcheck implements Healthcheck {

constructor() {
}

public getName(): string {
return 'mongodb';
}

public check(): Promise {
return {
true,
'content'
};
}
}
`

$3

#### Basic authentication

`
const server = new Server({
container: container,
auth: {
basic: {
'demo': {
password: 'password',
roles: ['admin']
}
}
}
});
`

#### JWT authentication

`
const server = new Server({
container: container,
auth: {
jwt: {
authorizationUrl: 'http://localhost:9000/auth/realms/master/protocol/openid-connect/auth?nonce=',
certificate: '.......CONTENT.......',
application: 'test'
}
}
});
`

#### Protect a route

Protect a route using auth options:
`
@httpGet({ url: '/:name', auth: ['jwt', 'basic'] })
public async get(@pathParam('name')name: string) {
...
}
`

Allow only a list of roles to access to a route:
`
@httpGet({ url: '/:name', auth: { jwt: { role: ['admin'] } })
public async get(@pathParam('name')name: string) {
...
}
`

#### Get connected user
`
@httpGet({ url: '/:name', auth: 'jwt')
public async get(@pathParam('name')name: string, @auth()user: Principal {
const logger = getLogger('get', this);
logger.info('my name is', user.firstname, user.lastname, 'and my login is', user.login);
...
}
`

$3

ts-node-service provides GenericClient which is wrapper around request.
GenericClient features:
Serialization / Deserialization with tipify*
* Error management and expected status
* Authorization header format form a token or principal
Add request-id* header to the request

`
export class UserClient extends GenericClient {

public getUser(name: string) : Promise {
const options : RequestOptions = {
expectedStatus: 200,
principal: principal,
deserializeType: User
};
return this.get('http://localhost/api/users/' + name, options);
}
}
`

$3

#### Get request logger

With fastify a logger is created for every request, it allows to add a request id to every log.
To access to this logger:
`
const logger = getLogger();
logger.info('hello');
``

Usage

See ts-node-server-starter for an example.