feat: add default values to crudOptions

doralteres · Sep 18, 2023 · 3537deb · 3537deb
1 parent 852fc1a
commit 3537deb
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -0,0 +1,10 @@
+import {customFields} from './types';
+
+export const GET_LIST_DEFAULT_FILTERABLE_FIELDS: customFields = [];
+export const GET_LIST_DEFAULT_SORTABLE_FIELDS: customFields = [];
+export const DEFAULT_CREATABLE_FIELDS: customFields = {
+  exclude: ['id', 'createdAt', 'updatedAt'],
+};
+export const DEFAULT_UPDATABLE_FIELDS: customFields = {
+  exclude: ['id', 'createdAt', 'updatedAt'],
+};
diff --git a/src/middleware/body.ts b/src/middleware/body.ts
@@ -3,7 +3,7 @@ import {customFields} from '../types';
 import {isIncludeExcludeMatchCriteria} from './config';
 import {crudError} from '../utils';
 
-export const checkBodyFields = (bodyFields: customFields = []) => {
+export const checkBodyFields = (bodyFields: customFields) => {
   return async (req: Request, res: Response, next: NextFunction) => {
     const toTest = Object.keys(req.body);
     const {result, problematicFields} = await isIncludeExcludeMatchCriteria(

diff --git a/src/middleware/query.ts b/src/middleware/query.ts
@@ -4,6 +4,10 @@ import {customFields} from '../types';
 import {NextFunction, Request, Response} from 'express';
 import {isIncludeExcludeMatchCriteria} from './config';
 import {crudError} from '../utils';
+import {
+  GET_LIST_DEFAULT_FILTERABLE_FIELDS,
+  GET_LIST_DEFAULT_SORTABLE_FIELDS,
+} from '../config';
 
 export const buildOptionsFromQueryParams = (
   q: Record<string, any>,
@@ -24,7 +28,9 @@ export const buildOptionsFromQueryParams = (
   };
 };
 
-export const checkFilterableFields = (filterableFields: customFields = []) => {
+export const checkFilterableFields = (
+  filterableFields: customFields = GET_LIST_DEFAULT_FILTERABLE_FIELDS
+) => {
   return async (req: Request, res: Response, next: NextFunction) => {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const {_sort, _order, _start, _end, ...where} = req.query;
@@ -50,7 +56,9 @@ export const checkFilterableFields = (filterableFields: customFields = []) => {
   };
 };
 
-export const checkSortableFields = (sortableFields: customFields = []) => {
+export const checkSortableFields = (
+  sortableFields: customFields = GET_LIST_DEFAULT_SORTABLE_FIELDS
+) => {
   return async (req: Request, res: Response, next: NextFunction) => {
     const {_sort} = req.query;
     if (

diff --git a/src/routes/create.ts b/src/routes/create.ts
@@ -8,6 +8,7 @@ import {
 import {checkBodyFields} from '../middleware/body';
 import {getSequelizeErrorMessage} from '../utils';
 import {Sequelize} from 'sequelize';
+import {DEFAULT_CREATABLE_FIELDS} from '../config';
 
 const createRoute = (
   sequelize: Sequelize,
@@ -18,7 +19,7 @@ const createRoute = (
   router.post(
     '/',
     runCustomMiddleware(config.middleware),
-    checkBodyFields(config.creatableFields),
+    checkBodyFields(config.creatableFields || DEFAULT_CREATABLE_FIELDS),
     async (req, res) => {
       const {middleware, creatableFields, ...sequelizeOptions} = config;
       try {

diff --git a/src/routes/update.ts b/src/routes/update.ts
@@ -8,6 +8,7 @@ import {
 import {checkBodyFields} from '../middleware/body';
 import {getSequelizeErrorMessage} from '../utils';
 import {Sequelize} from 'sequelize';
+import {DEFAULT_UPDATABLE_FIELDS} from '../config';
 
 const updateRoute = (
   sequelize: Sequelize,
@@ -18,7 +19,7 @@ const updateRoute = (
   router.put(
     '/:resourceId',
     runCustomMiddleware(config.middleware),
-    checkBodyFields(config.updatableFields),
+    checkBodyFields(config.updatableFields || DEFAULT_UPDATABLE_FIELDS),
     async (req, res) => {
       const {middleware, updatableFields, ...sequelizeOptions} = config;
       try {