@omer-x/next-openapi-json-generator 1.3.3 → 2.0.0

package/dist/index.cjs

@@ -28,11 +28,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  default: () => src_default
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/core/generateOpenApiSpec.ts
 var import_node_path4 = __toESM(require("path"), 1);
@@ -272,36 +272,9 @@ function deepEqual(a, b) {
 }
 
 // src/core/zod-to-openapi.ts
-var import_zod_to_json_schema = require("zod-to-json-schema");
-
-// src/utils/zod-schema.ts
-function isFile(schema) {
-  const file = new File([], "nothing.txt");
-  const plainObject = { name: "test", size: 0 };
-  const fileResult = schema.safeParse(file);
-  const objectResult = schema.safeParse(plainObject);
-  return fileResult.success && !objectResult.success;
-}
-
-// src/core/zod-to-openapi.ts
+var import_zod = require("zod");
 function convertToOpenAPI(schema, isArray) {
-  const result = (0, import_zod_to_json_schema.zodToJsonSchema)(isArray ? schema.array() : schema, {
-    target: "openApi3",
-    $refStrategy: "none"
-  });
-  if (result.type === "object" && result.properties) {
-    for (const [propName, prop] of Object.entries(schema.shape)) {
-      if (isFile(prop)) {
-        result.properties[propName] = {
-          type: "string",
-          format: "binary",
-          description: prop.description
-          // contentEncoding: "base64", // swagger-ui-react doesn't support this
-        };
-      }
-    }
-  }
-  return result;
+  return import_zod.z.toJSONSchema(isArray ? schema.array() : schema);
 }
 
 // src/core/mask.ts
