Merge pull request #34 from DevKor-github/feat/restaurants

feat: restaurant endpoint

Author: juwoong

src/app.module.ts

@@ -14,6 +14,7 @@ import { FirebaseModule } from './firebase.module';
 import { ImagesModule } from './images/module';
 import { LoggerMiddleware } from './logger.middleware';
 import { SettingsModule } from './settings/module';
+import { RestaurantModule } from './restaurant/module';
 
 @Module({
   imports: [
@@ -30,6 +31,7 @@ import { SettingsModule } from './settings/module';
     SearchModule,
     NotificationModule,
     ImagesModule,
+    RestaurantModule,
     SettingsModule,
   ],
   controllers: [AppController],

src/notification/dto/index.ts

@@ -0,0 +1 @@
+export * from './notification.response.dto';

src/notification/dto/notification.response.dto.ts

@@ -0,0 +1,66 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class NotificationResponseDto {
+  @ApiProperty({
+    description: '알림 ID',
+    example: 'notification-id-123',
+  })
+  id: string;
+
+  @ApiProperty({
+    description: '사용자 ID',
+    example: 'user-id-123',
+  })
+  userId: string;
+
+  @ApiProperty({
+    description: '썸네일 URL',
+    example: 'https://example.com/thumbnail.jpg',
+    required: false,
+  })
+  thumbnailUrl?: string;
+
+  @ApiProperty({
+    description: '알림 타입',
+    example: 'FOLLOW_REQUEST',
+  })
+  type: string;
+
+  @ApiProperty({
+    description: '표시할 내용',
+    example: '새로운 팔로우 요청이 있습니다.',
+  })
+  displayContent: string;
+
+  @ApiProperty({
+    description: '생성 시간',
+    example: '2024-01-01T00:00:00.000Z',
+  })
+  createdAt: Date;
+}
+
+export class NotificationListResponseDto {
+  @ApiProperty({
+    description: '알림 목록',
+    type: [NotificationResponseDto],
+  })
+  notifications: NotificationResponseDto[];
+
+  @ApiProperty({
+    description: '총 알림 개수',
+    example: 10,
+  })
+  totalCount: number;
+
+  @ApiProperty({
+    description: '현재 페이지',
+    example: 1,
+  })
+  currentPage: number;
+
+  @ApiProperty({
+    description: '페이지당 항목 수',
+    example: 10,
+  })
+  perPage: number;
+}

src/restaurant/controller.ts

@@ -0,0 +1,40 @@
+import {
+  Controller,
+  Get,
+  HttpStatus,
+  Injectable,
+  Param,
+  Res,
+} from '@nestjs/common';
+import { RestaurantRepository } from './repositories/restaurant';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
+import { Response } from 'express';
+import { RestaurantResponse } from '@/user/dto';
+
+@ApiTags('restaurant')
+@Injectable()
+@Controller('restaurant')
+export class RestaurantController {
+  constructor(private readonly repo: RestaurantRepository) {}
+
+  @Get(':restaurantId')
+  @ApiResponse({
+    status: 200,
+    description: 'Get Restaurant information',
+    type: RestaurantResponse,
+  })
+  async getRestaurant(
+    @Param('restaurantId') restaurantId: string,
+    @Res() res: Response,
+  ) {
+    const resp = await this.repo.findById(restaurantId);
+
+    if (!resp) {
+      return res.status(HttpStatus.NOT_FOUND).json({
+        message: 'Restaurant not found',
+      });
+    }
+
+    return RestaurantResponse.fromEntity(resp);
+  }
+}

src/restaurant/entity.ts

@@ -1,4 +1,6 @@
-export interface RestaurantEntity {
+import { ApiProperty } from '@nestjs/swagger';
+
+export class RestaurantEntity {
   id: string;
   placeId: string;
   name: string;

src/restaurant/module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { PrismaService } from 'src/prisma/prisma.service';
+import { AuthModule } from '../auth/module';
+import { RestaurantRepository } from './repositories/restaurant';
+import { RestaurantController } from './controller';
+
+@Module({
+  imports: [AuthModule],
+  controllers: [RestaurantController],
+  providers: [PrismaService, RestaurantRepository],
+  exports: [],
+})
+export class RestaurantModule {}

src/tree/controller.ts

@@ -95,7 +95,7 @@ export class TreeController {
     return res.status(HttpStatus.OK).json(result);
   }
 
-  @Get(':restaurantId')
+  @Get('restaurants/:restaurantId')
   @ApiOperation({ summary: '식당에 대한 나무 목록 반환' })
   @ApiParam({
     name: 'restaurantId',

src/user/dto.ts

@@ -1,4 +1,10 @@
-import { Restaurant, FollowerStatus, Tag, $Enums, SavedRestaurant } from '@prisma/client';
+import {
+  Restaurant,
+  FollowerStatus,
+  Tag,
+  $Enums,
+  SavedRestaurant,
+} from '@prisma/client';
 import { Type } from 'class-transformer';
 import {
   IsArray,
@@ -13,6 +19,7 @@ import {
   IsOptional,
 } from 'class-validator';
 import { ApiProperty } from '@nestjs/swagger';
+import { RestaurantEntity } from '@/restaurant/entity';
 
 export class RestaurantResponse {
   @ApiProperty({
@@ -82,6 +89,18 @@ export class RestaurantResponse {
     response.createdAt = restaurant.createdAt;
     return response;
   }
+
+  static fromEntity(restaurant: RestaurantEntity): RestaurantResponse {
+    return {
+      id: restaurant.id,
+      placeId: restaurant.placeId,
+      name: restaurant.name,
+      address: restaurant.address,
+      latitude: restaurant.latitude,
+      longitude: restaurant.longitude,
+      createdAt: restaurant.createdAt,
+    };
+  }
 }
 
 export class RestaurantListResponse {
@@ -353,7 +372,7 @@ export class MypageTreeResponse {
 
   @ApiProperty({
     description: '나무 높이',
-    example: 38
+    example: 38,
   })
   @IsNumber()
   @IsNotEmpty()
@@ -367,18 +386,34 @@ export class MypageTreeResponse {
   @IsNotEmpty()
   location: string;
 
-  constructor(savedRestaurant: (SavedRestaurant & { restaurant: Restaurant })){
-    this.restaurantId = savedRestaurant.restaurant.id
-    this.restaurantName = savedRestaurant.restaurant.name
-    this.recommendationCount = savedRestaurant.recommendedByUsers.length
-    this.location = savedRestaurant.restaurant.address
+  @ApiProperty({
+    description: '사용자가 보유한 전체 나무 개수에 따른 종합 요약 메시지',
+    example: '뒷산이 부럽지 않을 만큼 풍성해졌어요',
+  })
+  @IsString()
+  @IsNotEmpty()
+  recapMessage: string;
+
+  @ApiProperty({
+    description: '사용자가 보유한 전체 트리 개수에 따른 종합 요약 이미지 URL',
+    example: 'https://example.com/images/level_2.png',
+  })
+  @IsString()
+  @IsNotEmpty()
+  recapImageUrl: string | null;
+
+  constructor(savedRestaurant: SavedRestaurant & { restaurant: Restaurant }) {
+    this.restaurantId = savedRestaurant.restaurant.id;
+    this.restaurantName = savedRestaurant.restaurant.name;
+    this.recommendationCount = savedRestaurant.recommendedByUsers.length;
+    this.location = savedRestaurant.restaurant.address;
   }
 }
 
 export class MypageResponse {
   @ApiProperty({
     description: '유저 고유 ID',
-    example: 'user-uuid-1234'
+    example: 'user-uuid-1234',
   })
   @IsString()
   @IsNotEmpty()
@@ -406,23 +441,23 @@ export class MypageResponse {
   })
   @IsNumber()
   @IsNotEmpty()
-  followerCount: number
+  followerCount: number;
 
   @ApiProperty({
     description: '팔로잉 수',
     example: 100,
   })
   @IsNumber()
   @IsNotEmpty()
-  followingCount: number
+  followingCount: number;
 
   @ApiProperty({
     description: '내가 심은 나무 수',
-    example: 30
+    example: 30,
   })
   @IsNumber()
   @IsNotEmpty()
-  treeCount: number
+  treeCount: number;
 
   @ApiProperty({
     description: '프로필 이미지',
@@ -440,7 +475,7 @@ export class MypageResponse {
   @IsOptional()
   @ValidateNested({ each: true })
   tags: Tag[];
-  
+
   @ApiProperty({
     description: 'MBTI',
     example: 'ENFP',
@@ -469,7 +504,7 @@ export class MypageResponse {
   })
   @IsNotEmpty()
   biggestTrees: MypageTreeResponse[];
-  
+
   @ApiProperty({
     description: '내 트리 목록',
     type: [MypageTreeResponse],
@@ -504,4 +539,4 @@ export class CheckFollowingStatusDto {
     example: FollowerStatus.PENDING,
   })
   followRequestStatus: FollowerStatus;
-}
+}

src/user/usecases/updateMbtiAndTags.spec.ts

@@ -72,3 +72,4 @@ describe('UpdateMbtiAndTagsUseCase', () => {
   });
 });
 
+

src/user/usecases/updateMbtiAndTags.ts

@@ -17,4 +17,3 @@ export class UpdateMbtiAndTagsUseCase {
     return this.userRepository.updatePartial(userId, param);
   }
 }
-