Merge pull request #85 from CHZZK-Study/fix/clean-type

fix: 타입 정리

src/@types/AuctionDetails.d.ts

@@ -0,0 +1,27 @@
+declare module 'AuctionDetails' {
+  export interface IAuctionDetailsBase {
+    productId: number;
+    sellerName: string;
+    description: string;
+    productName: string;
+    minPrice: number;
+    imageList: string[];
+  }
+
+  export interface IAuctionDetails extends IAuctionDetailsBase {
+    timeRemaining: number;
+    status: string;
+    isSeller: boolean;
+    participantCount: number;
+    isParticipating: boolean;
+    bidId: number | null;
+    bidAmount: number;
+    remainingBidCount: number;
+  }
+
+  export interface IPreAuctionDetails extends IAuctionDetailsBase {
+    createdAt: string;
+    likeCount: number;
+    isLiked: boolean;
+  }
+}

src/@types/AuctionItem.d.ts

@@ -0,0 +1,39 @@
+declare module 'AuctionItem' {
+  export interface IAuctionItemBase {
+    id: number;
+    name: string;
+    minPrice: number;
+    cdnPath: string;
+  }
+
+  export interface IPreAuctionItem extends IAuctionItemBase {
+    likeCount: number;
+    isLiked: boolean;
+  }
+
+  export interface IPreAuctionRegisteredItem extends IPreAuctionItem {
+    createdAt: string;
+  }
+
+  export interface IAuctionItem extends IAuctionItemBase {
+    participantCount: number;
+    timeRemaining: number;
+    isParticipating: boolean;
+  }
+  export interface IAuctionRegisteredItem extends IAuctionItem {
+    status: string;
+    createdAt: string;
+  }
+
+  export interface IUserAuctionWonItem extends IAuctionItemBase {
+    endDateTime: string;
+    winningBid: number;
+  }
+
+  export interface IUserAuctionLostItem extends IAuctionItemBase {
+    endDateTime: string;
+    highestBid: number;
+  }
+
+  export interface IUserAuctionHistoryItem extends Omit<IAuctionItem, 'isParticipating'> {}
+}

src/@types/Register.d.ts

