@nestia/sdk 4.2.0-dev.20241211 → 4.2.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 (108) 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/package.json +5 -5
  17. package/src/INestiaConfig.ts +271 -271
  18. package/src/NestiaSdkApplication.ts +307 -307
  19. package/src/NestiaSwaggerComposer.ts +138 -138
  20. package/src/analyses/AccessorAnalyzer.ts +67 -67
  21. package/src/analyses/ConfigAnalyzer.ts +155 -155
  22. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  23. package/src/analyses/GenericAnalyzer.ts +49 -49
  24. package/src/analyses/ImportAnalyzer.ts +171 -171
  25. package/src/analyses/PathAnalyzer.ts +69 -69
  26. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  27. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  28. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  29. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  30. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  31. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  32. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  33. package/src/analyses/SecurityAnalyzer.ts +25 -25
  34. package/src/analyses/TypedHttpRouteAnalyzer.ts +186 -186
  35. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +18 -18
  36. package/src/decorators/OperationMetadata.ts +15 -15
  37. package/src/executable/internal/CommandParser.ts +15 -15
  38. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  39. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  40. package/src/executable/sdk.ts +75 -75
  41. package/src/generates/CloneGenerator.ts +66 -66
  42. package/src/generates/E2eGenerator.ts +32 -32
  43. package/src/generates/SdkGenerator.ts +159 -159
  44. package/src/generates/SwaggerGenerator.ts +292 -292
  45. package/src/generates/internal/E2eFileProgrammer.ts +183 -183
  46. package/src/generates/internal/FilePrinter.ts +53 -53
  47. package/src/generates/internal/ImportDictionary.ts +147 -147
  48. package/src/generates/internal/SdkAliasCollection.ts +185 -185
  49. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  50. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  51. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  52. package/src/generates/internal/SdkHttpCloneReferencer.ts +71 -71
  53. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +301 -301
  54. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +529 -529
  55. package/src/generates/internal/SdkHttpRouteProgrammer.ts +117 -117
  56. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +362 -362
  57. package/src/generates/internal/SdkImportWizard.ts +55 -55
  58. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  59. package/src/generates/internal/SdkTypeProgrammer.ts +394 -394
  60. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +363 -363
  61. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +265 -265
  62. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  63. package/src/generates/internal/SwaggerOperationComposer.ts +117 -117
  64. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  65. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  66. package/src/index.ts +4 -4
  67. package/src/module.ts +3 -3
  68. package/src/structures/INestiaProject.ts +13 -13
  69. package/src/structures/INestiaSdkInput.ts +20 -20
  70. package/src/structures/IReflectApplication.ts +8 -8
  71. package/src/structures/IReflectController.ts +15 -15
  72. package/src/structures/IReflectHttpOperation.ts +26 -26
  73. package/src/structures/IReflectHttpOperationException.ts +19 -19
  74. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  75. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  76. package/src/structures/IReflectOperationError.ts +26 -26
  77. package/src/structures/IReflectType.ts +4 -4
  78. package/src/structures/IReflectTypeImport.ts +4 -4
  79. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  80. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  81. package/src/structures/ITypedApplication.ts +11 -11
  82. package/src/structures/ITypedHttpRoute.ts +30 -30
  83. package/src/structures/ITypedHttpRouteException.ts +15 -15
  84. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  85. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  86. package/src/structures/ITypedWebSocketRoute.ts +20 -20
  87. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  88. package/src/structures/MethodType.ts +5 -5
  89. package/src/structures/ParamCategory.ts +1 -1
  90. package/src/structures/TypeEntry.ts +22 -22
  91. package/src/transform.ts +9 -9
  92. package/src/transformers/IOperationMetadata.ts +44 -44
  93. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  94. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  95. package/src/transformers/SdkOperationTransformer.ts +253 -253
  96. package/src/transformers/TextPlainValidator.ts +17 -17
  97. package/src/typings/get-function-location.d.ts +7 -7
  98. package/src/utils/ArrayUtil.ts +26 -26
  99. package/src/utils/FileRetriever.ts +22 -22
  100. package/src/utils/MapUtil.ts +14 -14
  101. package/src/utils/MetadataUtil.ts +26 -26
  102. package/src/utils/PathUtil.ts +10 -10
  103. package/src/utils/SourceFinder.ts +66 -66
  104. package/src/utils/StringUtil.ts +17 -17
  105. package/src/utils/StripEnums.ts +5 -5
  106. package/src/utils/VersioningStrategy.ts +28 -28
  107. package/src/validators/HttpHeadersValidator.ts +34 -34
  108. package/src/validators/HttpQueryValidator.ts +34 -34
