Merge pull request #22 from p-society/auth-otp

Addition of Otp flow to project.

package.json

@@ -44,6 +44,7 @@
     "@socket.io/redis-adapter": "^8.3.0",
     "@types/nodemailer": "^6.4.17",
     "bcrypt": "^5.1.1",
+    "bcryptjs": "^2.4.3",
     "bullmq": "^5.34.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
@@ -62,6 +63,7 @@
     "@nestjs/schematics": "^10.1.4",
     "@nestjs/testing": "^10.4.1",
     "@types/bcrypt": "^5.0.2",
+    "@types/bcryptjs": "^2.4.6",
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.12",
     "@types/lodash": "^4.17.13",

src/app.module.ts

@@ -14,6 +14,8 @@ import { ReactionsModule } from './services/apis/reactions/reactions.module';
 import { ProfilesModule } from './services/apis/profiles/profiles.module';
 import { QueueModule } from './services/bullmq/queue.module';
 import { BullModule } from '@nestjs/bullmq';
+import { GenerateOtpModule } from './services/apis/otp/generateOtp.module';
+import { MailerModule } from './services/apis/mailer/mailer.module';
 
 @Module({
   imports: [
@@ -43,6 +45,8 @@ import { BullModule } from '@nestjs/bullmq';
     AdapterModule,
     ProfilesModule,
     ReactionsModule,
+    GenerateOtpModule,
+    MailerModule,
   ],
   controllers: [AppController],
   providers: [

src/common/hashing.ts

@@ -0,0 +1,15 @@
+import * as bcrypt from 'bcryptjs';
+
+export async function hashString(input: string): Promise<string> {
+  const saltRounds = 10;
+  const hashedString = await bcrypt.hash(input, saltRounds);
+  return hashedString;
+}
+
+export async function compareHashedString(
+  input: string,
+  hashedString: string,
+): Promise<boolean> {
+  const isMatch = await bcrypt.compare(input, hashedString);
+  return isMatch;
+}

src/constants/otp.constants.ts

@@ -0,0 +1 @@
+export const OTP_TTL = 10 * 60; // 10 minutes

src/constants/sports-enum.ts

@@ -5,4 +5,14 @@ enum SportsEnum {
   Basketball = 'Basketball',
   Volleyball = 'Volleyball',
 }
+
+export const SportsEnumList = [
+  SportsEnum.Football,
+  SportsEnum.Badminton,
+  SportsEnum.Basketball,
+  SportsEnum.Cricket,
+  SportsEnum.Football,
+  SportsEnum.Volleyball,
+];
+
 export default SportsEnum;

src/services/apis/mailer/mailer.controller.ts

@@ -1,22 +1,22 @@
-import { Controller, Post } from '@nestjs/common';
-import { MailerService } from './mailer.service';
+// import { Controller, Post } from '@nestjs/common';
+// import { MailerService } from './mailer.service';
 
-@Controller('mail')
-export class MailerController {
-  constructor(private mailerService: MailerService) {}
+// @Controller('mail')
+// export class MailerController {
+//   constructor(private mailerService: MailerService) {}
 
-  // @Public()
-  // @Post()
-  // async sendMail() {
-  //   await this.mailerService.sendMPassGenerationEmail(
-  //     '[email protected]',
-  //     'Saswat',
-  //     'XYZ'
-  //   )
-  //   await this.mailerService.sendSupportTicketResolvedEmail(
-  //     '[email protected]',
-  //     'Saswat',
-  //     '123456'
-  //   )
-  // }
-}
+//   // @Public()
+//   // @Post()
+//   // async sendMail() {
+//   //   await this.mailerService.sendMPassGenerationEmail(
+//   //     '[email protected]',
+//   //     'Saswat',
+//   //     'XYZ'
+//   //   )
+//   //   await this.mailerService.sendSupportTicketResolvedEmail(
+//   //     '[email protected]',
+//   //     'Saswat',
+//   //     '123456'
+//   //   )
+//   // }
+// }

src/services/apis/mailer/mailer.module.ts

@@ -4,7 +4,7 @@ import { MailerService } from './mailer.service';
 import { MailerModule as NestMailerModule } from '@nestjs-modules/mailer';
 import { HandlebarsAdapter } from '@nestjs-modules/mailer/dist/adapters/handlebars.adapter';
 import * as path from 'path';
-import { MailerController } from './mailer.controller';
+// import { MailerController } from './mailer.controller';
 
 @Global()
 @Module({
@@ -24,15 +24,21 @@ import { MailerController } from './mailer.controller';
           from: configService.get<string>('MAIL_FROM'),
         },
         template: {
-          dir: path.join(__dirname, 'templates'),
+          dir: path.join(
+            __dirname,
+            '../../../../src/services/apis/mailer/templates',
+          ),
           adapter: new HandlebarsAdapter(),
           options: {
             strict: true,
           },
         },
         options: {
           partials: {
-            dir: path.join(__dirname, 'templates/partials'),
+            dir: path.join(
+              __dirname,
+              '../../../../src/services/apis/mailer/templates/partials',
+            ),
             options: {
               strict: true,
             },
@@ -41,7 +47,7 @@ import { MailerController } from './mailer.controller';
       }),
     }),
   ],
-  controllers: [MailerController],
+  controllers: [],
   providers: [MailerService],
   exports: [MailerService],
 })

