@nestia/core 2.5.9-dev.20240223 → 2.5.10-dev.20240223

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.10-dev.20240223",
   "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.10-dev.20240223",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "detect-ts-node": "^1.0.5",
@@ -45,15 +45,15 @@
     "raw-body": "^2.0.0",
     "reflect-metadata": ">=0.1.12",
     "rxjs": ">=6.0.0",
-    "typia": "^5.4.5"
+    "typia": "^5.4.12"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=2.5.9-dev.20240223",
+    "@nestia/fetcher": ">=2.5.10-dev.20240223",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",
     "rxjs": ">=6.0.0",
-    "typia": ">=5.4.5 <6.0.0"
+    "typia": ">=5.4.12 <6.0.0"
   },
   "devDependencies": {
     "@fastify/multipart": "^8.1.0",

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;
   }
 }

package/src/structures/ISwaggerComponents.ts

@@ -1,29 +1,29 @@
-import { IJsonComponents } from "typia";
-
-import { ISwaggerSecurityScheme } from "./ISwaggerSecurityScheme";
-
-/**
- * Reusable components in Swagger.
- *
- * `ISwaggerComponents` is a data structure representing content of `components` object
- * in `swagger.json` file generated by Nestia. Note that, this is not an universal
- * structure, but a dedicated structure only for Nestia.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface ISwaggerComponents {
-  /**
-   * An object to hold reusable DTO schemas.
-   *
-   * For reference, `nestia` stores every object and alias types as reusable DTO
-   * schemas. The alias type means that defined by `type` keyword in TypeScript.
-   */
-  schemas?: Record<string, IJsonComponents.IAlias>;
-
-  /**
-   * An object to hold reusable security schemes.
-   *
-   * This property be configured by user in `nestia.config.ts` file.
-   */
-  securitySchemes?: Record<string, ISwaggerSecurityScheme>;
-}
+import { IJsonComponents } from "typia";
+
+import { ISwaggerSecurityScheme } from "./ISwaggerSecurityScheme";
+
+/**
+ * Reusable components in Swagger.
+ *
+ * `ISwaggerComponents` is a data structure representing content of `components` object
+ * in `swagger.json` file generated by Nestia. Note that, this is not an universal
+ * structure, but a dedicated structure only for Nestia.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISwaggerComponents {
+  /**
+   * An object to hold reusable DTO schemas.
+   *
+   * For reference, `nestia` stores every object and alias types as reusable DTO
+   * schemas. The alias type means that defined by `type` keyword in TypeScript.
+   */
+  schemas?: Record<string, IJsonComponents.IAlias>;
+
+  /**
+   * An object to hold reusable security schemes.
+   *
+   * This property be configured by user in `nestia.config.ts` file.
+   */
+  securitySchemes?: Record<string, ISwaggerSecurityScheme>;
+}

package/src/structures/ISwaggerInfo.ts

@@ -1,80 +1,80 @@
-/**
- * Information about the API.
- *
- * @author Samchon
- */
-export interface ISwaggerInfo {
-  /**
-   * The title of the API.
-   */
-  title: string;
-
-  /**
-   * A short description of the API.
-   */
-  description?: string;
-
-  /**
-   * A URL to the Terms of Service for the API.
-   *
-   * @format uri
-   */
-  termsOfService?: string;
-
-  /**
-   * The contact information for the exposed API.
-   */
-  contact?: ISwaggerInfo.IContact;
-
-  /**
-   * The license information for the exposed API.
-   */
-  license?: ISwaggerInfo.ILicense;
-
-  /**
-   * Version of the API.
-   */
-  version: string;
-}
-export namespace ISwaggerInfo {
-  /**
-   * Contact information for the exposed API.
-   */
-  export interface IContact {
-    /**
-     * The identifying name of the contact person/organization.
-     */
-    name?: string;
-
-    /**
-     * The URL pointing to the contact information.
-     *
-     * @format uri
-     */
-    url?: string;
-
-    /**
-     * The email address of the contact person/organization.
-     *
-     * @format email
-     */
-    email?: string;
-  }
-
-  /**
-   * License information for the exposed API.
-   */
-  export interface ILicense {
-    /**
-     * The license name used for the API.
-     */
-    name: string;
-
-    /**
-     * A URL to the license used for the API.
-     *
-     * @format uri
-     */
-    url?: string;
-  }
-}
+/**
+ * Information about the API.
+ *
+ * @author Samchon
+ */
+export interface ISwaggerInfo {
+  /**
+   * The title of the API.
+   */
+  title: string;
+
+  /**
+   * A short description of the API.
+   */
+  description?: string;
+
+  /**
+   * A URL to the Terms of Service for the API.
+   *
+   * @format uri
+   */
+  termsOfService?: string;
+
+  /**
+   * The contact information for the exposed API.
+   */
+  contact?: ISwaggerInfo.IContact;
+
+  /**
+   * The license information for the exposed API.
+   */
+  license?: ISwaggerInfo.ILicense;
+
+  /**
+   * Version of the API.
+   */
+  version: string;
+}
+export namespace ISwaggerInfo {
+  /**
+   * Contact information for the exposed API.
+   */
+  export interface IContact {
+    /**
+     * The identifying name of the contact person/organization.
+     */
+    name?: string;
+
+    /**
+     * The URL pointing to the contact information.
+     *
+     * @format uri
+     */
+    url?: string;
+
+    /**
+     * The email address of the contact person/organization.
+     *
+     * @format email
+     */
+    email?: string;
+  }
+
+  /**
+   * License information for the exposed API.
+   */
+  export interface ILicense {
+    /**
+     * The license name used for the API.
+     */
+    name: string;
+
+    /**
+     * A URL to the license used for the API.
+     *
+     * @format uri
+     */
+    url?: string;
+  }
+}

