From 762f2cfe515ff9e10cdb634d25653f8ad1d13d8b Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 10 Oct 2025 12:26:28 +0100 Subject: [PATCH] Release v2.6.0 --- .version | 2 +- CHANGELOG.md | 10 ++++ FAQ.md | 2 +- README.md | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/Auth0Client.html | 43 ++++++++++------- docs/classes/AuthenticationError.html | 4 +- docs/classes/CacheKey.html | 10 ++-- docs/classes/ConnectError.html | 10 ++++ docs/classes/GenericError.html | 4 +- docs/classes/InMemoryCache.html | 4 +- docs/classes/LocalStorageCache.html | 4 +- docs/classes/MfaRequiredError.html | 4 +- docs/classes/MissingRefreshTokenError.html | 4 +- docs/classes/MyAccountApiError.html | 7 +++ docs/classes/PopupCancelledError.html | 4 +- docs/classes/PopupTimeoutError.html | 4 +- docs/classes/TimeoutError.html | 4 +- docs/classes/UseDpopNonceError.html | 4 +- docs/classes/User.html | 4 +- docs/enums/ResponseType.html | 8 ++++ docs/functions/createAuth0Client.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- docs/interfaces/Auth0ClientOptions.html | 48 +++++++++---------- docs/interfaces/AuthorizationParams.html | 30 ++++++------ docs/interfaces/DecodedToken.html | 4 +- docs/interfaces/GetTokenSilentlyOptions.html | 10 ++-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +-- docs/interfaces/ICache.html | 4 +- docs/interfaces/IdToken.html | 4 +- docs/interfaces/LogoutOptions.html | 10 ++-- docs/interfaces/LogoutUrlOptions.html | 6 +-- docs/interfaces/PopupConfigOptions.html | 6 +-- docs/interfaces/PopupLoginOptions.html | 4 +- .../RedirectConnectAccountOptions.html | 22 +++++++++ docs/interfaces/RedirectLoginOptions.html | 12 ++--- docs/interfaces/RedirectLoginResult.html | 6 ++- docs/modules.html | 9 +++- docs/types/CacheEntry.html | 2 +- docs/types/CacheKeyData.html | 2 +- docs/types/CacheLocation.html | 2 +- docs/types/Cacheable.html | 2 +- docs/types/ConnectAccountRedirectResult.html | 9 ++++ docs/types/FetcherConfig.html | 2 +- .../GetTokenSilentlyVerboseResponse.html | 2 +- docs/types/KeyManifestEntry.html | 2 +- docs/types/MaybePromise.html | 2 +- docs/types/TokenEndpointResponse.html | 2 +- docs/types/WrappedCacheEntry.html | 2 +- package-lock.json | 4 +- package.json | 2 +- src/version.ts | 2 +- 54 files changed, 224 insertions(+), 144 deletions(-) create mode 100644 docs/classes/ConnectError.html create mode 100644 docs/classes/MyAccountApiError.html create mode 100644 docs/enums/ResponseType.html create mode 100644 docs/interfaces/RedirectConnectAccountOptions.html create mode 100644 docs/types/ConnectAccountRedirectResult.html diff --git a/.version b/.version index d80b4a814..7433fb30c 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.5.0 \ No newline at end of file +v2.6.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 06167fb0a..83ebaa5e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [v2.6.0](https://github.com/auth0/auth0-spa-js/tree/v2.6.0) (2025-10-10) +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.5.0...v2.6.0) + +**Added** +- Add support for connected accounts [\#1422](https://github.com/auth0/auth0-spa-js/pull/1422) ([adamjmcgrath](https://github.com/adamjmcgrath)) + +**Fixed** +- Fetcher should set DPoP nonce with nonce id [\#1431](https://github.com/auth0/auth0-spa-js/pull/1431) ([adamjmcgrath](https://github.com/adamjmcgrath)) +- fix: do not mark setAuthorizationHeader as async [\#1428](https://github.com/auth0/auth0-spa-js/pull/1428) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.5.0](https://github.com/auth0/auth0-spa-js/tree/v2.5.0) (2025-10-01) [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.4.1...v2.5.0) diff --git a/FAQ.md b/FAQ.md index 0d4d373cc..99adcfd40 100644 --- a/FAQ.md +++ b/FAQ.md @@ -124,7 +124,7 @@ If you want to use a CDN bundle together with import maps, you will need to use diff --git a/README.md b/README.md index 67b547ac5..fc78bbe97 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ npm install @auth0/auth0-spa-js From the CDN: ```html - + ``` ### Configure Auth0 diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index b19bebb7b..a43a94301 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE43WyW7bMBAG4HfR2WgSI0lb3wo7CYzYreFsh6IHmhpJRGiSJUdA1SLvXliOEYkihzrPz4+LuOjnvwzhD2az7FuN1flcClCYTTLDsMpmGZfMOXBnneKnCvcym2SvQuXZ7GL65W3SM0Ch4AyFVjfWahu2vBBlzhmv4B6aIXSqUK3vQIEVPDKUbpVSlmoNe22btsch0ytTzkpzJh9QW1ZCxBpEKG9dsC38roWFPDJDP0Fqwjmhyi0UFlz1qF8h9gljSUrfaFObOVMcpIwONxBKmo9iD7pGSuxGKI+mxipPDhZGm+9acYhQg0jCCxNkq86R/WEOJ819GEIh2ILx/sl+j/XR6dW1h2or/rZHd8Ms28dVL0exC+A6h7zdSEGvG6CgO8A28yAkKJQNNfNIdgz/IrBqN9YY3w9THSy9W6HDLQO3gdeYWMBleu1WutQ1uVd6iTT1ZGVa+whR4PFe0KoQJUUOY0l0pUuhkmY3RZFbyIUFjkk1FBwNb8HVEtPuMUex7Z66UWg7zys25vS4thWv/fnXzxdX08ADvWDIgsp7bZRzeP4OixGETsVREttJCCqHQkq4BeQV2ONW8pVeMSX5t8wz2J12sAVntHKDESbiqd7uoVkzJQpwGPyqfj3lrVmzg43VezEcareWco6/CCo3WiiMzT0YSskvlhkDeXwjDwIpkVtgCMHf4aJWvD2qZ4NQX72+fPv1H3EybvdbCwAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE43XUW/aMBAH8O+SZzTaau023hB0FSpsiNL2YdqDcS7EamJ79kVaNvW7TwQYiWOf83x//xw7zmF+/E0QfmMySTZgtZIWtrWGZJRohnkySUBWpR23ax9yLItklLwJmSaTz++j/8K0wvxqVgiQeAF4wawFO24Vu8L1jWuARMEZCiXvjVHGbzkhypwxnsMj1H3oXCFHKymBY+BR2lVKeQAJRvCA0q5SykKuoFSmbp67z3TKlLNUnBVPqAzbQ8DqRShvlbEN/KqEgTSwQjdBasJaIfcbyAzYfKveIHQQQklSr6ecq0riVIsQ60Yob610pWdMciiK4PI9oai5FSWoKnTwehHKo6mhyrOFuVb6m5IcAlQvEvH8BDmq1Ui+68P3by+GkAgmY7zbb06xLnpze+egyog/TUNZM8PKsOrkKHYOXKWQNgfT67UDFPQA2GSeRAESi5paeSA7hH8VmDcHa4jvhqkJFk6XaXELT3dxBhMbuIjv3VLtVUWelU4iTj2bIq5dQhR47AtKZmJPkf1YFF2qvZBRs52iyA2kwgDH08/dqT1SPDliyFTRBfiCg+EN2KrAuHvMUWxzfO8lmtb9Amt9vl00FWf81ZdP17c3nhvKnCHzKqfaIOfwy33YDC90Lg6S2K4Ar3IoRIXOiz9vqrvvJ5TIxub5CshzMMevw4U7xZjkNs4XMDtl4Xz5de1IPDbbI9QrJkUGFr2nx63HvBWrd7A2qhT9R23XYs7xFiVTrcThVfjX7g3F5FfDtIY0/MH0AjGRG2AI3v8dWSV50xLGvVBXvfv4/vMfXpqJPwYNAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index c206b946a..f848064a8 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE8VdXZPjtrH9L5pXeUyA3/uWWsepLcf3urx28jDlUnEkzAwzEqmQ1M6OXf7vKYKk1Gh2gyClVJ48XjXQDZzuBvqABP9YVeVbvfrw8MfqNS92qw9RsF4V2UGtPqy2lcoa9ZdT8+J93OeqaFbr1anarz6snk7FtsnLov52JHP/0hz2q/Vqu8/qWtWrD6vVn+uhcyGTc+9Uv32jb137C4W8WFsWdVOdtk1ZTfZ3ZwqDvterY1a1JpkGXlRKL7iMYV8+58U/8+blp/J4Ok6rHckv1vysml9r5TDSi+A1uj7tfilfVfFxn+WH2kkpbnH9HP+sdnmlttPeckc1Waz/JSt2ezX09DHb7x+z7eu0EWy7xZZsX9T29bOq67wsHFzclL4GfY3k53yvimb/7oQ+bnG19hlBRjVZrD+vWyFVNPk2a9RuWvu4wTWeX57c3L2TW6xJfd2+ZMWz0vM2rRCLL9a7adtVzXfH0gFXU/iis6l33+T1N8eqbNS2m/KZHtZ2+X9lsVVOzgWlF4+8nqW1vpHWZ1WoKmtU29lPVVk+uQx43GR5BtO7he9Vs31xWbuw+By9cKvxt3YM+favVUXsDeCP1s2GMZKnqjz8lL3vy2ycE0Y93pnS9DAMI+dvccZKXfY4jFLhycs2ULlN290gd6WmzU7V2yo/NtQqx2hFbeZZgPakferOy4L2F0LmNm7Ddcx6T5/48uJFVTmR+PBIlu2bSZNc98+8CQbwdZM1dBoktQ/iV+vNjsfP81SDFldrpwOLVT2Or+UOMDPs7Dax0XeFfSAof8kPqjw1dDTCH28ThqMeF8WfYfT8wBsb4RJxjFIHpxvrm+dtzpqtbsZYsci/OIuAY+niwOpdI4nbuBjd7SI/G49hvrMx5rh4nE29Af6RrN0YzUdr1eask3Z1Ruc8f59ng9XpbfYs8nyrbdj9P2bFVu33amcJAFPmhiFAdLw8CNBIFoYBZZJzILAmuIYCpd0hGNz0WsKB0rsgIGbYMR0SrE3Lg4K3D4TFj0/Zz+rfp7ziYgIL3CYgyF4XRcNoAPNDgTbGJQ4syg0nODxlm4Zkm2jdUP46zXQY0FrnxcAsC6wBYLFmkffbLIOun9d1Xjz/rJ4qVb9odo8JAUbwRqFg631ZSHADWxAaVuOcQmTaGLNIPe1yRdGEdlNAs9vYUW/L41wjhja3sYAJXasFM0N4iUX2UJ62bllIO1gKQvvXWp0ZZDqmRxK3CWa620VRPB7D/PBlzHGJW5t6wykK9cZz+4wBqM2VFtCBwqieFyHzbLCGhs2eRTFhs02G0dm0Tx+z7csFmrxoVPWUbVX9bfeLu+fXqpno5q4ToQHtDeFPpqY6f17ceaUO5ZepObg7Sy1Rke33P6j3ekrHRcxRCcxrfy+32f5zU1bZszJRHbxsJHGTJ0roXp3yyNhkB+ea0GtzMmd9z+76bH7nrA+54ITKCVd01oq9ckLtlHfa9EJH/VT8qA5l9U47qfHrTRx03KOTc5pmcqm92O7LWu1cx3KHG8zTLb00FuFl2Pr37HF/Ud28H1X97fnf7fkbLATfqW25UzvzsQeQpuDv9gfb4PRszaekbP3dbe3PRxkGMupO8Dkwq7KT7UEwRhU5+X8tmuqdmn39g3WmojD0LwBsNm1je093ZyHacGARM0P5DnENNj33QHpK4X1vGqNXd+M+wntD/krd2Xar6nrOuFGLK/Wrr8e8UvUmd9RuyF+pe0eFtVU7anHt3OOK3T7vU4W6s16zQrcqtRfmzhq3+rGbTb5z0wrFr9RcdYXvHAfHTa60oMxOTVd4f3af93Gj+VbglPzPKjse+8WVysyj369N0HSHU3l6bCYzsY/lzm0Iw6T2DRzVuiWuvzSzTICtFtuBgf1Bvf+YFfmTqhsKV/zztbCS/U2hOrKRmdZXuOee1nf/att0j1pOTuWP2fuj+qkqD3mNhw1/cn57QcP4gxo/DT38MI89m+zp7iJlSRitgEULkSF4ZYaws07X8sTU51KZEMqIpejTmIFEqi5iy/TQNLipxGF1tWhgCX9Tidu+waLnWKmn/OuElrPQwtk6PU3rOAstc+2mnA6fQWaGBqLu+UG9f5c1GbXU9z/dpPaBfTlVP4NdC/ajhC7HHenQcuGelFLsFjcOWkfJYEKxc1agdWNn6R9Z/1gWT/kzssH47Vp3GXc25S+macz0PavmL7oapEooVuf9qJmDCRNAPma1+rXaO5twkb9e91Mr66x5kL5e7244wxj5L6/dbLPIBkiMtU/nllX+u34496esymg+ixBzp8l2eX3cZ+9z+r27tKGHSNnNrn7l4UgesLDaz02uVn7Ivm6yZ/L4hdV+aXO1+lO+2be8tZqF6p3R7GojBp5t85IX83DALa82pd5WaokhZrurzdDvrc63wmh2tRHZttp8yfanmb5hNLsBIHDX4AaFbeswZ/x4s+Q0+qkd0wwDtmVRqK1xYu5igtHsaiPK6jkreslZZqCG12eJ4kvezDfDaHa1EVX/FvfmVOWzzEANlxiCl+X+Vcf/149GsDFqSs1YlMtDlrNTTfR6d27BDw6ZzCFd1yf6JItTfW5xrepRueCgfLJkcFe/V+qN3whRys8trh55W9e0Z9i2CCOHjxrexJDZBtxA8alW8CG6ORF1R7S9tTnf4wsnFpj1/YzLJybMy/pcpfoXTD4Vn9W2LHazps3WybUGvjTN8RrbmPa3mDd8243jTF2aLTDCyiHMM+B+glkgusjoV/ONhyXb/1xl0H3fxRKrJirxL6qqZ+ZFwr5LL/8FE1Xx5Urzuh5uY9rt3a01r//zG3GdnXqk7BL8nG3fP2cH9Tlv1MeyfM1nGc60v8Fq0PVVf19Wv1RZUWfbufu+O1sn1xpYdxcMfWwvG/prewb6/l1GP/LJWcf2cPWOQo/5u9kbWtTuBhB+X1YH49zADTTQ7FojivLtp6r8ku/mbbDNZv+D5QcYMCQBOScJwAEwU/NWVq+qghyzg12w0Q0c5MeqmrUtuDS5gXLj9iU35aM7mK7bTDqwzLZtpNnc7VUBq5Hk2d+oSAJHSsNvzg+eDtfC/b2l7iylPCXnXsyPrjdx6Xn6ihPSeO4MpcqeD8ymlzcBtLrehLIY3RzoZITRbpEZrtnPxYap3TfZBxgCNzlHVTC5z2LVudH/alo6A6aXBHpWevOvy0qWALoiL01MHZtDflb1aT/t4J3YfyGDgI5nJpDecnqM+rX9qSQ5EpoxPjesaQ1XAT0emWUGuiPbqSkwpNznoHFgS5j+74i2NOTEMLhzWeN6DAcbXC7IYBTDif4burXUMtuM6Iw3RNpNw4/ljowrW+93sCU9YG4c10WA1aipOJhnnuvyMNekqRWU648a3cJzooUm3zsdI82wf9YzWzew3344ezvDbWe3S22fPNq9nfkumdg6DOd0PDNJ7FST5Xu1+1nVx7Ko588v0cFSw6icfb7q2SFpY9kbZ22y+xlpezSU2+Rt2qxrNjAOBkOo/q4vqf612lsgwjJzXrnkD3DJXqePb0cG8w/tlKeGR4BWj1rNNsF1kZzWPrUsjnowTGcfndzpW6NnAELYdA+7WWDd5CtkzakqfimvsxH0chMTx0EzGTGzw8VOiYw7deFCTFuXeqqd/bCcAJnNryI+KEsmGA9u8DOT1HSGsmVkJyPc0pVbrlpizBXuMD9r3Thl3Sxf/VeS1a0ylWOaQhx5dwNVsTuWedGM9okdV07KXPsKBN/p1KsQtMnz7hCY1D59nQDdxcKbBabtcbhkYIlFlvsGpm1yunpgiVW2t8SnzXJ7YXyJXeztCNNGOVyUsMQi6j2taWPshb2jHcbVXPxlLJ/m3sOy2VTZ21RPd4MUPYRP9rtXuKeXDA3W55MmFDznX1SxcVJjiC5S9pQd8v27mzZTdpG6Q77b7ZWbOlN2GVb59tUNr4vgIkXtK7OqqtRu016446SSbLJQefmU7100DnLL1OTb5lQ5qDnLLVLzph7rnD5+MtRc5BapUYcsJ0sBQ8kgtVzF5ouq8qec3mOOdUHxZdlDFcwTP2bmGMQWKXnMq+ZlxxwSGnqg5CJVv5eFyosnchNsaAKCixR1r7lNqjmLLYuhl7JQm+J0eHTACAlfrdDdFblWi0zIdrtK1fSdkFDpRW6RmtOxdbPdJqNv0DQuRYOii5TlDuPJl48lO01j1MksS0xfydNWMxt95Q9Yp1bdx6fpBfeR/6rc1Nw7IJwvh/ZfDXmOZ3TfySyD9vfpue9kls19yZyFmbNvvXN40jmbl0177OTgohfJZaqazUtWv0wrOsstUrN107K9Skm2nc74ncyy7g8O3R8Wd1+fHjf/eiNfSTJUXOSWIVFMp45OZtko8um8WluuqpvovqyeNw4azmKLlTgVGEDQWZF5fTx5n7j9kvgZl7LPu4edv3odzsW4e+sM2PolyvBx7w4FuE0HVX2PlbjU3TYtVNE91uJSbltxwLU2gcVUlW3r31JijzXNKK7tOs3KmlJkr6mtvaOCmuh9opS29Y7r6HHvUxW0rXezfB73bS+cJ3selyqMiunqxBrjZrFMxLe9TLb1Pa6Rx91PV8c2DaPSeKxgsii29Y8q4nHvE7Ww1fepQpgIAJcS2FWPi1PNq3xtmnHZO9Y1VfDaeieq3bEChzrXpqM+PVo673516hUfHOInvv6hqseyfYGdPEKckKa2I7+tV3mxU19XH/44v9D7YSXv/ft0tV495Wq/q1cfHoa9w7Y86FdPfut/+4dqdyOtRCfyrbdaP3jrUN4Hv/22fhjk9T/rf9BCYrV+EOsgvpepNMSEISZX6we59r37QCaGmDTE/NX6wR+r9A2hYLV+CMZCgSEUrtYP4VgoNISi1fohGgtFhlC8Wj/EY6HYEEpW64dkLJQYQulq/ZCOhVJzQtv5FcS8CzTxeuYFIWfOvGhnWEhCzpx60U6yICZfmLMv2nkWxPwLEwDRTrUgIBAmBqKdbUGgIEwYRDvhggBCmEiIds4FgYUwwRDttAsCDmHiIdtpl97aD++90JSUJiJSsE6OgkFHgyC7NEGR7dxLSUqasMh29iUBnzRhkSE/HBMYGbHDMZGRLQCS8AhpIiNbAGS4Dvz7VMampImNTPkJMtHxPXaCfBMdX6ND+JlvguNLdoJ8lKx8boJ8Exs/YIfjm+j4IT8cEx1fo0OEg2+C48f8cEx4/IQdjomOr9FJKBx9E53AYwcemOgEgh14YOITaHyIuA1MdAKfHXiA1pOAG3hgohOE7MADE50g4gdu4hPE/MBNfIIWBZ9YGAITniDlB27CE3rcwEMTnbCFwCfWmtDEJuQTW2iiE/KJLTTRCVsMfGL9CtGCzye20AQnZBNbaGITtgD4/tqP72M/MiVNbEKNTbD2o3vfC01JE52QT22hiU7Ep7bIhCfS8BBLbWTCE/GpLTLhidjUFpnoRBodag9lohOF7LAjtCeL+GGb8EQaHiIFRiY4kQYnoTapkQlO1CLgp6SkCU7cIhB4lGRsghO3GATkFjk24YlbDALC02MTnJgFJzbBiQN24LEJTxyyA49NeOKIHzjaN8f8wE2A4haFgNi7xCY8ccoO3EQn0egQO5LExCbR2BCBk5jIJBqZiBpKYmKTtAgEhE8mJjSJLmJIaBITmqSd/4BY7xITmKSd/dBby/TeC8xklZjAJO3shyQwCapq2vkPJSlpQpO0AIQ+KWlik7YQhAElmZropIKd9dTEJ5Vsok5NfFKfTdSpiVDawhASvpGa+KS60qStNBFKNUKEb6QmPqnGh6hgUhOdNGERT1HhqdGhSk9ce7YIRGTxiapPr0UgospPD9WfnmTN7H6Dsi0GEVWseqgK9VoUIqpc9VAd6rUoRFTB6qFK1NN8AFWyeqgW9VokIqpo9VA16rG76u4nKNqCEcVrP70PvBjJIqA0GUD7sRgRBYKNDoHJAk0KRFT1jOkCTQtEVP2MCQNNDMSUU2HKQFMDMclpIKgEn+0EJg4Ev40TmDwQ/EZOYAJBWPBCJILQVEFMsjAILc0VMCOTmNppMYmpIEA8gtBsQUwFAeIRhOYLYioIEJMgNF8QU0GAmAShCYM4JhFAZILQpEFMeSCiE4QmDWLKAxGdIDRpkFAeiOgEoUmDhPJARCcITRskFKKIUBCaNkhIZg1TcC0WCYUSYhSE5g0SCiXEKAjNGzAejTgFobkDJlIQryA0e5BQ6CNeQWj6IKGYO0QsCE0fJBT2iFgQmj5IyA2rQNSC0ARCSqGPqAWhKYSUQh+RC0JTCCmFfoDp0oDPEohfEJpFSClPQfyC0CxCSu6iBGIYhOYRUspXEMMgNJOQUpgijkFoJiGlMEUcg9BUQkphikgGocmElIpnRDMITSbQpw6IZxCaTWDSKWIahGYUhOdRBI8IMb2t+W2PchbENwhNKwiP8hbEOAjNK3DmIrQ0syA8yl0Q6SA0tSA8KrMg1kFE3fkD5S6IdhCaXhAeyd0jxDS/IDzKYRD1IDTDIDzKYxD5IDTJwMwWIiBE1OFFuVeETyQ0XuQZDKIghKYaBHkMg1gIobkGZhFEPITQbAMT3oiJEJpvEOQJD6IihCYcaAZeIDJCaNJBkAdCiI8QmnYQgjYXcRIitmCGWAmhuQchQrpjhFps2RLG+Cwp5rFA5ITQJIQgT6gQPyE6goKZXwRb0sFGRQRiKYRmIxhrEVMhkg428vwLwZZ0sNGLKOIrhGYlaO5bIMZCaGZCSCp+EGkhNDUhJJ3LEW8hEgtqiLkQCV8cC8RdCM1QMJsJxF6I1FJ4If5CpJbCCzEYIpUWMBCJITRVISQV8ojFEJqtENTBoEBEhkhDCxaIyxCpZUuP+AyheQtBnRAKRGkITVwwuyVEaghNXghJZwfEbEjNX9D+IBG3ITWDISTJ6UhEb0ivO1+PaWF0nOt1wBHRKRHBITWNwSRViTgOqZkMbnToWNeL+KQqEdEhO6KDxEMiqkNqPoPBQyKyQ2pCg7MYYdc9EsHggdgO2T0XweCB6A7ZPxxBbAok4juk4DeSEjEeUvMaNMMqEechNbNBc6wSsR6yYz1IllUi1kNqZoPmJSViPaRmNmhOViLWQ2pmg06AEj86obkNQZ1ZSvzshKY2BHXGKEdPT0h+my7xAxSye6yFnl/8DIVmOIRPTzB+kEKTHMKnZw0/S6FZDuHTsYGfp9BEh/Bp7PBDFZrrED7t7/i5Ck13CPpISCIuRPodeuSSJBEdIjXpIeiDIYkYEal5D0GfDUlEikhNfYiARhDxItLvnk6iEUTUiNT0hwhoBBE3IjX/IQIaQUSOSE2BCPrsQiJ+RGoWRAQ0gogikZoIEfTJkUQsidRMiAhoBBFNIjUZIkIqWBFPIjUbIkIqWBFRIjUd0j4GSYjiJ5g0diH5DBNCLugeLqOeOUJMidRsiKAOciQiSqSmQ0RI7PQlYkqk5kMEdZgjEVUiNSEiqPMcibgSqRkRQR3USESWSE2JCOqoRiK2RHZsCXVWIxFbIjUjIqgDGInIEtmRJdQJjERUieyoEuoIRiKqRHZUCXUGIxFVIjUdIqhDGImYEtkxJRGFFmJKpKZDmPBCVImM2OdnJKJKZE+V0GsWIktkR5YwaxaiS2RHlzBrFiJMZBRY1izEmMiOMWHWLMSZyI4zYdYsxJrIjjVh1izEm8gosaxZiDiRUWpZsxBzIjvmhFmzEHciY2FZsxB5IjvyhFmzEH0iO/qEWbMQfSLjwLJmIf5EdvwJs2Yh/kTGkWXNQgSKjGPLmoUYFNkxKExQIQ5FxqllzUIkiuxIFOq8UiISRSZdwqRya8+h6Ofnv6iqUbtP3XP0Dw/D3Tp/rDb9s/XtHlV32T5m3+5NP/zx55+Xp+nb/2s7H67kujQMvUu7JGoF16s06f7bHoR3f4j+F9H1vF61LHX/R9z/EQX9H/H5j6FV0nfY1rT9H+HwR9r/IXzO5vZdgqrZ6Y+egBEHF8NFwLQ1b7YCo/bBqM8WRGwvlaE5gnMdSr7V+ZO8l8ZJCMz2WbuH11HgeBOg1R+MjhOui/3+Vb0bXQTA7rgHMo659gc0aAkHzYGVHY919/GBS1MJhiwH1xr0twwk09XwIjkwIkyhER7Xsr2OAbaCeAUsXuebpi9NfeAng6On56AYhiCGEPAHh0+5ANSfRdv2XxQEJgKnGOKKt/PcRTlcTXrpKfVgWNjM6G8DgPMEPSxgcTk1L6po8u6bO6qqSsNRpA87sfRxvvn42F9teekjjsEg5DCp0dl3hvlOhslKhn9J2RgePnrZX9KdF/VwSTeYPDABgnev381EdLk/rR0xF0+PWa3aV6ngMGEKk1xIgRcTYTaA0+wHQzZgOyl370YCBIGUckhvxwEYeTAAOffqPw4LJhZmPXaKdLPscW80DUDTxKpQFU1lDDIAg0xCW9NXZTSMIDDeVMud/kgcgBVGs7C23p+/agXmyljYzs7PgtT2c9B3mwOcJLQhOacl1pj283/9pwCN1QpMINd0n+Vm9AYgehPOIbsEpu9eAF4JsE653NG1NBtGMGEMW4r2cafuj2DYkaTnjQjrg8WT6fABdHh2/sDX38HsRXCtZzXCSxdAHgV6hw1K/98eTr/fgvn9oIZRhv0mK+zlol4uHv47TIs3zEbEpbruY4zDN8bBtHhwaBEblpXKGsWseSCTsOp1+yfVbF+UuRuBiZrzzJ3alju1G23+AmB70s8tu2APn06ozi/EwigDILVnXEwXeX3cZ0aCiaH9kvOM8bynMKzZnUy7VdbXCplBEkPMJOfK/W0BcKmBOd8fnDDmQMN3AcCe4EbMH9w65uZeFdt9WavdaDkJQFAmrB3th3Why0KwQm6fMN7PGIVVb3IfQcO6G/QRN2TrsJcLe7mInexW22an6m2VH3H6gN4lh1jvNfl9/RT0cAT9Bmgoy6JeLmLH+XX7khXPahQdwodJi22NtkDQ1MDS6nx3Lkj6AMx0qA/ZoO77yIxUAnclwuMcwri7BQ4YbqXksJWKuFGAW8ZhKoCbQG8IEsHa0uY0IzjhDondN/epcKs/qGU0h84tWa3nDzsCyw3AYy6nPFXlgd5lRTCtsOtq2x7vsuCQPc5R24bH7H1fZsaES5iUBq/pg2LILH4fFEEfFEEfjmEvF3GDHa4aganLCEZ/SF2WHjonOZbHY1WW5qYC7la4CdM95NtRPhIpXHPYxgbGPmgT9ZMQcznpWTUdbTJKDTH0FMkPvTkvQGaSgPmXb5x3K/Z4XwnaW5rrxnV/P4WxdoI049icqK8FdDzBVhW4py/dRRnkLiKCpAZb4gw9vuXNS//NPbi4wVBy7YEcHsSY3YM/q+ZUmxECsjjbCtzQBfMvDK1hoZNscL5kxW6vhm+ybbP9/jHbvhp+CmgurpOmOVqZABhlbJ2bm8uQgEtZe+THtBrtZ3xgccSZfPmSAQgJsDkZOBDJsqFDD5uX3FwDErh6+Oxox1vp9ikKgB3neXlxUIeyeh9v5IC3sUxmXnzJm1GZnMAttM9FdF4Dugot2UaZzrY3wwPS5ZKl1/K6PpnRkcIZZjdI+i5TqA0ypwG3Qr6q90NW5E+qbsaLMxykx9mLiWLI9bbvuNGt9kq9mWVNCpMH6/979Zxt3+vsoNorz7oS00xmsJuQc4vhxiu4SMP5GshYya50uoe6KavsWY1dE8wBu8zv2y/IjsMJMjg+O31tWzKbg+FPNq7OH4YC8IFswrcvT2byMnaQ1mbkugG5Y95ldPsx4SvgGYFIh8MNj8e+7edU7UlT4PSnXDo9ZF832bMBeQJXUcmllEP2/qiOVXnIzXU8gl7rcTn48JSN0zg8vGMXm8NTVql/n/KqrT/QphCm4YCbNONWSZjD4ao17KFlxI4gr+u8eO6/zqLHMrYHOFPIdTQyxIPzHw6F2LnoZmkmfYE1TJvGEQSrXr2R+1Qfhg/b+Hx9JpxImH4Glk6yxT+xQ46h4RyORfl2rMovOS5RPLgisuVr2S6I3d60+3oM2E0A9exBSllQKUcYx7ED0yjZMGi/6IZOQ4RRIMTnA2LWkP7qXriThkV4yEX+5TJe2BROPbvmlNVzVvTHVkbmgBWdz7U2b1CE6xa0e6haZcyNnLkYEXYIRzPww5I96z3fbQqdGSb0gfCSETs2vIjBBWE4rQ56UNt3MyzdbLNiq/Z7Is9JsC1n6c+uD02RUMuDyR1bO9GrLNkHxJtlIHUffZUxHgrowmeRJu7OhRhBv5GD37CcX9tb/tVYs+BcsKv++WJdqBp6mDwfJLAe1rI4RsaIYYUlObcyP70NAg62HuhXkXBr9tANDyjc/bDUttFNperTHiVBSIWx9Qz6rhnIv6B5OuQ/liCq1KH8Ym5ZwfoZ93PCJpHuc4RNaW6dIKre+dyJW3hHKwjcSoS9U6TDk0JigEkMB/kDiy0uvC+HYL2tFFW5Gmw158D9yaY+5dQE8vsuMyue9tVSsHhyDlAjXg2Ez/B0QsyltprjxYyjNK4xXungVoM9zBg/igO3epxj6dtkoS64ErDJ7vy1AdgSbsTYfWB9esJpCUY3ewjBZlYwoSyZYSN/hMGxJoP/ppx7wW86gmgGKeX8ABxLfHb76P5jffRhI6QJ2Vzd9mMeNcJNNUsNnfJNV0+bD6tB9sDnkIdXG8M9CLR3SNGSfdzrVPdUQP1UVk2VFXW2HedpD24zQ0tfo8cFDbqHXaf6ljpIx1UNCDq2GDnV6qmsDvihkPYtc6Cfg+9Uq0NVoVUFIsgu7iM+Fj67MdRSthmDBZ3JhcIExVYluIcngphN4RywD5gNt0QbswfRYx/DON+iDzcq0A2H41PJPk7zVlavqsKliQcTAlvQvVXZ8dgfV4+YOPhwHUtKXO6Ih4EEk/awZEp6nfltvTrmR7XPC7X68PDbn3/+BymOMk9i4AAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE8VdW3PjNrL+L/Kr1xHA+7ylJputVDbnpHaS3QdXSkVLsM0didQhKc84qfz3UwQJqdHsBkFKW/sUZ9TobqAvQH8NQX+s6upLs/rw+Mfqc1HuVh/i8H5V5ge1+rDa1ipv1ben9nX9cV+osl3dr071fvVh9Xwqt21Rlc03I5qH1/awX92vtvu8aVSz+rBa/XlvmAuZnrlTfIdB3/jyi4S8aFuVTVuftm1VT/K7s4kB7/vVMa87lWwFLyLlOrzMYV+9FOW/ivb15+p4Ok6LHdEvlvyi2l8b5THTC+E1sn7Y/VJ9VuXHfV4cGi+heMT1a/wPtStqtZ32ljtqyGL5r3m52yvD6WO+3z/l28/TSrDjFmuyfVXbz59U0xRV6eHiNvU11teW/FTsVdnu372sj0dcLX1GkFFDFssvmo5IlW2xzVu1m5Y+HnCN51cnP3fv6RZLUl+3r3n5ovS6TQvE5IvlbrpxdfvdsfKwq018kdk2u78UzV+OddWqbb/kMz2sY/k/VblVXs4FqRfPvJkltbmR1BdVqjpvVcfs57qqnn0mPB6yPIPp08L3qt2++uxdmHy53Kos1bb9drutTmU7bzNxjp2jETz8fOyZ/rWuidMK/NB5/LHm+FxXh5/z932Vj7PUiOOdTT0KpqJ8VXWBgslSev4hbKyEzymMESrWMsTmpbZFUuiFeLnMps3bceSOxRm65ZLy4/GTpzBAulye8nPKO0N3lfOMJW92qtnWxdHTnNSY6zQCYfq3LvkVWzpM4Ye3CdMRRzZM4TwsJeeH5VioT1gyQj0caSxv7EiLJDkdh5HKOo6PBqiYHc58RVXS/kLQ3MZtOMaLkjw1k2UFN6mSb+HNq+CRhVnp7mQ8Qy6bk1nRk6l5hnQ6sFjR8xL1XD2cYefWaVHantAPBOUvxUFVJ+aQBT+8TRiOOC6KP0vp+YE3VsIn4hihHk43ljfP27wlO92M0WKRf3EaAcfSqILTu0YUt3Exmu0iPxvPYb6zMer4eJxLvGX8Iwn6MJKPTrjHWybt6ozMef4+Twen07v0WeT5Tt2w+3/My63a79XOEQA2zQ1DgGC8PAjQTBaGAaWSdyCwKviGAiXdIxj85DrCgZK7ICBm6DEdEqxOy4OC1w+ExU/P+T/U/52KmosJTHCbgCC5LoqG0QTmhwKtjE8cOIRbTnB4zjctCVPTsiH9dZLpMKClzouBWRo4A8ChzSLvd2kGXb9omqJ8+Yd6rlXzqtsCTAgwhDcKBRf3ZSHBTWxBaDiV8wqRaWXsIvW0KxTVX3CrAobdRo9mWx3nKmHG3EYDJnSdGswM4SUauUN5WrtlIe2hKQjtXxt1bj3RMT2iuE0w02wXRfF4DvPDl1HHJ25d4i2nKNUXvinIKIDGXKkBHSiM6HkRMk8HZ2i49FkUEy7dZBSfVfvhY759vZimKFtVP+db1XzTf+Lv+Y1qJ9jc9SS0QQdF+Jb2FPOXxcxrdajeptbg7ky1RES+3/+o3pspGRcyTyEwr/292ub7T21V5y/KtqrxshHFTa6i0Vy98shYZQ/nmpDrcjJveS/+8lx+5y0PueCEyAlX9JaKvXJC7JR3uuRCR/2h/EkdqvqddlLr05s46Jijl3PaanKpvdzuq0btfOdyhwfMky3XWSKiy7T15/nT/iK6fT92XWXz7+78DTaC79S22qmdfV8KpCn4uftGrHWPwb5e6eJ3t3VfrLQUZMSd4AVSp7CT6wYpI4pc/L+Wbf1Orb7+wLlScRQFFwNsNt1gN6e7MxGtONCIWaFih7AGl5wHQD0l8GFQjZGr2fjP8MGiv1J2vt2qppkzbzTiSvnq67GoVbMpPKVb9FfK3lFh7ZSORly79rhid6/7VKHuLdeu0J1C3YW5t8Stvh23KXZ+UiH5lZLrvvCd4+B4yJUaVPmp7QvvT/7rPh40Xwuckv9V58fjsLlSmXn0+bUJmmY4lafHajIL+1Tt/KZgFnUY4CnWL3F9285SAY5arAc27I/q/ae8LJ5V01J2xR9fa1aS35RVRzoyy/oZnrmn5T18dh26RyMnl/Kn/P1J/VxXh6LB04YfeX/tSZvxRzX+GoX5YB56Nsnp7kLlSBgdgUMKkSF4YRaxt0zvW8SWPK8bxGNhxFb0A3Fr2hZ1IVsmh4bBbSEeu6tDAgv420L8zg0OOcdaPRdfJ6SciRau1ul5WsaZaJlrt9V0+BiaGRKIuudH9f5d3ubUVj98dJPaB/Lyqn6MXgvOo4QszxOpGbnwTEoJ9osbD6mjZDAh2Dsr0LKxswzfdflYlc/FC9LB+uxadxkzm/IXWzVm+V5U90UZ1TRUCcXKfBgN81BhwpBPeaN+rffeKlzor5f93NF6SzbU18vdmR7GyH956faYZTrAmwDvwxelvj0WzBUATHET1JLm6tdWH6nMoTLvVBubFuwMJW+J3X310xhxZmSeqa+dZ9Hu/Sc6EF8pc6favNj7Cj1TXyn1Ld8XO32PfKObh95LTQ2crwtElLtr7VVd/K6Z/pzXOQ0EE2T++PKuaI77/H0O37vLGHp+lN7ssbE6HMnOJCv9PORq4Yf86yZ/IfuWrPTLmKvFn4rNvmv4qFlWvbOGXa2EAag3r0U5zw545NWqNNtaLVHEHne1GvqliPlaWMOuViLf1pu3fH+a6RvWsBsYBB63/UzhOnPPmT+uMrxmP1VqzFCA+P6wjwoe3ySeoURVv+TlQDlLDTTw+ixRvhXtfDWsYVcrUQ/fsd+c6mKWGmjgEkXwtjx8lf9/9Z0iNkZtqhmbcnXIC3apCa535xH85JDKnKWb5kS3gDnR5xHXih7V2R7CJ2ttf/F7pb7wByFK+HnE1TPvAIHu8ocrwsjpo4E3UWS2AjcQfGoUvH06J6LuiLG3Vud7/MTTArW+n/Hc04R6+ZCr1PDNrB/KT2pblbtZy+Zicq2Cr217vEY3Zvwt1g2/L+e5UpdhC5Rwgm/zFHiYgOQIFjn99Ix1y7j7z1UKPQwslmg1AWG9qbqZmRcJ/S5c/gMqqvLtSvV6DrdR7fbu1qk3/PkXcZ2eeqbsFvySb98/5Qf1qWjVx6r6XMxSnBl/g92g59V8X9W/1HnZ5Nu55747F5NrFWz6J/0+ds/7/bW7PPD+XU7flea0YzlcfaLQc/5u9oEWjbuBCb+v6oPVcPMzGhh2rRJl9eXnunordvMO2Paw/8L2AxQwSUDOSQJwAszSfKnqz6qGzRkPveCgGzjIT3U961hwGXID4dZ7h37CR68eXneY9ECZXcdIe/hFqal3W1glyab5qEgCvVjzmfeNbfNo39876M5RylN0/sX86F0gH87TbwORynPNxzp/OTCHXl4FMOp6Fapy9LyilxLWuEVq+GY/Hx2mTt8kDzAFbnGOqmRyn0Or86D/1rL0CkxvCfSqDOpfl5UcAXRFXppYuhRkkOZYlY36BS6eKk+HTrPLR+5kcbHCx2o3yeZuIOKWGijEyNAItacoSDtLIptn/6Ga0346CfRk/4EsCxjPTLKD5iw63a+DXyBBLfDIJarA5dbPk0ztaSOiGUvtF5q0hKvicjwzxwr0V1OmlsCi8l+D1gPcYvjfEWNpkxPT4Nro1jNAHjr4PATECIYL/Tf0rLtjtRnSGd+E6854P8G05cn9Do6kJ8zN47oIcCo1FQfz1PPdzeeqNHXg4fhRs1vY1luo8oNX12+G/rPupt5Af3cv/XaKu1rtS3Wf7MTfTn2fTOychnc6npkk+gtpamcOSLMVIxgsVYzK2effwvBI2pj2xlmbZD8jbY+mcpu8Tat1zQHGQ2Foqr/rX/H4td47TIRp5ny1nO+3k1ynu+0jhfk7VtWp5S1Ai0ejZqvgu0lOS5/aFkccLNXZK+I7/bMaMwxC6PQA2SzQbvKrsu2pLn+prtMRcLmJiuOgmYyY2eHiRrDGTH2gK1vXpZ7qBqscDTt7+FU4FaXJBEDFTX5mkprOUK6M7KWEX7ryy1VLlLnCHeZnrRunrJvlq/9IsrpVppqfps6/Amf9lpBHF4IcMGPXd15snRbic8XVPTefw9nmOAn5OlRkWN1QWVNc/krXrB462hxuuY4eSKhr7Xwx0VlKeXQ4HDr5tjqmVJrb85hWybchRHMa90BGTU9rnOGGMPShB+ognXhAwJbZv/9Z7o5V0fFB1WsvjKS59guoPNOpL6LSKk985WWu9OnHnGgWC991mtbH44mnJRo5Xnua1snr4aclWrne6JlWy++5niV6sW9TTSvl8UzVEo2ob8lPK+OGGz31sB5G5Z/C+2HuK3ibTZ1/meJ0Z6joKfzgfvmOuwJrSXBecp0Q8FK8qXLjJcYiXSTsOT8U+3c/aTbtInGHYrfbKz9xNu0yWxXbz372uhAuEtQ9WKLqWu023XOHXiLJIQuFV8/F3keioVsmpti2p9pDzJlukZgv6qkp6FOpJeZCt0iMOsDvjHNCDNVyEZs3VRfPBV35jmVB8mXZQ5XMtVE7cxiyRUKeirp93TG1gyUHUi4S9XtVqqJ8JktzSxIgXCSo/670pJgz2bIYeq1KtSlPhycPGyHiqwX6uyI3apEK+W5Xq4Z+kRsKvdAtEnM6dm622+T0++XWk7SQdJGwwmM+xfK55KdpG/U0yxLTV/IOiJ2NvvLXPqZ23afn6Q33if8x8Km197Bwsdy0/25JpMZi39MsM+3v02vf0yxb+4rp0Nur7/zFh0nnbF83XTPcw0UvlMtEtZvXvHmdFnSmWyRm6ydle5WQfDud8XuaZewPHuwPi9k3p6fNv7+Q32u1RFzollminE4dPc2yWRTTebVxPBQ8wb6qXzYeEs5ki4V4FRiA0FuQ/eM95K+53ObNrTMj31/B4X/4Bq7FmL1zBVx8iTJ8zN2jAHfJoKrvsRCfutslhSq6x1J8ym2nHXCtTdhiqsp28XeU2GNJM4prt0y7sqYEuWtqJ3dUUBPcJ0ppF3dcR4+5T1XQLu52+Tzm7S6cJzmPSxVGxHR14oxxu1gm4ttdJrt4j2vkMfvp6tglYVQajwVMFsUu/qgiHnOfqIWdvk8VwkQA+JTAvnJ8nGpe5euSjMvesaypgtfFnah2xwI86lyXjOb05GDef+rFFTcO8T3Uf6r6qepeQSFbiBPU1HHkt/tVUe7U19WHP86vQnxYyYfgIVvdr54Ltd81qw+P5uywrQ76+4u/DZ/9U3WnkY6iJ/lmvbp/XN9HwUMQBr/9dv9oRugP9D9oMrG6fxT3Yfogg8giExaZXN0/ynuZPWSZRSUtqmB1/xhQMgOLLFzdP4YUWWiRRav7x4giiyyyeHX/GFNksUWWrO4fE4osscjS1f1jSpGlFlm2un/MKLLMXt1usQVpBoHsoA0hSErbFKJbcyFJStscolt2QRpE2BYR3coL0ibCNoroFl+QZhG2XUS3/oK0jLBNIzoTCNI4wraO6KwgSPsI20CiM4QgTSRsG8nOEJK0kbRtJDtDSHEfhA9pakeLROHCxottIdmZQcr7MHxIE5vQNpDsrCADKlClbSDZWUGG9+H6ARPa9pGdEWREzsa2j+yMIGOS0raP7IwgSUtK2z4y49fStk+wZtYysK0TCHY+gW2dQLLzCVBC0/Yh/S2wDRSE7HwC20BBxM3Htk8QsyYPbPsECWfywDZPkPJLZJsnyPglss0TavOQgRbaBgr58AltA4Vc+IS2ecKAnU+ItpyQnU9omyfsrBCQ6SC0DRTG/HxsA4UJNx/bPmFnhEAQ6SC0zRNm/MRt80RrduKRbZ6os0FA7iuRbZ5IshOPbANFATPxyDZPFHITj9CZIGInHtnWiWJ+4rZ1os4IAblNRrZ9opSfuG2gKOMmbpsn7mwQkBtvbJsn5tNbbJsn5tNbbJsn1gc2cjOPbQPFfHqLbQvFXHqL0bGtM0IQ3wfpQ5zahLZ5Ym2e5D5IHmSIWNrmifn0Ftvmifn0FtsGSrSByB0gsQ2U8OktsQ2UcOktsc2TaPOQqTWxzZOE7MwT2zxJxM48sQ2UdGYIyUSYoKN1Z4aQrCIS20JJZ4ZQkpS2hZLODCG5+yW2hdLODGFIUaa2hdLODCHp7qltoZSzUGpbKA3Ymae2hdKQnXlqWyiN2JmntoXSmJ+5baFUW4g8i6eo/km5mdv2SbV9yJNeatsn0/YhIyiz7ZNp+2TUfDLbPllnhoj0zcy2UNaZISItlNkWyjozROT+l9kWynRlGnSLFMShTWlbKOvMEJEWymwLZZ0ZooiktC2UdYaIYpISFamdIaKEpMR16ppd+v4zSCu4zN1/BEklm7v7zyCtthRd261RubrWtmLURQXrujNJzNTgqGRdazCBrsLXqGhdJ6wX9J9B2s4wMV2zr1Hhuu5ME9NV+xqZTYMIMV23jwAGweuLIQYNJMR0lY9BBg0lxHSdj2EGDSbEdKWPgQYNJ8S0P2CoQQMKMV3tY7BBcIdxgcEGDSkka6KuEhht0JgC4+gIbxAaVaDjBwEOQsMKCe2PEsNCnV0SBhdCNtPoQkL7GEIehMYXEtrHEPYgJJ8ZBYIfhGQPgALhD0LyR0CBEAgheaMhCEJooCGhvRyBEEKDDczMEBAhNNyQ0BGBoAihAYeEjogAw3naanREIDhCaNAhoSMCARJCAw8pnSERKCF6VIKKHgRKCI09pLTvIlxCaPQhpX0XIRNC4w8pg2oiq2kEImVwTWQ1jUGktDcgfEJoHCIlfRdBFEIDESlt4BCjsJ1hUtrACKYQGoxIaQMjoEJoOCKjDYygCqEhiYw2G4IrhEYlMtpsCLEQGpfIaLMhzEJoZCKjzYZQC9HDFnRuQLiF0OgEnXIQcCEiFpkVCLsQGqLIGEgco+edZTI6NSAAQ2iYIiOPbwJBGEIDFRntOQjEEBqqyGjPQTCG0HCFWNOug7AMoRELOvUiMENoyEKsaTdDeIbQqIVYk8WTQJCG0MCFWNOOhlANobELsaY9DQEbQgMYYk0bOsbND939WDPtD2Q9jWOINZ0kEMghNJRBt+wQyiE0lsFsWgjnEEnfqkopj0dIh0h669EuhMAOoUENwTTBEOIhNK7BaIwwD6GRDcH0zBDsITS4IZi2GUI+hMY3BNM5S3DzShuPaZ4h/ENolEMw/TMEgQgNdAimhYZQEJE6DigIBxFp32yk/Q1BISLt7cc03ZD9NOohmL4bgkSEBj7oXRRhIiKNHCkAwSJCgx+CbukJhIyIlG2eCASNCA2BCEk7HMJHhEZBhGQ0RsbLHMZDIInQUIjoGkPjQEUwiehxEoYvMp2GQ2hrIKREaDxESNrlEVgiNCQiJO3yCC8RWW862uURZCI0MCLodqNAqInQ2AhtZwSbiKw3He3xCDmRGh0RdANMIuhEanyEXGOJoBOp4RFBN6Ikwk7kuu/0k7uCROCJXLPNFomwE6nxEUE3hSQCT6QGSERAN6kReiI1QsKsBOopa4CEdmKJwBOpARL6zCQReCI1QEKfHCUCT6RgMS+JsBPZ389gbIHAEzlc0SAjSSL0RPa3NOh+jUTwiewvajDWQPiJ1BgJbQ0En8j+skZARqhECIrkERSJEBTZX9gIaNPhKxuSz5cSX9rQOIkIUpLx6N5GbzwSWZT48oZGSgTdIpH4AocM+f1A4jscDhxF4mscMmb3A4kvcmiwhLYHvsmhwRLOHvgyh+QPmhIhKVKjJZw9EJQiA+GwB8JSpMZLREjuzxKBKTJwXL1Bpgv621F0FkRgitSAiQjJs6NEaIrs0RTysg6CU2SQ8GZGcIoMHBkTwSlSQyYipDMQwlOkxkwE3UKTCFCRIQ84SwSoSI2a0I0SiRAVqVETulUiEaIiNWpCN0skQlSkRk3opoJEiIrUqAndWpEIUZEhj15KhKhIjZoIulMnEaQiw9509HUrhKnIiK/vJMJUpMZNREiHKAJVZNRHHb1uCFaRGjsR0ZomRsbT4Imgm3cSISsy6i8m0vkVQStSwyciojdHhK1IjZ8IxjkRuCI1gCIY70ToiuzRFcY9EboiNYQiGJ9D+Irs8ZWItiDCV2SPrzCej/AV2eMrMW1BhK/IHl+JaQsifEX2+EpMWxDhK7LHV2LagghfkT2+EtMWRPiK7PGVmLYgQlikRlEE3f2SCGKRPcRCt78kwlhkj7HQ/S+JMBbZYyx0A0wijEVqHEUk9LEFgSyyB1noFpREIIvsQRa6ByURyCJ7kIVuQkkEssgeZKG7UBKBLLIHWejGjkQgi+xBFrpbIxHIIjWQIuh2jUQoi+xRFrpfIxHKInuUhW7YSISyyB5loTs2EqEsUkMpgm7ESISzyB5noTsxEuEsssdZ6FaMRDiL1GAKk8sR0CLZSygSoSyyR1noXQ2BLDJbO3Y1hLLIHmVhdjUEs8hMOnY1hLPILHDsaghpkT3SwuxqCGmRPdLC7GoIaZE90sLsaghpkT3SwuxqCGmRWerY1RDWInushdnVENYS9FgLvasFCGsJ1oLf1QKEtgQ92kLvagFCW4IebaF3tQChLcE65He1AOEtQY+30LtagPCWoMdb6F0tQHhLsE74XS1AiEuw7r9mQWbbAEEugYZVBN04DQbMRX+56U3Vrdr90H/J6fHRPHz2x2ozfPGpO8pqpt13oLoD7Ic//vzz8lWn7v865ua9xMvAKLiMy6KO8H7V3cHp/xBi+EOaj4L18EecDX8kwfBHaj7Kzn/I/o8Oa+r/kGvzR2T+GPh01VX/Ryg47buvfNXtTv/AIZz7ZQoiZMbaDxCC+cdg/mcNeC61JTmBq97Pnx61ecv3J9XAwRlUO2LHmm8NAqkxGNmdwbTSndsyLPb7z+rdYhECDsZsKTv+gCadwklzxsqPx6Z/MPYyVELFBwcIjK+l5o+zGQJWI/MACNQqAryTlBvZPaMDlxIaMGGNcP7dksvQADhOHJvAOceLCQFpPopMLAh2xbqfvdwOvycOdARuYmKPn96ZRWWejAYel0KPSxw8hmdc4PJC0yWusapsi/4XN1VdV5brSKBAEDh4jF9phuEugSoBG6qQzZhLGsOkIY0PhsYHA5O5hPkjMfZjvXKQqIafjinKxvx0DNB+DQXHLK/f7RSXwDknETPqKW9U911aMBJmqO5WFDPw8s10IDTKYJ6RJs9w/vtU7d7h+BjoLNacy26JUI7hZLm9TP8OjL20AVxazr/0uPxpb40NgWdmXBrQI1XZ1tY0IzDNjPNGPfSzstcHmobduMzInf6xaWBYuH1I5+j9+ddx4WJB68TnAOBcSzM66F/dAUwCsOJyHZsIYZl0vyM+/Ka4FYxgN+KG7vPCjuBoDdadc+w+F+r3d8BImAfXrJ/oofbIZA1Nlpocb/6IzelGnM87XKbUzxqBlUzXcFNldcIGkGDXExm77v0b4Hn/Brh5Yr4enguHqRVm+YCNPIvdl6J9rc+/aAKYZVA1N6vxvGCWzLgsOYwe7zNwMdloBj9YAIZam4vZu81uwG5a1rNGgBtgZjzCpNHhv8MxyGxB4bDNGJHRcDyOB7pkoEvNf43vCXN8CkwYpmwsVdXnQu2qQ17YOcE6SbOb/LZWeauY0wpYeXbh9fhn1W5flX2yhHHJKb9TnbPsRgf5ELhbZg5Ka06H/kfUrBxkVRHucWpXnx+vgNkQRo/gXGVXNMd9bu0EKdwJQnbgyGAZDLGIXbFjddRPAKJcBgezx6jhZR94KoC7s3FPmXHS8bs9kBM8fJ9zZ8blClVu91WjdqONH9a+KT/6zfZ1mMoTbv8YpxZYZgyRFgzuZirYcIjdcFicaIjdeKCLB7qEXfRO6manmm1dHEcZyjodDZJNVhkkhsM5NhoWNRo0Nfu8Kd7Zk6T6un3Nyxc1CjMBz1icp+rXRGGVBSvGhDs/wnfvwWYNjJsZbwu5HWHgkVs5KYY6rzkHsd5dg3siPAWfq7iMmwX43SK4anAFpKkpAi7N6ORoBStMjewuNOTUrf6JXms4PCZIdgXq/OWAq08J6092S3muqwN9PI5hmmFrp248Ph7DKbNHym7gMX/fV7m14FDr83IP3hMMwREO/x4OwWFsGw3hGQ90rMOa58JgSoN2NvEesNvQiyp7ZzlWx2NdVfaZEO4K3GasORTbcZ6ykCl2sGVrWFgnwyKkXI56UW2PqY1SBCzfRMAvXnvemOwlhHsaP7jojwBEXXAZ7xiuBzfDG1PWngrSjedwAmrpLv6BI6ivIm/9Y1fk6SIFEwvYLGY4dqfy4de8YdEHE6EvB3J6cBtka9cX1Z4aO0LAEYkdBV7ZhHkYhlZ0jmluGq95udsrU5hs8/3+Kd9+tvwUeDvHpG2PbjQHxmjMsSns/UjAMlImXDYvxgcdMC7hUunl54hATIBlz0x9EHKHHsNh81rYm0EG94KQne34cN5dywHtCS4fFeVBHar6fTxxMDxl5ZZvRTsCOjKYjSIuEIsGQJdo74aT5rJZgSF6ON+YC9aiaU5oA1nDEI24gfpFcuhQcLtjj5Wf1fshL4tn1bTjbRqWP2xuwH2EGCZrwfnTXqkvdsHTfX0JxA23qnv1km/fm/ygupdL+7LVNg1kw87bPFwJ7QMXzGz0AYsFaQ5NW9X5ixo7J1gEth2yr14KIqDgyZTt2umxZEIHw3nVh8EURgN7GPz46oSOhPAw6RxGbR0wiUnpULs6tQT6H8CDjTAFAXvE6fmc6j25i8EoZY9Yh/zrJn+xTJ7CQ23IJZVD/v6kjnV1KOytHCYHwRZRh+d8nMghxBBzUXp4zmv1f6ei7koRdC6EiC3bArIeh4ZHM2i6MyjGgq+HommK8mX4kTU9l7E+IHhYyP7wPmCN+bEYcYDIqQg4W4zmsoblRWLAB1MwSxZH0D9lATMJLA9ZHKFUX8jTbgBGsweBy0Pa0BYwg0WhsQXLY3TOTiB2z54myurLsa7eClzoCOjDbI+m6nbV/oTb/44cCALrLMqZrSpJaBmitCI9JwFuA+h+UBP1xbrr4ABhNsdJA+nIgIsN85w/PJnDsz7bQbk80A+HQiOwHfiqfsnLoZVpbR9WrcTN3n5VGbou1NsAzN3Fmmk+NKAHgRZpmuIBa9zze+fQra0rAqbnynYAxjsiCItwqGHP0cFPrWOzzcut2u+ppAkWKuJ2+J6Hhl7IvcbqSXB5QjPRWzbFQ8Jcw4IKmsdQtYynAtRgNy7qPX1oI+g3BtyUbO+z41Z8tSoveGyT7IKax/ahaOhhBtWUbOOr23yPVupIYdpn7/mYpLM51dZBO4Pl3lk8W4yfq0+rYUYeimA2Z9v0hh/vIDCpsunEYkN0ASF21H0Z1M0FLVH3/R0wFc4y6JdXQakKj1ZrE7msq9bqUL3Zx3EgPxm2BjYpG6RldC9OwLsqgu1JmPHj4bCeYkOj/xn5trIzBYxy0y+ULJA22lnhCdncDhNr0+E3R2ZhegfijKUIc/hhS/tmWysKF4DbMVvdD41/fQlA4/Tvu9wuJ4XVXWDPJA2CLUHsJMOk2A56w8GO1rUcbjDe+GHUskjp+BocjBBTe7Iy27w92VeX4GoH7Gp3D/ZDXYFDBuxtnPMPOsGDIvTHlMtNzekZZ3mrTuTGcRsV3OvYdqwTm4NHAbk21QpbsbZFa282qdXq4jIA/LVtkMXAySwzpxi2s9uXRsPPKJPgL8QYJL8cFeqhwDO+YGttrDx0a8EehE/FpgdW7DuGcAdi23TwpypgDFrN1dScH1kNmgETap6ruq3zssm34z3RgivYhuepUaN7xdYNFjajDCN1Rhkft8Auwl4vPTXquaoP+IaXsFoh7JXWU6MOdW0vpH2TgvN4jM3DkvJ8AZKFW7vRoLJHuDjc/mIuM2IWzwRK370aBFhx9nvL98WuvzKqjWBnTMiCvV5ufjrEEg5dgG0Enn9aCZ5UoS+blqJkT1NfqvqzqnGRarUAWWzxS50fj8O9iDGwC4OZvSN++eUgGI6wZIkDE46kO/12vzoWR7UvSrX68Pjbn3/+P717ZIkv+AAA"; \ No newline at end of file diff --git a/docs/classes/Auth0Client.html b/docs/classes/Auth0Client.html index 5925e612e..b32e8970b 100644 --- a/docs/classes/Auth0Client.html +++ b/docs/classes/Auth0Client.html @@ -1,7 +1,8 @@ Auth0Client | @auth0/auth0-spa-js

Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE.

-

Constructors

Constructors

Methods

  • Parameters

    • dpop: undefined | Dpop

    Returns asserts dpop is Dpop

  • await auth0.checkSession();
    +

Constructors

Methods

  • Parameters

    • dpop: undefined | Dpop

    Returns asserts dpop is Dpop

  • await auth0.checkSession();
     

    Check if the user is logged in using getTokenSilently. The difference with getTokenSilently is that this doesn't return a token, but it will @@ -32,12 +33,18 @@ means that checkSession could silently return without authenticating the user on page refresh when using a private tab, despite having previously logged in. As a workaround, use getTokenSilently instead and handle the possible login_required error as shown in the readme.

    -

    Parameters

    Returns Promise<void>

  • Initiates a redirect to connect the user's account with a specified connection. +This method generates PKCE parameters, creates a transaction, and redirects to the /connect endpoint.

    +

    Type Parameters

    • TAppState = any

      The application state to persist through the transaction.

      +

    Parameters

    Returns Promise<void>

    Resolves when the redirect is initiated.

    +

    Throws

    If the connect request to the My Account API fails.

    +
  • Returns a new Fetcher class that will contain a fetchWithAuth() method. This is a drop-in replacement for the Fetch API's fetch() method, but will handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

    Check the EXAMPLES.md file for a deeper look into this method.

    -

    Type Parameters

    • TOutput extends CustomFetchMinimalOutput = Response

    Parameters

    Returns Fetcher<TOutput>

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

    Parameters

    • options: CustomTokenExchangeOptions

      The options required to perform the token exchange.

    Returns Promise<TokenEndpointResponse>

    A promise that resolves to the token endpoint response, which contains the issued Auth0 tokens.

    @@ -55,41 +62,41 @@

    Example Usage:

    // Define the token exchange options
    const options: CustomTokenExchangeOptions = {
    subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
    subject_token_type: 'urn:acme:legacy-system-token',
    scope: "openid profile"
    };

    // Exchange the external token for Auth0 tokens
    try {
    const tokenResponse = await instance.exchangeToken(options);
    // Use tokenResponse.access_token, tokenResponse.id_token, etc.
    } catch (error) {
    // Handle token exchange error
    }
    -
  • Returns a string to be used to demonstrate possession of the private +

  • 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;
      }
      • accessToken: string
      • method: string
      • Optional nonce?: string
      • url: string

    Returns Promise<string>

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

    +

    Parameters

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

    Returns Promise<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

    • Optional id: 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<undefined | string>

  • const claims = await auth0.getIdTokenClaims();
    +