src/services/apis/mailer/mailer.service.ts

@@ -9,17 +9,20 @@ export class MailerService {
 
   async sendMail(
     to: string,
-    subject: string,
-    content: string,
+    // subject: string,
+    // content: string,
+    otp: string,
     template?: string,
-    context?: Record<string, any>,
+    //context?: Record<string, any>,
   ) {
     await this.mailerService.sendMail({
       to,
-      subject,
-      text: content,
+      subject: 'OTP for your account',
       template: template ? `./${template}` : undefined,
-      context: context || {},
+      context: {
+        otp,
+        supportEmail: '[email protected]',
+      },
     });
   }
 }

src/services/apis/mailer/templates/partials/otp.hbs

@@ -1,6 +1,68 @@
-<p> Use
-  the OTP below to complete the process:</p>
-<div class='otp'> {{otp}} </div>
-<p>This OTP is valid for 15 minutes. If you didn’t request this, please ignore
-  this email or contact support at
-  {{supportEmail}}</p>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <style>
+    body {
+      font-family: Arial, sans-serif;
+      background-color: #f4f4f4;
+      margin: 0;
+      padding: 0;
+    }
+    .container {
+      max-width: 600px;
+      margin: 20px auto;
+      background-color: #ffffff;
+      padding: 20px;
+      border-radius: 8px;
+      box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
+    }
+    .header {
+      text-align: center;
+      padding-bottom: 20px;
+      border-bottom: 1px solid #dddddd;
+    }
+    .header h1 {
+      margin: 0;
+      color: #333333;
+    }
+    .content {
+      padding: 20px 0;
+    }
+    .otp {
+      font-size: 24px;
+      font-weight: bold;
+      color: #333333;
+      text-align: center;
+      margin: 20px 0;
+    }
+    .footer {
+      text-align: center;
+      padding-top: 20px;
+      border-top: 1px solid #dddddd;
+      color: #777777;
+    }
+    .footer a {
+      color: #007BFF;
+      text-decoration: none;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <div class="header">
+      <h1>Programming Society</h1>
+    </div>
+    <div class="content">
+      <p>Dear Member,</p>
+      <p>Use the OTP below to complete the process:</p>
+      <div class="otp">{{otp}}</div>
+      <p>This OTP is valid for 10 minutes. If you didn’t request this, please ignore this email or contact support at <a href="mailto:{{supportEmail}}">{{supportEmail}}</a>.</p>
+    </div>
+    <div class="footer">
+      <p>Thank you,<br>Programming Society Team</p>
+    </div>
+  </div>
+</body>
+</html>

src/services/apis/otp/dto/generateOtp.dto.ts

@@ -0,0 +1,23 @@
+import { date, z } from 'zod';
+
+// DTO for incoming OTP payload. This ensures the payload structure and validates fields.
+/**
+ * The email of the user to send OTP.
+ * @example  "[email protected]"
+ * */
+
+export const OtpValidation = z.object({
+  email: z.string().email(),
+});
+
+/**
+ * The email of the user to send OTP.
+ * @example  "
+ * */
+export const VerifyOtpValidation = z.object({
+  email: z.string().email(),
+  otp: z.string().trim(),
+});
+
+export type OtpDto = z.infer<typeof OtpValidation>;
+export type VerifyOtpDto = z.infer<typeof VerifyOtpValidation>;

src/services/apis/otp/generateOtp.controller.ts

@@ -0,0 +1,30 @@
+import { Body, Controller, Post } from '@nestjs/common';
+import { GenerateOtpService } from './generateOtp.service';
+import {
+  OtpDto,
+  OtpValidation,
+  VerifyOtpDto,
+  VerifyOtpValidation,
+} from './dto/generateOtp.dto';
+import { Public } from '../auth/decorators/public.decorator';
+
+@Controller('otp')
+export class GenerateOtpController {
+  constructor(private readonly generateOtpService: GenerateOtpService) {}
+
+  @Public()
+  @Post('generate')
+  async create(@Body() generateOtpDto: OtpDto) {
+    generateOtpDto = OtpValidation.parse(generateOtpDto);
+    return await this.generateOtpService.enqueueOtpJob(generateOtpDto);
+  }
+
+  @Public()
+  @Post('verify')
+  async verify(@Body() verifyOtpDto: VerifyOtpDto) {
+    verifyOtpDto = VerifyOtpValidation.parse(verifyOtpDto);
+    return (await this.generateOtpService.compareOtp(verifyOtpDto))
+      ? 'OTP is correct'
+      : 'OTP is incorrect';
+  }
+}

src/services/apis/otp/generateOtp.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { GenerateOtpController } from './generateOtp.controller';
+import { GenerateOtpService } from './generateOtp.service';
+
+@Module({
+  imports: [],
+  controllers: [GenerateOtpController],
+  providers: [GenerateOtpService],
+  exports: [GenerateOtpService], // not exporting services as no need in testing (??)
+})
+export class GenerateOtpModule {}