@openapi-qraft/tanstack-query-react-types 2.0.0-next.10

package/src/service-operation/ServiceOperationQueryFn.ts

@@ -0,0 +1,32 @@
+import type {
+  AreAllOptional,
+  QueryFnOptionsByParameters,
+  QueryFnOptionsByQueryKey,
+  RequestFnResponse,
+} from '@openapi-qraft/tanstack-query-react-types';
+
+export interface ServiceOperationQueryFn<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  <
+    TMeta extends Record<string, any>,
+    TSignal extends AbortSignal = AbortSignal,
+  >(
+    options:
+      | QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>
+      | (AreAllOptional<TParams> extends true
+          ? QueryFnOptionsByParameters<TParams, TMeta, TSignal> | void
+          : QueryFnOptionsByParameters<TParams, TMeta, TSignal>),
+    client?: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        signal?: TSignal;
+        meta?: TMeta;
+      }
+    ) => Promise<RequestFnResponse<TQueryFnData, TError>>
+  ): Promise<RequestFnResponse<TQueryFnData, TError>>;
+}

package/src/service-operation/ServiceOperationRefetchQueries.ts

@@ -0,0 +1,31 @@
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { RefetchOptions } from '@tanstack/query-core';
+
+export interface ServiceOperationRefetchQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  refetchQueries<TInfinite extends boolean = false>(
+    filters?:
+      | QueryFiltersByParameters<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+      | QueryFiltersByQueryKey<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >,
+    options?: RefetchOptions
+  ): Promise<void>;
+}

package/src/service-operation/ServiceOperationRemoveQueries.ts

@@ -0,0 +1,29 @@
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+
+export interface ServiceOperationRemoveQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  removeQueries<TInfinite extends boolean = false>(
+    filters?:
+      | QueryFiltersByParameters<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+      | QueryFiltersByQueryKey<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+  ): void;
+}

package/src/service-operation/ServiceOperationResetQueries.ts

@@ -0,0 +1,31 @@
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { ResetOptions } from '@tanstack/query-core';
+
+export interface ServiceOperationResetQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  resetQueries<TInfinite extends boolean = false>(
+    filters?:
+      | QueryFiltersByParameters<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+      | QueryFiltersByQueryKey<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >,
+    options?: ResetOptions
+  ): Promise<void>;
+}

package/src/service-operation/ServiceOperationSetInfiniteQueryData.ts

@@ -0,0 +1,20 @@
+import type {
+  OperationInfiniteData,
+  ServiceOperationInfiniteQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { NoInfer, SetDataOptions, Updater } from '@tanstack/query-core';
+
+export interface ServiceOperationSetInfiniteQueryData<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams = {},
+> {
+  setInfiniteQueryData(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    updater: Updater<
+      NoInfer<OperationInfiniteData<TQueryFnData, TParams>> | undefined,
+      NoInfer<OperationInfiniteData<TQueryFnData, TParams>> | undefined
+    >,
+    options?: SetDataOptions
+  ): OperationInfiniteData<TQueryFnData, TParams> | undefined;
+}

package/src/service-operation/ServiceOperationSetQueriesData.ts

@@ -0,0 +1,35 @@
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { NoInfer, SetDataOptions, Updater } from '@tanstack/query-core';
+
+export interface ServiceOperationSetQueriesData<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  setQueriesData<TInfinite extends boolean = false>(
+    filters:
+      | QueryFiltersByParameters<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+      | QueryFiltersByQueryKey<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >,
+    updater: Updater<
+      NoInfer<TQueryFnData> | undefined,
+      NoInfer<TQueryFnData> | undefined
+    >,
+    options?: SetDataOptions
+  ): Array<TQueryFnData | undefined>;
+}

package/src/service-operation/ServiceOperationSetQueryData.ts

