@apollo/client 4.0.0-alpha.1 → 4.0.0-alpha.11

package/.changeset/afraid-grapes-call.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Export `gql` from the `@apollo/client/react` entrypoint.

package/.changeset/afraid-moons-arrive.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": minor
+---
+
+Allow mocked responses passed to `MockLink` to accept a callback for the `delay` option. The `delay` callback will be given the current operation which can be used to determine what delay should be used for the mock.

package/.changeset/beige-mirrors-talk.md

@@ -0,0 +1,15 @@
+---
+"@apollo/client": major
+---
+
+`onError` link now uses a single `error` property to report the error that caused the link callback to be called. This will be an instance of `CombinedGraphQLErrors` in the event GraphQL errors were emitted from the terminating link, `CombinedProtocolErrors` if the terminating link emitted protocol errors, or the unwrapped error type if any other non-GraphQL error was thrown or emitted.
+
+```diff
+- const errorLink = onError(({ graphQLErrors, networkError, protocolErrors }) => {
+-   graphQLErrors.forEach(error => console.log(error.message));
++ const errorLink = onError(({ error }) => {
++   if (error.name === 'CombinedGraphQLErrors') {
++     error.errors.forEach(rawError => console.log(rawError.message));
++   }
+});
+```

package/.changeset/cool-kiwis-hunt.md

@@ -0,0 +1,15 @@
+---
+"@apollo/client": minor
+---
+
+Add ability to specify message formatter for `CombinedGraphQLErrors` and `CombinedProtocolErrors`. To provide your own message formatter, override the static `formatMessage` property on these classes.
+
+```ts
+CombinedGraphQLErrors.formatMessage = (errors, { result, defaultFormatMessage }) => {
+  return "Some formatted message"
+};
+
+CombinedProtocolErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+  return "Some formatted message"
+};
+```

package/.changeset/cuddly-spiders-tie.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove `TSerialized` generic argument to `ApolloCache`. The `ApolloCache` base cache abstraction now returns `unknown` for `cache.extract` which can be overridden by a cache subclass.

package/.changeset/dirty-eagles-poke.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Removed the `@apollo/client/react/context` and `@apollo/client/react/hooks` entry points. Please use `@apollo/client/react` instead.

package/.changeset/early-eggs-develop.md

@@ -0,0 +1,22 @@
+---
+"@apollo/client": minor
+---
+
+Introduce a new `realisticDelay` helper function for use with the `delay` callback for mocked responses used with `MockLink`. `realisticDelay` will generate a random value between 20 and 50ms to provide an experience closer to unpredictable network latency. `realisticDelay` can be configured with a `min` and `max` to set different thresholds if the defaults are not sufficient.
+
+```ts
+import { realisticDelay } from '@apollo/client/testing';
+
+new MockLink([
+  {
+    request: { query },
+    result: { data: { greeting: 'Hello' }},
+    delay: realisticDelay()
+  },
+  {
+    request: { query },
+    result: { data: { greeting: 'Hello' }},
+    delay: realisticDelay({ min: 10, max: 100 })
+  },
+]);
+```

package/.changeset/eighty-squids-fix.md

@@ -0,0 +1,15 @@
+---
+"@apollo/client": major
+---
+
+`ObservableQuery.setOptions` has been removed as it was an alias of `reobserve`. Prefer using `reobserve` directly instead.
+
+```diff
+const observable = client.watchQuery(options);
+
+// Use reobserve to set new options and reevaluate the query
+- observable.setOptions(newOptions);
++ observable.reobserve(newOptions);
+```
+
+As a result of this change, `reobserve` has been marked for public use and is no longer considered an internal API. The `newNetworkStatus` argument has been removed to facilitate this change.

package/.changeset/eleven-kangaroos-jump.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove `variables` from the result returned from `useSubscription`.

package/.changeset/forty-shrimps-fry.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Subscriptions now emit a `SubscribeResult` instead of a `FetchResult`. As a result, the `errors` field has been removed in favor of `error`.

package/.changeset/forty-tomatoes-punch.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+The returned `networkStatus` in `useLazyQuery` is now set to `setVariables` when calling the `useLazyQuery` `execute` function for the first time with variables.

package/.changeset/four-countries-clean.md

