@apollo/client 4.0.0-alpha.1 → 4.0.0-alpha.11

package/__cjs/react/hooks/useLazyQuery.d.cts

@@ -1,282 +1,284 @@
 import type { TypedDocumentNode } from "@graphql-typed-document-node/core";
 import type { DocumentNode } from "graphql";
-import type { ApolloClient, ApolloQueryResult, DefaultContext, ErrorLike, ErrorPolicy, FetchMoreQueryOptions, MaybeMasked, ObservableQuery, OperationVariables, RefetchWritePolicy, SubscribeToMoreFunction, Unmasked, UpdateQueryMapFn, WatchQueryFetchPolicy, WatchQueryOptions } from "@apollo/client/core";
-import { NetworkStatus } from "@apollo/client/core";
-import type { NoInfer } from "@apollo/client/react";
-import type { VariablesOption } from "@apollo/client/react";
-import type { OnlyRequiredProperties } from "@apollo/client/utilities";
+import type { ApolloClient, DefaultContext, ErrorLike, ErrorPolicy, FetchMoreQueryOptions, MaybeMasked, ObservableQuery, OperationVariables, QueryResult, RefetchWritePolicy, SubscribeToMoreFunction, Unmasked, UpdateQueryMapFn, WatchQueryFetchPolicy, WatchQueryOptions } from "@apollo/client";
+import { NetworkStatus } from "@apollo/client";
+import type { NoInfer, VariablesOption } from "@apollo/client/utilities";
 import type { NextFetchPolicyContext } from "../../core/watchQueryOptions.cjs";
-export interface LazyQueryHookOptions<TData = any, 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);
-    /**
-    * 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 `false`.
-    * 
-    * @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;
-    /**
-    * Whether to canonize cache results before returning them. Canonization takes some extra time, but it speeds up future deep equality comparisons. Defaults to false.
-    * 
-    * @deprecated
-    * 
-    * Using `canonizeResults` can result in memory leaks so we generally do not recommend using this option anymore. A future version of Apollo Client will contain a similar feature without the risk of memory leaks.
-    */
-    canonizeResults?: 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;
-    /**
-    * 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<any>;
-    /**
-    * 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;
+export declare namespace useLazyQuery {
+    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);
+        /**
+        * 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;
+        /**
+        * 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;
+    }
+    type Result<TData, TVariables extends OperationVariables> = {
+        /**
+        * 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>>>;
+        /**
+        * 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: FetchMoreQueryOptions<TFetchVars, TFetchData> & {
+            updateQuery?: (previousQueryResult: Unmasked<TData>, options: {
+                fetchMoreResult: Unmasked<TFetchData>;
+                variables: TFetchVars;
+            }) => Unmasked<TData>;
+        }) => Promise<QueryResult<MaybeMasked<TFetchData>>>;
+        /**
+        * 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 of your GraphQL query after it completes.
+        * 
+        * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+        * 
+        * @docGroup
+        * 
+        * 1. Operation data
+        */
+        data: MaybeMasked<TData> | undefined;
+        /**
+        * 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;
+    } & ({
+        /**
+         * If `true`, the associated lazy query has been executed.
+         *
+         * @docGroup 2. Network info
+         */
+        called: true;
+        /**
+        * An object containing the variables that were provided for the query.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation data
+        */
+        variables: TVariables;
+    } | {
+        /**
+         * If `true`, the associated lazy query has been executed.
+         *
+         * @docGroup 2. Network info
+         */
+        called: false;
+        /**
+        * An object containing the variables that were provided for the query.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation data
+        */
+        variables: Partial<TVariables>;
+    });
+    type ExecOptions<TVariables extends OperationVariables = OperationVariables> = {
+        /**
+        * 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;
+    } & VariablesOption<TVariables>;
+    type ResultTuple<TData, TVariables extends OperationVariables> = [
+        execute: ExecFunction<TData, TVariables>,
+        result: useLazyQuery.Result<TData, TVariables>
+    ];
+    type ExecFunction<TData, TVariables extends OperationVariables> = (...args: {} extends TVariables ? [
+        options?: useLazyQuery.ExecOptions<TVariables>
+    ] : [options: useLazyQuery.ExecOptions<TVariables>]) => Promise<QueryResult<TData>>;
 }
-export type LazyQueryHookExecOptions<TVariables extends OperationVariables = OperationVariables> = {
-    /**
-    * 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;
-} & VariablesOption<TVariables>;
-export interface LazyQueryResult<TData, TVariables extends OperationVariables> {
-    /**
-    * 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<ApolloQueryResult<MaybeMasked<TData>>>;
-    /**
-    * An object containing the variables that were provided for the query.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation data
-    */
-    variables: TVariables | undefined;
-    /**
-    * 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: FetchMoreQueryOptions<TFetchVars, TFetchData> & {
-        updateQuery?: (previousQueryResult: Unmasked<TData>, options: {
-            fetchMoreResult: Unmasked<TFetchData>;
-            variables: TFetchVars;
-        }) => Unmasked<TData>;
-    }) => Promise<ApolloQueryResult<MaybeMasked<TFetchData>>>;
-    /**
-    * 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<any>;
-    /**
-    * A reference to the internal `ObservableQuery` used by the hook.
-    */
-    observable: ObservableQuery<TData, TVariables>;
-    /**
-    * An object containing the result of your GraphQL query after it completes.
-    * 
-    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
-    * 
-    * @docGroup
-    * 
-    * 1. Operation data
-    */
-    data: MaybeMasked<TData> | undefined;
-    /**
-    * 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;
-    /**
-    * If `true`, the associated lazy query has been executed.
-    * 
-    * This field is only present on the result object returned by [`useLazyQuery`](/react/data/queries/#executing-queries-manually).
-    * 
-    * @docGroup
-    * 
-    * 2. Network info
-    */
-    called: boolean;
-}
-export type LazyQueryResultTuple<TData, TVariables extends OperationVariables> = [
-    execute: LazyQueryExecFunction<TData, TVariables>,
-    result: LazyQueryResult<TData, TVariables>
-];
-export type LazyQueryExecFunction<TData, TVariables extends OperationVariables> = (...args: [TVariables] extends [never] ? [
-    options?: LazyQueryHookExecOptions<TVariables>
-] : Record<string, never> extends OnlyRequiredProperties<TVariables> ? [
-    options?: LazyQueryHookExecOptions<TVariables>
-] : [options: LazyQueryHookExecOptions<TVariables>]) => Promise<ApolloQueryResult<TData>>;
 /**
  * A hook for imperatively executing queries in an Apollo application, e.g. in response to user interaction.
  *
@@ -312,5 +314,5 @@ export type LazyQueryExecFunction<TData, TVariables extends OperationVariables>
  * @param options - Default options to control how the query is executed.
  * @returns A tuple in the form of `[execute, result]`
  */
