@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,155 +1,155 @@
1
- /// <reference path="../typings/get-function-location.d.ts" />
2
- import { INestApplication, VersioningType } from "@nestjs/common";
3
- import { MODULE_PATH } from "@nestjs/common/constants";
4
- import { NestContainer } from "@nestjs/core";
5
- import { Module } from "@nestjs/core/injector/module";
6
- import fs from "fs";
7
- import getFunctionLocation from "get-function-location";
8
- import path from "path";
9
- import { HashMap, Pair, Singleton } from "tstl";
10
-
11
- import { INestiaConfig } from "../INestiaConfig";
12
- import { SdkGenerator } from "../generates/SdkGenerator";
13
- import { INestiaSdkInput } from "../structures/INestiaSdkInput";
14
- import { ArrayUtil } from "../utils/ArrayUtil";
15
- import { MapUtil } from "../utils/MapUtil";
16
- import { SourceFinder } from "../utils/SourceFinder";
17
-
18
- export namespace ConfigAnalyzer {
19
- export const input = async (
20
- config: INestiaConfig,
21
- ): Promise<INestiaSdkInput> => {
22
- return MapUtil.take(memory, config, async () => {
23
- if (typeof config.input === "function")
24
- return application(await config.input());
25
-
26
- const sources: string[] = await SourceFinder.find({
27
- include: Array.isArray(config.input)
28
- ? config.input
29
- : typeof config.input === "object"
30
- ? config.input.include
31
- : [config.input],
32
- exclude:
33
- typeof config.input === "object" && !Array.isArray(config.input)
34
- ? (config.input.exclude ?? [])
35
- : [],
36
- filter: filter(config),
37
- });
38
- const controllers: INestiaSdkInput.IController[] = [];
39
- for (const file of sources) {
40
- const external: any[] = await import(file);
41
- for (const key in external) {
42
- const instance: Function = external[key];
43
- if (Reflect.getMetadata("path", instance) !== undefined)
44
- controllers.push({
45
- class: instance,
46
- location: file,
47
- prefixes: [],
48
- });
49
- }
50
- }
51
- return {
52
- controllers,
53
- };
54
- });
55
- };
56
-
57
- export const application = async (
58
- app: INestApplication,
59
- ): Promise<INestiaSdkInput> => {
60
- const container: NestContainer = (app as any).container as NestContainer;
61
- const modules: Module[] = [...container.getModules().values()].filter(
62
- (m) => !!m.controllers.size,
63
- );
64
- const unique: HashMap<Function, Set<string>> = new HashMap();
65
-
66
- for (const m of modules) {
67
- const path: string =
68
- Reflect.getMetadata(
69
- MODULE_PATH + container.getModules().applicationId,
70
- m.metatype,
71
- ) ??
72
- Reflect.getMetadata(MODULE_PATH, m.metatype) ??
73
- "";
74
- for (const controller of [...m.controllers.keys()])
75
- if (typeof controller === "function")
76
- unique.take(controller, () => new Set()).add(path);
77
- }
78
- const controllers: INestiaSdkInput.IController[] = [];
79
- for (const it of unique) {
80
- const file: string | null =
81
- (await getFunctionLocation(it.first))?.source ?? null;
82
- if (file === null) continue;
83
- const location: string = normalize_file(file);
84
- if (location.length === 0) continue;
85
- controllers.push({
86
- class: it.first,
87
- prefixes: Array.from(it.second),
88
- location,
89
- });
90
- }
91
-
92
- const versioning = (app as any).config?.versioningOptions;
93
- return {
94
- controllers,
95
- globalPrefix:
96
- typeof (app as any).config?.globalPrefix === "string"
97
- ? {
98
- prefix: (app as any).config.globalPrefix,
99
- exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
100
- }
101
- : undefined,
102
- versioning:
103
- versioning === undefined || versioning.type !== VersioningType.URI
104
- ? undefined
105
- : {
106
- prefix:
107
- versioning.prefix === undefined || versioning.prefix === false
108
- ? "v"
109
- : versioning.prefix,
110
- defaultVersion: versioning.defaultVersion,
111
- },
112
- };
113
- };
114
- }
115
- const memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
116
- const normalize_file = (str: string) =>
117
- str.substring(
118
- str.startsWith("file:///")
119
- ? process.cwd()[0] === "/"
120
- ? 7
121
- : 8
122
- : str.startsWith("file://")
123
- ? 7
124
- : 0,
125
- );
126
-
127
- const filter =
128
- (config: INestiaConfig) =>
129
- async (location: string): Promise<boolean> =>
130
- location.endsWith(".ts") &&
131
- !location.endsWith(".d.ts") &&
132
- (config.output === undefined ||
133
- (location.indexOf(path.join(config.output, "functional")) === -1 &&
134
- (await (
135
- await bundler.get(config.output)
136
- )(location))) === false);
137
-
138
- const bundler = new Singleton(async (output: string) => {
139
- const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
140
- const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
141
- assets,
142
- async (file) => {
143
- const relative: string = path.join(output, file);
144
- const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
145
- const stats: fs.Stats = await fs.promises.stat(location);
146
- return new Pair(relative, stats.isDirectory());
147
- },
148
- );
149
- return async (file: string): Promise<boolean> => {
150
- for (const it of tuples)
151
- if (it.second === false && file === it.first) return true;
152
- else if (it.second === true && file.indexOf(it.first) === 0) return true;
153
- return false;
154
- };
155
- });
1
+ /// <reference path="../typings/get-function-location.d.ts" />
2
+ import { INestApplication, VersioningType } from "@nestjs/common";
3
+ import { MODULE_PATH } from "@nestjs/common/constants";
4
+ import { NestContainer } from "@nestjs/core";
5
+ import { Module } from "@nestjs/core/injector/module";
6
+ import fs from "fs";
7
+ import getFunctionLocation from "get-function-location";
8
+ import path from "path";
9
+ import { HashMap, Pair, Singleton } from "tstl";
10
+
11
+ import { INestiaConfig } from "../INestiaConfig";
12
+ import { SdkGenerator } from "../generates/SdkGenerator";
13
+ import { INestiaSdkInput } from "../structures/INestiaSdkInput";
14
+ import { ArrayUtil } from "../utils/ArrayUtil";
15
+ import { MapUtil } from "../utils/MapUtil";
16
+ import { SourceFinder } from "../utils/SourceFinder";
17
+
18
+ export namespace ConfigAnalyzer {
19
+ export const input = async (
20
+ config: INestiaConfig,
21
+ ): Promise<INestiaSdkInput> => {
22
+ return MapUtil.take(memory, config, async () => {
23
+ if (typeof config.input === "function")
24
+ return application(await config.input());
25
+
26
+ const sources: string[] = await SourceFinder.find({
27
+ include: Array.isArray(config.input)
28
+ ? config.input
29
+ : typeof config.input === "object"
30
+ ? config.input.include
31
+ : [config.input],
32
+ exclude:
33
+ typeof config.input === "object" && !Array.isArray(config.input)
34
+ ? (config.input.exclude ?? [])
35
+ : [],
36
+ filter: filter(config),
37
+ });
38
+ const controllers: INestiaSdkInput.IController[] = [];
39
+ for (const file of sources) {
40
+ const external: any[] = await import(file);
41
+ for (const key in external) {
42
+ const instance: Function = external[key];
43
+ if (Reflect.getMetadata("path", instance) !== undefined)
44
+ controllers.push({
45
+ class: instance,
46
+ location: file,
47
+ prefixes: [],
48
+ });
49
+ }
50
+ }
51
+ return {
52
+ controllers,
53
+ };
54
+ });
55
+ };
56
+
57
+ export const application = async (
58
+ app: INestApplication,
59
+ ): Promise<INestiaSdkInput> => {
60
+ const container: NestContainer = (app as any).container as NestContainer;
61
+ const modules: Module[] = [...container.getModules().values()].filter(
62
+ (m) => !!m.controllers.size,
63
+ );
64
+ const unique: HashMap<Function, Set<string>> = new HashMap();
65
+
66
+ for (const m of modules) {
67
+ const path: string =
68
+ Reflect.getMetadata(
69
+ MODULE_PATH + container.getModules().applicationId,
70
+ m.metatype,
71
+ ) ??
72
+ Reflect.getMetadata(MODULE_PATH, m.metatype) ??
73
+ "";
74
+ for (const controller of [...m.controllers.keys()])
75
+ if (typeof controller === "function")
76
+ unique.take(controller, () => new Set()).add(path);
77
+ }
78
+ const controllers: INestiaSdkInput.IController[] = [];
79
+ for (const it of unique) {
80
+ const file: string | null =
81
+ (await getFunctionLocation(it.first))?.source ?? null;
82
+ if (file === null) continue;
83
+ const location: string = normalize_file(file);
84
+ if (location.length === 0) continue;
85
+ controllers.push({
86
+ class: it.first,
87
+ prefixes: Array.from(it.second),
88
+ location,
89
+ });
90
+ }
91
+
92
+ const versioning = (app as any).config?.versioningOptions;
93
+ return {
94
+ controllers,
95
+ globalPrefix:
96
+ typeof (app as any).config?.globalPrefix === "string"
97
+ ? {
98
+ prefix: (app as any).config.globalPrefix,
99
+ exclude: (app as any).config.globalPrefixOptions?.exclude ?? {},
100
+ }
101
+ : undefined,
102
+ versioning:
103
+ versioning === undefined || versioning.type !== VersioningType.URI
104
+ ? undefined
105
+ : {
106
+ prefix:
107
+ versioning.prefix === undefined || versioning.prefix === false
108
+ ? "v"
109
+ : versioning.prefix,
110
+ defaultVersion: versioning.defaultVersion,
111
+ },
112
+ };
113
+ };
114
+ }
115
+ const memory = new Map<INestiaConfig, Promise<INestiaSdkInput>>();
116
+ const normalize_file = (str: string) =>
117
+ str.substring(
118
+ str.startsWith("file:///")
119
+ ? process.cwd()[0] === "/"
120
+ ? 7
121
+ : 8
122
+ : str.startsWith("file://")
123
+ ? 7
124
+ : 0,
125
+ );
126
+
127
+ const filter =
128
+ (config: INestiaConfig) =>
129
+ async (location: string): Promise<boolean> =>
130
+ location.endsWith(".ts") &&
131
+ !location.endsWith(".d.ts") &&
132
+ (config.output === undefined ||
133
+ (location.indexOf(path.join(config.output, "functional")) === -1 &&
134
+ (await (
135
+ await bundler.get(config.output)
136
+ )(location))) === false);
137
+
138
+ const bundler = new Singleton(async (output: string) => {
139
+ const assets: string[] = await fs.promises.readdir(SdkGenerator.BUNDLE_PATH);
140
+ const tuples: Pair<string, boolean>[] = await ArrayUtil.asyncMap(
141
+ assets,
142
+ async (file) => {
143
+ const relative: string = path.join(output, file);
144
+ const location: string = path.join(SdkGenerator.BUNDLE_PATH, file);
145
+ const stats: fs.Stats = await fs.promises.stat(location);
146
+ return new Pair(relative, stats.isDirectory());
147
+ },
148
+ );
149
+ return async (file: string): Promise<boolean> => {
150
+ for (const it of tuples)
151
+ if (it.second === false && file === it.first) return true;
152
+ else if (it.second === true && file.indexOf(it.first) === 0) return true;
153
+ return false;
154
+ };
155
+ });