added factory, utils, errors and types

Author: mariocoski

README.md

@@ -8,19 +8,24 @@
 
 express.js implementation of js-items
 
-There is a fantastic alternative to this project (and @js-items/express is based on it): 
+There is a fantastic alternative to this project (and @js-items/express is based on it):
 [js-entity-repos/express](https://github.com/js-entity-repos/express).
 
 The main differences to the @js-entity-repos/express:
+
 - different naming convention: using `item` instead of `entity`
 - cursor based pagination operates using `before` and `after` instead of `cursor` and `direction`
-- enveloping response (GET /items) which allows client to more easily discover the pagination and metadata
-- transactions handlers for each request handler - this could be used for i.e. permissions checks
-- possibility to override each request handler
-- no /count route as not restful
+- `enveloping` response (GET /items) which allows client to more easily discover the pagination and metadata
+- `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
 
 ## Installation:
+
 `npm i @js-items/express --save`
 
 Credits:
-- [ryansmith94](https://github.com/ryansmith94)
+
+- [ryansmith94](https://github.com/ryansmith94)
+- [best-practices-for-a-pragmatic-restful-api](https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api)

package-lock.json

@@ -30,6 +30,8 @@
     "@types/express": "^4.16.1",
     "@types/jest": "24.0.11",
     "@types/node": "11.12.1",
+    "@types/ramda": "^0.26.6",
+    "@types/uuid": "^3.4.4",
     "jest": "24.5.0",
     "rimraf": "2.6.3",
     "ts-jest": "24.0.0",
@@ -41,11 +43,16 @@
     "access": "public"
   },
   "dependencies": {
+    "body-parser": "^1.18.3",
+    "boolean": "^1.0.0",
     "codecov": "^3.2.0",
     "dotenv": "^7.0.0",
     "express": "^4.16.4",
+    "http-status-codes": "^1.3.2",
     "jscpd": "^2.0.11",
     "jscpd-badge-reporter": "^1.1.3",
-    "make-error": "^1.3.5"
+    "make-error": "^1.3.5",
+    "ramda": "^0.26.1",
+    "uuid": "^3.3.2"
   }
 }

package.json

@@ -1,7 +1,31 @@
 import { Item } from '@js-items/foundation';
 import Facade from '@js-items/foundation/dist/Facade';
+import CreateFilter from './types/CreateFilter';
+import CreatePatch from './types/CreatePatch';
+import DocumentIntoItem from './types/DocumentIntoItem';
+import ItemIntoDocument from './types/ItemIntoDocument';
+import TransactionHandler from './types/TransactionHandler';
 
-// tslint:disable-next-line:no-empty-interface
 export default interface FacadeConfig<I extends Item> {
+  readonly totalHeaderName: string;
+  readonly beforeHeaderName: string;
+  readonly hasAfterHeaderName: string;
+  readonly hasBeforeHeaderName: string;
+  readonly afterHeaderName: string;
+  readonly envelopeParamName: string;
+  readonly prettyParamName: string;
+  readonly createFilter: CreateFilter<I>;
+  readonly createPatch: CreatePatch<I>;
+  readonly convertDocumentIntoItem: DocumentIntoItem<I>;
+  readonly convertItemIntoDocument: ItemIntoDocument<I>;
+  readonly beforeGetItem?: TransactionHandler;
+  readonly beforeUpdateItem?: TransactionHandler;
+  readonly beforeReplaceItem?: TransactionHandler;
+  readonly beforeDeleteItem?: TransactionHandler;
+  readonly beforeGetItems?: TransactionHandler;
+  readonly beforeCreateItem?: TransactionHandler;
+  readonly beforeDeleteItems?: TransactionHandler;
+  readonly defaultTransactionHandler: TransactionHandler;
+  readonly defaultPaginationLimit: number;
   readonly service: Facade<I>;
 }

src/FacadeConfig.ts

@@ -8,6 +8,14 @@ import TransactionHandler from './types/TransactionHandler';
 import RequestHandlerFactory from './types/RequestHandlerFactory';
 
 export default interface FactoryConfig<I extends Item> {
+  readonly enableJsonBodyParser?: boolean;
+  readonly totalHeaderName?: string;
+  readonly hasAfterHeaderName?: string;
+  readonly afterHeaderName?: string;
+  readonly hasBeforeHeaderName?: string;
+  readonly beforeHeaderName?: string;
+  readonly envelopParamName?: string;
+  readonly prettyParamName?: string;
   readonly createFilter?: CreateFilter<I>;
   readonly createPatch?: CreatePatch<I>;
   readonly convertDocumentIntoItem?: DocumentIntoItem<I>;

src/FactoryConfig.ts

@@ -0,0 +1,14 @@
+// tslint:disable:no-any
+import { BaseError } from 'make-error';
+
+export default class JsonError extends BaseError {
+
+  public data: any;
+  public path: string[];
+
+  constructor(data: any, path: string[]) {
+    super();
+    this.data = data;
+    this.path = path;
+  }
+}

src/errors/JsonError.ts

@@ -0,0 +1,14 @@
+// tslint:disable:no-any
+import { BaseError } from 'make-error';
+
+export default class NumberError extends BaseError {
+
+  public data: any;
+  public path: string[];
+
+  constructor(data: any, path: string[]) {
+    super();
+    this.data = data;
+    this.path = path;
+  }
+}

src/errors/NumberError.ts

@@ -0,0 +1,82 @@
+import { Item } from '@js-items/foundation';
+import { json } from 'body-parser';
+import { Router } from 'express';
+import _defaultTo from 'ramda/src/defaultTo';
+import FacadeConfig from './FacadeConfig';
+import FactoryConfig from './FactoryConfig';
+import defaultCreateItem from './functions/createItem';
+import defaultDeleteItem from './functions/deleteItem';
+// 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 defaultTransactionHandler from './utils/defaultTransactionHandler';
+
+export default <I extends Item>({
+  deleteItem,
+  deleteItems,
+  getItem,
+  getItems,
+  updateItem,
+  replaceItem,
+  createItem,
+  totalHeaderName,
+  hasAfterHeaderName,
+  afterHeaderName,
+  hasBeforeHeaderName,
+  beforeHeaderName,
+  envelopParamName,
+  prettyParamName,
+  ...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 customAfterHeaderName = _defaultTo('x-after-cursor')(afterHeaderName);
+  const customEnvelopParamName = _defaultTo('envelope')(envelopParamName);
+  const customPrettyParamName = _defaultTo('pretty')(prettyParamName);
+
+  const facadeConfig: FacadeConfig<I> = {
+    afterHeaderName: customAfterHeaderName,
+    beforeHeaderName: customBeforeHeaderName,
+    convertDocumentIntoItem: ({ document }) => document,
+    convertItemIntoDocument: ({ item }) => item,
+    createFilter: ({ filter }) => filter,
+    createPatch: ({ document }) => document,
+    defaultPaginationLimit: 10,
+    defaultTransactionHandler,
+    envelopeParamName: customEnvelopParamName,
+    hasAfterHeaderName: customHasAfterHeaderName,
+    hasBeforeHeaderName: customHasBeforeHeaderName,
+    prettyParamName: customPrettyParamName,
+    totalHeaderName: customTotalHeaderName,
+    ...config,
+  };
+
+  const router = Router();
+  const bodyParserEnabled = _defaultTo(true)(config.enableJsonBodyParser);
+
+  if (bodyParserEnabled) {
+    router.use(json());
+  }
+
+  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 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.post('', createItemFactory(facadeConfig));
+
+  return router;
+};

src/factory.ts

@@ -0,0 +1,25 @@
+import { Item } from '@js-items/foundation';
+import { Request, Response } from 'express';
+import { OK } from 'http-status-codes';
+import _defaultTo from 'ramda/src/defaultTo';
+import FacadeConfig from '../../FacadeConfig';
+import RequestHandlerFactory from '../../types/RequestHandlerFactory';
+
+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 }));
+  });
+};
+
+export default createItem;

src/functions/createItem/index.ts

@@ -0,0 +1,28 @@
+import { Item } from '@js-items/foundation';
+import { Request, Response } from 'express';
+import { NO_CONTENT } from 'http-status-codes';
+import _defaultTo from 'ramda/src/defaultTo';
+import FacadeConfig from '../../FacadeConfig';
+import RequestHandlerFactory from '../../types/RequestHandlerFactory';
+import getJsonQueryParam from '../utils/getJsonQueryParam';
+
+const deleteItem: RequestHandlerFactory = <I extends Item>(
+  config: FacadeConfig<I>
+) => async (req: Request, res: Response) => {
+  const transactionHandler = _defaultTo(config.defaultTransactionHandler)(
+    config.beforeDeleteItem
+  );
+
+  await transactionHandler({ req, res }, async () => {
+    const filter = getJsonQueryParam(req.query, 'filter');
+
+    await config.service.deleteItem({
+      filter: config.createFilter({ filter, req, res }),
+      id: req.params.id,
+    });
+
+    res.status(NO_CONTENT).send();
+  });
+};
+
+export default deleteItem;