Add list support to useFragment, useSuspenseFragment, and client.watchFragment

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

@@ -39,20 +39,34 @@ type AllFieldsModifier<Entity extends Record<string, any>> = Modifier<Entity[key
 
 // @public (undocumented)
 export namespace ApolloCache {
+    // (undocumented)
+    export interface ObservableFragment<TData = unknown> extends Observable<ApolloCache.WatchFragmentResult<TData>> {
+        getCurrentResult: () => ApolloCache.WatchFragmentResult<TData>;
+        reobserve: (options: ApolloCache.WatchFragmentReobserveOptions<TData>) => void;
+    }
+    // (undocumented)
+    export type WatchFragmentFromValue<TData> = StoreObject | Reference | FragmentType<NoInfer_2<TData>> | string;
     export interface WatchFragmentOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
         fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
         fragmentName?: string;
-        from: StoreObject | Reference | FragmentType<NoInfer_2<TData>> | string;
+        from: ApolloCache.WatchFragmentFromValue<TData> | Array<ApolloCache.WatchFragmentFromValue<TData> | null>;
         optimistic?: boolean;
         variables?: TVariables;
     }
+    // (undocumented)
+    export interface WatchFragmentReobserveOptions<TData = unknown> {
+        // (undocumented)
+        from: TData extends Array<any> ? Array<StoreObject | Reference | FragmentType<TData> | string | null> : StoreObject | Reference | FragmentType<TData> | string;
+    }
     export type WatchFragmentResult<TData = unknown> = ({
         complete: true;
         missing?: never;
-    } & GetDataState<TData, "complete">) | ({
+    } & GetDataState<TData, "complete">) | {
         complete: false;
-        missing: MissingTree;
-    } & GetDataState<TData, "partial">);
+        missing?: MissingTree;
+        data: TData extends Array<infer TItem> ? Array<DataValue.Partial<TItem | null>> : DataValue.Partial<TData>;
+        dataState: "partial";
+    };
 }
 
 // @public (undocumented)
@@ -106,7 +120,20 @@ export abstract class ApolloCache {
     updateQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
     // (undocumented)
     abstract watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
-    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): Observable<ApolloCache.WatchFragmentResult<Unmasked<TData>>>;
+    // (undocumented)
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.WatchFragmentFromValue<TData>>;
+    }): ApolloCache.ObservableFragment<Array<Unmasked<TData>>>;
+    // (undocumented)
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<null>;
+    }): ApolloCache.ObservableFragment<Array<null>>;
+    // (undocumented)
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.WatchFragmentFromValue<TData> | null>;
+    }): ApolloCache.ObservableFragment<Array<Unmasked<TData> | null>>;
+    // (undocumented)
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): ApolloCache.ObservableFragment<Unmasked<TData>>;
     // (undocumented)
     abstract write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
     writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, fragment, fragmentName, variables, overwrite, id, broadcast, }: Cache_2.WriteFragmentOptions<TData, TVariables>): Reference | undefined;

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

@@ -224,6 +224,11 @@ export namespace ApolloClient {
         extensions?: Record<string, unknown>;
     }
     // (undocumented)
+    export interface ObservableFragment<TData = unknown> extends Observable_2<ApolloClient.WatchFragmentResult<TData>> {
+        getCurrentResult: () => ApolloClient.WatchFragmentResult<TData>;
+        reobserve: (options: ApolloCache.WatchFragmentReobserveOptions<TData>) => void;
+    }
+    // (undocumented)
     export interface Options {
         assumeImmutableResults?: boolean;
         cache: ApolloCache;
@@ -295,7 +300,7 @@ export namespace ApolloClient {
     // (undocumented)
     export type WatchFragmentOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = ApolloCache.WatchFragmentOptions<TData, TVariables>;
     // (undocumented)
-    export type WatchFragmentResult<TData = unknown> = ApolloCache.WatchFragmentResult<TData>;
+    export type WatchFragmentResult<TData = unknown> = ApolloCache.WatchFragmentResult<MaybeMasked<TData>>;
     export type WatchQueryOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
         fetchPolicy?: WatchQueryFetchPolicy;
         nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TData, TVariables>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
@@ -367,7 +372,17 @@ export class ApolloClient {
     subscribe<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.SubscribeOptions<TData, TVariables>): SubscriptionObservable<ApolloClient.SubscribeResult<MaybeMasked<TData>>>;
     // (undocumented)
     version: string;
-    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables>): Observable_2<ApolloClient.WatchFragmentResult<MaybeMasked<TData>>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.WatchFragmentFromValue<TData>>;
+    }): ApolloClient.ObservableFragment<Array<TData>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<null>;
+    }): ApolloClient.ObservableFragment<Array<null>>;
+    // (undocumented)
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.WatchFragmentFromValue<TData> | null>;
+    }): ApolloClient.ObservableFragment<Array<TData | null>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables>): ApolloClient.ObservableFragment<TData>;
     watchQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchQueryOptions<TData, TVariables>): ObservableQuery<TData, TVariables>;
     writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteFragmentOptions<TData, TVariables>): Reference_2 | undefined;
     writeQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteQueryOptions<TData, TVariables>): Reference_2 | undefined;
