Contents:
- Users/Auth
- Mongoose
- Nodemailer
- Changelogs
Authentication, authorization and user/account management built with @nestjs. This module
takes care of session storage/management using mongo-store and connect-session (Express/MongoDb), account login/logout,
password resets and registration.
You'll need to apply some configuration options when bootstrapping your server:
``typescript
import { NestFactory } from '@nestjs/core';
import { CoreModule } from './core/core.module';
import { expressConfig } from '@synap-libs/nest';
async function bootstrap()
{
const app = await NestFactory.create(CoreModule);
// This allows the SynapNestUsersModule to set up passport middleware and session persistence
expressConfig(app, {
// Without passing corsOpts, you won't be able to make use of this module's API
corsOpts: { origin: [/localhost/], credentials: true },
dbConnectionUrl: 'mongodb://localhost:27017/my-db'
});
app.listen(9000);
}
bootstrap().catch(e => Logger.log(
Error bootstrapping app: ${e.stack || e.message || e},`
'Bootstrap')
);
See auth.interfaces for further available options the expressConfig method accepts.
Now you can use the module in your application:
`typescript
import { Module } from '@nestjs/common';
import { SynapNestUsersModule } from '@synap-libs/nest';
@Module({
imports: [SynapNestUsersModule.forRoot()]
})
export class CoreModule
{
}
`
This module provides a base user schema that looks like this:
`typescript
import * as moment from 'moment';
export const BaseSchema = {
createdAt: { type: Date, required: true, default: moment(new Date(Date.now())).toDate() },
deleted: { type: Boolean, required: true, default: false },
email: { type: String, required: true, index: { unique: true } },
enabled: { type: Boolean, required: true, default: true },
firstName: { type: String, required: true },
lastLoggedIn: { type: Date, required: false },
lastName: { type: String, required: true },
password: { type: String, required: true },
registrationToken: { type: String, required: false },
resetPasswordToken: { type: String, required: false },
roles: { type: [String], required: true, default: ['user'] },
tokenExpires: { type: Date, required: false },
updatedAt: { type: Date, required: true, default: moment(new Date(Date.now())).toDate() }
};
`
If you don't need any other properties on your users, then you can skip ahead. If you do require additional properties,
you can pass them in the forRoot method when importing the module:
`typescript
SynapNestUsersModule.forRoot({
extraSchemaFields: {
img: { type: String, required: true, default: 'assets/images/stock-user.png' },
displayName: { type: String, required: true, default: function()
{
if (!(this.firstName && this.lastName))
return 'awesome.user';
return ${this.firstName.toLowerCase()}.${this.lastName.toLowerCase()};`
}}
}
})
This is an extension of Nest's MongooseModule. The only differences are
1) The mongoose package is 5.3.1 as opposed to 5.0.1 which is the version included in @nestjs/mongoose
2) The createMongooseProviders method has been updated to allow schema hooks and dependency injection
`typescript
import { Module } from '@nestjs/common';
import { MongooseModule, InjectModel } from './';
import { Schema, Model, Document } from 'mongoose';
// CoreModule
@Module({
imports: [
MongooseModule.forRoot('mongodb://localhost:27017/my-db', { useNewUrlParser: true }),
MyModule
]
})
export class CoreModule {}
// Document Interface
export interface MyDocument extends Document
{
someProp:string;
}
// MyService
export class MyService
{
constructor(@InjectModel('MyModel') private readonly myModel:Model
{
}
}
// MyModule
@Module({
imports: [
MongooseModule.forFeature([{
name: 'MyModel',
schema: new Schema({ someProp: { type: String } }),
hooks: [
{
type: 'post',
method: 'remove',
fn: async (doc:MyDocument, svc:MyService) => console.log('MyModel.postRemove'),
inject: ['MyService']
}
]
}])
]
})
export class MyModule {}
``
A Nodemailer module built with @nestjs.
#Usage:
TODO
TODO