Returns Promise<undefined | string>

  • const claims = await auth0.getIdTokenClaims();
     

    Returns all claims from the id_token if available.

    -

    Returns Promise<undefined | IdToken>

  • const token = await auth0.getTokenWithPopup(options);
    +

    Returns Promise<undefined | IdToken>

  • const token = await auth0.getTokenWithPopup(options);
     

    Opens a popup with the /authorize URL using the parameters 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.

    -

    Parameters

    Returns Promise<undefined | string>

  • const user = await auth0.getUser();
     

    Returns the user information if available (decoded from the id_token).

    Type Parameters

    Returns Promise<undefined | TUser>

    Typeparam

    TUser The type to return, has to extend User.

    -
  • const isAuthenticated = await auth0.isAuthenticated();
     

    Returns true if there's valid information stored, otherwise returns false.

    -

    Returns Promise<boolean>

  • try {
    await auth0.loginWithPopup(options);
    } catch(e) {
    if (e instanceof PopupCancelledError) {
    // Popup was closed before login completed
    }
    } +

    Returns Promise<boolean>

  • try {
    await auth0.loginWithPopup(options);
    } catch(e) {
    if (e instanceof PopupCancelledError) {
    // Popup was closed before login completed
    }
    }

    Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce @@ -98,21 +105,21 @@

    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.

    -

    Parameters

    Returns Promise<void>

  • await auth0.loginWithRedirect(options);
     

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

    -

    Type Parameters

    • TAppState = any

    Parameters

    Returns Promise<void>

  • await auth0.logout(options);
     

    Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session.

    If the federated option is specified it also clears the Identity Provider session. Read more about how Logout works at Auth0.

    -

    Parameters

    Returns Promise<void>

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

    +

    Parameters

    Returns Promise<void>

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

    It requires enabling the Auth0ClientOptions.useDpop option.

    Parameters

    • nonce: string

      The nonce value.

    • Optional id: string

      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.

      -

    Returns Promise<void>

\ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 9362331cc..fb25ed296 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,9 +1,9 @@ AuthenticationError | @auth0/auth0-spa-js

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 full)

Constructors

Hierarchy (view full)

Constructors

Properties

appState: any = null
error: string
error_description: string
state: string

Methods

\ No newline at end of file +

Constructors

Properties

appState: any = null
error: string
error_description: string
state: string

Methods

\ No newline at end of file diff --git a/docs/classes/CacheKey.html b/docs/classes/CacheKey.html index c0f9baa43..75ffe1be6 100644 --- a/docs/classes/CacheKey.html +++ b/docs/classes/CacheKey.html @@ -1,4 +1,4 @@ -CacheKey | @auth0/auth0-spa-js

Constructors

constructor +CacheKey | @auth0/auth0-spa-js

Constructors

Properties

audience? clientId prefix @@ -7,12 +7,12 @@

Methods

Constructors

Properties

audience?: string
clientId: string
prefix: string = CACHE_KEY_PREFIX
scope?: string
suffix?: string

Methods

  • Converts this CacheKey instance into a string for use in a cache

    +

Constructors

Properties

audience?: string
clientId: string
prefix: string = CACHE_KEY_PREFIX
scope?: string
suffix?: string

Methods

  • Converts this CacheKey instance into a string for use in a cache

    Returns string

    A string representation of the key

    -
  • Converts a cache key string into a CacheKey instance.

    Parameters

    • key: string

      The key to convert

    Returns CacheKey

    An instance of CacheKey

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html new file mode 100644 index 000000000..19aa1c14f --- /dev/null +++ b/docs/classes/ConnectError.html @@ -0,0 +1,10 @@ +ConnectError | @auth0/auth0-spa-js

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 full)

