added test coverage for getItems

Author: mariocoski

.env.example

@@ -19,7 +19,8 @@ The main differences to the @js-entity-repos/express:
 - `granular transactions handlers` for each `request handler` - this could be used for i.e. `authentication` or `permissions` checks
 - possibility to `override` each `request handler`
 - ability to disable json body parser middleware if already present in the stack (`enableJsonBodyParser: false`)
-- replaced /count path with optional header available on get request
+- by default all responses are `pretty` which improves readability, you can disabled that by query param (`/endpoint?pretty=false`) 
+- dropped support for `/count` endpoint, instead allows client to get number of available items by adding query param (`/endpoint?total=true` for get request, resulting in additional header: `x-total-count`) 
 
 ## Installation:
 

README.md

@@ -31,9 +31,13 @@
     "@types/jest": "24.0.11",
     "@types/node": "11.12.1",
     "@types/ramda": "^0.26.6",
+    "@types/source-map-support": "^0.5.0",
+    "@types/supertest": "^2.0.7",
     "@types/uuid": "^3.4.4",
     "jest": "24.5.0",
     "rimraf": "2.6.3",
+    "source-map-support": "^0.5.12",
+    "supertest": "^4.0.2",
     "ts-jest": "24.0.0",
     "tslint": "5.14.0",
     "tslint-config-prettier": "1.18.0",

assets/jscpd-badge.svg

