@strato-admin/ra-core 0.1.0

package/dist/controller/list/useListParams.js

@@ -0,0 +1,282 @@
+import { useCallback, useMemo, useEffect, useState, useRef } from 'react';
+import { parse, stringify } from 'query-string';
+import lodashDebounce from 'lodash/debounce.js';
+import { useStore } from "../../store/index.js";
+import { useNavigate, useLocation } from "../../routing/index.js";
+import queryReducer, { SET_FILTER, HIDE_FILTER, SHOW_FILTER, SET_PAGE, SET_PER_PAGE, SET_SORT, SORT_ASC, } from "./queryReducer.js";
+import removeEmpty from "../../util/removeEmpty.js";
+import { useIsMounted } from "../../util/hooks.js";
+/**
+ * Get the list parameters (page, sort, filters) and modifiers.
+ *
+ * These parameters are merged from 3 sources:
+ *   - the query string from the URL
+ *   - the params stored in the state (from previous navigation)
+ *   - the options passed to the hook (including the filter defaultValues)
+ *
+ * @returns {Array} A tuple [parameters, modifiers].
+ * Destructure as [
+ *    { page, perPage, sort, order, filter, filterValues, displayedFilters, requestSignature },
+ *    { setFilters, hideFilter, showFilter, setPage, setPerPage, setSort }
+ * ]
+ *
+ * @example
+ *
+ * const [listParams, listParamsActions] = useListParams({
+ *      resource: 'posts',
+ *      location: location // From react-router. Injected to your component by react-admin inside a List
+ *      filterDefaultValues: {
+ *          published: true
+ *      },
+ *      sort: {
+ *          field: 'published_at',
+ *          order: 'DESC'
+ *      },
+ *      perPage: 25
+ * });
+ *
+ * const {
+ *      page,
+ *      perPage,
+ *      sort,
+ *      order,
+ *      filter,
+ *      filterValues,
+ *      displayedFilters,
+ *      requestSignature
+ * } = listParams;
+ *
+ * const {
+ *      setFilters,
+ *      hideFilter,
+ *      showFilter,
+ *      setPage,
+ *      setPerPage,
+ *      setSort,
+ * } = listParamsActions;
+ */
+export const useListParams = ({ debounce = 500, disableSyncWithLocation = false, filterDefaultValues, perPage = 10, resource, sort = defaultSort, storeKey = disableSyncWithLocation ? false : `${resource}.listParams`, }) => {
+    const location = useLocation();
+    const navigate = useNavigate();
+    const [localParams, setLocalParams] = useState(defaultParams);
+    // As we can't conditionally call a hook, if the storeKey is false,
+    // we'll ignore the params variable later on and won't call setParams either.
+    const [params, setParams] = useStore(storeKey || `${resource}.listParams`, defaultParams);
+    const tempParams = useRef(undefined);
+    const isMounted = useIsMounted();
+    const requestSignature = [
+        location.search,
+        resource,
+        storeKey,
+        JSON.stringify(!storeKey ? localParams : params),
+        JSON.stringify(filterDefaultValues),
+        JSON.stringify(sort),
+        perPage,
+        disableSyncWithLocation,
+    ];
+    const queryFromLocation = disableSyncWithLocation
+        ? {}
+        : parseQueryFromLocation(location);
+    const query = useMemo(() => getQuery({
+        queryFromLocation,
+        params: !storeKey ? localParams : params,
+        filterDefaultValues,
+        sort,
+        perPage,
+    }), requestSignature // eslint-disable-line react-hooks/exhaustive-deps
+    );
+    // if the location includes params (for example from a link like
+    // the categories products on the demo), we need to persist them in the
+    // store as well so that we don't lose them after a redirection back
+    // to the list
+    useEffect(() => {
+        if (Object.keys(queryFromLocation).length > 0) {
+            setParams(query);
+        }
+    }, [location.search]); // eslint-disable-line
+    const changeParams = useCallback(action => {
+        // do not change params if the component is already unmounted
+        // this is necessary because changeParams can be debounced, and therefore
+        // executed after the component is unmounted
+        if (!isMounted.current)
+            return;
+        if (!tempParams.current) {
+            // no other changeParams action dispatched this tick
+            tempParams.current = queryReducer(query, action);
+            // schedule side effects for next tick
+            setTimeout(() => {
+                if (!tempParams.current) {
+                    // the side effects were already processed by another changeParams
+                    return;
+                }
+                if (disableSyncWithLocation && !storeKey) {
+                    setLocalParams(tempParams.current);
+                }
+                else if (disableSyncWithLocation && !!storeKey) {
+                    setParams(tempParams.current);
+                }
+                else {
+                    // the useEffect above will apply the changes to the params in the store
+                    navigate({
+                        search: `?${stringify({
+                            ...tempParams.current,
+                            filter: JSON.stringify(tempParams.current.filter),
+                            displayedFilters: JSON.stringify(tempParams.current.displayedFilters),
+                        })}`,
+                    }, {
+                        state: {
+                            _scrollToTop: action.type === SET_PAGE,
+                        },
+                    });
+                }
+                tempParams.current = undefined;
+            }, 0);
+        }
+        else {
+            // side effects already scheduled, just change the params
+            tempParams.current = queryReducer(tempParams.current, action);
+        }
+    }, [...requestSignature, navigate] // eslint-disable-line react-hooks/exhaustive-deps
+    );
+    const setSort = useCallback((sort) => changeParams({
+        type: SET_SORT,
+        payload: sort,
+    }), [changeParams]);
+    const setPage = useCallback((newPage) => changeParams({ type: SET_PAGE, payload: newPage }), [changeParams]);
+    const setPerPage = useCallback((newPerPage) => changeParams({ type: SET_PER_PAGE, payload: newPerPage }), [changeParams]);
+    const filterValues = query.filter || emptyObject;
+    const displayedFilterValues = query.displayedFilters || emptyObject;
+    const debouncedSetFilters = lodashDebounce((filter, displayedFilters) => {
+        changeParams({
+            type: SET_FILTER,
+            payload: {
+                filter: removeEmpty(filter),
+                displayedFilters,
+            },
+        });
+    }, debounce);
+    const setFilters = useCallback((filter, displayedFilters = undefined, debounce = false) => debounce
+        ? debouncedSetFilters(filter, displayedFilters)
+        : changeParams({
+            type: SET_FILTER,
+            payload: {
+                filter: removeEmpty(filter),
+                displayedFilters,
+            },
+        }), [changeParams] // eslint-disable-line react-hooks/exhaustive-deps
+    );
+    const hideFilter = useCallback((filterName) => {
+        changeParams({
+            type: HIDE_FILTER,
+            payload: filterName,
+        });
+    }, [changeParams]);
+    const showFilter = useCallback((filterName, defaultValue) => {
+        changeParams({
+            type: SHOW_FILTER,
+            payload: {
+                filterName,
+                defaultValue,
+            },
+        });
+    }, [changeParams]);
+    return [
+        {
+            filterValues,
+            requestSignature,
+            ...query,
+            displayedFilters: displayedFilterValues,
+        },
+        {
+            changeParams,
+            setPage,
+            setPerPage,
+            setSort,
+            setFilters,
+            hideFilter,
+            showFilter,
+        },
+    ];
+};
+const parseObject = (query, field) => {
+    if (query[field] && typeof query[field] === 'string') {
+        try {
+            query[field] = JSON.parse(query[field]);
+        }
+        catch (err) {
+            delete query[field];
+        }
+    }
+};
+export const parseQueryFromLocation = ({ search }) => {
+    const query = parse(search);
+    parseObject(query, 'filter');
+    parseObject(query, 'displayedFilters');
+    return query;
+};
+/**
+ * Check if user has already set custom sort, page, or filters for this list
+ *
+ * User params come from the store as the params props. By default,
+ * this object is:
+ *
+ * { filter: {}, order: null, page: 1, perPage: null, sort: null }
+ *
+ * To check if the user has custom params, we must compare the params
+ * to these initial values.
+ *
+ * @param {Object} params
+ */
+export const hasCustomParams = (params) => {
+    return (params &&
+        params.filter &&
+        (Object.keys(params.filter).length > 0 ||
+            params.order != null ||
+            params.page !== 1 ||
+            params.perPage != null ||
+            params.sort != null));
+};
+/**
+ * Merge list params from 3 different sources:
+ *   - the query string
+ *   - the params stored in the state (from previous navigation)
+ *   - the props passed to the List component (including the filter defaultValues)
+ */
+export const getQuery = ({ queryFromLocation, params, filterDefaultValues, sort, perPage, }) => {
+    const query = Object.keys(queryFromLocation).length > 0
+        ? queryFromLocation
+        : hasCustomParams(params)
+            ? { ...params }
+            : { filter: filterDefaultValues || {} };
+    if (!query.sort) {
+        query.sort = sort.field;
+        query.order = sort.order;
+    }
+    if (query.perPage == null) {
+        query.perPage = perPage;
+    }
+    if (query.page == null) {
+        query.page = 1;
+    }
+    return {
+        ...query,
+        page: getNumberOrDefault(query.page, 1),
+        perPage: getNumberOrDefault(query.perPage, 10),
+    };
+};
+export const getNumberOrDefault = (possibleNumber, defaultValue) => {
+    if (typeof possibleNumber === 'undefined') {
+        return defaultValue;
+    }
+    const parsedNumber = typeof possibleNumber === 'string'
+        ? parseInt(possibleNumber, 10)
+        : possibleNumber;
+    return isNaN(parsedNumber) ? defaultValue : parsedNumber;
+};
+const emptyObject = {};
+const defaultSort = {
+    field: 'id',
+    order: SORT_ASC,
+};
+const defaultParams = {};
+//# sourceMappingURL=useListParams.js.map

