Merge pull request #549 from samchon/features/TypedException

Complement #540 - `ISwaggerRoute.IResponseBody.description` is required.
samchon · Aug 17, 2023 · 45ad1b5 · 45ad1b5
2 parents 6bdc102 + 2cfc470
commit 45ad1b5
Show file tree

Hide file tree

Showing 33 changed files with 146 additions and 80 deletions.
diff --git a/benchmark/package.json b/benchmark/package.json
@@ -24,7 +24,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/core": "^1.6.4",
+    "@nestia/core": "^1.6.5",
     "typia": "^4.2.3"
   },
   "devDependencies": {

diff --git a/deploy/latest.sh b/deploy/latest.sh
@@ -50,4 +50,4 @@ npm install --save typia@latest
 npm install --save-dev @nestia/core@latest
 npm install --save-dev @nestia/fetcher@latest
 npm run build
-npm publish --access public --tag latest
+npm publish --access public --tag latest
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -36,8 +36,8 @@
     "inquirer": "^8.2.5"
   },
   "devDependencies": {
-    "@nestia/core": "^1.6.4",
-    "@nestia/sdk": "^1.6.4",
+    "@nestia/core": "^1.6.5",
+    "@nestia/sdk": "^1.6.5",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/inquirer": "^9.0.3",
     "@types/node": "^18.11.16",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestia/core",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "description": "Super-fast validation decorators of NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -34,7 +34,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^1.6.4",
+    "@nestia/fetcher": "^1.6.5",
     "@nestjs/common": ">= 7.0.1",
     "@nestjs/core": ">= 7.0.1",
     "@nestjs/platform-express": ">= 7.0.1",
@@ -47,7 +47,7 @@
     "typia": "^4.2.3"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">= 1.6.4",
+    "@nestia/fetcher": ">= 1.6.5",
     "@nestjs/common": ">= 7.0.1",
     "@nestjs/core": ">= 7.0.1",
     "@nestjs/platform-express": ">= 7.0.1",

diff --git a/packages/fetcher/package.json b/packages/fetcher/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

diff --git a/packages/migrate/package.json b/packages/migrate/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestia/migrate",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "description": "Migration program from swagger to NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -30,8 +30,8 @@
   },
   "homepage": "https://github.com/samchon/nestia#readme",
   "devDependencies": {
-    "@nestia/core": "^1.6.4",
-    "@nestia/fetcher": "^1.6.4",
+    "@nestia/core": "^1.6.5",
+    "@nestia/fetcher": "^1.6.5",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/node": "^20.3.3",
     "prettier": "^2.8.8",

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestia/sdk",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "description": "Nestia SDK and Swagger generator",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -35,7 +35,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^1.6.4",
+    "@nestia/fetcher": "^1.6.5",
     "cli": "^1.0.1",
     "glob": "^7.2.0",
     "path-to-regexp": "^6.2.1",
@@ -47,7 +47,7 @@
     "typia": "^4.2.3"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">= 1.6.4",
+    "@nestia/fetcher": ">= 1.6.5",
     "@nestjs/common": ">= 7.0.1",
     "@nestjs/core": ">= 7.0.1",
     "reflect-metadata": ">= 0.1.12",

diff --git a/packages/sdk/src/generates/SwaggerGenerator.ts b/packages/sdk/src/generates/SwaggerGenerator.ts
@@ -580,7 +580,7 @@ export namespace SwaggerGenerator {
             );
             if (schema !== null)
                 output[status] = {
-                    description: exp.description,
+                    description: exp.description ?? "",
                     content: {
                         "application/json": { schema },
                     },
@@ -610,11 +610,11 @@ export namespace SwaggerGenerator {
             const description: string | undefined =
                 elements.length === 1 ? undefined : elements.slice(1).join(" ");
             const oldbie = output[status];
-            if (oldbie !== undefined && oldbie.description === undefined)
+            if (description && oldbie !== undefined)
                 oldbie.description = description;
             else if (oldbie === undefined)
                 output[status] = {
-                    description,
+                    description: description ?? "",
                     content: {
                         "application/json": {
                             schema: {},
@@ -651,7 +651,7 @@ export namespace SwaggerGenerator {
                 ? `${warning.get(!!description).get("response", route.method)}${
                       description ?? ""
                   }`
-                : description,
+                : description ?? "",
             content:
                 schema === null || route.output.name === "void"
                     ? undefined

diff --git a/packages/sdk/src/generates/internal/SdkFunctionProgrammer.ts b/packages/sdk/src/generates/internal/SdkFunctionProgrammer.ts
@@ -227,7 +227,7 @@ export namespace SdkFunctionProgrammer {
                 )
                     continue;
                 comments.push(
-                    value.description
+                    value.description?.length
                         ? `@throws ${key} ${value.description.split("\n")[0]}`
                         : `@throws ${key}`,
                 );

diff --git a/packages/sdk/src/structures/ISwaggerRoute.ts b/packages/sdk/src/structures/ISwaggerRoute.ts
@@ -31,7 +31,7 @@ export namespace ISwaggerRoute {
     export type IResponseBody = Record<
         string,
         {
-            description?: string;
+            description: string;
             content?: IContent;
             "x-nestia-encrypted"?: boolean;
         }

diff --git a/test/features/body-manual-assert/swagger.json b/test/features/body-manual-assert/swagger.json
@@ -57,7 +57,6 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "",
           "content": {
             "application/json": {
               "schema": {

diff --git a/test/features/body-manual-is/swagger.json b/test/features/body-manual-is/swagger.json
@@ -57,7 +57,6 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "",
           "content": {
             "application/json": {
               "schema": {

diff --git a/test/features/body-manual-validate/swagger.json b/test/features/body-manual-validate/swagger.json
@@ -57,7 +57,6 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "",
           "content": {
             "application/json": {
               "schema": {

diff --git a/test/features/distribute-assert/packages/api/package.json b/test/features/distribute-assert/packages/api/package.json
@@ -9,7 +9,7 @@
     "build:sdk": "rimraf ../../src/api/functional && cd ../.. && npx nestia sdk && cd packages/api",
     "compile": "rimraf lib && tsc",
     "deploy": "npm run build && npm publish",
-    "prepare": "ts-patch install"
+    "postinstall": "ts-patch install"
   },
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@nestia/fetcher": "^1.5.8",
-    "typia": "^4.2.1"
+    "@nestia/fetcher": "^1.6.4",
+    "typia": "^4.2.3"
   }
 }
diff --git a/test/features/distribute-json/packages/api/package.json b/test/features/distribute-json/packages/api/package.json
@@ -9,7 +9,7 @@
     "build:sdk": "rimraf ../../src/api/functional && cd ../.. && npx nestia sdk && cd packages/api",
     "compile": "rimraf lib && tsc",
     "deploy": "npm run build && npm publish",
-    "prepare": "ts-patch install"
+    "postinstall": "ts-patch install"
   },
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@nestia/fetcher": "^1.5.8",
-    "typia": "^4.2.1"
+    "@nestia/fetcher": "^1.6.4",
+    "typia": "^4.2.3"
   }
 }
diff --git a/test/features/distribute/packages/api/package.json b/test/features/distribute/packages/api/package.json
@@ -30,6 +30,6 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@nestia/fetcher": "^1.5.8"
+    "@nestia/fetcher": "^1.6.4"
   }
 }
diff --git a/test/features/encrypted/swagger.json b/test/features/encrypted/swagger.json
@@ -57,7 +57,7 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of yours",
+          "description": "## Warning\n\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n----------------\nInformation of yours",
           "content": {
             "text/plain": {
               "schema": {
@@ -70,7 +70,7 @@
         },
         "responses": {
           "201": {
-            "description": "## Warning\nResponse data have been encrypted.\n\nThe response body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedRoute.P.ost](https://github.com/samchon/@nestia/core#encryptedroute) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of newly joined seller",
+            "description": "## Warning\n\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n----------------\nInformation of newly joined seller",
             "content": {
               "text/plain": {
                 "schema": {
@@ -129,7 +129,7 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nEmail and password",
+          "description": "## Warning\n\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n----------------\nEmail and password",
           "content": {
             "text/plain": {
               "schema": {
@@ -142,7 +142,7 @@
         },
         "responses": {
           "201": {
-            "description": "## Warning\nResponse data have been encrypted.\n\nThe response body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedRoute.P.ost](https://github.com/samchon/@nestia/core#encryptedroute) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of the seller",
+            "description": "## Warning\n\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n----------------\nInformation of the seller",
             "content": {
               "text/plain": {
                 "schema": {
@@ -201,7 +201,7 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nOld and new passwords",
+          "description": "## Warning\n\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n----------------\nOld and new passwords",
           "content": {
             "text/plain": {
               "schema": {

diff --git a/test/features/equals/swagger.json b/test/features/equals/swagger.json
@@ -57,7 +57,6 @@
         "tags": [],
         "parameters": [],
         "requestBody": {
-          "description": "",
           "content": {
             "application/json": {
               "schema": {

diff --git a/test/features/exception-filter/swagger.json b/test/features/exception-filter/swagger.json
@@ -32,6 +32,7 @@
         },
         "responses": {
           "201": {
+            "description": "",
             "content": {
               "application/json": {
                 "schema": {
@@ -53,6 +54,7 @@
         "parameters": [],
         "responses": {
           "200": {
+            "description": "",
             "x-nestia-encrypted": false
           }
         },
@@ -78,6 +80,7 @@
         ],
         "responses": {
           "200": {
+            "description": "",
             "x-nestia-encrypted": false
           }
         },
@@ -102,6 +105,7 @@
         ],
         "responses": {
           "200": {
+            "description": "",
             "content": {
               "application/json": {
                 "schema": {
@@ -123,6 +127,7 @@
         "parameters": [],
         "responses": {
           "200": {
+            "description": "",
             "x-nestia-encrypted": false
           }
         },
@@ -137,6 +142,7 @@
         "parameters": [],
         "responses": {
           "200": {
+            "description": "",
             "x-nestia-encrypted": false
           }
         },
@@ -151,6 +157,7 @@
         "parameters": [],
         "responses": {
           "200": {
+            "description": "",
             "content": {
               "application/json": {
                 "schema": {

diff --git a/test/features/exception/src/controllers/ExceptionController.ts b/test/features/exception/src/controllers/ExceptionController.ts
@@ -1,5 +1,4 @@
 import { Controller } from "@nestjs/common";
-import { ApiResponse } from "@nestjs/swagger";
 import typia, { TypeGuardError } from "typia";
 
 import {
@@ -16,11 +15,11 @@ import { IUnprocessibleEntity } from "@api/lib/structures/IUnprocessibleEntity";
 
 @Controller("exception")
 export class ExceptionController {
+    @TypedRoute.Post(":section/typed")
     @TypedException<TypeGuardError>(400, "invalid request")
     @TypedException<INotFound>(404, "unable to find the matched section")
     @TypedException<IUnprocessibleEntity>(428)
     @TypedException<IInternalServerError>("5XX", "internal server error")
-    @TypedRoute.Post(":section/typed")
     public async typed(
         @TypedParam("section") section: string,
         @TypedBody() input: IBbsArticle.IStore,
@@ -52,11 +51,11 @@ export class ExceptionController {
      * @throw 428 unable to process the request
      * @throw 5XX internal server error
      */
+    @TypedRoute.Post(":section/composite")
     @TypedException<TypeGuardError>(400, "invalid request")
     @TypedException<INotFound>(404)
     @TypedException<IUnprocessibleEntity>(428)
     @TypedException<IInternalServerError>("5XX")
-    @TypedRoute.Post(":section/composite")
     public async composite(
         @TypedParam("section") section: string,
         @TypedBody() input: IBbsArticle.IStore,