Merge pull request #468 from apollographql/main

Create a new pull request by comparing changes across two branches

Author: GulajavaMinistudio

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

@@ -1692,6 +1692,8 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
     hasObservers(): boolean;
     // (undocumented)
     isDifferentFromLastResult(newResult: ApolloQueryResult<TData>, variables?: TVariables): boolean | undefined;
+    // @internal (undocumented)
+    protected notify(): void;
     // (undocumented)
     readonly options: WatchQueryOptions<TVariables, TData>;
     // (undocumented)
@@ -1711,6 +1713,8 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
     resetDiff(): void;
     // (undocumented)
     resetLastResults(): void;
+    // @internal (undocumented)
+    protected resetNotifications(): void;
     // (undocumented)
     resetQueryStoreErrors(): void;
     // (undocumented)
@@ -1719,15 +1723,17 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
     resubscribeAfterError(observer: Observer<ApolloQueryResult<TData>>): ObservableSubscription;
     // (undocumented)
     result(): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    // @internal (undocumented)
+    protected scheduleNotify(): void;
     // (undocumented)
     setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
     setVariables(variables: TVariables): Promise<ApolloQueryResult<MaybeMasked<TData>> | void>;
     // (undocumented)
     silentSetOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): void;
     startPolling(pollInterval: number): void;
     stopPolling(): void;
-    subscribeToMore<TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData>): () => void;
-    updateQuery<TVars extends OperationVariables = TVariables>(mapFn: (previousQueryResult: Unmasked<TData>, options: Pick<WatchQueryOptions<TVars, TData>, "variables">) => Unmasked<TData>): void;
+    subscribeToMore<TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>): () => void;
+    updateQuery(mapFn: UpdateQueryMapFn<TData, TVariables>): void;
     get variables(): TVariables | undefined;
 }
 
@@ -1864,8 +1870,6 @@ class QueryInfo {
     // (undocumented)
     lastRequestId: number;
     // (undocumented)
-    listeners: Set<QueryListener>;
-    // (undocumented)
     markError(error: ApolloError): ApolloError;
     // (undocumented)
     markReady(): NetworkStatus;
@@ -1878,14 +1882,10 @@ class QueryInfo {
     // (undocumented)
     networkStatus?: NetworkStatus;
     // (undocumented)
-    notify(): void;
-    // (undocumented)
     readonly observableQuery: ObservableQuery<any, any> | null;
     // (undocumented)
     readonly queryId: string;
     // (undocumented)
-    reset(): void;
-    // (undocumented)
     resetDiff(): void;
     // (undocumented)
     resetLastWrite(): void;
@@ -1901,9 +1901,6 @@ class QueryInfo {
     variables?: Record<string, any>;
 }
 
-// @public (undocumented)
-export type QueryListener = (queryInfo: QueryInfo) => void;
-
 // @public (undocumented)
 class QueryManager<TStore> {
     // Warning: (ae-forgotten-export) The symbol "QueryManagerOptions" needs to be exported by the entry point index.d.ts
@@ -1944,6 +1941,8 @@ class QueryManager<TStore> {
     getLocalState(): LocalState<TStore>;
     // (undocumented)
     getObservableQueries(include?: InternalRefetchQueriesInclude): Map<string, ObservableQuery<any, OperationVariables>>;
+    // (undocumented)
+    getOrCreateQuery(queryId: string): QueryInfo;
     // Warning: (ae-forgotten-export) The symbol "QueryStoreValue" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -2008,8 +2007,6 @@ class QueryManager<TStore> {
     // (undocumented)
     resetErrors(queryId: string): void;
     // (undocumented)
-    setObservableQuery(observableQuery: ObservableQuery<any, any>): void;
-    // (undocumented)
     readonly ssrMode: boolean;
     // (undocumented)
     startGraphQLSubscription<T = any>(options: SubscriptionOptions): Observable<FetchResult<T>>;
@@ -2317,12 +2314,33 @@ class Stump extends Layer {
 }
 
 // @public (undocumented)
-export type SubscribeToMoreOptions<TData = any, TSubscriptionVariables = OperationVariables, TSubscriptionData = TData> = {
+export interface SubscribeToMoreFunction<TData, TVariables extends OperationVariables = OperationVariables> {
+    // (undocumented)
+    <TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>): () => void;
+}
+
+// @public (undocumented)
+export interface SubscribeToMoreOptions<TData = any, TSubscriptionVariables extends OperationVariables = OperationVariables, TSubscriptionData = TData, TVariables extends OperationVariables = TSubscriptionVariables> {
+    // (undocumented)
+    context?: DefaultContext;
+    // (undocumented)
     document: DocumentNode | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;
-    variables?: TSubscriptionVariables;
-    updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>;
+    // (undocumented)
     onError?: (error: Error) => void;
-    context?: DefaultContext;
+    // (undocumented)
+    updateQuery?: SubscribeToMoreUpdateQueryFn<TData, TVariables, TSubscriptionData>;
+    // (undocumented)
+    variables?: TSubscriptionVariables;
+}
+
+// @public (undocumented)
+export type SubscribeToMoreUpdateQueryFn<TData = any, TVariables extends OperationVariables = OperationVariables, TSubscriptionData = TData> = {
+    (
+    unsafePreviousData: Unmasked<TData>, options: UpdateQueryOptions<TData, TVariables> & {
+        subscriptionData: {
+            data: Unmasked<TSubscriptionData>;
+        };
+    }): Unmasked<TData> | void;
 };
 
 // @public (undocumented)
@@ -2421,18 +2439,22 @@ type UnwrapFragmentRefs<TData> = true extends IsAny<TData> ? TData : TData exten
 type UpdateQueries<TData> = MutationOptions<TData, any, any>["updateQueries"];
 
 // @public (undocumented)
-type UpdateQueryFn<TData = any, TSubscriptionVariables = OperationVariables, TSubscriptionData = TData> = (previousQueryResult: Unmasked<TData>, options: {
-    subscriptionData: {
-        data: Unmasked<TSubscriptionData>;
-    };
-    variables?: TSubscriptionVariables;
-}) => Unmasked<TData>;
+export interface UpdateQueryMapFn<TData = any, TVariables = OperationVariables> {
+    // (undocumented)
+    (
+    unsafePreviousData: Unmasked<TData>, options: UpdateQueryOptions<TData, TVariables>): Unmasked<TData> | void;
+}
 
 // @public (undocumented)
-export interface UpdateQueryOptions<TVariables> {
-    // (undocumented)
+export type UpdateQueryOptions<TData, TVariables> = {
     variables?: TVariables;
-}
+} & ({
+    complete: true;
+    previousData: Unmasked<TData>;
+} | {
+    complete: false;
+    previousData: DeepPartial<Unmasked<TData>> | undefined;
+});
 
 // @public (undocumented)
 export interface UriFunction {
@@ -2508,11 +2530,10 @@ interface WriteContext extends ReadMergeModifyContext {
 // src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
-// src/core/ObservableQuery.ts:120:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
-// src/core/ObservableQuery.ts:121:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
+// src/core/ObservableQuery.ts:128:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
+// src/core/ObservableQuery.ts:129:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
 // src/core/QueryManager.ts:159:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
 // src/core/QueryManager.ts:414:7 - (ae-forgotten-export) The symbol "UpdateQueries" needs to be exported by the entry point index.d.ts
-// src/core/watchQueryOptions.ts:277:2 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
 // src/link/http/selectHttpOptionsAndBody.ts:128:32 - (ae-forgotten-export) The symbol "HttpQueryOptions" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)