next-openapi-gen 0.7.2 → 0.7.4

package/README.md

@@ -60,6 +60,7 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
   "schemaDir": "src/types", // or "src/schemas" for Zod schemas
   "schemaType": "zod", // or "typescript" for TypeScript types
   "outputFile": "openapi.json",
+  "outputDir": "./public",
   "docsUrl": "/api-docs",
   "includeOpenApiRoutes": false,
   "debug": false
@@ -68,18 +69,19 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
 
 ### Configuration Options
 
-| Option                 | Description                                      |
-| ---------------------- | ------------------------------------------------ |
-| `apiDir`               | Path to the API directory                        |
-| `schemaDir`            | Path to the types/schemas directory              |
-| `schemaType`           | Schema type: `"zod"` or `"typescript"`           |
-| `outputFile`           | Path to the OpenAPI output file                  |
-| `docsUrl`              | API documentation URL (for Swagger UI)           |
-| `includeOpenApiRoutes` | Whether to include only routes with @openapi tag |
-| `defaultResponseSet`   | Default error response set for all endpoints     |
-| `responseSets`         | Named sets of error response codes               |
-| `errorConfig`          | Error schema configuration                       |
-| `debug`                | Enable detailed logging during generation        |
+| Option                 | Description                                                            |
+| ---------------------- | ---------------------------------------------------------------------- |
+| `apiDir`               | Path to the API directory                                              |
+| `schemaDir`            | Path to the types/schemas directory                                    |
+| `schemaType`           | Schema type: `"zod"` or `"typescript"`                                 |
+| `outputFile`           | Name of the OpenAPI output file                                        |
+| `outputDir`            | Directory where OpenAPI file will be generated (default: `"./public"`) |
+| `docsUrl`              | API documentation URL (for Swagger UI)                                 |
+| `includeOpenApiRoutes` | Whether to include only routes with @openapi tag                       |
+| `defaultResponseSet`   | Default error response set for all endpoints                           |
+| `responseSets`         | Named sets of error response codes                                     |
+| `errorConfig`          | Error schema configuration                                             |
+| `debug`                | Enable detailed logging during generation                              |
 
 ## Documenting Your API
 
@@ -192,7 +194,7 @@ This command will generate OpenAPI documentation based on your API code:
 
 - Scan API directories for routes
 - Analyze types/schemas
-- Generate OpenAPI file (`openapi.json`) in `public` folder
+- Generate OpenAPI file (`openapi.json`) in specified output directory (default: `public` folder)
 - Create Scalar/Swagger UI endpoint and page (if enabled)
 
 ### 3. View API Documentation

package/dist/commands/generate.js

