ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
150 lines • 7.07 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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.useCanAccess = void 0;
var react_1 = require("react");
var react_query_1 = require("@tanstack/react-query");
var useAuthProvider_1 = __importDefault(require("./useAuthProvider"));
var core_1 = require("../core");
var controller_1 = require("../controller");
/**
* A hook that calls the authProvider.canAccess() method using react-query for a provided resource and action (and optionally a record).
*
* The return value updates according to the request state:
*
* - start: { isPending: true }
* - success: { canAccess: true | false, isPending: false }
* - error: { error: [error from provider], isPending: false }
*
* Useful to enable or disable features based on users permissions.
*
* @param {Object} params Any params you want to pass to the authProvider
* @param {string} params.resource The resource to check access for
* @param {string} params.action The action to check access for
* @param {Object} params.record Optional. The record to check access for
*
* @returns Return the react-query result and a canAccess property which is a boolean indicating the access status
*
* @example
* import { useCanAccess } from 'react-admin';
*
* const PostDetail = () => {
* const { isPending, canAccess, error } = useCanAccess({
* resource: 'posts',
* action: 'read',
* });
* if (isPending || !canAccess) {
* return null;
* }
* if (error) {
* return <div>{error.message}</div>;
* }
* return <PostEdit />;
* };
*/
var useCanAccess = function (params) {
var authProvider = (0, useAuthProvider_1.default)();
var resource = (0, core_1.useResourceContext)(params);
if (!resource) {
throw new Error('useCanAccess must be used inside a <Resource> component or provide a resource prop');
}
var record = (0, controller_1.useRecordContext)(params);
var authProviderHasCanAccess = !!(authProvider === null || authProvider === void 0 ? void 0 : authProvider.canAccess);
var queryResult = (0, react_query_1.useQuery)(__assign({ queryKey: ['auth', 'canAccess', __assign(__assign({}, params), { record: record, resource: resource })], queryFn: function (_a) {
var signal = _a.signal;
return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_b) {
if (!authProvider || !authProvider.canAccess) {
return [2 /*return*/, true];
}
return [2 /*return*/, authProvider.canAccess(__assign(__assign({}, params), { record: record, resource: resource, signal: authProvider.supportAbortSignal ? signal : undefined }))];
});
});
}, enabled: authProviderHasCanAccess }, params));
var result = (0, react_1.useMemo)(function () {
// Don't check for the authProvider or authProvider.canAccess method in the useMemo
// to avoid unnecessary re-renders
return __assign(__assign({}, queryResult), { canAccess: queryResult.data });
}, [queryResult]);
return authProviderHasCanAccess
? result
: emptyQueryObserverResult;
};
exports.useCanAccess = useCanAccess;
var emptyQueryObserverResult = {
canAccess: true,
data: true,
dataUpdatedAt: 0,
error: null,
errorUpdatedAt: 0,
errorUpdateCount: 0,
failureCount: 0,
failureReason: null,
fetchStatus: 'idle',
isError: false,
isInitialLoading: false,
isLoading: false,
isLoadingError: false,
isFetched: true,
isFetchedAfterMount: true,
isFetching: false,
isPaused: false,
isPlaceholderData: false,
isPending: false,
isRefetchError: false,
isRefetching: false,
isStale: false,
isSuccess: true,
status: 'success',
refetch: function () { return Promise.resolve(emptyQueryObserverResult); },
};
//# sourceMappingURL=useCanAccess.js.map