Merge pull request #1157 from samchon/feat/param

Close #914: `@TypedParam()` to consider `validate` option.

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@nestia/station",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0",
   "description": "Nestia station",
   "scripts": {
     "build": "node deploy build",

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/core",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0-dev.20241216-3",
   "description": "Super-fast validation decorators of NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -52,7 +52,7 @@
     "ws": "^7.5.3"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=4.4.0-dev.20241216",
+    "@nestia/fetcher": ">=4.4.0-dev.20241216-3",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",

packages/core/src/decorators/TypedParam.ts

@@ -5,7 +5,7 @@ import {
 } from "@nestjs/common";
 import type express from "express";
 import type { FastifyRequest } from "fastify";
-import typia, { TypeGuardError } from "typia";
+import typia, { IValidation, TypeGuardError } from "typia";
 
 import { NoTransformConfigurationError } from "./NoTransformConfigurationError";
 
@@ -35,6 +35,7 @@ import { NoTransformConfigurationError } from "./NoTransformConfigurationError";
 export function TypedParam<T extends boolean | bigint | number | string | null>(
   name: string,
   assert?: (value: string) => T,
+  validate?: boolean,
 ): ParameterDecorator {
   if (assert === undefined) {
     NoTransformConfigurationError("TypedParam");
@@ -52,14 +53,24 @@ export function TypedParam<T extends boolean | bigint | number | string | null>(
     try {
       return assert(str);
     } catch (exp) {
-      if (typia.is<TypeGuardError>(exp))
-        throw new BadRequestException({
-          path: exp.path,
-          reason: exp.message,
+      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);

packages/core/src/options/INestiaTransformOptions.ts

@@ -1,6 +1,12 @@
 export interface INestiaTransformOptions {
-  validate?: // NORMAL
-  | "assert"
+  validate?: INestiaTransformOptions.Validate;
+  stringify?: INestiaTransformOptions.Stringify | null;
+  throws?: boolean;
+}
+export namespace INestiaTransformOptions {
+  export type Validate =
+    // NORMAL
+    | "assert"
     | "is"
     | "validate"
     // STRICT
@@ -13,12 +19,11 @@ export interface INestiaTransformOptions {
     // PRUNE
     | "assertPrune"
     | "validatePrune";
-  stringify?:
+
+  export type Stringify =
     | "stringify"
     | "assert"
     | "is"
     | "validate"
-    | "validate.log"
-    | null;
-  throws?: boolean;
+    | "validate.log";
 }

packages/core/src/programmers/TypedParamProgrammer.ts

@@ -25,6 +25,9 @@ export namespace TypedParamProgrammer {
         type: props.type,
         name: undefined,
       }),
+      ...(props.context.options?.validate?.startsWith("validate")
+        ? [ts.factory.createTrue()]
+        : []),
     ];
   };
 }

packages/editor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/editor",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0-dev.20241216-3",
   "typings": "lib/index.d.ts",
   "main": "lib/index.js",
   "module": "lib/index.mjs",

packages/fetcher/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0-dev.20241216-3",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

packages/migrate/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/migrate",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0-dev.20241216-3",
   "description": "Migration program from swagger to NestJS",
   "typings": "lib/index.d.ts",
   "main": "lib/index.js",

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/sdk",
-  "version": "4.4.0-dev.20241216",
+  "version": "4.4.0-dev.20241216-3",
   "description": "Nestia SDK and Swagger generator",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -47,8 +47,8 @@
     "typia": "^7.4.0"
   },
   "peerDependencies": {
-    "@nestia/core": ">=4.4.0-dev.20241216",
-    "@nestia/fetcher": ">=4.4.0-dev.20241216",
+    "@nestia/core": ">=4.4.0-dev.20241216-3",
+    "@nestia/fetcher": ">=4.4.0-dev.20241216-3",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",

test/features/param-validate/nestia.config.ts

@@ -0,0 +1,16 @@
+import { INestiaConfig } from "@nestia/sdk";
+
+export const NESTIA_CONFIG: INestiaConfig = {
+  input: ["src/controllers"],
+  output: "src/api",
+  swagger: {
+    beautify: true,
+    output: "swagger.json",
+    security: {
+      bearer: {
+        type: "apiKey",
+      },
+    },
+  },
+};
+export default NESTIA_CONFIG;

test/features/param-validate/src/Backend.ts

@@ -0,0 +1,28 @@
+import core from "@nestia/core";
+import { INestApplication } from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+
+export class Backend {
+  private application_?: INestApplication;
+
+  public async open(): Promise<void> {
+    this.application_ = await NestFactory.create(
+      await core.EncryptedModule.dynamic(__dirname + "/controllers", {
+        key: "A".repeat(32),
+        iv: "B".repeat(16),
+      }),
+      { logger: false },
+    );
+    await core.WebSocketAdaptor.upgrade(this.application_);
+    await this.application_.listen(37_000);
+  }
+
+  public async close(): Promise<void> {
+    if (this.application_ === undefined) return;
+
+    const app = this.application_;
+    await app.close();
+
+    delete this.application_;
+  }
+}

test/features/param-validate/src/api/HttpError.ts

@@ -0,0 +1 @@
+export { HttpError } from "@nestia/fetcher";

test/features/param-validate/src/api/IConnection.ts

@@ -0,0 +1 @@
+export type { IConnection } from "@nestia/fetcher";

test/features/param-validate/src/api/Primitive.ts

@@ -0,0 +1 @@
+export type { Primitive } from "typia";

test/features/param-validate/src/api/Resolved.ts

@@ -0,0 +1 @@
+export type { Resolved } from "typia";

test/features/param-validate/src/api/functional/calculate/index.ts

@@ -0,0 +1,51 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.calculate
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+import type { IConnection } from "@nestia/fetcher";
+import { WebSocketConnector } from "tgrid";
+import type { Driver } from "tgrid";
+import type { Format } from "typia/lib/tags/Format";
+
+import type { ICalculator } from "../../structures/ICalculator";
+import type { IListener } from "../../structures/IListener";
+import type { IPrecision } from "../../structures/IPrecision";
+
+/**
+ * @controller CalculateController.connect
+ * @path /calculate/:id
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function connect(
+  connection: IConnection<connect.Header>,
+  id: string & Format<"uuid">,
+  provider: connect.Provider,
+): Promise<connect.Output> {
+  const connector: WebSocketConnector<
+    connect.Header,
+    connect.Provider,
+    connect.Listener
+  > = new WebSocketConnector(connection.headers ?? ({} as any), provider);
+  await connector.connect(
+    `${connection.host.endsWith("/") ? connection.host.substring(0, connection.host.length - 1) : connection.host}${connect.path(id)}`,
+  );
+  const driver: Driver<connect.Listener> = connector.getDriver();
+  return {
+    connector,
+    driver,
+  };
+}
+export namespace connect {
+  export type Output = {
+    connector: WebSocketConnector<Header, Provider, Listener>;
+    driver: Driver<Listener>;
+  };
+  export type Header = IPrecision;
+  export type Provider = IListener;
+  export type Listener = ICalculator;
+
+  export const path = (id: string & Format<"uuid">) =>
+    `/calculate/${encodeURIComponent(id?.toString() ?? "null")}`;
+}

test/features/param-validate/src/api/functional/health/index.ts

@@ -0,0 +1,35 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+import type { IConnection } from "@nestia/fetcher";
+import { PlainFetcher } from "@nestia/fetcher/lib/PlainFetcher";
+
+/**
+ * @controller HealthController.get
+ * @path GET /health
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export async function get(connection: IConnection): Promise<void> {
+  return PlainFetcher.fetch(connection, {
+    ...get.METADATA,
+    template: get.METADATA.path,
+    path: get.path(),
+  });
+}
+export namespace get {
+  export const METADATA = {
+    method: "GET",
+    path: "/health",
+    request: null,
+    response: {
+      type: "application/json",
+      encrypted: false,
+    },
+    status: 200,
+  } as const;
+
+  export const path = () => "/health";
+}

test/features/param-validate/src/api/functional/index.ts

@@ -0,0 +1,10 @@
+/**
+ * @packageDocumentation
+ * @module api.functional
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+//================================================================
+export * as calculate from "./calculate";
+export * as health from "./health";
+export * as performance from "./performance";
+export * as param from "./param";