package/dist/controller/list/useListParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListParams.js","sourceRoot":"","sources":["../../../src/controller/list/useListParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,cAAc,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,6BAAoB;AACvC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,+BAAsB;AACzD,OAAO,YAAY,EAAE,EACjB,UAAU,EACV,WAAW,EACX,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,GACX,0BAAuB;AAExB,OAAO,WAAW,kCAA+B;AACjD,OAAO,EAAE,YAAY,EAAE,4BAAyB;AAWhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAC1B,QAAQ,GAAG,GAAG,EACd,uBAAuB,GAAG,KAAK,EAC/B,mBAAmB,EACnB,OAAO,GAAG,EAAE,EACZ,QAAQ,EACR,IAAI,GAAG,WAAW,EAClB,QAAQ,GAAG,uBAAuB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,aAAa,GACrD,EAA2B,EAAE;IAC7C,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC9D,mEAAmE;IACnE,6EAA6E;IAC7E,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAChC,QAAQ,IAAI,GAAG,QAAQ,aAAa,EACpC,aAAa,CAChB,CAAC;IACF,MAAM,UAAU,GAAG,MAAM,CAAyB,SAAS,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IAEjC,MAAM,gBAAgB,GAAG;QACrB,QAAQ,CAAC,MAAM;QACf,QAAQ;QACR,QAAQ;QACR,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC;QAChD,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC;QACnC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QACpB,OAAO;QACP,uBAAuB;KAC1B,CAAC;IAEF,MAAM,iBAAiB,GAAG,uBAAuB;QAC7C,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEvC,MAAM,KAAK,GAAG,OAAO,CACjB,GAAG,EAAE,CACD,QAAQ,CAAC;QACL,iBAAiB;QACjB,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM;QACxC,mBAAmB;QACnB,IAAI;QACJ,OAAO;KACV,CAAC,EACN,gBAAgB,CAAC,kDAAkD;KACtE,CAAC;IAEF,gEAAgE;IAChE,uEAAuE;IACvE,oEAAoE;IACpE,cAAc;IACd,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,SAAS,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,sBAAsB;IAE7C,MAAM,YAAY,GAAG,WAAW,CAC5B,MAAM,CAAC,EAAE;QACL,6DAA6D;QAC7D,yEAAyE;QACzE,4CAA4C;QAC5C,IAAI,CAAC,SAAS,CAAC,OAAO;YAAE,OAAO;QAE/B,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YACtB,oDAAoD;YACpD,UAAU,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACjD,sCAAsC;YACtC,UAAU,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;oBACtB,kEAAkE;oBAClE,OAAO;gBACX,CAAC;gBACD,IAAI,uBAAuB,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACvC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACvC,CAAC;qBAAM,IAAI,uBAAuB,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;oBAC/C,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACJ,wEAAwE;oBACxE,QAAQ,CACJ;wBACI,MAAM,EAAE,IAAI,SAAS,CAAC;4BAClB,GAAG,UAAU,CAAC,OAAO;4BACrB,MAAM,EAAE,IAAI,CAAC,SAAS,CAClB,UAAU,CAAC,OAAO,CAAC,MAAM,CAC5B;4BACD,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAC5B,UAAU,CAAC,OAAO,CAAC,gBAAgB,CACtC;yBACJ,CAAC,EAAE;qBACP,EACD;wBACI,KAAK,EAAE;4BACH,YAAY,EAAE,MAAM,CAAC,IAAI,KAAK,QAAQ;yBACzC;qBACJ,CACJ,CAAC;gBACN,CAAC;gBACD,UAAU,CAAC,OAAO,GAAG,SAAS,CAAC;YACnC,CAAC,EAAE,CAAC,CAAC,CAAC;QACV,CAAC;aAAM,CAAC;YACJ,yDAAyD;YACzD,UAAU,CAAC,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;IACL,CAAC,EACD,CAAC,GAAG,gBAAgB,EAAE,QAAQ,CAAC,CAAC,kDAAkD;KACrF,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,CACvB,CAAC,IAAiB,EAAE,EAAE,CAClB,YAAY,CAAC;QACT,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KAChB,CAAC,EACN,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,CACvB,CAAC,OAAe,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EACvE,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC1B,CAAC,UAAkB,EAAE,EAAE,CACnB,YAAY,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,EAC7D,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,IAAI,WAAW,CAAC;IACjD,MAAM,qBAAqB,GAAG,KAAK,CAAC,gBAAgB,IAAI,WAAW,CAAC;IAEpE,MAAM,mBAAmB,GAAG,cAAc,CAAC,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE;QACpE,YAAY,CAAC;YACT,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE;gBACL,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;gBAC3B,gBAAgB;aACnB;SACJ,CAAC,CAAC;IACP,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEb,MAAM,UAAU,GAAG,WAAW,CAC1B,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,EAAE,CACvD,QAAQ;QACJ,CAAC,CAAC,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,CAAC;QAC/C,CAAC,CAAC,YAAY,CAAC;YACT,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE;gBACL,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;gBAC3B,gBAAgB;aACnB;SACJ,CAAC,EACZ,CAAC,YAAY,CAAC,CAAC,kDAAkD;KACpE,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC1B,CAAC,UAAkB,EAAE,EAAE;QACnB,YAAY,CAAC;YACT,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,UAAU;SACtB,CAAC,CAAC;IACP,CAAC,EACD,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC1B,CAAC,UAAkB,EAAE,YAAiB,EAAE,EAAE;QACtC,YAAY,CAAC;YACT,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE;gBACL,UAAU;gBACV,YAAY;aACf;SACJ,CAAC,CAAC;IACP,CAAC,EACD,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF,OAAO;QACH;YACI,YAAY;YACZ,gBAAgB;YAChB,GAAG,KAAK;YACR,gBAAgB,EAAE,qBAAqB;SAC1C;QACD;YACI,YAAY;YACZ,OAAO;YACP,UAAU;YACV,OAAO;YACP,UAAU;YACV,UAAU;YACV,UAAU;SACb;KACJ,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IACjC,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EAAE,MAAM,EAAE,EAAuB,EAAE;IACtE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC7B,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAkB,EAAE,EAAE;IAClD,OAAO,CACH,MAAM;QACN,MAAM,CAAC,MAAM;QACb,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC;YAClC,MAAM,CAAC,KAAK,IAAI,IAAI;YACpB,MAAM,CAAC,IAAI,KAAK,CAAC;YACjB,MAAM,CAAC,OAAO,IAAI,IAAI;YACtB,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAC3B,CAAC;AACN,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EACrB,iBAAiB,EACjB,MAAM,EACN,mBAAmB,EACnB,IAAI,EACJ,OAAO,GACV,EAAE,EAAE;IACD,MAAM,KAAK,GACP,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC;QACrC,CAAC,CAAC,iBAAiB;QACnB,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC;YACvB,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE;YACf,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,IAAI,EAAE,EAAE,CAAC;IAElD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IAC7B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IAC5B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,OAAO;QACH,GAAG,KAAK;QACR,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;KACnC,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAC9B,cAA2C,EAC3C,YAAoB,EACtB,EAAE;IACA,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE,CAAC;QACxC,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,MAAM,YAAY,GACd,OAAO,cAAc,KAAK,QAAQ;QAC9B,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC;QAC9B,CAAC,CAAC,cAAc,CAAC;IAEzB,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC;AAC7D,CAAC,CAAC;AAqCF,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,MAAM,WAAW,GAAG;IAChB,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,QAAQ;CACT,CAAC;AAEX,MAAM,aAAa,GAAG,EAAE,CAAC"}

