chore(api): auth module refactoring

Author: akdasa

modules/libs/protocol/auth.ts

@@ -65,15 +65,15 @@ export const RevokedTokenStorageKey = (token: JwtToken) => `tokens:revoked:${tok
 /*                               Authentication                               */
 /* -------------------------------------------------------------------------- */
 
-export interface OtpLogInRequest {
+export interface OtpSignInRequest {
   /** Login to sign up with */
   login: string;
 
   /** OTP to validate */
   otp: string;
 }
 
-export interface OtpLogInResponse {
+export interface OtpSignInResponse {
   /** Access token to authenticate user */
   accessToken: string;
 
@@ -94,12 +94,12 @@ export interface RefreshTokensResponse {
   refreshToken: string;
 }
 
-export interface LogOutRequest {
+export interface SignOutRequest {
   /** Refresh token */
   refreshToken: string;
 }
 
-export interface LogOutResponse {
+export interface SignOutResponse {
 }
 
 /* -------------------------------------------------------------------------- */

modules/libs/protocol/routes.ts

@@ -1,10 +1,12 @@
 export const Routes = (baseUrl: string = '') => ({
   auth: {
     root: () => `${baseUrl}/auth`,
-    login: (method: string) => `${baseUrl}/auth/login/${method}`,
-    logout: () => `${baseUrl}/auth/logout`,
+    signIn:  (method: string) => `${baseUrl}/auth/signin/${method}`,
+    signOut: ()               => `${baseUrl}/auth/signout`,
+
+    signup: (method: string) => `${baseUrl}/auth/signup/${method}`,
     tokens: {
-      refresh: () => `${baseUrl}/auth/tokens/refresh`,
+      refresh: () => `${baseUrl}/auth/refresh`,
     },
     profile: () => `${baseUrl}/auth/profile`,
   },

modules/services/api/src/auth/auth.module.ts

@@ -3,10 +3,9 @@ import { JwtModule } from '@nestjs/jwt';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { Role, User, UserRole } from '@vidya/entities';
 
-import { LoginController } from './controllers/login.controller';
 import { OtpController } from './controllers/otp.controller';
-import { ProfileController } from './controllers/profile.controller';
 import { TokensController } from './controllers/tokens.controller';
+import { UserAuthenticationController } from './controllers/user-authentication.controller';
 import { AuthRolesMappingProfile } from './mappers/roles.mapper';
 import { AuthService } from './services/auth.service';
 import { AuthUsersService } from './services/auth-users.service';
@@ -18,12 +17,7 @@ import { RevokedTokensService } from './services/revokedTokens.service';
     TypeOrmModule.forFeature([User, Role, UserRole]),
     JwtModule.register({ global: true }),
   ],
-  controllers: [
-    LoginController,
-    OtpController,
-    TokensController,
-    ProfileController,
-  ],
+  controllers: [UserAuthenticationController, OtpController, TokensController],
   providers: [
     OtpService,
     AuthUsersService,

modules/services/api/src/auth/controllers/otp.controller.ts

@@ -18,7 +18,7 @@ import { OtpService } from '@vidya/api/auth/services';
 import { Routes } from '@vidya/protocol';
 
 @Controller()
-@ApiTags('Authentication')
+@ApiTags('Authentication :: One-Time Password')
 export class OtpController {
   constructor(private readonly otpService: OtpService) {}
 

modules/services/api/src/auth/controllers/profile.controller.ts

@@ -30,7 +30,7 @@ import { JwtToken, OtpType, Routes } from '@vidya/protocol';
 
 @Controller()
 @ApiTags('Authentication')
-export class LoginController {
+export class UserAuthenticationController {
   constructor(
     @Inject(AuthConfig.KEY)
     private readonly authConfig: ConfigType<typeof AuthConfig>,
@@ -41,20 +41,20 @@ export class LoginController {
   ) {}
 
   /* -------------------------------------------------------------------------- */
-  /*                            POST /auth/login/otp                            */
+  /*                            POST /auth/signin/otp                           */
   /* -------------------------------------------------------------------------- */
 
-  @Post(Routes().auth.login('otp'))
+  @Post(Routes().auth.signIn('otp'))
   @ApiOperation({
-    summary: 'Authorizes user',
-    operationId: 'auth::login',
+    summary: 'Signs user in with OTP',
+    operationId: 'auth::signIn',
     description:
-      `Authorizes user by OTP.\n\n` +
-      `Returns access and refresh tokens if the user has been authorized.`,
+      `Signs user in with one-time password.\n\n` +
+      `Returns access and refresh tokens if the user has been authenticated.`,
   })
   @ApiOkResponse({
-    type: dto.OtpLogInRequest,
-    description: 'User has been authorized.',
+    type: dto.OtpSignInRequest,
+    description: 'User has been authenticated.',
   })
   @ApiUnauthorizedResponse({
     type: dto.ErrorResponse,
@@ -64,10 +64,10 @@ export class LoginController {
     type: dto.ErrorResponse,
     description: 'Too many requests',
   })
-  async loginWithOtp(
-    @Body() request: dto.OtpLogInRequest,
-  ): Promise<dto.OtpLogInResponse> {
-    // TODO rate limit login attempts
+  async signinWithOtp(
+    @Body() request: dto.OtpSignInRequest,
+  ): Promise<dto.OtpSignInResponse> {
+    // TODO rate limit login attempts by login
 
     // validate OTP, if invalid send 401 Unauthorized response
     const otp = await this.otpService.validate(request.login, request.otp);
@@ -91,7 +91,7 @@ export class LoginController {
         : undefined,
     );
 
-    return new dto.OtpLogInResponse({
+    return new dto.OtpSignInResponse({
       accessToken: tokens.accessToken,
       refreshToken: tokens.refreshToken,
     });
@@ -101,17 +101,18 @@ export class LoginController {
   /*                              POST /auth/logout                             */
   /* -------------------------------------------------------------------------- */
 
-  @Post(Routes().auth.logout())
+  @Post(Routes().auth.signOut())
   @UseGuards(AuthenticatedUser)
   @ApiBearerAuth()
   @ApiOperation({
-    summary: 'Log out user',
-    operationId: 'auth::logout',
+    summary: 'Signs user out',
+    operationId: 'auth::signOut',
     description:
-      `Log out user.\n\n` + `Revokes the refresh token and logs out the user.`,
+      `Signs user out.\n\n` +
+      `Revokes the refresh token and signs the user out.`,
   })
   @ApiOkResponse({
-    type: dto.LogOutResponse,
+    type: dto.SignOutResponse,
     description: 'User has been logged out.',
   })
   @ApiBadRequestResponse({
@@ -123,9 +124,9 @@ export class LoginController {
     description: 'Unauthorized request.',
   })
   async logoutUser(
-    @Body() request: dto.LogOutRequest,
+    @Body() request: dto.SignOutRequest,
     @UserAccessToken() userAccessToken: JwtToken,
-  ): Promise<dto.LogOutResponse> {
+  ): Promise<dto.SignOutResponse> {
     // revoke access token to prevent reusing it
     await this.revokedTokensService.revoke(userAccessToken);
 
@@ -136,6 +137,6 @@ export class LoginController {
     }
 
     // user logged out
-    return new dto.LogOutResponse();
+    return new dto.SignOutResponse();
   }
 }

…src/auth/controllers/login.controller.ts …ollers/user-authentication.controller.tsmodules/services/api/src/auth/controllers/login.controller.ts renamed to modules/services/api/src/auth/controllers/user-authentication.controller.ts modules/services/api/src/auth/controllers/login.controller.ts renamed to modules/services/api/src/auth/controllers/user-authentication.controller.ts

@@ -7,7 +7,7 @@ import { IsNotEmpty, IsString } from 'class-validator';
 /*                                Authentcation                               */
 /* -------------------------------------------------------------------------- */
 
-export class OtpLogInRequest implements protocol.OtpLogInRequest {
+export class OtpSignInRequest implements protocol.OtpSignInRequest {
   @ApiProperty({ example: 'example@example.com' })
   @IsNotEmpty()
   login: string;
@@ -18,7 +18,7 @@ export class OtpLogInRequest implements protocol.OtpLogInRequest {
   otp: string;
 }
 
-export class OtpLogInResponse implements protocol.OtpLogInResponse {
+export class OtpSignInResponse implements protocol.OtpSignInResponse {
   constructor(options: { accessToken: string; refreshToken: string }) {
     this.accessToken = options.accessToken;
     this.refreshToken = options.refreshToken;
@@ -40,14 +40,14 @@ export class RefreshTokensRequest implements protocol.RefreshTokensRequest {
   refreshToken: string;
 }
 
-export class LogOutRequest implements protocol.LogOutRequest {
+export class SignOutRequest implements protocol.SignOutRequest {
   @ApiProperty({ example: 'refreshToken' })
   @IsString()
   @IsNotEmpty()
   refreshToken: string;
 }
 
-export class LogOutResponse implements protocol.LogOutResponse {}
+export class SignOutResponse implements protocol.SignOutResponse {}
 
 /* -------------------------------------------------------------------------- */
 /*                                   Tokens                                   */

modules/services/api/src/auth/dto/auth.dto.ts

@@ -30,7 +30,7 @@ const Crud = CrudDecorators({
 });
 
 @Controller()
-@ApiTags('Roles')
+@ApiTags('Education :: Roles')
 @ApiBearerAuth()
 @UseGuards(AuthenticatedUser)
 export class RolesController {

modules/services/api/src/edu/controllers/roles/roles.controller.ts

@@ -19,7 +19,7 @@ const Crud = CrudDecorators({
 });
 
 @Controller()
-@ApiTags('Users')
+@ApiTags('Education :: Users')
 @UseGuards(AuthenticatedUser)
 export class UserRolesController {
   constructor(

modules/services/api/src/edu/controllers/users/userRoles.controller.ts

@@ -30,7 +30,7 @@ const Crud = CrudDecorators({
 
 @Controller()
 @ApiBearerAuth()
-@ApiTags('Users')
+@ApiTags('Education :: Users')
 @UseGuards(AuthenticatedUser)
 export class UsersController {
   constructor(