diff --git a/CHANGELOG.md b/CHANGELOG.md index b019017a..21d52462 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.1.0](https://github.com/auth0/auth0-react/tree/v2.1.0) (2023-05-05) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.0.2...v2.1.0) + +**Added** +- Adding onBeforeAuthentication to the withAuthenticationRequired HOC [\#534](https://github.com/auth0/auth0-react/pull/534) ([stephenkelzer](https://github.com/stephenkelzer)) + ## [v2.0.2](https://github.com/auth0/auth0-react/tree/v2.0.2) (2023-04-26) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.0.1...v2.0.2) diff --git a/docs/assets/search.js b/docs/assets/search.js index 4afc3962..da03592c 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"Auth0Provider\",\"url\":\"functions/Auth0Provider.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"Auth0ProviderOptions\",\"url\":\"interfaces/Auth0ProviderOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"children\",\"url\":\"interfaces/Auth0ProviderOptions.html#children\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"onRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ProviderOptions.onRedirectCallback\"},{\"kind\":1024,\"name\":\"skipRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#skipRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/Auth0ProviderOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":4194304,\"name\":\"AppState\",\"url\":\"types/AppState.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AppState.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AppState\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"types/AppState.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppState.__type\"},{\"kind\":64,\"name\":\"useAuth0\",\"url\":\"functions/useAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"withAuth0\",\"url\":\"functions/withAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuth0Props\",\"url\":\"interfaces/WithAuth0Props.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"auth0\",\"url\":\"interfaces/WithAuth0Props.html#auth0\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuth0Props\"},{\"kind\":64,\"name\":\"withAuthenticationRequired\",\"url\":\"functions/withAuthenticationRequired.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuthenticationRequiredOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"onRedirecting\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"WithAuthenticationRequiredOptions.onRedirecting\"},{\"kind\":1024,\"name\":\"loginOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#loginOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":32,\"name\":\"Auth0Context\",\"url\":\"variables/Auth0Context.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"Auth0ContextInterface\",\"url\":\"interfaces/Auth0ContextInterface.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"getAccessTokenSilently\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenSilently\"},{\"kind\":1024,\"name\":\"getAccessTokenWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenWithPopup\"},{\"kind\":1024,\"name\":\"getIdTokenClaims\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getIdTokenClaims\"},{\"kind\":1024,\"name\":\"loginWithRedirect\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithRedirect\"},{\"kind\":1024,\"name\":\"loginWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithPopup\"},{\"kind\":1024,\"name\":\"logout\",\"url\":\"interfaces/Auth0ContextInterface.html#logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#logout.__type-14\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.logout\"},{\"kind\":1024,\"name\":\"handleRedirectCallback\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.handleRedirectCallback\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/Auth0ContextInterface.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/Auth0ContextInterface.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isLoading\",\"url\":\"interfaces/Auth0ContextInterface.html#isLoading\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/Auth0ContextInterface.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":128,\"name\":\"OAuthError\",\"url\":\"classes/OAuthError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/OAuthError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/OAuthError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/OAuthError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.657]],[\"comment/0\",[]],[\"name/1\",[1,34.657]],[\"comment/1\",[]],[\"name/2\",[2,34.657]],[\"comment/2\",[]],[\"name/3\",[3,34.657]],[\"comment/3\",[]],[\"name/4\",[4,15.198]],[\"comment/4\",[]],[\"name/5\",[5,34.657]],[\"comment/5\",[]],[\"name/6\",[6,29.549]],[\"comment/6\",[]],[\"name/7\",[7,34.657]],[\"comment/7\",[]],[\"name/8\",[4,15.198]],[\"comment/8\",[]],[\"name/9\",[8,29.549]],[\"comment/9\",[]],[\"name/10\",[9,34.657]],[\"comment/10\",[]],[\"name/11\",[10,34.657]],[\"comment/11\",[]],[\"name/12\",[11,34.657]],[\"comment/12\",[]],[\"name/13\",[12,34.657]],[\"comment/13\",[]],[\"name/14\",[13,34.657]],[\"comment/14\",[]],[\"name/15\",[14,34.657]],[\"comment/15\",[]],[\"name/16\",[8,29.549]],[\"comment/16\",[]],[\"name/17\",[15,34.657]],[\"comment/17\",[]],[\"name/18\",[4,15.198]],[\"comment/18\",[]],[\"name/19\",[16,34.657]],[\"comment/19\",[]],[\"name/20\",[6,29.549]],[\"comment/20\",[]],[\"name/21\",[17,34.657]],[\"comment/21\",[]],[\"name/22\",[18,34.657]],[\"comment/22\",[]],[\"name/23\",[19,34.657]],[\"comment/23\",[]],[\"name/24\",[4,15.198]],[\"comment/24\",[]],[\"name/25\",[20,34.657]],[\"comment/25\",[]],[\"name/26\",[4,15.198]],[\"comment/26\",[]],[\"name/27\",[21,34.657]],[\"comment/27\",[]],[\"name/28\",[4,15.198]],[\"comment/28\",[]],[\"name/29\",[22,34.657]],[\"comment/29\",[]],[\"name/30\",[4,15.198]],[\"comment/30\",[]],[\"name/31\",[23,34.657]],[\"comment/31\",[]],[\"name/32\",[4,15.198]],[\"comment/32\",[]],[\"name/33\",[24,34.657]],[\"comment/33\",[]],[\"name/34\",[4,15.198]],[\"comment/34\",[]],[\"name/35\",[25,34.657]],[\"comment/35\",[]],[\"name/36\",[4,15.198]],[\"comment/36\",[]],[\"name/37\",[26,29.549]],[\"comment/37\",[]],[\"name/38\",[27,34.657]],[\"comment/38\",[]],[\"name/39\",[28,34.657]],[\"comment/39\",[]],[\"name/40\",[29,34.657]],[\"comment/40\",[]],[\"name/41\",[30,34.657]],[\"comment/41\",[]],[\"name/42\",[31,34.657]],[\"comment/42\",[]],[\"name/43\",[32,34.657]],[\"comment/43\",[]],[\"name/44\",[33,34.657]],[\"comment/44\",[]],[\"name/45\",[26,29.549]],[\"comment/45\",[]],[\"name/46\",[34,34.657]],[\"comment/46\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"8\":{},\"18\":{},\"24\":{},\"26\":{},\"28\":{},\"30\":{},\"32\":{},\"34\":{},\"36\":{}},\"comment\":{}}],[\"appstate\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"auth0\",{\"_index\":12,\"name\":{\"13\":{}},\"comment\":{}}],[\"auth0context\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"auth0contextinterface\",{\"_index\":18,\"name\":{\"22\":{}},\"comment\":{}}],[\"auth0provider\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"auth0provideroptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"children\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":33,\"name\":{\"44\":{}},\"comment\":{}}],[\"context\",{\"_index\":6,\"name\":{\"6\":{},\"20\":{}},\"comment\":{}}],[\"error\",{\"_index\":26,\"name\":{\"37\":{},\"45\":{}},\"comment\":{}}],[\"error_description\",{\"_index\":34,\"name\":{\"46\":{}},\"comment\":{}}],[\"getaccesstokensilently\",{\"_index\":19,\"name\":{\"23\":{}},\"comment\":{}}],[\"getaccesstokenwithpopup\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"getidtokenclaims\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"handleredirectcallback\",{\"_index\":25,\"name\":{\"35\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":27,\"name\":{\"38\":{}},\"comment\":{}}],[\"isloading\",{\"_index\":28,\"name\":{\"39\":{}},\"comment\":{}}],[\"loginoptions\",{\"_index\":16,\"name\":{\"19\":{}},\"comment\":{}}],[\"loginwithpopup\",{\"_index\":23,\"name\":{\"31\":{}},\"comment\":{}}],[\"loginwithredirect\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"logout\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":30,\"name\":{\"41\":{}},\"comment\":{}}],[\"oautherror\",{\"_index\":32,\"name\":{\"43\":{}},\"comment\":{}}],[\"onredirectcallback\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"onredirecting\",{\"_index\":15,\"name\":{\"17\":{}},\"comment\":{}}],[\"redirectloginoptions\",{\"_index\":31,\"name\":{\"42\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":8,\"name\":{\"9\":{},\"16\":{}},\"comment\":{}}],[\"skipredirectcallback\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"useauth0\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"user\",{\"_index\":29,\"name\":{\"40\":{}},\"comment\":{}}],[\"withauth0\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"withauth0props\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"withauthenticationrequired\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"withauthenticationrequiredoptions\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"Auth0Provider\",\"url\":\"functions/Auth0Provider.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"Auth0ProviderOptions\",\"url\":\"interfaces/Auth0ProviderOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"children\",\"url\":\"interfaces/Auth0ProviderOptions.html#children\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"onRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ProviderOptions.onRedirectCallback\"},{\"kind\":1024,\"name\":\"skipRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#skipRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/Auth0ProviderOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":4194304,\"name\":\"AppState\",\"url\":\"types/AppState.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AppState.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AppState\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"types/AppState.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppState.__type\"},{\"kind\":64,\"name\":\"useAuth0\",\"url\":\"functions/useAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"withAuth0\",\"url\":\"functions/withAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuth0Props\",\"url\":\"interfaces/WithAuth0Props.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"auth0\",\"url\":\"interfaces/WithAuth0Props.html#auth0\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuth0Props\"},{\"kind\":64,\"name\":\"withAuthenticationRequired\",\"url\":\"functions/withAuthenticationRequired.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuthenticationRequiredOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"onRedirecting\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"WithAuthenticationRequiredOptions.onRedirecting\"},{\"kind\":1024,\"name\":\"onBeforeAuthentication\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onBeforeAuthentication\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onBeforeAuthentication.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"WithAuthenticationRequiredOptions.onBeforeAuthentication\"},{\"kind\":1024,\"name\":\"loginOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#loginOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":32,\"name\":\"Auth0Context\",\"url\":\"variables/Auth0Context.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"Auth0ContextInterface\",\"url\":\"interfaces/Auth0ContextInterface.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"getAccessTokenSilently\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenSilently\"},{\"kind\":1024,\"name\":\"getAccessTokenWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenWithPopup\"},{\"kind\":1024,\"name\":\"getIdTokenClaims\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getIdTokenClaims\"},{\"kind\":1024,\"name\":\"loginWithRedirect\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithRedirect\"},{\"kind\":1024,\"name\":\"loginWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithPopup\"},{\"kind\":1024,\"name\":\"logout\",\"url\":\"interfaces/Auth0ContextInterface.html#logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#logout.__type-14\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.logout\"},{\"kind\":1024,\"name\":\"handleRedirectCallback\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.handleRedirectCallback\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/Auth0ContextInterface.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/Auth0ContextInterface.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isLoading\",\"url\":\"interfaces/Auth0ContextInterface.html#isLoading\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/Auth0ContextInterface.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":128,\"name\":\"OAuthError\",\"url\":\"classes/OAuthError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/OAuthError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/OAuthError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/OAuthError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,35.066]],[\"comment/0\",[]],[\"name/1\",[1,35.066]],[\"comment/1\",[]],[\"name/2\",[2,35.066]],[\"comment/2\",[]],[\"name/3\",[3,35.066]],[\"comment/3\",[]],[\"name/4\",[4,14.697]],[\"comment/4\",[]],[\"name/5\",[5,35.066]],[\"comment/5\",[]],[\"name/6\",[6,29.957]],[\"comment/6\",[]],[\"name/7\",[7,35.066]],[\"comment/7\",[]],[\"name/8\",[4,14.697]],[\"comment/8\",[]],[\"name/9\",[8,29.957]],[\"comment/9\",[]],[\"name/10\",[9,35.066]],[\"comment/10\",[]],[\"name/11\",[10,35.066]],[\"comment/11\",[]],[\"name/12\",[11,35.066]],[\"comment/12\",[]],[\"name/13\",[12,35.066]],[\"comment/13\",[]],[\"name/14\",[13,35.066]],[\"comment/14\",[]],[\"name/15\",[14,35.066]],[\"comment/15\",[]],[\"name/16\",[8,29.957]],[\"comment/16\",[]],[\"name/17\",[15,35.066]],[\"comment/17\",[]],[\"name/18\",[4,14.697]],[\"comment/18\",[]],[\"name/19\",[16,35.066]],[\"comment/19\",[]],[\"name/20\",[4,14.697]],[\"comment/20\",[]],[\"name/21\",[17,35.066]],[\"comment/21\",[]],[\"name/22\",[6,29.957]],[\"comment/22\",[]],[\"name/23\",[18,35.066]],[\"comment/23\",[]],[\"name/24\",[19,35.066]],[\"comment/24\",[]],[\"name/25\",[20,35.066]],[\"comment/25\",[]],[\"name/26\",[4,14.697]],[\"comment/26\",[]],[\"name/27\",[21,35.066]],[\"comment/27\",[]],[\"name/28\",[4,14.697]],[\"comment/28\",[]],[\"name/29\",[22,35.066]],[\"comment/29\",[]],[\"name/30\",[4,14.697]],[\"comment/30\",[]],[\"name/31\",[23,35.066]],[\"comment/31\",[]],[\"name/32\",[4,14.697]],[\"comment/32\",[]],[\"name/33\",[24,35.066]],[\"comment/33\",[]],[\"name/34\",[4,14.697]],[\"comment/34\",[]],[\"name/35\",[25,35.066]],[\"comment/35\",[]],[\"name/36\",[4,14.697]],[\"comment/36\",[]],[\"name/37\",[26,35.066]],[\"comment/37\",[]],[\"name/38\",[4,14.697]],[\"comment/38\",[]],[\"name/39\",[27,29.957]],[\"comment/39\",[]],[\"name/40\",[28,35.066]],[\"comment/40\",[]],[\"name/41\",[29,35.066]],[\"comment/41\",[]],[\"name/42\",[30,35.066]],[\"comment/42\",[]],[\"name/43\",[31,35.066]],[\"comment/43\",[]],[\"name/44\",[32,35.066]],[\"comment/44\",[]],[\"name/45\",[33,35.066]],[\"comment/45\",[]],[\"name/46\",[34,35.066]],[\"comment/46\",[]],[\"name/47\",[27,29.957]],[\"comment/47\",[]],[\"name/48\",[35,35.066]],[\"comment/48\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"8\":{},\"18\":{},\"20\":{},\"26\":{},\"28\":{},\"30\":{},\"32\":{},\"34\":{},\"36\":{},\"38\":{}},\"comment\":{}}],[\"appstate\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"auth0\",{\"_index\":12,\"name\":{\"13\":{}},\"comment\":{}}],[\"auth0context\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"auth0contextinterface\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"auth0provider\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"auth0provideroptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"children\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":34,\"name\":{\"46\":{}},\"comment\":{}}],[\"context\",{\"_index\":6,\"name\":{\"6\":{},\"22\":{}},\"comment\":{}}],[\"error\",{\"_index\":27,\"name\":{\"39\":{},\"47\":{}},\"comment\":{}}],[\"error_description\",{\"_index\":35,\"name\":{\"48\":{}},\"comment\":{}}],[\"getaccesstokensilently\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"getaccesstokenwithpopup\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"getidtokenclaims\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"handleredirectcallback\",{\"_index\":26,\"name\":{\"37\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":28,\"name\":{\"40\":{}},\"comment\":{}}],[\"isloading\",{\"_index\":29,\"name\":{\"41\":{}},\"comment\":{}}],[\"loginoptions\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"loginwithpopup\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"loginwithredirect\",{\"_index\":23,\"name\":{\"31\":{}},\"comment\":{}}],[\"logout\",{\"_index\":25,\"name\":{\"35\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":31,\"name\":{\"43\":{}},\"comment\":{}}],[\"oautherror\",{\"_index\":33,\"name\":{\"45\":{}},\"comment\":{}}],[\"onbeforeauthentication\",{\"_index\":16,\"name\":{\"19\":{}},\"comment\":{}}],[\"onredirectcallback\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"onredirecting\",{\"_index\":15,\"name\":{\"17\":{}},\"comment\":{}}],[\"redirectloginoptions\",{\"_index\":32,\"name\":{\"44\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":8,\"name\":{\"9\":{},\"16\":{}},\"comment\":{}}],[\"skipredirectcallback\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"useauth0\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"user\",{\"_index\":30,\"name\":{\"42\":{}},\"comment\":{}}],[\"withauth0\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"withauth0props\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"withauthenticationrequired\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"withauthenticationrequiredoptions\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 3a985858..8ad2496d 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -27,7 +27,7 @@

Hierarchy

+
  • Defined in src/errors.tsx:7
  • @@ -68,19 +68,19 @@
    Optional error_description: Returns OAuthError
    +
  • Defined in src/errors.tsx:8
  • Properties

    error: string
    +
  • Defined in src/errors.tsx:8
  • error_description?: string
    +
  • Defined in src/errors.tsx:8
  • message: string
    +
  • Defined in src/auth0-provider.tsx:135
  • +
  • Defined in src/use-auth0.tsx:27
  • +
  • Defined in src/with-auth0.tsx:29
  • +
  • Defined in src/with-authentication-required.tsx:97
  • Returns Promise<string | GetTokenSilentlyVerboseResponse>

    +
  • Defined in src/auth0-context.tsx:52
  • getAccessTokenWithPopup: ((options?: GetTokenWithPopupOptions, config?: PopupConfigOptions) => Promise<undefined | string>)
    @@ -170,7 +170,7 @@
    Optional options: Optional config: PopupConfigOptions

    Returns Promise<undefined | string>

    +
  • Defined in src/auth0-context.tsx:74
  • getIdTokenClaims: (() => Promise<undefined | IdToken>)
    @@ -187,7 +187,7 @@

    Type declaration

    Returns Promise<undefined | IdToken>

    +
  • Defined in src/auth0-context.tsx:86
  • handleRedirectCallback: ((url?: string) => Promise<RedirectLoginResult<any>>)
    @@ -212,19 +212,19 @@
    Optional url: Returns Promise<RedirectLoginResult<any>>
    +
  • Defined in src/auth0-context.tsx:140
  • isAuthenticated: boolean
    +
  • Defined in src/auth-state.tsx:8
  • isLoading: boolean
    +
  • Defined in src/auth-state.tsx:9
  • loginWithPopup: ((options?: PopupLoginOptions, config?: PopupConfigOptions) => Promise<void>)
    @@ -254,7 +254,7 @@
    Optional options: Optional config: PopupConfigOptions

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:115
  • loginWithRedirect: ((options?: RedirectLoginOptions<AppState>) => Promise<void>)
    @@ -278,7 +278,7 @@

    Parameters

    Optional options: RedirectLoginOptions<AppState>

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:97
  • logout: ((options?: LogoutOptions) => void)
    @@ -303,13 +303,13 @@

    Parameters

    Optional options: LogoutOptions

    Returns void

    +
  • Defined in src/auth0-context.tsx:130
  • user?: TUser
    +
  • Defined in src/auth-state.tsx:10
  • +
  • Defined in src/auth0-provider.tsx:86
  • cookieDomain?: string
    @@ -250,7 +250,7 @@
    Optional appState: Optional user: User

    Returns void

    +
  • Defined in src/auth0-provider.tsx:54
  • sessionCheckExpiryDays?: number
    @@ -270,7 +270,7 @@
    +
  • Defined in src/auth0-provider.tsx:68
  • useCookiesForTransactions?: boolean
    diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index f81ba37b..6ef34e8f 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in src/auth0-context.tsx:18
  • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index d1894e99..7b7b9379 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RedirectLoginOptions
    +
  • Defined in src/auth0-context.tsx:20
  • diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 2138d821..df463107 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -23,7 +23,7 @@

    Hierarchy

    • WithAuth0Props
    +
  • Defined in src/with-auth0.tsx:7
  • @@ -39,7 +39,7 @@

    Properties

    +
  • Defined in src/with-auth0.tsx:8
  • +
  • Defined in src/with-authentication-required.tsx:86
  • loginOptions?: RedirectLoginOptions<AppState>
    @@ -56,7 +57,24 @@
    +
  • Defined in src/with-authentication-required.tsx:80
  • +
    + +
    onBeforeAuthentication?: (() => Promise<void>)
    +
    +

    Type declaration

    +
    onRedirecting?: (() => Element)
    @@ -65,7 +83,7 @@

    Type declaration

    +
  • Defined in src/with-authentication-required.tsx:55
  • returnTo?: string | (() => string)
    @@ -85,7 +103,7 @@
    +
  • Defined in src/with-authentication-required.tsx:45
  • \ No newline at end of file diff --git a/docs/types/AppState.html b/docs/types/AppState.html index a13d692e..0e2bf44f 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -26,7 +26,7 @@
    [key:
    Optional returnTo?: string
    +
  • Defined in src/auth0-provider.tsx:36
  • +
  • Defined in src/auth0-context.tsx:169