@nestia/core 2.5.8 → 2.5.9

package/src/decorators/EncryptedBody.ts

@@ -1,105 +1,105 @@
-import { AesPkcs5 } from "@nestia/fetcher/lib/AesPkcs5";
-import { IEncryptionPassword } from "@nestia/fetcher/lib/IEncryptionPassword";
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-import { assert, is, validate } from "typia";
-
-import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
-import { Singleton } from "../utils/Singleton";
-import { ENCRYPTION_METADATA_KEY } from "./internal/EncryptedConstant";
-import { get_text_body } from "./internal/get_text_body";
-import { headers_to_object } from "./internal/headers_to_object";
-import { validate_request_body } from "./internal/validate_request_body";
-
-/**
- * Encrypted body decorator.
- *
- * `EncryptedBody` is a decorator function getting `application/json` typed data from
- * requeset body which has been encrypted by AES-128/256 algorithm. Also,
- * `EncyrptedBody` validates the request body data type through
- * [typia](https://github.com/samchon/typia) ad the validation speed is
- * maximum 15,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. Also,
- * `EncryptedRoute` decrypts request body using those options.
- *
- *  - AES-128/256
- *  - CBC mode
- *  - PKCS #5 Padding
- *  - Base64 Encoding
- *
- * @return Parameter decorator
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function EncryptedBody<T>(
-  validator?: IRequestBodyValidator<T>,
-): ParameterDecorator {
-  const checker = validate_request_body("EncryptedBody")(validator);
-  return createParamDecorator(async function EncryptedBody(
-    _unknown: any,
-    context: ExecutionContext,
-  ) {
-    const request: express.Request | FastifyRequest = context
-      .switchToHttp()
-      .getRequest();
-    if (isTextPlain(request.headers["content-type"]) === false)
-      throw new BadRequestException(`Request body type is not "text/plain".`);
-
-    const param: IEncryptionPassword | IEncryptionPassword.Closure | undefined =
-      Reflect.getMetadata(ENCRYPTION_METADATA_KEY, context.getClass());
-    if (!param)
-      throw new Error(
-        "Error on nestia.core.EncryptedBody(): no encryption password is given.",
-      );
-
-    // GET BODY DATA
-    const headers: Singleton<Record<string, string>> = new Singleton(() =>
-      headers_to_object(request.headers),
-    );
-    const body: string = await get_text_body(request);
-    const password: IEncryptionPassword =
-      typeof param === "function"
-        ? param({ headers: headers.get(), body, direction: "decode" })
-        : param;
-
-    // PARSE AND VALIDATE DATA
-    const data: any = JSON.parse(decrypt(body, password.key, password.iv));
-    const error: Error | null = checker(data);
-    if (error !== null) throw error;
-    return data;
-  })();
-}
-Object.assign(EncryptedBody, is);
-Object.assign(EncryptedBody, assert);
-Object.assign(EncryptedBody, validate);
-
-/**
- * @internal
- */
-const decrypt = (body: string, key: string, iv: string): string => {
-  try {
-    return AesPkcs5.decrypt(body, key, iv);
-  } catch (exp) {
-    if (exp instanceof Error)
-      throw new BadRequestException(
-        "Failed to decrypt the request body. Check your body content or encryption password.",
-      );
-    else throw exp;
-  }
-};
-
-/**
- * @internal
- */
-const isTextPlain = (text?: string): boolean =>
-  text !== undefined &&
-  text
-    .split(";")
-    .map((str) => str.trim())
-    .some((str) => str === "text/plain");
+import { AesPkcs5 } from "@nestia/fetcher/lib/AesPkcs5";
+import { IEncryptionPassword } from "@nestia/fetcher/lib/IEncryptionPassword";
+import {
+  BadRequestException,
+  ExecutionContext,
+  createParamDecorator,
+} from "@nestjs/common";
+import type express from "express";
+import type { FastifyRequest } from "fastify";
+import { assert, is, validate } from "typia";
+
+import { IRequestBodyValidator } from "../options/IRequestBodyValidator";
+import { Singleton } from "../utils/Singleton";
+import { ENCRYPTION_METADATA_KEY } from "./internal/EncryptedConstant";
+import { get_text_body } from "./internal/get_text_body";
+import { headers_to_object } from "./internal/headers_to_object";
+import { validate_request_body } from "./internal/validate_request_body";
+
+/**
+ * Encrypted body decorator.
+ *
+ * `EncryptedBody` is a decorator function getting `application/json` typed data from
+ * requeset body which has been encrypted by AES-128/256 algorithm. Also,
+ * `EncyrptedBody` validates the request body data type through
+ * [typia](https://github.com/samchon/typia) ad the validation speed is
+ * maximum 15,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. Also,
+ * `EncryptedRoute` decrypts request body using those options.
+ *
+ *  - AES-128/256
+ *  - CBC mode
+ *  - PKCS #5 Padding
+ *  - Base64 Encoding
+ *
+ * @return Parameter decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function EncryptedBody<T>(
+  validator?: IRequestBodyValidator<T>,
+): ParameterDecorator {
+  const checker = validate_request_body("EncryptedBody")(validator);
+  return createParamDecorator(async function EncryptedBody(
+    _unknown: any,
+    context: ExecutionContext,
+  ) {
+    const request: express.Request | FastifyRequest = context
+      .switchToHttp()
+      .getRequest();
+    if (isTextPlain(request.headers["content-type"]) === false)
+      throw new BadRequestException(`Request body type is not "text/plain".`);
+
+    const param: IEncryptionPassword | IEncryptionPassword.Closure | undefined =
+      Reflect.getMetadata(ENCRYPTION_METADATA_KEY, context.getClass());
+    if (!param)
+      throw new Error(
+        "Error on nestia.core.EncryptedBody(): no encryption password is given.",
+      );
+
+    // GET BODY DATA
+    const headers: Singleton<Record<string, string>> = new Singleton(() =>
+      headers_to_object(request.headers),
+    );
+    const body: string = await get_text_body(request);
+    const password: IEncryptionPassword =
+      typeof param === "function"
+        ? param({ headers: headers.get(), body, direction: "decode" })
+        : param;
+
+    // PARSE AND VALIDATE DATA
+    const data: any = JSON.parse(decrypt(body, password.key, password.iv));
+    const error: Error | null = checker(data);
+    if (error !== null) throw error;
+    return data;
+  })();
+}
+Object.assign(EncryptedBody, is);
+Object.assign(EncryptedBody, assert);
+Object.assign(EncryptedBody, validate);
+
+/**
+ * @internal
+ */
+const decrypt = (body: string, key: string, iv: string): string => {
+  try {
+    return AesPkcs5.decrypt(body, key, iv);
+  } catch (exp) {
+    if (exp instanceof Error)
+      throw new BadRequestException(
+        "Failed to decrypt the request body. Check your body content or encryption password.",
+      );
+    else throw exp;
+  }
+};
+
+/**
+ * @internal
+ */
+const isTextPlain = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "text/plain");

