@nestia/core 2.5.8 → 2.5.9-dev.20240223

package/src/decorators/TypedException.ts

@@ -1,90 +1,90 @@
-/**
- * > You must configure the generic argument `T`
- *
- * Exception decorator.
- *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occured 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.
- *
- * @param status Status number or pattern like "2XX", "3XX", "4XX", "5XX"
- * @param description Description about the exception
- * @returns Method decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function TypedException(
-  status: number | "2XX" | "3XX" | "4XX" | "5XX",
-  description?: string | undefined,
-): never;
-
-/**
- * Exception decorator.
- *
- * `TypedException` is a decorator function describing HTTP exception and its type
- * which could be occured 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.
- *
- * @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
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function TypedException<T>(
-  status: number | "2XX" | "3XX" | "4XX" | "5XX",
-  description?: string | undefined,
-): MethodDecorator;
-
-/**
- * @internal
- */
-export function TypedException<T>(
-  status: number | "2XX" | "3XX" | "4XX" | "5XX",
-  description?: string | undefined,
-  type?: string | undefined,
-): MethodDecorator {
-  return function TypedException(
-    target: Object | T,
-    propertyKey: string | symbol,
-    descriptor: TypedPropertyDescriptor<any>,
-  ) {
-    const array: IProps[] = (() => {
-      const oldbie: IProps[] | undefined = Reflect.getMetadata(
-        `nestia/TypedException`,
-        (target as any)[propertyKey],
-      );
-      if (oldbie !== undefined) return oldbie;
-
-      const newbie: IProps[] = [];
-      Reflect.defineMetadata(
-        `nestia/TypedException`,
-        newbie,
-        (target as any)[propertyKey],
-      );
-      return newbie;
-    })();
-    array.push({
-      status,
-      description,
-      type: type!,
-    });
-    return descriptor;
-  };
-}
-
-/**
- * @internal
- */
-interface IProps {
-  status: number | "2XX" | "3XX" | "4XX" | "5XX";
-  description?: string | undefined;
-  type: string;
-}
+/**
+ * > You must configure the generic argument `T`
+ *
+ * Exception decorator.
+ *
+ * `TypedException` is a decorator function describing HTTP exception and its type
+ * which could be occured 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.
+ *
+ * @param status Status number or pattern like "2XX", "3XX", "4XX", "5XX"
+ * @param description Description about the exception
+ * @returns Method decorator
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function TypedException(
+  status: number | "2XX" | "3XX" | "4XX" | "5XX",
+  description?: string | undefined,
+): never;
+
+/**
+ * Exception decorator.
+ *
+ * `TypedException` is a decorator function describing HTTP exception and its type
+ * which could be occured 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.
+ *
+ * @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
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function TypedException<T>(
+  status: number | "2XX" | "3XX" | "4XX" | "5XX",
+  description?: string | undefined,
+): MethodDecorator;
+
+/**
+ * @internal
+ */
+export function TypedException<T>(
+  status: number | "2XX" | "3XX" | "4XX" | "5XX",
+  description?: string | undefined,
+  type?: string | undefined,
+): MethodDecorator {
+  return function TypedException(
+    target: Object | T,
+    propertyKey: string | symbol,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) {
+    const array: IProps[] = (() => {
+      const oldbie: IProps[] | undefined = Reflect.getMetadata(
+        `nestia/TypedException`,
+        (target as any)[propertyKey],
+      );
+      if (oldbie !== undefined) return oldbie;
+
+      const newbie: IProps[] = [];
+      Reflect.defineMetadata(
+        `nestia/TypedException`,
+        newbie,
+        (target as any)[propertyKey],
+      );
+      return newbie;
+    })();
+    array.push({
+      status,
+      description,
+      type: type!,
+    });
+    return descriptor;
+  };
+}
+
+/**
+ * @internal
+ */
+interface IProps {
+  status: number | "2XX" | "3XX" | "4XX" | "5XX";
+  description?: string | undefined;
+  type: string;
+}

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

