feat: forgot password

.gitignore

@@ -13,3 +13,4 @@ dist/
 
 # orm
 ormconfig.json
+sendgrid.env

package.json

@@ -42,6 +42,7 @@
   },
   "dependencies": {
     "@prisma/client": "^3.14.0",
+    "@sendgrid/mail": "^8.1.3",
     "aws-sdk": "^2.846.0",
     "bcryptjs": "^2.4.3",
     "cors": "^2.8.5",
@@ -61,4 +62,4 @@
     "typeorm": "^0.2.31",
     "uuid": "^8.3.2"
   }
-}
+}

src/modules/users/infra/http/controller/UsersController.ts

@@ -6,6 +6,9 @@
 import ReadAllUsersService from '@modules/users/services/ReadAllUsersService';
 import ReadUserByIdService from '@modules/users/services/ReadUserByIdService';
 import UpdateUserService from '@modules/users/services/UpdateUserService';
+import SendPinToUserEmailService from '@modules/users/services/SendPinToUserEmailService';
+import VerifyPinService from '@modules/users/services/VerifyPinService';
+import resetPasswordService from '@modules/users/services/resetPasswordService';
 
 export default class UserController {
   public async create(req: Request, res: Response): Promise<Response> {
@@ -32,18 +35,18 @@
     return res.status(201).json(user);
   }
 
   public async readAll(req: Request, res: Response): Promise<Response> {
 
     const readUsers = container.resolve(ReadAllUsersService);
 
     const users = await readUsers.execute();
 
     if(users) {
         users.forEach(user => {
         user.password = '###';
       });
     }
 
     return res.status(201).json(users);
   }
 
@@ -56,7 +59,7 @@
       id,
     });
 
     if(user){
       user.password = '###';
     }
 
@@ -104,4 +107,41 @@
     return res.status(201).json(user);
   }
 
+  public async sendPin(req: Request, res: Response): Promise<Response> {
+    const { email } = req.body;
+
+    const sendPinToUserEmail = container.resolve(SendPinToUserEmailService);
+
+    const user = await sendPinToUserEmail.execute({
+      email,
+    });
+
+    return res.status(201).json({id: user.id});
+  }
+
+  public async verifyPin(req: Request, res: Response): Promise<Response> {
+    const { id } = req.params;
+    const { pin } = req.body;
+
+    const verifyPin = container.resolve(VerifyPinService);
+
+    const user = await verifyPin.execute({
+      id,
+      pin,
+    });
+
+    return res.status(201).json({id: user.id});
+  }
+
+  public async resetPassword(req: Request, res: Response): Promise<Response> {
+    const { id } = req.params;
+    const { password } = req.body;
+
+    const resetPassword = container.resolve(resetPasswordService);
+
+    const user = await resetPassword.execute({id, password});
+
+    return res.status(201).json({id: user.id});
+  }
+
 }

src/modules/users/infra/http/routes/users.routes.ts

@@ -11,6 +11,9 @@ usersRoutes.patch('/update/:id', usersController.update);
 usersRoutes.delete('/delete/:id', usersController.delete);
 usersRoutes.get('/read', usersController.readAll);
 usersRoutes.get('/read/:id', usersController.readById);
+usersRoutes.post('/send-pin', usersController.sendPin);
+usersRoutes.post('/verify-pin/:id', usersController.verifyPin);
+usersRoutes.post('/reset-password/:id', usersController.resetPassword);
 
 
 export default usersRoutes;

src/modules/users/infra/prisma/entities/users.prisma

@@ -1,10 +1,12 @@
 model Users {
-  id         String   @id @default(uuid())
-  name       String   @unique
-  email      String
+  id         String    @id @default(uuid())
+  name       String    
+  email      String    @unique
   password   String
   language   String
   phone      String
-  created_at DateTime @default(now())
-  updated_at DateTime @default(now())
+  pin        String?
+  pinExpires DateTime?
+  created_at DateTime  @default(now())
+  updated_at DateTime  @default(now())
 }

src/modules/users/infra/prisma/repositories/UsersRepository.ts

@@ -52,9 +52,23 @@ export default class UsersRepository implements IUsersRepository {
     return user;
   }
 
-  public async update(id: string, data: IUpdateUserDTO): Promise<Users> {
-    const user = await this.ormRepository.update({ where: { id }, data });
+  public update(id: string, data: IUpdateUserDTO): Promise<Users> {
+    return this.ormRepository.update({ where: { id }, data });
+  }
+
+  public sendPinToUserEmail(email: string, pin: string, pinExpires: Date): Promise<Users> {
+    return this.ormRepository.update({
+      where: { email },
+      data: { pin, pinExpires },
+    });
 
-    return user;
   }
+
+  public resetPassword(id: string, password: string): Promise<Users> {
+    return this.ormRepository.update({
+      where: { id },
+      data: { password },
+    });
+  }
+
 }

src/modules/users/repositories/IUsersRepository.ts

@@ -11,6 +11,8 @@ interface IUsersRepository {
   findById(id: string): Promise<Users | null>;
   delete(id: string): Promise<Users>;
   update(id: string, data: IUpdateUserDTO): Promise<Users>;
+  sendPinToUserEmail(email: string, pin: string, pinExpires: Date): Promise<Users>;
+  resetPassword(id: string, password: string): Promise<Users>;
 }
 
 export default IUsersRepository;

