refactor: tidy up API methods for UserController

Author: Bentroen

server/src/user/user.controller.ts

@@ -9,9 +9,8 @@ import {
 } from '@nestjs/common';
 import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
 import { PageQueryDTO } from '@shared/validation/common/dto/PageQuery.dto';
-import { GetUser } from '@shared/validation/user/dto/GetUser.dto';
-import { UpdateUsernameDto } from '@shared/validation/user/dto/UpdateUsername.dto';
 import { UpdateUserProfileDto } from '@shared/validation/user/dto/UpdateUserProfile.dto';
+import { UserQuery } from '@shared/validation/user/dto/UserQuery.dto';
 
 import { GetRequestToken, validateUser } from '@server/GetRequestUser';
 
@@ -27,44 +26,29 @@ export class UserController {
     private readonly userService: UserService,
   ) {}
 
-  @Get('/:username')
-  async getUser(@Param('username') username: string) {
-    return await this.userService.getUserByEmailOrId({ username: username });
-    // TODO: this may call userService.getUserByUsername directly
-  }
-
-  @Get('by-query')
-  async getUserByQuery(@Query() query: GetUser) {
-    return await this.userService.getUserByEmailOrId(query);
-  }
-
-  @Get('paginated')
-  async getUserPaginated(@Query() query: PageQueryDTO) {
-    return await this.userService.getUserPaginated(query);
-  }
-
-  @Get('me')
+  @Get()
   @ApiTags('user')
-  @ApiBearerAuth()
-  @ApiOperation({ summary: 'Get the token owner data' })
-  async getMe(@GetRequestToken() user: UserDocument | null) {
-    user = validateUser(user);
-    return await this.userService.getSelfUserData(user);
+  @ApiOperation({ summary: 'Get user data' })
+  async getUser(
+    @Query() query: UserQuery,
+    @GetRequestToken() user: UserDocument | null,
+  ) {
+    if ('me' in query && query.me) {
+      user = validateUser(user);
+      return await this.userService.getSelfUserData(user);
+    }
+
+    return await this.userService.getUserPaginated(query as PageQueryDTO);
   }
 
-  @Patch('username')
+  @Get(':username')
   @ApiTags('user')
-  @ApiBearerAuth()
-  @ApiOperation({ summary: 'Update the username' })
-  async updateUsername(
-    @GetRequestToken() user: UserDocument | null,
-    @Body() body: UpdateUsernameDto,
-  ) {
-    user = validateUser(user);
-    return await this.userService.updateUsername(user, body);
+  @ApiOperation({ summary: 'Get user profile by username' })
+  async getUserProfile(@Param('username') username: string) {
+    return await this.userService.findByUsername(username);
   }
 
-  @Patch('profile')
+  @Patch()
   @ApiTags('user')
   @ApiBearerAuth()
   @ApiOperation({ summary: 'Update the profile' })

web/src/modules/auth/features/auth.utils.ts

@@ -40,9 +40,11 @@ export const getUserData = async (): Promise<LoggedUserData | never> => {
   if (!token) throw new Error('No token found');
   if (!token.value) throw new Error('No token found');
 
+  let res;
+
   try {
     // verify the token with the server
-    const res = await axiosInstance.get('/user/me', {
+    res = await axiosInstance.get('/user?me=true', {
       headers: {
         authorization: `Bearer ${token.value}`,
       },