@openapi-qraft/react 1.2.0 → 1.4.0

package/src/callbacks/isFetching.ts

@@ -1,14 +1,14 @@
 import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { ServiceOperationIsFetchingQueriesCallback } from '../ServiceOperation.js';
 
 export function isFetching<TData>(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationIsFetchingQueriesCallback<
-      OperationRequestSchema,
+      OperationSchema,
       unknown,
       TData
     >['isFetching']

package/src/callbacks/isMutating.ts

@@ -0,0 +1,22 @@
+import { callQueryClientMethodWithMutationFilters } from '../lib/callQueryClientMethodWithMutationFilters.js';
+import type { OperationSchema } from '../lib/requestFn.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { ServiceOperationIsMutatingQueriesCallback } from '../ServiceOperation.js';
+
+export function isMutating<TData>(
+  _: QraftClientOptions | undefined,
+  schema: OperationSchema,
+  args: Parameters<
+    ServiceOperationIsMutatingQueriesCallback<
+      OperationSchema,
+      unknown,
+      TData
+    >['isMutating']
+  >
+): Promise<void> {
+  return callQueryClientMethodWithMutationFilters(
+    'isMutating',
+    schema,
+    args as never
+  ) as never;
+}

package/src/callbacks/mutationFn.ts

@@ -1,15 +1,15 @@
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { ServiceOperationMutation } from '../ServiceOperation.js';
 
 export const mutationFn = (
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: unknown
 ) => {
   const [client, options] = args as Parameters<
     ServiceOperationMutation<
-      OperationRequestSchema,
+      OperationSchema,
       unknown,
       unknown,
       never

package/src/callbacks/prefetchInfiniteQuery.ts

@@ -0,0 +1,22 @@
+import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { ServiceOperationQuery } from '../ServiceOperation.js';
+
+export const prefetchInfiniteQuery: <
+  TSchema extends { url: string; method: 'get' | 'head' | 'options' },
+  TData,
+  TParams,
+>(
+  _: QraftClientOptions | undefined,
+  schema: TSchema,
+  args: Parameters<
+    ServiceOperationQuery<TSchema, TData, TParams>['prefetchInfiniteQuery']
+  >
+) => Promise<TData> = (_, schema, args) => {
+  return callQueryClientMethodWithQueryKey(
+    'prefetchInfiniteQuery',
+    schema,
+    true,
+    args as never
+  ) as never;
+};

package/src/callbacks/prefetchQuery.ts

@@ -0,0 +1,22 @@
+import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientFetchMethod.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { ServiceOperationQuery } from '../ServiceOperation.js';
+
+export const prefetchQuery: <
+  TSchema extends { url: string; method: 'get' | 'head' | 'options' },
+  TData,
+  TParams,
+>(
+  _: QraftClientOptions | undefined,
+  schema: TSchema,
+  args: Parameters<
+    ServiceOperationQuery<TSchema, TData, TParams>['prefetchQuery']
+  >
+) => Promise<TData> = (_, schema, args) => {
+  return callQueryClientMethodWithQueryKey(
+    'prefetchQuery',
+    schema,
+    false,
+    args as never
+  ) as never;
+};

package/src/callbacks/queryFn.ts

@@ -12,9 +12,9 @@ export const queryFn: <
 ) => Promise<TData> = (_, schema, args) => {
   const [options, client] = args;
 
-  return client('queryKey' in options ? options.queryKey[0] : schema, {
+  return client('queryKey' in options ? options.queryKey![0] : schema, {
     parameters:
-      'queryKey' in options ? options.queryKey[1] : options.parameters,
+      'queryKey' in options ? options.queryKey![1] : options.parameters,
     meta: options.meta,
     signal: options.signal,
   }) as Promise<never>;

package/src/callbacks/refetchQueries.ts

@@ -1,14 +1,14 @@
 import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import type { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
 
 export function refetchQueries<TData>(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationResetQueriesCallback<
-      OperationRequestSchema,
+      OperationSchema,
       unknown,
       TData
     >['refetchQueries']

package/src/callbacks/removeQueries.ts

@@ -0,0 +1,22 @@
+import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
+import type { OperationSchema } from '../lib/requestFn.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { ServiceOperationRemoveQueriesCallback } from '../ServiceOperation.js';
+
+export function removeQueries<TData>(
+  _: QraftClientOptions | undefined,
+  schema: OperationSchema,
+  args: Parameters<
+    ServiceOperationRemoveQueriesCallback<
+      OperationSchema,
+      unknown,
+      TData
+    >['removeQueries']
+  >
+): Promise<void> {
+  return callQueryClientMethodWithQueryFilters(
+    'removeQueries',
+    schema,
+    args as never
+  ) as never;
+}

package/src/callbacks/resetQueries.ts

@@ -1,14 +1,14 @@
 import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import type { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
 
 export function resetQueries<TData>(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationResetQueriesCallback<
-      OperationRequestSchema,
+      OperationSchema,
       unknown,
       TData
     >['resetQueries']

package/src/callbacks/setInfiniteQueryData.ts

@@ -1,32 +1,25 @@
 import { InfiniteData } from '@tanstack/query-core';
 
-import { composeInfiniteQueryKey } from '../lib/composeInfiniteQueryKey.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientMethodWithQueryKey.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
-import type {
-  ServiceOperationInfiniteQueryKey,
-  ServiceOperationQuery,
-} from '../ServiceOperation.js';
+import type { ServiceOperationQuery } from '../ServiceOperation.js';
 
 export function setInfiniteQueryData<TData>(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationQuery<
-      OperationRequestSchema,
+      OperationSchema,
       unknown,
       TData
     >['setInfiniteQueryData']
   >
 ): InfiniteData<TData> | undefined {
-  const [parameters, updater, queryClient, options] = args;
-
-  const queryKey: ServiceOperationInfiniteQueryKey<
-    OperationRequestSchema,
-    unknown
-  > = Array.isArray(parameters)
-    ? parameters
-    : composeInfiniteQueryKey(schema, parameters);
-
-  return queryClient.setQueryData(queryKey, updater as never, options);
+  return callQueryClientMethodWithQueryKey(
+    'setQueryData',
+    schema,
+    true,
+    args as never
+  ) as never;
 }

package/src/callbacks/setQueryData.ts

@@ -1,28 +1,23 @@
-import { composeQueryKey } from '../lib/composeQueryKey.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import { callQueryClientMethodWithQueryKey } from '../lib/callQueryClientMethodWithQueryKey.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
-import {
-  ServiceOperationQuery,
-  ServiceOperationQueryKey,
-} from '../ServiceOperation.js';
+import type { ServiceOperationSetQueryDataCallback } from '../ServiceOperation.js';
 
 export function setQueryData<TData>(
-  qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  _: QraftClientOptions | undefined,
+  schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<
-      OperationRequestSchema,
+    ServiceOperationSetQueryDataCallback<
+      OperationSchema,
       unknown,
       TData
     >['setQueryData']
   >
 ): TData | undefined {
-  const [parameters, updater, queryClient, options] = args;
-
-  const queryKey: ServiceOperationQueryKey<OperationRequestSchema, unknown> =
-    Array.isArray(parameters)
-      ? parameters
-      : composeQueryKey(schema, parameters);
-
-  return queryClient.setQueryData(queryKey, updater as never, options);
+  return callQueryClientMethodWithQueryKey(
+    'setQueryData',
+    schema,
+    false,
+    args as never
+  ) as never;
 }

package/src/callbacks/useInfiniteQuery.ts

@@ -1,23 +1,15 @@
 'use client';
 
-import { useContext } from 'react';
-
 import type { DefaultError, InfiniteData } from '@tanstack/query-core';
 import {
   useInfiniteQuery as useInfiniteQueryBase,
-  UseInfiniteQueryResult,
+  type UseInfiniteQueryResult,
 } 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 { OperationSchema } from '../lib/requestFn.js';
+import { useComposeUseQueryOptions } from '../lib/useComposeUseQueryOptions.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
-import { QraftContext } from '../QraftContext.js';
-import {
-  ServiceOperationInfiniteQueryKey,
-  ServiceOperationQuery,
-} from '../ServiceOperation.js';
+import type { ServiceOperationQuery } from '../ServiceOperation.js';
 
 export const useInfiniteQuery: <
   TQueryFnData,
@@ -25,45 +17,13 @@ export const useInfiniteQuery: <
   TData = InfiniteData<TQueryFnData>,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<
-      OperationRequestSchema,
-      unknown,
-      unknown
-    >['useInfiniteQuery']
+    ServiceOperationQuery<OperationSchema, unknown, unknown>['useInfiniteQuery']
   >
 ) => UseInfiniteQueryResult<TData, TError> = (qraftOptions, schema, args) => {
-  const [parameters, options, queryClientByArg] = args;
-
-  const contextValue = useContext(qraftOptions?.context ?? QraftContext);
-  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
-
-  const queryKey: ServiceOperationInfiniteQueryKey<
-    OperationRequestSchema,
-    unknown
-  > = Array.isArray(parameters)
-    ? (parameters as never)
-    : composeInfiniteQueryKey(schema, parameters);
-
   return useInfiniteQueryBase(
-    {
-      ...options,
-      queryKey,
-      queryFn:
-        options?.queryFn ??
-        function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
-          return contextValue.request(
-            { baseUrl: contextValue.baseUrl },
-            schema,
-            {
-              parameters: shelfMerge(2, queryParams, pageParam) as never,
-              signal,
-              meta,
-            }
-          );
-        },
-    },
-    useQueryClient(qraftOptions, queryClientByArg)
+    // @ts-expect-error
+    ...useComposeUseQueryOptions(qraftOptions, schema, args, true)
   ) as never;
 };

package/src/callbacks/useIsFetching.ts

@@ -3,17 +3,17 @@
 import { useIsFetching as useIsFetchingTanstack } from '@tanstack/react-query';
 
 import { composeQueryFilters } from '../lib/composeQueryFilters.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.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,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationQuery<
-      OperationRequestSchema,
+      OperationSchema,
       object | undefined,
       TVariables,
       unknown
@@ -22,12 +22,6 @@ export const useIsFetching: <TVariables = unknown>(
 ) => 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)

package/src/callbacks/useIsMutating.ts

@@ -0,0 +1,42 @@
+'use client';
+
+import type { DefaultError } from '@tanstack/query-core';
+import {
+  UseMutationResult,
+  useIsMutating as useIsMutatingStateTanstack,
+} from '@tanstack/react-query';
+
+import { composeMutationFilters } from '../lib/composeMutationFilters.js';
+import type { OperationSchema } from '../lib/requestFn.js';
+import { useQueryClient } from '../lib/useQueryClient.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { ServiceOperationMutation } from '../ServiceOperation.js';
+
+export const useIsMutating: <
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TContext = unknown,
+>(
+  _: QraftClientOptions | undefined,
+  schema: OperationSchema,
+  args: Parameters<
+    ServiceOperationMutation<
+      OperationSchema,
+      object | undefined,
+      TVariables,
+      TData
+    >['useIsMutating']
+  >
+) => UseMutationResult<TData, TError, TVariables, TContext> = (
+  qraftOptions,
+  schema,
+  args
+) => {
+  const [filters, queryClientByArg] = args;
+
+  return useIsMutatingStateTanstack(
+    composeMutationFilters(schema, filters) as never,
+    useQueryClient(qraftOptions, queryClientByArg)
+  ) as never;
+};

package/src/callbacks/useMutation.ts

@@ -9,7 +9,7 @@ import {
 } from '@tanstack/react-query';
 
 import { composeMutationKey } from '../lib/composeMutationKey.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
@@ -25,10 +25,10 @@ export const useMutation: <
   TContext = unknown,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationMutation<
-      OperationRequestSchema,
+      OperationSchema,
       object | undefined,
       TVariables,
       TData
@@ -52,7 +52,8 @@ export const useMutation: <
     );
 
   const contextValue = useContext(qraftOptions?.context ?? QraftContext);
-  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
+  if (!contextValue?.requestFn)
+    throw new Error(`QraftContext.request not found`);
 
   const mutationKey =
     options && 'mutationKey' in options
@@ -70,28 +71,22 @@ export const useMutation: <
         options?.mutationFn ??
         (parameters
           ? function (bodyPayload) {
-              return contextValue.request(
-                { baseUrl: contextValue.baseUrl },
-                schema,
-                {
-                  parameters,
-                  body: bodyPayload as never,
-                }
-              );
+              return contextValue.requestFn(schema, {
+                parameters,
+                baseUrl: contextValue.baseUrl,
+                body: bodyPayload as never,
+              });
             }
           : function (parametersAndBodyPayload) {
               const { body, ...parameters } = parametersAndBodyPayload as {
                 body: unknown;
               };
 
-              return contextValue.request(
-                { baseUrl: contextValue.baseUrl },
-                schema,
-                {
-                  body,
-                  parameters,
-                } as never
-              );
+              return contextValue.requestFn(schema, {
+                parameters,
+                baseUrl: contextValue.baseUrl,
+                body,
+              } as never);
             }),
     },
     useQueryClient(qraftOptions, queryClientByArg)

package/src/callbacks/useMutationState.ts

@@ -1,15 +1,13 @@
 'use client';
 
-import { useContext } from 'react';
-
 import type { DefaultError } from '@tanstack/query-core';
 import {
   UseMutationResult,
   useMutationState as useMutationStateTanstack,
 } from '@tanstack/react-query';
 
-import { composeMutationKey } from '../lib/composeMutationKey.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import { composeMutationFilters } from '../lib/composeMutationFilters.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { ServiceOperationMutation } from '../ServiceOperation.js';
@@ -21,10 +19,10 @@ export const useMutationState: <
   TContext = unknown,
 >(
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
     ServiceOperationMutation<
-      OperationRequestSchema,
+      OperationSchema,
       object | undefined,
       TVariables,
       TData
@@ -37,33 +35,10 @@ export const useMutationState: <
 ) => {
   const [options, queryClientByArg] = args;
 
-  if (
-    options?.filters &&
-    'parameters' in options.filters &&
-    'mutationKey' in options.filters
-  ) {
-    throw new Error(
-      `'useMutationState': 'parameters' and 'mutationKey' cannot be used together`
-    );
-  }
-
-  const filters = options?.filters;
-
   return useMutationStateTanstack(
     {
       ...options,
-      filters:
-        filters && 'mutationKey' in filters
-          ? filters
-          : {
-              ...filters,
-              mutationKey: composeMutationKey(
-                schema,
-                filters && 'parameters' in filters
-                  ? filters.parameters
-                  : undefined
-              ),
-            },
+      filters: composeMutationFilters(schema, options?.filters),
     } as never,
     useQueryClient(qraftOptions, queryClientByArg)
   ) as never;

package/src/callbacks/useQueries.ts

@@ -8,7 +8,7 @@ import {
 } from '@tanstack/react-query';
 
 import { composeQueryKey } from '../lib/composeQueryKey.js';
-import type { OperationRequestSchema } from '../lib/request.js';
+import type { OperationSchema } from '../lib/requestFn.js';
 import { useQueryClient } from '../lib/useQueryClient.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
@@ -16,19 +16,16 @@ import { ServiceOperationQuery } from '../ServiceOperation.js';
 
 export const useQueries: (
   qraftOptions: QraftClientOptions | undefined,
-  schema: OperationRequestSchema,
+  schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<
-      OperationRequestSchema,
-      unknown,
-      unknown
-    >['useQueries']
+    ServiceOperationQuery<OperationSchema, unknown, unknown>['useQueries']
   >
 ) => QueriesResults<never> = (qraftOptions, schema, args) => {
   const [options, queryClientByArg] = args;
 
   const contextValue = useContext(qraftOptions?.context ?? QraftContext);
-  if (!contextValue?.request) throw new Error(`QraftContext.request not found`);
+  if (!contextValue?.requestFn)
+    throw new Error(`QraftContext.requestFn not found`);
 
   return useQueriesTanstack(
     {
@@ -43,6 +40,7 @@ export const useQueries: (
                   },
                   queryOptions
                 );
+                // @ts-expect-error
                 delete queryOptionsCopy.parameters;
                 return queryOptionsCopy;
               })()
@@ -53,15 +51,12 @@ export const useQueries: (
           queryFn:
             optionsWithQueryKey.queryFn ??
             function ({ queryKey: [, queryParams], signal, meta }) {
-              return contextValue.request(
-                { baseUrl: contextValue.baseUrl },
-                schema,
-                {
-                  parameters: queryParams as never,
-                  signal,
-                  meta,
-                }
-              );
+              return contextValue.requestFn(schema, {
+                parameters: queryParams as never,
+                baseUrl: contextValue.baseUrl,
+                signal,
+                meta,
+              });
             },
         };
       }),