@nestia/sdk 7.0.3 → 7.1.1-dev.20250714

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 (115) 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/SdkHttpFunctionProgrammer.js +1 -1
  17. package/lib/generates/internal/SdkHttpFunctionProgrammer.js.map +1 -1
  18. package/lib/generates/internal/SdkHttpSimulationProgrammer.js +7 -10
  19. package/lib/generates/internal/SdkHttpSimulationProgrammer.js.map +1 -1
  20. package/package.json +6 -11
  21. package/src/INestiaConfig.ts +269 -269
  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/ExceptionAnalyzer.ts +154 -154
  27. package/src/analyses/GenericAnalyzer.ts +49 -49
  28. package/src/analyses/ImportAnalyzer.ts +171 -171
  29. package/src/analyses/PathAnalyzer.ts +69 -69
  30. package/src/analyses/ReflectControllerAnalyzer.ts +105 -105
  31. package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
  32. package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +71 -71
  33. package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +348 -348
  34. package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +127 -127
  35. package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
  36. package/src/analyses/ReflectWebSocketOperationAnalyzer.ts +172 -172
  37. package/src/analyses/SecurityAnalyzer.ts +25 -25
  38. package/src/analyses/TypedHttpRouteAnalyzer.ts +204 -204
  39. package/src/analyses/TypedWebSocketRouteAnalyzer.ts +33 -33
  40. package/src/decorators/OperationMetadata.ts +15 -15
  41. package/src/executable/internal/CommandParser.ts +15 -15
  42. package/src/executable/internal/NestiaConfigLoader.ts +78 -78
  43. package/src/executable/internal/NestiaSdkCommand.ts +103 -103
  44. package/src/executable/sdk.ts +75 -75
  45. package/src/generates/CloneGenerator.ts +66 -66
  46. package/src/generates/E2eGenerator.ts +32 -32
  47. package/src/generates/SdkGenerator.ts +160 -160
  48. package/src/generates/SwaggerGenerator.ts +284 -284
  49. package/src/generates/internal/E2eFileProgrammer.ts +205 -205
  50. package/src/generates/internal/FilePrinter.ts +53 -53
  51. package/src/generates/internal/ImportDictionary.ts +163 -163
  52. package/src/generates/internal/SdkAliasCollection.ts +255 -255
  53. package/src/generates/internal/SdkDistributionComposer.ts +103 -103
  54. package/src/generates/internal/SdkFileProgrammer.ts +116 -116
  55. package/src/generates/internal/SdkHttpCloneProgrammer.ts +124 -124
  56. package/src/generates/internal/SdkHttpCloneReferencer.ts +75 -75
  57. package/src/generates/internal/SdkHttpFunctionProgrammer.ts +279 -276
  58. package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +500 -500
  59. package/src/generates/internal/SdkHttpParameterProgrammer.ts +178 -178
  60. package/src/generates/internal/SdkHttpRouteProgrammer.ts +107 -107
  61. package/src/generates/internal/SdkHttpSimulationProgrammer.ts +309 -340
  62. package/src/generates/internal/SdkImportWizard.ts +55 -55
  63. package/src/generates/internal/SdkRouteDirectory.ts +18 -18
  64. package/src/generates/internal/SdkTypeProgrammer.ts +384 -384
  65. package/src/generates/internal/SdkTypeTagProgrammer.ts +102 -102
  66. package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +366 -366
  67. package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +87 -87
  68. package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +279 -279
  69. package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
  70. package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
  71. package/src/generates/internal/SwaggerOperationParameterComposer.ts +177 -177
  72. package/src/generates/internal/SwaggerOperationResponseComposer.ts +110 -110
  73. package/src/index.ts +4 -4
  74. package/src/module.ts +3 -3
  75. package/src/structures/INestiaProject.ts +13 -13
  76. package/src/structures/INestiaSdkInput.ts +20 -20
  77. package/src/structures/IReflectApplication.ts +8 -8
  78. package/src/structures/IReflectController.ts +15 -15
  79. package/src/structures/IReflectHttpOperation.ts +26 -26
  80. package/src/structures/IReflectHttpOperationException.ts +19 -19
  81. package/src/structures/IReflectHttpOperationParameter.ts +81 -81
  82. package/src/structures/IReflectHttpOperationSuccess.ts +22 -22
  83. package/src/structures/IReflectOperationError.ts +26 -26
  84. package/src/structures/IReflectType.ts +4 -4
  85. package/src/structures/IReflectTypeImport.ts +4 -4
  86. package/src/structures/IReflectWebSocketOperation.ts +17 -17
  87. package/src/structures/IReflectWebSocketOperationParameter.ts +38 -38
  88. package/src/structures/ITypedApplication.ts +11 -11
  89. package/src/structures/ITypedHttpRoute.ts +41 -41
  90. package/src/structures/ITypedHttpRouteException.ts +15 -15
  91. package/src/structures/ITypedHttpRouteParameter.ts +41 -41
  92. package/src/structures/ITypedHttpRouteSuccess.ts +22 -22
  93. package/src/structures/ITypedWebSocketRoute.ts +24 -24
  94. package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
  95. package/src/structures/MethodType.ts +5 -5
  96. package/src/structures/ParamCategory.ts +1 -1
  97. package/src/structures/TypeEntry.ts +22 -22
  98. package/src/transform.ts +9 -9
  99. package/src/transformers/IOperationMetadata.ts +44 -44
  100. package/src/transformers/ISdkOperationTransformerContext.ts +8 -8
  101. package/src/transformers/SdkOperationProgrammer.ts +209 -209
  102. package/src/transformers/SdkOperationTransformer.ts +253 -253
  103. package/src/transformers/TextPlainValidator.ts +17 -17
  104. package/src/typings/get-function-location.d.ts +7 -7
  105. package/src/utils/ArrayUtil.ts +26 -26
  106. package/src/utils/FileRetriever.ts +22 -22
  107. package/src/utils/MapUtil.ts +14 -14
  108. package/src/utils/MetadataUtil.ts +26 -26
  109. package/src/utils/PathUtil.ts +10 -10
  110. package/src/utils/SourceFinder.ts +66 -66
  111. package/src/utils/StringUtil.ts +17 -17
  112. package/src/utils/StripEnums.ts +5 -5
  113. package/src/utils/VersioningStrategy.ts +28 -28
  114. package/src/validators/HttpHeadersValidator.ts +34 -34
  115. 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,93 +1,93 @@
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
- [![Gurubase](https://img.shields.io/badge/Gurubase-Document%20Chatbot-006BFF)](https://gurubase.io/g/nestia)
10
- [![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)
11
-
12
- Nestia is a set of helper libraries for NestJS, supporting below features:
13
-
14
- - `@nestia/core`:
15
- - Super-fast/easy decorators
16
- - Advanced WebSocket routes
17
- - `@nestia/sdk`:
18
- - Swagger generator, more evolved than ever
19
- - SDK library generator for clients
20
- - Mockup Simulator for client applications
21
- - Automatic E2E test functions generator
22
- - `@nestia/e2e`: Test program utilizing e2e test functions
23
- - `@nestia/benchmark`: Benchmark program using e2e test functions
24
- - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
25
- - [`@agentica`](https://github.com/wrtnlabs/agentica): Agentic AI library specialized in LLM function calling
26
- - [`@autobe`](https://github.com/wrtnlabs/autobe): Vibe coding agent generating NestJS application
27
- - `nestia`: Just CLI (command line interface) tool
28
-
29
- > [!NOTE]
30
- >
31
- > - **Only one line** required, with pure TypeScript type
32
- > - Enhance performance **30x** up
33
- > - Runtime validator is **20,000x faster** than `class-validator`
34
- > - JSON serialization is **200x faster** than `class-transformer`
35
- > - Software Development Kit
36
- > - Collection of typed `fetch` functions with DTO structures like [tRPC](https://trpc.io/)
37
- > - Mockup simulator means embedded backend simulator in the SDK
38
- > - similar with [msw](https://mswjs.io/), but fully automated
39
-
40
- ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
41
-
42
- > Left is NestJS server code, and right is client (frontend) code utilizing SDK
43
-
44
-
45
-
46
-
47
- ## Sponsors and Backers
48
- Thanks for your support.
49
-
50
- Your donation would encourage `nestia` development.
51
-
52
- [![Backers](https://opencollective.com/nestia/backers.svg?avatarHeight=75&width=600)](https://opencollective.com/nestia)
53
-
54
-
55
-
56
-
57
- ## Guide Documents
58
- Check out the document in the [website](https://nestia.io/docs/):
59
-
60
- ### 🏠 Home
61
- - [Introduction](https://nestia.io/docs/)
62
- - [Setup](https://nestia.io/docs/setup/)
63
- - [Pure TypeScript](https://nestia.io/docs/pure)
64
-
65
- ### 📖 Features
66
- - Core Library
67
- - [`@WebSocketRoute`](https://nestia.io/docs/core/WebSocketRoute)
68
- - [`@TypedRoute`](https://nestia.io/docs/core/TypedRoute/)
69
- - [**`@TypedBody`**](https://nestia.io/docs/core/TypedBody/)
70
- - [`@TypedParam`](https://nestia.io/docs/core/TypedParam/)
71
- - [`@TypedQuery`](https://nestia.io/docs/core/TypedQuery/)
72
- - [`@TypedFormData`](https://nestia.io/docs/core/TypedFormData/)
73
- - [`@TypedHeaders`](https://nestia.io/docs/core/TypedHeaders/)
74
- - [`@TypedException`](https://nestia.io/docs/core/TypedException/)
75
- - Software Development Kit
76
- - [SDK Builder](https://nestia.io/docs/sdk/)
77
- - [Mockup Simulator](https://nestia.io/docs/sdk/simulate/)
78
- - [E2E Test Functions](https://nestia.io/docs/sdk/e2e/)
79
- - [Distribution](https://nestia.io/docs/sdk/distribute/)
80
- - Swagger Document
81
- - [Swagger Builder](https://nestia.io/docs/swagger/)
82
- - [**AI Chatbot Development**](https://nestia.io/docs/swagger/chat/)
83
- - [Cloud Swagger Editor](https://nestia.io/docs/swagger/editor/)
84
- - [Documentation Strategy](https://nestia.io/docs/swagger/strategy/)
85
- - E2E Testing
86
- - [Why E2E Test?](https://nestia.io/docs/e2e/why/)
87
- - [Test Program Development](https://nestia.io/docs/e2e/development/)
88
- - [Performance Benchmark](https://nestia.io/docs/e2e/benchmark/)
89
-
90
- ### 🔗 Appendix
91
- - [API Documents](https://nestia.io/api)
92
- - [⇲ Benchmark Result](https://github.com/samchon/nestia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
93
- - [⇲ `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
+ [![Gurubase](https://img.shields.io/badge/Gurubase-Document%20Chatbot-006BFF)](https://gurubase.io/g/nestia)
10
+ [![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)
11
+
12
+ Nestia is a set of helper libraries for NestJS, supporting below features:
13
+
14
+ - `@nestia/core`:
15
+ - Super-fast/easy decorators
16
+ - Advanced WebSocket routes
17
+ - `@nestia/sdk`:
18
+ - Swagger generator, more evolved than ever
19
+ - SDK library generator for clients
20
+ - Mockup Simulator for client applications
21
+ - Automatic E2E test functions generator
22
+ - `@nestia/e2e`: Test program utilizing e2e test functions
23
+ - `@nestia/benchmark`: Benchmark program using e2e test functions
24
+ - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
25
+ - [`@agentica`](https://github.com/wrtnlabs/agentica): Agentic AI library specialized in LLM function calling
26
+ - [`@autobe`](https://github.com/wrtnlabs/autobe): Vibe coding agent generating NestJS application
27
+ - `nestia`: Just CLI (command line interface) tool
28
+
29
+ > [!NOTE]
30
+ >
31
+ > - **Only one line** required, with pure TypeScript type
32
+ > - Enhance performance **30x** up
33
+ > - Runtime validator is **20,000x faster** than `class-validator`
34
+ > - JSON serialization is **200x faster** than `class-transformer`
35
+ > - Software Development Kit
36
+ > - Collection of typed `fetch` functions with DTO structures like [tRPC](https://trpc.io/)
37
+ > - Mockup simulator means embedded backend simulator in the SDK
38
+ > - similar with [msw](https://mswjs.io/), but fully automated
39
+
40
+ ![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
41
+
42
+ > Left is NestJS server code, and right is client (frontend) code utilizing SDK
43
+
44
+
45
+
46
+
47
+ ## Sponsors and Backers
48
+ Thanks for your support.
49
+
50
+ Your donation would encourage `nestia` development.
51
+
52
+ [![Backers](https://opencollective.com/nestia/backers.svg?avatarHeight=75&width=600)](https://opencollective.com/nestia)
53
+
54
+
55
+
56
+
57
+ ## Guide Documents
58
+ Check out the document in the [website](https://nestia.io/docs/):
59
+
60
+ ### 🏠 Home
61
+ - [Introduction](https://nestia.io/docs/)
62
+ - [Setup](https://nestia.io/docs/setup/)
63
+ - [Pure TypeScript](https://nestia.io/docs/pure)
64
+
65
+ ### 📖 Features
66
+ - Core Library
67
+ - [`@WebSocketRoute`](https://nestia.io/docs/core/WebSocketRoute)
68
+ - [`@TypedRoute`](https://nestia.io/docs/core/TypedRoute/)
69
+ - [**`@TypedBody`**](https://nestia.io/docs/core/TypedBody/)
70
+ - [`@TypedParam`](https://nestia.io/docs/core/TypedParam/)
71
+ - [`@TypedQuery`](https://nestia.io/docs/core/TypedQuery/)
72
+ - [`@TypedFormData`](https://nestia.io/docs/core/TypedFormData/)
73
+ - [`@TypedHeaders`](https://nestia.io/docs/core/TypedHeaders/)
74
+ - [`@TypedException`](https://nestia.io/docs/core/TypedException/)
75
+ - Software Development Kit
76
+ - [SDK Builder](https://nestia.io/docs/sdk/)
77
+ - [Mockup Simulator](https://nestia.io/docs/sdk/simulate/)
78
+ - [E2E Test Functions](https://nestia.io/docs/sdk/e2e/)
79
+ - [Distribution](https://nestia.io/docs/sdk/distribute/)
80
+ - Swagger Document
81
+ - [Swagger Builder](https://nestia.io/docs/swagger/)
82
+ - [**AI Chatbot Development**](https://nestia.io/docs/swagger/chat/)
83
+ - [Cloud Swagger Editor](https://nestia.io/docs/swagger/editor/)
84
+ - [Documentation Strategy](https://nestia.io/docs/swagger/strategy/)
85
+ - E2E Testing
86
+ - [Why E2E Test?](https://nestia.io/docs/e2e/why/)
87
+ - [Test Program Development](https://nestia.io/docs/e2e/development/)
88
+ - [Performance Benchmark](https://nestia.io/docs/e2e/benchmark/)
89
+
90
+ ### 🔗 Appendix
91
+ - [API Documents](https://nestia.io/api)
92
+ - [⇲ Benchmark Result](https://github.com/samchon/nestia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
93
+ - [⇲ `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
+ }