@@ -1140,7 +1155,7 @@ export type WatchQueryOptions<TVariables extends OperationVariables = OperationV
 
 // Warnings were encountered during analysis:
 //
-// 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/ApolloClient.ts:385: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
 

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

@@ -87,8 +87,21 @@ export type BackgroundQueryHookOptions<TData = unknown, TVariables extends Opera
 // @public
 export function createQueryPreloader(client: ApolloClient): PreloadQueryFunction;
 
+// Warning: (ae-forgotten-export) The symbol "FromPrimitive" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type From<TData> = FromPrimitive<TData> | Array<FromPrimitive<TData>>;
+
+// Warning: (ae-forgotten-export) The symbol "FromPrimitive_2" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type From_2<TData> = FromPrimitive_2<TData> | Array<FromPrimitive_2<TData>>;
+
 // @public (undocumented)
-type From<TData> = StoreObject_2 | Reference_2 | FragmentType<NoInfer_2<TData>> | string | null;
+type FromPrimitive<TData> = StoreObject | Reference | FragmentType<NoInfer_2<TData>> | string | null;
+
+// @public (undocumented)
+type FromPrimitive_2<TData> = StoreObject_2 | Reference_2 | FragmentType<NoInfer_2<TData>> | string | null;
 
 // @public (undocumented)
 export function getApolloContext(): ReactTypes.Context<ApolloContextValue>;
@@ -388,6 +401,21 @@ export namespace useBackgroundQuery {
 // @public @deprecated (undocumented)
 export type UseBackgroundQueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useBackgroundQuery.Result<TData, TVariables>;
 
+// @public
+export function useFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useFragment.Options<TData, TVariables> & {
+    from: Array<NonNullable<From<TData>>>;
+}): useFragment.Result<Array<TData>>;
+
+// @public
+export function useFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useFragment.Options<TData, TVariables> & {
+    from: Array<null>;
+}): useFragment.Result<Array<null>>;
+
+// @public
+export function useFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useFragment.Options<TData, TVariables> & {
+    from: Array<From<TData>>;
+}): useFragment.Result<Array<TData | null>>;
+
 // @public
 export function useFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useFragment.Options<TData, TVariables>): useFragment.Result<TData>;
 
@@ -426,18 +454,20 @@ export namespace useFragment {
         client?: ApolloClient;
         fragment: DocumentNode_2 | TypedDocumentNode_2<TData, TVariables>;
         fragmentName?: string;
-        from: StoreObject | Reference | FragmentType<NoInfer_2<TData>> | string | null;
+        from: From<TData>;
         optimistic?: boolean;
         variables?: NoInfer_2<TVariables>;
     }
     // (undocumented)
     export type Result<TData> = ({
         complete: true;
         missing?: never;
-    } & GetDataState<MaybeMasked_2<TData>, "complete">) | ({
+    } & GetDataState<MaybeMasked_2<TData>, "complete">) | {
         complete: false;
         missing?: MissingTree;
-    } & GetDataState<MaybeMasked_2<TData>, "partial">);
+        data: TData extends Array<infer TItem> ? Array<DataValue.Partial<TItem | null>> : DataValue.Partial<TData>;
+        dataState: "partial";
+    };
 }
 
 // @public @deprecated (undocumented)
