[#60] 💄 format and organize prior types

Author: KingNono1030

src/types/apiResponse.types.d.ts

@@ -1,8 +1,6 @@
 interface ApiResponse<T = unknown> {
-  isSuccess: boolean
-  code: string // 예시) TEAM004
-  message: string // 예시) "This is a deleted post."
-  result?: T
+  isSuccess: boolean // 요청 성공 여부
+  code: string // 응답 코드 (예: TEAM004)
+  message: string // 응답 메시지 (예: "This is a deleted post.")
+  result?: T // 응답 데이터 (제네릭 타입)
 }
-type ApiResponseObject = ApiResponse<Record<string, never>>
-type ApiResponseString = ApiResponse<string>

src/types/auth.types.d.ts

@@ -2,31 +2,32 @@
 path: '/v1/auth'
 GET: 로그인한 유저 조회
 */
-export type GetMemberInfoResult = User
+export type GetLoggedInUserResponse = User
 
 /*
 path: '/v1/auth/sign-up'
 POST: 회원가입
 */
 export interface SignUpRequest {
-  email: Email
-  password: Password
-  name: Name
-  gitHub: GitHub
+  email: Email // 이메일
+  password: Password // 비밀번호
+  name: Name // 사용자 이름
+  gitHub: GitHub // GitHub 계정 URL
 }
 export interface SignUpResponse extends User {
-  gitHub: GitHub
+  gitHub: GitHub // GitHub 계정 URL
 }
 
 /*
 path: '/v1/auth/sign-in'
 POST: 로그인
 */
 export interface SignInRequest {
-  email: Email
-  password: Password
+  email: Email // 이메일
+  password: Password // 비밀번호
 }
-export interface SignInResponseResult extends User {
-  accessToken: Token
-  refreshToken: Token
+
+export interface SignInResponse extends User {
+  accessToken: Token // 액세스 토큰
+  refreshToken: Token // 리프레시 토큰
 }

src/types/community.types.d.ts

@@ -1,47 +1,59 @@
+// 커뮤니티 카테고리
 export type CommunityCategory = 'SKILL' | 'CAREER' | 'OTHER'
 export type CommunityLabelCategory = '기술' | '커리어' | '기타'
 
-type CommunityBaseBody = {
-  communityCategory: CommunityCategory
-  communityTitle: string
-  communityContent: string
+type CommunityBase = {
+  communityCategory: CommunityCategory // 커뮤니티 글 카테고리
+  communityTitle: string // 커뮤니티 글 제목
+  communityContent: string // 커뮤니티 글 내용
 }
 
+// 인기 멤버 구조
 type CommunityTop5Member = {
-  member: MemberInfo
-  totalLikes: number
+  member: MemberInfo // 멤버 정보
+  totalLikes: number // 총 좋아요 수
 }
 
-interface CommunityListType extends PostBaseBody, CommunityBaseBody {}
+// 커뮤니티 리스트 타입
+interface CommunityListItem extends PostBaseBody, CommunityBase {}
 
-interface CommunityDetail extends CommunityListDetail {
-  isComment: boolean
+// 커뮤니티 상세 타입
+interface CommunityDetail extends CommunityListItem {
+  isComment: boolean // 댓글 허용 여부
 }
+
 /*
 path: '/v1/community'
 GET: 커뮤니티 글 전체 조회
 */
-export type GetCommunityListResponse = CommunityListType
-/* POST: 커뮤니티 글 등록 */
-export interface CommunityCreateRequest extends CommunityBaseBody {
-  isComment?: boolean // 답변 동의 여부
+export type GetCommunityListResponse = CommunityListItem[]
+/*
+POST: 커뮤니티 글 등록
+*/
+export interface CommunityCreateRequest extends CommunityBase {
+  isComment?: boolean // 댓글 허용 여부
 }
-export interface CommunityCreateResponse extends CommunityBaseBody, TimeStamps {
-  id: Id
+export interface CommunityCreateResponse extends CommunityBase, TimeStamps {
+  id: Id // 생성된 커뮤니티 글 ID
   member: Id // 작성자 Id
-  isComment: boolean
+  isComment: boolean // 댓글 허용 여부
 }
 
 /*
 path: '/v1/community/{id}'
 GET: 커뮤니티 글 상세 조회
 */
 export type GetCommunityDetailResponse = CommunityDetail
-/* PATHCH: 커뮤니티 글 수정 */
-export type CommunityUpdateRequest = CommunityBaseBody
+
+/*
+PATCH: 커뮤니티 글 수정
+*/
+export type CommunityUpdateRequest = CommunityBase
 export type CommunityUpdateResponse = CommunityCreateResponse
-/* DELETE: 커뮤니티 글 삭제 
-반환 값:
+
+/*
+DELETE: 커뮤니티 글 삭제
+반환 값: 기본 ApiResponse 구조 사용
 {
   "isSuccess": true,
   "code": "COMMON200",
@@ -51,6 +63,6 @@ export type CommunityUpdateResponse = CommunityCreateResponse
 
 /*
 path: '/v1/community/top5'
-GET: 인기 커뮤니티 Top5 유저 조회 (좋아요 순))
+GET: 좋아요 순으로 인기 커뮤니티 Top 5 유저 조회
 */
-export type GetCommunityTop5Response = CommunityTop5Member[]
+export type GetCommunityTop5Response = CommunityTopMember[]

src/types/global.types.d.ts

@@ -1,32 +1,33 @@
 // 기본 타입 정의
-type Id = number
-type URL = string
-type Token = string
+type Id = number // 고유 ID
+type URL = string // URL
+type Token = string // JWT 또는 인증 토큰
 
 // 사용자 관련 타입
-type Email = string
-type Password = string
-type Name = string
-type Nickname = string
-type GitHub = string
+type Email = string // 이메일
+type Password = string // 비밀번호
+type Name = string // 사용자 이름
+type Nickname = string // 닉네임
+type GitHub = string // GitHub 프로필 URL
 
 // 공통 속성 타입
-type TechStack = string
+type TechStack = string // 기술 스택 (예: "React", "Node.js")
 
 // 타임스탬프 정의
 type TimeStamps = {
   // Format: date-time
-  createdAt: string
-  updatedAt?: string // 있을 수도 있고 없을 수도 있음
+  createdAt: string // 생성 시간 (ISO 8601)
+  updatedAt?: string // 수정 시간 (선택적, ISO 8601)
 }
 
 // 사용자 관련 인터페이스
 interface User {
-  id: Id
-  email: Email
-  name: Name
-  nickname: Nickname
-  imageUrl: URL
+  id: Id // 사용자 고유 ID
+  email: Email // 이메일
+  name: Name // 이름
+  nickname: Nickname // 닉네임
+  imageUrl: URL // 프로필 이미지 URL
 }
 
+// MemberInfo: 일부 사용자 정보를 제외한 타입
 type MemberInfo = Omit<User, 'email' | 'name'>

src/types/post.types.d.ts

@@ -1,16 +1,17 @@
-// 게시글 관련 타입
-type PostType = 'COMMUNITY' | 'TEAM' | 'PORTFOLIO' | 'PROJECT'
+// 게시글 유형
+type PostCategory = 'COMMUNITY' | 'TEAM' | 'PORTFOLIO' | 'PROJECT'
 
 // 게시글 기본 구조
 interface PostBaseBody extends TimeStamps {
-  id: Id
-  member: MemberInfo // 게시글 작성자
-  views: number
-  answers: number
-  likes: number
+  id: Id // 게시글 고유 ID
+  member: MemberInfo // 게시글 작성자 정보
+  views: number // 조회수
+  answers: number // 답변 수
+  likes: number // 좋아요 수
 }
 
+// 좋아요 요청 타입
 interface LikeRequest {
-  likeId: Id
-  likeType: PostType
+  likeId: Id // 좋아요 대상 ID
+  likeType: PostCategory // 대상 유형 (PostCategory)
 }

src/types/team.types.d.ts

@@ -1,68 +1,72 @@
-export type TeamType = 'STUDY' | 'PROJECT' | 'MENTORING'
-export type TeamLabelType = '스터디' | '프로젝트' | '멘토링'
-export type TeamRecruitmentLabelType = '모집 중' | '모집 완료'
-export type TeamPosition = string
+// 팀 모집글 관련 기본 타입
+export type TeamType = 'STUDY' | 'PROJECT' | 'MENTORING' // 팀 모집글 유형
+export type TeamLabelType = '스터디' | '프로젝트' | '멘토링' // 팀 모집글 유형 라벨
+export type TeamRecruitmentLabelType = '모집 중' | '모집 완료' // 모집 상태 라벨
+export type TeamPosition = string // 역할 (예: 프론트엔드, 백엔드 등)
 
-type TeamBaseBody = {
-  teamTitle: string
-  teamContent: string
-  teamType: TeamType
-  teamPosition: TeamPosition
-  teamRecruitmentNum: number
-  teamTechStack?: TechStack[]
-  teamTags?: Tag[]
+// 팀 모집글 공통 속성
+type TeamBase = {
+  teamTitle: string // 팀 모집글 제목
+  teamContent: string // 팀 모집글 내용
+  teamType: TeamType // 팀 모집글 유형
+  teamPosition: TeamPosition // 모집 역할
+  teamRecruitmentNum: number // 모집 인원
+  teamTechStack?: TechStack[] // 사용 기술 스택
+  teamTags?: Tag[] // 태그
 }
 
-export interface TeamListType extends PostBaseBody, TeamBaseBody {
-  teamIsActive: boolean
+// 팀 모집글 리스트 아이템
+export interface TeamListItem extends PostBaseBody, TeamBase {
+  teamIsActive: boolean // 모집 활성 상태
 }
 
 /*
 path: '/v1/team'
-
-GET: 팀 모집급 전체 조회
+GET: 팀 모집글 모집급 전체 조회
 */
-export type GetTeamListResponse = TeamListType[]
+export type GetTeamListResponse = TeamListItem[]
 
-/* POST: 팀 모집글 등록 */
-export type TeamCreateRequest = TeamBaseBody
-export interface TeamCreateResponse extends TimeStamps, TeamBaseBody {
-  id: Id
+/* 
+POST: 팀 모집글 등록 
+*/
+export type TeamCreateRequest = TeamBase
+export interface TeamCreateResponse extends TimeStamps, TeamBase {
+  id: Id // 팀 모집글 ID
 }
 
 /* 
 path: '/v1/team/{teamId}'
 GET: 팀 모집글 상세 조회
 */
-export type GetTeamDetailResponse = TeamListType
+export type GetTeamDetailResponse = TeamListItem
 
-/* DELETE: 팀 모집글 삭제 
-
-반환 값:
+/* 
+DELETE: 팀 모집글 삭제
+반환 값: 공통 응답 타입 활용 (ApiResponse)
 {
   "isSuccess": true,
   "code": "COMMON200",
-  "message": "팀 모집글이 성공적으로 삭제되었습니다."
+  "message": "팀 모집글 모집글이 성공적으로 삭제되었습니다."
 }
 */
 
 /* 
 path: '/v1/team/{teamId}/add'
 
-POST: 팀 멤버 추가
+POST: 팀 모집글 멤버 추가
 */
 export interface TeamAddMemberRequest {
-  memberId: Id
+  memberId: Id // 추가할 멤버 ID
 }
 export interface TeamAddMemberResponse {
-  id: Id
-  teamId: Id
-  memberId: Id
+  id: Id // 추가 작업 ID
+  teamId: Id // 팀 모집글 ID
+  memberId: Id // 멤버 ID
 }
 
 /* 
 path: '/v1/team/{teamId}/close'
-PATCH: 팀 모집 마감
+PATCH: 팀 모집글 모집 마감
 
 반환 값:
 {
@@ -80,9 +84,9 @@ export type SearchMembersResponse = MemberInfo[]
 
 /* 
 path: '/v1/team/{teamId}/members'
-GET: 팀 멤버 전체 조회
+GET: 팀 모집글 멤버 전체 조회
 */
 export type GetTeamMembersResponse = {
-  teamId: Id
-  members: MemberInfo[]
+  teamId: Id // 팀 모집글 ID
+  members: MemberInfo[] // 팀 모집글 멤버 리스트
 }