@openapi-qraft/react 1.6.0 → 1.8.0

package/src/service-operation/ServiceOperationUseMutationState.ts

@@ -0,0 +1,112 @@
+import type {
+  DefaultError,
+  Mutation,
+  MutationState,
+  MutationStatus,
+  QueryClient,
+} from '@tanstack/query-core';
+
+import type { PartialParameters } from '../lib/PartialParameters.type.js';
+import type { ServiceOperationMutationKey } from './ServiceOperationKey.js';
+import type { MutationVariables } from './ServiceOperationUseMutation.js';
+
+interface UseMutationStateFiltersBase<
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+  TContext = unknown,
+> {
+  /**
+   * Match mutation key exactly
+   */
+  exact?: boolean;
+  /**
+   * Include mutations matching this predicate function
+   */
+  predicate?: (
+    mutation: Mutation<
+      TData,
+      TError,
+      MutationVariables<TBody, TParams>,
+      TContext
+    >
+  ) => boolean;
+
+  /**
+   * Filter by mutation status
+   */
+  status?: MutationStatus;
+}
+
+export interface MutationFiltersByParameters<
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+  TContext = unknown,
+> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
+  /**
+   * Include mutations matching these parameters
+   */
+  parameters?: PartialParameters<TParams>;
+  mutationKey?: never;
+}
+
+export interface MutationFiltersByMutationKey<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+  TContext = unknown,
+> extends UseMutationStateFiltersBase<TBody, TData, TParams, TError, TContext> {
+  /**
+   * Include mutations matching this mutation key
+   */
+  mutationKey?: ServiceOperationMutationKey<
+    TSchema,
+    PartialParameters<TParams>
+  >;
+  parameters?: never;
+}
+
+export interface ServiceOperationUseMutationState<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+> {
+  useMutationState<
+    TContext = unknown,
+    TResult = MutationState<
+      TData,
+      TError,
+      MutationVariables<TBody, TParams>,
+      TContext
+    >,
+  >(
+    options?: {
+      filters?:
+        | MutationFiltersByParameters<TBody, TData, TParams, TError, TContext>
+        | MutationFiltersByMutationKey<
+            TSchema,
+            TBody,
+            TData,
+            TParams,
+            TError,
+            TContext
+          >;
+      select?: (
+        mutation: Mutation<
+          TData,
+          TError,
+          MutationVariables<TBody, TParams>,
+          TContext
+        >
+      ) => TResult;
+    },
+    queryClient?: QueryClient
+  ): Array<TResult>;
+}

package/src/service-operation/ServiceOperationUseQueries.ts

@@ -0,0 +1,40 @@
+import type {
+  DefaultError,
+  QueriesPlaceholderDataFunction,
+  QueryClient,
+} from '@tanstack/query-core';
+import type { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useQueries<TCombinedResult = Array<UseQueryResult<TData, TError>>>(
+    options: {
+      queries: ReadonlyArray<
+        Omit<
+          UseQueryOptions<
+            TData,
+            TError,
+            TData,
+            ServiceOperationQueryKey<TSchema, TParams>
+          >,
+          'placeholderData' | 'suspense' | 'queryKey'
+        > & {
+          placeholderData?: TData | QueriesPlaceholderDataFunction<TData>;
+        } & (
+            | { parameters: TParams; queryKey?: never }
+            | { queryKey: ServiceOperationQueryKey<TSchema, TParams> }
+          )
+      >;
+      combine?: (
+        results: Array<UseQueryResult<TData, TError>>
+      ) => TCombinedResult;
+    },
+    queryClient?: QueryClient
+  ): TCombinedResult;
+}

package/src/service-operation/ServiceOperationUseQuery.ts

@@ -0,0 +1,48 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type {
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
+  UndefinedInitialDataOptions,
+  UseQueryResult,
+} from '@tanstack/react-query';
+
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  getQueryKey<QueryKeyParams extends TParams | undefined = undefined>(
+    parameters?: QueryKeyParams
+  ): ServiceOperationQueryKey<TSchema, QueryKeyParams>;
+
+  useQuery(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    options?: Omit<
+      UndefinedInitialDataOptions<
+        TData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >,
+    queryClient?: QueryClient
+  ): UseQueryResult<TData, TError | Error>;
+
+  useQuery(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    options: Omit<
+      DefinedInitialDataOptions<
+        TData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >,
+    queryClient?: QueryClient
+  ): DefinedUseQueryResult<TData, TError | Error>;
+}

package/src/service-operation/ServiceOperationUseSuspenseInfiniteQuery.ts

@@ -0,0 +1,43 @@
+import type {
+  DefaultError,
+  InfiniteQueryPageParamsOptions,
+  QueryClient,
+} from '@tanstack/query-core';
+import type {
+  UseSuspenseInfiniteQueryOptions,
+  UseSuspenseInfiniteQueryResult,
+} 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 ServiceOperationUseSuspenseInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useSuspenseInfiniteQuery<TPageParam extends TParams>(
+    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+    options: Omit<
+      UseSuspenseInfiniteQueryOptions<
+        TData,
+        TError,
+        OperationInfiniteData<TData, TParams>,
+        TData,
+        ServiceOperationInfiniteQueryKey<TSchema, TParams>,
+        PartialParameters<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<TData, PartialParameters<TPageParam>>,
+    queryClient?: QueryClient
+  ): UseSuspenseInfiniteQueryResult<
+    OperationInfiniteData<TData, TParams>,
+    TError | Error
+  >;
+}

package/src/service-operation/ServiceOperationUseSuspenseQueries.ts

@@ -0,0 +1,40 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type {
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from '@tanstack/react-query';
+
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseSuspenseQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useSuspenseQueries<
+    TCombinedResult = Array<UseSuspenseQueryResult<TData, TError>>,
+  >(
+    options: {
+      queries: ReadonlyArray<
+        Omit<
+          UseSuspenseQueryOptions<
+            TData,
+            TError,
+            TData,
+            ServiceOperationQueryKey<TSchema, TParams>
+          >,
+          'queryKey'
+        > &
+          (
+            | { parameters: TParams; queryKey?: never }
+            | { queryKey: ServiceOperationQueryKey<TSchema, TParams> }
+          )
+      >;
+      combine?: (
+        results: Array<UseSuspenseQueryResult<TData, TError>>
+      ) => TCombinedResult;
+    },
+    queryClient?: QueryClient
+  ): TCombinedResult;
+}

package/src/service-operation/ServiceOperationUseSuspenseQueryQuery.ts

@@ -0,0 +1,28 @@
+import type { DefaultError, QueryClient } from '@tanstack/query-core';
+import type {
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from '@tanstack/react-query';
+
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export interface ServiceOperationUseSuspenseQueryQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useSuspenseQuery(
+    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>,
+    options?: Omit<
+      UseSuspenseQueryOptions<
+        TData,
+        TError,
+        TData,
+        ServiceOperationQueryKey<TSchema, TParams>
+      >,
+      'queryKey'
+    >,
+    queryClient?: QueryClient
+  ): UseSuspenseQueryResult<TData, TError | Error>;
+}

package/src/service-operation/index.ts

@@ -0,0 +1,4 @@
+export type {
+  ServiceOperationQuery,
+  ServiceOperationMutation,
+} from './ServiceOperation.js';