@@ -10,8 +10,8 @@ export async function generate() {
     // Create api dir if not exists
     const apiDir = path.resolve(config.apiDir);
     await fse.ensureDir(apiDir);
-    // Create public dir if not exists
-    const outputDir = path.resolve("./public");
+    // Use user-defined output directory
+    const outputDir = path.resolve(config.outputDir);
     await fse.ensureDir(outputDir);
     const apiDocs = generator.generate();
     // Write api docs

package/dist/lib/openapi-generator.js

@@ -17,13 +17,14 @@ export class OpenApiGenerator {
     }
     getConfig() {
         // @ts-ignore
-        const { apiDir, schemaDir, docsUrl, ui, outputFile, includeOpenApiRoutes, schemaType = "typescript", defaultResponseSet, responseSets, errorConfig, debug } = this.template;
+        const { apiDir, schemaDir, docsUrl, ui, outputFile, outputDir, includeOpenApiRoutes, schemaType = "typescript", defaultResponseSet, responseSets, errorConfig, debug } = this.template;
         return {
             apiDir,
             schemaDir,
             docsUrl,
             ui,
             outputFile,
+            outputDir,
             includeOpenApiRoutes,
             schemaType,
             defaultResponseSet,

package/dist/lib/route-processor.js

@@ -2,9 +2,8 @@ import * as t from "@babel/types";
 import fs from "fs";
 import path from "path";
 import traverse from "@babel/traverse";
-import { parse } from "@babel/parser";
 import { SchemaProcessor } from "./schema-processor.js";
-import { capitalize, extractJSDocComments, extractPathParameters, getOperationId, } from "./utils.js";
+import { capitalize, extractJSDocComments, parseTypeScriptFile, extractPathParameters, getOperationId, } from "./utils.js";
 import { logger } from "./logger.js";
 const HTTP_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE"];
 const MUTATION_HTTP_METHODS = ["PATCH", "POST", "PUT"];
@@ -118,10 +117,7 @@ export class RouteProcessor {
         if (this.processFileTracker[filePath])
             return;
         const content = fs.readFileSync(filePath, "utf-8");
-        const ast = parse(content, {
-            sourceType: "module",
-            plugins: ["typescript", "decorators-legacy"],
-        });
+        const ast = parseTypeScriptFile(content);
         traverse.default(ast, {
             ExportNamedDeclaration: (path) => {
                 const declaration = path.node.declaration;

package/dist/lib/schema-processor.js

@@ -1,8 +1,8 @@
 import fs from "fs";
 import path from "path";
-import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 import * as t from "@babel/types";
+import { parseTypeScriptFile } from "./utils.js";
 import { ZodSchemaConverter } from "./zod-converter.js";
 import { logger } from "./logger.js";
 export class SchemaProcessor {
@@ -167,10 +167,14 @@ export class SchemaProcessor {
                 const enumValues = this.processEnum(typeNode);
                 return enumValues;
             }
-            if (t.isTSTypeLiteral(typeNode) || t.isTSInterfaceBody(typeNode) || t.isTSInterfaceDeclaration(typeNode)) {
+            if (t.isTSTypeLiteral(typeNode) ||
+                t.isTSInterfaceBody(typeNode) ||
+                t.isTSInterfaceDeclaration(typeNode)) {
                 const properties = {};
                 // Handle interface extends clause
-                if (t.isTSInterfaceDeclaration(typeNode) && typeNode.extends && typeNode.extends.length > 0) {
+                if (t.isTSInterfaceDeclaration(typeNode) &&
+                    typeNode.extends &&
+                    typeNode.extends.length > 0) {
                     typeNode.extends.forEach((extendedType) => {
                         const extendedSchema = this.resolveTSNodeType(extendedType);
                         if (extendedSchema.properties) {
@@ -179,7 +183,9 @@ export class SchemaProcessor {
                     });
                 }
                 // Get members from interface declaration body or direct members
-                const members = t.isTSInterfaceDeclaration(typeNode) ? typeNode.body.body : typeNode.members;
+                const members = t.isTSInterfaceDeclaration(typeNode)
+                    ? typeNode.body.body
+                    : typeNode.members;
                 if (members) {
                     (members || []).forEach((member) => {
                         if (t.isTSPropertySignature(member) && t.isIdentifier(member.key)) {
@@ -270,9 +276,9 @@ export class SchemaProcessor {
             if (t.isIdentifier(node.expression)) {
                 // Convert to TSTypeReference-like structure for processing
                 const syntheticNode = {
-                    type: 'TSTypeReference',
+                    type: "TSTypeReference",
                     typeName: node.expression,
-                    typeParameters: node.typeParameters
+                    typeParameters: node.typeParameters,
                 };
                 return this.resolveTSNodeType(syntheticNode);
             }
@@ -322,13 +328,14 @@ export class SchemaProcessor {
                         const properties = {};
                         const keyNames = this.extractKeysFromLiteralType(keysParam);
                         if (typeName === "Pick") {
-                            keyNames.forEach(key => {
+                            keyNames.forEach((key) => {
                                 if (baseType.properties[key]) {
                                     properties[key] = baseType.properties[key];
                                 }
                             });
                         }
-                        else { // Omit
+                        else {
+                            // Omit
                             Object.entries(baseType.properties).forEach(([key, value]) => {
                                 if (!keyNames.includes(key)) {
                                     properties[key] = value;
@@ -460,10 +467,7 @@ export class SchemaProcessor {
         try {
             // Recognizes different elements of TS like variable, type, interface, enum
             const content = fs.readFileSync(filePath, "utf-8");
-            const ast = parse(content, {
-                sourceType: "module",
-                plugins: ["typescript", "decorators-legacy"],
-            });
+            const ast = parseTypeScriptFile(content);
             this.collectTypeDefinitions(ast, schemaName);
             // Reset the set of processed types before each schema processing
             this.processingTypes.clear();

package/dist/lib/utils.js

@@ -1,3 +1,4 @@
+import { parse } from "@babel/parser";
 export function capitalize(string) {
     return string.charAt(0).toUpperCase() + string.slice(1);
 }
@@ -208,3 +209,22 @@ export function getOperationId(routePath, method) {
     const operation = routePath.replaceAll(/\//g, "-").replace(/^-/, "");
     return `${method}-${operation}`;
 }
+/**
+ * Common Babel parser configuration for TypeScript files with JSX support
+ */
+const DEFAULT_PARSER_OPTIONS = {
+    sourceType: "module",
+    plugins: ["typescript", "jsx", "decorators-legacy"],
+};
+/**
+ * Parse TypeScript/TSX file content with the standard configuration
+ * @param content - File content to parse
+ * @param options - Optional parser options to override defaults
+ * @returns Parsed AST
+ */
+export function parseTypeScriptFile(content, options) {
+    return parse(content, {
+        ...DEFAULT_PARSER_OPTIONS,
+        ...options,
+    });
+}

package/dist/lib/zod-converter.js

@@ -1,8 +1,8 @@
 import fs from "fs";
 import path from "path";
-import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 import * as t from "@babel/types";
+import { parseTypeScriptFile } from "./utils.js";
 import { logger } from "./logger.js";
 /**
  * Class for converting Zod schemas to OpenAPI specifications
@@ -146,10 +146,7 @@ export class ZodSchemaConverter {
                 return;
             }
             // Parse the file
-            const ast = parse(content, {
-                sourceType: "module",
-                plugins: ["typescript", "decorators-legacy"],
-            });
+            const ast = parseTypeScriptFile(content);
             // Create a map to store imported modules
             const importedModules = {};
             // Look for all exported Zod schemas
@@ -459,10 +456,7 @@ export class ZodSchemaConverter {
     processAllSchemasInFile(filePath) {
         try {
             const content = fs.readFileSync(filePath, "utf-8");
-            const ast = parse(content, {
-                sourceType: "module",
-                plugins: ["typescript", "decorators-legacy"],
-            });
+            const ast = parseTypeScriptFile(content);
             traverse.default(ast, {
                 ExportNamedDeclaration: (path) => {
                     if (t.isVariableDeclaration(path.node.declaration)) {
@@ -1343,10 +1337,7 @@ export class ZodSchemaConverter {
     scanFileForTypeMappings(filePath) {
         try {
             const content = fs.readFileSync(filePath, "utf-8");
-            const ast = parse(content, {
-                sourceType: "module",
-                plugins: ["typescript", "decorators-legacy"],
-            });
+            const ast = parseTypeScriptFile(content);
             traverse.default(ast, {
                 TSTypeAliasDeclaration: (path) => {
                     if (t.isIdentifier(path.node.id)) {
@@ -1413,10 +1404,7 @@ export class ZodSchemaConverter {
     preprocessAllSchemasInFile(filePath) {
         try {
             const content = fs.readFileSync(filePath, "utf-8");
-            const ast = parse(content, {
-                sourceType: "module",
-                plugins: ["typescript", "decorators-legacy"],
-            });
+            const ast = parseTypeScriptFile(content);
             // Collect all exported Zod schemas
             traverse.default(ast, {
                 ExportNamedDeclaration: (path) => {

package/dist/openapi-template.js

@@ -91,6 +91,7 @@ export default {
     docsUrl: "api-docs",
     ui: "scalar",
     outputFile: "openapi.json",
+    outputDir: "./public",
     includeOpenApiRoutes: false,
     debug: false,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "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",
@@ -42,15 +42,15 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@babel/parser": "^7.25.7",
-    "@babel/traverse": "^7.25.7",
-    "@babel/types": "^7.25.7",
-    "commander": "^12.1.0",
-    "fs-extra": "^10.0.0",
-    "ora": "^8.1.0"
+    "@babel/parser": "^7.28.3",
+    "@babel/traverse": "^7.28.3",
+    "@babel/types": "^7.28.2",
+    "commander": "^14.0.0",
+    "fs-extra": "^11.3.1",
+    "ora": "^8.2.0"
   },
   "devDependencies": {
-    "@types/node": "^22.7.4",
-    "typescript": "^4.5.4"
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2"
   }
 }