@nestia/core 2.5.6 → 2.5.7-dev.20240215

package/src/decorators/PlainBody.ts

@@ -64,6 +64,9 @@ export function PlainBody(
 }
 Object.assign(PlainBody, assert);
 
+/**
+ * @internal
+ */
 const isTextPlain = (text?: string): boolean =>
   text !== undefined &&
   text

package/src/decorators/TypedBody.ts

@@ -51,6 +51,9 @@ Object.assign(TypedBody, is);
 Object.assign(TypedBody, assert);
 Object.assign(TypedBody, validate);
 
+/**
+ * @internal
+ */
 const isApplicationJson = (text?: string): boolean =>
   text !== undefined &&
   text

package/src/decorators/TypedException.ts

@@ -1,5 +1,3 @@
-import "reflect-metadata";
-
 /**
  * > You must configure the generic argument `T`
  *
@@ -82,6 +80,9 @@ export function TypedException<T>(
   };
 }
 
+/**
+ * @internal
+ */
 interface IProps {
   status: number | "2XX" | "3XX" | "4XX" | "5XX";
   description?: string | undefined;

package/src/decorators/TypedFormData.ts

@@ -35,20 +35,20 @@ import { validate_request_form_data } from "./internal/validate_request_form_dat
  * 2. Do not allow dynamic property
  * 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/multipart`
  * 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 multipart from "fastify-multipart";
  * import { NestFactory } from "@nestjs/core";
- * import { 
- *   FastifyAdapter, 
- *   NestFastifyApplication 
+ * import {
+ *   FastifyAdapter,
+ *   NestFastifyApplication
  * } from "@nestjs/platform-fastify";
- * 
+ *
  * export async function main() {
  *   const app = await NestFactory.create<NestFastifyApplication>(
  *     AppModule,
@@ -108,6 +108,9 @@ export namespace TypedFormData {
   Object.assign(Body, typia.http.validateFormData);
 }
 
+/**
+ * @internal
+ */
 const decodeExpress = <T>(props: IRequestFormDataProps<T>) => {
   const upload = multerApplication.get().fields(
     props!.files.map((file) => ({
@@ -137,6 +140,9 @@ const decodeExpress = <T>(props: IRequestFormDataProps<T>) => {
   };
 };
 
+/**
+ * @internal
+ */
 const decodeFastify =
   <T>(_props: IRequestFormDataProps<T>) =>
   async (socket: {
@@ -200,6 +206,9 @@ const isMultipartFormData = (text?: string): boolean =>
     .map((str) => str.trim())
     .some((str) => str === "multipart/form-data");
 
+/**
+ * @internal
+ */
 const isExpressRequest = (
   request: express.Request | FastifyRequest,
 ): request is express.Request => (request as express.Request).app !== undefined;

package/src/decorators/TypedRoute.ts

@@ -1,144 +1,144 @@
-import {
-  CallHandler,
-  Delete,
-  ExecutionContext,
-  Get,
-  NestInterceptor,
-  Patch,
-  Post,
-  Put,
-  UseInterceptors,
-  applyDecorators,
-} from "@nestjs/common";
-import { HttpArgumentsHost } from "@nestjs/common/interfaces";
-import type express from "express";
-import { catchError, map } from "rxjs/operators";
-import typia from "typia";
-
-import { IResponseBodyStringifier } from "../options/IResponseBodyStringifier";
-import { get_path_and_stringify } from "./internal/get_path_and_stringify";
-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).
- *
- * 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.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace TypedRoute {
-  /**
-   * Router decorator function for the GET method.
-   *
-   * @param path Path of the HTTP request
-   * @returns Method decorator
-   */
-  export const Get = Generator("Get");
-
-  /**
-   * Router decorator function for the POST method.
-   *
-   * @param path Path of the HTTP request
-   * @returns Method decorator
-   */
-  export const Post = Generator("Post");
-
-  /**
-   * Router decorator function for the PATH method.
-   *
-   * @param path Path of the HTTP request
-   * @returns Method decorator
-   */
-  export const Patch = Generator("Patch");
-
-  /**
-   * Router decorator function for the PUT method.
-   *
-   * @param path Path of the HTTP request
-   * @returns Method decorator
-   */
-  export const Put = Generator("Put");
-
-  /**
-   * Router decorator function for the DELETE method.
-   *
-   * @param path Path of the HTTP request
-   * @returns Method decorator
-   */
-  export const Delete = Generator("Delete");
-
-  /**
-   * @internal
-   */
-  function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
-    function route(path?: string | string[]): MethodDecorator;
-    function route<T>(stringify?: IResponseBodyStringifier<T>): MethodDecorator;
-    function route<T>(
-      path: string | string[],
-      stringify?: IResponseBodyStringifier<T>,
-    ): MethodDecorator;
-
-    function route(...args: any[]): MethodDecorator {
-      const [path, stringify] = get_path_and_stringify(`TypedRoute.${method}`)(
-        ...args,
-      );
-      return applyDecorators(
-        ROUTERS[method](path),
-        UseInterceptors(new TypedRouteInterceptor(stringify)),
-      );
-    }
-    return route;
-  }
-}
-for (const method of [
-  typia.json.stringify,
-  typia.json.isStringify,
-  typia.json.assertStringify,
-  typia.json.validateStringify,
-])
-  for (const [key, value] of Object.entries(method))
-    for (const deco of [
-      TypedRoute.Get,
-      TypedRoute.Delete,
-      TypedRoute.Post,
-      TypedRoute.Put,
-      TypedRoute.Patch,
-    ])
-      (deco as any)[key] = value;
-
-/**
- * @internal
- */
-class TypedRouteInterceptor implements NestInterceptor {
-  public constructor(private readonly stringify: (input: any) => string) {}
-
-  public intercept(context: ExecutionContext, next: CallHandler) {
-    const http: HttpArgumentsHost = context.switchToHttp();
-    const response: express.Response = http.getResponse();
-    response.header("Content-Type", "application/json");
-
-    return next.handle().pipe(
-      map((value) => this.stringify(value)),
-      catchError((err) => route_error(http.getRequest(), err)),
-    );
-  }
-}
-
-/**
- * @internal
- */
-const ROUTERS = {
-  Get,
-  Post,
-  Patch,
-  Put,
-  Delete,
-};
+import {
+  CallHandler,
+  Delete,
+  ExecutionContext,
+  Get,
+  NestInterceptor,
+  Patch,
+  Post,
+  Put,
+  UseInterceptors,
+  applyDecorators,
+} from "@nestjs/common";
+import { HttpArgumentsHost } from "@nestjs/common/interfaces";
+import type express from "express";
+import { catchError, map } from "rxjs/operators";
+import typia from "typia";
+
+import { IResponseBodyStringifier } from "../options/IResponseBodyStringifier";
+import { get_path_and_stringify } from "./internal/get_path_and_stringify";
+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).
+ *
+ * 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.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export namespace TypedRoute {
+  /**
+   * Router decorator function for the GET method.
+   *
+   * @param path Path of the HTTP request
+   * @returns Method decorator
+   */
+  export const Get = Generator("Get");
+
+  /**
+   * Router decorator function for the POST method.
+   *
+   * @param path Path of the HTTP request
+   * @returns Method decorator
+   */
+  export const Post = Generator("Post");
+
+  /**
+   * Router decorator function for the PATH method.
+   *
+   * @param path Path of the HTTP request
+   * @returns Method decorator
+   */
+  export const Patch = Generator("Patch");
+
+  /**
+   * Router decorator function for the PUT method.
+   *
+   * @param path Path of the HTTP request
+   * @returns Method decorator
+   */
+  export const Put = Generator("Put");
+
+  /**
+   * Router decorator function for the DELETE method.
+   *
+   * @param path Path of the HTTP request
+   * @returns Method decorator
+   */
+  export const Delete = Generator("Delete");
+
+  /**
+   * @internal
+   */
+  function Generator(method: "Get" | "Post" | "Put" | "Patch" | "Delete") {
+    function route(path?: string | string[]): MethodDecorator;
+    function route<T>(stringify?: IResponseBodyStringifier<T>): MethodDecorator;
+    function route<T>(
+      path: string | string[],
+      stringify?: IResponseBodyStringifier<T>,
+    ): MethodDecorator;
+
+    function route(...args: any[]): MethodDecorator {
+      const [path, stringify] = get_path_and_stringify(`TypedRoute.${method}`)(
+        ...args,
+      );
+      return applyDecorators(
+        ROUTERS[method](path),
+        UseInterceptors(new TypedRouteInterceptor(stringify)),
+      );
+    }
+    return route;
+  }
+}
+for (const method of [
+  typia.json.stringify,
+  typia.json.isStringify,
+  typia.json.assertStringify,
+  typia.json.validateStringify,
+])
+  for (const [key, value] of Object.entries(method))
+    for (const deco of [
+      TypedRoute.Get,
+      TypedRoute.Delete,
+      TypedRoute.Post,
+      TypedRoute.Put,
+      TypedRoute.Patch,
+    ])
+      (deco as any)[key] = value;
+
+/**
+ * @internal
+ */
+class TypedRouteInterceptor implements NestInterceptor {
+  public constructor(private readonly stringify: (input: any) => string) {}
+
+  public intercept(context: ExecutionContext, next: CallHandler) {
+    const http: HttpArgumentsHost = context.switchToHttp();
+    const response: express.Response = http.getResponse();
+    response.header("Content-Type", "application/json");
+
+    return next.handle().pipe(
+      map((value) => this.stringify(value)),
+      catchError((err) => route_error(http.getRequest(), err)),
+    );
+  }
+}
+
+/**
+ * @internal
+ */
+const ROUTERS = {
+  Get,
+  Post,
+  Patch,
+  Put,
+  Delete,
+};

package/src/decorators/internal/get_path_and_querify.ts

@@ -40,6 +40,9 @@ const take =
     );
   };
 
+/**
+ * @internal
+ */
 const querify = (input: Record<string, any>): URLSearchParams => {
   const output: URLSearchParams = new URLSearchParams();
   for (const [key, value] of Object.entries(input))

package/src/decorators/internal/load_controller.ts

@@ -1,51 +1,51 @@
-import is_ts_node from "detect-ts-node";
-
-import { Creator } from "../../typings/Creator";
-import { SourceFinder } from "../../utils/SourceFinder";
-
-/**
- * @internal
- */
-export const load_controllers = async (
-  path: string | string[] | { include: string[]; exclude?: string[] },
-): Promise<Creator<object>[]> => {
-  const sources: string[] = await SourceFinder.find({
-    include: Array.isArray(path)
-      ? path
-      : typeof path === "object"
-        ? path.include
-        : [path],
-    exclude:
-      typeof path === "object" && !Array.isArray(path)
-        ? path.exclude ?? []
-        : [],
-    filter:
-      EXTENSION === "ts"
-        ? (file) =>
-            file.substring(file.length - 3) === ".ts" &&
-            file.substring(file.length - 5) !== ".d.ts"
-        : (flle) => flle.substring(flle.length - 3) === ".js",
-  });
-  return mount(sources);
-};
-
-/**
- * @internal
- */
-async function mount(sources: string[]): Promise<any[]> {
-  const controllers: any[] = [];
-  for (const file of sources) {
-    const external: any = await import(file);
-    for (const key in external) {
-      const instance: Creator<object> = external[key];
-      if (Reflect.getMetadata("path", instance) !== undefined)
-        controllers.push(instance);
-    }
-  }
-  return controllers;
-}
-
-/**
- * @internal
- */
-const EXTENSION = is_ts_node ? "ts" : "js";
+import is_ts_node from "detect-ts-node";
+
+import { Creator } from "../../typings/Creator";
+import { SourceFinder } from "../../utils/SourceFinder";
+
+/**
+ * @internal
+ */
+export const load_controllers = async (
+  path: string | string[] | { include: string[]; exclude?: string[] },
+): Promise<Creator<object>[]> => {
+  const sources: string[] = await SourceFinder.find({
+    include: Array.isArray(path)
+      ? path
+      : typeof path === "object"
+        ? path.include
+        : [path],
+    exclude:
+      typeof path === "object" && !Array.isArray(path)
+        ? path.exclude ?? []
+        : [],
+    filter:
+      EXTENSION === "ts"
+        ? (file) =>
+            file.substring(file.length - 3) === ".ts" &&
+            file.substring(file.length - 5) !== ".d.ts"
+        : (flle) => flle.substring(flle.length - 3) === ".js",
+  });
+  return mount(sources);
+};
+
+/**
+ * @internal
+ */
+async function mount(sources: string[]): Promise<any[]> {
+  const controllers: any[] = [];
+  for (const file of sources) {
+    const external: any = await import(file);
+    for (const key in external) {
+      const instance: Creator<object> = external[key];
+      if (Reflect.getMetadata("path", instance) !== undefined)
+        controllers.push(instance);
+    }
+  }
+  return controllers;
+}
+
+/**
+ * @internal
+ */
+const EXTENSION = is_ts_node ? "ts" : "js";

package/src/decorators/internal/validate_request_body.ts

@@ -4,6 +4,9 @@ import typia, { IValidation, TypeGuardError } from "typia";
 import { IRequestBodyValidator } from "../../options/IRequestBodyValidator";
 import { NoTransformConfigureError } from "./NoTransformConfigureError";
 
+/**
+ * @internal
+ */
 export const validate_request_body =
   (method: string) =>
   <T>(validator?: IRequestBodyValidator<T>) => {
@@ -15,6 +18,9 @@ export const validate_request_body =
       new Error(`Error on nestia.core.${method}(): invalid typed validator.`);
   };
 
+/**
+ * @internal
+ */
 const assert =
   <T>(closure: (data: T) => T) =>
   (input: T) => {
@@ -35,6 +41,9 @@ const assert =
     }
   };
 
+/**
+ * @internal
+ */
 const is =
   <T>(closure: (data: T) => boolean) =>
   (input: T) => {
@@ -42,6 +51,9 @@ const is =
     return success ? null : new BadRequestException(MESSAGE);
   };
 
+/**
+ * @internal
+ */
 const validate =
   <T>(closure: (data: T) => IValidation<T>) =>
   (input: T) => {
@@ -54,4 +66,7 @@ const validate =
         });
   };
 
+/**
+ * @internal
+ */
 const MESSAGE = "Request body data is not following the promised type.";

package/src/decorators/internal/validate_request_form_data.ts

@@ -4,6 +4,9 @@ import typia, { IValidation, TypeGuardError } from "typia";
 import { IRequestFormDataProps } from "../../options/IRequestFormDataProps";
 import { NoTransformConfigureError } from "./NoTransformConfigureError";
 
+/**
+ * @internal
+ */
 export const validate_request_form_data = <T>(
   props?: IRequestFormDataProps<T>,
 ) => {
@@ -19,6 +22,9 @@ export const validate_request_form_data = <T>(
     );
 };
 
+/**
+ * @internal
+ */
 const assert =
   <T>(closure: (input: FormData) => T) =>
   (input: FormData): T | BadRequestException => {
@@ -38,6 +44,9 @@ const assert =
     }
   };
 
+/**
+ * @internal
+ */
 const is =
   <T>(closure: (input: FormData) => T | null) =>
   (input: FormData): T | BadRequestException => {
@@ -45,6 +54,9 @@ const is =
     return result !== null ? result : new BadRequestException(MESSAGE);
   };
 
+/**
+ * @internal
+ */
 const validate =
   <T>(closure: (input: FormData) => IValidation<T>) =>
   (input: FormData): T | BadRequestException => {
@@ -57,4 +69,7 @@ const validate =
         });
   };
 
+/**
+ * @internal
+ */
 const MESSAGE = "Request multipart data is not following the promised type.";

package/src/decorators/internal/validate_request_headers.ts

@@ -4,6 +4,9 @@ import typia, { IValidation, TypeGuardError } from "typia";
 import { IRequestHeadersValidator } from "../../options/IRequestHeadersValidator";
 import { NoTransformConfigureError } from "./NoTransformConfigureError";
 
+/**
+ * @internal
+ */
 export const validate_request_headers = <T>(
   validator?: IRequestHeadersValidator<T>,
 ) => {
@@ -15,6 +18,9 @@ export const validate_request_headers = <T>(
     new Error(`Error on nestia.core.TypedHeaders(): invalid typed validator.`);
 };
 
+/**
+ * @internal
+ */
 const assert =
   <T>(closure: (input: Record<string, string | string[] | undefined>) => T) =>
   (
@@ -36,6 +42,9 @@ const assert =
     }
   };
 
+/**
+ * @internal
+ */
 const is =
   <T>(
     closure: (input: Record<string, string | string[] | undefined>) => T | null,
@@ -47,6 +56,9 @@ const is =
     return result !== null ? result : new BadRequestException(MESSAGE);
   };
 
+/**
+ * @internal
+ */
 const validate =
   <T>(
     closure: (
@@ -65,4 +77,7 @@ const validate =
         });
   };
 
+/**
+ * @internal
+ */
 const MESSAGE = "Request headers data is not following the promised type.";

package/src/decorators/internal/validate_request_query.ts

@@ -4,6 +4,9 @@ import typia, { IValidation, TypeGuardError } from "typia";
 import { IRequestQueryValidator } from "../../options/IRequestQueryValidator";
 import { NoTransformConfigureError } from "./NoTransformConfigureError";
 
+/**
+ * @internal
+ */
 export const validate_request_query = <T>(
   validator?: IRequestQueryValidator<T>,
 ) => {
@@ -15,6 +18,9 @@ export const validate_request_query = <T>(
     new Error(`Error on nestia.core.TypedQuery(): invalid typed validator.`);
 };
 
+/**
+ * @internal
+ */
 const assert =
   <T>(closure: (input: URLSearchParams) => T) =>
   (input: URLSearchParams): T | BadRequestException => {
@@ -34,6 +40,9 @@ const assert =
     }
   };
 
+/**
+ * @internal
+ */
 const is =
   <T>(closure: (input: URLSearchParams) => T | null) =>
   (input: URLSearchParams): T | BadRequestException => {
@@ -41,6 +50,9 @@ const is =
     return result !== null ? result : new BadRequestException(MESSAGE);
   };
 
+/**
+ * @internal
+ */
 const validate =
   <T>(closure: (input: URLSearchParams) => IValidation<T>) =>
   (input: URLSearchParams): T | BadRequestException => {
@@ -53,4 +65,7 @@ const validate =
         });
   };
 
+/**
+ * @internal
+ */
 const MESSAGE = "Request query data is not following the promised type.";