@apollo/client 4.1.0-alpha.9 → 4.1.0-rc.0

package/__cjs/cache/inmemory/policies.d.cts

@@ -1,5 +1,6 @@
 import type { FieldNode, FragmentDefinitionNode, InlineFragmentNode, SelectionSetNode } from "graphql";
 import type { OperationVariables } from "@apollo/client";
+import type { Incremental } from "@apollo/client/incremental";
 import type { Reference, StoreObject, StoreValue } from "@apollo/client/utilities";
 import { isReference } from "@apollo/client/utilities";
 import type { FragmentMap } from "@apollo/client/utilities/internal";
@@ -36,10 +37,10 @@ export type KeyArgsFunction = (args: Record<string, any> | null, context: {
     field: FieldNode | null;
     variables?: Record<string, any>;
 }) => KeySpecifier | false | ReturnType<IdGetter>;
-export type FieldPolicy<TExisting = any, TIncoming = TExisting, TReadResult = TIncoming, TOptions extends FieldFunctionOptions = FieldFunctionOptions> = {
+export type FieldPolicy<TExisting = any, TIncoming = TExisting, TReadResult = TIncoming, TReadOptions extends FieldReadFunctionOptions = FieldReadFunctionOptions, TMergeOptions extends FieldMergeFunctionOptions = FieldMergeFunctionOptions> = {
     keyArgs?: KeySpecifier | KeyArgsFunction | false;
-    read?: FieldReadFunction<TExisting, TReadResult, TOptions>;
-    merge?: FieldMergeFunction<TExisting, TIncoming, TOptions> | boolean;
+    read?: FieldReadFunction<TExisting, TReadResult, TReadOptions>;
+    merge?: FieldMergeFunction<TExisting, TIncoming, TMergeOptions> | boolean;
 };
 export type StorageType = Record<string, any>;
 export interface FieldFunctionOptions<TArgs = Record<string, any>, TVariables extends OperationVariables = Record<string, any>> {
@@ -55,15 +56,36 @@ export interface FieldFunctionOptions<TArgs = Record<string, any>, TVariables ex
     readField: ReadFieldFunction;
     canRead: CanReadFunction;
     mergeObjects: MergeObjectsFunction;
+}
+export interface FieldReadFunctionOptions<TArgs = Record<string, any>, TVariables extends OperationVariables = Record<string, any>> extends FieldFunctionOptions<TArgs, TVariables> {
+}
+export interface FieldMergeFunctionOptions<TArgs = Record<string, any>, TVariables extends OperationVariables = Record<string, any>> extends FieldFunctionOptions<TArgs, TVariables> {
+    /**
+     * Any `extensions` provided when writing the cache.
+     */
+    extensions: Record<string, unknown> | undefined;
+    /**
+     * Details about the field when the `@stream` directive is used. Useful with
+     * custom merge functions to determine how to merge existing cache data with
+     * the incoming stream array.
+     *
+     * This field is only available in `merge` functions when the `@stream`
+     * directive is used on the field.
+     *
+     * > [!NOTE]
+     * > This field is not available when using the `Defer20220824Handler`
+     */
+    streamFieldInfo?: Incremental.StreamFieldInfo;
     /**
-     * Any `extensions` provided when writing the cache. `extensions` is only
-     * available in `merge` functions and never available in `read` functions.
+     * The same value as the `existing` argument, but preserves the `existing`
+     * value on refetches when `refetchWritePolicy` is `overwrite` (the default).
      */
-    extensions?: Record<string, unknown>;
+    existingData: unknown;
 }
 type MergeObjectsFunction = <T extends StoreObject | Reference>(existing: T, incoming: T) => T;
-export type FieldReadFunction<TExisting = any, TReadResult = TExisting, TOptions extends FieldFunctionOptions = FieldFunctionOptions> = (existing: SafeReadonly<TExisting> | undefined, options: TOptions) => TReadResult | undefined;
-export type FieldMergeFunction<TExisting = any, TIncoming = TExisting, TOptions extends FieldFunctionOptions = FieldFunctionOptions> = (existing: SafeReadonly<TExisting> | undefined, incoming: SafeReadonly<TIncoming>, options: TOptions) => SafeReadonly<TExisting>;
+export type FieldReadFunction<TExisting = any, TReadResult = TExisting, TOptions extends FieldReadFunctionOptions = FieldReadFunctionOptions> = (existing: SafeReadonly<TExisting> | undefined, options: TOptions) => TReadResult | undefined;
+export type FieldMergeFunction<TExisting = any, TIncoming = TExisting, TOptions extends FieldMergeFunctionOptions = FieldMergeFunctionOptions> = (existing: SafeReadonly<TExisting> | undefined, incoming: SafeReadonly<TIncoming>, options: TOptions) => SafeReadonly<TExisting>;
+export declare const defaultStreamFieldMergeFn: FieldMergeFunction<Array<any>>;
 export type PossibleTypesMap = {
     [supertype: string]: string[];
 };
@@ -97,7 +119,7 @@ export declare class Policies {
     readField<V = StoreValue>(options: ReadFieldOptions, context: ReadMergeModifyContext): SafeReadonly<V> | undefined;
     getReadFunction(typename: string | undefined, fieldName: string): FieldReadFunction | undefined;
     getMergeFunction(parentTypename: string | undefined, fieldName: string, childTypename: string | undefined): FieldMergeFunction | undefined;
-    runMergeFunction(existing: StoreValue, incoming: StoreValue, { field, typename, merge }: MergeInfo, context: WriteContext, storage?: StorageType): any;
+    runMergeFunction(existing: StoreValue, incoming: StoreValue, { field, typename, merge, path }: MergeInfo, context: WriteContext, storage?: StorageType): any;
 }
 export declare function normalizeReadFieldOptions(readFieldArgs: any[], objectOrReference: StoreObject | Reference | undefined, variables?: ReadMergeModifyContext["variables"]): ReadFieldOptions;
 export {};

package/__cjs/cache/inmemory/types.d.cts

@@ -1,6 +1,7 @@
 import type { DocumentNode, FieldNode } from "graphql";
 import type { OperationVariables } from "@apollo/client";
 import type { Reference, StoreObject, StoreValue } from "@apollo/client/utilities";
+import type { ExtensionsWithStreamInfo } from "@apollo/client/utilities/internal";
 import type { Transaction } from "../core/cache.cjs";
 import type { AllFieldsModifier, CanReadFunction, Modifiers, ToReferenceFunction } from "../core/types/common.cjs";
 import type { FieldValueGetter } from "./entityStore.cjs";
@@ -93,6 +94,7 @@ export interface MergeInfo {
     field: FieldNode;
     typename: string | undefined;
     merge: FieldMergeFunction;
+    path: Array<string | number>;
 }
 export interface MergeTree {
     info?: MergeInfo;
@@ -102,6 +104,6 @@ export interface ReadMergeModifyContext {
     store: NormalizedCache;
     variables?: OperationVariables;
     varString?: string;
-    extensions?: Record<string, unknown>;
+    extensions?: ExtensionsWithStreamInfo;
 }
 //# sourceMappingURL=types.d.cts.map

package/__cjs/cache/inmemory/writeToStore.cjs

@@ -72,6 +72,7 @@ class StoreWriter {
             selectionSet: operationDefinition.selectionSet,
             mergeTree: { map: new Map() },
             context,
+            path: [],
         });
         if (!(0, utilities_1.isReference)(ref)) {
             throw (0, invariant_1.newInvariantError)(109, result);
@@ -129,7 +130,7 @@ class StoreWriter {
     processSelectionSet({ dataId, result, selectionSet, context, 
     // This object allows processSelectionSet to report useful information
     // to its callers without explicitly returning that information.
-    mergeTree, }) {
+    mergeTree, path: currentPath, }) {
         const { policies } = this.cache;
         // This variable will be repeatedly updated using context.merge to
         // accumulate all fields that need to be written into the store.
@@ -175,6 +176,7 @@ class StoreWriter {
         context, typename).forEach((context, field) => {
             const resultFieldKey = (0, internal_1.resultKeyNameFromField)(field);
             const value = result[resultFieldKey];
+            const path = [...currentPath, field.name.value];
             fieldNodeSet.add(field);
             if (value !== void 0) {
                 const storeFieldName = policies.getStoreFieldName({
@@ -189,7 +191,7 @@ class StoreWriter {
                 // values before processing nested selection sets.
                 field.selectionSet ?
                     getContextFlavor(context, false, false)
-                    : context, childTree);
+                    : context, childTree, path);
                 // To determine if this field holds a child object with a merge function
                 // defined in its type policy (see PR #7070), we need to figure out the
                 // child object's __typename.
@@ -207,6 +209,17 @@ class StoreWriter {
                         field,
                         typename,
                         merge,
+                        path,
+                    };
+                }
+                else if ((0, internal_1.hasDirectives)(["stream"], field) &&
+                    Array.isArray(incomingValue) &&
+                    context.extensions?.[internal_1.streamInfoSymbol]) {
+                    childTree.info = {
+                        field,
+                        typename,
+                        merge: policies_js_1.defaultStreamFieldMergeFn,
+                        path,
                     };
                 }
                 else {
@@ -292,7 +305,7 @@ class StoreWriter {
         }
         return incoming;
     }
-    processFieldValue(value, field, context, mergeTree) {
+    processFieldValue(value, field, context, mergeTree, path) {
         if (!field.selectionSet || value === null) {
             // In development, we need to clone scalar values so that they can be
             // safely frozen with maybeDeepFreeze in readFromStore.ts. In production,
@@ -301,7 +314,7 @@ class StoreWriter {
         }
         if ((0, internal_1.isArray)(value)) {
             return value.map((item, i) => {
-                const value = this.processFieldValue(item, field, context, getChildMergeTree(mergeTree, i));
+                const value = this.processFieldValue(item, field, context, getChildMergeTree(mergeTree, i), [...path, i]);
                 maybeRecycleChildMergeTree(mergeTree, i);
                 return value;
             });
@@ -311,6 +324,7 @@ class StoreWriter {
             selectionSet: field.selectionSet,
             context,
             mergeTree,
+            path,
         });
     }
     // Implements https://spec.graphql.org/draft/#sec-Field-Collection, but with