@openapi-qraft/react 2.4.0 → 2.5.0-beta.0

package/src/lib/requestFn.ts

@@ -178,12 +178,7 @@ export function bodySerializer(
   schema: OperationSchema,
   body: RequestFnInfo['body']
 ) {
-  if (
-    schema.method === 'get' ||
-    schema.method === 'head' ||
-    schema.method === 'options'
-  )
-    return undefined;
+  if (isReadOnlyOperation(schema)) return undefined;
 
   if (body === undefined || body === null) return undefined;
 
@@ -314,3 +309,22 @@ export type {
  * @deprecated use `RequestFnInfo` instead
  */
 export type RequestFnPayload = RequestFnInfo;
+
+function isReadOnlyOperation(operation: {
+  readonly method:
+    | 'get'
+    | 'put'
+    | 'post'
+    | 'patch'
+    | 'delete'
+    | 'options'
+    | 'head'
+    | 'trace';
+}) {
+  return (
+    operation.method === 'get' ||
+    operation.method === 'head' ||
+    operation.method === 'trace' ||
+    operation.method === 'options'
+  );
+}

package/src/lib/requestFnResponseRejecter.test.ts

@@ -0,0 +1,46 @@
+import { describe, expect, it } from 'vitest';
+import { requestFnResponseRejecter } from './requestFnResponseRejecter.js';
+
+describe('requestFnResponseRejecter', () => {
+  it('should throw error if input is an Error instance', () => {
+    const error = new Error('Test error');
+    expect(() => requestFnResponseRejecter(error)).toThrow(error);
+  });
+
+  it('should throw error from error property if input contains error field', () => {
+    const customError = new Error('Error from error property');
+    const responseWithError = { error: customError };
+    expect(() => requestFnResponseRejecter(responseWithError)).toThrow(
+      customError
+    );
+  });
+
+  it('should throw generic "Unhandled `requestFn` response" if input does not match known formats', () => {
+    const unknownResponse = { data: 'some data' };
+    expect(() =>
+      requestFnResponseRejecter(
+        // @ts-expect-error - invalid test case
+        unknownResponse
+      )
+    ).toThrow('Unhandled `requestFn` response');
+  });
+
+  it('should add source data to cause property when throwing unhandled response error', () => {
+    const unknownResponse = { data: 'some data' };
+
+    try {
+      requestFnResponseRejecter(
+        // @ts-expect-error - invalid test case
+        unknownResponse
+      );
+      expect.fail('Expected an error to be thrown');
+    } catch (error) {
+      if (error instanceof Error) {
+        expect(error.message).toBe('Unhandled `requestFn` response');
+        expect(error.cause).toBe(unknownResponse);
+      } else {
+        expect.fail('Thrown error should be an instance of Error');
+      }
+    }
+  });
+});

package/src/lib/requestFnResponseRejecter.ts

@@ -0,0 +1,11 @@
+import type { RequestFnResponse } from './requestFn.js';
+
+export function requestFnResponseRejecter<TData, TError>(
+  requestFnResponseOrError: RequestFnResponse<TData, TError> | Error
+): TData | undefined {
+  if (requestFnResponseOrError instanceof Error) throw requestFnResponseOrError;
+  if ('error' in requestFnResponseOrError) throw requestFnResponseOrError.error;
+  throw new Error('Unhandled `requestFn` response', {
+    cause: requestFnResponseOrError,
+  });
+}

package/src/lib/useComposeUseQueryOptions.ts

@@ -7,6 +7,7 @@ import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { OperationSchema } from './requestFn.js';
 import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
 import { composeQueryKey } from './composeQueryKey.js';
+import { requestFnResponseRejecter } from './requestFnResponseRejecter.js';
 import { requestFnResponseResolver } from './requestFnResponseResolver.js';
 import { shelfMerge } from './shelfMerge.js';
 
@@ -25,17 +26,23 @@ export function useComposeUseQueryOptions(
   const queryFn =
     options?.queryFn ??
     function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
+      const { body, ...parameters } = queryParams as {
+        body: BodyInit;
+        parameters: Record<string, unknown>;
+      };
+
       return qraftOptions
         .requestFn(schema, {
           // @ts-expect-error - Too complex to type
           parameters: infinite
-            ? (shelfMerge(2, queryParams, pageParam) as never)
-            : queryParams,
+            ? (shelfMerge(2, parameters, pageParam) as never)
+            : parameters,
           baseUrl: qraftOptions.baseUrl,
+          body,
           signal,
           meta,
         })
-        .then(requestFnResponseResolver, requestFnResponseResolver);
+        .then(requestFnResponseResolver, requestFnResponseRejecter);
     };
 
   const queryKey = Array.isArray(parameters)