react-apollo-form

react-apollo-form copied to clipboard

v3.1.5

Compare Source

v3.1.4

Compare Source

v3.1.3

Compare Source

• Revert the changes made in #​3497, which have lead to problems with onCompleted being called more often than necessary.
  @​hwillson in 0901f4a

v3.1.2

Compare Source

Bug Fixes

• Make sure SSR is fully disabled when using ssr: false and ssrMode: true.
  @​maapteh in #​3515
• Fixed MockLink's broken newData function handling.
  @​pawelkleczek in #​3539
• Fixed an issue that prevented networkStatus from changing ready at the end of pagination.
  @​mu29 in #​3514

v3.1.1

Compare Source

Improvements

• Calling startPolling or stopPolling after a component has unmounted is now a no-op (instead of throwing an exception). Polling is automatically stopped when a component is unmounted, so it doesn't need to be called manually.
  @​hwillson in #​3485
• Allow ignoreResults to be controlled through graphql and withMutation options.
  @​tim-stasse in #​3431
• Be a bit more defensive when it comes to accessing the internal ObservableQuery instance, to avoid attempting to use it after a component has unmounted.
  @​jfrolich in #​3490

Bug Fixes

• A fix has been applied to prevent an unchanging loading state when an error occurs after a refetch, that is the same as the previous error.
  @​jet2jet in #​3477
• Add back in the removed ChildDataProps and ChildMutateProps types.
  @​hwillson in #​3495
• Make sure onCompleted is called each time a useLazyQuery based query completes, after the execution function is called.
  @​hwillson in #​3497

v3.1.0

Compare Source

Potentially Breaking Change

• Change the default query data state from {} to undefined. This change aligns all parts of the React Apollo query cycle so that data is always undefined if there is no data, instead of data being converted into an empty object. This change impacts the initial query response, initial SSR response, data value when errors occur, data value when skipping, etc. All of these areas are now aligned to only ever return a value for data if there really is a value to return (instead of making it seem like there is one by converting to {}).
  @​hwillson in #​3388

Bug Fixes

• Adds support for the skip option when using useSubscription.
  @​n1ru4l in #​3356
• Makes sure refetch, fetchMore, updateQuery, startPolling, stopPolling, and subscribeToMore maintain a stable identity when they're passed back alongside query results.
  @​hwillson in #​3422
• Fixed problematic re-renders that were caused by using fetchMore.updateQuery with notifyOnNetworkStatusChange set to true. When notifyOnNetworkStatusChange is true, re-renders will now wait until updateQuery has completed, to make sure the updated data is used during the render.
  @​hwillson in #​3433
• Add client to the useMutation result.
  @​joshalling in #​3417
• Prevent inline onError and onCompleted callbacks from being part of the internal memoization that's used to decide when certain after render units of functionality are run, when using useQuery. This fixes issues related to un-necessary component cleanup, like error disappearing from results when it should be present.
  @​dylanwulf in #​3419
• useLazyQuery's execution function can now be called multiple times in a row, and will properly submit network requests each time called, when using a fetch policy of network-only.
  @​hwillson in #​3453
• SSR enhancements to support network-only and cache-and-network fetch policies, along with changes to ensure disabled SSR queries are not fired.
  @​mikebm in #​3435
• Remove void from the MutationFunction's returned Promise types.
  @​hwillson in #​3458
• Prevent duplicate onCompleted calls during the same query execution cycle.
  @​hwillson in #​3461
• Make sure polling is stopped when a component is unmounted.
  @​dqunbp in #​3273
• Documentation fixes.
  @​SeanRoberts in #​3380

v3.0.1

Compare Source

Improvements

• Documentation updates.
  @​joshalling in #​3324

Bug Fixes

• Dedupe onError callback calls and ensure refetch sets loading state properly.
  @​hwillson in #​3339
• Add missing useLazyQuery export to the react-apollo (all) package.
  @​hwillson in #​3320
• Remove void from being one of the MutationTuple mutate function possible generics. This will make it easier to properly destructure results returned by the mutate function Promise.
  @​hwillson in #​3334
• Export MockedProviderProps and MockedProviderState from @apollo/react-testing.
  @​hwillson in #​3337
