ts-deco 1.0.3 → 1.0.5

package/README.md

@@ -2,25 +2,7 @@
 
 TypeScript decorator utilities with **strict validation standards**
 
-## 특징
-
-### 🔒 엄격한 검증 기준
-
-기존의 널널한 커스텀 데코레이터 방식과 달리, `ts-deco`는 **엄격한 타입 검증과 검증 규칙**을 제공합니다.
-
-- ✅ **타입 안전성**: 모든 데코레이터는 엄격한 타입 체크를 거칩니다
-- ✅ **명시적 검증**: 옵션과 검증 규칙이 명확하게 정의되어 있습니다
-- ✅ **일관된 동작**: 모든 데코레이터가 동일한 기준으로 동작합니다
-- ✅ **런타임 안정성**: 잘못된 타입이나 값에 대해 명확한 에러를 제공합니다
-
-### 기존 방식 vs ts-deco
-
-| 기존 커스텀 방식 | ts-deco |
-|----------------|---------|
-| 느슨한 타입 체크 | 엄격한 타입 검증 |
-| 불명확한 검증 규칙 | 명시적 검증 옵션 |
-| 일관성 없는 동작 | 표준화된 동작 |
-| 런타임 에러 가능성 | 타입 안전성 보장 |
+엄격한 타입 검증과 검증 규칙을 제공하는 NestJS용 DTO 데코레이터 라이브러리입니다.
 
 ## 설치
 
@@ -28,267 +10,242 @@ TypeScript decorator utilities with **strict validation standards**
 npm install ts-deco
 ```
 
-## 배포
-
-### 사전 준비
-
-#### 1. npm 로그인
-
-배포하기 전에 npm에 로그인해야 합니다:
-
-```bash
-npm login
-```
-
-npm 계정이 없다면 [npmjs.com](https://www.npmjs.com)에서 계정을 생성하세요.
-
-#### 2. 2단계 인증 (2FA) 설정
-
-npm 패키지 배포를 위해서는 **2단계 인증(2FA)** 또는 **granular access token**이 필요합니다.
-
-**방법 1: 2FA 활성화 (권장)**
-
-1. [npmjs.com](https://www.npmjs.com)에 로그인
-2. 계정 설정 → "Two-Factor Authentication" 활성화
-3. 인증 앱(Google Authenticator 등)으로 QR 코드 스캔
-4. 배포 시 OTP 코드 입력
-
-**방법 2: Granular Access Token 사용**
-
-1. [npmjs.com](https://www.npmjs.com) → Account Settings → Access Tokens
-2. "Generate New Token" → "Granular Access Token" 선택
-3. 권한: "Publish" 선택
-4. "Bypass 2FA" 옵션 활성화 (선택사항)
-5. 생성된 토큰을 사용하여 로그인:
-
-```bash
-npm login --auth-type=legacy
-# 또는 환경변수로 설정
-export NPM_TOKEN=your_token_here
-```
-
-> **참고**: Granular Access Token을 사용하면 2FA를 우회할 수 있지만, 보안을 위해 2FA 활성화를 권장합니다.
-
-### npm 스크립트 사용
+## 빠른 시작
 
-```bash
-# 패치 버전 (1.0.0 -> 1.0.1)
-npm run publish:patch
-
-# 마이너 버전 (1.0.0 -> 1.1.0)
-npm run publish:minor
+`Property` 데코레이터 하나로 모든 타입을 처리할 수 있습니다:
 
