nestia 4.0.4 → 4.0.5

package/README.md

@@ -5,13 +5,14 @@
 
 Nestia is a set of helper libraries for NestJS, supporting below features:
 
-  - [`@nestia/core`](#nestiacore): **15,000x times faster** validation decorator using [typia](https://github.com/samchon/typia)
-  - [`@nestia/sdk`](#nestiasdk): evolved **SDK** and **Swagger** generator for `@nestia/core`
+  - [`@nestia/core`](#nestiacore): **15,000x times faster** validation decorators
+  - [`@nestia/sdk`](#nestiasdk): evolved **SDK** and **Swagger** generators
+    - SDK (Software Development Kit)
+       - interaction library for client developers
+      - almost same with [tRPC](https://github.com/trpc/trpc)
   - `nestia`: just CLI (command line interface) tool
 
-![Is Function Benchmark](https://github.com/samchon/typia/raw/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz/images/is.svg)
-
-> Measured on [Intel i5-1135g7, Surface Pro 8](https://github.com/samchon/typia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz#is)
+![nestia-sdk-demo](https://user-images.githubusercontent.com/13158709/215004990-368c589d-7101-404e-b81b-fbc936382f05.gif)
 
 
 
@@ -55,7 +56,7 @@ npx ts-node -C ttypescript src/index.ts
 ```
 
 ### Manual Setup
-If you want to install and configure `nestia` manually, read [Guide Documents - Setup](https://github.com/samchon/nestia/wiki/Setup).
+If you want to install and configure `nestia` manually, read [Guide Documents -> Setup](https://github.com/samchon/nestia/wiki/Setup).
 
 
 
@@ -97,65 +98,20 @@ export class BbsArticlesController {
 }
 ```
 
-### TypedBody
-`TypedBody()` is a decorator function of `application/json` typed request body.
-
-Also, it supports super-fast validation pipe, which is maximum **15,000x times faster** then `nest.Body()` function using `class-validator`.
-
-### TypedRoute
-`TypedRoute` is a set of decorator functions for `application/json` typed response body.
-
-Also, it supports safe and fast JSON stringify function pipe, which is maximum 10x times faster than native `JSON.stringify()` function. Furthermore, it is **type safe** through validation.
+If you want to know more about this core library, visit [Guide Documents](https://github.com/samchon/nestia/wiki).
 
-  - `TypedRoute.Get()`
-  - `TypedRoute.Post()`
-  - `TypedRoute.Put()`
-  - `TypedRoute.Patch()`
-  - `TypedRoute.Delete()`
-
-### Comment Tags
-You can enhance DTO type validation by writing comment tags.
-
-If you want to know about it detaily, visit [Guide Documents of typia](https://github.com/samchon/typia/wiki/Runtime-Validators#comment-tags).
-
-```typescript
-export interface IBbsArticle {
-    /**
-     * @format uuid
-     */
-    id: string;
-
-    writer: IBbsArticle.IWriter;
-
-    /**
-     * @minItems 1
-     */
-    contents: IBbsArticle.IContent[];
-}
-export namespace IBbsArticle {
-    export interface IWriter {
-        /**
-         * @minLength 3
-         */
-        name: string;
-
-        /**
-         * @format email
-         */
-        email: string;
-
-        /**
-         * @pattern ^0[0-9]{7,16}
-         */
-        mobile: string;
-
-        /**
-         * @minimum 18
-         */
-        age: number;
-    }
-}
-```
+  - Decorators
+    - [TypedRoute](https://github.com/samchon/nestia/wiki/Core-Library#typedroute)
+    - [TypedBody](https://github.com/samchon/nestia/wiki/Core-Library#typedbody)
+    - [TypedQuery](https://github.com/samchon/nestia/wiki/Core-Library#typedquery)
+    - [TypedParam](https://github.com/samchon/nestia/wiki/Core-Library#typedparam)
+  - Enhancements
+    - [Comment Tags](https://github.com/samchon/nestia/wiki/Core-Library#comment-tags)
+    - [Configuration](https://github.com/samchon/nestia/wiki/Core-Library#configuration)
+  - Advanced Usage
+    - [DynamicModule](https://github.com/samchon/nestia/wiki/Core-Library#dynamicmodule)
+    - [Encryption](https://github.com/samchon/nestia/wiki/Core-Library#encryption)
+    - [Inheritance](https://github.com/samchon/nestia/wiki/Core-Library#inheritance)
 
 
 
@@ -168,7 +124,7 @@ Automatic *SDK* and *Swagger* generator for [@nestia/core](#nestiacore).
 
 With [@nestia/core](#nestiacore), you can boost up validation speed maximum **15,000x times faster**. However, as `@nestjs/swagger` does not support [@nestia/core](#nestiacore), you can't generate swagger documents from `@nestjs/swagger` more.
 
-Instead, I provide you `@nestia/sdk` module, which can generate not only swagger documents, but also SDK (Software Development Kit) library.
+Instead, I provide you `@nestia/sdk` module, which can generate not only swagger documents, but also SDK (Software Development Kit) library. The SDK library can be utilized by client developers and it is almost same with `tRPC`.
 
 ### Usage
 ```bash
@@ -180,71 +136,31 @@ npx nestia <sdk|swagger> <source_directories_or_patterns> \
 # EXAMPLES
 npx nestia sdk "src/**/*.controller.ts" --out "src/api"
 npx nestia swagger "src/controllers" --out "dist/swagger.json"
-```
-
-You can generate sdk or swagger documents by above commands.
-
-If you've configured `nestia.config.ts` file, you can omit all options like below. About the `nestia.config.ts` file, read [Guide Documents - Configuration](https://github.com/samchon/nestia/wiki/Configuration)
 
-```bash
+# ONLY WHEN "nestia.config.ts" FILE EXISTS
 npx nestia sdk
 npx nestia swagger
 ```
 
-### Demonstration
-When you generate SDK library through `npx nestia sdk` command, `@nestia/sdk` will generate below code, by analyzing your backend source code in the compilation level. 
-
-```typescript
-import { Fetcher, IConnection } from "@nestia/fetcher";
-import { IBbsArticle } from "../../../structures/IBbsArticle";
-
-/**
- * Store a new content.
- * 
- * @param input Content to store
- * @returns Newly archived article
- */
-export function store(
-    connection: api.IConnection, 
-    input: IBbsArticle.IStore
-): Promise<IBbsArticle> {
-    return Fetcher.fetch(
-        connection,
-        store.ENCRYPTED,
-        store.METHOD,
-        store.path(),
-        input
-    );
-}
-export namespace store {
-    export const METHOD = "POST" as const;
-    export function path(): string {
-        return "/bbs/articles";
-    }
-}
-```
+You can generate sdk or swagger documents by above commands.
 
-With SDK library, client developers would get take advantages of TypeScript like below. 
+If you want to know more, visit [Guide Documents](https://github.com/samchon/nestia/wiki).
 
-If you want to learn how to distribute SDK library, visit and read [Guide Documents - Distribution](https://github.com/samchon/nestia/wiki/Distribution).
+  - Generators
+    - [Swagger Documents](https://github.com/samchon/nestia/wiki/SDK-Generator#swagger-documents)
+    - [SDK Library](https://github.com/samchon/nestia/wiki/SDK-Generator#sdk-library)
+  - Advanced Usage
+    - [Comment Tags](https://github.com/samchon/nestia/wiki/SDK-Generator#comment-tags)
+    - [Configuration](https://github.com/samchon/nestia/wiki/SDK-Generator#configuration)
 
-```typescript
-import api from "@bbs-api";
-import typia from "typia";
+### Demonstration
+Here is example projects building Swagger Documents and SDK Library with `npx nestia swagger` and `npx nestia sdk` comands. `@nestia/sdk` generates those documents and libraries by analyzing your NestJS backend server code in the compilation level.
 
-export async function test_bbs_article_store(connection: api.IConnection) {
-    const article: IBbsArticle = await api.functional.bbs.articles.store(
-        connection,
-        {
-            name: "John Doe",
-            title: "some title",
-            content: "some content",
-        }
-    );
-    typia.assert(article);
-    console.log(article);
-}
-```
+Project | Controller | SDK | Swagger
+--------|------------|-----|---------
+`npx nestia start` | [`BbsArticlesController`](https://github.com/samchon/nestia-template/blob/master/src/controllers/BbsArticlesController.ts) | [Functions](https://github.com/samchon/nestia-template/blob/master/src/api/functional/bbs/articles/index.ts) | [Editor](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia-template%2Fmaster%2Fdist%2Fswagger.json)
+[fake-iamport](https://github.com/samchon/fake-iamport-server) | [`IamportCertificationsController`](https://github.com/samchon/fake-iamport-server/blob/master/src/controllers/FakeIamportCertificationsController.ts) | [Functions](https://github.com/samchon/fake-iamport-server/blob/master/src/api/functional/certifications/index.ts) | [Editor](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Ffake-iamport-server%2Fmaster%2Fdist%2Fswagger.json)
+[fake-toss-payments](https://github.com/samchon/fake-toss-payments-server) | [`TossPaymentsController`](https://github.com/samchon/fake-toss-payments-server/blob/master/src/controllers/FakeTossPaymentsController.ts) | [Functions](https://github.com/samchon/fake-toss-payments-server/blob/master/src/api/functional/v1/payments/index.ts) | [Editor](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Ffake-toss-payments-server%2Fmaster%2Fdist%2Fswagger.json)
 
 
 
@@ -288,4 +204,59 @@ export function assertStringify<T>(input: T): string; // safe and faster
 
 All functions in `typia` require **only one line**. You don't need any extra dedication like JSON schema definitions or decorator function calls. Just call `typia` function with only one line like `typia.assert<T>(input)`.
 
-Also, as `typia` performs AOT (Ahead of Time) compilation skill, its performance is much faster than other competitive libaries. For an example, when comparing validate function `is()` with other competitive libraries, `typia` is maximum **15,000x times faster** than `class-validator`.
+Also, as `typia` performs AOT (Ahead of Time) compilation skill, its performance is much faster than other competitive libaries. For an example, when comparing validate function `is()` with other competitive libraries, `typia` is maximum **15,000x times faster** than `class-validator`.
+
+### Reactia
+> https://github.com/samchon/reactia
+>
+> Not published yet, but soon
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/reactia/blob/master/LICENSE)
+[![Build Status](https://github.com/samchon/reactia/workflows/build/badge.svg)](https://github.com/samchon/reactia/actions?query=workflow%3Abuild)
+[![Guide Documents](https://img.shields.io/badge/wiki-documentation-forestgreen)](https://github.com/samchon/reactia/wiki)
+
+Reactia is an automatic React components generator, just by analyzing TypeScript type.
+
+  - `@reactia/core`: Core Library analyzing TypeScript type
+  - `@reactia/mui`: Material UI Theme for `core` and `nest`
+  - `@reactia/nest`: Automatic Frontend Application Builder for `NestJS`
+  <!-- - `reactia`: Just CLI tool -->
+
+![Sample](https://user-images.githubusercontent.com/13158709/199074008-46b2dd67-02be-40b1-aa0f-74ac41f3e0a7.png)
+
+When you want to automate an individual component, just use `@reactia/core`.
+
+```tsx
+import ReactDOM from "react-dom";
+
+import typia from "typia";
+import { ReactiaComponent } from "@reactia/core";
+import { MuiInputTheme } from "@reactia/mui";
+
+const RequestInput = ReactiaComponent<IRequestDto>(MuiInputTheme());
+const input: IRequestDto = { ... };
+
+ReactDOM.render(
+    <RequestInput input={input} />,
+    document.body
+);
+```
+
+Otherwise, you can fully automate frontend application development through `@reactia/nest`.
+
+```tsx
+import React from "react";
+import ReactDOM from "react-dom";
+
+import { ISwagger } "@nestia/swagger";
+import { MuiApplicationTheme } from "@reactia/mui";
+import { ReactiaApplication } from "@reactia/nest";
+
+const swagger: ISwagger = await import("./swagger.json");
+const App: React.FC = ReactiaApplication(MuiApplicationTheme())(swagger);
+
+ReactDOM.render(
+    <App />,
+    document.body
+);
+```

package/bin/NestiaSetupWizard.js

@@ -61,7 +61,8 @@ var NestiaSetupWizard;
                 halt(() => { })("make package.json file or move to it.");
             const pack = JSON.parse(yield fs_1.default.promises.readFile("package.json", "utf8"));
             add(args.manager)(pack)("@nestia/core", false);
-            add(args.manager)(pack)("@nestia/sdk", false);
+            add(args.manager)(pack)("@nestia/sdk", true);
+            add(args.manager)(pack)("nestia", true);
             const modulo = yield (_a = process.cwd() +
                 "/node_modules/@nestia/core/lib/executable/internal/CoreSetupWizard", Promise.resolve().then(() => __importStar(require(_a))));
             return modulo.CoreSetupWizard;

package/bin/NestiaSetupWizard.js.map

@@ -1 +1 @@
-{"version":3,"file":"NestiaSetupWizard.js","sourceRoot":"","sources":["../src/NestiaSetupWizard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAA+B;AAC/B,4CAAoB;AAEpB,IAAiB,iBAAiB,CAiCjC;AAjCD,WAAiB,iBAAiB;IAM9B,SAAsB,WAAW,CAAC,IAAgB;;YAC9C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;KAAA;IAHqB,6BAAW,cAGhC,CAAA;IAED,SAAsB,OAAO,CAAC,IAAgB;;YAC1C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;KAAA;IAHqB,yBAAO,UAG5B,CAAA;IAED,SAAe,OAAO,CAAC,IAAgB;;;YACnC,IAAI,YAAE,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,KAAK;gBACvC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,uCAAuC,CAAC,CAAC;YAE5D,MAAM,IAAI,GAAQ,IAAI,CAAC,KAAK,CACxB,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CACrD,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAC/C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YAE9C,MAAM,MAAM,GACR,YACI,OAAO,CAAC,GAAG,EAAE;gBACT,oEAAoE,0DAC3E,CAAC;YACN,OAAO,MAAM,CAAC,eAAe,CAAC;QAClC,CAAC;KAAA;AACL,CAAC,EAjCgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAiCjC;AAED,MAAM,GAAG,GACL,CAAC,OAAe,EAAE,EAAE,CACpB,CAAC,IAAS,EAAE,EAAE,CACd,CAAC,MAAc,EAAE,OAAgB,EAAQ,EAAE;IACvC,MAAM,MAAM,GACR,CAAC,OAAO,KAAK,KAAK;QACd,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACpD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC/D,YAAE,CAAC,UAAU,CAAC,eAAe,GAAG,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GACR,OAAO,KAAK,MAAM;QACd,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9B,CAAC,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzD,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,CAAC,GAAG,OAAO,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;AACpE,CAAC,CAAC;AAEN,MAAM,IAAI,GACN,CAAC,MAAiB,EAAE,EAAE,CACtB,CAAC,IAAY,EAAS,EAAE;IACpB,MAAM,EAAE,CAAC;IACT,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrB,CAAC,CAAC;AAEN,SAAS,OAAO,CAAC,OAAe;IAC5B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,uBAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;AAC/C,CAAC"}
+{"version":3,"file":"NestiaSetupWizard.js","sourceRoot":"","sources":["../src/NestiaSetupWizard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAA+B;AAC/B,4CAAoB;AAEpB,IAAiB,iBAAiB,CAkCjC;AAlCD,WAAiB,iBAAiB;IAM9B,SAAsB,WAAW,CAAC,IAAgB;;YAC9C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;KAAA;IAHqB,6BAAW,cAGhC,CAAA;IAED,SAAsB,OAAO,CAAC,IAAgB;;YAC1C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;KAAA;IAHqB,yBAAO,UAG5B,CAAA;IAED,SAAe,OAAO,CAAC,IAAgB;;;YACnC,IAAI,YAAE,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,KAAK;gBACvC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,uCAAuC,CAAC,CAAC;YAE5D,MAAM,IAAI,GAAQ,IAAI,CAAC,KAAK,CACxB,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CACrD,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAC/C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC7C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAExC,MAAM,MAAM,GACR,YACI,OAAO,CAAC,GAAG,EAAE;gBACT,oEAAoE,0DAC3E,CAAC;YACN,OAAO,MAAM,CAAC,eAAe,CAAC;QAClC,CAAC;KAAA;AACL,CAAC,EAlCgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAkCjC;AAED,MAAM,GAAG,GACL,CAAC,OAAe,EAAE,EAAE,CACpB,CAAC,IAAS,EAAE,EAAE,CACd,CAAC,MAAc,EAAE,OAAgB,EAAQ,EAAE;IACvC,MAAM,MAAM,GACR,CAAC,OAAO,KAAK,KAAK;QACd,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACpD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC/D,YAAE,CAAC,UAAU,CAAC,eAAe,GAAG,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GACR,OAAO,KAAK,MAAM;QACd,CAAC,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9B,CAAC,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzD,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,CAAC,GAAG,OAAO,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;AACpE,CAAC,CAAC;AAEN,MAAM,IAAI,GACN,CAAC,MAAiB,EAAE,EAAE,CACtB,CAAC,IAAY,EAAS,EAAE;IACpB,MAAM,EAAE,CAAC;IACT,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrB,CAAC,CAAC;AAEN,SAAS,OAAO,CAAC,OAAe;IAC5B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,uBAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;AAC/C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestia",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "Nestia CLI",
   "main": "bin/index.js",
   "bin": {