watchFragment fixes (#11754)

apollographql · Apr 4, 2024 · 80d2ba5 · 80d2ba5
1 parent 4cbd229
commit 80d2ba5
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 15 deletions.
diff --git a/.api-reports/api-report-cache.md b/.api-reports/api-report-cache.md
@@ -65,8 +65,6 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
     // (undocumented)
     abstract watch<TData = any, TVariables = any>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
     // Warning: (ae-forgotten-export) The symbol "OperationVariables" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentOptions" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentResult" needs to be exported by the entry point index.d.ts
     watchFragment<TData = any, TVars = OperationVariables>(options: WatchFragmentOptions<TData, TVars>): Observable<WatchFragmentResult<TData>>;
     // (undocumented)
     abstract write<TData = any, TVariables = any>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
@@ -977,7 +975,7 @@ export type TypePolicy = {
 };
 
 // @public
-interface WatchFragmentOptions<TData, TVars> {
+export interface WatchFragmentOptions<TData, TVars> {
     // @deprecated (undocumented)
     canonizeResults?: boolean;
     fragment: DocumentNode | TypedDocumentNode<TData, TVars>;
@@ -988,7 +986,7 @@ interface WatchFragmentOptions<TData, TVars> {
 }
 
 // @public
-type WatchFragmentResult<TData> = {
+export type WatchFragmentResult<TData> = {
     data: TData;
     complete: true;
     missing?: never;

diff --git a/.api-reports/api-report-core.md b/.api-reports/api-report-core.md
@@ -79,8 +79,6 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
     updateQuery<TData = any, TVariables = any>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: TData | null) => TData | null | void): TData | null;
     // (undocumented)
     abstract watch<TData = any, TVariables = any>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentOptions" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentResult" needs to be exported by the entry point index.d.ts
     watchFragment<TData = any, TVars = OperationVariables>(options: WatchFragmentOptions<TData, TVars>): Observable<WatchFragmentResult<TData>>;
     // (undocumented)
     abstract write<TData = any, TVariables = any>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
@@ -2213,7 +2211,7 @@ export interface UriFunction {
 }
 
 // @public
-interface WatchFragmentOptions<TData, TVars> {
+export interface WatchFragmentOptions<TData, TVars> {
     // @deprecated (undocumented)
     canonizeResults?: boolean;
     fragment: DocumentNode | TypedDocumentNode<TData, TVars>;
@@ -2224,7 +2222,7 @@ interface WatchFragmentOptions<TData, TVars> {
 }
 
 // @public
-type WatchFragmentResult<TData> = {
+export type WatchFragmentResult<TData> = {
     data: TData;
     complete: true;
     missing?: never;

diff --git a/.api-reports/api-report.md b/.api-reports/api-report.md
@@ -81,8 +81,6 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
     updateQuery<TData = any, TVariables = any>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: TData | null) => TData | null | void): TData | null;
     // (undocumented)
     abstract watch<TData = any, TVariables = any>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentOptions" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "WatchFragmentResult" needs to be exported by the entry point index.d.ts
     watchFragment<TData = any, TVars = OperationVariables>(options: WatchFragmentOptions<TData, TVars>): Observable<WatchFragmentResult<TData>>;
     // (undocumented)
     abstract write<TData = any, TVariables = any>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
@@ -3023,7 +3021,7 @@ TVariables
 };
 
 // @public
-interface WatchFragmentOptions<TData, TVars> {
+export interface WatchFragmentOptions<TData, TVars> {
     // @deprecated (undocumented)
     canonizeResults?: boolean;
     fragment: DocumentNode | TypedDocumentNode<TData, TVars>;
@@ -3034,7 +3032,7 @@ interface WatchFragmentOptions<TData, TVars> {
 }
 
 // @public
-type WatchFragmentResult<TData> = {
+export type WatchFragmentResult<TData> = {
     data: TData;
     complete: true;
     missing?: never;

diff --git a/.changeset/old-onions-sleep.md b/.changeset/old-onions-sleep.md
@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Export `WatchFragmentOptions` and `WatchFragmentResult` from main entrypoint and fix bug where `this` wasn't bound to the `watchFragment` method on `ApolloClient`.
diff --git a/.size-limits.json b/.size-limits.json
@@ -1,4 +1,4 @@
 {
-  "dist/apollo-client.min.cjs": 39510,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32799
+  "dist/apollo-client.min.cjs": 39518,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32809
 }
diff --git a/src/cache/index.ts b/src/cache/index.ts
@@ -1,6 +1,10 @@
 import "../utilities/globals/index.js";
 
-export type { Transaction } from "./core/cache.js";
+export type {
+  Transaction,
+  WatchFragmentOptions,
+  WatchFragmentResult,
+} from "./core/cache.js";
 export { ApolloCache } from "./core/cache.js";
 export { Cache } from "./core/types/Cache.js";
 export type { DataProxy } from "./core/types/DataProxy.js";

diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts
@@ -239,6 +239,7 @@ export class ApolloClient<TCacheShape> implements DataProxy {
     this.watchQuery = this.watchQuery.bind(this);
     this.query = this.query.bind(this);
     this.mutate = this.mutate.bind(this);
+    this.watchFragment = this.watchFragment.bind(this);
     this.resetStore = this.resetStore.bind(this);
     this.reFetchObservableQueries = this.reFetchObservableQueries.bind(this);
 

diff --git a/src/core/index.ts b/src/core/index.ts
@@ -40,6 +40,8 @@ export type {
   FieldMergeFunction,
   FieldFunctionOptions,
   PossibleTypesMap,
+  WatchFragmentOptions,
+  WatchFragmentResult,
 } from "../cache/index.js";
 export {
   Cache,