feat: example strategy

Author: omermecitoglu

src/core/definer.ts

@@ -1,4 +1,5 @@
 import { customErrorTypes } from "~/types/error";
+import type { ExampleStrategy } from "~/types/example";
 import type { HttpMethod } from "~/types/http";
 import type { RouteHandler, RouteMethodHandler } from "~/types/next";
 import type { ResponseDefinition } from "~/types/response";
@@ -59,6 +60,7 @@ type RouteOptions<
     hander: RouteMethodHandler<PathParamsInput, Req, Res>
   ) => RouteMethodHandler<PathParamsInput, Req, Res>,
   security?: OperationObject["security"],
+  exampleStrategy?: ExampleStrategy,
 } & (RouteWithBody<RequestBodyInput, RequestBodyOutput> | RouteWithoutBody);
 
 function defineRoute<

src/core/example.ts

@@ -0,0 +1,12 @@
+import type { ExampleStrategy } from "~/types/example";
+import generateExample from "~/utils/generateExample";
+import type { ZodType } from "zod";
+
+export function injectExample(strategy: ExampleStrategy, schema: ZodType<unknown> | string, isArray: boolean) {
+  if (strategy === "none" || typeof schema === "string") return {};
+  const isStrict = strategy === "strict-full" || strategy === "strict-ignore-optionals";
+  const ignoreOptionals = strategy === "ignore-optional" || strategy === "strict-ignore-optionals";
+  return {
+    example: generateExample(isArray ? schema.array() : schema, ignoreOptionals, isStrict),
+  };
+}

src/types/example.ts

@@ -0,0 +1 @@
+export type ExampleStrategy = "none" | "full" | "ignore-optional" | "strict-full" | "strict-ignore-optionals";