From fe04e457f3c20e34ba3a172ad1cc62415bc1e425 Mon Sep 17 00:00:00 2001 From: Gyanesh Gouraw Date: Wed, 28 Jan 2026 12:58:12 +0530 Subject: [PATCH] Revert "Release v2.12.0 (#1000)" This reverts commit 76b0d9b3d45177562b5f2a8fd11ab73c4d7b8dda. --- .version | 2 +- CHANGELOG.md | 9 ---- docs/assets/hierarchy.js | 2 +- docs/assets/icons.js | 2 +- docs/assets/icons.svg | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 6 +-- docs/classes/AuthenticationError.html | 2 +- docs/classes/ConnectError.html | 2 +- docs/classes/GenericError.html | 2 +- docs/classes/LocalStorageCache.html | 2 +- docs/classes/MfaRequiredError.html | 2 +- docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/OAuthError.html | 4 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 4 +- docs/classes/User.html | 4 +- docs/enums/ResponseType.html | 4 +- docs/functions/Auth0Provider.html | 2 +- docs/functions/useAuth0.html | 2 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 26 ++++------- docs/interfaces/Auth0ContextInterface.html | 43 +++++++------------ docs/interfaces/Auth0ProviderOptions.html | 42 +++++++++--------- docs/interfaces/ClientConfiguration.html | 6 --- docs/interfaces/GetTokenSilentlyOptions.html | 10 ++--- docs/interfaces/GetTokenWithPopupOptions.html | 4 +- docs/interfaces/ICache.html | 4 +- docs/interfaces/IdToken.html | 4 +- docs/interfaces/LogoutOptions.html | 10 ++--- docs/interfaces/LogoutUrlOptions.html | 8 ++-- docs/interfaces/PopupConfigOptions.html | 24 ++--------- docs/interfaces/PopupLoginOptions.html | 2 +- .../RedirectConnectAccountOptions.html | 14 +++--- docs/interfaces/RedirectLoginOptions.html | 8 ++-- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +++--- docs/modules.html | 2 +- docs/types/AppState.html | 4 +- docs/types/CacheLocation.html | 2 +- docs/types/ConnectAccountRedirectResult.html | 2 +- docs/types/ConnectedAccount.html | 2 +- docs/types/TokenEndpointResponse.html | 4 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 51 files changed, 131 insertions(+), 185 deletions(-) delete mode 100644 docs/interfaces/ClientConfiguration.html diff --git a/.version b/.version index a5db00c8..805579f3 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.12.0 \ No newline at end of file +v2.11.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 67822199..2d9efbca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,5 @@ # Change Log -## [v2.12.0](https://github.com/auth0/auth0-react/tree/v2.12.0) (2026-01-28) -[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.11.0...v2.12.0) - -**Added** -- feat: add getConfiguration method to Auth0Client and updated documentation [\#991](https://github.com/auth0/auth0-react/pull/991) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta)) - -**Security** -- Security: Example app update Next.js dependency for CVE-2025-55184 and CVE-2025-55183 [\#951](https://github.com/auth0/auth0-react/pull/951) ([tusharpandey13](https://github.com/tusharpandey13)) - ## [v2.11.0](https://github.com/auth0/auth0-react/tree/v2.11.0) (2025-12-11) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.10.0...v2.11.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 9ea380ca..6b198bfe 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlMtuwjAQRf9l1qaQ2I5CdhWtqkr0oT7UBWJhmYFYBDu1nRXi36uAWhkCdVhFcu7k3OuZyRasMd5BMeOMEsoYSdl4TsDiskLpldEOii2kbNw+tNggFPBq6qaempXSL/VBQmCt9AKKlGcEGltBAUp7tEsh0Q07+pvSbyogICvhHBTg3WLQfmDwV9S+LFW1sKihmKWcz3cEUs4DFw/oP8wa9Zfy5Z7Qz8ylsh6edgQoY4GFx4mQJUaAB9G1kWlG28g0owFvaqSo3r2xYoXH6CTNf9F7ArphR3zRwuGgpeVJQPtQGzSNv7fW2P9AoS7COIrI+LiNyEZhV5+W4g2/G2VxEQWfauMBGaWnczwRWmJV9cCdkfcg8s7m9L3XjrgHLQ/v8rbxJWqvpGgnPMo7I48TeXLUPeWc0qs3XFp05X7P4l28UNODzejR/0CjVTLKC3XXjCvNE8JGnDBKCcs54QknPBuTLE3aMeZZ2OhPh3e1qZ+Nlhh11BHHo2dpuKkTozXK+ESFuhhjt/sBUIgHAQ==" \ No newline at end of file +window.hierarchyData = "eJyVlMtOwzAQRf9l1i5Qv5JmhwpCSLzEQywqFpY7bSxSO9jOCvXfUVqB3JbisIrkHOfM9YzzCd65GKCaCSYJYwWhnL0R8LhoUEfjbIDqEyhn/cOqFUIFD67t2hu3NPa+3SIE3o2dQ0WFJND5BiowNqJfKI3h9IA/qeOqAQK6USFABTHMR/0HRj+b+pe1aeYeLVQzysu3NQHKy6SKK4zP7h3tq4n1xjCsmGPbBtS0JsBYkZRwPVW6xoxwC/03MhOyj8yETHw3TqvmKTqvlrirHtPyW70xYDg9gI+WsF3obQVPbM9mha6Ll947/5co5TKOnYhc0E3ESdrV24V6xI/OeJxnxftsPiCncn+Op8pqbJoBul/wAUZB941Dz/UAHmAr0rM872KNNhqt+gnP+n7B80ZxttM9E4Kxy0dceAz15p7lu3hkzwA3kzv/A4ve6Kwv5f4zrqzghE1KwqkkvCiJOCuJkJTIMe/HWMi00S8BL1rX3jmrMVvRAZyPLsfpTZ06a1HnJyrlco71+gtvAAcT" \ No newline at end of file diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 3ae8f55e..58882d76 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 10db10be..50ad5799 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 2af5d713..d8abc43f 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJyll11v0zAUhv+Lrzu2FTagd1OBqVLHqnYTF4gL45wm1hLb2M5oQfx3lKRpPvyRyLlszuv3cZzjV6ff/yINB40WaAtKcKbg6SgAzZDAOkELBCzP1GW79ibRWYpm6IWyCC0+zBBJsVJogbSKLqi6gIMGyXCK/s3O3ne5ToBpSrCmnH2WkssGUa4HdWkRdVnX83G0JWcMiHZg2tUw/3tgIClx+LerYf4r9gAZl8clJgmYgE45jLDmBKc7zSWOwUExJGGkhz3ewq+cSogc59VXBHKoUpTFW9hLUMkTfwFXm7mUYdzHomsdpKZmeLccNlzkYokZgTR1HpJFFLbf0uiJZsBz1wUxJGEkP2S6/7OCT4KLr5wRcEAMSTDJbh7oV7TF1ZKz4ueKaZB7TFo3kNaPqkg0lF3o/Oa2b72R/JVGIB9FEaTK7dwTDhlzSf+U2bzBEmdu357OsB0X4ikFppec7Wmcy9LOCrTowoD3oMsw2NEUmE6PvtNzaKeBv1GdlHdvDLkvDkOveuHfAq0soT/aNir3aPetamHGax7zXPvOp6PwNXQlfJbpsFsjCtt1Fd5lh/pgpmwCbs1jygZpbVUYbAsRlUD0aaq6I4TnzPuFvCumbWLwpW1CX5MUt6xOSmG37ErGmDUzbj33+LY8uMqb2kLsNNatG66Pokjp0/Pe2quP769v5u0QLjIA/0wNg3PB6jAu4AuLYsrsRnvLvy5OYHR6rP76W1B5qg2kRzt5BxCdfB3Uc33wi+RK86yaWg8kwSwGo3tOzk5l+Nt8AU0SkFVI9YGdYjij2jGLBKfFZ6j+ePZZVlE4sz1nNahXLGnR4905rEt5O3dNX43PPmekPPju1NU1un3XMsoVlFKbR13zLP9dZ5Jt/bk4wsAMHZ+jqTYQP/4DSP2x4w==" \ No newline at end of file +window.navigationData = "eJyll8tu2zAQRf+Fa6dJ3CZtvQvcBww4jWEnyKLogqXGEhGJZEkqtVv03wtJlvXgQwK1jOfyHEoiB5Pvf5GGg0YLtAUlOFPweBSAZkhgnaAFApZn6rJde5PoLEUz9EJZhBYfZoikWCm0QFpFF1RdwEGDZDhF/2Zn9l2uE2CaEqwpZ5+l5LJRlOtBXVpCXdf1fJxtyRkDoh2adjWM/xUYSEoc/HY1jL9i95BxeVxikoAp6JTDDGtOcLrTXOIYHBYjEma63+Mt/MqphMjxvvqJQA9VirJ4C3sJKnnkL+A6Zq5kmPehOLUOU1Mz2C3ChotcLDEjkKbOl2QJhe23BD3SDHjuuiBGJMzkl0znPyn4JLj4xhkBh8SIBJvs8EBecSyulpwVf66YBrnHpHUDaf1T1RKNZFc6v7ntozeSv9II5IMoGqlyk3vBITCX9E/ZmzdY4szN7eUM7Mgmq8u7uaMpMJ0efQ/jyE4TP1OdlFdhjLkfDlOver24JVpZevBobFTu0c6tamHgNY95rn3vp5Pwna8q+CTTYVoTCtt11Us529PYJzNjE3RrHlM2aGunwmRbiKgEok9Dzh0hPGfeL+RdMW0Tgw9tC/oOSXHL6sYl7MhuZAysGTnrMcS35cFV3iYqxE5j3brh+iiKpnn6vbf26uP765t5e7AtegD+mRqAc8FKGDc0F4hi6CuewsqvixMcnTNWf/0tqDzVhtKTnbwDiE5ch/VcH/wiudI8q4bIA0kwi8E4PSeyMxn+NF9AkwRk1aT6wk4x3FHtmEWC0+IzVP8H9l3WULizPfY0qlcsaXHGu2NR1/J27hqGGs4+Z6R88d0hqAu6fdcC5QrKqI1R1zzLf9c9ybb+XBwBMJuOj2imDcWP//QYiiQ=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 178be51b..34f2f0bc 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1mt1u2zgQhd+FuVVTc0jbse+62V2gQLEttsXuhREUqsTEQhRJK8lpiyDvvqB+h+JIoRz1LrA4h4fkN0NG4hPL0+8F2x+e2H2UhGzP4cpjif+g2J59fHcqj3/keZozj53ymO1ZEPtFoYq3/aPLY/kQM699wvaMPXut2ppDpxakSVHmp6B8We7CbIukPZb5uUpK013fIV+B7HpULtYv2lav6uVrqIogj7IyShO3HgcRM3qH9abrXD9fXadJqX6U75NS5bd+oDoDUftL8ZZsOLl2xiCDNElUUL4LgvSUlP9G5fFvFUa5Csp5nV00Qn4t9D0qj3kvRE8CPcYxo7nyS/WnKoOjyud6q2Jvu9gF7JgIutmwgSyL8E1UvImSo8qjUoXn2/kRHP3kTn1J71Uy11YTWzaxC8zOnUpU7pfq9yzNPuVpejvTUhsfZmmWNfGL2NKgq6KopulzFKukjH/O9qYhV0VRzVfRiyxuUGfjpzQ7Za9yqFMxa1SWsXidJrfR3Sn3jaLo7C0YhC9jSqP2V5rMLZLakKYsaUKXMfM+rBbwOvajh2K+oSisVi5owxcwdfSTMFZtbb/24/ibH9zPtFaLtHU96EUWMBgVurlKyijw60o4x1lU+IPoX1Bko+JD6odRcjfbXNzF/QJbcXoXnV0rquCFS0Rn6MyjROdp2RNEnN6lpzO81EELGCjOr1LF4lXqVMw+RjUhyyBsHXY/5eljFKr8Y3VyHq+ag3YzjrrHKA7zieMRpXyBoiZmfWh+/LSt52Omgy7o9QbSxHkLIL2kybzq72iruI+y1xnTCktZw2h+qPJ/gkmjwSSMWLYd7Add6ibUqXbOnegS3A41I+XNFu6ppDfblaPgRduYXouByemRNBt8pDH+7xTlKpyYuxeDZv2XPJa3br28mMQvj3Bqs331LNR7btrJLGwyTX5Tt2muzOBX2E2Tb5WgPxRc3HibgSPHPme/uaGzsM1clac8+ZK+wmEtUaaLmIPVbsvX/SvCd1n2ufTL/tRT/sx0OW9+nv26SoXNC6spwYuusd81HtkPWnuj01tkaVKor7qXyS6HLc/tb7CcdFcvLBjRy3Bdrqenc/h4cp0EmOe560HNfPTzyP8WD46Yk5IbSR8RO83bUxJU7JknA1fRU1FVpBWh1z5ylfrebmOEVvdsrpidahPqdmOquxuPRUmofrD9E3tUeaGr5p7BpbjcMY/dRioO9VeD2onHgvThQVVchGlwqv68aZr9o/RbfN24bv12xbzDyhPy8mojb268QxtcPah+aDX6X6pAzrwDpwK5FciNQGDeATzYXW7XayMQrEAwAgXzDoLqUViBwgiUzDtIKlBagdIIXDPvsKYC11bg2gjcMO+woQI3VuDGCNyOTc7WCtwagVfMO2ypHq+swCsjcMe8wxUVuLMCdyYAmocdSYDNDh/AU9FDcscJfkyAuMaC0+zZDHETIq7R4EAG2xxxEySu8eAkg9xmiZswcY0IJznkNk/cBIprTDjJIreZ4iZUXKPCSR65zRU3weIaF06ixW22uAkX18hwEi9u88VNwEAzw0nCwCYMTMJAMwMkYWATBoMSVdUokjAgqpRJGGhmgCQMbMLAJAw0M0ASBjZhYBIGmhmQZG21CQOTMNDMAEkY2ISBSRhUdYskDGzCwCQMNDNAEgY2YWASBpoZIAkDmzAwCROaGSAJEzZhwiRMaGYESZiwCRMmYUIzI0jChE2YGGyEYnSdBbEXmoQJzYwg8RQ2YcIkTGhmBL0J24QJkzChmRFkARQ2YcIkTGhmxJocs02YMAkTmhlB4ilswoRJmNDMiC3Zs02YMAmTmhlB4iltwqRJmOSjY5Y2YdIkTMKobWkTJk3CZHXWIhND2oTJwXGrOm+RiSGJE5dJmNTMSDIxpE2YNAmTmhlJsi1twqRJmNTMSJJtaRPW/FSdzB9VXqrwfX1CPxyYn2VF/Y/zE/vaHNxF917siYkrtn96fu4P6vunZ3RW1890X80rOKSxQhrcXaN7jYWkdr2UFLOlujcVWFMiSXfFrPv3ECmhgcoztLpXYr0kQC8JbgPuPyIgGYFk3JxN3bHphde97nqOLHpPglZ3i0DZ1QISXGX7u169Iu8F3cAjmAMECKzrOOG4FOZdoF4TZdXGSam5zoNcIVN1zNZdyLw2hhYAzb+bmnmdp1dCK+lWNYhbOL3aVa+2c1Sj7830kqiQ8NUZmugzNsINFQDuBpx9RwXJYXzd8sC8YYKkEC/cbW3tuyFIDpHC3erJ2H0OJIoSjbtVE+sqBlJDpYm7JRm6O4F0UK5ytxwzv2+g9EKLINxmbXhlAvlCKcbdcoy464D0UJJxtyxr7ysgEZRW4JZWtQi19aEBgtsA04qGYalESelmaeyDD1pJXCndUKW+ZqPBIlrBjdbBZx5kDuWRcNNqlcbIBQQHuMEx+DqB7CEt6bYg/ecHJINmTGybw4JbzS1GiiQgUsBRirwKgCRR9QC36nEqlHWElmgnkG681RdokBMkAW6biS4VthVUxKQbXZ1OVt8NQKZQvRBuLLRifWLm3fcK5BIlqHSb93FhqpSj2RQOs3njsSzKVBwliu0PN8/P/wN0jl0g"; \ No newline at end of file +window.searchData = "eJy1ml1vnTgQhv+Lc0vT47HP5103uytVqrbVttq9OIoqCk4OCgEWOGmrKP99ZT7HeCAmoXfRwfP6tf3M2AE/sjz9XrDD8ZHdRUnIDhx2Hkv8e8UO7OO7c3n6I8/TnHnsnMfswILYLwpVvO0fXZ7K+5h57RN2YOzJa9XWHDq1IE2KMj8H5fNyF2ZbJO2xzM9VUpru+g75CmTXo3KxftG2elUvX0NVBHmUlVGauPU4iJjRO6w3Xef6+eoqTUr1o3yflCq/8QPVGYjaX4q3ZMPJtTMGGaRJooLyXRCk56T8NypPf6swylVQzuvsohHya6HvUXnKeyF6EugxjhnNlV+qP1UZnFQ+11sVe9PFLmDHRNDNhg1kWYRvouJNlJxUHpUqfLmdH8HJT27Vl/ROJXNtNbFlE7vA7NyqROV+qX7P0uxTnqY3My218WGWZlkTv4gtDboqimqaPkexSsr452xvGnJVFNV8Fb3I4gZ1Nn5Ks3P2Koc6FbNGZRmLelX/SpO59Uj70guaNKHLmHkfVnN1FfvRfTHfUBRWkxS04QuYOvlJGKu2jF75cfzND+5mWqtF2hIa9CILGIwK3VwlZRT4ddGZ4ywq/EH0L6hnUfEh9cMouZ1tLu7ifoGtOL2NXpyWVfDC2dgZeuGu3XladrOO09v0/AIvddACBoqXV6li8Sp1LmafWJqQZRC2zpWf8vQhClX+sTqkjlfNQbsZp8pTFIf5xEmEUr5AUROzPjQ/frDV8zHTQRf0egNp4rwFkF7SZF71d7RV3EXZ64xphaWsYTQ/VPk/waTRYBJGLNsO9oMudRPqVDvnTnQJboeakfJmC/dU0pvtylHwom1Mr8XA5PRImg0+0hj/d45yFU7M3bNBs/4hHctbt16eTeLnRzi12b56Fuo9N+1kFjaZJr+pmzRXZvAr7KbJt0rQHwoubrzNwJFjn7Pf3NBZ2GauynOefElf4bCWKNNFzMFqv+Xr/m3cuyz7XPplf+opf2a6nDc/z34zpMLm3dCU4EXX2O8aj+wHrb3R6S2yNCnUV93LZJfDli/tb7CcdFfPLBjRy3Bdrqanc/h4cp0EmOe5q0HNfPDzyP8WD46Yk5IbSR8RO82bcxJU7JknA1fRc1FVpBWh1z5ylfrebmOEVvdsrpidahPqdmOqu2uPRUmofrDDI3tQeaGr5oHBpbjcM4/dRCoO9Qv62onHgvT+XlVchGlwrv68bpr9o/QLc924bv12xbzjyhPycrPeXl97xza4elD90Gr0v1SBnHlHTgVyK5AbgcC8I3iwv1zLvREIViAYgYJ5R0H1KKxAYQRK5h0lFSitQGkErpl3XFOBaytwbQRumHfcUIEbK3BjBG7HJmdrBW6NwB3zjluqx50VuDMC98w77qjAvRW4NwHQPOxJAmx2+ACeih6SO07wYwLENRacZs9miJsQcY0GBzLY5oibIHGNBycZ5DZL3ISJa0Q4ySG3eeImUFxjwkkWuc0UN6HiGhVO8shtrrgJFte4cBItbrPFTbi4RoaTeHGbL24CBpoZThIGNmFgEgaaGSAJA5swGJSoqkaRhAFRpUzCQDMDJGFgEwYmYaCZAUGWR5swMAkDzQyQhIFNGJiEgWYGSMLAJgxMwqCqWyRhYBMGJmGgmQGSMLAJA5Mw0MwASRjYhIFJmNDMAEmYsAkTJmFCMyNIwoRNmDAJEzC6zsImTAw2wmonJPEUxF5oEiY0M4LEU9iECZMwoZkR9CZsEyZMwoRmRkhyzDZhwiRMaGYEiaewCRMmYUIzIzZkzzZhwiRMaGYEiaewCRMmYXI1OmZpEyZNwiQftS1twqRJmNTMCDIxpE2YNAmTFWFkYkibMDk4blXnLTIxJHHiMgmTmhlJsi1twqRJmNTMSJJtaRPW/FQdrh9UXqrwfX3IPh6Zn2VF/b/vI/vanL3Fuj3rPzKxZYfHp6f+rH14fELHbf1M99W8Res1YI80Vu4a3ZsoZGfXS0mYLdW9bMCaEkm6K2bdf3jIHRqoFPO1urdaaO54LwluA+6/AyAZQDJuzqZupPTCCI/1HFn0qgPN3waBsqsFJHeV7W9G9Ypo9px1hsyBQHMn6zjhuBTmzZleEw1046TUXH5BrpCpOsYtO4lLVmgB0Py7qZmXX3qlba+0c1Ii7qz0aijr945q9C2TXhKlKnerSaP3QhBuK6TqBpx5qwNJYXTdaLPvYyA5xAt3W9uxOxRIFPHC3Wqndf0BqaFCzN2KCbqvgHRQTeJu2WV+U0D5gBZBuM3a8JoC8oWSnrslK3G/AOmhHONuSdbeEUAiKLW4W27VItRehQYIbgNMKxqGtQ1lkVtqjn1kQSuJ+BduqFJfkNFgEa3gRuvg0woyh+uum1arNEYuIDjADY7BFwFkD2kJN0b6V/5IBs2Y2DS7u9v6FmNFElVxcJQiP7+jiUPVA9yqx7lQ1plXIoalG2/1pRXkBEmA22aiS4VtBRUx6UZXp5PV3+ORKVQvwI2FVqxPzLz7RoBcogSVbvM+LkyVcjSbwmE2rz2WRZmKo0Sxw/H66el/H0H8AQ=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 44328e99..5ba5a2a9 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1595,9 +1595,9 @@ .container-main { grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( - 0, - 20rem - ); + 0, + 20rem + ); grid-template-areas: "sidebar content toc"; } diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 44a77c44..b7fc8047 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,6 +1,6 @@ AuthenticationError | @auth0/auth0-react
@auth0/auth0-react
    Preparing search index...

    Class AuthenticationError

    Thrown when handling the redirect callback fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

    -

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    appState error error_description diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 5d5bcef9..550dc812 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,6 +1,6 @@ ConnectError | @auth0/auth0-react
    @auth0/auth0-react
      Preparing search index...

      Class ConnectError

      Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      appState connection error diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 0b092c15..756f8422 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,5 +1,5 @@ GenericError | @auth0/auth0-react
      @auth0/auth0-react
        Preparing search index...

        Class GenericError

        Thrown when network requests to the Auth server fail.

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index b7cbe717..b10ce507 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -3,4 +3,4 @@ get remove set -

        Constructors

        Methods

        • Returns string[]

        • Type Parameters

          Parameters

          • key: string

          Returns MaybePromise<T | undefined>

        • Parameters

          • key: string

          Returns void

        • Type Parameters

          Parameters

          • key: string
          • entry: T

          Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        +

        Constructors

        Methods

        • Returns string[]

        • Type Parameters

          Parameters

          • key: string

          Returns MaybePromise<undefined | T>

        • Parameters

          • key: string

          Returns void

        • Type Parameters

          Parameters

          • key: string
          • entry: T

          Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 0615345a..e3e4321a 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,5 +1,5 @@ MfaRequiredError | @auth0/auth0-react
        @auth0/auth0-react
          Preparing search index...

          Class MfaRequiredError

          Error thrown when the token exchange results in a mfa_required error

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          error error_description message diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index fa85f156..cc98e101 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,5 +1,5 @@ MissingRefreshTokenError | @auth0/auth0-react
          @auth0/auth0-react
            Preparing search index...

            Class MissingRefreshTokenError

            Error thrown when there is no refresh token to use

            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            audience error error_description diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 0889c324..a4549344 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -1,7 +1,7 @@ OAuthError | @auth0/auth0-react
            @auth0/auth0-react
              Preparing search index...

              Class OAuthError

              An OAuth2 error will come from the authorization server and will have at least an error property which will be the error code. And possibly an error_description property

              See: https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6

              -

              Hierarchy

              • Error
                • OAuthError
              Index

              Constructors

              constructor +

              Hierarchy

              • Error
                • OAuthError
              Index

              Constructors

              constructor

              Properties

              error error_description? message @@ -10,7 +10,7 @@ prepareStackTrace? stackTraceLimit

              Methods

              captureStackTrace -

              Constructors

              • Parameters

                • error: string
                • Optionalerror_description: string

                Returns OAuthError

              Properties

              error: string
              error_description?: string
              message: string
              name: string
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

              +

              Constructors

              • Parameters

                • error: string
                • Optionalerror_description: string

                Returns OAuthError

              Properties

              error: string
              error_description?: string
              message: string
              name: string
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

              https://v8.dev/docs/stack-trace-api#customizing-stack-traces

              stackTraceLimit: number

              Methods

              • Create .stack property on a target object

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index c5c1917c..59b08e6d 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,5 +1,5 @@ PopupCancelledError | @auth0/auth0-react
              @auth0/auth0-react
                Preparing search index...

                Class PopupCancelledError

                Thrown when network requests to the Auth server fail.

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                error error_description message diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index cf1a0538..3ddc168d 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,5 +1,5 @@ PopupTimeoutError | @auth0/auth0-react
                @auth0/auth0-react
                  Preparing search index...

                  Class PopupTimeoutError

                  Error thrown when the login popup times out (if the user does not complete auth)

                  -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor +

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor

                  Properties

                  error error_description message diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 4fcbc454..a6e387d7 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,6 +1,6 @@ TimeoutError | @auth0/auth0-react
                  @auth0/auth0-react
                    Preparing search index...

                    Class TimeoutError

                    Thrown when silent auth times out (usually due to a configuration issue) or when network requests to the Auth server timeout.

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    error error_description message diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index 249f8823..9af63162 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,5 +1,5 @@ UseDpopNonceError | @auth0/auth0-react
                    @auth0/auth0-react
                      Preparing search index...

                      Class UseDpopNonceError

                      Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.

                      -

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor +

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor

                      Properties

                      error error_description message @@ -10,7 +10,7 @@ stackTraceLimit

                      Methods

                      captureStackTrace fromPayload -

                      Constructors

                      Properties

                      error: string
                      error_description: string
                      message: string
                      name: string
                      newDpopNonce: string | undefined
                      stack?: string
                      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                      Optional override for formatting stack traces

                      +

                      Constructors

                      Properties

                      error: string
                      error_description: string
                      message: string
                      name: string
                      newDpopNonce: undefined | string
                      stack?: string
                      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                      Optional override for formatting stack traces

                      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                      stackTraceLimit: number

                      Methods

                      • Create .stack property on a target object

                        Parameters

                        • targetObject: object
                        • OptionalconstructorOpt: Function

                        Returns void

                      • Parameters

                        • __namedParameters: { error: string; error_description: string }

                        Returns GenericError

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      diff --git a/docs/classes/User.html b/docs/classes/User.html index a44701f3..a71f4039 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,4 +1,4 @@ -User | @auth0/auth0-react
                      @auth0/auth0-react
                        Preparing search index...

                        Class User

                        Indexable

                        • [key: string]: any
                        Index

                        Constructors

                        constructor +User | @auth0/auth0-react
                        @auth0/auth0-react
                          Preparing search index...

                          Class User

                          Indexable

                          • [key: string]: any
                          Index

                          Constructors

                          constructor

                          Properties

                          address? birthdate? email? @@ -19,4 +19,4 @@ updated_at? website? zoneinfo? -

                          Constructors

                          Properties

                          address?: string
                          birthdate?: string
                          email?: string
                          email_verified?: boolean
                          family_name?: string
                          gender?: string
                          given_name?: string
                          locale?: string
                          middle_name?: string
                          name?: string
                          nickname?: string
                          phone_number?: string
                          phone_number_verified?: boolean
                          picture?: string
                          preferred_username?: string
                          profile?: string
                          sub?: string
                          updated_at?: string
                          website?: string
                          zoneinfo?: string

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          +

                          Constructors

                          Properties

                          address?: string
                          birthdate?: string
                          email?: string
                          email_verified?: boolean
                          family_name?: string
                          gender?: string
                          given_name?: string
                          locale?: string
                          middle_name?: string
                          name?: string
                          nickname?: string
                          phone_number?: string
                          phone_number_verified?: boolean
                          picture?: string
                          preferred_username?: string
                          profile?: string
                          sub?: string
                          updated_at?: string
                          website?: string
                          zoneinfo?: string

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index 32396df7..19f79fd3 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -3,6 +3,6 @@
                        • code: used for the standard login flow.
                        • connect_code: used for the connect account flow.
                          • -
                          Index

                          Enumeration Members

                          Code +
                          Index

                          Enumeration Members

                          Code ConnectCode -

                          Enumeration Members

                          Code: "code"
                          ConnectCode: "connect_code"

                          Settings

                          Member Visibility

                          On This Page

                          Enumeration Members
                          +

                          Enumeration Members

                          Code: "code"
                          ConnectCode: "connect_code"

                          Settings

                          Member Visibility

                          On This Page

                          Enumeration Members
                          diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 58892a39..24e20cb5 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -2,4 +2,4 @@

                          Provides the Auth0Context to its child components.

                          -

                          Type Parameters

                          Parameters

                          Returns Element

                          Settings

                          Member Visibility
                          +

                          Type Parameters

                          Parameters

                          Returns Element

                          Settings

                          Member Visibility
                          diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 7e814e7b..5e91b071 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -3,4 +3,4 @@

                          Use the useAuth0 hook in your components to access the auth state and methods.

                          TUser is an optional type param to provide a type to the user field.

                          -

                          Type Parameters

                          Parameters

                          Returns Auth0ContextInterface<TUser>

                          Settings

                          Member Visibility
                          +

                          Type Parameters

                          Parameters

                          Returns Auth0ContextInterface<TUser>

                          Settings

                          Member Visibility
                          diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index 5d45894a..10345e06 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -4,4 +4,4 @@

                          Wrap your class components in this Higher Order Component to give them access to the Auth0Context.

                          Providing a context as the second argument allows you to configure the Auth0Provider the Auth0Context should come from f you have multiple within your application.

                          -

                          Type Parameters

                          Parameters

                          Returns ComponentType<Omit<P, "auth0">>

                          Settings

                          Member Visibility
                          +

                          Type Parameters

                          Parameters

                          Returns ComponentType<Omit<P, "auth0">>

                          Settings

                          Member Visibility
                          diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index 3153dc0e..c02c057f 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -3,4 +3,4 @@

                          When you wrap your components in this Higher Order Component and an anonymous user visits your component they will be redirected to the login page; after login they will be returned to the page they were redirected from.

                          -

                          Type Parameters

                          Parameters

                          Returns FC<P>

                          Settings

                          Member Visibility
                          +

                          Type Parameters

                          Parameters

                          Returns FC<P>

                          Settings

                          Member Visibility
                          diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 3ce3e244..2094c871 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...

                            @auth0/auth0-react

                            Hierarchy Summary

                            Settings

                            Member Visibility
                            +@auth0/auth0-react
                            @auth0/auth0-react
                              Preparing search index...

                              @auth0/auth0-react

                              Hierarchy Summary

                              Settings

                              Member Visibility
                              diff --git a/docs/index.html b/docs/index.html index 742931d2..cdd43e30 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,17 +6,14 @@ License CircleCI

                              📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback

                              - -
                              error: Error | undefined
                              exchangeToken: (
                                  options: CustomTokenExchangeOptions,
                              ) => Promise<TokenEndpointResponse>
                              const tokenResponse = await exchangeToken({
                                subject_token: 'external_token_value',
                                subject_token_type: 'urn:acme:legacy-system-token',
                                scope: 'openid profile email'
                              });
