@nestia/sdk 8.1.0 → 9.0.0-dev.20251107

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 -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/executable/internal/NestiaConfigLoader.js +4 -4
  15. package/lib/executable/sdk.js +12 -12
  16. package/package.json +7 -7
  17. package/src/INestiaConfig.ts +267 -267
  18. package/src/NestiaSdkApplication.ts +307 -307
  19. package/src/NestiaSwaggerComposer.ts +138 -138
  20. package/src/analyses/AccessorAnalyzer.ts +67 -67
  21. package/src/analyses/ConfigAnalyzer.ts +155 -155
  22. package/src/analyses/DtoAnalyzer.ts +246 -246
  23. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  24. package/src/analyses/GenericAnalyzer.ts +49 -49
  25. package/src/analyses/ImportAnalyzer.ts +126 -126
  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 +197 -197
  47. package/src/generates/internal/FilePrinter.ts +53 -53
  48. package/src/generates/internal/ImportDictionary.ts +192 -192
  49. package/src/generates/internal/SdkAliasCollection.ts +261 -261
  50. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  51. package/src/generates/internal/SdkFileProgrammer.ts +110 -110
  52. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  53. package/src/generates/internal/SdkHttpCloneReferencer.ts +77 -77
  54. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +279 -279
  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 +108 -108
  58. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +310 -310
  59. package/src/generates/internal/SdkImportWizard.ts +62 -62
  60. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  61. package/src/generates/internal/SdkTypeProgrammer.ts +385 -385
  62. package/src/generates/internal/SdkTypeTagProgrammer.ts +104 -104
  63. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +381 -381
  64. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  65. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +302 -302
  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 +77 -77
  79. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  80. package/src/structures/IReflectImport.ts +6 -6
  81. package/src/structures/IReflectOperationError.ts +26 -26
  82. package/src/structures/IReflectType.ts +4 -4
  83. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  84. package/src/structures/IReflectWebSocketOperationParameter.ts +36 -36
  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 +238 -238
  99. package/src/transformers/SdkOperationTransformer.ts +252 -252
  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 +63 -63
  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,197 +1,197 @@
