@apollo/client 4.0.0-alpha.2 → 4.0.0-alpha.20

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/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/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/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/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-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/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/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/metal-needles-search.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": patch
----
-
-ObservableQuery: implement the `rxjs` `InteropObservable` interface to ensure `from(observableQuery)` stays possible

package/.changeset/mighty-penguins-wink.md

@@ -1,16 +0,0 @@
----
-"@apollo/client": major
----
-
-Removes the `throwServerError` utility function. Now that `ServerError` is an
-`Error` subclass, you can throw these errors directly:
-
-```js
-import { ServerError } from '@apollo/client';
-
-// instead of
-throwServerError(response, result, 'error message')
-
-// Use
-throw new ServerError('error message', { response, result })
-```

package/.changeset/modern-feet-do.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": patch
----
-
-`@apollo/client`, `@apollo/client/core` and `@apollo/client/cache` no longer export an empty `Cache` runtime object. This is meant to be a type-only namespace.

package/.changeset/moody-lobsters-listen.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": major
----
-
-The `Cache.DiffResult<T>` type is now a union type with better type safety for both complete and partial results. Checking `diff.complete` will now narrow the type of `result` depending on whether the value is `true` or `false`.
-
-When `true`, `diff.result` will be a non-null value equal to the `T` generic type. When `false`, `diff.result` now reports `result` as `DeepPartial<T> | null` indicating that fields in the result may be missing (`DeepPartial<T>`) or empty entirely (`null`).

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

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

package/.changeset/nice-donkeys-reflect.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove the `errors` property from the results emitted from `ObservableQuery` or returned from `client.query`. Read errors from the `error` property instead.

package/.changeset/nice-waves-work.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": major
----
-
-The result resolved from the promise returned from the execute function in `useLazyQuery` is now an `ApolloQueryResult` type and no longer includes all the fields returned from the `useLazyQuery` hook tuple.
-
-If you need access to the additional properties such as `called`, `refetch`, etc. not included in `ApolloQueryResult`, read them from the hook instead.

package/.changeset/polite-bees-care.md

@@ -1,26 +0,0 @@
----
-"@apollo/client": major
----
-
-`useLazyQuery` will no longer rerender with the loading state when calling the execute function the first time unless the `notifyOnNetworkStatusChange` option is set to `true` (which is the new default).
-
-If you prefer the behavior from 3.x, rerender the component with
-`notifyOnNetworkStatusChange` set to `false` after the execute function is
-called the first time.
-
-```ts
-function MyComponent() {
-  const [notifyOnNetworkStatusChange, setNotifyOnNetworkStatusChange] = useState(true);
-  const [execute] = useLazyQuery(query, { notifyOnNetworkStatusChange });
-
-  async function runExecute() {
-    await execute();
-
-    // Set to false after the initial fetch to stop receiving notifications
-    // about changes to the loading states.
-    setNotifyOnNetworkStatusChange(false);
-  }
-
-  // ...
-}
-```

package/.changeset/popular-games-sleep.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Changes the default `Accept` header to `application/graphql-response+json`.

package/.changeset/pre.json

@@ -1,78 +0,0 @@
-{
-  "mode": "pre",
-  "tag": "alpha",
-  "initialVersions": {
-    "@apollo/client": "3.12.2"
-  },
-  "changesets": [
-    "brave-radios-wait",
-    "bright-ads-share",
-    "calm-frogs-remain",
-    "calm-seals-relate",
-    "chatty-planes-grin",
-    "clean-sheep-hide",
-    "clever-zebras-mate",
-    "cool-bikes-shake",
-    "cuddly-spiders-tie",
-    "curvy-pianos-count",
-    "dirty-trees-pump",
-    "empty-rabbits-move",
-    "fluffy-shoes-applaud",
-    "forty-hairs-occur",
-    "fresh-moose-hope",
-    "good-dolphins-peel",
-    "gorgeous-chefs-tap",
-    "healthy-apes-sneeze",
-    "hip-vans-act",
-    "hot-cycles-notice",
-    "itchy-drinks-refuse",
-    "itchy-roses-accept",
-    "kind-fishes-develop",
-    "late-trainers-peel",
-    "light-dolphins-taste",
-    "light-sloths-end",
-    "lucky-hats-push",
-    "many-papayas-hide",
-    "metal-needles-search",
-    "mighty-penguins-wink",
-    "modern-feet-do",
-    "moody-lobsters-listen",
-    "nervous-goats-allow",
-    "nice-donkeys-reflect",
-    "nice-waves-work",
-    "polite-bees-care",
-    "popular-games-sleep",
-    "purple-lions-cough",
-    "rare-houses-prove",
-    "real-gorillas-move",
-    "rich-eagles-cross",
-    "rich-kids-carry",
-    "rude-fans-study",
-    "seven-foxes-melt",
-    "shiny-carrots-invent",
-    "short-jokes-jam",
-    "silly-knives-exist",
-    "slimy-maps-press",
-    "slow-ravens-explain",
-    "small-buttons-rhyme",
-    "small-cycles-rescue",
-    "small-kids-film",
-    "smart-rats-explode",
-    "smooth-coins-collect",
-    "smooth-pens-reply",
-    "soft-mails-clean",
-    "sour-pillows-guess",
-    "strange-seahorses-impress",
-    "tall-bikes-develop",
-    "tall-cups-suffer",
-    "tame-doors-shop",
-    "tidy-squids-poke",
-    "tough-taxis-smoke",
-    "tough-tips-drop",
-    "twenty-snakes-sort",
-    "unlucky-sheep-change",
-    "yellow-cats-judge",
-    "young-phones-fold",
-    "young-turtles-explode"
-  ]
-}

