@openapi-qraft/react 1.14.0-beta.5 → 2.0.0-next.0

package/src/lib/callQueryClientFetchMethod.ts

@@ -1,7 +1,9 @@
 import type { QueryClient } from '@tanstack/query-core';
+import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { OperationSchema, RequestFn } from './requestFn.js';
 import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
 import { composeQueryKey } from './composeQueryKey.js';
+import { requestFnResponseResolver } from './requestFnResponseResolver.js';
 import { shelfMerge } from './shelfMerge.js';
 
 /**
@@ -11,68 +13,68 @@ import { shelfMerge } from './shelfMerge.js';
 export function callQueryClientMethodWithQueryKey<
   QFMethod extends QueryKeyMethods,
 >(
+  qraftOptions: CreateAPIQueryClientOptions,
   queryFilterMethod: QFMethod,
   schema: OperationSchema,
   infinite: boolean,
   args: QueryClientMethodArgs<QFMethod>
 ): ReturnType<(typeof QueryClient.prototype)[QFMethod]> {
-  const [{ requestFn, baseUrl, parameters, ...options }, queryClient] = args;
+  const {
+    requestFn: requestFnOption,
+    baseUrl: baseUrlOption,
+    queryFn: queryFnOption,
+    parameters,
+    ...options
+  } = args[0] ?? {};
 
-  if (!queryClient) throw new Error('queryClient is required');
-  if (!queryClient[queryFilterMethod])
-    throw new Error(
-      `queryClient is invalid, ${queryFilterMethod} method does not exist`
-    );
+  const queryClient = qraftOptions.queryClient;
+  const baseUrl = baseUrlOption ?? qraftOptions.baseUrl;
 
-  if (options.queryKey && parameters) {
+  if (queryFnOption && requestFnOption) {
     throw new Error(
-      'callQueryClientMethodWithQueryKey: options.queryKey and options.parameters are mutually exclusive'
+      'callQueryClientMethodWithQueryKey: options.queryFn and options.requestFn are mutually exclusive'
     );
   }
 
-  if (options.queryFn && requestFn) {
+  const requestFn = requestFnOption ?? qraftOptions.requestFn;
+
+  if (options.queryKey && parameters) {
     throw new Error(
-      'callQueryClientMethodWithQueryKey: options.queryFn and requestFn are mutually exclusive'
+      'callQueryClientMethodWithQueryKey: options.queryKey and options.parameters are mutually exclusive'
     );
   }
 
   const queryFn =
-    options.queryFn ??
-    (requestFn
-      ? // @ts-expect-error - Not inferring the correct type for `queryFn`
-        function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
-          return requestFn(schema, {
-            parameters: infinite
-              ? (shelfMerge(2, queryParams, pageParam) as never)
-              : queryParams,
-            baseUrl,
-            signal,
-            meta,
-          });
-        }
-      : undefined);
-
-  if (parameters) {
+    queryFnOption ??
     // @ts-expect-error - Too complex union to type
-    return queryClient[queryFilterMethod]({
-      ...options,
-      // Event if queryFn is undefined, it will override the default queryFn from `setQueryDefaults(...)`
-      ...(queryFn ? { queryFn } : {}),
-      queryKey: infinite
-        ? composeInfiniteQueryKey(schema, parameters)
-        : composeQueryKey(schema, parameters),
-    });
-  }
+    function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
+      return requestFn(schema, {
+        parameters: infinite
+          ? (shelfMerge(2, queryParams, pageParam) as never)
+          : queryParams,
+        baseUrl,
+        signal,
+        meta,
+      }).then(requestFnResponseResolver, requestFnResponseResolver);
+    };
 
   // @ts-expect-error - Too complex union to type
-  return queryClient[queryFilterMethod]({ ...options, queryFn });
+  return queryClient[queryFilterMethod]({
+    ...options,
+    queryFn,
+    queryKey:
+      options.queryKey ??
+      (infinite
+        ? composeInfiniteQueryKey(schema, parameters)
+        : composeQueryKey(schema, parameters)),
+  });
 }
 
 type QueryClientMethodArgs<QMethod extends keyof QueryClientPrototype> = [
   options: Parameters<QueryClientPrototype[QMethod]>[0] & {
     parameters?: unknown;
     baseUrl?: string;
-    requestFn?: RequestFn<unknown>;
+    requestFn?: RequestFn<unknown, unknown>;
   },
   queryClient: QueryClient,
 ];

package/src/lib/callQueryClientMethodWithMutationFilters.ts

@@ -1,4 +1,5 @@
 import type { QueryClient } from '@tanstack/query-core';
+import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { OperationSchema } from './requestFn.js';
 import { composeMutationFilters } from './composeMutationFilters.js';
 
@@ -9,24 +10,19 @@ import { composeMutationFilters } from './composeMutationFilters.js';
 export function callQueryClientMethodWithMutationFilters<
   QFMethod extends QueryFilterMethods,
 >(
+  qraftOptions: CreateAPIQueryClientOptions,
   queryFilterMethod: QFMethod,
   schema: OperationSchema,
   args: [...Parameters<(typeof QueryClient.prototype)[QFMethod]>, QueryClient]
 ): ReturnType<(typeof QueryClient.prototype)[QFMethod]> {
-  const filters = args.length > 1 ? args[0] : undefined;
-  const queryClient = args[args.length - 1] as QueryClient | undefined;
-
-  if (!queryClient) throw new Error('queryClient is required');
-  if (!queryClient[queryFilterMethod])
-    throw new Error(
-      `queryClient is invalid, ${queryFilterMethod} method does not exist`
-    );
+  const filters = args[0];
+  const queryClient = qraftOptions.queryClient;
 
   // @ts-expect-error - Too complex to type
   return queryClient[queryFilterMethod](
     composeMutationFilters(schema, filters as never),
     // @ts-expect-error - Argument types are too complex
-    ...args.slice(1, -1)
+    ...args.slice(1, args.length)
   );
 }
 

package/src/lib/callQueryClientMethodWithQueryFilters.ts

@@ -1,4 +1,5 @@
 import type { QueryClient } from '@tanstack/query-core';
+import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { OperationSchema } from './requestFn.js';
 import { composeQueryFilters } from './composeQueryFilters.js';
 
@@ -9,24 +10,19 @@ import { composeQueryFilters } from './composeQueryFilters.js';
 export function callQueryClientMethodWithQueryFilters<
   QFMethod extends QueryFilterMethods,
 >(
+  qraftOptions: CreateAPIQueryClientOptions,
   queryFilterMethod: QFMethod,
   schema: OperationSchema,
   args: [...Parameters<(typeof QueryClient.prototype)[QFMethod]>, QueryClient]
 ): ReturnType<(typeof QueryClient.prototype)[QFMethod]> {
-  const filters = args.length > 1 ? args[0] : undefined;
-  const queryClient = args[args.length - 1] as QueryClient | undefined;
-
-  if (!queryClient) throw new Error('queryClient is required');
-  if (!queryClient[queryFilterMethod])
-    throw new Error(
-      `queryClient is invalid, ${queryFilterMethod} method does not exist`
-    );
+  const filters = args[0];
+  const queryClient = qraftOptions.queryClient;
 
   // @ts-expect-error - Too complex to type
   return queryClient[queryFilterMethod](
     composeQueryFilters(schema, filters as never),
     // @ts-expect-error - Argument types are too complex
-    ...args.slice(1, -1)
+    ...args.slice(1, args.length)
   );
 }
 

package/src/lib/callQueryClientMethodWithQueryKey.ts

@@ -1,4 +1,5 @@
 import type { QueryClient } from '@tanstack/query-core';
+import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { OperationSchema } from './requestFn.js';
 import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
 import { composeQueryKey } from './composeQueryKey.js';
@@ -10,19 +11,13 @@ import { composeQueryKey } from './composeQueryKey.js';
 export function callQueryClientMethodWithQueryKey<
   QFMethod extends QueryKeyMethods,
 >(
-  queryFilterMethod: QFMethod,
+  qraftOptions: CreateAPIQueryClientOptions,
+  queryClientMethod: QFMethod,
   schema: OperationSchema,
   infinite: boolean,
   args: [...Parameters<(typeof QueryClient.prototype)[QFMethod]>, QueryClient]
 ): ReturnType<(typeof QueryClient.prototype)[QFMethod]> {
-  const parameters = args.length > 1 ? args[0] : undefined;
-  const queryClient = args[args.length - 1] as QueryClient | undefined;
-
-  if (!queryClient) throw new Error('queryClient is required');
-  if (!queryClient[queryFilterMethod])
-    throw new Error(
-      `queryClient is invalid, ${queryFilterMethod} method does not exist`
-    );
+  const parameters = args[0];
 
   const queryKey = Array.isArray(parameters)
     ? parameters
@@ -30,8 +25,13 @@ export function callQueryClientMethodWithQueryKey<
       ? composeInfiniteQueryKey(schema, parameters)
       : composeQueryKey(schema, parameters);
 
+  const queryClient = qraftOptions.queryClient;
+
   // @ts-expect-error - Too complex to type
-  return queryClient[queryFilterMethod](queryKey, ...args.slice(1, -1));
+  return queryClient[queryClientMethod](
+    queryKey,
+    ...args.slice(1, args.length)
+  );
 }
 
 type QueryKeyMethod<QFMethod extends keyof typeof QueryClient.prototype> =

package/src/lib/requestFn.ts

@@ -11,12 +11,12 @@
  *
  * @throws {error: object|string, response: Response} Throws an error if the request fails. The error includes the error message and the response from the server.
  */
