byzip-v2-sdk 1.0.0

package/README.md

@@ -0,0 +1,109 @@
+# ByZip V2 SDK
+
+분양모음집 V2 프로젝트의 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK입니다.
+
+## 설치
+
+```bash
+npm install byzip-v2-sdk
+```
+
+## 사용법
+
+### 기본 import
+
+```typescript
+import {
+  LoginRequestDto,
+  LoginResponseDto,
+  GetMeResponseDto,
+  UpdateMeRequestDto,
+} from "byzip-v2-sdk";
+```
+
+### 사용 예제
+
+#### 로그인 타입 사용
+
+```typescript
+import { LoginRequestDto, LoginResponseDto } from "byzip-v2-sdk";
+
+// 로그인 요청
+const loginRequest: LoginRequestDto = {
+  username: "user@example.com",
+  password: "password123",
+  rememberMe: true,
+};
+
+// 로그인 응답 타입 지정
+const handleLoginResponse = (response: LoginResponseDto) => {
+  console.log("Access Token:", response.accessToken);
+  console.log("User Info:", response.user);
+};
+```
+
+#### 사용자 프로필 타입 사용
+
+```typescript
+import { GetMeResponseDto, UpdateMeRequestDto } from "byzip-v2-sdk";
+
+// 프로필 조회 응답 타입 지정
+const handleProfileResponse = (response: GetMeResponseDto) => {
+  console.log("Profile:", response.profile);
+  console.log("Permissions:", response.permissions);
+};
+
+// 프로필 업데이트 요청
+const updateRequest: UpdateMeRequestDto = {
+  fullName: "홍길동",
+  phoneNumber: "010-1234-5678",
+  settings: {
+    language: "ko",
+    notifications: {
+      email: true,
+      push: false,
+    },
+  },
+};
+```
+
+## 타입 정의
+
+### Users 모듈
+
+#### Login DTO
+
+- `LoginRequestDto`: 로그인 요청
+- `LoginResponseDto`: 로그인 응답
+- `LoginErrorDto`: 로그인 에러 응답
+- `RefreshTokenRequestDto`: 토큰 갱신 요청
+- `RefreshTokenResponseDto`: 토큰 갱신 응답
+
+#### Me (사용자 프로필) DTO
+
+- `UserProfileDto`: 사용자 기본 정보
+- `GetMeResponseDto`: 사용자 프로필 조회 응답
+- `UpdateMeRequestDto`: 사용자 프로필 업데이트 요청
+- `UpdateMeResponseDto`: 사용자 프로필 업데이트 응답
+- `ChangePasswordRequestDto`: 비밀번호 변경 요청
+- `ChangePasswordResponseDto`: 비밀번호 변경 응답
+- `DeleteAccountRequestDto`: 계정 삭제 요청
+- `DeleteAccountResponseDto`: 계정 삭제 응답
+
+## 개발
+
+### 빌드
+
+```bash
+npm run build
+```
+
+### 배포
+
+```bash
+npm publish
+```
+
+## 라이선스
+
+ISC

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * ByZip V2 SDK
+ * 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK
+ */
+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 });
+exports.SDK_INFO = exports.SDK_VERSION = void 0;
+// Users 모듈
+__exportStar(require("./users"), exports);
+// SDK 버전 정보
+exports.SDK_VERSION = "1.0.0";
+// SDK 정보
+exports.SDK_INFO = {
+    name: "byzip-v2-sdk",
+    version: exports.SDK_VERSION,
+    description: "분양모음집 V2 SDK - 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK",
+};

package/dist/users/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Users 모듈 타입 정의 export
+ */
+export * from "./login.dto";
+export * from "./me.dto";

package/dist/users/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Users 모듈 타입 정의 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 });
+// Login 관련 타입들
+__exportStar(require("./login.dto"), exports);
+// Me (사용자 프로필) 관련 타입들
+__exportStar(require("./me.dto"), exports);

package/dist/users/login.dto.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 사용자 로그인 관련 DTO 정의
+ */
+export interface LoginRequestDto {
+    /** 이메일 또는 사용자명 */
+    username: string;
+    /** 비밀번호 */
+    password: string;
+    /** 자동 로그인 여부 */
+    rememberMe?: boolean;
+}
+export interface LoginResponseDto {
+    /** 인증 토큰 */
+    accessToken: string;
+    /** 리프레시 토큰 */
+    refreshToken: string;
+    /** 토큰 만료 시간 (Unix timestamp) */
+    expiresAt: number;
+    /** 사용자 기본 정보 */
+    user: {
+        /** 사용자 ID */
+        id: number;
+        /** 사용자명 */
+        username: string;
+        /** 이메일 */
+        email: string;
+        /** 프로필 이미지 URL */
+        profileImageUrl?: string;
+    };
+}
+export interface LoginErrorDto {
+    /** 에러 코드 */
+    code: "INVALID_CREDENTIALS" | "ACCOUNT_LOCKED" | "ACCOUNT_NOT_VERIFIED" | "SERVER_ERROR";
+    /** 에러 메시지 */
+    message: string;
+    /** 추가 정보 */
+    details?: {
+        /** 계정 잠금 해제 시간 (Unix timestamp) */
+        unlockAt?: number;
+        /** 재시도 가능 횟수 */
+        remainingAttempts?: number;
+    };
+}
+export interface RefreshTokenRequestDto {
+    /** 리프레시 토큰 */
+    refreshToken: string;
+}
+export interface RefreshTokenResponseDto {
+    /** 새로운 액세스 토큰 */
+    accessToken: string;
+    /** 새로운 리프레시 토큰 */
+    refreshToken: string;
+    /** 토큰 만료 시간 (Unix timestamp) */
+    expiresAt: number;
+}

