@nestia/core 2.4.3 → 3.0.0-dev.20231209

package/src/decorators/EncryptedModule.ts

@@ -1,79 +1,79 @@
-import { IEncryptionPassword } from "@nestia/fetcher/lib/IEncryptionPassword";
-import { Module } from "@nestjs/common";
-
-import { Creator } from "../typings/Creator";
-import { ENCRYPTION_METADATA_KEY } from "./internal/EncryptedConstant";
-import { load_controllers } from "./internal/load_controller";
-
-/**
- * Encrypted module.
- *
- * `EncryptedModule` is an extension of the {@link Module} class decorator function
- * who configures encryption password of the AES-128/256 algorithm. The encryption
- * algorithm and password would be used by {@link EncryptedRoute} and {@link EncryptedBody}
- * to encrypt the request and response bod of the HTTP protocol.
- *
- * By using this `EncryptedModule` decorator function, all of the
- * {@link Controller controllers} configured in the *metadata* would be automatically
- * changed to the {@link EncryptedController} with the *password*. If there're some
- * original {@link EncryptedController} decorated classes in the *metadata*, their
- * encryption password would be kept.
- *
- * Therefore, if you're planning to place original {@link EncryptedController} decorated
- * classes in the *metadata*, I hope them to have different encryption password from the
- * module level. If not, I recommend you use the {@link Controller} decorator
- * function instead.
- *
- * In addition, the `EncryptedModule` supports a convenient dynamic controller importing
- * function, {@link EncryptedModule.dynamic}. If you utilize the function with directory
- * path of the controller classes, it imports and configures the controller classes into
- * the `Module`, automatically.
- *
- * @param metadata Module configuration metadata
- * @param password Encryption password or its getter function
- * @returns Class decorator
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function EncryptedModule(
-  metadata: Parameters<typeof Module>[0],
-  password: IEncryptionPassword | IEncryptionPassword.Closure,
-): ClassDecorator {
-  return function (target: any) {
-    Module(metadata)(target);
-    if (metadata.controllers === undefined) return;
-
-    for (const c of metadata.controllers)
-      if (Reflect.hasMetadata(ENCRYPTION_METADATA_KEY, c) === false)
-        Reflect.defineMetadata(ENCRYPTION_METADATA_KEY, password, c);
-  };
-}
-
-export namespace EncryptedModule {
-  /**
-   * Dynamic encrypted module.
-   *
-   * `EncryptedModule.dynamic` is an extension of the {@link EncryptedModule} function
-   * who configures controller classes by the dynamic importing. By specifying directory
-   * path of the controller classes, those controllers would be automatically imported
-   * and configured.
-   *
-   * @param path Directory path of the controller classes
-   * @param password Encryption password or its getter function
-   * @param options Additional options except controller
-   * @returns Class decorated module instance
-   */
-  export async function dynamic(
-    path: string | string[] | { include: string[]; exclude?: string[] },
-    password: IEncryptionPassword | IEncryptionPassword.Closure,
-    options: Omit<Parameters<typeof Module>[0], "controllers"> = {},
-  ): Promise<object> {
-    // LOAD CONTROLLERS
-    const controllers: Creator<object>[] = await load_controllers(path);
-
-    // RETURNS WITH DECORATING
-    @EncryptedModule({ ...options, controllers }, password)
-    class NestiaModule {}
-    return NestiaModule;
-  }
-}
+import { IEncryptionPassword } from "@nestia/fetcher/lib/IEncryptionPassword";
+import { Module } from "@nestjs/common";
+
+import { Creator } from "../typings/Creator";
+import { ENCRYPTION_METADATA_KEY } from "./internal/EncryptedConstant";
+import { load_controllers } from "./internal/load_controller";
+
+/**
+ * Encrypted module.
+ *
+ * `EncryptedModule` is an extension of the {@link Module} class decorator function
+ * who configures encryption password of the AES-128/256 algorithm. The encryption
+ * algorithm and password would be used by {@link EncryptedRoute} and {@link EncryptedBody}
+ * to encrypt the request and response bod of the HTTP protocol.
+ *
+ * By using this `EncryptedModule` decorator function, all of the
+ * {@link Controller controllers} configured in the *metadata* would be automatically
+ * changed to the {@link EncryptedController} with the *password*. If there're some
+ * original {@link EncryptedController} decorated classes in the *metadata*, their
+ * encryption password would be kept.
+ *
+ * Therefore, if you're planning to place original {@link EncryptedController} decorated
+ * classes in the *metadata*, I hope them to have different encryption password from the
+ * module level. If not, I recommend you use the {@link Controller} decorator
+ * function instead.
+ *
+ * In addition, the `EncryptedModule` supports a convenient dynamic controller importing
+ * function, {@link EncryptedModule.dynamic}. If you utilize the function with directory
+ * path of the controller classes, it imports and configures the controller classes into
+ * the `Module`, automatically.
+ *
+ * @param metadata Module configuration metadata
+ * @param password Encryption password or its getter function
+ * @returns Class decorator
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function EncryptedModule(
+  metadata: Parameters<typeof Module>[0],
+  password: IEncryptionPassword | IEncryptionPassword.Closure,
+): ClassDecorator {
+  return function (target: any) {
+    Module(metadata)(target);
+    if (metadata.controllers === undefined) return;
+
+    for (const c of metadata.controllers)
+      if (Reflect.hasMetadata(ENCRYPTION_METADATA_KEY, c) === false)
+        Reflect.defineMetadata(ENCRYPTION_METADATA_KEY, password, c);
+  };
+}
+
+export namespace EncryptedModule {
+  /**
+   * Dynamic encrypted module.
+   *
+   * `EncryptedModule.dynamic` is an extension of the {@link EncryptedModule} function
+   * who configures controller classes by the dynamic importing. By specifying directory
+   * path of the controller classes, those controllers would be automatically imported
+   * and configured.
+   *
+   * @param path Directory path of the controller classes
+   * @param password Encryption password or its getter function
+   * @param options Additional options except controller
+   * @returns Class decorated module instance
+   */
+  export async function dynamic(
+    path: string | string[] | { include: string[]; exclude?: string[] },
+    password: IEncryptionPassword | IEncryptionPassword.Closure,
+    options: Omit<Parameters<typeof Module>[0], "controllers"> = {},
+  ): Promise<object> {
+    // LOAD CONTROLLERS
+    const controllers: Creator<object>[] = await load_controllers(path);
+
+    // RETURNS WITH DECORATING
+    @EncryptedModule({ ...options, controllers }, password)
+    class NestiaModule {}
+    return NestiaModule;
+  }
+}

