@nestia/core 7.3.0 → 7.3.2

package/src/decorators/TypedFormData.ts

@@ -18,32 +18,34 @@ import { validate_request_form_data } from "./internal/validate_request_form_dat
  * `multipart/form-data` content type. It automatically casts property type
  * following its DTO definition, and performs the type validation too.
  *
- * Also, `TypedFormData.Body()` is much easier and type safer than `@nest.UploadFile()`.
- * If you're considering the [SDK library](https://nestia.io/docs/sdk/sdk) generation,
- * only `TypedFormData.Body()` can do it. Therefore, I recommend you to use
+ * Also, `TypedFormData.Body()` is much easier and type safer than
+ * `@nest.UploadFile()`. If you're considering the [SDK
+ * library](https://nestia.io/docs/sdk/sdk) generation, only
+ * `TypedFormData.Body()` can do it. Therefore, I recommend you to use
  * `TypedFormData.Body()` instead of the `@nest.UploadFile()` function.
  *
- * For reference, target type `T` must follow such restriction. Of course, if actual
- * form-data values are different with their promised type `T`,
+ * For reference, target type `T` must follow such restriction. Of course, if
+ * actual form-data values are different with their promised type `T`,
  * `BadRequestException` error (status code: 400) would be thrown.
  *
  * 1. Type `T` must be an object type
  * 2. Do not allow dynamic property
- * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array types are allowed
+ * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array
+ *    types are allowed
  * 4. By the way, union type never be not allowed
  *
- * By the way, if you're using `fastify`, you have to setup `fastify-multer`
- * and configure like below when composing the NestJS application. If you don't do
+ * By the way, if you're using `fastify`, you have to setup `fastify-multer` and
+ * configure like below when composing the NestJS application. If you don't do
  * that, `@TypedFormData.Body()` will not work properly, and throw 500 internal
  * server error when `Blob` or `File` type being utilized.
  *
  * ```typescript
- * import fastifyMulter from "fastify-multer";
  * import { NestFactory } from "@nestjs/core";
  * import {
  *   FastifyAdapter,
- *   NestFastifyApplication
+ *   NestFastifyApplication,
  * } from "@nestjs/platform-fastify";
+ * import fastifyMulter from "fastify-multer";
  *
  * export async function main() {
  *   const app = await NestFactory.create<NestFastifyApplication>(
@@ -55,8 +57,8 @@ import { validate_request_form_data } from "./internal/validate_request_form_dat
  * }
  * ```
  *
- * @todo Change to ReadableStream through configuring storage engine of multer
  * @author Jeongho Nam - https://github.com/samchon
+ * @todo Change to ReadableStream through configuring storage engine of multer
  */
 export namespace TypedFormData {
   /**
@@ -67,16 +69,14 @@ export namespace TypedFormData {
    * Much easier and type safer than `@nest.UploadFile()` decorator.
    *
    * @param factory Factory function ncreating the `multer` or `fastify-multer`
-   *                instance. In the factory function, you also can specify the
-   *                multer composition options like `storage` engine.
+   *   instance. In the factory function, you also can specify the multer
+   *   composition options like `storage` engine.
    */
   export function Body<Multer extends IMulterBase>(
     factory: () => Multer | Promise<Multer>,
   ): ParameterDecorator;
 
-  /**
-   * @internal
-   */
+  /** @internal */
   export function Body<T extends object>(
     factory: () => Promise<IMulterBase>,
     props?: IRequestFormDataProps<T> | undefined,
@@ -111,9 +111,7 @@ export namespace TypedFormData {
     })();
   }
 
-  /**
-   * Base type of the `multer` or `fastify-multer`.
-   */
+  /** Base type of the `multer` or `fastify-multer`. */
   export interface IMulterBase {
     single(fieldName: string): any;
     array(fieldName: string, maxCount?: number): any;
@@ -123,9 +121,7 @@ export namespace TypedFormData {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 const decode = <T>(
   multer: ExpressMulter.Multer,
   props: IRequestFormDataProps<T>,
@@ -159,9 +155,7 @@ const decode = <T>(
   };
 };
 
-/**
- * @internal
- */
+/** @internal */
 const parseFiles =
   (data: FormData) =>
   (files: Express.Multer.File[] | Record<string, Express.Multer.File[]>) => {
@@ -169,24 +163,30 @@ const parseFiles =
       for (const file of files)
         data.append(
           file.fieldname,
-          new File([file.buffer], file.originalname, {
-            type: file.mimetype,
-          }),
+          new File(
+            [file.buffer satisfies Uint8Array as any],
+            file.originalname,
+            {
+              type: file.mimetype,
+            },
+          ),
         );
     else
       for (const [key, value] of Object.entries(files))
         for (const file of value)
           data.append(
             key,
-            new File([file.buffer], file.originalname, {
-              type: file.mimetype,
-            }),
+            new File(
+              [file.buffer satisfies Uint8Array as any],
+              file.originalname,
+              {
+                type: file.mimetype,
+              },
+            ),
           );
   };
 
-/**
- * @internal
- */
+/** @internal */
 const isMultipartFormData = (text?: string): boolean =>
   text !== undefined &&
   text

package/src/decorators/TypedHeaders.ts

@@ -8,13 +8,14 @@ import { validate_request_headers } from "./internal/validate_request_headers";
 /**
  * Type safe HTTP headers decorator.
  *
- * `TypedHeaders` is a decorator function that can parse HTTP headers. It is almost
- * same with {@link nest.Headers}, but it can automatically cast property type following
- * its DTO definition. Also, `TypedHeaders` performs type validation.
+ * `TypedHeaders` is a decorator function that can parse HTTP headers. It is
+ * almost same with {@link nest.Headers}, but it can automatically cast property
+ * type following its DTO definition. Also, `TypedHeaders` performs type
+ * validation.
  *
- * For reference, target type `T` must follow such restrictions. Also, if actual HTTP
- * header values are different with their promised type `T`, `BadRequestException`
- * error (status code: 400) would be thrown.
+ * For reference, target type `T` must follow such restrictions. Also, if actual
+ * HTTP header values are different with their promised type `T`,
+ * `BadRequestException` error (status code: 400) would be thrown.
  *
  * 1. Type `T` must be an object type
  * 2. Do not allow dynamic property
@@ -24,27 +25,28 @@ import { validate_request_headers } from "./internal/validate_request_headers";
  * 6. By the way, union type never be not allowed
  * 7. Property `set-cookie` must be array type
  * 8. Those properties cannot be array type
- *   - age
- *   - authorization
- *   - content-length
- *   - content-type
- *   - etag
- *   - expires
- *   - from
- *   - host
- *   - if-modified-since
- *   - if-unmodified-since
- *   - last-modified
- *   - location
- *   - max-forwards
- *   - proxy-authorization
- *   - referer
- *   - retry-after
- *   - server
- *   - user-agent
  *
- * @returns Parameter decorator
+ * - Age
+ * - Authorization
+ * - Content-length
+ * - Content-type
+ * - Etag
+ * - Expires
+ * - From
+ * - Host
+ * - If-modified-since
+ * - If-unmodified-since
+ * - Last-modified
+ * - Location
+ * - Max-forwards
+ * - Proxy-authorization
+ * - Referer
+ * - Retry-after
+ * - Server
+ * - User-agent
+ *
  * @author Jeongho Nam - https://github.com/samchon
+ * @returns Parameter decorator
  */
 export function TypedHeaders<T extends object>(
   validator?: IRequestHeadersValidator<T>,

package/src/decorators/TypedParam.ts

@@ -12,9 +12,10 @@ import { NoTransformConfigurationError } from "./NoTransformConfigurationError";
 /**
  * Type safe URL parameter decorator.
  *
- * `TypedParam` is a decorator function getting specific typed parameter from the
- * HTTP request URL. It's almost same with the {@link nest.Param}, but `TypedParam`
- * automatically casts parameter value to be following its type, and validates it.
+ * `TypedParam` is a decorator function getting specific typed parameter from
+ * the HTTP request URL. It's almost same with the {@link nest.Param}, but
+ * `TypedParam` automatically casts parameter value to be following its type,
+ * and validates it.
  *
  * ```typescript
  * import { tags } from "typia";
@@ -27,10 +28,9 @@ import { NoTransformConfigurationError } from "./NoTransformConfigurationError";
  * ): Promise<void>;
  * ```
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @param name URL Parameter name
  * @returns Parameter decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function TypedParam<T extends boolean | bigint | number | string | null>(
   name: string,

package/src/decorators/TypedQuery.ts

@@ -27,12 +27,13 @@ import { validate_request_query } from "./internal/validate_request_query";
 /**
  * Type safe URL query decorator.
  *
- * `TypedQuery` is a decorator function that can parse URL query string. It is almost
- * same with {@link nest.Query}, but it can automatically cast property type following
- * its DTO definition. Also, `TypedQuery` performs type validation.
+ * `TypedQuery` is a decorator function that can parse URL query string. It is
+ * almost same with {@link nest.Query}, but it can automatically cast property
+ * type following its DTO definition. Also, `TypedQuery` performs type
+ * validation.
  *
- * For reference, target type `T` must follow such restriction. Also, if
- * actual URL query parameter values are different with their promised type `T`,
+ * For reference, target type `T` must follow such restriction. Also, if actual
+ * URL query parameter values are different with their promised type `T`,
  * `BadRequestException` error (status code: 400) would be thrown.
  *
  * 1. Type `T` must be an object type
@@ -40,8 +41,8 @@ import { validate_request_query } from "./internal/validate_request_query";
  * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
  * 4. By the way, union type never be not allowed
  *
- * @returns Parameter decorator
  * @author Jeongho Nam - https://github.com/samchon
+ * @returns Parameter decorator
  */
 export function TypedQuery<T extends object>(
   validator?: IRequestQueryValidator<T>,
@@ -133,9 +134,7 @@ export namespace TypedQuery {
    */
   export const Delete = Generator("Delete");
 
-  /**
-   * @internal
-   */
+  /** @internal */
   function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
     function route(path?: string | string[]): MethodDecorator;
     function route<T>(stringify?: IResponseBodyQuerifier<T>): MethodDecorator;
@@ -167,17 +166,13 @@ export namespace TypedQuery {
         (deco as any)[key] = value;
 }
 
-/**
- * @internal
- */
+/** @internal */
 function tail(url: string): string {
   const index: number = url.indexOf("?");
   return index === -1 ? "" : url.substring(index + 1);
 }
 
-/**
- * @internal
- */
+/** @internal */
 function isApplicationQuery(text?: string): boolean {
   return (
     text !== undefined &&
@@ -188,9 +183,7 @@ function isApplicationQuery(text?: string): boolean {
   );
 }
 
-/**
- * @internal
- */
+/** @internal */
 class FakeURLSearchParams {
   public constructor(private readonly target: Record<string, string[]>) {}
 
@@ -213,9 +206,7 @@ class FakeURLSearchParams {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 class TypedQueryRouteInterceptor implements NestInterceptor {
   public constructor(
     private readonly toSearchParams: (input: any) => URLSearchParams,
@@ -233,9 +224,7 @@ class TypedQueryRouteInterceptor implements NestInterceptor {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 const ROUTERS = {
   Get,
   Post,

package/src/decorators/TypedRoute.ts

@@ -22,15 +22,15 @@ import { route_error } from "./internal/route_error";
 /**
  * Type safe router decorator functions.
  *
- * `TypedRoute` is a module containing router decorator functions which can boost up
- * JSON string conversion speed about 200x times faster than `class-transformer`.
- * Furthermore, such JSON string conversion is even type safe through
- * [typia](https://github.com/samchon/typia).
+ * `TypedRoute` is a module containing router decorator functions which can
+ * boost up JSON string conversion speed about 200x times faster than
+ * `class-transformer`. Furthermore, such JSON string conversion is 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 `TypedRoute` 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 `TypedRoute`
+ * composes JSON string through `typia.assertStringify<T>()` function, it is not
+ * possible to modify response data through interceptors.
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
@@ -78,18 +78,17 @@ export namespace TypedRoute {
   /**
    * 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,
@@ -100,47 +99,34 @@ export namespace TypedRoute {
   /**
    * Error log information of the response validation failure.
    *
-   * `IValidationErrorLog` is a structure representing the error log
-   * information when the returned value from the `@TypedRoute` or
-   * `@EncryptedRoute` decorated controller method is not following
-   * the promised type `T`.
+   * `IValidationErrorLog` is a structure representing the error log information
+   * when the returned value from the `@TypedRoute` or `@EncryptedRoute`
+   * decorated controller method is not following the promised type `T`.
    *
    * If you've configured the transformation option to `validate.log` or
    * `validateEquals.log` in the `tsconfig.json` file, then this error log
    * information `IValidateErrorLog` would be logged through the
-   * {@link setValidateErrorLogger} function instead of throwing the
-   * 400 bad request error.
+   * {@link setValidateErrorLogger} function instead of throwing the 400 bad
+   * request error.
    */
   export interface IValidateErrorLog {
-    /**
-     * HTTP method of the request.
-     */
+    /** HTTP method of the request. */
     method: string;
 
-    /**
-     * HTTP path of the request.
-     */
+    /** HTTP path of the request. */
     path: string;
 
-    /**
-     * Validation error information with detailed reasons.
-     */
+    /** Validation error information with detailed reasons. */
     errors: IValidation.IError[];
 
-    /**
-     * Data that is not following the promised type `T`.
-     */
+    /** Data that is not following the promised type `T`. */
     data: unknown;
   }
 
-  /**
-   * @internal
-   */
+  /** @internal */
   export let __logger: (log: IValidateErrorLog) => void = console.log;
 
-  /**
-   * @internal
-   */
+  /** @internal */
   function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
     function route(path?: string | string[]): MethodDecorator;
     function route<T>(stringify?: IResponseBodyStringifier<T>): MethodDecorator;
@@ -177,9 +163,7 @@ for (const method of [
     ])
       (deco as any)[key] = value;
 
-/**
- * @internal
- */
+/** @internal */
 class TypedRouteInterceptor implements NestInterceptor {
   public constructor(
     private readonly stringify: (
@@ -202,9 +186,7 @@ class TypedRouteInterceptor implements NestInterceptor {
   }
 }
 
-/**
- * @internal
- */
+/** @internal */
 const ROUTERS = {
   Get,
   Post,

package/src/decorators/WebSocketRoute.ts

@@ -8,15 +8,15 @@ import { validate_request_query } from "./internal/validate_request_query";
 /**
  * WebSocket route decorator.
  *
- * `@WebSocketRoute()` is a route decorator function for WebSocket routes.
- * If you want to define a WebSocket route with this `@WebSocketRoute` decorator,
- * please don't forget to call the {@link WebSocketAdaptor.upgrade} function
- * to the {@link INestApplication} instance.
+ * `@WebSocketRoute()` is a route decorator function for WebSocket routes. If
+ * you want to define a WebSocket route with this `@WebSocketRoute` decorator,
+ * please don't forget to call the {@link WebSocketAdaptor.upgrade} function to
+ * the {@link INestApplication} instance.
  *
- * Also, `WebSocketRoute` is a module containing parameter decorator
- * functions of below for the `@WebSocketRoute` decorated method, at the same
- * time. Note that, every parameters must be decorated by one of the parameter
- * decorators in the `WebSocketRoute` module. One thing more important is,
+ * Also, `WebSocketRoute` is a module containing parameter decorator functions
+ * of below for the `@WebSocketRoute` decorated method, at the same time. Note
+ * that, every parameters must be decorated by one of the parameter decorators
+ * in the `WebSocketRoute` module. One thing more important is,
  * {@link WebSocketRoute.Acceptor} decorated parameter must be defined in the
  * method. If not, it would be both compilation/runtime error.
  *
@@ -28,16 +28,16 @@ import { validate_request_query } from "./internal/validate_request_query";
  *
  * For reference, key difference between `@WebSocketGateway()` of NestJS and
  * `@WebSocketRoute()` of Nestia is, `@WebSocketRoute()` can make multiple
- * WebSocket routes by configuring *paths*, besides `@WebSocketGateway()`
- * can't do it.
+ * WebSocket routes by configuring _paths_, besides `@WebSocketGateway()` can't
+ * do it.
  *
  * Furthermore, if you build SDK (Software Development Kit) library through
  * `@nestia/sdk`, you can make safe WebSocket client taking advantages of
  * TypeScript type hints and checks.
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @param path Path(s) of the WebSocket request
  * @returns Method decorator
- * @author Jeongho Nam - https://github.com/samchon
  */
 export function WebSocketRoute(
   path?: undefined | string | string[],
@@ -62,7 +62,8 @@ export namespace WebSocketRoute {
    * Acceptor parameter decorator.
    *
    * `@WebSocketRoute.Acceptor()` is a parameter decorator function for the
-   * `WebSocketAcceptor<Header, Provider, Listener>` (of `tgrid`) typed parameter.
+   * `WebSocketAcceptor<Header, Provider, Listener>` (of `tgrid`) typed
+   * parameter.
    *
    * In the controller method decorated by `@WebSocketRoute()` and
    * `@WebSocketRoute.Acceptor()`, call {@link WebSocketAcceptor.accept} function
@@ -71,8 +72,8 @@ export namespace WebSocketRoute {
    * {@link WebSocketAcceptor.rejcet} function instead.
    *
    * For reference, this `@WebSocketRoute.Acceptor()` parameter decorator is
-   * essential for the method decorated by `@WebSocketRoute()` decorator.
-   * If you forget it, it would be both compilation/runtime error.
+   * essential for the method decorated by `@WebSocketRoute()` decorator. If you
+   * forget it, it would be both compilation/runtime error.
    */
   export function Acceptor(): ParameterDecorator {
     return function WebSocketAcceptor(
@@ -98,8 +99,8 @@ export namespace WebSocketRoute {
    * by calling the `Driver<Listener>` instance.
    *
    * For reference, this `@WebSocketRoute.Driver()` decorator is optional, and
-   * can be substituted by `@WebSocketRoute.Acceptor()` decorated parameter
-   * by calling the {@link WebSocketAcceptor.getDriver} function.
+   * can be substituted by `@WebSocketRoute.Acceptor()` decorated parameter by
+   * calling the {@link WebSocketAcceptor.getDriver} function.
    */
   export function Driver(): ParameterDecorator {
     return function WebSocketDriver(
@@ -121,12 +122,12 @@ export namespace WebSocketRoute {
    * WebSocket header with type casting and assertion.
    *
    * For reference, `@WebSocketRoute.Header()` is different with HTTP headers.
-   * It's for WebSocket protocol, especially for TGrid's {@link WebSocketConnector}
-   * and {@link WebSocketAcceptor}'s special header.
+   * It's for WebSocket protocol, especially for TGrid's
+   * {@link WebSocketConnector} and {@link WebSocketAcceptor}'s special header.
    *
-   * Also, this `@WebSocketRoute.Header()` decorator is optional, and
-   * can be substituted by `@WebSocketRoute.Acceptor()` decorated parameter
-   * by accessting to the {@link WebSocketAcceptor.header} property.
+   * Also, this `@WebSocketRoute.Header()` decorator is optional, and can be
+   * substituted by `@WebSocketRoute.Acceptor()` decorated parameter by
+   * accessting to the {@link WebSocketAcceptor.header} property.
    */
   export function Header<T>(
     validator?: IRequestBodyValidator<T>,
@@ -151,9 +152,9 @@ export namespace WebSocketRoute {
    * `@WebSocketRoute.Param()` is a parameter decorator function for the URL
    * parameter with type casting and assertion.
    *
-   * It's almost same with the {@link TypedParam}, but
-   * `@WebSocketRoute.Param()` is only for WebSocket protocol router function
-   * decorated by {@link WebSocketRoute}.
+   * It's almost same with the {@link TypedParam}, but `@WebSocketRoute.Param()`
+   * is only for WebSocket protocol router function decorated by
+   * {@link WebSocketRoute}.
    *
    * @param field URL parameter field name
    */
@@ -185,18 +186,19 @@ export namespace WebSocketRoute {
    * `@WebSocketRoute.Query()` is a parameter decorator function for the URL
    * query string with type casting and assertion.
    *
-   * It is almost same with {@link TypedQuery}, but
-   * `@WebSocketRoute.Query()` is only for WebSocket protocol router function
-   * decorated by {@link WebSocketRoute}.
+   * It is almost same with {@link TypedQuery}, but `@WebSocketRoute.Query()` is
+   * only for WebSocket protocol router function decorated by
+   * {@link WebSocketRoute}.
    *
    * For reference, as same with {@link TypedQuery}, `@WebSocketRoute.Query()`
-   * has same restriction for the target type `T`. If actual URL query
-   * parameter values are different with their promised type `T`,
-   * it would be runtime error.
+   * has same restriction for the target type `T`. If actual URL query parameter
+   * values are different with their promised type `T`, it would be runtime
+   * error.
    *
    * 1. Type `T` must be an object type
    * 2. Do not allow dynamic property
-   * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
+   * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are
+   *    allowed
    * 4. By the way, union type never be not allowed
    */
   export function Query<T extends object>(
@@ -216,9 +218,7 @@ export namespace WebSocketRoute {
     };
   }
 
-  /**
-   * @internal
-   */
+  /** @internal */
   const emplace = (
     target: Object,
     propertyKey: string | symbol,

package/src/decorators/internal/EncryptedConstant.ts

@@ -1,4 +1,2 @@
-/**
- * @internal
- */
+/** @internal */
 export const ENCRYPTION_METADATA_KEY = "nestia:core:encryption:password";