@nestia/core 2.6.3-dev.20240328 → 2.6.3

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.
Files changed (32) hide show
  1. package/package.json +3 -3
  2. package/src/decorators/EncryptedBody.ts +105 -105
  3. package/src/decorators/EncryptedModule.ts +96 -96
  4. package/src/decorators/PlainBody.ts +75 -75
  5. package/src/decorators/SwaggerCustomizer.ts +116 -116
  6. package/src/decorators/TypedBody.ts +62 -62
  7. package/src/decorators/TypedException.ts +90 -90
  8. package/src/decorators/TypedFormData.ts +219 -219
  9. package/src/decorators/TypedQuery.ts +251 -251
  10. package/src/decorators/TypedRoute.ts +144 -144
  11. package/src/decorators/internal/get_path_and_querify.ts +106 -106
  12. package/src/decorators/internal/load_controller.ts +51 -51
  13. package/src/decorators/internal/validate_request_body.ts +72 -72
  14. package/src/decorators/internal/validate_request_form_data.ts +75 -75
  15. package/src/decorators/internal/validate_request_headers.ts +83 -83
  16. package/src/decorators/internal/validate_request_query.ts +71 -71
  17. package/src/module.ts +16 -16
  18. package/src/options/IRequestFormDataProps.ts +27 -27
  19. package/src/programmers/PlainBodyProgrammer.ts +52 -52
  20. package/src/programmers/TypedExceptionProgrammer.ts +71 -71
  21. package/src/programmers/TypedFormDataBodyProgrammer.ts +108 -108
  22. package/src/programmers/http/HttpQuerifyProgrammer.ts +96 -96
  23. package/src/structures/ISwagger.ts +91 -91
  24. package/src/structures/ISwaggerComponents.ts +29 -29
  25. package/src/structures/ISwaggerInfo.ts +80 -80
  26. package/src/structures/ISwaggerRoute.ts +50 -50
  27. package/src/structures/ISwaggerSecurityScheme.ts +65 -65
  28. package/src/transformers/NodeTransformer.ts +16 -16
  29. package/src/transformers/ParameterDecoratorTransformer.ts +120 -120
  30. package/src/transformers/TypedExceptionTransformer.ts +48 -48
  31. package/src/transformers/TypedRouteTransformer.ts +88 -88
  32. package/src/utils/Singleton.ts +20 -20