package/dist/controller/list/useListSortContext.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useListSortContext = void 0;
+const react_1 = require("react");
+const ListSortContext_1 = require("./ListSortContext.cjs");
+/**
+ * Hook to read the list sort controller props from the ListSortContext.
+ *
+ * Must be used within a <ListSortContextProvider> (e.g. as a descendent of <List>
+ * or <ListBase>).
+ *
+ * @returns {ListSortContextValue} list controller props
+ *
+ * @see useListController for how it is filled
+ */
+const useListSortContext = () => {
+    const context = (0, react_1.useContext)(ListSortContext_1.ListSortContext);
+    if (!context) {
+        throw new Error('useListSortContext must be used inside a ListSortContextProvider');
+    }
+    return context;
+};
+exports.useListSortContext = useListSortContext;
+//# sourceMappingURL=useListSortContext.js.map

package/dist/controller/list/useListSortContext.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListSortContext.js","sourceRoot":"","sources":["../../../src/controller/list/useListSortContext.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AAEnC,2DAA0E;AAE1E;;;;;;;;;GASG;AACI,MAAM,kBAAkB,GAAG,GAAyB,EAAE;IACzD,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,iCAAe,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACX,kEAAkE,CACrE,CAAC;IACN,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AARW,QAAA,kBAAkB,sBAQ7B"}

