fix: generate null type and return null data for the empty responses instead of an empty object {}

Author: radist2s

packages/react-client/src/lib/responseUtils.ts

@@ -9,7 +9,7 @@ export async function processResponse<TData, TError>(
 ): Promise<RequestFnResponse<TData, TError>> {
   if (response.status === 204 || response.headers.get('Content-Length') === '0')
     return (
-      response.ok ? { data: {}, response } : { error: {}, response }
+      response.ok ? { data: null, response } : { error: null, response }
     ) as RequestFnResponse<TData, TError>;
 
   const contentType = response.headers.get('Content-Type')?.toLowerCase();

packages/react-client/src/tests/msw/handlers.ts

@@ -143,6 +143,14 @@ export const handlers = [
       const query = getQueryParameters<Services['files']['deleteFiles']>(
         request.url
       );
+
+      if (query?.pendingOnly) {
+        return new HttpResponse(null, {
+          status: 204,
+          statusText: 'No pending files deleted',
+        });
+      }
+
       return HttpResponse.json({ query });
     }
   ),

packages/react-client/src/tests/qraftAPIClient.test.tsx

@@ -1202,6 +1202,34 @@ describe('Qraft uses Mutations', () => {
     });
   });
 
+  it('handles useMutations for 204 responses and returns `null` data', async () => {
+    const { qraft, queryClient } = createClient();
+
+    const { result } = renderHook(() => qraft.files.deleteFiles.useMutation(), {
+      wrapper: (props) => <Providers {...props} queryClient={queryClient} />,
+    });
+
+    act(() => {
+      result.current.mutate({ query: { pendingOnly: true } });
+    });
+
+    await waitFor(() => {
+      expect(result.current.data).toEqual(null);
+    });
+
+    result.current.data satisfies
+      | {
+          query?: {
+            all?: boolean;
+          };
+        }
+      | null
+      | undefined;
+
+    // @ts-expect-error - never satisfies never
+    result.current.data satisfies never;
+  });
+
   it('supports useMutation with predefined parameters', async () => {
     const { qraft, queryClient } = createClient();
 

packages/tanstack-query-react-plugin/src/__snapshots__/explicit-import-extensions/services/FilesService.ts.snapshot.ts

@@ -1332,15 +1332,15 @@ type DeleteFilesSchema = {
     url: "/files";
 };
 type DeleteFilesParameters = paths["/files"]["delete"]["parameters"];
-type DeleteFilesData = paths["/files"]["delete"]["responses"]["200"]["content"]["application/json"] | undefined;
+type DeleteFilesData = paths["/files"]["delete"]["responses"]["200"]["content"]["application/json"] | null;
 type DeleteFilesError = paths["/files"]["delete"]["responses"]["default"]["content"]["application/json"];
 type DeleteFilesBody = undefined;
 type TrashFilesSchema = {
     method: "delete";
     url: "/files/trash";
 };
 type TrashFilesParameters = paths["/files/trash"]["delete"]["parameters"];
-type TrashFilesData = paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/json"] | paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/octet-stream"] | undefined;
+type TrashFilesData = paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/json"] | paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/octet-stream"] | null;
 type TrashFilesError = paths["/files/trash"]["delete"]["responses"]["default"]["content"]["application/json"];
 type TrashFilesBody = undefined;
 type GetFileListSchema = {

packages/tanstack-query-react-plugin/src/__snapshots__/queryable-write-operations/services/FilesService.ts.snapshot.ts

@@ -2316,15 +2316,15 @@ type DeleteFilesSchema = {
     url: "/files";
 };
 type DeleteFilesParameters = paths["/files"]["delete"]["parameters"];
-type DeleteFilesData = paths["/files"]["delete"]["responses"]["200"]["content"]["application/json"] | undefined;
+type DeleteFilesData = paths["/files"]["delete"]["responses"]["200"]["content"]["application/json"] | null;
 type DeleteFilesError = paths["/files"]["delete"]["responses"]["default"]["content"]["application/json"];
 type DeleteFilesBody = undefined;
 type TrashFilesSchema = {
     method: "delete";
     url: "/files/trash";
 };
 type TrashFilesParameters = paths["/files/trash"]["delete"]["parameters"];
-type TrashFilesData = paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/json"] | paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/octet-stream"] | undefined;
+type TrashFilesData = paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/json"] | paths["/files/trash"]["delete"]["responses"]["200"]["content"]["application/octet-stream"] | null;
 type TrashFilesError = paths["/files/trash"]["delete"]["responses"]["default"]["content"]["application/json"];
 type TrashFilesBody = undefined;
 type GetFileListSchema = {

packages/tanstack-query-react-plugin/src/ts-factory/getServiceFactory.ts

@@ -338,7 +338,7 @@ const getOperationResponseFactory = (
     responses
       .map(([statusCode, mediaType]) => {
         if (mediaType === null)
-          return factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword);
+          return factory.createLiteralTypeNode(factory.createNull());
 
         if (!mediaType)
           return factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);