Version Packages (alpha)

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or setup this action to publish automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to release-4.0, this PR will be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

release-4.0 is currently in pre mode so this branch has prereleases rather than normal releases. If you want to exit prereleases, run changeset pre exit on release-4.0.

⚠️⚠️⚠️⚠️⚠️⚠️

Releases

@apollo/client@4.0.0-alpha.0

Major Changes

• #12379 ef892b4 Thanks @jerelmiller! - Removes the addTypename option from InMemoryCache and MockedProvider. __typename is now always added to the outgoing query document when using InMemoryCache and cannot be disabled.

  If you are using <MockedProvider /> with addTypename={false}, ensure that your mocked responses include a __typename field. This will ensure cache normalization kicks in and behaves more like production.

• #12222 d1a9054 Thanks @jerelmiller! - Drop support for React 16.

• #12376 a0c996a Thanks @jerelmiller! - Remove deprecated ignoreResults option from useMutation. If you don't want to synchronize component state with the mutation, use useApolloClient to access your client instance and use client.mutate directly.

• #12224 51e6c0f Thanks @jerelmiller! - Remove deprecated partialRefetch option.

• #12211 c2736db Thanks @jerelmiller! - Remove the deprecated graphql, withQuery, withMutation, withSubscription, and withApollo hoc components. Use the provided React hooks instead.

• #12262 10ef733 Thanks @jerelmiller! - Remove itAsync test utility.

• #12304 86469a2 Thanks @jerelmiller! - 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).

• #12254 0028ac0 Thanks @jerelmiller! - Changes the default Accept header to application/graphql-response+json.

• #12333 3e4beaa Thanks @jerelmiller! - 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.

• #12223 69c1cb6 Thanks @jerelmiller! - Remove subscribeAndCount testing utility from @apollo/client/testing.

• #12300 4d581e4 Thanks @jerelmiller! - 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

• #12329 61febe4 Thanks @phryneas! - Rework package publish format (Rework build process 1/? #12329, Rework build process 2/?: add babel transform #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")

• #12304 86469a2 Thanks @jerelmiller! - ### 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.

• #12359 ebb4d96 Thanks @jerelmiller! - Remove the onCompleted and onError callbacks from useQuery and useLazyQuery.

  See #12352 for more context on this change.

• #12304 86469a2 Thanks @jerelmiller! - ### Changes for users of InMemoryCache

  cache.diff no longer throws when returnPartialData is set to false without a complete result. Instead, cache.diff will return null when it is unable to read a full cache result.

  If you use cache.diff directly with returnPartialData: false, remove the try/catch block and replace with a check for null.

  Changes for third-party cache implementations

  The client now expects cache.diff to return null instead of throwing when the cache returns an incomplete result and returnPartialData is false. The internal try/catch blocks have been removed around cache.diff. If your cache implementation throws for incomplete results, please update this to return null.

• #12211 c2736db Thanks @jerelmiller! - Remove the deprecated Query, Mutation, and Subscription components. Use the provided React hooks instead.

Minor Changes

• #12333 3e4beaa Thanks @jerelmiller! - 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.

Patch Changes

• #12291 ae5d06a Thanks @phryneas! - Remove deprecated resetApolloContext export

• #12369 bdfc5b2 Thanks @phryneas! - ObervableQuery.refetch: don't refetch with cache-and-network, swich to network-only instead

• #12375 d3f8f13 Thanks @jerelmiller! - Export the UseSuspenseFragmentOptions type.

[svc-apollo-docs]

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branch release-4.0 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

• !docs set-base-branch version-2.6
• !docs set-base-branch main

Build ID: fcbde5d783778dd4203c9438

[netlify]

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	47616c0
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67b5ac851cd7620008ea9a28
😎 Deploy Preview	https://deploy-preview-12221--apollo-client-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pkg-pr-new]

npm i https://pkg.pr.new/@apollo/client@12221

commit: 47616c0

[github-actions]

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "dist/__cjs/index.cjs"	44 KB (+0.02% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/__cjs/index.cjs" (production)	41.51 KB (+0.02% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	33.02 KB (+0.02% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	30.54 KB (+0.03% 🔺)
import { ApolloProvider } from "dist/react/index.js"	1.17 KB (+0.51% 🔺)
import { ApolloProvider } from "dist/react/index.js" (production)	1.16 KB (+0.68% 🔺)
import { useQuery } from "dist/react/index.js"	4.58 KB (+0.11% 🔺)
import { useQuery } from "dist/react/index.js" (production)	3.75 KB (+0.16% 🔺)
import { useLazyQuery } from "dist/react/index.js"	4.96 KB (+0.12% 🔺)
import { useLazyQuery } from "dist/react/index.js" (production)	4.13 KB (+0.15% 🔺)
import { useMutation } from "dist/react/index.js"	3.31 KB (+0.18% 🔺)
import { useMutation } from "dist/react/index.js" (production)	2.61 KB (+0.23% 🔺)
import { useSubscription } from "dist/react/index.js"	4.18 KB (+0.15% 🔺)
import { useSubscription } from "dist/react/index.js" (production)	3.3 KB (+0.09% 🔺)
import { useSuspenseQuery } from "dist/react/index.js"	5.44 KB (+0.11% 🔺)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.22 KB (+0.14% 🔺)
import { useBackgroundQuery } from "dist/react/index.js"	4.93 KB (+0.12% 🔺)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.68 KB (+0.16% 🔺)
import { useLoadableQuery } from "dist/react/index.js"	4.98 KB (+0.12% 🔺)
import { useLoadableQuery } from "dist/react/index.js" (production)	3.74 KB (+0.14% 🔺)
import { useReadQuery } from "dist/react/index.js"	2.17 KB (+0.23% 🔺)
import { useReadQuery } from "dist/react/index.js" (production)	2.11 KB (+0.28% 🔺)
import { useFragment } from "dist/react/index.js"	1.88 KB (+0.27% 🔺)
import { useFragment } from "dist/react/index.js" (production)	1.83 KB (+0.27% 🔺)