package/dist/controller/list/useListSortContext.d.cts

@@ -0,0 +1,13 @@
+import { ListSortContextValue } from "./ListSortContext.cjs";
+/**
+ * Hook to read the list sort controller props from the ListSortContext.
+ *
+ * Must be used within a <ListSortContextProvider> (e.g. as a descendent of <List>
+ * or <ListBase>).
+ *
+ * @returns {ListSortContextValue} list controller props
+ *
+ * @see useListController for how it is filled
+ */
+export declare const useListSortContext: () => ListSortContextValue;
+//# sourceMappingURL=useListSortContext.d.ts.map

package/dist/controller/list/useListSortContext.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListSortContext.d.ts","sourceRoot":"","sources":["../../../src/controller/list/useListSortContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,oBAAoB,EAAE,8BAA0B;AAE1E;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,QAAO,oBAQrC,CAAC"}

package/dist/controller/list/useListSortContext.d.ts

@@ -0,0 +1,13 @@
+import { ListSortContextValue } from "./ListSortContext.js";
+/**
+ * Hook to read the list sort controller props from the ListSortContext.
+ *
+ * Must be used within a <ListSortContextProvider> (e.g. as a descendent of <List>
+ * or <ListBase>).
+ *
+ * @returns {ListSortContextValue} list controller props
+ *
+ * @see useListController for how it is filled
+ */
+export declare const useListSortContext: () => ListSortContextValue;
+//# sourceMappingURL=useListSortContext.d.ts.map