+

                              Type Parameters

                              • TOutput extends CustomFetchMinimalOutput = Response

                              Parameters

                              Returns Fetcher<TOutput>

                              error: undefined | Error
                              exchangeToken: (
                                  options: CustomTokenExchangeOptions,
                              ) => Promise<TokenEndpointResponse>
                              const tokenResponse = await exchangeToken({
                                subject_token: 'external_token_value',
                                subject_token_type: 'urn:acme:legacy-system-token',
                                scope: 'openid profile email'
                              });

                              Exchanges an external subject token for Auth0 tokens via a token exchange request.

                              @@ -52,13 +51,13 @@

                              Type Declaration

                              generateDpopProof: (
                                  params: {
                                      accessToken: string;
                                      method: string;
                                      nonce?: string;
                                      url: string;
                                  },
                              ) => Promise<string>

                              Returns a string to be used to demonstrate possession of the private +

                              generateDpopProof: (
                                  params: {
                                      accessToken: string;
                                      method: string;
                                      nonce?: string;
                                      url: string;
                                  },
                              ) => Promise<string>

                              Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              Type Declaration

                                • (
                                      params: {
                                          accessToken: string;
                                          method: string;
                                          nonce?: string;
                                          url: string;
                                      },
                                  ): Promise<string>

                                • Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                                  It requires enabling the Auth0ClientOptions.useDpop option.

                                  -

                                  Parameters

                                  • params: { accessToken: string; method: string; nonce?: string; url: string }

                                  Returns Promise<string>

                              getAccessTokenSilently: {
                                  (
                                      options: GetTokenSilentlyOptions & { detailedResponse: true },
                                  ): Promise<GetTokenSilentlyVerboseResponse>;
                                  (options?: GetTokenSilentlyOptions): Promise<string>;
                                  (
                                      options: GetTokenSilentlyOptions,
                                  ): Promise<string | GetTokenSilentlyVerboseResponse>;
                              }
                              const token = await getAccessTokenSilently(options);
