@nestia/sdk 8.0.8 → 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 (116) 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/SdkWebSocketNamespaceProgrammer.js +1 -0
  17. package/lib/generates/internal/SdkWebSocketNamespaceProgrammer.js.map +1 -1
  18. package/lib/generates/internal/SdkWebSocketRouteProgrammer.js +11 -12
  19. package/lib/generates/internal/SdkWebSocketRouteProgrammer.js.map +1 -1
  20. package/package.json +7 -7
  21. package/src/INestiaConfig.ts +267 -267
  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/DtoAnalyzer.ts +246 -246
  27. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  28. package/src/analyses/GenericAnalyzer.ts +49 -49
  29. package/src/analyses/ImportAnalyzer.ts +126 -126
  30. package/src/analyses/PathAnalyzer.ts +69 -69
  31. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  32. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  33. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  34. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  35. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  36. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  37. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  38. package/src/analyses/SecurityAnalyzer.ts +25 -25
  39. package/src/analyses/TypedHttpRouteAnalyzer.ts +204 -204
  40. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  41. package/src/decorators/OperationMetadata.ts +15 -15
  42. package/src/executable/internal/CommandParser.ts +15 -15
  43. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  44. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  45. package/src/executable/sdk.ts +75 -75
  46. package/src/generates/CloneGenerator.ts +66 -66
  47. package/src/generates/E2eGenerator.ts +32 -32
  48. package/src/generates/SdkGenerator.ts +160 -160
  49. package/src/generates/SwaggerGenerator.ts +284 -284
  50. package/src/generates/internal/E2eFileProgrammer.ts +197 -197
  51. package/src/generates/internal/FilePrinter.ts +53 -53
  52. package/src/generates/internal/ImportDictionary.ts +192 -192
  53. package/src/generates/internal/SdkAliasCollection.ts +261 -261
  54. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  55. package/src/generates/internal/SdkFileProgrammer.ts +110 -110
  56. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  57. package/src/generates/internal/SdkHttpCloneReferencer.ts +77 -77
  58. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +279 -279
  59. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +500 -500
  60. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  61. package/src/generates/internal/SdkHttpRouteProgrammer.ts +108 -108
  62. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +310 -310
  63. package/src/generates/internal/SdkImportWizard.ts +62 -62
  64. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  65. package/src/generates/internal/SdkTypeProgrammer.ts +385 -385
  66. package/src/generates/internal/SdkTypeTagProgrammer.ts +104 -104
  67. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +381 -368
  68. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  69. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +302 -282
  70. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  71. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  72. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  73. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  74. package/src/index.ts +4 -4
  75. package/src/module.ts +3 -3
  76. package/src/structures/INestiaProject.ts +13 -13
  77. package/src/structures/INestiaSdkInput.ts +20 -20
  78. package/src/structures/IReflectApplication.ts +8 -8
  79. package/src/structures/IReflectController.ts +15 -15
  80. package/src/structures/IReflectHttpOperation.ts +26 -26
  81. package/src/structures/IReflectHttpOperationException.ts +19 -19
  82. package/src/structures/IReflectHttpOperationParameter.ts +77 -77
  83. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  84. package/src/structures/IReflectImport.ts +6 -6
  85. package/src/structures/IReflectOperationError.ts +26 -26
  86. package/src/structures/IReflectType.ts +4 -4
  87. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  88. package/src/structures/IReflectWebSocketOperationParameter.ts +36 -36
  89. package/src/structures/ITypedApplication.ts +11 -11
  90. package/src/structures/ITypedHttpRoute.ts +41 -41
  91. package/src/structures/ITypedHttpRouteException.ts +15 -15
  92. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  93. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  94. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  95. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  96. package/src/structures/MethodType.ts +5 -5
  97. package/src/structures/ParamCategory.ts +1 -1
  98. package/src/structures/TypeEntry.ts +22 -22
  99. package/src/transform.ts +9 -9
  100. package/src/transformers/IOperationMetadata.ts +44 -44
  101. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  102. package/src/transformers/SdkOperationProgrammer.ts +238 -238
  103. package/src/transformers/SdkOperationTransformer.ts +252 -252
  104. package/src/transformers/TextPlainValidator.ts +17 -17
  105. package/src/typings/get-function-location.d.ts +7 -7
  106. package/src/utils/ArrayUtil.ts +26 -26
  107. package/src/utils/FileRetriever.ts +22 -22
  108. package/src/utils/MapUtil.ts +14 -14
  109. package/src/utils/MetadataUtil.ts +26 -26
  110. package/src/utils/PathUtil.ts +10 -10
  111. package/src/utils/SourceFinder.ts +63 -63
  112. package/src/utils/StringUtil.ts +17 -17
  113. package/src/utils/StripEnums.ts +5 -5
  114. package/src/utils/VersioningStrategy.ts +28 -28
  115. package/src/validators/HttpHeadersValidator.ts +34 -34
  116. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,103 +1,103 @@
