feat: Fix open-api body bug

Author: oliverbutler

.changeset/honest-numbers-battle.md

@@ -0,0 +1,10 @@
+---
+'@ts-rest/core': major
+'@ts-rest/express': major
+'@ts-rest/nest': major
+'@ts-rest/next': major
+'@ts-rest/open-api': major
+'@ts-rest/react-query': major
+---
+
+Migrate paths to a string rather than function

libs/example-contracts/src/lib/contract-blog.ts

@@ -9,14 +9,24 @@ export interface Post {
   published: boolean;
   tags: string[];
 }
+
+const PostSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  description: z.string().nullable(),
+  content: z.string().nullable(),
+  published: z.boolean().nullable(),
+  tags: z.array(z.string()),
+});
+
 const c = initContract();
 
 export const apiBlog = c.router({
   createPost: {
     method: 'POST',
     path: '/posts',
     responses: {
-      201: c.response<Post>(),
+      201: PostSchema,
     },
     body: z.object({
       title: z.string(),
@@ -29,7 +39,7 @@ export const apiBlog = c.router({
   updatePost: {
     method: 'PATCH',
     path: `/posts/:id`,
-    responses: { 200: c.response<Post>() },
+    responses: { 200: PostSchema },
     body: z.object({
       title: z.string().optional(),
       content: z.string().optional(),
@@ -42,8 +52,8 @@ export const apiBlog = c.router({
     method: 'DELETE',
     path: `/posts/:id`,
     responses: {
-      200: c.response<{ message: string }>(),
-      404: c.response<{ message: string }>(),
+      200: z.object({ message: z.string() }),
+      404: z.object({ message: z.string() }),
     },
     body: null,
     summary: 'Delete a post',
@@ -52,8 +62,8 @@ export const apiBlog = c.router({
     method: 'GET',
     path: `/posts/:id`,
     responses: {
-      200: c.response<Post>(),
-      404: c.response<null>(),
+      200: PostSchema,
+      404: z.null(),
     },
     query: null,
     summary: 'Get a post by id',
@@ -62,7 +72,7 @@ export const apiBlog = c.router({
     method: 'GET',
     path: '/posts',
     responses: {
-      200: c.response<{ posts: Post[]; total: number }>(),
+      200: z.object({ posts: PostSchema.array(), total: z.number() }),
     },
     query: z.object({
       take: z.string().transform(Number).optional(),

libs/ts-rest/core/src/lib/client.spec.ts

@@ -302,6 +302,7 @@ describe('client', () => {
 
       const result = await client.posts.patchPost({
         params: { id: '1' },
+        body: null,
       });
 
       expect(result).toStrictEqual({ body: value, status: 200 });
@@ -312,7 +313,7 @@ describe('client', () => {
         headers: {
           'Content-Type': 'application/json',
         },
-        body: JSON.stringify({}),
+        body: undefined,
       });
     });
   });

libs/ts-rest/core/src/lib/client.ts

@@ -9,10 +9,10 @@ import { HTTPStatusCode } from './status-codes';
 import { Without, ZodInferOrType } from './type-utils';
 
 type RecursiveProxyObj<T extends AppRouter> = {
-  [TKey in keyof T]: T[TKey] extends AppRouter
-    ? RecursiveProxyObj<T[TKey]>
-    : T[TKey] extends AppRoute
+  [TKey in keyof T]: T[TKey] extends AppRoute
     ? DataReturn<T[TKey]>
+    : T[TKey] extends AppRouter
+    ? RecursiveProxyObj<T[TKey]>
     : never;
 };
 

libs/ts-rest/open-api/src/lib/ts-rest-open-api.ts

@@ -38,13 +38,19 @@ const isZodObject = (body: unknown): body is ZodTypeAny => {
   return (body as ZodTypeAny)?.safeParse !== undefined;
 };
 
-const getResponseSchemaFromZod = (response: unknown) =>
-  isZodObject(response)
-    ? zodToJsonSchema(response, {
-        name: 'zodObject',
-        target: 'openApi3',
-      }).definitions['zodObject']
-    : undefined;
+const getResponseSchemaFromZod = (response: unknown) => {
+  const isZodObj = isZodObject(response);
+
+  if (!isZodObj) {
+    return null;
+  }
+  const schema = zodToJsonSchema(response, {
+    name: 'zodObject',
+    target: 'openApi3',
+  });
+
+  return schema.definitions['zodObject'];
+};
 
 export const generateOpenApi = (
   router: AppRouter,
@@ -66,8 +72,9 @@ export const generateOpenApi = (
       ?.map((param) => param.slice(1, -1));
 
     const bodySchema =
-      path.route?.method !== 'GET' &&
-      getResponseSchemaFromZod(path.route.responses);
+      path.route?.method !== 'GET'
+        ? getResponseSchemaFromZod(path.route.body)
+        : null;
 
     const responses = Object.keys(path.route.responses).reduce((acc, key) => {
       const keyAsNumber = Number(key);

libs/ts-rest/react-query/src/lib/ts-rest-client.ts

@@ -31,10 +31,10 @@ import {
 } from '@ts-rest/core';
 
 type RecursiveProxyObj<T extends AppRouter> = {
-  [TKey in keyof T]: T[TKey] extends AppRouter
-    ? RecursiveProxyObj<T[TKey]>
-    : T[TKey] extends AppRoute
+  [TKey in keyof T]: T[TKey] extends AppRoute
     ? Without<UseQueryArgs<T[TKey]>, never>
+    : T[TKey] extends AppRouter
+    ? RecursiveProxyObj<T[TKey]>
     : never;
 };
 

package.json

@@ -39,7 +39,7 @@
     "express": "4.18.1",
     "graphql": "^16.6.0",
     "next": "12.2.5",
-    "openapi3-ts": "^3.0.1",
+    "openapi3-ts": "^2.0.2",
     "postcss": "^8.4.16",
     "prism-react-renderer": "^1.2.1",
     "react": "18.2.0",

yarn.lock

@@ -11358,12 +11358,12 @@ open@^8.0.9, open@^8.4.0:
     is-docker "^2.1.1"
     is-wsl "^2.2.0"
 
-openapi3-ts@^3.0.1:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/openapi3-ts/-/openapi3-ts-3.0.1.tgz#8ea3da309b7409146bcd28282a54d193ceb824f4"
-  integrity sha512-PddTYhMx/RWOo7yT+XikkVaKwoe4YUDU2GXB6TlK6VJQQyvcezwBGSbCZqscAAdeLvGbpjWbSiPQyc9MSk9s4g==
+openapi3-ts@^2.0.2:
+  version "2.0.2"
+  resolved "https://registry.yarnpkg.com/openapi3-ts/-/openapi3-ts-2.0.2.tgz#a200dd838bf24c9086c8eedcfeb380b7eb31e82a"
+  integrity sha512-TxhYBMoqx9frXyOgnRHufjQfPXomTIHYKhSKJ6jHfj13kS8OEIhvmE8CTuQyKtjjWttAjX5DPxM1vmalEpo8Qw==
   dependencies:
-    yaml "^2.1.1"
+    yaml "^1.10.2"
 
 opener@^1.5.1, opener@^1.5.2:
   version "1.5.2"
@@ -15307,11 +15307,6 @@ yaml@^1.10.0, yaml@^1.10.2, yaml@^1.7.2:
   resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b"
   integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==
 
-yaml@^2.1.1:
-  version "2.1.1"
-  resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.1.1.tgz#1e06fb4ca46e60d9da07e4f786ea370ed3c3cfec"
-  integrity sha512-o96x3OPo8GjWeSLF+wOAbrPfhFOGY0W00GNaxCDv+9hkcDJEnev1yh8S7pgHF0ik6zc8sQLuL8hjHjJULZp8bw==
-
 yargs-parser@21.0.1, yargs-parser@^21.0.0, yargs-parser@^21.0.1:
   version "21.0.1"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.0.1.tgz#0267f286c877a4f0f728fceb6f8a3e4cb95c6e35"