https://github.com/graphql-compose/graphql-compose-relay
https://github.com/graphql-compose/graphql-compose-relay
graphql graphql-compose graphql-compose-plugin relay schema-builder
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/graphql-compose/graphql-compose-relay
- Owner: graphql-compose
- License: mit
- Created: 2016-07-04T05:03:42.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:43:20.000Z (over 2 years ago)
- Last Synced: 2025-06-01T08:13:54.947Z (25 days ago)
- Topics: graphql, graphql-compose, graphql-compose-plugin, relay, schema-builder
- Language: JavaScript
- Homepage:
- Size: 3.97 MB
- Stars: 29
- Watchers: 4
- Forks: 3
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# graphql-compose-relay
[](https://travis-ci.org/graphql-compose/graphql-compose-relay)
[](https://codecov.io/github/graphql-compose/graphql-compose-relay)
[](https://www.npmjs.com/package/graphql-compose-relay)
[](http://www.npmtrends.com/graphql-compose-relay)
[](https://gitter.im/graphql-compose/Lobby)
[](http://commitizen.github.io/cz-cli/)
[](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)