fix: wrap response validation errors when using joi (#323)

previously `joi` threw the raw `joi` errors when response validation
failed, unlike `zod` validation which wrapped them in a
`KoaRuntimeError`

this change aligns the behavior to match `zod` schema builder

also fixes a few documentation typos

Author: mnahkies

packages/typescript-koa-runtime/src/joi.ts

@@ -1,7 +1,7 @@
 import type {Schema as JoiSchema} from "joi"
 import {KoaRuntimeError, type RequestInputType} from "./errors"
 
-/** @deprecated: update & re-generate to import from @nahkies/typescript-koa-runtime/server directly */
+/** @deprecated: update and re-generate to import from @nahkies/typescript-koa-runtime/server directly */
 export type {Params} from "./server"
 
 // Note: joi types don't appear to have an equivalent of z.infer,
@@ -48,32 +48,36 @@ export function responseValidationFactory(
   possibleResponses.sort((x, y) => (x[0] < y[0] ? -1 : 1))
 
   return (status: number, value: unknown) => {
-    for (const [match, schema] of possibleResponses) {
-      const isMatch =
-        (/^\d+$/.test(match) && String(status) === match) ||
-        (/^\d[xX]{2}$/.test(match) && String(status)[0] === match[0])
+    try {
+      for (const [match, schema] of possibleResponses) {
+        const isMatch =
+          (/^\d+$/.test(match) && String(status) === match) ||
+          (/^\d[xX]{2}$/.test(match) && String(status)[0] === match[0])
 
-      if (isMatch) {
-        const result = schema.validate(value)
+        if (isMatch) {
+          const result = schema.validate(value)
+
+          if (result.error) {
+            throw result.error
+          }
+
+          return result.value
+        }
+      }
+
+      if (defaultResponse) {
+        const result = defaultResponse.validate(value)
 
         if (result.error) {
           throw result.error
         }
 
         return result.value
       }
-    }
-
-    if (defaultResponse) {
-      const result = defaultResponse.validate(value)
 
-      if (result.error) {
-        throw result.error
-      }
-
-      return result.value
+      return value
+    } catch (err) {
+      throw KoaRuntimeError.ResponseError(err)
     }
-
-    return value
   }
 }

packages/typescript-koa-runtime/src/server.ts

@@ -68,14 +68,14 @@ export type ServerConfig = {
   /**
    * set to "disabled" to disable body parsing middleware, omit or pass undefined for defaults.
    *
-   * if disabling, ensure you pass a body parsing middlware that places the parsed
+   * if disabling, ensure you pass a body parsing middleware that places the parsed
    * body on `ctx.body` for request body processing to work.
    **/
   body?: "disabled" | KoaBodyMiddlewareOptions | undefined
 
   /**
    *
-   * useful for mounting logging, alternative body parsers, etc
+   * useful for mounting logging, alternative body parsers, etc.
    */
   middleware?: Middleware[]
 
@@ -105,7 +105,7 @@ export type Params<Params, Query, Body, Header> = {
  * Enables CORS and body parsing by default. It's recommended to customize the CORS options
  * for production usage.
  *
- * If you need more control over your Koa server you should avoid calling this function,
+ * If you need more control over your Koa server, you should avoid calling this function
  * and instead mount the router from your generated codes `createRouter` call directly
  * onto a server you have constructed.
  */

packages/typescript-koa-runtime/src/zod.ts

@@ -1,7 +1,7 @@
 import type {z} from "zod"
 import {KoaRuntimeError, type RequestInputType} from "./errors"
 
-/** @deprecated: update & re-generate to import from @nahkies/typescript-koa-runtime/server directly */
+/** @deprecated: update and re-generate to import from @nahkies/typescript-koa-runtime/server directly */
 export type {Params} from "./server"
 
 export function parseRequestInput<Schema extends z.ZodTypeAny>(