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

package/cache/inmemory/types.d.ts

@@ -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.js";
 import type { AllFieldsModifier, CanReadFunction, Modifiers, ToReferenceFunction } from "../core/types/common.js";
 import type { FieldValueGetter } from "./entityStore.js";
@@ -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.ts.map

package/cache/inmemory/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/cache/inmemory/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FieldNode } from \"graphql\";\n\nimport type { OperationVariables } from \"@apollo/client\";\nimport type {\n  Reference,\n  StoreObject,\n  StoreValue,\n} from \"@apollo/client/utilities\";\n\nimport type { Transaction } from \"../core/cache.js\";\nimport type {\n  AllFieldsModifier,\n  CanReadFunction,\n  Modifiers,\n  ToReferenceFunction,\n} from \"../core/types/common.js\";\n\nimport type { FieldValueGetter } from \"./entityStore.js\";\nimport type { FragmentRegistryAPI } from \"./fragmentRegistry.js\";\nimport type {\n  FieldMergeFunction,\n  KeyFieldsFunction,\n  PossibleTypesMap,\n  StorageType,\n  TypePolicies,\n} from \"./policies.js\";\n\nexport type { Reference, StoreObject, StoreValue };\n\nexport interface IdGetterObj extends Object {\n  __typename?: string;\n  id?: string;\n  _id?: string;\n}\n\nexport declare type IdGetter = (value: IdGetterObj) => string | undefined;\n\n/**\n * This is an interface used to access, set and remove\n * StoreObjects from the cache\n */\nexport interface NormalizedCache {\n  has(dataId: string): boolean;\n  get(dataId: string, fieldName: string): StoreValue;\n\n  // The store.merge method allows either argument to be a string ID, but\n  // the other argument has to be a StoreObject. Either way, newer fields\n  // always take precedence over older fields.\n  merge(olderId: string, newerObject: StoreObject): void;\n  merge(olderObject: StoreObject, newerId: string): void;\n\n  modify<Entity extends Record<string, any>>(\n    dataId: string,\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>,\n    exact: boolean\n  ): boolean;\n  delete(dataId: string, fieldName?: string): boolean;\n  clear(): void;\n\n  // non-Map elements:\n  /**\n   * returns an Object with key-value pairs matching the contents of the store\n   */\n  toObject(): NormalizedCacheObject;\n  /**\n   * replace the state of the store\n   */\n  replace(newData: NormalizedCacheObject): void;\n\n  /**\n   * Retain (or release) a given root ID to protect (or expose) it and its\n   * transitive child entities from (or to) garbage collection. The current\n   * retainment count is returned by both methods. Note that releasing a root\n   * ID does not cause that entity to be garbage collected, but merely removes\n   * it from the set of root IDs that will be considered during the next\n   * mark-and-sweep collection.\n   */\n  retain(rootId: string): number;\n  release(rootId: string): number;\n\n  getFieldValue: FieldValueGetter;\n  toReference: ToReferenceFunction;\n  canRead: CanReadFunction;\n\n  getStorage(\n    idOrObj: string | StoreObject,\n    ...storeFieldNames: (string | number)[]\n  ): StorageType;\n}\n\n/**\n * This is a normalized representation of the Apollo query result cache. It consists of\n * a flattened representation of query result trees.\n */\nexport interface NormalizedCacheObject {\n  __META?: {\n    // Well-known singleton IDs like ROOT_QUERY and ROOT_MUTATION are\n    // always considered to be root IDs during cache.gc garbage\n    // collection, but other IDs can become roots if they are written\n    // directly with cache.writeFragment or retained explicitly with\n    // cache.retain. When such IDs exist, we include them in the __META\n    // section so that they can survive cache.{extract,restore}.\n    extraRootIds: string[];\n  };\n  [dataId: string]: StoreObject | undefined;\n}\n\nexport type OptimisticStoreItem = {\n  id: string;\n  data: NormalizedCacheObject;\n  transaction: Transaction;\n};\n\nexport type ReadQueryOptions = {\n  /**\n   * The Apollo Client store object.\n   */\n  store: NormalizedCache;\n  /**\n   * A parsed GraphQL query document.\n   */\n  query: DocumentNode;\n  variables?: Object;\n  previousResult?: any;\n  rootId?: string;\n  config?: ApolloReducerConfig;\n};\n\nexport type DiffQueryAgainstStoreOptions = ReadQueryOptions & {\n  returnPartialData?: boolean;\n};\n\nexport type ApolloReducerConfig = {\n  dataIdFromObject?: KeyFieldsFunction;\n};\n\nexport interface InMemoryCacheConfig extends ApolloReducerConfig {\n  resultCaching?: boolean;\n  possibleTypes?: PossibleTypesMap;\n  typePolicies?: TypePolicies;\n  fragments?: FragmentRegistryAPI;\n}\n\nexport interface MergeInfo {\n  field: FieldNode;\n  typename: string | undefined;\n  merge: FieldMergeFunction;\n}\n\nexport interface MergeTree {\n  info?: MergeInfo;\n  map: Map<string | number, MergeTree>;\n}\n\nexport interface ReadMergeModifyContext {\n  store: NormalizedCache;\n  variables?: OperationVariables;\n  // A JSON.stringify-serialized version of context.variables.\n  varString?: string;\n  extensions?: Record<string, unknown>;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/cache/inmemory/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FieldNode } from \"graphql\";\n\nimport type { OperationVariables } from \"@apollo/client\";\nimport type {\n  Reference,\n  StoreObject,\n  StoreValue,\n} from \"@apollo/client/utilities\";\nimport type { ExtensionsWithStreamInfo } from \"@apollo/client/utilities/internal\";\n\nimport type { Transaction } from \"../core/cache.js\";\nimport type {\n  AllFieldsModifier,\n  CanReadFunction,\n  Modifiers,\n  ToReferenceFunction,\n} from \"../core/types/common.js\";\n\nimport type { FieldValueGetter } from \"./entityStore.js\";\nimport type { FragmentRegistryAPI } from \"./fragmentRegistry.js\";\nimport type {\n  FieldMergeFunction,\n  KeyFieldsFunction,\n  PossibleTypesMap,\n  StorageType,\n  TypePolicies,\n} from \"./policies.js\";\n\nexport type { Reference, StoreObject, StoreValue };\n\nexport interface IdGetterObj extends Object {\n  __typename?: string;\n  id?: string;\n  _id?: string;\n}\n\nexport declare type IdGetter = (value: IdGetterObj) => string | undefined;\n\n/**\n * This is an interface used to access, set and remove\n * StoreObjects from the cache\n */\nexport interface NormalizedCache {\n  has(dataId: string): boolean;\n  get(dataId: string, fieldName: string): StoreValue;\n\n  // The store.merge method allows either argument to be a string ID, but\n  // the other argument has to be a StoreObject. Either way, newer fields\n  // always take precedence over older fields.\n  merge(olderId: string, newerObject: StoreObject): void;\n  merge(olderObject: StoreObject, newerId: string): void;\n\n  modify<Entity extends Record<string, any>>(\n    dataId: string,\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>,\n    exact: boolean\n  ): boolean;\n  delete(dataId: string, fieldName?: string): boolean;\n  clear(): void;\n\n  // non-Map elements:\n  /**\n   * returns an Object with key-value pairs matching the contents of the store\n   */\n  toObject(): NormalizedCacheObject;\n  /**\n   * replace the state of the store\n   */\n  replace(newData: NormalizedCacheObject): void;\n\n  /**\n   * Retain (or release) a given root ID to protect (or expose) it and its\n   * transitive child entities from (or to) garbage collection. The current\n   * retainment count is returned by both methods. Note that releasing a root\n   * ID does not cause that entity to be garbage collected, but merely removes\n   * it from the set of root IDs that will be considered during the next\n   * mark-and-sweep collection.\n   */\n  retain(rootId: string): number;\n  release(rootId: string): number;\n\n  getFieldValue: FieldValueGetter;\n  toReference: ToReferenceFunction;\n  canRead: CanReadFunction;\n\n  getStorage(\n    idOrObj: string | StoreObject,\n    ...storeFieldNames: (string | number)[]\n  ): StorageType;\n}\n\n/**\n * This is a normalized representation of the Apollo query result cache. It consists of\n * a flattened representation of query result trees.\n */\nexport interface NormalizedCacheObject {\n  __META?: {\n    // Well-known singleton IDs like ROOT_QUERY and ROOT_MUTATION are\n    // always considered to be root IDs during cache.gc garbage\n    // collection, but other IDs can become roots if they are written\n    // directly with cache.writeFragment or retained explicitly with\n    // cache.retain. When such IDs exist, we include them in the __META\n    // section so that they can survive cache.{extract,restore}.\n    extraRootIds: string[];\n  };\n  [dataId: string]: StoreObject | undefined;\n}\n\nexport type OptimisticStoreItem = {\n  id: string;\n  data: NormalizedCacheObject;\n  transaction: Transaction;\n};\n\nexport type ReadQueryOptions = {\n  /**\n   * The Apollo Client store object.\n   */\n  store: NormalizedCache;\n  /**\n   * A parsed GraphQL query document.\n   */\n  query: DocumentNode;\n  variables?: Object;\n  previousResult?: any;\n  rootId?: string;\n  config?: ApolloReducerConfig;\n};\n\nexport type DiffQueryAgainstStoreOptions = ReadQueryOptions & {\n  returnPartialData?: boolean;\n};\n\nexport type ApolloReducerConfig = {\n  dataIdFromObject?: KeyFieldsFunction;\n};\n\nexport interface InMemoryCacheConfig extends ApolloReducerConfig {\n  resultCaching?: boolean;\n  possibleTypes?: PossibleTypesMap;\n  typePolicies?: TypePolicies;\n  fragments?: FragmentRegistryAPI;\n}\n\nexport interface MergeInfo {\n  field: FieldNode;\n  typename: string | undefined;\n  merge: FieldMergeFunction;\n  path: Array<string | number>;\n}\n\nexport interface MergeTree {\n  info?: MergeInfo;\n  map: Map<string | number, MergeTree>;\n}\n\nexport interface ReadMergeModifyContext {\n  store: NormalizedCache;\n  variables?: OperationVariables;\n  // A JSON.stringify-serialized version of context.variables.\n  varString?: string;\n  extensions?: ExtensionsWithStreamInfo;\n}\n"]}