• Add @types/react as a peer dep, to address potential TS compilation errors when using ApolloProvider.
  @​zkochan in #​3278
• Make sure error's are maintained after re-renders, when they should be.
  @​hwillson in #​3362

v3.0.0

Compare Source

Overview

This major release includes a large refactoring of the existing React Apollo codebase, to introduce new improvements, changes, features and bug fixes. The biggest new features are:

• Provides new useQuery, useLazyQuery, useMutation, useSubscription, and useApolloClient hooks, following React's Hooks API.
• Maintains support for React Apollo's graphql HOC and render proper components.
• Introduces a new monorepo structure, with separately published packages, making it easier to use just the parts of React Apollo you're interested in:
  • @apollo/react-common
  • @apollo/react-hooks
  • @apollo/react-components
  • @apollo/react-hoc
  • @apollo/react-ssr
  • @apollo/react-testing
• Thorough codebase pruning and cleaning to reduce the overall React Apollo bundle size.
• And more!

Consult the Hooks migration guide for more details around upgrading. For more information regarding how to use the new hooks, please consult the updated React Apollo docs (all docs have been updated to be hooks first).

Breaking Changes

• The minimum supported React version is now 16.8.

• The react-apollo@3 package preserves most of the functionality of react-apollo@2 by re-exporting existing components and functions from @apollo/react-components and @apollo/react-hoc. If you want to use Hooks, Components, or HOC directly, import the new @apollo/react-hooks, @apollo/react-components, and/or @apollo/react-hoc packages instead.

• React Apollo testing utilities are no longer available as part of the react-apollo package. They should now be imported from the new @apollo/react-testing package.

• The deprecated walkTree function has been removed (9b24d756).

• The deprecated GraphqlQueryControls and MutationFunc types have been removed (ade881f0).

• Preact is no longer supported (b742ae63).

• Various Typescript type changes. Since we've introduced a third way of managing data with React (Hooks), we had to rework many of the existing exported types to better align with the Hooks way of doing things. Base types are used to hold common properties across Hooks, Components and the graphql HOC, and these types are then extended when needed to provide properties that are specific to a certain React paradigm (30edb1b0 and 3d138db3).

• catchAsyncError, wrap, and compose utilities have been removed (2c3a262, 7de864e, and e6089a7).

  Previously, compose was imported then exported directly from lodash using flowRight. To keep using compose, install the lodash.flowright package, then update your compose imports as:

  import compose from 'lodash.flowright';
  

• Render prop components (Query, Mutation and Subscription) can no longer be extended. In other words, this is no longer possible:

  class SomeQuery extends Query<SomeData, SomeVariables> {}
  

  All class based render prop components have been converted to functional components, so they could then just wrap their hook based equivalents (useQuery, useMutation, useSubscription).

  While we recommend switching over to use the new hooks as soon as possible, if you're looking for a stop gap you can consider typing a Query component in a similar fashion, like:

  export const SomeQuery = () => (
    <Query<SomeData, SomeVariables> query={SOME_QUERY} ...>
      {({ data }) => {
        return <div> ... things happen... </div>;
      }}
    </Query>
  );
  

v2.5.8

Compare Source

2.5.8 (2019-06-21)

Bug Fixes

• Makes the use of apollo-client 2.6.3's ObservableQuery.resetQueryStoreErrors method optional, for people who can't update to react-apollo's new apollo-client peer dep of 2.6.3. @​hwillson in #​3151

v2.5.7

Compare Source

Improvements

• Make sure MockedProvider is using the proper CJS/ESM bundle, when referencing ApolloProvider.
  @​jure in #​3029.
• Adjust the ApolloContext definition to play a bit more nicely with React.createContext types.
  @​JoviDeCroock in #​3018
• The result of a mutation is now made available to the wrapped component, when using the graphql HOC.
  @​andycarrell in #​3008
• Check equality of stringified variables in the MockLink to improve debugging experience used by MockedProvider.
  @​evans in #​3078

Bug Fixes

• Removed leftover apollo-client@beta peer dep.
  @​brentertz in #​3064
• Stop setting optional input to null, when using the graphql HOC.
  @​ZhengYuTay in #​3056
• Fix typescript error caused by query being mandatory in the fetchMore signature.
  @​HsuTing in #​3065