+

                              Parameters

                              • params: { accessToken: string; method: string; nonce?: string; url: string }

                              Returns Promise<string>

                              getAccessTokenSilently: {
                                  (
                                      options: GetTokenSilentlyOptions & { detailedResponse: true },
                                  ): Promise<GetTokenSilentlyVerboseResponse>;
                                  (options?: GetTokenSilentlyOptions): Promise<string>;
                                  (
                                      options: GetTokenSilentlyOptions,
                                  ): Promise<string | GetTokenSilentlyVerboseResponse>;
                              }
                              const token = await getAccessTokenSilently(options);

                              If there's a valid token stored, return it. Otherwise, opens an @@ -77,7 +76,7 @@ back to using an iframe to make the token exchange.

                              Note that in all cases, falling back to an iframe requires access to the auth0 cookie.

                              -
                              getAccessTokenWithPopup: (
                                  options?: GetTokenWithPopupOptions,
                                  config?: PopupConfigOptions,
                              ) => Promise<string | undefined>
                              const token = await getTokenWithPopup(options, config);
+
                              getAccessTokenWithPopup: (
                                  options?: GetTokenWithPopupOptions,
                                  config?: PopupConfigOptions,
                              ) => Promise<undefined | string>
                              const token = await getTokenWithPopup(options, config);

                              Get an access token interactively.

                              @@ -85,41 +84,31 @@ provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

                              -
                              getConfiguration: () => Readonly<ClientConfiguration>
                              const config = getConfiguration();
                              // { domain: 'tenant.auth0.com', clientId: 'abc123' }
