feat: Adds constructFilter to config.

readme.md

@@ -27,7 +27,11 @@ export interface TodoEntity extends Entity {
 import factory from '@js-entity-repos/express/dist/factory';
 
 const todosFacade = factory<TodoEntity>({
-  // Optional property that determines the default pagination limit.
+  // Optional property that modifies a filter for the service.
+  constructFilter: (filter) => {
+    return filter;
+  },
+  // Optional property.
   defaultPaginationLimit: 10,
   // Optional property that catches errors from handlers.
   errorCatcher: (handler) => (req, res) => {

src/FacadeConfig.ts

@@ -1,8 +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 ErrorCatcher from './utils/ErrorCatcher';
 
 export default interface FacadeConfig<E extends Entity> {
+  readonly constructFilter: (filter: Filter<E>) => any;
   readonly service: Facade<E>;
   readonly errorCatcher: ErrorCatcher;
   readonly defaultPaginationLimit: number;

src/factory.ts

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

src/functions/countEntities.ts

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

src/functions/getEntities.ts

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

src/functions/getEntity.ts

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

src/functions/patchEntities.ts

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

src/functions/removeEntities.ts

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

src/functions/removeEntity.ts

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

src/functions/replaceEntity.ts

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

src/utils/getJsonQueryParam.ts

@@ -3,5 +3,5 @@ import Query from './Query';
 
 export default (data: Query, paramName: string) => {
   const paramValue = data[paramName];
-  return paramValue === undefined ? undefined : parseJson(paramValue, [paramName]);
+  return paramValue === undefined ? {} : parseJson(paramValue, [paramName]);
 };