@@ -1,124 +1,124 @@
1
- import { IPointer } from "tstl";
2
- import ts from "typescript";
3
- import { IJsDocTagInfo } from "typia";
4
- import { MetadataAliasType } from "typia/lib/schemas/metadata/MetadataAliasType";
5
- import { MetadataAtomic } from "typia/lib/schemas/metadata/MetadataAtomic";
6
- import { MetadataObjectType } from "typia/lib/schemas/metadata/MetadataObjectType";
7
-
8
- import { INestiaProject } from "../../structures/INestiaProject";
9
- import { ITypedApplication } from "../../structures/ITypedApplication";
10
- import { MapUtil } from "../../utils/MapUtil";
11
- import { StringUtil } from "../../utils/StringUtil";
12
- import { FilePrinter } from "./FilePrinter";
13
- import { ImportDictionary } from "./ImportDictionary";
14
- import { SdkTypeProgrammer } from "./SdkTypeProgrammer";
15
-
16
- export namespace SdkHttpCloneProgrammer {
17
- export interface IModule {
18
- name: string;
19
- children: Map<string, IModule>;
20
- programmer:
21
- | null
22
- | ((importer: ImportDictionary) => ts.TypeAliasDeclaration);
23
- }
24
-
25
- export const write = (app: ITypedApplication): Map<string, IModule> => {
26
- // COMPOSE THE DICTIONARY
27
- const dict: Map<string, IModule> = new Map();
28
- for (const [k, v] of app.collection.objects.entries())
29
- if (StringUtil.isImplicit(k) === false)
30
- prepare({
31
- dict,
32
- name: k,
33
- programmer: (importer) => write_object(app.project)(importer)(v),
34
- });
35
- for (const [k, v] of app.collection.aliases.entries())
36
- if (StringUtil.isImplicit(k) === false)
37
- prepare({
38
- dict,
39
- name: k,
40
- programmer: (importer) => write_alias(app.project)(importer)(v),
41
- });
42
- return dict;
43
- };
44
-
45
- const prepare = (props: {
46
- dict: Map<string, IModule>;
47
- name: string;
48
- programmer: (importer: ImportDictionary) => ts.TypeAliasDeclaration;
49
- }) => {
50
- let next: Map<string, IModule> = props.dict;
51
- const accessors: string[] = props.name.split(".");
52
- const modulo: IPointer<IModule> = { value: null! };
53
-
54
- accessors.forEach((acc, i) => {
55
- modulo.value = MapUtil.take(next, acc, () => ({
56
- name: acc,
57
- children: new Map(),
58
- programmer: null,
59
- }));
60
- if (i === accessors.length - 1)
61
- modulo.value.programmer = props.programmer;
62
- next = modulo.value.children;
63
- });
64
- return modulo!;
65
- };
66
-
67
- const write_alias =
68
- (project: INestiaProject) =>
69
- (importer: ImportDictionary) =>
70
- (alias: MetadataAliasType): ts.TypeAliasDeclaration =>
71
- FilePrinter.description(
72
- ts.factory.createTypeAliasDeclaration(
73
- [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
74
- alias.name.split(".").at(-1)!,
75
- [],
76
- SdkTypeProgrammer.write(project)(importer)(alias.value),
77
- ),
78
- writeComment([])(alias.description, alias.jsDocTags),
79
- );
80
-
81
- const write_object =
82
- (project: INestiaProject) =>
83
- (importer: ImportDictionary) =>
84
- (object: MetadataObjectType): ts.TypeAliasDeclaration => {
85
- return FilePrinter.description(
86
- ts.factory.createTypeAliasDeclaration(
87
- [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
88
- object.name.split(".").at(-1)!,
89
- [],
90
- SdkTypeProgrammer.write_object(project)(importer)(object),
91
- ),
92
- writeComment([])(object.description ?? null, object.jsDocTags),
93
- );
94
- };
95
- }
96
-
97
- const writeComment =
98
- (atomics: MetadataAtomic[]) =>
99
- (description: string | null, jsDocTags: IJsDocTagInfo[]): string => {
100
- const lines: string[] = [];
101
- if (description?.length)
102
- lines.push(...description.split("\n").map((s) => `${s}`));
103
-
104
- const filtered: IJsDocTagInfo[] =
105
- !!atomics.length && !!jsDocTags?.length
106
- ? jsDocTags.filter(
107
- (tag) =>
108
- !atomics.some((a) =>
109
- a.tags.some((r) => r.some((t) => t.kind === tag.name)),
110
- ),
111
- )
112
- : (jsDocTags ?? []);
113
-
114
- if (description?.length && filtered.length) lines.push("");
115
- if (filtered.length)
116
- lines.push(
117
- ...filtered.map((t) =>
118
- t.text?.length
119
- ? `@${t.name} ${t.text.map((e) => e.text).join("")}`
120
- : `@${t.name}`,
121
- ),
122
- );
123
- return lines.join("\n");
124
- };
1
+ import { IPointer } from "tstl";
2
+ import ts from "typescript";
3
+ import { IJsDocTagInfo } from "typia";
4
+ import { MetadataAliasType } from "typia/lib/schemas/metadata/MetadataAliasType";
5
+ import { MetadataAtomic } from "typia/lib/schemas/metadata/MetadataAtomic";
6
+ import { MetadataObjectType } from "typia/lib/schemas/metadata/MetadataObjectType";
7
+
8
+ import { INestiaProject } from "../../structures/INestiaProject";
9
+ import { ITypedApplication } from "../../structures/ITypedApplication";
10
+ import { MapUtil } from "../../utils/MapUtil";
11
+ import { StringUtil } from "../../utils/StringUtil";
12
+ import { FilePrinter } from "./FilePrinter";
13
+ import { ImportDictionary } from "./ImportDictionary";
14
+ import { SdkTypeProgrammer } from "./SdkTypeProgrammer";
15
+
16
+ export namespace SdkHttpCloneProgrammer {
17
+ export interface IModule {
18
+ name: string;
19
+ children: Map<string, IModule>;
20
+ programmer:
21
+ | null
22
+ | ((importer: ImportDictionary) => ts.TypeAliasDeclaration);
23
+ }
24
+
25
+ export const write = (app: ITypedApplication): Map<string, IModule> => {
26
+ // COMPOSE THE DICTIONARY
27
+ const dict: Map<string, IModule> = new Map();
28
+ for (const [k, v] of app.collection.objects.entries())
29
+ if (StringUtil.isImplicit(k) === false)
30
+ prepare({
31
+ dict,
32
+ name: k,
33
+ programmer: (importer) => write_object(app.project)(importer)(v),
34
+ });
35
+ for (const [k, v] of app.collection.aliases.entries())
36
+ if (StringUtil.isImplicit(k) === false)
37
+ prepare({
38
+ dict,
39
+ name: k,
40
+ programmer: (importer) => write_alias(app.project)(importer)(v),
41
+ });
42
+ return dict;
43
+ };
44
+
45
+ const prepare = (props: {
46
+ dict: Map<string, IModule>;
47
+ name: string;
48
+ programmer: (importer: ImportDictionary) => ts.TypeAliasDeclaration;
49
+ }) => {
50
+ let next: Map<string, IModule> = props.dict;
51
+ const accessors: string[] = props.name.split(".");
52
+ const modulo: IPointer<IModule> = { value: null! };
53
+
54
+ accessors.forEach((acc, i) => {
55
+ modulo.value = MapUtil.take(next, acc, () => ({
56
+ name: acc,
57
+ children: new Map(),
58
+ programmer: null,
59
+ }));
60
+ if (i === accessors.length - 1)
61
+ modulo.value.programmer = props.programmer;
62
+ next = modulo.value.children;
63
+ });
64
+ return modulo!;
65
+ };
66
+
67
+ const write_alias =
68
+ (project: INestiaProject) =>
69
+ (importer: ImportDictionary) =>
70
+ (alias: MetadataAliasType): ts.TypeAliasDeclaration =>
71
+ FilePrinter.description(
72
+ ts.factory.createTypeAliasDeclaration(
73
+ [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
74
+ alias.name.split(".").at(-1)!,
75
+ [],
76
+ SdkTypeProgrammer.write(project)(importer)(alias.value),
77
+ ),
78
+ writeComment([])(alias.description, alias.jsDocTags),
79
+ );
80
+
81
+ const write_object =
82
+ (project: INestiaProject) =>
83
+ (importer: ImportDictionary) =>
84
+ (object: MetadataObjectType): ts.TypeAliasDeclaration => {
85
+ return FilePrinter.description(
86
+ ts.factory.createTypeAliasDeclaration(
87
+ [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
88
+ object.name.split(".").at(-1)!,
89
+ [],
90
+ SdkTypeProgrammer.write_object(project)(importer)(object),
91
+ ),
92
+ writeComment([])(object.description ?? null, object.jsDocTags),
93
+ );
94
+ };
95
+ }
96
+
97
+ const writeComment =
98
+ (atomics: MetadataAtomic[]) =>
99
+ (description: string | null, jsDocTags: IJsDocTagInfo[]): string => {
100
+ const lines: string[] = [];
101
+ if (description?.length)
102
+ lines.push(...description.split("\n").map((s) => `${s}`));
103
+
104
+ const filtered: IJsDocTagInfo[] =
105
+ !!atomics.length && !!jsDocTags?.length
106
+ ? jsDocTags.filter(
107
+ (tag) =>
108
+ !atomics.some((a) =>
109
+ a.tags.some((r) => r.some((t) => t.kind === tag.name)),
110
+ ),
111
+ )
112
+ : (jsDocTags ?? []);
113
+
114
+ if (description?.length && filtered.length) lines.push("");
115
+ if (filtered.length)
116
+ lines.push(
117
+ ...filtered.map((t) =>
118
+ t.text?.length
119
+ ? `@${t.name} ${t.text.map((e) => e.text).join("")}`
120
+ : `@${t.name}`,
121
+ ),
122
+ );
123
+ return lines.join("\n");
124
+ };
@@ -1,71 +1,71 @@
1
- import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
-
3
- import { IReflectType } from "../../structures/IReflectType";
4
- import { ITypedApplication } from "../../structures/ITypedApplication";
5
- import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
6
- import { StringUtil } from "../../utils/StringUtil";
7
-
8
- export namespace SdkHttpCloneReferencer {
9
- export const replace = (app: ITypedApplication): void => {
10
- const directory: string = `${app.project.config.output}/structures`;
11
- for (const route of app.routes)
12
- if (route.protocol === "http")
13
- visitRoute({
14
- directory,
15
- route,
16
- });
17
- };
18
-
19
- const visitRoute = (props: {
20
- directory: string;
21
- route: ITypedHttpRoute;
22
- }): void => {
23
- const unique: Set<string> = new Set();
24
- for (const p of props.route.parameters)
25
- visitType({
26
- unique,
27
- metadata: p.metadata,
28
- type: p.type,
29
- name: (name) => (p.type = { name }),
30
- });
31
- for (const v of Object.values(props.route.exceptions))
32
- visitType({
33
- unique,
34
- metadata: v.metadata,
35
- type: v.type,
36
- name: (name) => (v.type = { name }),
37
- });
38
- visitType({
39
- unique,
40
- metadata: props.route.success.metadata,
41
- type: props.route.success.type,
42
- name: (name) => (props.route.success.type = { name }),
43
- });
44
- props.route.imports = Array.from(unique).map((str) => ({
45
- file: `${props.directory}/${str}`,
46
- instances: [str],
47
- }));
48
- };
49
-
50
- const visitType = (p: {
51
- unique: Set<string>;
52
- metadata: Metadata;
53
- type: IReflectType;
54
- name: (key: string) => void;
55
- }): void => {
56
- const enroll = (key: string) => {
57
- if (key.length && StringUtil.isImplicit(key) === false)
58
- p.unique.add(key.split(".")[0]);
59
- };
60
- for (const alias of p.metadata.aliases) enroll(alias.type.name);
61
- for (const array of p.metadata.arrays) enroll(array.type.name);
62
- for (const tuple of p.metadata.tuples) enroll(tuple.type.name);
63
- for (const object of p.metadata.objects) enroll(object.type.name);
64
- p.name(p.metadata.getName());
65
- };
66
- }
67
-
68
- const getFullText = (type: IReflectType): string =>
69
- type.typeArguments === undefined
70
- ? type.name
71
- : `${type.name}<${type.typeArguments.map(getFullText).join(", ")}>`;
1
+ import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
+
3
+ import { IReflectType } from "../../structures/IReflectType";
4
+ import { ITypedApplication } from "../../structures/ITypedApplication";
5
+ import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
6
+ import { StringUtil } from "../../utils/StringUtil";
7
+
8
+ export namespace SdkHttpCloneReferencer {
9
+ export const replace = (app: ITypedApplication): void => {
10
+ const directory: string = `${app.project.config.output}/structures`;
11
+ for (const route of app.routes)
12
+ if (route.protocol === "http")
13
+ visitRoute({
14
+ directory,
15
+ route,
16
+ });
17
+ };
18
+
19
+ const visitRoute = (props: {
20
+ directory: string;
21
+ route: ITypedHttpRoute;
22
+ }): void => {
23
+ const unique: Set<string> = new Set();
24
+ for (const p of props.route.parameters)
25
+ visitType({
26
+ unique,
27
+ metadata: p.metadata,
28
+ type: p.type,
29
+ name: (name) => (p.type = { name }),
30
+ });
31
+ for (const v of Object.values(props.route.exceptions))
32
+ visitType({
33
+ unique,
34
+ metadata: v.metadata,
35
+ type: v.type,
36
+ name: (name) => (v.type = { name }),
37
+ });
38
+ visitType({
39
+ unique,
40
+ metadata: props.route.success.metadata,
41
+ type: props.route.success.type,
42
+ name: (name) => (props.route.success.type = { name }),
43
+ });
44
+ props.route.imports = Array.from(unique).map((str) => ({
45
+ file: `${props.directory}/${str}`,
46
+ instances: [str],
47
+ }));
48
+ };
49
+
50
+ const visitType = (p: {
51
+ unique: Set<string>;
52
+ metadata: Metadata;
53
+ type: IReflectType;
54
+ name: (key: string) => void;
55
+ }): void => {
56
+ const enroll = (key: string) => {
57
+ if (key.length && StringUtil.isImplicit(key) === false)
58
+ p.unique.add(key.split(".")[0]);
59
+ };
60
+ for (const alias of p.metadata.aliases) enroll(alias.type.name);
61
+ for (const array of p.metadata.arrays) enroll(array.type.name);
62
+ for (const tuple of p.metadata.tuples) enroll(tuple.type.name);
63
+ for (const object of p.metadata.objects) enroll(object.type.name);
64
+ p.name(p.metadata.getName());
65
+ };
66
+ }
67
+
68
+ const getFullText = (type: IReflectType): string =>
69
+ type.typeArguments === undefined
70
+ ? type.name
71
+ : `${type.name}<${type.typeArguments.map(getFullText).join(", ")}>`;