@apollo/client 4.2.0-alpha.3 → 4.2.0-alpha.4

package/invariantErrorCodes.js

@@ -363,7 +363,7 @@ const client = new ApolloClient({
         "For more information, please visit: https://go.apollo.dev/c/docs"
   },
 
-  70: {
+  72: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "options.fetchPolicy !== \"cache-and-network\"",
 
@@ -373,7 +373,7 @@ const client = new ApolloClient({
         "using a different fetchPolicy, such as cache-first or network-only."
   },
 
-  71: {
+  73: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "options.fetchPolicy !== \"standby\"",
 
@@ -382,7 +382,7 @@ const client = new ApolloClient({
         "as cache-first or network-only."
   },
 
-  72: {
+  74: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "options.query",
 
@@ -390,164 +390,164 @@ const client = new ApolloClient({
         "in the query option."
   },
 
-  73: {
+  75: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "options.query.kind === \"Document\"",
     message: 'You must wrap the query string in a "gql" tag.'
   },
 
-  74: {
+  76: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "!options.returnPartialData",
     message: "returnPartialData option only supported on watchQuery."
   },
 
-  75: {
+  77: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "!options.pollInterval",
     message: "pollInterval option only supported on watchQuery."
   },
 
-  76: {
+  78: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "!options.notifyOnNetworkStatusChange",
     message: "notifyOnNetworkStatusChange option only supported on watchQuery."
   },
 
-  77: {
+  79: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "optionsWithDefaults.mutation",
     message: "The `mutation` option is required. Please provide a GraphQL document in the `mutation` option."
   },
 
-  78: {
+  80: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "optionsWithDefaults.fetchPolicy === \"network-only\" ||\n    optionsWithDefaults.fetchPolicy === \"no-cache\"",
     message: "Mutations only support 'network-only' or 'no-cache' fetch policies. The default 'network-only' behavior automatically writes mutation results to the cache. Passing 'no-cache' skips the cache write."
   },
 
-  80: {
+  82: {
     file: "@apollo/client/core/ObservableQuery.js",
     condition: "fetchPolicy === \"standby\"",
     message: "The `variablesUnknown` option can only be used together with a `standby` fetch policy."
   },
 
-  82: {
+  84: {
     file: "@apollo/client/core/ObservableQuery.js",
     condition: "this.options.fetchPolicy !== \"cache-only\"",
     message: "Cannot execute `fetchMore` for 'cache-only' query '%s'. Please use a different fetch policy."
   },
 
-  83: {
+  85: {
     file: "@apollo/client/core/ObservableQuery.js",
     condition: "updateQuery",
     message: "You must provide an `updateQuery` function when using `fetchMore` with a `no-cache` fetch policy."
   },
 
-  87: {
+  89: {
     file: "@apollo/client/core/QueryManager.js",
     message: "QueryManager stopped while query was in flight"
   },
 
-  88: {
+  90: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Mutation '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  89: {
+  91: {
     file: "@apollo/client/core/QueryManager.js",
     message: "Store reset while query was in flight (not completed in link chain)"
   },
 
-  92: {
+  94: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!this.getDocumentInfo(query).hasClientExports || this.localState",
     message: "Subscription '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  93: {
+  95: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "%s '%s' contains `@client` fields but local state has not been configured."
   },
 
-  94: {
+  96: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!hasIncrementalDirective",
     message: "%s '%s' contains `@client` and `@defer` directives. These cannot be used together."
   },
 
-  95: {
+  97: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Query '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  97: {
+  99: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Query '%s' contains `@client` fields but local state has not been configured."
   },
 
-  98: {
+  100: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "didEmitValue",
     message: "The link chain completed without emitting a value. This is likely unintentional and should be updated to emit a value before completing."
   },
 
-  99: {
+  104: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
     condition: "typeof dataId === \"string\"",
     message: "store.merge expects a string ID"
   },
 
-  102: {
+  107: {
     file: "@apollo/client/cache/inmemory/key-extractor.js",
     condition: "extracted !== void 0",
     message: `Missing field '%s' while extracting keyFields from %s`
   },
 
-  103: {
+  108: {
     file: "@apollo/client/cache/inmemory/policies.js",
     condition: "!old || old === which",
     message: `Cannot change root %s __typename more than once`
   },
 
-  106: {
+  111: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: "Cannot automatically merge arrays"
   },
 
-  107: {
+  112: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     message: `No fragment named %s`
   },
 
-  108: {
+  113: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     condition: "!isReference(value)",
     message: `Missing selection set for object of type %s returned for query field %s`
   },
 
-  109: {
+  114: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `Could not identify object %s`
   },
 
-  111: {
+  116: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `No fragment named %s`
   }
 };
 
 export const devDebug = {
-  79: {
+  81: {
     file: "@apollo/client/core/ApolloClient.js",
     message: `In client.refetchQueries, Promise.all promise rejected with error %o`
   },
 
-  86: {
+  88: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: `Missing cache result fields: %o`
   }
@@ -625,34 +625,59 @@ export const devWarn = {
         "If you are using a split link, ensure each branch contains a terminating link that handles the request."
   },
 
-  81: {
+  70: {
+    file: "@apollo/client/core/ApolloClient.js",
+    message: "`refetchOn` was set on query '%s' but no `RefetchEventManager` is configured on this `ApolloClient` instance. This option has no effect. Pass a `RefetchEventManager` instance to the `refetchEventManager` option on the `ApolloClient` constructor."
+  },
+
+  71: {
+    file: "@apollo/client/core/ApolloClient.js",
+    message: "`refetchOn` references the '%s' event on query '%s' but no source is configured for it on the `RefetchEventManager`. This event will never fire. Add a source for the event to the `sources` option or call `setEventSource` on the refetch event manager."
+  },
+
+  83: {
     file: "@apollo/client/core/ObservableQuery.js",
 
     message: `Called refetch(%o) for query %o, which does not declare a $variables variable.
 Did you mean to call refetch(variables) instead of refetch({ variables })?`
   },
 
-  85: {
+  87: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Cannot poll on 'cache-only' query '%s' and as such, polling is disabled. Please use a different fetch policy."
   },
 
-  90: {
+  92: {
     file: "@apollo/client/core/QueryManager.js",
     message: `Unknown query named "%s" requested in refetchQueries options.include array`
   },
 
-  91: {
+  93: {
     file: "@apollo/client/core/QueryManager.js",
     message: `Unknown anonymous query requested in refetchQueries options.include array`
   },
 
-  96: {
+  98: {
     file: "@apollo/client/core/QueryManager.js",
     message: '[%s]: Fragments masked by data masking are inaccessible when using fetch policy "no-cache". Please add `@unmask` to each fragment spread to access the data.'
   },
 
-  100: {
+  101: {
+    file: "@apollo/client/core/RefetchEventManager.js",
+    message: "Connected an `ApolloClient` instance to a `RefetchEventManager` that was already connected to a different `ApolloClient`. The previous client has been disconnected and will no longer receive refetch events from this manager."
+  },
+
+  102: {
+    file: "@apollo/client/core/RefetchEventManager.js",
+    message: "Received '%s' event but an `ApolloClient` instance is not connected to the `RefetchEventManager`. No queries will refetch. Pass the manager to the `refetchEventManager` option on the `ApolloClient` constructor."
+  },
+
+  103: {
+    file: "@apollo/client/core/RefetchEventManager.js",
+    message: "Received '%s' event but no source is configured for it on the `RefetchEventManager`. No queries will refetch. Add the event to the `sources` option or call `setEventSource`."
+  },
+
+  105: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
 
     message: "cache.modify: You are trying to write a Reference that is not part of the store: %o\n" +
@@ -660,24 +685,24 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`
         "`toReference(object, true)`"
   },
 
-  101: {
+  106: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
 
     message: "cache.modify: Writing an array with a mix of both References and Objects will not result in the Objects being normalized correctly.\n" +
         "Please convert the object instance %o to a Reference before writing it to the cache by calling `toReference(object, true)`."
   },
 
-  104: {
+  109: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: `Inferring subtype %s of supertype %s`
   },
 
-  105: {
+  110: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: `Undefined 'from' passed to readField with arguments %s`
   },
 
-  112: {
+  117: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
 
     message: `Cache data may be lost when replacing the %s field of a %s object.
@@ -696,7 +721,7 @@ For more information about these options, please refer to the documentation:
 `
   },
 
-  113: {
+  118: {
     file: "@apollo/client/cache/core/cache.js",
     message: "Could not identify object passed to `from` for '%s' fragment, either because the object is non-normalized or the key fields are missing. If you are masking this object, please ensure the key fields are requested by the parent object."
   }
@@ -713,12 +738,12 @@ export const devError = {
     message: "The result of getSnapshot should be cached to avoid an infinite loop"
   },
 
-  84: {
+  86: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Unhandled GraphQL subscription error"
   },
 
-  110: {
+  115: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `Missing field '%s' while writing result %o`
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client",
-  "version": "4.2.0-alpha.3",
+  "version": "4.2.0-alpha.4",
   "description": "A fully-featured caching GraphQL client.",
   "private": false,
   "keywords": [

package/react/hooks/useBackgroundQuery.d.ts

@@ -1,4 +1,4 @@
-import type { ApolloClient, DefaultContext, DocumentNode, ErrorPolicy, OperationVariables, RefetchWritePolicy, TypedDocumentNode, WatchQueryFetchPolicy } from "@apollo/client";
+import type { ApolloClient, DefaultContext, DocumentNode, ErrorPolicy, OperationVariables, RefetchOn, RefetchWritePolicy, TypedDocumentNode, WatchQueryFetchPolicy } from "@apollo/client";
 import type { SubscribeToMoreFunction } from "@apollo/client";
 import type { QueryRef } from "@apollo/client/react";
 import type { FetchMoreFunction, RefetchFunction } from "@apollo/client/react/internal";
@@ -72,6 +72,25 @@ export declare namespace useBackgroundQuery {
             */
             queryKey?: string | number | any[];
             /**
+            * Determines whether events trigger refetches for the query. Provide an
+            * object mapping each refetch event to `true` (enable), `false` (disable)
+            * or a callback function that returns `true`/`false` to control individual
+            * events. Provide `false` to disable all automatic refetch events for this
+            * query. Provide `true` to enable all automatic refetch events for this query.
+            * Provide a callback function to perform additional logic to determine
+            * whether to enable or disable a refetch for a query.
+            * 
+            * `@remarks`
+            * `refetchOn` inherits from `defaultOptions.watchQuery.refetchOn`. If
+            * `defaultOptions.watchQuery.refetchOn` is not set, all refetch events are
+            * enabled by default.
+            * 
+            * This option only has an effect when the client is configured with a
+            * `refetchEventManager`.
+            * @docGroup 1. Operation options
+            */
+            refetchOn?: RefetchOn.Option;
+            /**
             * If `true`, the query is not executed. The default value is `false`.
             * 
             * @deprecated We recommend using `skipToken` in place of the `skip` option as

package/react/hooks/useBackgroundQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBackgroundQuery.js","sourceRoot":"","sources":["../../../src/react/hooks/useBackgroundQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAmB/B,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,YAAY,GACb,MAAM,+BAA+B,CAAC;AAUvC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAkiB7D,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,kBAAkB,CAIzB,KAA0D,EAC1D,OAAqE;IAKrE,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAC1E,CAAC,KAAK,EAAE,OAAO,IAAK,EAAU,CAAC,CAAC;AACnC,CAAQ,CAAC;AAEX,SAAS,mBAAmB,CAK1B,KAA0D,EAC1D,OAEmD;IAKnD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;IAC1C,MAAM,QAAQ,GAAG,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEzD,yEAAyE;IACzE,iEAAiE;IACjE,wEAAwE;IACxE,wEAAwE;IACxE,6EAA6E;IAC7E,uBAAuB;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC;IAC/D,cAAc,CAAC,OAAO,KAAK,WAAW,KAAK,SAAS,CAAC;IAErD,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAiB,QAAQ,EAAE,GAAG,EAAE,CACxE,MAAM,CAAC,UAAU,CACf,iBAA6D,CAC9D,CACF,CAAC;IAEF,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,YAAY,CAAC,QAAQ,CAAC,CACvB,CAAC;IACF,IAAI,cAAc,CAAC,eAAe,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjD,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACzD,qBAAqB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,sEAAsE;IACtE,2EAA2E;IAC3E,0EAA0E;IAC1E,6EAA6E;IAC7E,yDAAyD;IACzD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,2EAA2E;QAC3E,iEAAiE;QACjE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC9B,uEAAuE;QACvE,kEAAkE;IACpE,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAyC,KAAK,CAAC,WAAW,CACvE,CAAC,OAAO,EAAE,EAAE;QACV,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,MAAM,OAAO,GAAuC,KAAK,CAAC,WAAW,CACnE,CAAC,SAAS,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD,OAAO;QACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD;YACE,SAAS;YACT,OAAO;YACP,kGAAkG;YAClG,eAAe,EAAE,QAAQ,CAAC,UAAU;iBACjC,eAA6D;SACjE;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DataState,\n  DefaultContext,\n  DocumentNode,\n  ErrorPolicy,\n  OperationVariables,\n  RefetchWritePolicy,\n  TypedDocumentNode,\n  WatchQueryFetchPolicy,\n} from \"@apollo/client\";\nimport type { SubscribeToMoreFunction } from \"@apollo/client\";\nimport type { QueryRef } from \"@apollo/client/react\";\nimport type {\n  FetchMoreFunction,\n  RefetchFunction,\n} from \"@apollo/client/react/internal\";\nimport {\n  getSuspenseCache,\n  unwrapQueryRef,\n  updateWrappedQueryRef,\n  wrapQueryRef,\n} from \"@apollo/client/react/internal\";\nimport type {\n  DocumentationTypes as UtilityDocumentationTypes,\n  NoInfer,\n  OptionWithFallback,\n  SignatureStyle,\n  VariablesOption,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { SkipToken } from \"./constants.js\";\nimport { useSuspenseHookCacheKey, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useWatchQueryOptions } from \"./useSuspenseQuery.js\";\n\nexport declare namespace useBackgroundQuery {\n  import _self = useBackgroundQuery;\n  export type FetchPolicy = Extract<\n    WatchQueryFetchPolicy,\n    \"cache-first\" | \"network-only\" | \"no-cache\" | \"cache-and-network\"\n  >;\n\n  export namespace Base {\n    export interface Options {\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#client:member} */\n      client?: ApolloClient;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy_suspense:member} */\n      refetchWritePolicy?: RefetchWritePolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n      errorPolicy?: ErrorPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n      context?: DefaultContext;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n      returnPartialData?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n      fetchPolicy?: FetchPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#queryKey:member} */\n      queryKey?: string | number | any[];\n\n      /**\n       * {@inheritDoc @apollo/client!QueryOptionsDocumentation#skip_deprecated:member}\n       *\n       * @example Recommended usage of `skipToken`:\n       *\n       * ```ts\n       * import { skipToken, useBackgroundQuery } from \"@apollo/client\";\n       *\n       * const [queryRef] = useBackgroundQuery(\n       *   query,\n       *   id ? { variables: { id } } : skipToken\n       * );\n       * ```\n       */\n      skip?: boolean;\n    }\n  }\n\n  export type Options<\n    TVariables extends OperationVariables = OperationVariables,\n  > = Base.Options & VariablesOption<TVariables>;\n\n  export namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Options<\n        TVariables extends OperationVariables = OperationVariables,\n      > extends Base.Options,\n          UtilityDocumentationTypes.VariableOptions<TVariables> {}\n    }\n  }\n\n  export interface Result<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > {\n    /** {@inheritDoc @apollo/client!ObservableQuery#subscribeToMore:member(1)} */\n    subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!ObservableQuery#fetchMore:member(1)}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    fetchMore: FetchMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!QueryResultDocumentation#refetch:member}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    refetch: RefetchFunction<TData, TVariables>;\n  }\n\n  namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Result<\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      > extends _self.Result<TData, TVariables> {}\n    }\n  }\n\n  export interface DefaultOptions\n    extends ApolloClient.DefaultOptions.WatchQuery.Calculated {\n    skip: false;\n  }\n\n  export type ResultForOptions<\n    TData,\n    TVariables extends OperationVariables,\n    TOptions extends Record<string, never> | Options<TVariables> | SkipToken,\n  > = [\n    queryRef: TOptions extends any ?\n      TOptions extends SkipToken ?\n        undefined\n      : | QueryRef<\n            TData,\n            TVariables,\n            | \"complete\"\n            | \"streaming\"\n            | (\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"errorPolicy\"\n                  > extends \"none\" ?\n                    never\n                  : \"empty\")\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"returnPartialData\"\n                  > extends false ?\n                    never\n                  : \"partial\")\n              )\n          >\n        | (OptionWithFallback<TOptions, DefaultOptions, \"skip\"> extends false ?\n            never\n          : undefined)\n    : never,\n    result: useBackgroundQuery.Result<TData, TVariables>,\n  ];\n\n  export namespace DocumentationTypes {\n    export interface useBackgroundQuery {\n      /**\n       * For a detailed explanation of useBackgroundQuery, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).\n       *\n       * @returns A tuple containing:\n       *\n       * 1.  A `QueryRef` that can be passed to `useReadQuery` to read the query result. The `queryRef` is `undefined` if the query is skipped.\n       * 2.  An object containing helper functions for the query:\n       *     - `refetch`: A function to re-execute the query\n       *     - `fetchMore`: A function to fetch more results for pagination\n       *     - `subscribeToMore`: A function to subscribe to updates\n       *\n       * @example\n       *\n       * ```jsx\n       * import { Suspense } from \"react\";\n       * import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\";\n       * import { useBackgroundQuery, useReadQuery } from \"@apollo/client/react\";\n       *\n       * const query = gql`\n       *   foo {\n       *     bar\n       *   }\n       * `;\n       *\n       * const client = new ApolloClient({\n       *   link: new HttpLink({ uri: \"http://localhost:4000/graphql\" }),\n       *   cache: new InMemoryCache(),\n       * });\n       *\n       * function SuspenseFallback() {\n       *   return <div>Loading...</div>;\n       * }\n       *\n       * function Child({ queryRef }) {\n       *   const { data } = useReadQuery(queryRef);\n       *\n       *   return <div>{data.foo.bar}</div>;\n       * }\n       *\n       * function Parent() {\n       *   const [queryRef] = useBackgroundQuery(query);\n       *\n       *   return (\n       *     <Suspense fallback={<SuspenseFallback />}>\n       *       <Child queryRef={queryRef} />\n       *     </Suspense>\n       *   );\n       * }\n       *\n       * function App() {\n       *   return (\n       *     <ApolloProvider client={client}>\n       *       <Parent />\n       *     </ApolloProvider>\n       *   );\n       * }\n       * ```\n       *\n       * @param query - A GraphQL query document parsed into an AST by `gql`.\n       * @param options - An optional object containing options for the query. Instead of passing a `useBackgroundQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useBackgroundQuery` hook from executing the query or suspending.\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    export interface useBackgroundQuery_Deprecated {\n      /**\n       * @deprecated Avoid manually specifying generics on `useBackgroundQuery`.\n       * Instead, rely on TypeScript's type inference along with a correctly typed `TypedDocumentNode` to get accurate types for your query results.\n       *\n       * {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)}\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n  }\n\n  export namespace Signatures {\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n    export interface Classic {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [options?: useBackgroundQuery.Options<NoInfer<TVariables>>]\n        : [options: useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | useBackgroundQuery.Options<NoInfer<TVariables>>,\n          ]\n        : [options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Modern {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: {} extends TVariables ?\n          DocumentNode | TypedDocumentNode<TData, TVariables>\n        : // this overload should only be accessible if all `TVariables` are optional\n          never\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        Record<string, never>\n      >;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        skipToken: SkipToken\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, SkipToken>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends useBackgroundQuery.Options<NoInfer<TVariables>> &\n          VariablesOption<\n            TVariables & {\n              [K in Exclude<\n                keyof TOptions[\"variables\"],\n                keyof TVariables\n              >]?: never;\n            }\n          >,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ? [options?: TOptions]\n        : [options: TOptions]\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, TOptions>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends useBackgroundQuery.Options<NoInfer<TVariables>> &\n          VariablesOption<\n            TVariables & {\n              [K in Exclude<\n                keyof TOptions[\"variables\"],\n                keyof TVariables\n              >]?: never;\n            }\n          >,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ? [options?: TOptions | SkipToken]\n        : [options: TOptions | SkipToken]\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        TOptions | SkipToken\n      >;\n    }\n\n    export type Evaluated = SignatureStyle extends \"classic\" ? Classic : Modern;\n  }\n\n  /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n  export interface Signature extends Signatures.Evaluated {}\n}\n\nexport const useBackgroundQuery: useBackgroundQuery.Signature =\n  function useBackgroundQuery<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  >(\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n    options?: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n  ): [\n    QueryRef<TData, TVariables, DataState<TData>[\"dataState\"]> | undefined,\n    useBackgroundQuery.Result<TData, TVariables>,\n  ] {\n    \"use no memo\";\n    return wrapHook(\n      \"useBackgroundQuery\",\n      useBackgroundQuery_,\n      useApolloClient(typeof options === \"object\" ? options.client : undefined)\n    )(query, options ?? ({} as any));\n  } as any;\n\nfunction useBackgroundQuery_<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options:\n    | (SkipToken & Partial<useBackgroundQuery.Options<NoInfer<TVariables>>>)\n    | useBackgroundQuery.Options<NoInfer<TVariables>>\n): [\n  QueryRef<TData, TVariables, TStates> | undefined,\n  useBackgroundQuery.Result<TData, TVariables>,\n] {\n  const client = useApolloClient(options.client);\n  const suspenseCache = getSuspenseCache(client);\n  const watchQueryOptions = useWatchQueryOptions({ client, query, options });\n  const { fetchPolicy } = watchQueryOptions;\n  const cacheKey = useSuspenseHookCacheKey(query, options);\n\n  // This ref tracks the first time query execution is enabled to determine\n  // whether to return a query ref or `undefined`. When initialized\n  // in a skipped state (either via `skip: true` or `skipToken`) we return\n  // `undefined` for the `queryRef` until the query has been enabled. Once\n  // enabled, a query ref is always returned regardless of whether the query is\n  // skipped again later.\n  const didFetchResult = React.useRef(fetchPolicy !== \"standby\");\n  didFetchResult.current ||= fetchPolicy !== \"standby\";\n\n  const queryRef = suspenseCache.getQueryRef<TData, TStates>(cacheKey, () =>\n    client.watchQuery(\n      watchQueryOptions as ApolloClient.WatchQueryOptions<any, any>\n    )\n  );\n\n  const [wrappedQueryRef, setWrappedQueryRef] = React.useState(\n    wrapQueryRef(queryRef)\n  );\n  if (unwrapQueryRef(wrappedQueryRef) !== queryRef) {\n    setWrappedQueryRef(wrapQueryRef(queryRef));\n  }\n  if (queryRef.didChangeOptions(watchQueryOptions)) {\n    const promise = queryRef.applyOptions(watchQueryOptions);\n    updateWrappedQueryRef(wrappedQueryRef, promise);\n  }\n\n  // This prevents issues where rerendering useBackgroundQuery after the\n  // queryRef has been disposed would cause the hook to return a new queryRef\n  // instance since disposal also removes it from the suspense cache. We add\n  // the queryRef back in the suspense cache so that the next render will reuse\n  // this queryRef rather than initializing a new instance.\n  React.useEffect(() => {\n    // Since the queryRef is disposed async via `setTimeout`, we have to wait a\n    // tick before checking it and adding back to the suspense cache.\n    const id = setTimeout(() => {\n      if (queryRef.disposed) {\n        suspenseCache.add(cacheKey, queryRef);\n      }\n    });\n\n    return () => clearTimeout(id);\n    // Omitting the deps is intentional. This avoids stale closures and the\n    // conditional ensures we aren't running the logic on each render.\n  });\n\n  const fetchMore: FetchMoreFunction<TData, TVariables> = React.useCallback(\n    (options) => {\n      const promise = queryRef.fetchMore(options);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  const refetch: RefetchFunction<TData, TVariables> = React.useCallback(\n    (variables) => {\n      const promise = queryRef.refetch(variables);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  React.useEffect(() => queryRef.softRetain(), [queryRef]);\n\n  return [\n    didFetchResult.current ? wrappedQueryRef : void 0,\n    {\n      fetchMore,\n      refetch,\n      // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here\n      subscribeToMore: queryRef.observable\n        .subscribeToMore as SubscribeToMoreFunction<TData, TVariables>,\n    },\n  ];\n}\n"]}
+{"version":3,"file":"useBackgroundQuery.js","sourceRoot":"","sources":["../../../src/react/hooks/useBackgroundQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAoB/B,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,YAAY,GACb,MAAM,+BAA+B,CAAC;AAUvC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAqiB7D,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,kBAAkB,CAIzB,KAA0D,EAC1D,OAAqE;IAKrE,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAC1E,CAAC,KAAK,EAAE,OAAO,IAAK,EAAU,CAAC,CAAC;AACnC,CAAQ,CAAC;AAEX,SAAS,mBAAmB,CAK1B,KAA0D,EAC1D,OAEmD;IAKnD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;IAC1C,MAAM,QAAQ,GAAG,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEzD,yEAAyE;IACzE,iEAAiE;IACjE,wEAAwE;IACxE,wEAAwE;IACxE,6EAA6E;IAC7E,uBAAuB;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC;IAC/D,cAAc,CAAC,OAAO,KAAK,WAAW,KAAK,SAAS,CAAC;IAErD,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAiB,QAAQ,EAAE,GAAG,EAAE,CACxE,MAAM,CAAC,UAAU,CACf,iBAA6D,CAC9D,CACF,CAAC;IAEF,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,YAAY,CAAC,QAAQ,CAAC,CACvB,CAAC;IACF,IAAI,cAAc,CAAC,eAAe,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjD,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACzD,qBAAqB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,sEAAsE;IACtE,2EAA2E;IAC3E,0EAA0E;IAC1E,6EAA6E;IAC7E,yDAAyD;IACzD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,2EAA2E;QAC3E,iEAAiE;QACjE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC9B,uEAAuE;QACvE,kEAAkE;IACpE,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAyC,KAAK,CAAC,WAAW,CACvE,CAAC,OAAO,EAAE,EAAE;QACV,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,MAAM,OAAO,GAAuC,KAAK,CAAC,WAAW,CACnE,CAAC,SAAS,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD,OAAO;QACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD;YACE,SAAS;YACT,OAAO;YACP,kGAAkG;YAClG,eAAe,EAAE,QAAQ,CAAC,UAAU;iBACjC,eAA6D;SACjE;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DataState,\n  DefaultContext,\n  DocumentNode,\n  ErrorPolicy,\n  OperationVariables,\n  RefetchOn,\n  RefetchWritePolicy,\n  TypedDocumentNode,\n  WatchQueryFetchPolicy,\n} from \"@apollo/client\";\nimport type { SubscribeToMoreFunction } from \"@apollo/client\";\nimport type { QueryRef } from \"@apollo/client/react\";\nimport type {\n  FetchMoreFunction,\n  RefetchFunction,\n} from \"@apollo/client/react/internal\";\nimport {\n  getSuspenseCache,\n  unwrapQueryRef,\n  updateWrappedQueryRef,\n  wrapQueryRef,\n} from \"@apollo/client/react/internal\";\nimport type {\n  DocumentationTypes as UtilityDocumentationTypes,\n  NoInfer,\n  OptionWithFallback,\n  SignatureStyle,\n  VariablesOption,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { SkipToken } from \"./constants.js\";\nimport { useSuspenseHookCacheKey, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useWatchQueryOptions } from \"./useSuspenseQuery.js\";\n\nexport declare namespace useBackgroundQuery {\n  import _self = useBackgroundQuery;\n  export type FetchPolicy = Extract<\n    WatchQueryFetchPolicy,\n    \"cache-first\" | \"network-only\" | \"no-cache\" | \"cache-and-network\"\n  >;\n\n  export namespace Base {\n    export interface Options {\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#client:member} */\n      client?: ApolloClient;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy_suspense:member} */\n      refetchWritePolicy?: RefetchWritePolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n      errorPolicy?: ErrorPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n      context?: DefaultContext;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n      returnPartialData?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n      fetchPolicy?: FetchPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#queryKey:member} */\n      queryKey?: string | number | any[];\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchOn:member} */\n      refetchOn?: RefetchOn.Option;\n\n      /**\n       * {@inheritDoc @apollo/client!QueryOptionsDocumentation#skip_deprecated:member}\n       *\n       * @example Recommended usage of `skipToken`:\n       *\n       * ```ts\n       * import { skipToken, useBackgroundQuery } from \"@apollo/client\";\n       *\n       * const [queryRef] = useBackgroundQuery(\n       *   query,\n       *   id ? { variables: { id } } : skipToken\n       * );\n       * ```\n       */\n      skip?: boolean;\n    }\n  }\n\n  export type Options<\n    TVariables extends OperationVariables = OperationVariables,\n  > = Base.Options & VariablesOption<TVariables>;\n\n  export namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Options<\n        TVariables extends OperationVariables = OperationVariables,\n      > extends Base.Options,\n          UtilityDocumentationTypes.VariableOptions<TVariables> {}\n    }\n  }\n\n  export interface Result<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > {\n    /** {@inheritDoc @apollo/client!ObservableQuery#subscribeToMore:member(1)} */\n    subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!ObservableQuery#fetchMore:member(1)}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    fetchMore: FetchMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!QueryResultDocumentation#refetch:member}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    refetch: RefetchFunction<TData, TVariables>;\n  }\n\n  namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Result<\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      > extends _self.Result<TData, TVariables> {}\n    }\n  }\n\n  export interface DefaultOptions\n    extends ApolloClient.DefaultOptions.WatchQuery.Calculated {\n    skip: false;\n  }\n\n  export type ResultForOptions<\n    TData,\n    TVariables extends OperationVariables,\n    TOptions extends Record<string, never> | Options<TVariables> | SkipToken,\n  > = [\n    queryRef: TOptions extends any ?\n      TOptions extends SkipToken ?\n        undefined\n      : | QueryRef<\n            TData,\n            TVariables,\n            | \"complete\"\n            | \"streaming\"\n            | (\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"errorPolicy\"\n                  > extends \"none\" ?\n                    never\n                  : \"empty\")\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"returnPartialData\"\n                  > extends false ?\n                    never\n                  : \"partial\")\n              )\n          >\n        | (OptionWithFallback<TOptions, DefaultOptions, \"skip\"> extends false ?\n            never\n          : undefined)\n    : never,\n    result: useBackgroundQuery.Result<TData, TVariables>,\n  ];\n\n  export namespace DocumentationTypes {\n    export interface useBackgroundQuery {\n      /**\n       * For a detailed explanation of useBackgroundQuery, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).\n       *\n       * @returns A tuple containing:\n       *\n       * 1.  A `QueryRef` that can be passed to `useReadQuery` to read the query result. The `queryRef` is `undefined` if the query is skipped.\n       * 2.  An object containing helper functions for the query:\n       *     - `refetch`: A function to re-execute the query\n       *     - `fetchMore`: A function to fetch more results for pagination\n       *     - `subscribeToMore`: A function to subscribe to updates\n       *\n       * @example\n       *\n       * ```jsx\n       * import { Suspense } from \"react\";\n       * import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\";\n       * import { useBackgroundQuery, useReadQuery } from \"@apollo/client/react\";\n       *\n       * const query = gql`\n       *   foo {\n       *     bar\n       *   }\n       * `;\n       *\n       * const client = new ApolloClient({\n       *   link: new HttpLink({ uri: \"http://localhost:4000/graphql\" }),\n       *   cache: new InMemoryCache(),\n       * });\n       *\n       * function SuspenseFallback() {\n       *   return <div>Loading...</div>;\n       * }\n       *\n       * function Child({ queryRef }) {\n       *   const { data } = useReadQuery(queryRef);\n       *\n       *   return <div>{data.foo.bar}</div>;\n       * }\n       *\n       * function Parent() {\n       *   const [queryRef] = useBackgroundQuery(query);\n       *\n       *   return (\n       *     <Suspense fallback={<SuspenseFallback />}>\n       *       <Child queryRef={queryRef} />\n       *     </Suspense>\n       *   );\n       * }\n       *\n       * function App() {\n       *   return (\n       *     <ApolloProvider client={client}>\n       *       <Parent />\n       *     </ApolloProvider>\n       *   );\n       * }\n       * ```\n       *\n       * @param query - A GraphQL query document parsed into an AST by `gql`.\n       * @param options - An optional object containing options for the query. Instead of passing a `useBackgroundQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useBackgroundQuery` hook from executing the query or suspending.\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    export interface useBackgroundQuery_Deprecated {\n      /**\n       * @deprecated Avoid manually specifying generics on `useBackgroundQuery`.\n       * Instead, rely on TypeScript's type inference along with a correctly typed `TypedDocumentNode` to get accurate types for your query results.\n       *\n       * {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)}\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n  }\n\n  export namespace Signatures {\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n    export interface Classic {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [options?: useBackgroundQuery.Options<NoInfer<TVariables>>]\n        : [options: useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | useBackgroundQuery.Options<NoInfer<TVariables>>,\n          ]\n        : [options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Modern {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: {} extends TVariables ?\n          DocumentNode | TypedDocumentNode<TData, TVariables>\n        : // this overload should only be accessible if all `TVariables` are optional\n          never\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        Record<string, never>\n      >;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        skipToken: SkipToken\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, SkipToken>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends useBackgroundQuery.Options<NoInfer<TVariables>> &\n          VariablesOption<\n            TVariables & {\n              [K in Exclude<\n                keyof TOptions[\"variables\"],\n                keyof TVariables\n              >]?: never;\n            }\n          >,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ? [options?: TOptions]\n        : [options: TOptions]\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, TOptions>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends useBackgroundQuery.Options<NoInfer<TVariables>> &\n          VariablesOption<\n            TVariables & {\n              [K in Exclude<\n                keyof TOptions[\"variables\"],\n                keyof TVariables\n              >]?: never;\n            }\n          >,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ? [options?: TOptions | SkipToken]\n        : [options: TOptions | SkipToken]\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        TOptions | SkipToken\n      >;\n    }\n\n    export type Evaluated = SignatureStyle extends \"classic\" ? Classic : Modern;\n  }\n\n  /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n  export interface Signature extends Signatures.Evaluated {}\n}\n\nexport const useBackgroundQuery: useBackgroundQuery.Signature =\n  function useBackgroundQuery<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  >(\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n    options?: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n  ): [\n    QueryRef<TData, TVariables, DataState<TData>[\"dataState\"]> | undefined,\n    useBackgroundQuery.Result<TData, TVariables>,\n  ] {\n    \"use no memo\";\n    return wrapHook(\n      \"useBackgroundQuery\",\n      useBackgroundQuery_,\n      useApolloClient(typeof options === \"object\" ? options.client : undefined)\n    )(query, options ?? ({} as any));\n  } as any;\n\nfunction useBackgroundQuery_<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options:\n    | (SkipToken & Partial<useBackgroundQuery.Options<NoInfer<TVariables>>>)\n    | useBackgroundQuery.Options<NoInfer<TVariables>>\n): [\n  QueryRef<TData, TVariables, TStates> | undefined,\n  useBackgroundQuery.Result<TData, TVariables>,\n] {\n  const client = useApolloClient(options.client);\n  const suspenseCache = getSuspenseCache(client);\n  const watchQueryOptions = useWatchQueryOptions({ client, query, options });\n  const { fetchPolicy } = watchQueryOptions;\n  const cacheKey = useSuspenseHookCacheKey(query, options);\n\n  // This ref tracks the first time query execution is enabled to determine\n  // whether to return a query ref or `undefined`. When initialized\n  // in a skipped state (either via `skip: true` or `skipToken`) we return\n  // `undefined` for the `queryRef` until the query has been enabled. Once\n  // enabled, a query ref is always returned regardless of whether the query is\n  // skipped again later.\n  const didFetchResult = React.useRef(fetchPolicy !== \"standby\");\n  didFetchResult.current ||= fetchPolicy !== \"standby\";\n\n  const queryRef = suspenseCache.getQueryRef<TData, TStates>(cacheKey, () =>\n    client.watchQuery(\n      watchQueryOptions as ApolloClient.WatchQueryOptions<any, any>\n    )\n  );\n\n  const [wrappedQueryRef, setWrappedQueryRef] = React.useState(\n    wrapQueryRef(queryRef)\n  );\n  if (unwrapQueryRef(wrappedQueryRef) !== queryRef) {\n    setWrappedQueryRef(wrapQueryRef(queryRef));\n  }\n  if (queryRef.didChangeOptions(watchQueryOptions)) {\n    const promise = queryRef.applyOptions(watchQueryOptions);\n    updateWrappedQueryRef(wrappedQueryRef, promise);\n  }\n\n  // This prevents issues where rerendering useBackgroundQuery after the\n  // queryRef has been disposed would cause the hook to return a new queryRef\n  // instance since disposal also removes it from the suspense cache. We add\n  // the queryRef back in the suspense cache so that the next render will reuse\n  // this queryRef rather than initializing a new instance.\n  React.useEffect(() => {\n    // Since the queryRef is disposed async via `setTimeout`, we have to wait a\n    // tick before checking it and adding back to the suspense cache.\n    const id = setTimeout(() => {\n      if (queryRef.disposed) {\n        suspenseCache.add(cacheKey, queryRef);\n      }\n    });\n\n    return () => clearTimeout(id);\n    // Omitting the deps is intentional. This avoids stale closures and the\n    // conditional ensures we aren't running the logic on each render.\n  });\n\n  const fetchMore: FetchMoreFunction<TData, TVariables> = React.useCallback(\n    (options) => {\n      const promise = queryRef.fetchMore(options);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  const refetch: RefetchFunction<TData, TVariables> = React.useCallback(\n    (variables) => {\n      const promise = queryRef.refetch(variables);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  React.useEffect(() => queryRef.softRetain(), [queryRef]);\n\n  return [\n    didFetchResult.current ? wrappedQueryRef : void 0,\n    {\n      fetchMore,\n      refetch,\n      // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here\n      subscribeToMore: queryRef.observable\n        .subscribeToMore as SubscribeToMoreFunction<TData, TVariables>,\n    },\n  ];\n}\n"]}

package/react/hooks/useLazyQuery.d.ts

@@ -1,6 +1,6 @@
 import type { TypedDocumentNode } from "@graphql-typed-document-node/core";
 import type { DocumentNode } from "graphql";
-import type { ApolloClient, DataState, DefaultContext, ErrorLike, ErrorPolicy, GetDataState, InternalTypes, MaybeMasked, ObservableQuery, OperationVariables, RefetchWritePolicy, SubscribeToMoreFunction, UpdateQueryMapFn, WatchQueryFetchPolicy } from "@apollo/client";
+import type { ApolloClient, DataState, DefaultContext, ErrorLike, ErrorPolicy, GetDataState, InternalTypes, MaybeMasked, ObservableQuery, OperationVariables, RefetchOn, RefetchWritePolicy, SubscribeToMoreFunction, UpdateQueryMapFn, WatchQueryFetchPolicy } from "@apollo/client";
 import { NetworkStatus } from "@apollo/client";
 import type { DocumentationTypes as UtilityDocumentationTypes, NoInfer, OptionWithFallback, SignatureStyle, VariablesOption } from "@apollo/client/utilities/internal";
 export declare namespace useLazyQuery {
@@ -82,6 +82,25 @@ export declare namespace useLazyQuery {
         * @docGroup 1. Operation options
         */
         client?: ApolloClient;
+        /**
+        * Determines whether events trigger refetches for the query. Provide an
+        * object mapping each refetch event to `true` (enable), `false` (disable)
+        * or a callback function that returns `true`/`false` to control individual
+        * events. Provide `false` to disable all automatic refetch events for this
+        * query. Provide `true` to enable all automatic refetch events for this query.
+        * Provide a callback function to perform additional logic to determine
+        * whether to enable or disable a refetch for a query.
+        * 
+        * `@remarks`
+        * `refetchOn` inherits from `defaultOptions.watchQuery.refetchOn`. If
+        * `defaultOptions.watchQuery.refetchOn` is not set, all refetch events are
+        * enabled by default.
+        * 
+        * This option only has an effect when the client is configured with a
+        * `refetchEventManager`.
+        * @docGroup 1. Operation options
+        */
+        refetchOn?: RefetchOn.Option;
     }
     namespace DocumentationTypes {
         namespace useLazyQuery {

package/react/hooks/useLazyQuery.js

@@ -76,6 +76,7 @@ export const useLazyQuery = function useLazyQuery(query, options) {
         const updatedOptions = {
             query,
             errorPolicy: stableOptions?.errorPolicy,
+            refetchOn: stableOptions?.refetchOn,
             refetchWritePolicy: stableOptions?.refetchWritePolicy,
             returnPartialData: stableOptions?.returnPartialData,
             notifyOnNetworkStatusChange: stableOptions?.notifyOnNetworkStatusChange,