nestia 3.1.6 → 4.0.0-dev.20221217

package/README.md

@@ -1,76 +1,19 @@
 # Nestia
-Automatic `SDK` and `Swagger` generator for the `NestJS`, evolved than ever.
-
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE) 
-[![npm version](https://badge.fury.io/js/nestia.svg)](https://www.npmjs.com/package/nestia) 
-[![Downloads](https://img.shields.io/npm/dm/nestia.svg)](https://www.npmjs.com/package/nestia) 
-[![Build Status](https://github.com/samchon/nestia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild) 
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/nestia/blob/master/LICENSE)
+[![Build Status](https://github.com/samchon/typia/workflows/build/badge.svg)](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)
 [![Guide Documents](https://img.shields.io/badge/wiki-documentation-forestgreen)](https://github.com/samchon/nestia/wiki)
 
-  - Github: https://github.com/samchon/nestia
-  - NPM: https://www.npmjs.com/package/nestia
-  - Guide Documents: https://github.com/samchon/nestia/wiki
-
-`nestia` is an evolved `SDK` and `Swagger` generator, which analyzes your `NestJS` server code in the compilation level. With `nestia` and compilation level analyzer, you don't need to write any swagger or class-validator decorators. All you need to do is use the `nestia` CLI as shown below.
+Nestia is a helper library set for NestJS, supporting below features:
 
-Reading below contents, feel how the "compilation level" makes `nestia` stronger.
+  - [`@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`: just CLI (command line interface) tool
 
-Components | `nestia`::SDK | `nestia`::swagger | `@nestjs/swagger`
------------|---|---|---
-Pure DTO interface | ✔ | ✔ | ❌
-Description comments | ✔ | ✔ | ❌
-Simple structure | ✔ | ✔ | ✔
-Generic type | ✔ | ✔ | ❌
-Union type | ✔ | ✔ | ▲
-Intersection type | ✔ | ✔ | ▲
-Conditional type | ✔ | ▲ | ❌
-Auto completion | ✔ | ❌ | ❌
-Type hints | ✔ | ❌ | ❌
-5x faster `JSON.stringify()` | ✔ | ❌ | ❌
-Ensure type safety | ✅ | ❌ | ❌
+For reference, **15,000x times faster validation** means the difference in validation speed between `typia` used by `@nestia/core` and `class-validator` used by `NestJS`. If you visit `typia` repo and [read how it fast and stable](https://github.com/samchon/typia/wiki/Runtime-Validators#powerful-validator), you may understand why I've started this `nestia` project.
 
-```typescript
-// IMPORT SDK LIBRARY GENERATED BY NESTIA
-import api from "@samchon/shopping-api";
-import { IPage } from "@samchon/shopping-api/lib/structures/IPage";
-import { ISale } from "@samchon/shopping-api/lib/structures/ISale";
-import { ISaleQuestion } from "@samchon/shopping-api/lib/structures/ISaleQuestion";
-
-export async function trace_sale_question_and_comment
-    (connection: api.IConnection): Promise<void>
-{
-    // LIST UP SALE SUMMARIES
-    const index: IPage<ISale.ISummary> = await api.functional.shoppings.sales.index
-    (
-        connection,
-        "general",
-        { limit: 100, page: 1 }
-    );
+![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)
 
-    // PICK A SALE
-    const sale: ISale = await api.functional.shoppings.sales.at
-    (
-        connection, 
-        "general",
-        index.data[0].id
-    );
-    console.log("sale", sale);
-
-    // WRITE A QUESTION
-    const question: ISaleQuestion = await api.functional.shoppings.sales.questions.store
-    (
-        connection,
-        "general",
-        sale.id,
-        {
-            title: "How to use this product?",
-            body: "The description is not fully enough. Can you introduce me more?",
-            files: []
-        }
-    );
-    console.log("question", question);
-}
-```
+> 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)
 
 
 
@@ -81,642 +24,257 @@ export async function trace_sale_question_and_comment
 npx nestia start <directory>
 ```
 
-Just run the uppder command, then boilerplate project using `nestia` would be installed.
-
-When the installation has been completed, you can start NestJS backend development directly.  and you also can generate SDK library or Swagger documents by running below command. You can get more information by reading [README](https://github.com/samchon/nestia-template) content of the boilderplate project.
+Just run above command, then boilerplate project would be constructed.
 
+### Setup Wizard
 ```bash
-cd <directory>
-npm run build:sdk
-npm run build:swagger
+npx nestia setup
 ```
 
-However, supported range of the boilerplate project is limited. It guides from "setting up nestia configuration" to "how to accomplish TDD through SDK", but nothing more. If you want more guidance like 
-configuring DB or preparing non-distruptive update system, visit [samchon/backend](https://github.com/samchon/backend) and create a new repository from that.
-
-### Manual Installation
-If you need to manual install, follow below step.
+When you want to use `nestia` in orindary project, just type above command.
 
-At first, install those dependencies.
+All installation and configuration processes would be automatically done.
 
-```sh
-npm install --save nestia-helper
-npm install --save-dev nestia
+Also, you can specify package manager by `--manage` argument like below:
 
-npm install --save-dev typescript
-npm install --save-dev ttypescript
-npm install --save-dev ts-node
+```bash
+npx nestia setup --manager npm
+npx nestia setup --manager pnpm
+npx nestia setup --manager yarn
 ```
 
-After the installation, check the `tsconfig.json` file. When you're using nestia, your TypeScript project must be configured to using CommonJS module with strict mode. Also, if you configure plugins like below to using [nestia-helper](https://github.com/samchon/nestia-helper), you can get great benefit by using [pure DTO interface](#pure-dto-interface).
-
-```json
-{
-  "compilerOptions": {
-    "module": "CommonJS",
-    "strict": true,
-    "plugins": [
-      { "transform": "nestia-helper/lib/transform" } 
-    ]
-  }
-}
-```
+After the setup, you can compile `@nestia/core` utilization code by using `ttsc` ([`ttypescript`](https://github.com/cevek/ttypescript)) command. If you want to run your TypeScript file directly through `ts-node`, add `-C ttypescript` argument like below:
 
-When all manual setup processes are completed, you can generate the `SDK` or `Swagger`.
+```bash
+# COMPILE THROUGH TTYPESCRIPT
+npx ttsc
 
-```sh
-npx nestia sdk "src/**/*.controller" --out "src/api"
-npx nestia swagger "src/**/*.controller" --out "swagger.json"
+# RUN TS-NODE WITH TTYPESCRIPT
+npx ts-node -C ttypescript src/index.ts
 ```
 
-> If all of your controller files are gathered into one directory:
->
-> ```sh
-> npx nestia sdk "src/controllers" --out "src/api"
-> npx nestia swagger "src/controllers" --out "swagger.json"
-> ```
-> 
-> You can omit all of the parameters if you've configured the [nestia.config.ts](#configuration) file.
-> 
-> ```sh
-> npx nestia sdk
-> npx nestia swagger
-> ```
+### Manual Setup
+If you want to install and setup `nestia` manually, read [Guide Documents - Setup](https://github.com/samchon/nestia/wiki/Setup).
 
 
 
 
-## Demonstrations
-### Pure DTO Interface
-`nestia` can utilize pure interface type as DTO.
+## `@nestia/core`
+[![npm version](https://img.shields.io/npm/v/@nestia/core.svg)](https://www.npmjs.com/package/@nestia/core)
+[![Downloads](https://img.shields.io/npm/dm/@nestia/core.svg)](https://www.npmjs.com/package/@nestia/core)
 
-Unlike `@nestjs/swagger` which requires the DTO class with decorators, `nestia` can use the pure interface type directly. Also, `nestia` can utilize the pure descriptive comments, instead of using the `description` property of the decorators. Furthermore, `nestia` can even support generic types, union/intersection types and even conditional types.
+super-fast validation decorators for NestJS.
 
-Look at the code below, you may see the difference between `nestia` and `@nestjs/swagger`, and thereby catch the meaning of the pure DTO interface.
+`@nestia/core` is a transformer library of NestJS, supporting super-fast validation decorators, by wrapping [typia](https://github.com/samchon/typia). Comparing validation speed with `class-validator`, `typia` is maximum **15,000x times faster** and it even much safer.
 
-  - Simple [`ISaleArticleComment`](https://github.com/samchon/nestia/tree/master/demo/safe/src/api/structures/ISaleArticleComment.ts)
-  - Generic interfaces
-    - grandparent interface, [`ISaleArticle<Content>`](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/structures/ISaleArticle.ts)
-    - parent interface, [`ISaleInquiry<Content>`](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/structures/ISaleInquiry.ts)
-    - 1st sub-type interface, [`ISaleQuestion`](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/structures/ISaleQuestion.ts)
-    - 2nd sub-type interface, [`ISaleReview`](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/structures/ISaleReview.ts)
-  - Union alias type [`ISaleEntireArticle`](https://github.com/samchon/nestia/tree/master/demo/union/src/api/structures/ISaleEntireArticle.ts)
+Furthermore, `@nestia/core` can use pure interface typed DTO with **only one line**.
 
-```typescript
-/**
- * Comment wrote on a sale related article.
- * 
- * When an article of a sale has been enrolled, all of the participants like consumers and
- * sellers can write a comment on that article. However, when the writer is a consumer, the
- * consumer can hide its name through the annoymous option. 
- * 
- * Also, writing a reply comment for a specific comment is possible and in that case, the 
- * {@link ISaleArticleComment.parent_id} property would be activated.
- * 
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface ISaleArticleComment
-{
-    /**
-     * Primary Key.
-     */
-    id: number;
+Therefore, it does not require any extra dedication like defining JSON schema (`@nestjs/swagger`) or using class definition with decorator function calls (`class-validator`). Just enjoy the **superfast** decorator with pure TypeScript type.
 
-    /**
-     * Parent comment ID.
-     * 
-     * Only When this comment has been written as a reply.
-     */
-    parent_id: number | null;
-
-    /**
-     * Type of the writer.
-     */
-    writer_type: "seller" | "consumer";
+```typescript
+import { Controller } from "@nestjs/common";
+import { TypedBody, TypedRoute } from "@nestia/core";
 
-    /**
-     * Name of the writer.
-     * 
-     * When this is a type of anonymous comment, writer name would be hidden.
-     */
-    writer_name: string | null;
+import { IBbsArticle } from "@bbs-api/structures/IBbsArticle";
 
-    /**
-     * Contents of the comments.
+@Controller("bbs/articles")
+export class BbsArticlesController {
+    /** 
+     * Store a new content.
      * 
-     * When the comment writer tries to modify content, it would not modify the comment
-     * content but would be accumulated. Therefore, all of the people can read how
-     * the content has been changed.
+     * @param inupt Content to store
+     * @returns Newly archived article
      */
-    contents: ISaleArticleComment.IContent[];
-
-    /**
-     * Creation time.
-     */
-    created_at: string;
+    @TypedRoute.Post() // 10x faster and safer JSON.stringify()
+    public async store(
+        @TypedBody() input: IBbsArticle.IStore // supoer-fast validator
+    ): Promise<IBbsArticle>;
 }
 ```
 
+### TypedBody
+`TypedBody()` is a decorator function of `application/json` typed request body.
 
+Also, it supports super-fast validation pipe using, which is maximum 15,000x times faster then ordinary `nest.Body()` decorator using `class-validator`.
 
+### TypedRoute
+`TypedRoute()` is a decorator function of `application/json` typed reponse 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.
 
-### Advanced Controller Class
-Controller also can use the generic arguments.
-
-In the previous [Pure DTO Interface](#pure-dto-interface) corner, we've learned that `nestia` can use the pure interface type as DTO. Also, we've learned that utilizing generic, union/intersection and even conditional typed interfaces are also possible.
-
-In the Controller case, it's same with the upper DTO story. With `nestia`, defining a generic typed controller class is also possible, too. By defining a generic typed controller class as a super-type class, you can reduce both duplicated code and description comments. 
-
-Look at the below code and feel how powerful `nestia` is.
-
-  - Simple [`CustomerSaleArticleCommentsController`](https://github.com/samchon/nestia/blob/master/demo/safe/src/controllers/ConsumerSaleArticleCommentsController.ts)
-  - Generic controllers
-    - abstract controller, [`SaleInquiriesController<Content, Store, Json>`](https://github.com/samchon/nestia/tree/master/demo/generic/src/controllers/SaleInquiriesController.ts)
-    - 1st sub-type controller, [`ConsumerSaleQuestionsController`](https://github.com/samchon/nestia/tree/master/demo/generic/src/controllers/ConsumerSaleQuestionsController.ts)
-    - 2nd sub-type controller, [`ConsumerSaleQuestionsController`](https://github.com/samchon/nestia/tree/master/demo/generic/src/controllers/ConsumerSaleQuestionsController.ts)
-  - Union controller, [`ConsumerSaleEntireArticlesController`](https://github.com/samchon/nestia/tree/master/demo/union/src/controllers/ConsumerSaleEntireArticlesController.ts)
+### Comment Tags
+You can enhance DTO type validation by writing comment tags.
 
-Also, you can validate request body data from client automatically, by using [nestia-helper](https://github.com/samchon/nestia-helper) and its `TypedBody()` decorator, which is maximum 1,000x times faster than other. Furthermore, `nestia-helper` boosts up JSON string conversion speed about 5x times faster through its `TypedRoute()` component. 
-
-![typescript-json benchmark](https://user-images.githubusercontent.com/13158709/194713658-62fb0716-c24e-41f9-be0d-01edeabb1dd6.png)
+If you want to know about it detaily, visit [Guide Documents of typia](https://github.com/samchon/typia/wiki/Runtime-Validators#comment-tags).
 
 ```typescript
-import express from "express";
-import { Controller, Param, Request } from "@nestjs/common";
-import { TypedBody, TypedRoute } from "nestia-helper";
+export interface IBbsArticle {
+    /**
+     * @format uuid
+     */
+    id: string;
 
-import { ISaleArticleComment } from "../api/structures/ISaleArticleComment";
+    writer: IBbsArticle.IWriter;
 
-@Controller("consumers/:section/sales/:saleId/articles/:articleId/comments")
-export class ConsumerSaleArticleCommentsController {
     /**
-     * Store a new comment.
-     *
-     * Write a comment on a sale article. If you configure the comment to be
-     * `anonymous`, only administrator, you and seller of the sale can read
-     * the content.
-     *
-     * @param request Instance of the Express.Request
-     * @param sectionCode Code of the target section
-     * @param saleId ID of the target sale
-     * @param articleId ID of the target article
-     * @param body Content to write
-     * @return Newly archived comment
-     *
-     * @throw 400 bad request error when type of the input data is not valid
-     * @throw 401 unauthorized error when you've not logged in yet
-     * @throw 403 forbidden error when you're a seller and the sale is not yours
-     * @throw 404 not found error when unable to find the matched record
+     * @minItems 1
      */
-    @TypedRoute.Post() // 5x faster JSON.stringify()
-    public async store(
-        @Request() request: express.Request,
-        @Param("section") sectionCode: string,
-        @Param("saleId") saleId: string,
-        @Param("articleId") articleId: string,
-        @TypedBody() body: ISaleArticleComment.IStore, // auto validation
-    ): Promise<ISaleArticleComment>;
+    contents: IBbsArticle.IContent[];
 }
-```
-
-
-
-
-### Software Development Kit
-> `Swagger` is torturing client developers.
->
-> If you're a backend developer and you deliver a `Swagger` to your companion client developers, they should analyze the `Swagger` and implement duplicated router functions with DTO interfaces by themselves. During those jobs, if a client developer takes a mistake by mis-reading the `Swagger`, it becomes a critical runtime error directly.
->
-> Why are you torturing the client developers such like that? If you deliver an SDK (Software Development Kit) instead of the `Swagger`, the client developers don't need to read the `Swagger` file. They never need to implement the duplicated DTO interfaces with router functions, either.
->
-> Therefore, just build the SDK through this `nestia` and deliver the SDK. Your client developers would be anticipated from the long time torturing and become happy. Your solution would be much more reliable and efficient, too.
-
-Looking at the SDK library file, generated by `nestia`, it is perfect.
-
-Route method, path and parameters are well-formed and DTO structures are correctly imported. Also, descriptive comments are fully revived in the SDK library, regardless of where they are written.
-
-Furthermore, there's not any problem even when a generic typed controller class comes. `nestia` will specialize the generic arguments exactly, by analyzing your `NestJS` server code, in the compilation level.
-
-  - [simple/.../comments/index.ts](https://github.com/samchon/nestia/blob/master/demo/safe/src/api/functional/consumers/sales/articles/comments/index.ts)
-  - [generic/.../questions/index.ts](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/functional/consumers/sales/questions/index.ts)
-  - [generic/.../reviews/index.ts](https://github.com/samchon/nestia/tree/master/demo/generic/src/api/functional/consumers/sales/reviews/index.ts)
-  - [union/.../entire_articles/index.ts](https://github.com/samchon/nestia/tree/master/demo/union/src/api/functional/consumers/sales/entire_articles/index.ts)
-
-```typescript
-/**
- * @packageDocumentation
- * @module api.functional.consumers.sales.reviews
- * @nestia Generated by Nestia - https://github.com/samchon/nestia 
- */
-//================================================================
-import { Fetcher, Primitive } from "nestia-fetcher";
-import type { IConnection } from "nestia-fetcher";
-import TSON from "typescript-json";
-
-import type { ISaleReview } from "./../../../../structures/ISaleReview";
-import type { ISaleInquiry } from "./../../../../structures/ISaleInquiry";
+export namespace IBbsArticle {
+    export interface IWriter {
+        /**
+         * @minLength 3
+         */
+        name: string;
 
-/**
- * Store a new inquiry.
- * 
- * Write a new article inquirying about a sale.
- * 
- * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
- * @param request Instance of the Express.Request
- * @param section Code of the target section
- * @param saleId ID of the target sale
- * @param input Content to archive
- * @return Newly archived inquiry
- * @throw 400 bad request error when type of the input data is not valid
- * @throw 401 unauthorized error when you've not logged in yet
- * 
- * @controller ConsumerSaleReviewsController.store()
- * @path POST /consumers/:section/sales/:saleId/reviews
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function store
-    (
-        connection: IConnection,
-        section: string,
-        saleId: string,
-        input: Primitive<store.Input>
-    ): Promise<store.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        store.ENCRYPTED,
-        store.METHOD,
-        store.path(section, saleId),
-        input,
-        store.stringify
-    );
-}
-export namespace store
-{
-    export type Input = Primitive<ISaleReview.IStore>;
-    export type Output = Primitive<ISaleInquiry<ISaleReview.IContent>>;
+        /**
+         * @format email
+         */
+        email: string;
 
-    export const METHOD = "POST" as const;
-    export const PATH: string = "/consumers/:section/sales/:saleId/reviews";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: false,
-    };
-
-    export function path(section: string, saleId: string): string
-    {
-        return `/consumers/${section}/sales/${saleId}/reviews`;
-    }
-    export const stringify = (input: Input) => TSON.stringify(input);
-}
+        /**
+         * @pattern ^0[0-9]{7,16}
+         */
+        mobile: string;
 
-/**
- * Update an inquiry.
- * 
- * Update ordinary inquiry article. However, it would not modify the content reocrd
- * {@link ISaleInquiry.IContent}, but be accumulated into the {@link ISaleInquiry.contents}. 
- * Therefore, all of the poeple can read how the content has been changed.
- * 
- * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
- * @param request Instance of the Express.Request
- * @param section Code of the target section
- * @param saleId ID of the target sale
- * @param id ID of the target article to be updated
- * @param input New content to be overwritten
- * @return The newly created content record
- * @throw 400 bad request error when type of the input data is not valid
- * @throw 401 unauthorized error when you've not logged in yet
- * @throw 403 forbidden error when the article is not yours
- * 
- * @controller ConsumerSaleReviewsController.update()
- * @path PUT /consumers/:section/sales/:saleId/reviews/:id
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function update
-    (
-        connection: IConnection,
-        section: string,
-        saleId: string,
-        id: number,
-        input: Primitive<update.Input>
-    ): Promise<update.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        update.ENCRYPTED,
-        update.METHOD,
-        update.path(section, saleId, id),
-        input,
-        update.stringify
-    );
-}
-export namespace update
-{
-    export type Input = Primitive<ISaleReview.IStore>;
-    export type Output = Primitive<ISaleInquiry<ISaleReview.IContent>>;
-
-    export const METHOD = "PUT" as const;
-    export const PATH: string = "/consumers/:section/sales/:saleId/reviews/:id";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: false,
-    };
-
-    export function path(section: string, saleId: string, id: number): string
-    {
-        return `/consumers/${section}/sales/${saleId}/reviews/${id}`;
+        /**
+         * @minimum 18
+         */
+        age: number;
     }
-    export const stringify = (input: Input) => TSON.stringify(input);
 }
 ```
 
 
 
 
-### Swagger
-Building `Swagger` is also possible and even much powerful.
-
-Looking at the [simple/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Fsimple%2Fswagger.json) file, generated by `nestia`, everything is perfect. Route method, path and parameters are well-formed. Also, schema definitions are exactly matched with the pure interface type `ISaleArticleComment`. Of course, descriptive comments are perfectly resurrected in the `description` properties of the `swagger.json` file.
-
-Looking at the another file [generic/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Fgeneric%2Fswagger.json), you can find that there isn't any problem even when a generic typed DTO and controller come. The last file [union/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Funion%2Fswagger.json), there's no problem on the union type, either.
-
-  - View in the `Swagger Editor`
-    - [simple/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Fsafe%2Fswagger.json)
-    - [generic/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Fgeneric%2Fswagger.json)
-    - [union/swagger.json](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fnestia%2Fmaster%2Fdemo%2Funion%2Fswagger.json)
+## `@nestia/sdk`
+[![npm version](https://img.shields.io/npm/v/@nestia/sdk.svg)](https://www.npmjs.com/package/@nestia/sdk)
+[![Downloads](https://img.shields.io/npm/dm/@nestia/sdk.svg)](https://www.npmjs.com/package/@nestia/sdk)
 
-![Swagger Editor](https://github.com/samchon/nestia/wiki/images/swagger-editor-comment.png)
+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.
 
-
-## Configuration
-Components                   | `nestia.config.ts` | `CLI` | `@nestjs/swagger`
------------------------------|--------------------|-------|------------------
-Swagger Generation           | ✔  | ✔  | ✔
-SDK Generation               | ✔  | ✔  | ❌
-5x faster `JSON.stringify()` | ✔  | ❌ | ❌
-Type check in runtime        | ✔  | ❌ | ❌
-Custom compiler options      | ✔  | ❌ | ❌
-
-`nestia` can configure generator options by two ways: CLI and configuration file.
-
-At first, the CLI (Command Line Interface) is convenient, but does not support detailed options.
-
-```sh
+### Usage
+```bash
 # BASIC COMMAND
 npx nestia <sdk|swagger> <source_directories_or_patterns> \
     --exclude <exclude_directory_or_pattern> \
     --out <output_directory_or_file>
 
 # EXAMPLES
-npx nestia sdk "src/controllers" --out "src/api"
-npx nestia swagger "src/**/*.controller.ts" --out "swagger.json"
-npx nestia swagger "src/main/controllers" "src/sub/controllers" \
-    --exclude "src/main/test" \
-    --out "composite.swagger.json"
+npx nestia sdk "src/**/*.controller.ts" --out "src/api"
+npx nestia swagger "src/controllers" --out "dist/swagger.json"
+```
 
-# ONLY WHEN NESTIA.CONFIG.TS EXISTS
+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
 npx nestia sdk
 npx nestia swagger
 ```
 
-Besides, the configuration file `nestia.config.ts` supports much detailed options. 
-
-The detailed options are listed up to the `IConfiguration` interface. You can utilize the `IConfiguration` type like below. If you want to know more about those options, please check the [Guide Documents](https://github.com/samchon/nestia/wiki/Configuration).
-
-<details>
-    <summary> Read <code>IConfiguration</code> </summary>
+### 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 ts from "typescript";
-import type { StripEnums } from "./utils/StripEnums";
+import { Fetcher, IConnection } from "@nestia/fetcher";
+import { IBbsArticle } from "../../../structures/IBbsArticle";
 
 /**
- * Definition for the `nestia.config.ts` file.
- *
- * @author Jeongho Nam - https://github.com/samchon
+ * Store a new content.
+ * 
+ * @param input Content to store
+ * @returns Newly archived article
  */
-export interface IConfiguration {
-    /**
-     * List of files or directories containing the NestJS controller classes.
-     */
-    input: string | string[] | IConfiguration.IInput;
-
-    /**
-     * Output directory that SDK would be placed in.
-     *
-     * If not configured, you can't build the SDK library.
-     */
-    output?: string;
-
-    /**
-     * Compiler options for the TypeScript.
-     *
-     * If you've omitted this property or the assigned property cannot fully cover the
-     * `tsconfig.json`, the properties from the `tsconfig.json` would be assigned to here.
-     * Otherwise, this property has been configured and it's detailed values are different
-     * with the `tsconfig.json`, this property values would be used instead.
-     *
-     * ```typescript
-     * import ts from "typescript";
-     *
-     * const tsconfig: ts.TsConfig;
-     * const nestiaConfig: IConfiguration;
-     *
-     * const compilerOptions: ts.CompilerOptions = {
-     *     ...tsconfig.compilerOptions,
-     *     ...(nestiaConfig.compilerOptions || {})
-     * }
-     * ```
-     */
-    compilerOptions?: StripEnums<ts.CompilerOptions>;
-
-    /**
-     * Whether to assert parameter types or not.
-     *
-     * If you configure this property to be `true`, all of the function parameters would be
-     * checked through the [typescript-json](https://github.com/samchon/typescript-json#runtime-type-checkers).
-     * This option would make your SDK library slower, but would enahcne the type safety even
-     * in the runtime level.
-     *
-     * @default false
-     */
-    assert?: boolean;
-
-    /**
-     * Whether to optimize JSON string conversion 2x faster or not.
-     *
-     * If you configure this property to be `true`, the SDK library would utilize the
-     * [typescript-json](https://github.com/samchon/typescript-json#fastest-json-string-converter)
-     * and the JSON string conversion speed really be 2x faster.
-     *
-     * @default false
-     */
-    json?: boolean;
-
-    /**
-     * Whether to wrap DTO by primitive type.
-     *
-     * If you don't configure this property as `false`, all of DTOs in the
-     * SDK library would be automatically wrapped by {@link Primitive} type.
-     *
-     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
-     * all of methods in the DTO type would be automatically erased. Also, if
-     * the DTO has a `toJSON()` method, the DTO type would be automatically
-     * converted to return type of the `toJSON()` method.
-     *
-     * @default true
-     */
-    primitive?: boolean;
-
-    /**
-     * Building `swagger.json` is also possible.
-     *
-     * If not specified, you can't build the `swagger.json`.
-     */
-    swagger?: IConfiguration.ISwagger;
+export function store(
+    connection: api.IConnection, 
+    input: IBbsArticle.IStore
+): Promise<IBbsArticle> {
+    return Fetcher.fetch(
+        connection,
+        store.ENCRYPTED,
+        store.METHOD,
+        store.path(),
+        input
+    );
 }
-export namespace IConfiguration {
-    /**
-     * List of files or directories to include or exclude to specifying the NestJS
-     * controllers.
-     */
-    export interface IInput {
-        /**
-         * List of files or directories containing the NestJS controller classes.
-         */
-        include: string[];
-
-        /**
-         * List of files or directories to be excluded.
-         */
-        exclude?: string[];
-    }
-
-    /**
-     * Building `swagger.json` is also possible.
-     */
-    export interface ISwagger {
-        /**
-         * Output path of the `swagger.json`.
-         *
-         * If you've configured only directory, the file name would be the `swagger.json`.
-         * Otherwise you've configured the full path with file name and extension, the
-         * `swagger.json` file would be renamed to it.
-         */
-        output: string;
+export namespace store {
+    export const METHOD = "POST" as const;
+    export function path(): string {
+        return "/bbs/articles";
     }
 }
-
-```
-</details>
-
-```typescript
-import type { IConfiguration } from "nestia";
-
-export const NESTIA_CONFIG: IConfiguration = {
-    input: "./src/controllers",
-    output: "./src/api",
-    json: true,
-    swagger: {
-        output: "./public/swagger.json"
-    }
-};
-export default NESTIA_CONFIG;
 ```
 
+With SDK library, client developers would get take advantages of TypeScript like below. 
 
+If you want to learn how to distribute SDK library, visit and read [Guide Documents - Distribution](https://github.com/samchon/nestia/wiki/Distribution).
 
+```typescript
+import api from "@bbs-api";
+import typia from "typia";
 
-## Appendix
-### Dependencies of the SDK
-An SDK library generated by `nestia` requires [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module. Also, [typescript-json](https://github.com/samchon/typescript-json) module can be required following your `nestia.config.ts` configuration file.
-
-The `npx nestia install` command installs those dependencies with the `package.json` configuration.
-
-```bash
-# MOVE TO THE DISTRIBUTION DIRECTORY
-cd packages/api
-
-# INSTALL DEPENDENCIES OF THE SDK
-npx nestia install
+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);
+}
 ```
 
-### Nestia-Helper
-https://github.com/samchon/nestia-helper
 
-If you utilize `nestia` with [nestia-helper](https://github.com/samchon/nestia-helper), you can automatically validatea pure DTO interace without any extra dedication. It analyzes your backend server code in the compilation level and add request body validation code automatically.
 
-```typescript
-import helper from "nestia-helper";
-import { Controller } from "@nestjs/common";
 
-@Controller("bbs/articles")
-export class BbsArticlesController {
-    //----
-    // `TSON.stringify()` for `IBbsArticle` 
-    // Boost up JSON conversion speed about 5x times faster 
-    //----
-    // `TSON.assert()` for `IBbsArticle.IStore`
-    // If client request body is not following type type, 
-    // `BadRequestException` (status code: 400) would be thrown
-    //----
-    @helper.TypedRoute.Post()
-    public async store(
-        // automatic validation
-        @helper.TypedBody() input: IBbsArticle.IStore
-    ): Promise<IBbsArticle> {
-        const article: BbsArticle = await BbsArticeProvider.store(input);
-        const json: IBbsArticle = await BbsArticleProvider.json().getOne(article);
-
-        // 5x times faster JSON conversion
-        return Paginator.paginate(stmt, input);
-    }
-}
-```
+## Appendix
+### Typia
+> https://github.com/samchon/typia
+> 
+> `@nestia/core` is wrapping `typia` and the `typia` is:
 
-### TypeScript-JSON
-https://github.com/samchon/typescript-json
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/typia/blob/master/LICENSE)
+[![npm version](https://img.shields.io/npm/v/typia.svg)](https://www.npmjs.com/package/typia)
+[![Downloads](https://img.shields.io/npm/dm/typia.svg)](https://www.npmjs.com/package/typia)
+[![Build Status](https://github.com/samchon/typia/workflows/build/badge.svg)](https://github.com/samchon/typia/actions?query=workflow%3Abuild)
+[![Guide Documents](https://img.shields.io/badge/wiki-documentation-forestgreen)](https://github.com/samchon/typia/wiki)
 
 ```typescript
-import TSON from "typescript-json";
-
-//----
 // RUNTIME VALIDATORS
-//----
-// ALLOW SUPERFLUOUS PROPERTIES
-TSON.assert<T>(input); // throws exception
-TSON.is<T>(input); // returns boolean value
-TSON.validate<T>(input); // archives all errors
-
-// DO NOT ALLOW SUPERFLUOUS PROPERTIES
-TSON.equals<T>(input); // returns boolean value
-TSON.assert<T>(input); // throws exception
-TSON.validateEquals<T>(input); // archives all errors
-
-//----
-// APPENDIX FUNCTIONS
-//----
-TSON.stringify<T>(input); // 5x faster JSON.stringify()
-TSON.application<[T, U, V], "swagger">(); // JSON schema application generator
-TSON.create<T>(input); // 2x faster object creator (only one-time construction)
+export function is<T>(input: unknown | T): input is T; // returns boolean
+export function assert<T>(input: unknown | T): T; // throws TypeGuardError
+export function validate<T>(input: unknown | T): IValidation<T>; // detailed
+
+// STRICT VALIDATORS
+export function equals<T>(input: unknown | T): input is T;
+export function assertEquals<T>(input: unknown | T): T;
+export function validateEquals<T>(input: unknown | T): IValidation<T>;
+
+// JSON
+export function application<T>(): IJsonApplication; // JSON schema
+export function assertParse<T>(input: string): T; // type safe parser
+export function assertStringify<T>(input: T): string; // safe and faster
+    // +) isParse, validateParse 
+    // +) stringify, isStringify, validateStringify
 ```
 
-`typescript-json` is a transformer library providing JSON related functions.
+`typia` is a transformer library of TypeScript, supporting below features:
 
-  - Powerful Runtime type checkers:
-    - Performed by only one line, `TSON.assert<T>(input)`
-    - Only one library which can validate union type
-    - Maximum 9,000x faster than other libraries
-  - 5x faster `JSON.stringify()` function:
-    - Performed by only one line: `TSON.stringify<T>(input)`
-    - Only one library which can stringify union type
-    - 10,000x faster optimizer construction time than similar libraries
+  - Super-fast Runtime Validators
+  - Safe JSON parse and fast stringify functions
+  - JSON schema generator
 
-[typescript-json](https://github.com/samchon/typescript-json) analyzes TypeScript source code and generates optimized validators and JSON string converters in the compilation level. It is the reason why `nestia` can generate SDK library is by analyzing NestJS code and how [nestia-helper](https://github.com/samchon/nestia-helper) validates request body data automatically.
+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, its performance enhancement is much greater than other libraries. For example, validator function `TSON.is<T>(input: T): boolean` is maximum 9,000x times faster than other validator libraries.
+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`.