[Feature] Add Raw Response

.changeset/purple-kids-juggle.md

@@ -0,0 +1,5 @@
+---
+"@softnetics/hono-react-query": minor
+---
+
+Add Raw Response to the response from the lib.

src/index.spec.tsx

@@ -9,7 +9,7 @@
 
 import { createReactQueryClient, HonoResponseError } from '.'
 
 const basicHonoApp = new Hono()
   .get('/users', (c) => {
     return c.json({ users: [{ id: 'id', name: 'John Doe' }] }, 200)
   })
@@ -51,7 +51,7 @@
       baseUrl: 'http://localhost:3000',
     })
 
     const queryOptions = client.queryOptions('/users/:id', '$get', {
       input: {
         param: { id: 'none' },
       },
@@ -71,19 +71,21 @@
             }
             status: 200
             format: 'json'
+            raw: Response
           }
         | {
             data: {
               error: string
             }
             status: 400
             format: 'json'
+            raw: Response
           },
         Error
       >
     >()
 
     const queryFn = () =>
       client.useQuery('/users/:id', '$get', {
         input: { param: { id: 'none' } },
         options: { throwOnError: false },
@@ -100,13 +102,15 @@
             }
             status: 200
             format: 'json'
+            raw: Response
           }
         | {
             data: {
               error: string
             }
             status: 400
             format: 'json'
+            raw: Response
           },
         Error
       >
@@ -118,7 +122,7 @@
       baseUrl: 'http://localhost:3000',
     })
 
     const queryOptions = client.queryOptions('/users/:id', '$get', {
       input: {
         param: { id: 'none' },
       },
@@ -135,12 +139,13 @@
           }
           status: 200
           format: 'json'
+          raw: Response
         },
         Error | HonoResponseError<{ error: string }, 400, 'json'>
       >
     >()
 
     const queryFn = () =>
       client.useQuery('/users/:id', '$get', {
         input: { param: { id: 'none' } },
         options: { throwOnError: true },
@@ -157,6 +162,7 @@
           }
           status: 200
           format: 'json'
+          raw: Response
         },
         | Error
         | HonoResponseError<
@@ -171,7 +177,7 @@
   })
 
   it('should create the query client with the correct types', () => {
     const client = createReactQueryClient<BasicHonoApp>({
       baseUrl: 'http://localhost:3000',
     })
 
@@ -196,10 +202,16 @@
     >()
 
     expectTypeOf<ReturnType<typeof client.useSetQueryData<'/users', '$post'>>>().toMatchTypeOf<
-      (data: { data: { user: { id: string; name: string } }; status: 201; format: 'json' }) => {
+      (data: {
         data: { user: { id: string; name: string } }
         status: 201
         format: 'json'
+        raw: Response
+      }) => {
+        data: { user: { id: string; name: string } }
+        status: 201
+        format: 'json'
+        raw: Response
       }
     >()
 

src/index.ts

@@ -56,6 +56,8 @@ function getter(obj: object, paths: string[]): any {
 }
 
 async function responseParser(response: Response, throwOnError?: boolean): Promise<any> {
+  const raw = response.clone()
+
   let data: any
   const contentType = response.headers.get('content-type')
   if (contentType?.includes('application/json')) {
@@ -74,6 +76,7 @@ async function responseParser(response: Response, throwOnError?: boolean): Promi
       : contentType?.includes('text/plain')
         ? 'text'
         : 'body',
+    raw,
   }
 
   if (response.ok || throwOnError === false) {

src/types.ts

@@ -37,7 +37,7 @@ type InferFunctionReturn<T> = T extends (...rest: any[]) => infer TReturn ? Awai
 
 type ClientResponseParser<T> =
   T extends ClientResponse<infer TData, infer TStatus, infer TFormat>
-    ? { data: TData; status: TStatus; format: TFormat }
+    ? { data: TData; status: TStatus; format: TFormat; raw: Response }
     : never
 
 type SuccessResponse<T> =