@apollo/client 4.0.0-rc.3 → 4.0.0-rc.5

package/react/hooks/useQuery.d.ts

@@ -1,254 +1,278 @@
 import type { ApolloClient, ApolloQueryResult, DataState, DefaultContext, DocumentNode, ErrorLike, ErrorPolicy, FetchMoreOptions, GetDataState, ObservableQuery, OperationVariables, QueryResult, RefetchWritePolicy, SubscribeToMoreFunction, TypedDocumentNode, UpdateQueryMapFn, WatchQueryFetchPolicy, WatchQueryOptions } from "@apollo/client";
 import { NetworkStatus } from "@apollo/client";
 import type { MaybeMasked } from "@apollo/client/masking";
-import type { NoInfer, VariablesOption } from "@apollo/client/utilities/internal";
+import type { DocumentationTypes as UtilityDocumentationTypes, NoInfer, VariablesOption } from "@apollo/client/utilities/internal";
 import type { NextFetchPolicyContext } from "../../core/watchQueryOptions.js";
 export declare namespace useQuery {
-    type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
-        /**
-        * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
-        * 
-        * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
-        * 
-        * The default value is `cache-first`.
-        * 
-        * @docGroup
-        * 
-        * 3. Caching options
-        */
-        fetchPolicy?: WatchQueryFetchPolicy;
-        /**
-        * Specifies the `FetchPolicy` to be used after this query has completed.
-        * 
-        * @docGroup
-        * 
-        * 3. Caching options
-        */
-        nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
-        /**
-        * Defaults to the initial value of options.fetchPolicy, but can be explicitly configured to specify the WatchQueryFetchPolicy to revert back to whenever variables change (unless nextFetchPolicy intervenes).
-        * 
-        * @docGroup
-        * 
-        * 3. Caching options
-        */
-        initialFetchPolicy?: WatchQueryFetchPolicy;
-        /**
-        * Specifies whether a `NetworkStatus.refetch` operation should merge incoming field data with existing data, or overwrite the existing data. Overwriting is probably preferable, but merging is currently the default behavior, for backwards compatibility with Apollo Client 3.x.
-        * 
-        * @docGroup
-        * 
-        * 3. Caching options
-        */
-        refetchWritePolicy?: RefetchWritePolicy;
-        /**
-        * Specifies how the query handles a response that returns both GraphQL errors and partial results.
-        * 
-        * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
-        * 
-        * The default value is `none`, meaning that the query result includes error details but not partial results.
-        * 
-        * @docGroup
-        * 
-        * 1. Operation options
-        */
-        errorPolicy?: ErrorPolicy;
-        /**
-        * Specifies the interval (in milliseconds) at which the query polls for updated results.
-        * 
-        * The default value is `0` (no polling).
-        * 
-        * @docGroup
-        * 
-        * 2. Networking options
-        */
-        pollInterval?: number;
-        /**
-        * If `true`, the in-progress query's associated component re-renders whenever the network status changes or a network error occurs.
-        * 
-        * The default value is `true`.
-        * 
-        * @docGroup
-        * 
-        * 2. Networking options
-        */
-        notifyOnNetworkStatusChange?: boolean;
-        /**
-        * If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
-        * 
-        * The default value is `false`.
-        * 
-        * @docGroup
-        * 
-        * 3. Caching options
-        */
-        returnPartialData?: boolean;
-        /**
-        * A callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval.
-        * 
-        * @docGroup
-        * 
-        * 2. Networking options
-        */
-        skipPollAttempt?: () => boolean;
-        /**
-        * Pass `false` to skip executing the query during [server-side rendering](https://www.apollographql.com/docs/react/performance/server-side-rendering/).
-        * 
-        * @docGroup
-        * 
-        * 2. Networking options
-        */
-        ssr?: boolean;
-        /**
-        * The instance of `ApolloClient` to use to execute the query.
-        * 
-        * By default, the instance that's passed down via context is used, but you can provide a different instance here.
-        * 
-        * @docGroup
-        * 
-        * 1. Operation options
-        */
-        client?: ApolloClient;
-        /**
-        * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
-        * 
-        * @docGroup
-        * 
-        * 2. Networking options
-        */
-        context?: DefaultContext;
-        /**
-        * If true, the query is not executed.
-        * 
-        * The default value is `false`.
-        * 
-        * @docGroup
-        * 
-        * 1. Operation options
-        */
-        skip?: boolean;
-    } & VariablesOption<TVariables>;
-    type Result<TData = unknown, TVariables extends OperationVariables = OperationVariables, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = {
-        /**
-        * The instance of Apollo Client that executed the query. Can be useful for manually executing followup queries or writing data to the cache.
-        * 
-        * @docGroup
-        * 
-        * 2. Network info
-        */
-        client: ApolloClient;
-        /**
-        * A reference to the internal `ObservableQuery` used by the hook.
-        */
-        observable: ObservableQuery<TData, TVariables>;
-        /**
-        * An object containing the result from the most recent _previous_ execution of this query.
-        * 
-        * This value is `undefined` if this is the query's first execution.
-        * 
-        * @docGroup
-        * 
-        * 1. Operation data
-        */
-        previousData?: MaybeMasked<TData>;
-        /**
-        * If the query produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
-        * 
-        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
-        * 
-        * @docGroup
-        * 
-        * 1. Operation data
-        */
-        error?: ErrorLike;
-        /**
-        * If `true`, the query is still in flight and results have not yet been returned.
-        * 
-        * @docGroup
-        * 
-        * 2. Network info
-        */
-        loading: boolean;
-        /**
-        * A number indicating the current network state of the query's associated request. [See possible values.](https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/core/networkStatus.ts#L4)
-        * 
-        * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
-        * 
-        * @docGroup
-        * 
-        * 2. Network info
-        */
-        networkStatus: NetworkStatus;
-        /**
-        * A function that instructs the query to begin re-executing at a specified interval (in milliseconds).
-        * 
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        startPolling: (pollInterval: number) => void;
-        /**
-        * A function that instructs the query to stop polling after a previous call to `startPolling`.
-        * 
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        stopPolling: () => void;
-        /**
-        * A function that enables you to execute a [subscription](https://www.apollographql.com/docs/react/data/subscriptions/), usually to subscribe to specific fields that were included in the query.
-        * 
-        * This function returns _another_ function that you can call to terminate the subscription.
-        * 
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
-        /**
-        * A function that enables you to update the query's cached result without executing a followup GraphQL operation.
-        * 
-        * See [using updateQuery and updateFragment](https://www.apollographql.com/docs/react/caching/cache-interaction/#using-updatequery-and-updatefragment) for additional information.
-        * 
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        updateQuery: (mapFn: UpdateQueryMapFn<TData, TVariables>) => void;
-        /**
-        * A function that enables you to re-execute the query, optionally passing in new `variables`.
-        * 
-        * To guarantee that the refetch performs a network request, its `fetchPolicy` is set to `network-only` (unless the original query's `fetchPolicy` is `no-cache` or `cache-and-network`, which also guarantee a network request).
-        * 
-        * See also [Refetching](https://www.apollographql.com/docs/react/data/queries/#refetching).
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        refetch: (variables?: Partial<TVariables>) => Promise<QueryResult<MaybeMasked<TData>>>;
-        /**
-        * An object containing the variables that were provided for the query.
-        * 
-        * @docGroup
-        * 
-        * 1. Operation data
-        */
-        variables: TVariables;
-        /**
-        * A function that helps you fetch the next set of results for a [paginated list field](https://www.apollographql.com/docs/react/pagination/core-api/).
-        * 
-        * 
-        * @docGroup
-        * 
-        * 3. Helper functions
-        */
-        fetchMore: <TFetchData = TData, TFetchVars extends OperationVariables = TVariables>(fetchMoreOptions: FetchMoreOptions<TData, TVariables, TFetchData, TFetchVars>) => Promise<QueryResult<MaybeMasked<TFetchData>>>;
-    } & GetDataState<MaybeMasked<TData>, TStates>;
+    namespace Base {
+        interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+            /**
+            * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
+            * 
+            * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
+            * 
+            * The default value is `cache-first`.
+            * 
+            * @docGroup
+            * 
+            * 3. Caching options
+            */
+            fetchPolicy?: WatchQueryFetchPolicy;
+            /**
+            * Specifies the `FetchPolicy` to be used after this query has completed.
+            * 
+            * @docGroup
+            * 
+            * 3. Caching options
+            */
+            nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
+            /**
+            * Defaults to the initial value of options.fetchPolicy, but can be explicitly configured to specify the WatchQueryFetchPolicy to revert back to whenever variables change (unless nextFetchPolicy intervenes).
+            * 
+            * @docGroup
+            * 
+            * 3. Caching options
+            */
+            initialFetchPolicy?: WatchQueryFetchPolicy;
+            /**
+            * Specifies whether a `NetworkStatus.refetch` operation should merge incoming field data with existing data, or overwrite the existing data. Overwriting is probably preferable, but merging is currently the default behavior, for backwards compatibility with Apollo Client 3.x.
+            * 
+            * @docGroup
+            * 
+            * 3. Caching options
+            */
+            refetchWritePolicy?: RefetchWritePolicy;
+            /**
+            * Specifies how the query handles a response that returns both GraphQL errors and partial results.
+            * 
+            * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
+            * 
+            * The default value is `none`, meaning that the query result includes error details but not partial results.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation options
+            */
+            errorPolicy?: ErrorPolicy;
+            /**
+            * Specifies the interval (in milliseconds) at which the query polls for updated results.
+            * 
+            * The default value is `0` (no polling).
+            * 
+            * @docGroup
+            * 
+            * 2. Networking options
+            */
+            pollInterval?: number;
+            /**
+            * If `true`, the in-progress query's associated component re-renders whenever the network status changes or a network error occurs.
+            * 
+            * The default value is `true`.
+            * 
+            * @docGroup
+            * 
+            * 2. Networking options
+            */
+            notifyOnNetworkStatusChange?: boolean;
+            /**
+            * If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
+            * 
+            * The default value is `false`.
+            * 
+            * @docGroup
+            * 
+            * 3. Caching options
+            */
+            returnPartialData?: boolean;
+            /**
+            * A callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval.
+            * 
+            * @docGroup
+            * 
+            * 2. Networking options
+            */
+            skipPollAttempt?: () => boolean;
+            /**
+            * Pass `false` to skip executing the query during [server-side rendering](https://www.apollographql.com/docs/react/performance/server-side-rendering/).
+            * 
+            * @docGroup
+            * 
+            * 2. Networking options
+            */
+            ssr?: boolean;
+            /**
+            * The instance of `ApolloClient` to use to execute the query.
+            * 
+            * By default, the instance that's passed down via context is used, but you can provide a different instance here.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation options
+            */
+            client?: ApolloClient;
+            /**
+            * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
+            * 
+            * @docGroup
+            * 
+            * 2. Networking options
+            */
+            context?: DefaultContext;
+            /**
+            * If true, the query is not executed.
+            * 
+            * The default value is `false`.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation options
+            */
+            skip?: boolean;
+        }
+    }
+    type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = Base.Options<TData, TVariables> & VariablesOption<TVariables>;
+    namespace DocumentationTypes {
+        interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Options<TData, TVariables> {
+            /**
+            * An object containing all of the GraphQL variables your query requires to execute.
+            * 
+            * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation options
+            */
+            variables?: TVariables;
+        }
+    }
+    namespace Base {
+        interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+            /**
+            * The instance of Apollo Client that executed the query. Can be useful for manually executing followup queries or writing data to the cache.
+            * 
+            * @docGroup
+            * 
+            * 2. Network info
+            */
+            client: ApolloClient;
+            /**
+            * A reference to the internal `ObservableQuery` used by the hook.
+            */
+            observable: ObservableQuery<TData, TVariables>;
+            /**
+            * An object containing the result from the most recent _previous_ execution of this query.
+            * 
+            * This value is `undefined` if this is the query's first execution.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation data
+            */
+            previousData?: MaybeMasked<TData>;
+            /**
+            * A single ErrorLike object describing the error that occured during the latest query execution.
+            * 
+            * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+            * 
+            * @docGroup
+            * 
+            * 1. Operation data
+            */
+            error?: ErrorLike;
+            /**
+            * If `true`, the query is still in flight and results have not yet been returned.
+            * 
+            * @docGroup
+            * 
+            * 2. Network info
+            */
+            loading: boolean;
+            /**
+            * A number indicating the current network state of the query's associated request. [See possible values.](https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/core/networkStatus.ts#L4)
+            * 
+            * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
+            * 
+            * @docGroup
+            * 
+            * 2. Network info
+            */
+            networkStatus: NetworkStatus;
+            /**
+            * A function that instructs the query to begin re-executing at a specified interval (in milliseconds).
+            * 
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            startPolling: (pollInterval: number) => void;
+            /**
+            * A function that instructs the query to stop polling after a previous call to `startPolling`.
+            * 
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            stopPolling: () => void;
+            /**
+            * A function that enables you to execute a [subscription](https://www.apollographql.com/docs/react/data/subscriptions/), usually to subscribe to specific fields that were included in the query.
+            * 
+            * This function returns _another_ function that you can call to terminate the subscription.
+            * 
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
+            /**
+            * A function that enables you to update the query's cached result without executing a followup GraphQL operation.
+            * 
+            * See [using updateQuery and updateFragment](https://www.apollographql.com/docs/react/caching/cache-interaction/#using-updatequery-and-updatefragment) for additional information.
+            * 
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            updateQuery: (mapFn: UpdateQueryMapFn<TData, TVariables>) => void;
+            /**
+            * A function that enables you to re-execute the query, optionally passing in new `variables`.
+            * 
+            * To guarantee that the refetch performs a network request, its `fetchPolicy` is set to `network-only` (unless the original query's `fetchPolicy` is `no-cache` or `cache-and-network`, which also guarantee a network request).
+            * 
+            * See also [Refetching](https://www.apollographql.com/docs/react/data/queries/#refetching).
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            refetch: (variables?: Partial<TVariables>) => Promise<QueryResult<MaybeMasked<TData>>>;
+            /**
+            * An object containing the variables that were provided for the query.
+            * 
+            * @docGroup
+            * 
+            * 1. Operation data
+            */
+            variables: TVariables;
+            /**
+            * A function that helps you fetch the next set of results for a [paginated list field](https://www.apollographql.com/docs/react/pagination/core-api/).
+            * 
+            * 
+            * @docGroup
+            * 
+            * 3. Helper functions
+            */
+            fetchMore: <TFetchData = TData, TFetchVars extends OperationVariables = TVariables>(fetchMoreOptions: FetchMoreOptions<TData, TVariables, TFetchData, TFetchVars>) => Promise<QueryResult<MaybeMasked<TFetchData>>>;
+        }
+    }
+    type Result<TData = unknown, TVariables extends OperationVariables = OperationVariables, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = Base.Result<TData, TVariables> & GetDataState<MaybeMasked<TData>, TStates>;
+    namespace DocumentationTypes {
+        interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Result<TData, TVariables>, UtilityDocumentationTypes.DataState<TData> {
+        }
+    }
 }
 export declare function useQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useQuery.Options<NoInfer<TData>, NoInfer<TVariables>> & {
     returnPartialData: true;