Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-compose/graphql-compose-connection
Plugin for TypeComposer (graphql-compose), that adds `connection` resolver.
https://github.com/graphql-compose/graphql-compose-connection
graphql graphql-compose graphql-compose-plugin schema-builder
Last synced: about 2 months ago
JSON representation
Plugin for TypeComposer (graphql-compose), that adds `connection` resolver.
- Host: GitHub
- URL: https://github.com/graphql-compose/graphql-compose-connection
- Owner: graphql-compose
- License: mit
- Created: 2016-07-10T09:47:06.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:02:43.000Z (over 1 year ago)
- Last Synced: 2024-04-14T06:45:19.914Z (5 months ago)
- Topics: graphql, graphql-compose, graphql-compose-plugin, schema-builder
- Language: TypeScript
- Homepage: https://github.com/nodkz/graphql-compose
- Size: 2.13 MB
- Stars: 45
- Watchers: 4
- Forks: 11
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# graphql-compose-connection
[](https://travis-ci.org/graphql-compose/graphql-compose-connection)
[](https://codecov.io/github/graphql-compose/graphql-compose-connection)
[](https://www.npmjs.com/package/graphql-compose-connection)
[](http://www.npmtrends.com/graphql-compose-connection)
[](http://commitizen.github.io/cz-cli/)
This is a plugin for [graphql-compose](https://github.com/graphql-compose/graphql-compose) family, which adds to the ObjectTypeComposer `connection` resolver.
Live demo: [https://graphql-compose.herokuapp.com/](https://graphql-compose.herokuapp.com/)
This package completely follows to Relay Cursor Connections Specification ().
Besides standard connection arguments `first`, `last`, `before` and `after`, also added significant arguments:
- `filter` arg - for filtering records
- `sort` arg - for sorting records. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields).
[CHANGELOG](https://github.com/graphql-compose/graphql-compose-connection/blob/master/CHANGELOG.md)
## Installation
```bash
npm install graphql graphql-compose graphql-compose-connection --save
```
Modules `graphql` and `graphql-compose` are in `peerDependencies`, so should be installed explicitly in your app. They should not installed as submodules, cause internally checks the classes instances.
## Example
Implementation details of `findManyResolver` and `countResolver` can be found in [this file](./src/__mocks__/User.ts).
```js
import { prepareConnectionResolver } from 'graphql-compose-connection';
import { UserTC, findManyResolver, countResolver } from './user';
prepareConnectionResolver(userTC, {
findManyResolver,
countResolver,
sort: {
// Sorting key, visible for users in GraphQL Schema
_ID_ASC: {
// Sorting value for ORM/Driver
value: { _id: 1 },
// Field names in record, which data will be packed in `cursor`
// edges {
// cursor <- base64(cursorData), for this example `cursorData` = { _id: 334ae453 }
// node <- record from DB
// }
// By this fields MUST be created UNIQUE index in database!
cursorFields: ['_id'],
// If for connection query provided `before` argument with above `cursor`.
// We should construct (`rawQuery`) which will be point to dataset before cursor.
// Unpacked data from `cursor` will be available in (`cursorData`) argument.
// PS. All other filter options provided via GraphQL query will be added automatically.
// ----- [record] ----- sorted dataset, according to above option with `value` name
// ^^^^^ `rawQuery` should filter this set
beforeCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery._id) rawQuery._id = {};
rawQuery._id.$lt = cursorData._id;
},
// Constructing `rawQuery` for connection `after` argument.
// ----- [record] ----- sorted dataset
// ^^^^^ `rawQuery` should filter this set
afterCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery._id) rawQuery._id = {};
rawQuery._id.$gt = cursorData._id;
},
},
_ID_DESC: {
value: { _id: -1 },
cursorFields: ['_id'],
beforeCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery._id) rawQuery._id = {};
rawQuery._id.$gt = cursorData._id;
},
afterCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery._id) rawQuery._id = {};
rawQuery._id.$lt = cursorData._id;
},
},
// More complex sorting parameter with 2 fields
AGE_ID_ASC: {
value: { age: 1, _id: -1 },
// By these fields MUST be created COMPOUND UNIQUE index in database!
cursorFields: ['age', '_id'],
beforeCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery.age) rawQuery.age = {};
if (!rawQuery._id) rawQuery._id = {};
rawQuery.age.$lt = cursorData.age;
rawQuery._id.$gt = cursorData._id;
},
afterCursorQuery: (rawQuery, cursorData, resolveParams) => {
if (!rawQuery.age) rawQuery.age = {};
if (!rawQuery._id) rawQuery._id = {};
rawQuery.age.$gt = cursorData.age;
rawQuery._id.$lt = cursorData._id;
},
}
},
});
```
## Used in plugins
[graphql-compose-mongoose](https://github.com/graphql-compose/graphql-compose-mongoose) - converts mongoose models to graphql types
## License
[MIT](https://github.com/graphql-compose/graphql-compose-connection/blob/master/LICENSE.md)