Constructors

Properties

appState: any = null
connection: string
error: string
error_description: string
state: string

Methods

\ No newline at end of file diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 96e4d650c..4767583ee 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,6 +1,6 @@ GenericError | @auth0/auth0-spa-js

Thrown when network requests to the Auth server fail.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

error: string
error_description: string

Methods

  • Parameters

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

    Returns GenericError

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string

Methods

  • Parameters

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

    Returns GenericError

\ No newline at end of file diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index 6db40a33a..462d805c0 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,3 +1,3 @@ -InMemoryCache | @auth0/auth0-spa-js

Constructors

constructor +InMemoryCache | @auth0/auth0-spa-js
\ No newline at end of file +

Constructors

Properties

enclosedCache: ICache = ...
\ No newline at end of file diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index 63f953e37..7495d2f0f 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,6 +1,6 @@ -LocalStorageCache | @auth0/auth0-spa-js

Implements

Constructors

constructor +LocalStorageCache | @auth0/auth0-spa-js

Implements

Constructors

Methods

Constructors

Methods

\ No newline at end of file +

Constructors

Methods

\ No newline at end of file diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 530a73ee1..199caadd6 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,7 +1,7 @@ MfaRequiredError | @auth0/auth0-spa-js

Error thrown when the token exchange results in a mfa_required error

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

