@nestia/sdk 10.0.2 → 11.0.0-dev.20260312

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 (151) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +93 -93
  3. package/assets/bundle/api/HttpError.ts +1 -1
  4. package/assets/bundle/api/IConnection.ts +1 -1
  5. package/assets/bundle/api/Primitive.ts +1 -1
  6. package/assets/bundle/api/Resolved.ts +1 -1
  7. package/assets/bundle/api/index.ts +4 -4
  8. package/assets/bundle/api/module.ts +6 -6
  9. package/assets/bundle/distribute/README.md +37 -37
  10. package/assets/bundle/distribute/package.json +28 -28
  11. package/assets/bundle/distribute/tsconfig.json +109 -109
  12. package/assets/bundle/e2e/index.ts +42 -42
  13. package/assets/config/nestia.config.ts +97 -97
  14. package/lib/INestiaConfig.d.ts +3 -3
  15. package/lib/NestiaSdkApplication.js.map +1 -1
  16. package/lib/NestiaSwaggerComposer.d.ts +3 -2
  17. package/lib/NestiaSwaggerComposer.js +5 -6
  18. package/lib/NestiaSwaggerComposer.js.map +1 -1
  19. package/lib/analyses/AccessorAnalyzer.js +2 -2
  20. package/lib/analyses/AccessorAnalyzer.js.map +1 -1
  21. package/lib/analyses/DtoAnalyzer.js.map +1 -1
  22. package/lib/analyses/ImportAnalyzer.js.map +1 -1
  23. package/lib/analyses/ReflectHttpOperationAnalyzer.js +3 -3
  24. package/lib/analyses/ReflectHttpOperationAnalyzer.js.map +1 -1
  25. package/lib/analyses/ReflectHttpOperationExceptionAnalyzer.js +4 -2
  26. package/lib/analyses/ReflectHttpOperationExceptionAnalyzer.js.map +1 -1
  27. package/lib/analyses/ReflectHttpOperationParameterAnalyzer.js +7 -11
  28. package/lib/analyses/ReflectHttpOperationParameterAnalyzer.js.map +1 -1
  29. package/lib/analyses/ReflectHttpOperationResponseAnalyzer.js +6 -6
  30. package/lib/analyses/ReflectHttpOperationResponseAnalyzer.js.map +1 -1
  31. package/lib/analyses/TypedHttpRouteAnalyzer.d.ts +1 -1
  32. package/lib/analyses/TypedHttpRouteAnalyzer.js +6 -8
  33. package/lib/analyses/TypedHttpRouteAnalyzer.js.map +1 -1
  34. package/lib/executable/internal/NestiaConfigLoader.js +111 -52
  35. package/lib/executable/internal/NestiaConfigLoader.js.map +1 -1
  36. package/lib/executable/internal/NestiaSdkCommand.js.map +1 -1
  37. package/lib/executable/sdk.js +0 -0
  38. package/lib/generates/SwaggerGenerator.d.ts +1 -1
  39. package/lib/generates/SwaggerGenerator.js +11 -12
  40. package/lib/generates/SwaggerGenerator.js.map +1 -1
  41. package/lib/generates/internal/E2eFileProgrammer.js +8 -9
  42. package/lib/generates/internal/E2eFileProgrammer.js.map +1 -1
  43. package/lib/generates/internal/SdkAliasCollection.d.ts +2 -2
  44. package/lib/generates/internal/SdkAliasCollection.js +2 -2
  45. package/lib/generates/internal/SdkAliasCollection.js.map +1 -1
  46. package/lib/generates/internal/SdkDistributionComposer.js +1 -1
  47. package/lib/generates/internal/SdkHttpCloneProgrammer.js.map +1 -1
  48. package/lib/generates/internal/SdkHttpCloneReferencer.js.map +1 -1
  49. package/lib/generates/internal/SdkHttpFunctionProgrammer.js +11 -12
  50. package/lib/generates/internal/SdkHttpFunctionProgrammer.js.map +1 -1
  51. package/lib/generates/internal/SdkHttpNamespaceProgrammer.js +13 -16
  52. package/lib/generates/internal/SdkHttpNamespaceProgrammer.js.map +1 -1
  53. package/lib/generates/internal/SdkHttpRouteProgrammer.js +4 -4
  54. package/lib/generates/internal/SdkHttpRouteProgrammer.js.map +1 -1
  55. package/lib/generates/internal/SdkHttpSimulationProgrammer.js +12 -16
  56. package/lib/generates/internal/SdkHttpSimulationProgrammer.js.map +1 -1
  57. package/lib/generates/internal/SdkImportWizard.js +2 -2
  58. package/lib/generates/internal/SdkImportWizard.js.map +1 -1
  59. package/lib/generates/internal/SdkTypeProgrammer.d.ts +2 -3
  60. package/lib/generates/internal/SdkTypeProgrammer.js +6 -7
  61. package/lib/generates/internal/SdkTypeProgrammer.js.map +1 -1
  62. package/lib/generates/internal/SdkTypeTagProgrammer.d.ts +1 -1
  63. package/lib/generates/internal/SdkTypeTagProgrammer.js +11 -11
  64. package/lib/generates/internal/SdkTypeTagProgrammer.js.map +1 -1
  65. package/lib/generates/internal/SdkWebSocketNamespaceProgrammer.js +6 -8
  66. package/lib/generates/internal/SdkWebSocketNamespaceProgrammer.js.map +1 -1
  67. package/lib/generates/internal/SdkWebSocketRouteProgrammer.js +2 -2
  68. package/lib/generates/internal/SdkWebSocketRouteProgrammer.js.map +1 -1
  69. package/lib/generates/internal/SwaggerOperationComposer.d.ts +3 -3
  70. package/lib/generates/internal/SwaggerOperationComposer.js.map +1 -1
  71. package/lib/generates/internal/SwaggerOperationParameterComposer.d.ts +1 -1
  72. package/lib/generates/internal/SwaggerOperationParameterComposer.js +10 -8
  73. package/lib/generates/internal/SwaggerOperationParameterComposer.js.map +1 -1
  74. package/lib/generates/internal/SwaggerOperationResponseComposer.d.ts +3 -3
  75. package/lib/generates/internal/SwaggerOperationResponseComposer.js.map +1 -1
  76. package/lib/module.d.ts +1 -0
  77. package/lib/module.js +1 -0
  78. package/lib/module.js.map +1 -1
  79. package/lib/structures/IReflectHttpOperationException.d.ts +3 -4
  80. package/lib/structures/IReflectHttpOperationParameter.d.ts +3 -5
  81. package/lib/structures/IReflectHttpOperationSuccess.d.ts +3 -4
  82. package/lib/structures/ITypedApplication.d.ts +1 -1
  83. package/lib/structures/ITypedHttpRouteException.d.ts +2 -2
  84. package/lib/structures/ITypedHttpRouteParameter.d.ts +2 -2
  85. package/lib/structures/ITypedHttpRouteSuccess.d.ts +2 -2
  86. package/lib/transformers/IOperationMetadata.d.ts +2 -4
  87. package/lib/transformers/ISdkOperationTransformerContext.d.ts +1 -1
  88. package/lib/transformers/SdkOperationProgrammer.js +8 -10
  89. package/lib/transformers/SdkOperationProgrammer.js.map +1 -1
  90. package/lib/transformers/SdkOperationTransformer.js +6 -8
  91. package/lib/transformers/SdkOperationTransformer.js.map +1 -1
  92. package/lib/transformers/TextPlainValidator.d.ts +2 -2
  93. package/lib/transformers/TextPlainValidator.js.map +1 -1
  94. package/lib/utils/MetadataUtil.d.ts +2 -2
  95. package/lib/utils/MetadataUtil.js.map +1 -1
  96. package/lib/validators/HttpHeadersValidator.d.ts +2 -3
  97. package/lib/validators/HttpHeadersValidator.js +2 -2
  98. package/lib/validators/HttpHeadersValidator.js.map +1 -1
  99. package/lib/validators/HttpQueryValidator.d.ts +2 -3
  100. package/lib/validators/HttpQueryValidator.js +2 -2
  101. package/lib/validators/HttpQueryValidator.js.map +1 -1
  102. package/package.json +44 -30
  103. package/src/INestiaConfig.ts +267 -267
  104. package/src/NestiaSdkApplication.ts +307 -307
  105. package/src/NestiaSwaggerComposer.ts +143 -138
  106. package/src/analyses/AccessorAnalyzer.ts +67 -67
  107. package/src/analyses/DtoAnalyzer.ts +260 -260
  108. package/src/analyses/ImportAnalyzer.ts +126 -126
  109. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  110. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +72 -71
  111. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +350 -348
  112. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +126 -127
  113. package/src/analyses/TypedHttpRouteAnalyzer.ts +208 -204
  114. package/src/executable/internal/NestiaConfigLoader.ts +85 -78
  115. package/src/executable/internal/NestiaSdkCommand.ts +107 -103
  116. package/src/generates/SwaggerGenerator.ts +291 -284
  117. package/src/generates/internal/E2eFileProgrammer.ts +196 -197
  118. package/src/generates/internal/FilePrinter.ts +64 -64
  119. package/src/generates/internal/ImportDictionary.ts +192 -192
  120. package/src/generates/internal/SdkAliasCollection.ts +260 -261
  121. package/src/generates/internal/SdkFileProgrammer.ts +110 -110
  122. package/src/generates/internal/SdkHttpCloneProgrammer.ts +126 -124
  123. package/src/generates/internal/SdkHttpCloneReferencer.ts +77 -77
  124. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +278 -279
  125. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +502 -500
  126. package/src/generates/internal/SdkHttpRouteProgrammer.ts +109 -108
  127. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +312 -310
  128. package/src/generates/internal/SdkImportWizard.ts +62 -62
  129. package/src/generates/internal/SdkTypeProgrammer.ts +388 -385
  130. package/src/generates/internal/SdkTypeTagProgrammer.ts +114 -104
  131. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +379 -381
  132. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +302 -302
  133. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  134. package/src/generates/internal/SwaggerOperationParameterComposer.ts +161 -162
  135. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  136. package/src/module.ts +4 -3
  137. package/src/structures/IReflectHttpOperationException.ts +18 -19
  138. package/src/structures/IReflectHttpOperationParameter.ts +79 -77
  139. package/src/structures/IReflectHttpOperationSuccess.ts +21 -22
  140. package/src/structures/ITypedApplication.ts +11 -11
  141. package/src/structures/ITypedHttpRouteException.ts +15 -15
  142. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  143. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  144. package/src/transformers/IOperationMetadata.ts +46 -44
  145. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  146. package/src/transformers/SdkOperationProgrammer.ts +240 -238
  147. package/src/transformers/SdkOperationTransformer.ts +248 -252
  148. package/src/transformers/TextPlainValidator.ts +17 -17
  149. package/src/utils/MetadataUtil.ts +26 -26
  150. package/src/validators/HttpHeadersValidator.ts +36 -34
  151. package/src/validators/HttpQueryValidator.ts +36 -34
