Merge pull request #379 from credebl/refactor-sign-in-sign-up-api

Refactor sign in and sign up api

apps/api-gateway/src/authz/authz.controller.ts

@@ -21,7 +21,7 @@ import { Response } from 'express';
 import { EmailVerificationDto } from '../user/dto/email-verify.dto';
 import { AuthTokenResponse } from './dtos/auth-token-res.dto';
 import { LoginUserDto } from '../user/dto/login-user.dto';
-import { AddUserDetails } from '../user/dto/add-user.dto';
+import { AddUserDetailsDto } from '../user/dto/add-user.dto';
 import { CustomExceptionFilter } from 'apps/api-gateway/common/exception-handler';
 
 
@@ -71,37 +71,30 @@ export class AuthzController {
 
   /**
   *
-  * @param email
-  * @param userInfo
-  * @param res
-  * @returns Add new user
+  * @Body userInfo
+  * @returns User's registration status
   */
   @Post('/signup')
   @ApiOperation({ summary: 'Register new user to platform', description: 'Register new user to platform' })
-  async addUserDetails(@Body() userInfo: AddUserDetails, @Res() res: Response): Promise<Response> {
-      const userDetails = await this.authzService.addUserDetails(userInfo);
+  async addUserDetails(@Body() userInfo: AddUserDetailsDto, @Res() res: Response): Promise<Response> {
+      await this.authzService.addUserDetails(userInfo);
       const finalResponse = {
         statusCode: HttpStatus.CREATED,
-        message: ResponseMessages.user.success.create,
-        data: userDetails.response
+        message: ResponseMessages.user.success.create
       };
     return res.status(HttpStatus.CREATED).json(finalResponse);
 
   }
-
-
   /**
-  * 
-  * @param loginUserDto 
-  * @param res 
-  * @returns User access token details
+  * @Body loginUserDto
+  * @returns User's access token details
   */
   @Post('/signin')
   @ApiOperation({
     summary: 'Authenticate the user for the access',
     description: 'Authenticate the user for the access'
   })
-  @ApiResponse({ status: 200, description: 'Success', type: AuthTokenResponse })
+  @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: AuthTokenResponse })
   @ApiBody({ type: LoginUserDto })
   async login(@Body() loginUserDto: LoginUserDto, @Res() res: Response): Promise<Response> {
 
@@ -110,7 +103,7 @@ export class AuthzController {
       const finalResponse: IResponseType = {
         statusCode: HttpStatus.OK,
         message: ResponseMessages.user.success.login,
-        data: userData.response
+        data: userData
       };
 
       return res.status(HttpStatus.OK).json(finalResponse);

apps/api-gateway/src/authz/authz.service.ts

@@ -8,8 +8,8 @@ import {
 } from '@nestjs/websockets';
 import { UserEmailVerificationDto } from '../user/dto/create-user.dto';
 import { EmailVerificationDto } from '../user/dto/email-verify.dto';
-import { AddUserDetails } from '../user/dto/add-user.dto';
-
+import { AddUserDetailsDto } from '../user/dto/add-user.dto';
+import { ISendVerificationEmail, ISignInUser, IVerifyUserEmail } from '@credebl/common/interfaces/user.interface';
 
 @Injectable()
 @WebSocketGateway()
@@ -28,23 +28,23 @@ export class AuthzService extends BaseService {
     return this.sendNats(this.authServiceProxy, 'get-user-by-keycloakUserId', keycloakUserId);
   }
 
-  async sendVerificationMail(userEmailVerification: UserEmailVerificationDto): Promise<UserEmailVerificationDto> {
+  async sendVerificationMail(userEmailVerification: UserEmailVerificationDto): Promise<ISendVerificationEmail> {
     const payload = { userEmailVerification };
     return this.sendNatsMessage(this.authServiceProxy, 'send-verification-mail', payload);
   }
 
-  async verifyEmail(param: EmailVerificationDto): Promise<EmailVerificationDto> {
+  async verifyEmail(param: EmailVerificationDto): Promise<IVerifyUserEmail> {
     const payload = { param };
     return this.sendNatsMessage(this.authServiceProxy, 'user-email-verification', payload);
   }
 
-  async login(email: string, password?: string, isPasskey = false): Promise<{ response: object }> {
+  async login(email: string, password?: string, isPasskey = false): Promise<ISignInUser> {
     const payload = { email, password, isPasskey };
-    return this.sendNats(this.authServiceProxy, 'user-holder-login', payload);
+    return this.sendNatsMessage(this.authServiceProxy, 'user-holder-login', payload);
   }
 
-  async addUserDetails(userInfo: AddUserDetails): Promise<{ response: string }> {
+  async addUserDetails(userInfo: AddUserDetailsDto): Promise<string> {
     const payload = { userInfo };
-    return this.sendNats(this.authServiceProxy, 'add-user', payload);
+    return this.sendNatsMessage(this.authServiceProxy, 'add-user', payload);
   }
 }

apps/api-gateway/src/dtos/email-validator.dto.ts

@@ -5,8 +5,9 @@ import { IsEmail, IsNotEmpty, MaxLength } from 'class-validator';
 export class EmailValidator {
 
   @ApiProperty()
-  @IsNotEmpty({ message: 'Email is required.' })
-  @MaxLength(256, { message: 'Email must be at most 256 character.' })
+  @IsEmail({}, { message: 'Please provide a valid email' })
+  @IsNotEmpty({ message: 'Email is required' })  
+  @MaxLength(256, { message: 'Email must be at most 256 character' })
   @IsEmail()
   email: string;
 }

apps/api-gateway/src/user/dto/add-user.dto.ts

@@ -1,9 +1,9 @@
 import { trim } from '@credebl/common/cast.helper';
 import { ApiProperty } from '@nestjs/swagger';
 import { Transform } from 'class-transformer';
-import { IsBoolean, IsEmail, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+import { IsBoolean, IsEmail, IsNotEmpty, IsOptional, IsString, MaxLength, MinLength } from 'class-validator';
 
-export class AddUserDetails {
+export class AddUserDetailsDto {
 
     @ApiProperty({ example: 'awqx@getnada.com' })
     @IsEmail({}, { message: 'Please provide a valid email' })
@@ -13,11 +13,15 @@ export class AddUserDetails {
 
     @ApiProperty({ example: 'Alen' })
     @IsNotEmpty({ message: 'First name is required' })
+    @MinLength(2, { message: 'First name must be at least 2 characters.' })
+    @MaxLength(50, { message: 'First name must be at most 50 characters.' })
     @IsString({ message: 'First name should be a string' })
     firstName: string;
 
     @ApiProperty({ example: 'Harvey' })
     @IsNotEmpty({ message: 'Last name is required' })
+    @MinLength(2, { message: 'Last name must be at least 2 characters.' })
+    @MaxLength(50, { message: 'Last name must be at most 50 characters.' })
     @IsString({ message: 'Last name should be a string' })
     lastName: string;
 

apps/api-gateway/src/user/dto/create-user.dto.ts

@@ -8,8 +8,9 @@ export class UserEmailVerificationDto {
     @ApiProperty()
     @Transform(({ value }) => trim(value))
     @Transform(({ value }) => toLowerCase(value))
-    @IsNotEmpty({ message: 'Email is required.' })
-    @MaxLength(256, { message: 'Email must be at most 256 character.' })
+    @IsEmail({}, { message: 'Please provide a valid email' }) 
+    @IsNotEmpty({ message: 'Email is required' })
+    @MaxLength(256, { message: 'Email must be at most 256 character' })
     @IsEmail()
     email: string;
 }

apps/api-gateway/src/user/dto/email-verify.dto.ts

@@ -9,8 +9,9 @@ export class EmailVerificationDto {
     @ApiProperty()
     @Transform(({ value }) => trim(value))
     @Transform(({ value }) => toLowerCase(value))
-    @IsNotEmpty({ message: 'Email is required.' })
-    @MaxLength(256, { message: 'Email must be at most 256 character.' })
+    @IsEmail({}, { message: 'Please provide a valid email' })
+    @IsNotEmpty({ message: 'Email is required' })  
+    @MaxLength(256, { message: 'Email must be at most 256 character' })
     @IsEmail()
     email: string;
 

apps/api-gateway/src/user/dto/login-user.dto.ts

@@ -6,8 +6,8 @@ import {  trim } from '@credebl/common/cast.helper';
 
 export class LoginUserDto {
     @ApiProperty({ example: 'awqx@getnada.com' })
-    @IsEmail()
-    @IsNotEmpty({ message: 'Please provide valid email' })
+    @IsEmail({}, { message: 'Please provide a valid email' })
+    @IsNotEmpty({ message: 'Email is required' }) 
     @IsString({ message: 'email should be string' })
     email: string;
 

apps/user/interfaces/user.interface.ts

@@ -66,8 +66,8 @@ interface IUserOrgRole {
     email?: string;
     orgRoles: string[];
   }
-
-  export interface ISendVerificationEmail {
+  
+export interface ISendVerificationEmail {
     email: string;
     username?: string;
   }
@@ -176,8 +176,13 @@ interface IUserOrgRole {
     search: string;
   }
 
-  export class IVerifyUserEmail {
-    email: string;
-    verificationCode: string;
+export interface IVerifyUserEmail{
+  email: string;
+  verificationCode: string;
 }
 
+export interface  IUserSignIn{
+  email: string;
+  password: string;
+  isPasskey: boolean;
+}

apps/user/src/user.controller.ts

@@ -1,14 +1,14 @@
-import { AddPasskeyDetails, ICheckUserDetails, PlatformSettings, ShareUserCertificate, UpdateUserProfile, UserCredentials, IUserInformation, IUsersProfile, UserInvitations, ISendVerificationEmail, IVerifyUserEmail} from '../interfaces/user.interface';
+import { AddPasskeyDetails, ICheckUserDetails, PlatformSettings, ShareUserCertificate, UpdateUserProfile, UserCredentials, IUsersProfile, UserInvitations, IUserInformation, IUserSignIn} from '../interfaces/user.interface';
 import {IOrgUsers, Payload} from '../interfaces/user.interface';
 
 import { AcceptRejectInvitationDto } from '../dtos/accept-reject-invitation.dto';
 import { Controller } from '@nestjs/common';
-import { LoginUserDto } from '../dtos/login-user.dto';
 import { MessagePattern } from '@nestjs/microservices';
 import { UserService } from './user.service';
 import { VerifyEmailTokenDto } from '../dtos/verify-email.dto';
 import { user } from '@prisma/client';
 import { IUsersActivity } from 'libs/user-activity/interface';
+import { ISendVerificationEmail, ISignInUser, IVerifyUserEmail } from '@credebl/common/interfaces/user.interface';
 
 @Controller()
 export class UserController {
@@ -34,9 +34,13 @@ export class UserController {
   async verifyEmail(payload: { param: VerifyEmailTokenDto }): Promise<IVerifyUserEmail> {
     return this.userService.verifyEmail(payload.param);
   }
+ /**
+  * @Body loginUserDto
+  * @returns User's access token details
+  */
 
   @MessagePattern({ cmd: 'user-holder-login' })
-  async login(payload: LoginUserDto): Promise<object> {
+  async login(payload: IUserSignIn): Promise<ISignInUser> {
    return this.userService.login(payload);
   }
 
@@ -129,8 +133,12 @@ export class UserController {
   async checkUserExist(payload: { userEmail: string }): Promise<ICheckUserDetails> {
     return this.userService.checkUserExist(payload.userEmail);
   }
+  /**
+  * @Body userInfo
+  * @returns User's registration status
+  */
   @MessagePattern({ cmd: 'add-user' })
-  async addUserDetailsInKeyCloak(payload: { userInfo: IUserInformation }): Promise<string | object> {
+  async addUserDetailsInKeyCloak(payload: { userInfo: IUserInformation }): Promise<string> {
     return this.userService.createUserForToken(payload.userInfo);
   }
 

apps/user/src/user.service.ts

@@ -36,11 +36,9 @@ import {
   IOrgUsers,
   UpdateUserProfile,
   UserCredentials, 
-  ISendVerificationEmail,
    IUserInformation,
     IUsersProfile,
-    UserInvitations,  
-    IVerifyUserEmail
+    UserInvitations
 } from '../interfaces/user.interface';
 import { AcceptRejectInvitationDto } from '../dtos/accept-reject-invitation.dto';
 import { UserActivityService } from '@credebl/user-activity';
@@ -57,6 +55,7 @@ import { AwsService } from '@credebl/aws';
 import puppeteer from 'puppeteer';
 import { WorldRecordTemplate } from '../templates/world-record-template';
 import { IUsersActivity } from 'libs/user-activity/interface';
+import { ISendVerificationEmail, ISignInUser, IVerifyUserEmail } from '@credebl/common/interfaces/user.interface';
 
 @Injectable()
 export class UserService {
@@ -267,7 +266,7 @@ export class UserService {
       const holderRoleData = await this.orgRoleService.getRole(OrgRoles.HOLDER);
       await this.userOrgRoleService.createUserOrgRole(userDetails.id, holderRoleData.id);
 
-      return 'User created successfully';
+      return ResponseMessages.user.success.signUpUser;
     } catch (error) {
       this.logger.error(`Error in createUserForToken: ${JSON.stringify(error)}`);
       throw new RpcException(error.response ? error.response : error);
@@ -312,7 +311,7 @@ export class UserService {
    * @param loginUserDto
    * @returns User access token details
    */
-  async login(loginUserDto: LoginUserDto): Promise<object> {
+  async login(loginUserDto: LoginUserDto): Promise<ISignInUser> {
     const { email, password, isPasskey } = loginUserDto;
 
     try {
@@ -344,7 +343,7 @@ export class UserService {
     }
   }
 
-  async generateToken(email: string, password: string): Promise<object> {
+  async generateToken(email: string, password: string): Promise<ISignInUser> {
     try {
       const supaInstance = await this.supabaseService.getClient();
       this.logger.error(`supaInstance::`, supaInstance);
@@ -361,6 +360,7 @@ export class UserService {
       }
 
       const token = data?.session;
+
       return token;
     } catch (error) {
       throw new RpcException(error.response ? error.response : error);

libs/common/src/interfaces/user.interface.ts

@@ -0,0 +1,16 @@
+export interface ISignInUser {
+        access_token: string;
+        token_type?: string;
+        expires_in?: number;
+        expires_at?: number;
+        refresh_token?: string;
+      }
+      export interface IVerifyUserEmail{
+        email: string;
+        verificationCode: string;
+      }
+      export interface ISendVerificationEmail {
+        email: string;
+        username?: string;
+      }
+

libs/common/src/response-messages/index.ts

@@ -17,8 +17,8 @@ export const ResponseMessages = {
             userActivity: 'User activities fetched successfully',
             userCredentials: 'User credentials fetched successfully',
             platformEcosystemettings: 'Platform and ecosystem settings updated',
-            fetchPlatformSettings: 'Platform settings fetched'
-
+            fetchPlatformSettings: 'Platform settings fetched',
+            signUpUser:'User created successfully'
         },
         error: {
             exists: 'User already exists',