Merge pull request #66 from UMC-AlbaLog/feat/ALBA_65

[FEATURE] 알람 기능 API 추가

Author: codie0226

prisma/schema.prisma

@@ -272,6 +272,6 @@ enum user_work_log_status {
 
 enum notification_type {
   payment
-  work_time    @map("work time")
-  work_approve @map("work approve")
+  work_time
+  work_approve
 }

src/DTO/error_dto.ts

@@ -26,3 +26,9 @@ export class UserRegionError extends CustomError {
     super('USER_REGION_ERROR', 400, message, data);
   }
 }
+
+export class NotificationNotFoundError extends CustomError {
+  constructor(message: string = 'No Notification', data: any = null) {
+    super('NO_NOTIFICATION', 404, message, data);
+  }
+}

src/DTO/notification_dto.ts

@@ -0,0 +1,36 @@
+import { binToUuid } from '../util/uuid';
+import { notification_type as NotificationType } from '@prisma/client';
+
+export interface DefaultNotificationInterface {
+  userId: string;
+  message: string;
+  type: NotificationType;
+}
+
+export class ResponseFromNotification implements DefaultNotificationInterface {
+  userId: string;
+  message: string;
+  type: NotificationType;
+  notificationId: string;
+  status: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+
+  constructor(data: {
+    user_id: Uint8Array<ArrayBufferLike>;
+    message: string;
+    type: NotificationType;
+    notification_id: Uint8Array<ArrayBufferLike>;
+    status: boolean;
+    created_at: Date;
+    updated_at: Date;
+  }) {
+    this.userId = binToUuid(data.user_id);
+    this.message = data.message;
+    this.type = data.type as NotificationType;
+    this.notificationId = binToUuid(data.notification_id);
+    this.status = data.status;
+    this.createdAt = data.created_at;
+    this.updatedAt = data.updated_at;
+  }
+}

src/controller/notification_controller.ts

@@ -0,0 +1,81 @@
+import { Body, Controller, Delete, Post, Query, Request, Route, Security, Tags } from 'tsoa';
+import { Request as ExpressRequest } from 'express';
+import { DefaultNotificationInterface, ResponseFromNotification } from '../DTO/notification_dto';
+import { NotificationService } from '../service/notification_service';
+import { TsoaSuccessResponse } from '../config/response_interface';
+
+@Route('api/notification')
+@Tags('Notification')
+export class NotificationController extends Controller {
+  /**
+   * 알람 생성 api
+   * 알람 type - work_time, work_approve, payment
+   * @param body 알람 정보 입력
+   * @summary 알람 생성 API
+   */
+  @Post('/new')
+  public async sendNotification(@Body() body: DefaultNotificationInterface) {
+    const { userId, message, type } = body;
+
+    const notification = await NotificationService.sendNotificationService({
+      userId,
+      message,
+      type,
+    });
+
+    return new TsoaSuccessResponse<ResponseFromNotification>(notification);
+  }
+
+  /**
+   * 유저 알림 목록 조회
+   * @param req
+   * @summary 유저 알림 목록 조회 API
+   */
+  @Post('/get')
+  @Security('jwt')
+  public async getUserNotification(@Request() req: ExpressRequest) {
+    const userId = (req.user as unknown as { id: string }).id;
+
+    const result = await NotificationService.getNotificationService(userId);
+
+    return new TsoaSuccessResponse<ResponseFromNotification[]>(result);
+  }
+
+  /**
+   * 알림 삭제 API
+   * query - 알림 UUID
+   * @param req
+   * @param notification_id 삭제할 ID
+   * @summary 알림 삭제 API (하나)
+
+   */
+  @Delete('/delete')
+  @Security('jwt')
+  public async deleteNotification(
+    @Request() req: ExpressRequest,
+    @Query() notification_id: string,
+  ): Promise<TsoaSuccessResponse<string>> {
+    const userId = (req.user as unknown as { id: string }).id;
+
+    const result = await NotificationService.deleteNotificationService(userId, notification_id);
+
+    return new TsoaSuccessResponse<string>(result as string);
+  }
+
+  /**
+   * 모든 알림 삭제 API
+   * @summary 모든 알림 삭제 API
+   * @param req
+   */
+  @Delete('/deleteAll')
+  @Security('jwt')
+  public async deleteAllNotification(
+    @Request() req: ExpressRequest,
+  ): Promise<TsoaSuccessResponse<number>> {
+    const userId = (req.user as unknown as { id: string }).id;
+
+    const result: number = await NotificationService.deleteAllNotificationService(userId);
+
+    return new TsoaSuccessResponse<number>(result);
+  }
+}

