@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,71 +1,71 @@
1
- import { TypedException } from "@nestia/core";
2
- import { JsonMetadataFactory } from "typia/lib/factories/JsonMetadataFactory";
3
-
4
- import { IReflectController } from "../structures/IReflectController";
5
- import { IReflectHttpOperationException } from "../structures/IReflectHttpOperationException";
6
- import { IReflectOperationError } from "../structures/IReflectOperationError";
7
- import { IOperationMetadata } from "../transformers/IOperationMetadata";
8
-
9
- export namespace ReflectHttpOperationExceptionAnalyzer {
10
- export interface IContext {
11
- controller: IReflectController;
12
- function: Function;
13
- functionName: string;
14
- httpMethod: string;
15
- metadata: IOperationMetadata;
16
- errors: IReflectOperationError[];
17
- }
18
- export const analyze = (
19
- ctx: IContext,
20
- ): Record<string, IReflectHttpOperationException> => {
21
- const preconfigured: TypedException.IProps<any>[] = analyzePreconfigured(
22
- ctx.function,
23
- )
24
- .slice()
25
- .reverse();
26
- const errors: IReflectOperationError[] = [];
27
- const exceptions: IReflectHttpOperationException[] = preconfigured
28
- .map((pre, i) => {
29
- const matched: IOperationMetadata.IException | null =
30
- ctx.metadata.exceptions[i];
31
- if (matched === undefined) {
32
- errors.push({
33
- file: ctx.controller.file,
34
- class: ctx.controller.class.name,
35
- function: ctx.functionName,
36
- from: `exception (status: ${pre.status})`,
37
- contents: ["Unable to find exception type."],
38
- });
39
- return null;
40
- } else if (matched.type === null) {
41
- errors.push({
42
- file: ctx.controller.file,
43
- class: ctx.controller.class.name,
44
- function: ctx.functionName,
45
- from: `exception (status: ${pre.status})`,
46
- contents: ["Failed to get the type info."],
47
- });
48
- }
49
- const schema: IOperationMetadata.ISchema | null = matched.primitive
50
- .success
51
- ? matched.primitive.data
52
- : null;
53
- if (schema === null || matched.type === null) return null; // unreachable
54
- return {
55
- status: pre.status,
56
- description: pre.description ?? null,
57
- example: pre.example,
58
- examples: pre.examples,
59
- type: matched.type,
60
- ...schema,
61
- validate: JsonMetadataFactory.validate,
62
- } satisfies IReflectHttpOperationException;
63
- })
64
- .filter((e) => e !== null);
65
- if (errors.length) ctx.errors.push(...errors);
66
- return Object.fromEntries(exceptions.map((e) => [e.status, e]));
67
- };
68
-
69
- const analyzePreconfigured = (func: Function): TypedException.IProps<any>[] =>
70
- Reflect.getMetadata("nestia/TypedException", func) ?? [];
71
- }
1
+ import { TypedException } from "@nestia/core";
2
+ import { JsonMetadataFactory } from "typia/lib/factories/JsonMetadataFactory";
3
+
4
+ import { IReflectController } from "../structures/IReflectController";
5
+ import { IReflectHttpOperationException } from "../structures/IReflectHttpOperationException";
6
+ import { IReflectOperationError } from "../structures/IReflectOperationError";
7
+ import { IOperationMetadata } from "../transformers/IOperationMetadata";
8
+
9
+ export namespace ReflectHttpOperationExceptionAnalyzer {
10
+ export interface IContext {
11
+ controller: IReflectController;
12
+ function: Function;
13
+ functionName: string;
14
+ httpMethod: string;
15
+ metadata: IOperationMetadata;
16
+ errors: IReflectOperationError[];
17
+ }
18
+ export const analyze = (
19
+ ctx: IContext,
20
+ ): Record<string, IReflectHttpOperationException> => {
21
+ const preconfigured: TypedException.IProps<any>[] = analyzePreconfigured(
22
+ ctx.function,
23
+ )
24
+ .slice()
25
+ .reverse();
26
+ const errors: IReflectOperationError[] = [];
27
+ const exceptions: IReflectHttpOperationException[] = preconfigured
28
+ .map((pre, i) => {
29
+ const matched: IOperationMetadata.IException | null =
30
+ ctx.metadata.exceptions[i];
31
+ if (matched === undefined) {
32
+ errors.push({
33
+ file: ctx.controller.file,
34
+ class: ctx.controller.class.name,
35
+ function: ctx.functionName,
36
+ from: `exception (status: ${pre.status})`,
37
+ contents: ["Unable to find exception type."],
38
+ });
39
+ return null;
40
+ } else if (matched.type === null) {
41
+ errors.push({
42
+ file: ctx.controller.file,
43
+ class: ctx.controller.class.name,
44
+ function: ctx.functionName,
45
+ from: `exception (status: ${pre.status})`,
46
+ contents: ["Failed to get the type info."],
47
+ });
48
+ }
49
+ const schema: IOperationMetadata.ISchema | null = matched.primitive
50
+ .success
51
+ ? matched.primitive.data
52
+ : null;
53
+ if (schema === null || matched.type === null) return null; // unreachable
54
+ return {
55
+ status: pre.status,
56
+ description: pre.description ?? null,
57
+ example: pre.example,
58
+ examples: pre.examples,
59
+ type: matched.type,
60
+ ...schema,
61
+ validate: JsonMetadataFactory.validate,
62
+ } satisfies IReflectHttpOperationException;
63
+ })
64
+ .filter((e) => e !== null);
65
+ if (errors.length) ctx.errors.push(...errors);
66
+ return Object.fromEntries(exceptions.map((e) => [e.status, e]));
67
+ };
68
+
69
+ const analyzePreconfigured = (func: Function): TypedException.IProps<any>[] =>
70
+ Reflect.getMetadata("nestia/TypedException", func) ?? [];
71
+ }