feat(core): do not require body for DELETE endpoints in contracts (#672)

Author: Gabrola

.changeset/late-bugs-destroy.md

@@ -0,0 +1,5 @@
+---
+'@ts-rest/core': minor
+---
+
+Do not require `body` to be defined for DELETE endpoints in contracts

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

@@ -126,6 +126,13 @@ const postsRouter = c.router({
       204: c.noBody(),
     },
   },
+  deletePostUndefinedBody: {
+    method: 'DELETE',
+    path: `/posts/:id`,
+    responses: {
+      204: c.noBody(),
+    },
+  },
 });
 
 // Three endpoints, two for posts, and one for health
@@ -610,6 +617,24 @@ describe('client', () => {
       expect(result.headers.has('Content-Length')).toBe(false);
       expect(result.headers.has('Content-Type')).toBe(false);
     });
+
+    it('w/ undefined body', async () => {
+      fetchMock.deleteOnce(
+        {
+          url: 'https://api.com/posts/1',
+        },
+        { status: 204 },
+      );
+
+      const result = await client.posts.deletePostUndefinedBody({
+        params: { id: '1' },
+      });
+
+      expect((result.body as Blob).size).toStrictEqual(0);
+      expect(result.status).toBe(204);
+      expect(result.headers.has('Content-Length')).toBe(false);
+      expect(result.headers.has('Content-Type')).toBe(false);
+    });
   });
 
   describe('multipart/form-data', () => {

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

@@ -263,13 +263,16 @@ export const fetchApi = (options: FetchApiOptions) => {
   };
 
   if (route.method !== 'GET') {
-    if (route.contentType === 'multipart/form-data') {
+    if ('contentType' in route && route.contentType === 'multipart/form-data') {
       fetcherArgs = {
         ...fetcherArgs,
         contentType: 'multipart/form-data',
         body: body instanceof FormData ? body : createFormData(body),
       };
-    } else if (route.contentType === 'application/x-www-form-urlencoded') {
+    } else if (
+      'contentType' in route &&
+      route.contentType === 'application/x-www-form-urlencoded'
+    ) {
       fetcherArgs = {
         ...fetcherArgs,
         contentType: 'application/x-www-form-urlencoded',

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

@@ -69,6 +69,14 @@ export type AppRouteMutation = AppRouteCommon & {
   body: ContractAnyType | ContractNoBodyType;
 };
 
+/**
+ * A mutation endpoint. In REST terms, one using POST, PUT,
+ * PATCH, or DELETE.
+ */
+export type AppRouteDeleteNoBody = AppRouteCommon & {
+  method: 'DELETE';
+};
+
 type ValidatedHeaders<
   T extends AppRoute,
   TOptions extends RouterOptions,
@@ -158,7 +166,7 @@ type ApplyOptions<
 /**
  * A union of all possible endpoint types.
  */
-export type AppRoute = AppRouteQuery | AppRouteMutation;
+export type AppRoute = AppRouteQuery | AppRouteMutation | AppRouteDeleteNoBody;
 export type AppRouteStrictStatusCodes = Omit<AppRoute, 'strictStatusCodes'> & {
   strictStatusCodes: true;
 };

libs/ts-rest/express/src/lib/ts-rest-express.ts

@@ -1,7 +1,5 @@
 import {
   AppRoute,
-  AppRouteMutation,
-  AppRouteQuery,
   AppRouter,
   checkZodSchema,
   HTTPStatusCode,
@@ -88,7 +86,7 @@ const recursivelyApplyExpressRouter = ({
 const validateRequest = (
   req: Request,
   res: Response,
-  schema: AppRouteQuery | AppRouteMutation,
+  schema: AppRoute,
   options: TsRestExpressOptions<AppRouter>,
 ) => {
   const paramsResult = checkZodSchema(req.params, schema.pathParams, {

libs/ts-rest/fastify/src/lib/ts-rest-fastify.ts

@@ -1,7 +1,5 @@
 import {
   AppRoute,
-  AppRouteMutation,
-  AppRouteQuery,
   AppRouter,
   checkZodSchema,
   FlattenAppRouter,
@@ -143,7 +141,7 @@ const isAppRouteImplementation = <TRoute extends AppRoute>(
 const validateRequest = (
   request: fastify.FastifyRequest,
   reply: fastify.FastifyReply,
-  schema: AppRouteQuery | AppRouteMutation,
+  schema: AppRoute,
   options: BaseRegisterRouterOptions,
 ) => {
   const paramsResult = checkZodSchema(request.params, schema.pathParams, {

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

@@ -236,7 +236,7 @@ export const generateOpenApi = (
     );
 
     const bodySchema =
-      path.route?.method !== 'GET'
+      path.route?.method !== 'GET' && 'body' in path.route
         ? getOpenApiSchemaFromZod(path.route.body)
         : null;
 
@@ -268,7 +268,7 @@ export const generateOpenApi = (
     );
 
     const contentType =
-      path.route?.method !== 'GET'
+      path.route?.method !== 'GET' && 'contentType' in path.route
         ? path.route?.contentType ?? 'application/json'
         : 'application/json';
 

libs/ts-rest/serverless/src/lib/router.ts

@@ -71,7 +71,7 @@ const recursivelyProcessContract = ({
 
 const validateRequest = <TPlatformArgs, TRequestExtension>(
   req: TsRestRequest,
-  schema: AppRouteQuery | AppRouteMutation,
+  schema: AppRoute,
   options: ServerlessHandlerOptions<TPlatformArgs, TRequestExtension>,
 ) => {
   const paramsResult = checkZodSchema(req.params, schema.pathParams, {