@nestia/core 14.0.1 → 14.0.3

package/src/options/IRequestBodyValidator.ts

@@ -4,17 +4,88 @@ export type IRequestBodyValidator<T> =
   | IRequestBodyValidator.IAssert<T>
   | IRequestBodyValidator.IIs<T>
   | IRequestBodyValidator.IValidate<T>;
+/**
+ * The request body validator that the transform passes to `TypedBody`,
+ * `EncryptedBody`, `PlainBody`, `WebSocketRoute.Header`, and
+ * `McpRoute.Params`.
+ *
+ * The literal `type` field selects which typia function generated the
+ * validator: `assert`, `is`, or `validate`. `validate_request_body` turns a
+ * failure of any variant into a 400 response. Assert and validate success
+ * supply their returned data to the decorated argument; is success keeps the
+ * input.
+ *
+ * @evidence contracts/common.md#principled-implementation The union is discriminated by the literal `type`, so the runtime selects the assert, is, or validate path with one comparison and the compiler checks that each variant carries the function its tag names.
+ * @evidence contracts/common.md#clear-and-simple-design Three variants, one per typia function family, with no shared base because each function has a different shape.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior; the runtime rejects an unknown `type` with an error instead of accepting it.
+ * @evidence contracts/common.md#meaningful-documentation The comment names the decorators that receive the validator, the meaning of the discriminant, and the response a failure becomes.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+ */
 export namespace IRequestBodyValidator {
+  /**
+   * Validator generated from `typia.assert`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function returning validated data, which may be a clone, or throwing TypeGuardError. The shared runner retains successful data and converts the guard error to BadRequestException carrying the first failure's path, reason, expected type and value.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from; the failure response is stated on the union.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+   */
   export interface IAssert<T> {
     type: "assert";
+    /**
+     * The typia assertion function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The generated assertion returns the validated value, including a separate clone for clone modes, or throws TypeGuardError. Successful data becomes the decorated argument without requiring identity with the parsed input.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its input is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+     */
     assert: (input: T) => T;
   }
+  /**
+   * Validator generated from `typia.is`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the parsed value that returns a boolean, because the value is already parsed and is returned as it is; a failing result becomes a `BadRequestException` with only the fixed message, because `typia.is` records no failure detail.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+   */
   export interface IIs<T> {
     type: "is";
+    /**
+     * The typia check function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the parsed value and returning a boolean, because the value is already parsed and is returned as it is.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+     */
     is: (input: T) => boolean;
   }
+  /**
+   * Validator generated from `typia.validate`.
+   *
+   * @evidence contracts/common.md#principled-implementation The callback returns IValidation; successful result.data becomes the decorated argument, including a clone, while failure becomes BadRequestException carrying every validation error.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+   */
   export interface IValidate<T> {
     type: "validate";
+    /**
+     * The typia validation function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the parsed value and returning the validation result with every error.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The union and callback members describe validation of parsed body values without native platform resources.
+     */
     validate: (input: T) => IValidation<T>;
   }
 }

package/src/options/IRequestFormDataProps.ts

@@ -7,19 +7,99 @@ export interface IRequestFormDataProps<T> {
     | IRequestFormDataProps.IIs<T>
     | IRequestFormDataProps.IValidate<T>;
 }