package/src/decorators/EncryptedRoute.ts

@@ -1,5 +1,5 @@
-import { AesPkcs5 } from "@nestia/fetcher/lib/AesPkcs5";
 import { IEncryptionPassword } from "@nestia/fetcher/lib/IEncryptionPassword";
+import { AesPkcs5 } from "@nestia/fetcher/lib/internal/AesPkcs5";
 import {
   CallHandler,
   Delete,
@@ -14,6 +14,7 @@ import {
 } from "@nestjs/common";
 import { HttpArgumentsHost } from "@nestjs/common/interfaces";
 import express from "express";
+import type { FastifyRequest } from "fastify";
 import { catchError, map } from "rxjs/operators";
 import typia from "typia";
 
@@ -129,10 +130,15 @@ for (const method of [
  * @internal
  */
 class EncryptedRouteInterceptor implements NestInterceptor {
+  private readonly success: number;
+
   public constructor(
     private readonly method: string,
     private readonly stringify: (input: any) => string,
-  ) {}
+  ) {
+    this.success =
+      this.method === "GET" || this.method === "DELETE" ? 200 : 201;
+  }
 
   public intercept(context: ExecutionContext, next: CallHandler) {
     const http: HttpArgumentsHost = context.switchToHttp();
@@ -152,18 +158,29 @@ class EncryptedRouteInterceptor implements NestInterceptor {
           const request: express.Request = http.getRequest();
           return headers_to_object(request.headers);
         });
-        const body: string | undefined = this.stringify(value);
-        const password: IEncryptionPassword =
-          typeof param === "function"
-            ? param({
-                headers: headers.get(),
-                body,
-                direction: "encode",
-              })
-            : param;
-
-        if (body === undefined) return body;
-        return AesPkcs5.encrypt(body, password.key, password.iv);
+        const body: Uint8Array = (() => {
+          const body = this.stringify(value);
+          if (body === undefined) return Buffer.from([]);
+
+          const password: IEncryptionPassword =
+            typeof param === "function"
+              ? param({
+                  body,
+                  direction: "encode",
+                  headers: headers.get(),
+                })
+              : param;
+          return AesPkcs5.encrypt(body, password.key, password.iv);
+        })();
+        // return body;
+        const response: express.Response = http.getResponse();
+        if (isExpressRequest(http.getRequest()))
+          response
+            .header("Content-Type", "application/octet-stream")
+            .status(this.success)
+            .send(body)
+            .end();
+        return body;
       }),
       catchError((err) => route_error(http.getRequest(), err)),
     );
