byzip-v2-sdk 1.0.0 → 1.0.2

package/README.md

@@ -2,95 +2,183 @@
 
 분양모음집 V2 프로젝트의 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK입니다.
 
-## 설치
+## ✨ 특징
+
+- 🚀 **런타임 의존성 없음** - 순수 TypeScript 타입 정의만 제공
+- 📦 **가벼운 번들** - 추가 패키지 설치 불필요
+- 🔒 **타입 안전성** - 완전한 TypeScript 타입 체크 지원
+- 🌐 **범용 호환성** - 모든 JavaScript/TypeScript 환경에서 사용 가능
+
+## 📦 설치
 
 ```bash
 npm install byzip-v2-sdk
 ```
 
-## 사용법
+## 🚀 사용법
 
 ### 기본 import
 
 ```typescript
 import {
+  // 인증 관련
   LoginRequestDto,
   LoginResponseDto,
+  RegisterRequestDto,
+  TokenDataDto,
+
+  // 사용자 관련
   GetMeResponseDto,
-  UpdateMeRequestDto,
+  UpdateUserRequestDto,
+  UsersRolesEnum,
+  UsersStatusEnum,
+
+  // 공통 응답
+  BaseResponseDto,
+  createSuccessResponse,
+  createErrorResponse,
 } from "byzip-v2-sdk";
 ```
 
 ### 사용 예제
 
-#### 로그인 타입 사용
+#### 🔐 인증 관련
 
 ```typescript
-import { LoginRequestDto, LoginResponseDto } from "byzip-v2-sdk";
+import {
+  LoginRequestDto,
+  LoginResponseDto,
+  RegisterRequestDto,
+} from "byzip-v2-sdk";
 
 // 로그인 요청
 const loginRequest: LoginRequestDto = {
-  username: "user@example.com",
-  password: "password123",
-  rememberMe: true,
+  userId: "user123",
+  password: "password123!",
 };
 
-// 로그인 응답 타입 지정
+// 회원가입 요청
+const registerRequest: RegisterRequestDto = {
+  userId: "newuser",
+  name: "홍길동",
+  email: "user@example.com",
+  password: "password123!",
+  confirmPassword: "password123!",
+  phoneNumber: "010-1234-5678", // 선택사항
+};
+
+// 로그인 응답 처리
 const handleLoginResponse = (response: LoginResponseDto) => {
-  console.log("Access Token:", response.accessToken);
-  console.log("User Info:", response.user);
+  if (response.success) {
+    console.log("로그인 성공:", response.data.accessToken);
+    console.log("메시지:", response.message);
+  }
 };
 ```
 
-#### 사용자 프로필 타입 사용
+#### 👤 사용자 프로필 관련
 
 ```typescript
-import { GetMeResponseDto, UpdateMeRequestDto } from "byzip-v2-sdk";
+import {
+  GetMeResponseDto,
+  UpdateUserRequestDto,
+  UsersGenderEnum,
+  UsersRolesEnum,
+} from "byzip-v2-sdk";
 
-// 프로필 조회 응답 타입 지정
+// 프로필 조회 응답 처리
 const handleProfileResponse = (response: GetMeResponseDto) => {
-  console.log("Profile:", response.profile);
-  console.log("Permissions:", response.permissions);
+  console.log("사용자 ID:", response.userId);
+  console.log("이름:", response.name);
+  console.log("역할:", response.role);
+  console.log("상태:", response.status);
+  console.log("이메일 인증:", response.emailVerified);
 };
 
 // 프로필 업데이트 요청
-const updateRequest: UpdateMeRequestDto = {
-  fullName: "홍길동",
-  phoneNumber: "010-1234-5678",
-  settings: {
-    language: "ko",
-    notifications: {
-      email: true,
-      push: false,
-    },
-  },
+const updateRequest: UpdateUserRequestDto = {
+  name: "홍길동",
+  email: "newemail@example.com",
+  phoneNumber: "010-9876-5432",
+  birthDate: "1990-01-01",
+  gender: UsersGenderEnum.MALE,
+  role: UsersRolesEnum.USER,
 };
 ```
 