src/modules/users/services/ResetPasswordService.ts

@@ -0,0 +1,38 @@
+import { inject, injectable } from 'tsyringe';
+
+import { Users } from '@prisma/client';
+
+import AppError from '@shared/errors/AppError';
+
+import IHashProvider from '@shared/container/providers/HashProvider/models/IHashProvider';
+import IUsersRepository from '../repositories/IUsersRepository';
+
+interface IRequest {
+  id: string;
+  password: string;
+}
+
+@injectable()
+export default class UpdateUserService {
+  constructor(
+    @inject('UsersRepository')
+    private usersRepository: IUsersRepository,
+
+    @inject('HashProvider')
+    private hashProvider: IHashProvider,
+  ) { }
+
+public async execute({
+  id,
+  password,
+}: IRequest): Promise<Users> {
+    const userAlreadyExists = await this.usersRepository.findById(id);
+
+    if (!userAlreadyExists) throw new AppError('User with this id does not exist');
+
+    const hashedPassword = await this.hashProvider.generateHash(password);
+    const updatedUser = await this.usersRepository.resetPassword(id, hashedPassword);
+
+    return updatedUser;
+  }
+}

src/modules/users/services/SendPinToUserEmailService.ts

@@ -0,0 +1,55 @@
+import { inject, injectable } from 'tsyringe';
+import sgMail from '@sendgrid/mail';
+
+import { Users } from '@prisma/client';
+
+import AppError from '@shared/errors/AppError';
+
+import IUsersRepository from '../repositories/IUsersRepository';
+
+interface IRequest {
+  email: string;
+}
+
+@injectable()
+export default class SendPinToUserEmailService {
+  constructor(
+    @inject('UsersRepository')
+    private usersRepository: IUsersRepository,
+  ) { }
+
+  public async execute({
+    email,
+  }: IRequest): Promise<Users> {
+    const userAlreadyExists = await this.usersRepository.findByEmailWithRelations(email);
+    if (!userAlreadyExists) throw new AppError('User with this email does not exist');
+
+    const expiration = 5;
+    const pin = Math.floor(Math.random() * 9999).toString();
+    const data = new Date();
+    data.setMinutes(data.getMinutes() + expiration);
+    const user = await this.usersRepository.sendPinToUserEmail(
+      email.toLowerCase(),
+      pin,
+      data,
+    );
+
+    sgMail.setApiKey(process.env.SENDGRID_API_KEY as string)
+    const msg = {
+      to: email, 
+      from: '[email protected]', 
+      subject: 'Apogeo | Recuperação de senha',
+      text: user.name + ', seu pin para recuperação de senha é: ' + pin + '. Ele expira em ' + expiration + ' minutos.',
+      html: user.name + ', seu pin para recuperação de senha é: <strong>' + pin + '</strong>. Ele expira em ' + expiration + ' minutos.',
+    };
+
+    try {
+      await sgMail.send(msg);
+      console.log('Email sent');
+    } catch (error: any) {
+      console.error(error);
+    }
+
+    return user;
+  }
+}

src/modules/users/services/VerifyPinService.ts

@@ -0,0 +1,28 @@
+import { inject, injectable } from 'tsyringe';
+import { Users } from '@prisma/client';
+import AppError from '@shared/errors/AppError';
+import IUsersRepository from '../repositories/IUsersRepository';
+
+interface IRequest {
+  id: string;
+  pin: string;
+}
+
+@injectable()
+export default class VerifyPinService {
+  constructor(
+    @inject('UsersRepository')
+    private usersRepository: IUsersRepository,
+  ) { }
+
+  public async execute({
+    id, pin,
+  }: IRequest): Promise<Users> {
+    const user = await this.usersRepository.findById(id);
+    if (!user) throw new AppError('User with this id does not exist');
+    if (user?.pinExpires && user.pin != pin) throw new AppError('Pin is incorrect');
+    if (user?.pinExpires && user.pinExpires < new Date()) throw new AppError('Pin is expired');
+
+    return user;
+  }
+}

src/shared/infra/prisma/migrations/20240724230110_pin_related_fields/migration.sql

@@ -0,0 +1,15 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[email]` on the table `Users` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- DropIndex
+DROP INDEX "Users_name_key";
+
+-- AlterTable
+ALTER TABLE "Users" ADD COLUMN     "pin" TEXT,
+ADD COLUMN     "pinExpires" TIMESTAMP(3);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Users_email_key" ON "Users"("email");

src/shared/infra/prisma/schema.prisma

@@ -9,12 +9,14 @@ generator client {
 }
 
 model Users {
-  id         String   @id @default(uuid())
-  name       String   @unique
-  email      String
+  id         String    @id @default(uuid())
+  name       String
+  email      String    @unique
   password   String
   language   String
   phone      String
-  created_at DateTime @default(now())
-  updated_at DateTime @default(now())
+  pin        String?
+  pinExpires DateTime?
+  created_at DateTime  @default(now())
+  updated_at DateTime  @default(now())
 }