@nestia/core 4.6.1-dev.20250117 → 4.6.1

package/src/decorators/TypedBody.ts

@@ -1,59 +1,59 @@
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-
-import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
-import { is_request_body_undefined } from "./internal/is_request_body_undefined";
-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`.
- *
- * 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
- */
-export function TypedBody<T>(
-  validator?: IRequestBodyValidator<T>,
-): ParameterDecorator {
-  const checker = validate_request_body("TypedBody")(validator);
-  return createParamDecorator(function TypedBody(
-    _unknown: any,
-    context: ExecutionContext,
-  ) {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-    if (is_request_body_undefined(request) && checker(undefined as T) === null)
-      return undefined;
-    else if (isApplicationJson(request.headers["content-type"]) === false)
-      throw new BadRequestException(
-        `Request body type is not "application/json".`,
-      );
-
-    const error: Error | null = checker(request.body);
-    if (error !== null) throw error;
-    return request.body;
-  })();
-}
-
-/**
- * @internal
- */
-const isApplicationJson = (text?: string): boolean =>
-  text !== undefined &&
-  text
-    .split(";")
-    .map((str) => str.trim())
-    .some((str) => str === "application/json");
+import {
+  BadRequestException,
+  ExecutionContext,
+  createParamDecorator,
+} from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+
+import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
+import { is_request_body_undefined } from "./internal/is_request_body_undefined";
+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`.
+ *
+ * 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
+ */
+export function TypedBody<T>(
+  validator?: IRequestBodyValidator<T>,
+): ParameterDecorator {
+  const checker = validate_request_body("TypedBody")(validator);
+  return createParamDecorator(function TypedBody(
+    _unknown: any,
+    context: ExecutionContext,
+  ) {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+    if (is_request_body_undefined(request) && checker(undefined as T) === null)
+      return undefined;
+    else if (isApplicationJson(request.headers["content-type"]) === false)
+      throw new BadRequestException(
+        `Request body type is not "application/json".`,
+      );
+
+    const error: Error | null = checker(request.body);
+    if (error !== null) throw error;
+    return request.body;
+  })();
+}
+
+/**
+ * @internal
+ */
+const isApplicationJson = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "application/json");

package/src/decorators/TypedException.ts

@@ -1,166 +1,166 @@
-/**
- * > 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 props Properties for the exception
- * @returns Method decorator
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function TypedException(props: TypedException.IProps<unknown>): never;
-
-/**
- * > 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
- *
- * @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",
-  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 props Properties for the exception
- * @returns Method decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function TypedException<T>(
-  props: TypedException.IProps<T>,
-): MethodDecorator;
-
-/**
- * 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
- *
- * @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
- */
-export function TypedException<T>(...args: any[]): MethodDecorator {
-  const props: TypedException.IProps<T> =
-    typeof args[0] === "object"
-      ? args[0]
-      : { status: args[0], description: args[1] };
-  return function TypedException(
-    target: Object | T,
-    propertyKey: string | symbol,
-    descriptor: TypedPropertyDescriptor<any>,
-  ) {
-    const array: TypedException.IProps<any>[] = (() => {
-      const oldbie: TypedException.IProps<any>[] | undefined =
-        Reflect.getMetadata(
-          "nestia/TypedException",
-          (target as any)[propertyKey],
-        );
-      if (oldbie !== undefined) return oldbie;
-
-      const newbie: TypedException.IProps<any>[] = [];
-      Reflect.defineMetadata(
-        "nestia/TypedException",
-        newbie,
-        (target as any)[propertyKey],
-      );
-      return newbie;
-    })();
-    array.push(props);
-    return descriptor;
-  };
-}
-export namespace TypedException {
-  /**
-   * Properties for the exception.
-   */
-  export interface IProps<T> {
-    /**
-     * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
-     */
-    status: number | "2XX" | "3XX" | "4XX" | "5XX";
-
-    /**
-     * Description about the exception.
-     */
-    description?: string | undefined;
-
-    /**
-     * Example value.
-     */
-    example?: T | undefined;
-
-    /**
-     * Collection of examples for the exception.
-     */
-    examples?: Record<string, IExample<T>> | undefined;
-  }
-
-  /**
-   * Metadata collected in the {@link IProps.examples}.
-   */
-  export interface IExample<T> {
-    /**
-     * Summary of the example.
-     */
-    summary?: string | undefined;
-
-    /**
-     * Description of the example.
-     */
-    description?: string | undefined;
-
-    /**
-     * Value of the example.
-     */
-    value: T;
-  }
-}
+/**
+ * > 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 props Properties for the exception
+ * @returns Method decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function TypedException(props: TypedException.IProps<unknown>): never;
+
+/**
+ * > 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
+ *
+ * @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",
+  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 props Properties for the exception
+ * @returns Method decorator
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function TypedException<T>(
+  props: TypedException.IProps<T>,
+): MethodDecorator;
+
+/**
+ * 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
+ *
+ * @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
+ */
+export function TypedException<T>(...args: any[]): MethodDecorator {
+  const props: TypedException.IProps<T> =
+    typeof args[0] === "object"
+      ? args[0]
+      : { status: args[0], description: args[1] };
+  return function TypedException(
+    target: Object | T,
+    propertyKey: string | symbol,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) {
+    const array: TypedException.IProps<any>[] = (() => {
+      const oldbie: TypedException.IProps<any>[] | undefined =
+        Reflect.getMetadata(
+          "nestia/TypedException",
+          (target as any)[propertyKey],
+        );
+      if (oldbie !== undefined) return oldbie;
+
+      const newbie: TypedException.IProps<any>[] = [];
+      Reflect.defineMetadata(
+        "nestia/TypedException",
+        newbie,
+        (target as any)[propertyKey],
+      );
+      return newbie;
+    })();
+    array.push(props);
+    return descriptor;
+  };
+}
+export namespace TypedException {
+  /**
+   * Properties for the exception.
+   */
+  export interface IProps<T> {
+    /**
+     * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
+     */
+    status: number | "2XX" | "3XX" | "4XX" | "5XX";
+
+    /**
+     * Description about the exception.
+     */
+    description?: string | undefined;
+
+    /**
+     * Example value.
+     */
+    example?: T | undefined;
+
+    /**
+     * Collection of examples for the exception.
+     */
+    examples?: Record<string, IExample<T>> | undefined;
+  }
+
+  /**
+   * Metadata collected in the {@link IProps.examples}.
+   */
+  export interface IExample<T> {
+    /**
+     * Summary of the example.
+     */
+    summary?: string | undefined;
+
+    /**
+     * Description of the example.
+     */
+    description?: string | undefined;
+
+    /**
+     * Value of the example.
+     */
+    value: T;
+  }
+}