-
                              - -

                              Returns a readonly copy of the initialization configuration -containing the domain and clientId.

                              -

                              Type Declaration

                                • (): Readonly<ClientConfiguration>

                                • Returns a readonly copy of the initialization configuration.

                                  -

                                  Returns Readonly<ClientConfiguration>

                                  An object containing domain and clientId

                                  -
                                  const auth0 = new Auth0Client({
                                    domain: 'tenant.auth0.com',
                                    clientId: 'abc123'
                                  });

                                  const config = auth0.getConfiguration();
                                  // { domain: 'tenant.auth0.com', clientId: 'abc123' }
-
                                  - -
                              getDpopNonce: (id?: string) => Promise<string | undefined>

                              Returns the current DPoP nonce used for making requests to Auth0.

                              +
                              getDpopNonce: (id?: string) => Promise<undefined | string>

                              Returns the current DPoP nonce used for making requests to Auth0.

                              It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              -

                              Type Declaration

                                • (id?: string): Promise<string | undefined>

                                • Returns the current DPoP nonce used for making requests to Auth0.

                                  +

                                  Type Declaration

                                    • (id?: string): Promise<undefined | string>

                                    • Returns the current DPoP nonce used for making requests to Auth0.

                                      It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                                      It requires enabling the Auth0ClientOptions.useDpop option.

                                      Parameters

                                      • Optionalid: string

                                        The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                        -

                                      Returns Promise<string | undefined>

                                  The nonce value.

                                  +

                              Returns Promise<undefined | string>

                              The nonce value.

                              The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                              -
                              getIdTokenClaims: () => Promise<IdToken | undefined>
                              const claims = await getIdTokenClaims();
