@openapi-qraft/react 1.1.4 → 1.2.0

package/src/callbacks/useIsFetching.ts

@@ -0,0 +1,35 @@
+'use client';
+
+import { useIsFetching as useIsFetchingTanstack } from '@tanstack/react-query';
+
+import { composeQueryFilters } from '../lib/composeQueryFilters.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import type { ServiceOperationQuery } from '../ServiceOperation.js';
+
+export const useIsFetching: <TVariables = unknown>(
+  qraftOptions: QraftClientOptions | undefined,
+  schema: OperationRequestSchema,
+  args: Parameters<
+    ServiceOperationQuery<
+      OperationRequestSchema,
+      object | undefined,
+      TVariables,
+      unknown
+    >['useIsFetching']
+  >
+) => number = (qraftOptions, schema, args) => {
+  const [filters, queryClientByArg] = args;
+
+  if (filters && 'parameters' in filters && 'mutationKey' in filters) {
+    throw new Error(
+      `'useMutationState': 'parameters' and 'mutationKey' cannot be used together`
+    );
+  }
+
+  return useIsFetchingTanstack(
+    composeQueryFilters(schema, filters) as never,
+    useQueryClient(qraftOptions, queryClientByArg)
+  ) as never;
+};

package/src/callbacks/useMutation.ts

@@ -6,13 +6,13 @@ import type { DefaultError } from '@tanstack/query-core';
 import {
   useMutation as useMutationBase,
   UseMutationResult,
-  useQueryClient,
 } from '@tanstack/react-query';
 
 import { composeMutationKey } from '../lib/composeMutationKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import {
   ServiceOperationMutation,
   ServiceOperationMutationKey,
@@ -25,10 +25,10 @@ export const useMutation: <
   TContext = unknown,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
     ServiceOperationMutation<
-      RequestClientSchema,
+      OperationRequestSchema,
       object | undefined,
       TVariables,
       TData
@@ -51,10 +51,8 @@ export const useMutation: <
       `'useMutation': parameters and 'options.mutationKey' cannot be used together`
     );
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
-
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
   const mutationKey =
     options && 'mutationKey' in options
@@ -72,22 +70,30 @@ export const useMutation: <
         options?.mutationFn ??
         (parameters
           ? function (bodyPayload) {
-              return requestClient(schema, {
-                parameters,
-                body: bodyPayload as never,
-              });
+              return contextValue.request(
+                { baseUrl: contextValue.baseUrl },
+                schema,
+                {
+                  parameters,
+                  body: bodyPayload as never,
+                }
+              );
             }
           : function (parametersAndBodyPayload) {
               const { body, ...parameters } = parametersAndBodyPayload as {
                 body: unknown;
               };
 
-              return requestClient(schema, {
-                body,
-                parameters,
-              } as never);
+              return contextValue.request(
+                { baseUrl: contextValue.baseUrl },
+                schema,
+                {
+                  body,
+                  parameters,
+                } as never
+              );
             }),
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useMutationState.ts

@@ -6,13 +6,12 @@ import type { DefaultError } from '@tanstack/query-core';
 import {
   UseMutationResult,
   useMutationState as useMutationStateTanstack,
-  useQueryClient,
 } from '@tanstack/react-query';
 
 import { composeMutationKey } from '../lib/composeMutationKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
-import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import { ServiceOperationMutation } from '../ServiceOperation.js';
 
 export const useMutationState: <
@@ -22,10 +21,10 @@ export const useMutationState: <
   TContext = unknown,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
     ServiceOperationMutation<
-      RequestClientSchema,
+      OperationRequestSchema,
       object | undefined,
       TVariables,
       TData
@@ -48,11 +47,6 @@ export const useMutationState: <
     );
   }
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
-
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
-
   const filters = options?.filters;
 
   return useMutationStateTanstack(
@@ -71,6 +65,6 @@ export const useMutationState: <
               ),
             },
     } as never,
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useQueries.ts