error: string
error_description: string
mfa_token: string

Methods

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string
mfa_token: string

Methods

\ No newline at end of file diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 800cc3a5e..9e2876fd4 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,8 +1,8 @@ MissingRefreshTokenError | @auth0/auth0-spa-js

Class MissingRefreshTokenError

Error thrown when there is no refresh token to use

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

audience: string
error: string
error_description: string
scope: string

Methods

\ No newline at end of file +

Constructors

Properties

audience: string
error: string
error_description: string
scope: string

Methods

\ No newline at end of file diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html new file mode 100644 index 000000000..ab98c9b93 --- /dev/null +++ b/docs/classes/MyAccountApiError.html @@ -0,0 +1,7 @@ +MyAccountApiError | @auth0/auth0-spa-js

Hierarchy

  • Error
    • MyAccountApiError

Constructors

Properties

Constructors

Properties

detail: string
status: number
title: string
type: string
validation_errors?: {
    detail: string;
    field?: string;
    pointer?: string;
    source?: string;
}[]

Type declaration

  • detail: string
  • Optional field?: string
  • Optional pointer?: string
  • Optional source?: string
\ No newline at end of file diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index e165ab308..c6e2b8d9f 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,7 +1,7 @@ PopupCancelledError | @auth0/auth0-spa-js

