@openapi-qraft/react 1.5.0 → 1.7.0

package/src/service-operation/QueryFilters.ts

@@ -0,0 +1,227 @@
+import type { DefaultError, FetchStatus, Query } from '@tanstack/query-core';
+
+import type { PartialParameters } from '../lib/PartialParameters.type.js';
+import type { OperationInfiniteData } from './OperationInfiniteData.js';
+import type {
+  ServiceOperationBaseQueryKey,
+  ServiceOperationInfiniteQueryKey,
+  ServiceOperationQueryKey,
+} from './ServiceOperationKey.js';
+
+export type QueryTypeFilter = 'all' | 'active' | 'inactive';
+
+interface QueryFiltersBase<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> {
+  /**
+   * Include queries matching this predicate function
+   */
+  predicate?: TInfinite extends true
+    ? QueryFilterInfinitePredicate<TSchema, TData, TParams, TError>
+    : TInfinite extends false
+      ? QueryFilterRegularPredicate<TSchema, TData, TParams, TError>
+      : (query: string) => boolean;
+
+  /**
+   * Filter to active queries, inactive queries or all queries
+   */
+  type?: QueryTypeFilter;
+
+  /**
+   * Include or exclude stale queries
+   */
+  stale?: boolean;
+
+  /**
+   * Include queries matching their fetchStatus
+   */
+  fetchStatus?: FetchStatus;
+}
+
+interface QueryFiltersByQueryKeyBase<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
+  infinite?: never;
+  parameters?: never;
+}
+
+interface QueryFiltersByExactQueryKey<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersByQueryKeyBase<
+    TSchema,
+    TData,
+    TInfinite,
+    TParams,
+    TError
+  > {
+  /**
+   * Include queries matching this query key
+   */
+  queryKey: ServiceOperationBaseQueryKey<TSchema, TInfinite, TParams>;
+
+  /**
+   * Match query key exactly
+   */
+  exact: true;
+}
+
+interface QueryFiltersWeakExactQueryKey<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersByQueryKeyBase<
+    TSchema,
+    TData,
+    TInfinite,
+    TParams,
+    TError
+  > {
+  /**
+   * Include queries matching this query key
+   */
+  queryKey?: ServiceOperationBaseQueryKey<
+    TSchema,
+    TInfinite,
+    PartialParameters<TParams>
+  >;
+
+  /**
+   * Match query key exactly
+   */
+  exact?: false;
+}
+
+export type QueryFiltersByQueryKey<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> =
+  | QueryFiltersByExactQueryKey<TSchema, TData, TInfinite, TParams, TError>
+  | QueryFiltersWeakExactQueryKey<TSchema, TData, TInfinite, TParams, TError>;
+
+interface QueryFiltersByParametersBase<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
+  /**
+   * Is the query infinite
+   */
+  infinite?: TInfinite;
+
+  queryKey?: never;
+}
+
+interface QueryFiltersByExactParameters<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersByParametersBase<
+    TSchema,
+    TData,
+    TInfinite,
+    TParams,
+    TError
+  > {
+  /**
+   * Match query key exactly
+   */
+  exact: true;
+
+  /**
+   * Include queries matching parameters
+   */
+  parameters: TParams;
+}
+
+interface QueryFiltersByWeakParameters<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> extends QueryFiltersByParametersBase<
+    TSchema,
+    TData,
+    TInfinite,
+    TParams,
+    TError
+  > {
+  /**
+   * Match query key exactly
+   */
+  exact?: false;
+
+  /**
+   * Include queries matching parameters
+   */
+  parameters?: PartialParameters<TParams>;
+}
+
+export type QueryFiltersByParameters<
+  TSchema extends { url: string; method: string },
+  TData,
+  TInfinite extends boolean,
+  TParams = {},
+  TError = DefaultError,
+> =
+  | QueryFiltersByExactParameters<TSchema, TData, TInfinite, TParams, TError>
+  | QueryFiltersByWeakParameters<TSchema, TData, TInfinite, TParams, TError>;
+
+interface QueryFilterInfinitePredicate<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  /**
+   * Include queries matching this predicate function
+   */
+  (
+    query: Query<
+      OperationInfiniteData<TData, TParams>,
+      TError,
+      OperationInfiniteData<TData, TParams>,
+      ServiceOperationInfiniteQueryKey<TSchema, TParams>
+    >
+  ): boolean;
+}
+
+interface QueryFilterRegularPredicate<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  /**
+   * Include queries matching this predicate function
+   */
+  (
+    query: Query<
+      TData,
+      TError,
+      TData,
+      ServiceOperationQueryKey<TSchema, TParams>
+    >
+  ): boolean;
+}