package/dist/controller/list/useListSortContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListSortContext.d.ts","sourceRoot":"","sources":["../../../src/controller/list/useListSortContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,oBAAoB,EAAE,6BAA0B;AAE1E;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,QAAO,oBAQrC,CAAC"}

package/dist/controller/list/useListSortContext.js

@@ -0,0 +1,20 @@
+import { useContext } from 'react';
+import { ListSortContext } from "./ListSortContext.js";
+/**
+ * Hook to read the list sort controller props from the ListSortContext.
+ *
+ * Must be used within a <ListSortContextProvider> (e.g. as a descendent of <List>
+ * or <ListBase>).
+ *
+ * @returns {ListSortContextValue} list controller props
+ *
+ * @see useListController for how it is filled
+ */
+export const useListSortContext = () => {
+    const context = useContext(ListSortContext);
+    if (!context) {
+        throw new Error('useListSortContext must be used inside a ListSortContextProvider');
+    }
+    return context;
+};
+//# sourceMappingURL=useListSortContext.js.map

package/dist/controller/list/useListSortContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListSortContext.js","sourceRoot":"","sources":["../../../src/controller/list/useListSortContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,eAAe,EAAwB,6BAA0B;AAE1E;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAyB,EAAE;IACzD,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACX,kEAAkE,CACrE,CAAC;IACN,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC"}

package/dist/controller/list/useRecordSelection.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRecordSelection = void 0;
+const react_1 = require("react");
+const store_1 = require("../../store/index.cjs");
+/**
+ * Get the list of selected items for a resource, and callbacks to change the selection
+ *
+ * @param args.resource The resource name, e.g. 'posts'
+ * @param args.storeKey The key to use to store selected items. Pass false to disable synchronization with the store.
+ * @param args.disableSyncWithStore Controls the selection synchronization with the store
+ *
+ * @returns {Object} Destructure as [selectedIds, { select, unselect, toggle, clearSelection }].
+ */
+const useRecordSelection = (args) => {
+    const { resource = '', storeKey, disableSyncWithStore } = args;
+    const finalStoreKey = `${storeKey || resource}.selectedIds`;
+    const [localSelectionStore, setLocalSelectionStore] = (0, react_1.useState)(defaultIds);
+    // As we can't conditionally call a hook, if the disableSyncWithStore is true,
+    // we'll ignore the useStore values later on and won't call set functions either.
+    const [selectionStore, setSelectionStore] = (0, store_1.useStore)(finalStoreKey, defaultIds);
+    const [storeKeys, setStoreKeys] = (0, store_1.useStore)(`${resource}.selectedIds.storeKeys`, defaultStoreKeys);
+    (0, react_1.useEffect)(function addStoreKeyToStore() {
+        if (!disableSyncWithStore && storeKey) {
+            setStoreKeys(storeKeys => {
+                if (!storeKeys.includes(finalStoreKey)) {
+                    return [...storeKeys, finalStoreKey];
+                }
+                else {
+                    return storeKeys;
+                }
+            });
+        }
+    }, [disableSyncWithStore, finalStoreKey, setStoreKeys, storeKey]);
+    const { getItem, setItem } = (0, store_1.useStoreContext)();
+    const ids = disableSyncWithStore ? localSelectionStore : selectionStore;
+    const setStore = (0, react_1.useMemo)(() => disableSyncWithStore ? setLocalSelectionStore : setSelectionStore, [disableSyncWithStore, setSelectionStore]);
+    const selectionModifiers = (0, react_1.useMemo)(() => ({
+        select: (idsToSelect) => {
+            if (!idsToSelect)
+                return;
+            setStore(idsToSelect);
+        },
+        unselect(idsToRemove, fromAllStoreKeys) {
+            if (!idsToRemove || idsToRemove.length === 0)
+                return;
+            setStore(ids => ids.filter(id => !idsToRemove.includes(id)));
+            if (!disableSyncWithStore && fromAllStoreKeys) {
+                storeKeys
+                    .filter(storeKey => storeKey !== finalStoreKey)
+                    .forEach(storeKey => {
+                    const ids = getItem(storeKey);
+                    if (ids) {
+                        setItem(storeKey, ids.filter(id => !idsToRemove.includes(id)));
+                    }
+                });
+            }
+        },
+        toggle: (id) => {
+            if (typeof id === 'undefined')
+                return;
+            setStore(ids => {
+                if (!Array.isArray(ids))
+                    return [...ids];
+                const index = ids.indexOf(id);
+                const hasId = index > -1;
+                return hasId
+                    ? [...ids.slice(0, index), ...ids.slice(index + 1)]
+                    : [...ids, id];
+            });
+        },
+        clearSelection: (fromAllStoreKeys) => {
+            setStore(defaultIds);
+            if (!disableSyncWithStore && fromAllStoreKeys) {
+                storeKeys
+                    .filter(storeKey => storeKey !== finalStoreKey)
+                    .forEach(storeKey => {
+                    const ids = getItem(storeKey);
+                    if (ids) {
+                        setItem(storeKey, defaultIds);
+                    }
+                });
+            }
+        },
+    }), [
+        disableSyncWithStore,
+        finalStoreKey,
+        getItem,
+        setItem,
+        setStore,
+        storeKeys,
+    ]);
+    return [ids, selectionModifiers];
+};
+exports.useRecordSelection = useRecordSelection;
+const defaultIds = [];
+const defaultStoreKeys = [];
+//# sourceMappingURL=useRecordSelection.js.map