@@ -912,9 +942,24 @@ export namespace useSubscription {
     }
 }
 
+// @public
+export function useSuspenseFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useSuspenseFragment.Options<TData, TVariables> & {
+    from: Array<NonNullable<FromPrimitive_2<TData>>>;
+}): useSuspenseFragment.Result<Array<TData>>;
+
+// @public
+export function useSuspenseFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useSuspenseFragment.Options<TData, TVariables> & {
+    from: Array<null>;
+}): useSuspenseFragment.Result<Array<null>>;
+
+// @public
+export function useSuspenseFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: useSuspenseFragment.Options<TData, TVariables> & {
+    from: Array<FromPrimitive_2<TData>>;
+}): useSuspenseFragment.Result<Array<TData | null>>;
+
 // @public
 export function useSuspenseFragment<TData, TVariables extends OperationVariables = OperationVariables>(options: useSuspenseFragment.Options<TData, TVariables> & {
-    from: NonNullable<From<TData>>;
+    from: NonNullable<From_2<TData>>;
 }): useSuspenseFragment.Result<TData>;
 
 // @public
@@ -924,7 +969,7 @@ export function useSuspenseFragment<TData, TVariables extends OperationVariables
 
 // @public
 export function useSuspenseFragment<TData, TVariables extends OperationVariables = OperationVariables>(options: useSuspenseFragment.Options<TData, TVariables> & {
-    from: From<TData>;
+    from: From_2<TData>;
 }): useSuspenseFragment.Result<TData | null>;
 
 // @public
