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

package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts

@@ -3,7 +3,6 @@ import type {
   FetchQueryOptions,
   GetNextPageParamFunction,
   InitialPageParam,
-  QueryClient,
   QueryFunction,
 } from '@tanstack/query-core';
 import type { PartialParameters } from '../lib/PartialParameters.type.js';
@@ -29,7 +28,7 @@ export interface ServiceOperationFetchInfiniteQuery<
           TPageParam,
           TError
         > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
       | (FetchInfiniteQueryOptionsByParameters<
           TSchema,
           TData,
@@ -37,8 +36,7 @@ export interface ServiceOperationFetchInfiniteQuery<
           TPageParam,
           TError
         > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
-    queryClient: QueryClient
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
   ): Promise<OperationInfiniteData<TData, TParams>>;
 
   prefetchInfiniteQuery<TPageParam extends TParams>(
@@ -50,7 +48,7 @@ export interface ServiceOperationFetchInfiniteQuery<
           TPageParam,
           TError
         > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
       | (FetchInfiniteQueryOptionsByParameters<
           TSchema,
           TData,
@@ -58,8 +56,7 @@ export interface ServiceOperationFetchInfiniteQuery<
           TPageParam,
           TError
         > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
-    queryClient: QueryClient
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
   ): Promise<void>;
 }
 
@@ -136,20 +133,24 @@ type FetchInfiniteQueryOptionsByParameters<
 type FetchInfiniteQueryOptionsQueryFn<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
+  TError,
 > =
   | {
-      queryFn?: QueryFunction<
+      queryFn: QueryFunction<
         TData,
         ServiceOperationInfiniteQueryKey<TSchema, TParams>
       >;
     }
   | {
-      requestFn: RequestFn<TData>;
+      /**
+       * Custom request function to use for the query
+       */
+      requestFn?: RequestFn<TData, TError>;
       /**
        * Base URL to use for the request (used in the `queryFn`)
        * @example 'https://api.example.com'
        */
-      baseUrl: string | undefined;
+      baseUrl?: string | undefined;
       queryFn?: never; // Workaround to fix union type error
     };

package/src/service-operation/ServiceOperationFetchQuery.ts

@@ -1,37 +1,52 @@
 import type {
   DefaultError,
   FetchQueryOptions,
-  QueryClient,
   QueryFunction,
 } from '@tanstack/query-core';
 import type { RequestFn } from '../lib/requestFn.js';
 import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+import { AreAllOptional } from '../lib/AreAllOptional.js';
 
 export interface ServiceOperationFetchQuery<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
   TError = DefaultError,
 > {
   fetchQuery(
-    options:
-      | (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
-          FetchQueryOptionsQueryFn<TSchema, TData, TParams>)
-      | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
-          FetchQueryOptionsQueryFn<TSchema, TData, TParams>),
-    queryClient: QueryClient
+    options: AreAllOptional<TParams> extends true
+      ? ServiceOperationFetchQueryOptions<
+          TSchema,
+          TData,
+          TParams,
+          TError
+        > | void
+      : ServiceOperationFetchQueryOptions<TSchema, TData, TParams, TError>
   ): Promise<TData>;
 
   prefetchQuery(
-    options:
-      | (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
-          FetchQueryOptionsQueryFn<TSchema, TData, TParams>)
-      | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
-          FetchQueryOptionsQueryFn<TSchema, TData, TParams>),
-    queryClient: QueryClient
+    options: AreAllOptional<TParams> extends true
+      ? ServiceOperationFetchQueryOptions<
+          TSchema,
+          TData,
+          TParams,
+          TError
+        > | void
+      : ServiceOperationFetchQueryOptions<TSchema, TData, TParams, TError>
   ): Promise<void>;
 }
 
+type ServiceOperationFetchQueryOptions<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams,
+  TError,
+> =
+  | (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
+      FetchQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
+  | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
+      FetchQueryOptionsQueryFn<TSchema, TData, TParams, TError>);
+
 type FetchQueryOptionsBase<
   TSchema extends { url: string; method: string },
   TData,
