refactor: rename UserViewDto to UserPreviewDto and create new DTO for user profile

Author: Bentroen

server/src/search/search.service.ts

@@ -1,7 +1,7 @@
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import { SearchQueryDTO } from '@shared/validation/common/dto/SearchQuery.dto';
 import { SongViewDto } from '@shared/validation/song/dto/SongView.dto';
-import { UserViewDto } from '@shared/validation/user/dto/UserView.dto';
+import { UserPreviewDto } from '@shared/validation/user/dto/UserPreview.dto';
 
 import { SongService } from '@server/song/song.service';
 import { UserService } from '@server/user/user.service';
@@ -61,7 +61,7 @@ export class SearchService {
     return {
       users: users.map(
         ({ username, profileImage }) =>
-          new UserViewDto({
+          new UserPreviewDto({
             username,
             profileImage,
           }),

server/src/user/user.service.ts

@@ -6,7 +6,7 @@ import { CreateUser } from '@shared/validation/user/dto/CreateUser.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 { UserViewDto } from '@shared/validation/user/dto/UserView.dto';
+import { UserProfileViewDto } from '@shared/validation/user/dto/UserProfileView.dto';
 import { validate } from 'class-validator';
 import { Model } from 'mongoose';
 
@@ -156,12 +156,14 @@ export class UserService {
       user = await this.findByUsername(username);
     }
 
-    if (user) return new UserViewDto(user);
+    if (!user) {
+      throw new HttpException(
+        'You must provide an email, ID or username',
+        HttpStatus.BAD_REQUEST,
+      );
+    }
 
-    throw new HttpException(
-      'You must provide an email, ID or username',
-      HttpStatus.BAD_REQUEST,
-    );
+    return UserProfileViewDto.fromUserDocument(user);
   }
 
   public async getHydratedUser(user: UserDocument) {

shared/validation/user/dto/UserView.dto.ts renamed to shared/validation/user/dto/UserPreview.dto.ts

@@ -1,8 +1,8 @@
-export class UserViewDto {
+export class UserPreviewDto {
   username: string;
   profileImage: string;
 
-  constructor(partial: UserViewDto) {
+  constructor(partial: UserPreviewDto) {
     Object.assign(this, partial);
   }
 }

shared/validation/user/dto/UserProfileView.dto.ts

@@ -0,0 +1,33 @@
+import { UserDocument } from '@server/user/entity/user.entity';
+
+export class UserProfileViewDto {
+  username: string;
+  publicName: string;
+  profileImage: string;
+  description: string;
+  lastSeen: Date;
+  loginCount: number;
+  loginStreak: number;
+  playCount: number;
+  // socialLinks: Record<keyof typeof UserLinks, string | undefined>;
+
+  public static fromUserDocument(user: UserDocument): UserProfileViewDto {
+    return new UserProfileViewDto({
+      username: user.username,
+      publicName: user.publicName,
+      profileImage: user.profileImage,
+      description: user.description,
+      lastSeen: user.lastSeen,
+      loginCount: user.loginCount,
+      loginStreak: user.loginStreak,
+      playCount: user.playCount,
+      // socialLinks: user.socialLinks,
+    });
+  }
+
+  constructor(partial: UserProfileViewDto) {
+    Object.assign(this, partial);
+  }
+}
+
+// TODO: refactor all DTOs as ...Request.dto and ...Response.dto

web/src/modules/auth/types/User.ts

@@ -17,41 +17,10 @@ export type LoggedUserData = {
   prefersDarkTheme: boolean;
   creationDate: string;
   lastEdited: string;
-  lastLogin: string;
+  lastSeen: string;
   createdAt: string;
   updatedAt: string;
   id: string;
 };
 
-export enum SocialLinksTypes {
-  BANDCAMP = 'bandcamp',
-  DISCORD = 'discord',
-  FACEBOOK = 'facebook',
-  GITHUB = 'github',
-  INSTAGRAM = 'instagram',
-  REDDIT = 'reddit',
-  SNAPCHAT = 'snapchat',
-  SOUNDCLOUD = 'soundcloud',
-  SPOTIFY = 'spotify',
-  STEAM = 'steam',
-  TELEGRAM = 'telegram',
-  TIKTOK = 'tiktok',
-  THREADS = 'threads',
-  TWITCH = 'twitch',
-  X = 'x',
-  YOUTUBE = 'youtube',
-}
-
-export type SocialLinks = {
-  [K in SocialLinksTypes]?: string;
-};
-
-export type UserProfileData = {
-  lastLogin: Date;
-  loginStreak: number;
-  playCount: number;
-  publicName: string;
-  description: string;
-  profileImage: string;
-  socialLinks: SocialLinks;
-};
+// TODO: make this a DTO (part of the validation module)

web/src/modules/user/components/UserProfile.tsx

@@ -1,20 +1,19 @@
+import { UserProfileViewDto } from '@shared/validation/user/dto/UserProfileView.dto';
 import Image from 'next/image';
 
-import { SocialLinksTypes, UserProfileData } from '../../auth/types/User';
-
 type UserProfileProps = {
-  userData: UserProfileData;
+  userData: UserProfileViewDto;
 };
 
 const UserProfile = ({ userData }: UserProfileProps) => {
   const {
-    lastLogin,
+    lastSeen,
     loginStreak,
     playCount,
     publicName,
     description,
     profileImage,
-    socialLinks,
+    // socialLinks,
   } = userData;
 
   return (
@@ -28,12 +27,12 @@ const UserProfile = ({ userData }: UserProfileProps) => {
       />
       <h1 className='text-2xl font-bold'>{publicName}</h1>
       <p className='text-gray-500'>{description}</p>
-      <p className='text-gray-500'>Last Login: {lastLogin.toLocaleString()}</p>
+      <p className='text-gray-500'>Last Login: {lastSeen.toLocaleString()}</p>
       <p className='text-gray-500'>Login Streak: {loginStreak}</p>
       <p className='text-gray-500'>Play Count: {playCount}</p>
-      <ul className='mt-4'>
+      {/* <ul className='mt-4'>
         {Object.keys(socialLinks).map((key, index) => {
-          const link = socialLinks[key as SocialLinksTypes];
+          const link = socialLinks[key as keyof UserLinks];
           if (!link) return null;
 
           return (
@@ -44,7 +43,7 @@ const UserProfile = ({ userData }: UserProfileProps) => {
             </li>
           );
         })}
-      </ul>
+      </ul> */}
     </section>
   );
 };