-## 타입 정의
+#### 📝 공통 응답 처리
 
-### Users 모듈
+```typescript
+import {
+  BaseResponseDto,
+  createSuccessResponse,
+  createErrorResponse,
+} from "byzip-v2-sdk";
+
+// 성공 응답 생성
+const successResponse = createSuccessResponse(
+  { message: "처리 완료" },
+  "요청이 성공적으로 처리되었습니다."
+);
+
+// 에러 응답 생성
+const errorResponse = createErrorResponse("처리 중 오류가 발생했습니다.");
+
+// 응답 타입 처리
+const handleResponse = <T>(response: BaseResponseDto<T>) => {
+  if (response.success) {
+    console.log("성공:", response.data);
+  } else {
+    console.error("실패:", response.message);
+  }
+};
+```
+
+## 📚 타입 정의
+
+### 🔐 인증 관련 (Auth)
+
+| 타입                    | 설명             |
+| ----------------------- | ---------------- |
+| `LoginRequestDto`       | 로그인 요청      |
+| `LoginResponseDto`      | 로그인 응답      |
+| `RegisterRequestDto`    | 회원가입 요청    |
+| `RegisterResponseDto`   | 회원가입 응답    |
+| `TokenDataDto`          | 토큰 데이터      |
+| `DeleteUserRequestDto`  | 사용자 삭제 요청 |
+| `DeleteUserResponseDto` | 사용자 삭제 응답 |
 
-#### Login DTO
+### 👤 사용자 관련 (User)
 
-- `LoginRequestDto`: 로그인 요청
-- `LoginResponseDto`: 로그인 응답
-- `LoginErrorDto`: 로그인 에러 응답
-- `RefreshTokenRequestDto`: 토큰 갱신 요청
-- `RefreshTokenResponseDto`: 토큰 갱신 응답
+| 타입                        | 설명                  |
+| --------------------------- | --------------------- |
+| `UsersModelDto`             | 사용자 모델           |
+| `GetMeResponseDto`          | 내 정보 조회 응답     |
+| `UpdateUserRequestDto`      | 사용자 정보 수정 요청 |
+| `UpdateUserResponseDto`     | 사용자 정보 수정 응답 |
+| `GetAllUsersResponseDto`    | 모든 사용자 조회 응답 |
+| `ChangePasswordRequestDto`  | 비밀번호 변경 요청    |
+| `ChangePasswordResponseDto` | 비밀번호 변경 응답    |
+| `DeleteAccountRequestDto`   | 계정 삭제 요청        |
+| `DeleteAccountResponseDto`  | 계정 삭제 응답        |
 
-#### Me (사용자 프로필) DTO
+### 📊 열거형 (Enums)
 
-- `UserProfileDto`: 사용자 기본 정보
-- `GetMeResponseDto`: 사용자 프로필 조회 응답
-- `UpdateMeRequestDto`: 사용자 프로필 업데이트 요청
-- `UpdateMeResponseDto`: 사용자 프로필 업데이트 응답
-- `ChangePasswordRequestDto`: 비밀번호 변경 요청
-- `ChangePasswordResponseDto`: 비밀번호 변경 응답
-- `DeleteAccountRequestDto`: 계정 삭제 요청
-- `DeleteAccountResponseDto`: 계정 삭제 응답
+| 열거형            | 값                                                        |
+| ----------------- | --------------------------------------------------------- |
+| `UsersRolesEnum`  | `ADMIN`, `USER`                                           |
+| `UsersStatusEnum` | `ACTIVE`, `INACTIVE`, `SUSPENDED`, `PENDING_VERIFICATION` |
+| `UsersGenderEnum` | `MALE`, `FEMALE`, `OTHER`                                 |
 
-## 개발
+### 📦 공통 (Common)
+
+| 타입                         | 설명                |
+| ---------------------------- | ------------------- |
+| `BaseResponseDto<T>`         | 기본 API 응답 구조  |
+| `createSuccessResponse<T>()` | 성공 응답 생성 함수 |
+| `createErrorResponse<T>()`   | 에러 응답 생성 함수 |
+
+## 🛠️ 개발
 
 ### 빌드
 
