Added a New, Optional Apollo Link: HeadersLink

[joncursi]

This link allows you to access the REST API's response headers within the data object that comes back from Apollo Client.

NOTE: Since GraphQL only accepts field names written in camelCase, the headers should be requested in camel case format. I.e. if your REST API returns a total-count header, you'll want to ask for it using totalCount.

HeadersLink Setup

import { RestLink } from 'apollo-link-rest';
import { HeadersLink } from 'apollo-rest-utils';

const headersLink = new HeadersLink();
const restLink = new RestLink({ ... });

new ApolloClient({
  ...
  cache: new InMemoryCache({ ... }),
  link: ApolloLink.from([headersLink, restLink]),
  ...
});

HeadersLink Usage

const { data } = wrapRestQuery<'something'>()(
  gql`
    query SomethingQuery($id: String!) {
      something(id: $id) {
        _id
        fieldA
        fieldB
        fieldC
      }
      headers {
        nextOffset
        totalCount
        totalPages
      }
    }
  `,
  {
    endpoint: REST.GET.SOMETHING,
    variables: {
      id,
    },
  },
);

console.log(data?.something); // response data
console.log(data?.headers); // response headers

[TheCleric]

LGTM

Thanks for making this better!

We'll need to get some unit tests in here though to get the PR to pass. Let me know if I can help with that @joncursi

[joncursi]

@TheCleric thanks and yes, would definitely appreciate some assistance on that! :)

[github-actions]

Total Coverage: 100.00%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
lib/HeadersLink
index.ts	100%	100%	100%
lib/generateRoutes
index.ts	100%	100%	100%
lib/types
index.ts	100%	100%	100%
invalidQueryError.ts	100%	100%	100%
lib/types/restSchema
index.ts	100%	100%	100%
lib/useRestQuery
index.ts	100%	100%	100%

[github-actions]

Total Coverage: 100.00%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
lib/HeadersLink
index.ts	100%	100%	100%
lib/generateRoutes
index.ts	100%	100%	100%
lib/types
index.ts	100%	100%	100%
invalidQueryError.ts	100%	100%	100%
lib/types/restSchema
index.ts	100%	100%	100%
lib/useRestQuery
index.ts	100%	100%	100%