@apollo/client 4.2.3 → 4.3.0-alpha.1

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @apollo/client
 
+## 4.3.0-alpha.1
+
+### Patch Changes
+
+- [#13268](https://github.com/apollographql/apollo-client/pull/13268) [`419e2b5`](https://github.com/apollographql/apollo-client/commit/419e2b5bfe573d1eb4c3a0ff7aa9084e6aaa2f37) Thanks [@DaleSeo](https://github.com/DaleSeo)! - Align the remaining cache generic constraints with `Cache.Implementation`. The deprecated React mutation types (`MutationHookOptions`, `MutationFunctionOptions`, `MutationTuple`) and the internal `InternalRefetchQueriesOptions` and `QueryInfo` types still constrained their cache type parameter to `ApolloCache`, so they now match the rest of the overridable cache API.
+
+## 4.3.0-alpha.0
+
+### Minor Changes
+
+- [#13250](https://github.com/apollographql/apollo-client/pull/13250) [`bad7035`](https://github.com/apollographql/apollo-client/commit/bad7035565e15c18800080d9e0abf1d89b3d82fa) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Add the ability to define the cache type for the client. `client.cache` currently returns `ApolloCache` as the cache type regardless of what cache you've provided to `ApolloClient`.
+
+  Declare the cache type using the `cache` property in the `TypeOverrides` interface to set the cache implementation used for the client.
+
+  ```ts
+  // apollo.d.ts
+  import type { InMemoryCache } from "@apollo/client";
+
+  declare module "@apollo/client" {
+    export interface TypeOverrides {
+      cache: InMemoryCache;
+    }
+  }
+  ```
+
+  Now anywhere `cache` is accessible, the type is the declared cache type:
+
+  ```ts
+  client.cache;
+  //     ^? InMemoryCache
+
+  client.mutate({
+    update: (cache) => {
+      //     ^? InMemoryCache
+    },
+  });
+  ```
+
+  > [!NOTE]
+  > Setting a cache type enforces that cache type in the `cache` option for the `ApolloClient` constructor.
+
 ## 4.2.3
 
 ### Patch Changes

package/__cjs/cache/core/types/Cache.d.cts

@@ -1,10 +1,13 @@
-import type { DataValue, DocumentNode, OperationVariables, TypedDocumentNode } from "@apollo/client";
+import type { DataValue, DocumentNode, OperationVariables, TypedDocumentNode, TypeOverrides } from "@apollo/client";
 import type { Unmasked } from "@apollo/client/masking";
 import type { ExtensionsWithStreamInfo } from "@apollo/client/utilities/internal";
 import type { ApolloCache } from "../cache.cjs";
 import type { AllFieldsModifier, MissingFieldError, Modifiers } from "./common.cjs";
 export declare namespace Cache {
     type WatchCallback<TData = unknown> = (diff: Cache.DiffResult<TData>, lastDiff?: Cache.DiffResult<TData>) => void;
+    type Implementation = TypeOverrides extends {
+        cache: infer TCache;
+    } ? TCache extends ApolloCache ? TCache : "The cache type declared in TypeOverrides does not extend `ApolloCache` and cannot be used with Apollo Client. See https://www.apollographql.com/docs/react/data/typescript#declaring-the-cache-type." : ApolloCache;
     interface ReadOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
         /**
          * The GraphQL query shape to be used constructed using the `gql` template
@@ -80,7 +83,7 @@ export declare namespace Cache {
         optimistic?: boolean;
         broadcast?: boolean;
     }
-    interface BatchOptions<TCache extends ApolloCache, TUpdateResult = void> {
+    interface BatchOptions<TCache extends Cache.Implementation, TUpdateResult = void> {
         /**
          * A function that performs cache operations. Receives the cache instance as its argument.
          *