Feat: add support for "type": "file" in parameters (#766)

Author: drwpow

src/transform/schema.ts

@@ -97,7 +97,8 @@ export function transformSchemaObj(node: any, options: TransformSchemaObjOptions
       }
       case "string":
       case "number":
-      case "boolean": {
+      case "boolean":
+      case "unknown": {
         output += nodeType(node) || "any";
         break;
       }

src/utils.ts

@@ -32,7 +32,17 @@ export function isRef(obj: any): obj is ReferenceObject {
 }
 
 /** Return type of node (works for v2 or v3, as there are no conflicting types) */
-type SchemaObjectType = "anyOf" | "array" | "boolean" | "enum" | "number" | "object" | "oneOf" | "ref" | "string";
+type SchemaObjectType =
+  | "anyOf"
+  | "array"
+  | "boolean"
+  | "enum"
+  | "number"
+  | "object"
+  | "oneOf"
+  | "ref"
+  | "string"
+  | "unknown";
 export function nodeType(obj: any): SchemaObjectType | undefined {
   if (!obj || typeof obj !== "object") {
     return undefined;
@@ -67,6 +77,11 @@ export function nodeType(obj: any): SchemaObjectType | undefined {
     return "array";
   }
 
+  // file
+  if (obj.type === "file") {
+    return "unknown";
+  }
+
   // return object by default
   return "object";
 }

tests/schema.test.ts

@@ -209,6 +209,10 @@ describe("SchemaObject", () => {
         `components["parameters"]["ReferenceObject"]`
       );
     });
+
+    it("file", () => {
+      expect(transform({ type: "file" }, { ...defaults })).toBe("unknown");
+    });
   });
 
   describe("advanced", () => {

tests/v2/expected/petstore.immutable.ts

@@ -235,7 +235,7 @@ export interface operations {
         /** Additional data to pass to server */
         readonly additionalMetadata?: string;
         /** file to upload */
-        readonly file?: { readonly [key: string]: unknown };
+        readonly file?: unknown;
       };
     };
     readonly responses: {

tests/v2/expected/petstore.ts

@@ -235,7 +235,7 @@ export interface operations {
         /** Additional data to pass to server */
         additionalMetadata?: string;
         /** file to upload */
-        file?: { [key: string]: unknown };
+        file?: unknown;
       };
     };
     responses: {