@nestia/sdk 7.0.3 → 7.1.1-dev.20250714

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 (115) 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/lib/generates/internal/SdkHttpFunctionProgrammer.js +1 -1
  17. package/lib/generates/internal/SdkHttpFunctionProgrammer.js.map +1 -1
  18. package/lib/generates/internal/SdkHttpSimulationProgrammer.js +7 -10
  19. package/lib/generates/internal/SdkHttpSimulationProgrammer.js.map +1 -1
  20. package/package.json +6 -11
  21. package/src/INestiaConfig.ts +269 -269
  22. package/src/NestiaSdkApplication.ts +307 -307
  23. package/src/NestiaSwaggerComposer.ts +138 -138
  24. package/src/analyses/AccessorAnalyzer.ts +67 -67
  25. package/src/analyses/ConfigAnalyzer.ts +155 -155
  26. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  27. package/src/analyses/GenericAnalyzer.ts +49 -49
  28. package/src/analyses/ImportAnalyzer.ts +171 -171
  29. package/src/analyses/PathAnalyzer.ts +69 -69
  30. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  31. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  32. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  33. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  34. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  35. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  36. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  37. package/src/analyses/SecurityAnalyzer.ts +25 -25
  38. package/src/analyses/TypedHttpRouteAnalyzer.ts +204 -204
  39. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  40. package/src/decorators/OperationMetadata.ts +15 -15
  41. package/src/executable/internal/CommandParser.ts +15 -15
  42. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  43. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  44. package/src/executable/sdk.ts +75 -75
  45. package/src/generates/CloneGenerator.ts +66 -66
  46. package/src/generates/E2eGenerator.ts +32 -32
  47. package/src/generates/SdkGenerator.ts +160 -160
  48. package/src/generates/SwaggerGenerator.ts +284 -284
  49. package/src/generates/internal/E2eFileProgrammer.ts +205 -205
  50. package/src/generates/internal/FilePrinter.ts +53 -53
  51. package/src/generates/internal/ImportDictionary.ts +163 -163
  52. package/src/generates/internal/SdkAliasCollection.ts +255 -255
  53. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  54. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  55. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  56. package/src/generates/internal/SdkHttpCloneReferencer.ts +75 -75
  57. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +279 -276
  58. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +500 -500
  59. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  60. package/src/generates/internal/SdkHttpRouteProgrammer.ts +107 -107
  61. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +309 -340
  62. package/src/generates/internal/SdkImportWizard.ts +55 -55
  63. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  64. package/src/generates/internal/SdkTypeProgrammer.ts +384 -384
  65. package/src/generates/internal/SdkTypeTagProgrammer.ts +102 -102
  66. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +366 -366
  67. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  68. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +279 -279
  69. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  70. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  71. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  72. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  73. package/src/index.ts +4 -4
  74. package/src/module.ts +3 -3
  75. package/src/structures/INestiaProject.ts +13 -13
  76. package/src/structures/INestiaSdkInput.ts +20 -20
  77. package/src/structures/IReflectApplication.ts +8 -8
  78. package/src/structures/IReflectController.ts +15 -15
  79. package/src/structures/IReflectHttpOperation.ts +26 -26
  80. package/src/structures/IReflectHttpOperationException.ts +19 -19
  81. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  82. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  83. package/src/structures/IReflectOperationError.ts +26 -26
  84. package/src/structures/IReflectType.ts +4 -4
  85. package/src/structures/IReflectTypeImport.ts +4 -4
  86. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  87. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  88. package/src/structures/ITypedApplication.ts +11 -11
  89. package/src/structures/ITypedHttpRoute.ts +41 -41
  90. package/src/structures/ITypedHttpRouteException.ts +15 -15
  91. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  92. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  93. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  94. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  95. package/src/structures/MethodType.ts +5 -5
  96. package/src/structures/ParamCategory.ts +1 -1
  97. package/src/structures/TypeEntry.ts +22 -22
  98. package/src/transform.ts +9 -9
  99. package/src/transformers/IOperationMetadata.ts +44 -44
  100. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  101. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  102. package/src/transformers/SdkOperationTransformer.ts +253 -253
  103. package/src/transformers/TextPlainValidator.ts +17 -17
  104. package/src/typings/get-function-location.d.ts +7 -7
  105. package/src/utils/ArrayUtil.ts +26 -26
  106. package/src/utils/FileRetriever.ts +22 -22
  107. package/src/utils/MapUtil.ts +14 -14
  108. package/src/utils/MetadataUtil.ts +26 -26
  109. package/src/utils/PathUtil.ts +10 -10
  110. package/src/utils/SourceFinder.ts +66 -66
  111. package/src/utils/StringUtil.ts +17 -17
  112. package/src/utils/StripEnums.ts +5 -5
  113. package/src/utils/VersioningStrategy.ts +28 -28
  114. package/src/validators/HttpHeadersValidator.ts +34 -34
  115. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,32 +1,32 @@
