@nestia/sdk 4.4.2 → 4.5.0-dev.20241218-2

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 (123) 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/analyses/AccessorAnalyzer.js +11 -11
  15. package/lib/analyses/AccessorAnalyzer.js.map +1 -1
  16. package/lib/analyses/TypedHttpRouteAnalyzer.js +1 -1
  17. package/lib/analyses/TypedHttpRouteAnalyzer.js.map +1 -1
  18. package/lib/analyses/TypedWebSocketRouteAnalyzer.js +1 -1
  19. package/lib/analyses/TypedWebSocketRouteAnalyzer.js.map +1 -1
  20. package/lib/executable/internal/NestiaConfigLoader.js +4 -4
  21. package/lib/executable/sdk.js +12 -12
  22. package/lib/generates/internal/E2eFileProgrammer.js +2 -2
  23. package/lib/generates/internal/E2eFileProgrammer.js.map +1 -1
  24. package/lib/generates/internal/SdkFileProgrammer.js +1 -1
  25. package/lib/generates/internal/SdkFileProgrammer.js.map +1 -1
  26. package/lib/generates/internal/SwaggerOperationComposer.js +2 -2
  27. package/lib/generates/internal/SwaggerOperationComposer.js.map +1 -1
  28. package/lib/structures/ITypedHttpRoute.d.ts +1 -1
  29. package/lib/structures/ITypedWebSocketRoute.d.ts +1 -1
  30. package/package.json +8 -8
  31. package/src/INestiaConfig.ts +271 -271
  32. package/src/NestiaSdkApplication.ts +307 -307
  33. package/src/NestiaSwaggerComposer.ts +138 -138
  34. package/src/analyses/AccessorAnalyzer.ts +67 -67
  35. package/src/analyses/ConfigAnalyzer.ts +155 -155
  36. package/src/analyses/ExceptionAnalyzer.ts +154 -154
  37. package/src/analyses/GenericAnalyzer.ts +49 -49
  38. package/src/analyses/ImportAnalyzer.ts +171 -171
  39. package/src/analyses/PathAnalyzer.ts +69 -69
  40. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  41. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  42. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  43. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  44. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  45. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  46. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  47. package/src/analyses/SecurityAnalyzer.ts +25 -25
  48. package/src/analyses/TypedHttpRouteAnalyzer.ts +186 -186
  49. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +18 -18
  50. package/src/decorators/OperationMetadata.ts +15 -15
  51. package/src/executable/internal/CommandParser.ts +15 -15
  52. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  53. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  54. package/src/executable/sdk.ts +75 -75
  55. package/src/generates/CloneGenerator.ts +66 -66
  56. package/src/generates/E2eGenerator.ts +32 -32
  57. package/src/generates/SdkGenerator.ts +159 -159
  58. package/src/generates/SwaggerGenerator.ts +292 -292
  59. package/src/generates/internal/E2eFileProgrammer.ts +183 -183
  60. package/src/generates/internal/FilePrinter.ts +53 -53
  61. package/src/generates/internal/ImportDictionary.ts +147 -147
  62. package/src/generates/internal/SdkAliasCollection.ts +185 -185
  63. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  64. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  65. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  66. package/src/generates/internal/SdkHttpCloneReferencer.ts +71 -71
  67. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +301 -301
  68. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +529 -529
  69. package/src/generates/internal/SdkHttpRouteProgrammer.ts +117 -117
  70. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +362 -362
  71. package/src/generates/internal/SdkImportWizard.ts +55 -55
  72. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  73. package/src/generates/internal/SdkTypeProgrammer.ts +377 -377
  74. package/src/generates/internal/SdkTypeTagProgrammer.ts +120 -120
  75. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +363 -363
  76. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +265 -265
  77. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  78. package/src/generates/internal/SwaggerOperationComposer.ts +119 -117
  79. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  80. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  81. package/src/index.ts +4 -4
  82. package/src/module.ts +3 -3
  83. package/src/structures/INestiaProject.ts +13 -13
  84. package/src/structures/INestiaSdkInput.ts +20 -20
  85. package/src/structures/IReflectApplication.ts +8 -8
  86. package/src/structures/IReflectController.ts +15 -15
  87. package/src/structures/IReflectHttpOperation.ts +26 -26
  88. package/src/structures/IReflectHttpOperationException.ts +19 -19
  89. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  90. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  91. package/src/structures/IReflectOperationError.ts +26 -26
  92. package/src/structures/IReflectType.ts +4 -4
  93. package/src/structures/IReflectTypeImport.ts +4 -4
  94. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  95. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  96. package/src/structures/ITypedApplication.ts +11 -11
  97. package/src/structures/ITypedHttpRoute.ts +30 -30
  98. package/src/structures/ITypedHttpRouteException.ts +15 -15
  99. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  100. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  101. package/src/structures/ITypedWebSocketRoute.ts +20 -20
  102. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  103. package/src/structures/MethodType.ts +5 -5
  104. package/src/structures/ParamCategory.ts +1 -1
  105. package/src/structures/TypeEntry.ts +22 -22
  106. package/src/transform.ts +9 -9
  107. package/src/transformers/IOperationMetadata.ts +44 -44
  108. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  109. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  110. package/src/transformers/SdkOperationTransformer.ts +253 -253
  111. package/src/transformers/TextPlainValidator.ts +17 -17
  112. package/src/typings/get-function-location.d.ts +7 -7
  113. package/src/utils/ArrayUtil.ts +26 -26
  114. package/src/utils/FileRetriever.ts +22 -22
  115. package/src/utils/MapUtil.ts +14 -14
  116. package/src/utils/MetadataUtil.ts +26 -26
  117. package/src/utils/PathUtil.ts +10 -10
  118. package/src/utils/SourceFinder.ts +66 -66
  119. package/src/utils/StringUtil.ts +17 -17
  120. package/src/utils/StripEnums.ts +5 -5
  121. package/src/utils/VersioningStrategy.ts +28 -28
  122. package/src/validators/HttpHeadersValidator.ts +34 -34
  123. package/src/validators/HttpQueryValidator.ts +34 -34
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2021 Jeongho Nam
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Jeongho Nam
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,87 +1,87 @@
1
- # Nestia
2
- ![Nestia Logo](https://nestia.io/logo.png)
3
-
4
- [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE)
5
- [![npm version](https://img.shields.io/npm/v/@nestia/fetcher.svg)](https://www.npmjs.com/package/@nestia/fetcher)
6
- [![Downloads](https://img.shields.io/npm/dm/@nestia/fetcher.svg)](https://www.npmjs.com/package/@nestia/fetcher)
7
- [![Build Status](https://github.com/samchon/nestia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)
8
- [![Guide Documents](https://img.shields.io/badge/guide-documents-forestgreen)](https://nestia.io/docs/)
9
- [![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
10
-
11
- Nestia is a set of helper libraries for NestJS, supporting below features:
12
-
13
- - `@nestia/core`:
14
- - Super-fast/easy decorators
15
- - Advanced WebSocket routes
16
- - `@nestia/sdk`:
17
- - Swagger generator evolved than ever
18
- - SDK library generator for clients
19
- - Mockup Simulator for client applications
20
- - Automatic E2E test functions generator
21
- - `@nestia/e2e`: Test program utilizing e2e test functions
22
- - `@nestia/benchmark`: Benchmark program using e2e test functions
23
- - `@nestia/migrate`: OpenAPI generator from Swagger to NestJS/SDK
24
- - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
25
- - `nestia`: Just CLI (command line interface) tool
26
-
27
- > [!NOTE]
28
- >
29
- > - **Only one line** required, with pure TypeScript type
30
- > - Enhance performance **30x** up
31
- > - Runtime validator is **20,000x faster** than `class-validator`
32
- > - JSON serialization is **200x faster** than `class-transformer`
33
- > - Software Development Kit
34
- > - Collection of typed `fetch` functions with DTO structures like [tRPC](https://trpc.io/)
35
- > - Mockup simulator means embedded backend simulator in the SDK
36
- > - similar with [msw](https://mswjs.io/), but fully automated
37
-
38
- ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
39
-
40
- > Left is NestJS server code, and right is client (frontend) code utilizing SDK
41
-
42
-
43
-
44
-
45
- ## Sponsors and Backers
46
- Thanks for your support.
47
-
48
- Your donation would encourage `nestia` development.
49
-
50
- [![Backers](https://opencollective.com/nestia/backers.svg?avatarHeight=75&width=600)](https://opencollective.com/nestia)
51
-
52
-
53
-
54
-
55
- ## Guide Documents
56
- Check out the document in the [website](https://nestia.io/docs/):
57
-
58
- ### 🏠 Home
59
- - [Introduction](https://nestia.io/docs/)
60
- - [Setup](https://nestia.io/docs/setup/)
61
- - [Pure TypeScript](https://nestia.io/docs/pure)
62
-
63
- ### 📖 Features
64
- - Core Library
65
- - [WebSocketRoute](https://nestia.io/docs/core/WebSocketRoute)
66
- - [TypedRoute](https://nestia.io/docs/core/TypedRoute/)
67
- - [TypedBody](https://nestia.io/docs/core/TypedBody/)
68
- - [TypedParam](https://nestia.io/docs/core/TypedParam/)
69
- - [TypedQuery](https://nestia.io/docs/core/TypedQuery/)
70
- - [TypedHeaders](https://nestia.io/docs/core/TypedHeaders/)
71
- - [TypedException](https://nestia.io/docs/core/TypedException/)
72
- - Generators
73
- - [Swagger Documents](https://nestia.io/docs/sdk/swagger/)
74
- - [Software Development Kit](https://nestia.io/docs/sdk/sdk/)
75
- - [E2E Functions](https://nestia.io/docs/sdk/e2e/)
76
- - [Mockup Simulator](https://nestia.io/docs/sdk/simulator/)
77
- - E2E Testing
78
- - [Why E2E Test?](https://nestia.io/docs/e2e/why/)
79
- - [Test Program Development](https://nestia.io/docs/e2e/development/)
80
- - [Performance Benchmark](https://nestia.io/docs/e2e/benchmark/)
81
- - [Swagger to NestJS](https://nestia.io/docs/migrate/)
82
- - [TypeScript Swagger Editor](https://nestia.io/docs/editor/)
83
-
84
- ### 🔗 Appendix
85
- - [API Documents](https://nestia.io/api)
86
- - [⇲ Benchmark Result](https://github.com/samchon/nestia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
87
- - [⇲ `dev.to` Articles](https://dev.to/samchon/series/22751)
1
+ # Nestia
2
+ ![Nestia Logo](https://nestia.io/logo.png)
3
+
4
+ [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE)
5
+ [![npm version](https://img.shields.io/npm/v/@nestia/fetcher.svg)](https://www.npmjs.com/package/@nestia/fetcher)
6
+ [![Downloads](https://img.shields.io/npm/dm/@nestia/fetcher.svg)](https://www.npmjs.com/package/@nestia/fetcher)
7
+ [![Build Status](https://github.com/samchon/nestia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)
8
+ [![Guide Documents](https://img.shields.io/badge/guide-documents-forestgreen)](https://nestia.io/docs/)
9
+ [![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
10
+
11
+ Nestia is a set of helper libraries for NestJS, supporting below features:
12
+
13
+ - `@nestia/core`:
14
+ - Super-fast/easy decorators
15
+ - Advanced WebSocket routes
16
+ - `@nestia/sdk`:
17
+ - Swagger generator evolved than ever
18
+ - SDK library generator for clients
19
+ - Mockup Simulator for client applications
20
+ - Automatic E2E test functions generator
21
+ - `@nestia/e2e`: Test program utilizing e2e test functions
22
+ - `@nestia/benchmark`: Benchmark program using e2e test functions
23
+ - `@nestia/migrate`: OpenAPI generator from Swagger to NestJS/SDK
24
+ - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
25
+ - `nestia`: Just CLI (command line interface) tool
26
+
27
+ > [!NOTE]
28
+ >
29
+ > - **Only one line** required, with pure TypeScript type
30
+ > - Enhance performance **30x** up
31
+ > - Runtime validator is **20,000x faster** than `class-validator`
32
+ > - JSON serialization is **200x faster** than `class-transformer`
33
+ > - Software Development Kit
34
+ > - Collection of typed `fetch` functions with DTO structures like [tRPC](https://trpc.io/)
35
+ > - Mockup simulator means embedded backend simulator in the SDK
36
+ > - similar with [msw](https://mswjs.io/), but fully automated
37
+
38
+ ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
39
+
40
+ > Left is NestJS server code, and right is client (frontend) code utilizing SDK
41
+
42
+
43
+
44
+
45
+ ## Sponsors and Backers
46
+ Thanks for your support.
47
+
48
+ Your donation would encourage `nestia` development.
49
+
50
+ [![Backers](https://opencollective.com/nestia/backers.svg?avatarHeight=75&width=600)](https://opencollective.com/nestia)
51
+
52
+
53
+
54
+
55
+ ## Guide Documents
56
+ Check out the document in the [website](https://nestia.io/docs/):
57
+
58
+ ### 🏠 Home
59
+ - [Introduction](https://nestia.io/docs/)
60
+ - [Setup](https://nestia.io/docs/setup/)
61
+ - [Pure TypeScript](https://nestia.io/docs/pure)
62
+
63
+ ### 📖 Features
64
+ - Core Library
65
+ - [WebSocketRoute](https://nestia.io/docs/core/WebSocketRoute)
66
+ - [TypedRoute](https://nestia.io/docs/core/TypedRoute/)
67
+ - [TypedBody](https://nestia.io/docs/core/TypedBody/)
68
+ - [TypedParam](https://nestia.io/docs/core/TypedParam/)
69
+ - [TypedQuery](https://nestia.io/docs/core/TypedQuery/)
70
+ - [TypedHeaders](https://nestia.io/docs/core/TypedHeaders/)
71
+ - [TypedException](https://nestia.io/docs/core/TypedException/)
72
+ - Generators
73
+ - [Swagger Documents](https://nestia.io/docs/sdk/swagger/)
74
+ - [Software Development Kit](https://nestia.io/docs/sdk/sdk/)
75
+ - [E2E Functions](https://nestia.io/docs/sdk/e2e/)
76
+ - [Mockup Simulator](https://nestia.io/docs/sdk/simulator/)
77
+ - E2E Testing
78
+ - [Why E2E Test?](https://nestia.io/docs/e2e/why/)
79
+ - [Test Program Development](https://nestia.io/docs/e2e/development/)
80
+ - [Performance Benchmark](https://nestia.io/docs/e2e/benchmark/)
81
+ - [Swagger to NestJS](https://nestia.io/docs/migrate/)
82
+ - [TypeScript Swagger Editor](https://nestia.io/docs/editor/)
83
+
84
+ ### 🔗 Appendix
85
+ - [API Documents](https://nestia.io/api)
86
+ - [⇲ Benchmark Result](https://github.com/samchon/nestia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
87
+ - [⇲ `dev.to` Articles](https://dev.to/samchon/series/22751)
@@ -1 +1 @@
1
- export { HttpError } from "@nestia/fetcher";
1
+ export { HttpError } from "@nestia/fetcher";
@@ -1 +1 @@
1
- export type { IConnection } from "@nestia/fetcher";
1
+ export type { IConnection } from "@nestia/fetcher";
@@ -1 +1 @@
1
- export type { Primitive } from "typia";
1
+ export type { Primitive } from "typia";
@@ -1 +1 @@
1
- export type { Resolved } from "typia";
1
+ export type { Resolved } from "typia";
@@ -1,4 +1,4 @@
1
- import * as api from "./module";
2
-
3
- export * from "./module";
4
- export default api;
1
+ import * as api from "./module";
2
+
3
+ export * from "./module";
4
+ export default api;
@@ -1,6 +1,6 @@
1
- export type * from "./IConnection";
2
- export type * from "./Primitive";
3
- export type * from "./Resolved";
4
- export * from "./HttpError";
5
-
6
- export * as functional from "./functional";
1
+ export type * from "./IConnection";
2
+ export type * from "./Primitive";
3
+ export type * from "./Resolved";
4
+ export * from "./HttpError";
5
+
6
+ export * as functional from "./functional";
@@ -1,38 +1,38 @@
1
- # SDK Library
2
- This is a SDK library generated by [`nestia`](https://nestia.io).
3
-
4
- With this SDK library, you can easily and safely interact with backend server.
5
-
6
- Just import and call some API functions like gif image below:
7
-
8
- ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
9
-
10
- > Left is server code, and right is client code utilizing the SDK
11
-
12
-
13
-
14
-
15
- # What [`Nestia`](https://nestia.io) is:
16
- ![Nestia Logo](https://nestia.io/logo.png)
17
-
18
- [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE)
19
- [![npm version](https://img.shields.io/npm/v/@nestia/core.svg)](https://www.npmjs.com/package/@nestia/core)
20
- [![Downloads](https://img.shields.io/npm/dm/nestia.svg)](https://www.npmjs.com/package/nestia)
21
- [![Build Status](https://github.com/samchon/nestia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)
22
- [![Guide Documents](https://img.shields.io/badge/guide-documents-forestgreen)](https://nestia.io/docs/)
23
-
24
- [Nestia](https://nestia.io) is a set of helper libraries for NestJS, supporting below features:
25
-
26
- - `@nestia/core`: super-fast decorators
27
- - `@nestia/sdk`
28
- - SDK generator for clients
29
- - Swagger generator evolved than ever
30
- - Automatic E2E test functions generator
31
- - `nestia`: just CLI (command line interface) tool
32
-
33
- > [!NOTE]
34
- >
35
- > - **Only one line** required, with pure TypeScript type
36
- > - Runtime validator is **20,000x faster** than `class-validator`
37
- > - JSON serialization is **200x faster** than `class-transformer`
1
+ # SDK Library
2
+ This is a SDK library generated by [`nestia`](https://nestia.io).
3
+
4
+ With this SDK library, you can easily and safely interact with backend server.
5
+
6
+ Just import and call some API functions like gif image below:
7
+
8
+ ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
9
+
10
+ > Left is server code, and right is client code utilizing the SDK
11
+
12
+
13
+
14
+
15
+ # What [`Nestia`](https://nestia.io) is:
16
+ ![Nestia Logo](https://nestia.io/logo.png)
17
+
18
+ [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE)
19
+ [![npm version](https://img.shields.io/npm/v/@nestia/core.svg)](https://www.npmjs.com/package/@nestia/core)
20
+ [![Downloads](https://img.shields.io/npm/dm/nestia.svg)](https://www.npmjs.com/package/nestia)
21
+ [![Build Status](https://github.com/samchon/nestia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)
22
+ [![Guide Documents](https://img.shields.io/badge/guide-documents-forestgreen)](https://nestia.io/docs/)
23
+
24
+ [Nestia](https://nestia.io) is a set of helper libraries for NestJS, supporting below features:
25
+
26
+ - `@nestia/core`: super-fast decorators
27
+ - `@nestia/sdk`
28
+ - SDK generator for clients
29
+ - Swagger generator evolved than ever
30
+ - Automatic E2E test functions generator
31
+ - `nestia`: just CLI (command line interface) tool
32
+
33
+ > [!NOTE]
34
+ >
35
+ > - **Only one line** required, with pure TypeScript type
36
+ > - Runtime validator is **20,000x faster** than `class-validator`
37
+ > - JSON serialization is **200x faster** than `class-transformer`
38
38
  > - SDK is similar with [tRPC](https://trpc.io), but much advanced
@@ -1,28 +1,28 @@
1
- {
2
- "name": "@ORGANIZATION/PROJECT-api",
3
- "version": "0.1.0",
4
- "description": "SDK library generated by Nestia",
5
- "main": "lib/index.js",
6
- "typings": "lib/index.d.ts",
7
- "scripts": {
8
- "build": "npm run build:sdk && npm run compile",
9
- "build:sdk": "rimraf ${output}/functional && cd ${root} && npx nestia sdk && cd ${current}",
10
- "compile": "rimraf lib && tsc",
11
- "deploy": "npm run build && npm publish"
12
- },
13
- "repository": {
14
- "type": "git",
15
- "url": "https://github.com/samchon/nestia"
16
- },
17
- "author": "Jeongho Nam",
18
- "license": "MIT",
19
- "bugs": {
20
- "url": "https://github.com/samchon/nestia/issues"
21
- },
22
- "homepage": "https://nestia.io",
23
- "files": [
24
- "lib",
25
- "package.json",
26
- "README.md"
27
- ]
28
- }
1
+ {
2
+ "name": "@ORGANIZATION/PROJECT-api",
3
+ "version": "0.1.0",
4
+ "description": "SDK library generated by Nestia",
5
+ "main": "lib/index.js",
6
+ "typings": "lib/index.d.ts",
7
+ "scripts": {
8
+ "build": "npm run build:sdk && npm run compile",
9
+ "build:sdk": "rimraf ${output}/functional && cd ${root} && npx nestia sdk && cd ${current}",
10
+ "compile": "rimraf lib && tsc",
11
+ "deploy": "npm run build && npm publish"
12
+ },
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "https://github.com/samchon/nestia"
16
+ },
17
+ "author": "Jeongho Nam",
18
+ "license": "MIT",
19
+ "bugs": {
20
+ "url": "https://github.com/samchon/nestia/issues"
21
+ },
22
+ "homepage": "https://nestia.io",
23
+ "files": [
24
+ "lib",
25
+ "package.json",
26
+ "README.md"
27
+ ]
28
+ }