Merge pull request #829 from pmcelhaney/invalid-json-schema

configure JSONSchemaFaker to not fail on invalid types

.changeset/eight-dolls-collect.md

@@ -0,0 +1,5 @@
+---
+"counterfact": patch
+---
+
+configure JSONSchemaFaker to not fail on invalid types

src/server/response-builder.ts

@@ -6,6 +6,8 @@ import type { OpenApiOperation, ResponseBuilder } from "./types.d.ts";
 JSONSchemaFaker.option("useExamplesValue", true);
 JSONSchemaFaker.option("minItems", 0);
 JSONSchemaFaker.option("maxItems", 20);
+JSONSchemaFaker.option("failOnInvalidTypes", false);
+JSONSchemaFaker.option("failOnInvalidFormat", false);
 
 function convertToXmlIfNecessary(
   type: string,

test/server/response-builder.test.ts

@@ -151,6 +151,31 @@ describe("a response builder", () => {
         },
       ]);
     });
+
+    it("returns 500 if it doesn't know what to do with the status code", () => {
+      const operationWithInvalidSchema = structuredClone(operation);
+
+      // @ts-expect-error TypeScript can't track the type with structuredClone()
+      operationWithInvalidSchema.responses[200].content[
+        "application/json"
+      ].schema.type = "file";
+
+      const response = createResponseBuilder(
+        operationWithInvalidSchema,
+      )[200]?.random();
+
+      expect(response?.status).toBe(200);
+      expect(response?.content).toStrictEqual([
+        {
+          body: undefined,
+          type: "application/json",
+        },
+        {
+          body: "example text response",
+          type: "text/plain",
+        },
+      ]);
+    });
   });
 
   describe("builds a random response based on an Open API operation object (OpenAPI 2)", () => {