@openapi-qraft/react 1.6.0 → 1.8.0

package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts

@@ -0,0 +1,156 @@
+import type {
+  DefaultError,
+  FetchQueryOptions,
+  GetNextPageParamFunction,
+  InitialPageParam,
+  QueryClient,
+  QueryFunction,
+} from '@tanstack/query-core';
+
+import type { PartialParameters } from '../lib/PartialParameters.type.js';
+import type { RequestFn } from '../lib/requestFn.js';
+import type { OperationInfiniteData } from './OperationInfiniteData.js';
+import type {
+  ServiceOperationInfiniteQueryKey,
+  ServiceOperationQueryKey,
+} from './ServiceOperationKey.js';
+
+export interface ServiceOperationFetchInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  fetchInfiniteQuery<TPageParam extends TParams>(
+    options:
+      | (FetchInfiniteQueryOptionsByQueryKey<
+          TSchema,
+          TData,
+          TParams,
+          TPageParam,
+          TError
+        > &
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
+      | (FetchInfiniteQueryOptionsByParameters<
+          TSchema,
+          TData,
+          TParams,
+          TPageParam,
+          TError
+        > &
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
+    queryClient: QueryClient
+  ): Promise<OperationInfiniteData<TData, TParams>>;
+
+  prefetchInfiniteQuery<TPageParam extends TParams>(
+    options:
+      | (FetchInfiniteQueryOptionsByQueryKey<
+          TSchema,
+          TData,
+          TParams,
+          TPageParam,
+          TError
+        > &
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>)
+      | (FetchInfiniteQueryOptionsByParameters<
+          TSchema,
+          TData,
+          TParams,
+          TPageParam,
+          TError
+        > &
+          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams>),
+    queryClient: QueryClient
+  ): Promise<void>;
+}
+
+type FetchInfiniteQueryPages<TData = unknown, TPageParam = unknown> =
+  | {
+      pages?: never;
+    }
+  | {
+      pages: number;
+      getNextPageParam: GetNextPageParamFunction<
+        PartialParameters<TPageParam>,
+        TData
+      >;
+    };
+
+type FetchInfiniteQueryOptionsBase<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TPageParam = unknown,
+  TError = DefaultError,
+> = Omit<
+  FetchQueryOptions<
+    TData,
+    TError,
+    OperationInfiniteData<TData, TParams>,
+    ServiceOperationQueryKey<TSchema, TParams>,
+    TPageParam
+  >,
+  'queryKey'
+> &
+  InitialPageParam<PartialParameters<TPageParam>> &
+  FetchInfiniteQueryPages<TData, TPageParam>;
+
+type FetchInfiniteQueryOptionsByQueryKey<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TPageParam = {},
+  TError = DefaultError,
+> = FetchInfiniteQueryOptionsBase<
+  TSchema,
+  TData,
+  TParams,
+  TPageParam,
+  TError
+> & {
+  /**
+   * Fetch Queries by query key
+   */
+  queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
+  parameters?: never;
+};
+type FetchInfiniteQueryOptionsByParameters<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TPageParam = {},
+  TError = DefaultError,
+> = FetchInfiniteQueryOptionsBase<
+  TSchema,
+  TData,
+  TParams,
+  TPageParam,
+  TError
+> & {
+  /**
+   * Fetch Queries by parameters
+   */
+  parameters?: TParams;
+  queryKey?: never;
+};
+
+type FetchInfiniteQueryOptionsQueryFn<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+> =
+  | {
+      queryFn?: QueryFunction<
+        TData,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>
+      >;
+    }
+  | {
+      requestFn: RequestFn<TData>;
+      /**
+       * Base URL to use for the request (used in the `queryFn`)
+       * @example 'https://api.example.com'
+       */
+      baseUrl: string | undefined;
+      queryFn?: never; // Workaround to fix union type error
+    };

package/src/service-operation/ServiceOperationFetchQuery.ts

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

package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts

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

package/src/service-operation/ServiceOperationGetQueriesData.ts

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

package/src/service-operation/ServiceOperationGetQueryData.ts

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

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,
+> = NonNullable<T> extends never ? [S] : [S, T];

package/src/service-operation/ServiceOperationMutationFn.ts

@@ -0,0 +1,92 @@
+interface QueryFnBaseUrlOptions {
+  /**
+   * Base URL to use for the request
+   * @example 'https://api.example.com'
+   */
+  baseUrl: string;
+}
+
+interface ServiceOperationMutationFnOptionsBase<TBody, TParams> {
+  parameters: TParams;
+  body: TBody;
+}
+
+interface ServiceOperationMutationFnOptions<TBody, TParams>
+  extends ServiceOperationMutationFnOptionsBase<TBody, TParams> {
+  baseUrl?: never;
+}
+
+interface ServiceOperationMutationFnOptionsWithBaseUrl<TBody, TParams>
+  extends ServiceOperationMutationFnOptionsBase<TBody, TParams>,
+    QueryFnBaseUrlOptions {}
+
+export interface ServiceOperationMutationFn<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+> {
+  /**
+   * @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>;
+}