Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 5.14 KB

README.md

File metadata and controls

129 lines (94 loc) · 5.14 KB
Raw

Nestjs Abstract

Abstraction component for NestJs.

Fair warning: This package is still in early development stage. Please give me any feedbacks if you decide to try it out and find any problems/area-for-improvements. Thank you!

Features

  • Provides Abstractions for your NestJS RESTfulAPI.
  • Includes: AbstractModule, AbstractService, and AbstractControllerFactory along with AbstractModel (mongoose) and AbstractEntity (typeorm).
  • Supports @nestjs/swagger

Motivations

I am a big fan of TypeScript and abstraction overall. One of the biggest motivations is to create a BaseController to work with Swagger's decorators that @nestjs/swagger provides which is on the todo list. Main reason is I want to roll out a version of the package that will make it work with non-swagger applications first as this is my first attempt at an npm package.

Installation

npm i nest-abstract

Usage

  1. Import AbstractModule in your AppModule

     import { Module } from '@nestjs/common';
 import { AbstractModule } from 'nest-abstract';

 @Module({
     imports: [AbstractModule.forRoot()],
 })
 export class AppModule {}

    By default, AbstractModule will use Mongoose. You can pass a value of ObjectMapping to the forRoot() method.

    import { Module } from '@nestjs/common';
import { AbstractModule, ObjectMapping } from 'nest-abstract';

@Module({
    imports: [AbstractModule.forRoot(ObjectMapping.TypeOrm)],
})
export class AppModule {}

    Note: ObjectMapping.Mongoose will require you to install mongoose and @nestjs/mongoose while ObjectMapping.TypeOrm will require you to install typeorm and @nestjs/typeorm.

    Note: I will list the usage for Mongoose from step 2 on.

  2. Create your MongooseSchema and create an interface that will extend AbstractModel. AbstractModel is an interface that has: createdAt, updatedAt and id.

    import { Schema } from 'mongoose';
import { AbstractModel } from 'nest-abstract';

const todoSchema = new Schema({
    content: {
        type: String
    }
}, { timestamps: true });

interface Todo extends AbstractModel {
    content: string;
}

    Use your schema to initialize your Model with @nestjs/mongoose.

  3. Create your Service with AbstractMongooseService.

    import { Injectable } from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import { AbstractMongooseService } from 'nest-abstract';
import { Model } from 'mongoose';

@Injectable()
export class TodoService extends AbstractMongooseService<Todo> {
    constructor(@InjectModel('todo') private readonly _todoModel: Model<Todo>) {
        super(_todoModel);
    }
}

    Use @InjectModel() from @nestjs/mongoose to inject your MongooseModel and pass that to the abstract constructor.

  4. Create your Controller with abstractControllerFactory

    import { Controller } from '@nestjs/common';
import { abstractControllerFactory } from 'nest-abstract';
import { Todo } from './todo.model';
import { TodoService } from './todo.service';

const BaseController = abstractControllerFactory<Todo>({model: TodoService.model});

@Controller('todo')
export class TodoController extends BaseController {
    constructor(private readonly _todoService: TodoService) {
        super(_todoService);
    }
}

  5. Make sure you put your Service in providers array in Module and your Controller in controllers array in Module.

    Now your TodoController should have 5 pre-defined route handlers: find, findById, create, update and delete

With Authentication

To enable Authenticate on your Controllers with Passport, abstractControllerWithAuth.

You need to install passport and @nestjs/passport if you want to enable Authentication.

import { abstractControllerWithAuth } from 'nest-abstract';

const BaseController = abstractControllerWithAuth<Todo>({model: TodoService.model});

By default, auth is enabled by on all 5 CRUDs operations.

With Swagger

To enable Swagger on your Controller, use abstractControllerWithSwagger.

Authentication is "mandatory" with Swagger so you will have to have: passport, @nestjs/passport and @nestjs/swagger installed. By default, auth is enabled by on all 5 CRUDs operations. If you wish to use abstractControllerWithSwagger without auth, please pass in an object of type DefaultAuthObj and set all the properties to false.

Plans

Credit