Thrown when network requests to the Auth server fail.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

error: string
error_description: string
popup: Window

Methods

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string
popup: Window

Methods

\ No newline at end of file diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index d24ba63b5..a26d938c1 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,7 +1,7 @@ PopupTimeoutError | @auth0/auth0-spa-js

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

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

error: string
error_description: string
popup: Window

Methods

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string
popup: Window

Methods

\ No newline at end of file diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index bd72f7e37..44c68cf0d 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,7 +1,7 @@ TimeoutError | @auth0/auth0-spa-js

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

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

error: string
error_description: string

Methods

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string

Methods

\ No newline at end of file diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index a315f3141..8263e3224 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,7 +1,7 @@ UseDpopNonceError | @auth0/auth0-spa-js

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

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

error: string
error_description: string
newDpopNonce: undefined | string

Methods

\ No newline at end of file +

Constructors

Properties

error: string
error_description: string
newDpopNonce: undefined | string

Methods

\ No newline at end of file diff --git a/docs/classes/User.html b/docs/classes/User.html index bf1c7f973..8bd42f74f 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,4 +1,4 @@ -User | @auth0/auth0-spa-js

Indexable

[key: string]: any

Constructors

constructor +User | @auth0/auth0-spa-js

Indexable

[key: string]: any

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
\ No newline at end of file +

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
\ No newline at end of file diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html new file mode 100644 index 000000000..07a0cf159 --- /dev/null +++ b/docs/enums/ResponseType.html @@ -0,0 +1,8 @@ +ResponseType | @auth0/auth0-spa-js

Enumeration ResponseType

The types of responses expected from the authorization server.

+
    +
  • code: used for the standard login flow.
  • +
  • connect_code: used for the connect account flow.
  • +
+

Enumeration Members

Enumeration Members

Code: "code"
ConnectCode: "connect_code"
\ No newline at end of file diff --git a/docs/functions/createAuth0Client.html b/docs/functions/createAuth0Client.html index d88e87c90..4a6f386f2 100644 --- a/docs/functions/createAuth0Client.html +++ b/docs/functions/createAuth0Client.html @@ -3,4 +3,4 @@ a user on page refresh. Please see the checkSession docs for more info.

Parameters

Returns Promise<Auth0Client>

An instance of Auth0Client

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 1ae406830..da74d39f2 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/auth0-spa-js
\ No newline at end of file +@auth0/auth0-spa-js
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index a6f010cbc..ed110e785 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,7 +16,7 @@
npm install @auth0/auth0-spa-js
 

From the CDN:

-
<script src="https://cdn.auth0.com/js/auth0-spa-js/2.5/auth0-spa-js.production.js"></script>
+
<script src="https://cdn.auth0.com/js/auth0-spa-js/2.6/auth0-spa-js.production.js"></script>
 