package/cache/inmemory/writeToStore.d.ts

@@ -21,7 +21,6 @@ export interface WriteContext extends ReadMergeModifyContext {
     clientOnly: boolean;
     deferred: boolean;
     flavors: Map<string, FlavorableWriteContext>;
-    extensions?: Record<string, unknown>;
 }
 type FlavorableWriteContext = Pick<WriteContext, "clientOnly" | "deferred" | "flavors">;
 export declare class StoreWriter {

package/cache/inmemory/writeToStore.js

@@ -3,10 +3,10 @@ import { Trie } from "@wry/trie";
 import { Kind } from "graphql";
 import { addTypenameToDocument, canonicalStringify, isReference, } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { argumentsObjectFromField, cloneDeep, getDefaultValues, getFragmentFromSelection, getOperationDefinition, isArray, isField, isNonEmptyArray, makeReference, resultKeyNameFromField, shouldInclude, } from "@apollo/client/utilities/internal";
+import { argumentsObjectFromField, cloneDeep, getDefaultValues, getFragmentFromSelection, getOperationDefinition, hasDirectives, isArray, isField, isNonEmptyArray, makeReference, resultKeyNameFromField, shouldInclude, streamInfoSymbol, } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
 import { extractFragmentContext, fieldNameFromStoreName, makeProcessedFieldsMerger, storeValueIsStoreObject, } from "./helpers.js";
-import { normalizeReadFieldOptions } from "./policies.js";
+import { defaultStreamFieldMergeFn, normalizeReadFieldOptions, } from "./policies.js";
 // Since there are only four possible combinations of context.clientOnly and
 // context.deferred values, we should need at most four "flavors" of any given
 // WriteContext. To avoid creating multiple copies of the same context, we cache
@@ -65,6 +65,7 @@ export class StoreWriter {
             selectionSet: operationDefinition.selectionSet,
             mergeTree: { map: new Map() },
             context,
+            path: [],
         });
         if (!isReference(ref)) {
             throw newInvariantError(109, result);
@@ -122,7 +123,7 @@ export 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.
@@ -168,6 +169,7 @@ export class StoreWriter {
         context, typename).forEach((context, field) => {
             const resultFieldKey = resultKeyNameFromField(field);
             const value = result[resultFieldKey];
+            const path = [...currentPath, field.name.value];
             fieldNodeSet.add(field);
             if (value !== void 0) {
                 const storeFieldName = policies.getStoreFieldName({
@@ -182,7 +184,7 @@ export 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.
@@ -200,6 +202,17 @@ export class StoreWriter {
                         field,
                         typename,
                         merge,
+                        path,
+                    };
+                }
+                else if (hasDirectives(["stream"], field) &&
+                    Array.isArray(incomingValue) &&
+                    context.extensions?.[streamInfoSymbol]) {
+                    childTree.info = {
+                        field,
+                        typename,
+                        merge: defaultStreamFieldMergeFn,
+                        path,
                     };
                 }
                 else {
@@ -285,7 +298,7 @@ export 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,
@@ -294,7 +307,7 @@ export class StoreWriter {
         }
         if (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;
             });
@@ -304,6 +317,7 @@ export class StoreWriter {
             selectionSet: field.selectionSet,
             context,
             mergeTree,
+            path,
         });
     }
     // Implements https://spec.graphql.org/draft/#sec-Field-Collection, but with