1
- import cp from "child_process";
2
- import fs from "fs";
3
- import path from "path";
4
- import typia from "typia";
5
-
6
- import { INestiaConfig } from "../../INestiaConfig";
7
-
8
- export namespace SdkDistributionComposer {
9
- export const compose = async (props: {
10
- config: INestiaConfig;
11
- websocket: boolean;
12
- }) => {
13
- if (!fs.existsSync(props.config.distribute!))
14
- await fs.promises.mkdir(props.config.distribute!);
15
-
16
- const root: string = process.cwd();
17
- const output: string = path.resolve(props.config.output!);
18
- process.chdir(props.config.distribute!);
19
-
20
- const exit = () => process.chdir(root);
21
- if (await configured()) return exit();
22
-
23
- // COPY FILES
24
- console.log("Composing SDK distribution environments...");
25
- for (const file of await fs.promises.readdir(BUNDLE))
26
- await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
27
-
28
- // CONFIGURE PATHS
29
- for (const file of ["package.json", "tsconfig.json"])
30
- await replace({ root, output })(file);
31
-
32
- // INSTALL PACKAGES
33
- const v: IDependencies = await dependencies();
34
- execute("npm install --save-dev rimraf");
35
- execute(`npm install --save @nestia/fetcher@${v.version}`);
36
- execute(`npm install --save typia@${v.typia}`);
37
- if (props.websocket) execute(`npm install --save tgrid@${v.tgrid}`);
38
- execute("npx typia setup --manager npm");
39
-
40
- exit();
41
- };
42
-
43
- const configured = async (): Promise<boolean> =>
44
- ["package.json", "tsconfig.json"].every(fs.existsSync) &&
45
- (await (async () => {
46
- const content = JSON.parse(
47
- await fs.promises.readFile("package.json", "utf8"),
48
- );
49
- return !!content.dependencies?.["@nestia/fetcher"];
50
- })());
51
-
52
- const execute = (command: string) => {
53
- console.log(` - ${command}`);
54
- cp.execSync(command, { stdio: "ignore" });
55
- };
56
-
57
- const replace =
58
- (props: { root: string; output: string }) =>
59
- async (file: string): Promise<void> => {
60
- const relative = (from: string) => (to: string) =>
61
- path.relative(from, to).split("\\").join("/");
62
- const root: string = relative(process.cwd())(props.root);
63
- const output: string = relative(process.cwd())(props.output);
64
- const current: string = relative(props.root)(process.cwd());
65
-
66
- const content: string = await fs.promises.readFile(file, "utf8");
67
- await fs.promises.writeFile(
68
- file,
69
- content
70
- .split("${root}")
71
- .join(root)
72
- .split("${output}")
73
- .join(output)
74
- .split("${current}")
75
- .join(current),
76
- "utf8",
77
- );
78
- };
79
-
80
- const dependencies = async (): Promise<IDependencies> => {
81
- const content: string = await fs.promises.readFile(
82
- __dirname + "/../../../package.json",
83
- "utf8",
84
- );
85
- const json: {
86
- version: string;
87
- dependencies: Record<string, string>;
88
- devDependencies: Record<string, string>;
89
- } = JSON.parse(content);
90
- return typia.assert<IDependencies>({
91
- ...json.devDependencies,
92
- ...json.dependencies,
93
- version: json.version,
94
- });
95
- };
96
- }
97
-
98
- interface IDependencies {
99
- version: string;
100
- typia: string;
101
- tgrid: string;
102
- }
103
- const BUNDLE = __dirname + "/../../../assets/bundle/distribute";
1
+ import cp from "child_process";
2
+ import fs from "fs";
3
+ import path from "path";
4
+ import typia from "typia";
5
+
6
+ import { INestiaConfig } from "../../INestiaConfig";
7
+
8
+ export namespace SdkDistributionComposer {
9
+ export const compose = async (props: {
10
+ config: INestiaConfig;
11
+ websocket: boolean;
12
+ }) => {
13
+ if (!fs.existsSync(props.config.distribute!))
14
+ await fs.promises.mkdir(props.config.distribute!);
15
+
16
+ const root: string = process.cwd();
17
+ const output: string = path.resolve(props.config.output!);
18
+ process.chdir(props.config.distribute!);
19
+
20
+ const exit = () => process.chdir(root);
21
+ if (await configured()) return exit();
22
+
23
+ // COPY FILES
24
+ console.log("Composing SDK distribution environments...");
25
+ for (const file of await fs.promises.readdir(BUNDLE))
26
+ await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
27
+
28
+ // CONFIGURE PATHS
29
+ for (const file of ["package.json", "tsconfig.json"])
30
+ await replace({ root, output })(file);
31
+
32
+ // INSTALL PACKAGES
33
+ const v: IDependencies = await dependencies();
34
+ execute("npm install --save-dev rimraf");
35
+ execute(`npm install --save @nestia/fetcher@${v.version}`);
36
+ execute(`npm install --save typia@${v.typia}`);
37
+ if (props.websocket) execute(`npm install --save tgrid@${v.tgrid}`);
38
+ execute("npx typia setup --manager npm");
39
+
40
+ exit();
41
+ };
42
+
43
+ const configured = async (): Promise<boolean> =>
44
+ ["package.json", "tsconfig.json"].every(fs.existsSync) &&
45
+ (await (async () => {
46
+ const content = JSON.parse(
47
+ await fs.promises.readFile("package.json", "utf8"),
48
+ );
49
+ return !!content.dependencies?.["@nestia/fetcher"];
50
+ })());
51
+
52
+ const execute = (command: string) => {
53
+ console.log(` - ${command}`);
54
+ cp.execSync(command, { stdio: "ignore" });
55
+ };
56
+
57
+ const replace =
58
+ (props: { root: string; output: string }) =>
59
+ async (file: string): Promise<void> => {
60
+ const relative = (from: string) => (to: string) =>
61
+ path.relative(from, to).split("\\").join("/");
62
+ const root: string = relative(process.cwd())(props.root);
63
+ const output: string = relative(process.cwd())(props.output);
64
+ const current: string = relative(props.root)(process.cwd());
65
+
66
+ const content: string = await fs.promises.readFile(file, "utf8");
67
+ await fs.promises.writeFile(
68
+ file,
69
+ content
70
+ .split("${root}")
71
+ .join(root)
72
+ .split("${output}")
73
+ .join(output)
74
+ .split("${current}")
75
+ .join(current),
76
+ "utf8",
77
+ );
78
+ };
79
+
80
+ const dependencies = async (): Promise<IDependencies> => {
81
+ const content: string = await fs.promises.readFile(
82
+ __dirname + "/../../../package.json",
83
+ "utf8",
84
+ );
85
+ const json: {
86
+ version: string;
87
+ dependencies: Record<string, string>;
88
+ devDependencies: Record<string, string>;
89
+ } = JSON.parse(content);
90
+ return typia.assert<IDependencies>({
91
+ ...json.devDependencies,
92
+ ...json.dependencies,
93
+ version: json.version,
94
+ });
95
+ };
96
+ }
97
+
98
+ interface IDependencies {
99
+ version: string;
100
+ typia: string;
101
+ tgrid: string;
102
+ }
103
+ const BUNDLE = __dirname + "/../../../assets/bundle/distribute";
@@ -1,110 +1,110 @@
1
- import fs from "fs";
2
- import ts from "typescript";
3
-
4
- import { INestiaProject } from "../../structures/INestiaProject";
5
- import { ITypedApplication } from "../../structures/ITypedApplication";
6
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
- import { ITypedWebSocketRoute } from "../../structures/ITypedWebSocketRoute";
8
- import { MapUtil } from "../../utils/MapUtil";
9
- import { FilePrinter } from "./FilePrinter";
10
- import { ImportDictionary } from "./ImportDictionary";
11
- import { SdkHttpRouteProgrammer } from "./SdkHttpRouteProgrammer";
12
- import { SdkRouteDirectory } from "./SdkRouteDirectory";
13
- import { SdkWebSocketRouteProgrammer } from "./SdkWebSocketRouteProgrammer";
14
-
15
- export namespace SdkFileProgrammer {
16
- /* ---------------------------------------------------------
17
- CONSTRUCTOR
18
- --------------------------------------------------------- */
19
- export const generate = async (app: ITypedApplication): Promise<void> => {
20
- // CONSTRUCT FOLDER TREE
21
- const root: SdkRouteDirectory = new SdkRouteDirectory(null, "functional");
22
- for (const route of app.routes) emplace(root)(route);
23
-
24
- // ITERATE FILES
25
- await iterate(app.project)(root)(`${app.project.config.output}/functional`);
26
- };
27
-
28
- const emplace =
29
- (directory: SdkRouteDirectory) =>
30
- (route: ITypedHttpRoute | ITypedWebSocketRoute): void => {
31
- // OPEN DIRECTORIES
32
- for (const key of route.accessor.slice(0, -1)) {
33
- directory = MapUtil.take(
34
- directory.children,
35
- key,
36
- () => new SdkRouteDirectory(directory, key),
37
- );
38
- }
39
-
40
- // ADD ROUTE
41
- directory.routes.push(route);
42
- };
43
-
44
- /* ---------------------------------------------------------
45
- FILE ITERATOR
46
- --------------------------------------------------------- */
47
- const iterate =
48
- (project: INestiaProject) =>
49
- (directory: SdkRouteDirectory) =>
50
- async (outDir: string): Promise<void> => {
51
- // CREATE A NEW DIRECTORY
52
- try {
53
- await fs.promises.mkdir(outDir);
54
- } catch {}
55
-
56
- // ITERATE CHILDREN
57
- const statements: ts.Statement[] = [];
58
- for (const [key, value] of directory.children) {
59
- await iterate(project)(value)(`${outDir}/${key}`);
60
- statements.push(
61
- ts.factory.createExportDeclaration(
62
- undefined,
63
- false,
64
- ts.factory.createNamespaceExport(ts.factory.createIdentifier(key)),
65
- ts.factory.createStringLiteral(`./${key}/index`),
66
- undefined,
67
- ),
68
- );
69
- }
70
- if (statements.length && directory.routes.length)
71
- statements.push(FilePrinter.enter());
72
-
73
- // ITERATE ROUTES
74
- const importer: ImportDictionary = new ImportDictionary(
75
- `${outDir}/index.ts`,
76
- );
77
- directory.routes.forEach((route, i) => {
78
- if (!(project.config.clone === true && route.protocol === "http"))
79
- importer.declarations(route.imports);
80
- statements.push(
81
- ...(route.protocol === "http"
82
- ? SdkHttpRouteProgrammer.write(project)(importer)(route)
83
- : SdkWebSocketRouteProgrammer.write(project)(importer)(route)),
84
- );
85
- if (i !== directory.routes.length - 1)
86
- statements.push(FilePrinter.enter());
87
- });
88
-
89
- // FINALIZE THE CONTENT
90
- if (directory.routes.length !== 0)
91
- statements.push(
92
- ...importer.toStatements(outDir),
93
- ...(!importer.empty() && statements.length
94
- ? [FilePrinter.enter()]
95
- : []),
96
- ...statements.splice(0, statements.length),
97
- );
98
- await FilePrinter.write({
99
- location: importer.file,
100
- statements,
101
- top:
102
- "/**\n" +
103
- " * @packageDocumentation\n" +
104
- ` * @module ${directory.module}\n` +
105
- " * @nestia Generated by Nestia - https://github.com/samchon/nestia \n" +
106
- " */\n" +
107
- "//================================================================\n",
108
- });
109
- };
110
- }
1
+ import fs from "fs";
2
+ import ts from "typescript";
3
+
4
+ import { INestiaProject } from "../../structures/INestiaProject";
5
+ import { ITypedApplication } from "../../structures/ITypedApplication";
6
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
7
+ import { ITypedWebSocketRoute } from "../../structures/ITypedWebSocketRoute";
8
+ import { MapUtil } from "../../utils/MapUtil";
9
+ import { FilePrinter } from "./FilePrinter";
10
+ import { ImportDictionary } from "./ImportDictionary";
11
+ import { SdkHttpRouteProgrammer } from "./SdkHttpRouteProgrammer";
12
+ import { SdkRouteDirectory } from "./SdkRouteDirectory";
13
+ import { SdkWebSocketRouteProgrammer } from "./SdkWebSocketRouteProgrammer";
14
+
15
+ export namespace SdkFileProgrammer {
16
+ /* ---------------------------------------------------------
17
+ CONSTRUCTOR
18
+ --------------------------------------------------------- */
19
+ export const generate = async (app: ITypedApplication): Promise<void> => {
20
+ // CONSTRUCT FOLDER TREE
21
+ const root: SdkRouteDirectory = new SdkRouteDirectory(null, "functional");
22
+ for (const route of app.routes) emplace(root)(route);
23
+
24
+ // ITERATE FILES
25
+ await iterate(app.project)(root)(`${app.project.config.output}/functional`);
26
+ };
27
+
28
+ const emplace =
29
+ (directory: SdkRouteDirectory) =>
30
+ (route: ITypedHttpRoute | ITypedWebSocketRoute): void => {
31
+ // OPEN DIRECTORIES
32
+ for (const key of route.accessor.slice(0, -1)) {
33
+ directory = MapUtil.take(
34
+ directory.children,
35
+ key,
36
+ () => new SdkRouteDirectory(directory, key),
37
+ );
38
+ }
39
+
40
+ // ADD ROUTE
41
+ directory.routes.push(route);
42
+ };
43
+
44
+ /* ---------------------------------------------------------
45
+ FILE ITERATOR
46
+ --------------------------------------------------------- */
47
+ const iterate =
48
+ (project: INestiaProject) =>
49
+ (directory: SdkRouteDirectory) =>
50
+ async (outDir: string): Promise<void> => {
51
+ // CREATE A NEW DIRECTORY
52
+ try {
53
+ await fs.promises.mkdir(outDir);
54
+ } catch {}
55
+
56
+ // ITERATE CHILDREN
57
+ const statements: ts.Statement[] = [];
58
+ for (const [key, value] of directory.children) {
59
+ await iterate(project)(value)(`${outDir}/${key}`);
60
+ statements.push(
61
+ ts.factory.createExportDeclaration(
62
+ undefined,
63
+ false,
64
+ ts.factory.createNamespaceExport(ts.factory.createIdentifier(key)),
65
+ ts.factory.createStringLiteral(`./${key}/index`),
66
+ undefined,
67
+ ),
68
+ );
69
+ }
70
+ if (statements.length && directory.routes.length)
71
+ statements.push(FilePrinter.enter());
72
+
73
+ // ITERATE ROUTES
74
+ const importer: ImportDictionary = new ImportDictionary(
75
+ `${outDir}/index.ts`,
76
+ );
77
+ directory.routes.forEach((route, i) => {
78
+ if (!(project.config.clone === true && route.protocol === "http"))
79
+ importer.declarations(route.imports);
80
+ statements.push(
81
+ ...(route.protocol === "http"
82
+ ? SdkHttpRouteProgrammer.write(project)(importer)(route)
83
+ : SdkWebSocketRouteProgrammer.write(project)(importer)(route)),
84
+ );
85
+ if (i !== directory.routes.length - 1)
86
+ statements.push(FilePrinter.enter());
87
+ });
88
+
89
+ // FINALIZE THE CONTENT
90
+ if (directory.routes.length !== 0)
91
+ statements.push(
92
+ ...importer.toStatements(outDir),
93
+ ...(!importer.empty() && statements.length
94
+ ? [FilePrinter.enter()]
95
+ : []),
96
+ ...statements.splice(0, statements.length),
97
+ );
98
+ await FilePrinter.write({
99
+ location: importer.file,
100
+ statements,
101
+ top:
102
+ "/**\n" +
103
+ " * @packageDocumentation\n" +
104
+ ` * @module ${directory.module}\n` +
105
+ " * @nestia Generated by Nestia - https://github.com/samchon/nestia \n" +
106
+ " */\n" +
107
+ "//================================================================\n",
108
+ });
109
+ };
110
+ }