v3.13.1

Compare Source

Patch Changes

• #​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.

v3.13.0

Compare Source

Minor Changes

• #​12066 c01da5d Thanks @​jerelmiller! - Adds a new useSuspenseFragment hook.

  useSuspenseFragment suspends until data is complete. It is a drop-in replacement for useFragment when you prefer to use Suspense to control the loading state of a fragment. See the documentation for more details.

• #​12174 ba5cc33 Thanks @​jerelmiller! - Ensure errors thrown in the onCompleted callback from useMutation don't call onError.

• #​12340 716d02e Thanks @​phryneas! - Deprecate the onCompleted and onError callbacks of useQuery and useLazyQuery.
  For more context, please see the related issue on GitHub.

• #​12276 670f112 Thanks @​Cellule! - Provide a more type-safe option for the previous data value passed to observableQuery.updateQuery. Using it could result in crashes at runtime as this callback could be called with partial data even though its type reported the value as a complete result.

  The updateQuery callback function is now called with a new type-safe previousData property and a new complete property in the 2nd argument that determines whether previousData is a complete or partial result.

  As a result of this change, it is recommended to use the previousData property passed to the 2nd argument of the callback rather than using the previous data value from the first argument since that value is not type-safe. The first argument is now deprecated and will be removed in a future version of Apollo Client.

  observableQuery.updateQuery(
    (unsafePreviousData, { previousData, complete }) => {
      previousData;
      // ^? TData | DeepPartial<TData> | undefined
  
      if (complete) {
        previousData;
        // ^? TData
      } else {
        previousData;
        // ^? DeepPartial<TData> | undefined
      }
    }
  );

• #​12174 ba5cc33 Thanks @​jerelmiller! - Reject the mutation promise if errors are thrown in the onCompleted callback of useMutation.

Patch Changes

• #​12276 670f112 Thanks @​Cellule! - Fix the return type of the updateQuery function to allow for undefined. updateQuery had the ability to bail out of the update by returning a falsey value, but the return type enforced a query value.

  observableQuery.updateQuery(
    (unsafePreviousData, { previousData, complete }) => {
      if (!complete) {
        // Bail out of the update by returning early
        return;
      }
  
      // ...
    }
  );

• #​12296 2422df2 Thanks @​Cellule! - Deprecate option ignoreResults in useMutation.
  Once this option is removed, existing code still using it might see increase in re-renders.
  If you don't want to synchronize your component state with the mutation, please use useApolloClient to get your ApolloClient instance and call client.mutate directly.

• #​12338 67c16c9 Thanks @​phryneas! - In case of a multipart response (e.g. with @defer), query deduplication will
  now keep going until the final chunk has been received.

• #​12276 670f112 Thanks @​Cellule! - Fix the type of the variables property passed as the 2nd argument to the subscribeToMore callback. This was previously reported as the variables type for the subscription itself, but is now properly typed as the query variables.

v3.12.11

Compare Source

Patch Changes

• #​12351 3da908b Thanks @​jerelmiller! - Fixes an issue where the wrong networkStatus and loading value was emitted from observableQuery when calling fetchMore with a no-cache fetch policy. The networkStatus now properly reports as ready and loading as false after the result is returned.

• #​12354 a24ef94 Thanks @​phryneas! - Fix missing main.d.cts file

v3.12.10

Compare Source

Patch Changes

• #​12341 f2bb0b9 Thanks @​phryneas! - useReadQuery/useQueryRefHandlers: Fix a "hook order" warning that might be emitted in React 19 dev mode.

• #​12342 219b26b Thanks @​phryneas! - Add graphql-ws ^6.0.3 as a valid peerDependency

v3.12.9

Compare Source

Patch Changes

• #​12321 daa4f33 Thanks @​jerelmiller! - Fix type of extensions in protocolErrors for ApolloError and the onError link. According to the multipart HTTP subscription protocol, fatal tranport errors follow the GraphQL error format which require extensions to be a map as its value instead of an array.

• #​12318 b17968b Thanks @​jerelmiller! - Allow RetryLink to retry an operation when fatal transport-level errors are emitted from multipart subscriptions.

  const retryLink = new RetryLink({
    attempts: (count, operation, error) => {
      if (error instanceof ApolloError) {
        // errors available on the `protocolErrors` field in `ApolloError`
        console.log(error.protocolErrors);
      }
  
      return true;
    },
  });

