Release 4.1

.api-reports/api-report-cache.api.md

@@ -94,6 +94,7 @@ export abstract class ApolloCache {
     abstract removeOptimistic(id: string): void;
     // (undocumented)
     abstract reset(options?: Cache_2.ResetOptions): Promise<void>;
+    resolvesClientField?(typename: string, fieldName: string): boolean;
     abstract restore(serializedState: unknown): this;
     // (undocumented)
     transformDocument(document: DocumentNode): DocumentNode;
@@ -544,6 +545,8 @@ export class InMemoryCache extends ApolloCache {
     // (undocumented)
     reset(options?: Cache_2.ResetOptions): Promise<void>;
     // (undocumented)
+    resolvesClientField(typename: string, fieldName: string): boolean;
+    // (undocumented)
     restore(data: NormalizedCacheObject): this;
     // (undocumented)
     retain(rootId: string, optimistic?: boolean): number;

.api-reports/api-report-core.api.md

@@ -195,6 +195,13 @@ export namespace ApolloClient {
         }
     }
     // (undocumented)
+    export interface Experiment {
+        // (undocumented)
+        (this: ApolloClient, options: ApolloClient.Options): void;
+        // (undocumented)
+        v: 1;
+    }
+    // (undocumented)
     export type MutateOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
         optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
             IGNORE: IgnoreModifier;
@@ -231,6 +238,7 @@ export namespace ApolloClient {
         documentTransform?: DocumentTransform;
         // (undocumented)
         enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
+        experiments?: ApolloClient.Experiment[];
         incrementalHandler?: Incremental.Handler<any>;
         link: ApolloLink;
         // (undocumented)
@@ -1132,8 +1140,8 @@ export type WatchQueryOptions<TVariables extends OperationVariables = OperationV
 
 // Warnings were encountered during analysis:
 //
-// src/core/ApolloClient.ts:353:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
-// src/core/ObservableQuery.ts:361:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
+// src/core/ApolloClient.ts:362:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
+// src/core/ObservableQuery.ts:368:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
 // src/core/QueryManager.ts:180:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)

.api-reports/api-report-incremental.api.md

@@ -25,27 +25,38 @@ namespace Defer20220824Handler {
         return: Defer20220824Handler.Chunk<Record<string, unknown>>;
     }
     // (undocumented)
-    type IncrementalDeferPayload<TData = Record<string, unknown>> = {
-        data?: TData | null | undefined;
+    type IncrementalDeferResult<TData = Record<string, unknown>> = {
+        data?: TData | null;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         path?: Incremental.Path;
         label?: string;
     };
     // (undocumented)
+    type IncrementalResult<TData = Record<string, unknown>> = IncrementalDeferResult<TData> | IncrementalStreamResult<TData>;
+    // (undocumented)
+    type IncrementalStreamResult<TData = Array<unknown>> = {
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        items?: TData;
+        path?: Incremental.Path;
+        label?: string;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
     type InitialResult<TData = Record<string, unknown>> = {
         data?: TData | null | undefined;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         hasNext: boolean;
+        incremental?: ReadonlyArray<IncrementalResult<TData>>;
     };
     // (undocumented)
     type SubsequentResult<TData = Record<string, unknown>> = {
         data?: TData | null | undefined;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         hasNext: boolean;
-        incremental?: Array<IncrementalDeferPayload<TData>>;
+        incremental?: Array<IncrementalResult<TData>>;
     };
     // (undocumented)
     interface TypeOverrides {
@@ -80,6 +91,102 @@ class DeferRequest<TData extends Record<string, unknown>> implements Incremental
     hasNext: boolean;
 }
 
+// @public (undocumented)
+export namespace GraphQL17Alpha9Handler {
+    // (undocumented)
+    export type Chunk<TData> = InitialResult<TData> | SubsequentResult<TData>;
+    // (undocumented)
+    export interface CompletedResult {
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        id: string;
+    }
+    // (undocumented)
+    export interface GraphQL17Alpha9Result extends HKT {
+        // (undocumented)
+        arg1: unknown;
+        // (undocumented)
+        arg2: unknown;
+        // (undocumented)
+        return: GraphQL17Alpha9Handler.Chunk<Record<string, unknown>>;
+    }
+    // (undocumented)
+    export interface IncrementalDeferResult<TData = Record<string, unknown>> {
+        // (undocumented)
+        data: TData;
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        extensions?: Record<string, unknown>;
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        subPath?: Incremental.Path;
+    }
+    // (undocumented)
+    export type IncrementalResult<TData = unknown> = IncrementalDeferResult<TData> | IncrementalStreamResult<TData>;
+    // (undocumented)
+    export interface IncrementalStreamResult<TData = ReadonlyArray<unknown>> {
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        extensions?: Record<string, unknown>;
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        items: TData;
+        // (undocumented)
+        subPath?: Incremental.Path;
+    }
+    // (undocumented)
+    export type InitialResult<TData = Record<string, unknown>> = {
+        data: TData;
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        pending: ReadonlyArray<PendingResult>;
+        hasNext: boolean;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
+    export interface PendingResult {
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        label?: string;
+        // (undocumented)
+        path: Incremental.Path;
+    }
+    // (undocumented)
+    export type SubsequentResult<TData = unknown> = {
+        hasNext: boolean;
+        pending?: ReadonlyArray<PendingResult>;
+        incremental?: ReadonlyArray<IncrementalResult<TData>>;
+        completed?: ReadonlyArray<CompletedResult>;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
+    export interface TypeOverrides {
+        // (undocumented)
+        AdditionalApolloLinkResultTypes: GraphQL17Alpha9Result;
+    }
+}
+
+// @public
+export class GraphQL17Alpha9Handler implements Incremental.Handler<GraphQL17Alpha9Handler.Chunk<any>> {
+    // @internal @deprecated (undocumented)
+    extractErrors(result: ApolloLink.Result<any>): GraphQLFormattedError[] | undefined;
+    // @internal @deprecated (undocumented)
+    isIncrementalResult(result: ApolloLink.Result<any>): result is GraphQL17Alpha9Handler.InitialResult | GraphQL17Alpha9Handler.SubsequentResult;
+    // @internal @deprecated (undocumented)
+    prepareRequest(request: ApolloLink.Request): ApolloLink.Request;
+    // Warning: (ae-forgotten-export) The symbol "IncrementalRequest" needs to be exported by the entry point index.d.ts
+    //
+    // @internal @deprecated (undocumented)
+    startRequest<TData>(_: {
+        query: DocumentNode;
+    }): IncrementalRequest<TData>;
+}
+
 // @public (undocumented)
 export namespace Incremental {
     // @internal @deprecated (undocumented)
@@ -106,6 +213,14 @@ export namespace Incremental {
     export type Path = ReadonlyArray<string | number>;
 }
 
+// @public (undocumented)
+class IncrementalRequest<TData> implements Incremental.IncrementalRequest<GraphQL17Alpha9Handler.Chunk<TData>, TData> {
+    // (undocumented)
+    handle(cacheData: TData | DeepPartial<TData> | null | undefined, chunk: GraphQL17Alpha9Handler.Chunk<TData>): FormattedExecutionResult<TData>;
+    // (undocumented)
+    hasNext: boolean;
+}
+
 // @public (undocumented)
 export namespace NotImplementedHandler {
     // (undocumented)

.api-reports/api-report-local-state.api.md

@@ -14,6 +14,7 @@ import type { NoInfer as NoInfer_2 } from '@apollo/client/utilities/internal';
 import type { OperationVariables } from '@apollo/client';
 import type { RemoveIndexSignature } from '@apollo/client/utilities/internal';
 import type { TypedDocumentNode } from '@apollo/client';
+import type { WatchQueryFetchPolicy } from '@apollo/client';
 
 // @public (undocumented)
 type InferContextValueFromResolvers<TResolvers> = TResolvers extends {
@@ -91,14 +92,15 @@ export class LocalState<TResolvers extends LocalState.Resolvers = LocalState.Res
     ]);
     addResolvers(resolvers: TResolvers): void;
     // (undocumented)
-    execute<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ document, client, context, remoteResult, variables, onlyRunForcedResolvers, returnPartialData, }: {
+    execute<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ document, client, context, remoteResult, variables, onlyRunForcedResolvers, returnPartialData, fetchPolicy, }: {
         document: DocumentNode | TypedDocumentNode<TData, TVariables>;
         client: ApolloClient;
         context: DefaultContext | undefined;
         remoteResult: FormattedExecutionResult<any> | undefined;
         variables: TVariables | undefined;
         onlyRunForcedResolvers?: boolean;
         returnPartialData?: boolean;
+        fetchPolicy: WatchQueryFetchPolicy;
     }): Promise<FormattedExecutionResult<TData>>;
     // (undocumented)
     getExportedVariables<TVariables extends OperationVariables = OperationVariables>({ document, client, context, variables, }: {

.api-reports/api-report-react.api.md

@@ -639,7 +639,9 @@ export namespace useMutation {
     }
     ]) => Promise<ApolloClient.MutateResult<MaybeMasked<TData>>>;
     // (undocumented)
-    export type MutationFunctionOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = Options<TData, TVariables, TCache>;
+    export type MutationFunctionOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = Options<TData, TVariables, TCache> & {
+        context?: DefaultContext | ((hookContext: DefaultContext | undefined) => DefaultContext);
+    };
     // (undocumented)
     export interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache, TConfiguredVariables extends Partial<TVariables> = Partial<TVariables>> {
         awaitRefetchQueries?: boolean;

.api-reports/api-report-utilities_internal.api.md

@@ -100,9 +100,20 @@ export type DecoratedPromise<TValue> = PendingPromise<TValue> | FulfilledPromise
 export function decoratePromise<TValue>(promise: Promise<TValue>): DecoratedPromise<TValue>;
 
 // @internal @deprecated (undocumented)
-export class DeepMerger<TContextArgs extends any[]> {
+export namespace DeepMerger {
+    // (undocumented)
+    export type ArrayMergeStrategy = "truncate" | "combine";
+    // (undocumented)
+    export interface Options {
+        // (undocumented)
+        arrayMerge?: DeepMerger.ArrayMergeStrategy;
+    }
+}
+
+// @internal @deprecated (undocumented)
+export class DeepMerger<TContextArgs extends any[] = any[]> {
     // Warning: (ae-forgotten-export) The symbol "ReconcilerFunction" needs to be exported by the entry point index.d.ts
-    constructor(reconciler?: ReconcilerFunction<TContextArgs>);
+    constructor(reconciler?: ReconcilerFunction<TContextArgs>, options?: DeepMerger.Options);
     // (undocumented)
     isObject: typeof isNonNullObject;
     // (undocumented)
@@ -449,7 +460,7 @@ export type VariablesOption<TVariables extends OperationVariables> = {} extends
 
 // Warnings were encountered during analysis:
 //
-// src/utilities/internal/getStoreKeyName.ts:88:1 - (ae-forgotten-export) The symbol "storeKeyNameStringify" needs to be exported by the entry point index.d.ts
+// src/utilities/internal/getStoreKeyName.ts:89:1 - (ae-forgotten-export) The symbol "storeKeyNameStringify" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

.api-reports/api-report.api.md

@@ -95,6 +95,7 @@ export abstract class ApolloCache {
     abstract removeOptimistic(id: string): void;
     // (undocumented)
     abstract reset(options?: Cache_2.ResetOptions): Promise<void>;
+    resolvesClientField?(typename: string, fieldName: string): boolean;
     abstract restore(serializedState: unknown): this;
     // (undocumented)
     transformDocument(document: DocumentNode): DocumentNode;
@@ -201,6 +202,13 @@ export namespace ApolloClient {
             variables?: TVariables;
         }
     }
+    // (undocumented)
+    export interface Experiment {
+        // (undocumented)
+        (this: ApolloClient, options: ApolloClient.Options): void;
+        // (undocumented)
+        v: 1;
+    }
     // Warning: (ae-forgotten-export) The symbol "VariablesOption" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -242,6 +250,7 @@ export namespace ApolloClient {
         documentTransform?: DocumentTransform;
         // (undocumented)
         enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
+        experiments?: ApolloClient.Experiment[];
         // Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
         incrementalHandler?: Incremental.Handler<any>;
         link: ApolloLink;
@@ -1373,6 +1382,8 @@ export class InMemoryCache extends ApolloCache {
     // (undocumented)
     reset(options?: Cache_2.ResetOptions): Promise<void>;
     // (undocumented)
+    resolvesClientField(typename: string, fieldName: string): boolean;
+    // (undocumented)
     restore(data: NormalizedCacheObject): this;
     // (undocumented)
     retain(rootId: string, optimistic?: boolean): number;
@@ -1569,14 +1580,15 @@ class LocalState<TResolvers extends LocalState.Resolvers = LocalState.Resolvers<
     ]);
     addResolvers(resolvers: TResolvers): void;
     // (undocumented)
-    execute<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ document, client, context, remoteResult, variables, onlyRunForcedResolvers, returnPartialData, }: {
+    execute<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ document, client, context, remoteResult, variables, onlyRunForcedResolvers, returnPartialData, fetchPolicy, }: {
         document: DocumentNode | TypedDocumentNode<TData, TVariables>;
         client: ApolloClient;
         context: DefaultContext | undefined;
         remoteResult: FormattedExecutionResult<any> | undefined;
         variables: TVariables | undefined;
         onlyRunForcedResolvers?: boolean;
         returnPartialData?: boolean;
+        fetchPolicy: WatchQueryFetchPolicy;
     }): Promise<FormattedExecutionResult<TData>>;
     // (undocumented)
     getExportedVariables<TVariables extends OperationVariables = OperationVariables>({ document, client, context, variables, }: {
@@ -2711,13 +2723,13 @@ interface WriteContext extends ReadMergeModifyContext {
 // src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/types.ts:134:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
-// src/core/ApolloClient.ts:159:5 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
-// src/core/ApolloClient.ts:353:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
-// src/core/ObservableQuery.ts:361:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
+// src/core/ApolloClient.ts:168:5 - (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
+// src/core/ApolloClient.ts:362:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
+// src/core/ObservableQuery.ts:368:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
 // src/core/QueryManager.ts:180:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
-// src/local-state/LocalState.ts:147:5 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
-// src/local-state/LocalState.ts:200:7 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
-// src/local-state/LocalState.ts:243:7 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
+// src/local-state/LocalState.ts:149:5 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
+// src/local-state/LocalState.ts:202:7 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
+// src/local-state/LocalState.ts:245:7 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

.changeset/big-flowers-move.md

@@ -0,0 +1,23 @@
+---
+"@apollo/client": minor
+---
+
+You can now provide a callback function as the `context` option on the `mutate` function returned by `useMutation`. The callback function is called with the value of the `context` option provided to the `useMutation` hook. This is useful if you'd like to merge the context object provided to the `useMutation` hook with a value provided to the `mutate` function.
+
+
+```ts
+function MyComponent() {
+  const [mutate, result] = useMutation(MUTATION, {
+    context: { foo: true }
+  });
+
+  async function runMutation() {
+    await mutate({
+      // sends context as { foo: true, bar: true }
+      context: (hookContext) => ({ ...hookContext, bar: true })
+    });
+  }
+
+  // ...
+}
+```

.changeset/cold-kiwis-give.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": minor
+---
+
+Fix an issue where deferred payloads that reteurned arrays with fewer items than the original cached array would retain items from the cached array. This change includes `@stream` arrays where stream arrays replace the cached arrays.

.changeset/flat-worms-notice.md

@@ -0,0 +1,7 @@
+---
+"@apollo/client": minor
+---
+
+Don't set the fallback value of a `@client` field to `null` when a `read` function is defined. Instead the `read` function will be called with an `existing` value of `undefined` to allow default arguments to be used to set the returned value.
+
+When a `read` function is not defined nor is there a defined resolver for the field, warn and set the value to `null` only in that instance.

.changeset/funny-bats-hammer.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Fix an issue where calling `fetchMore` with `@defer` or `@stream` would not rerender incremental results as they were streamed.