# nestjs-easy-auth > User authentication for NestJS. Latest version **0.1.0** (published 2023-10-19) · MIT license · 0 weekly downloads ## Install ```sh npm install nestjs-easy-auth pnpm add nestjs-easy-auth yarn add nestjs-easy-auth bun add nestjs-easy-auth ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.0 | | Published | 2023-10-19 | | First published | 2023-10-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 15 | | Unpacked size | 412.7 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | bpisano | | Maintainers | bpisano | ## Links - npm: https://www.npmjs.com/package/nestjs-easy-auth - Repository: https://github.com/bpisano/nestjs-easy-auth - Homepage: https://github.com/bpisano/nestjs-easy-auth#readme - Issues: https://github.com/bpisano/nestjs-easy-auth/issues - npm.io page: https://npm.io/package/nestjs-easy-auth ## Dependencies (15) - [bcrypt](https://npm.io/package/bcrypt.md) ^5.1.1 - [date-fns](https://npm.io/package/date-fns.md) ^2.30.0 - [passport](https://npm.io/package/passport.md) ^0.6.0 - [@nestjs/jwt](https://npm.io/package/@nestjs/jwt.md) ^10.1.1 - [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^10.2.6 - [passport-jwt](https://npm.io/package/passport-jwt.md) ^4.0.1 - [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^10.2.6 - [@nestjs/config](https://npm.io/package/@nestjs/config.md) ^3.1.1 - [passport-local](https://npm.io/package/passport-local.md) ^1.0.0 - [class-validator](https://npm.io/package/class-validator.md) ^0.14.0 - [@nestjs/passport](https://npm.io/package/@nestjs/passport.md) ^10.0.2 - [model-conversion](https://npm.io/package/model-conversion.md) ^1.0.0 - [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1 - [@nestjs/event-emitter](https://npm.io/package/@nestjs/event-emitter.md) ^2.0.2 - [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^10.2.6 ## Recent versions - 0.1.0 (latest) — 2023-10-19 - 0.0.5 — 2023-10-17 - 0.0.4 — 2023-10-17 - 0.0.3 — 2023-10-16 - 0.0.2 — 2023-10-16 - 0.0.1 — 2023-10-16 ## README # NestJS Easy Auth Elegant and simple authentication solution for NestJS. ```typescript @Module({ imports: [ AuthModule.withConfiguration({ jwtConfig: { secret: 'my-secret', accessTokenExpiresIn: '1h', refreshTokenExpiresIn: '1d', tokenExtraction: ExtractJwt.fromAuthHeaderAsBearerToken(), ignoreExpiration: false }, modelProvider: DefaultModelProvider.withModels({ credentials: CredentialsMock, user: UserMock }), methods: [SignInEmailPassword.forRoot(), LogInEmailPassword.forRoot()] }) ] }) export class ApiModule {} ``` # Table of Contents - [Installation](#installation) - [Quick start](#quick-start) 1. [Provide your database](#1-provide-your-database) 2. [Provide your jwt configuration](#2-provide-your-jwt-configuration) 3. [Provide your models](#3-provide-your-models) 4. [Provide your authentication methods](#4-provide-your-authentication-methods) - [Documentation](#documentation) - [Introduction](#introduction) - [Authentication methods](#authentication-methods) - [Sign in with email and password](#sign-in-with-email-and-password) - [Login with email and password](#login-with-email-and-password) - [Creating your own authentication method](#creating-your-own-authentication-method) # Installation You can install the package using the following commands: ```bash $ yarn yarn add nestjs-easy-auth $ npm npm install nestjs-easy-auth ``` # Quick start ### 1. Provide your database This package allows you to use your own database for the credentials and user storage. You can create your own `CredentialsStorage` and `UserStorage`.
Using MongoDB You can use MongoDB as the main storage. Thi, you can install [nestjs-easy-auth-mongo](https://github.com/bpisano/nestjs-easy-auth-mongo) which provides a MongoDB implementation. To get started, import the `AuthMongoProviderModule` in your `ApiModule`. ```bash $ yarn yarn add nestjs-easy-auth-mongo $ npm npm install nestjs-easy-auth-mongo ``` ```typescript @Module({ imports: [ AuthMongoProviderModule.withConfiguration({ dbName: 'your-database-name', uri: 'mongodb://user:password@127.0.0.1:27017', schemas: { credentials: DBCredentialsSchema, user: DBUserSchema } }) ] }) export class ApiModule {} ```
Using SQL Comming soon...
Using a custom database See providing a custom storage.
### 2. Provide your jwt configuration Provide your jwt configuration using the `jwtConfig` property. ```typescript AuthModule.withConfiguration({ jwtConfig: { secret: 'my-secret', accessTokenExpiresIn: '1h', refreshTokenExpiresIn: '1d', tokenExtraction: ExtractJwt.fromAuthHeaderAsBearerToken(), ignoreExpiration: false } }); ``` ### 3. Provide your models This package allows you to use your own `Credentials` and `User` models. Your models needs to conforms to the `CredentialsRepresentation` and `UserRepresentation` interfaces.
Credentials model example ```typescript export class Credentials implements CredentialsRepresentation { public constructor( public readonly userId: string, public readonly authType: string, public readonly accessToken: string, public readonly refreshToken: string, public readonly accessTokenExpiration: Date, public readonly refreshTokenExpiration: Date ) {} // Required to convert the model to a database model. public toDatabaseModel(): DBCredentials { return new DBCredentials( this.userId, this.authType, this.accessToken, this.refreshToken, this.accessTokenExpiration, this.refreshTokenExpiration ); } // Required to convert the model to a public model. public toPublicModel(): PublicCredentials { return new PublicCredentials( this.userId, this.authType, this.accessToken, this.refreshToken, this.accessTokenExpiration, this.refreshTokenExpiration ); } } ```
User model example ```typescript export class User implements UserRepresentation { public constructor( public readonly id: string, public readonly email: string, public readonly hashedPassword?: string ) {} // Required to convert the model to a database model. public toDatabaseModel(): DBUser { return new DBUser(this.id, this.email, this.hashedPassword); } // Required to convert the model to a public model. // Do not include the hashed password in the public model. public toPublicModel(): PublicUser { return new PublicUser(this.id, this.email); } } ```
You can provide your models using the `DefaultModelProvider` class. ```typescript AuthModule.withConfiguration({ jwtConfig: { ... }, modelProvider: DefaultModelProvider.withModels({ credentials: CredentialsMock, user: UserMock }) }); ``` ### 4. Provide your authentication methods You can provide your authentication methods using the `methods` property. These methods will be used to authenticate your users. ```typescript AuthModule.withConfiguration({ jwtConfig: { ... }, modelProvider: DefaultModelProvider.withModels({ ... }), methods: [SignInEmailPassword.forRoot(), LogInEmailPassword.forRoot()] }); ``` With theses methods, you can create and authentify users using their email and password with the following HTTP requests: ```HTTP POST /auth/sign-in { "email": "user@yourdomain.com", "password": "my-password" } ``` ```HTTP POST /auth/login { "email": "user@yourdomain.com", "password": "my-password" } ``` You can also refresh you credentials using the `POST /auth/refresh` endpoint. ```HTTP POST /auth/refresh { "refresh_token": "your-refresh-token" } ``` # Documentation ## Authentication methods ### SignInEmailPassword #### Inputs | **Property** | **Example** | | ------------ | --------------------- | | email | `user@yourdomain.com` | | password | `yourpassword` | #### Options | **Option** | **Default value** | | ------------ | -------------------------------- | | hashPassword | `SignInEmailPassword.brcyptHash` | ### LoginEmailPassword #### Inputs | **Property** | **Example** | | ------------ | --------------------- | | email | `user@yourdomain.com` | | password | `yourpassword` | #### Options | **Option** | **Default value** | | --------------- | --------------------------------------------- | | comparePassword | `LoginEmailPassword.bcryptPasswordComparison` | --- _Source: https://npm.io/package/nestjs-easy-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._