@nestia/core 2.4.3 → 3.0.0-dev.20231209

package/src/decorators/TypedException.ts

@@ -1,89 +1,89 @@
-import "reflect-metadata";
-
-/**
- * > 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;
-  };
-}
-
-interface IProps {
-  status: number | "2XX" | "3XX" | "4XX" | "5XX";
-  description?: string | undefined;
-  type: string;
-}
+import "reflect-metadata";
+
+/**
+ * > 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;
+  };
+}
+
+interface IProps {
+  status: number | "2XX" | "3XX" | "4XX" | "5XX";
+  description?: string | undefined;
+  type: string;
+}

package/src/decorators/TypedHeaders.ts

@@ -1,69 +1,69 @@
-import { ExecutionContext, createParamDecorator } from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-import typia from "typia";
-
-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
- *
- * @returns Parameter decorator
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function TypedHeaders<T extends object>(
-  validator?: IRequestHeadersValidator<T>,
-): ParameterDecorator {
-  const checker = validate_request_headers(validator);
-  return createParamDecorator(function TypedHeaders(
-    _unknown: any,
-    context: ExecutionContext,
-  ) {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-
-    const output: T | Error = checker(request.headers);
-    if (output instanceof Error) throw output;
-    return output;
-  })();
-}
-Object.assign(TypedHeaders, typia.http.assertHeaders);
-Object.assign(TypedHeaders, typia.http.isHeaders);
-Object.assign(TypedHeaders, typia.http.validateHeaders);
+import { ExecutionContext, createParamDecorator } from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+import typia from "typia";
+
+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
+ *
+ * @returns Parameter decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function TypedHeaders<T extends object>(
+  validator?: IRequestHeadersValidator<T>,
+): ParameterDecorator {
+  const checker = validate_request_headers(validator);
+  return createParamDecorator(function TypedHeaders(
+    _unknown: any,
+    context: ExecutionContext,
+  ) {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+
+    const output: T | Error = checker(request.headers);
+    if (output instanceof Error) throw output;
+    return output;
+  })();
+}
+Object.assign(TypedHeaders, typia.http.assertHeaders);
+Object.assign(TypedHeaders, typia.http.isHeaders);
+Object.assign(TypedHeaders, typia.http.validateHeaders);

package/src/decorators/TypedParam.ts

@@ -1,65 +1,65 @@
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-import typia, { TypeGuardError } from "typia";
-
-import { NoTransformConfigureError } from "./internal/NoTransformConfigureError";
-
-/**
- * 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>;
- * ```
- *
- * @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,
-  assert?: (value: string) => T,
-): ParameterDecorator {
-  if (assert === undefined) throw NoTransformConfigureError("TypedParam");
-
-  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))
-        throw new BadRequestException({
-          path: exp.path,
-          reason: exp.message,
-          expected: exp.expected,
-          value: exp.value,
-          message: `Invalid URL parameter value on "${name}".`,
-        });
-      throw exp;
-    }
-  })(name);
-}
-Object.assign(TypedParam, typia.http.parameter);
+import {
+  BadRequestException,
+  ExecutionContext,
+  createParamDecorator,
+} from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+import typia, { TypeGuardError } from "typia";
+
+import { NoTransformConfigureError } from "./internal/NoTransformConfigureError";
+
+/**
+ * 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>;
+ * ```
+ *
+ * @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,
+  assert?: (value: string) => T,
+): ParameterDecorator {
+  if (assert === undefined) throw NoTransformConfigureError("TypedParam");
+
+  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))
+        throw new BadRequestException({
+          path: exp.path,
+          reason: exp.message,
+          expected: exp.expected,
+          value: exp.value,
+          message: `Invalid URL parameter value on "${name}".`,
+        });
+      throw exp;
+    }
+  })(name);
+}
+Object.assign(TypedParam, typia.http.parameter);