BREAKING Requires @apollo/client 3.13.1

PowerKiKi · PowerKiKi · commit 6d3d5ba67a5a · 2025-02-17T15:35:16.000+09:00
- Requires `@apollo/client` 3.13.1
- Dropped `SubscriptionResult`, because it added extra maintenance work to
keep native types in sync, and it brought no value over using native
type.
    ```diff
    - import type { SubscriptionResult } from 'apollo-angular';
    + import type { FetchResult } from '@apollo/client/core';
    ```
- Most methods of `QueryRef` forward types from `@apollo/client`. That
should allow always using correct types from whichever `@apollo/client`
version is installed without needing to touch `apollo-angular`.
- `QueryRef.valueChanges` and `QueryRef.queryId` are readonly, because
there is no reason for those to be re-affected.
diff --git a/.changeset/khaki-worms-lick.md b/.changeset/khaki-worms-lick.md
@@ -0,0 +1,18 @@
+---
+'apollo-angular': major
+---
+
+- Requires `@apollo/client` 3.13.1
+- Dropped `SubscriptionResult`, because it added extra maintenance work to
+keep native types in sync, and it brought no value over using native
+type.
+    ```diff
+    - import type { SubscriptionResult } from 'apollo-angular';
+    + import type { FetchResult } from '@apollo/client/core';
+    ```
+- Most methods of `QueryRef` forward types from `@apollo/client`. That
+should allow always using correct types from whichever `@apollo/client`
+version is installed without needing to touch `apollo-angular`.
+- `QueryRef.valueChanges` and `QueryRef.queryId` are readonly, because
+there is no reason for those to be re-affected.
+
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "@angular/platform-browser-dynamic": "^18.0.0",
     "@angular/platform-server": "^18.0.0",
     "@angular/router": "^18.0.0",
-    "@apollo/client": "^3.10.4",
+    "@apollo/client": "^3.13.1",
     "@babel/core": "^7.24.6",
     "@babel/preset-env": "^7.24.6",
     "@changesets/changelog-github": "^0.5.0",
diff --git a/packages/apollo-angular/package.json b/packages/apollo-angular/package.json
@@ -35,7 +35,7 @@
   },
   "peerDependencies": {
     "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "@apollo/client": "^3.10.0",
+    "@apollo/client": "^3.13.1",
     "graphql": "^15.0.0 || ^16.0.0",
     "rxjs": "^6.0.0 || ^7.0.0"
   },
