# graphql-compose-relay

> Plugin for `graphql-compose` which wraps graphql types with Relay specific logic.

Latest version **5.0.3** (published 2019-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install graphql-compose-relay
pnpm add graphql-compose-relay
yarn add graphql-compose-relay
bun add graphql-compose-relay
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.3 |
| Published | 2019-11-01 |
| First published | 2016-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 75.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Maintainers | nodkz |
| Keywords | graphql, compose, graphql-compose, relay |

## Links

- npm: https://www.npmjs.com/package/graphql-compose-relay
- Repository: https://github.com/graphql-compose/graphql-compose-relay
- Issues: https://github.com/graphql-compose/graphql-compose-relay/issues
- npm.io page: https://npm.io/package/graphql-compose-relay

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 5.0.3 (latest) — 2019-11-01
- 5.0.2 — 2019-06-04
- 5.0.1 — 2019-04-29
- 5.0.0 — 2019-04-28
- 4.0.0 — 2019-03-15
- 3.0.0 — 2018-09-05
- 2.1.1 — 2018-06-26
- 2.1.0 — 2018-06-26
- 2.0.1 — 2018-06-06
- 2.0.0 — 2018-04-16
- 1.1.10 — 2018-04-03
- 1.1.9 — 2018-02-15
- 1.1.8 — 2018-02-12
- 1.1.7 — 2018-02-09
- 1.1.6 — 2018-02-09
- … 25 more at https://npm.io/package/graphql-compose-relay/versions

## README

# graphql-compose-relay

[![travis build](https://img.shields.io/travis/graphql-compose/graphql-compose-relay.svg)](https://travis-ci.org/graphql-compose/graphql-compose-relay)
[![codecov coverage](https://img.shields.io/codecov/c/github/graphql-compose/graphql-compose-relay.svg)](https://codecov.io/github/graphql-compose/graphql-compose-relay)
[![](https://img.shields.io/npm/v/graphql-compose-relay.svg)](https://www.npmjs.com/package/graphql-compose-relay)
[![npm](https://img.shields.io/npm/dt/graphql-compose-relay.svg)](http://www.npmtrends.com/graphql-compose-relay)
[![Join the chat at https://gitter.im/graphql-compose/Lobby](https://badges.gitter.im/graphql-compose/graphql-compose.svg)](https://gitter.im/graphql-compose/Lobby)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Greenkeeper badge](https://badges.greenkeeper.io/graphql-compose/graphql-compose-relay.svg)](https://greenkeeper.io/)


This is a plugin for [graphql-compose](https://github.com/graphql-compose/graphql-compose), which wraps GraphQL types with Relay specific things, like `Node` type and interface, `globalId`, `clientMutationId`.

Live demo: [https://graphql-compose.herokuapp.com/](https://graphql-compose.herokuapp.com/)

[CHANGELOG](https://github.com/graphql-compose/graphql-compose-relay/blob/master/CHANGELOG.md)

Installation
============
```
npm install graphql graphql-compose graphql-compose-relay --save
```
Modules `graphql` and `graphql-compose` are in `peerDependencies`, so should be installed explicitly in your app. They have global objects and should not have ability to be installed as submodule.

Example
=======
`ObjectTypeComposer` is a [graphql-compose](https://github.com/graphql-compose/graphql-compose) utility, that wraps GraphQL types and provide bunch of useful methods for type manipulation.
```js
import composeWithRelay from 'graphql-compose-relay';
import { ObjectTypeComposer } from 'graphql-compose';
import { RootQueryType, UserType } from './my-graphq-object-types';

const queryTC = new ObjectTypeComposer(RootQueryType);
const userTC = new ObjectTypeComposer(UserType);

// If passed RootQuery, then will be added only `node` field to this type.
// Via RootQuery.node you may find objects by globally unique ID among all types.
composeWithRelay(queryTC);

// Other types, like User, will be wrapped with middlewares that:
// - add relay's id field. Field will be added or wrapped to return Relay's globally unique ID.
// - for mutations will be added clientMutationId to input and output objects types
// - this type will be added to NodeInterface for resolving via RootQuery.node
composeWithRelay(userTC);
```
That's all!

All mutations resolvers' arguments will be placed into `input` field, and added `clientMutationId`. If `input` fields already exists in resolver, then  `clientMutationId` will be added to it, rest argument stays untouched. Accepted value via `args.input.clientMutationId` will be transfer to `payload.clientMutationId`, as Relay required it.

To all wrapped Types with Relay, will be added `id` field or wrapped, if it exist already. This field will return globally unique ID among all types in the following format `base64(TypeName + ':' + recordId)`.  

For `RootQuery` will be added `node` field, that will resolve by globalId only that types, which you wrap with `composeWithRelay`.

All this annoying operations is too fatigue to do by hands. So this middleware done all Relay magic implicitly for you.

Requirements
============
Method `composeWithRelay` accept `ObjectTypeComposer` as input argument. So `ObjectTypeComposer` should meet following requirements:
- has defined `recordIdFn` (function that from object of this type, returns you id for the globalId construction)
- should have `findById` resolver (that will be used by `RootQuery.node`)

If something is missing `composeWithRelay` throws error.

Compatible plugins
==================
- [graphql-compose-mongoose](https://github.com/graphql-compose/graphql-compose-mongoose)


License
=======
[MIT](https://github.com/graphql-compose/graphql-compose-relay/blob/master/LICENSE.md)

---
_Source: https://npm.io/package/graphql-compose-relay · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._