next-openapi-gen 0.10.1 → 0.10.3

package/README.md

@@ -72,7 +72,7 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
   ],
   "apiDir": "src/app/api", // or "pages/api" for Pages Router
   "routerType": "app", // "app" (default) or "pages" for legacy Pages Router
-  "schemaDir": "src/types", // or "src/schemas" for Zod schemas
+  "schemaDir": "src/types", // or ["src/types", "src/schemas"] for multiple directories
   "schemaType": "zod", // or "typescript", or ["zod", "typescript"] for multiple
   "schemaFiles": [], // Optional: ["./schemas/models.yaml", "./schemas/api.json"]
   "outputFile": "openapi.json",
@@ -90,7 +90,7 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
 | ---------------------- | ----------------------------------------------------------------------------- |
 | `apiDir`               | Path to the API directory                                                     |
 | `routerType`           | Router type: `"app"` (default) or `"pages"` for legacy Pages Router           |
-| `schemaDir`            | Path to the types/schemas directory                                           |
+| `schemaDir`            | Path to types/schemas directory, or array of paths for multiple directories   |
 | `schemaType`           | Schema type: `"zod"`, `"typescript"`, or `["zod", "typescript"]` for multiple |
 | `schemaFiles`          | Optional: Array of custom OpenAPI schema files (YAML/JSON) to include         |
 | `outputFile`           | Name of the OpenAPI output file                                               |
@@ -210,25 +210,25 @@ export async function POST(request: NextRequest) {
 
 ## JSDoc Documentation Tags
 
-| Tag                    | Description                                                                                                              |
-| ---------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `@description`         | Endpoint description                                                                                                     |
-| `@operationId`         | Custom operation ID (overrides auto-generated ID)                                                                        |
-| `@pathParams`          | Path 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`) |
-| `@responseDescription` | Response description                                                                                                     |
-| `@responseSet`         | Override default response set (`public`, `auth`, `none`)                                                                 |
-| `@add`                 | Add custom response codes (`409:ConflictResponse`, `429`)                                                                |
-| `@contentType`         | Request body content type (`application/json`, `multipart/form-data`)                                                    |
-| `@auth`                | Authorization type (`bearer`, `basic`, `apikey`)                                                                         |
-| `@tag`                 | Custom tag                                                                                                               |
-| `@deprecated`          | Marks the route as deprecated                                                                                            |
-| `@openapi`             | Marks the route for inclusion in documentation (if includeOpenApiRoutes is enabled)                                      |
-| `@ignore`              | Excludes the route from OpenAPI documentation                                                                            |
-| `@method`              | HTTP method for Pages Router (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`) - required for Pages Router only                  |
+| Tag                    | Description                                                                                                                                          |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `@description`         | Endpoint description                                                                                                                                 |
+| `@operationId`         | Custom operation ID (overrides auto-generated ID)                                                                                                    |
+| `@pathParams`          | Path 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`)                             |
+| `@responseDescription` | Response description                                                                                                                                 |
+| `@responseSet`         | Override default response set (`public`, `auth`, `none`)                                                                                             |
+| `@add`                 | Add custom response codes (`409:ConflictResponse`, `429`)                                                                                            |
+| `@contentType`         | Request body content type (`application/json`, `multipart/form-data`)                                                                                |
+| `@auth`                | Authorization type (e.g., `bearer`, `basic`, `apikey`, or a custom type) — supports multiple auths using comma separator (e.g., `bearer, CustomType`) |
+| `@tag`                 | Custom tag                                                                                                                                           |
+| `@deprecated`          | Marks the route as deprecated                                                                                                                        |
+| `@openapi`             | Marks the route for inclusion in documentation (if includeOpenApiRoutes is enabled)                                                                  |
+| `@ignore`              | Excludes the route from OpenAPI documentation                                                                                                        |
+| `@method`              | HTTP method for Pages Router (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`) - required for Pages Router only                                              |
 
 ## Pages Router Support 🆕
 

package/dist/lib/pages-router-strategy.js

@@ -2,7 +2,7 @@ import fs from "fs";
 import traverseModule from "@babel/traverse";
 const traverse = traverseModule.default || traverseModule;
 import { HTTP_METHODS } from "./router-strategy.js";
