feat: add methodNotAllowedHandler to remove downstream boilerplate

examples/complete/package.json

@@ -3,8 +3,8 @@
     "type": "module",
     "dependencies": {
         "@js-joda/core": "^5.6.1",
-        "@mikro-orm/core": "^6.1.0",
-        "@mikro-orm/sqlite": "^6.1.0",
+        "@mikro-orm/core": "^6.1.7",
+        "@mikro-orm/sqlite": "^6.1.7",
         "flat": "^6.0.1",
         "http-errors": "^2.0.0",
         "koa": "^2.15.0",
@@ -16,9 +16,9 @@
     },
     "devDependencies": {
         "@types/http-errors": "^2.0.4",
-        "@types/koa": "^2.14.0",
+        "@types/koa": "^2.15.0",
         "@types/koa-bodyparser": "^4.3.12",
-        "tsx": "^4.7.0",
+        "tsx": "^4.7.1",
         "typescript": "^5.3.3"
     },
     "scripts": {

examples/complete/src/index.ts

@@ -1,22 +1,17 @@
 import Koa from "koa";
 import bodyParser from "koa-bodyparser";
 import {
-    JsonApiErrorBody,
     jsonApiErrorMiddleware,
     jsonApiRequestMiddleware,
+    methodNotAllowedHandler,
 } from "koa-jsonapi-zod";
 import Router from "koa-tree-router";
 import { registerRoutes } from "./route/index.js";
 import { requestContextMiddleware } from "./util/mikro-orm.js";
 
 const app = new Koa();
 
-app.use(
-    jsonApiRequestMiddleware({
-        excludedPaths: ["/health"],
-    }),
-);
-
+app.use(jsonApiRequestMiddleware());
 app.use(
     jsonApiErrorMiddleware({
         logError: (error, exposed) => {
@@ -27,10 +22,8 @@ app.use(
         },
     }),
 );
-
 app.use(bodyParser());
 
-// This is a non-resource endpoint, hence it was excluded from the `jsonApiMiddleware`
 app.use(async (context, next) => {
     if (context.url === "/health") {
         context.body = { status: "alive" };
@@ -40,30 +33,9 @@ app.use(async (context, next) => {
     return next();
 });
 
-const router = new Router({
-    onMethodNotAllowed: (context) => {
-        if (context.response.headers.allow === "") {
-            context.remove("allow");
-            context.status = 404;
-            context.body = new JsonApiErrorBody({
-                status: "404",
-                code: "not_found",
-                title: "Resource not found",
-            });
-            return;
-        }
-
-        context.status = 405;
-        context.body = new JsonApiErrorBody({
-            status: "405",
-            code: "method_not_allowed",
-            title: "Method not allowed",
-            detail: `Allowed methods: ${context.response.headers.allow}`,
-        });
-    },
-});
-
+const router = new Router({ onMethodNotAllowed: methodNotAllowedHandler });
 registerRoutes(router);
+
 app.use(requestContextMiddleware);
 app.use(router.routes());
 

package.json

@@ -44,7 +44,7 @@
     "@tsconfig/node20": "^20.1.2",
     "@types/content-type": "^1.1.8",
     "@types/http-errors": "^2.0.4",
-    "@types/koa": "^2.14.0",
+    "@types/koa": "^2.15.0",
     "@types/node": "^20.11.17",
     "@types/qs": "^6.9.11",
     "@vitest/coverage-v8": "^1.2.2",