@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,15 +1,15 @@
1
- import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
-
3
- import { IReflectType } from "./IReflectType";
4
-
5
- export interface ITypedHttpRouteException {
6
- // BASIC PROPERTIES
7
- status: number | "2XX" | "3XX" | "4XX" | "5XX";
8
- description: string | null;
9
- example: any;
10
- examples: Record<string, any>;
11
-
12
- // REFLECTED PROPERTIES
13
- type: IReflectType;
14
- metadata: Metadata;
15
- }
1
+ import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
+
3
+ import { IReflectType } from "./IReflectType";
4
+
5
+ export interface ITypedHttpRouteException {
6
+ // BASIC PROPERTIES
7
+ status: number | "2XX" | "3XX" | "4XX" | "5XX";
8
+ description: string | null;
9
+ example: any;
10
+ examples: Record<string, any>;
11
+
12
+ // REFLECTED PROPERTIES
13
+ type: IReflectType;
14
+ metadata: Metadata;
15
+ }
@@ -1,41 +1,41 @@
1
- import { IJsDocTagInfo } from "typia";
2
- import { Metadata } from "typia/lib/schemas/metadata/Metadata";
3
-
4
- import { IReflectType } from "./IReflectType";
5
-
6
- export type ITypedHttpRouteParameter =
7
- | ITypedHttpRouteParameter.IBody
8
- | ITypedHttpRouteParameter.IHeaders
9
- | ITypedHttpRouteParameter.IPath
10
- | ITypedHttpRouteParameter.IQuery;
11
- export namespace ITypedHttpRouteParameter {
12
- export interface IBody extends IBase<"body"> {
13
- contentType:
14
- | "application/json"
15
- | "application/x-www-form-urlencoded"
16
- | "multipart/form-data"
17
- | "text/plain";
18
- encrypted: boolean;
19
- }
20
- export interface IHeaders extends IBase<"headers"> {
21
- field: string | null;
22
- }
23
- export interface IPath extends IBase<"param"> {
24
- field: string;
25
- }
26
- export interface IQuery extends IBase<"query"> {
27
- field: string | null;
28
- }
29
-
30
- interface IBase<Category extends string> {
31
- category: Category;
32
- name: string;
33
- index: number;
34
- type: IReflectType;
35
- metadata: Metadata;
36
- example?: any;
37
- examples?: Record<string, any>;
38
- description: string | null;
39
- jsDocTags: IJsDocTagInfo[];
40
- }
41
- }
1
+ import { IJsDocTagInfo } from "typia";
2
+ import { Metadata } from "typia/lib/schemas/metadata/Metadata";
3
+
4
+ import { IReflectType } from "./IReflectType";
5
+
6
+ export type ITypedHttpRouteParameter =
7
+ | ITypedHttpRouteParameter.IBody
8
+ | ITypedHttpRouteParameter.IHeaders
9
+ | ITypedHttpRouteParameter.IPath
10
+ | ITypedHttpRouteParameter.IQuery;
11
+ export namespace ITypedHttpRouteParameter {
12
+ export interface IBody extends IBase<"body"> {
13
+ contentType:
14
+ | "application/json"
15
+ | "application/x-www-form-urlencoded"
16
+ | "multipart/form-data"
17
+ | "text/plain";
18
+ encrypted: boolean;
19
+ }
20
+ export interface IHeaders extends IBase<"headers"> {
21
+ field: string | null;
22
+ }
23
+ export interface IPath extends IBase<"param"> {
24
+ field: string;
25
+ }
26
+ export interface IQuery extends IBase<"query"> {
27
+ field: string | null;
28
+ }
29
+
30
+ interface IBase<Category extends string> {
31
+ category: Category;
32
+ name: string;
33
+ index: number;
34
+ type: IReflectType;
35
+ metadata: Metadata;
36
+ example?: any;
37
+ examples?: Record<string, any>;
38
+ description: string | null;
39
+ jsDocTags: IJsDocTagInfo[];
40
+ }
41
+ }
@@ -1,22 +1,22 @@
1
- import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
-
3
- import { IReflectType } from "./IReflectType";
4
-
5
- export interface ITypedHttpRouteSuccess {
6
- type: IReflectType;
7
- status: number | null;
8
- contentType:
9
- | "application/json"
10
- | "text/plain"
11
- | "application/x-www-form-urlencoded"
12
- | "application/json"
13
- | null;
14
- encrypted: boolean;
15
- metadata: Metadata;
16
- example?: any;
17
- examples?: Record<string, any>;
18
- setHeaders: Array<
19
- | { type: "setter"; source: string; target?: string }
20
- | { type: "assigner"; source: string }
21
- >;
22
- }
1
+ import { Metadata } from "typia/lib/schemas/metadata/Metadata";
2
+
3
+ import { IReflectType } from "./IReflectType";
4
+
5
+ export interface ITypedHttpRouteSuccess {
6
+ type: IReflectType;
7
+ status: number | null;
8
+ contentType:
9
+ | "application/json"
10
+ | "text/plain"
11
+ | "application/x-www-form-urlencoded"
12
+ | "application/json"
13
+ | null;
14
+ encrypted: boolean;
15
+ metadata: Metadata;
16
+ example?: any;
17
+ examples?: Record<string, any>;
18
+ setHeaders: Array<
19
+ | { type: "setter"; source: string; target?: string }
20
+ | { type: "assigner"; source: string }
21
+ >;
22
+ }
@@ -1,24 +1,24 @@
1
- import { VERSION_NEUTRAL } from "@nestjs/common";
2
- import ts from "typescript";
3
-
4
- import { IReflectController } from "./IReflectController";
5
- import { IReflectImport } from "./IReflectImport";
6
- import { ITypedWebSocketRouteParameter } from "./ITypedWebSocketRouteParameter";
7
-
8
- export interface ITypedWebSocketRoute {
9
- protocol: "websocket";
10
- controller: IReflectController;
11
- name: string;
12
- path: string;
13
- accessor: string[];
14
- function: Function;
15
- versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
16
- acceptor: ITypedWebSocketRouteParameter.IAcceptor;
17
- header: ITypedWebSocketRouteParameter.IHeader | null;
18
- pathParameters: ITypedWebSocketRouteParameter.IParam[];
19
- query: ITypedWebSocketRouteParameter.IQuery | null;
20
- driver: ITypedWebSocketRouteParameter.IDriver | null;
21
- imports: IReflectImport[];
22
- description: string | null;
23
- jsDocTags: ts.JSDocTagInfo[];
24
- }
1
+ import { VERSION_NEUTRAL } from "@nestjs/common";
2
+ import ts from "typescript";
3
+
4
+ import { IReflectController } from "./IReflectController";
5
+ import { IReflectImport } from "./IReflectImport";
6
+ import { ITypedWebSocketRouteParameter } from "./ITypedWebSocketRouteParameter";
7
+
8
+ export interface ITypedWebSocketRoute {
9
+ protocol: "websocket";
10
+ controller: IReflectController;
11
+ name: string;
12
+ path: string;
13
+ accessor: string[];
14
+ function: Function;
15
+ versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
16
+ acceptor: ITypedWebSocketRouteParameter.IAcceptor;
17
+ header: ITypedWebSocketRouteParameter.IHeader | null;
18
+ pathParameters: ITypedWebSocketRouteParameter.IParam[];
19
+ query: ITypedWebSocketRouteParameter.IQuery | null;
20
+ driver: ITypedWebSocketRouteParameter.IDriver | null;
21
+ imports: IReflectImport[];
22
+ description: string | null;
23
+ jsDocTags: ts.JSDocTagInfo[];
24
+ }
@@ -1,3 +1,3 @@
1
- import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
2
-
3
- export import ITypedWebSocketRouteParameter = IReflectWebSocketOperationParameter;
1
+ import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
2
+
3
+ export import ITypedWebSocketRouteParameter = IReflectWebSocketOperationParameter;
@@ -1,5 +1,5 @@
1
- export type MethodType = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
2
-
3
- export namespace MethodType {
4
- export const VALUES: MethodType[] = ["GET", "POST", "PUT", "PATCH", "DELETE"];
5
- }
1
+ export type MethodType = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
2
+
3
+ export namespace MethodType {
4
+ export const VALUES: MethodType[] = ["GET", "POST", "PUT", "PATCH", "DELETE"];
5
+ }
@@ -1 +1 @@
1
- export type ParamCategory = "param" | "query" | "body" | "rawBody" | "headers";
1
+ export type ParamCategory = "param" | "query" | "body" | "rawBody" | "headers";
@@ -1,22 +1,22 @@
1
- import { hash } from "tstl";
2
- import ts from "typescript";
3
-
4
- export class TypeEntry {
5
- public constructor(
6
- public readonly type: ts.Type,
7
- public readonly nullable: boolean,
8
- public readonly required: boolean,
9
- ) {}
10
-
11
- public equals(obj: TypeEntry): boolean {
12
- return (
13
- this.type === obj.type &&
14
- this.nullable === obj.nullable &&
15
- this.required === obj.required
16
- );
17
- }
18
-
19
- public hashCode(): number {
20
- return hash(this.type, this.nullable, this.required);
21
- }
22
- }
1
+ import { hash } from "tstl";
2
+ import ts from "typescript";
3
+
4
+ export class TypeEntry {
5
+ public constructor(
6
+ public readonly type: ts.Type,
7
+ public readonly nullable: boolean,
8
+ public readonly required: boolean,
9
+ ) {}
10
+
11
+ public equals(obj: TypeEntry): boolean {
12
+ return (
13
+ this.type === obj.type &&
14
+ this.nullable === obj.nullable &&
15
+ this.required === obj.required
16
+ );
17
+ }
18
+
19
+ public hashCode(): number {
20
+ return hash(this.type, this.nullable, this.required);
21
+ }
22
+ }
package/src/transform.ts CHANGED
@@ -1,9 +1,9 @@
1
- import ts from "typescript";
2
-
3
- import { SdkOperationTransformer } from "./transformers/SdkOperationTransformer";
4
-
5
- export const transform = (
6
- program: ts.Program,
7
- ): ts.TransformerFactory<ts.SourceFile> =>
8
- SdkOperationTransformer.iterateFile(program.getTypeChecker());
9
- export default transform;
1
+ import ts from "typescript";
2
+
3
+ import { SdkOperationTransformer } from "./transformers/SdkOperationTransformer";
4
+
5
+ export const transform = (
6
+ program: ts.Program,
7
+ ): ts.TransformerFactory<ts.SourceFile> =>
8
+ SdkOperationTransformer.iterateFile(program.getTypeChecker());
9
+ export default transform;
@@ -1,44 +1,44 @@
1
- import { IJsDocTagInfo } from "typia";
2
- import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
3
- import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
4
- import { ValidationPipe } from "typia/lib/typings/ValidationPipe";
5
-
6
- import { IReflectImport } from "../structures/IReflectImport";
7
- import { IReflectType } from "../structures/IReflectType";
8
-
9
- export interface IOperationMetadata {
10
- parameters: IOperationMetadata.IParameter[];
11
- success: IOperationMetadata.IResponse;
12
- exceptions: IOperationMetadata.IResponse[];
13
- description: string | null;
14
- jsDocTags: IJsDocTagInfo[];
15
- }
16
- export namespace IOperationMetadata {
17
- export interface IParameter extends IResponse {
18
- name: string;
19
- index: number;
20
- description: string | null;
21
- jsDocTags: IJsDocTagInfo[];
22
- }
23
- export interface IResponse {
24
- type: IReflectType | null;
25
- imports: IReflectImport[];
26
- primitive: ValidationPipe<ISchema, IError>;
27
- resolved: ValidationPipe<ISchema, IError>;
28
- }
29
- export interface IException {
30
- type: IReflectType | null;
31
- imports: IReflectImport[];
32
- primitive: ValidationPipe<ISchema, IError>;
33
- }
34
-
35
- export interface ISchema {
36
- components: IMetadataComponents;
37
- metadata: IMetadata;
38
- }
39
- export interface IError {
40
- name: string;
41
- accessor: string | null;
42
- messages: string[];
43
- }
44
- }
1
+ import { IJsDocTagInfo } from "typia";
2
+ import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
3
+ import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
4
+ import { ValidationPipe } from "typia/lib/typings/ValidationPipe";
5
+
6
+ import { IReflectImport } from "../structures/IReflectImport";
7
+ import { IReflectType } from "../structures/IReflectType";
8
+
9
+ export interface IOperationMetadata {
10
+ parameters: IOperationMetadata.IParameter[];
11
+ success: IOperationMetadata.IResponse;
12
+ exceptions: IOperationMetadata.IResponse[];
13
+ description: string | null;
14
+ jsDocTags: IJsDocTagInfo[];
15
+ }
16
+ export namespace IOperationMetadata {
17
+ export interface IParameter extends IResponse {
18
+ name: string;
19
+ index: number;
20
+ description: string | null;
21
+ jsDocTags: IJsDocTagInfo[];
22
+ }
23
+ export interface IResponse {
24
+ type: IReflectType | null;
25
+ imports: IReflectImport[];
26
+ primitive: ValidationPipe<ISchema, IError>;
27
+ resolved: ValidationPipe<ISchema, IError>;
28
+ }
29
+ export interface IException {
30
+ type: IReflectType | null;
31
+ imports: IReflectImport[];
32
+ primitive: ValidationPipe<ISchema, IError>;
33
+ }
34
+
35
+ export interface ISchema {
36
+ components: IMetadataComponents;
37
+ metadata: IMetadata;
38
+ }
39
+ export interface IError {
40
+ name: string;
41
+ accessor: string | null;
42
+ messages: string[];
43
+ }
44
+ }
@@ -1,8 +1,8 @@
1
- import ts from "typescript";
2
- import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
3
-
4
- export interface ISdkOperationTransformerContext {
5
- checker: ts.TypeChecker;
6
- transformer: ts.TransformationContext;
7
- collection: MetadataCollection;
8
- }
1
+ import ts from "typescript";
2
+ import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
3
+
4
+ export interface ISdkOperationTransformerContext {
5
+ checker: ts.TypeChecker;
6
+ transformer: ts.TransformationContext;
7
+ collection: MetadataCollection;
8
+ }