Feat reducer payload

packages/ra-core/src/controller/list/queryReducer.ts

@@ -19,36 +19,54 @@ export const HIDE_FILTER = 'HIDE_FILTER';
 const oppositeOrder = direction =>
     direction === SORT_DESC ? SORT_ASC : SORT_DESC;
 
+type SetSortPayload = {
+    field: string;
+    order?: typeof SORT_ASC | typeof SORT_DESC;
+};
+
+type SetPagePayload = number;
+
+type SetPerPagePayload = number;
+
+type SetFilterPayload = {
+    filter: any;
+    displayedFilters?: { [key: string]: boolean };
+};
+
+type SetShowFilterPayload = { filterName: string; defaultValue?: any };
+
+type SetHideFilterPayload = string;
+
+type SetDefaultPayload = ListParams;
+
 type ActionTypes =
     | {
           type: typeof SET_SORT;
-          payload: {
-              field: string;
-              order?: typeof SORT_ASC | typeof SORT_DESC;
-          };
+          payload: SetSortPayload;
       }
     | {
           type: typeof SET_PAGE;
-          payload: number;
+          payload: SetPagePayload;
       }
     | {
           type: typeof SET_PER_PAGE;
-          payload: number;
+          payload: SetPerPagePayload;
       }
     | {
           type: typeof SET_FILTER;
-          payload: {
-              filter: any;
-              displayedFilters?: { [key: string]: boolean };
-          };
+          payload: SetFilterPayload;
       }
     | {
           type: typeof SHOW_FILTER;
-          payload: { filterName: string; defaultValue?: any };
+          payload: SetShowFilterPayload;
       }
     | {
           type: typeof HIDE_FILTER;
-          payload: string;
+          payload: SetHideFilterPayload;
+      }
+    | {
+          type: undefined;
+          payload: SetDefaultPayload;
       };
 
 /**
@@ -57,10 +75,11 @@ type ActionTypes =
 export const queryReducer: Reducer<ListParams, ActionTypes> = (
     previousState,
     action
-) => {
+): ListParams => {
     switch (action.type) {
         case SET_SORT:
-            if (action.payload.field === previousState.sort) {
+            const { field } = action.payload as SetSortPayload;
+            if (field === previousState.sort) {
                 return {
                     ...previousState,
                     order: oppositeOrder(previousState.order),
@@ -70,16 +89,20 @@ export const queryReducer: Reducer<ListParams, ActionTypes> = (
 
             return {
                 ...previousState,
-                sort: action.payload.field,
+                sort: field,
                 order: action.payload.order || SORT_ASC,
                 page: 1,
             };
 
         case SET_PAGE:
-            return { ...previousState, page: action.payload };
+            return { ...previousState, page: action.payload as SetPagePayload };
 
         case SET_PER_PAGE:
-            return { ...previousState, page: 1, perPage: action.payload };
+            return {
+                ...previousState,
+                page: 1,
+                perPage: action.payload as SetPerPagePayload,
+            };
 
         case SET_FILTER: {
             return {
@@ -93,28 +116,28 @@ export const queryReducer: Reducer<ListParams, ActionTypes> = (
         }
 
         case SHOW_FILTER: {
+            const {
+                filterName,
+                defaultValue,
+            } = action.payload as SetShowFilterPayload;
             if (
                 previousState.displayedFilters &&
-                previousState.displayedFilters[action.payload.filterName]
+                previousState.displayedFilters[filterName]
             ) {
                 // the filter is already shown
                 return previousState;
             }
             return {
                 ...previousState,
                 filter:
-                    typeof action.payload.defaultValue !== 'undefined'
-                        ? set(
-                              previousState.filter,
-                              action.payload.filterName,
-                              action.payload.defaultValue
-                          )
+                    typeof defaultValue !== 'undefined'
+                        ? set(previousState.filter, filterName, defaultValue)
                         : previousState.filter,
                 // we don't use lodash.set() for displayed filters
                 // to avoid problems with compound filter names (e.g. 'author.name')
                 displayedFilters: {
                     ...previousState.displayedFilters,
-                    [action.payload.filterName]: true,
+                    [filterName]: true,
                 },
             };
         }
@@ -141,7 +164,10 @@ export const queryReducer: Reducer<ListParams, ActionTypes> = (
         }
 
         default:
-            return previousState;
+            return (
+                ((action as ActionTypes).payload as SetDefaultPayload) ??
+                previousState
+            );
     }
 };
 

packages/ra-core/src/controller/list/useListController.ts

@@ -1,5 +1,6 @@
 import { isValidElement, useEffect, useMemo } from 'react';
 import { UseQueryOptions } from 'react-query';
+import { omit } from 'lodash';
 
 import { useAuthenticated } from '../../auth';
 import { useTranslate } from '../../i18n';
@@ -85,6 +86,11 @@ export const useListController = <RecordType extends RaRecord = any>(
     } = useGetList<RecordType>(
         resource,
         {
+            ...omit(query, [
+                'requestSignature',
+                'displayedFilters',
+                'filterValues',
+            ]),
             pagination: {
                 page: query.page,
                 perPage: query.perPage,

packages/ra-core/src/controller/list/useListParams.ts

@@ -299,10 +299,7 @@ const parseObject = (query, field) => {
 };
 
 export const parseQueryFromLocation = ({ search }): Partial<ListParams> => {
-    const query = pickBy(
-        parse(search),
-        (v, k) => validQueryParams.indexOf(k) !== -1
-    );
+    const query = parse(search);
     parseObject(query, 'filter');
     parseObject(query, 'displayedFilters');
     return query;

packages/ra-core/src/dataProvider/useGetList.ts

@@ -63,6 +63,7 @@ export const useGetList = <RecordType extends RaRecord = any>(
         sort = { field: 'id', order: 'DESC' },
         filter = {},
         meta,
+        ...rest
     } = params;
     const dataProvider = useDataProvider();
     const queryClient = useQueryClient();
@@ -71,10 +72,11 @@ export const useGetList = <RecordType extends RaRecord = any>(
         Error,
         GetListResult<RecordType>
     >(
-        [resource, 'getList', { pagination, sort, filter, meta }],
+        [resource, 'getList', { ...rest, pagination, sort, filter, meta }],
         () =>
             dataProvider
                 .getList<RecordType>(resource, {
+                    ...rest,
                     pagination,
                     sort,
                     filter,