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

package/__cjs/core/ObservableQuery.d.cts

@@ -7,7 +7,7 @@ import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
 import type { ApolloClient } from "./ApolloClient.cjs";
 import { NetworkStatus } from "./networkStatus.cjs";
 import type { QueryManager } from "./QueryManager.cjs";
-import type { DataState, DefaultContext, ErrorLike, GetDataState, OperationVariables, TypedDocumentNode } from "./types.cjs";
+import type { DataState, DefaultContext, ErrorLike, GetDataState, OperationVariables, RefetchOn, TypedDocumentNode } from "./types.cjs";
 import type { ErrorPolicy, NextFetchPolicyContext, RefetchWritePolicy, SubscribeToMoreUpdateQueryFn, UpdateQueryMapFn, WatchQueryFetchPolicy } from "./watchQueryOptions.cjs";
 export declare namespace ObservableQuery {
     type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
@@ -106,6 +106,25 @@ export declare namespace ObservableQuery {
         * @docGroup 1. Operation options
         */
         variables: TVariables;
+        /**
+        * 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;
     };
     type FetchMoreOptions<TData, TVariables extends OperationVariables, TFetchData = TData, TFetchVars extends OperationVariables = TVariables> = {
         /**

package/__cjs/core/QueryManager.cjs

@@ -99,7 +99,7 @@ class QueryManager {
      */
     stop() {
         this.obsQueries.forEach((oq) => oq.stop());
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(87));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(89));
     }
     cancelPendingFetches(error) {
         this.fetchCancelFns.forEach((cancel) => cancel(error));
@@ -114,7 +114,7 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    88,
+                    90,
                     (0, internal_1.getOperationName)(mutation, "(anonymous)")
                 );
             }
@@ -353,7 +353,7 @@ class QueryManager {
         // depend on values that previously existed in the data portion of the
         // store. So, we cancel the promises and observers that we have issued
         // so far and not yet resolved (in the case of queries).
-        this.cancelPendingFetches((0, invariant_1.newInvariantError)(89));
+        this.cancelPendingFetches((0, invariant_1.newInvariantError)(91));
         this.obsQueries.forEach((observableQuery) => {
             // Set loading to true so listeners don't trigger unless they want
             // results with partial data.
@@ -423,10 +423,10 @@ class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant_1.invariant.warn(90, queryName);
+                        __DEV__ && invariant_1.invariant.warn(92, queryName);
                     }
                     else {
-                        __DEV__ && invariant_1.invariant.warn(91);
+                        __DEV__ && invariant_1.invariant.warn(93);
                     }
                 }
             });
@@ -455,7 +455,7 @@ class QueryManager {
         if (environment_1.__DEV__) {
             (0, invariant_1.invariant)(
                 !this.getDocumentInfo(query).hasClientExports || this.localState,
-                92,
+                94,
                 (0, internal_1.getOperationName)(query, "(anonymous)")
             );
         }
@@ -599,14 +599,14 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    93,
+                    95,
                     operation[0].toUpperCase() + operation.slice(1),
                     operationName ?? "(anonymous)"
                 );
             }
             (0, invariant_1.invariant)(
                 !hasIncrementalDirective,
-                94,
+                96,
                 operation[0].toUpperCase() + operation.slice(1),
                 operationName ?? "(anonymous)"
             );
@@ -784,7 +784,7 @@ class QueryManager {
             if (environment_1.__DEV__) {
                 (0, invariant_1.invariant)(
                     this.localState,
-                    95,
+                    97,
                     (0, internal_1.getOperationName)(normalized.query, "(anonymous)")
                 );
             }
@@ -960,7 +960,7 @@ class QueryManager {
                 !this.noCacheWarningsByCause.has(cause)) {
                 this.noCacheWarningsByCause.add(cause);
                 __DEV__ && invariant_1.invariant.warn(
-                    96,
+                    98,
                     (0, internal_1.getOperationName)(document, `Unnamed ${operationType ?? "operation"}`)
                 );
             }
@@ -1022,7 +1022,7 @@ class QueryManager {
                 if (environment_1.__DEV__) {
                     (0, invariant_1.invariant)(
                         this.localState,
-                        97,
+                        99,
                         (0, internal_1.getOperationName)(query, "(anonymous)")
                     );
                 }
@@ -1118,7 +1118,7 @@ function validateDidEmitValue() {
             didEmitValue = true;
         },
         complete() {
-            (0, invariant_1.invariant)(didEmitValue, 98);
+            (0, invariant_1.invariant)(didEmitValue, 100);
         },
     });
 }