sal-core v1.0.16

This library aims to facilitate making express apps with dependency injection. Interface of this library is very simple and we aim to keep it close to express.

To beign, you can import App decorator from sal-core and use it like this:

import express from "express"
import { App } from "sal-core"

const PORT = process.env.PORT || 3500;

@App({ port: PORT })
class TestApp {}

This will get a basic app started over just like you do in express. Now normally, you would create routers, and controllers in traditional way and register them but now, instead of doing that, all you have to do is import @Controller and mappings: @GetMapping, @PostMapping, @PutMapping, @PatchMapping, @DeleteMapping and make a controller like this:

import { Controller, GetMapping } from "sal-core";
import { Request, Response } from "express";

@Controller("/api/user")
class UserController {
    @GetMapping("/:id")
    public async getUser(req: Request, res: Response) {
        res.status(200).send({ id: 1, name: "sal" })   
    }
}

export default UserController

make sure to import this in main app.ts and use it like this

import UserController from "./user/user.controller";

@App({ port: PORT, controllers: [UserController] })
class TestApp {}

isn't it awesome?

Now that isn't it, this library was mainly designed to be a lightweight singleton dependency injection library. Therefore, you can as of now, make property injections & constructor injections.

Here is a example for how would development flow go with this library

user.repository.ts

import { Component } from "sal-core"

@Component
class UserRepository {
    public async getUser() {
        return { id: 1, name: "Mehdi" }
    }
}

export default UserRepository

user.service.ts

import { Autowired, Component } from "sal-core";
import UserRepository from "./user.repository";

@Component
class UserService {
    @Autowired private userRepo: UserRepository // This is a Property Injection
    constructor(private readonly userRepo: UserRepository) {} // This is a constructor injection

    /* Constructor injections are performed automatically if class is marked as Component */

    public async getUser() {
        return await this.userRepo.getUser() 
    }
}

export default UserService

user.controller.ts

import { Controller, GetMapping } from "sal-core";
import { Request, Response } from "express";
import UserService from "./user.service";

@Controller("/api/user")
class UserController {
    constructor(private readonly userService: UserService) {}

    @GetMapping("/:id")
    public async getUser(req: Request, res: Response) {
        const user = await this.userService.getUser()
        res.status(200).send({ ...user, params: req.params, query: req.query })   
    }
}

export default UserController

Validation in sal-core

For validations to work, you have to add a validator to sal-core like this:

import { setValidator } from "sal-core"
import { validateOrReject } from "class-validator"

setValidator(validateOrReject)

ts setValidator function takes parameter function that can reject or resolve.

now you can perform validations in controllers via following decorator:

class LoginDto {
    @IsString()
    email: string;
    @IsString()
    password: string;
}

@PostMapping()
async test(@Body body: LoginDto) {
    return { ...body, url: req?.url }
}

or you can use yup like:

import { setErrorAccessor } from "sal-core"

setErrorAccessor('error.errors[]')

// in handler

@PostMapping()
async test(@Req req: Request) {
    const validated = await schema.validate(req.body)
    return { ...body, url: req?.url }
}

And yes, thats all you have to do, body will automatically be validated against LoginDto or yup schema. for errors you'll get one error as below with 400 status code.

{ message: string }

Now you'll be thinking how will i access req & res objects in this handlers since that seems to be lost, We have following additonal decorators as well to manage it:

1. Req (injects request object)

@Req req: Request

2. Res (injects response object)

@Res res: Response

Middlewares:

As for middlewares, you can apply them to Controllers or handlers / methods of controllers like this.

const permission: RequestHandler = (req, res, next) => {
    console.log("passing permission check")
    next()
}
const logger: RequestHandler = (req, res, next) => {
    console.log(req.baseUrl)
    next()
}
const auth: RequestHandler = (req, res, next) => {
    console.log("passing user authentication")
    next()
}

@Controller("/api/users")
@Middlewares(logger)
class Test {
    constructor(private readonly userService: UserService) {}

    @GetMapping("/")
    @Middlewares(auth, permission)
    public async getUser(req: Request, res: Response) {
        const user = await this.userService.getUser()
        return user
    }
}

These are normal express middlewares and can have customized implementation as per your needs. To be straight forward, you can pass your existing middlewares to @Middleware decorator and apply it to either methods / controllers. For global middlwares, you can simple use

@App({ port: PORT, controllers: [UserController], middlewares: [express.json(), cors()] })

Circular Dependencies:

In case of circular dependencies, you will notice that circular property that gets executed first will be undefined If you ever come across such a case, where you just have to manage circular dependencies, use @Lazy("type:string").

here is an example:

user.service.ts

@Component
class UserService {
    constructor(private readonly userRepo: UserRepository) {}

    public async getUser() {
        return await this.userRepo.getUser()
    }
}

export default UserService

user.repository.ts

@Component
class UserRepository {
    @Lazy("UserService") private userService: UserService

    constructor(userService: UserService) {
        this.userService = userService
    }
    
    public async getUser() {
        return { id: 1, name: "Mehdi" }
    }
}

export default UserRepository

OR

user.repository.ts

@Component
class UserRepository {
    constructor(@Lazy("UserService", "userService") private userService: UserService) {}
    
    public async getUser() {
        return { id: 1, name: "Mehdi" }
    }
}

export default UserRepository

@Lazy is fully safe to use now, but it is good to refactor sometimes because circular dependency can also come from a poor design.

Exceptions

Exceptions can be handy, and you can control status codes, with messages that are thrown. you can throw these exceptions in controllers, services or repositories. It is not recommended to thorw these in middlewares because they currently don't have support for handling them.

1. BadRequestException
2. NotFoundException
3. UnauthorizedException
4. ForbiddenException
5. CustomException

import { BadRequestException } from 'sal-core'

// Throws error with status 404 and message passed to its constructor.
throw new BadRequestException("something was bad")

You can expect this response when above exception is thrown:

// It will have a status code of 400
{ message: "something was bad" }

As for CustomException, you have to pass both message and status as constructor parameters. thus giving you control over status code as well.

import { CustomException } from 'sal-core'

throw new CustomException("something was wrong", 400)

Container Api

The di-container exposes following properties. Try not to mess with them.

container.getApp()

This method is used to retrieve server instance returned by app.listen method of express. If you've an app UserApp, you can get its server as:

@App({ port: ..., controllers: ... })
class UserApp {}

const server = container.getApp(UserApp);

Now you do different stuff i:e attaching socket.io with it etc.

container.set - container.get

This is a method that you can manually use to set an instance against a class, so when that class type is @Autowired, that instance will be injected to it automatically.

import { DataSource } from "typeorm"
import { container } from "sal-core"

const dataSource = new DataSoruce({ /* options go here */ })
container.set(DataSource, dataSource);
const dataSource = container.get(DataSource) // It will return the data source instance

make sure to call container.set before importing Controllers for now.

Now you can inject it like this:

@Component
class UserRepository {
    constructor(private readonly dataSource: DataSource) {}

    // Use it as you like
}