feat: parsing File type in convertToOpenAPI

Author: omermecitoglu

src/core/zod-to-openapi.ts

@@ -1,11 +1,25 @@
 import zodToJsonSchema from "zod-to-json-schema";
+import { isFile } from "~/utils/zod-schema";
 import type { SchemaObject } from "@omer-x/openapi-types/schema";
-import type { ZodType } from "zod";
+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",
-  });
-  return result as SchemaObject;
+  }) as SchemaObject;
+  if (result.type === "object" && result.properties) {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    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;
 }

src/utils/zod-schema.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, it } from "@jest/globals";
+import z from "zod";
+import { isFile } from "./zod-schema";
+
+describe("isFile", () => {
+  it("should return true for a valid file schema", () => {
+    const fileSchema = z.instanceof(File);
+    const result = isFile(fileSchema);
+    expect(result).toBe(true);
+  });
+
+  it("should return false for a non-File type in schema", () => {
+    expect(isFile(z.string())).toBe(false);
+    expect(isFile(z.number())).toBe(false);
+  });
+});

src/utils/zod-schema.ts

@@ -0,0 +1,6 @@
+import type { ZodType } from "zod";
+
+export function isFile(schema: ZodType<unknown>) {
+  const result = schema.safeParse(new File([], "nothing.txt"));
+  return result.success;
+}