@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,108 +1,109 @@
1
- import ts from "typescript";
2
- import { IJsDocTagInfo } from "typia";
3
-
4
- import { INestiaConfig } from "../../INestiaConfig";
5
- import { INestiaProject } from "../../structures/INestiaProject";
6
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
- import { FilePrinter } from "./FilePrinter";
8
- import { ImportDictionary } from "./ImportDictionary";
9
- import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
10
- import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
11
- import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
12
-
13
- export namespace SdkHttpRouteProgrammer {
14
- export const write =
15
- (project: INestiaProject) =>
16
- (importer: ImportDictionary) =>
17
- (route: ITypedHttpRoute): ts.Statement[] => [
18
- FilePrinter.description(
19
- SdkHttpFunctionProgrammer.write(project)(importer)(route),
20
- describe(project.config, route),
21
- ),
22
- SdkHttpNamespaceProgrammer.write(project)(importer)(route),
23
- ];
24
-
25
- const describe = (config: INestiaConfig, route: ITypedHttpRoute): string => {
26
- // MAIN DESCRIPTION
27
- const descriptionComments: string[] = route.description
28
- ? route.description.split("\n")
29
- : [];
30
- const tagComments: string[] = [];
31
-
32
- // PARAMETERS
33
- for (const p of SdkHttpParameterProgrammer.getSignificant(route, true)) {
34
- const description: string | undefined =
35
- p.description ??
36
- p.jsDocTags.find((tag) => tag.name === "description")?.text?.[0].text ??
37
- route.jsDocTags
38
- .find((tag) => tag.name === "param" && tag.text?.[0].text === p.name)
39
- ?.text?.map((e) => e.text)
40
- .join("")
41
- .substring(p.name.length);
42
- if (!description?.length) continue;
43
-
44
- const name: string = config.keyword === true ? `props.${p.name}` : p.name;
45
- tagComments.push(
46
- `@param ${name} ${description
47
- .split("\n")
48
- .map((str) => str.trim())
49
- .map((str, i) => {
50
- if (i === 0) return str;
51
- const rpad: number = p.name.length + 8;
52
- return `${" ".repeat(rpad)}${str}`;
53
- })
54
- .join("\n")}`,
55
- );
56
- }
57
-
58
- // COMMENT TAGS
59
- const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
60
- (tag) => tag.name !== "param",
61
- );
62
- if (tags.length !== 0) {
63
- const content: string[] = tags.map((t) =>
64
- t.text?.length
65
- ? `@${t.name} ${t.text
66
- .map((e) => e.text)
67
- .join("")
68
- .split("\n")
69
- .map((str) => str.trim())
70
- .map((str, i) => {
71
- if (i === 0) return str;
72
- return `${" ".repeat(t.name.length + 1)} ${str}`;
73
- })
74
- .join("\n")}`
75
- : `@${t.name}`,
76
- );
77
- tagComments.push(...new Set(content));
78
- }
79
-
80
- // EXCEPTIONS
81
- for (const [key, value] of Object.entries(route.exceptions)) {
82
- if (
83
- tagComments.some(
84
- (str) =>
85
- str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
86
- )
87
- )
88
- continue;
89
- tagComments.push(
90
- value.description?.length
91
- ? `@throws ${key} ${value.description.split("\n")[0]}`
92
- : `@throws ${key}`,
93
- );
94
- }
95
-
96
- // POSTFIX
97
- return [
98
- ...descriptionComments,
99
- ...(descriptionComments.length && tagComments.length ? [""] : []),
100
- ...tagComments,
101
- ...(descriptionComments.length && tagComments.length ? [""] : []),
102
- `@controller ${route.controller.class.name}.${route.name}`,
103
- `@path ${route.method} ${route.path}`,
104
- `@accessor api.functional.${route.accessor.join(".")}`,
105
- `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
106
- ].join("\n");
107
- };
108
- }
1
+ import ts from "typescript";
2
+ import { IJsDocTagInfo } from "typia";
3
+
4
+ import { INestiaConfig } from "../../INestiaConfig";
5
+ import { INestiaProject } from "../../structures/INestiaProject";
6
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
+ import { FilePrinter } from "./FilePrinter";
8
+ import { ImportDictionary } from "./ImportDictionary";
9
+ import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
10
+ import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
11
+ import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
12
+
13
+ export namespace SdkHttpRouteProgrammer {
14
+ export const write =
15
+ (project: INestiaProject) =>
16
+ (importer: ImportDictionary) =>
17
+ (route: ITypedHttpRoute): ts.Statement[] => [
18
+ FilePrinter.description(
19
+ SdkHttpFunctionProgrammer.write(project)(importer)(route),
20
+ describe(project.config, route),
21
+ ),
22
+ SdkHttpNamespaceProgrammer.write(project)(importer)(route),
23
+ ];
24
+
25
+ const describe = (config: INestiaConfig, route: ITypedHttpRoute): string => {
26
+ // MAIN DESCRIPTION
27
+ const descriptionComments: string[] = route.description
28
+ ? route.description.split("\n")
29
+ : [];
30
+ const tagComments: string[] = [];
31
+
32
+ // PARAMETERS
33
+ for (const p of SdkHttpParameterProgrammer.getSignificant(route, true)) {
34
+ const description: string | undefined =
35
+ p.description ??
36
+ p.jsDocTags.find((tag) => tag.name === "description")?.text?.[0]
37
+ ?.text ??
38
+ route.jsDocTags
39
+ .find((tag) => tag.name === "param" && tag.text?.[0]?.text === p.name)
40
+ ?.text?.map((e) => e.text)
41
+ .join("")
42
+ .substring(p.name.length);
43
+ if (!description?.length) continue;
44
+
45
+ const name: string = config.keyword === true ? `props.${p.name}` : p.name;
46
+ tagComments.push(
47
+ `@param ${name} ${description
48
+ .split("\n")
49
+ .map((str) => str.trim())
50
+ .map((str, i) => {
51
+ if (i === 0) return str;
52
+ const rpad: number = p.name.length + 8;
53
+ return `${" ".repeat(rpad)}${str}`;
54
+ })
55
+ .join("\n")}`,
56
+ );
57
+ }
58
+
59
+ // COMMENT TAGS
60
+ const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
61
+ (tag) => tag.name !== "param",
62
+ );
63
+ if (tags.length !== 0) {
64
+ const content: string[] = tags.map((t) =>
65
+ t.text?.length
66
+ ? `@${t.name} ${t.text
67
+ .map((e) => e.text)
68
+ .join("")
69
+ .split("\n")
70
+ .map((str) => str.trim())
71
+ .map((str, i) => {
72
+ if (i === 0) return str;
73
+ return `${" ".repeat(t.name.length + 1)} ${str}`;
74
+ })
75
+ .join("\n")}`
76
+ : `@${t.name}`,
77
+ );
78
+ tagComments.push(...new Set(content));
79
+ }
80
+
81
+ // EXCEPTIONS
82
+ for (const [key, value] of Object.entries(route.exceptions)) {
83
+ if (
84
+ tagComments.some(
85
+ (str) =>
86
+ str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
87
+ )
88
+ )
89
+ continue;
90
+ tagComments.push(
91
+ value.description?.length
92
+ ? `@throws ${key} ${value.description.split("\n")[0]}`
93
+ : `@throws ${key}`,
94
+ );
95
+ }
96
+
97
+ // POSTFIX
98
+ return [
99
+ ...descriptionComments,
100
+ ...(descriptionComments.length && tagComments.length ? [""] : []),
101
+ ...tagComments,
102
+ ...(descriptionComments.length && tagComments.length ? [""] : []),
103
+ `@controller ${route.controller.class.name}.${route.name}`,
104
+ `@path ${route.method} ${route.path}`,
105
+ `@accessor api.functional.${route.accessor.join(".")}`,
106
+ `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
107
+ ].join("\n");
108
+ };
109
+ }