feat(Pagination): Add pagination resolver

close #46

Author: nodkz

README.md

@@ -14,9 +14,9 @@ This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose)
 Installation
 ============
 ```
-npm install graphql graphql-compose graphql-compose-connection mongoose graphql-compose-mongoose --save
+npm install graphql graphql-compose graphql-compose-connection graphql-compose-pagination mongoose graphql-compose-mongoose --save
 ```
-Modules `graphql`, `graphql-compose`, `graphql-compose-connection`, `mongoose` 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.
+Modules `graphql`, `graphql-compose`, `graphql-compose-connection`, `graphql-compose-pagination`, `mongoose` 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
 =======
@@ -76,8 +76,9 @@ GQC.rootQuery().addFields({
   userByIds: UserTC.getResolver('findByIds'),
   userOne: UserTC.getResolver('findOne'),
   userMany: UserTC.getResolver('findMany'),
-  userTotal: UserTC.getResolver('count'),
+  userCount: UserTC.getResolver('count'),
   userConnection: UserTC.getResolver('connection'),
+  userPagination: UserTC.getResolver('pagination'),
 });
 
 GQC.rootMutation().addFields({
@@ -314,7 +315,10 @@ export type typeConverterResolversOpts = {
     uniqueFields: string[],
     sortValue: mixed,
     directionFilter: (<T>(filterArg: T, cursorData: CursorDataType, isBefore: boolean) => T),
-  };
+  },
+  pagination?: false | {
+    perPage?: number,
+  },
 };
 ```
 
@@ -362,6 +366,8 @@ Besides standard connection arguments `first`, `last`, `before` and `after`, als
 
 This plugin completely follows to [Relay Cursor Connections Specification](https://facebook.github.io/relay/graphql/connections.htm).
 
+### [graphql-compose-pagination](https://github.com/nodkz/graphql-compose-pagination)
+This plugin adds `pagination` resolver.
 
 License
 =======

package.json

@@ -29,6 +29,7 @@
   "peerDependencies": {
     "graphql-compose": ">=1.20.3 || >=2.0.0",
     "graphql-compose-connection": ">=2.2.1",
+    "graphql-compose-pagination": ">=1.0.0",
     "mongoose": ">=4.0.0"
   },
   "devDependencies": {
@@ -50,6 +51,7 @@
     "graphql": "^0.10.3",
     "graphql-compose": "^2.0.0",
     "graphql-compose-connection": "^2.2.2",
+    "graphql-compose-pagination": "^1.0.0",
     "jest": "^20.0.4",
     "mongodb-memory-server": "^1.3.4",
     "mongoose": "^4.10.7",

src/__tests__/composeWithMongoose-test.js

@@ -163,6 +163,30 @@ describe('composeWithMongoose ->', () => {
     });
   });
 
+  describe('3rd party resolvers', () => {
+    describe('graphql-compose-connection', () => {
+      it('should add `connection` resolver by default', () => {
+        const tc2 = composeWithMongoose(UserModel);
+        expect(tc2.getResolver('connection')).toBeDefined();
+      });
+    });
+
+    describe('graphql-compose-pagination', () => {
+      it('should add `pagination` resolver by default', () => {
+        const tc2 = composeWithMongoose(UserModel);
+        expect(tc2.getResolver('pagination')).toBeDefined();
+      });
+
+      it('should add `pagination` resolver with `perPage` option', () => {
+        const tc2 = composeWithMongoose(UserModel, { resolvers: { pagination: { perPage: 333 } } });
+        const resolver = tc2.getResolver('pagination');
+        expect(resolver).toBeDefined();
+        // $FlowFixMe
+        expect(resolver.getArg('perPage').defaultValue).toBe(333);
+      });
+    });
+  });
+
   describe('complex situations', () => {
     it('required input fields, should be passed down to resolvers', () => {
       const typeComposer = composeWithMongoose(UserModel, {

src/composeWithMongoose.js

@@ -3,6 +3,7 @@
 
 import { TypeComposer, InputTypeComposer } from 'graphql-compose';
 import composeWithConnection from 'graphql-compose-connection';
+import composeWithPagination from 'graphql-compose-pagination';
 import { convertModelToGraphQL } from './fieldsConverter';
 import * as resolvers from './resolvers';
 import { getUniqueIndexes, extendByReversedIndexes } from './utils/getIndexesFromModel';
@@ -122,6 +123,15 @@ export function createResolvers(
   if (!{}.hasOwnProperty.call(opts, 'connection') || opts.connection !== false) {
     prepareConnectionResolver(model, typeComposer, opts.connection ? opts.connection : {});
   }
+
+  if (!{}.hasOwnProperty.call(opts, 'pagination') || opts.pagination !== false) {
+    const pOpts = opts.pagination || {};
+    composeWithPagination(typeComposer, {
+      findResolverName: 'findMany',
+      countResolverName: 'count',
+      ...pOpts,
+    });
+  }
 }
 
 export function prepareConnectionResolver(

src/definition.js

@@ -3,6 +3,7 @@
 
 import type { TypeComposer } from 'graphql-compose';
 import type { ConnectionSortMapOpts as _ConnectionSortMapOpts} from 'graphql-compose-connection/lib/definition';
+
 export type ConnectionSortMapOpts = _ConnectionSortMapOpts;
 
 export type ObjectMap = { [optName: string]: any };
@@ -185,6 +186,7 @@ export type TypeConverterResolversOpts = {
     filter?: FilterHelperArgsOpts | false,
   },
   connection?: ConnectionSortMapOpts | false,
+  pagination?: { perPage?: number } | false,
 };
 
 export type FilterHelperArgsOpts = {