feat: response example

Author: omermecitoglu

src/core/definer.ts

@@ -1,7 +1,7 @@
 import { customErrorTypes } from "~/types/error";
 import type { HttpMethod } from "~/types/http";
 import type { RouteHandler, RouteMethodHandler } from "~/types/next";
-import type { ResponseDefinition } from "~/types/response";
+import type { ResponseCollection } from "~/types/response";
 import { parseRequestBody, resolveRequestBody } from "./body";
 import { resolveParams } from "./params";
 import parsePathParams from "./path-params";
@@ -40,6 +40,7 @@ type RouteOptions<
   RequestBodyOutput,
   Req extends Request,
   Res extends Response,
+  ResponseDefinitions extends Record<string, unknown>,
 > = {
   operationId: string,
   method: Method,
@@ -52,7 +53,7 @@ type RouteOptions<
     source: ActionSource<PathParamsOutput, QueryParamsOutput, RequestBodyOutput>,
     request: Req
   ) => Res | Promise<Res>,
-  responses: Record<string, ResponseDefinition>,
+  responses: ResponseCollection<ResponseDefinitions>,
   handleErrors?: (
     errorType: typeof customErrorTypes[number] | "UNKNOWN_ERROR",
     issues?: ZodIssue[]
@@ -64,9 +65,18 @@ type RouteOptions<
 } & (RouteWithBody<RequestBodyInput, RequestBodyOutput> | RouteWithoutBody);
 
 function defineRoute<
-  M extends HttpMethod, PPI, PPO, QPI, QPO, RBI, RBO, MwReq extends Request, MwRes extends Response,
+  M extends HttpMethod,
+  PPI,
+  PPO,
+  QPI,
+  QPO,
+  RBI,
+  RBO,
+  MwReq extends Request,
+  MwRes extends Response,
+  ResDef extends Record<string, unknown>,
 >(input: RouteOptions<
-  M, PPI, PPO, QPI, QPO, RBI, RBO, MwReq, MwRes
+  M, PPI, PPO, QPI, QPO, RBI, RBO, MwReq, MwRes, ResDef
 >) {
   const handler: RouteMethodHandler<PPI, MwReq, MwRes> = async (request, context) => {
     try {

src/core/responses.ts

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

src/types/response.ts

@@ -1,7 +1,12 @@
-import type { ZodType } from "zod";
+import type { ZodType, ZodTypeDef } from "zod";
 
-export type ResponseDefinition = {
+export type ResponseDefinition<O, I = O> = {
   description: string,
-  content?: ZodType | string,
   isArray?: boolean,
+  content?: ZodType<O, ZodTypeDef, I> | string,
+  example?: NoInfer<O>,
+};
+
+export type ResponseCollection<T extends Record<string, unknown>> = {
+  [K in keyof T]: ResponseDefinition<T[K]>;
 };