refactor: convertToOpenAPI with native converter

Fixes #20

Author: omermecitoglu

src/core/body.test.ts

@@ -34,7 +34,7 @@ describe("resolveRequestBody", () => {
 
   it("should handle formData content type", () => {
     const schema = z.object({
-      file: z.instanceof(File),
+      file: z.file(),
     });
 
     const result = resolveRequestBody(schema, true);

src/core/definer.test.ts

@@ -121,7 +121,7 @@ describe("defineRoute", () => {
       description: "Uploads a file to the storage service",
       tags: ["Upload"],
       requestBody: z.object({
-        file: z.instanceof(File).describe("File object to be uploaded"),
+        file: z.file().describe("File object to be uploaded"),
       }),
       hasFormData: true,
       action: mockAction,

src/core/zod-to-openapi.test.ts

@@ -20,6 +20,8 @@ describe("convertToOpenAPI", () => {
       },
       required: ["name", "age"],
       additionalProperties: false,
+      // @ts-expect-error: @omer-x/openapi-types doesn't have this
+      $schema: "https://json-schema.org/draft/2020-12/schema",
     };
 
     expect(openAPISchema).toEqual(expectedSchema);
@@ -33,6 +35,8 @@ describe("convertToOpenAPI", () => {
     const expectedSchema: SchemaObject = {
       type: "array",
       items: { type: "string" },
+      // @ts-expect-error: @omer-x/openapi-types doesn't have this
+      $schema: "https://json-schema.org/draft/2020-12/schema",
     };
 
     expect(openAPISchema).toEqual(expectedSchema);
@@ -63,14 +67,16 @@ describe("convertToOpenAPI", () => {
       },
       required: ["user"],
       additionalProperties: false,
+      // @ts-expect-error: @omer-x/openapi-types doesn't have this
+      $schema: "https://json-schema.org/draft/2020-12/schema",
     };
 
     expect(openAPISchema).toEqual(expectedSchema);
   });
 
   it("should handle file type correctly in an object", () => {
     const zodSchema = z.object({
-      file: z.instanceof(File),
+      file: z.file(),
     });
 
     const openAPISchema = convertToOpenAPI(zodSchema, false);
@@ -81,10 +87,13 @@ describe("convertToOpenAPI", () => {
         file: {
           type: "string",
           format: "binary",
+          contentEncoding: "binary" as unknown as undefined,
         },
       },
       required: ["file"],
       additionalProperties: false,
+      // @ts-expect-error: @omer-x/openapi-types doesn't have this
+      $schema: "https://json-schema.org/draft/2020-12/schema",
     };
 
     expect(openAPISchema).toEqual(expectedSchema);

src/core/zod-to-openapi.ts

@@ -1,25 +1,6 @@
-import { zodToJsonSchema } from "zod-to-json-schema";
-import { isFile } from "~/utils/zod-schema";
+import { type ZodType, z } from "zod";
 import type { SchemaObject } from "@omer-x/openapi-types/schema";
-import type { ZodObject, ZodType } from "zod";
 
 export default function convertToOpenAPI(schema: ZodType<unknown>, isArray: boolean) {
-  const result = zodToJsonSchema(isArray ? schema.array() : schema, {
-    target: "openApi3",
-    $refStrategy: "none",
-  }) as SchemaObject;
-  if (result.type === "object" && result.properties) {
-    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-    for (const [propName, prop] of Object.entries<ZodType>((schema as ZodObject<{}>).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) as SchemaObject;
 }

src/utils/zod-schema.test.ts

@@ -4,7 +4,7 @@ import { isFile } from "./zod-schema";
 
 describe("isFile", () => {
   it("should return true for a valid file schema", () => {
-    const fileSchema = z.instanceof(File);
+    const fileSchema = z.file();
     const result = isFile(fileSchema);
     expect(result).toBe(true);
   });