Configure Auth0

Create a Single Page Application in the Auth0 Dashboard.

@@ -76,4 +76,4 @@

This project is licensed under the MIT license. See the LICENSE file for more info. -

\ No newline at end of file +

\ No newline at end of file diff --git a/docs/interfaces/Auth0ClientOptions.html b/docs/interfaces/Auth0ClientOptions.html index a28b9393f..a7859e525 100644 --- a/docs/interfaces/Auth0ClientOptions.html +++ b/docs/interfaces/Auth0ClientOptions.html @@ -1,4 +1,4 @@ -Auth0ClientOptions | @auth0/auth0-spa-js

Interface Auth0ClientOptions

interface Auth0ClientOptions {
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    clientId: string;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    sessionCheckExpiryDays?: number;
    useCookiesForTransactions?: boolean;
    useDpop?: boolean;
    useFormData?: boolean;
    useMrrt?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}

Hierarchy

  • BaseLoginOptions
    • Auth0ClientOptions

Properties

auth0Client? +Auth0ClientOptions | @auth0/auth0-spa-js

Interface Auth0ClientOptions

interface Auth0ClientOptions {
    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    };
    authorizationParams?: AuthorizationParams;
    authorizeTimeoutInSeconds?: number;
    cache?: ICache;
    cacheLocation?: CacheLocation;
    clientId: string;
    cookieDomain?: string;
    domain: string;
    httpTimeoutInSeconds?: number;
    issuer?: string;
    leeway?: number;
    legacySameSiteCookie?: boolean;
    nowProvider?: (() => number | Promise<number>);
    sessionCheckExpiryDays?: number;
    useCookiesForTransactions?: boolean;
    useDpop?: boolean;
    useFormData?: boolean;
    useMrrt?: boolean;
    useRefreshTokens?: boolean;
    useRefreshTokensFallback?: boolean;
    workerUrl?: string;
}

Hierarchy

  • BaseLoginOptions
    • Auth0ClientOptions

Properties

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

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

-

Type declaration

  • Optional env?: {
        [key: string]: string;
    }
    • [key: string]: string
  • name: string
  • version: string
authorizationParams?: AuthorizationParams

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

Type declaration

  • Optional env?: {
        [key: string]: string;
    }
    • [key: string]: string
  • name: string
  • version: string
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.

-
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.

-
cacheLocation?: CacheLocation

The location to use when storing cache data. Valid values are memory or localstorage. +

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

-
clientId: string

The Client ID found on your Application settings page

-
cookieDomain?: string

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

clientId: string

The Client ID found on your Application settings page

+
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

-
leeway?: number

The value in seconds used to account for clock skew in JWT expirations. +

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

+
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.

-
legacySameSiteCookie?: boolean

Sets an additional cookie with no SameSite attribute to support legacy browsers +

legacySameSiteCookie?: boolean

Sets an additional cookie with no SameSite attribute to support legacy browsers that are not compatible with the latest SameSite changes. This will log a warning on modern browsers, you can disable the warning by setting 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.

Type declaration

    • (): 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.

      -

      Returns number | Promise<number>

sessionCheckExpiryDays?: number

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

Returns number | Promise<number>

sessionCheckExpiryDays?: number

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

-
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.

Notes

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 legacy 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.

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). @@ -79,9 +79,9 @@

E.g. Using the file: protocol in an Electron application does not support that legacy technique.

Example

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 -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 +

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.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 3a1d3726e..429ea1ffe 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,6 +1,6 @@ AuthorizationParams | @auth0/auth0-spa-js

Interface AuthorizationParams

interface AuthorizationParams {
    acr_values?: string;
    audience?: string;
    connection?: string;
    display?: "page" | "popup" | "touch" | "wap";
    id_token_hint?: string;
    invitation?: string;
    login_hint?: string;
    max_age?: string | number;
    organization?: string;
    prompt?: "none" | "login" | "consent" | "select_account";
    redirect_uri?: string;
    scope?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

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

-

Properties

Properties

acr_values?: string
audience?: string

The default audience to be used for requesting API access.

-
connection?: string

The name of the connection configured for your application. +

Properties

acr_values?: string
audience?: string

The default audience to be used for requesting API access.

+
connection?: string

The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.

-
display?: "page" | "popup" | "touch" | "wap"
    +
display?: "page" | "popup" | "touch" | "wap"
  • 'page': displays the UI with a full page view
  • 'popup': displays the UI with a popup window
  • 'touch': displays the UI in a way that leverages a touch interface
  • 'wap': displays the UI with a "feature phone" type interface
-
id_token_hint?: string

Previously issued ID Token.

-
invitation?: string

The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

-
login_hint?: string

The user's email address or other identifier. When your app knows +

id_token_hint?: string

Previously issued ID Token.

+
invitation?: string

The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

+
login_hint?: string

The user's email address or other identifier. When your app knows which user is trying to authenticate, you can provide this parameter to pre-fill the email box or select the right session for sign-in.

This currently only affects the classic Lock experience.

-
max_age?: string | number

Maximum allowable elapsed time (in seconds) since authentication. +

max_age?: string | number

Maximum allowable elapsed time (in seconds) since authentication. If the last time the user authenticated is greater than this value, the user must be reauthenticated.

-
organization?: string

The organization to log in to.

+
organization?: string

The organization to log in to.

This will specify an organization parameter in your user's login request.

  • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
  • @@ -41,25 +41,25 @@ To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. More information is available on the Auth0 documentation portal
-
prompt?: "none" | "login" | "consent" | "select_account"
    +
prompt?: "none" | "login" | "consent" | "select_account"
  • 'none': do not prompt user for login or consent on reauthentication
  • 'login': prompt user for reauthentication
  • 'consent': prompt user for consent before processing request
  • 'select_account': prompt user to select an account
-
redirect_uri?: string

The default URL where Auth0 will redirect your browser to with +

redirect_uri?: string

The default URL where Auth0 will redirect your browser to with the authentication result. It must be whitelisted in the "Allowed Callback URLs" field in your Auth0 Application's settings. If not provided here, it should be provided in the other methods that provide authentication.

-
scope?: string

The default scope to be used on authentication requests.

+
scope?: string

The default scope to be used on authentication requests.

This defaults to profile email if not set. If you are setting extra scopes and require profile and email to be included then you must include them in the provided scope.

Note: The openid scope is always applied regardless of this setting.

-
screen_hint?: string

Provides a hint to Auth0 as to what flow should be displayed. +

screen_hint?: string

Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.

This only affects the New Universal Login Experience.

-
ui_locales?: string

The space-separated list of language tags, ordered by preference. +

ui_locales?: string

The space-separated list of language tags, ordered by preference. For example: 'fr-CA fr en'.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/DecodedToken.html b/docs/interfaces/DecodedToken.html index 41d170ca1..c8974f10e 100644 --- a/docs/interfaces/DecodedToken.html +++ b/docs/interfaces/DecodedToken.html @@ -1,3 +1,3 @@ -DecodedToken | @auth0/auth0-spa-js

Interface DecodedToken

interface DecodedToken {
    claims: IdToken;
    user: User;
}

Properties

claims +DecodedToken | @auth0/auth0-spa-js
\ No newline at end of file +

Properties

claims: IdToken
user: User
\ No newline at end of file diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 03b852d37..1bcc04271 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,4 +1,4 @@ -GetTokenSilentlyOptions | @auth0/auth0-spa-js

Interface GetTokenSilentlyOptions

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

Properties

authorizationParams? +GetTokenSilentlyOptions | @auth0/auth0-spa-js

Interface GetTokenSilentlyOptions

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

Properties

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

  • Optional scope?: string

    The scope that was used in the authentication request

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

    When off, ignores the cache and always sends a +

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

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index bdb4753e2..d1b5c9a08 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,8 @@ -GetTokenWithPopupOptions | @auth0/auth0-spa-js

    Interface GetTokenWithPopupOptions

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

    Hierarchy (view full)

    Properties

    authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-spa-js

    Interface GetTokenWithPopupOptions

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

    Hierarchy (view full)

    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?: "cache-only" | "on" | "off"

    When off, ignores the cache and always sends a request to Auth0. +

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

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 7dafa2b7c..0d0d74225 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,5 @@ -ICache | @auth0/auth0-spa-js
    interface ICache {
        allKeys?(): MaybePromise<string[]>;
        get<T>(key): MaybePromise<undefined | T>;
        remove(key): MaybePromise<void>;
        set<T>(key, entry): MaybePromise<void>;
    }

    Implemented by

    Methods

    allKeys? +ICache | @auth0/auth0-spa-js
    interface ICache {
        allKeys?(): MaybePromise<string[]>;
        get<T>(key): MaybePromise<undefined | T>;
        remove(key): MaybePromise<void>;
        set<T>(key, entry): MaybePromise<void>;
    }

    Implemented by

    Methods

    \ No newline at end of file +

    Methods

    \ No newline at end of file diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 43e129d0e..d32b4b4d1 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,4 +1,4 @@ -IdToken | @auth0/auth0-spa-js
    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

    Properties

    __raw +IdToken | @auth0/auth0-spa-js
    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

    Properties

    Properties

    __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
    \ No newline at end of file +

    Properties

    __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
    \ No newline at end of file diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index aae56b0ad..66da3ef52 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,4 +1,4 @@ -LogoutOptions | @auth0/auth0-spa-js

    Interface LogoutOptions

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

    Hierarchy (view full)

    Properties

    clientId? +LogoutOptions | @auth0/auth0-spa-js

    Interface LogoutOptions

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

    Hierarchy (view full)

    Properties

    clientId? logoutParams? onRedirect? openUrl? @@ -6,7 +6,7 @@

    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.

    • Optional federated?: boolean

      When supported by the upstream identity provider, @@ -21,7 +21,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

      -
    onRedirect?: ((url) => Promise<void>)

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

    +
    onRedirect?: ((url) => Promise<void>)

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

    Type declaration

      • (url): Promise<void>
      • Used to control the redirect and not rely on the SDK to do the actual redirect.

        Parameters

        • url: string

        Returns Promise<void>

        Example

        await auth0.logout({
        async onRedirect(url) {
        window.location.replace(url);
        }
        });
        @@ -29,10 +29,10 @@

        Deprecated

        since v2.0.1, use openUrl instead.

    Example

    await auth0.logout({
    async onRedirect(url) {
    window.location.replace(url);
    }
    });

    Deprecated

    since v2.0.1, use openUrl instead.

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

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

