issue #

- 팔로우 DTO 구현 중

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@baekyangdan/core-utils",
-  "version": "1.0.16",
+  "version": "1.0.23",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@baekyangdan/core-utils",
-      "version": "1.0.16",
+      "version": "1.0.23",
       "license": "ISC",
       "dependencies": {
         "@swc/core": "^1.15.5",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baekyangdan/core-utils",
-  "version": "1.0.16",
+  "version": "1.0.23",
   "description": "Common Repo",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -13,4 +13,4 @@ export * from './scheduler/http/HttpApiUrl';
 
 export * as SchedulerDTO from './scheduler/http/dto';
 
-export * as ScheduleType from './scheduler/type/schedule';
+export * as Type from './scheduler/type/schedule';

src/scheduler/decorator/composer.ts

@@ -0,0 +1,12 @@
+type Decorator = (target: Object, propertyKey: string | symbol) => void;
+
+export function composeDecorators(...decorators: Decorator[]): Decorator {
+  return (
+    target: Object,
+    property: string | symbol
+  ) => {
+    for (const decorator of decorators) {
+      decorator(target, property);
+    }
+  }
+}

src/scheduler/decorator/required-decorator.ts

@@ -0,0 +1,11 @@
+import { getMessage } from "../type/class-validator/MessageType";
+import { composeDecorators } from "./composer";
+import { IsNotEmpty } from "class-validator";
+
+export function IsRequired() {
+  const notEmptyMessage = getMessage('REQUIRED');
+
+  return composeDecorators(
+    IsNotEmpty({ message: notEmptyMessage })
+  );
+}

src/scheduler/decorator/valid-decorator.ts

@@ -0,0 +1,23 @@
+import { getMessage } from "../type/class-validator/MessageType";
+import { composeDecorators } from "./composer";
+import { IsIn, IsArray } from "class-validator";
+
+export function IsValid(allowedValues: ReadonlyArray<any>, isArray: boolean = false) {
+  const allowedValuesString = allowedValues.join(', ');
+
+  if (isArray) {
+    return composeDecorators(
+      IsArray({ message: `TYPE: The type of $property must be array.`}),
+      IsIn(allowedValues, {
+        each: true,
+        message: `${getMessage('INVALID_ARRAY')} Valid values: ${allowedValuesString}`
+      })
+    );
+  }
+
+  return composeDecorators(
+    IsIn(allowedValues, {
+      message: `${getMessage('INVALID')} Valid values: ${allowedValuesString}`
+    })
+  );
+}

src/scheduler/http/dto/follow/list/list-response.dto.ts

@@ -0,0 +1,16 @@
+import { IsRequired } from "src/scheduler/decorator/required-decorator";
+import { IsString } from 'class-validator';
+import { getMessage } from "src/scheduler/type/class-validator/MessageType";
+import type { BaseResponseDTO } from "../../base/base-response.dto"
+
+export class FollowList {
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  id!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  name!: string;
+}
+
+export type FollowListResponse = BaseResponseDTO<FollowList[]>;

src/scheduler/http/dto/index.ts

@@ -1,33 +1,36 @@
+export { BaseRequestDTO as BaseRequest } from './base/base-request.dto';
+export { type BaseResponseDTO as BaseResponse } from './base/base-response.dto';
+
 export { CheckDuplicationRequestDTO as CheckDuplicationRequest } from './account/checkDuplication/check-duplication-request.dto';
-export type { CheckDuplicationResponseDTO as CheckDuplicationResponse } from './account/checkDuplication/check-duplication-response.dto';
+export { type CheckDuplicationResponseDTO as CheckDuplicationResponse } from './account/checkDuplication/check-duplication-response.dto';
 
 export { LoginRequestDTO as LoginRequest } from './account/login/login-request.dto';
-export type { LoginResponseDTO as LoginResponse } from './account/login/login-response.dto';
+export { type LoginResponseDTO as LoginResponse } from './account/login/login-response.dto';
 
-export type { RefreshAccessTokenResponseDTO as RefreshAccessTokenResponse } from './account/refreshAccessToken/refresh-access-token-response.dto';
+export { type RefreshAccessTokenResponseDTO as RefreshAccessTokenResponse } from './account/refreshAccessToken/refresh-access-token-response.dto';
 
 export { ResetPasswordRequestDTO as ResetPasswordRequest } from './account/resetPassword/reset-password-request.dto';
-export type { ResetPasswordResponseDTO as ResetPasswordResponse } from './account/resetPassword/reset-password-response.dto';
+export { type ResetPasswordResponseDTO as ResetPasswordResponse } from './account/resetPassword/reset-password-response.dto';
 
 export { SendEmailVerificationCodeRequestDTO as SendEmailVerificationCodeRequest } from './account/sendEmailVerificationCode/send-email-verification-code-request.dto';
-export type { SendEmailVerificationCodeResponseDTO as SendEmailVerificationCodeResponse } from './account/sendEmailVerificationCode/sned-email-verification-code-response.dto';
+export { type SendEmailVerificationCodeResponseDTO as SendEmailVerificationCodeResponse } from './account/sendEmailVerificationCode/sned-email-verification-code-response.dto';
 
 export { SendPasswordResetCodeRequestDTO as SendPasswordResetCodeRequest } from './account/sendPasswordResetCode/send-password-reset-code-request.dto';
-export type { SendPasswordResetCodeResponseDTO as SendPasswordResetCodeResponse } from './account/sendPasswordResetCode/send-password-reset-code-response.dto';
+export { type SendPasswordResetCodeResponseDTO as SendPasswordResetCodeResponse } from './account/sendPasswordResetCode/send-password-reset-code-response.dto';
 
 export { SignupRequestDTO as SignupRequest } from './account/signup/signup-request.dto';
-export type { SignupResponseDTO as SignupResponse } from './account/signup/signup-response.dto';
+export { type SignupResponseDTO as SignupResponse } from './account/signup/signup-response.dto';
 
 export { VerifyEmailVerificationCodeRequestDTO as VerifyEmailVerificationCodeRequest } from './account/verifyEmailVerificationCode/verify-email-verification-code-request.dto';
-export type { VerifyEmailVerificationCodeResponseDTO as VerifyEmailVerificationCodeResponse } from './account/verifyEmailVerificationCode/verify-email-verification-code-response.dto';
+export { type VerifyEmailVerificationCodeResponseDTO as VerifyEmailVerificationCodeResponse } from './account/verifyEmailVerificationCode/verify-email-verification-code-response.dto';
 
 export { VerifyPasswordResetCodeRequestDTO as VerifyPasswordResetCodeRequest } from './account/verifyPasswordResetCode/verify-password-reset-code-request.dto';
-export type { VerifyPasswordResetCodeResponseDTO as VerifyPasswordResetCodeResponse } from './account/verifyPasswordResetCode/verify-password-reset-code.response.dto';
+export { type VerifyPasswordResetCodeResponseDTO as VerifyPasswordResetCodeResponse } from './account/verifyPasswordResetCode/verify-password-reset-code.response.dto';
 
 export { ScheduleCreateRequestDTO as ScheduleCreateRequest } from './schedule/create/create-request.dto';
-export type { ScheduleCreateResponseDTO as ScheduleCreateResponse } from './schedule/create/create-response.dto';
+export { type ScheduleCreateResponseDTO as ScheduleCreateResponse } from './schedule/create/create-response.dto';
 
 export { ScheduleListRequestDTO as ScheduleListRequest } from './schedule/list/list-request.dto';
-export type { ScheduleListResponseDTO as ScheduleListResponse, ScheduleList } from './schedule/list/list-response.dto';
+export { type ScheduleListResponseDTO as ScheduleListResponse, ScheduleList } from './schedule/list/list-response.dto';
 
-export type { ScheduleDetailResponseDTO as ScheduleDetailResponse, ScheduleDetail } from './schedule/detail/detail-response.dto';
+export { type ScheduleDetailResponseDTO as ScheduleDetailResponse, ScheduleDetail } from './schedule/detail/detail-response.dto';

src/scheduler/http/dto/schedule/create/create-request.dto.ts

@@ -1,19 +1,23 @@
 import { BaseRequestDTO } from '@BaseRequestDTO';
+import { Type as TransformType } from 'class-transformer';
 import { IsArray, IsDateString, IsIn, IsString } from 'class-validator';
-import { ScheduleTypeArray } from 'src/scheduler/type/schedule/ScheduleType';
+import { TypeArray, type Type } from 'src/scheduler/type/schedule/ScheduleType';
 
 export class ScheduleCreateRequestDTO extends BaseRequestDTO {
   @IsString()
   name!: string;
 
-  @IsDateString()
-  startDate!: string;
+  @IsString()
+  content!: string;
 
-  @IsDateString()
-  endDate!: string;
+  @TransformType(() => Date)
+  startDate!: Date;
 
-  @IsIn(ScheduleTypeArray)
-  type!: string;
+  @TransformType(() => Date)
+  endDate!: Date;
+
+  @IsIn(TypeArray)
+  type!: Type;
 
   @IsString()
   style!: string;

src/scheduler/http/dto/schedule/detail/detail-response.dto.ts

@@ -1,22 +1,74 @@
 import type { BaseResponseDTO } from '@BaseResponseDTO';
-import type { ScheduleType } from 'src/scheduler/type/schedule/ScheduleType';
+import type { Status } from 'src/scheduler/type/schedule/ScheduleStatus';
+import type { Type } from 'src/scheduler/type/schedule/ScheduleType';
+import { Type as TransformType } from 'class-transformer';
+import { IsRequired } from 'src/scheduler/decorator/required-decorator';
+import { IsArray, IsBoolean, IsDate, IsOptional, IsString, ValidateIf } from 'class-validator';
+import { getMessage } from 'src/scheduler/type/class-validator/MessageType';
 
-export type ScheduleDetail = {
-  id: string;
-  name: string;
-  startDate: Date;
-  endDate: Date;
-  status: string;
+export class ScheduleDetail {
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  id!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  name!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  status!: Status;
+
+  @ValidateIf(o => o.content !== undefined && o.content !== null)
+  @IsString({ message: getMessage('TYPE') })
   content?: string;
-  isDeleted: boolean;
-  type: ScheduleType;
-  createdAt: string;
-  owner: string;
-  style: string;
-  startTime: string;
-  endTime: string;
+
+  @IsRequired()
+  @IsBoolean({ message: getMessage('TYPE')})
+  isDeleted!: boolean;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  type!: Type;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  createdAt!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  owner!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  style!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  startTime!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  endTime!: string;
+
+  @ValidateIf(o => o.dayList !== undefined && o.dayList !== null)
+  @IsString({ message: getMessage('TYPE') })
   dayList?: string;
-  participantList?: string;
+
+  @ValidateIf(o => o.participantList !== undefined && o.participantList !== null)
+  @IsArray()
+  @IsString({ each: true, message: getMessage('TYPE') })
+  participantList?: string[];
+
+  @TransformType(() => Date)
+  @IsRequired()
+  @IsDate({ message: getMessage('TYPE') })
+  startDate!: Date;
+
+  @TransformType(() => Date)
+  @IsRequired()
+  @IsDate({ message: getMessage('TYPE') })
+  endDate!: Date;
 }
 
 export type ScheduleDetailResponseDTO = BaseResponseDTO<ScheduleDetail>;

src/scheduler/http/dto/schedule/list/list-request.dto.ts

@@ -1,20 +1,24 @@
 import { BaseRequestDTO } from '@BaseRequestDTO';
-import { IsArray, IsDateString, IsIn, IsNumberString, IsString, ValidateIf } from 'class-validator';
-import { ScheduleStatusArray } from 'src/scheduler/type/schedule/ScheduleStatus';
-import { ScheduleTypeArray } from 'src/scheduler/type/schedule/ScheduleType';
+import { Type } from 'class-transformer';
+import { IsArray, IsDate, IsIn, IsNumberString, IsString, ValidateIf } from 'class-validator';
+import { StatusArray } from 'src/scheduler/type/schedule/ScheduleStatus';
+import { TypeArray } from 'src/scheduler/type/schedule/ScheduleType';
 
 export class ScheduleListRequestDTO extends BaseRequestDTO {
   @ValidateIf(o => o.date !== undefined)
-  @IsDateString()
-  date?: string;
+  @Type(() => Date)
+  @IsDate()
+  date?: Date;
 
   @ValidateIf(o => o.startDate !== undefined)
-  @IsDateString()
-  startDate?: string;
+  @Type(() => Date)
+  @IsDate()
+  startDate?: Date;
 
   @ValidateIf(o => o.endDate !== undefined)
-  @IsDateString()
-  endDate?: string;
+  @Type(() => Date)
+  @IsDate()
+  endDate?: Date;
 
   @ValidateIf(o => o.styleList !== undefined)
   @IsArray()
@@ -22,12 +26,12 @@ export class ScheduleListRequestDTO extends BaseRequestDTO {
 
   @ValidateIf(o => o.typeList !== undefined)
   @IsArray()
-  @IsIn(ScheduleTypeArray, { each: true})
+  @IsIn(TypeArray, { each: true})
   typeList?: string[];
 
   @ValidateIf(o => o.status !== undefined)
   @IsString()
-  @IsIn(ScheduleStatusArray)
+  @IsIn(StatusArray)
   status?: string;
 
   @ValidateIf(o => o.name !== undefined)

src/scheduler/http/dto/schedule/list/list-response.dto.ts

@@ -1,15 +1,41 @@
 import type { BaseResponseDTO } from '@BaseResponseDTO';
-import type { ScheduleStatus } from "src/scheduler/type/schedule/ScheduleStatus";
-import type { ScheduleType } from "src/scheduler/type/schedule/ScheduleType";
+import type { Status } from "src/scheduler/type/schedule/ScheduleStatus";
+import type { Type } from "src/scheduler/type/schedule/ScheduleType";
+import { Type as TransformType } from 'class-transformer';
+import { IsDate, IsString } from 'class-validator';
+import { IsRequired } from 'src/scheduler/decorator/required-decorator';
+import { getMessage } from 'src/scheduler/type/class-validator/MessageType';
 
-export type ScheduleList = {
-  name: string;
-  id: string;
-  startDate: Date;
-  endDate: Date;
-  type: ScheduleType;
-  style: string;
-  status: ScheduleStatus;
+export class ScheduleList {
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE') })
+  name!: string;
+  
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  id!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  type!: Type;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  style!: string;
+
+  @IsRequired()
+  @IsString({ message: getMessage('TYPE')})
+  status!: Status;
+
+  @TransformType(() => Date)
+  @IsRequired()
+  @IsDate()
+  startDate!: Date;
+
+  @TransformType(() => Date)
+  @IsRequired()
+  @IsDate()
+  endDate!: Date;
 }
 
-export type ScheduleListResponseDTO = BaseResponseDTO<ScheduleList>;
+export type ScheduleListResponseDTO = BaseResponseDTO<ScheduleList[]>;

src/scheduler/type/class-validator/MessageType.ts

@@ -0,0 +1,10 @@
+export type MessageType = 'REQUIRED' | 'TYPE' | 'INVALID' | 'INVALID_ARRAY';
+
+export const getMessage = (type: MessageType) => {
+  switch (type) {
+    case 'REQUIRED': return `REQUIRED: $property is required entity.`;
+    case 'TYPE': return `TYPE: The type of $property is invalid.`;
+    case 'INVALID': return `INVALID: The value of $property($value) is invalid.`;
+    case 'INVALID_ARRAY': return `INVALID_ARRAY: The $property array includes invalid value($value).`
+  }
+}

src/scheduler/type/schedule/ScheduleDay.ts

@@ -1,4 +1,4 @@
-export const ScheduleDay: Record<string, string> = {
+export const Day: Record<string, string> = {
   1: '일',
   2: '월',
   3: '화',
@@ -8,6 +8,6 @@ export const ScheduleDay: Record<string, string> = {
   7: '토'
 } as const;
 
-export const ScheduleDayArray = '1234567'.split('');
+export const DayArray = '1234567'.split('');
 
-export const ScheduleDayLabelArray = '일월화수목금토'.split('');
+export const DayLabelArray = '일월화수목금토'.split('');

src/scheduler/type/schedule/ScheduleStatus.ts

@@ -1,8 +1,8 @@
-export type ScheduleStatus = 'yet' | 'completed';
+export type Status = 'yet' | 'completed';
 
-export const ScheduleStatusLabel: Record<ScheduleStatus, string> = {
+export const StatusLabel: Record<Status, string> = {
   'yet': '미완료',
   'completed': '완료'
 } as const;
 
-export const ScheduleStatusArray = ['yet', 'completed'] as const;
+export const StatusArray = ['yet', 'completed'] as const;

src/scheduler/type/schedule/ScheduleType.ts

@@ -1,6 +1,6 @@
-export type ScheduleType = 'once' | 'daily' | 'weekly' | 'monthly' | 'annual';
+export type Type = 'once' | 'daily' | 'weekly' | 'monthly' | 'annual';
 
-export const ScheduleTypeLabel: Record<ScheduleType, string> = {
+export const TypeLabel: Record<Type, string> = {
   'once': '반복없음',
   'daily': '매일',
   'weekly': '매주',
@@ -8,4 +8,4 @@ export const ScheduleTypeLabel: Record<ScheduleType, string> = {
   'annual': '매년'
 } as const;
 
-export const ScheduleTypeArray = ['once', 'daily', 'weekly', 'monthly', 'annual'] as const;
+export const TypeArray = ['once', 'daily', 'weekly', 'monthly', 'annual'] as const;

src/scheduler/type/schedule/index.ts

@@ -1,3 +1,3 @@
-export * as Day from './ScheduleDay';
-export * as Status from './ScheduleStatus';
-export * as Type from './ScheduleType';
+export * from './ScheduleDay';
+export * from './ScheduleStatus';
+export * from './ScheduleType';