feat: Allow non-object JSON responses

* allow non-object JSON responses * add basic type tests
seamapi · Aug 15, 2023 · 25d62b0 · 25d62b0
1 parent 78f95b1
commit 25d62b0
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 15 deletions.
diff --git a/packages/nextlove/src/generators/generate-openapi/index.ts b/packages/nextlove/src/generators/generate-openapi/index.ts
@@ -252,7 +252,9 @@ export async function generateOpenAPI(opts: GenerateOpenAPIOpts) {
       }
 
       const responseSchema = generateSchema(
-        addOkStatus ? jsonResponse.extend({ ok: z.boolean() }) : jsonResponse
+        addOkStatus && jsonResponse instanceof z.ZodObject
+          ? jsonResponse.extend({ ok: z.boolean() })
+          : jsonResponse
       )
 
       const schemaWithReferences = embedSchemaReferences(

diff --git a/packages/nextlove/src/generators/generate-route-types/index.ts b/packages/nextlove/src/generators/generate-route-types/index.ts
@@ -74,7 +74,8 @@ export const generateRouteTypes = async (opts: GenerateRouteTypesOpts) => {
     routeSpec.jsonResponse
       ? printNode(
           zodToTs(
-            setupParams.addOkStatus
+            setupParams.addOkStatus &&
+              routeSpec.jsonResponse instanceof z.ZodObject
               ? routeSpec.jsonResponse.extend({ ok: z.boolean() })
               : routeSpec.jsonResponse
           ).node

diff --git a/packages/nextlove/src/types/index.ts b/packages/nextlove/src/types/index.ts
@@ -24,7 +24,7 @@ export interface RouteSpec<
   QueryParams extends ParamDef = z.ZodObject<any, any, any, any, any>,
   CommonParams extends ParamDef = z.ZodObject<any, any, any, any, any>,
   Middlewares extends readonly Middleware<any, any>[] = any[],
-  JsonResponse extends ParamDef = z.ZodObject<any, any, any, any, any>,
+  JsonResponse extends ParamDef = z.ZodTypeAny,
   FormData extends ParamDef = z.ZodTypeAny
 > {
   methods: Methods
@@ -148,17 +148,6 @@ export type CreateWithRouteSpecFunction = <
   SP extends SetupParams<AuthMiddlewares, any>
 >(
   setupParams: SP
-) => <
-  RS extends RouteSpec<
-    string,
-    any,
-    any,
-    any,
-    any,
-    any,
-    z.ZodObject<any, any, any, any, any>,
-    any
-  >
->(
+) => <RS extends RouteSpec<string, any, any, any, any, any, z.ZodTypeAny, any>>(
   route_spec: RS
 ) => (next: RouteFunction<SP, RS>) => any
diff --git a/packages/nextlove/tests/route-spec-types.ts b/packages/nextlove/tests/route-spec-types.ts
@@ -186,3 +186,44 @@ export const myRoute7 = withRouteSpec(myRoute7Spec)(async (req, res) => {
   const errorApiResponse400 = res.status(400)
   expectTypeOf(errorApiResponse400.json).toMatchTypeOf<(body: any) => void>()
 })
+
+export const myRoute8Spec = {
+  auth: "none",
+  methods: ["GET"],
+  jsonResponse: z.array(z.object({ id: z.string() })),
+}
+
+export const myRoute8 = withRouteSpec(myRoute8Spec)(async (req, res) => {
+  const sucessfulApiResponse200 = res.status(200)
+  expectTypeOf(sucessfulApiResponse200.json).toMatchTypeOf<
+    (body: { id: string }[]) => void
+  >()
+  const sucessfulApiResponse201 = res.status(201)
+  expectTypeOf(sucessfulApiResponse201.json).toMatchTypeOf<
+    (body: { id: string }[]) => void
+  >()
+  const errorApiResponse400 = res.status(400)
+  expectTypeOf(errorApiResponse400.json).toMatchTypeOf<(body: any) => void>()
+})
+
+export const myRoute9Spec = {
+  auth: "none",
+  methods: ["GET"],
+  jsonResponse: z.union([
+    z.object({ id: z.string() }),
+    z.object({ name: z.string() }),
+  ]),
+}
+
+export const myRoute9 = withRouteSpec(myRoute9Spec)(async (req, res) => {
+  const sucessfulApiResponse200 = res.status(200)
+  expectTypeOf(sucessfulApiResponse200.json).toMatchTypeOf<
+    (body: { id: string } | { name: string }) => void
+  >()
+  const sucessfulApiResponse201 = res.status(201)
+  expectTypeOf(sucessfulApiResponse201.json).toMatchTypeOf<
+    (body: { id: string } | { name: string }) => void
+  >()
+  const errorApiResponse400 = res.status(400)
+  expectTypeOf(errorApiResponse400.json).toMatchTypeOf<(body: any) => void>()
+})