diff --git a/packages/apollo-angular/src/index.ts b/packages/apollo-angular/src/index.ts
@@ -15,7 +15,6 @@ export type {
   QueryOptionsAlone,
   ResultOf,
   SubscriptionOptionsAlone,
-  SubscriptionResult,
   VariablesOf,
   WatchQueryOptions,
   WatchQueryOptionsAlone,
diff --git a/packages/apollo-angular/src/query-ref.ts b/packages/apollo-angular/src/query-ref.ts
@@ -1,14 +1,11 @@
 import { from, Observable } from 'rxjs';
 import { NgZone } from '@angular/core';
 import type {
-  ApolloError,
   ApolloQueryResult,
-  FetchMoreQueryOptions,
   ObservableQuery,
   OperationVariables,
   SubscribeToMoreOptions,
   TypedDocumentNode,
-  UpdateQueryOptions,
 } from '@apollo/client/core';
 import { NetworkStatus } from '@apollo/client/core';
 import { EmptyObject, WatchQueryOptions } from './types';
@@ -46,14 +43,14 @@ function useInitialLoading<T, V extends OperationVariables>(obsQuery: Observable
 export type QueryRefFromDocument<T extends TypedDocumentNode> =
   T extends TypedDocumentNode<infer R, infer V> ? QueryRef<R, V & OperationVariables> : never;
 
-export class QueryRef<T, V extends OperationVariables = EmptyObject> {
-  public valueChanges: Observable<ApolloQueryResult<T>>;
-  public queryId: ObservableQuery<T, V>['queryId'];
+export class QueryRef<TData, TVariables extends OperationVariables = EmptyObject> {
+  public readonly valueChanges: Observable<ApolloQueryResult<TData>>;
+  public readonly queryId: ObservableQuery<TData, TVariables>['queryId'];
 
   constructor(
-    private readonly obsQuery: ObservableQuery<T, V>,
+    private readonly obsQuery: ObservableQuery<TData, TVariables>,
     ngZone: NgZone,
-    options: WatchQueryOptions<V, T>,
+    options: WatchQueryOptions<TVariables, TData>,
   ) {
     const wrapped = wrapWithZone(from(fixObservable(this.obsQuery)), ngZone);
 
@@ -65,69 +62,80 @@ export class QueryRef<T, V extends OperationVariables = EmptyObject> {
 
   // ObservableQuery's methods
 
-  public get options() {
+  public get options(): ObservableQuery<TData, TVariables>['options'] {
     return this.obsQuery.options;
   }
 
-  public get variables() {
+  public get variables(): ObservableQuery<TData, TVariables>['variables'] {
     return this.obsQuery.variables;
   }
 
-  public result(): Promise<ApolloQueryResult<T>> {
+  public result(): ReturnType<ObservableQuery<TData, TVariables>['result']> {
     return this.obsQuery.result();
   }
 
-  public getCurrentResult(): ApolloQueryResult<T> {
+  public getCurrentResult(): ReturnType<ObservableQuery<TData, TVariables>['getCurrentResult']> {
     return this.obsQuery.getCurrentResult();
   }
 
-  public getLastResult(): ApolloQueryResult<T> | undefined {
+  public getLastResult(): ReturnType<ObservableQuery<TData, TVariables>['getLastResult']> {
     return this.obsQuery.getLastResult();
   }
 
-  public getLastError(): ApolloError | undefined {
+  public getLastError(): ReturnType<ObservableQuery<TData, TVariables>['getLastError']> {
     return this.obsQuery.getLastError();
   }
 
-  public resetLastResults(): void {
+  public resetLastResults(): ReturnType<ObservableQuery<TData, TVariables>['resetLastResults']> {
     return this.obsQuery.resetLastResults();
   }
 
-  public refetch(variables?: V): Promise<ApolloQueryResult<T>> {
+  public refetch(
+    variables?: Parameters<ObservableQuery<TData, TVariables>['refetch']>[0],
+  ): ReturnType<ObservableQuery<TData, TVariables>['refetch']> {
     return this.obsQuery.refetch(variables);
   }
 
-  public fetchMore<K = V>(
-    fetchMoreOptions: FetchMoreQueryOptions<K, T>,
-  ): Promise<ApolloQueryResult<T>> {
+  public fetchMore<TFetchVars extends OperationVariables = TVariables>(
+    fetchMoreOptions: Parameters<QueryRef<TData, TFetchVars>['obsQuery']['fetchMore']>[0],
+  ): ReturnType<QueryRef<TData, TFetchVars>['obsQuery']['fetchMore']> {
     return this.obsQuery.fetchMore(fetchMoreOptions);
   }
 
-  public subscribeToMore<MT = any, MV = EmptyObject>(
-    options: SubscribeToMoreOptions<T, MV, MT>,
-  ): () => void {
-    // XXX: there's a bug in apollo-client typings
-    // it should not inherit types from ObservableQuery
-    return this.obsQuery.subscribeToMore(options as any);
+  public subscribeToMore<
+    TSubscriptionData = TData,
+    TSubscriptionVariables extends OperationVariables = TVariables,
+  >(
+    options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>,
+  ): ReturnType<ObservableQuery<TData, TVariables>['subscribeToMore']> {
+    return this.obsQuery.subscribeToMore(options);
   }
 
-  public updateQuery(mapFn: (previousQueryResult: T, options: UpdateQueryOptions<V>) => T): void {
+  public updateQuery(
+    mapFn: Parameters<ObservableQuery<TData, TVariables>['updateQuery']>[0],
+  ): ReturnType<ObservableQuery<TData, TVariables>['updateQuery']> {
     return this.obsQuery.updateQuery(mapFn);
   }
 
-  public stopPolling(): void {
+  public stopPolling(): ReturnType<ObservableQuery<TData, TVariables>['stopPolling']> {
     return this.obsQuery.stopPolling();
   }
 
-  public startPolling(pollInterval: number): void {
+  public startPolling(
+    pollInterval: Parameters<ObservableQuery<TData, TVariables>['startPolling']>[0],
+  ): ReturnType<ObservableQuery<TData, TVariables>['startPolling']> {
     return this.obsQuery.startPolling(pollInterval);
   }
 
-  public setOptions(opts: Partial<WatchQueryOptions<V, T>>) {
+  public setOptions(
+    opts: Parameters<ObservableQuery<TData, TVariables>['setOptions']>[0],
+  ): ReturnType<ObservableQuery<TData, TVariables>['setOptions']> {
     return this.obsQuery.setOptions(opts);
   }
 
-  public setVariables(variables: V) {
+  public setVariables(
+    variables: Parameters<ObservableQuery<TData, TVariables>['setVariables']>[0],
+  ): ReturnType<ObservableQuery<TData, TVariables>['setVariables']> {
     return this.obsQuery.setVariables(variables);
   }
 }
diff --git a/packages/apollo-angular/src/subscription.ts b/packages/apollo-angular/src/subscription.ts
@@ -1,14 +1,9 @@
 import type { DocumentNode } from 'graphql';
 import type { Observable } from 'rxjs';
 import { Injectable } from '@angular/core';
-import type { OperationVariables, TypedDocumentNode } from '@apollo/client/core';
+import type { FetchResult, OperationVariables, TypedDocumentNode } from '@apollo/client/core';
 import { Apollo } from './apollo';
-import {
-  EmptyObject,
-  ExtraSubscriptionOptions,
-  SubscriptionOptionsAlone,
-  SubscriptionResult,
-} from './types';
+import { EmptyObject, ExtraSubscriptionOptions, SubscriptionOptionsAlone } from './types';
 
 @Injectable()
 export abstract class Subscription<T = any, V extends OperationVariables = EmptyObject> {
@@ -21,7 +16,7 @@ export abstract class Subscription<T = any, V extends OperationVariables = Empty
     variables?: V,
     options?: SubscriptionOptionsAlone<V, T>,
     extra?: ExtraSubscriptionOptions,
-  ): Observable<SubscriptionResult<T>> {
+  ): Observable<FetchResult<T>> {
     return this.apollo.use(this.client).subscribe<T, V>(
       {
         ...options,
diff --git a/packages/apollo-angular/src/types.ts b/packages/apollo-angular/src/types.ts
@@ -1,4 +1,3 @@
-import type { ExecutionResult } from 'graphql';
 import type {
   ApolloClientOptions,
   MutationOptions as CoreMutationOptions,
@@ -69,8 +68,6 @@ export interface MutationOptions<TData = any, TVariables = EmptyObject>
 export interface WatchFragmentOptions<TData = any, TVariables = EmptyObject>
   extends CoreWatchFragmentOptions<TData, TVariables> {}
 
-export interface SubscriptionResult<TData> extends ExecutionResult<TData> {}
-
 export type NamedOptions = Record<string, ApolloClientOptions<any>>;
 
 export type Flags = {
diff --git a/yarn.lock b/yarn.lock
@@ -251,10 +251,10 @@
   dependencies:
     tslib "^2.3.0"
 
-"@apollo/client@^3.10.4":
-  version "3.10.8"
-  resolved "https://registry.yarnpkg.com/@apollo/client/-/client-3.10.8.tgz#96b1548818e45fac752ec2bd318e5466d9ca26b5"
-  integrity sha512-UaaFEitRrPRWV836wY2L7bd3HRCfbMie1jlYMcmazFAK23MVhz/Uq7VG1nwbotPb5xzFsw5RF4Wnp2G3dWPM3g==
+"@apollo/client@^3.13.1":
+  version "3.13.1"
+  resolved "https://registry.yarnpkg.com/@apollo/client/-/client-3.13.1.tgz#c0633c69c5446967b0e517a590595eeea61dd176"
+  integrity sha512-HaAt62h3jNUXpJ1v5HNgUiCzPP1c5zc2Q/FeTb2cTk/v09YlhoqKKHQFJI7St50VCJ5q8JVIc03I5bRcBrQxsg==
   dependencies:
     "@graphql-typed-document-node/core" "^3.1.1"
     "@wry/caches" "^1.0.0"
@@ -265,7 +265,6 @@
     optimism "^0.18.0"
     prop-types "^15.7.2"
     rehackt "^0.1.0"
-    response-iterator "^0.2.6"
     symbol-observable "^4.0.0"
     ts-invariant "^0.10.3"
     tslib "^2.3.0"
@@ -3436,13 +3435,6 @@
   dependencies:
     tslib "^2.3.0"
 
-"@wry/trie@^0.4.3":
-  version "0.4.3"
-  resolved "https://registry.yarnpkg.com/@wry/trie/-/trie-0.4.3.tgz#077d52c22365871bf3ffcbab8e95cb8bc5689af4"
-  integrity sha512-I6bHwH0fSf6RqQcnnXLJKhkSXG45MFral3GxPaY4uAl0LYDZM+YDVDAiU9bYwjTuysy1S0IeecWtmq1SZA3M1w==
-  dependencies:
-    tslib "^2.3.0"
-
 "@wry/trie@^0.5.0":
   version "0.5.0"
   resolved "https://registry.yarnpkg.com/@wry/trie/-/trie-0.5.0.tgz#11e783f3a53f6e4cd1d42d2d1323f5bc3fa99c94"
@@ -9494,13 +9486,13 @@ opener@^1.5.2:
   integrity sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==
 
 optimism@^0.18.0:
-  version "0.18.0"
-  resolved "https://registry.yarnpkg.com/optimism/-/optimism-0.18.0.tgz#e7bb38b24715f3fdad8a9a7fc18e999144bbfa63"
-  integrity sha512-tGn8+REwLRNFnb9WmcY5IfpOqeX2kpaYJ1s6Ae3mn12AeydLkR3j+jSCmVQFoXqU8D41PAJ1RG1rCRNWmNZVmQ==
+  version "0.18.1"
+  resolved "https://registry.yarnpkg.com/optimism/-/optimism-0.18.1.tgz#5cf16847921413dbb0ac809907370388b9c6335f"
+  integrity sha512-mLXNwWPa9dgFyDqkNi54sjDyNJ9/fTI6WGBLgnXku1vdKY/jovHfZT5r+aiVeFFLOz+foPNOm5YJ4mqgld2GBQ==
   dependencies:
     "@wry/caches" "^1.0.0"
     "@wry/context" "^0.7.0"
-    "@wry/trie" "^0.4.3"
+    "@wry/trie" "^0.5.0"
     tslib "^2.3.0"
 
 ora@5.4.1, ora@^5.1.0, ora@^5.4.1:
@@ -10677,11 +10669,6 @@ resolve@1.22.8, resolve@^1.1.6, resolve@^1.1.7, resolve@^1.12.0, resolve@^1.14.2
     path-parse "^1.0.7"
     supports-preserve-symlinks-flag "^1.0.0"
 
-response-iterator@^0.2.6:
-  version "0.2.6"
-  resolved "https://registry.yarnpkg.com/response-iterator/-/response-iterator-0.2.6.tgz#249005fb14d2e4eeb478a3f735a28fd8b4c9f3da"
-  integrity sha512-pVzEEzrsg23Sh053rmDUvLSkGXluZio0qu8VT6ukrYuvtjVfCbDZH9d6PGXb8HZfzdNZt8feXv/jvUzlhRgLnw==
-
 restore-cursor@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-3.1.0.tgz#39f67c54b3a7a58cea5236d95cf0034239631f7e"
@@ -11351,7 +11338,16 @@ string-length@^4.0.1:
     char-regex "^1.0.2"
     strip-ansi "^6.0.0"
 
-"string-width-cjs@npm:string-width@^4.2.0", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3:
+"string-width-cjs@npm:string-width@^4.2.0":
+  version "4.2.3"
+  resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
+  integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
+  dependencies:
+    emoji-regex "^8.0.0"
+    is-fullwidth-code-point "^3.0.0"
+    strip-ansi "^6.0.1"
+
+string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3:
   version "4.2.3"
   resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
   integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
@@ -11393,7 +11389,14 @@ stringify-entities@^4.0.0:
     character-entities-html4 "^2.0.0"
     character-entities-legacy "^3.0.0"
 
-"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1:
+"strip-ansi-cjs@npm:strip-ansi@^6.0.1":
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
+  integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
+  dependencies:
+    ansi-regex "^5.0.1"
+
+strip-ansi@^6.0.0, strip-ansi@^6.0.1:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
   integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
@@ -12454,7 +12457,7 @@ wildcard@^2.0.0:
   resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67"
   integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==
 
-"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0:
+"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0":
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
   integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