+
                              getIdTokenClaims: () => Promise<undefined | IdToken>
                              const claims = await getIdTokenClaims();

                              Returns all claims from the id_token if available.

                              -
                              handleRedirectCallback: (
                                  url?: string,
                              ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                              After the browser redirects back to the callback page, +

                              handleRedirectCallback: (
                                  url?: string,
                              ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                              After the browser redirects back to the callback page, call handleRedirectCallback to handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.

                              Type Declaration

                                • (url?: string): Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                • Parameters

                                  • Optionalurl: string

                                    The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.

                                    -

                                  Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                              isAuthenticated: boolean
                              isLoading: boolean
                              loginWithPopup: (
                                  options?: PopupLoginOptions,
                                  config?: PopupConfigOptions,
                              ) => Promise<void>
                              await loginWithPopup(options, config);
+

                              Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                              isAuthenticated: boolean
                              isLoading: boolean
                              loginWithPopup: (
                                  options?: PopupLoginOptions,
                                  config?: PopupConfigOptions,
                              ) => Promise<void>
                              await loginWithPopup(options, config);

                              Opens a popup with the /authorize URL using the parameters @@ -129,20 +118,20 @@

                              IMPORTANT: This method has to be called from an event handler that was started by the user like a button click, for example, otherwise the popup will be blocked in most browsers.

                              -
                              loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                              await loginWithRedirect(options);
+
                              loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                              await loginWithRedirect(options);

                              Performs a redirect to /authorize using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated.

                              -
                              logout: (options?: LogoutOptions) => Promise<void>
                              auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+
                              logout: (options?: LogoutOptions) => Promise<void>
                              auth0.logout({ logoutParams: { returnTo: window.location.origin } });

                              Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session. If the logoutParams.federated option is specified, it also clears the Identity Provider session. Read more about how Logout works at Auth0.

                              -
                              setDpopNonce: (nonce: string, id?: string) => Promise<void>

                              Sets the current DPoP nonce used for making requests to Auth0.

                              +
                              setDpopNonce: (nonce: string, id?: string) => Promise<void>

                              Sets the current DPoP nonce used for making requests to Auth0.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              Type Declaration

                                • (nonce: string, id?: string): Promise<void>

                                • Sets the current DPoP nonce used for making requests to Auth0.

                                  It requires enabling the Auth0ClientOptions.useDpop option.

                                  @@ -154,4 +143,4 @@

                                  The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                  -
                              user: TUser | undefined

                              Settings

                              Member Visibility

                              On This Page

                              Properties
                              +
                              user: undefined | TUser

                              Settings

                              Member Visibility

                              On This Page

                              Properties
                              diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html index 61cb089e..b3c48044 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -1,5 +1,5 @@ Auth0ProviderOptions | @auth0/auth0-react
                              @auth0/auth0-react
                                Preparing search index...

                                Interface Auth0ProviderOptions<TUser>

                                The main configuration to instantiate the Auth0Provider.

                                -
                                interface Auth0ProviderOptions<TUser extends User = User> {
                                    auth0Client?: {
                                        env?: { [key: string]: string };
                                        name: string;
                                        version: string;
                                    };
                                    authorizationParams?: ClientAuthorizationParams;
                                    authorizeTimeoutInSeconds?: number;
                                    cache?: ICache;
                                    cacheLocation?: CacheLocation;
                                    children?: ReactNode;
                                    clientId: string;
                                    context?: Context<Auth0ContextInterface<TUser>>;
                                    cookieDomain?: string;
                                    domain: string;
                                    httpTimeoutInSeconds?: number;
                                    issuer?: string;
                                    leeway?: number;
                                    legacySameSiteCookie?: boolean;
                                    nowProvider?: () => number | Promise<number>;
                                    onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                                    sessionCheckExpiryDays?: number;
                                    skipRedirectCallback?: boolean;
                                    useCookiesForTransactions?: boolean;
                                    useDpop?: boolean;
                                    useFormData?: boolean;
                                    useMrrt?: boolean;
                                    useRefreshTokens?: boolean;
                                    useRefreshTokensFallback?: boolean;
                                    workerUrl?: string;
                                }

                                Type Parameters

                                Hierarchy

                                • Auth0ClientOptions
                                  • Auth0ProviderOptions
                                Index

                                Properties

                                auth0Client? +
                                interface Auth0ProviderOptions<TUser extends User = User> {
                                    auth0Client?: {
                                        env?: { [key: string]: string };
                                        name: string;
                                        version: string;
                                    };
                                    authorizationParams?: ClientAuthorizationParams;
                                    authorizeTimeoutInSeconds?: number;
                                    cache?: ICache;
                                    cacheLocation?: CacheLocation;
                                    children?: ReactNode;
                                    clientId: string;
                                    context?: Context<Auth0ContextInterface<TUser>>;
                                    cookieDomain?: string;
                                    domain: string;
                                    httpTimeoutInSeconds?: number;
                                    issuer?: string;
                                    leeway?: number;
                                    legacySameSiteCookie?: boolean;
                                    nowProvider?: () => number | Promise<number>;
                                    onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                                    sessionCheckExpiryDays?: number;
                                    skipRedirectCallback?: boolean;
                                    useCookiesForTransactions?: boolean;
                                    useDpop?: boolean;
                                    useFormData?: boolean;
                                    useMrrt?: boolean;
                                    useRefreshTokens?: boolean;
                                    useRefreshTokensFallback?: boolean;
                                    workerUrl?: string;
                                }

                                Type Parameters

                                Hierarchy

                                • Auth0ClientOptions
                                  • Auth0ProviderOptions
                                Index

                                Properties

                                auth0Client? authorizationParams? authorizeTimeoutInSeconds? cache? @@ -25,16 +25,16 @@ useRefreshTokensFallback? workerUrl?

                                Properties

                                auth0Client?: { env?: { [key: string]: string }; name: string; version: string }

                                Internal property to send information about the client to the authorization server.

                                -
                                authorizationParams?: ClientAuthorizationParams

                                URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                                authorizationParams?: ClientAuthorizationParams

                                URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                -
                                authorizeTimeoutInSeconds?: number

                                A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout +

                                authorizeTimeoutInSeconds?: number

                                A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout Defaults to 60s.

                                -
                                cache?: ICache

                                Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.

                                +
                                cache?: ICache

                                Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.

                                cacheLocation?: CacheLocation

                                The location to use when storing cache data. Valid values are memory or localstorage. The default setting is memory.

                                Read more about changing storage options in the Auth0 docs

                                children?: ReactNode

                                The child nodes your Provider has wrapped

                                -
                                clientId: string

                                The Client ID found on your Application settings page

                                +
                                clientId: string

                                The Client ID found on your Application settings page

                                context?: Context<Auth0ContextInterface<TUser>>

                                Context to be used when creating the Auth0Provider, defaults to the internally created context.

                                This allows multiple Auth0Providers to be nested within the same application, the context value can then be passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access @@ -48,17 +48,17 @@ used to store data is different

                                For a sample on using multiple Auth0Providers review the React Account Linking Sample

                                -
                                cookieDomain?: string

                                The domain the cookie is accessible from. If not set, the cookie is scoped to +

                                cookieDomain?: string

                                The domain the cookie is accessible from. If not set, the cookie is scoped to the current domain, including the subdomain.

                                Note: setting this incorrectly may cause silent authentication to stop working on page load.

                                To keep a user logged in across multiple subdomains set this to your top-level domain and prefixed with a . (eg: .example.com).

                                -
                                domain: string

                                Your Auth0 account domain such as 'example.auth0.com', +

                                domain: string

                                Your Auth0 account domain such as 'example.auth0.com', 'example.eu.auth0.com' or , 'example.mycompany.com' (when using custom domains)

                                httpTimeoutInSeconds?: number

                                Specify the timeout for HTTP calls using fetch. The default is 10 seconds.

                                -
                                issuer?: string

                                The issuer to be used for validation of JWTs, optionally defaults to the domain above

                                +
                                issuer?: string

                                The issuer to be used for validation of JWTs, optionally defaults to the domain above

                                leeway?: number

                                The value in seconds used to account for clock skew in JWT expirations. Typically, this value is no more than a minute or two at maximum. Defaults to 60s.

                                @@ -68,38 +68,36 @@ this to false but be aware that some older useragents will not work, See https://www.chromium.org/updates/same-site/incompatible-clients Defaults to true

                                -
                                nowProvider?: () => number | Promise<number>

                                Modify the value used as the current time during the token validation.

                                +
                                nowProvider?: () => number | Promise<number>

                                Modify the value used as the current time during the token validation.

                                Note: Using this improperly can potentially compromise the token validation.

                                -
                                onRedirectCallback?: (appState?: AppState, user?: TUser) => void

                                By default this removes the code and state parameters from the url when you are redirected from the authorize page. +

                                onRedirectCallback?: (appState?: AppState, user?: TUser) => void

                                By default this removes the code and state parameters from the url when you are redirected from the authorize page. It uses window.history but you might want to overwrite this if you are using a custom router, like react-router-dom See the EXAMPLES.md for more info.

                                -
                                sessionCheckExpiryDays?: number

                                Number of days until the cookie auth0.is.authenticated will expire +

                                sessionCheckExpiryDays?: number

                                Number of days until the cookie auth0.is.authenticated will expire Defaults to 1.

                                -
                                skipRedirectCallback?: boolean

                                By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the +

                                skipRedirectCallback?: boolean

                                By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these instances you can instruct the client to ignore them eg

                                <Auth0Provider
                                  clientId={clientId}
                                  domain={domain}
                                  skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
                                >
                                -
                                useCookiesForTransactions?: boolean

                                If true, the SDK will use a cookie when storing information about the auth transaction while +

                                useCookiesForTransactions?: boolean

                                If true, the SDK will use a cookie when storing information about the auth transaction while the user is going through the authentication flow on the authorization server.

                                The default is false, in which case the SDK will use session storage.

                                You might want to enable this if you rely on your users being able to authenticate using flows that may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.

                                -
                                useDpop?: boolean

                                If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) +

                                useDpop?: boolean

                                If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) will be used to cryptographically bind tokens to this specific browser so they can't be used from a different device in case of a leak.

                                The default setting is false.

                                -
                                useFormData?: boolean

                                If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

                                +
                                useFormData?: boolean

                                If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

                                Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this, please verify that your Auth0 Rules continue to work as intended.

                                -
                                useMrrt?: boolean

                                If true, the SDK will allow the refreshing of tokens using MRRT

                                -
                                useRefreshTokens?: boolean

                                If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the standard technique of using a hidden iframe and the authorization_code grant with prompt=none is used. +

                                useMrrt?: boolean

                                If true, the SDK will allow the refreshing of tokens using MRRT

                                +
                                useRefreshTokens?: boolean

                                If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the authorization_code grant with prompt=none is used. The default setting is false.

                                -

                                Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. -Using a Custom Domain with this set to false is the most secure and recommended approach.

                                Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.

                                -
                                useRefreshTokensFallback?: boolean

                                If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +

                                useRefreshTokensFallback?: boolean

                                If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.

                                Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). @@ -108,9 +106,9 @@ 

                                let token: string;
                                try {
                                  token = await auth0.getTokenSilently();
                                } catch (e) {
                                  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                    auth0.loginWithRedirect();
                                  }
                                }
                                -
                                workerUrl?: string

                                If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict +

                                workerUrl?: string

                                If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

                                Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.

                                -

                                Settings

                                Member Visibility

                                On This Page

                                Properties
                                +

                                Settings

                                Member Visibility

                                On This Page

                                Properties
                                diff --git a/docs/interfaces/ClientConfiguration.html b/docs/interfaces/ClientConfiguration.html deleted file mode 100644 index e22f38a2..00000000 --- a/docs/interfaces/ClientConfiguration.html +++ /dev/null @@ -1,6 +0,0 @@ -ClientConfiguration | @auth0/auth0-react
                                @auth0/auth0-react
                                  Preparing search index...

                                  Interface ClientConfiguration

                                  Configuration details exposed by the Auth0Client after initialization.

                                  -
                                  interface ClientConfiguration {
                                      clientId: string;
                                      domain: string;
                                  }
                                  Index

                                  Properties

                                  clientId -domain -

                                  Properties

                                  clientId: string

                                  The Auth0 client ID that was configured

                                  -
                                  domain: string

                                  The Auth0 domain that was configured

                                  -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 15817030..809bdde0 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,4 +1,4 @@ -GetTokenSilentlyOptions | @auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...

                                    Interface GetTokenSilentlyOptions

                                    interface GetTokenSilentlyOptions {
                                        authorizationParams?: {
                                            audience?: string;
                                            redirect_uri?: string;
                                            scope?: string;
                                            [key: string]: any;
                                        };
                                        cacheMode?: "on"
                                        | "off"
                                        | "cache-only";
                                        detailedResponse?: boolean;
                                        timeoutInSeconds?: number;
                                    }
                                    Index

                                    Properties

                                    authorizationParams? +GetTokenSilentlyOptions | @auth0/auth0-react
                                    @auth0/auth0-react
                                      Preparing search index...

                                      Interface GetTokenSilentlyOptions

                                      interface GetTokenSilentlyOptions {
                                          authorizationParams?: {
                                              audience?: string;
                                              redirect_uri?: string;
                                              scope?: string;
                                              [key: string]: any;
                                          };
                                          cacheMode?: "on"
                                          | "off"
                                          | "cache-only";
                                          detailedResponse?: boolean;
                                          timeoutInSeconds?: number;
                                      }
                                      Index

                                      Properties

                                      authorizationParams? cacheMode? detailedResponse? timeoutInSeconds? @@ -13,13 +13,13 @@ It must be whitelisted in the "Allowed Web Origins" in your Auth0 Application's settings.

                                    • Optionalscope?: string

                                      The scope that was used in the authentication request

                                      -
                                      • cacheMode?: "on" | "off" | "cache-only"

                                      When off, ignores the cache and always sends a +

                                      cacheMode?: "on" | "off" | "cache-only"

                                      When off, ignores the cache and always sends a request to Auth0. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                      -
                                      detailedResponse?: boolean

                                      If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +

                                      detailedResponse?: boolean

                                      If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned (minus refresh_token if one was issued). Otherwise, just the access token is returned.

                                      The default is false.

                                      -
                                      timeoutInSeconds?: number

                                      A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout +

                                      timeoutInSeconds?: number

                                      A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout Defaults to 60s.

                                      -

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      +

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Properties
                                      diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 13480268..47a39a89 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,8 @@ -GetTokenWithPopupOptions | @auth0/auth0-react
                                      @auth0/auth0-react
                                        Preparing search index...

                                        Interface GetTokenWithPopupOptions

                                        interface GetTokenWithPopupOptions {
                                            authorizationParams?: AuthorizationParams;
                                            cacheMode?: "on" | "off" | "cache-only";
                                        }

                                        Hierarchy (View Summary)

                                        Index

                                        Properties

                                        authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-react
                                        @auth0/auth0-react
                                          Preparing search index...

                                          Interface GetTokenWithPopupOptions

                                          interface GetTokenWithPopupOptions {
                                              authorizationParams?: AuthorizationParams;
                                              cacheMode?: "on" | "off" | "cache-only";
                                          }

                                          Hierarchy (View Summary)

                                          Index

                                          Properties

                                          authorizationParams? cacheMode?

                                          Properties

                                          authorizationParams?: AuthorizationParams

                                          URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                          cacheMode?: "on" | "off" | "cache-only"

                                          When off, ignores the cache and always sends a request to Auth0. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                          -

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          +

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index f905521b..b868b768 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,5 @@ -ICache | @auth0/auth0-react
                                          @auth0/auth0-react
                                            Preparing search index...

                                            Interface ICache

                                            interface ICache {
                                                allKeys?(): MaybePromise<string[]>;
                                                get<T = Cacheable>(key: string): MaybePromise<T | undefined>;
                                                remove(key: string): MaybePromise<void>;
                                                set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                                            }

                                            Implemented by

                                            Index

                                            Methods

                                            allKeys? +ICache | @auth0/auth0-react
                                            @auth0/auth0-react
                                              Preparing search index...

                                              Interface ICache

                                              interface ICache {
                                                  allKeys?(): MaybePromise<string[]>;
                                                  get<T = Cacheable>(key: string): MaybePromise<undefined | T>;
                                                  remove(key: string): MaybePromise<void>;
                                                  set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                                              }

                                              Implemented by

                                              Index

                                              Methods

                                              allKeys? get remove set -

                                              Methods

                                              • Returns MaybePromise<string[]>

                                              • Type Parameters

                                                Parameters

                                                • key: string

                                                Returns MaybePromise<T | undefined>

                                              • Parameters

                                                • key: string

                                                Returns MaybePromise<void>

                                              • Type Parameters

                                                Parameters

                                                • key: string
                                                • entry: T

                                                Returns MaybePromise<void>

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Methods
                                              +

                                              Methods

                                              • Returns MaybePromise<string[]>

                                              • Type Parameters

                                                Parameters

                                                • key: string

                                                Returns MaybePromise<undefined | T>

                                              • Parameters

                                                • key: string

                                                Returns MaybePromise<void>

                                              • Type Parameters

                                                Parameters

                                                • key: string
                                                • entry: T

                                                Returns MaybePromise<void>

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Methods
                                              diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 12c82815..e4f7ad7f 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,4 +1,4 @@ -IdToken | @auth0/auth0-react
                                              @auth0/auth0-react
                                                Preparing search index...

                                                Interface IdToken

                                                interface IdToken {
                                                    __raw: string;
                                                    acr?: string;
                                                    address?: string;
                                                    amr?: string[];
                                                    at_hash?: string;
                                                    aud?: string;
                                                    auth_time?: string;
                                                    azp?: string;
                                                    birthdate?: string;
                                                    c_hash?: string;
                                                    cnf?: string;
                                                    email?: string;
                                                    email_verified?: boolean;
                                                    exp?: number;
                                                    family_name?: string;
                                                    gender?: string;
                                                    given_name?: string;
                                                    iat?: number;
                                                    iss?: string;
                                                    jti?: string;
                                                    locale?: string;
                                                    middle_name?: string;
                                                    name?: string;
                                                    nbf?: number;
                                                    nickname?: string;
                                                    nonce?: string;
                                                    org_id?: string;
                                                    org_name?: string;
                                                    phone_number?: string;
                                                    phone_number_verified?: boolean;
                                                    picture?: string;
                                                    preferred_username?: string;
                                                    profile?: string;
                                                    sid?: string;
                                                    sub_jwk?: string;
                                                    updated_at?: string;
                                                    website?: string;
                                                    zoneinfo?: string;
                                                    [key: string]: any;
                                                }

                                                Indexable

                                                • [key: string]: any
                                                Index

                                                Properties

                                                __raw +IdToken | @auth0/auth0-react
                                                @auth0/auth0-react
                                                  Preparing search index...

                                                  Interface IdToken

                                                  interface IdToken {
                                                      __raw: string;
                                                      acr?: string;
                                                      address?: string;
                                                      amr?: string[];
                                                      at_hash?: string;
                                                      aud?: string;
                                                      auth_time?: string;
                                                      azp?: string;
                                                      birthdate?: string;
                                                      c_hash?: string;
                                                      cnf?: string;
                                                      email?: string;
                                                      email_verified?: boolean;
                                                      exp?: number;
                                                      family_name?: string;
                                                      gender?: string;
                                                      given_name?: string;
                                                      iat?: number;
                                                      iss?: string;
                                                      jti?: string;
                                                      locale?: string;
                                                      middle_name?: string;
                                                      name?: string;
                                                      nbf?: number;
                                                      nickname?: string;
                                                      nonce?: string;
                                                      org_id?: string;
                                                      org_name?: string;
                                                      phone_number?: string;
                                                      phone_number_verified?: boolean;
                                                      picture?: string;
                                                      preferred_username?: string;
                                                      profile?: string;
                                                      sid?: string;
                                                      sub_jwk?: string;
                                                      updated_at?: string;
                                                      website?: string;
                                                      zoneinfo?: string;
                                                      [key: string]: any;
                                                  }

                                                  Indexable

                                                  • [key: string]: any
                                                  Index

                                                  Properties

                                                  __raw acr? address? amr? @@ -36,4 +36,4 @@ updated_at? website? zoneinfo? -

                                                  Properties

                                                  __raw

                                                  __raw: string
                                                  acr?: string
                                                  address?: string
                                                  amr?: string[]
                                                  at_hash?: string
                                                  aud?: string
                                                  auth_time?: string
                                                  azp?: string
                                                  birthdate?: string
                                                  c_hash?: string
                                                  cnf?: string
                                                  email?: string
                                                  email_verified?: boolean
                                                  exp?: number
                                                  family_name?: string
                                                  gender?: string
                                                  given_name?: string
                                                  iat?: number
                                                  iss?: string
                                                  jti?: string
                                                  locale?: string
                                                  middle_name?: string
                                                  name?: string
                                                  nbf?: number
                                                  nickname?: string
                                                  nonce?: string
                                                  org_id?: string
                                                  org_name?: string
                                                  phone_number?: string
                                                  phone_number_verified?: boolean
                                                  picture?: string
                                                  preferred_username?: string
                                                  profile?: string
                                                  sid?: string
                                                  sub_jwk?: string
                                                  updated_at?: string
                                                  website?: string
                                                  zoneinfo?: string

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  +

                                                  Properties

                                                  __raw

                                                  __raw: string
                                                  acr?: string
                                                  address?: string
                                                  amr?: string[]
                                                  at_hash?: string
                                                  aud?: string
                                                  auth_time?: string
                                                  azp?: string
                                                  birthdate?: string
                                                  c_hash?: string
                                                  cnf?: string
                                                  email?: string
                                                  email_verified?: boolean
                                                  exp?: number
                                                  family_name?: string
                                                  gender?: string
                                                  given_name?: string
                                                  iat?: number
                                                  iss?: string
                                                  jti?: string
                                                  locale?: string
                                                  middle_name?: string
                                                  name?: string
                                                  nbf?: number
                                                  nickname?: string
                                                  nonce?: string
                                                  org_id?: string
                                                  org_name?: string
                                                  phone_number?: string
                                                  phone_number_verified?: boolean
                                                  picture?: string
                                                  preferred_username?: string
                                                  profile?: string
                                                  sid?: string
                                                  sub_jwk?: string
                                                  updated_at?: string
                                                  website?: string
                                                  zoneinfo?: string

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 3eb9fbd3..7f85647e 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,11 +1,11 @@ -LogoutOptions | @auth0/auth0-react
                                                  @auth0/auth0-react
                                                    Preparing search index...

                                                    Interface LogoutOptions

                                                    interface LogoutOptions {
                                                        clientId?: string | null;
                                                        logoutParams?: {
                                                            federated?: boolean;
                                                            returnTo?: string;
                                                            [key: string]: any;
                                                        };
                                                        openUrl?: false
                                                        | ((url: string) => void | Promise<void>);
                                                    }

                                                    Hierarchy

                                                    • Omit<SPALogoutOptions, "onRedirect">
                                                      • LogoutOptions
                                                    Index

                                                    Properties

                                                    clientId? +LogoutOptions | @auth0/auth0-react
                                                    @auth0/auth0-react
                                                      Preparing search index...

                                                      Interface LogoutOptions

                                                      interface LogoutOptions {
                                                          clientId?: null | string;
                                                          logoutParams?: {
                                                              federated?: boolean;
                                                              returnTo?: string;
                                                              [key: string]: any;
                                                          };
                                                          openUrl?: false
                                                          | ((url: string) => void | Promise<void>);
                                                      }

                                                      Hierarchy

                                                      • Omit<SPALogoutOptions, "onRedirect">
                                                        • LogoutOptions
                                                      Index

                                                      Properties

                                                      clientId? logoutParams? openUrl? -

                                                      Properties

                                                      clientId?: string | null

                                                      The clientId of your application.

                                                      +

                                                      Properties

                                                      clientId?: null | string

                                                      The clientId of your application.

                                                      If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

                                                      If this property is set to null, then no client ID value is sent to the logout endpoint.

                                                      Read more about how redirecting after logout works

                                                      -
                                                      logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                      Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

                                                      logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                      Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

                                                      Type Declaration

                                                      • [key: string]: any

                                                        If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                      • Optionalfederated?: boolean

                                                        When supported by the upstream identity provider, @@ -20,7 +20,7 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                                        Read more about how redirecting after logout works

                                                        -
                                                      openUrl?: false | ((url: string) => void | Promise<void>)

                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                      +
                                                      openUrl?: false | ((url: string) => void | Promise<void>)

                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                      Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.

                                                      await auth0.logout({
                                                        openUrl(url) {
                                                          window.location.replace(url);
                                                        }
                                                      });
                                                      @@ -28,4 +28,4 @@ 
                                                      import { Browser } from '@capacitor/browser';

                                                      await auth0.logout({
                                                        async openUrl(url) {
                                                          await Browser.open({ url });
                                                        }
                                                      });
                                                      -

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      +

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 14d74f8d..4161f14e 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,10 +1,10 @@ -LogoutUrlOptions | @auth0/auth0-react
                                                      @auth0/auth0-react
                                                        Preparing search index...

                                                        Interface LogoutUrlOptions

                                                        interface LogoutUrlOptions {
                                                            clientId?: string | null;
                                                            logoutParams?: {
                                                                federated?: boolean;
                                                                returnTo?: string;
                                                                [key: string]: any;
                                                            };
                                                        }
                                                        Index

                                                        Properties

                                                        clientId? +LogoutUrlOptions | @auth0/auth0-react
                                                        @auth0/auth0-react
                                                          Preparing search index...

                                                          Interface LogoutUrlOptions

                                                          interface LogoutUrlOptions {
                                                              clientId?: null | string;
                                                              logoutParams?: {
                                                                  federated?: boolean;
                                                                  returnTo?: string;
                                                                  [key: string]: any;
                                                              };
                                                          }
                                                          Index

                                                          Properties

                                                          clientId? logoutParams? -

                                                          Properties

                                                          clientId?: string | null

                                                          The clientId of your application.

                                                          +

                                                          Properties

                                                          clientId?: null | string

                                                          The clientId of your application.

                                                          If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

                                                          If this property is set to null, then no client ID value is sent to the logout endpoint.

                                                          Read more about how redirecting after logout works

                                                          -
                                                          logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                          Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

                                                          logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                          Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

                                                          Type Declaration

                                                          • [key: string]: any

                                                            If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                          • Optionalfederated?: boolean

                                                            When supported by the upstream identity provider, @@ -19,4 +19,4 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                                            Read more about how redirecting after logout works

                                                            -

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          +

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 69cdd77d..bde08bd6 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,24 +1,8 @@ -PopupConfigOptions | @auth0/auth0-react
                                                          @auth0/auth0-react
                                                            Preparing search index...

                                                            Interface PopupConfigOptions

                                                            interface PopupConfigOptions {
                                                                closePopup?: boolean;
                                                                popup?: any;
                                                                timeoutInSeconds?: number;
                                                            }
                                                            Index

                                                            Properties

                                                            closePopup? -popup? +PopupConfigOptions | @auth0/auth0-react
                                                            @auth0/auth0-react
                                                              Preparing search index...

                                                              Interface PopupConfigOptions

                                                              interface PopupConfigOptions {
                                                                  popup?: any;
                                                                  timeoutInSeconds?: number;
                                                              }
                                                              Index

                                                              Properties

                                                              popup? timeoutInSeconds? -

                                                              Properties

                                                              closePopup?: boolean

                                                              Controls whether the SDK automatically closes the popup window.

                                                              -
                                                                -
                                                              • true (default): SDK closes the popup automatically after receiving the authorization response
                                                                • -
                                                              • false: SDK does not close the popup. The caller is responsible for closing it, including on errors.
                                                                • -
                                                              -

                                                              Setting this to false is useful when you need full control over the popup lifecycle, -such as in Chrome extensions where closing the popup too early can terminate the -extension's service worker before authentication completes.

                                                              -

                                                              When closePopup: false, you should close the popup in a try/finally block:

                                                              -
                                                              const popup = window.open('', '_blank');
                                                              try {
                                                                await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                              } finally {
                                                                popup.close();
                                                              }
