@mandujs/core 0.9.2 → 0.9.4

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.
@@ -1,308 +1,308 @@
1
- /**
2
- * Mandu Auth Guards - 인증/인가 헬퍼 🔐
3
- *
4
- * beforeHandle에서 사용할 수 있는 타입-안전 인증 헬퍼
5
- * 인증 실패 시 적절한 에러를 throw하여 체인 중단
6
- */
7
-
8
- import type { ManduContext } from "./context";
9
-
10
- /**
11
- * 인증 실패 에러 (401 Unauthorized)
12
- */
13
- export class AuthenticationError extends Error {
14
- readonly statusCode = 401;
15
-
16
- constructor(message: string = "Authentication required") {
17
- super(message);
18
- this.name = "AuthenticationError";
19
- }
20
- }
21
-
22
- /**
23
- * 인가 실패 에러 (403 Forbidden)
24
- */
25
- export class AuthorizationError extends Error {
26
- readonly statusCode = 403;
27
- readonly requiredRoles?: string[];
28
-
29
- constructor(message: string = "Access denied", requiredRoles?: string[]) {
30
- super(message);
31
- this.name = "AuthorizationError";
32
- this.requiredRoles = requiredRoles;
33
- }
34
- }
35
-
36
- /**
37
- * 기본 User 인터페이스
38
- * 프로젝트에서 확장하여 사용
39
- */
40
- export interface BaseUser {
41
- id: string;
42
- [key: string]: unknown;
43
- }
44
-
45
- /**
46
- * Role을 가진 User 인터페이스
47
- */
48
- export interface UserWithRole extends BaseUser {
49
- role: string;
50
- }
51
-
52
- /**
53
- * Roles 배열을 가진 User 인터페이스
54
- */
55
- export interface UserWithRoles extends BaseUser {
56
- roles: string[];
57
- }
58
-
59
- // ============================================
60
- // 🔐 Auth Helpers
61
- // ============================================
62
-
63
- /**
64
- * 인증된 사용자 필수
65
- * beforeHandle에서 user가 없으면 AuthenticationError throw
66
- *
67
- * @param ctx ManduContext
68
- * @param key store에서 user를 찾을 키 (기본: 'user')
69
- * @returns 인증된 User (타입 확정)
70
- * @throws AuthenticationError
71
- *
72
- * @example
73
- * typescript
74
- * import { requireUser } from '@mandujs/core'
75
- *
76
- * export default Mandu.filling()
77
- * .beforeHandle(async (ctx) => {
78
- * // JWT 토큰 검증 후 user 저장
79
- * const user = await verifyToken(ctx.headers.get('Authorization'));
80
- * ctx.set('user', user);
81
- * // void 반환 시 계속 진행
82
- * })
83
- * .get((ctx) => {
84
- * const user = requireUser(ctx); // User 타입 확정, 없으면 401
85
- * return ctx.ok({ message: "Hello, " + user.id + "!" });
86
- * })
87
- *
88
- */
89
- export function requireUser<T extends BaseUser = BaseUser>(
90
- ctx: ManduContext,
91
- key: string = "user"
92
- ): T {
93
- const user = ctx.get<T>(key);
94
-
95
- if (!user) {
96
- throw new AuthenticationError("User context is required");
97
- }
98
-
99
- if (typeof user !== "object" || !("id" in user)) {
100
- throw new AuthenticationError("Invalid user context");
101
- }
102
-
103
- return user;
104
- }
105
-
106
- /**
107
- * 특정 역할 필수 (단일 role 필드)
108
- *
109
- * @param ctx ManduContext
110
- * @param roles 허용된 역할 목록
111
- * @param key store에서 user를 찾을 키 (기본: 'user')
112
- * @returns 인증된 User (타입 확정)
113
- * @throws AuthenticationError (user 없음)
114
- * @throws AuthorizationError (역할 불일치)
115
- *
116
- * @example
117
- * typescript
118
- * .beforeHandle((ctx) => {
119
- * requireRole(ctx, 'admin', 'moderator'); // admin 또는 moderator만 허용
120
- * // void 반환 시 계속 진행
121
- * })
122
- *
123
- */
124
- export function requireRole<T extends UserWithRole = UserWithRole>(
125
- ctx: ManduContext,
126
- ...roles: string[]
127
- ): T {
128
- const user = requireUser<T>(ctx);
129
-
130
- if (!("role" in user) || typeof user.role !== "string") {
131
- throw new AuthorizationError("User has no role defined");
132
- }
133
-
134
- if (!roles.includes(user.role)) {
135
- throw new AuthorizationError(
136
- "Required role: " + roles.join(" or "),
137
- roles
138
- );
139
- }
140
-
141
- return user;
142
- }
143
-
144
- /**
145
- * 특정 역할 중 하나 필수 (roles 배열 필드)
146
- *
147
- * @param ctx ManduContext
148
- * @param roles 허용된 역할 목록 (하나라도 있으면 통과)
149
- * @param key store에서 user를 찾을 키 (기본: 'user')
150
- * @returns 인증된 User (타입 확정)
151
- * @throws AuthenticationError (user 없음)
152
- * @throws AuthorizationError (역할 불일치)
153
- *
154
- * @example
155
- * typescript
156
- * .beforeHandle((ctx) => {
157
- * requireAnyRole(ctx, 'editor', 'admin'); // editor 또는 admin 역할 필요
158
- * // void 반환 시 계속 진행
159
- * })
160
- *
161
- */
162
- export function requireAnyRole<T extends UserWithRoles = UserWithRoles>(
163
- ctx: ManduContext,
164
- ...roles: string[]
165
- ): T {
166
- const user = requireUser<T>(ctx);
167
-
168
- if (!("roles" in user) || !Array.isArray(user.roles)) {
169
- throw new AuthorizationError("User has no roles defined");
170
- }
171
-
172
- const hasRole = roles.some((role) => user.roles.includes(role));
173
-
174
- if (!hasRole) {
175
- throw new AuthorizationError(
176
- "Required one of roles: " + roles.join(", "),
177
- roles
178
- );
179
- }
180
-
181
- return user;
182
- }
183
-
184
- /**
185
- * 모든 역할 필수 (roles 배열 필드)
186
- *
187
- * @param ctx ManduContext
188
- * @param roles 필요한 역할 목록 (모두 있어야 통과)
189
- * @returns 인증된 User (타입 확정)
190
- * @throws AuthenticationError (user 없음)
191
- * @throws AuthorizationError (역할 불일치)
192
- *
193
- * @example
194
- * typescript
195
- * .beforeHandle((ctx) => {
196
- * requireAllRoles(ctx, 'verified', 'premium'); // verified AND premium 필요
197
- * // void 반환 시 계속 진행
198
- * })
199
- *
200
- */
201
- export function requireAllRoles<T extends UserWithRoles = UserWithRoles>(
202
- ctx: ManduContext,
203
- ...roles: string[]
204
- ): T {
205
- const user = requireUser<T>(ctx);
206
-
207
- if (!("roles" in user) || !Array.isArray(user.roles)) {
208
- throw new AuthorizationError("User has no roles defined");
209
- }
210
-
211
- const missingRoles = roles.filter((role) => !user.roles.includes(role));
212
-
213
- if (missingRoles.length > 0) {
214
- throw new AuthorizationError(
215
- "Missing required roles: " + missingRoles.join(", "),
216
- roles
217
- );
218
- }
219
-
220
- return user;
221
- }
222
-
223
- // ============================================
224
- // 🔐 Auth Handler Factory
225
- // ============================================
226
-
227
- /**
228
- * 인증 beforeHandle 생성 팩토리
229
- * 반복되는 인증 로직을 beforeHandle로 변환
230
- *
231
- * @example
232
- * typescript
233
- * const authHandler = createAuthGuard(async (ctx) => {
234
- * const token = ctx.headers.get('Authorization')?.replace('Bearer ', '');
235
- * if (!token) return null;
236
- * return await verifyJwt(token);
237
- * });
238
- *
239
- * export default Mandu.filling()
240
- * .beforeHandle(authHandler)
241
- * .get((ctx) => {
242
- * const user = requireUser(ctx);
243
- * return ctx.ok({ user });
244
- * })
245
- *
246
- */
247
- export function createAuthGuard<T extends BaseUser>(
248
- authenticator: (ctx: ManduContext) => T | null | Promise<T | null>,
249
- options: {
250
- key?: string;
251
- onUnauthenticated?: (ctx: ManduContext) => Response;
252
- } = {}
253
- ) {
254
- const { key = "user", onUnauthenticated } = options;
255
-
256
- return async (ctx: ManduContext): Promise<Response | void> => {
257
- try {
258
- const user = await authenticator(ctx);
259
-
260
- if (user) {
261
- ctx.set(key, user);
262
- return; // void 반환 시 계속 진행
263
- }
264
-
265
- if (onUnauthenticated) {
266
- return onUnauthenticated(ctx);
267
- }
268
-
269
- return ctx.unauthorized("Authentication required");
270
- } catch (error) {
271
- if (error instanceof AuthenticationError) {
272
- return ctx.unauthorized(error.message);
273
- }
274
- throw error;
275
- }
276
- };
277
- }
278
-
279
- /**
280
- * 역할 기반 beforeHandle 생성 팩토리
281
- *
282
- * @example
283
- * typescript
284
- * const adminOnly = createRoleGuard('admin');
285
- * const editorOrAdmin = createRoleGuard('editor', 'admin');
286
- *
287
- * export default Mandu.filling()
288
- * .beforeHandle(authHandler)
289
- * .beforeHandle(adminOnly) // admin만 접근 가능
290
- * .delete((ctx) => ctx.noContent())
291
- *
292
- */
293
- export function createRoleGuard(...allowedRoles: string[]) {
294
- return (ctx: ManduContext): Response | void => {
295
- try {
296
- requireRole(ctx, ...allowedRoles);
297
- return; // void 반환 시 계속 진행
298
- } catch (error) {
299
- if (error instanceof AuthenticationError) {
300
- return ctx.unauthorized(error.message);
301
- }
302
- if (error instanceof AuthorizationError) {
303
- return ctx.forbidden(error.message);
304
- }
305
- throw error;
306
- }
307
- };
308
- }
1
+ /**
2
+ * Mandu Auth Guards - 인증/인가 헬퍼 🔐
3
+ *
4
+ * beforeHandle에서 사용할 수 있는 타입-안전 인증 헬퍼
5
+ * 인증 실패 시 적절한 에러를 throw하여 체인 중단
6
+ */
7
+
8
+ import type { ManduContext } from "./context";
9
+
10
+ /**
11
+ * 인증 실패 에러 (401 Unauthorized)
12
+ */
13
+ export class AuthenticationError extends Error {
14
+ readonly statusCode = 401;
15
+
16
+ constructor(message: string = "Authentication required") {
17
+ super(message);
18
+ this.name = "AuthenticationError";
19
+ }
20
+ }
21
+
22
+ /**
23
+ * 인가 실패 에러 (403 Forbidden)
24
+ */
25
+ export class AuthorizationError extends Error {
26
+ readonly statusCode = 403;
27
+ readonly requiredRoles?: string[];
28
+
29
+ constructor(message: string = "Access denied", requiredRoles?: string[]) {
30
+ super(message);
31
+ this.name = "AuthorizationError";
32
+ this.requiredRoles = requiredRoles;
33
+ }
34
+ }
35
+
36
+ /**
37
+ * 기본 User 인터페이스
38
+ * 프로젝트에서 확장하여 사용
39
+ */
40
+ export interface BaseUser {
41
+ id: string;
42
+ [key: string]: unknown;
43
+ }
44
+
45
+ /**
46
+ * Role을 가진 User 인터페이스
47
+ */
48
+ export interface UserWithRole extends BaseUser {
49
+ role: string;
50
+ }
51
+
52
+ /**
53
+ * Roles 배열을 가진 User 인터페이스
54
+ */
55
+ export interface UserWithRoles extends BaseUser {
56
+ roles: string[];
57
+ }
58
+
59
+ // ============================================
60
+ // 🔐 Auth Helpers
61
+ // ============================================
62
+
63
+ /**
64
+ * 인증된 사용자 필수
65
+ * beforeHandle에서 user가 없으면 AuthenticationError throw
66
+ *
67
+ * @param ctx ManduContext
68
+ * @param key store에서 user를 찾을 키 (기본: 'user')
69
+ * @returns 인증된 User (타입 확정)
70
+ * @throws AuthenticationError
71
+ *
72
+ * @example
73
+ * typescript
74
+ * import { requireUser } from '@mandujs/core'
75
+ *
76
+ * export default Mandu.filling()
77
+ * .beforeHandle(async (ctx) => {
78
+ * // JWT 토큰 검증 후 user 저장
79
+ * const user = await verifyToken(ctx.headers.get('Authorization'));
80
+ * ctx.set('user', user);
81
+ * // void 반환 시 계속 진행
82
+ * })
83
+ * .get((ctx) => {
84
+ * const user = requireUser(ctx); // User 타입 확정, 없으면 401
85
+ * return ctx.ok({ message: "Hello, " + user.id + "!" });
86
+ * })
87
+ *
88
+ */
89
+ export function requireUser<T extends BaseUser = BaseUser>(
90
+ ctx: ManduContext,
91
+ key: string = "user"
92
+ ): T {
93
+ const user = ctx.get<T>(key);
94
+
95
+ if (!user) {
96
+ throw new AuthenticationError("User context is required");
97
+ }
98
+
99
+ if (typeof user !== "object" || !("id" in user)) {
100
+ throw new AuthenticationError("Invalid user context");
101
+ }
102
+
103
+ return user;
104
+ }
105
+
106
+ /**
107
+ * 특정 역할 필수 (단일 role 필드)
108
+ *
109
+ * @param ctx ManduContext
110
+ * @param roles 허용된 역할 목록
111
+ * @param key store에서 user를 찾을 키 (기본: 'user')
112
+ * @returns 인증된 User (타입 확정)
113
+ * @throws AuthenticationError (user 없음)
114
+ * @throws AuthorizationError (역할 불일치)
115
+ *
116
+ * @example
117
+ * typescript
118
+ * .beforeHandle((ctx) => {
119
+ * requireRole(ctx, 'admin', 'moderator'); // admin 또는 moderator만 허용
120
+ * // void 반환 시 계속 진행
121
+ * })
122
+ *
123
+ */
124
+ export function requireRole<T extends UserWithRole = UserWithRole>(
125
+ ctx: ManduContext,
126
+ ...roles: string[]
127
+ ): T {
128
+ const user = requireUser<T>(ctx);
129
+
130
+ if (!("role" in user) || typeof user.role !== "string") {
131
+ throw new AuthorizationError("User has no role defined");
132
+ }
133
+
134
+ if (!roles.includes(user.role)) {
135
+ throw new AuthorizationError(
136
+ "Required role: " + roles.join(" or "),
137
+ roles
138
+ );
139
+ }
140
+
141
+ return user;
142
+ }
143
+
144
+ /**
145
+ * 특정 역할 중 하나 필수 (roles 배열 필드)
146
+ *
147
+ * @param ctx ManduContext
148
+ * @param roles 허용된 역할 목록 (하나라도 있으면 통과)
149
+ * @param key store에서 user를 찾을 키 (기본: 'user')
150
+ * @returns 인증된 User (타입 확정)
151
+ * @throws AuthenticationError (user 없음)
152
+ * @throws AuthorizationError (역할 불일치)
153
+ *
154
+ * @example
155
+ * typescript
156
+ * .beforeHandle((ctx) => {
157
+ * requireAnyRole(ctx, 'editor', 'admin'); // editor 또는 admin 역할 필요
158
+ * // void 반환 시 계속 진행
159
+ * })
160
+ *
161
+ */
162
+ export function requireAnyRole<T extends UserWithRoles = UserWithRoles>(
163
+ ctx: ManduContext,
164
+ ...roles: string[]
165
+ ): T {
166
+ const user = requireUser<T>(ctx);
167
+
168
+ if (!("roles" in user) || !Array.isArray(user.roles)) {
169
+ throw new AuthorizationError("User has no roles defined");
170
+ }
171
+
172
+ const hasRole = roles.some((role) => user.roles.includes(role));
173
+
174
+ if (!hasRole) {
175
+ throw new AuthorizationError(
176
+ "Required one of roles: " + roles.join(", "),
177
+ roles
178
+ );
179
+ }
180
+
181
+ return user;
182
+ }
183
+
184
+ /**
185
+ * 모든 역할 필수 (roles 배열 필드)
186
+ *
187
+ * @param ctx ManduContext
188
+ * @param roles 필요한 역할 목록 (모두 있어야 통과)
189
+ * @returns 인증된 User (타입 확정)
190
+ * @throws AuthenticationError (user 없음)
191
+ * @throws AuthorizationError (역할 불일치)
192
+ *
193
+ * @example
194
+ * typescript
195
+ * .beforeHandle((ctx) => {
196
+ * requireAllRoles(ctx, 'verified', 'premium'); // verified AND premium 필요
197
+ * // void 반환 시 계속 진행
198
+ * })
199
+ *
200
+ */
201
+ export function requireAllRoles<T extends UserWithRoles = UserWithRoles>(
202
+ ctx: ManduContext,
203
+ ...roles: string[]
204
+ ): T {
205
+ const user = requireUser<T>(ctx);
206
+
207
+ if (!("roles" in user) || !Array.isArray(user.roles)) {
208
+ throw new AuthorizationError("User has no roles defined");
209
+ }
210
+
211
+ const missingRoles = roles.filter((role) => !user.roles.includes(role));
212
+
213
+ if (missingRoles.length > 0) {
214
+ throw new AuthorizationError(
215
+ "Missing required roles: " + missingRoles.join(", "),
216
+ roles
217
+ );
218
+ }
219
+
220
+ return user;
221
+ }
222
+
223
+ // ============================================
224
+ // 🔐 Auth Handler Factory
225
+ // ============================================
226
+
227
+ /**
228
+ * 인증 beforeHandle 생성 팩토리
229
+ * 반복되는 인증 로직을 beforeHandle로 변환
230
+ *
231
+ * @example
232
+ * typescript
233
+ * const authHandler = createAuthGuard(async (ctx) => {
234
+ * const token = ctx.headers.get('Authorization')?.replace('Bearer ', '');
235
+ * if (!token) return null;
236
+ * return await verifyJwt(token);
237
+ * });
238
+ *
239
+ * export default Mandu.filling()
240
+ * .beforeHandle(authHandler)
241
+ * .get((ctx) => {
242
+ * const user = requireUser(ctx);
243
+ * return ctx.ok({ user });
244
+ * })
245
+ *
246
+ */
247
+ export function createAuthGuard<T extends BaseUser>(
248
+ authenticator: (ctx: ManduContext) => T | null | Promise<T | null>,
249
+ options: {
250
+ key?: string;
251
+ onUnauthenticated?: (ctx: ManduContext) => Response;
252
+ } = {}
253
+ ) {
254
+ const { key = "user", onUnauthenticated } = options;
255
+
256
+ return async (ctx: ManduContext): Promise<Response | void> => {
257
+ try {
258
+ const user = await authenticator(ctx);
259
+
260
+ if (user) {
261
+ ctx.set(key, user);
262
+ return; // void 반환 시 계속 진행
263
+ }
264
+
265
+ if (onUnauthenticated) {
266
+ return onUnauthenticated(ctx);
267
+ }
268
+
269
+ return ctx.unauthorized("Authentication required");
270
+ } catch (error) {
271
+ if (error instanceof AuthenticationError) {
272
+ return ctx.unauthorized(error.message);
273
+ }
274
+ throw error;
275
+ }
276
+ };
277
+ }
278
+
279
+ /**
280
+ * 역할 기반 beforeHandle 생성 팩토리
281
+ *
282
+ * @example
283
+ * typescript
284
+ * const adminOnly = createRoleGuard('admin');
285
+ * const editorOrAdmin = createRoleGuard('editor', 'admin');
286
+ *
287
+ * export default Mandu.filling()
288
+ * .beforeHandle(authHandler)
289
+ * .beforeHandle(adminOnly) // admin만 접근 가능
290
+ * .delete((ctx) => ctx.noContent())
291
+ *
292
+ */
293
+ export function createRoleGuard(...allowedRoles: string[]) {
294
+ return (ctx: ManduContext): Response | void => {
295
+ try {
296
+ requireRole(ctx, ...allowedRoles);
297
+ return; // void 반환 시 계속 진행
298
+ } catch (error) {
299
+ if (error instanceof AuthenticationError) {
300
+ return ctx.unauthorized(error.message);
301
+ }
302
+ if (error instanceof AuthorizationError) {
303
+ return ctx.forbidden(error.message);
304
+ }
305
+ throw error;
306
+ }
307
+ };
308
+ }