byzip-v2-sdk 1.0.3 β†’ 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -16,98 +16,6 @@
16
16
  npm install byzip-v2-sdk
17
17
  ```
18
18
 
19
- ## πŸš€ μ‚¬μš©λ²•
20
-
21
- ### κΈ°λ³Έ import
22
-
23
- ```typescript
24
- import {
25
- // 인증 κ΄€λ ¨
26
- LoginRequestDto,
27
- LoginResponseDto,
28
- RegisterRequestDto,
29
- TokenDataDto,
30
-
31
- // μ‚¬μš©μž κ΄€λ ¨
32
- GetMeResponseDto,
33
- UpdateUserRequestDto,
34
- UsersRolesEnum,
35
- UsersStatusEnum,
36
-
37
- // 곡톡 응닡
38
- BaseResponseDto,
39
- createSuccessResponse,
40
- createErrorResponse,
41
- } from 'byzip-v2-sdk';
42
- ```
43
-
44
- ### μ‚¬μš© 예제
45
-
46
- #### πŸ” 인증 κ΄€λ ¨
47
-
48
- ```typescript
49
- import {
50
- LoginRequestDto,
51
- LoginResponseDto,
52
- RegisterRequestDto,
53
- } from 'byzip-v2-sdk';
54
-
55
- // 둜그인 μš”μ²­
56
- const loginRequest: LoginRequestDto = {
57
- userId: 'user123',
58
- password: 'password123!',
59
- };
60
-
61
- // νšŒμ›κ°€μž… μš”μ²­
62
- const registerRequest: RegisterRequestDto = {
63
- userId: 'newuser',
64
- name: '홍길동',
65
- email: 'user@example.com',
66
- password: 'password123!',
67
- confirmPassword: 'password123!',
68
- phoneNumber: '010-1234-5678', // 선택사항
69
- };
70
-
71
- // 둜그인 응닡 처리
72
- const handleLoginResponse = (response: LoginResponseDto) => {
73
- if (response.success) {
74
- console.log('둜그인 성곡:', response.data.accessToken);
75
- console.log('λ©”μ‹œμ§€:', response.message);
76
- }
77
- };
78
- ```
79
-
80
- #### πŸ‘€ μ‚¬μš©μž ν”„λ‘œν•„ κ΄€λ ¨
81
-
82
- ```typescript
83
- import {
84
- GetMeResponseDto,
85
- UpdateUserRequestDto,
86
- UsersGenderEnum,
87
- UsersRolesEnum,
88
- } from 'byzip-v2-sdk';
89
-
90
- // ν”„λ‘œν•„ 쑰회 응닡 처리
91
- const handleProfileResponse = (response: GetMeResponseDto) => {
92
- const { data } = response;
93
- console.log('μ‚¬μš©μž ID:', data.userId);
94
- console.log('이름:', data.name);
95
- console.log('μ—­ν• :', data.role);
96
- console.log('μƒνƒœ:', data.status);
97
- console.log('이메일 인증:', data.emailVerified);
98
- };
99
-
100
- // ν”„λ‘œν•„ μ—…λ°μ΄νŠΈ μš”μ²­
101
- const updateRequest: UpdateUserRequestDto = {
102
- name: '홍길동',
103
- email: 'newemail@example.com',
104
- phoneNumber: '010-9876-5432',
105
- birthDate: '1990-01-01',
106
- gender: UsersGenderEnum.MALE,
107
- role: UsersRolesEnum.USER,
108
- };
109
- ```
110
-
111
19
  #### πŸ“ 곡톡 응닡 처리
112
20
 
113
21
  ```typescript
@@ -136,55 +44,6 @@ const handleResponse = <T>(response: BaseResponseDto<T>) => {
136
44
  };
