next-openapi-gen 0.1.2 → 0.2.1

package/dist/lib/utils.js

@@ -1,83 +1,88 @@
-export function capitalize(string) {
-    return string.charAt(0).toUpperCase() + string.slice(1);
-}
-export function extractJSDocComments(path) {
-    const comments = path.node.leadingComments;
-    let summary = "";
-    let description = "";
-    let paramsType = "";
-    let bodyType = "";
-    let responseType = "";
-    let auth = "";
-    let isOpenApi = false;
-    if (comments) {
-        comments.forEach((comment) => {
-            const commentValue = cleanComment(comment.value);
-            isOpenApi = commentValue.includes("@openapi");
-            if (!summary) {
-                const summaryIndex = isOpenApi ? 1 : 0;
-                summary = commentValue.split("\n")[summaryIndex];
-            }
-            if (commentValue.includes("@auth")) {
-                const regex = /@auth:\s*(.*)/;
-                const value = commentValue.match(regex)[1].trim();
-                switch (value) {
-                    case "bearer":
-                        auth = "BearerAuth";
-                        break;
-                    case "basic":
-                        auth = "BasicAuth";
-                        break;
-                    case "apikey":
-                        auth = "ApiKeyAuth";
-                        break;
-                }
-            }
-            if (commentValue.includes("@desc")) {
-                const regex = /@desc:\s*(.*)/;
-                description = commentValue.match(regex)[1].trim();
-            }
-            if (commentValue.includes("@params")) {
-                paramsType = extractTypeFromComment(commentValue, "@params");
-            }
-            if (commentValue.includes("@body")) {
-                bodyType = extractTypeFromComment(commentValue, "@body");
-            }
-            if (commentValue.includes("@response")) {
-                responseType = extractTypeFromComment(commentValue, "@response");
-            }
-        });
-    }
-    return {
-        auth,
-        summary,
-        description,
-        paramsType,
-        bodyType,
-        responseType,
-        isOpenApi,
-    };
-}
-export function extractTypeFromComment(commentValue, tag) {
-    return commentValue.match(new RegExp(`${tag}\\s*:\\s*(\\w+)`))?.[1] || "";
-}
-export function cleanComment(commentValue) {
-    return commentValue.replace(/\*\s*/g, "").trim();
-}
-export function cleanSpec(spec) {
-    const propsToRemove = [
-        "apiDir",
-        "schemaDir",
-        "docsUrl",
-        "ui",
-        "outputFile",
-        "includeOpenApiRoutes",
-    ];
-    const newSpec = { ...spec };
-    propsToRemove.forEach((key) => delete newSpec[key]);
-    return newSpec;
-}
-export function getOperationId(routePath, method) {
-    const operation = routePath.replaceAll(/\//g, "-").replace(/^-/, "");
-    return `${method}-${operation}`;
-}
+export function capitalize(string) {
+    return string.charAt(0).toUpperCase() + string.slice(1);
+}
+export function extractJSDocComments(path) {
+    const comments = path.node.leadingComments;
+    let summary = "";
+    let description = "";
+    let paramsType = "";
+    let pathParamsType = "";
+    let bodyType = "";
+    let responseType = "";
+    let auth = "";
+    let isOpenApi = false;
+    if (comments) {
+        comments.forEach((comment) => {
+            const commentValue = cleanComment(comment.value);
+            isOpenApi = commentValue.includes("@openapi");
+            if (!summary) {
+                const summaryIndex = isOpenApi ? 1 : 0;
+                summary = commentValue.split("\n")[summaryIndex];
+            }
+            if (commentValue.includes("@auth")) {
+                const regex = /@auth:\s*(.*)/;
+                const value = commentValue.match(regex)[1].trim();
+                switch (value) {
+                    case "bearer":
+                        auth = "BearerAuth";
+                        break;
+                    case "basic":
+                        auth = "BasicAuth";
+                        break;
+                    case "apikey":
+                        auth = "ApiKeyAuth";
+                        break;
+                }
+            }
+            if (commentValue.includes("@desc")) {
+                const regex = /@desc:\s*(.*)/;
+                description = commentValue.match(regex)[1].trim();
+            }
+            if (commentValue.includes("@params")) {
+                paramsType = extractTypeFromComment(commentValue, "@params");
+            }
+            if (commentValue.includes("@pathParams")) {
+                pathParamsType = extractTypeFromComment(commentValue, "@pathParams");
+            }
+            if (commentValue.includes("@body")) {
+                bodyType = extractTypeFromComment(commentValue, "@body");
+            }
+            if (commentValue.includes("@response")) {
+                responseType = extractTypeFromComment(commentValue, "@response");
+            }
+        });
+    }
+    return {
+        auth,
+        summary,
+        description,
+        paramsType,
+        pathParamsType,
+        bodyType,
+        responseType,
+        isOpenApi,
+    };
+}
+export function extractTypeFromComment(commentValue, tag) {
+    return commentValue.match(new RegExp(`${tag}\\s*:\\s*(\\w+)`))?.[1] || "";
+}
+export function cleanComment(commentValue) {
+    return commentValue.replace(/\*\s*/g, "").trim();
+}
+export function cleanSpec(spec) {
+    const propsToRemove = [
+        "apiDir",
+        "schemaDir",
+        "docsUrl",
+        "ui",
+        "outputFile",
+        "includeOpenApiRoutes",
+    ];
+    const newSpec = { ...spec };
+    propsToRemove.forEach((key) => delete newSpec[key]);
+    return newSpec;
+}
+export function getOperationId(routePath, method) {
+    const operation = routePath.replaceAll(/\//g, "-").replace(/^-/, "");
+    return `${method}-${operation}`;
+}

package/dist/openapi-template.js

@@ -1,29 +1,29 @@
-export default {
-    openapi: "3.0.0",
-    info: {
-        title: "API Documentation",
-        version: "1.0.0",
-        description: "This is the OpenAPI specification for your project.",
-    },
-    servers: [
-        {
-            url: "http://localhost:3000/api",
-            description: "Local development server",
-        },
-    ],
-    components: {
-        securitySchemes: {
-            BearerAuth: {
-                type: "http",
-                scheme: "bearer",
-                bearerFormat: "JWT",
-            },
-        },
-    },
-    apiDir: "./src/app/api",
-    schemaDir: "./src",
-    docsUrl: "api-docs",
-    ui: "swagger",
-    outputFile: "swagger.json",
-    includeOpenApiRoutes: false,
-};
+export default {
+    openapi: "3.0.0",
+    info: {
+        title: "API Documentation",
+        version: "1.0.0",
+        description: "This is the OpenAPI specification for your project.",
+    },
+    servers: [
+        {
+            url: "http://localhost:3000/api",
+            description: "Local development server",
+        },
+    ],
+    components: {
+        securitySchemes: {
+            BearerAuth: {
+                type: "http",
+                scheme: "bearer",
+                bearerFormat: "JWT",
+            },
+        },
+    },
+    apiDir: "./src/app/api",
+    schemaDir: "./src",
+    docsUrl: "api-docs",
+    ui: "scalar",
+    outputFile: "openapi.json",
+    includeOpenApiRoutes: false,
+};

package/dist/types.js

@@ -1 +1 @@
-export {};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Super fast and easy way to generate OpenAPI documentation automatically from API routes in NextJS.",
   "type": "module",
   "main": "dist/index.js",
@@ -24,6 +24,7 @@
     "react",
     "nextjs",
     "openapi",
+    "scalar",
     "swagger",
     "docs",
     "api",