@apollo/client 4.0.0-alpha.12 → 4.0.0-alpha.14

package/.changeset/curvy-flies-accept.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+The `getCacheKey` function is no longer available from `operation.getContext()` in the link chain. Use `operation.client.cache.identify(obj)` in the link chain instead.

package/.changeset/dirty-cobras-change.md

@@ -0,0 +1,7 @@
+---
+"@apollo/client": major
+---
+
+Move most of the utilities in `@apollo/client/utilities` to `@apollo/client/utilities/internal`. Many of the utilities exported from the `@apollo/client/utilities` endpoint were not considered stable.
+
+As a result of this change, utilities or types exported from `@apollo/client/utilities` are now documented and considered stable and will not undergo breaking changes.

package/.changeset/few-crabs-move.md

@@ -0,0 +1,6 @@
+---
+"@apollo/client": major
+---
+
+`ObservableQuery` will now keep previous `data` around when emitting a `loading` state, unless `query` or `variables` changed.
+Note that `@exports` variables are not taken into account for this, so `data` will stay around even if they change.

package/.changeset/friendly-olives-refuse.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove the `@apollo/client/testing/experimental` test utilities. Use [GraphQL Testing Library](https://github.com/apollographql/graphql-testing-library) instead.

package/.changeset/funny-boats-wink.md

@@ -0,0 +1,35 @@
+---
+"@apollo/client": minor
+---
+
+Revamp local resolvers and fix several issues from the existing `resolvers` option.
+- Throwing errors in a resolver will set the field value as `null` and add an error to the response's `errors` array.
+- Remote results are dealiased before they are passed as the parent object to a resolver so that you can access fields by their field name.
+- You can now specify a `context` function that you can use to customize the `requestContext` given to resolvers.
+- The `LocalState` class accepts a `Resolvers` generic that provides autocompletion and type checking against your resolver types to ensure your resolvers are type-safe.
+- `data: null` is now handled correctly and does not call your local resolvers when the server does not provide a result.
+- Additional warnings have been added to provide hints when resolvers behave unexpectedly.
+
+```ts
+import { LocalState } from "@apollo/client/local-state";
+
+import { Resolvers } from "./path/to/local-resolvers-types.ts";
+
+// LocalState now accepts a `Resolvers` generic.
+const localState = new LocalState<Resolvers>({
+  // The return value of this funciton
+  context: (options) => ({
+    // ...
+  }),
+  resolvers: {
+    // ...
+  }
+});
+
+// You may also pass a `ContextValue` generic used to ensure the `context`
+// function returns the correct type. This type is inferred from your resolvers
+// if not provided.
+new LocalState<Resolvers, ContextValue>({
+  // ...
+});
+```

package/.changeset/fuzzy-seahorses-hunt.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Remove code that strips `@client` fields in `HttpLink` and `BatchHttpLink`. This was unused code since core handles removing `@client` fields and should have no observable change.

package/.changeset/gold-oranges-double.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Removed `getLastResult`, `getLastError` and `resetLastResults` from `ObservableQuery`

package/.changeset/little-parrots-bow.md

@@ -0,0 +1,14 @@
+---
+"@apollo/client": major
+---
+
+Removes the `resolvers` option from `ApolloClient`. Local resolvers have instead been moved to the new `LocalState` instance which is assigned to the `localState` option in `ApolloClient`. To migrate, move the `resolvers` values into a `LocalState` instance and assign that instance to `localState`.
+
+```diff
+new ApolloClient({
+- resolvers: { /* ... */ }
++ localState: new LocalState({
++   resolvers: { /* ... */ }
++ }),
+});
+```

package/.changeset/olive-cougars-ring.md

@@ -0,0 +1,9 @@
+---
+"@apollo/client": major
+---
+
+Remove local resolvers APIs from `ApolloClient` in favor of `localState`. Methods removed are:
+- `addResolvers`
+- `getResolvers`
+- `setResolvers`
+- `setLocalStateFragmentMatcher`

package/.changeset/pre.json

@@ -19,13 +19,16 @@
     "cool-bikes-shake",
     "cool-kiwis-hunt",
     "cuddly-spiders-tie",
+    "curvy-flies-accept",
     "curvy-pianos-count",
+    "dirty-cobras-change",
     "dirty-eagles-poke",
     "dirty-trees-pump",
     "early-eggs-develop",
     "eighty-squids-fix",
     "eleven-kangaroos-jump",
     "empty-rabbits-move",
+    "few-crabs-move",
     "fluffy-shoes-applaud",
     "forty-hairs-occur",
     "forty-shrimps-fry",
@@ -33,13 +36,17 @@
     "four-countries-clean",
     "four-ghosts-watch",
     "fresh-moose-hope",
+    "friendly-olives-refuse",
+    "funny-boats-wink",
     "funny-jeans-invent",
     "funny-terms-deny",
+    "fuzzy-seahorses-hunt",
     "fuzzy-tips-sit",
     "gentle-badgers-train",
     "gentle-waves-cough",
     "giant-apes-thank",
     "giant-bags-share",
+    "gold-oranges-double",
     "good-dolphins-peel",
     "gorgeous-chefs-tap",
     "great-roses-jog",
@@ -59,6 +66,7 @@
     "light-apes-rescue",
     "light-dolphins-taste",
     "light-sloths-end",
+    "little-parrots-bow",
     "little-spoons-kick",
     "loud-cows-raise",
     "lucky-hats-push",
@@ -78,6 +86,7 @@
     "ninety-bags-bake",
     "odd-chicken-hide",
     "odd-lemons-relax",
+    "olive-cougars-ring",
     "orange-suits-laugh",
     "perfect-ducks-reflect",
     "perfect-vans-give",
@@ -92,6 +101,7 @@
     "rich-eagles-cross",
     "rich-kids-carry",
     "rude-fans-study",
+    "serious-items-develop",
     "serious-moons-juggle",
     "seven-dragons-repair",
     "seven-foxes-melt",
@@ -103,6 +113,7 @@
     "short-tomatoes-attend",
     "silly-knives-exist",
     "silly-seas-confess",
+    "sixty-bats-cry",
     "slimy-chicken-melt",
     "slimy-maps-press",
     "slow-ravens-explain",
@@ -116,7 +127,10 @@
     "soft-mails-clean",
     "sour-kids-deliver",
     "sour-pillows-guess",
+    "spotty-mugs-poke",
     "strange-seahorses-impress",
+    "strong-rivers-fry",
+    "stupid-pumpkins-travel",
     "swift-rivers-share",
     "tall-bikes-develop",
     "tall-cups-suffer",
@@ -125,6 +139,7 @@
     "tender-swans-flash",
     "thick-books-grin",
     "thin-peas-hear",
+    "thirty-pens-jump",
     "tidy-pandas-punch",
     "tidy-squids-poke",
     "tough-rockets-allow",
@@ -136,6 +151,7 @@
     "unlucky-sheep-change",
     "warm-ties-sit",
     "wicked-forks-double",
+    "wicked-kiwis-buy",
     "witty-paws-marry",
     "yellow-cats-judge",
     "young-phones-fold",

package/.changeset/serious-items-develop.md

@@ -0,0 +1,17 @@
+---
+"@apollo/client": major
+---
+
+Third-party caches must now implement the `fragmentMatches` API. Additionally `fragmentMatches` must be able to handle both `InlineFragmentNode` and `FragmentDefinitionNode` nodes.
+
+```ts
+class MyCache extends ApolloCache {
+  // This is now required
+  public fragmentMatches(
+    fragment: InlineFragmentNode | FragmentDefinitionNode,
+    typename: string
+  ): boolean {
+    return // ... logic to determine if typename matches fragment
+  }
+}
+```

package/.changeset/sixty-bats-cry.md

@@ -0,0 +1,6 @@
+---
+"@apollo/client": major
+---
+
+Reworked the logic for then a loading state is triggered. If the link chain responds synchronously, a loading state will be omitted, otherwise it will be triggered.
+If local resolvers are used, the time window for "sync vs async" starts as soon as `@exports` variables are resolved.

package/.changeset/spotty-mugs-poke.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Dropped the `saveAsLastResult` argument from `ObservableQuery.getCurrentResult`

package/.changeset/strong-rivers-fry.md

@@ -0,0 +1,34 @@
+---
+"@apollo/client": major
+---
+
+The resolver function's `context` argument (the 3rd argument) has changed to provide additional information without the possibility of name clashes. Previously the `context` argument would spread request context and override the `client` and `cache` properties to give access to both inside of a resolver. The `context` argument takes now takes the following shape:
+
+```ts
+{
+  // the request context. By default `TContextValue` is of type `DefaultContext`,
+  // but can be changed if a `context` function is provided.
+  requestContext: TContextValue,
+  // The client instance making the request
+  client: ApolloClient,
+  // Whether the resolver is run as a result of gathering exported variables
+  // or resolving the value as part of the result
+  phase: "exports" | "resolve"
+}
+```
+
+To migrate, pull any request context from `requestContext` and the `cache` from the `client` property:
+
+```diff
+new LocalState({
+  resolvers: {
+    Query: {
+-     myResolver: (parent, args, { someValue, cache }) => {
++     myResolver: (parent, args, { requestContext, client }) => {
++       const someValue = requestContext.someValue;
++       const cache = client.cache;
+      }
+    }
+  }
+});
+```

package/.changeset/stupid-pumpkins-travel.md

@@ -0,0 +1,13 @@
+---
+"@apollo/client": major
+---
+
+Apollo Client no longer ships with support for `@client` fields out-of-the-box and now must be opt-in. To opt in to use `@client` fields, pass an instantiated `LocalState` instance to the `localState` option. If a query contains `@client` and local state hasn't been configured, an error will be thrown.
+
+```ts
+import { LocalState } from "@apollo/client/local-state";
+
+new ApolloClient({
+  localState: new LocalState(),
+});
+```

package/.changeset/thirty-pens-jump.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove the `fragmentMatcher` option from `ApolloClient`. Custom fragment matchers used with local state are no longer supported. Fragment matching is now performed by the configured `cache` via the `cache.fragmentMatches` API.

package/.changeset/wicked-kiwis-buy.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+A call to `ObservableQuery.setVariables` with different variables or a `ObservableQuery.refetch` call will always now guarantee that a value will be emitted from the observable, even if it is deep equal to the previous value.

package/CHANGELOG.md

@@ -1,5 +1,147 @@
 # @apollo/client
 
+## 4.0.0-alpha.14
+
+### Major Changes
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - The `getCacheKey` function is no longer available from `operation.getContext()` in the link chain. Use `operation.client.cache.identify(obj)` in the link chain instead.
+
+- [#12556](https://github.com/apollographql/apollo-client/pull/12556) [`c3fceda`](https://github.com/apollographql/apollo-client/commit/c3fceda86c5e0f499d0b5fa54ea7dc4c4391ae2c) Thanks [@phryneas](https://github.com/phryneas)! - `ObservableQuery` will now keep previous `data` around when emitting a `loading` state, unless `query` or `variables` changed.
+  Note that `@exports` variables are not taken into account for this, so `data` will stay around even if they change.
+
+- [#12556](https://github.com/apollographql/apollo-client/pull/12556) [`c3fceda`](https://github.com/apollographql/apollo-client/commit/c3fceda86c5e0f499d0b5fa54ea7dc4c4391ae2c) Thanks [@phryneas](https://github.com/phryneas)! - Removed `getLastResult`, `getLastError` and `resetLastResults` from `ObservableQuery`
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Removes the `resolvers` option from `ApolloClient`. Local resolvers have instead been moved to the new `LocalState` instance which is assigned to the `localState` option in `ApolloClient`. To migrate, move the `resolvers` values into a `LocalState` instance and assign that instance to `localState`.
+
+  ```diff
+  new ApolloClient({
+  - resolvers: { /* ... */ }
+  + localState: new LocalState({
+  +   resolvers: { /* ... */ }
+  + }),
+  });
+  ```
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove local resolvers APIs from `ApolloClient` in favor of `localState`. Methods removed are:
+
+  - `addResolvers`
+  - `getResolvers`
+  - `setResolvers`
+  - `setLocalStateFragmentMatcher`
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Third-party caches must now implement the `fragmentMatches` API. Additionally `fragmentMatches` must be able to handle both `InlineFragmentNode` and `FragmentDefinitionNode` nodes.
+
+  ```ts
+  class MyCache extends ApolloCache {
+    // This is now required
+    public fragmentMatches(
+      fragment: InlineFragmentNode | FragmentDefinitionNode,
+      typename: string
+    ): boolean {
+      return; // ... logic to determine if typename matches fragment
+    }
+  }
+  ```
+
+- [#12556](https://github.com/apollographql/apollo-client/pull/12556) [`c3fceda`](https://github.com/apollographql/apollo-client/commit/c3fceda86c5e0f499d0b5fa54ea7dc4c4391ae2c) Thanks [@phryneas](https://github.com/phryneas)! - Reworked the logic for then a loading state is triggered. If the link chain responds synchronously, a loading state will be omitted, otherwise it will be triggered.
+  If local resolvers are used, the time window for "sync vs async" starts as soon as `@exports` variables are resolved.
+
+- [#12556](https://github.com/apollographql/apollo-client/pull/12556) [`c3fceda`](https://github.com/apollographql/apollo-client/commit/c3fceda86c5e0f499d0b5fa54ea7dc4c4391ae2c) Thanks [@phryneas](https://github.com/phryneas)! - Dropped the `saveAsLastResult` argument from `ObservableQuery.getCurrentResult`
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - The resolver function's `context` argument (the 3rd argument) has changed to provide additional information without the possibility of name clashes. Previously the `context` argument would spread request context and override the `client` and `cache` properties to give access to both inside of a resolver. The `context` argument takes now takes the following shape:
+
+  ```ts
+  {
+    // the request context. By default `TContextValue` is of type `DefaultContext`,
+    // but can be changed if a `context` function is provided.
+    requestContext: TContextValue,
+    // The client instance making the request
+    client: ApolloClient,
+    // Whether the resolver is run as a result of gathering exported variables
+    // or resolving the value as part of the result
+    phase: "exports" | "resolve"
+  }
+  ```
+
+  To migrate, pull any request context from `requestContext` and the `cache` from the `client` property:
+
+  ```diff
+  new LocalState({
+    resolvers: {
+      Query: {
+  -     myResolver: (parent, args, { someValue, cache }) => {
+  +     myResolver: (parent, args, { requestContext, client }) => {
+  +       const someValue = requestContext.someValue;
+  +       const cache = client.cache;
+        }
+      }
+    }
+  });
+  ```
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Apollo Client no longer ships with support for `@client` fields out-of-the-box and now must be opt-in. To opt in to use `@client` fields, pass an instantiated `LocalState` instance to the `localState` option. If a query contains `@client` and local state hasn't been configured, an error will be thrown.
+
+  ```ts
+  import { LocalState } from "@apollo/client/local-state";
+
+  new ApolloClient({
+    localState: new LocalState(),
+  });
+  ```
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove the `fragmentMatcher` option from `ApolloClient`. Custom fragment matchers used with local state are no longer supported. Fragment matching is now performed by the configured `cache` via the `cache.fragmentMatches` API.
+
+- [#12556](https://github.com/apollographql/apollo-client/pull/12556) [`c3fceda`](https://github.com/apollographql/apollo-client/commit/c3fceda86c5e0f499d0b5fa54ea7dc4c4391ae2c) Thanks [@phryneas](https://github.com/phryneas)! - A call to `ObservableQuery.setVariables` with different variables or a `ObservableQuery.refetch` call will always now guarantee that a value will be emitted from the observable, even if it is deep equal to the previous value.
+
+### Minor Changes
+
+- [#12614](https://github.com/apollographql/apollo-client/pull/12614) [`d2851e2`](https://github.com/apollographql/apollo-client/commit/d2851e2c74541995760a86904b1e3ab4bd736e62) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Revamp local resolvers and fix several issues from the existing `resolvers` option.
+
+  - Throwing errors in a resolver will set the field value as `null` and add an error to the response's `errors` array.
+  - Remote results are dealiased before they are passed as the parent object to a resolver so that you can access fields by their field name.
+  - You can now specify a `context` function that you can use to customize the `requestContext` given to resolvers.
+  - The `LocalState` class accepts a `Resolvers` generic that provides autocompletion and type checking against your resolver types to ensure your resolvers are type-safe.
+  - `data: null` is now handled correctly and does not call your local resolvers when the server does not provide a result.
+  - Additional warnings have been added to provide hints when resolvers behave unexpectedly.
+
+  ```ts
+  import { LocalState } from "@apollo/client/local-state";
+
+  import { Resolvers } from "./path/to/local-resolvers-types.ts";
+
+  // LocalState now accepts a `Resolvers` generic.
+  const localState = new LocalState<Resolvers>({
+    // The return value of this funciton
+    context: (options) => ({
+      // ...
+    }),
+    resolvers: {
+      // ...
+    },
+  });
+
+  // You may also pass a `ContextValue` generic used to ensure the `context`
+  // function returns the correct type. This type is inferred from your resolvers
+  // if not provided.
+  new LocalState<Resolvers, ContextValue>({
+    // ...
+  });
+  ```
+
+## 4.0.0-alpha.13
+
+### Major Changes
+
+- [#12600](https://github.com/apollographql/apollo-client/pull/12600) [`34ff6aa`](https://github.com/apollographql/apollo-client/commit/34ff6aa25b47c3e84d0b18e2c69bc995814bf2f2) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Move most of the utilities in `@apollo/client/utilities` to `@apollo/client/utilities/internal`. Many of the utilities exported from the `@apollo/client/utilities` endpoint were not considered stable.
+
+  As a result of this change, utilities or types exported from `@apollo/client/utilities` are now documented and considered stable and will not undergo breaking changes.
+
+- [#12595](https://github.com/apollographql/apollo-client/pull/12595) [`60bb49c`](https://github.com/apollographql/apollo-client/commit/60bb49ccea9aecf3e6a212b5a1f71907e60af886) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove the `@apollo/client/testing/experimental` test utilities. Use [GraphQL Testing Library](https://github.com/apollographql/graphql-testing-library) instead.
+
+### Patch Changes
+
+- [#12618](https://github.com/apollographql/apollo-client/pull/12618) [`e4a3ecf`](https://github.com/apollographql/apollo-client/commit/e4a3ecfe50bc5b462067574a0ffb1951549fb60f) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Remove code that strips `@client` fields in `HttpLink` and `BatchHttpLink`. This was unused code since core handles removing `@client` fields and should have no observable change.
+
 ## 4.0.0-alpha.12
 
 ### Major Changes
@@ -1001,6 +1143,12 @@
 
 - [#12384](https://github.com/apollographql/apollo-client/pull/12384) [`6aa6fd3`](https://github.com/apollographql/apollo-client/commit/6aa6fd316cfdb31ebbe3e3133cca2965604e7ca1) Thanks [@jerelmiller](https://github.com/jerelmiller)! - Don't emit a partial cache result from `cache-only` queries when `returnPartialData` is `false`.
 
+## 3.13.8
+
+### Patch Changes
+
+- [#12567](https://github.com/apollographql/apollo-client/pull/12567) [`c19d415`](https://github.com/apollographql/apollo-client/commit/c19d41513cac0cc143aa7358f26c89c9408da102) Thanks [@thearchitector](https://github.com/thearchitector)! - Fix in-flight multipart urql subscription cancellation
+
 ## 3.13.7
 
 ### Patch Changes

package/__cjs/cache/core/cache.cjs

@@ -92,9 +92,9 @@ class ApolloCache {
             : this.identify(from);
         const dataMasking = !!options[Symbol.for("apollo.dataMasking")];
         if (environment_1.__DEV__) {
-            const actualFragmentName = fragmentName || (0, utilities_1.getFragmentDefinition)(fragment).name.value;
+            const actualFragmentName = fragmentName || (0, internal_1.getFragmentDefinition)(fragment).name.value;
             if (!id) {
-                __DEV__ && invariant_1.invariant.warn(97, actualFragmentName);
+                __DEV__ && invariant_1.invariant.warn(109, actualFragmentName);
             }
         }
         const diffOptions = {
@@ -142,7 +142,7 @@ class ApolloCache {
     }
     // Make sure we compute the same (===) fragment query document every
     // time we receive the same fragment in readFragment.
-    getFragmentDoc = (0, optimism_1.wrap)(utilities_1.getFragmentQueryDocument, {
+    getFragmentDoc = (0, optimism_1.wrap)(internal_1.getFragmentQueryDocument, {
         max: utilities_1.cacheSizes["cache.fragmentQueryDocuments"] ||
             1000 /* defaultCacheSizes["cache.fragmentQueryDocuments"] */,
         cache: caches_1.WeakCache,
@@ -193,12 +193,14 @@ class ApolloCache {
         });
     }
     /**
-     * @experimental
-     * @internal
-     * This is not a stable API - it is used in development builds to expose
-     * information to the DevTools.
-     * Use at your own risk!
-     */
+    * @experimental
+    * @internal
+    * This is not a stable API - it is used in development builds to expose
+    * information to the DevTools.
+    * Use at your own risk!
+    * 
+    * @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
+    */
     getMemoryInternals;
 }
 exports.ApolloCache = ApolloCache;