UNPKG

ra-core

Version:

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

184 lines 8.84 kB
"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || (function () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); 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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype); return g.next = verb(0), g["throw"] = verb(1), g["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 __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)); }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.useCheckAuth = void 0; var react_1 = require("react"); var useAuthProvider_1 = __importStar(require("./useAuthProvider")); var useLogout_1 = __importDefault(require("./useLogout")); var notification_1 = require("../notification"); var routing_1 = require("../routing"); var useCreatePath_1 = require("../routing/useCreatePath"); /** * Get a callback for calling the authProvider.checkAuth() method. * In case of rejection, redirects to the login page, displays a notification, * and throws an error. * * This is a low level hook. See those more specialized hooks * for common authentication tasks, based on useCheckAuth. * * @see useAuthenticated * @see useAuthState * * @returns {Function} checkAuth callback * * @example * * import { useCheckAuth } from 'react-admin'; * * const MyProtectedPage = () => { * const checkAuth = useCheckAuth(); * useEffect(() => { * checkAuth().catch(() => {}); * }, []); * return <p>Private content: EZAEZEZAET</p> * } // tip: use useAuthenticated() hook instead * * const MyPage = () => { * const checkAuth = useCheckAuth(); * const [authenticated, setAuthenticated] = useState(true); // optimistic auth * useEffect(() => { * checkAuth({}, false) * .then(() => setAuthenticated(true)) * .catch(() => setAuthenticated(false)); * }, []); * return authenticated ? <Bar /> : <BarNotAuthenticated />; * } // tip: use useAuthState() hook instead */ var useCheckAuth = function () { var authProvider = (0, useAuthProvider_1.default)(); var notify = (0, notification_1.useNotify)(); var logout = (0, useLogout_1.default)(); var basename = (0, routing_1.useBasename)(); var loginUrl = (0, useCreatePath_1.removeDoubleSlashes)("".concat(basename, "/").concat(useAuthProvider_1.defaultAuthParams.loginUrl)); var checkAuth = (0, react_1.useCallback)(function () { var args_1 = []; for (var _i = 0; _i < arguments.length; _i++) { args_1[_i] = arguments[_i]; } return __awaiter(void 0, __spreadArray([], args_1, true), void 0, function (params, logoutOnFailure, redirectTo) { var error_1, shouldSkipNotify; if (params === void 0) { params = {}; } if (logoutOnFailure === void 0) { logoutOnFailure = true; } if (redirectTo === void 0) { redirectTo = loginUrl; } return __generator(this, function (_a) { switch (_a.label) { case 0: // The authProvider is optional in react-admin if (!authProvider) { return [2 /*return*/, checkAuthWithoutAuthProvider()]; } _a.label = 1; case 1: _a.trys.push([1, 3, , 4]); return [4 /*yield*/, authProvider.checkAuth(params)]; case 2: return [2 /*return*/, _a.sent()]; case 3: error_1 = _a.sent(); if (logoutOnFailure) { logout({}, error_1 && error_1.redirectTo != null ? error_1.redirectTo : redirectTo); shouldSkipNotify = error_1 && error_1.message === false; !shouldSkipNotify && notify(getErrorMessage(error_1, 'ra.auth.auth_check_error'), { type: 'error' }); } throw error_1; case 4: return [2 /*return*/]; } }); }); }, [authProvider, logout, notify, loginUrl]); return checkAuth; }; exports.useCheckAuth = useCheckAuth; var checkAuthWithoutAuthProvider = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, undefined]; }); }); }; var getErrorMessage = function (error, defaultMessage) { return typeof error === 'string' ? error : typeof error === 'undefined' || !error.message ? defaultMessage : error.message; }; //# sourceMappingURL=useCheckAuth.js.map