Return a standard response to client in all controllers. All response could inherit from a BaseResponse class that have useful properties which will be used as a standard for returning responses to client.

If any entity is modified, use the typegoose pre-hook to update the updatedBy field on the entity that was modified

Use custom relative path in test (*.test.ts) files

Description

There currently isn't a standard for creating issues.

Why do we need this?

Bug Reports 🐛

To help maintainers resolve issues as quickly as possible it is important that we communicate effectively

Feature Requests 📦

To communicate clearly the feature details and reduce the debt of rework/refactoring

Community Questions 🤔

In an open-source community, everyone's voice should be heard clearly

Admin User should be able to perform CRUD operation on a User entity

Named exports are a better idea than default exports because they enforce consistent naming while importing - especially in TypeScript.

Enforce named exports in the linting (eslint) rules.

Refactor folders/files to follow the onion achitecture

It will be great to collaborate on Slack for contributors who are working on the project.

Add tenant service class/methods to make the tenant controller cleaner. Take a cue from the AuthService class here.

Catch and handle all rejected promises that were not handled in the application and return 500 internal server error to the client

Add a Permission entity that should have a list of role IDs.
The idea is, a Role can have one or more Permission that restricts what a User with that role can or cannot do.

Add eslint using the air-bnb standards and fix linting errors and warnings

Refactor long important paths to use relative paths set in tsconfig.json

Add API documentation like swagger

Delete trivial Agenda jobs in DB

Refactor test files to make it cleaner.

Implement save or update feature in the base repository here

Set/Get currently signed-in user so that it can be globally accessible

More documentation is required to help users of this application

Question

I was wondering if we could consider using tsoa package for routing instead of inversify-express-utils for two reasons.

1. tsoa comes out of the box with swagger documentation feature
2. tsoa is actively supported.

As this application is purely an API application, it will be very useful if API documentation can be easily integrated and maintained without too much overhead and writing too much decorators and customization.

Bug 🐛

There are a couple of spelling mistakes in the readme.

It will be very useful and convenient to have mapper methods that automatically map entities to DTOs which will be returned to the client.
One example is here .

const tenants = await this._tenantRepository.findManyByQuery({ name: tenantName });
const tenantDtoList = tenants.map(t => {
   let tenantDto: TenantDto = {
        name: t.name,
        description: t.description,
        isActive: t.isActive,
        id: t.id
    };
    return tenantDto;
});

return tenantDtoList

This can quickly get messy if the DTO has many properties that need to be manually mapped to it. It will be helpful to have an auto mapper method or package that can do this.

Implement password reset feature for user and write test for this feature

Question

Hi, I am the author of automapper-nartc. Due to allowing consumers creating different instances of AutoMapper (and making sure profiles/mappings still work with each instance), breaking changes have emerged. Specifically the MappingProfileBase.configure() method has changed.

Now whenever you call addProfile() on the AutoMapper instance, that instance will be pass in the configure() method. profile.configure(this).

const SomeProfile extends MappingProfileBase {
      constructor() {
         super();
      }

      configure(mapper: AutoMapper) {
         // use mapper.createMap() instead of this.createMap()
         mapper.createMap(...)
      }
}

Thanks for trying out the library.

Removed global variables and utilize dependency injection

Implement soft delete feature on entities.

I have an endpoint that is used to get a list of tenants by a query like so .../api/v1/tenants?name=default here. I want the user to get an empty list if they queried for a nonexisting tenant name.
Also if a client has passed in an unexpected get query, an empty array should be returned. .../api/v1/tenants?name="blahblah" should return an empty array.

Automatically set createdBy field on User entity using pre-hook method of typegoose

Return typescript class as the response gotten from repositories instead of a JavaScript object representation of the class.
After making calls to the DB using the injected repositories, the response (even after being cast to a typescript class) is always a JavaScript object instead of a typescript class.

const user:User = await new userRepository.findById(userId); // findById is defined to return Promise<User>

console.log(user instanceOf User) //strangely returns false
console.log(user typeof) // is a JavaScript object instead of a User

Because of this weird behavior, I can't call methods of user instance. Hence doing something like this user.activate(); (where activate() is a method in the User class) throws an annoying runtime error that says activate is not a method in user because of course user is not actually an instance of User
Is there a way to fix this? I won't be able to use packages like class-transform to simply convert the JavaScript object to its corresponding typescript class because User has a private constructor which will make class-transform methods (like plainToClass) to complain

Take a look here

const userInstance = User.createInstance({...dto, password: hashedPassword });
userRecord = await this._userRepository.save(userInstance);

even though userRecord seem like an instance of User, it actually isn't.

Setup continues integration with Travis CI

Setup in-memory DB using mongodb-memeory-server to easy testing

Currently, in the User and Tenant entities, which are children of the BaseEntity there are a few methods for setting certain properties such as setRole() (in the User entity), deactive() (in the BaseEntity).
It will be useful to have more of these methods that directly modifies the entity

The CONTRIBUTING document needs to be updated in order to assist existing and potential contributors on the process of contribution.

Write more test to cover more scenarios

Implement email confirmation feature for newly registered users

Proper documentation is need for existing and subsequently created public classes, properties and methods.

Implement pagination in all get all endpoints and return a standard pagination response

Lockout user when make "n" invalid login attempts for a given time which increases exponentially

A Tenant ID is passed by the client through the X-Tenant-Id header. This ID should be accessible everywhere without necessarily importing it.

I currently use a global variable to achieve (which I think isn't the right thing to do). Take a look here.

This boilerplate implements a multi-tenancy architecture. It will be convenient to seed mongo DB with the default tenant for the first time the application starts. This is because to call other endpoints in the application, X-Tenant-Id must be passed in the header. As shown here