@nestia/core 11.0.0-dev.20260312 → 11.0.0-dev.20260313-2

package/src/decorators/TypedException.ts

@@ -1,147 +1,147 @@
-/**
- * > You must configure the generic argument `T`
- *
- * Exception decorator.
- *
- * `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.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @param props Properties for the exception
- * @returns Method decorator
- */
-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 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.
- *
- * @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
- */
-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 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.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @template T Type of the exception
- * @param props Properties for the exception
- * @returns Method decorator
- */
-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 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.
- *
- * @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
- */
-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 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.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param props Properties for the exception
+ * @returns Method decorator
+ */
+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 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.
+ *
+ * @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
+ */
+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 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.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template T Type of the exception
+ * @param props Properties for the exception
+ * @returns Method decorator
+ */
+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 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.
+ *
+ * @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
+ */
+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;
+  }
+}

package/src/decorators/TypedHeaders.ts

@@ -1,66 +1,66 @@
-import { ExecutionContext, createParamDecorator } from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-
-import { IRequestHeadersValidator } from "../options/IRequestHeadersValidator";
-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.
- *
- * 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
- * 3. Property key must be lower case
- * 4. Property value cannot be `null`, but `undefined` is possible
- * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
- * 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
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @returns Parameter decorator
- */
-export function TypedHeaders<T extends object>(
-  validator?: IRequestHeadersValidator<T>,
-): ParameterDecorator {
-  const checker = validate_request_headers(validator);
-  return createParamDecorator(function TypedHeaders(
-    _unknown: any,
-    context: ExecutionContext,
-  ): T {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-    const output: T | Error = checker(request.headers);
-    if (output instanceof Error) throw output;
-    return output;
-  })();
-}
+import { ExecutionContext, createParamDecorator } from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+
+import { IRequestHeadersValidator } from "../options/IRequestHeadersValidator";
+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.
+ *
+ * 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
+ * 3. Property key must be lower case
+ * 4. Property value cannot be `null`, but `undefined` is possible
+ * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed
+ * 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
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @returns Parameter decorator
+ */
+export function TypedHeaders<T extends object>(
+  validator?: IRequestHeadersValidator<T>,
+): ParameterDecorator {
+  const checker = validate_request_headers(validator);
+  return createParamDecorator(function TypedHeaders(
+    _unknown: any,
+    context: ExecutionContext,
+  ): T {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+    const output: T | Error = checker(request.headers);
+    if (output instanceof Error) throw output;
+    return output;
+  })();
+}

package/src/decorators/TypedParam.ts

@@ -1,77 +1,77 @@
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-import typia, { IValidation, TypeGuardError } from "typia";
-
-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.
- *
- * ```typescript
- * import { tags } from "typia";
- *
- * \@TypedRoute.Get("shopping/sales/:id/:no/:paused")
- * public async pause(
- *   \@TypedParam("id", "uuid"), id: string & tags.Format<"uuid">,
- *   \@TypedParam("no") id: number & tags.Type<"uint32">
- *   \@TypedParam("paused") paused: boolean | null
- * ): Promise<void>;
- * ```
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @param name URL Parameter name
- * @returns Parameter decorator
- */
-export function TypedParam<T extends boolean | bigint | number | string | null>(
-  name: string,
-  assert?: (value: string) => T,
-  validate?: boolean,
-): ParameterDecorator {
-  if (assert === undefined) {
-    NoTransformConfigurationError("TypedParam");
-    assert = (value) => value as T;
-  }
-
-  return createParamDecorator(function TypedParam(
-    {}: any,
-    context: ExecutionContext,
-  ) {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-    const str: string = (request.params as any)[name];
-    try {
-      return assert(str);
-    } catch (exp) {
-      if (typia.is<TypeGuardError>(exp)) {
-        const trace: IValidation.IError = {
-          path: exp.path ?? "$input",
-          expected: exp.expected,
-          value: exp.value,
-        };
-        throw new BadRequestException({
-          message: `Invalid URL parameter value on "${name}".`,
-          ...(validate === true
-            ? {
-                errors: [trace],
-              }
-            : {
-                ...trace,
-                reason: exp.message,
-              }),
-        });
-      }
-      throw exp;
-    }
-  })(name);
-}
+import {
+  BadRequestException,
+  ExecutionContext,
+  createParamDecorator,
+} from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+import typia, { IValidation, TypeGuardError } from "typia";
+
+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.
+ *
+ * ```typescript
+ * import { tags } from "typia";
+ *
+ * \@TypedRoute.Get("shopping/sales/:id/:no/:paused")
+ * public async pause(
+ *   \@TypedParam("id", "uuid"), id: string & tags.Format<"uuid">,
+ *   \@TypedParam("no") id: number & tags.Type<"uint32">
+ *   \@TypedParam("paused") paused: boolean | null
+ * ): Promise<void>;
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param name URL Parameter name
+ * @returns Parameter decorator
+ */
+export function TypedParam<T extends boolean | bigint | number | string | null>(
+  name: string,
+  assert?: (value: string) => T,
+  validate?: boolean,
+): ParameterDecorator {
+  if (assert === undefined) {
+    NoTransformConfigurationError("TypedParam");
+    assert = (value) => value as T;
+  }
+
+  return createParamDecorator(function TypedParam(
+    {}: any,
+    context: ExecutionContext,
+  ) {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+    const str: string = (request.params as any)[name];
+    try {
+      return assert(str);
+    } catch (exp) {
+      if (typia.is<TypeGuardError>(exp)) {
+        const trace: IValidation.IError = {
+          path: exp.path ?? "$input",
+          expected: exp.expected,
+          value: exp.value,
+        };
+        throw new BadRequestException({
+          message: `Invalid URL parameter value on "${name}".`,
+          ...(validate === true
+            ? {
+                errors: [trace],
+              }
+            : {
+                ...trace,
+                reason: exp.message,
+              }),
+        });
+      }
+      throw exp;
+    }
+  })(name);
+}