@@ -180,3 +197,10 @@ const ROUTERS = {
   Patch,
   Delete,
 };
+
+/**
+ * @internal
+ */
+const isExpressRequest = (
+  request: express.Request | FastifyRequest,
+): request is express.Request => (request as express.Request).app !== undefined;

package/src/decorators/PlainBody.ts

@@ -1,72 +1,72 @@
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-import { assert } from "typia";
-
-import { get_text_body } from "./internal/get_text_body";
-import { validate_request_body } from "./internal/validate_request_body";
-
-/**
- * Plain body decorator.
- *
- * `PlainBody` is a decorator function getting full body text from the HTTP request.
- *
- * If you adjust the regular {@link Body} decorator function to the body parameter,
- * you can't get the full body text because the {@link Body} tries to convert the
- * body text to JSON object. Therefore, `@nestia/core` provides this `PlainBody`
- * decorator function to get the full body text.
- *
- * ```typescript
- * \@TypedRoute.Post("memo")
- * public store
- *     (
- *         \@PlainBody() body: string
- *     ): void;
- * ```
- *
- * @return Parameter decorator
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function PlainBody(): ParameterDecorator;
-
-/**
- * @internal
- */
-export function PlainBody(
-  assert?: (input: unknown) => string,
-): ParameterDecorator {
-  const checker = assert
-    ? validate_request_body("PlainBody")({
-        type: "assert",
-        assert,
-      })
-    : null;
-  return createParamDecorator(async function PlainBody(
-    _data: any,
-    context: ExecutionContext,
-  ) {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-    if (!isTextPlain(request.headers["content-type"]))
-      throw new BadRequestException(`Request body type is not "text/plain".`);
-    const value: string = await get_text_body(request);
-    if (checker) {
-      const error: Error | null = checker(value);
-      if (error !== null) throw error;
-    }
-    return value;
-  })();
-}
-Object.assign(PlainBody, assert);
-
-const isTextPlain = (text?: string): boolean =>
-  text !== undefined &&
-  text
-    .split(";")
-    .map((str) => str.trim())
-    .some((str) => str === "text/plain");
+import {
+  BadRequestException,
+  ExecutionContext,
+  createParamDecorator,
+} from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+import { assert } from "typia";
+
+import { get_text_body } from "./internal/get_text_body";
+import { validate_request_body } from "./internal/validate_request_body";
+
+/**
+ * Plain body decorator.
+ *
+ * `PlainBody` is a decorator function getting full body text from the HTTP request.
+ *
+ * If you adjust the regular {@link Body} decorator function to the body parameter,
+ * you can't get the full body text because the {@link Body} tries to convert the
+ * body text to JSON object. Therefore, `@nestia/core` provides this `PlainBody`
+ * decorator function to get the full body text.
+ *
+ * ```typescript
+ * \@TypedRoute.Post("memo")
+ * public store
+ *     (
+ *         \@PlainBody() body: string
+ *     ): void;
+ * ```
+ *
+ * @return Parameter decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function PlainBody(): ParameterDecorator;
+
+/**
+ * @internal
+ */
+export function PlainBody(
+  assert?: (input: unknown) => string,
+): ParameterDecorator {
+  const checker = assert
+    ? validate_request_body("PlainBody")({
+        type: "assert",
+        assert,
+      })
+    : null;
+  return createParamDecorator(async function PlainBody(
+    _data: any,
+    context: ExecutionContext,
+  ) {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+    if (!isTextPlain(request.headers["content-type"]))
+      throw new BadRequestException(`Request body type is not "text/plain".`);
+    const value: string = await get_text_body(request);
+    if (checker) {
+      const error: Error | null = checker(value);
+      if (error !== null) throw error;
+    }
+    return value;
+  })();
+}
+Object.assign(PlainBody, assert);
+
+const isTextPlain = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "text/plain");

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 { assert, is, misc, validate } from "typia";
-
-import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
-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 (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;
-  })();
-}
-
-Object.assign(TypedBody, misc.clone);
-Object.assign(TypedBody, is);
-Object.assign(TypedBody, assert);
-Object.assign(TypedBody, validate);
-
-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 { assert, is, misc, validate } from "typia";
+
+import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
+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 (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;
+  })();
+}
+
+Object.assign(TypedBody, misc.clone);
+Object.assign(TypedBody, is);
+Object.assign(TypedBody, assert);
+Object.assign(TypedBody, validate);
+
+const isApplicationJson = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "application/json");