@@ -939,7 +984,7 @@ export namespace useSuspenseFragment {
         export type Options<TData, TVariables extends OperationVariables> = {
             fragment: DocumentNode_2 | TypedDocumentNode_2<TData, TVariables>;
             fragmentName?: string;
-            from: From<TData>;
+            from: From_2<TData>;
             optimistic?: boolean;
             client?: ApolloClient;
         };
@@ -1090,7 +1135,8 @@ export type UseSuspenseQueryResult<TData = unknown, TVariables extends Operation
 
 // Warnings were encountered during analysis:
 //
-// src/react/hooks/useSuspenseFragment.ts:111:5 - (ae-forgotten-export) The symbol "From" needs to be exported by the entry point index.d.ts
+// src/react/hooks/useFragment.ts:148:5 - (ae-forgotten-export) The symbol "From" needs to be exported by the entry point index.d.ts
+// src/react/hooks/useSuspenseFragment.ts:144:5 - (ae-forgotten-export) The symbol "From_2" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

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

@@ -4,14 +4,14 @@
 
 ```ts
 
+import type { ApolloCache } from '@apollo/client';
 import type { ApolloClient } from '@apollo/client';
 import type { DataState } from '@apollo/client';
 import type { DecoratedPromise } from '@apollo/client/utilities/internal';
 import type { DocumentNode } from 'graphql';
 import type { InternalTypes } from '@apollo/client/react';
 import type { MaybeMasked } from '@apollo/client/masking';
 import type { MaybeMasked as MaybeMasked_2 } from '@apollo/client';
-import type { Observable } from 'rxjs';
 import type { ObservableQuery } from '@apollo/client';
 import type { OperationVariables } from '@apollo/client';
 
@@ -35,7 +35,7 @@ export type FetchMoreFunction<TData, TVariables extends OperationVariables> = <T
 
 // @public (undocumented)
 type FragmentCacheKey = [
-cacheId: string,
+cacheId: string | Array<string | null>,
 fragment: DocumentNode,
 stringifiedVariables: string
 ];
@@ -50,7 +50,7 @@ export interface FragmentKey {
 class FragmentReference<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
     // Warning: (ae-forgotten-export) The symbol "FragmentReferenceOptions" needs to be exported by the entry point index.d.ts
     constructor(client: ApolloClient, watchFragmentOptions: ApolloClient.WatchFragmentOptions<TData, TVariables> & {
-        from: string;
+        from: string | Array<string | null>;
     }, options: FragmentReferenceOptions);
     // (undocumented)
     readonly key: FragmentKey;
@@ -59,12 +59,14 @@ class FragmentReference<TData = unknown, TVariables extends OperationVariables =
     // (undocumented)
     listen(listener: Listener_2<MaybeMasked<TData>>): () => void;
     // (undocumented)
-    readonly observable: Observable<ApolloClient.WatchFragmentResult<TData>>;
+    readonly observable: ApolloClient.ObservableFragment<TData>;
     // Warning: (ae-forgotten-export) The symbol "FragmentRefPromise" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     promise: FragmentRefPromise<MaybeMasked<TData>>;
     // (undocumented)
+    reobserve(options: ApolloCache.WatchFragmentReobserveOptions<any>): void;
+    // (undocumented)
     retain(): () => void;
 }
 
@@ -203,7 +205,7 @@ class SuspenseCache {
     //
     // (undocumented)
     getFragmentRef<TData, TVariables extends OperationVariables>(cacheKey: FragmentCacheKey, client: ApolloClient, options: ApolloClient.WatchFragmentOptions<TData, TVariables> & {
-        from: string;
+        from: string | Array<string | null>;
     }): FragmentReference<TData, TVariables>;
     // (undocumented)
     getQueryRef<TData = unknown, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]>(cacheKey: CacheKey, createObservable: () => ObservableQuery<TData>): InternalQueryReference<TData, TStates>;

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

@@ -66,7 +66,7 @@ export function concatPagination<T = Reference_2>(keyArgs?: KeyArgs): FieldPolic
 // Warning: (ae-forgotten-export) The symbol "DeepPartialObject" needs to be exported by the entry point index.d.ts
 //
 // @public
-export type DeepPartial<T> = T extends DeepPartialPrimitive ? T : T extends Map<infer TKey, infer TValue> ? DeepPartialMap<TKey, TValue> : T extends ReadonlyMap<infer TKey, infer TValue> ? DeepPartialReadonlyMap<TKey, TValue> : T extends Set<infer TItem> ? DeepPartialSet<TItem> : T extends ReadonlySet<infer TItem> ? DeepPartialReadonlySet<TItem> : T extends (...args: any[]) => unknown ? T | undefined : T extends object ? T extends (ReadonlyArray<infer TItem>) ? TItem[] extends (T) ? readonly TItem[] extends T ? ReadonlyArray<DeepPartial<TItem | undefined>> : Array<DeepPartial<TItem | undefined>> : DeepPartialObject<T> : DeepPartialObject<T> : unknown;
+export type DeepPartial<T> = T extends DeepPartialPrimitive ? T : T extends Map<infer TKey, infer TValue> ? DeepPartialMap<TKey, TValue> : T extends ReadonlyMap<infer TKey, infer TValue> ? DeepPartialReadonlyMap<TKey, TValue> : T extends Set<infer TItem> ? DeepPartialSet<TItem> : T extends ReadonlySet<infer TItem> ? DeepPartialReadonlySet<TItem> : T extends (...args: any[]) => unknown ? T | undefined : T extends object ? T extends (ReadonlyArray<infer TItem>) ? TItem[] extends (T) ? readonly TItem[] extends T ? ReadonlyArray<DeepPartial<TItem>> : Array<DeepPartial<TItem>> : DeepPartialObject<T> : DeepPartialObject<T> : unknown;
 
 // @public (undocumented)
 type DeepPartialMap<TKey, TValue> = {} & Map<DeepPartial<TKey>, DeepPartial<TValue>>;

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

@@ -18,7 +18,7 @@ import type { HKT } from '@apollo/client/utilities';
 import type { InlineFragmentNode } from 'graphql';
 import type { MaybeMasked } from '@apollo/client';
 import type { NetworkStatus } from '@apollo/client';
-import type { Observable } from 'rxjs';
+import { Observable } from 'rxjs';
 import type { ObservableQuery } from '@apollo/client';
 import type { Observer } from 'rxjs';
 import type { OperationDefinitionNode } from 'graphql';
@@ -74,6 +74,9 @@ export const checkDocument: (doc: DocumentNode, expectedType?: OperationTypeNode
 // @internal @deprecated
 export function cloneDeep<T>(value: T): T;
 
+// @public
+export function combineLatestBatched<T>(observables: Array<Observable<T>>): Observable<T[]>;
+
 // Warning: (ae-forgotten-export) The symbol "TupleToIntersection" needs to be exported by the entry point index.d.ts
 //
 // @internal @deprecated