1
- import fs from "fs";
2
- import path from "path";
3
-
4
- import { ITypedApplication } from "../structures/ITypedApplication";
5
- import { E2eFileProgrammer } from "./internal/E2eFileProgrammer";
6
-
7
- export namespace E2eGenerator {
8
- export const generate = async (app: ITypedApplication): Promise<void> => {
9
- console.log("Generating E2E Test Functions");
10
-
11
- // PREPARE DIRECTORIES
12
- const output: string = path.resolve(app.project.config.e2e!);
13
- await mkdir(output);
14
- await mkdir(path.join(output, "features"));
15
- await mkdir(path.join(output, "features", "api"));
16
- await mkdir(path.join(output, "features", "api", "automated"));
17
-
18
- // GENERATE EACH TEST FILES
19
- for (const route of app.routes)
20
- if (route.protocol === "http")
21
- await E2eFileProgrammer.generate(app.project)({
22
- api: path.resolve(app.project.config.output!),
23
- current: path.join(output, "features", "api", "automated"),
24
- })(route);
25
- };
26
- }
27
-
28
- const mkdir = async (location: string): Promise<void> => {
29
- try {
30
- await fs.promises.mkdir(location);
31
- } catch {}
32
- };
1
+ import fs from "fs";
2
+ import path from "path";
3
+
4
+ import { ITypedApplication } from "../structures/ITypedApplication";
5
+ import { E2eFileProgrammer } from "./internal/E2eFileProgrammer";
6
+
7
+ export namespace E2eGenerator {
8
+ export const generate = async (app: ITypedApplication): Promise<void> => {
9
+ console.log("Generating E2E Test Functions");
10
+
11
+ // PREPARE DIRECTORIES
12
+ const output: string = path.resolve(app.project.config.e2e!);
13
+ await mkdir(output);
14
+ await mkdir(path.join(output, "features"));
15
+ await mkdir(path.join(output, "features", "api"));
16
+ await mkdir(path.join(output, "features", "api", "automated"));
17
+
18
+ // GENERATE EACH TEST FILES
19
+ for (const route of app.routes)
20
+ if (route.protocol === "http")
21
+ await E2eFileProgrammer.generate(app.project)({
22
+ api: path.resolve(app.project.config.output!),
23
+ current: path.join(output, "features", "api", "automated"),
24
+ })(route);
25
+ };
26
+ }
27
+
28
+ const mkdir = async (location: string): Promise<void> => {
29
+ try {
30
+ await fs.promises.mkdir(location);
31
+ } catch {}
32
+ };
@@ -1,160 +1,160 @@
1
- import fs from "fs";
2
- import NodePath from "path";
3
- import { IPointer } from "tstl";
4
-
5
- import { INestiaConfig } from "../INestiaConfig";
6
- import { IReflectOperationError } from "../structures/IReflectOperationError";
7
- import { IReflectType } from "../structures/IReflectType";
8
- import { ITypedApplication } from "../structures/ITypedApplication";
9
- import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
10
- import { CloneGenerator } from "./CloneGenerator";
11
- import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
12
- import { SdkFileProgrammer } from "./internal/SdkFileProgrammer";
13
- import { SdkHttpParameterProgrammer } from "./internal/SdkHttpParameterProgrammer";
14
-
15
- export namespace SdkGenerator {
16
- export const generate = async (app: ITypedApplication): Promise<void> => {
17
- if (app.project.config.output === undefined)
18
- throw new Error("Output directory is not defined.");
19
-
20
- // PREPARE NEW DIRECTORIES
21
- console.log("Generating SDK Library");
22
- try {
23
- await fs.promises.mkdir(app.project.config.output);
24
- } catch {}
25
-
26
- // BUNDLING
27
- const bundle: string[] = await fs.promises.readdir(BUNDLE_PATH);
28
- for (const file of bundle) {
29
- const current: string = `${BUNDLE_PATH}/${file}`;
30
- const target: string = `${app.project.config.output}/${file}`;
31
- const stats: fs.Stats = await fs.promises.stat(current);
32
-
33
- if (stats.isFile() === true) {
34
- const content: string = await fs.promises.readFile(current, "utf8");
35
- if (fs.existsSync(target) === false)
36
- await fs.promises.writeFile(target, content, "utf8");
37
- else if (BUNDLE_CHANGES[file] !== undefined) {
38
- const r: IPointer<string> = {
39
- value: await fs.promises.readFile(target, "utf8"),
40
- };
41
- for (const [before, after] of BUNDLE_CHANGES[file])
42
- r.value = r.value.replace(before, after);
43
- await fs.promises.writeFile(target, r.value, "utf8");
44
- }
45
- }
46
- }
47
-
48
- // STRUCTURES
49
- if (app.project.config.clone === true) await CloneGenerator.write(app);
50
-
51
- // FUNCTIONAL
52
- await SdkFileProgrammer.generate(app);
53
-
54
- // DISTRIBUTION
55
- if (app.project.config.distribute !== undefined)
56
- await SdkDistributionComposer.compose({
57
- config: app.project.config,
58
- websocket: app.routes.some((r) => r.protocol === "websocket"),
59
- });
60
- };
61
-
62
- export const validate = (
63
- app: ITypedApplication,
64
- ): IReflectOperationError[] => {
65
- const errors: IReflectOperationError[] = [];
66
- if (app.project.config.clone === true) return errors;
67
- for (const route of app.routes)
68
- if (route.protocol === "http")
69
- validateImplicit({
70
- config: app.project.config,
71
- errors,
72
- route,
73
- });
74
- return errors;
75
- };
76
-
77
- const validateImplicit = (props: {
78
- config: INestiaConfig;
79
- errors: IReflectOperationError[];
80
- route: ITypedHttpRoute;
81
- }): void => {
82
- for (const p of SdkHttpParameterProgrammer.getAll(props.route)) {
83
- if (isImplicitType(p.type))
84
- props.errors.push({
85
- file: props.route.controller.file,
86
- class: props.route.controller.class.name,
87
- function: props.route.name,
88
- from: `parameter ${JSON.stringify(p.name)}`,
89
- contents: [`implicit (unnamed) parameter type.`],
90
- });
91
- }
92
- if (props.config.propagate === true)
93
- for (const [key, value] of Object.entries(props.route.exceptions))
94
- if (isImplicitType(value.type))
95
- props.errors.push({
96
- file: props.route.controller.file,
97
- class: props.route.controller.class.name,
98
- function: props.route.name,
99
- from: `exception ${JSON.stringify(key)}`,
100
- contents: [`implicit (unnamed) exception type.`],
101
- });
102
- if (isImplicitType(props.route.success.type))
103
- props.errors.push({
104
- file: props.route.controller.file,
105
- class: props.route.controller.class.name,
106
- function: props.route.name,
107
- from: "success",
108
- contents: [`implicit (unnamed) return type.`],
109
- });
110
- };
111
-
112
- const isImplicitType = (type: IReflectType): boolean =>
113
- type.name === "__type" ||
114
- type.name === "__object" ||
115
- type.name.startsWith("__type.") ||
116
- type.name.startsWith("__object.") ||
117
- type.name.includes("readonly [") ||
118
- (!!type.typeArguments?.length && type.typeArguments.some(isImplicitType));
119
-
120
- export const BUNDLE_PATH = NodePath.join(
121
- __dirname,
122
- "..",
123
- "..",
124
- "assets",
125
- "bundle",
126
- "api",
127
- );
128
- }
129
-
130
- const BUNDLE_CHANGES: Record<string, [string, string][]> = {
131
- "IConnection.ts": [
132
- [
133
- `export { IConnection } from "@nestia/fetcher"`,
134
- `export type { IConnection } from "@nestia/fetcher"`,
135
- ],
136
- ],
137
- "module.ts": [
138
- [`export * from "./IConnection"`, `export type * from "./IConnection"`],
139
- ],
140
- "Primitive.ts": [
141
- [
142
- `export { Primitive } from "@nestia/fetcher"`,
143
- `export type { Primitive } from "typia"`,
144
- ],
145
- [
146
- `export type { Primitive } from "@nestia/fetcher"`,
147
- `export type { Primitive } from "typia"`,
148
- ],
149
- ],
150
- "Resolved.ts": [
151
- [
152
- `export { Resolved } from "@nestia/fetcher"`,
153
- `export type { Resolved } from "typia"`,
154
- ],
155
- [
156
- `export type { Resolved } from "@nestia/fetcher"`,
157
- `export type { Resolved } from "typia"`,
158
- ],
159
- ],
160
- };
1
+ import fs from "fs";
2
+ import NodePath from "path";
3
+ import { IPointer } from "tstl";
4
+
5
+ import { INestiaConfig } from "../INestiaConfig";
6
+ import { IReflectOperationError } from "../structures/IReflectOperationError";
7
+ import { IReflectType } from "../structures/IReflectType";
8
+ import { ITypedApplication } from "../structures/ITypedApplication";
9
+ import { ITypedHttpRoute } from "../structures/ITypedHttpRoute";
10
+ import { CloneGenerator } from "./CloneGenerator";
11
+ import { SdkDistributionComposer } from "./internal/SdkDistributionComposer";
12
+ import { SdkFileProgrammer } from "./internal/SdkFileProgrammer";
13
+ import { SdkHttpParameterProgrammer } from "./internal/SdkHttpParameterProgrammer";
14
+
15
+ export namespace SdkGenerator {
16
+ export const generate = async (app: ITypedApplication): Promise<void> => {
17
+ if (app.project.config.output === undefined)
18
+ throw new Error("Output directory is not defined.");
19
+
20
+ // PREPARE NEW DIRECTORIES
21
+ console.log("Generating SDK Library");
22
+ try {
23
+ await fs.promises.mkdir(app.project.config.output);
24
+ } catch {}
25
+
26
+ // BUNDLING
27
+ const bundle: string[] = await fs.promises.readdir(BUNDLE_PATH);
28
+ for (const file of bundle) {
29
+ const current: string = `${BUNDLE_PATH}/${file}`;
30
+ const target: string = `${app.project.config.output}/${file}`;
31
+ const stats: fs.Stats = await fs.promises.stat(current);
32
+
33
+ if (stats.isFile() === true) {
34
+ const content: string = await fs.promises.readFile(current, "utf8");
35
+ if (fs.existsSync(target) === false)
36
+ await fs.promises.writeFile(target, content, "utf8");
37
+ else if (BUNDLE_CHANGES[file] !== undefined) {
38
+ const r: IPointer<string> = {
39
+ value: await fs.promises.readFile(target, "utf8"),
40
+ };
41
+ for (const [before, after] of BUNDLE_CHANGES[file])
42
+ r.value = r.value.replace(before, after);
43
+ await fs.promises.writeFile(target, r.value, "utf8");
44
+ }
45
+ }
46
+ }
47
+
48
+ // STRUCTURES
49
+ if (app.project.config.clone === true) await CloneGenerator.write(app);
50
+
51
+ // FUNCTIONAL
52
+ await SdkFileProgrammer.generate(app);
53
+
54
+ // DISTRIBUTION
55
+ if (app.project.config.distribute !== undefined)
56
+ await SdkDistributionComposer.compose({
57
+ config: app.project.config,
58
+ websocket: app.routes.some((r) => r.protocol === "websocket"),
59
+ });
60
+ };
61
+
62
+ export const validate = (
63
+ app: ITypedApplication,
64
+ ): IReflectOperationError[] => {
65
+ const errors: IReflectOperationError[] = [];
66
+ if (app.project.config.clone === true) return errors;
67
+ for (const route of app.routes)
68
+ if (route.protocol === "http")
69
+ validateImplicit({
70
+ config: app.project.config,
71
+ errors,
72
+ route,
73
+ });
74
+ return errors;
75
+ };
76
+
77
+ const validateImplicit = (props: {
78
+ config: INestiaConfig;
79
+ errors: IReflectOperationError[];
80
+ route: ITypedHttpRoute;
81
+ }): void => {
82
+ for (const p of SdkHttpParameterProgrammer.getAll(props.route)) {
83
+ if (isImplicitType(p.type))
84
+ props.errors.push({
85
+ file: props.route.controller.file,
86
+ class: props.route.controller.class.name,
87
+ function: props.route.name,
88
+ from: `parameter ${JSON.stringify(p.name)}`,
89
+ contents: [`implicit (unnamed) parameter type.`],
90
+ });
91
+ }
92
+ if (props.config.propagate === true)
93
+ for (const [key, value] of Object.entries(props.route.exceptions))
94
+ if (isImplicitType(value.type))
95
+ props.errors.push({
96
+ file: props.route.controller.file,
97
+ class: props.route.controller.class.name,
98
+ function: props.route.name,
99
+ from: `exception ${JSON.stringify(key)}`,
100
+ contents: [`implicit (unnamed) exception type.`],
101
+ });
102
+ if (isImplicitType(props.route.success.type))
103
+ props.errors.push({
104
+ file: props.route.controller.file,
105
+ class: props.route.controller.class.name,
106
+ function: props.route.name,
107
+ from: "success",
108
+ contents: [`implicit (unnamed) return type.`],
109
+ });
110
+ };
111
+
112
+ const isImplicitType = (type: IReflectType): boolean =>
113
+ type.name === "__type" ||
114
+ type.name === "__object" ||
115
+ type.name.startsWith("__type.") ||
116
+ type.name.startsWith("__object.") ||
117
+ type.name.includes("readonly [") ||
118
+ (!!type.typeArguments?.length && type.typeArguments.some(isImplicitType));
119
+
120
+ export const BUNDLE_PATH = NodePath.join(
121
+ __dirname,
122
+ "..",
123
+ "..",
124
+ "assets",
125
+ "bundle",
126
+ "api",
127
+ );
128
+ }
129
+
130
+ const BUNDLE_CHANGES: Record<string, [string, string][]> = {
131
+ "IConnection.ts": [
132
+ [
133
+ `export { IConnection } from "@nestia/fetcher"`,
134
+ `export type { IConnection } from "@nestia/fetcher"`,
135
+ ],
136
+ ],
137
+ "module.ts": [
138
+ [`export * from "./IConnection"`, `export type * from "./IConnection"`],
139
+ ],
140
+ "Primitive.ts": [
141
+ [
142
+ `export { Primitive } from "@nestia/fetcher"`,
143
+ `export type { Primitive } from "typia"`,
144
+ ],
145
+ [
146
+ `export type { Primitive } from "@nestia/fetcher"`,
147
+ `export type { Primitive } from "typia"`,
148
+ ],
149
+ ],
150
+ "Resolved.ts": [
151
+ [
152
+ `export { Resolved } from "@nestia/fetcher"`,
153
+ `export type { Resolved } from "typia"`,
154
+ ],
155
+ [
156
+ `export type { Resolved } from "@nestia/fetcher"`,
157
+ `export type { Resolved } from "typia"`,
158
+ ],
159
+ ],
160
+ };