@@ -1,5 +1,5 @@
 declare module 'Register' {
-  export interface RegisterType {
+  export interface IRegister {
     productName: string;
     description: string;
     minPrice: number;

src/@types/myAuctionData.d.ts

@@ -1,7 +1,7 @@
-import type { Auction } from 'Auction';
+import type { IAuctionItemBase } from 'AuctionItem';
 
 // 개별 제품의 인터페이스
-export interface AuctionItem extends Auction {
+export interface AuctionItem extends IAuctionItemBase {
   status: string;
   createdAt: string;
 }

src/@types/productList.d.ts

@@ -1,3 +1,13 @@
+import type {
+  IAuctionItem,
+  IAuctionRegisteredItem,
+  IPreAuctionItem,
+  IPreAuctionRegisteredItem,
+  IUserAuctionHistoryItem,
+  IUserAuctionLostItem,
+  IUserAuctionWonItem,
+} from 'AuctionItem';
+
 // 기본적인 페이지네이션 데이터를 위한 인터페이스
 export interface PaginationData<T> {
   hasNext: boolean;
@@ -9,62 +19,10 @@ export interface PaginationData<T> {
   last: boolean;
 }
 
-// 공통된 리스트 아이템 인터페이스
-export interface AuctionListItem {
-  id: number;
-  name: string;
-  cdnPath: string | null;
-  minPrice: number;
-}
-
-// 진행중인 경매 목록
-export interface OngoingAuctionListItem extends AuctionListItem {
-  timeRemaining: number;
-  participantCount: number;
-  isParticipating: boolean;
-}
-
-// 사전 경매 목록
-export interface PreEnrollProductListItem extends AuctionListItem {
-  likeCount: number;
-  isLiked: boolean;
-}
-
-// 정식 등록 경매
-export interface OngoingAuctionRegisterdItem extends OngoingAuctionListItem {
-  status: string;
-  createdAt: string;
-}
-
-// 사전 등록 경매
-export interface PreEnrollProductRegisteredItem
-  extends PreEnrollProductListItem {
-  createdAt: string;
-}
-
-// 참여 성공한 경매
-export interface MyWonAuctionListItem extends AuctionListItem {
-  endDateTime: string;
-  winningBid: number;
-}
-
-export interface MyLostAuctionListItem extends AuctionListItem {
-  endDateTime: string;
-  highestBid: number;
-}
-
-// 참여 경매 목록
-export interface MyHistoryAuctionListItem extends AuctionListItem {
-  timeRemaining: number;
-  participantCount: number;
-}
-
-export type OngoingAuctionListData = PaginationData<OngoingAuctionListItem>;
-export type PreEnrollProductListData = PaginationData<PreEnrollProductListItem>;
-export type OngoingAuctionRegisteredData =
-  PaginationData<OngoingAuctionRegisterdItem>;
-export type PreEnrollProductRegisteredData =
-  PaginationData<PreEnrollProductRegisteredItem>;
-export type MyWonAuctionListData = PaginationData<MyWonAuctionListItem>;
-export type MyHistoryAuctionListData = PaginationData<MyHistoryAuctionListItem>;
-export type MyLostAuctionListData = PaginationData<MyLostAuctionListItem>;
+export type OngoingAuctionListData = PaginationData<IAuctionItem>;
+export type PreEnrollProductListData = PaginationData<IPreAuctionItem>;
+export type OngoingAuctionRegisteredData = PaginationData<IAuctionRegisteredItem>;
+export type PreEnrollProductRegisteredData = PaginationData<IPreAuctionRegisteredItem>;
+export type MyWonAuctionListData = PaginationData<IUserAuctionWonItem>;
+export type MyHistoryAuctionListData = PaginationData<IUserAuctionLostItem>;
+export type MyLostAuctionListData = PaginationData<IUserAuctionHistoryItem>;

src/components/bid/Bid.test.tsx

@@ -18,7 +18,7 @@ vi.mocked(useGetAuctionDetails).mockReturnValue({
     isParticipating: false,
     isSeller: false,
     minPrice: 23000,
-    name: 'qwer 미니 2집',
+    productName: 'qwer 미니 2집',
     participantCount: 4,
     productId: 14,
     remainingBidCount: 0,

src/components/bid/EditBid.test.tsx

@@ -18,7 +18,7 @@ vi.mocked(useGetAuctionDetails).mockReturnValue({
     isParticipating: false,
     isSeller: false,
     minPrice: 23000,
-    name: 'qwer 미니 2집',
+    productName: 'qwer 미니 2집',
     participantCount: 4,
     productId: 14,
     remainingBidCount: 0,

src/components/details/queries.ts

@@ -1,18 +1,18 @@
 import { API_END_POINT } from '@/constants/api';
-import { AuctionItem } from './AuctionItem';
 import { httpClient } from '@/api/axios';
 import { queryKeys } from '@/constants/queryKeys';
 import { useSuspenseQuery } from '@tanstack/react-query';
+import { IAuctionDetails } from 'AuctionDetails';
 
 export const useGetAuctionDetails = (auctionId: number) => {
-  const getAuctionDetails = async (): Promise<AuctionItem> => {
+  const getAuctionDetails = async (): Promise<IAuctionDetails> => {
     const response = await httpClient.get(`${API_END_POINT.AUCTIONS}/${auctionId}`);
 
     return response.data;
   };
 
   const { data: auctionDetails } = useSuspenseQuery({
-    queryKey: [queryKeys.DETAILS, auctionId],
+    queryKey: [queryKeys.AUCTION_DETAILS, auctionId],
     queryFn: getAuctionDetails,
   });
 

src/components/heart/queries.ts

@@ -1,12 +1,12 @@
 import { UseMutateFunction, useMutation, useQueryClient, useSuspenseQuery } from '@tanstack/react-query';
 
 import { API_END_POINT } from '@/constants/api';
+import type { IPreAuctionItem } from 'AuctionItem';
 import { httpClient } from '@/api/axios';
 import { queryKeys } from '@/constants/queryKeys';
-import { PreRegisterAuction } from 'Auction';
 
 export const useGetPreRegisterHeart = () => {
-  const getPreRegisterHeart = async (): Promise<PreRegisterAuction[]> => {
+  const getPreRegisterHeart = async (): Promise<IPreAuctionItem[]> => {
     const response = await httpClient.get(`${API_END_POINT.PRE_REGISTER}/history`);
 
     return response.data.items;
@@ -21,7 +21,7 @@ export const useGetPreRegisterHeart = () => {
 };
 
 export const useDeletePreRegisterHeart = (): {
-  mutate: UseMutateFunction<PreRegisterAuction[], Error, number, unknown>;
+  mutate: UseMutateFunction<IPreAuctionItem[], Error, number, unknown>;
 } => {
   const queryClient = useQueryClient();
   const deletePreRegisterHeart = async (id: number) => {
@@ -31,7 +31,7 @@ export const useDeletePreRegisterHeart = (): {
 
   const { mutate } = useMutation({
     mutationFn: deletePreRegisterHeart,
-    onSuccess: (data: PreRegisterAuction[]) => {
+    onSuccess: (data: IPreAuctionItem[]) => {
       queryClient.setQueryData([queryKeys.PRE_REGISTER_HEART], data);
       queryClient.invalidateQueries({
         queryKey: [queryKeys.PRE_REGISTER_HEART],

src/components/home/HomeAuctionItem.tsx

@@ -1,4 +1,4 @@
-import type { PreRegisterAuction, RegisterAuction } from 'Auction';
+import type { IAuctionItem, IPreAuctionItem } from 'AuctionItem';
 
 import LikeCount from '../common/atomic/LikeCount';
 import MinPrice from '../common/atomic/MinPrice';
@@ -7,9 +7,7 @@ import TimeLabel from '../common/atomic/TimeLabel';
 import { truncateText } from '@/utils/truncateText';
 import { useNavigate } from 'react-router-dom';
 
-type HomeAuctionItemProps<T> = T extends 'pre-register'
-  ? { kind: 'pre-register'; auction: PreRegisterAuction }
-  : { kind: 'register'; auction: RegisterAuction };
+type HomeAuctionItemProps<T> = T extends 'pre-register' ? { kind: 'pre-register'; auction: IPreAuctionItem } : { kind: 'register'; auction: IAuctionItem };
 
 const HomeAuctionItem = <T extends 'pre-register' | 'register'>({ kind, auction }: HomeAuctionItemProps<T>) => {
   const navigate = useNavigate();

src/components/home/queries.ts

@@ -1,19 +1,20 @@
-import type { PreRegisterAuction, RegisterAuction } from 'Auction';
-import { useSuspenseQueries } from '@tanstack/react-query';
+import type { IAuctionItem, IPreAuctionItem } from 'AuctionItem';
+
 import { API_END_POINT } from '@/constants/api';
 import { httpClient } from '@/api/axios';
 import { queryKeys } from '@/constants/queryKeys';
+import { useSuspenseQueries } from '@tanstack/react-query';
 
 export const useGetHomeAuctions = () => {
-  const getBestAuctions = async (): Promise<RegisterAuction[]> => {
+  const getBestAuctions = async (): Promise<IAuctionItem[]> => {
     const response = await httpClient.get(`${API_END_POINT.BEST}`);
     return response.data;
   };
-  const getImminentAuctions = async (): Promise<RegisterAuction[]> => {
+  const getImminentAuctions = async (): Promise<IAuctionItem[]> => {
     const response = await httpClient.get(`${API_END_POINT.IMMINENT}`);
     return response.data;
   };
-  const getPreRegisterAuctions = async (): Promise<PreRegisterAuction[]> => {
+  const getPreRegisterAuctions = async (): Promise<IPreAuctionItem[]> => {
     const response = await httpClient.get(`${API_END_POINT.PRE_REGISTER}`);
     return response.data.items;
   };

src/components/order/OrderHistoryProduct.tsx

@@ -1,9 +1,9 @@
-import { MyHistoryAuctionListItem } from '@/@types/productList';
-import { LuUsers } from 'react-icons/lu';
+import type { IUserAuctionHistoryItem } from 'AuctionItem';
 import { IoPricetagsOutline } from 'react-icons/io5';
+import { LuUsers } from 'react-icons/lu';
 import ProductItem from '../common/item/ProductItem';
 
-const OrderHistoryProduct = ({ product }: { product: MyHistoryAuctionListItem }) => {
+const OrderHistoryProduct = ({ product }: { product: IUserAuctionHistoryItem }) => {
   return (
     <ProductItem product={product}>
       <div className='flex'>

src/components/order/OrderLostProduct.tsx

@@ -1,9 +1,9 @@
-import { MyLostAuctionListItem } from '@/@types/productList';
+import type { IUserAuctionLostItem } from 'AuctionItem';
 import { IoPricetagsOutline } from 'react-icons/io5';
 import { LuUsers } from 'react-icons/lu';
 import ProductItem from '../common/item/ProductItem';
 
-const OrderLostProduct = ({ product }: { product: MyLostAuctionListItem }) => {
+const OrderLostProduct = ({ product }: { product: IUserAuctionLostItem }) => {
   return (
     <ProductItem product={product}>
       <div className='flex'>

src/components/order/OrderWonProduct.tsx

@@ -1,9 +1,9 @@
-import { MyWonAuctionListItem } from '@/@types/productList';
+import type { IUserAuctionWonItem } from 'AuctionItem';
 import { IoPricetagsOutline } from 'react-icons/io5';
 import { LuUsers } from 'react-icons/lu';
 import ProductItem from '../common/item/ProductItem';
 
-const OrderWonProduct = ({ product }: { product: MyWonAuctionListItem }) => {
+const OrderWonProduct = ({ product }: { product: IUserAuctionWonItem }) => {
   return (
     <ProductItem product={product}>
       <div className='flex'>

src/components/productList/OngoingProduct.tsx

@@ -1,11 +1,11 @@
 import Button from '../common/Button';
+import type { IAuctionItem } from 'AuctionItem';
 import { IoPricetagsOutline } from 'react-icons/io5';
 import { LuUsers } from 'react-icons/lu';
-import { OngoingAuctionListItem } from '@/@types/productList';
 import ProductItem from '../common/item/ProductItem';
 import { useNavigate } from 'react-router-dom';
 
-const OngoingProduct = ({ product }: { product: OngoingAuctionListItem }) => {
+const OngoingProduct = ({ product }: { product: IAuctionItem }) => {
   const navigate = useNavigate();
   const handleClick = () => navigate(`/auctions/bid/${product.id}`);
   return (

src/components/productList/PreEnrollProduct.tsx

@@ -1,10 +1,10 @@
-import { PreEnrollProductListItem } from '@/@types/productList';
+import Button from '../common/Button';
 import { FaHeart } from 'react-icons/fa';
+import type { IPreAuctionItem } from 'AuctionItem';
 import { IoPricetagsOutline } from 'react-icons/io5';
 import ProductItem from '../common/item/ProductItem';
-import Button from '../common/Button';
 
-const PreEnrollProduct = ({ product }: { product: PreEnrollProductListItem }) => {
+const PreEnrollProduct = ({ product }: { product: IPreAuctionItem }) => {
   return (
     <ProductItem product={product}>
       <div className='flex'>