@@ -434,6 +407,7 @@ async function generateOpenApiSpec(schemas, {
   exclude: excludeOption = [],
   routeDefinerName = "defineRoute",
   rootPath: additionalRootPath,
+  info,
   servers,
   security,
   securitySchemes,
@@ -468,18 +442,19 @@ async function generateOpenApiSpec(schemas, {
       securitySchemes
     }
   };
-  return {
+  return JSON.parse(JSON.stringify({
     openapi: "3.1.0",
     info: {
       title: metadata.serviceName,
-      version: metadata.version
+      version: metadata.version,
+      ...info ?? {}
     },
     servers,
     ...clearUnusedSchemasOption ? clearUnusedSchemas(pathsAndComponents) : pathsAndComponents,
     security,
     tags: []
-  };
+  }));
 }
 
 // src/index.ts
-var src_default = generateOpenApiSpec;
+var index_default = generateOpenApiSpec;

package/dist/index.d.cts

@@ -1,6 +1,5 @@
 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 = {
@@ -8,11 +7,12 @@ type GeneratorOptions = {
     exclude?: string[];
     routeDefinerName?: string;
     rootPath?: string;
-    servers?: ServerObject[];
+    info?: OpenApiDocument["info"];
+    servers?: OpenApiDocument["servers"];
     security?: OpenApiDocument["security"];
     securitySchemes?: ComponentsObject["securitySchemes"];
     clearUnusedSchemas?: boolean;
 };
-declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, servers, security, securitySchemes, clearUnusedSchemas: clearUnusedSchemasOption, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
+declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, info, servers, security, securitySchemes, clearUnusedSchemas: clearUnusedSchemasOption, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
 
 export { generateOpenApiSpec as default };

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 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 = {
@@ -8,11 +7,12 @@ type GeneratorOptions = {
     exclude?: string[];
     routeDefinerName?: string;
     rootPath?: string;
-    servers?: ServerObject[];
+    info?: OpenApiDocument["info"];
+    servers?: OpenApiDocument["servers"];
     security?: OpenApiDocument["security"];
     securitySchemes?: ComponentsObject["securitySchemes"];
     clearUnusedSchemas?: boolean;
 };
-declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, servers, security, securitySchemes, clearUnusedSchemas: clearUnusedSchemasOption, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
+declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, info, servers, security, securitySchemes, clearUnusedSchemas: clearUnusedSchemasOption, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
 
 export { generateOpenApiSpec as default };

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/core/generateOpenApiSpec.ts
-import path4 from "node:path";
+import path4 from "path";
 import getPackageMetadata from "@omer-x/package-metadata";
 
 // src/utils/object.ts
@@ -35,7 +35,7 @@ function clearUnusedSchemas({
 // src/core/dir.ts
 import { constants } from "fs";
 import fs from "fs/promises";
-import path from "node:path";
+import path from "path";
 import { Minimatch } from "minimatch";
 async function directoryExists(dirPath) {
   try {
@@ -72,7 +72,7 @@ function filterDirectoryItems(rootPath, items, include, exclude) {
 }
 
 // src/core/isDocumentedRoute.ts
-import fs2 from "node:fs/promises";
+import fs2 from "fs/promises";
 async function isDocumentedRoute(routePath2) {
   try {
     const rawCode = await fs2.readFile(routePath2, "utf-8");
@@ -83,8 +83,8 @@ async function isDocumentedRoute(routePath2) {
 }
 
 // src/core/next.ts
-import fs3 from "node:fs/promises";
-import path2 from "node:path";
+import fs3 from "fs/promises";
+import path2 from "path";
 
 // src/utils/generateRandomString.ts
 function generateRandomString(length) {
@@ -207,7 +207,7 @@ function verifyOptions(include, exclude) {
 }
 
 // src/core/getRoutePathName.ts
-import path3 from "node:path";
+import path3 from "path";
 function getRoutePathName(filePath, rootPath) {
   const dirName = path3.dirname(filePath);
   return "/" + path3.relative(rootPath, dirName).replaceAll("[", "{").replaceAll("]", "}").replaceAll("\\", "/");
@@ -236,36 +236,9 @@ function deepEqual(a, b) {
 }
 
 // src/core/zod-to-openapi.ts
-import { zodToJsonSchema } from "zod-to-json-schema";
-
-// src/utils/zod-schema.ts
-function isFile(schema) {
-  const file = new File([], "nothing.txt");
-  const plainObject = { name: "test", size: 0 };
-  const fileResult = schema.safeParse(file);
-  const objectResult = schema.safeParse(plainObject);
-  return fileResult.success && !objectResult.success;
-}
-
-// src/core/zod-to-openapi.ts
+import { z } from "zod";
 function convertToOpenAPI(schema, isArray) {
-  const result = zodToJsonSchema(isArray ? schema.array() : schema, {
-    target: "openApi3",
-    $refStrategy: "none"
-  });
-  if (result.type === "object" && result.properties) {
-    for (const [propName, prop] of Object.entries(schema.shape)) {
-      if (isFile(prop)) {
-        result.properties[propName] = {
-          type: "string",
-          format: "binary",
-          description: prop.description
-          // contentEncoding: "base64", // swagger-ui-react doesn't support this
-        };
-      }
-    }
-  }
-  return result;
+  return z.toJSONSchema(isArray ? schema.array() : schema);
 }
 
 // src/core/mask.ts
@@ -398,6 +371,7 @@ async function generateOpenApiSpec(schemas, {
   exclude: excludeOption = [],
   routeDefinerName = "defineRoute",
   rootPath: additionalRootPath,
+  info,
   servers,
   security,
   securitySchemes,
@@ -432,21 +406,22 @@ async function generateOpenApiSpec(schemas, {
       securitySchemes
     }
   };
-  return {
+  return JSON.parse(JSON.stringify({
     openapi: "3.1.0",
     info: {
       title: metadata.serviceName,
-      version: metadata.version
+      version: metadata.version,
+      ...info ?? {}
     },
     servers,
     ...clearUnusedSchemasOption ? clearUnusedSchemas(pathsAndComponents) : pathsAndComponents,
     security,
     tags: []
-  };
+  }));
 }
 
 // src/index.ts
-var src_default = generateOpenApiSpec;
+var index_default = generateOpenApiSpec;
 export {
-  src_default as default
+  index_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omer-x/next-openapi-json-generator",
-  "version": "1.3.3",
+  "version": "2.0.0",
   "description": "a Next.js plugin to generate OpenAPI documentation from route handlers",
   "keywords": [
     "next.js",
@@ -40,28 +40,28 @@
     }
   },
   "scripts": {
-    "test": "jest",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest --coverage",
     "dev": "tsup --watch",
     "build": "tsup"
   },
+  "peerDependencies": {
+    "@omer-x/next-openapi-route-handler": "^2",
+    "@omer-x/openapi-types": "^1",
+    "zod": "^4",
+    "typescript": "^5"
+  },
   "dependencies": {
     "@omer-x/package-metadata": "^1.0.2",
-    "minimatch": "^10.0.1",
-    "typescript": "^5.7.2",
-    "zod-to-json-schema": "^3.24.1"
+    "minimatch": "^10.0.3"
   },
   "devDependencies": {
-    "@omer-x/eslint-config": "^2.1.2",
-    "@types/node": "^22.10.2",
-    "eslint": "^9.16.0",
-    "semantic-release": "^24.2.0",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "tsup": "^8.3.5",
-    "zod": "^3.24.1"
-  },
-  "peerDependencies": {
-    "@omer-x/next-openapi-route-handler": "^1",
-    "@omer-x/openapi-types": "^1"
+    "@omer-x/eslint-config": "^2.1.3",
+    "@types/node": "^24.0.14",
+    "@vitest/coverage-v8": "^3.2.4",
+    "eslint": "^9.31.0",
+    "semantic-release": "^24.2.7",
+    "tsup": "^8.5.0",
+    "vitest": "^3.2.4"
   }
 }