    +
    openUrl?: false | ((url) => 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.

    Type declaration

      • (url): void | Promise<void>
      • Parameters

        • url: string

        Returns void | Promise<void>

    Example

    await auth0.logout({
    openUrl(url) {
    window.location.replace(url);
    }
    });

    Example

    import { Browser } from '@capacitor/browser';

    await auth0.logout({
    async openUrl(url) {
    await Browser.open({ url });
    }
    });
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index f992bb50f..4f24340ea 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,10 +1,10 @@ -LogoutUrlOptions | @auth0/auth0-spa-js

    Interface LogoutUrlOptions

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

    Hierarchy (view full)

    Properties

    clientId? +LogoutUrlOptions | @auth0/auth0-spa-js

    Interface LogoutUrlOptions

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

    Hierarchy (view full)

    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.

    • Optional federated?: 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 9a4fe9dde..a7d038c12 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,8 +1,8 @@ -PopupConfigOptions | @auth0/auth0-spa-js

    Interface PopupConfigOptions

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

    Properties

    popup? +PopupConfigOptions | @auth0/auth0-spa-js

    Interface PopupConfigOptions

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

    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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 6d456093e..cb40f0d4c 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,4 @@ -PopupLoginOptions | @auth0/auth0-spa-js

    Interface PopupLoginOptions

    interface PopupLoginOptions {
        authorizationParams?: AuthorizationParams;
    }

    Hierarchy (view full)

    Properties

    authorizationParams? +PopupLoginOptions | @auth0/auth0-spa-js

    Interface PopupLoginOptions

    interface PopupLoginOptions {
        authorizationParams?: AuthorizationParams;
    }

    Hierarchy (view full)

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html new file mode 100644 index 000000000..6d9d64039 --- /dev/null +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -0,0 +1,22 @@ +RedirectConnectAccountOptions | @auth0/auth0-spa-js

    Interface RedirectConnectAccountOptions<TAppState>

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

    Type Parameters

    • TAppState = any

    Properties

    appState?: TAppState

    Optional application state to persist through the transaction.

    +

    Example

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

    Additional authorization parameters for the request.

    +

    Example

    await auth0.connectAccountWithRedirect({
    connection: 'google-oauth2',
    authorization_params: {
    scope: 'https://www.googleapis.com/auth/calendar'
    access_type: 'offline'
    }
    }); +
    +

    Example

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

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

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

    Optional function to handle the redirect URL.

    +

    Type declaration

      • (url): Promise<void>
      • Optional function to handle the redirect URL.

        +

        Parameters

        • url: string

        Returns Promise<void>

        Example

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

    Example

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

    The URI to redirect back to after connecting the account.

    +
    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 62a937b19..c6e9f6771 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,13 +1,13 @@ -RedirectLoginOptions | @auth0/auth0-spa-js

    Interface RedirectLoginOptions<TAppState>

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

    Type Parameters

    • TAppState = any

    Hierarchy

    • BaseLoginOptions
      • RedirectLoginOptions

    Properties

    appState? +RedirectLoginOptions | @auth0/auth0-spa-js

    Interface RedirectLoginOptions<TAppState>

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

    Type Parameters

    • TAppState = any

    Hierarchy

    • BaseLoginOptions
      • RedirectLoginOptions

    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

    -
    onRedirect?: ((url) => Promise<void>)

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

    +
    fragment?: string

    Used to add to the URL fragment before redirecting

    +
    onRedirect?: ((url) => Promise<void>)

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

    Type declaration

      • (url): Promise<void>
      • Used to control the redirect and not rely on the SDK to do the actual redirect.

        Parameters

        • url: string

        Returns Promise<void>

        Example

        const client = new Auth0Client({
        async onRedirect(url) {
        window.location.replace(url);
        }
        });
        @@ -15,7 +15,7 @@

        Deprecated

        since v2.0.1, use openUrl instead.

    Example

    const client = new Auth0Client({
    async onRedirect(url) {
    window.location.replace(url);
    }
    });

    Deprecated

    since v2.0.1, use openUrl instead.

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

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

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

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

    Type declaration

      • (url): void | Promise<void>
      • Used to control the redirect and not rely on the SDK to do the actual redirect.

        Parameters

        • url: string

        Returns void | Promise<void>

        Example

        const client = new Auth0Client({
        openUrl(url) {
        window.location.replace(url);
        }
        });
        @@ -25,4 +25,4 @@

        Example

        import<
         

        Example

        import { Browser } from '@capacitor/browser';

        const client = new Auth0Client({
        async openUrl(url) {
        await Browser.open({ url });
        }
        });
        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginResult.html b/docs/interfaces/RedirectLoginResult.html index 1cbe28fd7..86ceffb48 100644 --- a/docs/interfaces/RedirectLoginResult.html +++ b/docs/interfaces/RedirectLoginResult.html @@ -1,3 +1,5 @@ -RedirectLoginResult | @auth0/auth0-spa-js

    Interface RedirectLoginResult<TAppState>

    interface RedirectLoginResult<TAppState> {
        appState?: TAppState;
    }

    Type Parameters

    • TAppState = any

    Properties

    appState? +RedirectLoginResult | @auth0/auth0-spa-js

    Interface RedirectLoginResult<TAppState>

    interface RedirectLoginResult<TAppState> {
        appState?: TAppState;
        response_type: Code;
    }

    Type Parameters

    • TAppState = any

    Properties

    appState?: TAppState

    State stored when the redirect request was made

    -
    \ No newline at end of file +
    response_type: Code

    The type of response, for login it will be code

    +
    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index eac2a3083..70e442db0 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,11 +1,14 @@ -@auth0/auth0-spa-js
    \ No newline at end of file diff --git a/docs/types/CacheEntry.html b/docs/types/CacheEntry.html index 8b567cd57..a49758ac8 100644 --- a/docs/types/CacheEntry.html +++ b/docs/types/CacheEntry.html @@ -1 +1 @@ -CacheEntry | @auth0/auth0-spa-js

    Type alias CacheEntry

    CacheEntry: {
        access_token: string;
        audience: string;
        client_id: string;
        decodedToken?: DecodedToken;
        expires_in: number;
        id_token?: string;
        oauthTokenScope?: string;
        refresh_token?: string;
        scope: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • audience: string
    • client_id: string
    • Optional decodedToken?: DecodedToken
    • expires_in: number
    • Optional id_token?: string
    • Optional oauthTokenScope?: string
    • Optional refresh_token?: string
    • scope: string
    • Optional token_type?: string
    \ No newline at end of file +CacheEntry | @auth0/auth0-spa-js

    Type alias CacheEntry

    CacheEntry: {
        access_token: string;
        audience: string;
        client_id: string;
        decodedToken?: DecodedToken;
        expires_in: number;
        id_token?: string;
        oauthTokenScope?: string;
        refresh_token?: string;
        scope: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • audience: string
    • client_id: string
    • Optional decodedToken?: DecodedToken
    • expires_in: number
    • Optional id_token?: string
    • Optional oauthTokenScope?: string
    • Optional refresh_token?: string
    • scope: string
    • Optional token_type?: string
    \ No newline at end of file diff --git a/docs/types/CacheKeyData.html b/docs/types/CacheKeyData.html index ba5a3f2a6..7869cdb81 100644 --- a/docs/types/CacheKeyData.html +++ b/docs/types/CacheKeyData.html @@ -1 +1 @@ -CacheKeyData | @auth0/auth0-spa-js

    Type alias CacheKeyData

    CacheKeyData: {
        audience?: string;
        clientId: string;
        scope?: string;
    }

    Type declaration

    • Optional audience?: string
    • clientId: string
    • Optional scope?: string
    \ No newline at end of file +CacheKeyData | @auth0/auth0-spa-js

    Type alias CacheKeyData

    CacheKeyData: {
        audience?: string;
        clientId: string;
        scope?: string;
    }

    Type declaration

    • Optional audience?: string
    • clientId: string
    • Optional scope?: string
    \ No newline at end of file diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 52cc980c1..64001f82d 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,2 +1,2 @@ CacheLocation | @auth0/auth0-spa-js
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index b1cb84606..695ac1067 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1 +1 @@ -Cacheable | @auth0/auth0-spa-js
    \ No newline at end of file +Cacheable | @auth0/auth0-spa-js
    \ No newline at end of file diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html new file mode 100644 index 000000000..8db13b839 --- /dev/null +++ b/docs/types/ConnectAccountRedirectResult.html @@ -0,0 +1,9 @@ +ConnectAccountRedirectResult | @auth0/auth0-spa-js

    Type alias ConnectAccountRedirectResult<TAppState>

    ConnectAccountRedirectResult<TAppState>: CompleteResponse & {
        appState?: TAppState;
        response_type: ConnectCode;
    }

    The result returned after a successful account connection redirect.

    +

    Combines the redirect login result (including any persisted app state) +with the complete response from the My Account API.

    +

    Type Parameters

    • TAppState = any

      The type of application state persisted through the transaction.

      +

    Type declaration

    • Optional appState?: TAppState

      State stored when the redirect request was made

      +
    • response_type: ConnectCode

      The type of response, for connect account it will be connect_code

      +

    Example

    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' +
    +
    \ No newline at end of file diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html index fbc3793c4..703c61635 100644 --- a/docs/types/FetcherConfig.html +++ b/docs/types/FetcherConfig.html @@ -1 +1 @@ -FetcherConfig | @auth0/auth0-spa-js

    Type alias FetcherConfig<TOutput>

    FetcherConfig<TOutput>: {
        baseUrl?: string;
        dpopNonceId?: string;
        fetch?: CustomFetchImpl<TOutput>;
        getAccessToken?: AccessTokenFactory;
    }

    Type Parameters

    • TOutput extends CustomFetchMinimalOutput

    Type declaration

    • Optional baseUrl?: string
    • Optional dpopNonceId?: string
    • Optional fetch?: CustomFetchImpl<TOutput>
    • Optional getAccessToken?: AccessTokenFactory
    \ No newline at end of file +FetcherConfig | @auth0/auth0-spa-js

    Type alias FetcherConfig<TOutput>

    FetcherConfig<TOutput>: {
        baseUrl?: string;
        dpopNonceId?: string;
        fetch?: CustomFetchImpl<TOutput>;
        getAccessToken?: AccessTokenFactory;
    }

    Type Parameters

    • TOutput extends CustomFetchMinimalOutput

    Type declaration

    • Optional baseUrl?: string
    • Optional dpopNonceId?: string
    • Optional fetch?: CustomFetchImpl<TOutput>
    • Optional getAccessToken?: AccessTokenFactory
    \ No newline at end of file diff --git a/docs/types/GetTokenSilentlyVerboseResponse.html b/docs/types/GetTokenSilentlyVerboseResponse.html index 32362a21b..71c242ac2 100644 --- a/docs/types/GetTokenSilentlyVerboseResponse.html +++ b/docs/types/GetTokenSilentlyVerboseResponse.html @@ -1 +1 @@ -GetTokenSilentlyVerboseResponse | @auth0/auth0-spa-js
    \ No newline at end of file +GetTokenSilentlyVerboseResponse | @auth0/auth0-spa-js
    \ No newline at end of file diff --git a/docs/types/KeyManifestEntry.html b/docs/types/KeyManifestEntry.html index b90876e5f..29a68c10f 100644 --- a/docs/types/KeyManifestEntry.html +++ b/docs/types/KeyManifestEntry.html @@ -1 +1 @@ -KeyManifestEntry | @auth0/auth0-spa-js
    \ No newline at end of file +KeyManifestEntry | @auth0/auth0-spa-js
    \ No newline at end of file diff --git a/docs/types/MaybePromise.html b/docs/types/MaybePromise.html index 741aecc62..6f3ec30cb 100644 --- a/docs/types/MaybePromise.html +++ b/docs/types/MaybePromise.html @@ -1 +1 @@ -MaybePromise | @auth0/auth0-spa-js
    \ No newline at end of file +MaybePromise | @auth0/auth0-spa-js
    \ No newline at end of file diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index f753c8810..c91bdb14d 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1 +1 @@ -TokenEndpointResponse | @auth0/auth0-spa-js

    Type alias TokenEndpointResponse

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

    Type declaration

    • access_token: string
    • expires_in: number
    • id_token: string
    • Optional refresh_token?: string
    • Optional scope?: string
    • token_type: string
    \ No newline at end of file +TokenEndpointResponse | @auth0/auth0-spa-js

    Type alias TokenEndpointResponse

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

    Type declaration

    • access_token: string
    • expires_in: number
    • id_token: string
    • Optional refresh_token?: string
    • Optional scope?: string
    • token_type: string
    \ No newline at end of file diff --git a/docs/types/WrappedCacheEntry.html b/docs/types/WrappedCacheEntry.html index ed2944020..f830ef34d 100644 --- a/docs/types/WrappedCacheEntry.html +++ b/docs/types/WrappedCacheEntry.html @@ -1 +1 @@ -WrappedCacheEntry | @auth0/auth0-spa-js
    \ No newline at end of file +WrappedCacheEntry | @auth0/auth0-spa-js
    \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 662991659..705d00adc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-spa-js", - "version": "2.5.0", + "version": "2.6.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-spa-js", - "version": "2.5.0", + "version": "2.6.0", "license": "MIT", "dependencies": { "browser-tabs-lock": "^1.2.15", diff --git a/package.json b/package.json index 33bdad01f..e63919820 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "@auth0/auth0-spa-js", "description": "Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE", "license": "MIT", - "version": "2.5.0", + "version": "2.6.0", "main": "dist/lib/auth0-spa-js.cjs.js", "types": "dist/typings/index.d.ts", "module": "dist/auth0-spa-js.production.esm.js", diff --git a/src/version.ts b/src/version.ts index 7bbbdcc04..265de7683 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.5.0'; +export default '2.6.0';