-export declare function useLazyQuery<TData = any, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: LazyQueryHookOptions<NoInfer<TData>, NoInfer<TVariables>>): LazyQueryResultTuple<TData, TVariables>;
+export declare function useLazyQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: useLazyQuery.Options<NoInfer<TData>, NoInfer<TVariables>>): useLazyQuery.ResultTuple<TData, TVariables>;
 //# sourceMappingURL=useLazyQuery.d.cts.map

package/__cjs/react/hooks/useLoadableQuery.cjs

@@ -5,14 +5,15 @@ const tslib_1 = require("tslib");
 const React = tslib_1.__importStar(require("react"));
 const cache_1 = require("@apollo/client/cache");
 const internal_1 = require("@apollo/client/react/internal");
+const environment_1 = require("@apollo/client/utilities/environment");
 const invariant_1 = require("@apollo/client/utilities/invariant");
 const index_js_1 = require("./internal/index.cjs");
+const validateSuspenseHookOptions_js_1 = require("./internal/validateSuspenseHookOptions.cjs");
 const useApolloClient_js_1 = require("./useApolloClient.cjs");
-const useSuspenseQuery_js_1 = require("./useSuspenseQuery.cjs");
 function useLoadableQuery(query, options = {}) {
     const client = (0, useApolloClient_js_1.useApolloClient)(options.client);
     const suspenseCache = (0, internal_1.getSuspenseCache)(client);
-    const watchQueryOptions = (0, useSuspenseQuery_js_1.useWatchQueryOptions)({ client, query, options });
+    const watchQueryOptions = useWatchQueryOptions({ client, query, options });
     const { queryKey = [] } = options;
     const [queryRef, setQueryRef] = React.useState(null);
     (0, internal_1.assertWrappedQueryRef)(queryRef);
@@ -70,4 +71,22 @@ function useLoadableQuery(query, options = {}) {
     }, []);
     return [loadQuery, queryRef, { fetchMore, refetch, reset, subscribeToMore }];
 }
+function useWatchQueryOptions({ client, query, options, }) {
+    return (0, index_js_1.useDeepMemo)(() => {
+        const fetchPolicy = options.fetchPolicy ||
+            client.defaultOptions.watchQuery?.fetchPolicy ||
+            "cache-first";
+        const watchQueryOptions = {
+            ...options,
+            fetchPolicy,
+            query,
+            notifyOnNetworkStatusChange: false,
+            nextFetchPolicy: void 0,
+        };
+        if (environment_1.__DEV__) {
+            (0, validateSuspenseHookOptions_js_1.validateSuspenseHookOptions)(watchQueryOptions);
+        }
+        return watchQueryOptions;
+    }, [client, options, query]);
+}
 //# sourceMappingURL=useLoadableQuery.cjs.map