next-openapi-gen 0.9.0 → 0.9.2

package/README.md

@@ -213,7 +213,7 @@ export async function POST(request: NextRequest) {
 | `@description`         | Endpoint description                                                                                                     |
 | `@operationId`         | Custom operation ID (overrides auto-generated ID)                                                                        |
 | `@pathParams`          | Path parameters type/schema                                                                                              |
-| `@params`              | Query parameters type/schema                                                                                             |
+| `@params`              | Query parameters type/schema (use `@queryParams` if you have prettier-plugin-jsdoc conflicts)                           |
 | `@body`                | Request body type/schema                                                                                                 |
 | `@bodyDescription`     | Request body description                                                                                                 |
 | `@response`            | Response type/schema with optional code and description (`User`, `201:User`, `User:Description`, `201:User:Description`) |

package/dist/lib/route-processor.js

@@ -336,29 +336,34 @@ export class RouteProcessor {
     getRoutePath(filePath) {
         // Normalize path separators first
         const normalizedPath = filePath.replaceAll("\\", "/");
-        // First, check if it's an app router path
-        if (normalizedPath.includes("/app/api/")) {
-            // Get the relative path from the api directory
-            const apiDirPos = normalizedPath.lastIndexOf("/app/api/");
-            let relativePath = normalizedPath.substring(apiDirPos + "/app/api".length);
-            // Remove the /route.ts or /route.tsx suffix
-            relativePath = relativePath.replace(/\/route\.tsx?$/, "");
-            // Remove Next.js route groups (folders in parentheses like (authenticated), (marketing))
-            relativePath = relativePath.replace(/\/\([^)]+\)/g, "");
-            // Convert Next.js dynamic route syntax to OpenAPI parameter syntax
-            relativePath = relativePath.replace(/\/\[([^\]]+)\]/g, "/{$1}");
-            // Handle catch-all routes ([...param])
-            relativePath = relativePath.replace(/\/\[\.\.\.(.*)\]/g, "/{$1}");
-            return relativePath;
+        // Normalize apiDir to ensure consistent format
+        const normalizedApiDir = this.config.apiDir
+            .replaceAll("\\", "/")
+            .replace(/^\.\//, "")
+            .replace(/\/$/, "");
+        // Find the apiDir position in the normalized path
+        const apiDirIndex = normalizedPath.indexOf(normalizedApiDir);
+        if (apiDirIndex === -1) {
+            throw new Error(`Could not find apiDir "${this.config.apiDir}" in file path "${filePath}"`);
         }
-        // For pages router or other formats
-        const suffixPath = normalizedPath.split("api")[1];
-        return suffixPath
-            .replace(/route\.tsx?$/, "")
-            .replace(/\/$/, "")
-            .replace(/\/\([^)]+\)/g, "") // Remove route groups for pages router too
-            .replace(/\/\[([^\]]+)\]/g, "/{$1}") // Replace [param] with {param}
-            .replace(/\/\[\.\.\.(.*)\]/g, "/{$1}"); // Replace [...param] with {param}
+        // Extract the path after apiDir
+        let relativePath = normalizedPath.substring(apiDirIndex + normalizedApiDir.length);
+        // Remove the /route.ts or /route.tsx suffix
+        relativePath = relativePath.replace(/\/route\.tsx?$/, "");
+        // Ensure the path starts with /
+        if (!relativePath.startsWith("/")) {
+            relativePath = "/" + relativePath;
+        }
+        // Remove trailing slash
+        relativePath = relativePath.replace(/\/$/, "");
+        // Remove Next.js route groups (folders in parentheses like (authenticated), (marketing))
+        relativePath = relativePath.replace(/\/\([^)]+\)/g, "");
+        // Handle catch-all routes ([...param]) before converting dynamic routes
+        // This must come first because [...param] would also match the [param] pattern
+        relativePath = relativePath.replace(/\/\[\.\.\.(.*?)\]/g, "/{$1}");
+        // Convert Next.js dynamic route syntax to OpenAPI parameter syntax
+        relativePath = relativePath.replace(/\/\[([^\]]+)\]/g, "/{$1}");
+        return relativePath || "/";
     }
     getSortedPaths(paths) {
         function comparePaths(a, b) {

package/dist/lib/utils.js

@@ -85,8 +85,9 @@ export function extractJSDocComments(path) {
                     tag = match[1].trim();
                 }
             }
-            if (commentValue.includes("@params")) {
-                paramsType = extractTypeFromComment(commentValue, "@params");
+            if (commentValue.includes("@params") || commentValue.includes("@queryParams")) {
+                paramsType = extractTypeFromComment(commentValue, "@queryParams") ||
+                    extractTypeFromComment(commentValue, "@params");
             }
             if (commentValue.includes("@pathParams")) {
                 pathParamsType = extractTypeFromComment(commentValue, "@pathParams");
@@ -169,8 +170,9 @@ export function extractJSDocComments(path) {
 }
 export function extractTypeFromComment(commentValue, tag) {
     // Updated regex to support generic types with angle brackets and array brackets
+    // Use multiline mode (m flag) to match tag at start of line (after optional * from JSDoc)
     return (commentValue
-        .match(new RegExp(`${tag}\\s*\\s*([\\w<>,\\s\\[\\]]+)`))?.[1]
+        .match(new RegExp(`^\\s*\\*?\\s*${tag}\\s+([\\w<>,\\s\\[\\]]+)`, 'm'))?.[1]
         ?.trim() || "");
 }
 export function cleanComment(commentValue) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Automatically generate OpenAPI 3.0 documentation from Next.js projects, with support for Zod schemas and TypeScript types.",
   "type": "module",
   "main": "dist/index.js",