@nestia/sdk 7.0.0-dev.20250608 → 7.0.1

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 (112) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +93 -92
  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/executable/internal/NestiaConfigLoader.js +5 -5
  15. package/lib/executable/internal/NestiaConfigLoader.js.map +1 -1
  16. package/lib/executable/sdk.js +12 -12
  17. package/package.json +5 -5
  18. package/src/INestiaConfig.ts +269 -269
  19. package/src/NestiaSdkApplication.ts +307 -307
  20. package/src/NestiaSwaggerComposer.ts +138 -138
  21. package/src/analyses/AccessorAnalyzer.ts +67 -67
  22. package/src/analyses/ConfigAnalyzer.ts +155 -155
  23. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  24. package/src/analyses/GenericAnalyzer.ts +49 -49
  25. package/src/analyses/ImportAnalyzer.ts +171 -171
  26. package/src/analyses/PathAnalyzer.ts +69 -69
  27. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  28. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  29. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  30. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  31. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  32. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  33. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  34. package/src/analyses/SecurityAnalyzer.ts +25 -25
  35. package/src/analyses/TypedHttpRouteAnalyzer.ts +204 -204
  36. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  37. package/src/decorators/OperationMetadata.ts +15 -15
  38. package/src/executable/internal/CommandParser.ts +15 -15
  39. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  40. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  41. package/src/executable/sdk.ts +75 -75
  42. package/src/generates/CloneGenerator.ts +66 -66
  43. package/src/generates/E2eGenerator.ts +32 -32
  44. package/src/generates/SdkGenerator.ts +160 -160
  45. package/src/generates/SwaggerGenerator.ts +284 -284
  46. package/src/generates/internal/E2eFileProgrammer.ts +205 -205
  47. package/src/generates/internal/FilePrinter.ts +53 -53
  48. package/src/generates/internal/ImportDictionary.ts +163 -163
  49. package/src/generates/internal/SdkAliasCollection.ts +255 -255
  50. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  51. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  52. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  53. package/src/generates/internal/SdkHttpCloneReferencer.ts +75 -75
  54. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +276 -276
  55. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +500 -500
  56. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  57. package/src/generates/internal/SdkHttpRouteProgrammer.ts +107 -107
  58. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +340 -340
  59. package/src/generates/internal/SdkImportWizard.ts +55 -55
  60. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  61. package/src/generates/internal/SdkTypeProgrammer.ts +384 -384
  62. package/src/generates/internal/SdkTypeTagProgrammer.ts +102 -102
  63. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +366 -366
  64. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  65. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +279 -279
  66. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  67. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  68. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  69. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  70. package/src/index.ts +4 -4
  71. package/src/module.ts +3 -3
  72. package/src/structures/INestiaProject.ts +13 -13
  73. package/src/structures/INestiaSdkInput.ts +20 -20
  74. package/src/structures/IReflectApplication.ts +8 -8
  75. package/src/structures/IReflectController.ts +15 -15
  76. package/src/structures/IReflectHttpOperation.ts +26 -26
  77. package/src/structures/IReflectHttpOperationException.ts +19 -19
  78. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  79. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  80. package/src/structures/IReflectOperationError.ts +26 -26
  81. package/src/structures/IReflectType.ts +4 -4
  82. package/src/structures/IReflectTypeImport.ts +4 -4
  83. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  84. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  85. package/src/structures/ITypedApplication.ts +11 -11
  86. package/src/structures/ITypedHttpRoute.ts +41 -41
  87. package/src/structures/ITypedHttpRouteException.ts +15 -15
  88. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  89. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  90. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  91. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  92. package/src/structures/MethodType.ts +5 -5
  93. package/src/structures/ParamCategory.ts +1 -1
  94. package/src/structures/TypeEntry.ts +22 -22
  95. package/src/transform.ts +9 -9
  96. package/src/transformers/IOperationMetadata.ts +44 -44
  97. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  98. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  99. package/src/transformers/SdkOperationTransformer.ts +253 -253
  100. package/src/transformers/TextPlainValidator.ts +17 -17
  101. package/src/typings/get-function-location.d.ts +7 -7
  102. package/src/utils/ArrayUtil.ts +26 -26
  103. package/src/utils/FileRetriever.ts +22 -22
  104. package/src/utils/MapUtil.ts +14 -14
  105. package/src/utils/MetadataUtil.ts +26 -26
  106. package/src/utils/PathUtil.ts +10 -10
  107. package/src/utils/SourceFinder.ts +66 -66
  108. package/src/utils/StringUtil.ts +17 -17
  109. package/src/utils/StripEnums.ts +5 -5
  110. package/src/utils/VersioningStrategy.ts +28 -28
  111. package/src/validators/HttpHeadersValidator.ts +34 -34
  112. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,178 +1,178 @@