package/.changeset/purple-lions-cough.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-`ObservableQuery.setVariables` will now resolve with the last emitted result instead of `undefined` when either the variables match the current variables or there are no subscribers to the query.

package/.changeset/rare-houses-prove.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": minor
----
-
-Add `react-server` entry point with stubs for normal exports.

package/.changeset/real-gorillas-move.md

@@ -1,21 +0,0 @@
----
-"@apollo/client": major
----
-
-Apollo Client now defaults to production mode, not development mode, if the
-environment cannot be determined.
-
-In modern bundlers, this should automatically be handled by the bundler loading
-the bundler with the `development` export condition.
-
-If neither the `production` nor the `development` export condition are
-used by the bundler/runtime, Apollo Client will fall back to `globalThis.__DEV__`
-to determine if it should run in production or development mode.
-
-Unlike Apollo Client 3 though, if `globalThis.__DEV__` is not set to `true`,
-Apollo Client will now default to `production`, not to `development`, behaviour.
-
-This switch to *explicilty* requiring `true` also resolves a situation where
-an HTML element with `id="__DEV__"` would create a global `__DEV__` variable
-with a referent to the DOM element, which in the past was picked up as "truthy" and
-would have triggered development mode.

package/.changeset/rich-eagles-cross.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-The `reobserve` option is no longer available in the result returned from `useLazyQuery`. This was considered an internal API and should not be used directly.

package/.changeset/rich-kids-carry.md

@@ -1,9 +0,0 @@
----
-"@apollo/client": major
----
-
-Fix type of `data` property on `ApolloQueryResult`. Previously this field was non-optional, non-null `TData`, however at runtime this value could be set to `undefined`. This field is now reported as `TData | undefined`.
-
-This will affect you in a handful of places:
-- The `data` property emitted from the result passed to the `next` callback from `client.watchQuery`
-- Fetch-based APIs that return an `ApolloQueryResult` type such as `observableQuery.refetch`, `observableQuery.fetchMore`, etc.

package/.changeset/rude-fans-study.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": minor
----
-
-Deprecate the `partial` flag on `ApolloQueryResult` and make it a non-optional property. Previously `partial` was only set conditionally if the result emitted was partial. This value is now available with all results that return an `ApolloQueryResult`.

package/.changeset/seven-foxes-melt.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-The promise returned when calling the execute function from `useLazyQuery` will now reject when using an `errorPolicy` of `none` when GraphQL errors are returned from the result.

package/.changeset/shiny-carrots-invent.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove `subscribeAndCount` testing utility from `@apollo/client/testing`.

package/.changeset/short-jokes-jam.md

@@ -1,27 +0,0 @@
----
-"@apollo/client": major
----
-
-Moves all React-related exports to the `@apollo/client/react` entrypoint and out of the main `@apollo/client` entrypoint. This prevents the need to install React in order to use the core client.
-
-The following is a list of exports available in `@apollo/client` that should now import from `@apollo/client/react`.
-- `ApolloConsumer`
-- `ApolloProvider`
-- `createQueryPreloader`
-- `getApolloContext`
-- `skipToken`
-- `useApolloClient`
-- `useBackgroundQuery`
-- `useFragment`
-- `useLazyQuery`
-- `useLoadableQuery`
-- `useMutation`
-- `useQuery`
-- `useQueryRefHandlers`
-- `useReactiveVar`
-- `useReadQuery`
-- `useSubscription`
-- `useSuspenseQuery`
-
-The following is a list of exports available in `@apollo/client/testing` that should now import from `@apollo/client/testing/react`:
-- `MockedProvider`

package/.changeset/silly-knives-exist.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Removes the `urql` multipart subscriptions utilities. Use the native multipart subscriptions support in `urql` instead.

package/.changeset/slimy-maps-press.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": patch
----
-
-Fix up the 4.0 CommonJS build

package/.changeset/slow-ravens-explain.md

