refactor: bundleResponses with example strategy

Author: omermecitoglu

src/core/content.test.ts

@@ -5,12 +5,12 @@ import type { RequestBodyObject } from "@omer-x/openapi-types/request-body";
 
 describe("resolveContent", () => {
   it("should return undefined if source is not provided", () => {
-    const result = resolveContent(undefined);
+    const result = resolveContent("none", undefined);
     expect(result).toBeUndefined();
   });
 
   it("should create content for a string schema reference", () => {
-    const result = resolveContent("User", false);
+    const result = resolveContent("none", "User", false);
 
     const expectedContent = {
       "application/json": {
@@ -29,7 +29,7 @@ describe("resolveContent", () => {
       age: z.number(),
     });
 
-    const result = resolveContent(zodSchema, false);
+    const result = resolveContent("none", zodSchema, false);
 
     const expectedContent = {
       "application/json": {
@@ -53,7 +53,7 @@ describe("resolveContent", () => {
   });
 
   it("should create multipart/form-data content when isFormData is true", () => {
-    const result = resolveContent("User", false, true);
+    const result = resolveContent("none", "User", false, true);
 
     const expectedContent = {
       "multipart/form-data": {

src/core/content.ts

@@ -1,16 +1,19 @@
+import type { ExampleStrategy } from "~/types/example";
 import { createSchemaRef } from "~/utils/openapi-components";
+import { injectExample } from "./example";
 import convertToOpenAPI from "./zod-to-openapi";
 import type { RequestBodyObject } from "@omer-x/openapi-types/request-body";
 import type { ZodType } from "zod";
 
-export function resolveContent(source?: ZodType<unknown> | string, isArray: boolean = false, isFormData: boolean = false) {
+export function resolveContent(exampleStrategy: ExampleStrategy, source?: ZodType<unknown> | string, isArray: boolean = false, isFormData: boolean = false) {
   if (!source) return undefined;
 
   const schema = typeof source === "string" ? createSchemaRef(source, isArray) : convertToOpenAPI(source, isArray);
 
   return {
     [isFormData ? "multipart/form-data" : "application/json"]: {
       schema,
+      ...injectExample(exampleStrategy, source, isArray),
     },
   } as RequestBodyObject["content"];
 }

src/core/definer.ts

@@ -114,7 +114,7 @@ function defineRoute<
     ...resolveParams("query", input.exampleStrategy ?? "none", input.queryParams),
   ];
 
-  const responses = bundleResponses(input.responses);
+  const responses = bundleResponses(input.responses, input.exampleStrategy ?? "none");
   const response400 = addBadRequest(input.queryParams, input.requestBody);
   if (response400) {
     responses["400"] = response400;

src/core/responses.test.ts

@@ -27,7 +27,7 @@ describe("addBadRequest", () => {
 describe("bundleResponses", () => {
   it("should return an empty when no responses are provided", () => {
     const collection: Record<string, ResponseDefinition> = {};
-    const result = bundleResponses(collection);
+    const result = bundleResponses(collection, "none");
     expect(result).toEqual({});
   });
 
@@ -37,7 +37,7 @@ describe("bundleResponses", () => {
       404: { description: "Not Found", content: "SomeOtherContent", isArray: true },
     };
 
-    const result = bundleResponses(collection);
+    const result = bundleResponses(collection, "none");
 
     expect(result).toEqual({
       200: {

src/core/responses.ts

@@ -1,3 +1,4 @@
+import type { ExampleStrategy } from "~/types/example";
 import type { ResponseDefinition } from "~/types/response";
 import { resolveContent } from "./content";
 import type { ResponseObject, ResponsesObject } from "@omer-x/openapi-types/response";
@@ -7,13 +8,13 @@ export function addBadRequest(queryParams?: unknown, requestBody?: unknown) {
   return { description: "Bad Request" } as ResponseObject;
 }
 
-export function bundleResponses(collection: Record<string, ResponseDefinition>) {
+export function bundleResponses(collection: Record<string, ResponseDefinition>, exampleStrategy: ExampleStrategy) {
   return Object.entries(collection).reduce((result, [key, response]) => {
     return {
       ...result,
       [key]: {
         description: response.description,
-        content: resolveContent(response.content, response.isArray),
+        content: resolveContent(exampleStrategy, response.content, response.isArray),
       } satisfies ResponseObject,
     };
   }, {}) as ResponsesObject;