ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
175 lines • 8.06 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.useReferenceInputController = void 0;
var react_1 = require("react");
var react_hook_form_1 = require("react-hook-form");
var dataProvider_1 = require("../../dataProvider");
var useReference_1 = require("../useReference");
var useReferenceParams_1 = require("./useReferenceParams");
var core_1 = require("../../core");
/**
* A hook for choosing a reference record. Useful for foreign keys.
*
* This hook fetches the possible values in the reference resource
* (using `dataProvider.getList()`), it returns the possible choices
* as the `choices` attribute.
*
* @example
* const {
* choices, // the available reference resource
* } = useReferenceInputController({
* input, // the input props
* resource: 'comments',
* reference: 'posts',
* source: 'post_id',
* });
*
* The hook also allow to filter results. It returns a `setFilters`
* function. It uses the value to create a filter for the query.
* You can also add a permanentFilter to further filter the result:
*
* @example
* const {
* choices, // the available reference resource
* setFilter,
* } = useReferenceInputController({
* input, // the input props
* resource: 'comments',
* reference: 'posts',
* source: 'post_id',
* permanentFilter: {
* author: 'john'
* },
* });
*/
var useReferenceInputController = function (props) {
var debounce = props.debounce, enableGetChoices = props.enableGetChoices, filter = props.filter, _a = props.page, initialPage = _a === void 0 ? 1 : _a, _b = props.perPage, initialPerPage = _b === void 0 ? 25 : _b, initialSort = props.sort, _c = props.queryOptions, queryOptions = _c === void 0 ? {} : _c, reference = props.reference, source = props.source;
var meta = queryOptions.meta, otherQueryOptions = __rest(queryOptions, ["meta"]);
var _d = (0, useReferenceParams_1.useReferenceParams)({
resource: reference,
page: initialPage,
perPage: initialPerPage,
sort: initialSort,
debounce: debounce,
filter: filter,
}), params = _d[0], paramsModifiers = _d[1];
// selection logic
var finalSource = (0, core_1.useWrappedSource)(source);
var currentValue = (0, react_hook_form_1.useWatch)({ name: finalSource });
var isGetMatchingEnabled = enableGetChoices
? enableGetChoices(params.filterValues)
: true;
// fetch possible values
var _e = (0, dataProvider_1.useGetList)(reference, {
pagination: {
page: params.page,
perPage: params.perPage,
},
sort: { field: params.sort, order: params.order },
filter: __assign(__assign({}, params.filter), filter),
meta: meta,
}, __assign({ enabled: isGetMatchingEnabled, placeholderData: function (previousData) { return previousData; } }, otherQueryOptions)), _f = _e.data, possibleValuesData = _f === void 0 ? [] : _f, total = _e.total, pageInfo = _e.pageInfo, isFetchingPossibleValues = _e.isFetching, isLoadingPossibleValues = _e.isLoading, isPendingPossibleValues = _e.isPending, errorPossibleValues = _e.error, refetchGetList = _e.refetch;
// fetch current value
var _g = (0, useReference_1.useReference)({
id: currentValue,
reference: reference,
// @ts-ignore the types of the queryOptions for the getMAny and getList are not compatible
options: __assign({ enabled: currentValue != null && currentValue !== '', meta: meta }, otherQueryOptions),
}), currentReferenceRecord = _g.referenceRecord, refetchReference = _g.refetch, errorReference = _g.error, isLoadingReference = _g.isLoading, isFetchingReference = _g.isFetching, isPendingReference = _g.isPending;
var isPending =
// The reference query isn't enabled when there is no value yet but as it has no data, react-query will flag it as pending
(currentValue != null && currentValue !== '' && isPendingReference) ||
isPendingPossibleValues;
// We need to delay the update of the referenceRecord and the finalData
// to the next React state update, because otherwise it can raise a warning
// with AutocompleteInput saying the current value is not in the list of choices
var _h = (0, react_1.useState)(undefined), referenceRecord = _h[0], setReferenceRecord = _h[1];
(0, react_1.useEffect)(function () {
setReferenceRecord(currentReferenceRecord);
}, [currentReferenceRecord]);
// add current value to possible sources
var finalData, finalTotal;
if (!referenceRecord ||
possibleValuesData.find(function (record) { return record.id === referenceRecord.id; })) {
finalData = possibleValuesData;
finalTotal = total;
}
else {
finalData = __spreadArray([referenceRecord], possibleValuesData, true);
finalTotal = total == null ? undefined : total + 1;
}
var refetch = (0, react_1.useCallback)(function () {
refetchGetList();
refetchReference();
}, [refetchGetList, refetchReference]);
var currentSort = (0, react_1.useMemo)(function () { return ({
field: params.sort,
order: params.order,
}); }, [params.sort, params.order]);
return {
sort: currentSort,
allChoices: finalData,
availableChoices: possibleValuesData,
selectedChoices: referenceRecord ? [referenceRecord] : [],
displayedFilters: params.displayedFilters,
error: errorReference || errorPossibleValues,
filter: params.filter,
filterValues: params.filterValues,
hideFilter: paramsModifiers.hideFilter,
isFetching: isFetchingReference || isFetchingPossibleValues,
isLoading: isLoadingReference || isLoadingPossibleValues,
isPending: isPending,
page: params.page,
perPage: params.perPage,
refetch: refetch,
resource: reference,
setFilters: paramsModifiers.setFilters,
setPage: paramsModifiers.setPage,
setPerPage: paramsModifiers.setPerPage,
setSort: paramsModifiers.setSort,
showFilter: paramsModifiers.showFilter,
// we return source and not finalSource because child inputs (e.g. AutocompleteInput) already call useInput and compute the final source
source: source,
total: finalTotal,
hasNextPage: pageInfo
? pageInfo.hasNextPage
: total != null
? params.page * params.perPage < total
: undefined,
hasPreviousPage: pageInfo ? pageInfo.hasPreviousPage : params.page > 1,
isFromReference: true,
};
};
exports.useReferenceInputController = useReferenceInputController;
//# sourceMappingURL=useReferenceInputController.js.map