@@ -104,6 +192,17 @@ npm run build
 npm publish
 ```
 
-## 라이선스
+## 📄 라이선스
 
 ISC
+
+---
+
+## 🔄 변경 로그
+
+### v1.0.2
+
+- ✅ 모든 DTO 클래스를 인터페이스로 변환
+- ✅ 런타임 의존성 제거 (`@nestjs/swagger` 제거)
+- ✅ 타입 안전성 향상
+- ✅ 번들 크기 최적화

package/dist/dto/auth/auth.dto.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 인증 관련 DTO 정의
+ */
+/** 로그인 요청 DTO */
+export interface LoginRequestDto {
+    /** 사용자 ID */
+    userId: string;
+    /** 비밀번호 */
+    password: string;
+}
+/** 토큰 데이터 DTO */
+export interface TokenDataDto {
+    /** 액세스 토큰 */
+    accessToken: string;
+    /** 리프레시 토큰 */
+    refreshToken: string;
+}
+/** 로그인 응답 DTO */
+export interface LoginResponseDto {
+    /** 요청 성공 여부 */
+    success: boolean;
+    /** 응답 메시지 */
+    message: string;
+    /** 토큰 데이터 */
+    data: TokenDataDto;
+}
+/** 회원가입 요청 DTO */
+export interface RegisterRequestDto {
+    /** 사용자 ID (로그인용) */
+    userId: string;
+    /** 사용자 이름 */
+    name: string;
+    /** 이메일 */
+    email: string;
+    /** 비밀번호 */
+    password: string;
+    /** 비밀번호 확인 */
+    confirmPassword: string;
+    /** 전화번호 (선택) */
+    phoneNumber?: string;
+}
+/** 회원가입 응답 DTO */
+export interface RegisterResponseDto {
+    /** 요청 성공 여부 */
+    success: boolean;
+    /** 응답 메시지 */
+    message: string;
+    /** 토큰 데이터 */
+    data: TokenDataDto;
+}
+/** 사용자 삭제 요청 DTO */
+export interface DeleteUserRequestDto {
+    /** 삭제할 사용자 ID */
+    userId: string;
+    /** 사용자 비밀번호 (본인 확인용) */
+    password: string;
+}
+/** 사용자 삭제 응답 DTO */
+export interface DeleteUserResponseDto {
+    /** 요청 성공 여부 */
+    success: boolean;
+    /** 응답 메시지 */
+    message: string;
+    /** 삭제된 사용자 정보 */
+    data: {
+        userId: string;
+    };
+}

package/dist/dto/auth/auth.dto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * 인증 관련 DTO 정의
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/dto/common/response.dto.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 공통 API 응답 구조 DTO
+ */
+/** 기본 API 응답 DTO */
+export interface BaseResponseDto<T = any> {
+    /** 요청 성공 여부 */
+    success: boolean;
+    /** 응답 메시지 */
+    message: string;
+    /** 응답 데이터 */
+    data: T;
+}
+/** 성공 응답 생성 함수 */
+export declare function createSuccessResponse<T>(data: T, message?: string): BaseResponseDto<T>;
+/** 에러 응답 생성 함수 */
+export declare function createErrorResponse<T = null>(message: string, data?: T): BaseResponseDto<T>;

package/dist/dto/common/response.dto.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * 공통 API 응답 구조 DTO
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSuccessResponse = createSuccessResponse;
+exports.createErrorResponse = createErrorResponse;
+/** 성공 응답 생성 함수 */
+function createSuccessResponse(data, message = "요청이 성공적으로 처리되었습니다.") {
+    return {
+        success: true,
+        message,
+        data,
+    };
+}
+/** 에러 응답 생성 함수 */
+function createErrorResponse(message, data = null) {
+    return {
+        success: false,
+        message,
+        data,
+    };
+}

package/dist/dto/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * DTO Export Index
+ * 모든 DTO 클래스들을 중앙에서 관리하고 export
+ */
+export * from "./auth/auth.dto";
+export * from "./common/response.dto";
+export * from "./user/user.dto";

package/dist/dto/index.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * DTO Export Index
+ * 모든 DTO 클래스들을 중앙에서 관리하고 export
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Auth 관련 DTO
+__exportStar(require("./auth/auth.dto"), exports);
+// Common 관련 DTO
+__exportStar(require("./common/response.dto"), exports);
+// User 관련 DTO
+__exportStar(require("./user/user.dto"), exports);

package/dist/dto/user/user.dto.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 사용자 프로필 관련 DTO 정의
+ */
+/** 사용자 역할 열거형 */
+export declare enum UsersRolesEnum {
+    ADMIN = "ADMIN",
+    USER = "USER"
+}
+/** 사용자 상태 열거형 */
+export declare enum UsersStatusEnum {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    SUSPENDED = "SUSPENDED",
+    PENDING_VERIFICATION = "PENDING_VERIFICATION"
+}
+/** 사용자 성별 열거형 */
+export declare enum UsersGenderEnum {
+    MALE = "MALE",
+    FEMALE = "FEMALE",
+    OTHER = "OTHER"
+}
+/** 사용자 모델 DTO */
+export interface UsersModelDto {
+    /** 사용자 고유 ID */
+    id: number;
+    /** 사용자 ID (로그인용) */
+    userId: string;
+    /** 사용자 비밀번호 */
+    password: string;
+    /** 사용자 이름 */
+    name: string;
+    /** 이메일 */
+    email: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: UsersGenderEnum;
+    /** 계정 생성일 */
+    createdAt: string;
+    /** 마지막 업데이트일 */
+    updatedAt: string;
+    /** 계정 상태 */
+    status: UsersStatusEnum;
+    /** 계정 역할 */
+    role: UsersRolesEnum;
+    /** 이메일 인증 여부 */
+    emailVerified: boolean;
+    /** 전화번호 인증 여부 */
+    phoneVerified: boolean;
+}
+/** 내 정보 조회 응답 DTO */
+export interface GetMeResponseDto {
+    /** 사용자 고유 ID */
+    id: number;
+    /** 사용자 ID (로그인용) */
+    userId: string;
+    /** 사용자 이름 */
+    name: string;
+    /** 이메일 */
+    email: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: UsersGenderEnum;
+    /** 계정 생성일 */
+    createdAt: string;
+    /** 마지막 업데이트일 */
+    updatedAt: string;
+    /** 계정 상태 */
+    status: UsersStatusEnum;
+    /** 계정 역할 */
+    role: UsersRolesEnum;
+    /** 이메일 인증 여부 */
+    emailVerified: boolean;
+    /** 전화번호 인증 여부 */
+    phoneVerified: boolean;
+}
+/** 비밀번호 변경 요청 DTO */
+export interface ChangePasswordRequestDto {
+    /** 현재 비밀번호 */
+    currentPassword: string;
+    /** 새 비밀번호 */
+    newPassword: string;
+    /** 새 비밀번호 확인 */
+    confirmPassword: string;
+}
+/** 비밀번호 변경 응답 DTO */
+export interface ChangePasswordResponseDto {
+    /** 성공 메시지 */
+    message: string;
+    /** 새 토큰 발급 여부 */
+    tokenRefreshRequired: boolean;
+}
+/** 계정 삭제 요청 DTO */
+export interface DeleteAccountRequestDto {
+    /** 비밀번호 확인 */
+    password: string;
+    /** 삭제 사유 */
+    reason?: string;
+}
+/** 계정 삭제 응답 DTO */
+export interface DeleteAccountResponseDto {
+    /** 성공 메시지 */
+    message: string;
+    /** 계정 삭제 예정일 (Unix timestamp) */
+    scheduledDeletionDate: number;
+}
+/** 모든 사용자 조회 응답 DTO */
+export interface GetAllUsersResponseDto {
+    /** 사용자 고유 ID */
+    id: number;
+    /** 사용자 ID (로그인용) */
+    userId: string;
+    /** 사용자 이름 */
+    name: string;
+    /** 이메일 */
+    email: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 계정 생성일 */
+    createdAt: string;
+    /** 계정 상태 */
+    status: UsersStatusEnum;
+    /** 계정 역할 */
+    role: UsersRolesEnum;
+    /** 이메일 인증 여부 */
+    emailVerified: boolean;
+}
+/** 사용자 정보 수정 요청 DTO */
+export interface UpdateUserRequestDto {
+    /** 사용자 이름 */
+    name?: string;
+    /** 이메일 */
+    email?: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** ROLE */
+    role?: UsersRolesEnum;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: UsersGenderEnum;
+}
+/** 사용자 정보 수정 응답 DTO */
+export interface UpdateUserResponseDto {
+    /** 사용자 고유 ID */
+    id: number;
+    /** 사용자 ID (로그인용) */
+    userId: string;
+    /** 사용자 이름 */
+    name: string;
+    /** 이메일 */
+    email: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: UsersGenderEnum;
+    /** 계정 생성일 */
+    createdAt: string;
+    /** 마지막 업데이트일 */
+    updatedAt: string;
+    /** 계정 상태 */
+    status: UsersStatusEnum;
+    /** 계정 역할 */
+    role: UsersRolesEnum;
+    /** 이메일 인증 여부 */
+    emailVerified: boolean;
+    /** 전화번호 인증 여부 */
+    phoneVerified: boolean;
+}

package/dist/dto/user/user.dto.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * 사용자 프로필 관련 DTO 정의
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsersGenderEnum = exports.UsersStatusEnum = exports.UsersRolesEnum = void 0;
+/** 사용자 역할 열거형 */
+var UsersRolesEnum;
+(function (UsersRolesEnum) {
+    UsersRolesEnum["ADMIN"] = "ADMIN";
+    UsersRolesEnum["USER"] = "USER";
+})(UsersRolesEnum || (exports.UsersRolesEnum = UsersRolesEnum = {}));
+/** 사용자 상태 열거형 */
+var UsersStatusEnum;
+(function (UsersStatusEnum) {
+    UsersStatusEnum["ACTIVE"] = "ACTIVE";
+    UsersStatusEnum["INACTIVE"] = "INACTIVE";
+    UsersStatusEnum["SUSPENDED"] = "SUSPENDED";
+    UsersStatusEnum["PENDING_VERIFICATION"] = "PENDING_VERIFICATION";
+})(UsersStatusEnum || (exports.UsersStatusEnum = UsersStatusEnum = {}));
+/** 사용자 성별 열거형 */
+var UsersGenderEnum;
+(function (UsersGenderEnum) {
+    UsersGenderEnum["MALE"] = "MALE";
+    UsersGenderEnum["FEMALE"] = "FEMALE";
+    UsersGenderEnum["OTHER"] = "OTHER";
+})(UsersGenderEnum || (exports.UsersGenderEnum = UsersGenderEnum = {}));

package/dist/index.d.ts

@@ -2,10 +2,10 @@
  * ByZip V2 SDK
  * 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK
  */
-export * from "./users";
-export declare const SDK_VERSION = "1.0.0";
+export * from "./dto";
+export declare const SDK_VERSION = "1.0.1";
 export declare const SDK_INFO: {
     readonly name: "byzip-v2-sdk";
-    readonly version: "1.0.0";
+    readonly version: "1.0.1";
     readonly description: "분양모음집 V2 SDK - 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK";
 };

package/dist/index.js

@@ -19,10 +19,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_INFO = exports.SDK_VERSION = void 0;
-// Users 모듈
-__exportStar(require("./users"), exports);
+__exportStar(require("./dto"), exports);
 // SDK 버전 정보
-exports.SDK_VERSION = "1.0.0";
+exports.SDK_VERSION = "1.0.1";
 // SDK 정보
 exports.SDK_INFO = {
     name: "byzip-v2-sdk",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "byzip-v2-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [