@omer-x/next-openapi-json-generator 1.1.1 → 1.2.0

package/dist/index.cjs

@@ -35,8 +35,39 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/core/generateOpenApiSpec.ts
+var import_node_path4 = __toESM(require("path"), 1);
 var import_package_metadata = __toESM(require("@omer-x/package-metadata"), 1);
 
+// src/utils/object.ts
+function omit(object, ...keys) {
+  return Object.fromEntries(Object.entries(object).filter(([key]) => !keys.includes(key)));
+}
+
+// src/core/clearUnusedSchemas.ts
+function countReferences(schemaName, source) {
+  return (source.match(new RegExp(`"#/components/schemas/${schemaName}"`, "g")) ?? []).length;
+}
+function clearUnusedSchemas({
+  paths,
+  components
+}) {
+  if (!components.schemas) return { paths, components };
+  const stringifiedPaths = JSON.stringify(paths);
+  const stringifiedSchemas = Object.fromEntries(Object.entries(components.schemas).map(([schemaName, schema]) => {
+    return [schemaName, JSON.stringify(schema)];
+  }));
+  return {
+    paths,
+    components: {
+      ...components,
+      schemas: Object.fromEntries(Object.entries(components.schemas).filter(([schemaName]) => {
+        const otherSchemas = omit(stringifiedSchemas, schemaName);
+        return countReferences(schemaName, stringifiedPaths) > 0 || countReferences(schemaName, Object.values(otherSchemas).join("")) > 0;
+      }))
+    }
+  };
+}
+
 // src/core/dir.ts
 var import_fs = require("fs");
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -46,7 +77,7 @@ async function directoryExists(dirPath) {
   try {
     await import_promises.default.access(dirPath, import_fs.constants.F_OK);
     return true;
-  } catch (err) {
+  } catch {
     return false;
   }
 }
@@ -76,8 +107,19 @@ function filterDirectoryItems(rootPath, items, include, exclude) {
   });
 }
 
-// src/core/next.ts
+// src/core/isDocumentedRoute.ts
 var import_promises2 = __toESM(require("fs/promises"), 1);
+async function isDocumentedRoute(routePath2) {
+  try {
+    const rawCode = await import_promises2.default.readFile(routePath2, "utf-8");
+    return rawCode.includes("@omer-x/next-openapi-route-handler");
+  } catch {
+    return false;
+  }
+}
+
+// src/core/next.ts
+var import_promises3 = __toESM(require("fs/promises"), 1);
 var import_node_path2 = __toESM(require("path"), 1);
 
 // src/core/middleware.ts
@@ -138,7 +180,7 @@ function safeEval(code, routePath) {
   }
 }
 async function getRouteExports(routePath2, routeDefinerName, schemas) {
-  const rawCode = await import_promises2.default.readFile(routePath2, "utf-8");
+  const rawCode = await import_promises3.default.readFile(routePath2, "utf-8");
   const middlewareName = detectMiddlewareName(rawCode);
   const code2 = transpile(rawCode, routeDefinerName, middlewareName);
   const fixedCode = Object.keys(schemas).reduce(injectSchemas, code2);
@@ -172,6 +214,13 @@ function verifyOptions(include, exclude) {
   };
 }
 
+// src/core/getRoutePathName.ts
+var import_node_path3 = __toESM(require("path"), 1);
+function getRoutePathName(filePath, rootPath) {
+  const dirName = import_node_path3.default.dirname(filePath);
+  return "/" + import_node_path3.default.relative(rootPath, dirName).replaceAll("[", "{").replaceAll("]", "}").replaceAll("\\", "/");
+}
+
 // src/utils/deepEqual.ts
 function deepEqual(a, b) {
   if (typeof a !== typeof b) return false;
@@ -316,9 +365,6 @@ function maskOperationSchemas(operation, storedSchemas) {
 }
 
 // src/core/route.ts
-function getRoutePathName(filePath, rootPath) {
-  return filePath.replace(rootPath, "").replace("[", "{").replace("]", "}").replaceAll("\\", "/").replace("/route.ts", "");
-}
 function createRouteRecord(method, filePath, rootPath, apiData) {
   return {
     method: method.toLocaleLowerCase(),
@@ -355,37 +401,50 @@ function bundleSchemas(schemas) {
 async function generateOpenApiSpec(schemas, {
   include: includeOption = [],
   exclude: excludeOption = [],
-  routeDefinerName = "defineRoute"
+  routeDefinerName = "defineRoute",
+  rootPath: additionalRootPath,
+  servers,
+  security,
+  securitySchemes
 } = {}) {
   const verifiedOptions = verifyOptions(includeOption, excludeOption);
   const appFolderPath = await findAppFolderPath();
   if (!appFolderPath) throw new Error("This is not a Next.js application!");
-  const routes = await getDirectoryItems(appFolderPath, "route.ts");
-  const verifiedRoutes = filterDirectoryItems(appFolderPath, routes, verifiedOptions.include, verifiedOptions.exclude);
+  const rootPath = additionalRootPath ? import_node_path4.default.resolve(appFolderPath, "./" + additionalRootPath) : appFolderPath;
+  const routes = await getDirectoryItems(rootPath, "route.ts");
+  const verifiedRoutes = filterDirectoryItems(rootPath, routes, verifiedOptions.include, verifiedOptions.exclude);
   const validRoutes = [];
   for (const route of verifiedRoutes) {
+    const isDocumented = await isDocumentedRoute(route);
+    if (!isDocumented) continue;
     const exportedRouteHandlers = await getRouteExports(route, routeDefinerName, schemas);
     for (const [method, routeHandler] of Object.entries(exportedRouteHandlers)) {
       if (!routeHandler || !routeHandler.apiData) continue;
       validRoutes.push(createRouteRecord(
         method.toLocaleLowerCase(),
         route,
-        appFolderPath,
+        rootPath,
         routeHandler.apiData
       ));
     }
   }
   const metadata = (0, import_package_metadata.default)();
+  const pathsAndComponents = {
+    paths: bundlePaths(validRoutes, schemas),
+    components: {
+      schemas: bundleSchemas(schemas),
+      securitySchemes
+    }
+  };
   return {
     openapi: "3.1.0",
     info: {
       title: metadata.serviceName,
       version: metadata.version
     },
-    paths: bundlePaths(validRoutes, schemas),
-    components: {
-      schemas: bundleSchemas(schemas)
-    },
+    servers,
+    ...clearUnusedSchemas(pathsAndComponents),
+    security,
     tags: []
   };
 }

package/dist/index.d.cts

@@ -1,11 +1,17 @@
 import { OpenApiDocument } from '@omer-x/openapi-types';
+import { ComponentsObject } from '@omer-x/openapi-types/components';
+import { ServerObject } from '@omer-x/openapi-types/server';
 import { ZodType } from 'zod';
 
 type GeneratorOptions = {
     include?: string[];
     exclude?: string[];
     routeDefinerName?: string;
+    rootPath?: string;
+    servers?: ServerObject[];
+    security?: OpenApiDocument["security"];
+    securitySchemes?: ComponentsObject["securitySchemes"];
 };
-declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
+declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, servers, security, securitySchemes, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
 
 export { generateOpenApiSpec as default };

package/dist/index.d.ts

@@ -1,11 +1,17 @@
 import { OpenApiDocument } from '@omer-x/openapi-types';
+import { ComponentsObject } from '@omer-x/openapi-types/components';
+import { ServerObject } from '@omer-x/openapi-types/server';
 import { ZodType } from 'zod';
 
 type GeneratorOptions = {
     include?: string[];
     exclude?: string[];
     routeDefinerName?: string;
+    rootPath?: string;
+    servers?: ServerObject[];
+    security?: OpenApiDocument["security"];
+    securitySchemes?: ComponentsObject["securitySchemes"];
 };
-declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
+declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, servers, security, securitySchemes, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
 
 export { generateOpenApiSpec as default };

package/dist/index.js

@@ -1,6 +1,37 @@
 // src/core/generateOpenApiSpec.ts
+import path4 from "node:path";
 import getPackageMetadata from "@omer-x/package-metadata";
 
+// src/utils/object.ts
+function omit(object, ...keys) {
+  return Object.fromEntries(Object.entries(object).filter(([key]) => !keys.includes(key)));
+}
+
+// src/core/clearUnusedSchemas.ts
+function countReferences(schemaName, source) {
+  return (source.match(new RegExp(`"#/components/schemas/${schemaName}"`, "g")) ?? []).length;
+}
+function clearUnusedSchemas({
+  paths,
+  components
+}) {
+  if (!components.schemas) return { paths, components };
+  const stringifiedPaths = JSON.stringify(paths);
+  const stringifiedSchemas = Object.fromEntries(Object.entries(components.schemas).map(([schemaName, schema]) => {
+    return [schemaName, JSON.stringify(schema)];
+  }));
+  return {
+    paths,
+    components: {
+      ...components,
+      schemas: Object.fromEntries(Object.entries(components.schemas).filter(([schemaName]) => {
+        const otherSchemas = omit(stringifiedSchemas, schemaName);
+        return countReferences(schemaName, stringifiedPaths) > 0 || countReferences(schemaName, Object.values(otherSchemas).join("")) > 0;
+      }))
+    }
+  };
+}
+
 // src/core/dir.ts
 import { constants } from "fs";
 import fs from "fs/promises";
@@ -10,7 +41,7 @@ async function directoryExists(dirPath) {
   try {
     await fs.access(dirPath, constants.F_OK);
     return true;
-  } catch (err) {
+  } catch {
     return false;
   }
 }
@@ -40,8 +71,19 @@ function filterDirectoryItems(rootPath, items, include, exclude) {
   });
 }
 
-// src/core/next.ts
+// src/core/isDocumentedRoute.ts
 import fs2 from "node:fs/promises";
+async function isDocumentedRoute(routePath2) {
+  try {
+    const rawCode = await fs2.readFile(routePath2, "utf-8");
+    return rawCode.includes("@omer-x/next-openapi-route-handler");
+  } catch {
+    return false;
+  }
+}
+
+// src/core/next.ts
+import fs3 from "node:fs/promises";
 import path2 from "node:path";
 
 // src/core/middleware.ts
@@ -102,7 +144,7 @@ function safeEval(code, routePath) {
   }
 }
 async function getRouteExports(routePath2, routeDefinerName, schemas) {
-  const rawCode = await fs2.readFile(routePath2, "utf-8");
+  const rawCode = await fs3.readFile(routePath2, "utf-8");
   const middlewareName = detectMiddlewareName(rawCode);
   const code2 = transpile(rawCode, routeDefinerName, middlewareName);
   const fixedCode = Object.keys(schemas).reduce(injectSchemas, code2);
@@ -136,6 +178,13 @@ function verifyOptions(include, exclude) {
   };
 }
 
+// src/core/getRoutePathName.ts
+import path3 from "node:path";
+function getRoutePathName(filePath, rootPath) {
+  const dirName = path3.dirname(filePath);
+  return "/" + path3.relative(rootPath, dirName).replaceAll("[", "{").replaceAll("]", "}").replaceAll("\\", "/");
+}
+
 // src/utils/deepEqual.ts
 function deepEqual(a, b) {
   if (typeof a !== typeof b) return false;
@@ -280,9 +329,6 @@ function maskOperationSchemas(operation, storedSchemas) {
 }
 
 // src/core/route.ts
-function getRoutePathName(filePath, rootPath) {
-  return filePath.replace(rootPath, "").replace("[", "{").replace("]", "}").replaceAll("\\", "/").replace("/route.ts", "");
-}
 function createRouteRecord(method, filePath, rootPath, apiData) {
   return {
     method: method.toLocaleLowerCase(),
@@ -319,37 +365,50 @@ function bundleSchemas(schemas) {
 async function generateOpenApiSpec(schemas, {
   include: includeOption = [],
   exclude: excludeOption = [],
-  routeDefinerName = "defineRoute"
+  routeDefinerName = "defineRoute",
+  rootPath: additionalRootPath,
+  servers,
+  security,
+  securitySchemes
 } = {}) {
   const verifiedOptions = verifyOptions(includeOption, excludeOption);
   const appFolderPath = await findAppFolderPath();
   if (!appFolderPath) throw new Error("This is not a Next.js application!");
-  const routes = await getDirectoryItems(appFolderPath, "route.ts");
-  const verifiedRoutes = filterDirectoryItems(appFolderPath, routes, verifiedOptions.include, verifiedOptions.exclude);
+  const rootPath = additionalRootPath ? path4.resolve(appFolderPath, "./" + additionalRootPath) : appFolderPath;
+  const routes = await getDirectoryItems(rootPath, "route.ts");
+  const verifiedRoutes = filterDirectoryItems(rootPath, routes, verifiedOptions.include, verifiedOptions.exclude);
   const validRoutes = [];
   for (const route of verifiedRoutes) {
+    const isDocumented = await isDocumentedRoute(route);
+    if (!isDocumented) continue;
     const exportedRouteHandlers = await getRouteExports(route, routeDefinerName, schemas);
     for (const [method, routeHandler] of Object.entries(exportedRouteHandlers)) {
       if (!routeHandler || !routeHandler.apiData) continue;
       validRoutes.push(createRouteRecord(
         method.toLocaleLowerCase(),
         route,
-        appFolderPath,
+        rootPath,
         routeHandler.apiData
       ));
     }
   }
   const metadata = getPackageMetadata();
+  const pathsAndComponents = {
+    paths: bundlePaths(validRoutes, schemas),
+    components: {
+      schemas: bundleSchemas(schemas),
+      securitySchemes
+    }
+  };
   return {
     openapi: "3.1.0",
     info: {
       title: metadata.serviceName,
       version: metadata.version
     },
-    paths: bundlePaths(validRoutes, schemas),
-    components: {
-      schemas: bundleSchemas(schemas)
-    },
+    servers,
+    ...clearUnusedSchemas(pathsAndComponents),
+    security,
     tags: []
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omer-x/next-openapi-json-generator",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "a Next.js plugin to generate OpenAPI documentation from route handlers",
   "keywords": [
     "next.js",
@@ -48,20 +48,20 @@
     "@omer-x/package-metadata": "^1.0.0",
     "minimatch": "^10.0.1",
     "typescript": "^5.6.3",
-    "zod-to-json-schema": "^3.23.3"
+    "zod-to-json-schema": "^3.23.5"
   },
   "devDependencies": {
-    "@omer-x/eslint-config": "^1.0.7",
-    "@omer-x/openapi-types": "^0.2.1",
-    "@types/node": "^22.7.9",
-    "eslint": "^8.57.1",
-    "semantic-release": "^24.1.3",
+    "@omer-x/eslint-config": "^2.0.2",
+    "@types/node": "^22.8.4",
+    "eslint": "^9.13.0",
+    "semantic-release": "^24.2.0",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tsup": "^8.3.0",
+    "tsup": "^8.3.5",
     "zod": "^3.23.8"
   },
   "peerDependencies": {
-    "@omer-x/next-openapi-route-handler": "^1"
+    "@omer-x/next-openapi-route-handler": "^1",
+    "@omer-x/openapi-types": "^1"
   }
 }