v3.12.8

Compare Source

Patch Changes

• #​12292 3abd944 Thanks @​phryneas! - Remove unused dependency response-iterator

• #​12287 bf313a3 Thanks @​phryneas! - Fixes an issue where client.watchFragment/useFragment with @includes crashes when a separate cache update writes to the conditionally included fields.

v3.12.7

Compare Source

Patch Changes

• #​12281 d638ec3 Thanks @​jerelmiller! - Make fatal tranport-level errors from multipart subscriptions available to the error link with the protocolErrors property.

  const errorLink = onError(({ protocolErrors }) => {
    if (protocolErrors) {
      console.log(protocolErrors);
    }
  });

• #​12281 d638ec3 Thanks @​jerelmiller! - Fix the array type for the errors field on the ApolloPayloadResult type. This type was always in the shape of the GraphQL error format, per the multipart subscriptions protocol and never a plain string or a JavaScript error object.

v3.12.6

Compare Source

Patch Changes

• #​12267 d57429d Thanks @​jerelmiller! - Maintain the TData type when used with Unmasked when TData is not a masked type generated from GraphQL Codegen.

• #​12270 3601246 Thanks @​jerelmiller! - Fix handling of tagged/branded primitive types when used as scalar values with Unmasked.

v3.12.5

Compare Source

Patch Changes

• #​12252 cb9cd4e Thanks @​jerelmiller! - Changes the default behavior of the MaybeMasked type to preserve types unless otherwise specified. This change makes it easier to upgrade from older versions of the client where types could have unexpectedly changed in the application due to the default of trying to unwrap types into unmasked types. This change also fixes the compilation performance regression experienced when simply upgrading the client since types are now preserved by default.

  A new mode option has now been introduced to allow for the old behavior. See the next section on migrating if you wish to maintain the old default behavior after upgrading to this version.

Migrating from <= v3.12.4

If you've adopted data masking and have opted in to using masked types by setting the enabled property to true, you can remove this configuration entirely:

-declare module "@​apollo/client" {
-  interface DataMasking {
-    mode: "unmask"
-  }
-}

If you prefer to specify the behavior explicitly, change the property from enabled: true, to mode: "preserveTypes":

declare module "@​apollo/client" {
  interface DataMasking {
-    enabled: true
+    mode: "preserveTypes"
  }
}

If you rely on the default behavior in 3.12.4 or below and would like to continue to use unmasked types by default, set the mode to unmask:

declare module "@​apollo/client" {
  interface DataMasking {
    mode: "unmask";
  }
}

v3.12.4

Compare Source

Patch Changes

• #​12236 4334d30 Thanks @​charpeni! - Fix an issue with refetchQueries where comparing DocumentNodes internally by references could lead to an unknown query, even though the DocumentNode was indeed an active query—with a different reference.

v3.12.3

Compare Source

Patch Changes

• #​12214 8bfee88 Thanks @​phryneas! - Data masking: prevent infinite recursion of ContainsFragmentsRefs type

• #​12204 851deb0 Thanks @​jerelmiller! - Fix Unmasked unwrapping tuple types into an array of their subtypes.

• #​12204 851deb0 Thanks @​jerelmiller! - Ensure MaybeMasked does not try and unwrap types that contain index signatures.

• #​12204 851deb0 Thanks @​jerelmiller! - Ensure MaybeMasked does not try to unwrap the type as Unmasked if the type contains any.

v3.12.2

Compare Source

Patch Changes

• #​12175 84af347 Thanks @​jerelmiller! - Update peer deps to allow for React 19 stable release.

v3.12.1

Compare Source

Patch Changes

• #​12171 e1efe74 Thanks @​phryneas! - Fix import extension in masking entry point.

v3.12.0

Compare Source

Minor Changes

Data masking 🎭

• #​12042 1c0ecbf Thanks @​jerelmiller! - Introduces data masking in Apollo Client.

  Data masking enforces that only the fields requested by the query or fragment is available to that component. Data masking is best paired with colocated fragments.

  To enable data masking in Apollo Client, set the dataMasking option to true.

  new ApolloClient({
    dataMasking: true,
    // ... other options
  });

  For detailed information on data masking, including how to incrementally adopt it in an existing applications, see the data masking documentation.