package/src/decorators/EncryptedModule.ts

@@ -1,96 +1,96 @@
-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.Closure,
-): ClassDecorator {
-  return function (target: any) {
-    Module(metadata)(target);
-    iterate(password)(target);
-  };
-}
-
-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 },
-      typeof password === "object" ? () => password : password,
-    )
-    class NestiaModule {}
-    return NestiaModule;
-  }
-}
-
-/**
- * @internal
- */
-const iterate =
-  (password: IEncryptionPassword.Closure) =>
-  (modulo: any): void => {
-    const imports = Reflect.getMetadata("imports", modulo);
-    if (Array.isArray(imports))
-      for (const imp of imports)
-        if (typeof imp === "function") iterate(password)(imp);
-
-    const controllers = Reflect.getMetadata("controllers", modulo);
-    if (Array.isArray(controllers))
-      for (const c of controllers)
-        if (typeof c === "function")
-          Reflect.defineMetadata(ENCRYPTION_METADATA_KEY, password, c);
-  };
+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.Closure,
+): ClassDecorator {
+  return function (target: any) {
+    Module(metadata)(target);
+    iterate(password)(target);
+  };
+}
+
+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 },
+      typeof password === "object" ? () => password : password,
+    )
+    class NestiaModule {}
+    return NestiaModule;
+  }
+}
+
+/**
+ * @internal
+ */
+const iterate =
+  (password: IEncryptionPassword.Closure) =>
+  (modulo: any): void => {
+    const imports = Reflect.getMetadata("imports", modulo);
+    if (Array.isArray(imports))
+      for (const imp of imports)
+        if (typeof imp === "function") iterate(password)(imp);
+
+    const controllers = Reflect.getMetadata("controllers", modulo);
+    if (Array.isArray(controllers))
+      for (const c of controllers)
+        if (typeof c === "function")
+          Reflect.defineMetadata(ENCRYPTION_METADATA_KEY, password, c);
+  };

package/src/decorators/PlainBody.ts

@@ -1,75 +1,75 @@
-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);
-
-/**
- * @internal
- */
-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);
+
+/**
+ * @internal
+ */
+const isTextPlain = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "text/plain");

package/src/decorators/SwaggerCustomizer.ts

@@ -0,0 +1,87 @@
+import { ISwagger } from "../structures/ISwagger";
+import { ISwaggerRoute } from "../structures/ISwaggerRoute";
+
+/**
+ * Swagger customization decorator.
+ *
+ * `SwaggerCustomizer` is a method decorator function which can used for
+ * customizing the swagger data with `npx nestia swagger` command. Furthermore,
+ * it is possible to add plugin properties starting with `x-` characters.
+ *
+ * In other words, this decorator function does not affect to the runtime,
+ * but only for the swagger data customization.
+ *
+ * @param closure Callback function which can customize the swagger data
+ * @returns Method decorator
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function SwaggerCustomizer(
+  closure: (props: SwaggerCustomizer.IProps) => unknown,
+): MethodDecorator {
+  return function SwaggerCustomizer(
+    target: Object,
+    propertyKey: string | symbol,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) {
+    Reflect.defineMetadata(
+      "nestia/SwaggerCustomizer",
+      closure,
+      target,
+      propertyKey,
+    );
+    return descriptor;
+  };
+}
+export namespace SwaggerCustomizer {
+  /**
+   * Properties for the `SwaggerCustomizer` decorator.
+   *
+   * `SwaggerCustomizer.IProps` is a type for the `closure` parameter of the
+   * `SwaggerCustomizer` decorator. It's a callback function which can customize
+   * the swagger data.
+   */
+  export interface IProps {
+    /**
+     * Swagger data.
+     */
+    swagger: ISwagger;
+
+    /**
+     * Method of the route.
+     */
+    method: string;
+
+    /**
+     * Path of the route.
+     */
+    path: string;
+
+    /**
+     * Route data.
+     */
+    route: ISwaggerRoute;
+
+    /**
+     * Get neighbor route data.
+     *
+     * @param accessor Accessor for getting neighbor route data
+     * @returns Neighbor route data
+     */
+    get(accessor: IAccessor): ISwaggerRoute | undefined;
+  }
+
+  /**
+   * Accessor for getting neighbor route data.
+   */
+  export interface IAccessor {
+    /**
+     * Path of the neighbor route.
+     */
+    path: string;
+
+    /**
+     * Method of the neighbor route.
+     */
+    method: string;
+  }
+}