package/src/service-operation/ServiceOperation.ts

@@ -0,0 +1,86 @@
+import type { DefaultError } from '@tanstack/query-core';
+
+import type { ServiceOperationCancelQueries } from './ServiceOperationCancelQueries.js';
+import type { ServiceOperationFetchInfiniteQuery } from './ServiceOperationFetchInfiniteQuery.js';
+import type { ServiceOperationFetchQuery } from './ServiceOperationFetchQuery.js';
+import type { ServiceOperationGetInfiniteQueryData } from './ServiceOperationGetInfiniteQueryData.js';
+import type { ServiceOperationGetQueriesData } from './ServiceOperationGetQueriesData.js';
+import type { ServiceOperationGetQueryData } from './ServiceOperationGetQueryData.js';
+import type { ServiceOperationGetQueryState } from './ServiceOperationGetQueryState.js';
+import type { ServiceOperationInvalidateQueries } from './ServiceOperationInvalidateQueries.js';
+import type { ServiceOperationIsFetchingQueries } from './ServiceOperationIsFetchingQueries.js';
+import type { ServiceOperationIsMutatingQueries } from './ServiceOperationIsMutatingQueries.js';
+import type { ServiceOperationMutationFn } from './ServiceOperationMutationFn.js';
+import type { ServiceOperationQueryFn } from './ServiceOperationQueryFn.js';
+import type { ServiceOperationRefetchQueries } from './ServiceOperationRefetchQueries.js';
+import type { ServiceOperationRemoveQueries } from './ServiceOperationRemoveQueries.js';
+import type { ServiceOperationResetQueries } from './ServiceOperationResetQueries.js';
+import type { ServiceOperationSetInfiniteQueryData } from './ServiceOperationSetInfiniteQueryData.js';
+import type { ServiceOperationSetQueriesData } from './ServiceOperationSetQueriesData.js';
+import type { ServiceOperationSetQueryData } from './ServiceOperationSetQueryData.js';
+import type { ServiceOperationUseInfiniteQuery } from './ServiceOperationUseInfiniteQuery.js';
+import type { ServiceOperationUseIsFetchingQueries } from './ServiceOperationUseIsFetchingQueries.js';
+import type { ServiceOperationUseIsMutating } from './ServiceOperationUseIsMutating.js';
+import type { ServiceOperationUseMutation } from './ServiceOperationUseMutation.js';
+import type { ServiceOperationUseMutationState } from './ServiceOperationUseMutationState.js';
+import type { ServiceOperationUseQueries } from './ServiceOperationUseQueries.js';
+import type { ServiceOperationUseQuery } from './ServiceOperationUseQuery.js';
+import type { ServiceOperationUseSuspenseInfiniteQuery } from './ServiceOperationUseSuspenseInfiniteQuery.js';
+import type { ServiceOperationUseSuspenseQueries } from './ServiceOperationUseSuspenseQueries.js';
+import type { ServiceOperationUseSuspenseQueryQuery } from './ServiceOperationUseSuspenseQueryQuery.js';
+
+export interface ServiceOperationQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams,
+  TError = DefaultError,
+> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationQueryFn<TSchema, TData, TParams>,
+    ServiceOperationFetchQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationGetQueryData<TSchema, TData, TParams>,
+    ServiceOperationGetQueryState<TSchema, TData, TParams, TError>,
+    ServiceOperationGetQueriesData<TSchema, TData, TParams, TError>,
+    ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>,
+    ServiceOperationSetQueryData<TSchema, TData, TParams>,
+    ServiceOperationSetQueriesData<TSchema, TData, TParams, TError>,
+    ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>,
+    ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationCancelQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationResetQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
+  schema: TSchema;
+  types: {
+    parameters: TParams;
+    data: TData;
+    error: TError;
+  };
+}
+
+export interface ServiceOperationMutation<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>,
+    ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>,
+    ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>,
+    ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError>,
+    ServiceOperationMutationFn<TSchema, TBody, TData, TParams> {
+  schema: TSchema;
+  types: {
+    parameters: TParams;
+    data: TData;
+    error: TError;
+    body: TBody;
+  };
+}

package/src/service-operation/ServiceOperationCancelQueries.ts

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

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;
+}