Merge pull request #1171 from samchon/feat/examples

Fix `TypedException.IProps.examples` type.
samchon · Dec 27, 2024 · c76cf0e · c76cf0e
2 parents 91f2979 + f4d797a
commit c76cf0e
Show file tree

Hide file tree

Showing 13 changed files with 140 additions and 19 deletions.
diff --git a/benchmark/package.json b/benchmark/package.json
@@ -42,7 +42,7 @@
     "reflect-metadata": "^0.2.2",
     "tgrid": "^1.1.0",
     "tstl": "^3.0.0",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "devDependencies": {
     "@types/autocannon": "^7.9.0",

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@nestia/station",
-  "version": "4.5.1",
+  "version": "4.5.2",
   "description": "Nestia station",
   "scripts": {
     "build": "node deploy build",

diff --git a/packages/benchmark/package.json b/packages/benchmark/package.json
@@ -34,7 +34,7 @@
     "ts-patch": "^3.3.0",
     "typescript": "~5.7.2",
     "typescript-transform-paths": "^3.4.7",
-    "typia": "^7.5.0",
+    "typia": "^7.5.1",
     "uuid": "^10.0.0"
   },
   "dependencies": {

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -39,7 +39,7 @@
     "@nestia/fetcher": "workspace:^",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
-    "@samchon/openapi": "^2.3.0",
+    "@samchon/openapi": "^2.3.1",
     "detect-ts-node": "^1.0.5",
     "get-function-location": "^2.0.0",
     "glob": "^7.2.0",
@@ -48,7 +48,7 @@
     "reflect-metadata": ">=0.1.12",
     "rxjs": ">=6.0.3",
     "tgrid": "^1.1.0",
-    "typia": "^7.5.0",
+    "typia": "^7.5.1",
     "ws": "^7.5.3"
   },
   "peerDependencies": {
@@ -57,7 +57,7 @@
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",
     "rxjs": ">=6.0.3",
-    "typia": ">=7.5.0 <8.0.0"
+    "typia": ">=7.5.1 <8.0.0"
   },
   "devDependencies": {
     "@nestjs/common": "^10.4.13",

diff --git a/packages/core/src/decorators/TypedException.ts b/packages/core/src/decorators/TypedException.ts
@@ -119,10 +119,48 @@ export function TypedException<T>(...args: any[]): MethodDecorator {
   };
 }
 export namespace TypedException {
+  /**
+   * Properties for the exception.
+   */
   export interface IProps<T> {
+    /**
+     * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
+     */
     status: number | "2XX" | "3XX" | "4XX" | "5XX";
+
+    /**
+     * Description about the exception.
+     */
+    description?: string | undefined;
+
+    /**
+     * Example value.
+     */
+    example?: T | undefined;
+
+    /**
+     * Collection of examples for the exception.
+     */
+    examples?: Record<string, IExample<T>> | undefined;
+  }
+
+  /**
+   * Metadata collected in the {@link IProps.examples}.
+   */
+  export interface IExample<T> {
+    /**
+     * Summary of the example.
+     */
+    summary?: string | undefined;
+
+    /**
+     * Description of the example.
+     */
     description?: string | undefined;
-    example?: T;
-    examples?: Record<string, T>;
+
+    /**
+     * Value of the example.
+     */
+    value: T;
   }
 }
diff --git a/packages/e2e/package.json b/packages/e2e/package.json
@@ -41,7 +41,7 @@
     "ts-patch": "^3.3.0",
     "typescript": "~5.7.2",
     "typescript-transform-paths": "^3.4.7",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "files": [
     "lib",

diff --git a/packages/editor/package.json b/packages/editor/package.json
@@ -35,12 +35,12 @@
   "dependencies": {
     "@mui/material": "^5.15.6",
     "@nestia/migrate": "workspace:^",
-    "@samchon/openapi": "^2.3.0",
+    "@samchon/openapi": "^2.3.1",
     "@stackblitz/sdk": "^1.11.0",
     "js-yaml": "^4.1.0",
     "prettier": "3.3.3",
     "react-mui-fileuploader": "^0.5.2",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.13.0",

diff --git a/packages/fetcher/package.json b/packages/fetcher/package.json
@@ -26,8 +26,8 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@samchon/openapi": "^2.3.0",
-    "typia": "^7.5.0"
+    "@samchon/openapi": "^2.3.1",
+    "typia": "^7.5.1"
   },
   "peerDependencies": {
     "typescript": ">= 4.8.0"
@@ -38,7 +38,7 @@
     "@typescript-eslint/parser": "^5.46.1",
     "rimraf": "^3.0.2",
     "typescript": "~5.7.2",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "files": [
     "README.md",

diff --git a/packages/migrate/package.json b/packages/migrate/package.json
@@ -72,13 +72,13 @@
   },
   "dependencies": {
     "@nestia/sdk": "workspace:^",
-    "@samchon/openapi": "^2.3.0",
+    "@samchon/openapi": "^2.3.1",
     "commander": "10.0.0",
     "inquirer": "8.2.5",
     "prettier": "^3.2.5",
     "tstl": "^3.0.0",
     "typescript": "~5.7.2",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "files": [
     "lib",

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -34,7 +34,7 @@
   "dependencies": {
     "@nestia/core": "workspace:^",
     "@nestia/fetcher": "workspace:^",
-    "@samchon/openapi": "^2.3.0",
+    "@samchon/openapi": "^2.3.1",
     "cli": "^1.0.1",
     "get-function-location": "^2.0.0",
     "glob": "^7.2.0",
@@ -44,7 +44,7 @@
     "tsconfck": "^2.1.2",
     "tsconfig-paths": "^4.1.1",
     "tstl": "^3.0.0",
-    "typia": "^7.5.0"
+    "typia": "^7.5.1"
   },
   "peerDependencies": {
     "@nestia/core": ">=4.5.0-dev.20241218-2",
@@ -53,7 +53,7 @@
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",
     "ts-node": ">=10.6.0",
-    "typia": ">=7.5.0 <8.0.0"
+    "typia": ">=7.5.1 <8.0.0"
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",

diff --git a/test/features/exception/src/controllers/ExceptionController.ts b/test/features/exception/src/controllers/ExceptionController.ts
@@ -27,6 +27,32 @@ export class ExceptionController {
       value: 123,
       message: "invalid type",
     },
+    examples: {
+      title: {
+        summary: "title",
+        description: "Wrong type of the title",
+        value: {
+          name: "BadRequestException",
+          method: "TypedBody",
+          path: "$input.title",
+          expected: "string",
+          value: 123,
+          message: "invalid type",
+        },
+      },
+      content: {
+        summary: "content",
+        description: "content of the article",
+        value: {
+          name: "BadRequestException",
+          method: "TypedBody",
+          path: "$input.title",
+          expected: "string",
+          value: 123,
+          message: "invalid type",
+        },
+      },
+    },
   })
   @TypedException<INotFound>(404, "unable to find the matched section")
   @TypedException<IUnprocessibleEntity>(428)

diff --git a/test/features/exception/src/test/features/test_swagger.ts b/test/features/exception/src/test/features/test_swagger.ts
@@ -25,4 +25,35 @@ export const test_swagger = async () => {
       { $ref: "#/components/schemas/IExceptional.Everything" },
     ],
   });
+
+  TestValidator.equals("examples")(
+    content.paths["/exception/{section}/typed"].post.responses[400].content[
+      "application/json"
+    ].examples,
+  )({
+    title: {
+      summary: "title",
+      description: "Wrong type of the title",
+      value: {
+        name: "BadRequestException",
+        method: "TypedBody",
+        path: "$input.title",
+        expected: "string",
+        value: 123,
+        message: "invalid type",
+      },
+    },
+    content: {
+      summary: "content",
+      description: "content of the article",
+      value: {
+        name: "BadRequestException",
+        method: "TypedBody",
+        path: "$input.title",
+        expected: "string",
+        value: 123,
+        message: "invalid type",
+      },
+    },
+  });
 };
diff --git a/test/features/exception/swagger.json b/test/features/exception/swagger.json
@@ -63,6 +63,32 @@
                   "expected": "string",
                   "value": 123,
                   "message": "invalid type"
+                },
+                "examples": {
+                  "title": {
+                    "summary": "title",
+                    "description": "Wrong type of the title",
+                    "value": {
+                      "name": "BadRequestException",
+                      "method": "TypedBody",
+                      "path": "$input.title",
+                      "expected": "string",
+                      "value": 123,
+                      "message": "invalid type"
+                    }
+                  },
+                  "content": {
+                    "summary": "content",
+                    "description": "content of the article",
+                    "value": {
+                      "name": "BadRequestException",
+                      "method": "TypedBody",
+                      "path": "$input.title",
+                      "expected": "string",
+                      "value": 123,
+                      "message": "invalid type"
+                    }
+                  }
                 }
               }
             }