@openapi-qraft/react 1.6.0 → 1.8.0

package/src/service-operation/ServiceOperationQueryFn.ts

@@ -0,0 +1,177 @@
+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;
+  baseUrl?: never;
+}
+
+interface QueryFnOptionsByParametersWithBaseUrl<
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal>,
+    QueryFnBaseUrlOptions {
+  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>;
+
+  parameters?: never;
+  baseUrl?: never;
+}
+
+interface QueryFnOptionsByQueryKeyWithBaseUrl<
+  TSchema extends { url: string; method: string },
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal>,
+    QueryFnBaseUrlOptions {
+  queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+
+  parameters?: never;
+}
+
+interface QueryFnBaseUrlOptions {
+  /**
+   * Base URL to use for the request
+   * @example 'https://api.example.com'
+   */
+  baseUrl: string;
+}
+
+export interface ServiceOperationQueryFn<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams,
+> {
+  /**
+   * @deprecated Use `<service>.<operation>(...)` instead.
+   */
+  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;
+
+  /**
+   * @deprecated Use `<service>.<operation>(...)` instead.
+   */
+  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>;
+
+  <
+    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;
+
+  <
+    TMeta extends Record<string, any>,
+    TSignal extends AbortSignal = AbortSignal,
+  >(
+    options:
+      | QueryFnOptionsByParametersWithBaseUrl<TParams, TMeta, TSignal>
+      | QueryFnOptionsByQueryKeyWithBaseUrl<TSchema, TParams, TMeta, TSignal>,
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        signal?: TSignal;
+        meta?: TMeta;
+      } & QueryFnBaseUrlOptions
+    ) => TData
+  ): TData;
+
+  <
+    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>;
+
+  <
+    TMeta extends Record<string, any>,
+    TSignal extends AbortSignal = AbortSignal,
+  >(
+    options:
+      | QueryFnOptionsByParametersWithBaseUrl<TParams, TMeta, TSignal>
+      | QueryFnOptionsByQueryKeyWithBaseUrl<TSchema, TParams, TMeta, TSignal>,
+    client: (
+      schema: TSchema,
+      options: {
+        parameters: TParams;
+        signal?: TSignal;
+        meta?: TMeta;
+      } & QueryFnBaseUrlOptions
+    ) => 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
+  >;
+}

package/src/service-operation/ServiceOperationUseIsFetchingQueries.ts

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

package/src/service-operation/ServiceOperationUseIsMutating.ts

@@ -0,0 +1,28 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+
+import type {
+  MutationFiltersByMutationKey,
+  MutationFiltersByParameters,
+} from './ServiceOperationUseMutationState.js';
+
+export interface ServiceOperationUseIsMutating<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+> {
+  useIsMutating<TContext = unknown>(
+    filters?:
+      | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
+      | MutationFiltersByMutationKey<
+          TSchema,
+          TBody,
+          TData,
+          TParams,
+          TError,
+          TContext
+        >,
+    queryClient?: QueryClient
+  ): number;
+}

package/src/service-operation/ServiceOperationUseMutation.ts

@@ -0,0 +1,46 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type {
+  UseMutationOptions,
+  UseMutationResult,
+} from '@tanstack/react-query';
+
+import type { ServiceOperationMutationKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseMutation<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+> {
+  getMutationKey<TMutationKeyParams extends TParams | undefined = undefined>(
+    parameters?: TMutationKeyParams
+  ): ServiceOperationMutationKey<TSchema, TMutationKeyParams>;
+
+  useMutation<
+    TVariables extends MutationVariables<TBody, TParams>,
+    TContext = unknown,
+  >(
+    parameters?: undefined,
+    options?: Omit<
+      UseMutationOptions<TData, TError, TVariables, TContext>,
+      'mutationKey'
+    > & {
+      mutationKey?: ServiceOperationMutationKey<TSchema, TParams>;
+    },
+    queryClient?: QueryClient
+  ): UseMutationResult<TData, TError | Error, TVariables, TContext>;
+
+  useMutation<TVariables extends TBody, TContext = unknown>(
+    parameters: TParams,
+    options?: Omit<
+      UseMutationOptions<TData, TError, TVariables, TContext>,
+      'mutationKey'
+    >,
+    queryClient?: QueryClient
+  ): UseMutationResult<TData, TError | Error, TVariables, TContext>;
+}
+
+export type MutationVariables<TBody, TParams> = {
+  body: TBody;
+} & (NonNullable<TParams> extends never ? {} : TParams);