1
- import ts from "typescript";
2
- import { IdentifierFactory } from "typia/lib/factories/IdentifierFactory";
3
- import { LiteralFactory } from "typia/lib/factories/LiteralFactory";
4
-
5
- import { INestiaProject } from "../../structures/INestiaProject";
6
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
- import { FilePrinter } from "./FilePrinter";
8
- import { ImportDictionary } from "./ImportDictionary";
9
- import { SdkAliasCollection } from "./SdkAliasCollection";
10
- import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
11
- import { SdkImportWizard } from "./SdkImportWizard";
12
-
13
- export namespace E2eFileProgrammer {
14
- export const generate =
15
- (project: INestiaProject) =>
16
- (props: { api: string; current: string }) =>
17
- async (route: ITypedHttpRoute): Promise<void> => {
18
- const importer: ImportDictionary = new ImportDictionary(
19
- `${props.current}/${getFunctionName(route)}.ts`,
20
- );
21
- if (project.config.clone !== true) importer.declarations(route.imports);
22
- importer.internal({
23
- file: props.api,
24
- declaration: false,
25
- type: "default",
26
- name: "api",
27
- });
28
- const functor: ts.Statement = generateFunctor(project)(importer)(route);
29
- await FilePrinter.write({
30
- location: importer.file,
31
- statements: [
32
- ...importer.toStatements(props.current),
33
- FilePrinter.enter(),
34
- functor,
35
- ],
36
- });
37
- };
38
-
39
- const generateFunctor =
40
- (project: INestiaProject) =>
41
- (importer: ImportDictionary) =>
42
- (route: ITypedHttpRoute): ts.Statement =>
43
- ts.factory.createVariableStatement(
44
- [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
45
- ts.factory.createVariableDeclarationList(
46
- [
47
- ts.factory.createVariableDeclaration(
48
- ts.factory.createIdentifier(getFunctionName(route)),
49
- undefined,
50
- undefined,
51
- generateArrow(project)(importer)(route),
52
- ),
53
- ],
54
- ts.NodeFlags.Const,
55
- ),
56
- );
57
-
58
- const generateArrow =
59
- (project: INestiaProject) =>
60
- (importer: ImportDictionary) =>
61
- (route: ITypedHttpRoute) => {
62
- const random = IdentifierFactory.access(
63
- ts.factory.createIdentifier(SdkImportWizard.typia(importer)),
64
- "random",
65
- );
66
- const connection = route.headerObject
67
- ? ts.factory.createObjectLiteralExpression(
68
- [
69
- ts.factory.createSpreadAssignment(
70
- ts.factory.createIdentifier("connection"),
71
- ),
72
- ts.factory.createPropertyAssignment(
73
- "headers",
74
- ts.factory.createObjectLiteralExpression(
75
- [
76
- ts.factory.createSpreadAssignment(
77
- IdentifierFactory.access(
78
- ts.factory.createIdentifier("connection"),
79
- "headers",
80
- ),
81
- ),
82
- ts.factory.createSpreadAssignment(
83
- ts.factory.createCallExpression(
84
- random,
85
- [
86
- project.config.clone === true
87
- ? SdkAliasCollection.from(project)(importer)(
88
- route.headerObject.metadata,
89
- )
90
- : SdkAliasCollection.name(route.headerObject),
91
- ],
92
- undefined,
93
- ),
94
- ),
95
- ],
96
- true,
97
- ),
98
- ),
99
- ],
100
- true,
101
- )
102
- : ts.factory.createIdentifier("connection");
103
- const entries = SdkHttpParameterProgrammer.getEntries({
104
- project,
105
- importer,
106
- route,
107
- body: true,
108
- e2e: true,
109
- prefix: ["api", "functional", ...route.accessor].join(".") + ".",
110
- });
111
- const fetch = ts.factory.createCallExpression(
112
- ts.factory.createIdentifier(
113
- ["api", "functional", ...route.accessor].join("."),
114
- ),
115
- undefined,
116
- [
117
- connection,
118
- ...(project.config.keyword === true && entries.length !== 0
119
- ? [
120
- LiteralFactory.write(
121
- Object.fromEntries(
122
- entries.map((e) => [
123
- e.key,
124
- ts.factory.createCallExpression(
125
- IdentifierFactory.access(
126
- ts.factory.createIdentifier(
127
- SdkImportWizard.typia(importer),
128
- ),
129
- "random",
130
- ),
131
- [e.type],
132
- undefined,
133
- ),
134
- ]),
135
- ),
136
- ),
137
- ]
138
- : entries.map((e) =>
139
- ts.factory.createCallExpression(
140
- IdentifierFactory.access(
141
- ts.factory.createIdentifier(
142
- SdkImportWizard.typia(importer),
143
- ),
144
- "random",
145
- ),
146
- [e.type],
147
- undefined,
148
- ),
149
- )),
150
- ],
151
- );
152
- const assert = ts.factory.createCallExpression(
153
- IdentifierFactory.access(
154
- ts.factory.createIdentifier(SdkImportWizard.typia(importer)),
155
- "assert",
156
- ),
157
- undefined,
158
- [ts.factory.createIdentifier("output")],
159
- );
160
-
161
- return ts.factory.createArrowFunction(
162
- [ts.factory.createModifier(ts.SyntaxKind.AsyncKeyword)],
163
- undefined,
164
- [
165
- IdentifierFactory.parameter(
166
- "connection",
167
- ts.factory.createTypeReferenceNode("api.IConnection"),
168
- ),
169
- ],
170
- undefined,
171
- undefined,
172
- ts.factory.createBlock([
173
- ts.factory.createVariableStatement(
174
- [],
175
- ts.factory.createVariableDeclarationList(
176
- [
177
- ts.factory.createVariableDeclaration(
178
- "output",
179
- undefined,
180
- project.config.propagate !== true &&
181
- route.success.type.name === "void"
182
- ? undefined
183
- : SdkAliasCollection.response(project)(importer)(route),
184
- ts.factory.createAwaitExpression(fetch),
185
- ),
186
- ],
187
- ts.NodeFlags.Const,
188
- ),
189
- ),
190
- ts.factory.createExpressionStatement(assert),
191
- ]),
192
- );
193
- };
194
- }
195
-
196
- const getFunctionName = (route: ITypedHttpRoute): string =>
197
- ["test", "api", ...route.accessor].join("_");
1
+ import ts from "typescript";
2
+ import { IdentifierFactory } from "typia/lib/factories/IdentifierFactory";
3
+ import { LiteralFactory } from "typia/lib/factories/LiteralFactory";
4
+
5
+ import { INestiaProject } from "../../structures/INestiaProject";
6
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
+ import { FilePrinter } from "./FilePrinter";
8
+ import { ImportDictionary } from "./ImportDictionary";
9
+ import { SdkAliasCollection } from "./SdkAliasCollection";
10
+ import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
11
+ import { SdkImportWizard } from "./SdkImportWizard";
12
+
13
+ export namespace E2eFileProgrammer {
14
+ export const generate =
15
+ (project: INestiaProject) =>
16
+ (props: { api: string; current: string }) =>
17
+ async (route: ITypedHttpRoute): Promise<void> => {
18
+ const importer: ImportDictionary = new ImportDictionary(
19
+ `${props.current}/${getFunctionName(route)}.ts`,
20
+ );
21
+ if (project.config.clone !== true) importer.declarations(route.imports);
22
+ importer.internal({
23
+ file: props.api,
24
+ declaration: false,
25
+ type: "default",
26
+ name: "api",
27
+ });
28
+ const functor: ts.Statement = generateFunctor(project)(importer)(route);
29
+ await FilePrinter.write({
30
+ location: importer.file,
31
+ statements: [
32
+ ...importer.toStatements(props.current),
33
+ FilePrinter.enter(),
34
+ functor,
35
+ ],
36
+ });
37
+ };
38
+
39
+ const generateFunctor =
40
+ (project: INestiaProject) =>
41
+ (importer: ImportDictionary) =>
42
+ (route: ITypedHttpRoute): ts.Statement =>
43
+ ts.factory.createVariableStatement(
44
+ [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
45
+ ts.factory.createVariableDeclarationList(
46
+ [
47
+ ts.factory.createVariableDeclaration(
48
+ ts.factory.createIdentifier(getFunctionName(route)),
49
+ undefined,
50
+ undefined,
51
+ generateArrow(project)(importer)(route),
52
+ ),
53
+ ],
54
+ ts.NodeFlags.Const,
55
+ ),
56
+ );
57
+
58
+ const generateArrow =
59
+ (project: INestiaProject) =>
60
+ (importer: ImportDictionary) =>
61
+ (route: ITypedHttpRoute) => {
62
+ const random = IdentifierFactory.access(
63
+ ts.factory.createIdentifier(SdkImportWizard.typia(importer)),
64
+ "random",
65
+ );
66
+ const connection = route.headerObject
67
+ ? ts.factory.createObjectLiteralExpression(
68
+ [
69
+ ts.factory.createSpreadAssignment(
70
+ ts.factory.createIdentifier("connection"),
71
+ ),
72
+ ts.factory.createPropertyAssignment(
73
+ "headers",
74
+ ts.factory.createObjectLiteralExpression(
75
+ [
76
+ ts.factory.createSpreadAssignment(
77
+ IdentifierFactory.access(
78
+ ts.factory.createIdentifier("connection"),
79
+ "headers",
80
+ ),
81
+ ),
82
+ ts.factory.createSpreadAssignment(
83
+ ts.factory.createCallExpression(
84
+ random,
85
+ [
86
+ project.config.clone === true
87
+ ? SdkAliasCollection.from(project)(importer)(
88
+ route.headerObject.metadata,
89
+ )
90
+ : SdkAliasCollection.name(route.headerObject),
91
+ ],
92
+ undefined,
93
+ ),
94
+ ),
95
+ ],
96
+ true,
97
+ ),
98
+ ),
99
+ ],
100
+ true,
101
+ )
102
+ : ts.factory.createIdentifier("connection");
103
+ const entries = SdkHttpParameterProgrammer.getEntries({
104
+ project,
105
+ importer,
106
+ route,
107
+ body: true,
108
+ e2e: true,
109
+ prefix: ["api", "functional", ...route.accessor].join(".") + ".",
110
+ });
111
+ const fetch = ts.factory.createCallExpression(
112
+ ts.factory.createIdentifier(
113
+ ["api", "functional", ...route.accessor].join("."),
114
+ ),
115
+ undefined,
116
+ [
117
+ connection,
118
+ ...(project.config.keyword === true && entries.length !== 0
119
+ ? [
120
+ LiteralFactory.write(
121
+ Object.fromEntries(
122
+ entries.map((e) => [
123
+ e.key,
124
+ ts.factory.createCallExpression(
125
+ IdentifierFactory.access(
126
+ ts.factory.createIdentifier(
127
+ SdkImportWizard.typia(importer),
128
+ ),
129
+ "random",
130
+ ),
131
+ [e.type],
132
+ undefined,
133
+ ),
134
+ ]),
135
+ ),
136
+ ),
137
+ ]
138
+ : entries.map((e) =>
139
+ ts.factory.createCallExpression(
140
+ IdentifierFactory.access(
141
+ ts.factory.createIdentifier(
142
+ SdkImportWizard.typia(importer),
143
+ ),
144
+ "random",
145
+ ),
146
+ [e.type],
147
+ undefined,
148
+ ),
149
+ )),
150
+ ],
151
+ );
152
+ const assert = ts.factory.createCallExpression(
153
+ IdentifierFactory.access(
154
+ ts.factory.createIdentifier(SdkImportWizard.typia(importer)),
155
+ "assert",
156
+ ),
157
+ undefined,
158
+ [ts.factory.createIdentifier("output")],
159
+ );
160
+
161
+ return ts.factory.createArrowFunction(
162
+ [ts.factory.createModifier(ts.SyntaxKind.AsyncKeyword)],
163
+ undefined,
164
+ [
165
+ IdentifierFactory.parameter(
166
+ "connection",
167
+ ts.factory.createTypeReferenceNode("api.IConnection"),
168
+ ),
169
+ ],
170
+ undefined,
171
+ undefined,
172
+ ts.factory.createBlock([
173
+ ts.factory.createVariableStatement(
174
+ [],
175
+ ts.factory.createVariableDeclarationList(
176
+ [
177
+ ts.factory.createVariableDeclaration(
178
+ "output",
179
+ undefined,
180
+ project.config.propagate !== true &&
181
+ route.success.type.name === "void"
182
+ ? undefined
183
+ : SdkAliasCollection.response(project)(importer)(route),
184
+ ts.factory.createAwaitExpression(fetch),
185
+ ),
186
+ ],
187
+ ts.NodeFlags.Const,
188
+ ),
189
+ ),
190
+ ts.factory.createExpressionStatement(assert),
191
+ ]),
192
+ );
193
+ };
194
+ }
195
+
196
+ const getFunctionName = (route: ITypedHttpRoute): string =>
197
+ ["test", "api", ...route.accessor].join("_");
@@ -1,53 +1,53 @@
1
- import fs from "fs";
2
- import { format } from "prettier";
3
- import ts from "typescript";
4
-
5
- export namespace FilePrinter {
6
- export const description = <Node extends ts.Node>(
7
- node: Node,
8
- comment: string,
9
- ): Node => {
10
- if (comment.length === 0) return node;
11
- ts.addSyntheticLeadingComment(
12
- node,
13
- ts.SyntaxKind.MultiLineCommentTrivia,
14
- ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
15
- true,
16
- );
17
- return node;
18
- };
19
-
20
- export const enter = () =>
21
- ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
22
-
23
- export const write = async (props: {
24
- location: string;
25
- statements: ts.Statement[];
26
- top?: string;
27
- }): Promise<void> => {
28
- const script: string = ts
29
- .createPrinter()
30
- .printFile(
31
- ts.factory.createSourceFile(
32
- props.statements,
33
- ts.factory.createToken(ts.SyntaxKind.EndOfFileToken),
34
- ts.NodeFlags.None,
35
- ),
36
- );
37
- await fs.promises.writeFile(
38
- props.location,
39
- await beautify((props.top ?? "") + script),
40
- "utf8",
41
- );
42
- };
43
-
44
- const beautify = async (script: string): Promise<string> => {
45
- try {
46
- return await format(script, {
47
- parser: "typescript",
48
- });
49
- } catch {
50
- return script;
51
- }
52
- };
53
- }
1
+ import fs from "fs";
2
+ import { format } from "prettier";
3
+ import ts from "typescript";
4
+
5
+ export namespace FilePrinter {
6
+ export const description = <Node extends ts.Node>(
7
+ node: Node,
8
+ comment: string,
9
+ ): Node => {
10
+ if (comment.length === 0) return node;
11
+ ts.addSyntheticLeadingComment(
12
+ node,
13
+ ts.SyntaxKind.MultiLineCommentTrivia,
14
+ ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
15
+ true,
16
+ );
17
+ return node;
18
+ };
19
+
20
+ export const enter = () =>
21
+ ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
22
+
23
+ export const write = async (props: {
24
+ location: string;
25
+ statements: ts.Statement[];
26
+ top?: string;
27
+ }): Promise<void> => {
28
+ const script: string = ts
29
+ .createPrinter()
30
+ .printFile(
31
+ ts.factory.createSourceFile(
32
+ props.statements,
33
+ ts.factory.createToken(ts.SyntaxKind.EndOfFileToken),
34
+ ts.NodeFlags.None,
35
+ ),
36
+ );
37
+ await fs.promises.writeFile(
38
+ props.location,
39
+ await beautify((props.top ?? "") + script),
40
+ "utf8",
41
+ );
42
+ };
43
+
44
+ const beautify = async (script: string): Promise<string> => {
45
+ try {
46
+ return await format(script, {
47
+ parser: "typescript",
48
+ });
49
+ } catch {
50
+ return script;
51
+ }
52
+ };
53
+ }