@@ -5,28 +5,30 @@ import { useContext } from 'react';
 import {
   QueriesResults,
   useQueries as useQueriesTanstack,
-  useQueryClient,
 } from '@tanstack/react-query';
 
 import { composeQueryKey } from '../lib/composeQueryKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import { ServiceOperationQuery } from '../ServiceOperation.js';
 
 export const useQueries: (
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
-    ServiceOperationQuery<RequestClientSchema, unknown, unknown>['useQueries']
+    ServiceOperationQuery<
+      OperationRequestSchema,
+      unknown,
+      unknown
+    >['useQueries']
   >
 ) => QueriesResults<never> = (qraftOptions, schema, args) => {
   const [options, queryClientByArg] = args;
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
-
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
   return useQueriesTanstack(
     {
@@ -51,15 +53,19 @@ export const useQueries: (
           queryFn:
             optionsWithQueryKey.queryFn ??
             function ({ queryKey: [, queryParams], signal, meta }) {
-              return requestClient(schema, {
-                parameters: queryParams as never,
-                signal,
-                meta,
-              });
+              return contextValue.request(
+                { baseUrl: contextValue.baseUrl },
+                schema,
+                {
+                  parameters: queryParams as never,
+                  signal,
+                  meta,
+                }
+              );
             },
         };
       }),
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useQuery.ts

@@ -5,14 +5,14 @@ import { useContext } from 'react';
 import type { DefaultError } from '@tanstack/query-core';
 import {
   useQuery as useQueryTanstack,
-  useQueryClient,
-  UseQueryResult,
+  type UseQueryResult,
 } from '@tanstack/react-query';
 
 import { composeQueryKey } from '../lib/composeQueryKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import {
   ServiceOperationQuery,
   ServiceOperationQueryKey,
@@ -20,21 +20,22 @@ import {
 
 export const useQuery: <TData = unknown, TError = DefaultError>(
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
-    ServiceOperationQuery<RequestClientSchema, unknown, unknown>['useQuery']
+    ServiceOperationQuery<OperationRequestSchema, unknown, unknown>['useQuery']
   >
 ) => UseQueryResult<TData, TError> = (qraftOptions, schema, args) => {
   const [parameters, options, queryClientByArg] = args;
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
-
-  const queryKey: ServiceOperationQueryKey<RequestClientSchema, unknown> =
+  const queryKey: ServiceOperationQueryKey<OperationRequestSchema, unknown> =
     Array.isArray(parameters)
-      ? (parameters as ServiceOperationQueryKey<RequestClientSchema, unknown>)
+      ? (parameters as ServiceOperationQueryKey<
+          OperationRequestSchema,
+          unknown
+        >)
       : composeQueryKey(schema, parameters);
 
   return useQueryTanstack(
@@ -44,13 +45,17 @@ export const useQuery: <TData = unknown, TError = DefaultError>(
       queryFn:
         options?.queryFn ??
         function ({ queryKey: [, queryParams], signal, meta }) {
-          return requestClient(schema, {
-            parameters: queryParams as never,
-            signal,
-            meta,
-          });
+          return contextValue.request(
+            { baseUrl: contextValue.baseUrl },
+            schema,
+            {
+              parameters: queryParams as never,
+              signal,
+              meta,
+            }
+          );
         },
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useSuspenseInfiniteQuery.ts

@@ -4,16 +4,16 @@ import { useContext } from 'react';
 
 import type { DefaultError, InfiniteData } from '@tanstack/query-core';
 import {
-  useQueryClient,
   useSuspenseInfiniteQuery as useSuspenseInfiniteQueryTanstack,
   UseSuspenseInfiniteQueryResult,
 } from '@tanstack/react-query';
 
 import { composeInfiniteQueryKey } from '../lib/composeInfiniteQueryKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
 import { shelfMerge } from '../lib/shelfMerge.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import {
   ServiceOperationInfiniteQueryKey,
   ServiceOperationQuery,
@@ -25,10 +25,10 @@ export const useSuspenseInfiniteQuery: <
   TData = InfiniteData<TQueryFnData>,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
     ServiceOperationQuery<
-      RequestClientSchema,
+      OperationRequestSchema,
       unknown,
       unknown
     >['useSuspenseInfiniteQuery']
@@ -40,13 +40,11 @@ export const useSuspenseInfiniteQuery: <
 ) => {
   const [parameters, options, queryClientByArg] = args;
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
-
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
   const queryKey: ServiceOperationInfiniteQueryKey<
-    RequestClientSchema,
+    OperationRequestSchema,
     unknown
   > = Array.isArray(parameters)
     ? (parameters as never)
@@ -59,13 +57,17 @@ export const useSuspenseInfiniteQuery: <
       queryFn:
         options?.queryFn ??
         function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
-          return requestClient(schema, {
-            parameters: shelfMerge(2, queryParams, pageParam) as never,
-            signal,
-            meta,
-          });
+          return contextValue.request(
+            { baseUrl: contextValue.baseUrl },
+            schema,
+            {
+              parameters: shelfMerge(2, queryParams, pageParam) as never,
+              signal,
+              meta,
+            }
+          );
         },
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useSuspenseQueries.ts

@@ -4,22 +4,22 @@ import { useContext } from 'react';
 
 import {
   SuspenseQueriesResults,
-  useQueryClient,
   useSuspenseQueries as useSuspenseQueriesTanstack,
 } from '@tanstack/react-query';
 
 import { composeQueryKey } from '../lib/composeQueryKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import { ServiceOperationQuery } from '../ServiceOperation.js';
 
 export const useSuspenseQueries: (
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
     ServiceOperationQuery<
-      RequestClientSchema,
+      OperationRequestSchema,
       unknown,
       unknown
     >['useSuspenseQueries']
@@ -27,10 +27,8 @@ export const useSuspenseQueries: (
 ) => SuspenseQueriesResults<never> = (qraftOptions, schema, args) => {
   const [options, queryClientByArg] = args;
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
-
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
   return useSuspenseQueriesTanstack(
     {
@@ -55,15 +53,19 @@ export const useSuspenseQueries: (
           queryFn:
             optionsWithQueryKey.queryFn ??
             function ({ queryKey: [, queryParams], signal, meta }) {
-              return requestClient(schema, {
-                parameters: queryParams as never,
-                signal,
-                meta,
-              });
+              return contextValue.request(
+                { baseUrl: contextValue.baseUrl },
+                schema,
+                {
+                  parameters: queryParams as never,
+                  signal,
+                  meta,
+                }
+              );
             },
         };
       }),
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/callbacks/useSuspenseQuery.ts

@@ -4,15 +4,15 @@ import { useContext } from 'react';
 
 import type { DefaultError } from '@tanstack/query-core';
 import {
-  useQueryClient,
   UseQueryResult,
   useSuspenseQuery as useSuspenseQueryTanstack,
 } from '@tanstack/react-query';
 
 import { composeQueryKey } from '../lib/composeQueryKey.js';
+import type { OperationRequestSchema } from '../lib/request.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
-import type { RequestClientSchema } from '../RequestClient.js';
 import {
   ServiceOperationQuery,
   ServiceOperationQueryKey,
@@ -24,10 +24,10 @@ export const useSuspenseQuery: <
   TData = TQueryFnData,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: Parameters<
     ServiceOperationQuery<
-      RequestClientSchema,
+      OperationRequestSchema,
       unknown,
       unknown
     >['useSuspenseQuery']
@@ -35,12 +35,10 @@ export const useSuspenseQuery: <
 ) => UseQueryResult<TData, TError> = (qraftOptions, schema, args) => {
   const [parameters, options, queryClientByArg] = args;
 
-  const { requestClient, queryClient: queryClientByContext } =
-    useContext(qraftOptions?.context ?? QraftContext) ?? {};
+  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
+  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
 
-  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
-
-  const queryKey: ServiceOperationQueryKey<RequestClientSchema, unknown> =
+  const queryKey: ServiceOperationQueryKey<OperationRequestSchema, unknown> =
     Array.isArray(parameters)
       ? (parameters as never)
       : composeQueryKey(schema, parameters);
@@ -52,13 +50,17 @@ export const useSuspenseQuery: <
       queryFn:
         options?.queryFn ??
         function ({ queryKey: [, queryParams], signal, meta }) {
-          return requestClient(schema, {
-            parameters: queryParams as never,
-            signal,
-            meta,
-          });
+          return contextValue.request(
+            { baseUrl: contextValue.baseUrl },
+            schema,
+            {
+              parameters: queryParams as never,
+              signal,
+              meta,
+            }
+          );
         },
     },
-    useQueryClient(queryClientByArg ?? queryClientByContext)
+    useQueryClient(qraftOptions, queryClientByArg)
   ) as never;
 };

package/src/index.ts

@@ -1,11 +1,16 @@
-export { qraftAPIClient } from './qraftAPIClient.js';
-export type { QraftClientOptions } from './qraftAPIClient.js';
-export { QraftContext } from './QraftContext.js';
-export type { QraftContextValue } from './QraftContext.js';
-export { request, urlSerializer, bodySerializer } from './lib/request.js';
-export type { APIRequestInit, HeadersOptions } from './lib/request.js';
+export { qraftAPIClient, type QraftClientOptions } from './qraftAPIClient.js';
+export { QraftContext, type QraftContextValue } from './QraftContext.js';
+export {
+  request,
+  baseRequest,
+  urlSerializer,
+  bodySerializer,
+  type OperationRequestInfo,
+  type OperationRequestSchema,
+  type RequestOptions,
+  type HeadersOptions,
+} from './lib/request.js';
 export type {
   ServiceOperationQuery,
   ServiceOperationMutation,
 } from './ServiceOperation.js';
-export type { RequestClient } from './RequestClient.js';

package/src/lib/callQueryClientMethodWithQueryFilters.ts

@@ -1,7 +1,7 @@
 import type { QueryClient } from '@tanstack/query-core';
 
-import type { RequestClientSchema } from '../RequestClient.js';
-import { composeQueryKey } from './composeQueryKey.js';
+import { composeQueryFilters } from './composeQueryFilters.js';
+import type { OperationRequestSchema } from './request.js';
 
 /**
  * Calls a query client method with query filters and options,
@@ -11,7 +11,7 @@ export function callQueryClientMethodWithQueryFilters<
   QFMethod extends QueryFilterMethods,
 >(
   queryFilterMethod: QFMethod,
-  schema: RequestClientSchema,
+  schema: OperationRequestSchema,
   args: [QueryClient, ...Parameters<(typeof QueryClient.prototype)[QFMethod]>]
 ): ReturnType<(typeof QueryClient.prototype)[QFMethod]> {
   const queryClient = (
@@ -24,7 +24,7 @@ export function callQueryClientMethodWithQueryFilters<
           : undefined
   ) as QueryClient | undefined;
 
-  const filters = composeFilters(
+  const filters = composeQueryFilters(
     schema,
     args.length === 1 ? undefined : args[0]
   );
@@ -44,42 +44,6 @@ export function callQueryClientMethodWithQueryFilters<
   return queryClient[queryFilterMethod](filters);
 }
 
-/**
- * Replaces the `parameters` field in the filters with a `queryKey` field based on the schema.
- * If no filters are provided, a `queryKey` will be composed schema's base query key.
- * @param schema
- * @param filters
- */
-function composeFilters<Filters extends object>(
-  schema: RequestClientSchema,
-  filters: Filters | undefined
-) {
-  if (!filters) {
-    return {
-      queryKey: composeQueryKey(schema, undefined),
-    };
-  }
-
-  if ('queryKey' in filters) {
-    return filters;
-  }
-
-  if ('parameters' in filters) {
-    const { parameters, ...filtersWithoutParameters } = filters;
-
-    Object.assign(filtersWithoutParameters, {
-      queryKey: composeQueryKey(schema, parameters),
-    });
-
-    return filtersWithoutParameters;
-  }
-
-  return {
-    ...filters,
-    queryKey: composeQueryKey(schema, undefined),
-  };
-}
-
 type QueryFiltersMethod<QFMethod extends keyof typeof QueryClient.prototype> =
   QFMethod;
 

package/src/lib/composeInfiniteQueryKey.ts

@@ -1,8 +1,8 @@
-import type { RequestClientSchema } from '../RequestClient.js';
-import { ServiceOperationInfiniteQueryKey } from '../ServiceOperation.js';
+import type { ServiceOperationInfiniteQueryKey } from '../ServiceOperation.js';
+import type { OperationRequestSchema } from './request.js';
 
 export function composeInfiniteQueryKey<
-  TSchema extends RequestClientSchema,
+  TSchema extends OperationRequestSchema,
   TParams,
 >(
   schema: TSchema,

package/src/lib/composeMutationKey.ts

@@ -1,26 +1,26 @@
-import type { RequestClientSchema } from '../RequestClient.js';
-import { ServiceOperationMutationKey } from '../ServiceOperation.js';
+import type { ServiceOperationMutationKey } from '../ServiceOperation.js';
+import type { OperationRequestSchema } from './request.js';
 
 /**
  * Omit `body` or `requestBody` from mutation parameters if exists
  * and return the rest of the parameters
  */
 export function composeMutationKey<
-  TSchema extends RequestClientSchema,
+  TSchema extends OperationRequestSchema,
   TParams = undefined,
 >(
   schema: TSchema,
   parameters: undefined
 ): ServiceOperationMutationKey<TSchema, undefined>;
 export function composeMutationKey<
-  TSchema extends RequestClientSchema,
+  TSchema extends OperationRequestSchema,
   TParams,
 >(
   schema: TSchema,
   parameters: TParams
 ): ServiceOperationMutationKey<TSchema, TParams>;
 export function composeMutationKey<
-  TSchema extends RequestClientSchema,
+  TSchema extends OperationRequestSchema,
   TParams = unknown,
 >(schema: TSchema, parameters: TParams | undefined) {
   return parameters === undefined