@nestia/sdk 9.0.0-dev.20251107-2 → 9.0.0

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 (113) 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/internal/NestiaSdkCommand.js +1 -1
  16. package/lib/executable/sdk.js +12 -12
  17. package/package.json +4 -4
  18. package/src/INestiaConfig.ts +267 -267
  19. package/src/NestiaSdkApplication.ts +307 -307
  20. package/src/NestiaSwaggerComposer.ts +138 -138
  21. package/src/analyses/AccessorAnalyzer.ts +67 -67
  22. package/src/analyses/ConfigAnalyzer.ts +155 -155
  23. package/src/analyses/DtoAnalyzer.ts +246 -246
  24. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  25. package/src/analyses/GenericAnalyzer.ts +49 -49
  26. package/src/analyses/ImportAnalyzer.ts +126 -126
  27. package/src/analyses/PathAnalyzer.ts +69 -69
  28. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  29. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  30. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  31. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  32. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  33. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  34. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  35. package/src/analyses/SecurityAnalyzer.ts +25 -25
  36. package/src/analyses/TypedHttpRouteAnalyzer.ts +204 -204
  37. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  38. package/src/decorators/OperationMetadata.ts +15 -15
  39. package/src/executable/internal/CommandParser.ts +15 -15
  40. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  41. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  42. package/src/executable/sdk.ts +75 -75
  43. package/src/generates/CloneGenerator.ts +66 -66
  44. package/src/generates/E2eGenerator.ts +32 -32
  45. package/src/generates/SdkGenerator.ts +160 -160
  46. package/src/generates/SwaggerGenerator.ts +284 -284
  47. package/src/generates/internal/E2eFileProgrammer.ts +197 -197
  48. package/src/generates/internal/FilePrinter.ts +53 -53
  49. package/src/generates/internal/ImportDictionary.ts +192 -192
  50. package/src/generates/internal/SdkAliasCollection.ts +261 -261
  51. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  52. package/src/generates/internal/SdkFileProgrammer.ts +110 -110
  53. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  54. package/src/generates/internal/SdkHttpCloneReferencer.ts +77 -77
  55. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +279 -279
  56. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +500 -500
  57. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  58. package/src/generates/internal/SdkHttpRouteProgrammer.ts +108 -108
  59. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +310 -310
  60. package/src/generates/internal/SdkImportWizard.ts +62 -62
  61. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  62. package/src/generates/internal/SdkTypeProgrammer.ts +385 -385
  63. package/src/generates/internal/SdkTypeTagProgrammer.ts +104 -104
  64. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +381 -381
  65. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  66. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +302 -302
  67. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  68. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  69. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  70. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  71. package/src/index.ts +4 -4
  72. package/src/module.ts +3 -3
  73. package/src/structures/INestiaProject.ts +13 -13
  74. package/src/structures/INestiaSdkInput.ts +20 -20
  75. package/src/structures/IReflectApplication.ts +8 -8
  76. package/src/structures/IReflectController.ts +15 -15
  77. package/src/structures/IReflectHttpOperation.ts +26 -26
  78. package/src/structures/IReflectHttpOperationException.ts +19 -19
  79. package/src/structures/IReflectHttpOperationParameter.ts +77 -77
  80. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  81. package/src/structures/IReflectImport.ts +6 -6
  82. package/src/structures/IReflectOperationError.ts +26 -26
  83. package/src/structures/IReflectType.ts +4 -4
  84. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  85. package/src/structures/IReflectWebSocketOperationParameter.ts +36 -36
  86. package/src/structures/ITypedApplication.ts +11 -11
  87. package/src/structures/ITypedHttpRoute.ts +41 -41
  88. package/src/structures/ITypedHttpRouteException.ts +15 -15
  89. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  90. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  91. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  92. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  93. package/src/structures/MethodType.ts +5 -5
  94. package/src/structures/ParamCategory.ts +1 -1
  95. package/src/structures/TypeEntry.ts +22 -22
  96. package/src/transform.ts +9 -9
  97. package/src/transformers/IOperationMetadata.ts +44 -44
  98. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  99. package/src/transformers/SdkOperationProgrammer.ts +238 -238
  100. package/src/transformers/SdkOperationTransformer.ts +252 -252
  101. package/src/transformers/TextPlainValidator.ts +17 -17
  102. package/src/typings/get-function-location.d.ts +7 -7
  103. package/src/utils/ArrayUtil.ts +26 -26
  104. package/src/utils/FileRetriever.ts +22 -22
  105. package/src/utils/MapUtil.ts +14 -14
  106. package/src/utils/MetadataUtil.ts +26 -26
  107. package/src/utils/PathUtil.ts +10 -10
  108. package/src/utils/SourceFinder.ts +63 -63
  109. package/src/utils/StringUtil.ts +17 -17
  110. package/src/utils/StripEnums.ts +5 -5
  111. package/src/utils/VersioningStrategy.ts +28 -28
  112. package/src/validators/HttpHeadersValidator.ts +34 -34
  113. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,69 +1,69 @@
