feat: Adds constructEntity, constructPatch, and constructDocument. (#19)

Author: ryasmi

package-lock.json

@@ -25,15 +25,15 @@
     "check-coverage": true
   },
   "dependencies": {
-    "@js-entity-repos/core": "^9.0.0",
+    "@js-entity-repos/core": "^9.1.0",
     "http-status-codes": "^1.3.0",
     "uuid": "^3.2.1"
   },
   "devDependencies": {
     "@ht2-labs/semantic-release": "1.0.31",
     "@ht2-labs/typescript-project": "1.0.10",
-    "@js-entity-repos/axios": "5.0.1",
-    "@js-entity-repos/memory": "4.0.3",
+    "@js-entity-repos/axios": "^5.0.1",
+    "@js-entity-repos/memory": "^4.3.0",
     "@types/dotenv": "4.0.3",
     "@types/express": "4.11.1",
     "@types/mocha": "5.2.0",

package.json

@@ -27,11 +27,22 @@ export interface TodoEntity extends Entity {
 import factory from '@js-entity-repos/express/dist/factory';
 
 const todosFacade = factory<TodoEntity>({
+  // Optional property to convert an entity to a response body. Defaults to the function below.
+  constructDocument: ({ entity, req, res }) => {
+    return entity;
+  },
+  // Optional property to convert a request body to an entity. Defaults to the function below.
+  constructEntity: ({ document, req, res }) => {
+    return document;
+  },
   // Optional property that modifies a filter for the service.
   constructFilter: ({ filter, req, res }) => {
-    // This is a great place to put authentication and authorisation logic.
     return filter;
   },
+  // Optional property to convert a request body to a patch. Defaults to the function below.
+  constructPatch: ({ document, req, res }) => {
+    return document;
+  },
   // Optional property. Defaults to 10.
   defaultPaginationLimit: 10,
   // Optional property to handle transactions. Defaults to "utils/handleTransaction".

readme.md

@@ -1,5 +1,6 @@
 {
   "extends": [
-    "@ht2-labs:base"
+    "@ht2-labs:base",
+    ":preserveSemverRanges"
   ]
 }

renovate.json

@@ -1,10 +1,16 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
+import DocumentConstructor from './utils/DocumentConstructor';
+import EntityConstructor from './utils/EntityConstructor';
 import FilterConstructor from './utils/FilterConstructor';
+import PatchConstructor from './utils/PatchConstructor';
 import TransactionHandler from './utils/TransactionHandler';
 
 export default interface FacadeConfig<E extends Entity> {
+  readonly constructDocument: DocumentConstructor<E>;
+  readonly constructEntity: EntityConstructor<E>;
   readonly constructFilter: FilterConstructor<E>;
+  readonly constructPatch: PatchConstructor<E>;
   readonly service: Facade<E>;
   readonly handleTransaction: TransactionHandler;
   readonly defaultPaginationLimit: number;

src/FacadeConfig.ts

@@ -1,10 +1,16 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
+import DocumentConstructor from './utils/DocumentConstructor';
+import EntityConstructor from './utils/EntityConstructor';
 import FilterConstructor from './utils/FilterConstructor';
+import PatchConstructor from './utils/PatchConstructor';
 import TransactionHandler from './utils/TransactionHandler';
 
 export default interface FactoryConfig<E extends Entity> {
+  readonly constructDocument?: DocumentConstructor<E>;
+  readonly constructEntity?: EntityConstructor<E>;
   readonly constructFilter?: FilterConstructor<E>;
+  readonly constructPatch?: PatchConstructor<E>;
   readonly service: Facade<E>;
   readonly handleTransaction?: TransactionHandler;
   readonly defaultPaginationLimit?: number;

src/FactoryConfig.ts

@@ -15,7 +15,10 @@ import handleTransaction from './utils/handleTransaction';
 
 export default <E extends Entity>(factoryConfig: FactoryConfig<E>): Router => {
   const facadeConfig: FacadeConfig<E> = {
+    constructDocument: ({ entity }) => entity,
+    constructEntity: ({ document }) => document,
     constructFilter: ({ filter }) => filter,
+    constructPatch: ({ document }) => document,
     defaultPaginationLimit: 10,
     handleTransaction,
     ...factoryConfig,

src/factory.ts

@@ -7,10 +7,10 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
       const { entity } = await config.service.createEntity({
-        entity: req.body,
+        entity: config.constructEntity({ document: req.body, req, res }),
         id: req.body.id,
       });
-      res.status(OK).json(entity);
+      res.status(OK).json(config.constructDocument({ entity, req, res }));
     });
   };
 };

src/functions/createEntity.ts

@@ -29,7 +29,9 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
       }
       res.setHeader('x-entities-has-more-backward', result.hasMoreBackward.toString());
       res.setHeader('x-entities-has-more-forward', result.hasMoreForward.toString());
-      res.json(result.entities);
+      res.json(result.entities.map((entity) => {
+        return config.constructDocument({ entity, req, res });
+      }));
     });
   };
 };

src/functions/getEntities.ts

@@ -12,7 +12,7 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
         filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
       });
-      res.status(OK).json(entity);
+      res.status(OK).json(config.constructDocument({ entity, req, res }));
     });
   };
 };

src/functions/getEntity.ts

@@ -11,9 +11,9 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
       const { entity } = await config.service.patchEntity({
         filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
-        patch: req.body,
+        patch: config.constructPatch({ document: req.body, req, res }),
       });
-      res.status(OK).json(entity);
+      res.status(OK).json(config.constructDocument({ entity, req, res }));
     });
   };
 };

src/functions/patchEntities.ts

@@ -9,11 +9,11 @@ export default <E extends Entity>(config: FacadeConfig<E>) => {
     await config.handleTransaction({ req, res }, async () => {
       const filter = getJsonQueryParam(req.query, 'filter');
       const { entity } = await config.service.replaceEntity({
-        entity: req.body,
+        entity: config.constructEntity({ document: req.body, req, res }),
         filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
       });
-      res.status(OK).json(entity);
+      res.status(OK).json(config.constructDocument({ entity, req, res }));
     });
   };
 };

src/functions/replaceEntity.ts

@@ -0,0 +1,12 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import { Request, Response } from 'express';
+
+export interface Opts<E extends Entity> {
+  readonly req: Request;
+  readonly res: Response;
+  readonly entity: E;
+}
+
+type DocumentConstructor<E extends Entity> = (opts: Opts<E>) => any;
+
+export default DocumentConstructor;

src/utils/DocumentConstructor.ts

@@ -0,0 +1,12 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import { Request, Response } from 'express';
+
+export interface Opts {
+  readonly req: Request;
+  readonly res: Response;
+  readonly document: any;
+}
+
+type EntityConstructor<E extends Entity> = (opts: Opts) => E;
+
+export default EntityConstructor;

src/utils/EntityConstructor.ts

@@ -0,0 +1,12 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import { Request, Response } from 'express';
+
+export interface Opts {
+  readonly req: Request;
+  readonly res: Response;
+  readonly document: any;
+}
+
+type PatchConstructor<E extends Entity> = (opts: Opts) => Partial<E>;
+
+export default PatchConstructor;