@@ -1,106 +1,106 @@
-import { InternalServerErrorException } from "@nestjs/common";
-import typia, { IValidation, TypeGuardError } from "typia";
-
-import { IResponseBodyQuerifier } from "../../options/IResponseBodyQuerifier";
-import { NoTransformConfigureError } from "./NoTransformConfigureError";
-
-/**
- * @internal
- */
-export const get_path_and_querify =
-  (method: string) =>
-  (
-    ...args: any[]
-  ): [string | string[] | undefined, (input: any) => URLSearchParams] => {
-    const path: string | string[] | null | undefined =
-      args[0] === undefined ||
-      typeof args[0] === "string" ||
-      Array.isArray(args[0])
-        ? args[0]
-        : null;
-    const functor: IResponseBodyQuerifier<any> | undefined =
-      path === null ? args[0] : args[1];
-    return [path ?? undefined, take(method)(functor)];
-  };
-
-/**
- * @internal
- */
-const take =
-  (method: string) =>
-  <T>(functor?: IResponseBodyQuerifier<T> | null) => {
-    if (functor === undefined) throw NoTransformConfigureError(method);
-    else if (functor === null) return querify;
-    else if (functor.type === "stringify") return functor.stringify;
-    else if (functor.type === "assert") return assert(functor.assert);
-    else if (functor.type === "is") return is(functor.is);
-    else if (functor.type === "validate") return validate(functor.validate);
-    throw new Error(
-      `Error on nestia.core.${method}(): invalid typed stringify function.`,
-    );
-  };
-
-/**
- * @internal
- */
-const querify = (input: Record<string, any>): URLSearchParams => {
-  const output: URLSearchParams = new URLSearchParams();
-  for (const [key, value] of Object.entries(input))
-    if (key === undefined) continue;
-    else if (Array.isArray(value))
-      for (const elem of value) output.append(key, String(elem));
-    else output.append(key, String(value));
-  return output;
-};
-
-/**
- * @internal
- */
-const assert =
-  <T>(closure: (data: T) => URLSearchParams) =>
-  (data: T) => {
-    try {
-      return closure(data);
-    } catch (exp) {
-      if (typia.is<TypeGuardError>(exp))
-        throw new InternalServerErrorException({
-          path: exp.path,
-          reason: exp.message,
-          expected: exp.expected,
-          value: exp.value,
-          message: MESSAGE,
-        });
-      throw exp;
-    }
-  };
-
-/**
- * @internal
- */
-const is =
-  <T>(closure: (data: T) => URLSearchParams | null) =>
-  (data: T) => {
-    const result: URLSearchParams | null = closure(data);
-    if (result === null) throw new InternalServerErrorException(MESSAGE);
-    return result;
-  };
-
-/**
- * @internal
- */
-const validate =
-  <T>(closure: (data: T) => IValidation<URLSearchParams>) =>
-  (data: T) => {
-    const result: IValidation<URLSearchParams> = closure(data);
-    if (result.success === false)
-      throw new InternalServerErrorException({
-        errors: result.errors,
-        message: MESSAGE,
-      });
-    return result.data;
-  };
-
-/**
- * @internal
- */
-const MESSAGE = "Response body data is not following the promised type.";
+import { InternalServerErrorException } from "@nestjs/common";
+import typia, { IValidation, TypeGuardError } from "typia";
+
+import { IResponseBodyQuerifier } from "../../options/IResponseBodyQuerifier";
+import { NoTransformConfigureError } from "./NoTransformConfigureError";
+
+/**
+ * @internal
+ */
+export const get_path_and_querify =
+  (method: string) =>
+  (
+    ...args: any[]
+  ): [string | string[] | undefined, (input: any) => URLSearchParams] => {
+    const path: string | string[] | null | undefined =
+      args[0] === undefined ||
+      typeof args[0] === "string" ||
+      Array.isArray(args[0])
+        ? args[0]
+        : null;
+    const functor: IResponseBodyQuerifier<any> | undefined =
+      path === null ? args[0] : args[1];
+    return [path ?? undefined, take(method)(functor)];
+  };
+
+/**
+ * @internal
+ */
+const take =
+  (method: string) =>
+  <T>(functor?: IResponseBodyQuerifier<T> | null) => {
+    if (functor === undefined) throw NoTransformConfigureError(method);
+    else if (functor === null) return querify;
+    else if (functor.type === "stringify") return functor.stringify;
+    else if (functor.type === "assert") return assert(functor.assert);
+    else if (functor.type === "is") return is(functor.is);
+    else if (functor.type === "validate") return validate(functor.validate);
+    throw new Error(
+      `Error on nestia.core.${method}(): invalid typed stringify function.`,
+    );
+  };
+
+/**
+ * @internal
+ */
+const querify = (input: Record<string, any>): URLSearchParams => {
+  const output: URLSearchParams = new URLSearchParams();
+  for (const [key, value] of Object.entries(input))
+    if (key === undefined) continue;
+    else if (Array.isArray(value))
+      for (const elem of value) output.append(key, String(elem));
+    else output.append(key, String(value));
+  return output;
+};
+
+/**
+ * @internal
+ */
+const assert =
+  <T>(closure: (data: T) => URLSearchParams) =>
+  (data: T) => {
+    try {
+      return closure(data);
+    } catch (exp) {
+      if (typia.is<TypeGuardError>(exp))
+        throw new InternalServerErrorException({
+          path: exp.path,
+          reason: exp.message,
+          expected: exp.expected,
+          value: exp.value,
+          message: MESSAGE,
+        });
+      throw exp;
+    }
+  };
+
+/**
+ * @internal
+ */
+const is =
+  <T>(closure: (data: T) => URLSearchParams | null) =>
+  (data: T) => {
+    const result: URLSearchParams | null = closure(data);
+    if (result === null) throw new InternalServerErrorException(MESSAGE);
+    return result;
+  };
+
+/**
+ * @internal
+ */
+const validate =
+  <T>(closure: (data: T) => IValidation<URLSearchParams>) =>
+  (data: T) => {
+    const result: IValidation<URLSearchParams> = closure(data);
+    if (result.success === false)
+      throw new InternalServerErrorException({
+        errors: result.errors,
+        message: MESSAGE,
+      });
+    return result.data;
+  };
+
+/**
+ * @internal
+ */
+const MESSAGE = "Response body data is not following the promised type.";