+/**
+ * Properties that the transform passes to `TypedFormData.Body`: the file fields
+ * and the validator.
+ *
+ * `files` names the file fields of the type with their limits, and `validator`
+ * validates the `FormData` made from the fields and the uploaded files.
+ *
+ * @evidence contracts/common.md#principled-implementation The record carries what the multipart handling needs: which fields are files, with how many each may hold, and how to validate the assembled form.
+ * @evidence contracts/common.md#clear-and-simple-design A two-member record whose nested types describe the variants and the file entries.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+ * @evidence contracts/common.md#meaningful-documentation The comment names the two members and the decorator that receives them.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+ */
 export namespace IRequestFormDataProps {
+  /**
+   * Validator generated from `typia.assert`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of `FormData` that returns the decoded object or throws the `TypeGuardError` of typia, which becomes a `BadRequestException` with the path, reason, expected type, and value.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+   */
   export interface IAssert<T> {
     type: "assert";
+    /**
+     * The typia assertion function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument, taking the form and returning the decoded object or throwing.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+     */
     assert: (input: FormData) => T;
   }
+  /**
+   * Validator generated from `typia.is`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of `FormData` that returns the decoded object or `null`; `null` becomes a `BadRequestException` with only the fixed message.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+   */
   export interface IIs<T> {
     type: "is";
+    /**
+     * The typia check function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument, taking the form and returning the decoded object or `null`.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+     */
     is: (input: FormData) => T | null;
   }
+  /**
+   * Validator generated from `typia.validate`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of `FormData` that returns the `IValidation` of typia; a failure becomes a `BadRequestException` carrying every error.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+   */
   export interface IValidate<T> {
     type: "validate";
+    /**
+     * The typia validation function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument, taking the form and returning the validation result.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+     */
     validate: (input: FormData) => IValidation<T>;
   }
+  /**
+   * A file field of a multipart form: its name and the number of files it may
+   * hold, or `null` for no limit.
+   *
+   * A limit of 1 makes the multer field accept one file; any other value leaves
+   * the field unlimited.
+   *
+   * @evidence contracts/common.md#principled-implementation A limit of 1 makes the multer field accept one file and any other value leaves the field unlimited, which is how the runtime configures `multer.fields`.
+   * @evidence contracts/common.md#clear-and-simple-design A two-field record with no behavior.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts The values come from the type through the transform, not from a fixture.
+   * @evidence contracts/common.md#meaningful-documentation The comment states the meaning of the name and of the limit.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation FormData validators and file-field names describe multipart protocol data; no member is a native storage path or handle.
+   */
   export interface IFile {
     name: string;
     limit: number | null;

package/src/options/IRequestHeadersValidator.ts

@@ -4,17 +4,84 @@ export type IRequestHeadersValidator<T> =
   | IRequestHeadersValidator.IAssert<T>
   | IRequestHeadersValidator.IIs<T>
   | IRequestHeadersValidator.IValidate<T>;
+/**
+ * The request headers validator that the transform passes to `TypedHeaders`.
+ *
+ * The literal `type` field selects which typia function generated the
+ * validator: `assert`, `is`, or `validate`. `validate_request_headers` turns a
+ * failure of any variant into a 400 response.
+ *
+ * @evidence contracts/common.md#principled-implementation The union is discriminated by the literal `type`, so the runtime selects the assert, is, or validate path with one comparison and the compiler checks that each variant carries the function its tag names.
+ * @evidence contracts/common.md#clear-and-simple-design Three variants, one per typia function family, with no shared base because each function has a different shape.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior; the runtime rejects an unknown `type` with an error instead of accepting it.
+ * @evidence contracts/common.md#meaningful-documentation The comment names the decorators that receive the validator, the meaning of the discriminant, and the response a failure becomes.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+ */
 export namespace IRequestHeadersValidator {
+  /**
+   * Validator generated from `typia.assert`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the header record of the request, whose values are strings, string arrays, or undefined that returns the decoded object or throws the `TypeGuardError` of typia; `validate_request_headers` catches the error and converts it to a `BadRequestException` carrying the path, reason, expected type, and value of the first failure.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from; the failure response is stated on the union.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+   */
   export interface IAssert<T> {
     type: "assert";
+    /**
+     * The typia assertion function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the header record of the request, whose values are strings, string arrays, or undefined and it returns the decoded object or throws the `TypeGuardError` of typia.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its input is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+     */
     assert: (input: Record<string, string | string[] | undefined>) => T;
   }
+  /**
+   * Validator generated from `typia.is`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the header record of the request, whose values are strings, string arrays, or undefined that returns the decoded object or `null`; a failing result becomes a `BadRequestException` with only the fixed message, because `typia.is` records no failure detail.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+   */
   export interface IIs<T> {
     type: "is";
+    /**
+     * The typia check function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the header record of the request, whose values are strings, string arrays, or undefined and returning the decoded object or `null`.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+     */
     is: (input: Record<string, string | string[] | undefined>) => T | null;
   }
+  /**
+   * Validator generated from `typia.validate`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the header record of the request, whose values are strings, string arrays, or undefined that returns the `IValidation` of typia; a failed result becomes a `BadRequestException` carrying every error of the validation.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+   */
   export interface IValidate<T> {
     type: "validate";
+    /**
+     * The typia validation function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the header record of the request, whose values are strings, string arrays, or undefined and returning the validation result with every error.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes HTTP header records and returns decoded values independently of native filesystem or process spelling.
+     */
     validate: (
       input: Record<string, string | string[] | undefined>,
     ) => IValidation<T>;

package/src/options/IRequestQueryValidator.ts

@@ -4,17 +4,85 @@ export type IRequestQueryValidator<T> =
   | IRequestQueryValidator.IAssert<T>
   | IRequestQueryValidator.IIs<T>
   | IRequestQueryValidator.IValidate<T>;
+/**
+ * The request query validator that the transform passes to `TypedQuery`,
+ * `TypedQuery.Body`, and `WebSocketRoute.Query`.
+ *
+ * The literal `type` field selects which typia function generated the
+ * validator: `assert`, `is`, or `validate`. `validate_request_query` turns a
+ * failure of any variant into a 400 response.
+ *
+ * @evidence contracts/common.md#principled-implementation The union is discriminated by the literal `type`, so the runtime selects the assert, is, or validate path with one comparison and the compiler checks that each variant carries the function its tag names.
+ * @evidence contracts/common.md#clear-and-simple-design Three variants, one per typia function family, with no shared base because each function has a different shape.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior; the runtime rejects an unknown `type` with an error instead of accepting it.
+ * @evidence contracts/common.md#meaningful-documentation The comment names the decorators that receive the validator, the meaning of the discriminant, and the response a failure becomes.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+ */
 export namespace IRequestQueryValidator {
+  /**
+   * Validator generated from `typia.assert`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the `URLSearchParams` of the query string or of an urlencoded body that returns the decoded object or throws the `TypeGuardError` of typia; `validate_request_query` catches the error and converts it to a `BadRequestException` carrying the path, reason, expected type, and value of the first failure, and a message-only one when a required property is missing.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from; the failure response is stated on the union.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+   */
   export interface IAssert<T> {
     type: "assert";
+    /**
+     * The typia assertion function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the `URLSearchParams` of the query string or of an urlencoded body and it returns the decoded object or throws the `TypeGuardError` of typia.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its input is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+     */
     assert: (input: URLSearchParams) => T;
   }
+  /**
+   * Validator generated from `typia.is`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the `URLSearchParams` of the query string or of an urlencoded body that returns the decoded object or `null`; a failing result becomes a `BadRequestException` with only the fixed message, because `typia.is` records no failure detail.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+   */
   export interface IIs<T> {
     type: "is";
+    /**
+     * The typia check function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the `URLSearchParams` of the query string or of an urlencoded body and returning the decoded object or `null`.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+     */
     is: (input: URLSearchParams) => T | null;
   }
+  /**
+   * Validator generated from `typia.validate`.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function of the `URLSearchParams` of the query string or of an urlencoded body that returns the `IValidation` of typia; a failed result becomes a `BadRequestException` carrying every error of the validation.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment names the typia function the variant comes from.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+   */
   export interface IValidate<T> {
     type: "validate";
+    /**
+     * The typia validation function generated for the requested type.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the type argument of the decorator, taking the `URLSearchParams` of the query string or of an urlencoded body and returning the validation result with every error.
+     * @evidence contracts/common.md#clear-and-simple-design One function member with the input the decorator has.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the requested type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The validator consumes URLSearchParams and describes query data rather than native paths or process arguments.
+     */
     validate: (input: URLSearchParams) => IValidation<T>;
   }
 }

package/src/options/IResponseBodyQuerifier.ts

@@ -1,30 +1,150 @@
 import { IValidation } from "typia";
 
+/**
+ * The serializer that the transform passes to `TypedQuery.Get`,
+ * `TypedQuery.Post`, `TypedQuery.Put`, `TypedQuery.Patch`, and
+ * `TypedQuery.Delete` for the urlencoded form of the response body.
+ *
+ * The literal `type` field selects which generated encoder/validator
+ * combination it contains: `stringify` (no validation), `is`, `assert`,
+ * `validate`, or `validate.log`. `get_path_and_querify` turns a failing
+ * validation into a 500 response, except `validate.log`, which logs the failure
+ * and answers with the plain conversion of the data into `URLSearchParams`.
+ *
+ * @evidence contracts/common.md#principled-implementation The union is discriminated by the literal `type`, so the runtime selects the serializer with one comparison; the transform combines its URLSearchParams encoder with assert, is or validate checks as selected, while stringify performs encoding alone and validate.log reports failures before fallback encoding.
+ * @evidence contracts/common.md#clear-and-simple-design Five variants describe plain encoding and the three validation callback shapes, with validate.log sharing the validate shape but selecting a different failure policy.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior; the runtime rejects an unknown `type` with an error instead of accepting it.
+ * @evidence contracts/common.md#meaningful-documentation The comment names the decorators that receive the serializer and the response each variant produces on a failed validation.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+ */
 export type IResponseBodyQuerifier<T> =
   | IResponseBodyquerifier.IStringify<T>
   | IResponseBodyquerifier.IIs<T>
   | IResponseBodyquerifier.IAssert<T>
   | IResponseBodyquerifier.IValidate<T>
   | IResponseBodyquerifier.IValidateLog<T>;
+/**
+ * The variant records of {@link IResponseBodyQuerifier}.
+ *
+ * The lowercase q is the spelling of the exported namespace name, which
+ * existing code may reference.
+ *
+ * @evidence contracts/common.md#principled-implementation The namespace declares the five variant records that IResponseBodyQuerifier combines, so the union and its variants are one public family.
+ * @evidence contracts/common.md#clear-and-simple-design Five records with no runtime members.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It contains types only; the spelling is kept because renaming an exported identifier is a breaking change.
+ * @evidence contracts/common.md#meaningful-documentation The comment states what the namespace holds and why its name has a lowercase q.
+ * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+ */
 export namespace IResponseBodyquerifier {
+  /**
+   * Generated URLSearchParams encoder without validation.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function that serializes the data as it is, so a value of the wrong type is serialized as far as its shape allows without this variant performing validation.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment identifies how validation and URLSearchParams encoding are combined.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+   */
   export interface IStringify<T> {
     type: "stringify";
+    /**
+     * The generated function of the variant, taking the response data.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the return type of the route method, and the runtime uses the result as the response body as it is.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the return type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+     */
     stringify: (input: T) => URLSearchParams;
   }
+  /**
+   * Generated URLSearchParams encoder guarded by a typia is check.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function that returns the encoded URLSearchParams, or `null` when the data is not of the type; `null` becomes a 500 `InternalServerErrorException` with a fixed message.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment identifies how validation and URLSearchParams encoding are combined.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+   */
   export interface IIs<T> {
     type: "is";
+    /**
+     * The generated function of the variant, taking the response data.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the return type of the route method, and it returns the serialized text or `null`.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the return type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+     */
     is: (input: T) => URLSearchParams | null;
   }
+  /**
+   * Generated URLSearchParams encoder preceded by a typia assertion.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function that returns the serialized text or throws the `TypeGuardError` of typia, which becomes a 500 `InternalServerErrorException` with the path, reason, expected type, and value.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment identifies how validation and URLSearchParams encoding are combined.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+   */
   export interface IAssert<T> {
     type: "assert";
+    /**
+     * The generated function of the variant, taking the response data.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the return type of the route method, and it returns the encoded URLSearchParams or throws.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the return type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+     */
     assert: (input: T) => URLSearchParams;
   }
+  /**
+   * Generated URLSearchParams encoder wrapped in a typia validation result.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags a function that returns IValidation<URLSearchParams>; a failure becomes a 500 `InternalServerErrorException` carrying every error.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment identifies how validation and URLSearchParams encoding are combined.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+   */
   export interface IValidate<T> {
     type: "validate";
+    /**
+     * The generated function of the variant, taking the response data.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the return type of the route method, and it returns the validation result.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the return type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+     */
     validate: (input: T) => IValidation<URLSearchParams>;
   }
+  /**
+   * Generated validation and URLSearchParams encoding for the `validate.log`
+   * mode.
+   *
+   * @evidence contracts/common.md#principled-implementation The variant tags the same function shape as `validate`, but a failure is passed to the logger registered with `TypedRoute.setValidateErrorLogger` and the response is the plain conversion of the data into `URLSearchParams`, so a validation failure never changes the status.
+   * @evidence contracts/common.md#clear-and-simple-design A two-member record, the tag and the function.
+   * @evidence contracts/common.md#prohibited-implementation-shortcuts It is a type and adds no runtime behavior.
+   * @evidence contracts/common.md#meaningful-documentation The comment identifies how validation and URLSearchParams encoding are combined.
+   * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+   */
   export interface IValidateLog<T> {
     type: "validate.log";
+    /**
+     * The generated function of the variant, taking the response data.
+     *
+     * @evidence contracts/common.md#principled-implementation The transform generates the function for the return type of the route method, and it returns the validation result.
+     * @evidence contracts/common.md#clear-and-simple-design One function member.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The function is generated from the type, and the runtime never edits its result.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the function is generated for the return type; its result is in the signature.
+     * @evidenceExclude contracts/portability.md#os-neutral-implementation The variants describe conversion of JavaScript response values to HTTP query text without native file access.
+     */
     validate: (input: T) => IValidation<URLSearchParams>;
   }
 }