UNPKG

ra-core

Version:

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

152 lines 7.39 kB
"use strict"; 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 __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 __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.useGetIdentity = void 0; var react_1 = require("react"); var react_query_1 = require("@tanstack/react-query"); var useAuthProvider_1 = __importDefault(require("./useAuthProvider")); var util_1 = require("../util"); var defaultIdentity = { id: '', }; var defaultQueryParams = { staleTime: 5 * 60 * 1000, }; /** * Return the current user identity by calling authProvider.getIdentity() on mount * * The return value updates according to the call state: * * - mount: { isPending: true } * - success: { identity, refetch: () => {}, isPending: false } * - error: { error: Error, isPending: false } * * The implementation is left to the authProvider. * * @returns The current user identity. Destructure as { isPending, identity, error, refetch }. * * @example * import { useGetIdentity, useGetOne } from 'react-admin'; * * const PostDetail = ({ id }) => { * const { data: post, isPending: postLoading } = useGetOne('posts', { id }); * const { identity, isPending: identityLoading } = useGetIdentity(); * if (postLoading || identityLoading) return <>Loading...</>; * if (!post.lockedBy || post.lockedBy === identity.id) { * // post isn't locked, or is locked by me * return <PostEdit post={post} /> * } else { * // post is locked by someone else and cannot be edited * return <PostShow post={post} /> * } * } */ var useGetIdentity = function (options) { if (options === void 0) { options = defaultQueryParams; } var authProvider = (0, useAuthProvider_1.default)(); var onSuccess = options.onSuccess, onError = options.onError, onSettled = options.onSettled, queryOptions = __rest(options, ["onSuccess", "onError", "onSettled"]); var result = (0, react_query_1.useQuery)(__assign({ queryKey: ['auth', 'getIdentity'], queryFn: function (_a) { var signal = _a.signal; return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_b) { if (authProvider && typeof authProvider.getIdentity === 'function') { return [2 /*return*/, authProvider.getIdentity({ signal: signal })]; } else { return [2 /*return*/, defaultIdentity]; } return [2 /*return*/]; }); }); } }, queryOptions)); var onSuccessEvent = (0, util_1.useEvent)(onSuccess !== null && onSuccess !== void 0 ? onSuccess : noop); var onErrorEvent = (0, util_1.useEvent)(onError !== null && onError !== void 0 ? onError : noop); var onSettledEvent = (0, util_1.useEvent)(onSettled !== null && onSettled !== void 0 ? onSettled : noop); (0, react_1.useEffect)(function () { if (result.data === undefined || result.isFetching) return; onSuccessEvent(result.data); }, [onSuccessEvent, result.data, result.isFetching]); (0, react_1.useEffect)(function () { if (result.error == null || result.isFetching) return; onErrorEvent(result.error); }, [onErrorEvent, result.error, result.isFetching]); (0, react_1.useEffect)(function () { if (result.status === 'pending' || result.isFetching) return; onSettledEvent(result.data, result.error); }, [ onSettledEvent, result.data, result.error, result.status, result.isFetching, ]); return (0, react_1.useMemo)(function () { return (__assign(__assign({}, result), { identity: result.data })); }, [result]); }; exports.useGetIdentity = useGetIdentity; exports.default = exports.useGetIdentity; var noop = function () { }; //# sourceMappingURL=useGetIdentity.js.map