feat: Improves constructFilter. (#6)

BREAKING CHANGE: Changes the signature of the `constructFilter` property in the `factory`.

Author: ryasmi

readme.md

@@ -28,7 +28,8 @@ import factory from '@js-entity-repos/express/dist/factory';
 
 const todosFacade = factory<TodoEntity>({
   // Optional property that modifies a filter for the service.
-  constructFilter: (filter) => {
+  constructFilter: ({ filter, req, res }) => {
+    // This is a great place to put authentication and authorisation logic.
     return filter;
   },
   // Optional property. Defaults to 10.

src/FacadeConfig.ts

@@ -1,10 +1,10 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
-import Filter from '@js-entity-repos/core/dist/types/Filter';
+import FilterConstructor from './utils/FilterConstructor';
 import TransactionHandler from './utils/TransactionHandler';
 
 export default interface FacadeConfig<E extends Entity> {
-  readonly constructFilter: (filter: Filter<E>) => any;
+  readonly constructFilter: FilterConstructor<E>;
   readonly service: Facade<E>;
   readonly handleTransaction: TransactionHandler;
   readonly defaultPaginationLimit: number;

src/FactoryConfig.ts

@@ -1,10 +1,10 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
-import { Filter } from '@js-entity-repos/core/dist/types/Filter';
+import FilterConstructor from './utils/FilterConstructor';
 import TransactionHandler from './utils/TransactionHandler';
 
 export default interface FactoryConfig<E extends Entity> {
-  readonly constructFilter?: (filter: Filter<E>) => any;
+  readonly constructFilter?: FilterConstructor<E>;
   readonly service: Facade<E>;
   readonly handleTransaction?: TransactionHandler;
   readonly defaultPaginationLimit?: number;

src/factory.ts

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

src/functions/countEntities.ts

@@ -7,8 +7,9 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       const { count } = await config.service.countEntities({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
       });
       res.status(OK).json(count);
     });

src/functions/getEntities.ts

@@ -8,9 +8,10 @@ import getNumberQueryParam from '../utils/getNumberQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       const limit = getNumberQueryParam(req.query, 'limit', config.defaultPaginationLimit);
       const result = await config.service.getEntities({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
         pagination: {
           cursor: req.query.cursor,
           forward: req.query.forward === 'true',

src/functions/getEntity.ts

@@ -7,8 +7,9 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       const { entity } = await config.service.getEntity({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
       });
       res.status(OK).json(entity);

src/functions/patchEntities.ts

@@ -7,8 +7,9 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       const { entity } = await config.service.patchEntity({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
         patch: req.body,
       });

src/functions/removeEntities.ts

@@ -7,8 +7,9 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       await config.service.removeEntities({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
       });
       res.status(NO_CONTENT).send();
     });

src/functions/removeEntity.ts

@@ -7,8 +7,9 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       await config.service.removeEntity({
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
       });
       res.status(NO_CONTENT).send();

src/functions/replaceEntity.ts

@@ -7,9 +7,10 @@ import getJsonQueryParam from '../utils/getJsonQueryParam';
 export default <E extends Entity>(config: FacadeConfig<E>) => {
   return async (req: Request, res: Response) => {
     await config.handleTransaction({ req, res }, async () => {
+      const filter = getJsonQueryParam(req.query, 'filter');
       const { entity } = await config.service.replaceEntity({
         entity: req.body,
-        filter: config.constructFilter(getJsonQueryParam(req.query, 'filter')),
+        filter: config.constructFilter({ filter, req, res }),
         id: req.params.id,
       });
       res.status(OK).json(entity);

src/utils/FilterConstructor.ts

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