@nestia/core 2.5.9-dev.20240223 → 2.5.9

package/lib/decorators/SwaggerCustomizer.d.ts

@@ -1,16 +1,64 @@
 import { ISwagger } from "../structures/ISwagger";
 import { ISwaggerRoute } from "../structures/ISwaggerRoute";
+/**
+ * Swagger customization decorator.
+ *
+ * `SwaggerCustomizer` is a method decorator function which can used for
+ * customizing the swagger data with `npx nestia swagger` command. Furthermore,
+ * it is possible to add plugin properties starting with `x-` characters.
+ *
+ * In other words, this decorator function does not affect to the runtime,
+ * but only for the swagger data customization.
+ *
+ * @param closure Callback function which can customize the swagger data
+ * @returns Method decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
 export declare function SwaggerCustomizer(closure: (props: SwaggerCustomizer.IProps) => unknown): MethodDecorator;
 export declare namespace SwaggerCustomizer {
+    /**
+     * Properties for the `SwaggerCustomizer` decorator.
+     *
+     * `SwaggerCustomizer.IProps` is a type for the `closure` parameter of the
+     * `SwaggerCustomizer` decorator. It's a callback function which can customize
+     * the swagger data.
+     */
     interface IProps {
+        /**
+         * Swagger data.
+         */
         swagger: ISwagger;
+        /**
+         * Method of the route.
+         */
         method: string;
+        /**
+         * Path of the route.
+         */
         path: string;
+        /**
+         * Route data.
+         */
         route: ISwaggerRoute;
+        /**
+         * Get neighbor route data.
+         *
+         * @param accessor Accessor for getting neighbor route data
+         * @returns Neighbor route data
+         */
         get(accessor: IAccessor): ISwaggerRoute | undefined;
     }
+    /**
+     * Accessor for getting neighbor route data.
+     */
     interface IAccessor {
+        /**
+         * Path of the neighbor route.
+         */
         path: string;
+        /**
+         * Method of the neighbor route.
+         */
         method: string;
     }
 }

package/lib/decorators/SwaggerCustomizer.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwaggerCustomizer = void 0;
+/**
+ * Swagger customization decorator.
+ *
+ * `SwaggerCustomizer` is a method decorator function which can used for
+ * customizing the swagger data with `npx nestia swagger` command. Furthermore,
+ * it is possible to add plugin properties starting with `x-` characters.
+ *
+ * In other words, this decorator function does not affect to the runtime,
+ * but only for the swagger data customization.
+ *
+ * @param closure Callback function which can customize the swagger data
+ * @returns Method decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
 function SwaggerCustomizer(closure) {
     return function SwaggerCustomizer(target, propertyKey, descriptor) {
         Reflect.defineMetadata("nestia/SwaggerCustomizer", closure, target, propertyKey);

package/lib/decorators/SwaggerCustomizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"SwaggerCustomizer.js","sourceRoot":"","sources":["../../src/decorators/SwaggerCustomizer.ts"],"names":[],"mappings":";;;AAGA,SAAgB,iBAAiB,CAC/B,OAAqD;IAErD,OAAO,SAAS,iBAAiB,CAC/B,MAAc,EACd,WAA4B,EAC5B,UAAwC;QAExC,OAAO,CAAC,cAAc,CACpB,0BAA0B,EAC1B,OAAO,EACP,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAhBD,8CAgBC"}
+{"version":3,"file":"SwaggerCustomizer.js","sourceRoot":"","sources":["../../src/decorators/SwaggerCustomizer.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;;;;GAaG;AACH,SAAgB,iBAAiB,CAC/B,OAAqD;IAErD,OAAO,SAAS,iBAAiB,CAC/B,MAAc,EACd,WAA4B,EAC5B,UAAwC;QAExC,OAAO,CAAC,cAAc,CACpB,0BAA0B,EAC1B,OAAO,EACP,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAhBD,8CAgBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/core",
-  "version": "2.5.9-dev.20240223",
+  "version": "2.5.9",
   "description": "Super-fast validation decorators of NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -36,7 +36,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^2.5.9-dev.20240223",
+    "@nestia/fetcher": "^2.5.9",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "detect-ts-node": "^1.0.5",
@@ -48,7 +48,7 @@
     "typia": "^5.4.5"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=2.5.9-dev.20240223",
+    "@nestia/fetcher": ">=2.5.9",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",

package/src/decorators/SwaggerCustomizer.ts

@@ -1,6 +1,20 @@
 import { ISwagger } from "../structures/ISwagger";
 import { ISwaggerRoute } from "../structures/ISwaggerRoute";
 
+/**
+ * Swagger customization decorator.
+ *
+ * `SwaggerCustomizer` is a method decorator function which can used for
+ * customizing the swagger data with `npx nestia swagger` command. Furthermore,
+ * it is possible to add plugin properties starting with `x-` characters.
+ *
+ * In other words, this decorator function does not affect to the runtime,
+ * but only for the swagger data customization.
+ *
+ * @param closure Callback function which can customize the swagger data
+ * @returns Method decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
 export function SwaggerCustomizer(
   closure: (props: SwaggerCustomizer.IProps) => unknown,
 ): MethodDecorator {
@@ -19,15 +33,55 @@ export function SwaggerCustomizer(
   };
 }
 export namespace SwaggerCustomizer {
+  /**
+   * Properties for the `SwaggerCustomizer` decorator.
+   *
+   * `SwaggerCustomizer.IProps` is a type for the `closure` parameter of the
+   * `SwaggerCustomizer` decorator. It's a callback function which can customize
+   * the swagger data.
+   */
   export interface IProps {
+    /**
+     * Swagger data.
+     */
     swagger: ISwagger;
+
+    /**
+     * Method of the route.
+     */
     method: string;
+
+    /**
+     * Path of the route.
+     */
     path: string;
+
+    /**
+     * Route data.
+     */
     route: ISwaggerRoute;
+
+    /**
+     * Get neighbor route data.
+     *
+     * @param accessor Accessor for getting neighbor route data
+     * @returns Neighbor route data
+     */
     get(accessor: IAccessor): ISwaggerRoute | undefined;
   }
+
+  /**
+   * Accessor for getting neighbor route data.
+   */
   export interface IAccessor {
+    /**
+     * Path of the neighbor route.
+     */
     path: string;
+
+    /**
+     * Method of the neighbor route.
+     */
     method: string;
   }
 }