package/dist/controller/list/useRecordSelection.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRecordSelection.js","sourceRoot":"","sources":["../../../src/controller/list/useRecordSelection.ts"],"names":[],"mappings":";;;AAAA,iCAAqD;AAErD,iDAAwD;AA4BxD;;;;;;;;GAQG;AACI,MAAM,kBAAkB,GAAG,CAC9B,IAA4B,EACQ,EAAE;IACtC,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,QAAQ,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IAE/D,MAAM,aAAa,GAAG,GAAG,QAAQ,IAAI,QAAQ,cAAc,CAAC;IAE5D,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAC/C,IAAA,gBAAQ,EAAqB,UAAU,CAAC,CAAC;IAC7C,8EAA8E;IAC9E,iFAAiF;IACjF,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,IAAA,gBAAQ,EAChD,aAAa,EACb,UAAU,CACb,CAAC;IACF,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,IAAA,gBAAQ,EACtC,GAAG,QAAQ,wBAAwB,EACnC,gBAAgB,CACnB,CAAC;IAEF,IAAA,iBAAS,EACL,SAAS,kBAAkB;QACvB,IAAI,CAAC,oBAAoB,IAAI,QAAQ,EAAE,CAAC;YACpC,YAAY,CAAC,SAAS,CAAC,EAAE;gBACrB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;oBACrC,OAAO,CAAC,GAAG,SAAS,EAAE,aAAa,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACJ,OAAO,SAAS,CAAC;gBACrB,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC,EACD,CAAC,oBAAoB,EAAE,aAAa,EAAE,YAAY,EAAE,QAAQ,CAAC,CAChE,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAe,GAAE,CAAC;IAE/C,MAAM,GAAG,GAAG,oBAAoB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC;IAExE,MAAM,QAAQ,GAAG,IAAA,eAAO,EACpB,GAAG,EAAE,CACD,oBAAoB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,iBAAiB,EACrE,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAC5C,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAA,eAAO,EAC9B,GAAG,EAAE,CAAC,CAAC;QACH,MAAM,EAAE,CAAC,WAA+B,EAAE,EAAE;YACxC,IAAI,CAAC,WAAW;gBAAE,OAAO;YAEzB,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC1B,CAAC;QACD,QAAQ,CACJ,WAA+B,EAC/B,gBAA0B;YAE1B,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAErD,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAE7D,IAAI,CAAC,oBAAoB,IAAI,gBAAgB,EAAE,CAAC;gBAC5C,SAAS;qBACJ,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,aAAa,CAAC;qBAC9C,OAAO,CAAC,QAAQ,CAAC,EAAE;oBAChB,MAAM,GAAG,GAAG,OAAO,CAAqB,QAAQ,CAAC,CAAC;oBAClD,IAAI,GAAG,EAAE,CAAC;wBACN,OAAO,CACH,QAAQ,EACR,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAC9C,CAAC;oBACN,CAAC;gBACL,CAAC,CAAC,CAAC;YACX,CAAC;QACL,CAAC;QACD,MAAM,EAAE,CAAC,EAAoB,EAAE,EAAE;YAC7B,IAAI,OAAO,EAAE,KAAK,WAAW;gBAAE,OAAO;YAEtC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACX,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;oBAAE,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC;gBAEzC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC9B,MAAM,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;gBAEzB,OAAO,KAAK;oBACR,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;oBACnD,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC;QACD,cAAc,EAAE,CAAC,gBAA0B,EAAE,EAAE;YAC3C,QAAQ,CAAC,UAAU,CAAC,CAAC;YAErB,IAAI,CAAC,oBAAoB,IAAI,gBAAgB,EAAE,CAAC;gBAC5C,SAAS;qBACJ,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,aAAa,CAAC;qBAC9C,OAAO,CAAC,QAAQ,CAAC,EAAE;oBAChB,MAAM,GAAG,GAAG,OAAO,CAAqB,QAAQ,CAAC,CAAC;oBAClD,IAAI,GAAG,EAAE,CAAC;wBACN,OAAO,CACH,QAAQ,EACR,UAAU,CACb,CAAC;oBACN,CAAC;gBACL,CAAC,CAAC,CAAC;YACX,CAAC;QACL,CAAC;KACJ,CAAC,EACF;QACI,oBAAoB;QACpB,aAAa;QACb,OAAO;QACP,OAAO;QACP,QAAQ;QACR,SAAS;KACZ,CACJ,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;AACrC,CAAC,CAAC;AArHW,QAAA,kBAAkB,sBAqH7B;AAEF,MAAM,UAAU,GAAG,EAAE,CAAC;AACtB,MAAM,gBAAgB,GAAG,EAAE,CAAC"}