@@ -56,7 +71,8 @@ interface FetchQueryOptionsByQueryKey<
   /**
    * Fetch Queries by query key
    */
-  queryKey?: ServiceOperationQueryKey<TSchema, TParams>;
+  queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+  parameters?: never;
 }
 
 interface FetchQueryOptionsByParameters<
@@ -68,27 +84,28 @@ interface FetchQueryOptionsByParameters<
   /**
    * Fetch Queries by parameters
    */
-  parameters?: TParams;
+  parameters: TParams;
   queryKey?: never;
 }
 
 type FetchQueryOptionsQueryFn<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
+  TError,
 > =
   | {
-      queryFn?: QueryFunction<
-        TData,
-        ServiceOperationQueryKey<TSchema, TParams>
-      >;
+      queryFn: QueryFunction<TData, ServiceOperationQueryKey<TSchema, TParams>>;
     }
   | {
-      requestFn: RequestFn<TData>;
+      /**
+       * Custom request function to use for the query
+       */
+      requestFn?: RequestFn<TData, TError>;
       /**
        * Base URL to use for the request (used in the `queryFn`)
        * @example 'https://api.example.com'
        */
-      baseUrl: string | undefined;
+      baseUrl?: string | undefined;
       queryFn?: never; // Workaround to fix union type error
     };

package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts

@@ -1,14 +1,15 @@
-import type { QueryClient } from '@tanstack/query-core';
+import type { AreAllOptional } from '../lib/AreAllOptional.js';
 import type { OperationInfiniteData } from './OperationInfiniteData.js';
 import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
 
 export interface ServiceOperationGetInfiniteQueryData<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
 > {
   getInfiniteQueryData(
-    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
-    queryClient: QueryClient
+    parameters: AreAllOptional<TParams> extends true
+      ? TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams> | void
+      : TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>
   ): OperationInfiniteData<TData, TParams> | undefined;
 }

package/src/service-operation/ServiceOperationGetQueriesData.ts

