July 27, 2017

Getting started with TypeScript and Apollo

James Baxley III
FrontendHow-to

This is a follow up to a similar post on using Flow and Apollo which can be found here.

When the Apollo team started out to build a flexible and incrementally adoptable GraphQL client, one of the early discussions centered around static typing for the library code. Since the library deals with a complex data types (like the parsed abstract syntax tree of a GraphQL operation), it seemed like making the code type safe was a needed addition.

The team investigated both Flow and TypeScript, and ultimately went with TypeScript for its active development, editor integration, and strong tooling. It’s been a huge help ever since.

Close, but not enough

Even though Apollo Client and React Apollo are both written in TypeScript, the actual type usage for application developers was not as strong as it should have been. In many places, React Apollo used either any, essentially bypassing static types, or left types off all together where allowed.

Luckily, thanks to the efforts of Ian Ker-Seymer, these shortcomings were brought to the attention of the Apollo team. With his help, application developers can opt in to much stronger TypeScript checking of their React apps!

Getting Started

This article will follow the same progression as the article on Flowand it also assumes you already have TypeScript configured in your project. If you don’t, check out this great starter tooling from Microsoft.

We will start with a simple React component wrapped with the graphql higher order component (HOC) from React Apollo. This component will display a hero from Star Wars and their friends, with data returned from a GraphQL endpoint:

import React from "react";
import gql from "graphql-tag";
import { graphql } from "react-apollo";

export const HERO_QUERY = gql`
  query GetCharacter($episode: Episode!) {
    hero(episode: $episode) {
      name
      id
      friends {
        name
        id
        appearsIn
      }
    }
  }
`;

export const withCharacter = graphql(HERO_QUERY, {
  options: () => ({
    variables: { episode: "JEDI" },
  }),
});