@@ -0,0 +1,24 @@
+---
+"@apollo/client": minor
+---
+
+Add a static `is` method to error types defined by Apollo Client. `is` makes it simpler to determine whether an error is a specific type, which can be helpful in cases where you'd like to narrow the error type in order to use specific properties from that error.
+
+This change applies to the following error types:
+- `CombinedGraphQLErrors`
+- `CombinedProtocolErrors`
+- `ServerError`
+- `ServerParseError`
+- `UnconventionalError`
+
+**Example**
+
+```ts
+import { CombinedGraphQLErrors } from "@apollo/client";
+
+if (CombinedGraphQLErrors.is(error)) {
+  console.log(error.message);
+  error.errors.forEach((graphQLError) => console.log(graphQLError.message))
+}
+```
+

package/.changeset/four-ghosts-watch.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Network errors triggered by queries now adhere to the `errorPolicy`. This means that GraphQL errors and network errors now behave the same way. Previously promise-based APIs, such as `client.query`, would reject the promise with the network error even if `errorPolicy` was set to `ignore`. The promise is now resolved with the `error` property set to the network error instead.

package/.changeset/funny-jeans-invent.md

@@ -0,0 +1,16 @@
+---
+"@apollo/client": major
+---
+
+`ssrMode`, `ssrForceFetchDelay` and `disableNetworkFetches` have been reworked:
+
+Previously, a `ObservableQuery` created by `client.query` or `client.watchQuery`
+while one of those were active would permanently be changed from a `fetchPolicy`
+of `"network-only"` or `"cache-and-network"` to `"cache-first"`, and stay that way
+even long after `disableNetworkFetches` would have been deactivated.
+
+Now, the `ObservableQuery` will keep their original `fetchPolicy`, but queries
+made during `disableNetworkFetches` will just apply the `fetchPolicy` replacement
+at request time, just for that one request.
+
+`ApolloClient.disableNetworkFetches` has been renamed to `ApolloClient.prioritizeCacheValues` to better reflect this behaviour.

package/.changeset/funny-terms-deny.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+`ObservableQuery.variables` can now be reset back to empty when calling `reobserve` with `variables: undefined`. Previously the `variables` key would be ignored so `variables` would remain unchanged.

package/.changeset/fuzzy-tips-sit.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Ensure `ObservableQuery` stops polling if switching to a `standby` `fetchPolicy`. When switching back to a non-`standby` `fetchPolicy`, polling will resume.

package/.changeset/gentle-badgers-train.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+`never` is no longer supported as a valid `TVariables` generic argument for APIs that require `variables` as part of its type. Use `Record<string, never>` instead.

package/.changeset/gentle-waves-cough.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+The `cache` and `forceFetch` properties are no longer available on context when calling `operation.getContext()`. `cache` can be accessed through the `operation` with `operation.client.cache` instead. `forceFetch` has been replaced with `queryDeduplication` which specifies whether `queryDeduplication` was enabled for the request or not.

package/.changeset/giant-apes-thank.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove the `onError` and `setOnError` methods from `ApolloLink`. `onError` was only used by `MockLink` to rewrite errors if `setOnError` was used.

package/.changeset/giant-bags-share.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Throw an error for queries and mutations if the link chain completes without emitting a value.

package/.changeset/gorgeous-chefs-tap.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Remove the `TCacheShape` generic argument to `ApolloClient`. `client.extract()` now returns `unknown` by default. You will either need to type-cast this to the expected serialized shape, or use the `cache.extract()` directly from the subclass to get more specific types.

package/.changeset/great-roses-jog.md

@@ -0,0 +1,15 @@
+---
+"@apollo/client": patch
+---
+
+The `variables` option used with various APIs are now enforced more consistently across the client when `TVariables` contains required variables. If required `variables` are not provided, TypeScript will now complain that it requires a `variables` option.
+
+This change affects the following APIs:
+- `client.query`
+- `client.mutate`
+- `client.subscribe`
+- `client.watchQuery`
+- `useBackgroundQuery`
+- `useQuery`
+- `useSubscription`
+- `useSuspenseQuery`

package/.changeset/grumpy-vans-type.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Unify error behavior on mutations for GraphQL errors and network errors by ensuring network errors are subject to the `errorPolicy`. Network errors created when using an `errorPolicy` of `all` will now resolve the promise and be returned on the `error` property of the result, or stripped away when the `errorPolicy` is `none`.

