next-openapi-gen 0.4.4 → 0.4.6

package/README.md

@@ -9,7 +9,7 @@ Automatically generate OpenAPI 3.0 documentation from Next.js projects, with sup
 - ✅ TypeScript types support
 - ✅ Zod schemas support
 - ✅ JSDoc comments support
-- ✅ Multiple UI interfaces: `Scalar`, `Swagger`, `Redoc`, `Stoplight` and `Rapidoc` available at `/api-docs` url.
+- ✅ Multiple UI interfaces: `Scalar`, `Swagger`, `Redoc`, `Stoplight` and `Rapidoc` available at `/api-docs` url
 - ✅ Path parameters detection (`/users/{id}`)
 - ✅ Intelligent parameter examples
 - ✅ Intuitive CLI for initialization and documentation generation

package/dist/lib/route-processor.js

@@ -16,7 +16,7 @@ export class RouteProcessor {
     processFileTracker = {};
     constructor(config) {
         this.config = config;
-        this.schemaProcessor = new SchemaProcessor(config.schemaDir);
+        this.schemaProcessor = new SchemaProcessor(config.schemaDir, config.schemaType);
     }
     /**
      * Get the SchemaProcessor instance
@@ -50,7 +50,7 @@ export class RouteProcessor {
                             const routePath = this.getRoutePath(filePath);
                             const pathParams = extractPathParameters(routePath);
                             // If we have path parameters but no pathParamsType defined, we should log a warning
-                            if (pathParams.length > 0 && !dataTypes.pathParams) {
+                            if (pathParams.length > 0 && !dataTypes.pathParamsType) {
                                 console.warn(`Route ${routePath} contains path parameters ${pathParams.join(", ")} but no @pathParams type is defined.`);
                             }
                             this.addRouteToPaths(declaration.id.name, filePath, dataTypes);
@@ -67,7 +67,7 @@ export class RouteProcessor {
                                     (this.config.includeOpenApiRoutes && dataTypes.isOpenApi)) {
                                     const routePath = this.getRoutePath(filePath);
                                     const pathParams = extractPathParameters(routePath);
-                                    if (pathParams.length > 0 && !dataTypes.pathParams) {
+                                    if (pathParams.length > 0 && !dataTypes.pathParamsType) {
                                         console.warn(`Route ${routePath} contains path parameters ${pathParams.join(", ")} but no @pathParams type is defined.`);
                                     }
                                     this.addRouteToPaths(decl.id.name, filePath, dataTypes);

package/dist/lib/utils.js

@@ -18,10 +18,10 @@ export function extractJSDocComments(path) {
     const comments = path.node.leadingComments;
     let summary = "";
     let description = "";
-    let params = "";
-    let pathParams = "";
-    let body = "";
-    let response = "";
+    let paramsType = "";
+    let pathParamsType = "";
+    let bodyType = "";
+    let responseType = "";
     let auth = "";
     let isOpenApi = false;
     if (comments) {
@@ -51,16 +51,16 @@ export function extractJSDocComments(path) {
                 description = commentValue.match(regex)[1].trim();
             }
             if (commentValue.includes("@params")) {
-                params = extractTypeFromComment(commentValue, "@params");
+                paramsType = extractTypeFromComment(commentValue, "@params");
             }
             if (commentValue.includes("@pathParams")) {
-                pathParams = extractTypeFromComment(commentValue, "@pathParams");
+                pathParamsType = extractTypeFromComment(commentValue, "@pathParams");
             }
             if (commentValue.includes("@body")) {
-                body = extractTypeFromComment(commentValue, "@body");
+                bodyType = extractTypeFromComment(commentValue, "@body");
             }
             if (commentValue.includes("@response")) {
-                response = extractTypeFromComment(commentValue, "@response");
+                responseType = extractTypeFromComment(commentValue, "@response");
             }
         });
     }
@@ -68,10 +68,10 @@ export function extractJSDocComments(path) {
         auth,
         summary,
         description,
-        params,
-        pathParams,
-        body,
-        response,
+        paramsType,
+        pathParamsType,
+        bodyType,
+        responseType,
         isOpenApi,
     };
 }

package/package.json

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