@nestia/sdk 11.0.0-dev.20260312 → 11.0.0-dev.20260313

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 (58) hide show
  1. package/assets/bundle/distribute/package.json +1 -1
  2. package/lib/INestiaConfig.d.ts +2 -2
  3. package/lib/NestiaSwaggerComposer.d.ts +1 -2
  4. package/lib/NestiaSwaggerComposer.js +6 -2
  5. package/lib/NestiaSwaggerComposer.js.map +1 -1
  6. package/lib/executable/internal/NestiaConfigLoader.js +8 -63
  7. package/lib/executable/internal/NestiaConfigLoader.js.map +1 -1
  8. package/lib/executable/sdk.js +12 -12
  9. package/lib/generates/SwaggerGenerator.js +6 -5
  10. package/lib/generates/SwaggerGenerator.js.map +1 -1
  11. package/package.json +8 -8
  12. package/src/analyses/ConfigAnalyzer.ts +155 -155
  13. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  14. package/src/analyses/GenericAnalyzer.ts +49 -49
  15. package/src/analyses/PathAnalyzer.ts +69 -69
  16. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  17. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  18. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  19. package/src/analyses/SecurityAnalyzer.ts +25 -25
  20. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  21. package/src/decorators/OperationMetadata.ts +15 -15
  22. package/src/executable/internal/CommandParser.ts +15 -15
  23. package/src/executable/sdk.ts +75 -75
  24. package/src/generates/CloneGenerator.ts +66 -66
  25. package/src/generates/E2eGenerator.ts +32 -32
  26. package/src/generates/SdkGenerator.ts +160 -160
  27. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  28. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  29. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  30. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  31. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  32. package/src/index.ts +4 -4
  33. package/src/structures/INestiaProject.ts +13 -13
  34. package/src/structures/INestiaSdkInput.ts +20 -20
  35. package/src/structures/IReflectApplication.ts +8 -8
  36. package/src/structures/IReflectController.ts +15 -15
  37. package/src/structures/IReflectHttpOperation.ts +26 -26
  38. package/src/structures/IReflectImport.ts +6 -6
  39. package/src/structures/IReflectOperationError.ts +26 -26
  40. package/src/structures/IReflectType.ts +4 -4
  41. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  42. package/src/structures/IReflectWebSocketOperationParameter.ts +36 -36
  43. package/src/structures/ITypedHttpRoute.ts +41 -41
  44. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  45. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  46. package/src/structures/MethodType.ts +5 -5
  47. package/src/structures/ParamCategory.ts +1 -1
  48. package/src/structures/TypeEntry.ts +22 -22
  49. package/src/transform.ts +9 -9
  50. package/src/typings/get-function-location.d.ts +7 -7
  51. package/src/utils/ArrayUtil.ts +26 -26
  52. package/src/utils/FileRetriever.ts +22 -22
  53. package/src/utils/MapUtil.ts +14 -14
  54. package/src/utils/PathUtil.ts +10 -10
  55. package/src/utils/SourceFinder.ts +63 -63
  56. package/src/utils/StringUtil.ts +17 -17
  57. package/src/utils/StripEnums.ts +5 -5
  58. package/src/utils/VersioningStrategy.ts +28 -28
