@nestia/sdk 4.4.2 → 4.5.0-dev.20241218

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 (123) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +87 -87
  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/analyses/AccessorAnalyzer.js +11 -11
  15. package/lib/analyses/AccessorAnalyzer.js.map +1 -1
  16. package/lib/analyses/TypedHttpRouteAnalyzer.js +1 -1
  17. package/lib/analyses/TypedHttpRouteAnalyzer.js.map +1 -1
  18. package/lib/analyses/TypedWebSocketRouteAnalyzer.js +1 -1
  19. package/lib/analyses/TypedWebSocketRouteAnalyzer.js.map +1 -1
  20. package/lib/executable/internal/NestiaConfigLoader.js +4 -4
  21. package/lib/executable/sdk.js +12 -12
  22. package/lib/generates/internal/E2eFileProgrammer.js +2 -2
  23. package/lib/generates/internal/E2eFileProgrammer.js.map +1 -1
  24. package/lib/generates/internal/SdkFileProgrammer.js +1 -1
  25. package/lib/generates/internal/SdkFileProgrammer.js.map +1 -1
  26. package/lib/generates/internal/SwaggerOperationComposer.js +2 -2
  27. package/lib/generates/internal/SwaggerOperationComposer.js.map +1 -1
  28. package/lib/structures/ITypedHttpRoute.d.ts +1 -1
  29. package/lib/structures/ITypedWebSocketRoute.d.ts +1 -1
  30. package/package.json +8 -8
  31. package/src/INestiaConfig.ts +271 -271
  32. package/src/NestiaSdkApplication.ts +307 -307
  33. package/src/NestiaSwaggerComposer.ts +138 -138
  34. package/src/analyses/AccessorAnalyzer.ts +67 -67
  35. package/src/analyses/ConfigAnalyzer.ts +155 -155
  36. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  37. package/src/analyses/GenericAnalyzer.ts +49 -49
  38. package/src/analyses/ImportAnalyzer.ts +171 -171
  39. package/src/analyses/PathAnalyzer.ts +69 -69
  40. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  41. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  42. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  43. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  44. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  45. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  46. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  47. package/src/analyses/SecurityAnalyzer.ts +25 -25
  48. package/src/analyses/TypedHttpRouteAnalyzer.ts +186 -186
  49. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +18 -18
  50. package/src/decorators/OperationMetadata.ts +15 -15
  51. package/src/executable/internal/CommandParser.ts +15 -15
  52. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  53. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  54. package/src/executable/sdk.ts +75 -75
  55. package/src/generates/CloneGenerator.ts +66 -66
  56. package/src/generates/E2eGenerator.ts +32 -32
  57. package/src/generates/SdkGenerator.ts +159 -159
  58. package/src/generates/SwaggerGenerator.ts +292 -292
  59. package/src/generates/internal/E2eFileProgrammer.ts +183 -183
  60. package/src/generates/internal/FilePrinter.ts +53 -53
  61. package/src/generates/internal/ImportDictionary.ts +147 -147
  62. package/src/generates/internal/SdkAliasCollection.ts +185 -185
  63. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  64. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  65. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  66. package/src/generates/internal/SdkHttpCloneReferencer.ts +71 -71
  67. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +301 -301
  68. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +529 -529
  69. package/src/generates/internal/SdkHttpRouteProgrammer.ts +117 -117
  70. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +362 -362
  71. package/src/generates/internal/SdkImportWizard.ts +55 -55
  72. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  73. package/src/generates/internal/SdkTypeProgrammer.ts +377 -377
  74. package/src/generates/internal/SdkTypeTagProgrammer.ts +120 -120
  75. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +363 -363
  76. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +265 -265
  77. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  78. package/src/generates/internal/SwaggerOperationComposer.ts +119 -117
  79. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  80. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  81. package/src/index.ts +4 -4
  82. package/src/module.ts +3 -3
  83. package/src/structures/INestiaProject.ts +13 -13
  84. package/src/structures/INestiaSdkInput.ts +20 -20
  85. package/src/structures/IReflectApplication.ts +8 -8
  86. package/src/structures/IReflectController.ts +15 -15
  87. package/src/structures/IReflectHttpOperation.ts +26 -26
  88. package/src/structures/IReflectHttpOperationException.ts +19 -19
  89. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  90. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  91. package/src/structures/IReflectOperationError.ts +26 -26
  92. package/src/structures/IReflectType.ts +4 -4
  93. package/src/structures/IReflectTypeImport.ts +4 -4
  94. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  95. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  96. package/src/structures/ITypedApplication.ts +11 -11
  97. package/src/structures/ITypedHttpRoute.ts +30 -30
  98. package/src/structures/ITypedHttpRouteException.ts +15 -15
  99. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  100. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  101. package/src/structures/ITypedWebSocketRoute.ts +20 -20
  102. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  103. package/src/structures/MethodType.ts +5 -5
  104. package/src/structures/ParamCategory.ts +1 -1
  105. package/src/structures/TypeEntry.ts +22 -22
  106. package/src/transform.ts +9 -9
  107. package/src/transformers/IOperationMetadata.ts +44 -44
  108. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  109. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  110. package/src/transformers/SdkOperationTransformer.ts +253 -253
  111. package/src/transformers/TextPlainValidator.ts +17 -17
  112. package/src/typings/get-function-location.d.ts +7 -7
  113. package/src/utils/ArrayUtil.ts +26 -26
  114. package/src/utils/FileRetriever.ts +22 -22
  115. package/src/utils/MapUtil.ts +14 -14
  116. package/src/utils/MetadataUtil.ts +26 -26
  117. package/src/utils/PathUtil.ts +10 -10
  118. package/src/utils/SourceFinder.ts +66 -66
  119. package/src/utils/StringUtil.ts +17 -17
  120. package/src/utils/StripEnums.ts +5 -5
  121. package/src/utils/VersioningStrategy.ts +28 -28
  122. package/src/validators/HttpHeadersValidator.ts +34 -34
  123. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,117 +1,117 @@