@@ -0,0 +1,17 @@
+import type { ServiceOperationQueryKey } from '@openapi-qraft/tanstack-query-react-types';
+import type { NoInfer, SetDataOptions, Updater } from '@tanstack/query-core';
+
+export interface ServiceOperationSetQueryData<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams = {},
+> {
+  setQueryData(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    updater: Updater<
+      NoInfer<TQueryFnData> | undefined,
+      NoInfer<TQueryFnData> | undefined
+    >,
+    options?: SetDataOptions
+  ): TQueryFnData | undefined;
+}

package/src/service-operation/ServiceOperationUseInfiniteQuery.ts

@@ -0,0 +1,76 @@
+import type {
+  AreAllOptional,
+  OperationInfiniteData,
+  PartialParameters,
+  ServiceOperationInfiniteQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { InfiniteQueryPageParamsOptions } from '@tanstack/query-core';
+import type {
+  DefinedInitialDataInfiniteOptions,
+  DefinedUseInfiniteQueryResult,
+  UndefinedInitialDataInfiniteOptions,
+  UseInfiniteQueryResult,
+} from '@tanstack/react-query';
+
+export interface ServiceOperationUseInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  getInfiniteQueryKey(
+    parameters: AreAllOptional<TParams> extends true ? TParams | void : TParams
+  ): ServiceOperationInfiniteQueryKey<TSchema, TParams>;
+
+  useInfiniteQuery<TPageParam extends TParams, TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options: Omit<
+      UndefinedInitialDataInfiniteOptions<
+        TQueryFnData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<
+        TQueryFnData,
+        PartialParameters<TPageParam>
+      >
+  ): UseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+
+  useInfiniteQuery<TPageParam extends TParams, TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options: Omit<
+      DefinedInitialDataInfiniteOptions<
+        TQueryFnData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<
+        TQueryFnData,
+        PartialParameters<TPageParam>
+      >
+  ): DefinedUseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+}

package/src/service-operation/ServiceOperationUseIsFetchingQueries.ts

@@ -0,0 +1,29 @@
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+
+export interface ServiceOperationUseIsFetchingQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  useIsFetching<TInfinite extends boolean = false>(
+    filters?:
+      | QueryFiltersByParameters<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+      | QueryFiltersByQueryKey<
+          TSchema,
+          TQueryFnData,
+          TInfinite,
+          TParams,
+          TError
+        >
+  ): number;
+}

package/src/service-operation/ServiceOperationUseIsMutating.ts

@@ -0,0 +1,31 @@
+import type {
+  MutationFiltersByMutationKey,
+  MutationFiltersByParameters,
+} from '@openapi-qraft/tanstack-query-react-types';
+
+export interface ServiceOperationUseIsMutating<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TMutationData,
+  TParams,
+  TError,
+> {
+  useIsMutating<TContext = unknown>(
+    filters?:
+      | MutationFiltersByParameters<
+          TBody,
+          TMutationData,
+          TParams,
+          TError,
+          TContext
+        >
+      | MutationFiltersByMutationKey<
+          TSchema,
+          TBody,
+          TMutationData,
+          TParams,
+          TError,
+          TContext
+        >
+  ): number;
+}

package/src/service-operation/ServiceOperationUseMutation.ts

