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

package/__cjs/core/ApolloClient.d.cts

@@ -12,7 +12,8 @@ import type { LazyType, OptionWithFallback, SignatureStyle, VariablesOption, var
 import { getApolloClientMemoryInternals } from "@apollo/client/utilities/internal";
 import type { DeclareDefaultOptions, DefaultOptions } from "./defaultOptions.cjs";
 import type { ObservableQuery } from "./ObservableQuery.cjs";
-import type { DefaultContext, ErrorLike, InternalRefetchQueriesInclude, InternalRefetchQueriesResult, MutationQueryReducersMap, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables, RefetchQueriesInclude, RefetchQueriesPromiseResults, SubscriptionObservable, TypedDocumentNode } from "./types.cjs";
+import type { RefetchEventManager } from "./RefetchEventManager.cjs";
+import type { DefaultContext, ErrorLike, InternalRefetchQueriesInclude, InternalRefetchQueriesResult, MutationQueryReducersMap, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables, RefetchOn, RefetchQueriesInclude, RefetchQueriesPromiseResults, SubscriptionObservable, TypedDocumentNode } from "./types.cjs";
 import type { ErrorPolicy, FetchPolicy, MutationFetchPolicy, NextFetchPolicyContext, RefetchWritePolicy, WatchQueryFetchPolicy } from "./watchQueryOptions.cjs";
 /**
 * @knipignore
@@ -106,6 +107,11 @@ export declare namespace ApolloClient {
          * Do not pass in experiments that are not provided by Apollo.
          */
         experiments?: ApolloClient.Experiment[];
+        /**
+         * The `RefetchEventManager` instance that manages automatic refetches for
+         * the client.
+         */
+        refetchEventManager?: RefetchEventManager;
     }
     export interface DevtoolsOptions {
         /**
@@ -699,6 +705,25 @@ export declare namespace ApolloClient {
         */
         query: DocumentNode | TypedDocumentNode<TData, 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;
+        /**
         * @internal This API is meant for framework integrations only.
         * Do not use for everyday use.
         *
@@ -965,6 +990,7 @@ export declare class ApolloClient {
     queryDeduplication: boolean;
     defaultOptions: ApolloClient.DefaultOptions;
     readonly devtoolsConfig: ApolloClient.DevtoolsOptions;
+    readonly refetchEventManager: RefetchEventManager | undefined;
     private queryManager;
     private devToolsHookCb?;
     private resetStoreCallbacks;
@@ -1017,6 +1043,7 @@ export declare class ApolloClient {
      * - Unsubscribes all active `ObservableQuery` instances by emitting a `completed` event
      * - Rejects all currently running queries with "QueryManager stopped while query was in flight"
      * - Removes all queryRefs from the suspense cache
+     * - Disconnects the `RefetchEventManager` if configured.
      */
     stop(): void;
     /**

package/__cjs/core/ObservableQuery.cjs

@@ -84,7 +84,7 @@ class ObservableQuery {
         // Make sure we don't store "standby" as the initialFetchPolicy.
         initialFetchPolicy = fetchPolicy === "standby" ? defaultFetchPolicy : (fetchPolicy), } = options;
         if (options[internal_1.variablesUnknownSymbol]) {
-            (0, invariant_1.invariant)(fetchPolicy === "standby", 80);
+            (0, invariant_1.invariant)(fetchPolicy === "standby", 82);
             this.variablesUnknown = true;
         }
         this.lastQuery = transformedQuery;
@@ -390,7 +390,7 @@ class ObservableQuery {
             const queryDef = (0, internal_1.getQueryDefinition)(this.query);
             const vars = queryDef.variableDefinitions;
             if (!vars || !vars.some((v) => v.variable.name.value === "variables")) {
-                __DEV__ && invariant_1.invariant.warn(81, variables, queryDef.name?.value || queryDef);
+                __DEV__ && invariant_1.invariant.warn(83, variables, queryDef.name?.value || queryDef);
             }
         }
         if (variables && !(0, equality_1.equal)(this.variables, variables)) {
@@ -406,7 +406,7 @@ class ObservableQuery {
     fetchMore({ query, variables, context, errorPolicy, updateQuery, }) {
         (0, invariant_1.invariant)(
             this.options.fetchPolicy !== "cache-only",
-            82,
+            84,
             (0, internal_1.getOperationName)(this.query, "(anonymous)")
         );
         const combinedOptions = {
@@ -440,7 +440,7 @@ class ObservableQuery {
         let wasUpdated = false;
         const isCached = this.options.fetchPolicy !== "no-cache";
         if (!isCached) {
-            (0, invariant_1.invariant)(updateQuery, 83);
+            (0, invariant_1.invariant)(updateQuery, 85);
         }
         const { finalize, pushNotification } = this.pushOperation(networkStatus_js_1.NetworkStatus.fetchMore);
         pushNotification({
@@ -616,7 +616,7 @@ class ObservableQuery {
                         onError(error);
                     }
                     else {
-                        invariant_1.invariant.error(84, error);
+                        invariant_1.invariant.error(86, error);
                     }
                     return;
                 }
@@ -867,7 +867,7 @@ class ObservableQuery {
                 if (!this.didWarnCacheOnlyPolling &&
                     pollInterval &&
                     fetchPolicy === "cache-only") {
-                    __DEV__ && invariant_1.invariant.warn(85, (0, internal_1.getOperationName)(this.query, "(anonymous)"));
+                    __DEV__ && invariant_1.invariant.warn(87, (0, internal_1.getOperationName)(this.query, "(anonymous)"));
                     this.didWarnCacheOnlyPolling = true;
                 }
             }
@@ -1367,7 +1367,7 @@ class ObservableQuery {
 exports.ObservableQuery = ObservableQuery;
 function logMissingFieldErrors(missing) {
     if (environment_1.__DEV__ && missing) {
-        __DEV__ && invariant_1.invariant.debug(86, missing);
+        __DEV__ && invariant_1.invariant.debug(88, missing);
     }
 }
 function isEqualQuery(a, b) {