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

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

@@ -1,22 +0,0 @@
----
-"@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

@@ -1,15 +0,0 @@
----
-"@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

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

package/.changeset/empty-rabbits-move.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-The `previousData` property on `useLazyQuery` will now change only when `data` changes. Previously `previousData` would change to the same value as `data` while the query was loading.

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

@@ -1,6 +0,0 @@
----
-"@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/fluffy-shoes-applaud.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove deprecated `partialRefetch` option.

package/.changeset/forty-hairs-occur.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Calling `refetch` with new variables will now set the `networkStatus` to `refetch` instead of `setVariables`.

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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,24 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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/fresh-moose-hope.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove the `iterateObserversSafely` utility function.

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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,35 +0,0 @@
----
-"@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/funny-jeans-invent.md

@@ -1,16 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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-seahorses-hunt.md

@@ -1,5 +0,0 @@
----
-"@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/fuzzy-tips-sit.md

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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

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

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

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

package/.changeset/good-dolphins-peel.md

@@ -1,113 +0,0 @@
----
-"@apollo/client": major
----
-
-Apollo Client no longer wraps errors in `ApolloError`. `ApolloError` has been replaced with separate error classes depending on the cause of the error. As such, APIs that return an `error` property have been updated to use the generic `Error` type. Use `instanceof` to check for more specific error types.
-
-## Migration guide
-
-`ApolloError` encapsulated 4 main error properties. The type of error would determine which property was set:
-- `graphqlErrors` - Errors returned from the `errors` field by the GraphQL server
-- `networkError` - Any non-GraphQL error that caused the query to fail
-- `protocolErrors` - Transport-level errors that occur during [multipart HTTP subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol)
-- `clientErrors` - A space to define custom errors. Mostly unused.
-
-These errors were mutally exclusive, meaning both `networkError` and `graphqlErrors` were never set simultaneously. The following replaces each of these fields from `ApolloError`.
-
-### `graphqlErrors`
-
-GraphQL errors are now encapsulated in a `CombinedGraphQLErrors` instance. You can access the raw GraphQL errors via the `errors` property.
-
-```js
-import { CombinedGraphQLErrors } from '@apollo/client';
-
-// ...
-
-const { error } = useQuery(query);
-
-if (error && error instanceof CombinedGraphQLErrors) {
-  console.log(error.errors);
-}
-```
-
-### `networkError`
-
-Network errors are no longer wrapped and are instead passed through directly.
-
-```js
-const client = new ApolloClient({
-  link: new ApolloLink(() => {
-    return new Observable((observer) => {
-      observer.error(new Error('Test error'));
-    })
-  })
-})
-
-// ...
-
-const { error } = useQuery(query);
-
-// error is `new Error('Test error')`;
-```
-
-### `protocolErrors`
-
-Protocol errors are now encapsulated in a `CombinedProtocolErrors` instance. You can access the raw protocol errors via the `errors` property.
-
-
-```js
-import { CombinedProtocolErrors } from '@apollo/client';
-
-// ...
-
-const { error } = useSubscription(subscription);
-
-if (error && error instanceof CombinedProtocolErrors) {
-  console.log(error.errors);
-}
-```
-
-### `clientErrors`
-
-These were unused by the client and have no replacement. Any non-GraphQL or non-protocol errors are now passed through unwrapped.
-
-### Strings as errors
-
-If the link sends a string error, Apollo Client will wrap this in an `Error` instance. This ensures `error` properties are guaranteed to be of type `Error`.
-
-```js
-const client = new ApolloClient({
-  link: new ApolloLink(() => {
-    return new Observable((observer) => {
-      // Oops we sent a string instead of wrapping it in an `Error`
-      observer.error('Test error');
-    })
-  })
-})
-
-// ...
-
-const { error } = useQuery(query);
-
-// The error string is wrapped and returned as `new Error('Test error')`;
-```
-
-### Non-error types
-
-If the link chain sends any other object type as an error, Apollo Client will wrap this in an `UnknownError` instance with the [`cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) set to the original object. This ensures `error` properties are guaranteed to be of type `Error`.
-
-```js
-const client = new ApolloClient({
-  link: new ApolloLink(() => {
-    return new Observable((observer) => {
-      observer.error({ message: 'Not a proper error type' });
-    })
-  })
-})
-
-// ...
-
-const { error } = useQuery(query);
-
-// error is an `UnknownError` instance. error.cause returns the original object.
-```

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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,15 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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/healthy-apes-sneeze.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove `fromError` utility function. Use [`throwError`](https://rxjs.dev/api/index/function/throwError) instead.

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

@@ -1,5 +0,0 @@
----
-"@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/hot-cycles-notice.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove the deprecated `graphql`, `withQuery`, `withMutation`, `withSubscription`, and `withApollo` hoc components. Use the provided React hooks instead.

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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,23 +0,0 @@
----
-"@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/itchy-drinks-refuse.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove `itAsync` test utility.

package/.changeset/itchy-roses-accept.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": patch
----
-
-Use an an empty object (`{}`) rather than an object with `null` prototype (`Object.create(null)`) in all areas that instantiate objects.

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

@@ -1,5 +0,0 @@
----
-"@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

@@ -1,11 +0,0 @@
----
-"@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/kind-fishes-develop.md

@@ -1,17 +0,0 @@
----
-"@apollo/client": major
----
-
-Updates the `ServerError` and `ServerParseError` types to be proper `Error` subclasses. Perviously these were plain `Error` intances with additional properties added at runtime. All properties are retained, but `instanceof` checks now work correctly.
-
-```js
-import { ServerError, ServerParseError } from '@apollo/client';
-
-if (error instanceof ServerError) {
-  // ...
-}
-
-if (error instanceof ServerParseError) {
-  // ...
-}
-```

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

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

package/.changeset/late-trainers-peel.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": patch
----
-
-* dropped the deprecated `DEV` export from `@apollo/client/utilities` and `@apollo/client/utilities/globals`
-* moved the `__DEV__` export from `@apollo/client/utilities/globals` to `@apollo/client/utilities/environment`
-* moved the `invariant`, `newInvariantError` and `InvariantError` exports from `@apollo/client/utilities/globals` to `@apollo/client/utilities/invariant`

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

@@ -1,5 +0,0 @@
----
-"@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/light-dolphins-taste.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-`useLazyQuery` no longer supports SSR environments and will now throw if the `execute` function is called in SSR. If you need to run a query in an SSR environment, use `useQuery` instead.

package/.changeset/light-sloths-end.md

@@ -1,16 +0,0 @@
----
-"@apollo/client": minor
----
-
-Apollo Client is no longer using `ts-invariant`, but ships with a modified variant of it.
-
-The existing export `setLogVerbosity` from `@apollo/client` is still available and
-now points to this new integration.
-**In most cases, you should be using this export.**
-It will no longer adjust the verbosity of `ts-invariant` and as such no longer
-influence other packages relying on `ts-invariant`.
-
-The new entry point `@apollo/client/utilities/invariant` now exports `invariant`,
-`InvariantError` and `setVerbosity`.
-(Note that these tools are mostly meant to be used by Apollo Client and libraries directly
-based on Apollo Client like the `@apollo/client-integration-*` packages.)

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

@@ -1,14 +0,0 @@
----
-"@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/little-spoons-kick.md

@@ -1,7 +0,0 @@
----
-"@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

@@ -1,7 +0,0 @@
----
-"@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-hats-push.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": major
----
-
-The execute function returned from `useLazyQuery` now only supports the `context` and `variables` options. This means that passing options supported by the hook no longer override the hook value.
-
-To change options, rerender the component with new options. These options will take effect with the next query execution.

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

@@ -1,34 +0,0 @@
----
-"@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

@@ -1,5 +0,0 @@
----
-"@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/many-papayas-hide.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-`ObservableQuery` will no longer terminate on errors and will instead emit a `next` value with an `error` property. This ensures that `ObservableQuery` instances can continue to receive updates after errors are returned in requests without the need to resubscribe to the observable.

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

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