package/dist/controller/list/useRecordSelection.d.cts

@@ -0,0 +1,33 @@
+import { RaRecord } from "../../types.cjs";
+type UseRecordSelectionWithResourceArgs = {
+    resource: string;
+    storeKey?: string;
+    disableSyncWithStore?: false;
+};
+type UseRecordSelectionWithNoStoreArgs = {
+    resource?: string;
+    storeKey?: string;
+    disableSyncWithStore: true;
+};
+export type UseRecordSelectionArgs = UseRecordSelectionWithResourceArgs | UseRecordSelectionWithNoStoreArgs;
+export type UseRecordSelectionResult<RecordType extends RaRecord = any> = [
+    RecordType['id'][],
+    {
+        select: (ids: RecordType['id'][]) => void;
+        unselect: (ids: RecordType['id'][], fromAllStoreKeys?: boolean) => void;
+        toggle: (id: RecordType['id']) => void;
+        clearSelection: (fromAllStoreKeys?: boolean) => void;
+    }
+];
+/**
+ * Get the list of selected items for a resource, and callbacks to change the selection
+ *
+ * @param args.resource The resource name, e.g. 'posts'
+ * @param args.storeKey The key to use to store selected items. Pass false to disable synchronization with the store.
+ * @param args.disableSyncWithStore Controls the selection synchronization with the store
+ *
+ * @returns {Object} Destructure as [selectedIds, { select, unselect, toggle, clearSelection }].
+ */
+export declare const useRecordSelection: <RecordType extends RaRecord = any>(args: UseRecordSelectionArgs) => UseRecordSelectionResult<RecordType>;
+export {};
+//# sourceMappingURL=useRecordSelection.d.ts.map

package/dist/controller/list/useRecordSelection.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRecordSelection.d.ts","sourceRoot":"","sources":["../../../src/controller/list/useRecordSelection.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,wBAAoB;AAEvC,KAAK,kCAAkC,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AACF,KAAK,iCAAiC,GAAG;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,IAAI,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC5B,kCAAkC,GAClC,iCAAiC,CAAC;AAExC,MAAM,MAAM,wBAAwB,CAAC,UAAU,SAAS,QAAQ,GAAG,GAAG,IAAI;IACtE,UAAU,CAAC,IAAI,CAAC,EAAE;IAClB;QACI,MAAM,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC;QAC1C,QAAQ,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;QACxE,MAAM,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;QACvC,cAAc,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;KACxD;CACJ,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,SAAS,QAAQ,GAAG,GAAG,EAChE,MAAM,sBAAsB,KAC7B,wBAAwB,CAAC,UAAU,CAmHrC,CAAC"}

package/dist/controller/list/useRecordSelection.d.ts

@@ -0,0 +1,33 @@
+import { RaRecord } from "../../types.js";
+type UseRecordSelectionWithResourceArgs = {
+    resource: string;
+    storeKey?: string;
+    disableSyncWithStore?: false;
+};
+type UseRecordSelectionWithNoStoreArgs = {
+    resource?: string;
+    storeKey?: string;
+    disableSyncWithStore: true;
+};
+export type UseRecordSelectionArgs = UseRecordSelectionWithResourceArgs | UseRecordSelectionWithNoStoreArgs;
+export type UseRecordSelectionResult<RecordType extends RaRecord = any> = [
+    RecordType['id'][],
+    {
+        select: (ids: RecordType['id'][]) => void;
+        unselect: (ids: RecordType['id'][], fromAllStoreKeys?: boolean) => void;
+        toggle: (id: RecordType['id']) => void;
+        clearSelection: (fromAllStoreKeys?: boolean) => void;
+    }
+];
+/**
+ * Get the list of selected items for a resource, and callbacks to change the selection
+ *
+ * @param args.resource The resource name, e.g. 'posts'
+ * @param args.storeKey The key to use to store selected items. Pass false to disable synchronization with the store.
+ * @param args.disableSyncWithStore Controls the selection synchronization with the store
+ *
+ * @returns {Object} Destructure as [selectedIds, { select, unselect, toggle, clearSelection }].
+ */
+export declare const useRecordSelection: <RecordType extends RaRecord = any>(args: UseRecordSelectionArgs) => UseRecordSelectionResult<RecordType>;
+export {};
+//# sourceMappingURL=useRecordSelection.d.ts.map