-
                                                              - -
                                                              true
-
                                                              - -
                                                              popup?: any

                                                              Accepts an already-created popup window to use. If not specified, the SDK +

                                                              Properties

                                                              popup?: any

                                                              Accepts an already-created popup window to use. If not specified, the SDK will create its own. This may be useful for platforms like iOS that have security restrictions around when popups can be invoked (e.g. from a user click event)

                                                              -
                                                              timeoutInSeconds?: number

                                                              The number of seconds to wait for a popup response before +

                                                              timeoutInSeconds?: number

                                                              The number of seconds to wait for a popup response before throwing a timeout error. Defaults to 60s

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              +

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 38e05944..59ea439d 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,4 @@ -PopupLoginOptions | @auth0/auth0-react
                                                              @auth0/auth0-react
                                                                Preparing search index...

                                                                Interface PopupLoginOptions

                                                                interface PopupLoginOptions {
                                                                    authorizationParams?: AuthorizationParams;
                                                                }

                                                                Hierarchy (View Summary)

                                                                Index

                                                                Properties

                                                                authorizationParams? +PopupLoginOptions | @auth0/auth0-react
                                                                @auth0/auth0-react
                                                                  Preparing search index...

                                                                  Interface PopupLoginOptions

                                                                  interface PopupLoginOptions {
                                                                      authorizationParams?: AuthorizationParams;
                                                                  }

                                                                  Hierarchy (View Summary)

                                                                  Index

                                                                  Properties

                                                                  authorizationParams?

                                                                  Properties

                                                                  authorizationParams?: AuthorizationParams

                                                                  URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index f07677ea..188a5631 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,4 +1,4 @@ -RedirectConnectAccountOptions | @auth0/auth0-react
                                                                  @auth0/auth0-react
                                                                    Preparing search index...

                                                                    Interface RedirectConnectAccountOptions<TAppState>

                                                                    interface RedirectConnectAccountOptions<TAppState = any> {
                                                                        appState?: TAppState;
                                                                        authorization_params?: AuthorizationParams;
                                                                        connection: string;
                                                                        openUrl?: (url: string) => Promise<void>;
                                                                        redirectUri?: string;
                                                                        scopes?: string[];
                                                                    }

                                                                    Type Parameters

                                                                    • TAppState = any
                                                                    Index

                                                                    Properties

                                                                    appState? +RedirectConnectAccountOptions | @auth0/auth0-react
                                                                    @auth0/auth0-react
                                                                      Preparing search index...

                                                                      Interface RedirectConnectAccountOptions<TAppState>

                                                                      interface RedirectConnectAccountOptions<TAppState = any> {
                                                                          appState?: TAppState;
                                                                          authorization_params?: AuthorizationParams;
                                                                          connection: string;
                                                                          openUrl?: (url: string) => Promise<void>;
                                                                          redirectUri?: string;
                                                                          scopes?: string[];
                                                                      }

                                                                      Type Parameters

                                                                      • TAppState = any
                                                                      Index

                                                                      Properties

                                                                      appState? authorization_params? connection openUrl? @@ -8,18 +8,18 @@ 
                                                                      await auth0.connectAccountWithRedirect({
                                                                        connection: 'google-oauth2',
                                                                        appState: { returnTo: '/settings' }
                                                                      });
                                                                      -
                                                                      authorization_params?: AuthorizationParams

                                                                      Additional authorization parameters for the request.

                                                                      +
                                                                      authorization_params?: AuthorizationParams

                                                                      Additional authorization parameters for the request.

                                                                      await auth0.connectAccountWithRedirect({
                                                                        connection: 'github',
                                                                        authorization_params: {
                                                                          audience: 'https://api.github.com'
                                                                        }
                                                                      });
                                                                      -
                                                                      connection: string

                                                                      The name of the connection to link (e.g. 'google-oauth2').

                                                                      -
                                                                      openUrl?: (url: string) => Promise<void>

                                                                      Optional function to handle the redirect URL.

                                                                      +
                                                                      connection: string

                                                                      The name of the connection to link (e.g. 'google-oauth2').

                                                                      +
                                                                      openUrl?: (url: string) => Promise<void>

                                                                      Optional function to handle the redirect URL.

                                                                      await auth0.connectAccountWithRedirect({
                                                                        connection: 'google-oauth2',
                                                                        openUrl: async (url) => { myBrowserApi.open(url); }
                                                                      });
                                                                      -
                                                                      redirectUri?: string

                                                                      The URI to redirect back to after connecting the account.

                                                                      -
                                                                      scopes?: string[]

                                                                      Array of scopes to request from the Identity Provider during the connect account flow.

                                                                      +
                                                                      redirectUri?: string

                                                                      The URI to redirect back to after connecting the account.

                                                                      +
                                                                      scopes?: string[]

                                                                      Array of scopes to request from the Identity Provider during the connect account flow.

                                                                      await auth0.connectAccountWithRedirect({
                                                                        connection: 'google-oauth2',
                                                                        scopes: ['https://www.googleapis.com/auth/calendar']
                                                                      });
                                                                      -

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      +

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 29a2b8a1..b8e0d3c2 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,16 +1,16 @@ -RedirectLoginOptions | @auth0/auth0-react
                                                                      @auth0/auth0-react
                                                                        Preparing search index...

                                                                        Interface RedirectLoginOptions<TAppState>

                                                                        interface RedirectLoginOptions<TAppState = AppState> {
                                                                            appState?: TAppState;
                                                                            authorizationParams?: AuthorizationParams;
                                                                            fragment?: string;
                                                                            openUrl?: (url: string) => void | Promise<void>;
                                                                        }

                                                                        Type Parameters

                                                                        Hierarchy

                                                                        • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                          • RedirectLoginOptions
                                                                        Index

                                                                        Properties

                                                                        appState? +RedirectLoginOptions | @auth0/auth0-react
                                                                        @auth0/auth0-react
                                                                          Preparing search index...

                                                                          Interface RedirectLoginOptions<TAppState>

                                                                          interface RedirectLoginOptions<TAppState = AppState> {
                                                                              appState?: TAppState;
                                                                              authorizationParams?: AuthorizationParams;
                                                                              fragment?: string;
                                                                              openUrl?: (url: string) => void | Promise<void>;
                                                                          }

                                                                          Type Parameters

                                                                          Hierarchy

                                                                          • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                            • RedirectLoginOptions
                                                                          Index

                                                                          Properties

                                                                          appState? authorizationParams? fragment? openUrl?

                                                                          Properties

                                                                          appState?: TAppState

                                                                          Used to store state before doing the redirect

                                                                          -
                                                                          authorizationParams?: AuthorizationParams

                                                                          URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                                                                          authorizationParams?: AuthorizationParams

                                                                          URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                                                          fragment?: string

                                                                          Used to add to the URL fragment before redirecting

                                                                          -
                                                                          openUrl?: (url: string) => void | Promise<void>

                                                                          Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                          +
                                                                          openUrl?: (url: string) => void | Promise<void>

                                                                          Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                          const client = new Auth0Client({
                                                                            openUrl(url) {
                                                                              window.location.replace(url);
                                                                            }
                                                                          });
 
                                                                          import { Browser } from '@capacitor/browser';

                                                                          const client = new Auth0Client({
                                                                            async openUrl(url) {
                                                                              await Browser.open({ url });
                                                                            }
                                                                          });
                                                                          -

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          +

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index fa57d63e..c2f45a67 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -1,3 +1,3 @@ WithAuth0Props | @auth0/auth0-react
                                                                          @auth0/auth0-react
                                                                            Preparing search index...

                                                                            Interface WithAuth0Props

                                                                            Components wrapped in withAuth0 will have an additional auth0 prop

                                                                            -
                                                                            interface WithAuth0Props {
                                                                                auth0: Auth0ContextInterface;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            auth0 -

                                                                            Properties

                                                                            auth0: Auth0ContextInterface

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            +
                                                                            interface WithAuth0Props {
                                                                                auth0: Auth0ContextInterface;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            auth0 +

                                                                            Properties

                                                                            auth0: Auth0ContextInterface

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 3145767b..be6cc116 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -1,5 +1,5 @@ WithAuthenticationRequiredOptions | @auth0/auth0-react
                                                                            @auth0/auth0-react
                                                                              Preparing search index...

                                                                              Interface WithAuthenticationRequiredOptions

                                                                              Options for the withAuthenticationRequired Higher Order Component

                                                                              -
                                                                              interface WithAuthenticationRequiredOptions {
                                                                                  context?: Context<Auth0ContextInterface<User>>;
                                                                                  loginOptions?: RedirectLoginOptions<AppState>;
                                                                                  onBeforeAuthentication?: () => Promise<void>;
                                                                                  onRedirecting?: () => Element;
                                                                                  returnTo?: string | (() => string);
                                                                              }
                                                                              Index

                                                                              Properties

                                                                              context? +
                                                                              interface WithAuthenticationRequiredOptions {
                                                                                  context?: Context<Auth0ContextInterface<User>>;
                                                                                  loginOptions?: RedirectLoginOptions<AppState>;
                                                                                  onBeforeAuthentication?: () => Promise<void>;
                                                                                  onRedirecting?: () => Element;
                                                                                  returnTo?: string | (() => string);
                                                                              }
                                                                              Index

                                                                              Properties

                                                                              context? loginOptions? onBeforeAuthentication? onRedirecting? @@ -7,20 +7,20 @@

                                                                              Properties

                                                                              context?: Context<Auth0ContextInterface<User>>

                                                                              The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers within your application and you wish to tie a specific component to a Auth0Provider other than the Auth0Provider associated with the default Auth0Context.

                                                                              -
                                                                              loginOptions?: RedirectLoginOptions<AppState>
                                                                              withAuthenticationRequired(Profile, {
                                                                                loginOptions: {
                                                                                  appState: {
                                                                                    customProp: 'foo'
                                                                                  }
                                                                                }
                                                                              })
+
                                                                              loginOptions?: RedirectLoginOptions<AppState>
                                                                              withAuthenticationRequired(Profile, {
                                                                                loginOptions: {
                                                                                  appState: {
                                                                                    customProp: 'foo'
                                                                                  }
                                                                                }
                                                                              })

                                                                              Pass additional login options, like extra appState to the login page. This will be merged with the returnTo option used by the onRedirectCallback handler.

                                                                              -
                                                                              onBeforeAuthentication?: () => Promise<void>
                                                                              withAuthenticationRequired(Profile, {
                                                                                onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                              })
+
                                                                              onBeforeAuthentication?: () => Promise<void>
                                                                              withAuthenticationRequired(Profile, {
                                                                                onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                              })

                                                                              Allows executing logic before the user is redirected to the login page.

                                                                              -
                                                                              onRedirecting?: () => Element
                                                                              withAuthenticationRequired(Profile, {
                                                                                onRedirecting: () => <div>Redirecting you to the login...</div>
                                                                              })
+
                                                                              onRedirecting?: () => Element
                                                                              withAuthenticationRequired(Profile, {
                                                                                onRedirecting: () => <div>Redirecting you to the login...</div>
                                                                              })

                                                                              Render a message to show that the user is being redirected to the login.

                                                                              -
                                                                              returnTo?: string | (() => string)
                                                                              withAuthenticationRequired(Profile, {
                                                                                returnTo: '/profile'
                                                                              })
+
                                                                              returnTo?: string | (() => string)
                                                                              withAuthenticationRequired(Profile, {
                                                                                returnTo: '/profile'
                                                                              })

                                                                              or

                                                                              @@ -28,4 +28,4 @@

                                                                              Add a path for the onRedirectCallback handler to return the user to after login.

                                                                              -

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              +

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              diff --git a/docs/modules.html b/docs/modules.html index ff2c5d41..0217d2f2 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -@auth0/auth0-react
                                                                              @auth0/auth0-react
                                                                                Preparing search index...

                                                                                  @auth0/auth0-react

                                                                                  Main

                                                                                  ClientConfiguration

                                                                                  Other

                                                                                  ResponseType
                                                                                  AuthenticationError
                                                                                  ConnectError
                                                                                  GenericError
                                                                                  InMemoryCache
                                                                                  LocalStorageCache
                                                                                  MfaRequiredError
                                                                                  MissingRefreshTokenError
                                                                                  OAuthError
                                                                                  PopupCancelledError
                                                                                  PopupTimeoutError
                                                                                  TimeoutError
                                                                                  UseDpopNonceError
                                                                                  User
                                                                                  Auth0ContextInterface
                                                                                  Auth0ProviderOptions
                                                                                  AuthorizationParams
                                                                                  GetTokenSilentlyOptions
                                                                                  GetTokenWithPopupOptions
                                                                                  ICache
                                                                                  IdToken
                                                                                  LogoutOptions
                                                                                  LogoutUrlOptions
                                                                                  PopupConfigOptions
                                                                                  PopupLoginOptions
                                                                                  RedirectConnectAccountOptions
                                                                                  RedirectLoginOptions
                                                                                  WithAuth0Props
                                                                                  WithAuthenticationRequiredOptions
                                                                                  AppState
                                                                                  Cacheable
                                                                                  CacheLocation
                                                                                  ConnectAccountRedirectResult
                                                                                  ConnectedAccount
                                                                                  CustomTokenExchangeOptions
                                                                                  FetcherConfig
                                                                                  TokenEndpointResponse
                                                                                  Auth0Context
                                                                                  Auth0Provider
                                                                                  useAuth0
                                                                                  withAuth0
                                                                                  withAuthenticationRequired

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Main
                                                                                  Other
                                                                                  +@auth0/auth0-react
                                                                                  @auth0/auth0-react
                                                                                    Preparing search index...

                                                                                      @auth0/auth0-react

                                                                                      Enumerations

                                                                                      ResponseType

                                                                                      Classes

                                                                                      AuthenticationError
                                                                                      ConnectError
                                                                                      GenericError
                                                                                      InMemoryCache
                                                                                      LocalStorageCache
                                                                                      MfaRequiredError
                                                                                      MissingRefreshTokenError
                                                                                      OAuthError
                                                                                      PopupCancelledError
                                                                                      PopupTimeoutError
                                                                                      TimeoutError
                                                                                      UseDpopNonceError
                                                                                      User

                                                                                      Interfaces

                                                                                      Auth0ContextInterface
                                                                                      Auth0ProviderOptions
                                                                                      AuthorizationParams
                                                                                      GetTokenSilentlyOptions
                                                                                      GetTokenWithPopupOptions
                                                                                      ICache
                                                                                      IdToken
                                                                                      LogoutOptions
                                                                                      LogoutUrlOptions
                                                                                      PopupConfigOptions
                                                                                      PopupLoginOptions
                                                                                      RedirectConnectAccountOptions
                                                                                      RedirectLoginOptions
                                                                                      WithAuth0Props
                                                                                      WithAuthenticationRequiredOptions

                                                                                      Type Aliases

                                                                                      AppState
                                                                                      Cacheable
                                                                                      CacheLocation
                                                                                      ConnectAccountRedirectResult
                                                                                      ConnectedAccount
                                                                                      CustomTokenExchangeOptions
                                                                                      FetcherConfig
                                                                                      TokenEndpointResponse

                                                                                      Variables

                                                                                      Auth0Context

                                                                                      Functions

                                                                                      Auth0Provider
                                                                                      useAuth0
                                                                                      withAuth0
                                                                                      withAuthenticationRequired

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Enumerations
                                                                                      Classes
                                                                                      Interfaces
                                                                                      Type Aliases
                                                                                      Variables
                                                                                      Functions
                                                                                      diff --git a/docs/types/AppState.html b/docs/types/AppState.html index f9642dce..88b8678d 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -1,6 +1,6 @@ AppState | @auth0/auth0-react
                                                                                      @auth0/auth0-react
                                                                                        Preparing search index...

                                                                                        Type Alias AppState

                                                                                        The state of the application before the user was redirected to the login page and any account that the user may have connected to.

                                                                                        -
                                                                                        type AppState = {
                                                                                            connectedAccount?: ConnectedAccount;
                                                                                            response_type?: ResponseType;
                                                                                            returnTo?: string;
                                                                                            [key: string]: any;
                                                                                        }

                                                                                        Indexable

                                                                                        • [key: string]: any
                                                                                        Index

                                                                                        Properties

                                                                                        connectedAccount? +
                                                                                        type AppState = {
                                                                                            connectedAccount?: ConnectedAccount;
                                                                                            response_type?: ResponseType;
                                                                                            returnTo?: string;
                                                                                            [key: string]: any;
                                                                                        }

                                                                                        Indexable

                                                                                        • [key: string]: any
                                                                                        Index

                                                                                        Properties

                                                                                        connectedAccount? response_type? returnTo? -

                                                                                        Properties

                                                                                        connectedAccount?: ConnectedAccount
                                                                                        response_type?: ResponseType
                                                                                        returnTo?: string

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        +

                                                                                        Properties

                                                                                        connectedAccount?: ConnectedAccount
                                                                                        response_type?: ResponseType
                                                                                        returnTo?: string

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 81cb9298..f6ec4cf9 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,2 +1,2 @@ CacheLocation | @auth0/auth0-react
                                                                                        @auth0/auth0-react
                                                                                          Preparing search index...

                                                                                          Type Alias CacheLocation

                                                                                          CacheLocation: "memory" | "localstorage"

                                                                                          The possible locations where tokens can be stored

                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          +

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 5ea6824b..26e54331 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -7,4 +7,4 @@ 
                                                                                          const result = await auth0.connectAccountWithRedirect(options);
                                                                                          console.log(result.appState); // Access persisted app state
                                                                                          console.log(result.connection);   // The connection of the account you connected to.
                                                                                          console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          +

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index 2546f8ec..b947e850 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,2 +1,2 @@ ConnectedAccount | @auth0/auth0-react
                                                                                          @auth0/auth0-react
                                                                                            Preparing search index...

                                                                                            Type Alias ConnectedAccount

                                                                                            ConnectedAccount: Omit<
                                                                                                ConnectAccountRedirectResult,
                                                                                                "appState"
                                                                                                | "response_type",
                                                                                            >

                                                                                            The account that has been connected during the connect flow.

                                                                                            -

                                                                                            Settings

                                                                                            Member Visibility
                                                                                            +

                                                                                            Settings

                                                                                            Member Visibility
                                                                                            diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index d5863864..5f3d5144 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,7 +1,7 @@ -TokenEndpointResponse | @auth0/auth0-react
                                                                                            @auth0/auth0-react
                                                                                              Preparing search index...

                                                                                              Type Alias TokenEndpointResponse

                                                                                              type TokenEndpointResponse = {
                                                                                                  access_token: string;
                                                                                                  expires_in: number;
                                                                                                  id_token: string;
                                                                                                  refresh_token?: string;
                                                                                                  scope?: string;
                                                                                                  token_type: string;
                                                                                              }
                                                                                              Index

                                                                                              Properties

                                                                                              access_token +TokenEndpointResponse | @auth0/auth0-react
                                                                                              @auth0/auth0-react
                                                                                                Preparing search index...

                                                                                                Type Alias TokenEndpointResponse

                                                                                                type TokenEndpointResponse = {
                                                                                                    access_token: string;
                                                                                                    expires_in: number;
                                                                                                    id_token: string;
                                                                                                    refresh_token?: string;
                                                                                                    scope?: string;
                                                                                                    token_type: string;
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                access_token expires_in id_token refresh_token? scope? token_type -

                                                                                                Properties

                                                                                                access_token: string
                                                                                                expires_in: number
                                                                                                id_token: string
                                                                                                refresh_token?: string
                                                                                                scope?: string
                                                                                                token_type: string

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                +

                                                                                                Properties

                                                                                                access_token: string
                                                                                                expires_in: number
                                                                                                id_token: string
                                                                                                refresh_token?: string
                                                                                                scope?: string
                                                                                                token_type: string

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 50d31890..956d966f 100644 --- a/docs/variables/Auth0Context.html +++ b/docs/variables/Auth0Context.html @@ -1,2 +1,2 @@ Auth0Context | @auth0/auth0-react
                                                                                                @auth0/auth0-react
                                                                                                  Preparing search index...

                                                                                                  Variable Auth0ContextConst

                                                                                                  Auth0Context: Context<Auth0ContextInterface<User>> = ...

                                                                                                  The Auth0 Context

                                                                                                  -

                                                                                                  Settings

                                                                                                  Member Visibility
                                                                                                  +

                                                                                                  Settings

                                                                                                  Member Visibility
                                                                                                  diff --git a/package-lock.json b/package-lock.json index d12a9310..2b158a36 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.11.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.11.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.12.0" diff --git a/package.json b/package.json index 53d5a11a..2349431a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.12.0", + "version": "2.11.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",