• Fixes an issue that caused the Query component to get stuck in an always loading state, caused by receiving an error (meaning subsequent valid responses couldn't be handled). The Query component can now handle an error in a response, then continue to handle a valid response afterwards.
  @​hwillson in #​3107
• Reorder Subscription component code to avoid setting state on unmounted component.
  @​jasonpaulos in #​3139
• Fix component stuck in loading state for network-only fetch policy.
  @​jasonpaulos in #​3126

v2.5.6

Compare Source

Improvements

• Both the Query component and graphql HOC now accept a returnPartialData prop. This is an important new feature, that should help address a lot of open Apollo Client / React Apollo issues, so we'll explain it here with an example. Before this release, if you run a query that looks like:

  const GET_MEMBER = gql`
    query GetMember($id: ID!) {
      member(id: $id) {
        id
        name
      }
    }
  `;
  

  in one component, the results are cached, then you run a superset query like the following in another component:

  const GET_MEMBER_WITH_PLANS = gql`
    query GetMemberWithPlans($id: ID!) {
      member(id: $id) {
        id
        name
        plans {
          id
          title
          duration
        }
      }
    }
  `;
  

  Apollo Client will not re-use the partial data that was cached from the first query, when it preps and displays the second component. It can't find a cache hit for the full second query, so it fires the full query over the network.

  With this release, if you set a returnPartialData prop to true on the second component, the data available to that component will be automatically pre-loaded with the parts of the query that can be found in the cache, before the full query is fired over the network. This means you can do things like showing partial data in your components, while the rest of the data is being loaded over the network.

v2.5.5

Compare Source

Improvements

• Export the Apollo Context provider (ApolloContext).
  @​MrLoh in #​2961

v2.5.4

Compare Source

Bug Fixes

• Fixes Could not find "client" in the context of ApolloConsumer errors when using MockedProvider.
  @​hwillson in #​2907
• Ensure Query components using a fetchPolicy of no-cache have their data preserved when the components tree is re-rendered.
  @​hwillson in #​2914

Improvements

• Documentation updates.
  @​afenton90 in #​2932

v2.5.3

Compare Source

Bug Fixes

• Fixed an infinite loop caused by using setState in the onError / onCompleted callbacks of the Query component.
  @​chenesan in #​2751
• Fixed an issue that prevented good results from showing up in a Query component, after an error was received, variables were adjusted, and then the good data was fetched.
  @​MerzDaniel in #​2718
• Fixed an issue that prevented Query component updates from firing (under certain circumstances) due to the internal lastResult value (that's used to help prevent unnecessary re-renders) not being updated.
  @​Glennrs in #​2840

Improvements

• MockedProvider now accepts a childProps prop that can be used to pass props down to a child component.
  @​miachenmtl in #​2482

• onCompleted callbacks now use a destructuring-friendly type definition.
  @​jozanza in #​2496

• @connection directives are now properly stripped from MockedResponse's, when using MockedProvider.
  @​ajmath in #​2523

• MockedProvider has been updated to stop setting a default resolvers value of {}, which means by default Apollo Client 2.5 local resolver functionality is not enabled when mocking with MockedProvider. This allows @client fields to be passed through the mocked link chain, like people were used to before AC 2.5. When using this default mode you will see a dev only warning message about this like:

  Found @​client directives in query but no client resolvers were specified. You can now pass apollo-link-state resolvers to the ApolloClient constructor.

  This message can be safely ignored. If you want to use MockedProvider with AC 2.5's new local resolver functionality, you can pass your local resolver map into the MockedProvider resolvers prop.
  @​ajmath in #​2524

• Improvements to the graphql HOC generics for fetchMore and refetch.
  @​EricMcRay in #​2525

• The ApolloProvider / ApolloConsumer implementations have been refactored to use React 16.3's new context API.
  @​wzrdzl in #​2540

• All dependencies and devDependencies have been updated to their latest versions, and related Typescript changes have been applied.
  @​hwillson in #​2873

v2.5.2

Compare Source

Bug Fixes

• Export Context type from types.ts instead of walkTree.ts, to reenable import { Context } from 'react-apollo' (which has been broken since 2.4.0).
  @​benjamn in #​2825

Improvements

• Add examples/rollup to enable application-level bundle measurement and demonstrate Rollup configuration best practices.
  @​benjamn in #​2839

• Bundle size reductions inspired by examples/rollup app.
  @​benjamn in #​2842

v2.5.1

Compare Source

Bug Fixes

• Make sure MockedProvider enables Apollo Client 2.5's local state handling, and allow custom / mocked resolvers to be passed in as props, and used with the created test ApolloClient instance.
  @​hwillson in #​2825

v2.5.0

Compare Source

Improvements

• Ready to be used with Apollo Client 2.5 and its new local state management features, as well as many overall code improvements to help reduce the React Apollo bundle size.
  #​2758
• A function can now be set as a MockedResponse result when using MockedProvider, such that every time the mocked result is returned, the function is run to calculate the result. This opens up new testing possibilities, like being able to verify if a mocked result was actually requested and received by a test.
  @​hwillson in #​2788

v2.4.1

Compare Source

Improvements

• Adds a onSubscriptionComplete prop to the Subscription component, that can be passed a callback to be called when the subscription observable is completed.
  @​sujeetsr in #​2716

• During server-side rendering, ObservableQuery objects created in previous rendering passes will now be preserved in later passes (within the same getDataFromTree or getMarkupFromTree call), so that errors can be handled properly when using the errorPolicy: "all" option.
  PR #​2753

v2.4.0

Compare Source

Bug Fixes

• Invoke onCompleted/onError even if Mutation unmounts.
  PR #​2710

Improvements

• The walkTree function has been deprecated, since there's no way to make its behavior consistent with the latest versions of React. To save bundle size, walkTree is no longer exported from react-apollo, though you can still access it as follows:

  import { walkTree } from 'react-apollo/walkTree';
  

v2.3.3

Compare Source

Bug Fixes

• Add react-dom as a peer dependency (since it's used by getDataFromTree and renderToStringWithData).
  @​hwillson in #​2660

Improvements

• Drop react 14.x support, since the 14.x release line is 2 years old now, and react-apollo is no longer tested against it.
  @​hwillson in #​2660

v2.3.2

Compare Source

Improvements

Bug Fixes

• This package no longer imports react-dom/server unconditionally at the top level, making react-apollo safer to use in environments like React Native that are neither browser-like nor Node-like, and thus struggle to import react-dom/server and its dependencies. Additionally, the React Native bundler has been instructed to ignore all react-dom/server dependencies within react-apollo, so react-dom will not be bundled in React Native apps simply because they import react-apollo. PR #​2627

v2.3.1

Compare Source

Improvements

• Restore original getDataFromTree(tree, context) API, and introduce a new alternative called getMarkupFromTree to enable custom rendering functions:

  export default function getDataFromTree(
    tree: React.ReactNode,
    context: { [key: string]: any } = {},
  ) {
    return getMarkupFromTree({
      tree,
      context,
      renderFunction: renderToStaticMarkup,
    });
  }
  
  export type GetMarkupFromTreeOptions = {
    tree: React.ReactNode;
    context?: { [key: string]: any };
    renderFunction?: typeof renderToStaticMarkup;
  };
  
  export function getMarkupFromTree({
    tree,
    context = {},
    renderFunction = renderToStaticMarkup,
  }: GetMarkupFromTreeOptions): Promise<string> {...}
  

  PR #​2586

Bug Fixes

• Version 2.3.0 was published incorrectly, breaking nested react-apollo/... imports. This problem was fixed in version 2.3.1 by running npm publish from the lib/ directory, as intended. Issue #​2591

v2.3.0

Compare Source

Bug Fixes

• Fix networkStatus to reflect the loading state correctly for partial refetching.
  @​steelbrain in #​2493

Improvements

• Reimplement getDataFromTree using ReactDOM.renderToStaticMarkup to make asynchronous server-side rendering compatible with React hooks. Although the rendering function used by getDataFromTree defaults to renderToStaticMarkup, any suitable rendering function can be passed as the optional second argument to getDataFromTree, which now returns a Promise<string> that resolves to The HTML rendered in the final pass, which means calling renderToString after getDataFromTree may not be necessary anymore. PR #​2533

v2.2.4

Compare Source

Bug Fixes

• lodash.isequal was improperly set as a dev dependency for MockLink / MockedProvider. It is now a dependency.
  @​danilobuerger in #​2449

Improvements

• The Subscription component now accepts a fetchPolicy prop.
  @​MatthieuLemoine in #​2298

Typescript

• Make sure the TVariables generic is passed to ObservableQuery.
  @​tgriesser in #​2311

v2.2.3

Compare Source

Bug Fixes

• Mutation errors are now properly returned as a render prop, when using a default errorPolicy of all.
  @​amacleay in #​2374
• <Mutation /> refetchQueries triggered by name (string) will now use the correct variables.
  @​fracmal in #​2422

Improvements

• Replace the lodash dependency with lodash.flowright (since that's the only non-dev lodash function we're dependent on). Dev lodash dependencies have also been updated to use their individual module equivalent.
  @​hwillson in #​2435
• Removed rollup-plugin-babel-minify as it's no longer being used.
  @​hwillson in #​2436
• Small getDataFromTree.ts logic adjustment to avoid unnecessary calls when a falsy element is encountered.
  @​HOUCe in #​2429
• graphql 14 updates.
  @​hwillson in #​2437
• All example apps (included in the repo) have been updated to work with the latest version of React Apollo.
  @​hwillson in #​2439

Typescript

• Fix lodash typings.
  @​williamboman in #​2430
• Typings: added context to MutationOptions.
  @​danilobuerger in #​2354
• Typings: more MutationOptions changes/fixes.
  @​danilobuerger in #​2340
• Remove allowSyntheticDefaultImports use. Typescript's allowSyntheticDefaultImports compiler option is something we'd like to start using, but we jumped the gun a bit by introducing it in https://github.com/apollographql/react-apollo/commit/9a96519d390783dfd9a431dc2dbaa476a24f7b80. Including it means that anyone who wants to use Typescript with React Apollo would have to also include it in their own local tsconfig.json, to be able to handle default imports properly. This is because we're also using Typescript's es2015 module option, which means allowSyntheticDefaultImports has to be enabled explicitly. We've switched back to using a combination of import * as X and require syntax, to work with default imports. We'll re-introduce allowSyntheticDefaultImports use in React Apollo 3.
  @​hwillson in #​2438

v2.2.2

Compare Source

• When using React.createContext and SSR, we now make sure the context provider value is reset to the previous value it had after its children are walked.
  @​mitchellhamilton in #​2304
• Revert:
  When a query failed on the first result, the query result data was being returned as undefined. This behavior has been changed so that data is returned as an empty object. This makes checking for data (e.g. instead of data && data.user you can just check data.user) and destructring (e.g. { data: { user } }) easier. Note: this could potentially hurt applications that are relying on a falsey check of data to see if any query errors have occurred. A better (and supported) way to check for errors is to use the result errors property.
  #​1983

v2.2.1

Compare Source

• Revert: "Typescript: use Partial<TData> instead of TData | {}, for the QueryResult data property."

v2.2.0

• Improved TypeScript Typings: Deprecated MutationFunc in favor of MutationFn. Added missing onCompleted and onError callbacks to MutationOpts.
  @​danilobuerger in #​2322
• Added an example app that shows how to test mutations.
  @​excitement-engineer in #​1998
• The <Subscription /> component now allows the registration of a callback function, that will be triggered each time the component receives data. The callback options object param consists of the current Apollo Client instance in client, and the received subscription data in subscriptionData.
  @​jedwards1211 in #​1966
• The graphql options object is no longer mutated, when calculating variables from props. This now prevents an issue where components created with graphql were not having their query variables updated properly, when props changed.
  @​ksmth in #​1968
• When a query failed on the first result, the query result data was being returned as undefined. This behavior has been changed so that data is returned as an empty object. This makes checking for data (e.g. instead of data && data.user you can just check data.user) and destructring (e.g. { data: { user } }) easier. Note: this could potentially hurt applications that are relying on a falsey check of data to see if any query errors have occurred. A better (and supported) way to check for errors is to use the result errors property.
  @​TLadd in #​1983
• Allow a custom cache object to be passed into the test-utils MockedProvider.
  @​palmfjord in #​2254
• Make the MockedProvider mocks prop read only.
  @​amacleay in #​2284
• Remove duplicate FetchMoreOptions and FetchMoreQueryOptions types, and instead import them from Apollo Client.
  @​skovy in #​2281
• Type changes for the graphql HOC options.skip property.
  @​jameslaneconkling in #​2208
• Avoid importing lodash directly.
  @​shahyar in #​2045
• When the Query skip prop is set to true, make sure the render prop loading param is set to false, since we're not actually loading anything.
  @​edorivai in #​1916
• No longer building against Node 9
  @​hwillson in #​2404
• Make sure <Subscription />, <Query /> & <Mutation /> all support using an Apollo Client instance configured in the context or via props.
  @​quentin- in #​1956
• Typescript: use Partial<TData> instead of TData | {}, for the QueryResult data property.
  @​tgriesser in #​2313
• Adjust <Query /> onCompleted and onError callbacks to be triggered via the componentDidUpdate lifecycle method. This ensures these callbacks can be used when data is fetched over the network, and when data is fetched from the local store (previsouly these callbacks were only being triggered when data was fetched over the network). @​olistic in #​2190
• Import lodash/flowRight using ES import to allow for treeshaking.
  @​Pajn in #​2332
• Fixed a regression where variables passed in graphql HOC options were not merged with mutation variables.
  @​samginn in #​2216
• Added a new partialRefetch prop (false by default). When a Query component is mounted, and a mutation is executed that returns the same ID as the mounted Query, but has less fields in its result, Apollo Client's QueryManager returns the data as an empty Object since a hit can't be found in the cache. This can lead to application errors when the UI elements rendered by the original Query component are expecting certain data values to exist, and they're all of a sudden stripped away. The recommended way to handle this is to use the mutations update prop to reconcile the mutation result with the data in the cache, getting everything into the expected state. This can definitely be a cumbersome process however, so to help address this the partialRefetch prop can be used to automatically refetch the original query and update the cache.
  @​steelbrain in #​2003

v2.1.11

• Fixed an issue in getDataFromTree where queries that threw more than one error had error messages swallowed, and returned an invalid error object with circular references. Multiple errors are now preserved.
  @​anand-sundaram-zocdoc in #​2133
• Update both the <Mutation /> component and graphql HOC to accept a new awaitRefetchQueries prop (boolean). When set to true, queries specified in refetchQueries will be completed before the mutation itself is completed. awaitRefetchQueries is false by default, which means refetchQueries are usually completed after the mutation has resolved. Relates to Apollo Client.
  PR #​3169.
  @​hwillson in #​2214
• Typings adjustment: pass TData along into MutationUpdaterFn when using MutationOpts, to ensure that the updater function is properly typed.
  @​danilobuerger in #​2227
• Check if queryManager is set before accessing it.
  @​danilobuerger in #​2165

v2.1.9

• Added onCompleted and onError props to the Query component, than can be used to register callback functions that are to be executed after a query successfully completes, or an error occurs. @​jeshep in #​1922
• Add UNSAFE_componentWillMount SSR support. @​leops in #​2152
• Clear out scheduler on MockedProvider unmount. @​danilobuerger in #​2151

v2.1.8

• Addressed deployment issue.

v2.1.7

• The ApolloProvider children prop type has been changed from element to node, to allow multiple children. @​quentin- in #​1955
• Properly support the new getDerivedStateFromProps lifecycle method. @​amannn in #​2076
• lodash is no longer pinned to version 4.17.10. @​cherewaty in #​1951
• README updates to replace apollo-client-preset with apollo-boost. @​JamesTheHacker in #​1925
• README updates to fix broken links. @​DennisKo in #​1935
• Project README has been updated to show a <Query /> example. @​petetnt in #​2102

v2.1.6

• Adjust getDataFromTree to properly traverse React 16.3's context API provider/consumer approach. @​marnusw in #​1978
• An ApolloClient instance can now be passed into a Mutation component via a prop named client. This prop will override an ApolloClient instance set via context, by the ApolloProvider component. @​amneacsu in #​1890
• The ApolloClient instance used by a Mutation is now available in that Mutation's result. PR #​1945 @​cooperka in #​1945

v2.1.5

• Dependency updates to align with typescript changes made in apollo-client 2.3.3 PR #​2105