@@ -1,4 +1,4 @@
-import type { DefaultError, NoInfer, QueryClient } from '@tanstack/query-core';
+import type { DefaultError, NoInfer } from '@tanstack/query-core';
 import type { OperationInfiniteData } from './OperationInfiniteData.js';
 import type {
   QueryFiltersByParameters,
@@ -12,14 +12,13 @@ import type {
 export interface ServiceOperationGetQueriesData<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
+  TParams,
   TError = DefaultError,
 > {
-  getQueriesData<TInfinite extends boolean>(
-    filters:
+  getQueriesData<TInfinite extends boolean = false>(
+    filters?:
       | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
-      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
-    queryClient: QueryClient
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
   ): TInfinite extends true
     ? Array<
         [

package/src/service-operation/ServiceOperationGetQueryData.ts

@@ -1,13 +1,14 @@
-import type { QueryClient } from '@tanstack/query-core';
+import type { AreAllOptional } from '../lib/AreAllOptional.js';
 import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
 
 export interface ServiceOperationGetQueryData<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
 > {
   getQueryData(
-    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
-    queryClient: QueryClient
+    parameters: AreAllOptional<TParams> extends true
+      ? TParams | ServiceOperationQueryKey<TSchema, TParams> | void
+      : TParams | ServiceOperationQueryKey<TSchema, TParams>
   ): TData | undefined;
 }

package/src/service-operation/ServiceOperationGetQueryState.ts

@@ -1,8 +1,4 @@
-import type {
-  DefaultError,
-  QueryClient,
-  QueryState,
-} from '@tanstack/query-core';
+import type { DefaultError, QueryState } from '@tanstack/query-core';
 import type { OperationInfiniteData } from './OperationInfiniteData.js';
 import type {
   ServiceOperationInfiniteQueryKey,
@@ -16,12 +12,10 @@ export interface ServiceOperationGetQueryState<
   TError = DefaultError,
 > {
   getQueryState(
-    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
-    queryClient: QueryClient
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>
   ): QueryState<TData, TError> | undefined;
 
   getInfiniteQueryState(
-    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
-    queryClient: QueryClient
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>
   ): QueryState<OperationInfiniteData<TData, TParams>, TError> | undefined;
 }

package/src/service-operation/ServiceOperationInvalidateQueries.ts

@@ -1,8 +1,4 @@
-import type {
-  DefaultError,
-  InvalidateOptions,
-  QueryClient,
-} from '@tanstack/query-core';
+import type { DefaultError, InvalidateOptions } from '@tanstack/query-core';
 import type {
   QueryFiltersByParameters,
   QueryFiltersByQueryKey,
@@ -28,34 +24,14 @@ export interface ServiceOperationInvalidateQueries<
   TParams = {},
   TError = DefaultError,
 > {
-  invalidateQueries<TInfinite extends boolean>(
-    filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>,
-    options: InvalidateOptions,
-    queryClient: QueryClient
-  ): Promise<void>;
-
-  invalidateQueries<TInfinite extends boolean>(
-    filters: InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>,
-    queryClient: QueryClient
-  ): Promise<void>;
-
-  invalidateQueries(queryClient: QueryClient): Promise<void>;
-}
-
-/**
- * @internal
- */
-export interface ServiceOperationInvalidateQueriesCallback<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> extends ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError> {
-  invalidateQueries<TInfinite extends boolean>(
-    filters:
-      | InvalidateQueryFilters<TSchema, TData, TInfinite, TParams, TError>
-      | QueryClient,
-    options?: InvalidateOptions | QueryClient,
-    queryClient?: QueryClient
+  invalidateQueries<TInfinite extends boolean = false>(
+    filters?: InvalidateQueryFilters<
+      TSchema,
+      TData,
+      TInfinite,
+      TParams,
+      TError
+    >,
+    options?: InvalidateOptions
   ): Promise<void>;
 }

package/src/service-operation/ServiceOperationIsFetchingQueries.ts

@@ -1,4 +1,4 @@
-import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type { DefaultError } from '@tanstack/query-core';
 import type {
   QueryFiltersByParameters,
   QueryFiltersByQueryKey,
@@ -10,30 +10,9 @@ export interface ServiceOperationIsFetchingQueries<
   TParams = {},
   TError = DefaultError,
 > {
-  isFetching<TInfinite extends boolean>(
-    filters:
-      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
-      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
-    queryClient: QueryClient
-  ): number;
-
-  isFetching(queryClient: QueryClient): number;
-}
-
-/**
- * @internal
- */
-export interface ServiceOperationIsFetchingQueriesCallback<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> extends ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
-  refetchQueries<TInfinite extends boolean>(
-    filters:
+  isFetching<TInfinite extends boolean = false>(
+    filters?:
       | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
       | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
-      | QueryClient,
-    queryClient?: QueryClient
   ): number;
 }

package/src/service-operation/ServiceOperationIsMutatingQueries.ts

@@ -1,4 +1,4 @@
-import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type { DefaultError } from '@tanstack/query-core';
 import type {
   MutationFiltersByMutationKey,
   MutationFiltersByParameters,
@@ -12,40 +12,7 @@ export interface ServiceOperationIsMutatingQueries<
   TError = DefaultError,
 > {
   isMutating<TContext>(
-    filters:
-      | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
-      | MutationFiltersByMutationKey<
-          TSchema,
-          TBody,
-          TData,
-          TParams,
-          TError,
-          TContext
-        >,
-    queryClient: QueryClient
-  ): number;
-
-  isMutating(queryClient: QueryClient): number;
-}
-
-/**
- * @internal
- */
-export interface ServiceOperationIsMutatingQueriesCallback<
-  TSchema extends { url: string; method: string },
-  TBody,
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> extends ServiceOperationIsMutatingQueries<
-    TSchema,
-    TBody,
-    TData,
-    TParams,
-    TError
-  > {
-  isMutating<TContext>(
-    filters:
+    filters?:
       | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
       | MutationFiltersByMutationKey<
           TSchema,
@@ -55,7 +22,5 @@ export interface ServiceOperationIsMutatingQueriesCallback<
           TError,
           TContext
         >
-      | QueryClient,
-    queryClient?: QueryClient
   ): number;
 }

package/src/service-operation/ServiceOperationMutationFn.ts

@@ -1,92 +1,49 @@
+import { AreAllOptional } from '../lib/AreAllOptional.js';
+import { RequestFnResponse } from '../lib/requestFn.js';
+
 interface QueryFnBaseUrlOptions {
   /**
    * Base URL to use for the request
    * @example 'https://api.example.com'
    */
-  baseUrl: string;
-}
-
-interface ServiceOperationMutationFnOptionsBase<TBody, TParams> {
-  parameters: TParams;
-  body: TBody;
+  baseUrl?: string;
 }
 
-interface ServiceOperationMutationFnOptions<TBody, TParams>
-  extends ServiceOperationMutationFnOptionsBase<TBody, TParams> {
-  baseUrl?: never;
-}
-
-interface ServiceOperationMutationFnOptionsWithBaseUrl<TBody, TParams>
-  extends ServiceOperationMutationFnOptionsBase<TBody, TParams>,
-    QueryFnBaseUrlOptions {}
+type ServiceOperationMutationFnOptions<TBody, TParams> =
+  AreAllOptional<TBody> extends true
+    ? AreAllOptional<TParams> extends true
+      ?
+          | void // todo::try to move void to arguments
+          | ({
+              parameters?: TParams;
+              body?: TBody;
+            } & QueryFnBaseUrlOptions)
+      : {
+          parameters: TParams;
+          body?: TBody;
+        } & QueryFnBaseUrlOptions
+    : AreAllOptional<TParams> extends true
+      ? {
+          parameters?: TParams;
+          body: TBody;
+        } & QueryFnBaseUrlOptions
+      : {
+          parameters: TParams;
+          body: TBody;
+        } & QueryFnBaseUrlOptions;
 
 export interface ServiceOperationMutationFn<
   TSchema extends { url: string; method: string },
   TBody,
   TData,
   TParams,
+  TError,
 > {
-  /**
-   * @deprecated Use `<service>.<operation>(...)` instead.
-   */
-  mutationFn(
-    client: (
-      schema: TSchema,
-      options: {
-        parameters: TParams;
-        body: TBody;
-      }
-    ) => TData,
-    options: {
-      parameters: TParams;
-      body: TBody;
-    }
-  ): TData;
-
-  /**
-   * @deprecated Use `<service>.<operation>(...)` instead.
-   */
-  mutationFn(
-    client: (
-      schema: TSchema,
-      options: {
-        parameters: TParams;
-        body: TBody;
-      }
-    ) => Promise<TData>,
-    options: {
-      parameters: TParams;
-      body: TBody;
-    }
-  ): Promise<TData>;
-
-  <TOptions extends ServiceOperationMutationFnOptions<TBody, TParams>>(
-    options: TOptions,
-    client: (schema: TSchema, options: TOptions) => TData
-  ): TData;
-
-  <
-    TOptions extends ServiceOperationMutationFnOptionsWithBaseUrl<
-      TBody,
-      TParams
-    >,
-  >(
-    options: TOptions,
-    client: (schema: TSchema, options: TOptions) => TData
-  ): TData;
-
   <TOptions extends ServiceOperationMutationFnOptions<TBody, TParams>>(
     options: TOptions,
-    client: (schema: TSchema, options: TOptions) => Promise<TData>
-  ): Promise<TData>;
-
-  <
-    TOptions extends ServiceOperationMutationFnOptionsWithBaseUrl<
-      TBody,
-      TParams
-    >,
-  >(
-    options: TOptions,
-    client: (schema: TSchema, options: TOptions) => Promise<TData>
-  ): Promise<TData>;
+    client?: (
+      schema: TSchema,
+      options: TOptions
+    ) => Promise<RequestFnResponse<TData, TError>>
+  ): Promise<RequestFnResponse<TData, TError>>;
 }