/next-apollo-typescript

🔺🚀 The original Next.js Apollo example implemented with Typescript

Primary LanguageTypeScript

Apollo Example

Changes to work with Typescript

  • A tsconfig file has been created using the default values from Next and also extending it for strict type checking
  • Types have been added to the Apollo connector. Types are used from the apollo-client, apollo-cache-inmemory and @apollo/react-hooks libraries.
  • GraphQL queries and mutations have been structured out to a separate graphql folder for easier reusability, testing and code generation.
  • I used the graphql-code-generator to generate types based on the schema and the GraphQL queries/mutations. This enables type checking and intellisense on DTOs.
  • All the components have been converted to TSX, default imports have been replaced by names ones.

Demo

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-apollo with-apollo-app
# or
yarn create next-app --example with-apollo with-apollo-app

Download manually

Download the example:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-apollo
cd with-apollo

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with now (download):

now

The idea behind the example

Apollo is a GraphQL client that allows you to easily query the exact data you need from a GraphQL server. In addition to fetching and mutating data, Apollo analyzes your queries and their results to construct a client-side cache of your data, which is kept up to date as further queries and mutations are run, fetching more results from the server.

In this simple example, we integrate Apollo seamlessly with Next by wrapping our pages/index.js inside a higher-order component (HOC). Using the HOC pattern we're able to pass down a central store of query result data created by Apollo into our React component hierarchy defined inside each page of our Next application.

On initial page load, while on the server and inside getInitialProps, we invoke the Apollo method, getDataFromTree. This method returns a promise; at the point in which the promise resolves, our Apollo Client store is completely initialized.

This example relies on graph.cool for its GraphQL backend.

Note: Do not be alarmed that you see two renders being executed. Apollo recursively traverses the React render tree looking for Apollo query components. When it has done that, it fetches all these queries and then passes the result to a cache. This cache is then used to render the data on the server side (another React render). https://www.apollographql.com/docs/react/api/react-ssr/#getdatafromtree