1
- import path from "path";
2
- import { Token, parse } from "path-to-regexp";
3
-
4
- export namespace PathAnalyzer {
5
- export const join = (...args: string[]) =>
6
- "/" +
7
- _Trim(
8
- path
9
- .join(...args.filter((s) => !!s.length))
10
- .split("\\")
11
- .join("/"),
12
- );
13
-
14
- export const escape = (str: string): string | null => {
15
- const args = _Parse(str);
16
- if (args === null) return null;
17
- return (
18
- "/" +
19
- args
20
- .map((arg) => (arg.type === "param" ? `:${arg.value}` : arg.value))
21
- .join("/")
22
- );
23
- };
24
-
25
- export const parameters = (str: string): string[] | null => {
26
- const args = _Parse(str);
27
- if (args === null) return null;
28
- return args.filter((arg) => arg.type === "param").map((arg) => arg.value);
29
- };
30
-
31
- function _Parse(str: string): IArgument[] | null {
32
- const tokens: Token[] | null = (() => {
33
- try {
34
- return parse(path.join(str).split("\\").join("/"));
35
- } catch {
36
- return null;
37
- }
38
- })();
39
- if (tokens === null) return null;
40
-
41
- const output: IArgument[] = [];
42
- for (const key of tokens) {
43
- if (typeof key === "string")
44
- output.push({
45
- type: "path",
46
- value: _Trim(key),
47
- });
48
- else if (typeof key.name === "number" || _Trim(key.name) === "")
49
- return null;
50
- else
51
- output.push({
52
- type: "param",
53
- value: _Trim(key.name),
54
- });
55
- }
56
- return output;
57
- }
58
-
59
- function _Trim(str: string): string {
60
- if (str[0] === "/") str = str.substring(1);
61
- if (str[str.length - 1] === "/") str = str.substring(0, str.length - 1);
62
- return str;
63
- }
64
-
65
- interface IArgument {
66
- type: "param" | "path";
67
- value: string;
68
- }
69
- }
1
+ import path from "path";
2
+ import { Token, parse } from "path-to-regexp";
3
+
4
+ export namespace PathAnalyzer {
5
+ export const join = (...args: string[]) =>
6
+ "/" +
7
+ _Trim(
8
+ path
9
+ .join(...args.filter((s) => !!s.length))
10
+ .split("\\")
11
+ .join("/"),
12
+ );
13
+
14
+ export const escape = (str: string): string | null => {
15
+ const args = _Parse(str);
16
+ if (args === null) return null;
17
+ return (
18
+ "/" +
19
+ args
20
+ .map((arg) => (arg.type === "param" ? `:${arg.value}` : arg.value))
21
+ .join("/")
22
+ );
23
+ };
24
+
25
+ export const parameters = (str: string): string[] | null => {
26
+ const args = _Parse(str);
27
+ if (args === null) return null;
28
+ return args.filter((arg) => arg.type === "param").map((arg) => arg.value);
29
+ };
30
+
31
+ function _Parse(str: string): IArgument[] | null {
32
+ const tokens: Token[] | null = (() => {
33
+ try {
34
+ return parse(path.join(str).split("\\").join("/"));
35
+ } catch {
36
+ return null;
37
+ }
38
+ })();
39
+ if (tokens === null) return null;
40
+
41
+ const output: IArgument[] = [];
42
+ for (const key of tokens) {
43
+ if (typeof key === "string")
44
+ output.push({
45
+ type: "path",
46
+ value: _Trim(key),
47
+ });
48
+ else if (typeof key.name === "number" || _Trim(key.name) === "")
49
+ return null;
50
+ else
51
+ output.push({
52
+ type: "param",
53
+ value: _Trim(key.name),
54
+ });
55
+ }
56
+ return output;
57
+ }
58
+
59
+ function _Trim(str: string): string {
60
+ if (str[0] === "/") str = str.substring(1);
61
+ if (str[str.length - 1] === "/") str = str.substring(0, str.length - 1);
62
+ return str;
63
+ }
64
+
65
+ interface IArgument {
66
+ type: "param" | "path";
67
+ value: string;
68
+ }
69
+ }
@@ -1,105 +1,105 @@
1
- import {
2
- HOST_METADATA,
3
- PATH_METADATA,
4
- SCOPE_OPTIONS_METADATA,
5
- } from "@nestjs/common/constants";
6
-
7
- import { INestiaProject } from "../structures/INestiaProject";
8
- import { INestiaSdkInput } from "../structures/INestiaSdkInput";
9
- import { IReflectController } from "../structures/IReflectController";
10
- import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
11
- import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
12
- import { IOperationMetadata } from "../transformers/IOperationMetadata";
13
- import { ArrayUtil } from "../utils/ArrayUtil";
14
- import { ReflectHttpOperationAnalyzer } from "./ReflectHttpOperationAnalyzer";
15
- import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
16
- import { ReflectWebSocketOperationAnalyzer } from "./ReflectWebSocketOperationAnalyzer";
17
-
18
- export namespace ReflectControllerAnalyzer {
19
- export interface IProps {
20
- project: Omit<INestiaProject, "config">;
21
- controller: INestiaSdkInput.IController;
22
- unique: WeakSet<Function>;
23
- }
24
- /* ---------------------------------------------------------
25
- CONTROLLER
26
- --------------------------------------------------------- */
27
- export const analyze = (props: IProps): IReflectController | null => {
28
- // MUST BE TYPE OF A CREATOR WHO HAS THE CONSTRUCTOR
29
- if (
30
- ArrayUtil.has(
31
- Reflect.getMetadataKeys(props.controller.class),
32
- PATH_METADATA,
33
- HOST_METADATA,
34
- SCOPE_OPTIONS_METADATA,
35
- ) === false
36
- )
37
- return null;
38
-
39
- // BASIC INFO
40
- const controller: IReflectController = {
41
- class: props.controller.class,
42
- file: props.controller.location,
43
- operations: [],
44
- prefixes: props.controller.prefixes,
45
- paths: ReflectMetadataAnalyzer.paths(props.controller.class).filter(
46
- (str) => {
47
- if (str.includes("*") === true) {
48
- props.project.warnings.push({
49
- file: props.controller.location,
50
- class: props.controller.class.name,
51
- function: null,
52
- from: null,
53
- contents: ["@nestia/sdk does not compose wildcard controller."],
54
- });
55
- return false;
56
- }
57
- return true;
58
- },
59
- ),
60
- versions: ReflectMetadataAnalyzer.versions(props.controller.class),
61
- security: ReflectMetadataAnalyzer.securities(props.controller.class),
62
- tags:
63
- Reflect.getMetadata("swagger/apiUseTags", props.controller.class) ?? [],
64
- };
65
-
66
- // OPERATORS
67
- for (const [key, value] of _Get_prototype_entries(props.controller.class)) {
68
- if (typeof value !== "function") continue;
69
- const metadata: IOperationMetadata | undefined = Reflect.getMetadata(
70
- "nestia/OperationMetadata",
71
- props.controller.class.prototype,
72
- key,
73
- );
74
- if (metadata === undefined) continue;
75
- else if (metadata.jsDocTags.some((tag) => tag.name === "ignore"))
76
- continue;
77
- const next: ReflectHttpOperationAnalyzer.IProps = {
78
- project: props.project,
79
- controller: controller,
80
- name: key,
81
- function: value,
82
- metadata,
83
- };
84
- const child: IReflectHttpOperation | IReflectWebSocketOperation | null =
85
- ReflectWebSocketOperationAnalyzer.analyze(next) ??
86
- ReflectHttpOperationAnalyzer.analyze(next);
87
- if (child !== null) controller.operations.push(child);
88
- }
89
- return controller;
90
- };
91
-
92
- function _Get_prototype_entries(creator: any): Array<[string, unknown]> {
93
- const keyList = Object.getOwnPropertyNames(creator.prototype);
94
- const entries: Array<[string, unknown]> = keyList.map((key) => [
95
- key,
96
- creator.prototype[key],
97
- ]);
98
-
99
- const parent = Object.getPrototypeOf(creator);
100
- if (parent.prototype !== undefined)
101
- entries.push(..._Get_prototype_entries(parent));
102
-
103
- return entries;
104
- }
105
- }
1
+ import {
2
+ HOST_METADATA,
3
+ PATH_METADATA,
4
+ SCOPE_OPTIONS_METADATA,
5
+ } from "@nestjs/common/constants";
6
+
7
+ import { INestiaProject } from "../structures/INestiaProject";
8
+ import { INestiaSdkInput } from "../structures/INestiaSdkInput";
9
+ import { IReflectController } from "../structures/IReflectController";
10
+ import { IReflectHttpOperation } from "../structures/IReflectHttpOperation";
11
+ import { IReflectWebSocketOperation } from "../structures/IReflectWebSocketOperation";
12
+ import { IOperationMetadata } from "../transformers/IOperationMetadata";
13
+ import { ArrayUtil } from "../utils/ArrayUtil";
14
+ import { ReflectHttpOperationAnalyzer } from "./ReflectHttpOperationAnalyzer";
15
+ import { ReflectMetadataAnalyzer } from "./ReflectMetadataAnalyzer";
16
+ import { ReflectWebSocketOperationAnalyzer } from "./ReflectWebSocketOperationAnalyzer";
17
+
18
+ export namespace ReflectControllerAnalyzer {
19
+ export interface IProps {
20
+ project: Omit<INestiaProject, "config">;
21
+ controller: INestiaSdkInput.IController;
22
+ unique: WeakSet<Function>;
23
+ }
24
+ /* ---------------------------------------------------------
25
+ CONTROLLER
26
+ --------------------------------------------------------- */
27
+ export const analyze = (props: IProps): IReflectController | null => {
28
+ // MUST BE TYPE OF A CREATOR WHO HAS THE CONSTRUCTOR
29
+ if (
30
+ ArrayUtil.has(
31
+ Reflect.getMetadataKeys(props.controller.class),
32
+ PATH_METADATA,
33
+ HOST_METADATA,
34
+ SCOPE_OPTIONS_METADATA,
35
+ ) === false
36
+ )
37
+ return null;
38
+
39
+ // BASIC INFO
40
+ const controller: IReflectController = {
41
+ class: props.controller.class,
42
+ file: props.controller.location,
43
+ operations: [],
44
+ prefixes: props.controller.prefixes,
45
+ paths: ReflectMetadataAnalyzer.paths(props.controller.class).filter(
46
+ (str) => {
47
+ if (str.includes("*") === true) {
48
+ props.project.warnings.push({
49
+ file: props.controller.location,
50
+ class: props.controller.class.name,
51
+ function: null,
52
+ from: null,
53
+ contents: ["@nestia/sdk does not compose wildcard controller."],
54
+ });
55
+ return false;
56
+ }
57
+ return true;
58
+ },
59
+ ),
60
+ versions: ReflectMetadataAnalyzer.versions(props.controller.class),
61
+ security: ReflectMetadataAnalyzer.securities(props.controller.class),
62
+ tags:
63
+ Reflect.getMetadata("swagger/apiUseTags", props.controller.class) ?? [],
64
+ };
65
+
66
+ // OPERATORS
67
+ for (const [key, value] of _Get_prototype_entries(props.controller.class)) {
68
+ if (typeof value !== "function") continue;
69
+ const metadata: IOperationMetadata | undefined = Reflect.getMetadata(
70
+ "nestia/OperationMetadata",
71
+ props.controller.class.prototype,
72
+ key,
73
+ );
74
+ if (metadata === undefined) continue;
75
+ else if (metadata.jsDocTags.some((tag) => tag.name === "ignore"))
76
+ continue;
77
+ const next: ReflectHttpOperationAnalyzer.IProps = {
78
+ project: props.project,
79
+ controller: controller,
80
+ name: key,
81
+ function: value,
82
+ metadata,
83
+ };
84
+ const child: IReflectHttpOperation | IReflectWebSocketOperation | null =
85
+ ReflectWebSocketOperationAnalyzer.analyze(next) ??
86
+ ReflectHttpOperationAnalyzer.analyze(next);
87
+ if (child !== null) controller.operations.push(child);
88
+ }
89
+ return controller;
90
+ };
91
+
92
+ function _Get_prototype_entries(creator: any): Array<[string, unknown]> {
93
+ const keyList = Object.getOwnPropertyNames(creator.prototype);
94
+ const entries: Array<[string, unknown]> = keyList.map((key) => [
95
+ key,
96
+ creator.prototype[key],
97
+ ]);
98
+
99
+ const parent = Object.getPrototypeOf(creator);
100
+ if (parent.prototype !== undefined)
101
+ entries.push(..._Get_prototype_entries(parent));
102
+
103
+ return entries;
104
+ }
105
+ }