@strato-admin/ra-core 0.1.0

package/dist/controller/field/useReferenceManyFieldController.cjs

@@ -0,0 +1,272 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useReferenceManyFieldController = void 0;
+const react_1 = require("react");
+const react_query_1 = require("@tanstack/react-query");
+const get_js_1 = __importDefault(require("lodash/get.js"));
+const isEqual_js_1 = __importDefault(require("lodash/isEqual.js"));
+const debounce_js_1 = __importDefault(require("lodash/debounce.js"));
+const util_1 = require("../../util/index.cjs");
+const dataProvider_1 = require("../../dataProvider/index.cjs");
+const notification_1 = require("../../notification/index.cjs");
+const useListController_1 = require("../list/useListController.cjs");
+const usePaginationState_1 = __importDefault(require("../usePaginationState.cjs"));
+const useRecordSelection_1 = require("../list/useRecordSelection.cjs");
+const useSortState_1 = __importDefault(require("../useSortState.cjs"));
+const core_1 = require("../../core/index.cjs");
+const record_1 = require("../record/index.cjs");
+const export_1 = require("../../export/index.cjs");
+const i18n_1 = require("../../i18n/index.cjs");
+/**
+ * Fetch reference records, and return them when available
+ *
+ * Uses dataProvider.getManyReference() internally.
+ *
+ * @example // fetch the comments related to the current post
+ * const { isPending, data } = useReferenceManyFieldController({
+ *     reference: 'comments',
+ *     target: 'post_id',
+ *     record: { id: 123, title: 'hello, world' },
+ *     resource: 'posts',
+ * });
+ *
+ * @param {Object} props
+ * @param {string} props.reference The linked resource name. Required.
+ * @param {string} props.target The target resource key. Required.
+ * @param {Object} props.filter The filter applied on the recorded records list
+ * @param {number} props.page the page number
+ * @param {number} props.perPage the number of item per page
+ * @param {Object} props.record The current resource record
+ * @param {string} props.resource The current resource name
+ * @param {Object} props.sort the sort to apply to the referenced records
+ * @param {string} props.source The key of the linked resource identifier
+ * @param {UseQuery Options} props.queryOptions `react-query` options`
+ *
+ * @returns {ListControllerResult} The reference many props
+ */
+const useReferenceManyFieldController = (props) => {
+    const { debounce = 500, reference, target, filter = defaultFilter, exporter = export_1.defaultExporter, source = 'id', page: initialPage, perPage: initialPerPage, sort: initialSort = { field: 'id', order: 'DESC' }, queryOptions = {}, } = props;
+    const notify = (0, notification_1.useNotify)();
+    const translate = (0, i18n_1.useTranslate)();
+    const record = (0, record_1.useRecordContext)(props);
+    const resource = (0, core_1.useResourceContext)(props);
+    const dataProvider = (0, dataProvider_1.useDataProvider)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    const { meta, ...otherQueryOptions } = queryOptions;
+    // pagination logic
+    const { page, setPage, perPage, setPerPage } = (0, usePaginationState_1.default)({
+        page: initialPage,
+        perPage: initialPerPage,
+    });
+    // sort logic
+    const { sort, setSort: setSortState } = (0, useSortState_1.default)(initialSort);
+    const setSort = (0, react_1.useCallback)((sort) => {
+        setSortState(sort);
+        setPage(1);
+    }, [setPage, setSortState]);
+    // selection logic
+    const [selectedIds, selectionModifiers] = (0, useRecordSelection_1.useRecordSelection)({
+        resource: reference,
+        storeKey: props.storeKey ?? `${resource}.${record?.id}.${reference}`,
+    });
+    const onUnselectItems = (0, react_1.useCallback)((fromAllStoreKeys) => {
+        return selectionModifiers.unselect(selectedIds, fromAllStoreKeys);
+    }, [selectedIds, selectionModifiers]);
+    // filter logic
+    const filterRef = (0, react_1.useRef)(filter);
+    const [displayedFilters, setDisplayedFilters] = (0, react_1.useState)({});
+    const [filterValues, setFilterValues] = (0, react_1.useState)(filter);
+    const hideFilter = (0, react_1.useCallback)((filterName) => {
+        setDisplayedFilters(previousState => {
+            const { [filterName]: _, ...newState } = previousState;
+            return newState;
+        });
+        setFilterValues(previousState => {
+            const { [filterName]: _, ...newState } = previousState;
+            return newState;
+        });
+    }, [setDisplayedFilters, setFilterValues]);
+    const showFilter = (0, react_1.useCallback)((filterName, defaultValue) => {
+        setDisplayedFilters(previousState => ({
+            ...previousState,
+            [filterName]: true,
+        }));
+        setFilterValues(previousState => ({
+            ...previousState,
+            [filterName]: defaultValue,
+        }));
+    }, [setDisplayedFilters, setFilterValues]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const debouncedSetFilters = (0, react_1.useCallback)((0, debounce_js_1.default)((filters, displayedFilters) => {
+        setFilterValues((0, util_1.removeEmpty)(filters));
+        setDisplayedFilters(displayedFilters);
+        setPage(1);
+    }, debounce), [setDisplayedFilters, setFilterValues, setPage]);
+    const setFilters = (0, react_1.useCallback)((filters, displayedFilters, debounce = false) => {
+        if (debounce) {
+            debouncedSetFilters(filters, displayedFilters);
+        }
+        else {
+            setFilterValues((0, util_1.removeEmpty)(filters));
+            setDisplayedFilters(displayedFilters);
+            setPage(1);
+        }
+    }, [setDisplayedFilters, setFilterValues, setPage, debouncedSetFilters]);
+    // handle filter prop change
+    (0, react_1.useEffect)(() => {
+        if (!(0, isEqual_js_1.default)(filter, filterRef.current)) {
+            filterRef.current = filter;
+            setFilterValues(filter);
+        }
+    }, [filter]);
+    const recordValue = (0, get_js_1.default)(record, source);
+    const { data, total, meta: responseMeta, pageInfo, error, isFetching, isLoading, isPaused, isPending, isPlaceholderData, refetch, } = (0, dataProvider_1.useGetManyReference)(reference, {
+        target,
+        id: recordValue,
+        pagination: { page, perPage },
+        sort,
+        filter: filterValues,
+        meta,
+    }, {
+        enabled: recordValue != null,
+        placeholderData: previousData => previousData,
+        onError: error => notify(typeof error === 'string'
+            ? error
+            : error?.message ||
+                'ra.notification.http_error', {
+            type: 'error',
+            messageArgs: {
+                _: typeof error === 'string'
+                    ? error
+                    : error?.message
+                        ? error.message
+                        : undefined,
+            },
+        }),
+        ...otherQueryOptions,
+    });
+    const onSelectAll = (0, util_1.useEvent)(async ({ limit = 250, queryOptions = {}, } = {}) => {
+        const { meta, onSuccess, onError } = queryOptions;
+        try {
+            const results = await queryClient.fetchQuery({
+                queryKey: [
+                    reference,
+                    'getManyReference',
+                    {
+                        target,
+                        id: (0, get_js_1.default)(record, source),
+                        pagination: { page: 1, perPage: limit },
+                        sort,
+                        filter,
+                        meta,
+                    },
+                ],
+                queryFn: () => dataProvider.getManyReference(reference, {
+                    target,
+                    id: (0, get_js_1.default)(record, source),
+                    pagination: { page: 1, perPage: limit },
+                    sort,
+                    filter,
+                    meta,
+                }),
+            });
+            const allIds = results.data?.map(({ id }) => id) || [];
+            selectionModifiers.select(allIds);
+            if (allIds.length === limit) {
+                notify('ra.message.select_all_limit_reached', {
+                    messageArgs: { max: limit },
+                    type: 'warning',
+                });
+            }
+            if (onSuccess) {
+                onSuccess(results);
+            }
+            return results.data;
+        }
+        catch (error) {
+            if (onError) {
+                onError(error);
+            }
+            notify('ra.notification.http_error', { type: 'warning' });
+        }
+    });
+    const getData = (0, util_1.useEvent)(async ({ maxResults, meta: metaOverride } = {}) => {
+        if (recordValue == null || total === 0) {
+            return [];
+        }
+        const limit = maxResults ?? (total != null ? total : useListController_1.DEFAULT_MAX_RESULTS);
+        const { data } = await queryClient.fetchQuery({
+            queryKey: [
+                reference,
+                'getManyReference',
+                {
+                    target,
+                    id: recordValue,
+                    pagination: { page: 1, perPage: limit },
+                    sort,
+                    filter: filterValues,
+                    meta: metaOverride ?? meta,
+                },
+            ],
+            queryFn: () => dataProvider.getManyReference(reference, {
+                target,
+                id: recordValue,
+                pagination: { page: 1, perPage: limit },
+                sort,
+                filter: filterValues,
+                meta: metaOverride ?? meta,
+            }),
+        });
+        return data;
+    });
+    const getResourceLabel = (0, core_1.useGetResourceLabel)();
+    const defaultTitle = translate(`resources.${reference}.page.list`, {
+        _: translate('ra.page.list', {
+            name: getResourceLabel(reference, 2),
+        }),
+    });
+    return {
+        sort,
+        data,
+        meta: responseMeta,
+        defaultTitle,
+        displayedFilters,
+        error,
+        exporter,
+        filterValues,
+        hideFilter,
+        isFetching,
+        isLoading,
+        isPaused,
+        isPending,
+        isPlaceholderData,
+        onSelect: selectionModifiers.select,
+        onSelectAll,
+        onToggleItem: selectionModifiers.toggle,
+        onUnselectItems,
+        page,
+        perPage,
+        refetch,
+        resource: reference,
+        selectedIds,
+        setFilters,
+        setPage,
+        setPerPage,
+        hasNextPage: pageInfo
+            ? pageInfo.hasNextPage
+            : total != null
+                ? page * perPage < total
+                : undefined,
+        hasPreviousPage: pageInfo ? pageInfo.hasPreviousPage : page > 1,
+        setSort,
+        showFilter,
+        total,
+        getData,
+    };
+};
+exports.useReferenceManyFieldController = useReferenceManyFieldController;
+const defaultFilter = {};
+//# sourceMappingURL=useReferenceManyFieldController.js.map

package/dist/controller/field/useReferenceManyFieldController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReferenceManyFieldController.js","sourceRoot":"","sources":["../../../src/controller/field/useReferenceManyFieldController.ts"],"names":[],"mappings":";;;;;;AAAA,iCAAiE;AACjE,uDAAwE;AACxE,2DAAgC;AAChC,mEAAwC;AACxC,qEAAgD;AAEhD,+CAAmD;AACnD,+DAA0E;AAC1E,+DAA+C;AAa/C,qEAAgE;AAChE,mFAAuD;AACvD,uEAAgE;AAChE,uEAA2C;AAC3C,+CAAqE;AACrE,gDAA6C;AAC7C,mDAA+C;AAC/C,+CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,MAAM,+BAA+B,GAAG,CAK3C,KAIC,EACmD,EAAE;IACtD,MAAM,EACF,QAAQ,GAAG,GAAG,EACd,SAAS,EACT,MAAM,EACN,MAAM,GAAG,aAAa,EACtB,QAAQ,GAAG,wBAAe,EAC1B,MAAM,GAAG,IAAI,EACb,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,cAAc,EACvB,IAAI,EAAE,WAAW,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAClD,YAAY,GAAG,EAGd,GACJ,GAAG,KAAK,CAAC;IACV,MAAM,MAAM,GAAG,IAAA,wBAAS,GAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAA,mBAAY,GAAE,CAAC;IACjC,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,KAAK,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAA,yBAAkB,EAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,YAAY,GAAG,IAAA,8BAAe,GAAE,CAAC;IACvC,MAAM,WAAW,GAAG,IAAA,4BAAc,GAAE,CAAC;IACrC,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,YAAY,CAAC;IAEpD,mBAAmB;IACnB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAA,4BAAkB,EAAC;QAC9D,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,cAAc;KAC1B,CAAC,CAAC;IAEH,aAAa;IACb,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAA,sBAAY,EAAC,WAAW,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,IAAA,mBAAW,EACvB,CAAC,IAAiB,EAAE,EAAE;QAClB,YAAY,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,CAAC,EACD,CAAC,OAAO,EAAE,YAAY,CAAC,CAC1B,CAAC;IAEF,kBAAkB;IAClB,MAAM,CAAC,WAAW,EAAE,kBAAkB,CAAC,GAAG,IAAA,uCAAkB,EAAC;QACzD,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,GAAG,QAAQ,IAAI,MAAM,EAAE,EAAE,IAAI,SAAS,EAAE;KACvE,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,IAAA,mBAAW,EAC/B,CAAC,gBAA0B,EAAE,EAAE;QAC3B,OAAO,kBAAkB,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;IACtE,CAAC,EACD,CAAC,WAAW,EAAE,kBAAkB,CAAC,CACpC,CAAC;IAEF,eAAe;IACf,MAAM,SAAS,GAAG,IAAA,cAAM,EAAC,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,IAAA,gBAAQ,EAErD,EAAE,CAAC,CAAC;IACP,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,IAAA,gBAAQ,EAE7C,MAAM,CAAC,CAAC;IACX,MAAM,UAAU,GAAG,IAAA,mBAAW,EAC1B,CAAC,UAAkB,EAAE,EAAE;QACnB,mBAAmB,CAAC,aAAa,CAAC,EAAE;YAChC,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,aAAa,CAAC;YACvD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,eAAe,CAAC,aAAa,CAAC,EAAE;YAC5B,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,aAAa,CAAC;YACvD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC,EACD,CAAC,mBAAmB,EAAE,eAAe,CAAC,CACzC,CAAC;IACF,MAAM,UAAU,GAAG,IAAA,mBAAW,EAC1B,CAAC,UAAkB,EAAE,YAAiB,EAAE,EAAE;QACtC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAClC,GAAG,aAAa;YAChB,CAAC,UAAU,CAAC,EAAE,IAAI;SACrB,CAAC,CAAC,CAAC;QACJ,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAC9B,GAAG,aAAa;YAChB,CAAC,UAAU,CAAC,EAAE,YAAY;SAC7B,CAAC,CAAC,CAAC;IACR,CAAC,EACD,CAAC,mBAAmB,EAAE,eAAe,CAAC,CACzC,CAAC;IAEF,uDAAuD;IACvD,MAAM,mBAAmB,GAAG,IAAA,mBAAW,EACnC,IAAA,qBAAc,EAAC,CAAC,OAAO,EAAE,gBAAgB,EAAE,EAAE;QACzC,eAAe,CAAC,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC,CAAC;QACtC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QACtC,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,CAAC,EAAE,QAAQ,CAAC,EACZ,CAAC,mBAAmB,EAAE,eAAe,EAAE,OAAO,CAAC,CAClD,CAAC;IAEF,MAAM,UAAU,GAAG,IAAA,mBAAW,EAC1B,CAAC,OAAO,EAAE,gBAAgB,EAAE,QAAQ,GAAG,KAAK,EAAE,EAAE;QAC5C,IAAI,QAAQ,EAAE,CAAC;YACX,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACJ,eAAe,CAAC,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC,CAAC;YACtC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;YACtC,OAAO,CAAC,CAAC,CAAC,CAAC;QACf,CAAC;IACL,CAAC,EACD,CAAC,mBAAmB,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,CAAC,CACvE,CAAC;IACF,4BAA4B;IAC5B,IAAA,iBAAS,EAAC,GAAG,EAAE;QACX,IAAI,CAAC,IAAA,oBAAO,EAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,SAAS,CAAC,OAAO,GAAG,MAAM,CAAC;YAC3B,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,WAAW,GAAG,IAAA,gBAAG,EAAC,MAAM,EAAE,MAAM,CAAe,CAAC;IACtD,MAAM,EACF,IAAI,EACJ,KAAK,EACL,IAAI,EAAE,YAAY,EAClB,QAAQ,EACR,KAAK,EACL,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,OAAO,GACV,GAAG,IAAA,kCAAmB,EACnB,SAAS,EACT;QACI,MAAM;QACN,EAAE,EAAE,WAAW;QACf,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QAC7B,IAAI;QACJ,MAAM,EAAE,YAAY;QACpB,IAAI;KACP,EACD;QACI,OAAO,EAAE,WAAW,IAAI,IAAI;QAC5B,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC,YAAY;QAC7C,OAAO,EAAE,KAAK,CAAC,EAAE,CACb,MAAM,CACF,OAAO,KAAK,KAAK,QAAQ;YACrB,CAAC,CAAC,KAAK;YACP,CAAC,CAAE,KAAe,EAAE,OAAO;gBACrB,4BAA4B,EACtC;YACI,IAAI,EAAE,OAAO;YACb,WAAW,EAAE;gBACT,CAAC,EACG,OAAO,KAAK,KAAK,QAAQ;oBACrB,CAAC,CAAC,KAAK;oBACP,CAAC,CAAE,KAAe,EAAE,OAAO;wBACzB,CAAC,CAAE,KAAe,CAAC,OAAO;wBAC1B,CAAC,CAAC,SAAS;aACxB;SACJ,CACJ;QACL,GAAG,iBAAiB;KACvB,CACJ,CAAC;IAEF,MAAM,WAAW,GAAG,IAAA,eAAQ,EACxB,KAAK,EAAE,EACH,KAAK,GAAG,GAAG,EACX,YAAY,GAAG,EAAE,MACM,EAAE,EAAE,EAAE;QAC7B,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;QAClD,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;gBACzC,QAAQ,EAAE;oBACN,SAAS;oBACT,kBAAkB;oBAClB;wBACI,MAAM;wBACN,EAAE,EAAE,IAAA,gBAAG,EAAC,MAAM,EAAE,MAAM,CAAe;wBACrC,UAAU,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;wBACvC,IAAI;wBACJ,MAAM;wBACN,IAAI;qBACP;iBACJ;gBACD,OAAO,EAAE,GAAG,EAAE,CACV,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE;oBACrC,MAAM;oBACN,EAAE,EAAE,IAAA,gBAAG,EAAC,MAAM,EAAE,MAAM,CAAe;oBACrC,UAAU,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;oBACvC,IAAI;oBACJ,MAAM;oBACN,IAAI;iBACP,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YACvD,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAClC,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC1B,MAAM,CAAC,qCAAqC,EAAE;oBAC1C,WAAW,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;oBAC3B,IAAI,EAAE,SAAS;iBAClB,CAAC,CAAC;YACP,CAAC;YAED,IAAI,SAAS,EAAE,CAAC;gBACZ,SAAS,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,OAAO,OAAO,CAAC,IAAI,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,OAAO,EAAE,CAAC;gBACV,OAAO,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC;YACD,MAAM,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC;IACL,CAAC,CACJ,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,eAAQ,EACpB,KAAK,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,KAAqB,EAAE,EAAE,EAAE;QAC9D,IAAI,WAAW,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GACP,UAAU,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,uCAAmB,CAAC,CAAC;QAChE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;YAC1C,QAAQ,EAAE;gBACN,SAAS;gBACT,kBAAkB;gBAClB;oBACI,MAAM;oBACN,EAAE,EAAE,WAAW;oBACf,UAAU,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;oBACvC,IAAI;oBACJ,MAAM,EAAE,YAAY;oBACpB,IAAI,EAAE,YAAY,IAAI,IAAI;iBAC7B;aACJ;YACD,OAAO,EAAE,GAAG,EAAE,CACV,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE;gBACrC,MAAM;gBACN,EAAE,EAAE,WAAW;gBACf,UAAU,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;gBACvC,IAAI;gBACJ,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,YAAY,IAAI,IAAI;aAC7B,CAAC;SACT,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC,CACJ,CAAC;IAEF,MAAM,gBAAgB,GAAG,IAAA,0BAAmB,GAAE,CAAC;IAC/C,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,SAAS,YAAY,EAAE;QAC/D,CAAC,EAAE,SAAS,CAAC,cAAc,EAAE;YACzB,IAAI,EAAE,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC;SACvC,CAAC;KACL,CAAC,CAAC;IAEH,OAAO;QACH,IAAI;QACJ,IAAI;QACJ,IAAI,EAAE,YAAY;QAClB,YAAY;QACZ,gBAAgB;QAChB,KAAK;QACL,QAAQ;QACR,YAAY;QACZ,UAAU;QACV,UAAU;QACV,SAAS;QACT,QAAQ;QACR,SAAS;QACT,iBAAiB;QACjB,QAAQ,EAAE,kBAAkB,CAAC,MAAM;QACnC,WAAW;QACX,YAAY,EAAE,kBAAkB,CAAC,MAAM;QACvC,eAAe;QACf,IAAI;QACJ,OAAO;QACP,OAAO;QACP,QAAQ,EAAE,SAAS;QACnB,WAAW;QACX,UAAU;QACV,OAAO;QACP,UAAU;QACV,WAAW,EAAE,QAAQ;YACjB,CAAC,CAAC,QAAQ,CAAC,WAAW;YACtB,CAAC,CAAC,KAAK,IAAI,IAAI;gBACb,CAAC,CAAC,IAAI,GAAG,OAAO,GAAG,KAAK;gBACxB,CAAC,CAAC,SAAS;QACjB,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;QAC/D,OAAO;QACP,UAAU;QACV,KAAK;QACL,OAAO;KAC8C,CAAC;AAC9D,CAAC,CAAC;AArTW,QAAA,+BAA+B,mCAqT1C;AA4BF,MAAM,aAAa,GAAG,EAAE,CAAC"}

package/dist/controller/field/useReferenceManyFieldController.d.cts

@@ -0,0 +1,50 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import { Exporter, FilterPayload, RaRecord, SortPayload } from "../../types.cjs";
+import type { ListControllerResult } from "../list/index.cjs";
+/**
+ * Fetch reference records, and return them when available
+ *
+ * Uses dataProvider.getManyReference() internally.
+ *
+ * @example // fetch the comments related to the current post
+ * const { isPending, data } = useReferenceManyFieldController({
+ *     reference: 'comments',
+ *     target: 'post_id',
+ *     record: { id: 123, title: 'hello, world' },
+ *     resource: 'posts',
+ * });
+ *
+ * @param {Object} props
+ * @param {string} props.reference The linked resource name. Required.
+ * @param {string} props.target The target resource key. Required.
+ * @param {Object} props.filter The filter applied on the recorded records list
+ * @param {number} props.page the page number
+ * @param {number} props.perPage the number of item per page
+ * @param {Object} props.record The current resource record
+ * @param {string} props.resource The current resource name
+ * @param {Object} props.sort the sort to apply to the referenced records
+ * @param {string} props.source The key of the linked resource identifier
+ * @param {UseQuery Options} props.queryOptions `react-query` options`
+ *
+ * @returns {ListControllerResult} The reference many props
+ */
+export declare const useReferenceManyFieldController: <RecordType extends RaRecord = RaRecord, ReferenceRecordType extends RaRecord = RaRecord, ErrorType = Error>(props: UseReferenceManyFieldControllerParams<RecordType, ReferenceRecordType, ErrorType>) => ListControllerResult<ReferenceRecordType, ErrorType>;
+export interface UseReferenceManyFieldControllerParams<RecordType extends Record<string, any> = Record<string, any>, ReferenceRecordType extends Record<string, any> = Record<string, any>, ErrorType = Error> {
+    debounce?: number;
+    filter?: FilterPayload;
+    page?: number;
+    perPage?: number;
+    record?: RecordType;
+    reference: string;
+    resource?: string;
+    exporter?: Exporter<ReferenceRecordType & RaRecord> | false;
+    sort?: SortPayload;
+    source?: string;
+    storeKey?: string;
+    target: string;
+    queryOptions?: Omit<UseQueryOptions<{
+        data: ReferenceRecordType[];
+        total: number;
+    }, ErrorType>, 'queryKey' | 'queryFn'>;
+}
+//# sourceMappingURL=useReferenceManyFieldController.d.ts.map

package/dist/controller/field/useReferenceManyFieldController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReferenceManyFieldController.d.ts","sourceRoot":"","sources":["../../../src/controller/field/useReferenceManyFieldController.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAQxE,OAAO,EACH,QAAQ,EACR,aAAa,EAEb,QAAQ,EACR,WAAW,EACd,wBAAoB;AACrB,OAAO,KAAK,EAGR,oBAAoB,EACvB,0BAAgB;AAUjB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,+BAA+B,GACxC,UAAU,SAAS,QAAQ,GAAG,QAAQ,EACtC,mBAAmB,SAAS,QAAQ,GAAG,QAAQ,EAC/C,SAAS,GAAG,KAAK,EAEjB,OAAO,qCAAqC,CACxC,UAAU,EACV,mBAAmB,EACnB,SAAS,CACZ,KACF,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CA2SrD,CAAC;AAEF,MAAM,WAAW,qCAAqC,CAClD,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5D,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrE,SAAS,GAAG,KAAK;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC,mBAAmB,GAAG,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC5D,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,CACf,eAAe,CACX;QAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAC9C,SAAS,CACZ,EACD,UAAU,GAAG,SAAS,CACzB,CAAC;CACL"}

package/dist/controller/field/useReferenceManyFieldController.d.ts

@@ -0,0 +1,50 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import { Exporter, FilterPayload, RaRecord, SortPayload } from "../../types.js";
+import type { ListControllerResult } from "../list/index.js";
+/**
+ * Fetch reference records, and return them when available
+ *
+ * Uses dataProvider.getManyReference() internally.
+ *
+ * @example // fetch the comments related to the current post
+ * const { isPending, data } = useReferenceManyFieldController({
+ *     reference: 'comments',
+ *     target: 'post_id',
+ *     record: { id: 123, title: 'hello, world' },
+ *     resource: 'posts',
+ * });
+ *
+ * @param {Object} props
+ * @param {string} props.reference The linked resource name. Required.
+ * @param {string} props.target The target resource key. Required.
+ * @param {Object} props.filter The filter applied on the recorded records list
+ * @param {number} props.page the page number
+ * @param {number} props.perPage the number of item per page
+ * @param {Object} props.record The current resource record
+ * @param {string} props.resource The current resource name
+ * @param {Object} props.sort the sort to apply to the referenced records
+ * @param {string} props.source The key of the linked resource identifier
+ * @param {UseQuery Options} props.queryOptions `react-query` options`
+ *
+ * @returns {ListControllerResult} The reference many props
+ */
+export declare const useReferenceManyFieldController: <RecordType extends RaRecord = RaRecord, ReferenceRecordType extends RaRecord = RaRecord, ErrorType = Error>(props: UseReferenceManyFieldControllerParams<RecordType, ReferenceRecordType, ErrorType>) => ListControllerResult<ReferenceRecordType, ErrorType>;
+export interface UseReferenceManyFieldControllerParams<RecordType extends Record<string, any> = Record<string, any>, ReferenceRecordType extends Record<string, any> = Record<string, any>, ErrorType = Error> {
+    debounce?: number;
+    filter?: FilterPayload;
+    page?: number;
+    perPage?: number;
+    record?: RecordType;
+    reference: string;
+    resource?: string;
+    exporter?: Exporter<ReferenceRecordType & RaRecord> | false;
+    sort?: SortPayload;
+    source?: string;
+    storeKey?: string;
+    target: string;
+    queryOptions?: Omit<UseQueryOptions<{
+        data: ReferenceRecordType[];
+        total: number;
+    }, ErrorType>, 'queryKey' | 'queryFn'>;
+}
+//# sourceMappingURL=useReferenceManyFieldController.d.ts.map

package/dist/controller/field/useReferenceManyFieldController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReferenceManyFieldController.d.ts","sourceRoot":"","sources":["../../../src/controller/field/useReferenceManyFieldController.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAQxE,OAAO,EACH,QAAQ,EACR,aAAa,EAEb,QAAQ,EACR,WAAW,EACd,uBAAoB;AACrB,OAAO,KAAK,EAGR,oBAAoB,EACvB,yBAAgB;AAUjB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,+BAA+B,GACxC,UAAU,SAAS,QAAQ,GAAG,QAAQ,EACtC,mBAAmB,SAAS,QAAQ,GAAG,QAAQ,EAC/C,SAAS,GAAG,KAAK,EAEjB,OAAO,qCAAqC,CACxC,UAAU,EACV,mBAAmB,EACnB,SAAS,CACZ,KACF,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CA2SrD,CAAC;AAEF,MAAM,WAAW,qCAAqC,CAClD,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5D,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrE,SAAS,GAAG,KAAK;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC,mBAAmB,GAAG,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC5D,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,CACf,eAAe,CACX;QAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAC9C,SAAS,CACZ,EACD,UAAU,GAAG,SAAS,CACzB,CAAC;CACL"}

package/dist/controller/field/useReferenceManyFieldController.js

@@ -0,0 +1,265 @@
+import { useCallback, useEffect, useRef, useState } from 'react';
+import { useQueryClient } from '@tanstack/react-query';
+import get from 'lodash/get.js';
+import isEqual from 'lodash/isEqual.js';
+import lodashDebounce from 'lodash/debounce.js';
+import { removeEmpty, useEvent } from "../../util/index.js";
+import { useDataProvider, useGetManyReference } from "../../dataProvider/index.js";
+import { useNotify } from "../../notification/index.js";
+import { DEFAULT_MAX_RESULTS } from "../list/useListController.js";
+import usePaginationState from "../usePaginationState.js";
+import { useRecordSelection } from "../list/useRecordSelection.js";
+import useSortState from "../useSortState.js";
+import { useResourceContext, useGetResourceLabel } from "../../core/index.js";
+import { useRecordContext } from "../record/index.js";
+import { defaultExporter } from "../../export/index.js";
+import { useTranslate } from "../../i18n/index.js";
+/**
+ * Fetch reference records, and return them when available
+ *
+ * Uses dataProvider.getManyReference() internally.
+ *
+ * @example // fetch the comments related to the current post
+ * const { isPending, data } = useReferenceManyFieldController({
+ *     reference: 'comments',
+ *     target: 'post_id',
+ *     record: { id: 123, title: 'hello, world' },
+ *     resource: 'posts',
+ * });
+ *
+ * @param {Object} props
+ * @param {string} props.reference The linked resource name. Required.
+ * @param {string} props.target The target resource key. Required.
+ * @param {Object} props.filter The filter applied on the recorded records list
+ * @param {number} props.page the page number
+ * @param {number} props.perPage the number of item per page
+ * @param {Object} props.record The current resource record
+ * @param {string} props.resource The current resource name
+ * @param {Object} props.sort the sort to apply to the referenced records
+ * @param {string} props.source The key of the linked resource identifier
+ * @param {UseQuery Options} props.queryOptions `react-query` options`
+ *
+ * @returns {ListControllerResult} The reference many props
+ */
+export const useReferenceManyFieldController = (props) => {
+    const { debounce = 500, reference, target, filter = defaultFilter, exporter = defaultExporter, source = 'id', page: initialPage, perPage: initialPerPage, sort: initialSort = { field: 'id', order: 'DESC' }, queryOptions = {}, } = props;
+    const notify = useNotify();
+    const translate = useTranslate();
+    const record = useRecordContext(props);
+    const resource = useResourceContext(props);
+    const dataProvider = useDataProvider();
+    const queryClient = useQueryClient();
+    const { meta, ...otherQueryOptions } = queryOptions;
+    // pagination logic
+    const { page, setPage, perPage, setPerPage } = usePaginationState({
+        page: initialPage,
+        perPage: initialPerPage,
+    });
+    // sort logic
+    const { sort, setSort: setSortState } = useSortState(initialSort);
+    const setSort = useCallback((sort) => {
+        setSortState(sort);
+        setPage(1);
+    }, [setPage, setSortState]);
+    // selection logic
+    const [selectedIds, selectionModifiers] = useRecordSelection({
+        resource: reference,
+        storeKey: props.storeKey ?? `${resource}.${record?.id}.${reference}`,
+    });
+    const onUnselectItems = useCallback((fromAllStoreKeys) => {
+        return selectionModifiers.unselect(selectedIds, fromAllStoreKeys);
+    }, [selectedIds, selectionModifiers]);
+    // filter logic
+    const filterRef = useRef(filter);
+    const [displayedFilters, setDisplayedFilters] = useState({});
+    const [filterValues, setFilterValues] = useState(filter);
+    const hideFilter = useCallback((filterName) => {
+        setDisplayedFilters(previousState => {
+            const { [filterName]: _, ...newState } = previousState;
+            return newState;
+        });
+        setFilterValues(previousState => {
+            const { [filterName]: _, ...newState } = previousState;
+            return newState;
+        });
+    }, [setDisplayedFilters, setFilterValues]);
+    const showFilter = useCallback((filterName, defaultValue) => {
+        setDisplayedFilters(previousState => ({
+            ...previousState,
+            [filterName]: true,
+        }));
+        setFilterValues(previousState => ({
+            ...previousState,
+            [filterName]: defaultValue,
+        }));
+    }, [setDisplayedFilters, setFilterValues]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const debouncedSetFilters = useCallback(lodashDebounce((filters, displayedFilters) => {
+        setFilterValues(removeEmpty(filters));
+        setDisplayedFilters(displayedFilters);
+        setPage(1);
+    }, debounce), [setDisplayedFilters, setFilterValues, setPage]);
+    const setFilters = useCallback((filters, displayedFilters, debounce = false) => {
+        if (debounce) {
+            debouncedSetFilters(filters, displayedFilters);
+        }
+        else {
+            setFilterValues(removeEmpty(filters));
+            setDisplayedFilters(displayedFilters);
+            setPage(1);
+        }
+    }, [setDisplayedFilters, setFilterValues, setPage, debouncedSetFilters]);
+    // handle filter prop change
+    useEffect(() => {
+        if (!isEqual(filter, filterRef.current)) {
+            filterRef.current = filter;
+            setFilterValues(filter);
+        }
+    }, [filter]);
+    const recordValue = get(record, source);
+    const { data, total, meta: responseMeta, pageInfo, error, isFetching, isLoading, isPaused, isPending, isPlaceholderData, refetch, } = useGetManyReference(reference, {
+        target,
+        id: recordValue,
+        pagination: { page, perPage },
+        sort,
+        filter: filterValues,
+        meta,
+    }, {
+        enabled: recordValue != null,
+        placeholderData: previousData => previousData,
+        onError: error => notify(typeof error === 'string'
+            ? error
+            : error?.message ||
+                'ra.notification.http_error', {
+            type: 'error',
+            messageArgs: {
+                _: typeof error === 'string'
+                    ? error
+                    : error?.message
+                        ? error.message
+                        : undefined,
+            },
+        }),
+        ...otherQueryOptions,
+    });
+    const onSelectAll = useEvent(async ({ limit = 250, queryOptions = {}, } = {}) => {
+        const { meta, onSuccess, onError } = queryOptions;
+        try {
+            const results = await queryClient.fetchQuery({
+                queryKey: [
+                    reference,
+                    'getManyReference',
+                    {
+                        target,
+                        id: get(record, source),
+                        pagination: { page: 1, perPage: limit },
+                        sort,
+                        filter,
+                        meta,
+                    },
+                ],
+                queryFn: () => dataProvider.getManyReference(reference, {
+                    target,
+                    id: get(record, source),
+                    pagination: { page: 1, perPage: limit },
+                    sort,
+                    filter,
+                    meta,
+                }),
+            });
+            const allIds = results.data?.map(({ id }) => id) || [];
+            selectionModifiers.select(allIds);
+            if (allIds.length === limit) {
+                notify('ra.message.select_all_limit_reached', {
+                    messageArgs: { max: limit },
+                    type: 'warning',
+                });
+            }
+            if (onSuccess) {
+                onSuccess(results);
+            }
+            return results.data;
+        }
+        catch (error) {
+            if (onError) {
+                onError(error);
+            }
+            notify('ra.notification.http_error', { type: 'warning' });
+        }
+    });
+    const getData = useEvent(async ({ maxResults, meta: metaOverride } = {}) => {
+        if (recordValue == null || total === 0) {
+            return [];
+        }
+        const limit = maxResults ?? (total != null ? total : DEFAULT_MAX_RESULTS);
+        const { data } = await queryClient.fetchQuery({
+            queryKey: [
+                reference,
+                'getManyReference',
+                {
+                    target,
+                    id: recordValue,
+                    pagination: { page: 1, perPage: limit },
+                    sort,
+                    filter: filterValues,
+                    meta: metaOverride ?? meta,
+                },
+            ],
+            queryFn: () => dataProvider.getManyReference(reference, {
+                target,
+                id: recordValue,
+                pagination: { page: 1, perPage: limit },
+                sort,
+                filter: filterValues,
+                meta: metaOverride ?? meta,
+            }),
+        });
+        return data;
+    });
+    const getResourceLabel = useGetResourceLabel();
+    const defaultTitle = translate(`resources.${reference}.page.list`, {
+        _: translate('ra.page.list', {
+            name: getResourceLabel(reference, 2),
+        }),
+    });
+    return {
+        sort,
+        data,
+        meta: responseMeta,
+        defaultTitle,
+        displayedFilters,
+        error,
+        exporter,
+        filterValues,
+        hideFilter,
+        isFetching,
+        isLoading,
+        isPaused,
+        isPending,
+        isPlaceholderData,
+        onSelect: selectionModifiers.select,
+        onSelectAll,
+        onToggleItem: selectionModifiers.toggle,
+        onUnselectItems,
+        page,
+        perPage,
+        refetch,
+        resource: reference,
+        selectedIds,
+        setFilters,
+        setPage,
+        setPerPage,
+        hasNextPage: pageInfo
+            ? pageInfo.hasNextPage
+            : total != null
+                ? page * perPage < total
+                : undefined,
+        hasPreviousPage: pageInfo ? pageInfo.hasPreviousPage : page > 1,
+        setSort,
+        showFilter,
+        total,
+        getData,
+    };
+};
+const defaultFilter = {};
+//# sourceMappingURL=useReferenceManyFieldController.js.map