nestia 2.1.0-dev.20220505 → 2.1.0-dev.20220506

package/README.md

@@ -1,5 +1,5 @@
 # Nestia
-Automatic SDK generator for the NestJS.
+Automatic `SDK` and `swagger.json` generator for the NestJS.
 
 [![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)
@@ -20,17 +20,17 @@ npx nestia sdk "src/**/*.controller.ts" --out "src/api"
 npx nestia swagger "src/controller" -- out "swagger.json"
 ```
 
-Don't write any `swagger` comment or decorator. Just deliver the SDK.
+Don't write any `swagger` comment or DTO decorator. Just deliver the SDK.
 
   - No swagger comment/decorator
   - No DTO comment/decorator
   - Only pure NestJS source code and interface structures are required
 
-When you're developing a backend server using the `NestJS`, you don't need any extra dedication, for delivering the Rest API to the client developers, like writing the `swagger` comments or decorators. 
+When you're developing a backend server using the `NestJS`, you don't need any extra dedication, for delivering the Rest API to the client developers, like writing the `swagger` comments or DTO decorators. 
 
-You just run this **Nestia** up, then **Nestia** would generate the SDK automatically, by analyzing your controller classes in the compliation and runtime level. Even generating the `swagger.json` without any swagger comment or decorator is also possible. When generating the SDK or `swwagger.json`, no DTO comment or decorator is required. Use only the pure interface definitions.
+You just run this **Nestia** up, then **Nestia** would generate the SDK automatically, by analyzing your controller classes in the compliation and runtime level. With the automatically generated SDK through this **Nestia**, client developer also does not need any extra work, like reading `swagger` and writing the duplicated interaction code. Client developer only needs to import the SDK and calls matched function with the `await` symbol.
 
-With the automatically generated SDK through this **Nestia**, client developer also does not need any extra work, like reading `swagger` and writing the duplicated interaction code. Client developer only needs to import the SDK and calls matched function with the `await` symbol.
+> Even generating the `swagger.json` without any swagger comment and DTO decorator is also possible. When generating the `swagger.json`, no DTO comment and decorator is required, either. Use only the pure interface definitions.
 
 ```typescript
 import api from "@samchon/bbs-api";
@@ -108,7 +108,7 @@ Also, when generating a SDK using the cli options, `compilerOptions` would follo
 npx nestia install
 ```
 
-SDK library generated by the **Nestia** requires the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) and [typescript-is](https://github.com/woutervh-/typescript-is) modules.
+SDK library generated by the **Nestia** requires the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module. Also, the [typescript-is](https://github.com/woutervh-/typescript-is) and [typescript-json](https://github.com/samchon/typescript-json) modules can be required following your [nestia.config.ts](#nestiaconfigts) options.
 
 The `npx nestia install` command installs those dependencies with `package.json` configuration.
 
@@ -116,8 +116,9 @@ The `npx nestia install` command installs those dependencies with `package.json`
 {
   "name": "payments-server-api",
   "dependencies": {
-    "nestia-fetcher": "^2.0.0",
-    "typescript-is": "^0.19.0"
+    "nestia-fetcher": "^2.0.1",
+    "typescript-is": "^0.19.0",
+    "typescript-json": "^2.0.9"
   }
 }
 ```
@@ -442,9 +443,9 @@ export namespace store
 ```
 
 ### `swagger.json`
-Even the `swagger.json` does not require any swagger comment or decorator function.
+Even the `swagger.json` generation does not require any swagger comment and DTO decorator.
 
-The **Nestia** will generate the perfect `swagger.json` automatically, by analyzing your source code (DTO interface and controller class) in the compilation and runtime level. Even your descriptive comments would be placed into the adequate `description` property in the `swagger.json`.
+The **Nestia** will generate the perfect `swagger.json` automatically, by analyzing your source code (DTO interface and controller class) in the compilation and runtime level. Furthermore, your descriptive comments would be automatically assigned into the adequate `description` property in the `swagger.json`.
 
 ```json
 {
@@ -587,6 +588,21 @@ The **Nestia** will generate the perfect `swagger.json` automatically, by analyz
           "body"
         ],
         "description": "Content info."
+      },
+      "ISaleComment.IStore": {
+        "type": "object",
+        "properties": {
+          "body": {
+            "description": "Body of the content.",
+            "type": "string",
+            "nullable": false
+          }
+        },
+        "nullable": false,
+        "required": [
+          "body"
+        ],
+        "description": "Store info."
       }
     }
   }

package/lib/generates/SwaggerGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SwaggerGenerator.d.ts","sourceRoot":"","sources":["../../src/generates/SwaggerGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAU9C,yBAAiB,gBAAgB,CACjC;IACI,SAAsB,QAAQ,CAEtB,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,MAAM,EAAE,cAAc,CAAC,QAAQ,EAC/B,SAAS,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,IAAI,CAAC,CAsCnB;CAuMJ"}
+{"version":3,"file":"SwaggerGenerator.d.ts","sourceRoot":"","sources":["../../src/generates/SwaggerGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAU9C,yBAAiB,gBAAgB,CACjC;IACI,SAAsB,QAAQ,CAEtB,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,MAAM,EAAE,cAAc,CAAC,QAAQ,EAC/B,SAAS,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,IAAI,CAAC,CAsCnB;CA0NJ"}

package/lib/generates/SwaggerGenerator.js

@@ -141,6 +141,9 @@ var SwaggerGenerator;
         });
     }
     SwaggerGenerator.generate = generate;
+    /* ---------------------------------------------------------
+        INITIALIZERS
+    --------------------------------------------------------- */
     function initialize(path) {
         return __awaiter(this, void 0, void 0, function () {
             var swagger, _a, _b, _c;
@@ -193,8 +196,18 @@ var SwaggerGenerator;
     }
     function generate_route(checker, collection, route) {
         var bodyParam = route.parameters.find(function (param) { return param.category === "body"; });
+        var tags = route.tags
+            .filter(function (tag) {
+            return tag.name === "tag" &&
+                tag.text &&
+                tag.text.find(function (elem) {
+                    return elem.kind === "text" &&
+                        elem.text.length;
+                }) !== undefined;
+        })
+            .map(function (tag) { return tag.text.find(function (elem) { return elem.kind === "text"; }).text; });
         return {
-            tags: [],
+            tags: tags,
             parameters: route.parameters
                 .filter(function (param) { return param.category !== "body"; })
                 .map(function (param) { return generate_parameter(checker, collection, route, param); }),
@@ -205,6 +218,9 @@ var SwaggerGenerator;
             description: CommentFactory_1.CommentFactory.generate(route.comments)
         };
     }
+    /* ---------------------------------------------------------
+        REQUEST & RESPONSE
+    --------------------------------------------------------- */
     function generate_parameter(checker, collection, route, parameter) {
         return {
             name: parameter.name,
@@ -269,6 +285,9 @@ var SwaggerGenerator;
         }));
         return __assign(__assign({}, exceptions), success);
     }
+    /* ---------------------------------------------------------
+        UTILS
+    --------------------------------------------------------- */
     function generate_schema(checker, collection, type) {
         var entity = MetadataFactory_1.MetadataFactory.generate(checker, type, collection);
         return SchemaFactory_1.SchemaFactory.schema((entity === null || entity === void 0 ? void 0 : entity.metadata) || null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestia",
-  "version": "2.1.0-dev.20220505",
+  "version": "2.1.0-dev.20220506",
   "description": "Automatic SDK and Document generator for the NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",