src/repository/notification_repository.ts

@@ -0,0 +1,81 @@
+import prisma from '../config/prisma';
+import { DefaultNotificationInterface } from '../DTO/notification_dto';
+import { uuidToBin } from '../util/uuid';
+
+export class NotificationRepository {
+  static async sendNotification(data: DefaultNotificationInterface) {
+    const { userId, message, type } = data;
+
+    const notification = await prisma.notification.create({
+      data: {
+        user_id: uuidToBin(userId),
+        message,
+        type,
+        status: true,
+      },
+    });
+
+    return notification;
+  }
+
+  static async getNotification(userId: Uint8Array<ArrayBuffer>) {
+    const notification = await prisma.notification.findMany({
+      where: {
+        user_id: userId,
+        status: true,
+      },
+    });
+
+    return notification;
+  }
+
+  static async verifyUserNotification(
+    userId: Uint8Array<ArrayBuffer>,
+    notificationId: Uint8Array<ArrayBuffer>,
+  ) {
+    const isExist = await prisma.notification.count({
+      where: {
+        user_id: userId,
+        notification_id: notificationId,
+        status: true,
+      },
+    });
+
+    if (isExist) {
+      return true;
+    }
+
+    return false;
+  }
+
+  static async deleteNotification(
+    userId: Uint8Array<ArrayBuffer>,
+    notificationId: Uint8Array<ArrayBuffer>,
+  ) {
+    const result = await prisma.notification.update({
+      data: {
+        status: false,
+      },
+      where: {
+        notification_id: notificationId,
+        user_id: userId,
+      },
+    });
+
+    return result;
+  }
+
+  static async deleteAllNotification(userId: Uint8Array<ArrayBuffer>) {
+    const result = await prisma.notification.updateMany({
+      data: {
+        status: false,
+      },
+      where: {
+        user_id: userId,
+        status: true,
+      },
+    });
+
+    return result.count;
+  }
+}

src/service/notification_service.ts

@@ -0,0 +1,56 @@
+import { NotificationNotFoundError } from '../DTO/error_dto';
+import { DefaultNotificationInterface, ResponseFromNotification } from '../DTO/notification_dto';
+import { NotificationRepository } from '../repository/notification_repository';
+import { binToUuid, uuidToBin } from '../util/uuid';
+
+export class NotificationService {
+  static async sendNotificationService(data: DefaultNotificationInterface) {
+    const result = await NotificationRepository.sendNotification(data);
+
+    return new ResponseFromNotification(result);
+  }
+
+  static async getNotificationService(userId: string) {
+    const parsedId = uuidToBin(userId);
+
+    const notification = await NotificationRepository.getNotification(parsedId);
+
+    if (notification.length === 0) {
+      throw new NotificationNotFoundError('알림이 존재하지 않습니다.', { userId });
+    }
+
+    const result = notification.map((item) => new ResponseFromNotification(item));
+
+    return result;
+  }
+
+  static async deleteNotificationService(userId: string, notificationId: string) {
+    const parsedId = uuidToBin(userId);
+    const parsedNotificationId = uuidToBin(notificationId);
+
+    const isExist = await NotificationRepository.verifyUserNotification(
+      parsedId,
+      parsedNotificationId,
+    );
+
+    if (!isExist) {
+      throw new NotificationNotFoundError('알림이 존재하지 않습니다.', { userId });
+    }
+
+    const result = await NotificationRepository.deleteNotification(parsedId, parsedNotificationId);
+
+    return binToUuid(result.notification_id);
+  }
+
+  static async deleteAllNotificationService(userId: string) {
+    const parsedId = uuidToBin(userId);
+
+    const result = await NotificationRepository.deleteAllNotification(parsedId);
+
+    if (result === 0) {
+      throw new NotificationNotFoundError('알림이 존재하지 않습니다.', { userId });
+    }
+
+    return result;
+  }
+}