-# 메이저 버전 (1.0.0 -> 2.0.0)
-npm run publish:major
+```typescript
+import { Property } from 'ts-deco';
 
-# 배포 전 확인 (실제 배포하지 않음)
-npm run publish:dry-run
-```
+class CreateUserDto {
+  @Property({ type: String, optional: false })
+  name: string;
 
-### 배포 스크립트 사용
+  @Property({ type: Number, min: 0, max: 120 })
+  age: number;
 
-```bash
-# 패치 버전 배포
-./deploy.sh patch
+  @Property({ type: String, optional: true })
+  email?: string;
 
-# 마이너 버전 배포
-./deploy.sh minor
+  @Property({ type: Boolean, optional: false })
+  isActive: boolean;
 
-# 메이저 버전 배포
-./deploy.sh major
+  @Property({ type: Date, optional: true })
+  createdAt?: Date;
+}
 ```
 
-> **참고**: 배포 전에 자동으로 빌드가 실행되며, `prepublishOnly` 훅을 통해 빌드가 확인됩니다.
-
 ## 주요 기능
 
-- **엄격한 타입 검증**을 제공하는 DTO 검증 데코레이터
-  - `DtoString`: 문자열 타입 엄격 검증
-  - `DtoNumber`: 숫자 타입 및 범위 검증 (min/max)
-  - `DtoDate`: 날짜 타입 검증 및 변환
-  - `DtoBoolean`: 불린 타입 검증 및 변환
-  - `DtoEnum`: 열거형 타입 엄격 검증
-  - `Property`: 통합 타입 기반 검증
-- **타입 안전한** 유틸리티 함수 (`applyDecorators`)
+### Property 데코레이터 (권장)
 
-## 사용 예시
+`Property` 데코레이터는 타입에 따라 자동으로 적절한 검증을 적용합니다.
 
-### 기본 사용법
+#### 기본 타입
 
 ```typescript
-import { DtoString, DtoNumber, Property } from 'ts-deco';
+import { Property } from 'ts-deco';
 
-class CreateUserDto {
-  // 필수 문자열 필드 (엄격한 검증)
-  @DtoString({ optional: false })
+class UserDto {
+  // 문자열
+  @Property({ type: String, optional: false })
   name: string;
 
-  // 숫자 범위 검증 (0 ~ 120)
-  @DtoNumber({ min: 0, max: 120 })
-  age: number;
+  // 숫자 (범위 검증)
+  @Property({ 
+    type: Number, 
+    min: 1, 
+    max: 100,
+    optional: false 
+  })
+  score: number;
 
-  // 선택적 문자열 필드
-  @Property({ type: String, optional: true })
-  email?: string;
+  // 날짜
+  @Property({ type: Date, optional: true })
+  birthDate?: Date;
+
+  // 불린
+  @Property({ type: Boolean, optional: false })
+  isActive: boolean;
 }
 ```
 
-### 엄격한 검증 예시
+#### 열거형 (Enum)
 
 ```typescript
-import { DtoNumber, DtoEnum } from 'ts-deco';
+import { Property } from 'ts-deco';
 
 enum UserRole {
   ADMIN = 'admin',
   USER = 'user',
+  GUEST = 'guest',
 }
 
-class UpdateUserDto {
-  // 최소/최대값이 명시적으로 검증됨
-  @DtoNumber({ 
-    min: 1, 
-    max: 100,
-    isInt: true,  // 정수만 허용
-    minMessage: '최소값은 1 이상이어야 합니다',
-    maxMessage: '최대값은 100 이하여야 합니다'
+class UserDto {
+  @Property({ 
+    enum: UserRole, 
+    optional: false 
   })
-  score: number;
+  role: UserRole;
 
-  // 열거형 값만 허용 (엄격한 타입 체크)
-  @DtoEnum(UserRole, { 
-    optional: false,
-    exclude: []  // 특정 값 제외 가능
+  // 특정 값 제외
+  @Property({ 
+    enum: UserRole, 
+    exclude: [UserRole.GUEST],
+    optional: false 
   })
-  role: UserRole;
+  allowedRole: UserRole;
 }
 ```
 
-## applyDecorators
-
-여러 데코레이터를 하나로 합치는 유틸리티 함수입니다.
+#### 배열
 
 ```typescript
-import { applyDecorators } from 'ts-deco';
-import { ApiProperty } from '@nestjs/swagger';
-import { IsString } from 'class-validator';
-
-const MyDecorator = applyDecorators(
-  ApiProperty(),
-  IsString()
-);
-```
+import { Property } from 'ts-deco';
 
-### 주의사항
-
-⚠️ **모든 데코레이터는 동일한 타입이어야 합니다.**
-- `ClassDecorator`끼리만 합칠 수 있습니다
-- `PropertyDecorator`끼리만 합칠 수 있습니다
-- `MethodDecorator`끼리만 합칠 수 있습니다
-- `ParameterDecorator`끼리만 합칠 수 있습니다
-
-### 데코레이터 타입별 반환값
+class UserDto {
+  @Property({ 
+    type: String, 
+    isArray: true,
+    optional: false 
+  })
+  tags: string[];
+
+  @Property({ 
+    type: Number, 
+    isArray: true,
+    min: 1,
+    max: 10,
+    optional: false 
+  })
+  scores: number[];
+}
+```
 
-- **ClassDecorator**: `Function | void` 반환 가능
-- **MethodDecorator**: `PropertyDescriptor | void` 반환 가능
-- **PropertyDecorator**: 반환값 없음 (void)
-- **ParameterDecorator**: 반환값 없음 (void)
+#### 커스텀 에러 메시지
 
-## 엄격한 검증 규칙
+```typescript
+import { Property } from 'ts-deco';
 
-`ts-deco`는 다음과 같은 엄격한 검증 규칙을 적용합니다:
+class UserDto {
+  @Property({ 
+    type: Number,
+    min: 1,
+    max: 100,
+    minMessage: '최소값은 1 이상이어야 합니다',
+    maxMessage: '최대값은 100 이하여야 합니다',
+    validatorMessage: '숫자 타입이어야 합니다',
+    optional: false
+  })
+  score: number;
+}
+```
 
-- **타입 불일치 시 즉시 에러**: 잘못된 타입이 전달되면 명확한 에러 메시지 제공
-- **범위 검증**: `min`/`max` 옵션이 제공되면 반드시 검증
-- **필수 필드 검증**: `optional: false`인 경우 값이 없으면 에러
-- **배열 검증**: `isArray: true`인 경우 배열 타입만 허용
-- **열거형 검증**: `DtoEnum`은 제공된 enum 값만 허용
+### 개별 데코레이터
 
-## 데코레이터 지원
+더 세밀한 제어가 필요한 경우 개별 데코레이터를 사용할 수 있습니다:
 
-### Legacy Decorators (현재 지원)
+```typescript
+import { DtoString, DtoNumber, DtoDate, DtoBoolean, DtoEnum } from 'ts-deco';
 
-⚠️ **이 유틸리티는 TypeScript legacy decorators를 지원합니다.**
+class UserDto {
+  @DtoString({ optional: false })
+  name: string;
 
-현재 이 라이브러리는 **Legacy Decorators** (또는 Stage 2 Decorators)를 기반으로 작동합니다. 이는 TypeScript에서 오랫동안 사용되어 온 안정적인 데코레이터 시스템입니다.
+  @DtoNumber({ min: 0, max: 120 })
+  age: number;
 
-### Stage 3 Decorators는 아직 지원하지 않습니다
+  @DtoDate({ optional: true })
+  birthDate?: Date;
 
-**Stage 3 Decorators란?**
+  @DtoBoolean({ optional: false })
+  isActive: boolean;
 
-- JavaScript/TypeScript의 새로운 데코레이터 제안으로, ECMAScript 표준화 과정의 Stage 3 단계에 있는 제안입니다
-- TypeScript 5.0 이후에 도입된 새로운 데코레이터 API입니다
-- 기존 Legacy Decorators와는 다른 문법과 동작 방식을 가집니다
+  @DtoEnum(UserRole, { optional: false })
+  role: UserRole;
+}
+```
 
-**왜 아직 지원하지 않나요?**
+## Property 데코레이터 옵션
 
-1. **호환성**: 현재 대부분의 NestJS, class-validator, class-transformer 등 주요 라이브러리들이 Legacy Decorators를 기반으로 작동합니다
-2. **안정성**: Legacy Decorators는 오랫동안 검증된 안정적인 시스템입니다
-3. **표준화 진행 중**: Stage 3 Decorators는 아직 Stage 4(최종 표준)가 아니며, 사양이 변경될 수 있습니다
+### 공통 옵션
 
-**Legacy Decorators vs Stage 3 Decorators**
+| 옵션 | 타입 | 기본값 | 설명 |
+|------|------|--------|------|
+| `type` | `String \| Number \| Date \| Boolean` | 필수 | 필드 타입 |
+| `enum` | `object` | - | 열거형 타입 (type 대신 사용) |
+| `optional` | `boolean` | `false` | 선택적 필드 여부 |
+| `isArray` | `boolean` | `false` | 배열 타입 여부 |
+| `validatorMessage` | `string` | - | 검증 실패 메시지 |
+| `arrayMessage` | `string` | - | 배열 검증 실패 메시지 |
+| `notEmptyMessage` | `string` | - | 빈 값 검증 실패 메시지 |
 
-| 항목 | Legacy Decorators (현재 지원) | Stage 3 Decorators (미지원) |
-|------|------------------------------|----------------------------|
-| TypeScript 설정 | `experimentalDecorators: true` | 별도 설정 필요 |
-| 문법 | `@decorator` 형태 | `@decorator` 형태 (내부 동작 다름) |
-| 타입 시그니처 | `(target, propertyKey, descriptor)` | `(value, context)` |
-| 라이브러리 호환성 | NestJS, class-validator 등과 호환 | 아직 일부 라이브러리만 지원 |
-| 안정성 | 검증됨 | 표준화 진행 중 |
+### 숫자 타입 전용 옵션
 
-**참고**: Stage 3 Decorators가 표준화되고 주요 라이브러리들이 지원하게 되면, 향후 버전에서 지원을 추가할 예정입니다.
+| 옵션 | 타입 | 기본값 | 설명 |
+|------|------|--------|------|
+| `min` | `number` | - | 최소값 |
+| `max` | `number` | - | 최대값 |
+| `isInt` | `boolean` | `false` | 정수만 허용 |
+| `minMessage` | `string` | - | 최소값 검증 실패 메시지 |
+| `maxMessage` | `string` | - | 최대값 검증 실패 메시지 |
 
-## 의존성
+### 열거형 전용 옵션
 
-이 라이브러리는 다음 패키지들을 **peer dependencies**로 사용합니다:
+| 옵션 | 타입 | 기본값 | 설명 |
+|------|------|--------|------|
+| `exclude` | `any[]` | `[]` | 제외할 enum 값들 |
 
-### Peer Dependencies
+### Swagger 옵션
 
-| 패키지 | 버전 | 용도 | 라이선스 |
-|--------|------|------|----------|
-| `@nestjs/swagger` | ^7.0.0 | API 문서화 데코레이터 (`ApiProperty`, `ApiPropertyOptional`) | MIT |
-| `class-transformer` | ^0.5.0 | 타입 변환 데코레이터 (`Type`, `Transform`) | MIT |
-| `class-validator` | ^0.14.0 | 검증 데코레이터 (`IsString`, `IsNumber`, `IsDate`, `IsBoolean`, `IsEnum`, `IsArray`, `IsDefined`, `IsNotEmpty`, `IsOptional`, `Min`, `Max` 등) | MIT |
+`@nestjs/swagger`의 `ApiPropertyOptions`를 모두 사용할 수 있습니다:
 
-### 개발 의존성
+```typescript
+@Property({ 
+  type: String,
+  description: '사용자 이름',
+  example: '홍길동',
+  optional: false
+})
+name: string;
+```
 
-- `typescript`: ^5.0.0 (컴파일 타임 타입 검사 및 트랜스파일)
+## 엄격한 검증 규칙
 
-> **참고**: 이 라이브러리는 런타임에 위 패키지들이 설치되어 있어야 합니다. `npm install` 시 자동으로 설치되지 않으므로, 프로젝트에 직접 설치해야 합니다.
+`ts-deco`는 다음과 같은 엄격한 검증 규칙을 적용합니다:
 
-## 라이선스
+- ✅ **타입 안전성**: 모든 데코레이터는 엄격한 타입 체크를 거칩니다
+- ✅ **명시적 검증**: 옵션과 검증 규칙이 명확하게 정의되어 있습니다
+- ✅ **일관된 동작**: 모든 데코레이터가 동일한 기준으로 동작합니다
+- ✅ **런타임 안정성**: 잘못된 타입이나 값에 대해 명확한 에러를 제공합니다
 
-### 본 프로젝트 라이선스
+### 검증 규칙
 
-이 프로젝트는 **ISC (Internet Systems Consortium) License** 하에 배포됩니다.
+- **타입 불일치 시 즉시 에러**: 잘못된 타입이 전달되면 명확한 에러 메시지 제공
+- **범위 검증**: `min`/`max` 옵션이 제공되면 반드시 검증
+- **필수 필드 검증**: `optional: false`인 경우 값이 없으면 에러
+- **배열 검증**: `isArray: true`인 경우 배열 타입만 허용
+- **열거형 검증**: `enum`이 제공되면 해당 값만 허용
 
-```
-ISC License
 
-Copyright (c) 2025 ts-deco contributors
+⚠️ **주의**: 모든 데코레이터는 동일한 타입이어야 합니다.
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
+## 데코레이터 지원
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-```
+이 라이브러리는 **TypeScript legacy decorators**를 지원합니다. Stage 3 decorators는 아직 지원하지 않습니다.
 
-### 의존성 라이선스
+## 의존성
 
-이 프로젝트가 사용하는 모든 의존성은 **MIT License** 하에 배포되며, ISC License와 호환됩니다.
+이 라이브러리는 다음 패키지들을 **dependencies**로 포함하고 있어, `npm install ts-deco` 실행 시 자동으로 함께 설치됩니다:
 
-- `@nestjs/swagger`: MIT License
-- `class-transformer`: MIT License  
-- `class-validator`: MIT License
+| 패키지 | 버전 | 용도 |
+|--------|------|------|
+| `@nestjs/swagger` | ^7.0.0 | API 문서화 데코레이터 |
+| `class-transformer` | ^0.5.0 | 타입 변환 데코레이터 |
+| `class-validator` | ^0.14.0 | 검증 데코레이터 |
 
-각 패키지의 라이선스 전문은 해당 패키지의 `LICENSE` 파일 또는 npm 패키지 페이지에서 확인할 수 있습니다.
+> **참고**: 별도로 설치할 필요 없이 `npm install ts-deco`만 실행하면 모든 의존성이 자동으로 설치됩니다.
 
-### 라이선스 호환성
+## 라이선스
 
-ISC License는 MIT License와 매우 유사하며, 두 라이선스 모두 매우 관대한(permissive) 오픈소스 라이선스입니다. 이 프로젝트와 의존성 패키지들은 모두 상호 호환되는 라이선스를 사용하므로 법적 문제가 없습니다.
+ISC License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-deco",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript decorator utilities for NestJS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,15 +26,12 @@
   ],
   "author": "",
   "license": "ISC",
-  "peerDependencies": {
+  "dependencies": {
     "@nestjs/swagger": "^7.0.0",
     "class-transformer": "^0.5.0",
     "class-validator": "^0.14.0"
   },
   "devDependencies": {
-    "@nestjs/swagger": "^7.0.0",
-    "class-transformer": "^0.5.0",
-    "class-validator": "^0.14.0",
     "typescript": "^5.0.0"
   }
 }