Road towards relay compatibility

[hardchor]

Just putting some thoughts down of currently missing features:

Unique Object IDs

Relay wants to be able to (re-)fetch any object in the graph by a unique ID via a root query named node:

node (id: "user123") {
  id
  name
}

Relay methods: fromGlobalId/toGlobalId
See: https://github.com/relayjs/relay-starter-kit/blob/master/data/schema.js#L115

Pagination

On the query side, relay requires first and after arguments (as well as last and before for backwards pagination):

users (first: 10, after: "user123") {
  edges {
    cursor
    node {
      id
      name
    }
  }
  pageInfo {
    hasNextPage
  }
}

• edges: describes the collection (https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types)
  ** cursor: would be the unique ID discusses above
  ** node: the box-standard field selector
• pageInfo: an object with meta-data about the current page (https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo)
  ** hasNextPage
  ** hasPreviousPage: for backwards pagination

Also see: https://facebook.github.io/relay/graphql/connections.htm

Mutation

TBC

I expect graphql-relay-js to help us out with the more intricate details

I hope we can work towards relay compatibility. Please let me know if this is more appropriate for an adapter, e.g. graffiti-mongoose

[hardchor]

Moved this to RisingStack/graffiti-mongoose#22 as it's purely a schema builder issue.

Feel free to re-open if you want to keep this to a wider audience.