@nestia/core 12.0.0-dev.20260601.1 → 12.0.0-dev.20260612.2

package/src/decorators/NoTransformConfigurationError.ts

@@ -1,40 +1,40 @@
-/** @internal */
-export function NoTransformConfigurationError(method: string) {
-  if (NoTransformConfigurationError.throws === true)
-    throw new Error(
-      [
-        `Error on nestia.core.${method}(): no transform has been configured.`,
-        `Build the project with "ttsc" (not stock "tsc"); the Go-backed @nestia/core transform attaches automatically through ttsc plugin auto-discovery.`,
-        `If "ttsc" is missing, run "npx nestia setup" to install the toolchain and runtime packages.`,
-        `If you're using a non-standard TypeScript compiler like Babel or SWC, the @nestia/core transformer is not available.`,
-        `If you're running "npx nestia sdk/swagger" or similar, run "npx ttsc --noEmit" to surface the underlying compilation error.`,
-        `See https://nestia.io/docs/setup for the full setup (tsgo and legacy paths); migration notes are at node_modules/@nestia/core/MIGRATION.md.`,
-      ].join(" "),
-    );
-  return undefined as never;
-}
-
-/** @internal */
-export namespace NoTransformConfigurationError {
-  /**
-   * Whether to throw an error or not.
-   *
-   * If you set this value to `false`, {@link NoTransformConfigurationError} will
-   * not throw an error.
-   *
-   * Even if you've not configured the plugin transformer of `tsconfig.json`
-   * file, the error will not be thrown and the program will be continued.
-   * Instead, every validations and assertions will be skipped and the value
-   * will be returned as it is. Furthermore, unexpected behaviors may occur.
-   *
-   * Therefore, it is not recommended to set this value to `false` in production
-   * environment. Configure this value to be `false` only when you're debugging
-   * or testing.
-   *
-   * By the way, if you hope the `false` value to be set, you have to do it
-   * before the first. If you configure the `false` value after the
-   * `@nestia/core` decorator functions are composed, the value will not be
-   * applied and the error will be thrown.
-   */
-  export let throws = true;
-}
+/** @internal */
+export function NoTransformConfigurationError(method: string) {
+  if (NoTransformConfigurationError.throws === true)
+    throw new Error(
+      [
+        `Error on nestia.core.${method}(): no transform has been configured.`,
+        `Build the project with "ttsc" (not stock "tsc"); the Go-backed @nestia/core transform attaches automatically through ttsc plugin auto-discovery.`,
+        `If "ttsc" is missing, run "npx nestia setup" to install the toolchain and runtime packages.`,
+        `If you're using a non-standard TypeScript compiler like Babel or SWC, the @nestia/core transformer is not available.`,
+        `If you're running "npx nestia sdk/swagger" or similar, run "npx ttsc --noEmit" to surface the underlying compilation error.`,
+        `See https://nestia.io/docs/setup for the full setup (tsgo and legacy paths); migration notes are at node_modules/@nestia/core/MIGRATION.md.`,
+      ].join(" "),
+    );
+  return undefined as never;
+}
+
+/** @internal */
+export namespace NoTransformConfigurationError {
+  /**
+   * Whether to throw an error or not.
+   *
+   * If you set this value to `false`, {@link NoTransformConfigurationError} will
+   * not throw an error.
+   *
+   * Even if you've not configured the plugin transformer of `tsconfig.json`
+   * file, the error will not be thrown and the program will be continued.
+   * Instead, every validations and assertions will be skipped and the value
+   * will be returned as it is. Furthermore, unexpected behaviors may occur.
+   *
+   * Therefore, it is not recommended to set this value to `false` in production
+   * environment. Configure this value to be `false` only when you're debugging
+   * or testing.
+   *
+   * By the way, if you hope the `false` value to be set, you have to do it
+   * before the first. If you configure the `false` value after the
+   * `@nestia/core` decorator functions are composed, the value will not be
+   * applied and the error will be thrown.
+   */
+  export let throws = true;
+}

package/src/decorators/PlainBody.ts