package/.changeset/hip-vans-act.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Default `TVariables` generic type to `OperationVariables` instead of `any` throughout the client in areas that did not yet have the default as such.

package/.changeset/hungry-bikes-cough.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Fix type of `variables` returned from `useLazyQuery`. When `called` is `false`, `variables` is now `Partial<TVariables>` instead of `TVariables`.

package/.changeset/itchy-chefs-run.md

@@ -0,0 +1,23 @@
+---
+"@apollo/client": major
+---
+
+When passing a `variables` key with the value `undefined`, the value will be replaced by the default value in the query, if it is provided, rather than leave it as `undefined`.
+
+```ts
+// given this query
+const query = gql`
+  query PaginatedQuery($limit: Int! = 10, $offset: Int) {
+    list(limit: $limit, offset: $offset) {
+      id
+    }
+  }
+`
+
+const observable = client.query({ query, variables: { limit: 5, offset: 0 }});
+console.log(observable.variables) // => { limit: 5, offset: 0 }
+
+observable.reobserve({ variables: { limit: undefined, offset: 10 }})
+// limit is now `10`. This would previously be `undefined`
+console.log(observable.variables) // => { limit: 10, offset: 10 }
+```

package/.changeset/khaki-keys-deliver.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+An initial loading state is now emitted from `ObservableQuery` when subscribing if `notifyOnNetworkStatusChange` is set to `true`.

package/.changeset/khaki-spies-work.md

@@ -0,0 +1,11 @@
+---
+"@apollo/client": major
+---
+
+Flatten out React hook types. As a result, the base types have been removed. Prefer using the hook types instead. Removed types include:
+- `BaseMutationOptions`
+- `BaseQueryOptions`
+- `BaseSubscriptionOptions`
+- `ObservableQueryFields`
+- `MutationSharedOptions`
+- `QueryFunctionOptions`

package/.changeset/large-plants-know.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Ensure a loading state is emitted when calling the `execute` function after changing clients in `useLazyQuery`.

package/.changeset/light-apes-rescue.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+`useQuery` no longer returns `reobserve` as part of its result. It was possible to use `reobserve` to set new options on the underlying `ObservableQuery` instance which differed from the options passed to the hook. This could result in unexpected results. Instead prefer to rerender the hook with new options.

package/.changeset/little-spoons-kick.md

@@ -0,0 +1,7 @@
+---
+"@apollo/client": major
+---
+
+`client.mutate` now returns a `MutateResult` instead of `FetchResult`. As a result, the `errors` property has been removed in favor of `error` which is set if either a network error occured or GraphQL errors are returned from the server.
+
+`useMutation` now also returns a `MutateResult` instead of a `FetchResult`.

package/.changeset/loud-cows-raise.md

@@ -0,0 +1,7 @@
+---
+"@apollo/client": patch
+---
+
+`useQuery` with `ssr: false` - previously, `skip` had a higher priortity than `ssr: false` while `ssr: false` had a higher priority than `fetchPolicy: "standby"` (which is roughly equivalent to `skip`).
+
+This priority has been adjusted so now both `skip` and `fetchPolicy: "standby"` have a higher priority than `ssr: false` and will return `loading: false`, while `ssr: false` will only come after those and will return `loading: true` if those are not set.

package/.changeset/lucky-sheep-explain.md

@@ -0,0 +1,34 @@
+---
+"@apollo/client": minor
+---
+
+Provide an extension to define types for `context` passed to the link chain. To define your own types, use [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) to add properties to the `DefaultContext` type.
+
+```ts
+// @apollo-client.d.ts
+// This import is necessary to ensure all Apollo Client imports
+// are still available to the rest of the application.
+import '@apollo/client';
+
+declare module "@apollo/client" {
+  interface DefaultContext extends Record<string, any> {
+    myProperty: string;
+  }
+}
+```
+
+Links that provide context options can be used with this type to add those context types to `DefaultContext`. For example, to add context options from `HttpLink`, add the following code:
+
+```ts
+import { HttpLink } from "@apollo/client";
+
+declare module "@apollo/client" {
+  interface DefaultContext extends HttpLink.ContextOptions {
+    myProperty: string;
+  }
+}
+```
+
+At this time, the following built-in links support context options:
+- `HttpLink.ContextOptions`
+- `BatchHttpLink.ContextOptions`

