Merge pull request #23 from modern-agile-team/feature/kjs/#15

[Feature] Add typeDoc to server source

Author: woorim960

server/app/src/apis/middlewares/validationCheck.ts

@@ -7,6 +7,13 @@ interface ValidationErrorItem {
   constraints?: object;
 }
 
+/**
+ * @description Validation logic for request
+ * @param {Request} req 
+ * @param {Response} res 
+ * @param {NextFunction} next 
+ * @returns
+ */
 async function validationCheck(
   req: Request,
   res: Response,

server/app/src/apis/module/error.ts

@@ -5,23 +5,25 @@ import {
 } from '../../service/error';
 import { Response } from 'express';
 
+/**
+ * Branch handling of error code capabilities for error codes
+ * @param err `{ unknown | ServerError | BadRequestError | NotFoundError }`
+ * @param res
+ * @returns {Response<ErrorResponse>} res
+ */
 function errorResposne(
   err: unknown | ServerError | BadRequestError | NotFoundError,
   res: Response
 ) {
   if (err instanceof ServerError) {
-    console.error(err);
     return res.status(500).json({ statusCode: err.code, msg: err.message });
   }
   if (err instanceof BadRequestError) {
-    console.error(err);
     return res.status(400).json({ statusCode: err.code, msg: err.message });
   }
   if (err instanceof NotFoundError) {
-    console.error(err);
     return res.status(404).json({ statusCode: err.code, msg: err.message });
   }
-  console.error(err);
   return res.status(500).json({ statusCode: 500, msg: 'Unknown error' });
 }
 

server/app/src/apis/visitor/visitor.ctrl.ts

@@ -1,9 +1,18 @@
 import { Request, Response } from 'express';
 import Visitor from '../../service/visitor';
 import VisitorRepository from '../../model/visitorRepository';
-import { BadRequestError } from '../../service/error';
+import { BadRequestError, ServerError } from '../../service/error';
 import errorResposne from '../module/error';
-
+import { VisitorCmtDto } from './visitor';
+
+/**
+ * Visitor increase and lookup API
+ * @url /apis/visitor/count
+ * @method patch
+ * @resBody `{ statusCode: number, todayCount: number, totalCount: number }` 
+ * success response body
+ * @resBody `{ statusCode: number, msg: string }` fail response body
+ */
 const updateAndGetVisitor = async (req: Request, res: Response) => {
   try {
     const visitor = new Visitor(new VisitorRepository());
@@ -16,75 +25,119 @@ const updateAndGetVisitor = async (req: Request, res: Response) => {
   }
 };
 
+/**
+ * Visit comment generation API
+ * @url /apis/visitor/comment
+ * @method post
+ * @reqBody `{ nickname: string, password: string, description: string }`
+ * @resBody `{ statusCode: number, commendId: number, msg: string }` success response body
+ * @resBody `{ statusCode: number, msg: string }` fail response body
+ */
 const createVisitComment = async (req: Request, res: Response) => {
-  const RequestVisitorComment = Object.assign(req.body);
+  const RequestVisitorComment: VisitorCmtDto = Object.assign(req.body);
 
   try {
-    if (RequestVisitorComment.nickname?.length === 0)
+    if (RequestVisitorComment.nickname?.length === 0) {
       req.body.nickname = '익명';
+    }
 
     const visitor = new Visitor(new VisitorRepository(), RequestVisitorComment);
 
     const response = await visitor.createComment();
 
-    if (response)
+    if (response) {
       return res.status(201).json({
         statusCode: 201,
         commentId: response,
         msg: 'Successful visitor comment creation',
       });
+    }
+    throw new ServerError('Interver Server Error')
   } catch (err) {
     return errorResposne(err, res);
   }
 };
 
+/**
+ * API for editing visited comments
+ * @url /apis/visitor/comment/:id
+ * @method patch
+ * @reqParams `{ id: number }` Unique number of edit comment
+ * @reqBody `{ password: string, description: string }`
+ * @resBody `{ statusCode: number, msg: string }` success or fail response body
+ */
 const updateVisitCommentById = async (req: Request, res: Response) => {
   const { id: visitorCommentId } = req.params;
 
-  const requestVisitorComment = Object.assign(req.body);
+  const requestVisitorComment: VisitorCmtDto = Object.assign(req.body);
 
   try {
     const visitor = new Visitor(new VisitorRepository(), requestVisitorComment);
 
     const response = await visitor.updateCommentById(Number(visitorCommentId));
 
-    if (!response.success)
+    if (!response.success) {
       return res.status(401).json({ statusCode: 401, msg: response.msg });
+    }
     return res.status(200).json({ statusCode: 200, msg: response.msg });
   } catch (err) {
     return errorResposne(err, res);
   }
 };
 
+/**
+ * All visit comment lookup APIs
+ * @url /apis/visitor/comments
+ * @method get
+ * @resBody `{ statusCode: number, visitorComments: [{id: number, nickname: string,
+  description: string, date: string }] }` success response body
+ * @resBody `{ statusCode: number, mesg: string }` fail response body
+ */
 const getVisitorComments = async (req: Request, res: Response) => {
   try {
     const visitor = new Visitor(new VisitorRepository());
 
-    const response = await visitor.getVisitorComments();
+    const { visitorComments } = await visitor.getVisitorComments();
 
-    return res.status(200).json({ statusCode: 200, ...response });
+    return res.status(200).json({ statusCode: 200, visitorComments });
   } catch (err) {
     return errorResposne(err, res);
   }
 };
 
+/**
+ * @typedef {Object} ResBody
+ * @property {number} statusCode
+ * @property {string} msg
+ */
+
+/**
+ * Visit comment delete API
+ * @url /apis/visitor/comment/:id
+ * @method delete
+ * @reqParams `{ id: number }` Unique ID of the target to be deleted 
+ * @resBody `{ statusCode: number, msg: string }` success response body
+ * @resBody `{ statusCode: number, msg: string }` fail response body
+ */
 const deleteVisitorCommentById = async (req: Request, res: Response) => {
   try {
     const visitorCommentId = req.params.id;
 
-    if (!visitorCommentId) throw new BadRequestError('id params is undefined');
-
+    if (!visitorCommentId) {
+      throw new BadRequestError('id params is undefined');
+    }
     const visitor = new Visitor(new VisitorRepository());
 
     const response = await visitor.deleteVisitorCommentById(
       Number(visitorCommentId)
     );
 
-    if (response)
+    if (response) {
       return res.status(200).json({
         statusCode: 200,
         msg: 'Successful deletion of visitor comment',
       });
+    }
   } catch (err) {
     return errorResposne(err, res);
   }

server/app/src/apis/visitor/visitor.d.ts

@@ -3,11 +3,11 @@ import { RowDataPacket } from 'mysql2';
 export interface VisitorDto extends RowDataPacket {
   todayCount: number;
   totalCount: number;
-  todayDate: string;
+  todayDate?: string;
 }
 
 export interface VisitorCmtDto {
-  nickname: string;
+  nickname?: string;
   password: string;
   description: string;
 }

server/app/src/model/visitorRepository.ts

@@ -7,7 +7,14 @@ import {
 import db from '../config/db';
 import { ServerError } from '../service/error';
 
+/**
+ * Visitor-related data processing class
+ */
 class VisitorRepository {
+  /**
+   * Today number of visitors and total number of visitors inquiry method
+   * @returns `{ todayCount: number, totalCount: number }`
+   */
   async getVisitorCnt(): Promise<VisitorDto> {
     let conn;
     try {
@@ -28,6 +35,10 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Today's visits and total visits increase method
+   * @returns `boolean` Whether to update
+   */
   async updateTodayVisitorCnt(): Promise<number> {
     let conn;
     try {
@@ -48,6 +59,11 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Inquery today's date for visitor count table
+   * @returns `string` today's date
+   * @example 2022-09-12 00:00:00
+   */
   async getVisitorTodayDate() {
     let conn;
     try {
@@ -66,6 +82,12 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Request date and number of visitors today, total number of visitors update method
+   * @params 
+   * @todayDate `string` today date
+   * @returns `boolean` Whether to update
+   */
   async updateTodayAndToTalVisitorCnt(todayDate: string) {
     let conn;
     try {
@@ -86,6 +108,11 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Visit comment generation method
+   * @params `{ nickname: string, password: string, description: string }`
+   * @returns `number` Unique ID of the updated visit comment
+   */
   async createComment({
     nickname,
     password,
@@ -113,6 +140,11 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Visit comment inquery method for ID
+   * @params `number` Unique ID of the inquery target
+   * @returns `{ id: number, nickname: string, description: string, date: string }`
+   */
   async getVisitorCommentById(
     visitorCommentId: number
   ): Promise<VisitorCmtEntity> {
@@ -132,6 +164,13 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Save visit comment modification method
+   * @params 
+   * @visitorCommentId `number` Unique ID to be modified
+   * @description `string` Modified comments
+   * @returns `boolean` Whether to update
+   */
   async updateVisitorComment(
     visitorCommentId: number,
     description: string
@@ -153,6 +192,10 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * All visit comment inquery method
+   * @returns `[{ id: number, nickname: string, description: string, date: string }]`
+   */
   async getVisitorComments(): Promise<VisitorCmtEntity[]> {
     let conn;
     try {
@@ -170,6 +213,12 @@ class VisitorRepository {
     }
   }
 
+  /**
+   * Delete visiting comments with unique ID method
+   * @params
+   * @id `number` Unique ID for deletion
+   * @returns `boolean` Whether to update
+   */
   async deleteVisitorCommentById(id: number): Promise<number> {
     let conn;
     try {