@@ -0,0 +1,51 @@
+import type {
+  AreAllOptional,
+  MutationVariables,
+  ServiceOperationMutationKey,
+  ServiceOperationUseMutationOptions,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { UseMutationResult } from '@tanstack/react-query';
+
+export interface ServiceOperationUseMutation<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TMutationData,
+  TParams,
+  TError,
+> {
+  getMutationKey(
+    parameters: TParams | void
+  ): ServiceOperationMutationKey<TSchema, TParams>;
+
+  useMutation<TVariables extends TBody, TContext = unknown>(
+    parameters: TParams,
+    options?: ServiceOperationUseMutationOptions<
+      TSchema,
+      TMutationData,
+      TParams,
+      TVariables,
+      TError,
+      TContext
+    >
+  ): UseMutationResult<
+    TMutationData,
+    TError | Error,
+    AreAllOptional<TVariables> extends true ? TVariables | void : TVariables,
+    TContext
+  >;
+
+  useMutation<
+    TVariables extends MutationVariables<TBody, TParams>,
+    TContext = unknown,
+  >(
+    parameters: void,
+    options?: ServiceOperationUseMutationOptions<
+      TSchema,
+      TMutationData,
+      TParams,
+      TVariables,
+      TError,
+      TContext
+    >
+  ): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
+}

package/src/service-operation/ServiceOperationUseMutationState.ts

@@ -0,0 +1,49 @@
+import type {
+  MutationFiltersByMutationKey,
+  MutationFiltersByParameters,
+  MutationVariables,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { Mutation, MutationState } from '@tanstack/query-core';
+
+export interface ServiceOperationUseMutationState<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TMutationData,
+  TParams,
+  TError,
+> {
+  useMutationState<
+    TContext = unknown,
+    TResult = MutationState<
+      TMutationData,
+      TError,
+      MutationVariables<TBody, TParams>,
+      TContext
+    >,
+  >(options?: {
+    filters?:
+      | MutationFiltersByParameters<
+          TBody,
+          TMutationData,
+          TParams,
+          TError,
+          TContext
+        >
+      | MutationFiltersByMutationKey<
+          TSchema,
+          TBody,
+          TMutationData,
+          TParams,
+          TError,
+          TContext
+        >;
+    select?: (
+      mutation: Mutation<
+        TMutationData,
+        TError,
+        MutationVariables<TBody, TParams>,
+        TContext
+      >
+    ) => TResult;
+  }): Array<TResult>;
+}

package/src/service-operation/ServiceOperationUseQueries.ts

@@ -0,0 +1,21 @@
+import type { UseQueryOptionsForUseQueries } from '@openapi-qraft/tanstack-query-react-types';
+import type { UseQueryResult } from '@tanstack/react-query';
+
+export interface ServiceOperationUseQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  useQueries<
+    T extends Array<
+      UseQueryOptionsForUseQueries<TSchema, TParams, TQueryFnData, TError>
+    >,
+    TCombinedResult = Array<UseQueryResult<TQueryFnData, TError>>,
+  >(options: {
+    queries: T;
+    combine?: (
+      results: Array<UseQueryResult<TQueryFnData, TError>>
+    ) => TCombinedResult;
+  }): TCombinedResult;
+}

package/src/service-operation/ServiceOperationUseQuery.ts

@@ -0,0 +1,51 @@
+import type {
+  AreAllOptional,
+  ServiceOperationQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type {
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
+  UndefinedInitialDataOptions,
+  UseQueryResult,
+} from '@tanstack/react-query';
+
+export interface ServiceOperationUseQuery<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  getQueryKey(
+    parameters: AreAllOptional<TParams> extends true ? TParams | void : TParams
+  ): ServiceOperationQueryKey<TSchema, TParams>;
+
+  useQuery<TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options?: Omit<
+      UndefinedInitialDataOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >
+  ): UseQueryResult<TData, TError | Error>;
+
+  useQuery<TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options: Omit<
+      DefinedInitialDataOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >
+  ): DefinedUseQueryResult<TData, TError | Error>;
+}

package/src/service-operation/ServiceOperationUseSuspenseInfiniteQuery.ts

@@ -0,0 +1,45 @@
+import type {
+  AreAllOptional,
+  OperationInfiniteData,
+  PartialParameters,
+  ServiceOperationInfiniteQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { InfiniteQueryPageParamsOptions } from '@tanstack/query-core';
+import type {
+  UseSuspenseInfiniteQueryOptions,
+  UseSuspenseInfiniteQueryResult,
+} from '@tanstack/react-query';
+
+export interface ServiceOperationUseSuspenseInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  useSuspenseInfiniteQuery<TPageParam extends TParams, TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationInfiniteQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options: Omit<
+      UseSuspenseInfiniteQueryOptions<
+        TQueryFnData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        TQueryFnData,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<
+        TQueryFnData,
+        PartialParameters<TPageParam>
+      >
+  ): UseSuspenseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+}

