@uplift-ltd/apollo v6.1.0

@uplift-ltd/apollo

Installation

npm i --save @uplift-ltd/apollo

API

useEnhancedQuery

Same API as Apollo useQuery except:

• It returns initialLoading, refetching, and fetchingMore (pass in notifyOnNetworkStatusChange: true)

import { useEnhancedQuery } from "@uplift-ltd/apollo";

useEnhancedQuery<MyQuery, MyQueryVariables>(MY_QUERY, { variables }, { auth: false });

See Apollo useQuery docs.

const { data, initialLoading, refetching, fetchingMore } = useEnhancedQuery(MY_QUERY, { notifyOnNetworkStatusChange: true};

useEnhancedLazyQuery

Same as Apollo useLazyQuery.

import { useEnhancedLazyQuery } from "@uplift-ltd/apollo";

useEnhancedLazyQuery<MyQuery, MyQueryVariables>(MY_QUERY, { variables });

See Apollo useLazyQuery docs.

useEnhancedMutation

Same as Apollo useMutation.

import { useEnhancedMutation } from "@uplift-ltd/apollo";

useEnhancedMutation<MyMutation, MyMutationVariables>(MY_MUTATION, { variables }, { auth: false });

Apollo useMutation docs.

useEnumValues

Fetch key and descriptions for an enum from the gql server. Providing a type for the enum will give correct data on the response type.

Note that introspection needs to be enabled for this to work.

import { useEnumValues } from "@uplift-ltd/apollo";

const colors = useEnumValues<MyColors>("MyColors");

console.log(colors); // => { BLUE: "Brand Blue", RED: "Danger Red" }

initClient

Configure Apollo client.

import { InMemoryCache } from "@apollo/client";
import { initClient } from "@uplift-ltd/apollo";

const cache = new InMemoryCache();

const client = initClient({
  cache,
  uri: `/api/graphql`,
});

getQueryName

Get the query or mutation name.

import { getQueryName } from "@uplift-ltd/apollo";

const CURRENT_USER_QUERY = gql`
  query CurrentUser {
    me {
      id
    }
  }
`;

const CurrentUserQueryName = getQueryName(CURRENT_USER_QUERY);

expect(CurrentUserQueryName).toEqual("CurrentUser");

getQueryBody

Get the query or mutation body.

import { getQueryBody } from "@uplift-ltd/apollo";

const CURRENT_USER_QUERY = gql`
  query CurrentUser {
    me {
      id
    }
  }
`;

const CurrentUserQueryBody = getQueryBody(CURRENT_USER_QUERY);

const EXPECTED_BODY = `
  query CurrentUser {
    me {
      id
    }
  }
`;

expect(CurrentUserQueryBody).toEqual(EXPECTED_BODY);

useSkipVariables

Problem: Apollo's API makes it (currently) impossible for typescript to determine that variables can't be potentially undefined. For example this:

const organizationSlug = "o";
const commentId = "c" as string | undefined;

const { data } = useQuery(InstanceCommentPageDocument, {
  // Error: Type 'string | undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'.ts(2322)
  variables: { organizationSlug, commentId },
  ssr: false,
  skip: !commentId,
});

This hook helps handle skippable variables.

const organizationSlug = "o";
const commentId = "c" as string | undefined;

const [skip, skipVariables] = useSkipVariables({ commentId });

const { data } = useQuery(InstanceCommentPageDocument, {
  variables: { organizationSlug, ...skipVariables },
  ssr: false,
  skip,
});

Note: Do not use skipVariables in any other case since the hook does not actually map the values, it relies on apollo skipping the query if any of the passed in variables are null or undefined.