package/src/structures/ISwaggerSecurityScheme.ts

@@ -1,65 +1,65 @@
-/**
- * Security scheme of Swagger Documents.
- *
- * `ISwaggerSecurityScheme` is a data structure representing content of
- * `securitySchemes` in `swagger.json` file. It is composed with 5 types of security
- * schemes as an union type like below.
- *
- * @reference https://swagger.io/specification/#security-scheme-object
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type ISwaggerSecurityScheme =
-  | ISwaggerSecurityScheme.IHttpBasic
-  | ISwaggerSecurityScheme.IHttpBearer
-  | ISwaggerSecurityScheme.IApiKey
-  | ISwaggerSecurityScheme.IOpenId
-  | ISwaggerSecurityScheme.IOAuth2;
-export namespace ISwaggerSecurityScheme {
-  export interface IHttpBasic {
-    type: "http";
-    scheme: "basic";
-  }
-  export interface IHttpBearer {
-    type: "http";
-    scheme: "bearer";
-    bearerFormat?: string;
-  }
-  export interface IApiKey {
-    type: "apiKey";
-
-    /**
-     * @default header
-     */
-    in?: "header" | "query" | "cookie";
-
-    /**
-     * @default Authorization
-     */
-    name?: string;
-  }
-
-  export interface IOpenId {
-    type: "openIdConnect";
-    openIdConnectUrl: string;
-  }
-
-  export interface IOAuth2 {
-    type: "oauth2";
-    flows: IOAuth2.IFlowSet;
-    description?: string;
-  }
-  export namespace IOAuth2 {
-    export interface IFlowSet {
-      authorizationCode?: IFlow;
-      implicit?: Omit<IFlow, "tokenUrl">;
-      password?: Omit<IFlow, "authorizationUrl">;
-      clientCredentials?: Omit<IFlow, "authorizationUrl">;
-    }
-    export interface IFlow {
-      authorizationUrl: string;
-      tokenUrl: string;
-      refreshUrl: string;
-      scopes?: Record<string, string>;
-    }
-  }
-}
+/**
+ * Security scheme of Swagger Documents.
+ *
+ * `ISwaggerSecurityScheme` is a data structure representing content of
+ * `securitySchemes` in `swagger.json` file. It is composed with 5 types of security
+ * schemes as an union type like below.
+ *
+ * @reference https://swagger.io/specification/#security-scheme-object
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type ISwaggerSecurityScheme =
+  | ISwaggerSecurityScheme.IHttpBasic
+  | ISwaggerSecurityScheme.IHttpBearer
+  | ISwaggerSecurityScheme.IApiKey
+  | ISwaggerSecurityScheme.IOpenId
+  | ISwaggerSecurityScheme.IOAuth2;
+export namespace ISwaggerSecurityScheme {
+  export interface IHttpBasic {
+    type: "http";
+    scheme: "basic";
+  }
+  export interface IHttpBearer {
+    type: "http";
+    scheme: "bearer";
+    bearerFormat?: string;
+  }
+  export interface IApiKey {
+    type: "apiKey";
+
+    /**
+     * @default header
+     */
+    in?: "header" | "query" | "cookie";
+
+    /**
+     * @default Authorization
+     */
+    name?: string;
+  }
+
+  export interface IOpenId {
+    type: "openIdConnect";
+    openIdConnectUrl: string;
+  }
+
+  export interface IOAuth2 {
+    type: "oauth2";
+    flows: IOAuth2.IFlowSet;
+    description?: string;
+  }
+  export namespace IOAuth2 {
+    export interface IFlowSet {
+      authorizationCode?: IFlow;
+      implicit?: Omit<IFlow, "tokenUrl">;
+      password?: Omit<IFlow, "authorizationUrl">;
+      clientCredentials?: Omit<IFlow, "authorizationUrl">;
+    }
+    export interface IFlow {
+      authorizationUrl: string;
+      tokenUrl: string;
+      refreshUrl: string;
+      scopes?: Record<string, string>;
+    }
+  }
+}