@@ -1,19 +0,0 @@
----
-"@apollo/client": major
----
-
-Switch to [RxJS](https://rxjs.dev/) as the observable implementation. `rxjs` is now a peer dependency of Apollo Client which means you will now need to install `rxjs` in addition to `@apollo/client`.
-
-This change is mostly transparent, however transforming values on observables, common in link implementations, differs in RxJS vs `zen-observable`. For example, you could modify values in the link chain emitted from a downstream link by using the `.map` function. In RxJS, this is done with the `.pipe` function and passing a `map` operator instead.
-
-```ts
-import { map } from "rxjs";
-
-const link new ApolloLink((operation, forward) => {
-  return forward(operation).pipe(
-    map((result) => performTransform(result))
-  );
-});
-```
-
-For a full list of operators and comprehensive documentation on the capabilities of RxJS, check out the [documentation](https://rxjs.dev/).

package/.changeset/small-buttons-rhyme.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove the deprecated `canonizeResults` option. It was prone to memory leaks. As such, some results that were referentially equal when `canonizeResults` option was set to `true` no longer retain the same object identity.

package/.changeset/small-cycles-rescue.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": patch
----
-
-Don't emit a partial cache result from `cache-only` queries when `returnPartialData` is `false`.

package/.changeset/small-kids-film.md

@@ -1,14 +0,0 @@
----
-"@apollo/client": major
----
-
-Rework package publish format (#12329, #12382)
-
-We have reworked the way Apollo Client is packaged.
-
-* shipping ESM and CJS
-* fixing up source maps
-* the build targets a modern runtime environment (browserslist query: `"since 2023, node >= 20, not dead"`)
-* removed the "proxy directory" `package.json` files, e.g. `cache/core/package.json` and `react/package.json`. While these helped with older build tools, modern build tooling uses the `exports` field in the root `package.json` instead and the presence of these files can confuse modern build tooling. If your build tooling still relies on those, please update your imports to import from e.g. `@apollo/client/cache/core/index.js` instead of `@apollo/client/cache/core` - but generally, this should not be necessary.
-* added an `exports` field to `package.json` to expose entry points
-* instead of `globalThis.__DEV__`, Apollo Client now primarily relies on the `development` and `production` exports conditions. It falls back to `globalThis.__DEV__` if the bundler doesn't know these, though.

package/.changeset/smart-rats-explode.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove `ObservableQuery.resetQueryStoreErrors` method. This method reset some internal state that was not consumed elsewhere in the client and resulted in a no-op.

package/.changeset/smooth-coins-collect.md

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

package/.changeset/smooth-pens-reply.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": major
----
-
-Require environments that support `WeakMap`, `WeakSet` and symbols. Apollo Client would fallback to `Map` and `Set` if the weak versions were not available. This has been removed and expects that these features are available in the source environment.
-
-If you are running in an environment without `WeakMap`, `WeakSet` or symbols, you will need to find appropriate polyfills.

package/.changeset/soft-mails-clean.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-`useLazyQuery` no longer supports calling the execute function in render and will now throw. If you need to execute the query immediately, use `useQuery` instead or move the call to a `useEffect`.

package/.changeset/sour-pillows-guess.md

@@ -1,7 +0,0 @@
----
-"@apollo/client": major
----
-
-The `defaultOptions` and `initialFetchPolicy` options are no longer supported with `useLazyQuery`.
-
-If you use `defaultOptions`, pass those options directly to the hook instead. If you use `initialFetchPolicy`, use `fetchPolicy` instead.

package/.changeset/strange-seahorses-impress.md

@@ -1,17 +0,0 @@
----
-"@apollo/client": major
----
-
-`useLazyQuery` no longer supports `variables` in the hook options and therefore no longer performs variable merging. The execute function must now be called with `variables` instead.
-
-```ts
-function MyComponent() {
-  const [execute] = useLazyQuery(query);
-
-  function runExecute() {
-    execute({ variables: { ... }});
-  }
-}
-```
-
-This change means the execute function returned from `useLazyQuery` is more type-safe. The execute function will require you to pass a `variables` option if the query type includes required variables.

package/.changeset/tall-bikes-develop.md

@@ -1,5 +0,0 @@
----
-"@apollo/client": major
----
-
-Remove `resetResultIdentities` option from `InMemoryCache.gc()`. This affected object canonization which has been removed.

package/.changeset/tall-cups-suffer.md

@@ -1,13 +0,0 @@
----
-"@apollo/client": major
----
-
-### Changes for users of `InMemoryCache`
-
-`cache.diff` now returns `null` instead of an empty object (`{}`) when `returnPartialData` is `true` and the result is empty.
-
-If you use `cache.diff` directly with `returnPartialData: true`, you will need to check for `null` before accessing any other fields on the `result` property. A non-null value indicates that at least one field was present in the cache for the given query document.
-
-### Changes for third-party cache implementations
-
-The client now expects `cache.diff` to return `null` instead of an empty object when there is no data that can be fulfilled from the cache and `returnPartialData` is `true`. If your cache implementation returns an empty object, please update this to return `null`.