@openapi-qraft/react 1.5.0 → 1.7.0

package/src/service-operation/ServiceOperationGetQueryState.ts

@@ -0,0 +1,28 @@
+import type {
+  DefaultError,
+  QueryClient,
+  QueryState,
+} from '@tanstack/query-core';
+
+import type { OperationInfiniteData } from './OperationInfiniteData.js';
+import type {
+  ServiceOperationInfiniteQueryKey,
+  ServiceOperationQueryKey,
+} from './ServiceOperationKey.js';
+
+export interface ServiceOperationGetQueryState<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  getQueryState(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    queryClient: QueryClient
+  ): QueryState<TData, TError> | undefined;
+
+  getInfiniteQueryState(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    queryClient: QueryClient
+  ): QueryState<OperationInfiniteData<TData, TParams>, TError> | undefined;
+}

package/src/service-operation/ServiceOperationInvalidateQueries.ts

@@ -0,0 +1,62 @@
+import type {
+  DefaultError,
+  InvalidateOptions,
+  QueryClient,
+} from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+  QueryTypeFilter,
+} from './QueryFilters.js';
+
+export type InvalidateQueryFilters<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> = (
+  | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+  | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+) & {
+  refetchType?: QueryTypeFilter | 'none';
+};
+
+export interface ServiceOperationInvalidateQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  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
+  ): Promise<void>;
+}

package/src/service-operation/ServiceOperationIsFetchingQueries.ts

@@ -0,0 +1,40 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from './QueryFilters.js';
+
+export interface ServiceOperationIsFetchingQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  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:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+      | QueryClient,
+    queryClient?: QueryClient
+  ): number;
+}

package/src/service-operation/ServiceOperationIsMutatingQueries.ts

@@ -0,0 +1,62 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+
+import type {
+  MutationFiltersByMutationKey,
+  MutationFiltersByParameters,
+} from './ServiceOperationUseMutationState.js';
+
+export interface ServiceOperationIsMutatingQueries<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams = {},
+  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:
+      | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
+      | MutationFiltersByMutationKey<
+          TSchema,
+          TBody,
+          TData,
+          TParams,
+          TError,
+          TContext
+        >
+      | QueryClient,
+    queryClient?: QueryClient
+  ): number;
+}

package/src/service-operation/ServiceOperationKey.ts

@@ -0,0 +1,20 @@
+export type ServiceOperationBaseQueryKey<
+  S extends { url: string; method: string },
+  Infinite extends boolean,
+  T,
+> = [S & { infinite: Infinite }, T];
+
+export type ServiceOperationQueryKey<
+  S extends { url: string; method: string },
+  T,
+> = ServiceOperationBaseQueryKey<S, false, T>;
+
+export type ServiceOperationInfiniteQueryKey<
+  S extends { url: string; method: string },
+  T,
+> = ServiceOperationBaseQueryKey<S, true, T>;
+
+export type ServiceOperationMutationKey<
+  S extends Record<'url' | 'method', string>,
+  T extends unknown,
+> = NonNullable<T> extends never ? [S] : [S, T];

package/src/service-operation/ServiceOperationMutationFn.ts

@@ -0,0 +1,34 @@
+export interface ServiceOperationMutationFn<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+> {
+  mutationFn(
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        body: TBody;
+      }
+    ) => TData,
+    options: {
+      parameters: TParams;
+      body: TBody;
+    }
+  ): TData;
+
+  mutationFn(
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        body: TBody;
+      }
+    ) => Promise<TData>,
+    options: {
+      parameters: TParams;
+      body: TBody;
+    }
+  ): Promise<TData>;
+}

package/src/service-operation/ServiceOperationQueryFn.ts

@@ -0,0 +1,67 @@
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+interface QueryFnOptionsBase<
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> {
+  signal?: TSignal;
+  meta?: TMeta;
+}
+
+interface QueryFnOptionsByParameters<
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal> {
+  parameters: TParams;
+  queryKey?: never;
+}
+
+interface QueryFnOptionsByQueryKey<
+  TSchema extends { url: string; method: string },
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal> {
+  queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+}
+
+export interface ServiceOperationQueryFn<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams,
+> {
+  queryFn<
+    TMeta extends Record<string, any>,
+    TSignal extends AbortSignal = AbortSignal,
+  >(
+    options:
+      | QueryFnOptionsByParameters<TParams, TMeta, TSignal>
+      | QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>,
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        signal?: TSignal;
+        meta?: TMeta;
+      }
+    ) => TData
+  ): TData;
+
+  queryFn<
+    TMeta extends Record<string, any>,
+    TSignal extends AbortSignal = AbortSignal,
+  >(
+    options:
+      | QueryFnOptionsByParameters<TParams, TMeta, TSignal>
+      | QueryFnOptionsByQueryKey<TSchema, TParams, TMeta, TSignal>,
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        signal?: TSignal;
+        meta?: TMeta;
+      }
+    ) => Promise<TData>
+  ): Promise<TData>;
+}

package/src/service-operation/ServiceOperationRefetchQueries.ts

@@ -0,0 +1,74 @@
+import type {
+  DefaultError,
+  QueryClient,
+  RefetchOptions,
+  ResetOptions,
+} from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from './QueryFilters.js';
+import { ServiceOperationResetQueries } from './ServiceOperationResetQueries.js';
+
+export interface ServiceOperationRefetchQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  refetchQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    options: RefetchOptions,
+    queryClient: QueryClient
+  ): Promise<void>;
+
+  refetchQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    queryClient: QueryClient
+  ): Promise<void>;
+
+  refetchQueries(queryClient: QueryClient): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationResetQueriesCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
+  resetQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+      | QueryClient,
+    options?: ResetOptions | QueryClient,
+    queryClient?: QueryClient
+  ): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationRefetchQueriesCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationRefetchQueries<TSchema, TData, TParams, TError> {
+  refetchQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+      | QueryClient,
+    options?: RefetchOptions | QueryClient,
+    queryClient?: QueryClient
+  ): Promise<void>;
+}

