feat: Moves cursors into headers. (#2)

BREAKING CHANGE: Uses `x-entities-next-cursor` and `x-entities-previous-cursor` headers for `getEntities` instead of the response body.

Author: ryasmi

package-lock.json

@@ -31,7 +31,7 @@
   "devDependencies": {
     "@ht2-labs/semantic-release": "1.0.31",
     "@ht2-labs/typescript-project": "1.0.9",
-    "@js-entity-repos/axios": "2.0.1",
+    "@js-entity-repos/axios": "3.0.0",
     "@js-entity-repos/memory": "3.0.1",
     "@types/dotenv": "4.0.2",
     "@types/express": "4.11.1",

package.json

@@ -16,6 +16,13 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
       },
       sort: getJsonQueryParam(req.query, 'sort'),
     });
-    res.status(OK).json(result);
+    res.status(OK);
+    if (result.nextCursor !== undefined) {
+      res.setHeader('x-entities-next-cursor', result.nextCursor);
+    }
+    if (result.previousCursor !== undefined) {
+      res.setHeader('x-entities-previous-cursor', result.previousCursor);
+    }
+    res.json(result.entities);
   });
 };

src/functions/getEntities.ts

@@ -1,7 +1,7 @@
+import memoryFactory from '@js-entity-repos/memory/dist/factory';
 import * as express from 'express';
 import { createServer, Server } from 'http';
 import expressFactory from '../factory';
-import memoryRepo from './memoryRepo';
 
 export interface Config {
   readonly port: number;
@@ -11,8 +11,14 @@ export interface Config {
 export default ({ port, route }: Config): Promise<Server> => {
   return new Promise<Server>((resolve) => {
     const app = express();
+    const state = { entities: [] };
     app.use(route, expressFactory({
-      service: memoryRepo(),
+      service: memoryFactory({
+        defaultPaginationLimit: 100,
+        entityName: 'Test Entity',
+        getEntities: () => state.entities,
+        setEntities: (entities) => state.entities = entities,
+      }),
     }));
     const server = createServer(app);
     server.listen(port, () => {