@nestia/sdk 4.2.0 → 4.3.0-dev.20241215-2

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