-export async function requestFn<T>(
+export async function requestFn<TData, TError>(
   schema: OperationSchema,
   requestInfo: RequestFnInfo,
   options?: RequestFnOptions
-): Promise<T> {
-  return baseRequestFn(schema, requestInfo, {
+): Promise<RequestFnResponse<TData, TError>> {
+  return baseRequestFn<TData, TError>(schema, requestInfo, {
     urlSerializer,
     bodySerializer,
     ...options,
@@ -39,46 +39,36 @@ export async function requestFn<T>(
  *
  * @throws {error: object|string, response: Response} Throws an error if the request fails. The error includes the error message and the response from the server.
  */
-export async function baseRequestFn<T>(
+export async function baseRequestFn<TData, TError>(
   requestSchema: OperationSchema,
   requestInfo: RequestFnInfo,
   options: WithRequired<RequestFnOptions, 'urlSerializer' | 'bodySerializer'>
-): Promise<T> {
+): Promise<RequestFnResponse<TData, TError>> {
   const { parameters, headers, body, ...requestInfoRest } = requestInfo;
 
   const requestBody = options.bodySerializer(requestSchema, requestInfo);
 
   const baseFetch = options.fetch ?? fetch;
 
-  const response = await baseFetch(
-    options.urlSerializer(requestSchema, requestInfo),
-    {
-      method: requestSchema.method.toUpperCase(),
-      body: requestBody,
-      headers: mergeHeaders(
-        {
-          Accept: 'application/json',
-          'Content-Type': requestSchema.mediaType ?? getBodyContentType(body),
-        },
-        headers,
-        parameters?.header,
-        requestBody instanceof FormData
-          ? // remove `Content-Type` if serialized body is FormData; browser will correctly set Content-Type & boundary expression
-            { 'Content-Type': null }
-          : undefined
-      ),
-      ...requestInfoRest,
-    }
-  );
-
-  // clone response to allow multiple reads
-  const clonedResponse = response.clone();
-
-  if (!response.ok) {
-    throw await getResponseBody(clonedResponse);
-  }
-
-  return (await getResponseBody(clonedResponse)) as T;
+  return baseFetch(options.urlSerializer(requestSchema, requestInfo), {
+    method: requestSchema.method.toUpperCase(),
+    body: requestBody,
+    headers: mergeHeaders(
+      {
+        Accept: 'application/json',
+        'Content-Type': requestSchema.mediaType ?? getBodyContentType(body),
+      },
+      headers,
+      parameters?.header,
+      requestBody instanceof FormData
+        ? // remove `Content-Type` if the serialized body is FormData; the browser will correctly set Content-Type & boundary expression
+          { 'Content-Type': null }
+        : undefined
+    ),
+    ...requestInfoRest,
+  })
+    .then(processResponse as typeof processResponse<TData, TError>)
+    .catch(resolveResponse as typeof resolveResponse<TData, TError>);
 }
 
 /**
@@ -257,32 +247,72 @@ function getBodyContentType(body: RequestFnPayload['body']) {
   if (!(body instanceof FormData)) return 'application/json';
 }
 
-async function getResponseBody<T>(response: Response): Promise<T | undefined> {
+async function processResponse<TData, TError>(
+  response: Response
+): Promise<RequestFnResponse<TData, TError>> {
   if (response.status === 204 || response.headers.get('Content-Length') === '0')
-    return undefined;
-
-  const contentType = response.headers.get('Content-Type')?.toLowerCase();
-  const isJSON =
-    contentType?.includes('/json') || contentType?.includes('+json');
+    return (
+      response.ok ? { data: {}, response } : { error: {}, response }
+    ) as RequestFnResponse<TData, TError>;
+
+  if (isJsonResponse(response)) {
+    // clone response before parsing every time to allow multiple reads
+    const jsonResponse = response.clone().json();
+    return resolveResponse(
+      response,
+      response.ok ? jsonResponse : Promise.reject(await jsonResponse)
+    );
+  }
 
-  if (isJSON) {
+  const jsonResponse = new Promise<TData>((resolve, reject) =>
     // attempt to parse JSON for successful responses, otherwise fail
-    if (response.ok) return response.json();
+    response.clone().text().then(JSON.parse).then(resolve, reject)
+  );
 
-    const errorFallbackResponse = response.clone(); // clone to allow multiple reads
+  return resolveResponse(
+    response,
+    response.ok ? jsonResponse : Promise.reject(await jsonResponse)
+  );
+}
 
-    return response.json().catch(() => {
-      if (process.env.NODE_ENV === 'development') {
-        console.warn(
-          'Failed to parse response body as JSON. Falling back to .text()'
-        );
-      }
-      // falling back to .text() when necessary for error messages
-      return errorFallbackResponse.text();
+function isJsonResponse(response: Response) {
+  const contentType = response.headers.get('Content-Type')?.toLowerCase();
+  return contentType?.includes('/json') || contentType?.includes('+json');
+}
+
+function resolveResponse<TData, TError>(
+  error: Error
+): Promise<RequestFnResponse<TData, TError>>;
+function resolveResponse<TData, TError>(
+  responseToReturn: Response,
+  responsePromise: Promise<TData>
+): Promise<RequestFnResponse<TData, TError>>;
+function resolveResponse<TData, TError>(
+  responseToReturn: Response | Error,
+  responsePromise?: Promise<TData>
+): Promise<RequestFnResponse<TData, TError>> {
+  if (!responsePromise)
+    return Promise.reject({
+      error: responseToReturn,
+      response: undefined,
+      data: undefined,
     });
-  }
 
-  return response.text() as Promise<T>;
+  return responsePromise
+    .then(
+      (data) =>
+        ({ data, response: responseToReturn }) as RequestFnResponse<
+          TData,
+          TError
+        >
+    )
+    .catch(
+      (error) =>
+        ({ error, response: responseToReturn }) as RequestFnResponse<
+          TData,
+          TError
+        >
+    );
 }
 
 // To have definitely typed headers without a conversion to stings
@@ -324,7 +354,7 @@ export interface RequestFnPayload {
    * Base URL to use for the request
    * @example 'https://api.example.com'
    */
-  baseUrl: string | undefined;
+  baseUrl?: string;
 
   /**
    * OpenAPI parameters
@@ -370,7 +400,26 @@ export interface RequestFnOptions {
   fetch?: typeof fetch;
 }
 
-export type RequestFn<T> = typeof requestFn<T>;
+export type RequestFn<TData, TError> = typeof requestFn<TData, TError>;
+
+export type RequestFnResponse<TData, TError> =
+  | {
+      data?: TData;
+      response: Response;
+      error?: never;
+    }
+  | {
+      // server error
+      error?: TError | Error;
+      response: Response;
+      data?: never;
+    }
+  | {
+      // network error
+      error?: Error;
+      data?: never;
+      response?: never;
+    };
 
 type WithRequired<T, K extends keyof T> = T & {
   [_ in K]: {};

package/src/lib/requestFnResponseResolver.ts

@@ -0,0 +1,8 @@
+import { RequestFnResponse } from './requestFn.js';
+
+export function requestFnResponseResolver<TData, TError>(
+  requestFnResponse: RequestFnResponse<TData, TError>
+): TData | undefined {
+  if ('error' in requestFnResponse) throw requestFnResponse.error;
+  return requestFnResponse.data;
+}

package/src/lib/urlSerializer.test.ts

@@ -45,7 +45,6 @@ describe('urlSerializer', () => {
     expect(
       urlSerializer(
         { url: '/users/{userId}/posts', method: 'get' },
-        // @ts-expect-error - Missing baseUrl fallback
         {
           parameters: { path: { userId: '123' } },
         }

package/src/lib/useComposeUseQueryOptions.ts

@@ -2,46 +2,41 @@
 
 import type { QueryClient } from '@tanstack/query-core';
 import type { UseQueryOptions } from '@tanstack/react-query';
-import type { QraftClientOptions } from '../qraftAPIClient.js';
+import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
 import type { ServiceOperationQueryKey } from '../service-operation/ServiceOperationKey.js';
 import type { OperationSchema } from './requestFn.js';
-import { useContext } from 'react';
-import { QraftContext } from '../QraftContext.js';
 import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
 import { composeQueryKey } from './composeQueryKey.js';
+import { requestFnResponseResolver } from './requestFnResponseResolver.js';
 import { shelfMerge } from './shelfMerge.js';
-import { useQueryClient } from './useQueryClient.js';
 
 /**
  * Composes the options for useQuery, useInfiniteQuery, useSuspenseQuery, and useSuspenseQueries.
  * @internal
  */
 export function useComposeUseQueryOptions(
-  qraftOptions: QraftClientOptions | undefined,
+  qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: UseQueryOptionsArgs,
   infinite: boolean
 ): never {
-  const [parameters, options, queryClient] = args;
-
-  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  const [parameters, options] = args;
 
   const queryFn =
     options?.queryFn ??
     // @ts-expect-error - Too complex to type
     function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
-      if (!contextValue?.requestFn)
-        throw new Error(`QraftContext.requestFn not found`);
-
-      return contextValue.requestFn(schema, {
-        // @ts-expect-error - Too complex to type
-        parameters: infinite
-          ? (shelfMerge(2, queryParams, pageParam) as never)
-          : queryParams,
-        baseUrl: contextValue.baseUrl,
-        signal,
-        meta,
-      });
+      return qraftOptions
+        .requestFn(schema, {
+          // @ts-expect-error - Too complex to type
+          parameters: infinite
+            ? (shelfMerge(2, queryParams, pageParam) as never)
+            : queryParams,
+          baseUrl: qraftOptions.baseUrl,
+          signal,
+          meta,
+        })
+        .then(requestFnResponseResolver, requestFnResponseResolver);
     };
 
   const queryKey = Array.isArray(parameters)
@@ -50,10 +45,7 @@ export function useComposeUseQueryOptions(
       ? composeInfiniteQueryKey(schema, parameters)
       : composeQueryKey(schema, parameters);
 
-  return [
-    { ...options, queryFn, queryKey },
-    useQueryClient(qraftOptions, queryClient),
-  ] as never;
+  return [{ ...options, queryFn, queryKey }, qraftOptions.queryClient] as never;
 }
 
 type UseQueryOptionsArgs = [