@@ -1,127 +1,126 @@
1
- import { SwaggerExample } from "@nestia/core";
2
- import {
3
- HEADERS_METADATA,
4
- HTTP_CODE_METADATA,
5
- INTERCEPTORS_METADATA,
6
- } from "@nestjs/common/constants";
7
- import typia from "typia";
8
- import { JsonMetadataFactory } from "typia/lib/factories/JsonMetadataFactory";
9
- import { HttpQueryProgrammer } from "typia/lib/programmers/http/HttpQueryProgrammer";
10
-
11
- import { IReflectController } from "../structures/IReflectController";
12
- import { IReflectHttpOperationSuccess } from "../structures/IReflectHttpOperationSuccess";
13
- import { IReflectOperationError } from "../structures/IReflectOperationError";
14
- import { IOperationMetadata } from "../transformers/IOperationMetadata";
15
- import { TextPlainValidator } from "../transformers/TextPlainValidator";
16
-
17
- export namespace ReflectHttpOperationResponseAnalyzer {
18
- export interface IContext {
19
- controller: IReflectController;
20
- function: Function;
21
- functionName: string;
22
- httpMethod: string;
23
- metadata: IOperationMetadata;
24
- errors: IReflectOperationError[];
25
- }
26
-
27
- export const analyze = (
28
- ctx: IContext,
29
- ): IReflectHttpOperationSuccess | null => {
30
- const errors: Array<string | IOperationMetadata.IError> = [];
31
- const report = () => {
32
- ctx.errors.push({
33
- file: ctx.controller.file,
34
- class: ctx.controller.class.name,
35
- function: ctx.functionName,
36
- from: "return",
37
- contents: errors,
38
- });
39
- return null;
40
- };
41
-
42
- const encrypted: boolean = hasInterceptor({
43
- name: "EncryptedRouteInterceptor",
44
- function: ctx.function,
45
- });
46
- const contentType: string | null = encrypted
47
- ? "text/plain"
48
- : hasInterceptor({
49
- name: "TypedQueryRouteInterceptor",
50
- function: ctx.function,
51
- })
52
- ? "application/x-www-form-urlencoded"
53
- : (Reflect.getMetadata(HEADERS_METADATA, ctx.function)?.find(
54
- (h: Record<string, string>) =>
55
- typeof h?.name === "string" &&
56
- typeof h?.value === "string" &&
57
- h.name.toLowerCase() === "content-type",
58
- )?.value ??
59
- Reflect.getMetadata("swagger/apiProduces", ctx.function)?.[0] ??
60
- (ctx.httpMethod === "HEAD" ? null : "application/json"));
61
-
62
- const schema =
63
- contentType === "application/json"
64
- ? ctx.metadata.success.primitive
65
- : ctx.metadata.success.resolved;
66
- if (schema.success === false) errors.push(...schema.errors);
67
- if (ctx.httpMethod === "HEAD" && contentType !== null)
68
- errors.push(`HEAD method must not have a content type.`);
69
- if (
70
- typia.is<IReflectHttpOperationSuccess["contentType"]>(contentType) ===
71
- false
72
- )
73
- errors.push(
74
- `@nestia/sdk does not support ${JSON.stringify(contentType)} content type.`,
75
- );
76
-
77
- if (errors.length) return report();
78
- else if (
79
- ctx.metadata.success.type === null ||
80
- schema.success === false ||
81
- !typia.is<IReflectHttpOperationSuccess["contentType"]>(contentType)
82
- )
83
- return null;
84
-
85
- const example: SwaggerExample.IData<any> | undefined = Reflect.getMetadata(
86
- "nestia/SwaggerExample/Response",
87
- ctx.function,
88
- );
89
- return {
90
- contentType: contentType,
91
- encrypted,
92
- status:
93
- getStatus(ctx.function) ?? (ctx.httpMethod === "POST" ? 201 : 200),
94
- type: ctx.metadata.success.type,
95
- ...schema.data,
96
- validate:
97
- contentType === "application/json" || encrypted === true
98
- ? JsonMetadataFactory.validate
99
- : contentType === "application/x-www-form-urlencoded"
100
- ? HttpQueryProgrammer.validate
101
- : contentType === "text/plain"
102
- ? TextPlainValidator.validate
103
- : (meta) =>
104
- meta.size()
105
- ? ["HEAD method must not have any return value."]
106
- : [],
107
- example: example?.example,
108
- examples: example?.examples,
109
- };
110
- };
111
-
112
- const getStatus = (func: Function): number | null => {
113
- const text = Reflect.getMetadata(HTTP_CODE_METADATA, func);
114
- if (text === undefined) return null;
115
- const value: number = Number(text);
116
- return isNaN(value) ? null : value;
117
- };
118
-
119
- const hasInterceptor = (props: {
120
- name: string;
121
- function: Function;
122
- }): boolean => {
123
- const meta = Reflect.getMetadata(INTERCEPTORS_METADATA, props.function);
124
- if (Array.isArray(meta) === false) return false;
125
- return meta.some((elem) => elem?.constructor?.name === props.name);
126
- };
127
- }
1
+ import { SwaggerExample } from "@nestia/core";
2
+ import {
3
+ HEADERS_METADATA,
4
+ HTTP_CODE_METADATA,
5
+ INTERCEPTORS_METADATA,
6
+ } from "@nestjs/common/constants";
7
+ import { HttpQueryProgrammer, JsonMetadataFactory } from "@typia/core";
8
+ import typia from "typia";
9
+
10
+ import { IReflectController } from "../structures/IReflectController";
11
+ import { IReflectHttpOperationSuccess } from "../structures/IReflectHttpOperationSuccess";
12
+ import { IReflectOperationError } from "../structures/IReflectOperationError";
13
+ import { IOperationMetadata } from "../transformers/IOperationMetadata";
14
+ import { TextPlainValidator } from "../transformers/TextPlainValidator";
15
+
16
+ export namespace ReflectHttpOperationResponseAnalyzer {
17
+ export interface IContext {
18
+ controller: IReflectController;
19
+ function: Function;
20
+ functionName: string;
21
+ httpMethod: string;
22
+ metadata: IOperationMetadata;
23
+ errors: IReflectOperationError[];
24
+ }
25
+
26
+ export const analyze = (
27
+ ctx: IContext,
28
+ ): IReflectHttpOperationSuccess | null => {
29
+ const errors: Array<string | IOperationMetadata.IError> = [];
30
+ const report = () => {
31
+ ctx.errors.push({
32
+ file: ctx.controller.file,
33
+ class: ctx.controller.class.name,
34
+ function: ctx.functionName,
35
+ from: "return",
36
+ contents: errors,
37
+ });
38
+ return null;
39
+ };
40
+
41
+ const encrypted: boolean = hasInterceptor({
42
+ name: "EncryptedRouteInterceptor",
43
+ function: ctx.function,
44
+ });
45
+ const contentType: string | null = encrypted
46
+ ? "text/plain"
47
+ : hasInterceptor({
48
+ name: "TypedQueryRouteInterceptor",
49
+ function: ctx.function,
50
+ })
51
+ ? "application/x-www-form-urlencoded"
52
+ : (Reflect.getMetadata(HEADERS_METADATA, ctx.function)?.find(
53
+ (h: Record<string, string>) =>
54
+ typeof h?.name === "string" &&
55
+ typeof h?.value === "string" &&
56
+ h.name.toLowerCase() === "content-type",
57
+ )?.value ??
58
+ Reflect.getMetadata("swagger/apiProduces", ctx.function)?.[0] ??
59
+ (ctx.httpMethod === "HEAD" ? null : "application/json"));
60
+
61
+ const schema =
62
+ contentType === "application/json"
63
+ ? ctx.metadata.success.primitive
64
+ : ctx.metadata.success.resolved;
65
+ if (schema.success === false) errors.push(...schema.errors);
66
+ if (ctx.httpMethod === "HEAD" && contentType !== null)
67
+ errors.push(`HEAD method must not have a content type.`);
68
+ if (
69
+ typia.is<IReflectHttpOperationSuccess["contentType"]>(contentType) ===
70
+ false
71
+ )
72
+ errors.push(
73
+ `@nestia/sdk does not support ${JSON.stringify(contentType)} content type.`,
74
+ );
75
+
76
+ if (errors.length) return report();
77
+ else if (
78
+ ctx.metadata.success.type === null ||
79
+ schema.success === false ||
80
+ !typia.is<IReflectHttpOperationSuccess["contentType"]>(contentType)
81
+ )
82
+ return null;
83
+
84
+ const example: SwaggerExample.IData<any> | undefined = Reflect.getMetadata(
85
+ "nestia/SwaggerExample/Response",
86
+ ctx.function,
87
+ );
88
+ return {
89
+ contentType,
90
+ encrypted,
91
+ status:
92
+ getStatus(ctx.function) ?? (ctx.httpMethod === "POST" ? 201 : 200),
93
+ type: ctx.metadata.success.type,
94
+ ...schema.data,
95
+ validate:
96
+ contentType === "application/json" || encrypted === true
97
+ ? JsonMetadataFactory.validate
98
+ : contentType === "application/x-www-form-urlencoded"
99
+ ? HttpQueryProgrammer.validate
100
+ : contentType === "text/plain"
101
+ ? TextPlainValidator.validate
102
+ : (schema) =>
103
+ schema.size()
104
+ ? ["HEAD method must not have any return value."]
105
+ : [],
106
+ example: example?.example,
107
+ examples: example?.examples,
108
+ };
109
+ };
110
+
111
+ const getStatus = (func: Function): number | null => {
112
+ const text = Reflect.getMetadata(HTTP_CODE_METADATA, func);
113
+ if (text === undefined) return null;
114
+ const value: number = Number(text);
115
+ return isNaN(value) ? null : value;
116
+ };
117
+
118
+ const hasInterceptor = (props: {
119
+ name: string;
120
+ function: Function;
121
+ }): boolean => {
122
+ const meta = Reflect.getMetadata(INTERCEPTORS_METADATA, props.function);
123
+ if (Array.isArray(meta) === false) return false;
124
+ return meta.some((elem) => elem?.constructor?.name === props.name);
125
+ };
126
+ }