add a hint to error handling for path-params

Author: omermecitoglu

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@omer-x/next-openapi-route-handler",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "a Next.js plugin to generate OpenAPI documentation from route handlers",
   "keywords": [
     "next.js",

package.json

@@ -2,7 +2,8 @@ import { safeParse } from "./zod-error-handler";
 import type { ZodError, ZodType, ZodTypeDef } from "zod";
 
 export default function parsePathParams<I, O>(source?: I, schema?: ZodType<O, ZodTypeDef, I>) {
-  if (!schema || !source) return null;
+  if (!schema) return null;
+  if (!source) throw new Error("UNNECESSARY_PATH_PARAMS");
   try {
     return safeParse(schema, source as Record<string, unknown>);
   } catch (error) {

src/core/path-params.ts

@@ -63,6 +63,15 @@ function createRoute<M extends HttpMethod, PPI, PPO, QPI, QPO, RBI, RBO>(input:
             return new Response(null, { status: 400 });
           case "PARSE_PATH_PARAMS":
             return new Response(null, { status: 404 });
+          case "UNNECESSARY_PATH_PARAMS": {
+            if (process.env.NODE_ENV !== "production") {
+              console.log([
+                "[Next OpenAPI Route Handler]",
+                "You tried to add pathParams to a route which doesn't have any dynamic params.",
+                "Maybe you meant queryParams instead?",
+              ].join(" "));
+            }
+          }
         }
       }
       return new Response(null, { status: 500 });