• #​12131 21c3f08 Thanks @​jerelmiller! - Allow null as a valid from value in useFragment.

v3.11.10

Compare Source

Patch Changes

• #​12093 1765668 Thanks @​mgmolisani! - Fixed a bug when evaluating the devtools flag with the new syntax devtools.enabled that could result to true when explicitly set to false.

v3.11.9

Compare Source

Patch Changes

• #​12110 a3f95c6 Thanks @​jerelmiller! - Fix an issue where errors returned from a fetchMore call from a Suspense hook would cause a Suspense boundary to be shown indefinitely.

v3.11.8

Compare Source

Patch Changes

• #​12054 35cf186 Thanks @​phryneas! - Fixed a bug where incorrect object access in some Safari extensions could cause a crash.

v3.11.7

Compare Source

Patch Changes

• #​12052 e471cef Thanks @​jerelmiller! - Fixes a regression from where passing an invalid identifier to from in useFragment would result in the warning TypeError: Cannot read properties of undefined (reading '__typename').

v3.11.6

Compare Source

Patch Changes

• #​12049 9c26892 Thanks @​phryneas and @​maciesielka! - Fix a bug where useFragment did not re-render as expected

• #​12044 04462a2 Thanks @​DoctorJohn! - Cache the useSubscription hook's restart function definition between re-renders.

v3.11.5

Compare Source

Patch Changes

• #​12027 eb3e21b Thanks @​JavaScriptBach! - Type MutationResult.reset as an arrow function

• #​12020 82d8cb4 Thanks @​jerelmiller! - Better conform to Rules of React by avoiding write of ref in render for useFragment.

v3.11.4

Compare Source

Patch Changes

• #​11994 41b17e5 Thanks @​jerelmiller! - Update the Modifier function type to allow cache.modify to return deeply partial data.

• #​11989 e609156 Thanks @​phryneas! - Fix a potential crash when calling clearStore while a query was running.

  Previously, calling client.clearStore() while a query was running had one of these results:

  • useQuery would stay in a loading: true state.
  • useLazyQuery would stay in a loading: true state, but also crash with a "Cannot read property 'data' of undefined" error.

  Now, in both cases, the hook will enter an error state with a networkError, and the promise returned by the useLazyQuery execute function will return a result in an error state.

• #​11994 41b17e5 Thanks @​jerelmiller! - Prevent accidental distribution on cache.modify field modifiers when a field is a union type array.

v3.11.3

Compare Source

Patch Changes

• #​11984 5db1659 Thanks @​jerelmiller! - Fix an issue where multiple fetches with results that returned errors would sometimes set the data property with an errorPolicy of none.

• #​11974 c95848e Thanks @​jerelmiller! - Fix an issue where fetchMore would write its result data to the cache when using it with a no-cache fetch policy.

• #​11974 c95848e Thanks @​jerelmiller! - Fix an issue where executing fetchMore with a no-cache fetch policy could sometimes result in multiple network requests.

• #​11974 c95848e Thanks @​jerelmiller! -

Potentially disruptive change

When calling fetchMore with a query that has a no-cache fetch policy, fetchMore will now throw if an updateQuery function is not provided. This provides a mechanism to merge the results from the fetchMore call with the query's previous result.

v3.11.2

Compare Source

Patch Changes

• #​11980 38c0a2c Thanks @​jerelmiller! - Fix missing getServerSnapshot error when using useSubscription on the server.

v3.11.1

Compare Source

Patch Changes

• #​11969 061cab6 Thanks @​jerelmiller! - Remove check for window.__APOLLO_CLIENT__ when determining whether to connect to Apollo Client Devtools when connectToDevtools or devtools.enabled is not specified. This now simply checks to see if the application is in development mode.

• #​11971 ecf77f6 Thanks @​jerelmiller! - Prevent the setTimeout for suggesting devtools from running in non-browser environments.

v3.11.0

Compare Source

Potentially Breaking Fixes