137
45
  ```
138
46
 
139
- ## πŸ“š νƒ€μž… μ •μ˜
140
-
141
- ### πŸ” 인증 κ΄€λ ¨ (Auth)
142
-
143
- | νƒ€μž… | μ„€λͺ… |
144
- | ------------------------- | ---------------- |
145
- | `LoginRequestDto` | 둜그인 μš”μ²­ |
146
- | `LoginResponseDto` | 둜그인 응닡 |
147
- | `RegisterRequestDto` | νšŒμ›κ°€μž… μš”μ²­ |
148
- | `RegisterResponseDto` | νšŒμ›κ°€μž… 응닡 |
149
- | `TokenDataDto` | 토큰 데이터 |
150
- | `RefreshTokenRequestDto` | 토큰 κ°±μ‹  μš”μ²­ |
151
- | `RefreshTokenResponseDto` | 토큰 κ°±μ‹  응닡 |
152
- | `LogoutResponseDto` | λ‘œκ·Έμ•„μ›ƒ 응닡 |
153
- | `DeleteUserRequestDto` | μ‚¬μš©μž μ‚­μ œ μš”μ²­ |
154
- | `DeleteUserResponseDto` | μ‚¬μš©μž μ‚­μ œ 응닡 |
155
-
156
- ### πŸ‘€ μ‚¬μš©μž κ΄€λ ¨ (User)
157
-
158
- | νƒ€μž… | μ„€λͺ… |
159
- | --------------------------- | --------------------- |
160
- | `UsersModelDto` | μ‚¬μš©μž λͺ¨λΈ |
161
- | `GetMeResponseDto` | λ‚΄ 정보 쑰회 응닡 |
162
- | `GetMeDataDto` | λ‚΄ 정보 데이터 |
163
- | `UpdateUserRequestDto` | μ‚¬μš©μž 정보 μˆ˜μ • μš”μ²­ |
164
- | `UpdateUserResponseDto` | μ‚¬μš©μž 정보 μˆ˜μ • 응닡 |
165
- | `GetAllUsersResponseDto` | λͺ¨λ“  μ‚¬μš©μž 쑰회 응닡 |
166
- | `UserSummaryDto` | μ‚¬μš©μž μš”μ•½ 정보 |
167
- | `ChangePasswordRequestDto` | λΉ„λ°€λ²ˆν˜Έ λ³€κ²½ μš”μ²­ |
168
- | `ChangePasswordResponseDto` | λΉ„λ°€λ²ˆν˜Έ λ³€κ²½ 응닡 |
169
- | `DeleteAccountRequestDto` | 계정 μ‚­μ œ μš”μ²­ |
170
- | `DeleteAccountResponseDto` | 계정 μ‚­μ œ 응닡 |
171
-
172
- ### πŸ“Š μ—΄κ±°ν˜• (Enums)
173
-
174
- | μ—΄κ±°ν˜• | κ°’ |
175
- | ----------------- | --------------------------------------------------------- |
176
- | `UsersRolesEnum` | `ADMIN`, `USER` |
177
- | `UsersStatusEnum` | `ACTIVE`, `INACTIVE`, `SUSPENDED`, `PENDING_VERIFICATION` |
178
- | `UsersGenderEnum` | `MALE`, `FEMALE`, `OTHER` |
179
-
180
- ### πŸ“¦ 곡톡 (Common)
181
-
182
- | νƒ€μž… | μ„€λͺ… |
183
- | ---------------------------- | ------------------- |
184
- | `BaseResponseDto<T>` | κΈ°λ³Έ API 응닡 ꡬ쑰 |
185
- | `createSuccessResponse<T>()` | 성곡 응닡 생성 ν•¨μˆ˜ |
186
- | `createErrorResponse<T>()` | μ—λŸ¬ 응닡 생성 ν•¨μˆ˜ |
187
-
188
47
  ## πŸ€– μžλ™ 배포
189
48
 
190
49
  이 νŒ¨ν‚€μ§€λŠ” λ°±μ—”λ“œ μ €μž₯μ†Œμ˜ νƒ€μž… 파일(`src/types/`)이 변경될 λ•Œλ§ˆλ‹€ GitHub Actionsλ₯Ό 톡해 μžλ™μœΌλ‘œ μ—…λ°μ΄νŠΈλ˜μ–΄ NPM에 λ°°ν¬λ©λ‹ˆλ‹€.
@@ -226,8 +85,6 @@ ISC
226
85
 
227
86
  ## πŸ”„ λ³€κ²½ 둜그
228
87
 
229
- ### v1.0.2
230
-
231
88
  - βœ… λͺ¨λ“  DTO 클래슀λ₯Ό μΈν„°νŽ˜μ΄μŠ€λ‘œ λ³€ν™˜
232
89
  - βœ… λŸ°νƒ€μž„ μ˜μ‘΄μ„± 제거 (`@nestjs/swagger` 제거)
233
90
  - βœ… νƒ€μž… μ•ˆμ „μ„± ν–₯상
@@ -0,0 +1,91 @@
1
+ export declare enum BugReportStatus {
2
+ OPEN = "open",
3
+ IN_PROGRESS = "in_progress",
4
+ RESOLVED = "resolved",
5
+ CLOSED = "closed"
6
+ }
7
+ export declare enum BugReportSeverity {
8
+ LOW = "low",
9
+ MEDIUM = "medium",
10
+ HIGH = "high",
11
+ CRITICAL = "critical"
12
+ }
13
+ export declare enum BugReportErrorType {
14
+ UNKNOWN = "unknown",
15
+ CLIENT_ERROR = "client_error",
16
+ SERVER_ERROR = "server_error",
17
+ NETWORK_ERROR = "network_error",
18
+ RUNTIME_ERROR = "runtime_error",
19
+ VALIDATION_ERROR = "validation_error",
20
+ SYNTAX_ERROR = "syntax_error",
21
+ REFERENCE_ERROR = "reference_error",
22
+ TYPE_ERROR = "type_error"
23
+ }
24
+ export interface CreateBugReportDto {
25
+ title: string;
26
+ description: string;
27
+ errorMessage?: string;
28
+ errorStack?: string;
29
+ errorType?: BugReportErrorType;
30
+ errorCode?: string;
31
+ url?: string;
32
+ userAgent?: string;
33
+ severity?: BugReportSeverity;
34
+ userId?: string;
35
+ assigneeId?: string;
36
+ metadata?: Record<string, any>;
37
+ }
38
+ export interface UpdateBugReportDto {
39
+ title?: string;
40
+ description?: string;
41
+ status?: BugReportStatus;
42
+ severity?: BugReportSeverity;
43
+ errorMessage?: string;
44
+ errorStack?: string;
45
+ errorType?: BugReportErrorType;
46
+ errorCode?: string;
47
+ assigneeId?: string;
48
+ metadata?: Record<string, any>;
49
+ }
50
+ export interface BugReportDataDto {
51
+ id: number;
52
+ title: string;
53
+ description: string;
54
+ errorMessage?: string;
55
+ errorStack?: string;
56
+ errorType: BugReportErrorType;
57
+ errorCode?: string;
58
+ url?: string;
59
+ userAgent?: string;
60
+ status: BugReportStatus;
61
+ severity: BugReportSeverity;
62
+ userId?: string;
63
+ assigneeId?: string;
64
+ metadata?: Record<string, any>;
65
+ createdAt: Date;
66
+ updatedAt: Date;
67
+ }
68
+ export interface GetBugReportResponseDto {
69
+ success: boolean;
70
+ message: string;
71
+ data: BugReportDataDto;
72
+ }
73
+ export interface GetBugReportsResponseDto {
74
+ success: boolean;
75
+ message: string;
76
+ data: BugReportDataDto[];
77
+ }
78
+ export interface CreateBugReportResponseDto {
79
+ success: boolean;
80
+ message: string;
81
+ data: BugReportDataDto;
82
+ }
83
+ export interface UpdateBugReportResponseDto {
84
+ success: boolean;
85
+ message: string;
86
+ data: BugReportDataDto;
87
+ }
88
+ export interface DeleteBugReportResponseDto {
89
+ success: boolean;
90
+ message: string;
91
+ }
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ // 버그 리포트 κ΄€λ ¨ νƒ€μž… μ •μ˜
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.BugReportErrorType = exports.BugReportSeverity = exports.BugReportStatus = void 0;
5
+ var BugReportStatus;
6
+ (function (BugReportStatus) {
7
+ BugReportStatus["OPEN"] = "open";
8
+ BugReportStatus["IN_PROGRESS"] = "in_progress";
9
+ BugReportStatus["RESOLVED"] = "resolved";
10
+ BugReportStatus["CLOSED"] = "closed";
11
+ })(BugReportStatus || (exports.BugReportStatus = BugReportStatus = {}));
12
+ var BugReportSeverity;
13
+ (function (BugReportSeverity) {
14
+ BugReportSeverity["LOW"] = "low";
15
+ BugReportSeverity["MEDIUM"] = "medium";
16
+ BugReportSeverity["HIGH"] = "high";
17
+ BugReportSeverity["CRITICAL"] = "critical";
18
+ })(BugReportSeverity || (exports.BugReportSeverity = BugReportSeverity = {}));
19
+ var BugReportErrorType;
20
+ (function (BugReportErrorType) {
21
+ BugReportErrorType["UNKNOWN"] = "unknown";
22
+ BugReportErrorType["CLIENT_ERROR"] = "client_error";
23
+ BugReportErrorType["SERVER_ERROR"] = "server_error";
24
+ BugReportErrorType["NETWORK_ERROR"] = "network_error";
25
+ BugReportErrorType["RUNTIME_ERROR"] = "runtime_error";
26
+ BugReportErrorType["VALIDATION_ERROR"] = "validation_error";
27
+ BugReportErrorType["SYNTAX_ERROR"] = "syntax_error";
28
+ BugReportErrorType["REFERENCE_ERROR"] = "reference_error";
29
+ BugReportErrorType["TYPE_ERROR"] = "type_error";
30
+ })(BugReportErrorType || (exports.BugReportErrorType = BugReportErrorType = {}));
@@ -0,0 +1,148 @@
1
+ export interface CreateHousingSupplyDto {
2
+ houseManageNo?: string;
3
+ pblancNo: string;
4
+ houseName?: string;
5
+ houseSecd?: string;
6
+ houseSecdNm?: string;
7
+ houseDtlSecd?: string;
8
+ houseDtlSecdNm?: string;
9
+ rentSecd?: string;
10
+ rentSecdNm?: string;
11
+ subscrptAreaCode?: string;
12
+ subscrptAreaCodeNm?: string;
13
+ hssplyZip?: string;
14
+ hssplyAdres?: string;
15
+ latitude?: number;
16
+ longitude?: number;
17
+ totSuplyHshldco?: number;
18
+ rcritPblancDe?: string;
19
+ rceptBgnde?: string;
20
+ rceptEndde?: string;
21
+ spsplyRceptBgnde?: string;
22
+ spsplyRceptEndde?: string;
23
+ przwnerPresnatnDe?: string;
24
+ cntrctCnclsBgnde?: string;
25
+ cntrctCnclsEndde?: string;
26
+ mvnPrearngeYm?: string;
27
+ hmpgAdres?: string;
28
+ pblancUrl?: string;
29
+ mdhsTelno?: string;
30
+ cnstrctEntrpsNm?: string;
31
+ bsnsMbyNm?: string;
32
+ nsprcNm?: string;
33
+ specltRdnEarthAt?: string;
34
+ mdatTrgetAreaSecd?: string;
35
+ parcprcUlsAt?: string;
36
+ imprmnBsnsAt?: string;
37
+ publicHouseEarthAt?: string;
38
+ lrsclBldlndAt?: string;
39
+ nplnPrvoprPublicHouseAt?: string;
40
+ publicHouseSpclwApplcAt?: string;
41
+ }
42
+ export interface UpdateHousingSupplyDto {
43
+ houseName?: string;
44
+ subscrptAreaCodeNm?: string;
45
+ hssplyAdres?: string;
46
+ latitude?: number;
47
+ longitude?: number;
48
+ totSuplyHshldco?: number;
49
+ rcritPblancDe?: string;
50
+ rceptBgnde?: string;
51
+ rceptEndde?: string;
52
+ mdhsTelno?: string;
53
+ }
54
+ export interface GetHousingSuppliesQueryDto {
55
+ search?: string;
56
+ houseSecd?: string;
57
+ houseSecdNm?: string;
58
+ houseDtlSecd?: string;
59
+ rentSecd?: string;
60
+ subscrptAreaCodeNm?: string;
61
+ rcritPblancDeFrom?: string;
62
+ rcritPblancDeTo?: string;
63
+ rceptBgndeFrom?: string;
64
+ rceptBgndeTo?: string;
65
+ parcprcUlsAt?: string;
66
+ specltRdnEarthAt?: string;
67
+ page?: number;
68
+ limit?: number;
69
+ sortBy?: string;
70
+ sortOrder?: 'ASC' | 'DESC';
71
+ }
72
+ export interface PaginationMetaDto {
73
+ page: number;
74
+ limit: number;
75
+ total: number;
76
+ totalPages: number;
77
+ itemCount: number;
78
+ }
79
+ export interface HousingSupplyDataDto {
80
+ id: number;
81
+ houseManageNo?: string;
82
+ pblancNo?: string;
83
+ houseName?: string;
84
+ houseSecd?: string;
85
+ houseSecdNm?: string;
86
+ houseDtlSecd?: string;
87
+ houseDtlSecdNm?: string;
88
+ rentSecd?: string;
89
+ rentSecdNm?: string;
90
+ subscrptAreaCode?: string;
91
+ subscrptAreaCodeNm?: string;
92
+ hssplyZip?: string;
93
+ hssplyAdres?: string;
94
+ latitude?: number;
95
+ longitude?: number;
96
+ totSuplyHshldco?: number;
97
+ rcritPblancDe?: Date;
98
+ rceptBgnde?: Date;
99
+ rceptEndde?: Date;
100
+ spsplyRceptBgnde?: Date;
101
+ spsplyRceptEndde?: Date;
102
+ przwnerPresnatnDe?: Date;
103
+ cntrctCnclsBgnde?: Date;
104
+ cntrctCnclsEndde?: Date;
105
+ mvnPrearngeYm?: Date;
106
+ hmpgAdres?: string;
107
+ pblancUrl?: string;
108
+ mdhsTelno?: string;
109
+ cnstrctEntrpsNm?: string;
110
+ bsnsMbyNm?: string;
111
+ nsprcNm?: string;
112
+ specltRdnEarthAt?: string;
113
+ mdatTrgetAreaSecd?: string;
114
+ parcprcUlsAt?: string;
115
+ imprmnBsnsAt?: string;
116
+ publicHouseEarthAt?: string;
117
+ lrsclBldlndAt?: string;
118
+ nplnPrvoprPublicHouseAt?: string;
119
+ publicHouseSpclwApplcAt?: string;
120
+ collectedAt: Date;
121
+ createdAt: Date;
122
+ updatedAt: Date;
123
+ }
124
+ export interface GetHousingSupplyResponseDto {
125
+ success: boolean;
126
+ message: string;
127
+ data: HousingSupplyDataDto;
128
+ }
129
+ export interface GetHousingSuppliesResponseDto {
130
+ success: boolean;
131
+ message: string;
132
+ data: HousingSupplyDataDto[];
133
+ meta: PaginationMetaDto;
134
+ }
135
+ export interface CreateHousingSupplyResponseDto {
136
+ success: boolean;
137
+ message: string;
138
+ data: HousingSupplyDataDto;
139
+ }
140
+ export interface UpdateHousingSupplyResponseDto {
141
+ success: boolean;
142
+ message: string;
143
+ data: HousingSupplyDataDto;
144
+ }
145
+ export interface DeleteHousingSupplyResponseDto {
146
+ success: boolean;
147
+ message: string;
148
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/dist/index.d.ts CHANGED
@@ -4,6 +4,8 @@
4
4
  */
5
5
  export * from './auth.const';
6
6
  export * from './auth.dto';
7
+ export * from './bug-report.dto';
8
+ export * from './housing-supply.dto';
7
9
  export * from './jwt.types';
8
10
  export * from './response.dto';
9
11
  export * from './response.helpers';
package/dist/index.js CHANGED
@@ -20,6 +20,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
20
20
  Object.defineProperty(exports, "__esModule", { value: true });
21
21
  __exportStar(require("./auth.const"), exports);
22
22
  __exportStar(require("./auth.dto"), exports);
23
+ __exportStar(require("./bug-report.dto"), exports);
24
+ __exportStar(require("./housing-supply.dto"), exports);
23
25
  __exportStar(require("./jwt.types"), exports);
24
26
  __exportStar(require("./response.dto"), exports);
25
27
  __exportStar(require("./response.helpers"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "byzip-v2-sdk",
3
- "version": "1.0.3",
3
+ "version": "1.0.5",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "files": [
@@ -8,8 +8,7 @@
8
8
  ],
9
9
  "scripts": {
10
10
  "build": "tsc",
11
- "prepublishOnly": "npm run build",
12
- "test": "echo \"Error: no test specified\" && exit 1"
11
+ "prepublishOnly": "npm run build"
13
12
  },
14
13
  "keywords": [
15
14
  "byzip",