package/.changeset/many-buses-allow.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Fix an issue where passing `onError` to `useMutation` would resolve the promise returned by the `mutate` function instead of rejecting when using an `errorPolicy` of `none`.

package/.changeset/mean-lizards-think.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Ensure `useLazyQuery` does not return a `partial` property which is not specified by the result type.

package/.changeset/nervous-fireants-bow.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": minor
+---
+
+Add a `data` property to `CombinedGraphQLErrors` that captures any partial data returned by the GraphQL response when `errors` are also returned.

package/.changeset/nervous-goats-allow.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Removes the `defaultOptions` option from `useQuery`. Use options directly or use the global `ApolloClient` `defaultOptions`.

package/.changeset/nice-dots-matter.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Removed the `parser` cache. The functionality has been replaced in a way that doesn't need caching.

package/.changeset/ninety-bags-bake.md

@@ -0,0 +1,17 @@
+---
+"@apollo/client": major
+---
+
+Mocked responses passed to `MockLink` now accept a callback for the `request.variables` option. This is used to determine if the mock should be matched for a set of request variables. With this change, the `variableMatcher` option has been removed in favor of passing a callback to `variables`. Update by moving the callback function from `variableMatcher` to `request.variables`.
+
+```diff
+new MockLink([
+  {
+    request: {
+      query,
++     variables: (requestVariables) => true
+    },
+-   variableMatcher: (requestVariables) => true
+  }
+]);
+```

package/.changeset/odd-chicken-hide.md

@@ -0,0 +1,17 @@
+---
+"@apollo/client": minor
+---
+
+Add the ability to detect if an error was an error was emitted from the link chain. This is useful if your application throws custom errors in other areas of the application and you'd like to differentiate them from errors emitted by the link chain itself.
+
+To detect if an error was emitted from the link chain, use `LinkError.is`.
+
+```ts
+import { LinkError } from "@apollo/client";
+
+client.query({ query }).catch((error) => {
+  if (LinkError.is(error)) {
+    // This error originated from the link chain
+  }
+});
+```

package/.changeset/odd-lemons-relax.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Rename all React hook result types and options. These types have all moved under a namespace that matches the hook name. For example, `useQuery` exports `useQuery.Options` and `useQuery.Result` types. As such, the old hook types have been deprecated and will be removed in v5.

package/.changeset/orange-suits-laugh.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Adjust `useMutation` types to better handle required variables. When required variables are missing, TypeScript will now complain if they are not provided either to the hook or the returned `mutate` function. Providing required variables to `useMutation` will make them optional in the returned `mutate` function.

package/.changeset/perfect-ducks-reflect.md

@@ -0,0 +1,12 @@
+---
+"@apollo/client": major
+---
+
+`ApolloLink.execute` now requires a third argument which provides the `client` that initiated the request to the link chain. If you use `execute` directly, add a third argument with a `client` property:
+
+```ts
+ApolloLink.execute(link, operation, { client });
+
+// or if you import the `execute` function directly:
+execute(link, operation, { client });
+```

package/.changeset/perfect-vans-give.md

@@ -0,0 +1,7 @@
+---
+"@apollo/client": major
+---
+
+The `@apollo/client` and `@apollo/client/core` entry points are now equal.
+In the next major, the `@apollo/client/core` entry point will be removed.
+Please change imports over from `@apollo/client/core` to `@apollo/client`.

package/.changeset/poor-eels-punch.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Mutations no longer report errors if the GraphQL result from the server contains an empty array of errors.

package/.changeset/pre.json