• #​11789 5793301 Thanks @​phryneas! - Changes usages of the GraphQLError type to GraphQLFormattedError.

  This was a type bug - these errors were never GraphQLError instances
  to begin with, and the GraphQLError class has additional properties that can
  never be correctly rehydrated from a GraphQL result.
  The correct type to use here is GraphQLFormattedError.

  Similarly, please ensure to use the type FormattedExecutionResult
  instead of ExecutionResult - the non-"Formatted" versions of these types
  are for use on the server only, but don't get transported over the network.

• #​11626 228429a Thanks @​phryneas! - Call nextFetchPolicy with "variables-changed" even if there is a fetchPolicy specified.

  Previously this would only be called when the current fetchPolicy was equal to the fetchPolicy option or the option was not specified. If you use nextFetchPolicy as a function, expect to see this function called more often.

  Due to this bug, this also meant that the fetchPolicy might be reset to the initial fetchPolicy, even when you specified a nextFetchPolicy function. If you previously relied on this behavior, you will need to update your nextFetchPolicy callback function to implement this resetting behavior.

  As an example, if your code looked like the following:

  useQuery(QUERY, {
    nextFetchPolicy(currentFetchPolicy, info) {
      // your logic here
    }
  );

  Update your function to the following to reimplement the resetting behavior:

  useQuery(QUERY, {
    nextFetchPolicy(currentFetchPolicy, info) {
      if (info.reason === 'variables-changed') {
        return info.initialFetchPolicy;
      }
      // your logic here
    }
  );

Minor Changes

• #​11923 d88c7f8 Thanks @​jerelmiller! - Add support for subscribeToMore function to useQueryRefHandlers.

• #​11854 3812800 Thanks @​jcostello-atlassian! - Support extensions in useSubscription

• #​11923 d88c7f8 Thanks @​jerelmiller! - Add support for subscribeToMore function to useLoadableQuery.

• #​11863 98e44f7 Thanks @​phryneas! - Reimplement useSubscription to fix rules of React violations.

• #​11869 a69327c Thanks @​phryneas! - Rewrite big parts of useQuery and useLazyQuery to be more compliant with the Rules of React and React Compiler

• #​11936 1b23337 Thanks @​jerelmiller! - Add the ability to specify a name for the client instance for use with Apollo Client Devtools. This is useful when instantiating multiple clients to identify the client instance more easily. This deprecates the connectToDevtools option in favor of a new devtools configuration.

  new ApolloClient({
    devtools: {
      enabled: true,
      name: "Test Client",
    },
  });

  This option is backwards-compatible with connectToDevtools and will be used in the absense of a devtools option.

• #​11923 d88c7f8 Thanks @​jerelmiller! - Add support for subscribeToMore function to useBackgroundQuery.

• #​11930 a768575 Thanks @​jerelmiller! - Deprecates experimental schema testing utilities introduced in 3.10 in favor of recommending @apollo/graphql-testing-library.

Patch Changes

• #​11951 0de03af Thanks @​phryneas! - add React 19 RC to peerDependencies

• #​11927 2941824 Thanks @​phryneas! - Add restart function to useSubscription.

• #​11949 4528918 Thanks @​alessbell! - Remove deprecated watchFragment option, canonizeResults

• #​11937 78332be Thanks @​phryneas! - createSchemaFetch: simulate serialized errors instead of an ApolloError instance

• #​11902 96422ce Thanks @​phryneas! - Add cause field to ApolloError.

• #​11806 8df6013 Thanks @​phryneas! - MockLink: add query default variables if not specified in mock request

• #​11926 3dd6432 Thanks @​phryneas! - watchFragment: forward additional options to diffOptions

• #​11946 7d833b8 Thanks @​jerelmiller! - Fix issue where mutations were not accessible by Apollo Client Devtools in 3.11.0-rc.0.

• #​11944 8f3d7eb Thanks @​sneyderdev! - Allow IgnoreModifier to be returned from a optimisticResponse function when inferring from a TypedDocumentNode when used with a generic argument.

• #​11954 4a6e86a Thanks @​phryneas! - Document (and deprecate) the previously undocumented errors property on the useQuery QueryResult type.

• #​11719 09a6677 Thanks @​phryneas! - Allow wrapping createQueryPreloader

• #​11921 70406bf Thanks @​phryneas! - add ignoreResults option to useSubscription