add openApiMetadata to openapi builder

seamapi · Oct 11, 2023 · 53daecb · 53daecb
1 parent 979f9be
commit 53daecb
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 49 deletions.
diff --git a/packages/nextlove/src/generators/generate-openapi/index.ts b/packages/nextlove/src/generators/generate-openapi/index.ts
@@ -144,6 +144,10 @@ export async function generateOpenAPI(opts: GenerateOpenAPIOpts) {
     )
     // TODO: support multipart/form-data
 
+    if (routeSpec.openApiMetada) {
+      // handle openApiMetadata
+    }
+
     // handle body
     let body_to_generate_schema
     if (isPostOrPutOrPatch) {

diff --git a/packages/nextlove/src/types/index.ts b/packages/nextlove/src/types/index.ts
@@ -27,6 +27,7 @@ export interface RouteSpec<
   JsonResponse extends ParamDef = z.ZodTypeAny,
   FormData extends ParamDef = z.ZodTypeAny
 > {
+  openApiMetada?: any
   methods: Methods
   auth: Auth
   jsonBody?: JsonBody
@@ -47,11 +48,11 @@ export type MiddlewareChainOutput<
   ? {}
   : MWChain extends readonly [infer First, ...infer Rest]
   ? First extends Middleware<infer T, any>
-    ? T &
-        (Rest extends readonly Middleware<any, any>[]
-          ? MiddlewareChainOutput<Rest>
-          : never)
-    : never
+  ? T &
+  (Rest extends readonly Middleware<any, any>[]
+    ? MiddlewareChainOutput<Rest>
+    : never)
+  : never
   : never
 
 export type AuthMiddlewares = {
@@ -116,34 +117,34 @@ export type RouteFunction<
 > = (
   req: (SP["authMiddlewareMap"] &
     typeof defaultMiddlewareMap)[RS["auth"]] extends Middleware<
-    infer AuthMWOut,
-    any
-  >
+      infer AuthMWOut,
+      any
+    >
     ? Omit<NextApiRequest, "query" | "body"> &
-        AuthMWOut &
-        MiddlewareChainOutput<
-          RS["middlewares"] extends readonly Middleware<any, any>[]
-            ? [...SP["globalMiddlewares"], ...RS["middlewares"]]
-            : SP["globalMiddlewares"]
-        > & {
-          body: RS["formData"] extends z.ZodTypeAny
-            ? z.infer<RS["formData"]>
-            : RS["jsonBody"] extends z.ZodTypeAny
-            ? z.infer<RS["jsonBody"]>
-            : {}
-          query: RS["queryParams"] extends z.ZodTypeAny
-            ? z.infer<RS["queryParams"]>
-            : {}
-          commonParams: RS["commonParams"] extends z.ZodTypeAny
-            ? z.infer<RS["commonParams"]>
-            : {}
-        }
+    AuthMWOut &
+    MiddlewareChainOutput<
+      RS["middlewares"] extends readonly Middleware<any, any>[]
+      ? [...SP["globalMiddlewares"], ...RS["middlewares"]]
+      : SP["globalMiddlewares"]
+    > & {
+      body: RS["formData"] extends z.ZodTypeAny
+      ? z.infer<RS["formData"]>
+      : RS["jsonBody"] extends z.ZodTypeAny
+      ? z.infer<RS["jsonBody"]>
+      : {}
+      query: RS["queryParams"] extends z.ZodTypeAny
+      ? z.infer<RS["queryParams"]>
+      : {}
+      commonParams: RS["commonParams"] extends z.ZodTypeAny
+      ? z.infer<RS["commonParams"]>
+      : {}
+    }
     : `unknown auth type: ${RS["auth"]}. You should configure this auth type in your auth_middlewares w/ createWithRouteSpec, or maybe you need to add "as const" to your route spec definition.`,
   res: NextApiResponseWithoutJsonAndStatusMethods &
     SuccessfulNextApiResponseMethods<
       RS["jsonResponse"] extends z.ZodTypeAny
-        ? z.infer<RS["jsonResponse"]>
-        : any
+      ? z.infer<RS["jsonResponse"]>
+      : any
     > &
     ErrorNextApiResponseMethods
 ) => Promise<void>

diff --git a/packages/nextlove/src/with-route-spec/index.ts b/packages/nextlove/src/with-route-spec/index.ts
@@ -9,7 +9,6 @@ import {
 import withMethods, { HTTPMethods } from "./middlewares/with-methods"
 import withValidation from "./middlewares/with-validation"
 import { z } from "zod"
-import withMetadata, { MetaData } from "./middlewares/with-metadata"
 
 type ParamDef = z.ZodTypeAny | z.ZodEffects<z.ZodTypeAny>
 
@@ -24,25 +23,22 @@ export const checkRouteSpec = <
     any
   >[],
   FormData extends ParamDef = z.ZodTypeAny,
-  MetaData extends ParamDef = z.ZodTypeAny,
   Spec extends RouteSpec<
     AuthType,
     Methods,
     JsonBody,
     QueryParams,
     CommonParams,
     Middlewares,
-    FormData,
-    MetaData
+    FormData
   > = RouteSpec<
     AuthType,
     Methods,
     JsonBody,
     QueryParams,
     CommonParams,
     Middlewares,
-    FormData,
-    MetaData
+    FormData
   >
 >(
   spec: Spec
@@ -113,7 +109,6 @@ export const createWithRouteSpec: CreateWithRouteSpecFunction = ((
             shouldValidateGetRequestBody,
             supportedArrayFormats,
           }),
-          withMetadata(spec.metaData),
           userDefinedRouteFn
         )(req as any, res)
       }

diff --git a/packages/nextlove/src/with-route-spec/middlewares/with-metadata.ts b/packages/nextlove/src/with-route-spec/middlewares/with-metadata.ts