@nestia/core 7.3.1 → 7.3.2

package/src/decorators/EncryptedModule.ts

@@ -8,32 +8,32 @@ import { load_controllers } from "./internal/load_controller";
 /**
  * Encrypted module.
  *
- * `EncryptedModule` is an extension of the {@link Module} class decorator function
- * who configures encryption password of the AES-128/256 algorithm. The encryption
- * algorithm and password would be used by {@link EncryptedRoute} and {@link EncryptedBody}
- * to encrypt the request and response bod of the HTTP protocol.
+ * `EncryptedModule` is an extension of the {@link Module} class decorator
+ * function who configures encryption password of the AES-128/256 algorithm. The
+ * encryption algorithm and password would be used by {@link EncryptedRoute} and
+ * {@link EncryptedBody} to encrypt the request and response bod of the HTTP
+ * protocol.
  *
  * By using this `EncryptedModule` decorator function, all of the
- * {@link Controller controllers} configured in the *metadata* would be automatically
- * changed to the {@link EncryptedController} with the *password*. If there're some
- * original {@link EncryptedController} decorated classes in the *metadata*, their
- * encryption password would be kept.
+ * {@link Controller controllers} configured in the _metadata_ would be
+ * automatically changed to the {@link EncryptedController} with the _password_.
+ * If there're some original {@link EncryptedController} decorated classes in the
+ * _metadata_, their encryption password would be kept.
  *
- * Therefore, if you're planning to place original {@link EncryptedController} decorated
- * classes in the *metadata*, I hope them to have different encryption password from the
- * module level. If not, I recommend you use the {@link Controller} decorator
- * function instead.
+ * Therefore, if you're planning to place original {@link EncryptedController}
+ * decorated classes in the _metadata_, I hope them to have different encryption
+ * password from the module level. If not, I recommend you use the
+ * {@link Controller} decorator function instead.
  *
- * In addition, the `EncryptedModule` supports a convenient dynamic controller importing
- * function, {@link EncryptedModule.dynamic}. If you utilize the function with directory
- * path of the controller classes, it imports and configures the controller classes into
- * the `Module`, automatically.
+ * In addition, the `EncryptedModule` supports a convenient dynamic controller
+ * importing function, {@link EncryptedModule.dynamic}. If you utilize the
+ * function with directory path of the controller classes, it imports and
+ * configures the controller classes into the `Module`, automatically.
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @param metadata Module configuration metadata
  * @param password Encryption password or its getter function
  * @returns Class decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function EncryptedModule(
   metadata: Parameters<typeof Module>[0],
@@ -49,10 +49,10 @@ export namespace EncryptedModule {
   /**
    * Dynamic encrypted module.
    *
-   * `EncryptedModule.dynamic` is an extension of the {@link EncryptedModule} function
-   * who configures controller classes by the dynamic importing. By specifying directory
-   * path of the controller classes, those controllers would be automatically imported
-   * and configured.
+   * `EncryptedModule.dynamic` is an extension of the {@link EncryptedModule}
+   * function who configures controller classes by the dynamic importing. By
+   * specifying directory path of the controller classes, those controllers
+   * would be automatically imported and configured.
    *
    * @param path Directory path of the controller classes
    * @param password Encryption password or its getter function
@@ -81,9 +81,7 @@ export namespace EncryptedModule {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 const iterate =
   (password: IEncryptionPassword.Closure) =>
   (modulo: any): void => {

package/src/decorators/EncryptedRoute.ts

@@ -28,20 +28,21 @@ import { route_error } from "./internal/route_error";
 /**
  * Encrypted router decorator functions.
  *
- * `EncryptedRoute` is a module containing router decorator functions which encrypts
- * response body data through AES-128/256 encryption. Furthermore, they can boost
- * up JSON string conversion speed about 50x times faster than `class-transformer`,
- * even type safe through [typia](https://github.com/samchon/typia).
+ * `EncryptedRoute` is a module containing router decorator functions which
+ * encrypts response body data through AES-128/256 encryption. Furthermore, they
+ * can boost up JSON string conversion speed about 50x times faster than
+ * `class-transformer`, even type safe through
+ * [typia](https://github.com/samchon/typia).
  *
  * For reference, if you try to invalid data that is not following the promised
- * type `T`, 500 internal server error would be thrown. Also, as `EncryptedRoute`
- * composes JSON string through `typia.assertStringify<T>()` function, it is not
- * possible to modify response data through interceptors.
+ * type `T`, 500 internal server error would be thrown. Also, as
+ * `EncryptedRoute` composes JSON string through `typia.assertStringify<T>()`
+ * function, it is not possible to modify response data through interceptors.
  *
- *  - AES-128/256
- *  - CBC mode
- *  - PKCS #5 Padding
- *  - Base64 Encoding
+ * - AES-128/256
+ * - CBC mode
+ * - PKCS #5 Padding
+ * - Base64 Encoding
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
@@ -89,18 +90,17 @@ export namespace EncryptedRoute {
   /**
    * Set the logger function for the response validation failure.
    *
-   * If you've configured the transformation option to `validate.log`
-   * in the `tsconfig.json` file, then the error log information of the
-   * response validation failure would be logged through this function
-   * instead of throwing the 400 bad request error.
+   * If you've configured the transformation option to `validate.log` in the
+   * `tsconfig.json` file, then the error log information of the response
+   * validation failure would be logged through this function instead of
+   * throwing the 400 bad request error.
    *
-   * By the way, be careful. If you've configured the response
-   * transformation option to be `validate.log`, client may get wrong
-   * response data. Therefore, this way is not recommended in the common
-   * backend server case.
+   * By the way, be careful. If you've configured the response transformation
+   * option to be `validate.log`, client may get wrong response data. Therefore,
+   * this way is not recommended in the common backend server case.
    *
-   * @param func Logger function
    * @default console.log
+   * @param func Logger function
    */
   export function setValidateErrorLogger(
     func: (log: IValidateErrorLog) => void,
@@ -110,9 +110,7 @@ export namespace EncryptedRoute {
 
   export import IValidateErrorLog = TypedRoute.IValidateErrorLog;
 
-  /**
-   * @internal
-   */
+  /** @internal */
   function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
     function route(path?: string | string[]): MethodDecorator;
     function route<T>(
@@ -152,9 +150,7 @@ for (const method of [
     ])
       (deco as any)[key] = value;
 
-/**
- * @internal
- */
+/** @internal */
 class EncryptedRouteInterceptor implements NestInterceptor {
   public constructor(
     private readonly method: string,
@@ -207,9 +203,7 @@ class EncryptedRouteInterceptor implements NestInterceptor {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 const ROUTERS = {
   Get,
   Post,

package/src/decorators/HumanRoute.ts

@@ -7,13 +7,13 @@ import { SwaggerCustomizer } from "./SwaggerCustomizer";
  * schema composer (of [`@samchon/openapi`](https://github.com/samchon/openapi))
  * excludes the API.
  *
- * In other words, if you adjust the `@HumanRoute()` decorator to the API,
- * the API never participates in the LLM function calling. When calling the
+ * In other words, if you adjust the `@HumanRoute()` decorator to the API, the
+ * API never participates in the LLM function calling. When calling the
  * {@link HttpLlm.application} function, matched {@link IHttpLlmFunction} data
  * never be composed.
  *
- * @returns Method decorator
  * @author Jeongho Nam - https://github.com/samchon
+ * @returns Method decorator
  */
 export function HumanRoute(): MethodDecorator {
   return SwaggerCustomizer((props) => {

package/src/decorators/NoTransformConfigurationError.ts

@@ -16,17 +16,19 @@ export namespace NoTransformConfigurationError {
    * If you set this value to `false`, {@link NoTransformConfigurationError} will
    * not throw an error.
    *
-   * Even if you've not configured the plugin transformer of `tsconfig.json` file,
-   * the error will not be thrown and the program will be continued. Instead, every
-   * validations and assertions will be skipped and the value will be returned as it is.
-   * Furthermore, unexpected behaviors may occur.
+   * Even if you've not configured the plugin transformer of `tsconfig.json`
+   * file, the error will not be thrown and the program will be continued.
+   * Instead, every validations and assertions will be skipped and the value
+   * will be returned as it is. Furthermore, unexpected behaviors may occur.
    *
    * Therefore, it is not recommended to set this value to `false` in production
-   * environment. Configure this value to be `false` only when you're debugging or testing.
+   * environment. Configure this value to be `false` only when you're debugging
+   * or testing.
    *
-   * By the way, if you hope the `false` value to be set, you have to do it before the first.
-   * If you configure the `false` value after the `@nestia/core` decorator functions are
-   * composed, the value will not be applied and the error will be thrown.
+   * By the way, if you hope the `false` value to be set, you have to do it
+   * before the first. If you configure the `false` value after the
+   * `@nestia/core` decorator functions are composed, the value will not be
+   * applied and the error will be thrown.
    */
   export let throws = true;
 }

package/src/decorators/PlainBody.ts

@@ -13,12 +13,13 @@ import { validate_request_body } from "./internal/validate_request_body";
 /**
  * Plain body decorator.
  *
- * `PlainBody` is a decorator function getting full body text from the HTTP request.
+ * `PlainBody` is a decorator function getting full body text from the HTTP
+ * request.
  *
- * If you adjust the regular {@link Body} decorator function to the body parameter,
- * you can't get the full body text because the {@link Body} tries to convert the
- * body text to JSON object. Therefore, `@nestia/core` provides this `PlainBody`
- * decorator function to get the full body text.
+ * If you adjust the regular {@link Body} decorator function to the body
+ * parameter, you can't get the full body text because the {@link Body} tries to
+ * convert the body text to JSON object. Therefore, `@nestia/core` provides this
+ * `PlainBody` decorator function to get the full body text.
  *
  * ```typescript
  * \@TypedRoute.Post("memo")
@@ -28,14 +29,12 @@ import { validate_request_body } from "./internal/validate_request_body";
  *     ): void;
  * ```
  *
- * @return Parameter decorator
  * @author Jeongho Nam - https://github.com/samchon
+ * @returns Parameter decorator
  */
 export function PlainBody(): ParameterDecorator;
 
-/**
- * @internal
- */
+/** @internal */
 export function PlainBody(
   assert?: (input: unknown) => string,
 ): ParameterDecorator {
@@ -68,9 +67,7 @@ export function PlainBody(
   })();
 }
 
-/**
- * @internal
- */
+/** @internal */
 const isTextPlain = (text?: string): boolean =>
   text !== undefined &&
   text

package/src/decorators/SwaggerCustomizer.ts

@@ -7,12 +7,12 @@ import { OpenApi } from "@samchon/openapi";
  * 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.
+ * In other words, this decorator function does not affect to the runtime, but
+ * only for the swagger data customization.
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @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,
@@ -51,24 +51,16 @@ export namespace SwaggerCustomizer {
    * the swagger data.
    */
   export interface IProps {
-    /**
-     * Swagger data.
-     */
+    /** Swagger data. */
     swagger: OpenApi.IDocument;
 
-    /**
-     * Method of the route.
-     */
+    /** Method of the route. */
     method: string;
 
-    /**
-     * Path of the route.
-     */
+    /** Path of the route. */
     path: string;
 
-    /**
-     * Route data.
-     */
+    /** Route data. */
     route: OpenApi.IOperation;
 
     /**
@@ -88,28 +80,18 @@ export namespace SwaggerCustomizer {
     get(accessor: IAccessor): OpenApi.IOperation | undefined;
   }
 
-  /**
-   * Accessor for getting neighbor route data.
-   */
+  /** Accessor for getting neighbor route data. */
   export interface IAccessor {
-    /**
-     * Path of the neighbor route.
-     */
+    /** Path of the neighbor route. */
     path: string;
 
-    /**
-     * Method of the neighbor route.
-     */
+    /** Method of the neighbor route. */
     method: string;
   }
 
-  /**
-   * Endpoint info of the route.
-   */
+  /** Endpoint info of the route. */
   export interface ISwaggerEndpoint extends IAccessor {
-    /**
-     * Route data.
-     */
+    /** Route data. */
     route: OpenApi.IOperation;
   }
 }

package/src/decorators/TypedBody.ts

@@ -13,16 +13,16 @@ import { validate_request_body } from "./internal/validate_request_body";
 /**
  * Type safe body decorator.
  *
- * `TypedBody` is a decorator function getting `application/json` typed data from
- * request body. Also, it validates the request body data type through
- * [typia](https://github.com/samchon/typia) and the validation speed is
- * maximum 20,000x times faster than `class-validator`.
+ * `TypedBody` is a decorator function getting `application/json` typed data
+ * from request body. Also, it validates the request body data type through
+ * [typia](https://github.com/samchon/typia) and the validation speed is maximum
+ * 20,000x times faster than `class-validator`.
  *
- * For reference, when the request body data is not following the promised type `T`,
- * `BadRequestException` error (status code: 400) would be thrown.
+ * For reference, when the request body data is not following the promised type
+ * `T`, `BadRequestException` error (status code: 400) would be thrown.
  *
- * @param validator Custom validator if required. Default is `typia.assert()`
  * @author Jeongho Nam - https://github.com/samchon
+ * @param validator Custom validator if required. Default is `typia.assert()`
  */
 export function TypedBody<T>(
   validator?: IRequestBodyValidator<T>,
@@ -48,9 +48,7 @@ export function TypedBody<T>(
   })();
 }
 
-/**
- * @internal
- */
+/** @internal */
 const isApplicationJson = (text?: string): boolean =>
   text !== undefined &&
   text

package/src/decorators/TypedException.ts

@@ -3,16 +3,17 @@
  *
  * Exception decorator.
  *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occurred in the method.
+ * `TypedException` is a decorator function describing HTTP exception and its
+ * type which could be occurred in the method.
  *
- * For reference, this decorator function does not affect to the method's behavior,
- * but only affects to the swagger documents generation. Also, it does not affect to
- * the SDK library generation yet, but will be used in the future.
+ * For reference, this decorator function does not affect to the method's
+ * behavior, but only affects to the swagger documents generation. Also, it does
+ * not affect to the SDK library generation yet, but will be used in the
+ * future.
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @param props Properties for the exception
  * @returns Method decorator
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function TypedException(props: TypedException.IProps<unknown>): never;
 
@@ -21,20 +22,20 @@ export function TypedException(props: TypedException.IProps<unknown>): never;
  *
  * Exception decorator.
  *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occurred in the method.
+ * `TypedException` is a decorator function describing HTTP exception and its
+ * type which could be occurred in the method.
  *
- * For reference, this decorator function does not affect to the method's behavior,
- * but only affects to the swagger documents generation. Also, it does not affect to
- * the SDK library generation yet, but will be used in the future.
+ * For reference, this decorator function does not affect to the method's
+ * behavior, but only affects to the swagger documents generation. Also, it does
+ * not affect to the SDK library generation yet, but will be used in the
+ * future.
  *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated Use {@link TypedException.IProps} typed function instead. This
+ *   typed function is deprecated and will be removed in the next major update.
  * @param status Status number or pattern like "2XX", "3XX", "4XX", "5XX"
  * @param description Description about the exception
  * @returns Method decorator
- *
- * @deprecated Use {@link TypedException.IProps} typed function instead.
- *             This typed function is deprecated and will be removed in the next major update.
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function TypedException(
   status: number | "2XX" | "3XX" | "4XX" | "5XX",
@@ -44,18 +45,18 @@ export function TypedException(
 /**
  * Exception decorator.
  *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occurred in the method.
+ * `TypedException` is a decorator function describing HTTP exception and its
+ * type which could be occurred in the method.
  *
- * For reference, this decorator function does not affect to the method's behavior,
- * but only affects to the swagger documents generation. Also, it does not affect to
- * the SDK library generation yet, but will be used in the future.
+ * For reference, this decorator function does not affect to the method's
+ * behavior, but only affects to the swagger documents generation. Also, it does
+ * not affect to the SDK library generation yet, but will be used in the
+ * future.
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @template T Type of the exception
  * @param props Properties for the exception
  * @returns Method decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function TypedException<T>(
   props: TypedException.IProps<T>,
@@ -64,30 +65,28 @@ export function TypedException<T>(
 /**
  * Exception decorator.
  *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occurred in the method.
+ * `TypedException` is a decorator function describing HTTP exception and its
+ * type which could be occurred in the method.
  *
- * For reference, this decorator function does not affect to the method's behavior,
- * but only affects to the swagger documents generation. Also, it does not affect to
- * the SDK library generation yet, but will be used in the future.
+ * For reference, this decorator function does not affect to the method's
+ * behavior, but only affects to the swagger documents generation. Also, it does
+ * not affect to the SDK library generation yet, but will be used in the
+ * future.
  *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated Use {@link TypedException.IProps} typed function instead. This
+ *   typed function is deprecated and will be removed in the next major update.
  * @template T Type of the exception
  * @param status Status number or pattern like "2XX", "3XX", "4XX", "5XX"
  * @param description Description about the exception
  * @returns Method decorator
- *
- * @deprecated Use {@link TypedException.IProps} typed function instead.
- *             This typed function is deprecated and will be removed in the next major update.
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function TypedException<T>(
   status: number | "2XX" | "3XX" | "4XX" | "5XX",
   description?: string | undefined,
 ): MethodDecorator;
 
-/**
- * @internal
- */
+/** @internal */
 export function TypedException<T>(...args: any[]): MethodDecorator {
   const props: TypedException.IProps<T> =
     typeof args[0] === "object"
@@ -119,48 +118,30 @@ export function TypedException<T>(...args: any[]): MethodDecorator {
   };
 }
 export namespace TypedException {
-  /**
-   * Properties for the exception.
-   */
+  /** Properties for the exception. */
   export interface IProps<T> {
-    /**
-     * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
-     */
+    /** Status number or pattern like "2XX", "3XX", "4XX", "5XX". */
     status: number | "2XX" | "3XX" | "4XX" | "5XX";
 
-    /**
-     * Description about the exception.
-     */
+    /** Description about the exception. */
     description?: string | undefined;
 
-    /**
-     * Example value.
-     */
+    /** Example value. */
     example?: T | undefined;
 
-    /**
-     * Collection of examples for the exception.
-     */
+    /** Collection of examples for the exception. */
     examples?: Record<string, IExample<T>> | undefined;
   }
 
-  /**
-   * Metadata collected in the {@link IProps.examples}.
-   */
+  /** Metadata collected in the {@link IProps.examples}. */
   export interface IExample<T> {
-    /**
-     * Summary of the example.
-     */
+    /** Summary of the example. */
     summary?: string | undefined;
 
-    /**
-     * Description of the example.
-     */
+    /** Description of the example. */
     description?: string | undefined;
 
-    /**
-     * Value of the example.
-     */
+    /** Value of the example. */
     value: T;
   }
 }