package/src/service-operation/ServiceOperationRemoveQueries.ts

@@ -0,0 +1,40 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from './QueryFilters.js';
+
+export interface ServiceOperationRemoveQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  removeQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    queryClient: QueryClient
+  ): void;
+
+  removeQueries(queryClient: QueryClient): void;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationRemoveQueriesCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationRemoveQueries<TSchema, TData, TParams, TError> {
+  removeQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+      | QueryClient,
+    queryClient?: QueryClient
+  ): void;
+}

package/src/service-operation/ServiceOperationResetQueries.ts

@@ -0,0 +1,53 @@
+import type {
+  DefaultError,
+  QueryClient,
+  ResetOptions,
+} from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from './QueryFilters.js';
+
+export interface ServiceOperationResetQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  resetQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    options: ResetOptions,
+    queryClient: QueryClient
+  ): Promise<void>;
+
+  resetQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    queryClient: QueryClient
+  ): Promise<void>;
+
+  resetQueries(queryClient: QueryClient): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationResetQueriesCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
+  resetQueries<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
+      | QueryClient,
+    options?: ResetOptions | QueryClient,
+    queryClient?: QueryClient
+  ): Promise<void>;
+}

package/src/service-operation/ServiceOperationSetInfiniteQueryData.ts

@@ -0,0 +1,25 @@
+import type {
+  NoInfer,
+  QueryClient,
+  SetDataOptions,
+  Updater,
+} from '@tanstack/query-core';
+
+import type { OperationInfiniteData } from './OperationInfiniteData.js';
+import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationSetInfiniteQueryData<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+> {
+  setInfiniteQueryData(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    updater: Updater<
+      NoInfer<OperationInfiniteData<TData, TParams>> | undefined,
+      NoInfer<OperationInfiniteData<TData, TParams>> | undefined
+    >,
+    queryClient: QueryClient,
+    options?: SetDataOptions
+  ): OperationInfiniteData<TData, TParams> | undefined;
+}

package/src/service-operation/ServiceOperationSetQueriesData.ts

@@ -0,0 +1,55 @@
+import type {
+  DefaultError,
+  NoInfer,
+  QueryClient,
+  SetDataOptions,
+  Updater,
+} from '@tanstack/query-core';
+
+import type {
+  QueryFiltersByParameters,
+  QueryFiltersByQueryKey,
+} from './QueryFilters.js';
+
+export interface ServiceOperationSetQueriesData<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
+  TError = DefaultError,
+> {
+  setQueriesData<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    options: SetDataOptions,
+    queryClient: QueryClient
+  ): Array<TData | undefined>;
+
+  setQueriesData<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    queryClient: QueryClient
+  ): Array<TData | undefined>;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationSetQueriesDataCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationSetQueriesData<TSchema, TData, TParams, TError> {
+  setQueriesData<TInfinite extends boolean>(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    options: SetDataOptions | QueryClient,
+    queryClient?: QueryClient
+  ): Array<TData | undefined>;
+}

package/src/service-operation/ServiceOperationSetQueryData.ts

@@ -0,0 +1,43 @@
+import type {
+  NoInfer,
+  QueryClient,
+  SetDataOptions,
+  Updater,
+} from '@tanstack/query-core';
+
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationSetQueryData<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {}, // todo::try to replace `TParams = {}` with `TParams = undefined`
+> {
+  setQueryData(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    options: SetDataOptions,
+    queryClient: QueryClient
+  ): TData | undefined;
+
+  setQueryData(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    queryClient: QueryClient
+  ): TData | undefined;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationSetQueryDataCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+> extends ServiceOperationSetQueryData<TSchema, TData, TParams> {
+  setQueryData(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    updater: Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>,
+    options: SetDataOptions | QueryClient,
+    queryClient?: QueryClient
+  ): TData | undefined;
+}

package/src/service-operation/ServiceOperationUseInfiniteQuery.ts

@@ -0,0 +1,70 @@
+import type {
+  DefaultError,
+  InfiniteQueryPageParamsOptions,
+  QueryClient,
+} from '@tanstack/query-core';
+import type {
+  DefinedInitialDataInfiniteOptions,
+  DefinedUseInfiniteQueryResult,
+  UndefinedInitialDataInfiniteOptions,
+  UseInfiniteQueryResult,
+} from '@tanstack/react-query';
+
+import type { PartialParameters } from '../lib/PartialParameters.type.js';
+import type { OperationInfiniteData } from './OperationInfiniteData.js';
+import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  getInfiniteQueryKey<TQueryKeyParams extends TParams>(
+    parameters: TQueryKeyParams
+  ): ServiceOperationInfiniteQueryKey<TSchema, TQueryKeyParams>;
+
+  useInfiniteQuery<TPageParam extends TParams>(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    options: Omit<
+      UndefinedInitialDataInfiniteOptions<
+        TData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
+    queryClient?: QueryClient
+  ): UseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+
+  useInfiniteQuery<TPageParam extends TParams>(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    options: Omit<
+      DefinedInitialDataInfiniteOptions<
+        TData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
+    queryClient?: QueryClient
+  ): DefinedUseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+}