export default withCharacter(({ data: { loading, hero, error } }) => {
  if (loading) return <div>Loading</div>;
  if (error) return <h1>ERROR</h1>;
  return (
    <div>
      {hero &&
        <div>
          <h3>{hero.name}</h3>
          {hero.friends.map(friend =>
            <h6 key={friend.id}>
              {friend.name}:
              {" "}{friend.appearsIn.map(x => x.toLowerCase()).join(", ")}
            </h6>
          )}
        </div>}
    </div>
  );
}

The above code pulls some data from a GraphQL API using a query and includes lifecycle information, such as loading and error information. With a few minor changes, we can tell Typescript how to support us in writing code within this render function.

Let’s walk through what is happening in this diff.

  1. We need to tell TypeScript what the shape of our data from our graphql server will look like. We manually write the types for our response data. Alternatively, you can use apollo-codegen to generate the types for you! Shoutout to Lewis Chung for working to make this easier and Martijn Walraven and Robin Ricard for the codegen framework!
+ export type Hero = {
+   name: string;
+   id: string;
+   appearsIn: string[];
+   friends: Hero[];
+ };

+ export type Response = {
+   hero: Hero,
+ };

2. The last line is where the magic happens. We tell TypeScript what the shape of the result will look like from the server when the graphql enhancer wraps a component.

If you already had your project set up with TypeScript, and have already typed your response data, all you have to do is add the type to the graphql HOC and you are off!

The immediate benefits can be seen by writing some bad code! Let’s make a mistake and see what happens:

export default withCharacter(({ loading, hero, error }) => {
  // Operator '>' cannot be applied to types 'boolean' and 'number'.
  if (loading > 1) return <div>Loading</div>;
  if (error) return <h1>error.name</h1>;
  return ...;
}

Since withCharacter is now typed, TypeScript will error out preventing a potential production bug!

Loki What GIF - Find & Share on GIPHY

Taking control of your tree

Wrapped components are almost always exported and used by a component somewhere else in your tree, so if your exported component has prop requirements, we need to tell TypeScript so it can help prevent errors elsewhere in our tree. Since the graphql wrapper supports polymorphic types, we can use the second type parameter of it to do just that! Let’s make a change to our initial component that converts it to use a prop called episode:

+ export type InputProps = {
+  episode: string,
+ };

+ export const withCharacter = graphql<Response, InputProps>(HERO_QUERY, {
- export const withCharacter = graphql<Response>(HERO_QUERY, {
+   options: ({ episode }) => ({
+     variables: { episode },
-   options: () => ({
-     variables: { episode: "JEDI" },
  }),
});

We can define the props that our exported component will need (InputProps) and attach them to our enhancer using the second type argument. Now our component can pass episode to pick which characters to load and TypeScript can know how to enforce that! In practice it would look like this:

import React from "react";
import ApolloClient, { createNetworkInterface } from "apollo-client";
import { ApolloProvider } from "react-apollo";

import Character from "./Character";

export const networkInterface = createNetworkInterface({
  uri: "https://mpjk0plp9.lp.gql.zone/graphql",
});
export const client = new ApolloClient({ networkInterface });

export default () =>
  <ApolloProvider client={client}>
    // Type '{}' is not assignable to type 'Readonly<InputProps>'.
    // Property 'episode' is missing in type '{}'.
    <Character />
  </ApolloProvider>;

The other benefit we get is typing of the options function itself. Let’s say we forgot what props are passed into our component and we thought the episode was a number:

export const withCharacter: OperationComponent<Response, InputProps> = graphql(HERO_QUERY, {
  options: ({ episode }) => ({
    // Operator '>' cannot be applied to types 'string' and 'number'.
    variables: { episode: episode > 1 },
  })
});

Thanks TypeScript!

Amy Sedaris Thank You GIF - Find & Share on GIPHY

Shaping your props

GraphQL is awesome at allowing you to only request the data you want from the server. The client still often needs to reshape or do client side calculations based on these results. React Apollo has a handy dandy props function which lets you reshape the resulting props into a new object. In practice, I use this for almost every enhancer I write.

Note: It also pairs nicely with Ramda for some fun, fun functional code.

Since this function can shape passed props, plus a potential data result, potential error, and loading state, having it strongly typed would prevent a lot of save => see error => check data => save workflows. Let’s take a look at how to set this up with React Apollo:

The most important part of the change above is including what the result of the props function will look like on line 5.

Now, let’s check it out in action a couple of weeks after we first wrote this file and forgot some things.

export const withCharacter = graphql<Response, InputProps, Props>(HERO_QUERY, {
  options: ({ episode }) => ({
    variables: { episode },
  }),
  props: ({ data, ownProps }) => ({
    ...data,
    // Operator '>' cannot be applied to types 'string' and 'number'.
    episode: ownProps.episode > 1,
    // Property 'isHero' does not exist on type 'Hero'.
    isHero: data && data.hero && data.hero.isHero,
  }),
});
  1. The first error shows we don’t have a good memory around what an episode represents. Maybe we should change it to episodeName ! Luckily, TypeScript has our back.
  2. I really thought we had an isHero field in our query? Whelp, looks like we don’t based on the types.

These two examples show type checking passed props and resulting data as well as the fact that data may not have arrived yet from the server!

Broad City Omg GIF - Find & Share on GIPHY

I hope that this article shows both how awesome TypeScript is, and how subtle the differences between Flow and TypeScript can be for application developers. They are both amazing choices!

I’d like to give a special thanks to Jonas HelferLewis ChungBrett JurgensIan, and Sashko Stubailo for reviewing the initial type PR. I’ve also started the effort to include documentation for Flow and TypeScript in the official React docs.

Written by

James Baxley III

Normally found on his farm working his bee hives or tending his flock of sheep, James is a believer in cultivating happy and healthly communities. He is a lover of design systems, roses, and fixing old land rovers.

Read more by James Baxley III

Stay in our orbit!

Become an Apollo insider and get first access to new features, best practices, and community events. Oh, and no junk mail. Ever.

Similar posts

July 17, 2020

Introducing the Apollo Client Best Practices Series

by Khalil Stemmler

Company