-import { parseTypeScriptFile } from "./utils.js";
+import { parseTypeScriptFile, performAuthPresetReplacements } from "./utils.js";
 export class PagesRouterStrategy {
     config;
     constructor(config) {
@@ -169,6 +169,8 @@ export class PagesRouterStrategy {
                 case "apikey":
                     auth = "ApiKeyAuth";
                     break;
+                default:
+                    auth = performAuthPresetReplacements(authValue);
             }
         }
         return {

package/dist/lib/route-processor.js

@@ -250,11 +250,10 @@ export class RouteProcessor {
         }
         // Add auth
         if (auth) {
-            definition.security = [
-                {
-                    [auth]: [],
-                },
-            ];
+            const authItems = auth.split(",").map(item => item.trim());
+            definition.security = authItems.map(authItem => ({
+                [authItem]: [],
+            }));
         }
         if (params) {
             definition.parameters =

package/dist/lib/schema-processor.js

@@ -14,8 +14,14 @@ import { logger } from "./logger.js";
 function normalizeSchemaTypes(schemaType) {
     return Array.isArray(schemaType) ? schemaType : [schemaType];
 }
+/**
+ * Normalize schemaDir to array
+ */
+function normalizeSchemaDirs(schemaDir) {
+    return Array.isArray(schemaDir) ? schemaDir : [schemaDir];
+}
 export class SchemaProcessor {
-    schemaDir;
+    schemaDirs;
     typeDefinitions = {};
     openapiDefinitions = {};
     contentType = "";
@@ -31,7 +37,7 @@ export class SchemaProcessor {
     importMap = {}; // { filePath: { importName: importPath } }
     currentFilePath = ""; // Track the file being processed
     constructor(schemaDir, schemaType = "typescript", schemaFiles) {
-        this.schemaDir = path.resolve(schemaDir);
+        this.schemaDirs = normalizeSchemaDirs(schemaDir).map((d) => path.resolve(d));
         this.schemaTypes = normalizeSchemaTypes(schemaType);
         // Initialize Zod converter if Zod is enabled
         if (this.schemaTypes.includes("zod")) {
@@ -140,9 +146,18 @@ export class SchemaProcessor {
             logger.debug(`No Zod schema found for ${schemaName}, trying TypeScript fallback`);
         }
         // Fall back to TypeScript types
-        this.scanSchemaDir(this.schemaDir, schemaName);
+        this.scanAllSchemaDirs(schemaName);
         return this.openapiDefinitions[schemaName] || {};
     }
+    scanAllSchemaDirs(schemaName) {
+        for (const dir of this.schemaDirs) {
+            if (!fs.existsSync(dir)) {
+                logger.warn(`Schema directory not found: ${dir}`);
+                continue;
+            }
+            this.scanSchemaDir(dir, schemaName);
+        }
+    }
     scanSchemaDir(dir, schemaName) {
         let files = this.directoryCache[dir];
         if (typeof files === "undefined") {
@@ -1229,7 +1244,7 @@ export class SchemaProcessor {
         }
         const { baseTypeName, typeArguments } = parsed;
         // Find the base generic type definition
-        this.scanSchemaDir(this.schemaDir, baseTypeName);
+        this.scanAllSchemaDirs(baseTypeName);
         const genericDefEntry = this.typeDefinitions[baseTypeName];
         const genericTypeDefinition = genericDefEntry?.node || genericDefEntry;
         if (!genericTypeDefinition) {
@@ -1241,7 +1256,7 @@ export class SchemaProcessor {
             // If it's a simple type reference (not another generic), find its definition
             if (!argTypeName.includes("<") &&
                 !this.isGenericTypeParameter(argTypeName)) {
-                this.scanSchemaDir(this.schemaDir, argTypeName);
+                this.scanAllSchemaDirs(argTypeName);
             }
         });
         // Create AST nodes for the type arguments by parsing them

package/dist/lib/utils.js

@@ -73,6 +73,8 @@ export function extractJSDocComments(path) {
                     case "apikey":
                         auth = "ApiKeyAuth";
                         break;
+                    default:
+                        auth = performAuthPresetReplacements(value);
                 }
             }
             if (commentValue.includes("@description")) {
@@ -247,6 +249,16 @@ export function cleanSpec(spec) {
     }
     return newSpec;
 }
+const AUTH_PRESET_REPLACEMENTS = {
+    bearer: "BearerAuth",
+    basic: "BasicAuth",
+    apikey: "ApiKeyAuth",
+};
+export function performAuthPresetReplacements(authValue) {
+    const authParts = authValue.split(",").map((part) => part.trim());
+    const mappedParts = authParts.map((part) => AUTH_PRESET_REPLACEMENTS[part.toLowerCase()] || part);
+    return mappedParts.join(",");
+}
 export function getOperationId(routePath, method) {
     const operation = routePath.replaceAll(/\//g, "-").replace(/^-/, "");
     return `${method}-${operation}`;

package/dist/lib/zod-converter.js

@@ -11,7 +11,7 @@ import { DrizzleZodProcessor } from "./drizzle-zod-processor.js";
  * Class for converting Zod schemas to OpenAPI specifications
  */
 export class ZodSchemaConverter {
-    schemaDir;
+    schemaDirs;
     zodSchemas = {};
     processingSchemas = new Set();
     processedModules = new Set();
@@ -26,7 +26,8 @@ export class ZodSchemaConverter {
     currentAST;
     currentImports;
     constructor(schemaDir) {
-        this.schemaDir = path.resolve(schemaDir);
+        const dirs = Array.isArray(schemaDir) ? schemaDir : [schemaDir];
+        this.schemaDirs = dirs.map((d) => path.resolve(d));
     }
     /**
      * Find a Zod schema by name and convert it to OpenAPI spec
@@ -63,8 +64,12 @@ export class ZodSchemaConverter {
                     return this.zodSchemas[schemaName];
                 }
             }
-            // Scan schema directory
-            this.scanDirectoryForZodSchema(this.schemaDir, schemaName);
+            // Scan schema directories
+            for (const dir of this.schemaDirs) {
+                this.scanDirectoryForZodSchema(dir, schemaName);
+                if (this.zodSchemas[schemaName])
+                    break;
+            }
             // Return the schema if found, or null if not
             if (this.zodSchemas[schemaName]) {
                 logger.debug(`Found and processed Zod schema: ${schemaName}`);
@@ -1554,8 +1559,10 @@ export class ZodSchemaConverter {
         for (const routeFile of routeFiles) {
             this.scanFileForTypeMappings(routeFile);
         }
-        // Scan schema directory
-        this.scanDirectoryForTypeMappings(this.schemaDir);
+        // Scan schema directories
+        for (const dir of this.schemaDirs) {
+            this.scanDirectoryForTypeMappings(dir);
+        }
     }
     /**
      * Scan a single file for type mappings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.10.1",
+  "version": "0.10.3",
   "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",