1
- import ts from "typescript";
2
-
3
- import { INestiaProject } from "../../structures/INestiaProject";
4
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
5
- import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
6
- import { ImportDictionary } from "./ImportDictionary";
7
- import { SdkAliasCollection } from "./SdkAliasCollection";
8
-
9
- export namespace SdkHttpParameterProgrammer {
10
- export interface IEntry {
11
- key: string;
12
- required: boolean;
13
- type: ts.TypeNode;
14
- parameter: ITypedHttpRouteParameter;
15
- }
16
-
17
- export const getAll = (
18
- route: ITypedHttpRoute,
19
- ): ITypedHttpRouteParameter[] => [
20
- ...route.pathParameters,
21
- ...route.queryParameters,
22
- ...route.headerParameters,
23
- ...(route.queryObject ? [route.queryObject] : []),
24
- ...(route.body ? [route.body] : []),
25
- ...(route.headerObject ? [route.headerObject] : []),
26
- ];
27
-
28
- export const getSignificant = (route: ITypedHttpRoute, body: boolean) => [
29
- ...route.pathParameters,
30
- ...route.queryParameters,
31
- ...(route.queryObject ? [route.queryObject] : []),
32
- ...(body && route.body ? [route.body] : []),
33
- ];
34
-
35
- export const getEntries = (props: {
36
- project: INestiaProject;
37
- importer: ImportDictionary;
38
- route: ITypedHttpRoute;
39
- body: boolean;
40
- prefix: boolean | string;
41
- e2e?: boolean;
42
- }): IEntry[] => {
43
- if (
44
- props.route.pathParameters.length === 0 &&
45
- props.route.queryParameters.length === 0 &&
46
- props.route.queryObject === null &&
47
- (props.body === false || props.route.body === null)
48
- )
49
- return [];
50
- const prefix =
51
- typeof props.prefix === "string"
52
- ? props.prefix
53
- : props.prefix === true
54
- ? `${props.route.name}.`
55
- : "";
56
- return [
57
- ...[...props.route.pathParameters, ...props.route.queryParameters].map(
58
- (p) => ({
59
- key: p.name,
60
- required: p.metadata.isRequired(),
61
- type:
62
- props.project.config.clone === true
63
- ? SdkAliasCollection.from(props.project)(props.importer)(
64
- p.metadata,
65
- )
66
- : SdkAliasCollection.name(p),
67
- parameter: p,
68
- }),
69
- ),
70
- ...(props.route.queryObject
71
- ? [
72
- {
73
- key: props.route.queryObject.name,
74
- required: props.route.queryObject.metadata.isRequired(),
75
- type:
76
- props.e2e === true
77
- ? props.project.config.clone === true
78
- ? SdkAliasCollection.from(props.project)(props.importer)(
79
- props.route.queryObject.metadata,
80
- )
81
- : SdkAliasCollection.name(props.route.queryObject)
82
- : ts.factory.createTypeReferenceNode(`${prefix}Query`),
83
- parameter: props.route.queryObject,
84
- },
85
- ]
86
- : []),
87
- ...(props.body && props.route.body
88
- ? [
89
- {
90
- key: props.route.body.name,
91
- required: props.route.body.metadata.isRequired(),
92
- type:
93
- props.e2e === true
94
- ? props.project.config.clone === true
95
- ? SdkAliasCollection.from(props.project)(props.importer)(
96
- props.route.body.metadata,
97
- )
98
- : SdkAliasCollection.name(props.route.body)
99
- : ts.factory.createTypeReferenceNode(`${prefix}Body`),
100
- parameter: props.route.body,
101
- },
102
- ]
103
- : []),
104
- ];
105
- };
106
-
107
- export const getParameterDeclarations = (props: {
108
- project: INestiaProject;
109
- importer: ImportDictionary;
110
- route: ITypedHttpRoute;
111
- body: boolean;
112
- prefix: boolean;
113
- }): ts.ParameterDeclaration[] => {
114
- const entries: IEntry[] = getEntries(props);
115
- if (entries.length === 0) return [];
116
- else if (props.project.config.keyword === true) {
117
- const typeName: string = props.prefix
118
- ? `${props.route.name}.Props`
119
- : "Props";
120
- const node: ts.TypeReferenceNode =
121
- props.body === false && props.route.body !== null
122
- ? ts.factory.createTypeReferenceNode("Omit", [
123
- ts.factory.createTypeReferenceNode(typeName),
124
- ts.factory.createLiteralTypeNode(
125
- ts.factory.createStringLiteral(props.route.body.name),
126
- ),
127
- ])
128
- : ts.factory.createTypeReferenceNode(typeName);
129
- return [
130
- ts.factory.createParameterDeclaration(
131
- undefined,
132
- undefined,
133
- "props",
134
- undefined,
135
- node,
136
- undefined,
137
- ),
138
- ];
139
- }
140
- return entries.map((e) =>
141
- ts.factory.createParameterDeclaration(
142
- undefined,
143
- undefined,
144
- e.key,
145
- e.required
146
- ? undefined
147
- : ts.factory.createToken(ts.SyntaxKind.QuestionToken),
148
- e.type,
149
- undefined,
150
- ),
151
- );
152
- };
153
-
154
- export const getArguments = (props: {
155
- project: INestiaProject;
156
- route: ITypedHttpRoute;
157
- body: boolean;
158
- }): ts.Expression[] => {
159
- const parameters = getSignificant(props.route, props.body);
160
- if (parameters.length === 0) return [];
161
- else if (props.project.config.keyword === true)
162
- return [ts.factory.createIdentifier("props")];
163
- return parameters.map((p) => ts.factory.createIdentifier(p.name));
164
- };
165
-
166
- export const getAccessors = (props: {
167
- project: INestiaProject;
168
- importer: ImportDictionary;
169
- route: ITypedHttpRoute;
170
- body: boolean;
171
- }): ts.Expression[] => {
172
- const prefix: string =
173
- props.project.config.keyword === true ? "props." : "";
174
- return getSignificant(props.route, props.body).map((p) =>
175
- ts.factory.createIdentifier(`${prefix}${p.name}`),
176
- );
177
- };
178
- }
1
+ import ts from "typescript";
2
+
3
+ import { INestiaProject } from "../../structures/INestiaProject";
4
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
5
+ import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
6
+ import { ImportDictionary } from "./ImportDictionary";
7
+ import { SdkAliasCollection } from "./SdkAliasCollection";
8
+
9
+ export namespace SdkHttpParameterProgrammer {
10
+ export interface IEntry {
11
+ key: string;
12
+ required: boolean;
13
+ type: ts.TypeNode;
14
+ parameter: ITypedHttpRouteParameter;
15
+ }
16
+
17
+ export const getAll = (
18
+ route: ITypedHttpRoute,
19
+ ): ITypedHttpRouteParameter[] => [
20
+ ...route.pathParameters,
21
+ ...route.queryParameters,
22
+ ...route.headerParameters,
23
+ ...(route.queryObject ? [route.queryObject] : []),
24
+ ...(route.body ? [route.body] : []),
25
+ ...(route.headerObject ? [route.headerObject] : []),
26
+ ];
27
+
28
+ export const getSignificant = (route: ITypedHttpRoute, body: boolean) => [
29
+ ...route.pathParameters,
30
+ ...route.queryParameters,
31
+ ...(route.queryObject ? [route.queryObject] : []),
32
+ ...(body && route.body ? [route.body] : []),
33
+ ];
34
+
35
+ export const getEntries = (props: {
36
+ project: INestiaProject;
37
+ importer: ImportDictionary;
38
+ route: ITypedHttpRoute;
39
+ body: boolean;
40
+ prefix: boolean | string;
41
+ e2e?: boolean;
42
+ }): IEntry[] => {
43
+ if (
44
+ props.route.pathParameters.length === 0 &&
45
+ props.route.queryParameters.length === 0 &&
46
+ props.route.queryObject === null &&
47
+ (props.body === false || props.route.body === null)
48
+ )
49
+ return [];
50
+ const prefix =
51
+ typeof props.prefix === "string"
52
+ ? props.prefix
53
+ : props.prefix === true
54
+ ? `${props.route.name}.`
55
+ : "";
56
+ return [
57
+ ...[...props.route.pathParameters, ...props.route.queryParameters].map(
58
+ (p) => ({
59
+ key: p.name,
60
+ required: p.metadata.isRequired(),
61
+ type:
62
+ props.project.config.clone === true
63
+ ? SdkAliasCollection.from(props.project)(props.importer)(
64
+ p.metadata,
65
+ )
66
+ : SdkAliasCollection.name(p),
67
+ parameter: p,
68
+ }),
69
+ ),
70
+ ...(props.route.queryObject
71
+ ? [
72
+ {
73
+ key: props.route.queryObject.name,
74
+ required: props.route.queryObject.metadata.isRequired(),
75
+ type:
76
+ props.e2e === true
77
+ ? props.project.config.clone === true
78
+ ? SdkAliasCollection.from(props.project)(props.importer)(
79
+ props.route.queryObject.metadata,
80
+ )
81
+ : SdkAliasCollection.name(props.route.queryObject)
82
+ : ts.factory.createTypeReferenceNode(`${prefix}Query`),
83
+ parameter: props.route.queryObject,
84
+ },
85
+ ]
86
+ : []),
87
+ ...(props.body && props.route.body
88
+ ? [
89
+ {
90
+ key: props.route.body.name,
91
+ required: props.route.body.metadata.isRequired(),
92
+ type:
93
+ props.e2e === true
94
+ ? props.project.config.clone === true
95
+ ? SdkAliasCollection.from(props.project)(props.importer)(
96
+ props.route.body.metadata,
97
+ )
98
+ : SdkAliasCollection.name(props.route.body)
99
+ : ts.factory.createTypeReferenceNode(`${prefix}Body`),
100
+ parameter: props.route.body,
101
+ },
102
+ ]
103
+ : []),
104
+ ];
105
+ };
106
+
107
+ export const getParameterDeclarations = (props: {
108
+ project: INestiaProject;
109
+ importer: ImportDictionary;
110
+ route: ITypedHttpRoute;
111
+ body: boolean;
112
+ prefix: boolean;
113
+ }): ts.ParameterDeclaration[] => {
114
+ const entries: IEntry[] = getEntries(props);
115
+ if (entries.length === 0) return [];
116
+ else if (props.project.config.keyword === true) {
117
+ const typeName: string = props.prefix
118
+ ? `${props.route.name}.Props`
119
+ : "Props";
120
+ const node: ts.TypeReferenceNode =
121
+ props.body === false && props.route.body !== null
122
+ ? ts.factory.createTypeReferenceNode("Omit", [
123
+ ts.factory.createTypeReferenceNode(typeName),
124
+ ts.factory.createLiteralTypeNode(
125
+ ts.factory.createStringLiteral(props.route.body.name),
126
+ ),
127
+ ])
128
+ : ts.factory.createTypeReferenceNode(typeName);
129
+ return [
130
+ ts.factory.createParameterDeclaration(
131
+ undefined,
132
+ undefined,
133
+ "props",
134
+ undefined,
135
+ node,
136
+ undefined,
137
+ ),
138
+ ];
139
+ }
140
+ return entries.map((e) =>
141
+ ts.factory.createParameterDeclaration(
142
+ undefined,
143
+ undefined,
144
+ e.key,
145
+ e.required
146
+ ? undefined
147
+ : ts.factory.createToken(ts.SyntaxKind.QuestionToken),
148
+ e.type,
149
+ undefined,
150
+ ),
151
+ );
152
+ };
153
+
154
+ export const getArguments = (props: {
155
+ project: INestiaProject;
156
+ route: ITypedHttpRoute;
157
+ body: boolean;
158
+ }): ts.Expression[] => {
159
+ const parameters = getSignificant(props.route, props.body);
160
+ if (parameters.length === 0) return [];
161
+ else if (props.project.config.keyword === true)
162
+ return [ts.factory.createIdentifier("props")];
163
+ return parameters.map((p) => ts.factory.createIdentifier(p.name));
164
+ };
165
+
166
+ export const getAccessors = (props: {
167
+ project: INestiaProject;
168
+ importer: ImportDictionary;
169
+ route: ITypedHttpRoute;
170
+ body: boolean;
171
+ }): ts.Expression[] => {
172
+ const prefix: string =
173
+ props.project.config.keyword === true ? "props." : "";
174
+ return getSignificant(props.route, props.body).map((p) =>
175
+ ts.factory.createIdentifier(`${prefix}${p.name}`),
176
+ );
177
+ };
178
+ }
@@ -1,107 +1,107 @@
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
- `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
105
- ].join("\n");
106
- };
107
- }
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
+ `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
105
+ ].join("\n");
106
+ };
107
+ }