@nestia/sdk 11.0.0-dev.20260316 → 11.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 (65) 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 +5 -5
  15. package/lib/executable/internal/NestiaConfigLoader.js.map +1 -1
  16. package/package.json +8 -8
  17. package/src/INestiaConfig.ts +267 -267
  18. package/src/NestiaSdkApplication.ts +307 -307
  19. package/src/NestiaSwaggerComposer.ts +143 -143
  20. package/src/analyses/AccessorAnalyzer.ts +67 -67
  21. package/src/analyses/DtoAnalyzer.ts +260 -260
  22. package/src/analyses/ImportAnalyzer.ts +126 -126
  23. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  24. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +72 -72
  25. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +350 -350
  26. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +126 -126
  27. package/src/analyses/TypedHttpRouteAnalyzer.ts +208 -208
  28. package/src/executable/internal/NestiaConfigLoader.ts +85 -85
  29. package/src/executable/internal/NestiaSdkCommand.ts +107 -107
  30. package/src/generates/SwaggerGenerator.ts +291 -291
  31. package/src/generates/internal/E2eFileProgrammer.ts +196 -196
  32. package/src/generates/internal/FilePrinter.ts +64 -64
  33. package/src/generates/internal/ImportDictionary.ts +192 -192
  34. package/src/generates/internal/SdkAliasCollection.ts +260 -260
  35. package/src/generates/internal/SdkFileProgrammer.ts +110 -110
  36. package/src/generates/internal/SdkHttpCloneProgrammer.ts +126 -126
  37. package/src/generates/internal/SdkHttpCloneReferencer.ts +77 -77
  38. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +278 -278
  39. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +502 -502
  40. package/src/generates/internal/SdkHttpRouteProgrammer.ts +109 -109
  41. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +312 -312
  42. package/src/generates/internal/SdkImportWizard.ts +62 -62
  43. package/src/generates/internal/SdkTypeProgrammer.ts +388 -388
  44. package/src/generates/internal/SdkTypeTagProgrammer.ts +114 -114
  45. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +379 -379
  46. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +302 -302
  47. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  48. package/src/generates/internal/SwaggerOperationParameterComposer.ts +161 -161
  49. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  50. package/src/module.ts +4 -4
  51. package/src/structures/IReflectHttpOperationException.ts +18 -18
  52. package/src/structures/IReflectHttpOperationParameter.ts +79 -79
  53. package/src/structures/IReflectHttpOperationSuccess.ts +21 -21
  54. package/src/structures/ITypedApplication.ts +11 -11
  55. package/src/structures/ITypedHttpRouteException.ts +15 -15
  56. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  57. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  58. package/src/transformers/IOperationMetadata.ts +46 -46
  59. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  60. package/src/transformers/SdkOperationProgrammer.ts +240 -240
  61. package/src/transformers/SdkOperationTransformer.ts +248 -248
  62. package/src/transformers/TextPlainValidator.ts +17 -17
  63. package/src/utils/MetadataUtil.ts +26 -26
  64. package/src/validators/HttpHeadersValidator.ts +40 -40
  65. package/src/validators/HttpQueryValidator.ts +40 -40
@@ -1,109 +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]
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
- }
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
+ }