Merge pull request #32 from sammarks/edge-customization

feat: add modifyEdgeFn for edge customization

.nvmrc

@@ -0,0 +1 @@
+10

README.md

@@ -92,6 +92,24 @@ database column name is "created_at" and the column name on the model is "create
   ```
 </details>
 
+#### Customizing Edges
+
+If you have additional metadata you would like to pass along with each edge, as is allowed by the Relay
+specification, you may do so using the `modifyEdgeFn` option:
+
+```javascript
+const result = await paginate(
+  baseQuery,
+  { first, last, before, after, orderBy, orderDirection },
+  {
+    modifyEdgeFn: (edge) => ({
+      ...edge,
+      custom: 'foo',
+    })
+  }
+);
+```
+
 ### Creating your own connector
 
 Only Knex.js is implemented for now. If you want to connect to a different ORM, you must make your own connector.

src/builder/index.js

@@ -109,7 +109,9 @@ const apolloCursorPaginationBuilder = ({
   },
   opts = {},
 ) => {
-  const { isAggregateFn, formatColumnFn, skipTotalCount = false } = opts;
+  const {
+    isAggregateFn, formatColumnFn, skipTotalCount = false, modifyEdgeFn,
+  } = opts;
   let {
     orderColumn, ascOrDesc,
   } = opts;
@@ -146,11 +148,14 @@ const apolloCursorPaginationBuilder = ({
     getNodesLength,
   });
 
-  const edges = convertNodesToEdges(nodes, {
+  let edges = convertNodesToEdges(nodes, {
     before, after, first, last,
   }, {
     orderColumn, ascOrDesc, isAggregateFn, formatColumnFn,
   });
+  if (modifyEdgeFn) {
+    edges = edges.map(edge => modifyEdgeFn(edge));
+  }
 
   const startCursor = edges[0] && edges[0].cursor;
   const endCursor = edges[edges.length - 1] && edges[edges.length - 1].cursor;

tests/test-app/src/queries/cat/root/cats-connection.js

@@ -22,6 +22,10 @@ export default async (_, args) => {
     {
       isAggregateFn: column => column === 'idsum',
       formatColumnFn: column => (column === 'idsum' ? Cat.knex().raw('sum(id)') : column),
+      modifyEdgeFn: edge => ({
+        ...edge,
+        custom: 'foo',
+      }),
     },
   );
   return result;

tests/test-app/src/type-defs/cat.js

@@ -14,6 +14,7 @@ const Cat = `
   type CatEdge {
     cursor: String!
     node: Cat!
+    custom: String
   }
 
   enum OrderDirection {

tests/test-app/tests/apollo-cursor-pagination/knex-implementation.test.js

@@ -678,4 +678,30 @@ describe('getCatsByOwner root query', () => {
       expect(response2.body.data.catsConnection.edges[1].node.lastName).not.toEqual(null);
     });
   });
+
+  describe('modifyEdgeFn', () => {
+    it('modifies edges per the callback', async () => {
+      const query = `
+        {
+          catsConnection(first: 2) {
+            edges {
+              cursor
+              node {
+                id
+                name
+              }
+              custom
+            }
+          }
+        }
+      `;
+      const response = await graphqlQuery(app, query);
+      expect(response.body.errors).not.toBeDefined();
+      expect(response.body.data.catsConnection.edges).toHaveLength(2);
+      expect(response.body.data.catsConnection.edges.map(edge => edge.node.name))
+        .toEqual([cat1.name, cat2.name]);
+      expect(response.body.data.catsConnection.edges.map(edge => edge.custom))
+        .toEqual(['foo', 'foo']);
+    });
+  });
 });