@apollo/client 3.8.0-alpha.0 → 3.8.0-alpha.10

package/react/hooks/hooks.cjs

@@ -29,9 +29,9 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 function useApolloClient(override) {
     var context$1 = React.useContext(context.getApolloContext());
     var client = override || context$1.client;
-    __DEV__ ? globals.invariant(!!client, 'Could not find "client" in the context or passed in as an option. ' +
+    globals.__DEV__ ? globals.invariant(!!client, 'Could not find "client" in the context or passed in as an option. ' +
         'Wrap the root component in an <ApolloProvider>, or pass an ApolloClient ' +
-        'instance in via options.') : globals.invariant(!!client, 31);
+        'instance in via options.') : globals.invariant(!!client, 32);
     return client;
 }
 
@@ -40,11 +40,11 @@ var uSESKey = "useSyncExternalStore";
 var realHook = React__namespace[uSESKey];
 var useSyncExternalStore = realHook || (function (subscribe, getSnapshot, getServerSnapshot) {
     var value = getSnapshot();
-    if (__DEV__ &&
+    if (globals.__DEV__ &&
         !didWarnUncachedGetSnapshot &&
         value !== getSnapshot()) {
         didWarnUncachedGetSnapshot = true;
-        __DEV__ && globals.invariant.error('The result of getSnapshot should be cached to avoid an infinite loop');
+        globals.__DEV__ && globals.invariant.error('The result of getSnapshot should be cached to avoid an infinite loop');
     }
     var _a = React__namespace.useState({ inst: { value: value, getSnapshot: getSnapshot } }), inst = _a[0].inst, forceUpdate = _a[1];
     if (utilities.canUseLayoutEffect) {
@@ -126,13 +126,21 @@ var InternalState = (function () {
         }
     }
     InternalState.prototype.forceUpdate = function () {
-        __DEV__ && globals.invariant.warn("Calling default no-op implementation of InternalState#forceUpdate");
+        globals.__DEV__ && globals.invariant.warn("Calling default no-op implementation of InternalState#forceUpdate");
     };
-    InternalState.prototype.asyncUpdate = function () {
+    InternalState.prototype.asyncUpdate = function (signal) {
         var _this = this;
-        return new Promise(function (resolve) {
+        return new Promise(function (resolve, reject) {
+            var watchQueryOptions = _this.watchQueryOptions;
+            var handleAborted = function () {
+                _this.asyncResolveFns.delete(resolve);
+                _this.optionsToIgnoreOnce.delete(watchQueryOptions);
+                signal.removeEventListener('abort', handleAborted);
+                reject(signal.reason);
+            };
             _this.asyncResolveFns.add(resolve);
-            _this.optionsToIgnoreOnce.add(_this.watchQueryOptions);
+            _this.optionsToIgnoreOnce.add(watchQueryOptions);
+            signal.addEventListener('abort', handleAborted);
             _this.forceUpdate();
         });
     };
@@ -182,7 +190,7 @@ var InternalState = (function () {
                 }
             };
             var subscription = obsQuery.subscribe(onNext, onError);
-            return function () { return subscription.unsubscribe(); };
+            return function () { return setTimeout(function () { return subscription.unsubscribe(); }); };
         }, [
             obsQuery,
             this.renderPromises,
@@ -309,9 +317,10 @@ var InternalState = (function () {
     InternalState.prototype.handleErrorOrCompleted = function (result, previousResult) {
         var _this = this;
         if (!result.loading) {
+            var error_1 = this.toApolloError(result);
             Promise.resolve().then(function () {
-                if (result.error) {
-                    _this.onError(result.error);
+                if (error_1) {
+                    _this.onError(error_1);
                 }
                 else if (result.data &&
                     (previousResult === null || previousResult === void 0 ? void 0 : previousResult.networkStatus) !== result.networkStatus &&
@@ -319,10 +328,15 @@ var InternalState = (function () {
                     _this.onCompleted(result.data);
                 }
             }).catch(function (error) {
-                __DEV__ && globals.invariant.warn(error);
+                globals.__DEV__ && globals.invariant.warn(error);
             });
         }
     };
+    InternalState.prototype.toApolloError = function (result) {
+        return utilities.isNonEmptyArray(result.errors)
+            ? new errors.ApolloError({ graphQLErrors: result.errors })
+            : result.error;
+    };
     InternalState.prototype.getCurrentResult = function () {
         if (!this.result) {
             this.handleErrorOrCompleted(this.result = this.observable.getCurrentResult());
@@ -365,11 +379,11 @@ var EAGER_METHODS = [
     'subscribeToMore',
 ];
 function useLazyQuery(query, options) {
-    var internalState = useInternalState(useApolloClient(options && options.client), query);
+    var _a, _b;
+    var abortControllersRef = React.useRef(new Set());
     var execOptionsRef = React.useRef();
-    var merged = execOptionsRef.current
-        ? utilities.mergeOptions(options, execOptionsRef.current)
-        : options;
+    var merged = execOptionsRef.current ? utilities.mergeOptions(options, execOptionsRef.current) : options;
+    var internalState = useInternalState(useApolloClient(options && options.client), (_b = (_a = execOptionsRef.current) === null || _a === void 0 ? void 0 : _a.query) !== null && _b !== void 0 ? _b : query);
     var useQueryResult = internalState.useQuery(tslib.__assign(tslib.__assign({}, merged), { skip: !execOptionsRef.current }));
     var initialFetchPolicy = useQueryResult.observable.options.initialFetchPolicy ||
         internalState.getDefaultFetchPolicy();
@@ -395,14 +409,28 @@ function useLazyQuery(query, options) {
         return eagerMethods;
     }, []);
     Object.assign(result, eagerMethods);
+    React.useEffect(function () {
+        return function () {
+            abortControllersRef.current.forEach(function (controller) {
+                controller.abort();
+            });
+        };
+    }, []);
     var execute = React.useCallback(function (executeOptions) {
+        var controller = new AbortController();
+        abortControllersRef.current.add(controller);
         execOptionsRef.current = executeOptions ? tslib.__assign(tslib.__assign({}, executeOptions), { fetchPolicy: executeOptions.fetchPolicy || initialFetchPolicy }) : {
             fetchPolicy: initialFetchPolicy,
         };
         var promise = internalState
-            .asyncUpdate()
-            .then(function (queryResult) { return Object.assign(queryResult, eagerMethods); });
-        promise.catch(function () { });
+            .asyncUpdate(controller.signal)
+            .then(function (queryResult) {
+            abortControllersRef.current.delete(controller);
+            return Object.assign(queryResult, eagerMethods);
+        });
+        promise.catch(function () {
+            abortControllersRef.current.delete(controller);
+        });
         return promise;
     }, []);
     return [execute, result];
@@ -429,8 +457,9 @@ function useMutation(mutation, options) {
     }
     var execute = React.useCallback(function (executeOptions) {
         if (executeOptions === void 0) { executeOptions = {}; }
-        var _a = ref.current, client = _a.client, options = _a.options, mutation = _a.mutation;
+        var _a = ref.current, options = _a.options, mutation = _a.mutation;
         var baseOptions = tslib.__assign(tslib.__assign({}, options), { mutation: mutation });
+        var client = executeOptions.client || ref.current.client;
         if (!ref.current.result.loading && !baseOptions.ignoreResults && ref.current.isMounted) {
             setResult(ref.current.result = {
                 loading: true,
@@ -443,7 +472,7 @@ function useMutation(mutation, options) {
         var mutationId = ++ref.current.mutationId;
         var clientOptions = core.mergeOptions(baseOptions, executeOptions);
         return client.mutate(clientOptions).then(function (response) {
-            var _a, _b, _c;
+            var _a;
             var data = response.data, errors$1 = response.errors;
             var error = errors$1 && errors$1.length > 0
                 ? new errors.ApolloError({ graphQLErrors: errors$1 })
@@ -461,11 +490,11 @@ function useMutation(mutation, options) {
                     setResult(ref.current.result = result_1);
                 }
             }
-            (_b = (_a = ref.current.options) === null || _a === void 0 ? void 0 : _a.onCompleted) === null || _b === void 0 ? void 0 : _b.call(_a, response.data, clientOptions);
-            (_c = executeOptions.onCompleted) === null || _c === void 0 ? void 0 : _c.call(executeOptions, response.data, clientOptions);
+            var onCompleted = executeOptions.onCompleted || ((_a = ref.current.options) === null || _a === void 0 ? void 0 : _a.onCompleted);
+            onCompleted === null || onCompleted === void 0 ? void 0 : onCompleted(response.data, clientOptions);
             return response;
         }).catch(function (error) {
-            var _a, _b, _c, _d;
+            var _a;
             if (mutationId === ref.current.mutationId &&
                 ref.current.isMounted) {
                 var result_2 = {
@@ -479,9 +508,9 @@ function useMutation(mutation, options) {
                     setResult(ref.current.result = result_2);
                 }
             }
-            if (((_a = ref.current.options) === null || _a === void 0 ? void 0 : _a.onError) || clientOptions.onError) {
-                (_c = (_b = ref.current.options) === null || _b === void 0 ? void 0 : _b.onError) === null || _c === void 0 ? void 0 : _c.call(_b, error, clientOptions);
-                (_d = executeOptions.onError) === null || _d === void 0 ? void 0 : _d.call(executeOptions, error, clientOptions);
+            var onError = executeOptions.onError || ((_a = ref.current.options) === null || _a === void 0 ? void 0 : _a.onError);
+            if (onError) {
+                onError(error, clientOptions);
                 return { data: void 0, errors: error };
             }
             throw error;
@@ -514,12 +543,12 @@ function useSubscription(subscription, options) {
     if (!hasIssuedDeprecationWarningRef.current) {
         hasIssuedDeprecationWarningRef.current = true;
         if (options === null || options === void 0 ? void 0 : options.onSubscriptionData) {
-            __DEV__ && globals.invariant.warn(options.onData
+            globals.__DEV__ && globals.invariant.warn(options.onData
                 ? "'useSubscription' supports only the 'onSubscriptionData' or 'onData' option, but not both. Only the 'onData' option will be used."
                 : "'onSubscriptionData' is deprecated and will be removed in a future major version. Please use the 'onData' option instead.");
         }
         if (options === null || options === void 0 ? void 0 : options.onSubscriptionComplete) {
-            __DEV__ && globals.invariant.warn(options.onComplete
+            globals.__DEV__ && globals.invariant.warn(options.onComplete
                 ? "'useSubscription' supports only the 'onSubscriptionComplete' or 'onComplete' option, but not both. Only the 'onComplete' option will be used."
                 : "'onSubscriptionComplete' is deprecated and will be removed in a future major version. Please use the 'onComplete' option instead.");
         }
@@ -658,20 +687,21 @@ function useFragment_experimental(options) {
     var diffOptions = tslib.__assign(tslib.__assign({}, rest), { id: typeof from === "string" ? from : cache.identify(from), query: cache["getFragmentDoc"](fragment, fragmentName), optimistic: optimistic });
     var resultRef = React.useRef();
     var latestDiff = cache.diff(diffOptions);
+    var getSnapshot = function () {
+        var latestDiffToResult = diffToResult(latestDiff);
+        return resultRef.current &&
+            equality.equal(resultRef.current.data, latestDiffToResult.data)
+            ? resultRef.current
+            : (resultRef.current = latestDiffToResult);
+    };
     return useSyncExternalStore(function (forceUpdate) {
         return cache.watch(tslib.__assign(tslib.__assign({}, diffOptions), { immediate: true, callback: function (diff) {
                 if (!equality.equal(diff, latestDiff)) {
-                    resultRef.current = diffToResult(latestDiff = diff);
+                    resultRef.current = diffToResult((latestDiff = diff));
                     forceUpdate();
                 }
             } }));
-    }, function () {
-        var latestDiffToResult = diffToResult(latestDiff);
-        return resultRef.current &&
-            equality.equal(resultRef.current.data, latestDiffToResult.data)
-            ? resultRef.current
-            : (resultRef.current = latestDiffToResult);
-    });
+    }, getSnapshot, getSnapshot);
 }
 function diffToResult(diff) {
     var result = {
@@ -692,10 +722,16 @@ function useDeepMemo(memoFn, deps) {
     return ref.current.value;
 }
 
-function useSuspenseCache() {
-    var suspenseCache = React.useContext(context.getApolloContext()).suspenseCache;
-    __DEV__ ? globals.invariant(suspenseCache, 'Could not find a "suspenseCache" in the context. Wrap the root component ' +
-        'in an <ApolloProvider> and provide a suspenseCache.') : globals.invariant(suspenseCache, 32);
+var useIsomorphicLayoutEffect = utilities.canUseLayoutEffect
+    ? React.useLayoutEffect
+    : React.useEffect;
+
+function useSuspenseCache(override) {
+    var context$1 = React.useContext(context.getApolloContext());
+    var suspenseCache = override || context$1.suspenseCache;
+    globals.__DEV__ ? globals.invariant(suspenseCache, 'Could not find a "suspenseCache" in the context or passed in as an option. ' +
+        'Wrap the root component in an <ApolloProvider> and provide a suspenseCache, ' +
+        'or pass a SuspenseCache instance in via options.') : globals.invariant(suspenseCache, 33);
     return suspenseCache;
 }
 
@@ -710,28 +746,32 @@ var DEFAULT_SUSPENSE_POLICY = 'always';
 var DEFAULT_ERROR_POLICY = 'none';
 function useSuspenseQuery_experimental(query, options) {
     if (options === void 0) { options = Object.create(null); }
-    var suspenseCache = useSuspenseCache();
+    var suspenseCache = useSuspenseCache(options.suspenseCache);
     var client = useApolloClient(options.client);
     var watchQueryOptions = useWatchQueryOptions({ query: query, options: options, client: client });
     var previousWatchQueryOptionsRef = React.useRef(watchQueryOptions);
+    var deferred = useIsDeferred(query);
     var fetchPolicy = watchQueryOptions.fetchPolicy, errorPolicy = watchQueryOptions.errorPolicy, returnPartialData = watchQueryOptions.returnPartialData, variables = watchQueryOptions.variables;
     var cacheEntry = suspenseCache.lookup(query, variables);
     var observable = React.useState(function () {
         return (cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.observable) || client.watchQuery(watchQueryOptions);
     })[0];
     var result = useObservableQueryResult(observable);
-    if (result.error && errorPolicy === 'none') {
+    var hasFullResult = result.data && !result.partial;
+    var hasPartialResult = result.data && result.partial;
+    var usePartialResult = returnPartialData && hasPartialResult;
+    var allowsThrownErrors = errorPolicy === 'none' && (!deferred || !hasPartialResult);
+    if (result.error &&
+        (result.error.networkError || allowsThrownErrors)) {
         throw result.error;
     }
     if (result.loading) {
         if (!cacheEntry) {
             cacheEntry = suspenseCache.add(query, variables, {
-                promise: observable.reobserve(watchQueryOptions),
+                promise: maybeWrapConcastWithCustomPromise(observable.reobserveAsConcast(watchQueryOptions), { deferred: deferred }),
                 observable: observable,
             });
         }
-        var hasFullResult = result.data && !result.partial;
-        var usePartialResult = returnPartialData && result.partial && result.data;
         var hasUsableResult = usePartialResult ||
             (fetchPolicy === 'cache-and-network' && hasFullResult);
         if (!hasUsableResult && !cacheEntry.fulfilled) {
@@ -755,28 +795,42 @@ function useSuspenseQuery_experimental(query, options) {
             suspenseCache.remove(query, variables);
         };
     }, []);
+    var fetchMore = React.useCallback(function (options) {
+        var promise = observable.fetchMore(options);
+        suspenseCache.add(query, watchQueryOptions.variables, {
+            promise: promise,
+            observable: observable,
+        });
+        return promise;
+    }, [observable]);
+    var refetch = React.useCallback(function (variables) {
+        var promise = observable.refetch(variables);
+        suspenseCache.add(query, watchQueryOptions.variables, {
+            promise: promise,
+            observable: observable,
+        });
+        return promise;
+    }, [observable]);
+    var subscribeToMore = React.useCallback(function (options) { return observable.subscribeToMore(options); }, [observable]);
     return React.useMemo(function () {
         return {
+            client: client,
             data: result.data,
-            error: errorPolicy === 'all' ? toApolloError(result) : void 0,
-            fetchMore: function (options) {
-                var promise = observable.fetchMore(options);
-                suspenseCache.add(query, watchQueryOptions.variables, {
-                    promise: promise,
-                    observable: observable,
-                });
-                return promise;
-            },
-            refetch: function (variables) {
-                var promise = observable.refetch(variables);
-                suspenseCache.add(query, watchQueryOptions.variables, {
-                    promise: promise,
-                    observable: observable,
-                });
-                return promise;
-            },
+            error: errorPolicy === 'ignore' ? void 0 : toApolloError(result),
+            networkStatus: result.networkStatus,
+            fetchMore: fetchMore,
+            refetch: refetch,
+            subscribeToMore: subscribeToMore,
         };
-    }, [result, observable, errorPolicy]);
+    }, [
+        client,
+        fetchMore,
+        refetch,
+        result,
+        observable,
+        errorPolicy,
+        subscribeToMore,
+    ]);
 }
 function validateOptions(options) {
     var query = options.query, _a = options.fetchPolicy, fetchPolicy = _a === void 0 ? DEFAULT_FETCH_POLICY : _a, returnPartialData = options.returnPartialData;
@@ -785,11 +839,11 @@ function validateOptions(options) {
     validatePartialDataReturn(fetchPolicy, returnPartialData);
 }
 function validateFetchPolicy(fetchPolicy) {
-    __DEV__ ? globals.invariant(SUPPORTED_FETCH_POLICIES.includes(fetchPolicy), "The fetch policy `".concat(fetchPolicy, "` is not supported with suspense.")) : globals.invariant(SUPPORTED_FETCH_POLICIES.includes(fetchPolicy), 33);
+    globals.__DEV__ ? globals.invariant(SUPPORTED_FETCH_POLICIES.includes(fetchPolicy), "The fetch policy `".concat(fetchPolicy, "` is not supported with suspense.")) : globals.invariant(SUPPORTED_FETCH_POLICIES.includes(fetchPolicy), 34);
 }
 function validatePartialDataReturn(fetchPolicy, returnPartialData) {
     if (fetchPolicy === 'no-cache' && returnPartialData) {
-        __DEV__ && globals.invariant.warn('Using `returnPartialData` with a `no-cache` fetch policy has no effect. To read partial data from the cache, consider using an alternate fetch policy.');
+        globals.__DEV__ && globals.invariant.warn('Using `returnPartialData` with a `no-cache` fetch policy has no effect. To read partial data from the cache, consider using an alternate fetch policy.');
     }
 }
 function toApolloError(result) {
@@ -797,6 +851,21 @@ function toApolloError(result) {
         ? new core.ApolloError({ graphQLErrors: result.errors })
         : result.error;
 }
+function maybeWrapConcastWithCustomPromise(concast, _a) {
+    var deferred = _a.deferred;
+    if (deferred) {
+        return new Promise(function (resolve, reject) {
+            var subscription = concast.subscribe({
+                next: function (value) {
+                    resolve(value);
+                    subscription.unsubscribe();
+                },
+                error: reject,
+            });
+        });
+    }
+    return concast.promise;
+}
 function useWatchQueryOptions(_a) {
     var query = _a.query, options = _a.options, client = _a.client;
     var defaultOptions = client.defaultOptions.watchQuery;
@@ -804,24 +873,29 @@ function useWatchQueryOptions(_a) {
         var errorPolicy = options.errorPolicy, fetchPolicy = options.fetchPolicy, _a = options.suspensePolicy, suspensePolicy = _a === void 0 ? DEFAULT_SUSPENSE_POLICY : _a, variables = options.variables, watchQueryOptions = tslib.__rest(options, ["errorPolicy", "fetchPolicy", "suspensePolicy", "variables"]);
         return tslib.__assign(tslib.__assign({}, watchQueryOptions), { query: query, errorPolicy: errorPolicy || (defaultOptions === null || defaultOptions === void 0 ? void 0 : defaultOptions.errorPolicy) || DEFAULT_ERROR_POLICY, fetchPolicy: fetchPolicy || (defaultOptions === null || defaultOptions === void 0 ? void 0 : defaultOptions.fetchPolicy) || DEFAULT_FETCH_POLICY, notifyOnNetworkStatusChange: suspensePolicy === 'always', fetchOnFirstSubscribe: false, variables: utilities.compact(tslib.__assign(tslib.__assign({}, defaultOptions === null || defaultOptions === void 0 ? void 0 : defaultOptions.variables), variables)) });
     }, [options, query, defaultOptions]);
-    if (__DEV__) {
+    if (globals.__DEV__) {
         validateOptions(watchQueryOptions);
     }
     return watchQueryOptions;
 }
+function useIsDeferred(query) {
+    return React.useMemo(function () { return utilities.hasDirectives(['defer'], query); }, [query]);
+}
 function useObservableQueryResult(observable) {
     var resultRef = React.useRef();
     var isMountedRef = React.useRef(false);
+    var subscribeTimeoutRef = React.useRef();
     if (!resultRef.current) {
         resultRef.current = observable.getCurrentResult();
     }
-    React.useLayoutEffect(function () {
+    useIsomorphicLayoutEffect(function () {
         isMountedRef.current = true;
         return function () {
             isMountedRef.current = false;
         };
     }, []);
     return useSyncExternalStore(React.useCallback(function (forceUpdate) {
+        clearTimeout(subscribeTimeoutRef.current);
         function handleUpdate() {
             var previousResult = resultRef.current;
             var result = observable.getCurrentResult();
@@ -835,12 +909,20 @@ function useObservableQueryResult(observable) {
                 forceUpdate();
             }
         }
-        var subscription = observable.subscribe({
-            next: handleUpdate,
-            error: handleUpdate,
+        var subscription;
+        subscribeTimeoutRef.current = setTimeout(function () {
+            subscription = observable.subscribe({
+                next: handleUpdate,
+                error: handleUpdate,
+            });
+            var result = resultRef.current;
+            if (result.networkStatus !== observable['queryInfo'].networkStatus &&
+                result.networkStatus === core.NetworkStatus.ready) {
+                observable['queryInfo'].markReady();
+            }
         });
         return function () {
-            subscription.unsubscribe();
+            subscription === null || subscription === void 0 ? void 0 : subscription.unsubscribe();
         };
     }, [observable]), function () { return resultRef.current; }, function () { return resultRef.current; });
 }