package/dist/users/login.dto.js

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

package/dist/users/me.dto.d.ts

@@ -0,0 +1,135 @@
+/**
+ * 사용자 프로필 관련 DTO 정의
+ */
+export interface UserProfileDto {
+    /** 사용자 ID */
+    id: number;
+    /** 사용자명 */
+    username: string;
+    /** 이메일 */
+    email: string;
+    /** 전체 이름 */
+    fullName?: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: "MALE" | "FEMALE" | "OTHER";
+    /** 계정 생성일 */
+    createdAt: string;
+    /** 마지막 업데이트일 */
+    updatedAt: string;
+    /** 계정 상태 */
+    status: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "PENDING_VERIFICATION";
+    /** 이메일 인증 여부 */
+    emailVerified: boolean;
+    /** 전화번호 인증 여부 */
+    phoneVerified: boolean;
+}
+export interface GetMeResponseDto {
+    /** 사용자 프로필 정보 */
+    profile: UserProfileDto;
+    /** 사용자 권한 */
+    permissions: string[];
+    /** 사용자 역할 */
+    roles: string[];
+    /** 구독 정보 */
+    subscription?: {
+        /** 구독 플랜 */
+        plan: "FREE" | "PREMIUM" | "ENTERPRISE";
+        /** 구독 시작일 */
+        startDate: string;
+        /** 구독 종료일 */
+        endDate?: string;
+        /** 구독 상태 */
+        status: "ACTIVE" | "EXPIRED" | "CANCELLED";
+    };
+    /** 설정 정보 */
+    settings: {
+        /** 언어 설정 */
+        language: string;
+        /** 시간대 설정 */
+        timezone: string;
+        /** 알림 설정 */
+        notifications: {
+            /** 이메일 알림 */
+            email: boolean;
+            /** 푸시 알림 */
+            push: boolean;
+            /** SMS 알림 */
+            sms: boolean;
+        };
+        /** 개인정보 설정 */
+        privacy: {
+            /** 프로필 공개 여부 */
+            profileVisible: boolean;
+            /** 온라인 상태 표시 여부 */
+            showOnlineStatus: boolean;
+        };
+    };
+}
+export interface UpdateMeRequestDto {
+    /** 전체 이름 */
+    fullName?: string;
+    /** 전화번호 */
+    phoneNumber?: string;
+    /** 프로필 이미지 URL */
+    profileImageUrl?: string;
+    /** 생년월일 */
+    birthDate?: string;
+    /** 성별 */
+    gender?: "MALE" | "FEMALE" | "OTHER";
+    /** 설정 정보 (부분 업데이트 가능) */
+    settings?: {
+        /** 언어 설정 */
+        language?: string;
+        /** 시간대 설정 */
+        timezone?: string;
+        /** 알림 설정 */
+        notifications?: {
+            email?: boolean;
+            push?: boolean;
+            sms?: boolean;
+        };
+        /** 개인정보 설정 */
+        privacy?: {
+            profileVisible?: boolean;
+            showOnlineStatus?: boolean;
+        };
+    };
+}
+export interface UpdateMeResponseDto {
+    /** 업데이트된 사용자 프로필 정보 */
+    profile: UserProfileDto;
+    /** 업데이트 성공 메시지 */
+    message: string;
+}
+export interface ChangePasswordRequestDto {
+    /** 현재 비밀번호 */
+    currentPassword: string;
+    /** 새 비밀번호 */
+    newPassword: string;
+    /** 새 비밀번호 확인 */
+    confirmPassword: string;
+}
+export interface ChangePasswordResponseDto {
+    /** 성공 메시지 */
+    message: string;
+    /** 새 토큰 발급 여부 */
+    tokenRefreshRequired: boolean;
+}
+export interface DeleteAccountRequestDto {
+    /** 비밀번호 확인 */
+    password: string;
+    /** 삭제 사유 */
+    reason?: string;
+}
+export interface DeleteAccountResponseDto {
+    /** 성공 메시지 */
+    message: string;
+    /** 계정 삭제 예정일 (Unix timestamp) */
+    scheduledDeletionDate: number;
+}

package/dist/users/me.dto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * 사용자 프로필 관련 DTO 정의
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "byzip-v2-sdk",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "byzip",
+    "byzip-v2-sdk",
+    "typescript",
+    "dto",
+    "types"
+  ],
+  "author": "",
+  "license": "ISC",
+  "description": "분양모음집 V2 SDK - 프론트엔드와 백엔드 간 타입 통일을 위한 TypeScript SDK",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}