@@ -1,144 +1,144 @@
1
- import {
2
- CallHandler,
3
- Delete,
4
- ExecutionContext,
5
- Get,
6
- NestInterceptor,
7
- Patch,
8
- Post,
9
- Put,
10
- UseInterceptors,
11
- applyDecorators,
12
- } from "@nestjs/common";
13
- import { HttpArgumentsHost } from "@nestjs/common/interfaces";
14
- import type express from "express";
15
- import { catchError, map } from "rxjs/operators";
16
- import typia from "typia";
17
-
18
- import { IResponseBodyStringifier } from "../options/IResponseBodyStringifier";
19
- import { get_path_and_stringify } from "./internal/get_path_and_stringify";
20
- import { route_error } from "./internal/route_error";
21
-
22
- /**
23
- * Type safe router decorator functions.
24
- *
25
- * `TypedRoute` is a module containing router decorator functions which can boost up
26
- * JSON string conversion speed about 200x times faster than `class-transformer`.
27
- * Furthermore, such JSON string conversion is even type safe through
28
- * [typia](https://github.com/samchon/typia).
29
- *
30
- * For reference, if you try to invalid data that is not following the promised
31
- * type `T`, 500 internal server error would be thrown. Also, as `TypedRoute` composes
32
- * JSON string through `typia.assertStringify<T>()` function, it is not possible to
33
- * modify response data through interceptors.
34
- *
35
- * @author Jeongho Nam - https://github.com/samchon
36
- */
37
- export namespace TypedRoute {
38
- /**
39
- * Router decorator function for the GET method.
40
- *
41
- * @param path Path of the HTTP request
42
- * @returns Method decorator
43
- */
44
- export const Get = Generator("Get");
45
-
46
- /**
47
- * Router decorator function for the POST method.
48
- *
49
- * @param path Path of the HTTP request
50
- * @returns Method decorator
51
- */
52
- export const Post = Generator("Post");
53
-
54
- /**
55
- * Router decorator function for the PATH method.
56
- *
57
- * @param path Path of the HTTP request
58
- * @returns Method decorator
59
- */
60
- export const Patch = Generator("Patch");
61
-
62
- /**
63
- * Router decorator function for the PUT method.
64
- *
65
- * @param path Path of the HTTP request
66
- * @returns Method decorator
67
- */
68
- export const Put = Generator("Put");
69
-
70
- /**
71
- * Router decorator function for the DELETE method.
72
- *
73
- * @param path Path of the HTTP request
74
- * @returns Method decorator
75
- */
76
- export const Delete = Generator("Delete");
77
-
78
- /**
79
- * @internal
80
- */
81
- function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
82
- function route(path?: string | string[]): MethodDecorator;
83
- function route<T>(stringify?: IResponseBodyStringifier<T>): MethodDecorator;
84
- function route<T>(
85
- path: string | string[],
86
- stringify?: IResponseBodyStringifier<T>,
87
- ): MethodDecorator;
88
-
89
- function route(...args: any[]): MethodDecorator {
90
- const [path, stringify] = get_path_and_stringify(`TypedRoute.${method}`)(
91
- ...args,
92
- );
93
- return applyDecorators(
94
- ROUTERS[method](path),
95
- UseInterceptors(new TypedRouteInterceptor(stringify)),
96
- );
97
- }
98
- return route;
99
- }
100
- }
101
- for (const method of [
102
- typia.json.stringify,
103
- typia.json.isStringify,
104
- typia.json.assertStringify,
105
- typia.json.validateStringify,
106
- ])
107
- for (const [key, value] of Object.entries(method))
108
- for (const deco of [
109
- TypedRoute.Get,
110
- TypedRoute.Delete,
111
- TypedRoute.Post,
112
- TypedRoute.Put,
113
- TypedRoute.Patch,
114
- ])
115
- (deco as any)[key] = value;
116
-
117
- /**
118
- * @internal
119
- */
120
- class TypedRouteInterceptor implements NestInterceptor {
121
- public constructor(private readonly stringify: (input: any) => string) {}
122
-
123
- public intercept(context: ExecutionContext, next: CallHandler) {
124
- const http: HttpArgumentsHost = context.switchToHttp();
125
- const response: express.Response = http.getResponse();
126
- response.header("Content-Type", "application/json");
127
-
128
- return next.handle().pipe(
129
- map((value) => this.stringify(value)),
130
- catchError((err) => route_error(http.getRequest(), err)),
131
- );
132
- }
133
- }
134
-
135
- /**
136
- * @internal
137
- */
138
- const ROUTERS = {
139
- Get,
140
- Post,
141
- Patch,
142
- Put,
143
- Delete,
144
- };
1
+ import {
2
+ CallHandler,
3
+ Delete,
4
+ ExecutionContext,
5
+ Get,
6
+ NestInterceptor,
7
+ Patch,
8
+ Post,
9
+ Put,
10
+ UseInterceptors,
11
+ applyDecorators,
12
+ } from "@nestjs/common";
13
+ import { HttpArgumentsHost } from "@nestjs/common/interfaces";
14
+ import type express from "express";
15
+ import { catchError, map } from "rxjs/operators";
16
+ import typia from "typia";
17
+
18
+ import { IResponseBodyStringifier } from "../options/IResponseBodyStringifier";
19
+ import { get_path_and_stringify } from "./internal/get_path_and_stringify";
20
+ import { route_error } from "./internal/route_error";
21
+
22
+ /**
23
+ * Type safe router decorator functions.
24
+ *
25
+ * `TypedRoute` is a module containing router decorator functions which can boost up
26
+ * JSON string conversion speed about 200x times faster than `class-transformer`.
27
+ * Furthermore, such JSON string conversion is even type safe through
28
+ * [typia](https://github.com/samchon/typia).
29
+ *
30
+ * For reference, if you try to invalid data that is not following the promised
31
+ * type `T`, 500 internal server error would be thrown. Also, as `TypedRoute` composes
32
+ * JSON string through `typia.assertStringify<T>()` function, it is not possible to
33
+ * modify response data through interceptors.
34
+ *
35
+ * @author Jeongho Nam - https://github.com/samchon
36
+ */
37
+ export namespace TypedRoute {
38
+ /**
39
+ * Router decorator function for the GET method.
40
+ *
41
+ * @param path Path of the HTTP request
42
+ * @returns Method decorator
43
+ */
44
+ export const Get = Generator("Get");
45
+
46
+ /**
47
+ * Router decorator function for the POST method.
48
+ *
49
+ * @param path Path of the HTTP request
50
+ * @returns Method decorator
51
+ */
52
+ export const Post = Generator("Post");
53
+
54
+ /**
55
+ * Router decorator function for the PATH method.
56
+ *
57
+ * @param path Path of the HTTP request
58
+ * @returns Method decorator
59
+ */
60
+ export const Patch = Generator("Patch");
61
+
62
+ /**
63
+ * Router decorator function for the PUT method.
64
+ *
65
+ * @param path Path of the HTTP request
66
+ * @returns Method decorator
67
+ */
68
+ export const Put = Generator("Put");
69
+
70
+ /**
71
+ * Router decorator function for the DELETE method.
72
+ *
73
+ * @param path Path of the HTTP request
74
+ * @returns Method decorator
75
+ */
76
+ export const Delete = Generator("Delete");
77
+
78
+ /**
79
+ * @internal
80
+ */
81
+ function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
82
+ function route(path?: string | string[]): MethodDecorator;
83
+ function route<T>(stringify?: IResponseBodyStringifier<T>): MethodDecorator;
84
+ function route<T>(
85
+ path: string | string[],
86
+ stringify?: IResponseBodyStringifier<T>,
87
+ ): MethodDecorator;
88
+
89
+ function route(...args: any[]): MethodDecorator {
90
+ const [path, stringify] = get_path_and_stringify(`TypedRoute.${method}`)(
91
+ ...args,
92
+ );
93
+ return applyDecorators(
94
+ ROUTERS[method](path),
95
+ UseInterceptors(new TypedRouteInterceptor(stringify)),
96
+ );
97
+ }
98
+ return route;
99
+ }
100
+ }
101
+ for (const method of [
102
+ typia.json.stringify,
103
+ typia.json.isStringify,
104
+ typia.json.assertStringify,
105
+ typia.json.validateStringify,
106
+ ])
107
+ for (const [key, value] of Object.entries(method))
108
+ for (const deco of [
109
+ TypedRoute.Get,
110
+ TypedRoute.Delete,
111
+ TypedRoute.Post,
112
+ TypedRoute.Put,
113
+ TypedRoute.Patch,
114
+ ])
115
+ (deco as any)[key] = value;
116
+
117
+ /**
118
+ * @internal
119
+ */
120
+ class TypedRouteInterceptor implements NestInterceptor {
121
+ public constructor(private readonly stringify: (input: any) => string) {}
122
+
123
+ public intercept(context: ExecutionContext, next: CallHandler) {
124
+ const http: HttpArgumentsHost = context.switchToHttp();
125
+ const response: express.Response = http.getResponse();
126
+ response.header("Content-Type", "application/json");
127
+
128
+ return next.handle().pipe(
129
+ map((value) => this.stringify(value)),
130
+ catchError((err) => route_error(http.getRequest(), err)),
131
+ );
132
+ }
133
+ }
134
+
135
+ /**
136
+ * @internal
137
+ */
138
+ const ROUTERS = {
139
+ Get,
140
+ Post,
141
+ Patch,
142
+ Put,
143
+ Delete,
144
+ };
@@ -1,106 +1,106 @@
1
- import { InternalServerErrorException } from "@nestjs/common";
2
- import typia, { IValidation, TypeGuardError } from "typia";
3
-
4
- import { IResponseBodyQuerifier } from "../../options/IResponseBodyQuerifier";
5
- import { NoTransformConfigureError } from "./NoTransformConfigureError";
6
-
7
- /**
8
- * @internal
9
- */
10
- export const get_path_and_querify =
11
- (method: string) =>
12
- (
13
- ...args: any[]
14
- ): [string | string[] | undefined, (input: any) => URLSearchParams] => {
15
- const path: string | string[] | null | undefined =
16
- args[0] === undefined ||
17
- typeof args[0] === "string" ||
18
- Array.isArray(args[0])
19
- ? args[0]
20
- : null;
21
- const functor: IResponseBodyQuerifier<any> | undefined =
22
- path === null ? args[0] : args[1];
23
- return [path ?? undefined, take(method)(functor)];
24
- };
25
-
26
- /**
27
- * @internal
28
- */
29
- const take =
30
- (method: string) =>
31
- <T>(functor?: IResponseBodyQuerifier<T> | null) => {
32
- if (functor === undefined) throw NoTransformConfigureError(method);
33
- else if (functor === null) return querify;
34
- else if (functor.type === "stringify") return functor.stringify;
35
- else if (functor.type === "assert") return assert(functor.assert);
36
- else if (functor.type === "is") return is(functor.is);
37
- else if (functor.type === "validate") return validate(functor.validate);
38
- throw new Error(
39
- `Error on nestia.core.${method}(): invalid typed stringify function.`,
40
- );
41
- };
42
-
43
- /**
44
- * @internal
45
- */
46
- const querify = (input: Record<string, any>): URLSearchParams => {
47
- const output: URLSearchParams = new URLSearchParams();
48
- for (const [key, value] of Object.entries(input))
49
- if (key === undefined) continue;
50
- else if (Array.isArray(value))
51
- for (const elem of value) output.append(key, String(elem));
52
- else output.append(key, String(value));
53
- return output;
54
- };
55
-
56
- /**
57
- * @internal
58
- */
59
- const assert =
60
- <T>(closure: (data: T) => URLSearchParams) =>
61
- (data: T) => {
62
- try {
63
- return closure(data);
64
- } catch (exp) {
65
- if (typia.is<TypeGuardError>(exp))
66
- throw new InternalServerErrorException({
67
- path: exp.path,
68
- reason: exp.message,
69
- expected: exp.expected,
70
- value: exp.value,
71
- message: MESSAGE,
72
- });
73
- throw exp;
74
- }
75
- };
76
-
77
- /**
78
- * @internal
79
- */
80
- const is =
81
- <T>(closure: (data: T) => URLSearchParams | null) =>
82
- (data: T) => {
83
- const result: URLSearchParams | null = closure(data);
84
- if (result === null) throw new InternalServerErrorException(MESSAGE);
85
- return result;
86
- };
87
-
88
- /**
89
- * @internal
90
- */
91
- const validate =
92
- <T>(closure: (data: T) => IValidation<URLSearchParams>) =>
93
- (data: T) => {
94
- const result: IValidation<URLSearchParams> = closure(data);
95
- if (result.success === false)
96
- throw new InternalServerErrorException({
97
- errors: result.errors,
98
- message: MESSAGE,
99
- });
100
- return result.data;
101
- };
102
-
103
- /**
104
- * @internal
105
- */
106
- const MESSAGE = "Response body data is not following the promised type.";
1
+ import { InternalServerErrorException } from "@nestjs/common";
2
+ import typia, { IValidation, TypeGuardError } from "typia";
3
+
4
+ import { IResponseBodyQuerifier } from "../../options/IResponseBodyQuerifier";
5
+ import { NoTransformConfigureError } from "./NoTransformConfigureError";
6
+
7
+ /**
8
+ * @internal
9
+ */
10
+ export const get_path_and_querify =
11
+ (method: string) =>
12
+ (
13
+ ...args: any[]
14
+ ): [string | string[] | undefined, (input: any) => URLSearchParams] => {
15
+ const path: string | string[] | null | undefined =
16
+ args[0] === undefined ||
17
+ typeof args[0] === "string" ||
18
+ Array.isArray(args[0])
19
+ ? args[0]
20
+ : null;
21
+ const functor: IResponseBodyQuerifier<any> | undefined =
22
+ path === null ? args[0] : args[1];
23
+ return [path ?? undefined, take(method)(functor)];
24
+ };
25
+
26
+ /**
27
+ * @internal
28
+ */
29
+ const take =
30
+ (method: string) =>
31
+ <T>(functor?: IResponseBodyQuerifier<T> | null) => {
32
+ if (functor === undefined) throw NoTransformConfigureError(method);
33
+ else if (functor === null) return querify;
34
+ else if (functor.type === "stringify") return functor.stringify;
35
+ else if (functor.type === "assert") return assert(functor.assert);
36
+ else if (functor.type === "is") return is(functor.is);
37
+ else if (functor.type === "validate") return validate(functor.validate);
38
+ throw new Error(
39
+ `Error on nestia.core.${method}(): invalid typed stringify function.`,
40
+ );
41
+ };
42
+
43
+ /**
44
+ * @internal
45
+ */
46
+ const querify = (input: Record<string, any>): URLSearchParams => {
47
+ const output: URLSearchParams = new URLSearchParams();
48
+ for (const [key, value] of Object.entries(input))
49
+ if (key === undefined) continue;
50
+ else if (Array.isArray(value))
51
+ for (const elem of value) output.append(key, String(elem));
52
+ else output.append(key, String(value));
53
+ return output;
54
+ };
55
+
56
+ /**
57
+ * @internal
58
+ */
59
+ const assert =
60
+ <T>(closure: (data: T) => URLSearchParams) =>
61
+ (data: T) => {
62
+ try {
63
+ return closure(data);
64
+ } catch (exp) {
65
+ if (typia.is<TypeGuardError>(exp))
66
+ throw new InternalServerErrorException({
67
+ path: exp.path,
68
+ reason: exp.message,
69
+ expected: exp.expected,
70
+ value: exp.value,
71
+ message: MESSAGE,
72
+ });
73
+ throw exp;
74
+ }
75
+ };
76
+
77
+ /**
78
+ * @internal
79
+ */
80
+ const is =
81
+ <T>(closure: (data: T) => URLSearchParams | null) =>
82
+ (data: T) => {
83
+ const result: URLSearchParams | null = closure(data);
84
+ if (result === null) throw new InternalServerErrorException(MESSAGE);
85
+ return result;
86
+ };
87
+
88
+ /**
89
+ * @internal
90
+ */
91
+ const validate =
92
+ <T>(closure: (data: T) => IValidation<URLSearchParams>) =>
93
+ (data: T) => {
94
+ const result: IValidation<URLSearchParams> = closure(data);
95
+ if (result.success === false)
96
+ throw new InternalServerErrorException({
97
+ errors: result.errors,
98
+ message: MESSAGE,
99
+ });
100
+ return result.data;
101
+ };
102
+
103
+ /**
104
+ * @internal
105
+ */
106
+ const MESSAGE = "Response body data is not following the promised type.";
@@ -1,51 +1,51 @@
1
- import is_ts_node from "detect-ts-node";
2
-
3
- import { Creator } from "../../typings/Creator";
4
- import { SourceFinder } from "../../utils/SourceFinder";
5
-
6
- /**
7
- * @internal
8
- */
9
- export const load_controllers = async (
10
- path: string | string[] | { include: string[]; exclude?: string[] },
11
- ): Promise<Creator<object>[]> => {
12
- const sources: string[] = await SourceFinder.find({
13
- include: Array.isArray(path)
14
- ? path
15
- : typeof path === "object"
16
- ? path.include
17
- : [path],
18
- exclude:
19
- typeof path === "object" && !Array.isArray(path)
20
- ? path.exclude ?? []
21
- : [],
22
- filter:
23
- EXTENSION === "ts"
24
- ? (file) =>
25
- file.substring(file.length - 3) === ".ts" &&
26
- file.substring(file.length - 5) !== ".d.ts"
27
- : (flle) => flle.substring(flle.length - 3) === ".js",
28
- });
29
- return mount(sources);
30
- };
31
-
32
- /**
33
- * @internal
34
- */
35
- async function mount(sources: string[]): Promise<any[]> {
36
- const controllers: any[] = [];
37
- for (const file of sources) {
38
- const external: any = await import(file);
39
- for (const key in external) {
40
- const instance: Creator<object> = external[key];
41
- if (Reflect.getMetadata("path", instance) !== undefined)
42
- controllers.push(instance);
43
- }
44
- }
45
- return controllers;
46
- }
47
-
48
- /**
49
- * @internal
50
- */
51
- const EXTENSION = is_ts_node ? "ts" : "js";
1
+ import is_ts_node from "detect-ts-node";
2
+
3
+ import { Creator } from "../../typings/Creator";
4
+ import { SourceFinder } from "../../utils/SourceFinder";
5
+
6
+ /**
7
+ * @internal
8
+ */
9
+ export const load_controllers = async (
10
+ path: string | string[] | { include: string[]; exclude?: string[] },
11
+ ): Promise<Creator<object>[]> => {
12
+ const sources: string[] = await SourceFinder.find({
13
+ include: Array.isArray(path)
14
+ ? path
15
+ : typeof path === "object"
16
+ ? path.include
17
+ : [path],
18
+ exclude:
19
+ typeof path === "object" && !Array.isArray(path)
20
+ ? path.exclude ?? []
21
+ : [],
22
+ filter:
23
+ EXTENSION === "ts"
24
+ ? (file) =>
25
+ file.substring(file.length - 3) === ".ts" &&
26
+ file.substring(file.length - 5) !== ".d.ts"
27
+ : (flle) => flle.substring(flle.length - 3) === ".js",
28
+ });
29
+ return mount(sources);
30
+ };
31
+
32
+ /**
33
+ * @internal
34
+ */
35
+ async function mount(sources: string[]): Promise<any[]> {
36
+ const controllers: any[] = [];
37
+ for (const file of sources) {
38
+ const external: any = await import(file);
39
+ for (const key in external) {
40
+ const instance: Creator<object> = external[key];
41
+ if (Reflect.getMetadata("path", instance) !== undefined)
42
+ controllers.push(instance);
43
+ }
44
+ }
45
+ return controllers;
46
+ }
47
+
48
+ /**
49
+ * @internal
50
+ */
51
+ const EXTENSION = is_ts_node ? "ts" : "js";