package/src/service-operation/ServiceOperationUseSuspenseQueries.ts

@@ -0,0 +1,26 @@
+import type {
+  UseQueryOptionsForUseSuspenseQuery,
+  WithOptional,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { UseSuspenseQueryResult } from '@tanstack/react-query';
+
+export interface ServiceOperationUseSuspenseQueries<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  useSuspenseQueries<
+    T extends Array<
+      UseQueryOptionsForUseSuspenseQuery<TSchema, TParams, TQueryFnData, TError>
+    >,
+    TCombinedResult = Array<UseSuspenseQueryResult<TQueryFnData, TError>>,
+  >(options: {
+    queries: T;
+    combine?: (
+      results: Array<
+        WithOptional<UseSuspenseQueryResult<TQueryFnData, TError>, 'data'>
+      >
+    ) => TCombinedResult;
+  }): TCombinedResult;
+}

package/src/service-operation/ServiceOperationUseSuspenseQuery.ts

@@ -0,0 +1,30 @@
+import type {
+  AreAllOptional,
+  ServiceOperationQueryKey,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type {
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from '@tanstack/react-query';
+
+export interface ServiceOperationUseSuspenseQuery<
+  TSchema extends { url: string; method: string },
+  TQueryFnData,
+  TParams,
+  TError,
+> {
+  useSuspenseQuery<TData = TQueryFnData>(
+    parameters:
+      | ServiceOperationQueryKey<TSchema, TParams>
+      | (AreAllOptional<TParams> extends true ? TParams | void : TParams),
+    options?: Omit<
+      UseSuspenseQueryOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >
+  ): UseSuspenseQueryResult<TData, TError | Error>;
+}

package/src/service-operation/index.ts

@@ -0,0 +1,29 @@
+export type * from './ServiceOperation.js';
+export type * from './ServiceOperationCancelQueries.js';
+export type * from './ServiceOperationFetchInfiniteQuery.js';
+export type * from './ServiceOperationFetchQuery.js';
+export type * from './ServiceOperationGetInfiniteQueryData.js';
+export type * from './ServiceOperationGetQueriesData.js';
+export type * from './ServiceOperationGetQueryData.js';
+export type * from './ServiceOperationGetQueryState.js';
+export type * from './ServiceOperationInvalidateQueries.js';
+export type * from './ServiceOperationIsFetchingQueries.js';
+export type * from './ServiceOperationIsMutatingQueries.js';
+export type * from './ServiceOperationMutationFn.js';
+export type * from './ServiceOperationQueryFn.js';
+export type * from './ServiceOperationRefetchQueries.js';
+export type * from './ServiceOperationRemoveQueries.js';
+export type * from './ServiceOperationResetQueries.js';
+export type * from './ServiceOperationSetInfiniteQueryData.js';
+export type * from './ServiceOperationSetQueriesData.js';
+export type * from './ServiceOperationSetQueryData.js';
+export type * from './ServiceOperationUseInfiniteQuery.js';
+export type * from './ServiceOperationUseIsFetchingQueries.js';
+export type * from './ServiceOperationUseIsMutating.js';
+export type * from './ServiceOperationUseMutation.js';
+export type * from './ServiceOperationUseMutationState.js';
+export type * from './ServiceOperationUseQueries.js';
+export type * from './ServiceOperationUseQuery.js';
+export type * from './ServiceOperationUseSuspenseInfiniteQuery.js';
+export type * from './ServiceOperationUseSuspenseQueries.js';
+export type * from './ServiceOperationUseSuspenseQuery.js';

package/src/shared/AreAllOptional.ts

@@ -0,0 +1,8 @@
+export type AreAllOptional<T> =
+  NonNullable<T> extends never
+    ? true
+    : {
+          [K in keyof T]-?: undefined extends T[K] ? never : K;
+        }[keyof T] extends never
+      ? true
+      : false;