@@ -5,6 +5,9 @@
     "@apollo/client": "3.12.2"
   },
   "changesets": [
+    "afraid-grapes-call",
+    "afraid-moons-arrive",
+    "beige-mirrors-talk",
     "brave-radios-wait",
     "bright-ads-share",
     "calm-frogs-remain",
@@ -13,58 +16,125 @@
     "clean-sheep-hide",
     "clever-zebras-mate",
     "cool-bikes-shake",
+    "cool-kiwis-hunt",
+    "cuddly-spiders-tie",
     "curvy-pianos-count",
+    "dirty-eagles-poke",
     "dirty-trees-pump",
+    "early-eggs-develop",
+    "eighty-squids-fix",
+    "eleven-kangaroos-jump",
     "empty-rabbits-move",
     "fluffy-shoes-applaud",
     "forty-hairs-occur",
+    "forty-shrimps-fry",
+    "forty-tomatoes-punch",
+    "four-countries-clean",
+    "four-ghosts-watch",
     "fresh-moose-hope",
+    "funny-jeans-invent",
+    "funny-terms-deny",
+    "fuzzy-tips-sit",
+    "gentle-badgers-train",
+    "gentle-waves-cough",
+    "giant-apes-thank",
+    "giant-bags-share",
     "good-dolphins-peel",
+    "gorgeous-chefs-tap",
+    "great-roses-jog",
+    "grumpy-vans-type",
     "healthy-apes-sneeze",
+    "hip-vans-act",
     "hot-cycles-notice",
+    "hungry-bikes-cough",
+    "itchy-chefs-run",
     "itchy-drinks-refuse",
     "itchy-roses-accept",
+    "khaki-keys-deliver",
+    "khaki-spies-work",
     "kind-fishes-develop",
+    "large-plants-know",
     "late-trainers-peel",
+    "light-apes-rescue",
     "light-dolphins-taste",
     "light-sloths-end",
+    "little-spoons-kick",
+    "loud-cows-raise",
     "lucky-hats-push",
+    "lucky-sheep-explain",
+    "many-buses-allow",
     "many-papayas-hide",
+    "mean-lizards-think",
     "metal-needles-search",
     "mighty-penguins-wink",
     "modern-feet-do",
     "moody-lobsters-listen",
+    "nervous-fireants-bow",
+    "nervous-goats-allow",
     "nice-donkeys-reflect",
+    "nice-dots-matter",
     "nice-waves-work",
+    "ninety-bags-bake",
+    "odd-chicken-hide",
+    "odd-lemons-relax",
+    "orange-suits-laugh",
+    "perfect-ducks-reflect",
+    "perfect-vans-give",
     "polite-bees-care",
+    "poor-eels-punch",
     "popular-games-sleep",
+    "purple-bears-flash",
     "purple-lions-cough",
     "rare-houses-prove",
     "real-gorillas-move",
+    "real-teachers-peel",
     "rich-eagles-cross",
     "rich-kids-carry",
     "rude-fans-study",
+    "serious-moons-juggle",
+    "seven-dragons-repair",
     "seven-foxes-melt",
+    "seven-schools-carry",
+    "shaggy-pugs-add",
     "shiny-carrots-invent",
     "short-jokes-jam",
+    "short-months-complain",
     "silly-knives-exist",
+    "slimy-chicken-melt",
+    "slimy-maps-press",
     "slow-ravens-explain",
+    "small-buttons-rhyme",
     "small-cycles-rescue",
     "small-kids-film",
+    "small-poems-rest",
     "smart-rats-explode",
     "smooth-coins-collect",
     "smooth-pens-reply",
     "soft-mails-clean",
     "sour-pillows-guess",
     "strange-seahorses-impress",
+    "swift-rivers-share",
+    "tall-bikes-develop",
     "tall-cups-suffer",
     "tame-doors-shop",
+    "tame-points-work",
+    "tender-swans-flash",
+    "thick-books-grin",
+    "thin-peas-hear",
+    "tidy-pandas-punch",
     "tidy-squids-poke",
+    "tough-rockets-allow",
     "tough-taxis-smoke",
     "tough-tips-drop",
+    "tricky-tables-shave",
     "twenty-snakes-sort",
+    "unlucky-kiwis-sell",
     "unlucky-sheep-change",
+    "warm-ties-sit",
+    "wicked-forks-double",
     "yellow-cats-judge",
+    "young-phones-fold",
+    "young-snails-grin",
     "young-turtles-explode"
   ]
 }

package/.changeset/purple-bears-flash.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Removed the `@apollo/client/react/parser` entry point. There is no replacement.

package/.changeset/real-teachers-peel.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": major
+---
+
+Unify error behavior on subscriptions for GraphQL errors and network errors by ensuring network errors are subject to the `errorPolicy`. Network errors that terminate the connection will now be emitted on the `error` property passed to the `next` callback followed by a call to the `complete` callback.

package/.changeset/serious-moons-juggle.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+`client.query` no longer supports `notifyOnNetworkStatusChange` in options. An error will be thrown if this option is set. The effects of this option were not observable by `client.query` since `client.query` emits a single result.