package/dist/controller/list/useRecordSelection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRecordSelection.d.ts","sourceRoot":"","sources":["../../../src/controller/list/useRecordSelection.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,uBAAoB;AAEvC,KAAK,kCAAkC,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AACF,KAAK,iCAAiC,GAAG;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,IAAI,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC5B,kCAAkC,GAClC,iCAAiC,CAAC;AAExC,MAAM,MAAM,wBAAwB,CAAC,UAAU,SAAS,QAAQ,GAAG,GAAG,IAAI;IACtE,UAAU,CAAC,IAAI,CAAC,EAAE;IAClB;QACI,MAAM,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC;QAC1C,QAAQ,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;QACxE,MAAM,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;QACvC,cAAc,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;KACxD;CACJ,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,SAAS,QAAQ,GAAG,GAAG,EAChE,MAAM,sBAAsB,KAC7B,wBAAwB,CAAC,UAAU,CAmHrC,CAAC"}

package/dist/controller/list/useRecordSelection.js

@@ -0,0 +1,94 @@
+import { useEffect, useMemo, useState } from 'react';
+import { useStore, useStoreContext } from "../../store/index.js";
+/**
+ * Get the list of selected items for a resource, and callbacks to change the selection
+ *
+ * @param args.resource The resource name, e.g. 'posts'
+ * @param args.storeKey The key to use to store selected items. Pass false to disable synchronization with the store.
+ * @param args.disableSyncWithStore Controls the selection synchronization with the store
+ *
+ * @returns {Object} Destructure as [selectedIds, { select, unselect, toggle, clearSelection }].
+ */
+export const useRecordSelection = (args) => {
+    const { resource = '', storeKey, disableSyncWithStore } = args;
+    const finalStoreKey = `${storeKey || resource}.selectedIds`;
+    const [localSelectionStore, setLocalSelectionStore] = useState(defaultIds);
+    // As we can't conditionally call a hook, if the disableSyncWithStore is true,
+    // we'll ignore the useStore values later on and won't call set functions either.
+    const [selectionStore, setSelectionStore] = useStore(finalStoreKey, defaultIds);
+    const [storeKeys, setStoreKeys] = useStore(`${resource}.selectedIds.storeKeys`, defaultStoreKeys);
+    useEffect(function addStoreKeyToStore() {
+        if (!disableSyncWithStore && storeKey) {
+            setStoreKeys(storeKeys => {
+                if (!storeKeys.includes(finalStoreKey)) {
+                    return [...storeKeys, finalStoreKey];
+                }
+                else {
+                    return storeKeys;
+                }
+            });
+        }
+    }, [disableSyncWithStore, finalStoreKey, setStoreKeys, storeKey]);
+    const { getItem, setItem } = useStoreContext();
+    const ids = disableSyncWithStore ? localSelectionStore : selectionStore;
+    const setStore = useMemo(() => disableSyncWithStore ? setLocalSelectionStore : setSelectionStore, [disableSyncWithStore, setSelectionStore]);
+    const selectionModifiers = useMemo(() => ({
+        select: (idsToSelect) => {
+            if (!idsToSelect)
+                return;
+            setStore(idsToSelect);
+        },
+        unselect(idsToRemove, fromAllStoreKeys) {
+            if (!idsToRemove || idsToRemove.length === 0)
+                return;
+            setStore(ids => ids.filter(id => !idsToRemove.includes(id)));
+            if (!disableSyncWithStore && fromAllStoreKeys) {
+                storeKeys
+                    .filter(storeKey => storeKey !== finalStoreKey)
+                    .forEach(storeKey => {
+                    const ids = getItem(storeKey);
+                    if (ids) {
+                        setItem(storeKey, ids.filter(id => !idsToRemove.includes(id)));
+                    }
+                });
+            }
+        },
+        toggle: (id) => {
+            if (typeof id === 'undefined')
+                return;
+            setStore(ids => {
+                if (!Array.isArray(ids))
+                    return [...ids];
+                const index = ids.indexOf(id);
+                const hasId = index > -1;
+                return hasId
+                    ? [...ids.slice(0, index), ...ids.slice(index + 1)]
+                    : [...ids, id];
+            });
+        },
+        clearSelection: (fromAllStoreKeys) => {
+            setStore(defaultIds);
+            if (!disableSyncWithStore && fromAllStoreKeys) {
+                storeKeys
+                    .filter(storeKey => storeKey !== finalStoreKey)
+                    .forEach(storeKey => {
+                    const ids = getItem(storeKey);
+                    if (ids) {
+                        setItem(storeKey, defaultIds);
+                    }
+                });
+            }
+        },
+    }), [
+        disableSyncWithStore,
+        finalStoreKey,
+        getItem,
+        setItem,
+        setStore,
+        storeKeys,
+    ]);
+    return [ids, selectionModifiers];
+};
+const defaultIds = [];
+const defaultStoreKeys = [];
+//# sourceMappingURL=useRecordSelection.js.map