@@ -7,6 +7,7 @@ import ItemIntoDocument from './types/ItemIntoDocument';
 import TransactionHandler from './types/TransactionHandler';
 
 export default interface FacadeConfig<I extends Item> {
+  readonly dataKeyName: string;
   readonly totalHeaderName: string;
   readonly beforeHeaderName: string;
   readonly hasAfterHeaderName: string;

package-lock.json

@@ -8,6 +8,7 @@ import TransactionHandler from './types/TransactionHandler';
 import RequestHandlerFactory from './types/RequestHandlerFactory';
 
 export default interface FactoryConfig<I extends Item> {
+  readonly dataKeyName?: string;
   readonly enableJsonBodyParser?: boolean;
   readonly totalHeaderName?: string;
   readonly hasAfterHeaderName?: string;

package.json

@@ -0,0 +1 @@
+export const TEST_URL = '/items'

src/FacadeConfig.ts

@@ -6,11 +6,11 @@ import FacadeConfig from './FacadeConfig';
 import FactoryConfig from './FactoryConfig';
 import defaultCreateItem from './functions/createItem';
 import defaultDeleteItem from './functions/deleteItem';
-// import defaultDeleteItems from './functions/deleteItems';
+import defaultDeleteItems from './functions/deleteItems';
 import defaultGetItem from './functions/getItem';
-// import defaultGetItems from './functions/getItems';
-// import defaultReplaceItem from './functions/replaceItem';
-// import defaultUpdateItem from './functions/updateItem';
+import defaultGetItems from './functions/getItems';
+import defaultReplaceItem from './functions/replaceItem';
+import defaultUpdateItem from './functions/updateItem';
 import defaultTransactionHandler from './utils/defaultTransactionHandler';
 
 export default <I extends Item>({
@@ -28,23 +28,32 @@ export default <I extends Item>({
   beforeHeaderName,
   envelopParamName,
   prettyParamName,
+  dataKeyName,
   ...config
 }: FactoryConfig<I>): Router => {
   const customTotalHeaderName = _defaultTo('x-total-count')(totalHeaderName);
-  const customHasBeforeHeaderName = _defaultTo('x-has-before')(hasBeforeHeaderName);
-  const customBeforeHeaderName = _defaultTo('x-before-cursor')(beforeHeaderName);
-  const customHasAfterHeaderName = _defaultTo('x-has-after')(hasAfterHeaderName);
+  const customHasBeforeHeaderName = _defaultTo('x-has-before')(
+    hasBeforeHeaderName
+  );
+  const customBeforeHeaderName = _defaultTo('x-before-cursor')(
+    beforeHeaderName
+  );
+  const customHasAfterHeaderName = _defaultTo('x-has-after')(
+    hasAfterHeaderName
+  );
   const customAfterHeaderName = _defaultTo('x-after-cursor')(afterHeaderName);
   const customEnvelopParamName = _defaultTo('envelope')(envelopParamName);
   const customPrettyParamName = _defaultTo('pretty')(prettyParamName);
-
+  const customDataKeyName = _defaultTo('data', dataKeyName);
+  
   const facadeConfig: FacadeConfig<I> = {
     afterHeaderName: customAfterHeaderName,
     beforeHeaderName: customBeforeHeaderName,
     convertDocumentIntoItem: ({ document }) => document,
     convertItemIntoDocument: ({ item }) => item,
     createFilter: ({ filter }) => filter,
     createPatch: ({ document }) => document,
+    dataKeyName: customDataKeyName,
     defaultPaginationLimit: 10,
     defaultTransactionHandler,
     envelopeParamName: customEnvelopParamName,
@@ -64,18 +73,18 @@ export default <I extends Item>({
 
   const deleteItemFactory = _defaultTo(defaultDeleteItem)(deleteItem);
   const getItemFactory = _defaultTo(defaultGetItem)(getItem);
-  // const updateItemFactory = _defaultTo(defaultUpdateItem)(updateItem);
-  // const replaceItemFactory = _defaultTo(defaultReplaceItem)(replaceItem);
-  // const deleteItemsFactory = _defaultTo(defaultDeleteItems)(deleteItems);
-  // const getItemsFactory = _defaultTo(defaultGetItems)(getItems);
+  const updateItemFactory = _defaultTo(defaultUpdateItem)(updateItem);
+  const replaceItemFactory = _defaultTo(defaultReplaceItem)(replaceItem);
+  const deleteItemsFactory = _defaultTo(defaultDeleteItems)(deleteItems);
+  const getItemsFactory = _defaultTo(defaultGetItems)(getItems);
   const createItemFactory = _defaultTo(defaultCreateItem)(createItem);
 
   router.delete('/:id', deleteItemFactory(facadeConfig));
   router.get('/:id', getItemFactory(facadeConfig));
-  // router.patch('/:id', updateItemFactory(facadeConfig));
-  // router.put('/:id', replaceItemFactory(facadeConfig));
-  // router.delete('', deleteItemsFactory(facadeConfig));
-  // router.get('', getItemsFactory(facadeConfig));
+  router.patch('/:id', updateItemFactory(facadeConfig));
+  router.put('/:id', replaceItemFactory(facadeConfig));
+  router.delete('', deleteItemsFactory(facadeConfig));
+  router.get('', getItemsFactory(facadeConfig));
   router.post('', createItemFactory(facadeConfig));
 
   return router;

src/FactoryConfig.ts

@@ -4,22 +4,29 @@ import { OK } from 'http-status-codes';
 import _defaultTo from 'ramda/src/defaultTo';
 import FacadeConfig from '../../FacadeConfig';
 import RequestHandlerFactory from '../../types/RequestHandlerFactory';
+import sendResponse from '../../utils/sendResponse';
 
-const createItem: RequestHandlerFactory =  <I extends Item>(config: FacadeConfig<I>) => async (
-  req: Request,
-  res: Response
-) => {
-  const transactionHandler = _defaultTo(config.defaultTransactionHandler)(config.beforeCreateItem);
+const createItem: RequestHandlerFactory = <I extends Item>(
+  config: FacadeConfig<I>
+) => async (req: Request, res: Response) => {
+  const transactionHandler = _defaultTo(config.defaultTransactionHandler)(
+    config.beforeCreateItem
+  );
 
   await transactionHandler({ req, res }, async () => {
-
     const { item } = await config.service.createItem({
       id: req.body.id,
       item: config.convertDocumentIntoItem({ document: req.body, req, res }),
     });
-    
-    res.status(OK).json(config.convertItemIntoDocument({ item, req, res }));
+
+    sendResponse({
+      config,
+      req,
+      res,
+      responseObject: config.convertItemIntoDocument({ item, req, res }),
+      status: OK,
+    });
   });
 };
 
-export default createItem;
+export default createItem;