@apollo/client 4.3.0-alpha.1 → 4.3.0-alpha.10

package/core/ApolloClient.d.ts

@@ -8,7 +8,7 @@ import type { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
 import type { LocalState } from "@apollo/client/local-state";
 import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
 import { DocumentTransform } from "@apollo/client/utilities";
-import type { LazyType, OptionWithFallback, SignatureStyle, VariablesOption, variablesUnknownSymbol } from "@apollo/client/utilities/internal";
+import type { LazyType, OptionWithFallback, Prettify, SignatureStyle, VariablesOption, variablesUnknownSymbol } from "@apollo/client/utilities/internal";
 import { getApolloClientMemoryInternals } from "@apollo/client/utilities/internal";
 import type { DeclareDefaultOptions, DefaultOptions } from "./defaultOptions.js";
 import type { ObservableQuery } from "./ObservableQuery.js";
@@ -232,7 +232,20 @@ export declare namespace ApolloClient {
     export namespace mutate {
         interface DefaultOptions extends ApolloClient.DefaultOptions.Mutate.Calculated {
         }
-        type ResultForOptions<TData, TVariables extends OperationVariables, TCache extends Cache.Implementation, TOptions extends Record<string, unknown> | MutateOptions<any, TVariables, TCache>> = LazyType<MutateResult<MaybeMasked<TData>, OptionWithFallback<TOptions, DefaultOptions, "errorPolicy"> & ErrorPolicy>>;
+        type OptionsFor<TData, TVariables extends OperationVariables, TCache extends Cache.Implementation, TOptions extends {
+            variables?: unknown;
+        }> = MutateOptions<NoInfer<TData>, NoInfer<TVariables>, TCache> & {
+            variables?: Prettify<TVariables & {
+                [K in keyof TOptions["variables"]]: K extends keyof TVariables ? TVariables[K] : never;
+            }>;
+        } & (Exclude<keyof TOptions, keyof MutateOptions<any, any, any>> extends (infer InvalidOptionNames extends string) ? [
+            InvalidOptionNames
+        ] extends [never] ? unknown : {
+            [K in InvalidOptionNames]: never;
+        } : never);
+        type ResultForOptions<TData, TErrorPolicy extends ErrorPolicy | undefined = undefined> = LazyType<MutateResult<MaybeMasked<TData>, OptionWithFallback<{
+            errorPolicy: TErrorPolicy;
+        }, DefaultOptions, "errorPolicy"> & ErrorPolicy>>;
         namespace Signatures {
             interface Classic {
                 /**
@@ -271,11 +284,21 @@ export declare namespace ApolloClient {
                 * 
                 * It takes options as an object with the following keys and values:
                 */
-                <TData, TVariables extends OperationVariables, TOptions extends ApolloClient.MutateOptions<NoInfer<TData>, NoInfer<TVariables>, Cache.Implementation> & VariablesOption<TVariables & {
-                    [K in Exclude<keyof TOptions["variables"], keyof TVariables>]?: never;
-                }>>(options: TOptions & {
+                <TData, TVariables extends OperationVariables, TOptions extends Omit<ApolloClient.MutateOptions<NoInfer<TData>, any, Cache.Implementation>, "variables"> & {
+                    variables?: unknown;
+                }, TErrorPolicy extends ErrorPolicy | undefined = undefined>(options: TOptions & ApolloClient.mutate.OptionsFor<TData, TVariables, Cache.Implementation, TOptions> & {
                     mutation: TypedDocumentNode<TData, TVariables>;
-                }): Promise<ApolloClient.mutate.ResultForOptions<TData, TVariables, Cache.Implementation, TOptions>>;
+                    /**
+                    * Specifies how the mutation handles a response that returns both GraphQL errors and partial results.
+                    * 
+                    * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
+                    * 
+                    * The default value is `none`, meaning that the mutation result includes error details but _not_ partial results.
+                    * 
+                    * @docGroup 1. Operation options
+                    */
+                    errorPolicy?: TErrorPolicy;
+                }): Promise<ApolloClient.mutate.ResultForOptions<TData, TErrorPolicy>>;
             }
             type Evaluated = SignatureStyle extends "classic" ? Classic : Modern;
         }
@@ -473,7 +496,18 @@ export declare namespace ApolloClient {
     export namespace query {
         interface DefaultOptions extends ApolloClient.DefaultOptions.Query.Calculated {
         }
-        type ResultForOptions<TData, TVariables extends OperationVariables, TOptions extends Record<string, unknown> | QueryOptions<any, TVariables>> = LazyType<QueryResult<MaybeMasked<TData>, OptionWithFallback<TOptions, DefaultOptions, "errorPolicy"> & ErrorPolicy>>;
+        type OptionsFor<TData, TVariables extends OperationVariables, TOptions extends {
+            variables?: unknown;
+        }> = QueryOptions<NoInfer<TData>, NoInfer<TVariables>> & {
+            variables?: Prettify<TVariables & {
+                [K in keyof TOptions["variables"]]: K extends keyof TVariables ? TVariables[K] : never;
+            }>;
+        } & (Exclude<keyof TOptions, keyof QueryOptions<any, any>> extends (infer InvalidOptionNames extends string) ? [
+            InvalidOptionNames
+        ] extends [never] ? unknown : {
+            [K in InvalidOptionNames]: never;
+        } : never);
+        type ResultForOptions<TData, TVariables extends OperationVariables, TOptions extends Record<string, unknown> | Omit<QueryOptions<any, any>, "variables">> = LazyType<QueryResult<MaybeMasked<TData>, OptionWithFallback<TOptions, DefaultOptions, "errorPolicy"> & ErrorPolicy>>;
         namespace Signatures {
             interface Classic {
                 /**
@@ -515,9 +549,9 @@ export declare namespace ApolloClient {
                 * describe how this query should be treated e.g. whether it should hit the
                 * server at all or just resolve from the cache, etc.
                 */
-                <TData, TVariables extends OperationVariables, TOptions extends ApolloClient.QueryOptions<NoInfer<TData>, NoInfer<TVariables>> & VariablesOption<TVariables & {
-                    [K in Exclude<keyof TOptions["variables"], keyof TVariables>]?: never;
-                }>>(options: TOptions & {
+                <TData, TVariables extends OperationVariables, TOptions extends Omit<ApolloClient.QueryOptions<NoInfer<TData>, any>, "variables"> & {
+                    variables?: unknown;
+                }>(options: TOptions & ApolloClient.query.OptionsFor<TData, TVariables, TOptions> & {
                     query: TypedDocumentNode<TData, TVariables>;
                 }): Promise<ApolloClient.query.ResultForOptions<TData, TVariables, TOptions>>;
             }

package/core/ApolloClient.js

@@ -71,8 +71,8 @@ export class ApolloClient {
      */
     constructor(options) {
         if (__DEV__) {
-            invariant(options.cache, 68);
-            invariant(options.link, 69);
+            invariant(options.cache, 69);
+            invariant(options.link, 70);
         }
         const { cache, documentTransform, ssrMode = false, ssrForceFetchDelay = 0, queryDeduplication = true, defaultOptions, defaultContext, assumeImmutableResults = cache.assumeImmutableResults, localState, devtools, dataMasking, link, incrementalHandler = new NotImplementedHandler(), experiments = [], refetchEventManager, } = options;
         this.link = link;
@@ -141,29 +141,28 @@ export class ApolloClient {
          */
         if (!hasSuggestedDevtools && __DEV__) {
             hasSuggestedDevtools = true;
-            if (window.document &&
-                window.top === window.self &&
-                /^(https?|file):$/.test(window.location.protocol)) {
+            const win = window;
+            const ua = win.navigator.userAgent;
+            let url;
+            if (typeof ua === "string") {
+                if (ua.indexOf("Chrome/") > -1) {
+                    url =
+                        "https://chrome.google.com/webstore/detail/" +
+                            "apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm";
+                }
+                else if (ua.indexOf("Firefox/") > -1) {
+                    url =
+                        "https://addons.mozilla.org/en-US/firefox/addon/apollo-developer-tools/";
+                }
+            }
+            if (win.document &&
+                win.top === win.self &&
+                /^(https?|file):$/.test(win.location.protocol) &&
+                url) {
                 setTimeout(() => {
-                    if (!window.__APOLLO_DEVTOOLS_GLOBAL_HOOK__) {
-                        const nav = window.navigator;
-                        const ua = nav && nav.userAgent;
-                        let url;
-                        if (typeof ua === "string") {
-                            if (ua.indexOf("Chrome/") > -1) {
-                                url =
-                                    "https://chrome.google.com/webstore/detail/" +
-                                        "apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm";
-                            }
-                            else if (ua.indexOf("Firefox/") > -1) {
-                                url =
-                                    "https://addons.mozilla.org/en-US/firefox/addon/apollo-developer-tools/";
-                            }
-                        }
-                        if (url) {
-                            __DEV__ && invariant.log("Download the Apollo DevTools for a better development " +
-                                "experience: %s", url);
-                        }
+                    if (!win.__APOLLO_DEVTOOLS_GLOBAL_HOOK__) {
+                        __DEV__ && invariant.log("Download the Apollo DevTools for a better development " +
+                            "experience: %s", url);
                     }
                 }, 10000);
             }
@@ -261,12 +260,12 @@ export class ApolloClient {
             if (refetchOn) {
                 const operationName = getOperationName(query, "(anonymous)");
                 if (!refetchEventManager) {
-                    __DEV__ && invariant.warn(70, operationName);
+                    __DEV__ && invariant.warn(71, operationName);
                 }
                 else if (typeof refetchOn === "object") {
                     Object.keys(refetchOn).forEach((source) => {
                         if (!refetchEventManager.hasSource(source)) {
-                            __DEV__ && invariant.warn(71, source, operationName);
+                            __DEV__ && invariant.warn(72, source, operationName);
                         }
                     });
                 }
@@ -288,13 +287,13 @@ export class ApolloClient {
             options = mergeOptions(this.defaultOptions.query, options);
         }
         if (__DEV__) {
-            invariant(options.fetchPolicy !== "cache-and-network", 72);
-            invariant(options.fetchPolicy !== "standby", 73);
-            invariant(options.query, 74);
-            invariant(options.query.kind === "Document", 75);
-            invariant(!options.returnPartialData, 76);
-            invariant(!options.pollInterval, 77);
-            invariant(!options.notifyOnNetworkStatusChange, 78);
+            invariant(options.fetchPolicy !== "cache-and-network", 73);
+            invariant(options.fetchPolicy !== "standby", 74);
+            invariant(options.query, 75);
+            invariant(options.query.kind === "Document", 76);
+            invariant(!options.returnPartialData, 77);
+            invariant(!options.pollInterval, 78);
+            invariant(!options.notifyOnNetworkStatusChange, 79);
         }
         return this.queryManager.query(options);
     };
@@ -312,9 +311,9 @@ export class ApolloClient {
             errorPolicy: "none",
         }, this.defaultOptions.mutate), options);
         if (__DEV__) {
-            invariant(optionsWithDefaults.mutation, 79);
+            invariant(optionsWithDefaults.mutation, 80);
             invariant(optionsWithDefaults.fetchPolicy === "network-only" ||
-                optionsWithDefaults.fetchPolicy === "no-cache", 80);
+                optionsWithDefaults.fetchPolicy === "no-cache", 81);
         }
         checkDocument(optionsWithDefaults.mutation, OperationTypeNode.MUTATION);
         return this.queryManager.mutate(optionsWithDefaults);
@@ -337,7 +336,7 @@ export class ApolloClient {
         })));
         return Object.assign(mapped, { restart: observable.restart });
     }
-    readQuery(options, optimistic = false) {
+    readQuery(options, optimistic = !!options.optimistic) {
         return this.cache.readQuery({ ...options, query: this.transform(options.query) }, optimistic);
     }
     watchFragment(options) {
@@ -362,7 +361,7 @@ export class ApolloClient {
         }
         return observable;
     }
-    readFragment(options, optimistic = false) {
+    readFragment(options, optimistic = !!options.optimistic) {
         return this.cache.readFragment({ ...options, fragment: this.transform(options.fragment) }, optimistic);
     }
     /**
@@ -520,7 +519,7 @@ export class ApolloClient {
         // result.queries and result.results instead, you shouldn't have to worry
         // about preventing uncaught rejections for the Promise.all result.
         result.catch((error) => {
-            __DEV__ && invariant.debug(81, error);
+            __DEV__ && invariant.debug(82, error);
         });
         return result;
     }