1
- import ts from "typescript";
2
- import { IJsDocTagInfo } from "typia";
3
-
4
- import { INestiaProject } from "../../structures/INestiaProject";
5
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
6
- import { FilePrinter } from "./FilePrinter";
7
- import { ImportDictionary } from "./ImportDictionary";
8
- import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
9
- import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
10
-
11
- export namespace SdkHttpRouteProgrammer {
12
- export const write =
13
- (project: INestiaProject) =>
14
- (importer: ImportDictionary) =>
15
- (route: ITypedHttpRoute): ts.Statement[] => {
16
- const props = {
17
- headers: route.parameters
18
- .filter((p) => p.category === "headers")
19
- .find((p) => p.field === null),
20
- query: route.parameters
21
- .filter((p) => p.category === "query")
22
- .find((p) => p.field === null),
23
- input: route.parameters.find((p) => p.category === "body"),
24
- };
25
- return [
26
- FilePrinter.description(
27
- SdkHttpFunctionProgrammer.write(project)(importer)(route, props),
28
- describe(route),
29
- ),
30
- SdkHttpNamespaceProgrammer.write(project)(importer)(route, props),
31
- ];
32
- };
33
-
34
- const describe = (route: ITypedHttpRoute): string => {
35
- // MAIN DESCRIPTION
36
- const descriptionComments: string[] = route.description
37
- ? route.description.split("\n")
38
- : [];
39
- const tagComments: string[] = [];
40
-
41
- // PARMAETERS
42
- for (const p of route.parameters) {
43
- if (p.category === "headers") continue;
44
-
45
- const description: string | undefined =
46
- p.description ??
47
- p.jsDocTags.find((tag) => tag.name === "description")?.text?.[0].text ??
48
- route.jsDocTags
49
- .find((tag) => tag.name === "param" && tag.text?.[0].text === p.name)
50
- ?.text?.map((e) => e.text)
51
- .join("")
52
- .substring(p.name.length);
53
- if (!description?.length) continue;
54
-
55
- tagComments.push(
56
- `@param ${p.name} ${description
57
- .split("\n")
58
- .map((str) => str.trim())
59
- .map((str, i) => {
60
- if (i === 0) return str;
61
- const rpad: number = p.name.length + 8;
62
- return `${" ".repeat(rpad)}${str}`;
63
- })
64
- .join("\n")}`,
65
- );
66
- }
67
-
68
- // COMMENT TAGS
69
- const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
70
- (tag) => tag.name !== "param",
71
- );
72
- if (tags.length !== 0) {
73
- const content: string[] = tags.map((t) =>
74
- t.text?.length
75
- ? `@${t.name} ${t.text
76
- .map((e) => e.text)
77
- .join("")
78
- .split("\n")
79
- .map((str) => str.trim())
80
- .map((str, i) => {
81
- if (i === 0) return str;
82
- return `${" ".repeat(t.name.length + 1)} ${str}`;
83
- })
84
- .join("\n")}`
85
- : `@${t.name}`,
86
- );
87
- tagComments.push(...new Set(content));
88
- }
89
-
90
- // EXCEPTIONS
91
- for (const [key, value] of Object.entries(route.exceptions)) {
92
- if (
93
- tagComments.some(
94
- (str) =>
95
- str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
96
- )
97
- )
98
- continue;
99
- tagComments.push(
100
- value.description?.length
101
- ? `@throws ${key} ${value.description.split("\n")[0]}`
102
- : `@throws ${key}`,
103
- );
104
- }
105
-
106
- // POSTFIX
107
- return [
108
- ...descriptionComments,
109
- ...(descriptionComments.length && tagComments.length ? [""] : []),
110
- ...tagComments,
111
- ...(descriptionComments.length && tagComments.length ? [""] : []),
112
- `@controller ${route.controller.class.name}.${route.name}`,
113
- `@path ${route.method} ${route.path}`,
114
- `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
115
- ].join("\n");
116
- };
117
- }
1
+ import ts from "typescript";
2
+ import { IJsDocTagInfo } from "typia";
3
+
4
+ import { INestiaProject } from "../../structures/INestiaProject";
5
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
6
+ import { FilePrinter } from "./FilePrinter";
7
+ import { ImportDictionary } from "./ImportDictionary";
8
+ import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
9
+ import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
10
+
11
+ export namespace SdkHttpRouteProgrammer {
12
+ export const write =
13
+ (project: INestiaProject) =>
14
+ (importer: ImportDictionary) =>
15
+ (route: ITypedHttpRoute): ts.Statement[] => {
16
+ const props = {
17
+ headers: route.parameters
18
+ .filter((p) => p.category === "headers")
19
+ .find((p) => p.field === null),
20
+ query: route.parameters
21
+ .filter((p) => p.category === "query")
22
+ .find((p) => p.field === null),
23
+ input: route.parameters.find((p) => p.category === "body"),
24
+ };
25
+ return [
26
+ FilePrinter.description(
27
+ SdkHttpFunctionProgrammer.write(project)(importer)(route, props),
28
+ describe(route),
29
+ ),
30
+ SdkHttpNamespaceProgrammer.write(project)(importer)(route, props),
31
+ ];
32
+ };
33
+
34
+ const describe = (route: ITypedHttpRoute): string => {
35
+ // MAIN DESCRIPTION
36
+ const descriptionComments: string[] = route.description
37
+ ? route.description.split("\n")
38
+ : [];
39
+ const tagComments: string[] = [];
40
+
41
+ // PARMAETERS
42
+ for (const p of route.parameters) {
43
+ if (p.category === "headers") continue;
44
+
45
+ const description: string | undefined =
46
+ p.description ??
47
+ p.jsDocTags.find((tag) => tag.name === "description")?.text?.[0].text ??
48
+ route.jsDocTags
49
+ .find((tag) => tag.name === "param" && tag.text?.[0].text === p.name)
50
+ ?.text?.map((e) => e.text)
51
+ .join("")
52
+ .substring(p.name.length);
53
+ if (!description?.length) continue;
54
+
55
+ tagComments.push(
56
+ `@param ${p.name} ${description
57
+ .split("\n")
58
+ .map((str) => str.trim())
59
+ .map((str, i) => {
60
+ if (i === 0) return str;
61
+ const rpad: number = p.name.length + 8;
62
+ return `${" ".repeat(rpad)}${str}`;
63
+ })
64
+ .join("\n")}`,
65
+ );
66
+ }
67
+
68
+ // COMMENT TAGS
69
+ const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
70
+ (tag) => tag.name !== "param",
71
+ );
72
+ if (tags.length !== 0) {
73
+ const content: string[] = tags.map((t) =>
74
+ t.text?.length
75
+ ? `@${t.name} ${t.text
76
+ .map((e) => e.text)
77
+ .join("")
78
+ .split("\n")
79
+ .map((str) => str.trim())
80
+ .map((str, i) => {
81
+ if (i === 0) return str;
82
+ return `${" ".repeat(t.name.length + 1)} ${str}`;
83
+ })
84
+ .join("\n")}`
85
+ : `@${t.name}`,
86
+ );
87
+ tagComments.push(...new Set(content));
88
+ }
89
+
90
+ // EXCEPTIONS
91
+ for (const [key, value] of Object.entries(route.exceptions)) {
92
+ if (
93
+ tagComments.some(
94
+ (str) =>
95
+ str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
96
+ )
97
+ )
98
+ continue;
99
+ tagComments.push(
100
+ value.description?.length
101
+ ? `@throws ${key} ${value.description.split("\n")[0]}`
102
+ : `@throws ${key}`,
103
+ );
104
+ }
105
+
106
+ // POSTFIX
107
+ return [
108
+ ...descriptionComments,
109
+ ...(descriptionComments.length && tagComments.length ? [""] : []),
110
+ ...tagComments,
111
+ ...(descriptionComments.length && tagComments.length ? [""] : []),
112
+ `@controller ${route.controller.class.name}.${route.name}`,
113
+ `@path ${route.method} ${route.path}`,
114
+ `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
115
+ ].join("\n");
116
+ };
117
+ }