@@ -1,76 +1,76 @@
-import {
-  BadRequestException,
-  ExecutionContext,
-  createParamDecorator,
-} from "@nestjs/common";
-import type express from "express";
-import type { FastifyRequest } from "fastify";
-
-import { get_text_body } from "./internal/get_text_body";
-import { is_request_body_undefined } from "./internal/is_request_body_undefined";
-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;
- * ```
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @returns Parameter decorator
- */
-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 (
-      is_request_body_undefined(request) &&
-      (checker ?? (() => null))(undefined as any) === null
-    )
-      return undefined;
-    else 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;
-  })();
-}
-
-/** @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 { get_text_body } from "./internal/get_text_body";
+import { is_request_body_undefined } from "./internal/is_request_body_undefined";
+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;
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @returns Parameter decorator
+ */
+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 (
+      is_request_body_undefined(request) &&
+      (checker ?? (() => null))(undefined as any) === null
+    )
+      return undefined;
+    else 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;
+  })();
+}
+
+/** @internal */
+const isTextPlain = (text?: string): boolean =>
+  text !== undefined &&
+  text
+    .split(";")
+    .map((str) => str.trim())
+    .some((str) => str === "text/plain");

package/src/decorators/SwaggerCustomizer.ts

@@ -1,97 +1,97 @@
-import { OpenApi } from "@typia/interface";
-
-/**
- * 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.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @param closure Callback function which can customize the swagger data
- * @returns Method decorator
- */
-export function SwaggerCustomizer(
-  closure: (props: SwaggerCustomizer.IProps) => unknown,
-): MethodDecorator {
-  return function SwaggerCustomizer(
-    target: Object,
-    propertyKey: string | symbol,
-    descriptor: TypedPropertyDescriptor<any>,
-  ) {
-    const array: Array<(props: SwaggerCustomizer.IProps) => unknown> = (() => {
-      if (Reflect.hasMetadata("nestia/SwaggerCustomizer", target, propertyKey))
-        return Reflect.getMetadata(
-          "nestia/SwaggerCustomizer",
-          target,
-          propertyKey,
-        );
-      const array: Array<(props: SwaggerCustomizer.IProps) => unknown> = [];
-      Reflect.defineMetadata(
-        "nestia/SwaggerCustomizer",
-        array,
-        target,
-        propertyKey,
-      );
-      return array;
-    })();
-    array.push(closure);
-    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: OpenApi.IDocument;
-
-    /** Method of the route. */
-    method: string;
-
-    /** Path of the route. */
-    path: string;
-
-    /** Route data. */
-    route: OpenApi.IOperation;
-
-    /**
-     * Get neighbor endpoint data through the controller method.
-     *
-     * @param func Controller method to find the neighbor endpoint
-     * @returns Neighbor endpoint data
-     */
-    at(func: Function): ISwaggerEndpoint | undefined;
-
-    /**
-     * Get neighbor route data.
-     *
-     * @param accessor Accessor for getting neighbor route data
-     * @returns Neighbor route data
-     */
-    get(accessor: IAccessor): OpenApi.IOperation | undefined;
-  }
-
-  /** Accessor for getting neighbor route data. */
-  export interface IAccessor {
-    /** Path of the neighbor route. */
-    path: string;
-
-    /** Method of the neighbor route. */
-    method: string;
-  }
-
-  /** Endpoint info of the route. */
-  export interface ISwaggerEndpoint extends IAccessor {
-    /** Route data. */
-    route: OpenApi.IOperation;
-  }
-}
+import { OpenApi } from "@typia/interface";
+
+/**
+ * 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.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param closure Callback function which can customize the swagger data
+ * @returns Method decorator
+ */
+export function SwaggerCustomizer(
+  closure: (props: SwaggerCustomizer.IProps) => unknown,
+): MethodDecorator {
+  return function SwaggerCustomizer(
+    target: Object,
+    propertyKey: string | symbol,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) {
+    const array: Array<(props: SwaggerCustomizer.IProps) => unknown> = (() => {
+      if (Reflect.hasMetadata("nestia/SwaggerCustomizer", target, propertyKey))
+        return Reflect.getMetadata(
+          "nestia/SwaggerCustomizer",
+          target,
+          propertyKey,
+        );
+      const array: Array<(props: SwaggerCustomizer.IProps) => unknown> = [];
+      Reflect.defineMetadata(
+        "nestia/SwaggerCustomizer",
+        array,
+        target,
+        propertyKey,
+      );
+      return array;
+    })();
+    array.push(closure);
+    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: OpenApi.IDocument;
+
+    /** Method of the route. */
+    method: string;
+
+    /** Path of the route. */
+    path: string;
+
+    /** Route data. */
+    route: OpenApi.IOperation;
+
+    /**
+     * Get neighbor endpoint data through the controller method.
+     *
+     * @param func Controller method to find the neighbor endpoint
+     * @returns Neighbor endpoint data
+     */
+    at(func: Function): ISwaggerEndpoint | undefined;
+
+    /**
+     * Get neighbor route data.
+     *
+     * @param accessor Accessor for getting neighbor route data
+     * @returns Neighbor route data
+     */
+    get(accessor: IAccessor): OpenApi.IOperation | undefined;
+  }
+
+  /** Accessor for getting neighbor route data. */
+  export interface IAccessor {
+    /** Path of the neighbor route. */
+    path: string;
+
+    /** Method of the neighbor route. */
+    method: string;
+  }
+
+  /** Endpoint info of the route. */
+  export interface ISwaggerEndpoint extends IAccessor {
+    /** Route data. */
+    route: OpenApi.IOperation;
+  }
+}