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

package/cache/inmemory/inMemoryCache.d.ts

@@ -2,13 +2,13 @@ import type { DocumentNode, FragmentDefinitionNode, InlineFragmentNode } from "g
 import type { OperationVariables, TypedDocumentNode } from "@apollo/client";
 import type { DeepPartial, Reference, StoreObject } from "@apollo/client/utilities";
 import type { IsLooselyEqual, NoInfer } from "@apollo/client/utilities/internal";
-import { getInMemoryCacheMemoryInternals } from "@apollo/client/utilities/internal";
+import { getInMemoryCacheMemoryInternals, handleIncrementalSymbol } from "@apollo/client/utilities/internal";
 import { ApolloCache } from "../core/cache.js";
 import type { Scalar } from "../core/Scalar.js";
 import type { Cache } from "../core/types/Cache.js";
 import { Policies } from "./policies.js";
 import { makeVar } from "./reactiveVars.js";
-import type { InMemoryCacheConfig, KnownScalars, NormalizedCacheObject } from "./types.js";
+import type { DiffIncrementalInfo, InMemoryCacheConfig, KnownScalars, NormalizedCacheObject } from "./types.js";
 type BroadcastOptions = Pick<Cache.BatchOptions<InMemoryCache>, "optimistic" | "onWatchUpdated">;
 export declare namespace InMemoryCache {
     type ScalarsOption = {
@@ -36,6 +36,7 @@ export declare class InMemoryCache extends ApolloCache {
     private addTypenameTransform;
     private maybeBroadcastWatch;
     readonly assumeImmutableResults = true;
+    readonly [handleIncrementalSymbol] = true;
     readonly policies: Policies;
     readonly makeVar: typeof makeVar;
     constructor(...args: {} extends InMemoryCache.ScalarsOption ? [
@@ -63,7 +64,10 @@ export declare class InMemoryCache extends ApolloCache {
     read<TData = unknown>(options: Cache.ReadOptions<TData, OperationVariables>): TData | null;
     write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.WriteOptions<TData, TVariables>): Reference | undefined;
     modify<Entity extends Record<string, any> = Record<string, any>>(options: Cache.ModifyOptions<Entity>): boolean;
-    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.DiffOptions<TData, TVariables>): Cache.DiffResult<TData>;
+    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache.DiffOptions<TData, TVariables> & {
+        [handleIncrementalSymbol]: true | DiffIncrementalInfo;
+    }): Cache.InternalDiffResultWithDataState<TData>;
+    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache.DiffOptions<TData, TVariables>): Cache.DiffResult<TData>;
     watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache.WatchOptions<TData, TVariables>): () => void;
     gc(options?: {
         resetResultCache?: boolean;

package/cache/inmemory/inMemoryCache.js

@@ -2,7 +2,7 @@ import { equal } from "@wry/equality";
 import { wrap } from "optimism";
 import { addTypenameToDocument, cacheSizes, canonicalStringify, DocumentTransform, isReference, print, } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { getInMemoryCacheMemoryInternals, getOperationDefinition, getUnwrappedType, isPlainObject, } from "@apollo/client/utilities/internal";
+import { getInMemoryCacheMemoryInternals, getOperationDefinition, getUnwrappedType, handleIncrementalSymbol, isPlainObject, } from "@apollo/client/utilities/internal";
 import { invariant } from "@apollo/client/utilities/invariant";
 import { ApolloCache } from "../core/cache.js";
 import { EntityStore, supportsResultCaching } from "./entityStore.js";
@@ -23,6 +23,10 @@ export class InMemoryCache extends ApolloCache {
     // Override the default value, since InMemoryCache result objects are frozen
     // in development and expected to remain logically immutable in production.
     assumeImmutableResults = true;
+    // InMemoryCache can handle incremental results in cache.diff. 3rd party
+    // caches that want to handle incremental results should talk to the Apollo
+    // Client team on how to handle this in Apollo Client 4.x.
+    [handleIncrementalSymbol] = true;
     // Dynamically imported code can augment existing typePolicies or
     // possibleTypes by calling cache.policies.addTypePolicies or
     // cache.policies.addPossibletypes.