@@ -1,49 +1,49 @@
1
- import ts from "typescript";
2
-
3
- export namespace GenericAnalyzer {
4
- export function analyze(
5
- checker: ts.TypeChecker,
6
- classNode: ts.ClassDeclaration,
7
- ): WeakMap<ts.Type, ts.Type> {
8
- const dict: WeakMap<ts.Type, ts.Type> = new WeakMap();
9
- explore(checker, dict, classNode);
10
- return dict;
11
- }
12
-
13
- function explore(
14
- checker: ts.TypeChecker,
15
- dict: WeakMap<ts.Type, ts.Type>,
16
- classNode: ts.ClassDeclaration,
17
- ): void {
18
- if (classNode.heritageClauses === undefined) return;
19
-
20
- for (const heritage of classNode.heritageClauses)
21
- for (const hType of heritage.types) {
22
- // MUST BE CLASS
23
- const expression: ts.Type = checker.getTypeAtLocation(hType.expression);
24
- const superNode: ts.Declaration | undefined =
25
- expression.symbol?.getDeclarations?.()?.[0];
26
-
27
- if (superNode === undefined || !ts.isClassDeclaration(superNode))
28
- continue;
29
-
30
- // SPECIFY GENERICS
31
- const usages: ReadonlyArray<ts.TypeNode> = hType.typeArguments || [];
32
- const parameters: ReadonlyArray<ts.TypeParameterDeclaration> =
33
- superNode.typeParameters || [];
34
-
35
- parameters.forEach((param, index) => {
36
- const paramType: ts.Type = checker.getTypeAtLocation(param);
37
- const usageType: ts.Type =
38
- usages[index] !== undefined
39
- ? checker.getTypeAtLocation(usages[index])
40
- : checker.getTypeAtLocation(param.default!);
41
-
42
- dict.set(paramType, usageType);
43
- });
44
-
45
- // RECURSIVE EXPLORATION
46
- explore(checker, dict, superNode);
47
- }
48
- }
49
- }
1
+ import ts from "typescript";
2
+
3
+ export namespace GenericAnalyzer {
4
+ export function analyze(
5
+ checker: ts.TypeChecker,
6
+ classNode: ts.ClassDeclaration,
7
+ ): WeakMap<ts.Type, ts.Type> {
8
+ const dict: WeakMap<ts.Type, ts.Type> = new WeakMap();
9
+ explore(checker, dict, classNode);
10
+ return dict;
11
+ }
12
+
13
+ function explore(
14
+ checker: ts.TypeChecker,
15
+ dict: WeakMap<ts.Type, ts.Type>,
16
+ classNode: ts.ClassDeclaration,
17
+ ): void {
18
+ if (classNode.heritageClauses === undefined) return;
19
+
20
+ for (const heritage of classNode.heritageClauses)
21
+ for (const hType of heritage.types) {
22
+ // MUST BE CLASS
23
+ const expression: ts.Type = checker.getTypeAtLocation(hType.expression);
24
+ const superNode: ts.Declaration | undefined =
25
+ expression.symbol?.getDeclarations?.()?.[0];
26
+
27
+ if (superNode === undefined || !ts.isClassDeclaration(superNode))
28
+ continue;
29
+
30
+ // SPECIFY GENERICS
31
+ const usages: ReadonlyArray<ts.TypeNode> = hType.typeArguments || [];
32
+ const parameters: ReadonlyArray<ts.TypeParameterDeclaration> =
33
+ superNode.typeParameters || [];
34
+
35
+ parameters.forEach((param, index) => {
36
+ const paramType: ts.Type = checker.getTypeAtLocation(param);
37
+ const usageType: ts.Type =
38
+ usages[index] !== undefined
39
+ ? checker.getTypeAtLocation(usages[index])
40
+ : checker.getTypeAtLocation(param.default!);
41
+
42
+ dict.set(paramType, usageType);
43
+ });
44
+
45
+ // RECURSIVE EXPLORATION
46
+ explore(checker, dict, superNode);
47
+ }
48
+ }
49
+ }
@@ -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
+ }
@@ -1,44 +1,44 @@
1
- import { VERSION_NEUTRAL } from "@nestjs/common";
2
- import { PATH_METADATA, VERSION_METADATA } from "@nestjs/common/constants";
3
- import { VersionValue } from "@nestjs/common/interfaces";
4
-
5
- import { SecurityAnalyzer } from "./SecurityAnalyzer";
6
-
7
- export namespace ReflectMetadataAnalyzer {
8
- export const paths = (target: Function): string[] => {
9
- const value: string | string[] = Reflect.getMetadata(PATH_METADATA, target);
10
- if (typeof value === "string") return [value];
11
- else if (value.length === 0) return [""];
12
- else return value;
13
- };
14
-
15
- export const extensions = (value: any): Record<string, any> => {
16
- const entire: Record<string, any>[] | undefined = Reflect.getMetadata(
17
- "swagger/apiExtension",
18
- value,
19
- );
20
- return entire ?? {};
21
- };
22
-
23
- export const securities = (value: any): Record<string, string[]>[] => {
24
- const entire: Record<string, string[]>[] | undefined = Reflect.getMetadata(
25
- "swagger/apiSecurity",
26
- value,
27
- );
28
- return entire ? SecurityAnalyzer.merge(...entire) : [];
29
- };
30
-
31
- export const versions = (
32
- target: any,
33
- ): Array<string | typeof VERSION_NEUTRAL> | undefined => {
34
- const value: VersionValue | undefined = Reflect.getMetadata(
35
- VERSION_METADATA,
36
- target,
37
- );
38
- return value === undefined
39
- ? undefined
40
- : Array.isArray(value)
41
- ? value
42
- : [value];
43
- };
44
- }
1
+ import { VERSION_NEUTRAL } from "@nestjs/common";
2
+ import { PATH_METADATA, VERSION_METADATA } from "@nestjs/common/constants";
3
+ import { VersionValue } from "@nestjs/common/interfaces";
4
+
5
+ import { SecurityAnalyzer } from "./SecurityAnalyzer";
6
+
7
+ export namespace ReflectMetadataAnalyzer {
8
+ export const paths = (target: Function): string[] => {
9
+ const value: string | string[] = Reflect.getMetadata(PATH_METADATA, target);
10
+ if (typeof value === "string") return [value];
11
+ else if (value.length === 0) return [""];
12
+ else return value;
13
+ };
14
+
15
+ export const extensions = (value: any): Record<string, any> => {
16
+ const entire: Record<string, any>[] | undefined = Reflect.getMetadata(
17
+ "swagger/apiExtension",
18
+ value,
19
+ );
20
+ return entire ?? {};
21
+ };
22
+
23
+ export const securities = (value: any): Record<string, string[]>[] => {
24
+ const entire: Record<string, string[]>[] | undefined = Reflect.getMetadata(
25
+ "swagger/apiSecurity",
26
+ value,
27
+ );
28
+ return entire ? SecurityAnalyzer.merge(...entire) : [];
29
+ };
30
+
31
+ export const versions = (
32
+ target: any,
33
+ ): Array<string | typeof VERSION_NEUTRAL> | undefined => {
34
+ const value: VersionValue | undefined = Reflect.getMetadata(
35
+ VERSION_METADATA,
36
+ target,
37
+ );
38
+ return value === undefined
39
+ ? undefined
40
+ : Array.isArray(value)
41
+ ? value
42
+ : [value];
43
+ };
44
+ }