From 5de2037d3f8de4819b0bcb06ec12991a73e86012 Mon Sep 17 00:00:00 2001 From: adamjmcgrath Date: Tue, 24 Jan 2023 12:38:05 +0000 Subject: [PATCH] Release v2.2.0 --- CHANGELOG.md | 10 + docs/.nojekyll | 1 + docs/assets/css/main.css | 2660 ----------------- docs/assets/highlight.css | 106 + docs/assets/images/icons.png | Bin 9615 -> 0 bytes docs/assets/images/icons@2x.png | Bin 28144 -> 0 bytes docs/assets/images/widgets.png | Bin 480 -> 0 bytes docs/assets/images/widgets@2x.png | Bin 855 -> 0 bytes docs/assets/js/main.js | 248 -- docs/assets/js/search.js | 1 - docs/assets/main.js | 58 + docs/assets/search.js | 1 + docs/assets/style.css | 1280 ++++++++ docs/classes/AccessTokenError.html | 142 + docs/classes/AuthError.html | 136 + docs/classes/CallbackHandlerError.html | 151 + docs/classes/HandlerError.html | 149 + docs/classes/LoginHandlerError.html | 139 + docs/classes/LogoutHandlerError.html | 139 + docs/classes/ProfileHandlerError.html | 139 + docs/classes/Session.html | 139 + .../classes/client_use_user.requesterror.html | 301 -- docs/classes/index.applicationerror.html | 255 -- docs/classes/index.identityprovidererror.html | 306 -- .../index.missingstatecookieerror.html | 268 -- .../classes/index.missingstateparamerror.html | 268 -- docs/classes/index.sessioncache.html | 528 ---- docs/classes/session_session.default.html | 387 --- .../utils_errors.accesstokenerror.html | 392 --- docs/classes/utils_errors.autherror.html | 384 --- .../utils_errors.callbackhandlererror.html | 409 --- docs/classes/utils_errors.handlererror.html | 406 --- .../utils_errors.loginhandlererror.html | 397 --- .../utils_errors.logouthandlererror.html | 397 --- .../utils_errors.profilehandlererror.html | 397 --- docs/enums/AccessTokenErrorCode.html | 98 + .../utils_errors.accesstokenerrorcode.html | 319 -- docs/functions/_initAuth.html | 102 + docs/functions/getAccessToken-1.html | 110 + docs/functions/getSession-1.html | 106 + docs/functions/handleAuth-1.html | 116 + docs/functions/handleCallback-1.html | 126 + docs/functions/handleLogin-1.html | 126 + docs/functions/handleLogout-1.html | 126 + docs/functions/handleProfile-1.html | 126 + docs/functions/initAuth0-1.html | 105 + docs/functions/updateSession-1.html | 112 + docs/functions/withApiAuthRequired-1.html | 108 + docs/functions/withPageAuthRequired-1.html | 116 + docs/index.html | 368 +-- docs/interfaces/AccessTokenRequest.html | 107 + docs/interfaces/Auth0Server.html | 152 + docs/interfaces/CallbackOptions.html | 99 + docs/interfaces/Claims.html | 102 + docs/interfaces/GetAccessTokenResult.html | 69 + docs/interfaces/LoginOptions.html | 89 + docs/interfaces/LogoutOptions.html | 86 + .../client_use_user.userprofile.html | 362 --- ...ent_with_page_auth_required.userprops.html | 236 -- ..._required.withpageauthrequiredoptions.html | 334 --- .../config.authorizationparameters.html | 296 -- docs/interfaces/config.baseconfig.html | 657 ---- docs/interfaces/config.cookieconfig.html | 364 --- docs/interfaces/config.nextconfig.html | 308 -- docs/interfaces/config.sessionconfig.html | 433 --- .../handlers_callback.callbackoptions.html | 314 -- .../handlers_login.authorizationparams.html | 444 --- .../handlers_login.loginoptions.html | 300 -- .../handlers_logout.logoutoptions.html | 284 -- docs/interfaces/index.auth0server.html | 415 --- ...n_get_access_token.accesstokenrequest.html | 337 --- ...get_access_token.getaccesstokenresult.html | 251 -- docs/interfaces/session_session.claims.html | 217 -- docs/modules/client.html | 258 -- docs/modules/client_use_user.html | 434 --- .../client_with_page_auth_required.html | 263 -- docs/modules/config.html | 317 -- docs/modules/edge.html | 402 --- docs/modules/handlers.html | 321 -- docs/modules/handlers_auth.html | 368 --- docs/modules/handlers_callback.html | 534 ---- docs/modules/handlers_login.html | 478 --- docs/modules/handlers_logout.html | 405 --- docs/modules/handlers_profile.html | 489 --- docs/modules/helpers.html | 240 -- docs/modules/helpers_testing.html | 252 -- .../helpers_with_api_auth_required.html | 245 -- ...helpers_with_middleware_auth_required.html | 263 -- .../helpers_with_page_auth_required.html | 402 --- docs/modules/index.html | 1127 ------- docs/modules/session.html | 267 -- docs/modules/session_get_access_token.html | 306 -- docs/modules/session_get_session.html | 238 -- docs/modules/session_session.html | 205 -- docs/modules/session_update_session.html | 254 -- docs/modules/utils_errors.html | 229 -- docs/modules/version.html | 206 -- docs/types/AfterCallback.html | 132 + docs/types/AfterRefetch.html | 110 + docs/types/ConfigParameters.html | 168 ++ docs/types/GetAccessToken.html | 114 + docs/types/GetLoginState.html | 115 + .../GetServerSidePropsResultWithSession.html | 103 + docs/types/GetSession.html | 110 + docs/types/HandleAuth.html | 120 + docs/types/HandleCallback.html | 174 ++ docs/types/HandleLogin.html | 174 ++ docs/types/HandleLogout.html | 174 ++ docs/types/HandleProfile.html | 174 ++ docs/types/Handlers.html | 104 + docs/types/InitAuth0.html | 109 + docs/types/OnError.html | 115 + docs/types/PageRoute.html | 115 + docs/types/ProfileOptions.html | 111 + docs/types/SessionStore.html | 93 + docs/types/SessionStorePayload.html | 93 + docs/types/UpdateSession.html | 116 + docs/types/WithApiAuthRequired.html | 112 + docs/types/WithPageAuthRequired.html | 120 + docs/types/WithPageAuthRequiredOptions.html | 114 + package-lock.json | 4 +- package.json | 2 +- src/version.ts | 2 +- 123 files changed, 7806 insertions(+), 22589 deletions(-) create mode 100644 docs/.nojekyll delete mode 100644 docs/assets/css/main.css create mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/images/icons.png delete mode 100644 docs/assets/images/icons@2x.png delete mode 100644 docs/assets/images/widgets.png delete mode 100644 docs/assets/images/widgets@2x.png delete mode 100644 docs/assets/js/main.js delete mode 100644 docs/assets/js/search.js create mode 100644 docs/assets/main.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/classes/AccessTokenError.html create mode 100644 docs/classes/AuthError.html create mode 100644 docs/classes/CallbackHandlerError.html create mode 100644 docs/classes/HandlerError.html create mode 100644 docs/classes/LoginHandlerError.html create mode 100644 docs/classes/LogoutHandlerError.html create mode 100644 docs/classes/ProfileHandlerError.html create mode 100644 docs/classes/Session.html delete mode 100644 docs/classes/client_use_user.requesterror.html delete mode 100644 docs/classes/index.applicationerror.html delete mode 100644 docs/classes/index.identityprovidererror.html delete mode 100644 docs/classes/index.missingstatecookieerror.html delete mode 100644 docs/classes/index.missingstateparamerror.html delete mode 100644 docs/classes/index.sessioncache.html delete mode 100644 docs/classes/session_session.default.html delete mode 100644 docs/classes/utils_errors.accesstokenerror.html delete mode 100644 docs/classes/utils_errors.autherror.html delete mode 100644 docs/classes/utils_errors.callbackhandlererror.html delete mode 100644 docs/classes/utils_errors.handlererror.html delete mode 100644 docs/classes/utils_errors.loginhandlererror.html delete mode 100644 docs/classes/utils_errors.logouthandlererror.html delete mode 100644 docs/classes/utils_errors.profilehandlererror.html create mode 100644 docs/enums/AccessTokenErrorCode.html delete mode 100644 docs/enums/utils_errors.accesstokenerrorcode.html create mode 100644 docs/functions/_initAuth.html create mode 100644 docs/functions/getAccessToken-1.html create mode 100644 docs/functions/getSession-1.html create mode 100644 docs/functions/handleAuth-1.html create mode 100644 docs/functions/handleCallback-1.html create mode 100644 docs/functions/handleLogin-1.html create mode 100644 docs/functions/handleLogout-1.html create mode 100644 docs/functions/handleProfile-1.html create mode 100644 docs/functions/initAuth0-1.html create mode 100644 docs/functions/updateSession-1.html create mode 100644 docs/functions/withApiAuthRequired-1.html create mode 100644 docs/functions/withPageAuthRequired-1.html create mode 100644 docs/interfaces/AccessTokenRequest.html create mode 100644 docs/interfaces/Auth0Server.html create mode 100644 docs/interfaces/CallbackOptions.html create mode 100644 docs/interfaces/Claims.html create mode 100644 docs/interfaces/GetAccessTokenResult.html create mode 100644 docs/interfaces/LoginOptions.html create mode 100644 docs/interfaces/LogoutOptions.html delete mode 100644 docs/interfaces/client_use_user.userprofile.html delete mode 100644 docs/interfaces/client_with_page_auth_required.userprops.html delete mode 100644 docs/interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html delete mode 100644 docs/interfaces/config.authorizationparameters.html delete mode 100644 docs/interfaces/config.baseconfig.html delete mode 100644 docs/interfaces/config.cookieconfig.html delete mode 100644 docs/interfaces/config.nextconfig.html delete mode 100644 docs/interfaces/config.sessionconfig.html delete mode 100644 docs/interfaces/handlers_callback.callbackoptions.html delete mode 100644 docs/interfaces/handlers_login.authorizationparams.html delete mode 100644 docs/interfaces/handlers_login.loginoptions.html delete mode 100644 docs/interfaces/handlers_logout.logoutoptions.html delete mode 100644 docs/interfaces/index.auth0server.html delete mode 100644 docs/interfaces/session_get_access_token.accesstokenrequest.html delete mode 100644 docs/interfaces/session_get_access_token.getaccesstokenresult.html delete mode 100644 docs/interfaces/session_session.claims.html delete mode 100644 docs/modules/client.html delete mode 100644 docs/modules/client_use_user.html delete mode 100644 docs/modules/client_with_page_auth_required.html delete mode 100644 docs/modules/config.html delete mode 100644 docs/modules/edge.html delete mode 100644 docs/modules/handlers.html delete mode 100644 docs/modules/handlers_auth.html delete mode 100644 docs/modules/handlers_callback.html delete mode 100644 docs/modules/handlers_login.html delete mode 100644 docs/modules/handlers_logout.html delete mode 100644 docs/modules/handlers_profile.html delete mode 100644 docs/modules/helpers.html delete mode 100644 docs/modules/helpers_testing.html delete mode 100644 docs/modules/helpers_with_api_auth_required.html delete mode 100644 docs/modules/helpers_with_middleware_auth_required.html delete mode 100644 docs/modules/helpers_with_page_auth_required.html delete mode 100644 docs/modules/index.html delete mode 100644 docs/modules/session.html delete mode 100644 docs/modules/session_get_access_token.html delete mode 100644 docs/modules/session_get_session.html delete mode 100644 docs/modules/session_session.html delete mode 100644 docs/modules/session_update_session.html delete mode 100644 docs/modules/utils_errors.html delete mode 100644 docs/modules/version.html create mode 100644 docs/types/AfterCallback.html create mode 100644 docs/types/AfterRefetch.html create mode 100644 docs/types/ConfigParameters.html create mode 100644 docs/types/GetAccessToken.html create mode 100644 docs/types/GetLoginState.html create mode 100644 docs/types/GetServerSidePropsResultWithSession.html create mode 100644 docs/types/GetSession.html create mode 100644 docs/types/HandleAuth.html create mode 100644 docs/types/HandleCallback.html create mode 100644 docs/types/HandleLogin.html create mode 100644 docs/types/HandleLogout.html create mode 100644 docs/types/HandleProfile.html create mode 100644 docs/types/Handlers.html create mode 100644 docs/types/InitAuth0.html create mode 100644 docs/types/OnError.html create mode 100644 docs/types/PageRoute.html create mode 100644 docs/types/ProfileOptions.html create mode 100644 docs/types/SessionStore.html create mode 100644 docs/types/SessionStorePayload.html create mode 100644 docs/types/UpdateSession.html create mode 100644 docs/types/WithApiAuthRequired.html create mode 100644 docs/types/WithPageAuthRequired.html create mode 100644 docs/types/WithPageAuthRequiredOptions.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 382b3254c..a8a354488 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [v2.2.0](https://github.com/auth0/nextjs-auth0/tree/v2.2.0) (2023-01-24) +[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.1.0...v2.2.0) + +**Added** +- [SDK-3862] Add support for JWT client authentication [\#1029](https://github.com/auth0/nextjs-auth0/pull/1029) ([ewanharris](https://github.com/ewanharris)) + +**Fixed** +- withMiddlewareAuthRequired returnTo should be a relative url [\#1028](https://github.com/auth0/nextjs-auth0/pull/1028) ([adamjmcgrath](https://github.com/adamjmcgrath)) +- Infer user exists if WithPageAuthRequired page is rendered [\#1014](https://github.com/auth0/nextjs-auth0/pull/1014) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v2.1.0](https://github.com/auth0/nextjs-auth0/tree/v2.1.0) (2023-01-11) [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.0.1...v2.1.0) diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css deleted file mode 100644 index 46571c27c..000000000 --- a/docs/assets/css/main.css +++ /dev/null @@ -1,2660 +0,0 @@ -:root { - --color-background: #fdfdfd; - --color-text: #222; - --color-text-aside: #707070; - --color-link: #4da6ff; - --color-menu-divider: #eee; - --color-menu-divider-focus: #000; - --color-menu-label: #707070; - --color-panel: #fff; - --color-panel-divider: #eee; - --color-comment-tag: #707070; - --color-comment-tag-text: #fff; - --color-code-background: rgba(0, 0, 0, 0.04); - --color-ts: #9600ff; - --color-ts-interface: #647f1b; - --color-ts-enum: #937210; - --color-ts-class: #0672de; - --color-ts-private: #707070; - --color-toolbar: #fff; - --color-toolbar-text: #333; -} - -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * * HTML5 display definitions - * * ========================================================================== */ -/** - * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; -} - -/** - * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; -} - -/** - * * Prevent modern browsers from displaying `audio` without controls. - * * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * * Known issue: no IE 6 support. */ -[hidden] { - display: none; -} - -/* ========================================================================== - * * Base - * * ========================================================================== */ -/** - * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * * `em` units. - * * 2. Prevent iOS text size adjust after orientation change, without disabling - * * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; -} - -/** - * * Address `font-family` inconsistency between `textarea` and other form - * * elements. */ -button, input, select, textarea { - font-family: sans-serif; -} - -/** - * * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; -} - -/* ========================================================================== - * * Links - * * ========================================================================== */ -/** - * * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; -} -a:active, a:hover { - outline: 0; -} - -/** - * * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * * Typography - * * ========================================================================== */ -/** - * * Address font sizes and margins set differently in IE 6/7. - * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -/** - * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; -} - -blockquote { - margin: 1em 40px; -} - -/** - * * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; -} - -/** - * * Address differences between Firefox and other browsers. - * * Known issue: no IE 6/7 normalization. */ -hr { - -moz-box-sizing: content-box; - box-sizing: content-box; - height: 0; -} - -/** - * * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; -} - -/** - * * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; -} - -/** - * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: "courier new", monospace; - font-size: 1em; -} - -/** - * * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -/** - * * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; -} -q:before, q:after { - content: ""; - content: none; -} - -/** - * * Address `quotes` property not supported in Safari 4. */ -/** - * * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; -} - -/** - * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* ========================================================================== - * * Lists - * * ========================================================================== */ -/** - * * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -/** - * * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; -} - -/** - * * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; -} - -/* ========================================================================== - * * Embedded content - * * ========================================================================== */ -/** - * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; -} - -/* 2 */ -/** - * * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; -} - -/* ========================================================================== - * * Figures - * * ========================================================================== */ -/** - * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; -} - -/* ========================================================================== - * * Forms - * * ========================================================================== */ -/** - * * Correct margin displayed oddly in IE 6/7. */ -/** - * * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * * 1. Correct color not being inherited in IE 6/7/8/9. - * * 2. Correct text not wrapping in Firefox 3. - * * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; -} - -/* 3 */ -/** - * * 1. Correct font size not being inherited in all browsers. - * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * * and Chrome. - * * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; -} - -/* 3 */ -/** - * * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * * the UA stylesheet. */ -button, input { - line-height: normal; -} - -/** - * * Address inconsistent `text-transform` inheritance for `button` and `select`. - * * All other form control elements do not inherit `text-transform` values. - * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; -} - -/** - * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * * and `video` controls. - * * 2. Correct inability to style clickable `input` types in iOS. - * * 3. Improve usability and consistency of cursor style between image-type - * * `input` and others. - * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * * Known issue: inner spacing remains in IE 6. */ -button, html input[type=button] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -input[type=reset], input[type=submit] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -/** - * * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; -} - -/** - * * 1. Address box sizing set to content-box in IE 8/9. - * * 2. Remove excess padding in IE 8/9. - * * 3. Remove excess padding in IE 7. - * * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ -} -input[type=checkbox], input[type=radio] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; -} -input[type=search] { - -webkit-appearance: textfield; - /* 1 */ - -moz-box-sizing: content-box; - -webkit-box-sizing: content-box; - /* 2 */ - box-sizing: content-box; -} -input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * * (include `-moz` to future-proof). */ -/** - * * Remove inner padding and search cancel button in Safari 5 and Chrome - * * on OS X. */ -/** - * * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; -} - -/* 2 */ -/* ========================================================================== - * * Tables - * * ========================================================================== */ -/** - * * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; -} - -ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-1 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-1 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-1 { - width: 8.3333333333%; -} - -.offset-1 { - margin-left: 8.3333333333%; -} - -.col-2 { - width: 16.6666666667%; -} - -.offset-2 { - margin-left: 16.6666666667%; -} - -.col-3 { - width: 25%; -} - -.offset-3 { - margin-left: 25%; -} - -.col-4 { - width: 33.3333333333%; -} - -.offset-4 { - margin-left: 33.3333333333%; -} - -.col-5 { - width: 41.6666666667%; -} - -.offset-5 { - margin-left: 41.6666666667%; -} - -.col-6 { - width: 50%; -} - -.offset-6 { - margin-left: 50%; -} - -.col-7 { - width: 58.3333333333%; -} - -.offset-7 { - margin-left: 58.3333333333%; -} - -.col-8 { - width: 66.6666666667%; -} - -.offset-8 { - margin-left: 66.6666666667%; -} - -.col-9 { - width: 75%; -} - -.offset-9 { - margin-left: 75%; -} - -.col-10 { - width: 83.3333333333%; -} - -.offset-10 { - margin-left: 83.3333333333%; -} - -.col-11 { - width: 91.6666666667%; -} - -.offset-11 { - margin-left: 91.6666666667%; -} - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: var(--color-code-background); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, .tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; - } - html.default .col-menu { - width: 28%; - } - html.default .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; - } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html.default .col-menu > *:last-child { - padding-bottom: 20px; - } - html.default .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; - } - html.default.to-has-menu header, -html.default.to-has-menu footer, -html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; - } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; - } - html.default.from-has-menu header, -html.default.from-has-menu footer, -html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; - } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - html.default.has-menu body { - overflow: hidden; - } - html.default.has-menu .overlay { - visibility: visible; - } - html.default.has-menu header, -html.default.has-menu footer, -html.default.has-menu .col-content { - transform: translate(-25%, 0); - } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -html.minimal .container { - margin: 0; -} -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; -} -html.minimal .content-wrap { - padding-left: 300px; -} -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; -} -html.minimal .tsd-member .tsd-member { - margin-left: 0; -} -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; -} -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; -} -html.minimal footer { - background-color: transparent; -} -html.minimal footer .container { - padding: 0; -} -html.minimal .tsd-generator { - padding: 0; -} -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; - } - html.minimal .content-wrap { - padding-left: 0; - } -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, -#tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member a[data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member a[data-tsd-kind=Interface] { - color: var(--color-ts-interface); -} -.tsd-member a[data-tsd-kind=Enum] { - color: var(--color-ts-enum); -} -.tsd-member a[data-tsd-kind=Class] { - color: var(--color-ts-class); -} -.tsd-member a[data-tsd-kind=Private] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; -} -.tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; -} -.tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, .tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.8; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, .tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; - } -} -input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; -} -input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 000000000..b0fda2181 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,106 @@ +:root { + --light-hl-0: #008000; + --dark-hl-0: #6A9955; + --light-hl-1: #AF00DB; + --dark-hl-1: #C586C0; + --light-hl-2: #000000; + --dark-hl-2: #D4D4D4; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; + --light-hl-4: #A31515; + --dark-hl-4: #CE9178; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #800000; + --dark-hl-9: #808080; + --light-hl-10: #800000; + --dark-hl-10: #569CD6; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png deleted file mode 100644 index 3836d5fe46e48bbe186116855aae879c23935327..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9615 zcmZ{Kc_36>+`rwViHMAd#!?~-${LfgP1$7)F~(N1WKRsT#$-?;yNq3ylq}iztr1xY z8DtsBI<`UHtDfii{r-60Kg@OSJ?GqW=bZ2NvwY{NzOLpergKbGR8*&KBGn9m;|lQC z2Vwv|y`nSufCHVQijE2uRauuTeKZL;=kiiF^SbTk;N^?*u%}Y7bF;O-aMK0lXm4nb zvU~Kf+x|Kgl@Ro%nu?L%x8-yetd((kCqY|t;-%}@Y3Ez_m(HTRt=ekeUQ2n4-aRvJ zrlKaWct8JSc8Kxl4KHu+3VW1L`9%n~_KC5}g6&tFXqyKT-}R0?EdkYqCmQot47^9Z z6;opqR@7Nq-s|6=e6*0^`}+X1kg>CpuGnbpL7{xFTa|8nymC0{xgx*tI7n4mTKZNA znsd@3eVsV>YhATuv~+5(^Vu4j?)Tn`{x@8ijIA;wdf`+0P3$vnSrcWFXXc{Lx`1Z7 z%-n(BM(owD$7LzqJx)(f^Cusecq>OW z=h6n4YzSVM-V!-DK(sLT`!W~}($=O$9|ie`>_fpH0=1G1tiIFw($?~{5T>`74|p0H z``5=UydE)!CiFvmECW|s^TzG9*7pN|KknkVm3C{fEu30gffX&8iCm? zTFPm6*k%Hog`Q6JGj@dg9Z5nlAc6ApUe>;6xauB0-u!?wMU92jVL|3EcP9gEu5^wH z%tXRy#>HCEs*?KgMf73UcJ!lJ?x<6+)eJ{mEIS|HMDP7(7!(< z@X;?ACT8mncW9*XIaiJPW}Mw@b0W||)!sYnLw)0j4&-rXQgJhnQ2?frg1Nfk&JpmV8F=dDZl)e%#Grs|&0th7_o) z?7hQn<1078qcq?#;)CH=2kBBiGt37EtcXfpTXtHB59dr9=B~jI`yPm-Q?(ys=ajAu zGY;eS^z&WFvztZI3I~}*l}_lI^}6D<&CZ94;|&G9_pMx!C~$~EL4^8`QjT#|tqxxk zhl4CdxppbDiOk!Ht#SVAK4gf6Cr#=U&1sVxZ`y-X zTSi#@wHf(?(Dd6ypNOyshRZ*tneVP^W?y?$ur_!9iD-vY{&Q5(ooX2;`SkUjwEYA~ zwGcylCT4_`MZobm(0v$U(IhfYXxyjNJ@ztpH0sDmfpn|LMp3eM(R4uqKi_q1=D1-d z%GdV<&2+_9k@sc44xhIjqktRA2!Su|vzM0R-@#MK&{RdLoU#$Hc?{{JItvX{hKCtc zQNqZpkfG^@LGJRZM4H_>`F=N;O*+_`>M_ko_XWCgu@}ntqLX8VSeZQ_25Z8|^!d?o z$~}~9|`ZW9d_o<=8&K^~;Cr08b;qgq{(*e*sNt00lO2lZ;m-b<`Rl}=Lr6iQ8+$&br z!RLn{5a}j1Dh^|_1)Q?<;iBSrS0V|c_D@3}mc2d!%tV1VN?BC@clkFdx?HB&9KOTF z)9eHpmUEYsCqx^%JHuNdwY zz9P3oPYuTAXZVY}LRp&2qNl$pbsXL1GJ@wx?@CTO!acs+OFfW_U6?&As-(GJED}RR zO}B+Kxph7aUUm>i3rbPZQGXN}oQq;u`yTnFDAJ*d$4gjEJH!JPyt6V{cOUp*Jbyol zE$8wh)T=vpJOWRbv}HvR(cUSlO}ePIPdJ`J@yp=IC&E6K%r?QfW7F&%p!H~@?%yj5 z&MpiV!hyfukD56A097f!0+ANt`JSB~oLak75oKQN7FH=rQbX#Eak37|4&mqp@S~TA zOo51)xQxX}5NQ(3I_UeR4B;P0Q#x$_lDce78ET`Blo;`Hj*R;b8slZS7Oak(LjDuE z3z?-~-U@vWe*cEOsf^9|duH9};Pe)!=Ky+QQ!jr2VV-jMUH-F>oB>Ds zDJw}jm%V?OT^fu1y`$`yRdaW03L?)6vmInxhAsGrPhWIP8?=speMFf9Inn4^t zs$!88*B~c1A2J6t0~hgK2BJ_Pl23l=oeQQqjI2(4Mcv6U_#9#$PEN|qz36rCZ5$@I zNF1LpRe%ZG4qwuYr7ZdaynrPs?spt;9VbQM$462zbksMVhAOqPunrR7@Nbv#5;VKk zJB7xC?~QXd(e9REiLixHxRGhLcKR#0va}|LMS`AXKGOIGFKQv?=+>zf^ zN5XLjX6^`zh*%1UG_QV1H`@z!HZgC+OT2`+_B( z)J95hk;3C+K4XCswSP}au;fx=47~*$k`RAaYEU-qb03y0#x|&>LAeiXgri5E(!h9k z|9OVt@sk1-4+>0?ELyw|zs`~<95M=%o?Gix$?8z4Gz3Kpw|b>?BcD&s{X)-aXg!GJ zyq&`ZEP{K^u7ActXP$gGnO#F0Sr+QUZe0&d5*Yhw9A?C4(Sx2j3QKAlUpkQz7nji^ z%y8F|W{ypj(T%Bf#Wgyvq4szMo?*U-;3IGBRg1fK9!h-=YRsZ_+t~2!-)=pr;)Vnk zmt95&wMb02toOf`I9>M^Kv3LqKb_-#jauF&cGrWsCnMt?p7*uh zevugda={D04DB#7wR375=1i5}Z9fi3r)!F#7qmX9`SjppE&%8l8bKt+ADRMTWRv21 z4L&PldV8YpHw3b^`p0uWlIm#J&K65-y4lQW0VzZR!4#gfeT{b#fL1e*)Z*Ux}M^}bO%OM7uXip_4! zL@yo@q{utZeVV?3CtXs}i>nI|%26fwuzt0f#96fQ!{=dEX^YKnvIk*D%y9Cin;9R) zi{?)baJhgFs$1$SOZESTpldw2H&FD=v*v@1cA!`|s;avDKHa>Q+uJ8qhy!9%C4&lJSTN4OeydYOm4S?Bj7*e{xRYbU9Xos)R7qZT3dBBD5{ zo+(E3pR{>>)}hFhE+}!yYP0V+CVhyAq+RV{^X`XA3{iXj(ir$k@u|t8ZJ1ZnHq2dd zD$0RHmGJ=!?T5`*T2zOEJ~y}Nsyt7O)%+!0ulRQdsopJJxoznfpusv=2@zLXIq@^& z>0T5k4lzGCG(DnltLIe@6=ZOG@C(dvmYXfh4IhJfMfY8S?KkT znb7~EDE}Yhg$J1LxB7m`L4VMS(+(SXTQvh_mz!x&M3-6Z zFRB*a%_gVEqI^mL5|c%V=l_oi%|~h>gL0SB4QH5uonWd#={KPg6}6ES)zk0~#3^KJ zJq@{iqbHe3gyC))jeQ`W;(u3|q)JxuF24|GMsh%v5>>VY-bok%* z1Yl@(5G2UCK=fQck}pAyWV0n{`ML|rsl_N7vmW|frii__zB;ozrQ7{z)y}M^Sg@m_ z;+?{q3sUZs3WxnBbp~CyyL(TA?C*0KIeDPp7w0$!Ijd+M8#}r~vYW)NB*$mG*7-vH z@s^wK07OMxq>WveCEQFQ*p&2gjD1j%i+#G9z##Th`gew>H5=`RwyfPDg2G%f>x3@c z14Oy}pQK?(i06GWLWu%4cGjDoE-tTEI$`9^E?nLT663vu_>6K1e!N>A-^q&tfl$0& zy&>w~+yUelAa!c@xd8iyt^`B^$cj+}h}0i!40K2Ve1KFCDezBzZO8@=k&r)`TNTJ* zzF4Pim>SYL^=~7kW>EyiVHXNMT2)8l#v^IW!pLB_8ZvVfK&m8QHkjsZ)mvd?o$VYG zX#HiWwWlW>N{D85URJ-d)}_3h73|)X=E(6hFzi#TF{$4aSka4TeY>1a_(RIkFBL#O zE0_FoSQI)}+si51ufAqRHhDU=actTRQl@y#2h}xaDv-A&GP&0Qu9V4ED5aWnX z1E#mRT1QSvL!4~%Ozt84nP{&F>VIm6w2q!EPhh^BF-94$4JhCTcrdbDXA3Q&8mPTh zqdPv|X}??B?bIZPpl}z%(zr<8U-NoXjb*L#xyqHHfpIGAgN$5i(E9#rYPYq_tISC4 z2TDkd*uZ;CIhVI2o!||T)Kz`ER@%rTf-&SfmJFF>;d(RW(B6k!1<)uxHM_1G+9BWe zc)k`gBxYMcztqY5@jccaU)CqQ@^G5TBVx(nNf2}D@);3+{D)GzyT{>%dO6ibggS({N!!=P4=M8J}5R*&fgd(w36z0M0D$ z(SN5a`i%sZ9vmaEjiC4)DF}ix&`?mc-vYwK@+}8Gqzj6r6y)lT|Iqwlpj(LXqvh;- zb>jECiiOZ%&Q7gQg7(ix-?-RE*c(O6NG0F-+VCr;701@%L~fyfHnU<;Vk`m3A2{1MSmpii@G*k?KDq0GdZ)|hd`8OHep z8@6wv_|9NKNpe*sc#?zZ1S#}*qk{k<(I99u6(QT#>wf9w^u9~9_>;2d20T=^g-;b5 ze9x~fHZ-JL=J`hq-;W{2SgN)&m9RsVo=%?`JYp`pxEA_>`18Y>XA$rfWm^pQfG3MQ zxT^I1*({tZz2}+!5$AyNUE*jiYwu_S8v<#qZS4e!bGGBdY`3RkgLMf%Kz8s-;7PF+ z6w#-FwV#)PiKGR79miXmrDyv=ZTjc)j>N=&h4F+#G;unBZhhZz?a*;8@bi5`fV4)O zuU5pCs;tvRzbV@P5%W5xLI4I+w*^KExeVlzP4kNRGp-wi3g$lf-I|(o`JQ|u^XfkP zcik+g-5~2lG*oHfjLCpfNalFwz=4ZY>$Rc-QGpws&tCfFZUuJDL)3et%ap*$Q=-v0 zgLfsn-&%#+wnox~@)6ppx30sK(UJg1dCAvQF&}DkoPI+uX_wH))iaYvWtl}BtVKpU&MN= z0GdENbhdLgIwL-#_phGK;mZRlk4zq8*)akvV5zRX@jFUmvcr#3p99P@4z@m|bz-)^ zbZl8Wt?hR*z(sEZl;2PaILIG#835i@YoZQ@EwrD9IOBl7BpJX(ilLgcd)KCZAzo^b z6Z{|~=H;$D2dD53tejr_jx7^y-zT{SNZpNjn4+wJQX~K#LcrlKOv=D5xk%QXD{tg; z+xh`PvMV*HC*rF?xyjK5@KsMl5*w`r@wL#r13uFpso~#^oYIFc^&gGNS825eqFttU2_sG%_ z;X8VXD#Ol4X&$2B_Z$*&-)ZIUXf9I%mOOXJ3O%GbGpJfl+9(jY^fF_(b!Gt{{HAA3 zusUOCPDHYT@&*H~7a050c7r-_CaFACp$BXx)5==@fC11Gn|n~~+u@6N-}lvdyl3&6 z<#c_zm0Xp1F!8o2OBbFfgzzC4vno}9XEf40dGaVo;jiwiazo8hZ~iPVD(re=5k;H| zotm286$6nnTeIw>1FY$Ri|t{Lp?o(Fg3g_>|y~Z+16tvyLc@r?t9g7 zBuXyVuu9bC#q`?@OFIhgS)6v^XP@H0ukl2X!RPMsg%`YHMGad z4{VsgxaprFss3X%HbZablb6IdaNdbISVWp7yQXPPn=s7?J9qLEH{4>XAv8}%h&TDg zs()1sh}4at3nL3^%q!?P9BbW80e*ZwU63}CV7pt}gVu;~V6c$9p+*wfhw!zeE-z|V z=k{Ksec2)$Hu&?pRh;*TPk0T$Fc~^oAoBT4q?-Q}Y&3DluXeoMQ0LesTk}pVlf5(I z$dl8;zA0&=L&z*F*H>W7IeiPhTo@P0VTB~vyC2Bm7lCN}t7@NNlKFSHGKkh?z_qij zoYju!#D4b28cdslLdIM5Cmqe&!v^IcRr=qq^?l+P^n@6}fh@)IS81hx)SPAY7osk0)^ulqC1F*{hBNQl+Y}b>XjVXnS_Cc!L zIZ@Jq#mp^E&fKT~t4DM_^S17R@YJ@`(7;zv1mz_Y=~q*Gdg#*yXGxotY=#F|lvhPM zjlE)VHS=8=)njE^c7M|ZiBqARx>9Ib!y91$70iC8jPi$c+ysP}5Q3s`ti&1sx>~oG zI^>^1onS%G`mtq&)cZ15dZ{X^#MOfatyH0I=l%Q)n z7*@kZtC_3?=J_}?_G@?F?UK<0_AhYFclyrS-PkfYhAeVHcF z16x+quy10*2V$A%p_|@C(vlf}j3uY83h(#TSr$(;^8(I={_=YQQWmA9-IlwJv>tQm z=vN-I{TO7X`;qBxwb5w$91YLV?ZD5}pddq(7IdMCH zi>`qAn|#FITi!L5;K!(tYm9r416}Wof}P8~?R9I9Gp(?VA;uQg19MO47*gS7fH*&jBO!+ zA*<^BMccHjJIvGHguBb4a`X z3aZw#!c&Xr8&szD1+gu&;vYfoWo>0Pxfr2%m34tC33fmRbzWF9I_Pqb9nNK@N##9_ z7K)v)des!^owH`MoXY_O?|;^9;comiPx0e78xhnnVvTYt+t+cU1rn_>gaFJsL-iPn)?<9P9cF#4)7q&v+d&6|3G@s-AcJy+m zE&u*GUaMK|x|4GmT(CgBICk`2BP@3rqtjKIRD#uBy}y*d;<>`?W&mGsG;i*_}V&^tlP`%;=g39@jxP z+3lrtg*!i6N;irOpUfKcd;iDl5a`<#kr8RwFm9=^m+ouwwjcXmTB}w5V#9IF^&Bl$ zr1$Ly#cQ<3u86>am9}pk&i%nxu(W&s@>qEDtn_xVtH-_EiQ}iAK4Ssfsdn&L9t=)d z`XOQN7*J)g$Jrtq0=-yeLnHg*23LxYA7$cxz^Yc)I6E-!;{LQwu_wfGw4&MYy7{n< z@{g0Hf)N5gAJKQ1Z&HGPn9x9B7U(m(9K&=+LHAc_D{YdMBZs~x)u1Y8|Oq!`C4(3_9<&$ddi6>R$Nsz z*ti?=jA-Sr_97V}feo+}Lq3-cfpgWR;PLI8s{ve9@?e;2o}0MpquOucipz^DrT}QH z*(<{nLb4h9799hx4&%I8KPj}xcQ}llgcaG1!nRb(PP?m)=CzA4v%6>oOe96H9 zv4mUhw`>V$29k?)$Co>qIqq(~3w4jJ;Hv5(RxjB-j_iEhlF;&|DDC|I8IcT>Vn;RY zhtw5mT0ygXAu=M%{^;GqYuYIMu4H;Mj--5CL}|zMEhOum_o51Y7i|D>$XmUFoe;@1 z%GsTUsKgF4w%-Cr3lg#~h)8;Lk%WQTLBS8r*sE{YBUDw4HU#o}E)8pVIEfWv&14?U z-+Za${OFm=>IA358en)nB5Iaqxw&Xi*ty@uDOX8o2c0tq0^sX>ZXD+Hn|;KY!Omm1 z^%wgf&Zy9Azd?vmU`~zuOOA0{TZ*mAC!_>|avcN83F#c+sFn_6tGo!v?95IUR2bL$ zlO(OlhszqAgy)mNt8PRulC#6u^SL#z-O&@{=_!AzBZ>T4ROorj%fx$A;u8u>saum0ha7p zeHRX-z)PW*@v9bruyAtVI@)PhaEs5kp`xyxTQ`U9$Whwz#z$=U$V|&0w@EfCUS!Ob zACSTE{VeC-0V~ZCpkKq~P4CLgdOeBy>vB+0ZxIt_Cp4aa%vI#LS^K}ui07WNo}5r0 zagMHmq-jqTf-OD<kAvu_ob1mUP%1jxeKqB!1&-)_hP{p74hHE%WM!atyx68j5b zSqwh8aKo|NIOL<2_eiX+iOsRP`{MUt{0iQetB*SL!F_8)_;0f$iJ4(o__4KWuvy_! z8TZ{dTb*rL6VmuN-yl2Z>0glL84u^jAH^DQl}VRI=x0CnuF*|;|My-5aPI;>(mo+m z`nyEOe&k$RG11$vEdDPG7^raBCw|#C*4#pIUoZJNx?4|ZC{)l>+jaSiiJ`GBKf}l) zUk1>%A61hqy!KvfRsM^|u6vwbH5WpfH(I5AdpBAg%rar%zW}nccGxfgRV4&v`tEoGyBq!uz^f zVqWEtxn%j&+Q2Fi$rL)H`M_HExP+?mFyN^){c{JXs{IM}f}p>7lfD zLZ;s)%6a(Ow@`(jP}k~pn@!dv6JhJkZf5UoumHv`g-tcCs)w* z#0sc%t9@Li{p}f*$vg$UiQ*RGZUr=ykDIaxRDU_(QfcURuYrpX*7IQcS$(Buw%VW7 zxaffDgn{-=K@iEh)LlPc3MPzc+qM^>RXr6Y8ASnP&dr6fqmwYILTpmh$E%{Iz%Qz( NZmR35l_G4O{0}dcmS_L~ diff --git a/docs/assets/images/icons@2x.png b/docs/assets/images/icons@2x.png deleted file mode 100644 index 5a209e2f6d7f915cc9cb6fe7a4264c8be4db87b0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 28144 zcmeFZcUTka`>%_-5TzIqq$xo`r3nZ`iiBRG(z{ZnN$)K|ii-3S5u{fmRRNLEoAh2n z@4X|01dtAA(50@mzH5K?{+)CF+}EWTz2eMdW-{;n-p}WG1C$hCWW;pD1Ox#ad~k9g4`y4!oVfq@3c(iW~uhy*`T7_0aH7`>`EnYuXVq#+YC==3#rnNM4TqqzM zpi2Elr!3hl!ZdK#y0bV+yVc8rwFEtAX3=QlvJ&e-EsBp)Q`0yKXbNuf-yYw7kh0CD z|Flk1UuHgvoR+*QR0ee&IDUfUzE7*`A=P$6nC;BPI@VJs|F#`Xc>X!`<6%M7XXNok zw^unt1h0m>-&2{GiIGsByulr92XZRrazZs&&M3jJintF7A}cE^uW4zt_r81yHt1I! z6-_gmO@78G3$})kfyhR0^qk?zev_%4R$qSjQI3MAg0)9EM#TOAD=_tf(*)S$7yiiR z&5v>wk3Bn**iD9S_I#2%^vi(^O+gpv2i^A);6^AcH%VC>0nH8|O!jN*L<#RtT z@aF9HMNu*d(BdiZq(LBO%(qsjSot+ZXQd{zLYh#CvOrK(?#u+|XYRylqcXOLk=m!) zBp`~~1dg7kF(Q#m)I8ZHMOD5%m&U)5jGOW@7+sm1N+O~^j*zRG;e4x@OteV=T4yo9 zSG`^0j^S)ZYp2DT>}AR|n$S)4FPI#8#(R~;Y**AZ9`&yqT;p`rks7Nhz;)dn-TgXU zw!^Bo@W6|jfp@}ijsSEFo#x3LnG;`o_yXK@2KuG8cTv&K@=dU?_PK*6=YU9!Ix8l;<_!y*Qc2phVpLM}&t|CuHBv&{M$K?VXtTabi(7kUMwV zl!>5cDNNqK6`Br*B~EcVh#5Z!FgiJZBN5nzpC7?UdAc+&AT0ivd;DA2$@YXMPK6=< z+#U~?*!R0i`3uu|#zDrRRN&j-j>ZOu#h-n#7WO^)@0> zCT6a$LGWwFLcPfN=(3#6`*UIS%uIT=LIXV-RbGE&!!+8)q~dkx`l{aKCe1`{J<5&< zlhRo;JX-UC>5)X;mwR+W96`@&ucHp$jIb~B_w_=mH>In?BLume!Wta=`ca+&7~pek zBVD?f5{nelCaje~EtZn+g3%5GJF}R_b`q}IH$Iom2IRD$^h*R)Cid8Q5~4Dzm!P&Q z<`iI)4wA#l@TwjPL)*9k5Vc!!;`9;bf?HRMm86wi9LI8A%*NGep3g11H{aP)>%l2Q zRMMQU!*0J$hJI5Qs3b=6?}qR7O;BU%Yzufc*ZKBV`}ro7zm=C?OY6Vlabc^r6r7P> z?1c^jD{e4n*Ou441V=Pd1eE8utX@)G5gq72HQAXLZ4l2wKd@yIYC+s) z-mu`E`kj=B!)a^B;pecv4W5oh>_tpj>^NU8L*eH4EhcOxQ|);$x(z(Yb5^tudSptV z%8z{(h@_t`chWkvFX=r!p~Vjhf1AdM>uGK05$1fyLb5D7m0!MUKW=JTZv)bXz9~*F z$yP@U3UE0=$;yjWr8b7C(1^oNDMZVxYYeMtL}ZnvQDkm>S0)=r_ugabEZ}AJ<<_Fu z{I^KKIz+V8K|pK811W5r##z8^S*2fr9Ln zlRG?Zzz8;xu9VSE8s+=(!^TGi1P2hC7%7MUqF=cZqFBtJNW9BROV ziv0cjsUmVvsU^X!`1UivK|dy+fSG$3YH8W0`q${`)taBT9jV{Hfh|&RIaJVvqRIFh zC*Rmvl&3*;XcMiJZ-+Mvfe0xN4N?AvJeABnNdgs(BYb!fK5<1)5UvM!Tz4_aojmUX z#Ymoh)m%fN(>6|#*RP~Lxt1?5);w}yT_lftje3sidO&MxNgcMg9@S+>M%s~y)0i`8 zT_+7LrZ~d<7V^K^C^~ast~@nM04^c5dw*&660^p%^R>n4xzd&jo)Y@ z1r=F09>jFOr%wsj^a3;>N!{rvf(qpkAdWM*5IYCsuwNwoJh7;9I$#`T6-NUIEKsiS;OylQ(XY zQtCiR1dyEGJV=~|zaFOEveB&szAVx*wsyuY?hiBGWR{h0!D zv;G`;F9cnib*YxugasrI^%uy@i)>BvC4V8@! zwy5#iHC#Qar(i0EPA3CuMQbaKy4m$CLjLSNwJs!13b%h{&x7479bv{SjC&3?SO&)3 z6q4nRRP(zOfw-mQrmx@Z64~o}GNXa9YCE$vD-(CLseaF%6HH+WZz4 zbRiJ~zAtA6*i9;z!+zZ?9~V0Lr66|Ae;}U1e#6D^hMhB6XJNHZi{t>DgU&jb=#rPK z@s04Hr_SOr%UCRY_SdDuSw^D*Rzre~4PCqgc)DBYam}@G^TxsTqX%w-yWtYU-Q2IX-a2Z4Kz_-yIe`m;x2bY1F?XZoIH=`uW{$R)ICXxqU$- zG#M6s!fDZwUOA_cs|PXe1T@XN3^UdYyR*t}943A1dTvXp!=%8c%)(s)5y@OJ@@%1a ztlq}Uvhfo3^ZO>ZO|NKfu37JMRRmXfJ_*VOBVnxFFmbq!zc%A+R+w|={11?sJpmca zCeCi;;-*yO)ywzKxa#q?E%@U-+LGH4{=2|reRd-Kz*Ps1$u6sPFO>{K9^k2Y!@=h7rZt472^BCU& z|0MZmbh1HlC3#bcjoX#m73R?H>6oW=45{gu0$S>j`v?``ch#0kGur}QbO_gO3XrB- zS4pz-Yrnqqt-k_LE-&~ox9gd#^n&HE%Z~grM;N@Das8-#U304PA$v*rj36j~qQzYN zsX>8?%q9DhpxrWR@M>30YI^WUDh4bcn+*bYn;~zt_g`$3{#G+=lBmWE;j}5e&vlDa zjsdE(Xg^o(Z|3$Tx>~-q5NrZ}^$y0eMd|h`7Y4OWkgF0(Cu&CfJV03AKfzSGBhMU4bqd4kc`qE!CH4Q^FdOCtUHaZW3R&>S}$! zhk=OYL~3fch$-?wa0)OEkynDzJR=vc^vuUQ$hF(>E(q3{7{4uhC^f@bzHUZT>k%%R zsekA}E`OlGE(x+lP1smp0;Ba7{C$F=@Pp~i$AsJkc)x+3Vf9xQB=aSN>D!T;Y5iU~39#6yoQuj6Bj%kdYC z`72YjnSoF_A)d#@S`|;~F|6TOn%b{4?MWJC4uG&NK=D zqd0rU$A@62MtWD$=Gg>TgO6)b6Vf41#Au&Zq<@p1RG!t}NG8kv#>%{bHuCdAeIao2 zkWX{dyO`XCdv`FlK?jS{48~Uaz;oD6PtoFF0u6HBTHCHh<)5wP<r?9UIw%{psu)`l~*PK0?1^oH}d{D_wF{En-ejdBHTK|(*2$K?xVkG zwYXl8^HAjVOqKQj0f6s~O`)Slp+alXd8@#4Iw?pHys|MW1|l%ipCPeN)|fLB$Dc(9s}LNw@?8G{ zU>U(Vid5}ltIy~zNv>o09)rC()g8O`<5~!qF*Z_?L;+2Sy!WSv=}|67mnOPb!A*2; z^f>okkk+f3+9?Tg&6NBMX%;BtB3Ds#(PZ6E4`X0e`~amc=9QGw3J-$!nw6)l1A8;m zFdl>D?g@J3P-41+3N`R32d*Hq0GWj!{3n&rVA)dpcB+|5`XZFFZI1bKA7d;-x=0wt zy;$6nvCJ$_&JDjWa%`LQYq&(6LqBP7G_+`+4$|qk7IlS4wK{qnP-3!yFO%_fw(8(Q(#|htD?ECEYPeT&anf%0GjGQC<0)vR3x=4pq`@gX z{0?*O(e3p_zu@N9G2O%!F8j&|FRhF(c@BWMxZTpdW0xv^K!`2L39%+Hs0#R>a@n-J#u*kF6~?DIhPrUi@$pR0tS?5wF%PE z(-eYCc#{7tVRzd>j~xO&LBPK62xxwmxrdd{N6!G1hfD0H?fV)_B^PBIm|@~CZXnpdaM=<+?&D8Md^RL00JfP zK|cm@`4bB6muuN!Zck2>k+wh^8kM73#1(%6#^TG;42H{?eTC(h^zB32g{Skc%t3Dn zcHX3$TQhR}n9xXCd$?igvlBH@ZU~p4OO*Gf=$@=w?9vYs)!RYa9V@}xVt8Sr4y_!< zGjn5?gnlSKhqS-YW^o#@NScez6I3x{ zv>meTLLYSK!pa+|kqQI8rWST7_)jL~mqQ}Ou*!V2U-g|ZR+pB%Z@w|HnZrV~uY*w?_gMhSp+4fY?hMmdNXYD(iruAlj0&qga8nQ1=c#y* zgYc@oWp>=|LQ+s})zQ5kv*UF?QMJ2|FN1CzjX$x&TwGJ!4VjOiZxVDVz#r28{^WRn z{o1SYRs*^Nt9(ZX`wad=44v--X~h#aROW$yKE=n-VWRfhI&wn|_X6(` z_WPK(bt4Q8gxJ=b%BW_nNj&h;H;2z`{vi`~)tCBk(zGYBp?f;(Ua+^@+rKm53ld9S zPP#A^Wv7>F7c36IAp7(%S716|mr9fnL?n&Q*?OcmX7>@shP*98yVXmJ{1{z!s;@_D zt0}M~j-0t@?)wY>a9PxzCVtBiTKiS1<;-&hv5CHiv=8d$IOnl?aI_>zR3eW}l*}`T zd7%jWK1w(iqAjU37u~dz-4@O^=PWhD7_yL+z1;-hnPx|je;QFR?I_x6McEg|;`Zuf z_}_7>V@hb=%%^H&>8W{N&Ud5bKD%p(B6#&l@nN^wOdQizb`@g}g1c|qGqGr^c>a1w z|5;G!BbS8(8#mlqM+re6&;L0Ba$evPxRGW!koG@-z@*c+8&^U^7Q+0jgUtgB$)Bh)OGD5oa(ju zL&w{}@q-4qVXtvRtXul%gWH0DxXe$&?MN>z2jh1!ElU%a2;fz@xaTyfs`lnr<` zLv5teGAw`KJIh))Wg8JzoRNMyP>X1rhr)=#Y8O6Nf7>}xLS8!@+&6k0h#H>Nn{`&~ z<h^0MI*wtWWT)UGMw#$-to|sCF?yXL$;_=8T>RsAI7ks*W{$R-UI&M5a3{Gda?9J z3PeWSws3vp1$(`F*+<1X7B6hG<6u)lqr|?N&1Up;Si*MeoRFeRNGZa1=`C?4ZaPvJ zuHL9EQ^d$jd1pu9n6iBgWPMtJyxmfJGQf{a*eag-%E@KZ$^*2_&F#h|LL)2_l*QS9(#5T>)&wtE8a=@FF+vG8N zk>*kU^97;}tRP6EGf5HKhlr6@^Nb7N1`_>QnnYF9-8tncspx59kcfE)TtFun#cCjn zEU2;}6Xu~xx+Bv+O;tKLcuo?~kQbcPghcWdz4-^H!wQOhQukRZRMRk>kfMa~V;A;p zSqpR3D87(4X}j4Awfr<~7h4dgK)pzpZf{bn z^yt`yH4+85n%*$3rL0fWi>l^4|J{Qess(a2+0W-O>gl%xIaVi`l9N3Nq}{$Q?o$#6 zP(6};On20~O*x}!V+=9YO)zz4yeTv@_04tEzA@Muc((5aTR+rHpa6@RymHX{a%Ss{ z+ZVey@TSCpCZq6G3WNWPfd3Z(|HlaUnQ37#)!hnd5VH}%lQbK+^qVrFox87bV{eTd zMjY@0wT+?ndYzV$vST&K{gWpow&Zbq;%=a$(B%@MLh@v!P|L4U zgM9JBN_Gb)g+}3@K$8-*b+GGuC&@6v)Fomd?4){kVQ)620*%U<8saNfLM+ndN~1z> zV$;~rU}Fc&M@|;i!@q(ZqbHdoB(EYYOs>u5jd5A-M`}}pr;g+_B5o2kj-|Pa zF8qc!e5d+kUV>;ih=57(*r24g=6@)>+c%LfGLw_-Bbm7r_`az+tag}5rqG&jrg(-W~CJFkaxZTf@_Ofx@ zzxqF#<4|HKKBpc&B9R1r8t{!k_=WNfzbR?aogs939=bT|!c4N>91ai-wsc4|JdG9y zGpB1A4i1ueuSS{R3h}0^YLpx`pB;Ok2-R5 zZzHya))4+|xc0QJ*&1>3;@0$RcgE3M_rt55cZ9<51j!pV&i`8js3v%e$CG{I{X+yj zruhC$iN%UA-Y%u_?FQq!rBg;{`8h`ZCg^bG&OC=733*%4cUW`DPGqp|OgNy?)-Lky zuY7>yw$@M~Jl&X?9MI2RqOdsWZwzFd6{P)UF5-=GVh z;$}}BvAUMs#V{T@TweGxI7dhuIzFqotm&oQreos6)^Nt1G4l8ce%&u1F<%WFM9t;W zBAEtq#1FS}e7Gq{9nzJ-0@1fhx^+w)&5)h+@I@?kv+h4xs>`xqTMB()kR)QH0W6ODL=b|ea)CmcTzPItT=KH66{L4@p}bW9=F z=+(cM#QUgiq$M^X08=_kUPU7sf!8j#4rN7NO0#TX0-;8=ySO&T7v$C}*`++cHZu0; zRv+{Je*j9;z>+TGv1i76Qc^1lu^>XXp&w}t;MzI_nTpY_m?O?J|UF!?x>j)zIZZ*}uTg|S?56^~@P4iEAwq#7&c^D#OmVAeT^&ib{UcAER@k$$X; zQdR$NNz=G^;6|aY!VuP>0e2>_I^ymyjmC*~Oj(aU>lb7XxoNc&mR~HbdffiYw#m3DLJ)nb-vczmSGI=PaP=yOJ4mrW01pSsP02=(ym z!R+#8VFsL>Puje-hBZZ0gY`?oFt44R6Z--pJ~w8q7te$W<+z`WB)mKtrOR>%f~{*2 z8>hh;3|%NPQq8-xDbWw`*n5*Ni7GB0zr7D?q`b1s^a4*X%Jk>EYA*r$va{t*S$Wk8 zL^lqaL9$a?PVadKA#e`-ocbsFKC1awpXsVmMxs^Fnz9Tb*6tD1sa`;k~@OqRo@ub(|hVwu)j^O#EQmIetE!ma(-|!O<`ZRqJb<$^dia$W5ARK;F@n)=G zXY|L|OhQ88G?ay6&;=(qqYF;O$NJ7x1?PPHYJC`UButfql;CF9^Z@N$9e`rgvKY7- zzkY{r^gSjplQ4S;+v7}YOOB)q;im)xJ8Tb}^>Fe{+E{o<&QW1zc~g`vO5=ii`UUW? zZp)~%d!YRLs1P5Gsp1zs3gc8)u&mU&?P*XcG+Tr-__K7L+$}7WQfV_Ngi(tq_9feK zK+m&sYg9Dt?NYYIX6$uOy3OW4i<~fWv+Cf(7LSO2Cy{IK;1#Y8C_5@I{l+TY*=I|v zB849$N`$Qn3)Wezrk#N{(Sj^ujO*o{#sa4oD_O8zmLim4B{5HQWLd}YpB(b z4G-q~15C`KQcuBSO|^7AHPTM2RneHT?`cv7UxhiJ{_{;Q;kGe05x5xg&K3|_>$pD_a&U>aXaI13$(JL50d8Z5nu7>Swu zA*$V;mYnn2)kI5c`a29y*`L60#8U8YzlVb^NVbZO*AIlUcC6{g-vYStoB)oYa(>HrRpU$_+Fu$?E^-+?mgq9i+l>lZ?b zT6(Rs*ytr2RlqzPAC<(}aFaO~EuqFiP9Nk%5YV?9#t-?A=4jtCuRhpfZRc5{uXo+q z=LI8vUYPpMT}NAmAiT1T|Lra-gEjft1a;1k`{Oe~KvJy%Wz~FR@vzsl)Hj`G)zsap zD0(^YuCzHguv&0Ryn%gl!eek+ywQej&`(Qef(ql7EcAYQoG}tAUY=Ns0uhUO05V)*ND z@*NLrHqhR{%JlU-nMJbBbn#Q$0gDOt;1glG|M6dhX@zoq#PRvcMk<`}n-dBYPlDbf zY2&o+<&J4^>4Q557tWSxa)1M;mS}X$!JFe6+N_0AI?erp9CdjDGuyvnelpc04y2u#n8-PU5wo6P&9?ZpnONA+t}Ucy z&nD(V>H%M8avRC7jdV$uW8n|L5W6kw7|(e8$j>_ZLqe`6y!1fWM}{tJ3t7HmzB894QuSOpNj=&WDT3e5Or0)3wFwasb4%9_M@6)K z&l3J-@<{!8U7lZ%P!XZsO|ejU04NSjBEBESP4Ff6+T}!&pxTCxBG{W z{I$5gyC-P##k--2l=5r77AsRg@o4?Q7zqe%7Y9-kbSnK|KDcKK;nZqb@o$i(QzUtW z4FlkIku@T67|OO;)}XWaHSwT$i->~}#O|Bld^q?M%%`d*s2x9BKP zZo$OD?q27J1NAg#Nd(Fn?4I|PbI>nwdR&!F6YOHC^L#n$QG{zQGnjL8QL{~TyS%sy zMT%4c%BbJPXL6?WNg|O1-c<>qUm^=RW`+5)eH2jAI{T^M6-_natW57V(D?*MKT4n;I#vjkQ1Y~X{0hj4% zF}qYRzy8zJX(%d$`X$XgPvDafqM65Qw_;|~(JO*m8-*q1ir0~W4cd`@#KX3_GEp5t z5?rPAGz%$L?%(5dRFgw~R^|tdxXDGF>^=J2drvtC0;nBNt)$2d+>6A}c}i_~ef`fu zywIKq{Tp+H@09h2i{+Dn7?p7~8D%gZ+<(bq<1f|tL;Qy~w3}O7WX))3Ej+(psj!1- zrlt&tNKU|u?sySN{!ByuYY@P5bL5@7&Uld^k~iLzJaP7WDAI|JZrsHHT>hmAC?xw& zC!c!IBNTzL7K;wAXR3vVTe1i(oYdqoy3H0Zw{@>?*4UcFaMCNHwib2efs0(Ync=2q zwM72#(Cn=nv2ablw^j({)fdng^E-(uP|5UD8@CzqpKlZ^=HH}?5{kmM7vLAoAatc; zwH5KZJkkdhh8C1p5+HZgC}LE+Xu}KIn7|*#?;j-8^-VaZ5jOW{JA#*;g5p`(xTiDd zKkPnW*IU@QEsE%-JWbaZU2+aF3<-bfklBU}TCC{E-~c1suP&!}=v`e&X_xF{wro+L zcgxt?1af+ArOGprbI<(>!E99@GkN&7?#q=uz{(bMN@|0qqxcTr07b2;i>k6W8Za(r zOGe?77{mF3SVV_<+hIDRNdbE)(lSDJU|Bf|swOh*8)pQ6AizER8M>1xnN1+Qcqhg$ z&ak{6PD5v75^-mAcvoOH6*!9Hkzpt)*#Ip_vNoGk)^|nj*9+w7+7R(=j4q>aw<4Wc z=nBx)kd4$ER29&>bnknJ`n4)pOczJMPJ! z0)p$AgO&S=`T1(PYN?P}4cSJ%&R?iNexQp^N$*`-AbTP7WfZIW#P4d}}S2|=#O7ke0mzh*aEWQE)y!|#~iGCKXe zpzrFFL$pk!^d8pUI(IfGO<%TTQHsrDXLDNnMC6*d0wT9m7x6Ft7V=_OlTqkuj{x>p z;1kpB_NxE04RdYk)Y!laqUU=rfZJ$T5)`7`QV?5(Ltg_xlECcjtEa{J!@6Brx);>b zl?P)xrifEIfWi;~!Hgrq*7bz~i3BH#^2_mOIb$vnOz3yqef|S?NrX2~aMzcrlIGhJ zJ57YYnbrjk0gMXNJsZ;3!GV3+U0eN7l{dNPN>2^D{M%{F_n#@Jh)M2G9pb6tlT&F# zzc){OFWO&LCDH1cNMGR@X9VA+vt>EiQ|#sD{Y6sIh0eE(T5g#Bhn{L{CgdEL#dtrL zC>~e(BtwcN6QdM$0h>v5cu{@BvleO1d{z*-w8N(k$wHP$AXwvfT1)EL-?E&6nLdTq zFA@*HmwLR__b301zkRRgd(MeG6hCvppG6OwFv=2NKQVx_rQX$Z3q-DFDcOMHtbuC2 zb}=nSGqv$BlXjj(ahhid7ECVPglKaK;z#;LgZZ+OisWYuKBPX7xpErFk*@EYkKqg2 ze61oYkPXBN#&}jK`c6OUoF{pGlCOmyvi0VbqIH)+GaMDJ>Eg{$20?GwP~=nbph7n3wT-iS@IWTjG!q<-}5nJdNKFs75SDJ`2N60FM#00h+c!NU0ufy*_DlHj73t z5%X`Hqe$xxtHUL9%+{FK#XTYqf1a`&Lh=``4pOX3cy239FO^N zfStakz4XYa-?AppcGY?%Pj@WYmLvxBlKhq06UyFTy`Dj|YO2D`3uG#B$$f7PEjp~U zN;XAx*Xx;j?A}%@n)?=Uw67Bf^MPlLUonDdnT0whr^OXyCbtVRp^N&tL4I{~Dg4l+ zvxK9}?_3)Y$>n?i!054VsQ<#MMZ=Q@luen-sz=N_VC}l?`zNJtA`krH?K@>?REBq0S+(}^2UlFWDqHi30Pa~uu05d$T+-JrcJV1?aXOg(}Rs zl`@li5%>|PHxJjZT#h6)u5#ukqU%dvk;$HYi|x;L7naNA&)c1zj7(iIm+BYA&tK7r zwW0zwzaX`x0|CVQVi4}J(N#ScVIBUXBSyY%CN{!aH)SJ(GEwpFU}-yF{d#w05hL=m zqA}!Sf^U&%EPmu~34)ZMEMWZ|Z{ zf+Da%zhehlo-wY?=x^Nensm)O!dR`~B96^wloNE6>dRY#u#pQB(ftm&2{0{aPw);3 zLS~XJegtuFdsZ#-4}Yw<2z1ya*ZublDU*Ut>&i)(l$<$AW-E7gWuf>Kh>nR@=~Jgg zYVeI|2kH%1E@)ScwTRMO*HTWJ!AcdT*o-xoiH_PF%JHNE29RfRx{{W~Mn)HwZeR53 z{~74suQ)4?@;WN79bIYU3yi%hNhnxTu7in4w>kOLA9 z^_cPfyxl`BO^Jaqzdl`|Ez%y3HTE#{dbqX?j$5k&zQxN?z*CZw+vAZV-WEk=-9oI^ zi>;EFv9pBIbUMsM{{@)yaWwa#nUxs`jEZa5y%dJ~ZYpxpbwF;r5KM9NBrtI6bS49Z z{7GcMaXGAxDfXDD;60Li!JF~fHPwUU&ynr@B*@3ChF52>+Zzj(2PL6C2Mor0xpcaX zJz8ihH2PY@>!))WZIW^vV%K*vW$Xw?vcF2|dP9n=qCP9;7B^IZhW=jxJ&T%Ztkc=ADNzA zsx*6uOG(O5$(&<*ti|J7dW)DtZjKZ4%;`A)POZf?A4Jh3X-N5M*8W<2T>+@m+RM zso4=f_o0cfhnM$+auk~mI=kVgHZ;l-+V`UB8DLApLi~fqxxCu82ZpTHwuvkJ zMaL0c$(fK#3^%@^>W3#TVHR`5ZG3y0Clb5K47#1K#yLmQyhW_55~ZZn&H*`)Kcz#xCRQCFdlucHx%dY1wZPf=tL$KK^-_TTkBlg%SX#-AMe8 zDRJaA`0SE_!0FPPn@x{0rimZQd9k+}88MLx`S?6fu6=l1Y@h3fs<=&*q;z=urTS=C zK%}u|(8k5e&Y-zSmoYb|zD$^cY}p6(t?!f9J6m?2>Tc-Xy34Rp*Ug6P;_=3oS~ z%u;Q7%I5MiGqZ{d!-pEl{0|+1NTm+haNN1M^6$Gh!|V@!B;}D{h3pn(C{xBk%}#IR zO1TK6*^j5|!U4^zB>Fw$Ab?>qDPT1M^Jx#~^C&2cPdIB_0;KSVNk9r$##HLTSD_Z& zz)jE%*Gj)7d9uVMl=+HdJ8%e}9%lwaY;_kEvV>UsLHx;mMC@f3lzq5Iv&y8{w)@Z#?E z$bXT?tyF)?<3bugVVY6(e@Vg`2i>|)$^m~$WioLwW}oXXZ}=w;=N0{LOx0{9*as^Bb{)>T@3m+vEip|GPIJDHTEO0j?I58}) z3~@%Q(7?0uCeHM#BsO=kytmWFVcmtD#HF#V$&{e5iF)nW6D|+WjJvd;&5ukcPLykI zL)z_SO#T-IEgtk{E$oT_$8EEJI%wS_Y2C(F)`01pzGC)%N-d}qrB@+6yelt`_?uuN zPMGYZCo678{Kdb+IPo{#IN(js1Ummj@!l19H8oPMb}r|M+d{D&z2T^r|!8rbRwlE=7j zz{QM`99y%o-F!wvWl#jR$l|ML^ohwPPlBQ~Vi{{yBOjvrhl~uf zK5Vk45;70o*YhtM&7#Sc2dfA3wZq@0ZZ6N~v6zg&MzJl<$ZNrwqf-$TiT@#W`2x6Mt;TiS4huyA5^}YIPTFF^l19VciDe9QgSuo770l zz$Fvs?0FY@_UtE2YE##{%dGmgZHHfzsU_`V*H`P4*F`ul(sYs9Jq*h6rbk1>eD34Z{2K;_cLbZ46halLc ze2%NUKU&GA!WwUqG&=coFm>87tCT*F4xGxo74O@5Y3xJVE!8F_1FP%~BdC2FS9Isf zXuW-CnGh!{^D*Drcrxc3Y`W9=5ZVYqn-rEs?8_&q}IoEx+VFS zRga(VCYV$<=Zq#wk?;b+las#o#HsNw*`FGFDeA^*xQuB(cE3~CcEUYt6MjgdL|p=P z2+pPgOZ0Zk#7FPiJV}Wb={;89-U46uTu_QI1&b)P=+se1|88_^!5Um>o)Nj!lfI}_ zA{$}3*734@W4yItj?m zLJCa$`Rn$L_lRPSglt!uro*Wg-e^WHi@NW8q5zxYdq%ULx=%RZ(Ry~zKFHmgD!x8n_+?xj`!7VyZLb@!Ht zcyvx*=Ox|L<#!iwxI;b}HqA-#(_&c7eI; zh0-~Nl>BWL;lGfbd$~ThM~0`;bnAxA&t^Bg46A9F67?ijVTmmSHXl37dKJH@X%pJ( zv;J34-$9e2BLwPjbgdS-#g6)O&a!wuZ-4?=C;(W1fb*oq3F7!&Q;TDT{dSIuAJ0r( zTYW}1z5Y^?(IYRkcvPK{&UNZ!DTD2NG^^l4v6pZ*x!@0~FW+zs*VWLZvD5?b&529v zzAIr#Blpmqud6Eze&qzM(zwET6WE`YFdmz$)SiInkY`uE9 z2W8d!Z|P-BLFnbp3rcnGlI9P_{}G(V#2CJpq^&-OF7u(-e@`ex!`4!J7AZxIWjne$ z*}p)Oo)D;<^YCfczySXZ)mxzJ%Trh$e@@Xs6YI$UjQXTpMM3=OD}yJh-k2t_G}69%^Fr!Z2HQA5*4M*x@spn| zrheG^IKj0ez3X@*QK}PLKen)$lLlOFZ8tSxuEOsfZ4ZBRv~f7a=7}eY0qYvDhVUkw zZOeCWJKZrO(yrm9v!+wYKhPp+8sVTN>nKBQt1)2z7ZTr41?oJxD3UIFa*^`;bD2FhRFQI1$)e-S7>YM&OE5M83i$Yg1gC4XbSB(3HY$XeKc0w~r|t-}85eyvq znGOcAFmP`I@uNFB6D-U3R7zi&HI?4$T$XBCYp7jyF2hIU++&75Z}~Yj0lG(o!Q{%x zle@H4z=iwQ^%fFV}$@P%l|Q*S||Fc=aU(OuYN7&dFa}V3Nc7J*3pGRNHysT zpl1qYqD}+z4udN>1yr0@uF3~3%~hGND|wBbU_IaPN$MmzOSBa(DV?!lmqJAFWhao7 z6XK-N{+v`HO%=al&V4z}>Sa|@+Qf8!nk9bZMS#vdzl+RDih{^-@~-07nqb7URdH*R+DD=7!&A9Oi{-a*?F%R^?_>z|&W zHQ+4C_b)3pp#^K(qJHO8s1UDOMw^aDYOOebgZD{HMbGVDVk$+=PF2;lVmdaX96DD( z2>^x9360&?xbJ=C?ww+GUzY7mi#yf$i@Zi^^Y}?DA8FLB1O|#d@$jX3gICv(QdzlV&8dxsHV(c+LsK>QTvzU6_ zYb0#5dCxZ%c~~}R7+|_=M1NiJ;GL(M6jlh!W$wT&BZz#^;TRxOvOoC5av{aK*jUdB zEJTT7g$OLq7j%VOxq7lBmjswrMs{Cq4i_QLuY?I-R*l_PX%)WEauEF6LE{{cM%g#Z zY=g9-pHTq4-?B_^ws)ot(CdUT(Q;?3ZgB%&0-LSJk}S~oODd0f;gmE$LNlWC)*SZw zTF2tWUDe>}3GAgFzfUW{@fr-5%+TXNF!#@u3xLK#M@{^pJ@RwHxR(mQv$rbM^u)yF zp7gc4+^-scO=w4GnLoUHm&|*G%B4)zdnT-@sLAXD{t?qVWoK?M#QmO7ZDZYumcROM zT0RXq?@|A$uOb2&0IX>Ab9ty?U)lM3)bo7LPM+d~0IDZ9U)9X4Pt|IhEccrc4$Yqg zxN&t9niz^0H@V{LX*57HW5=4LcVn`mZrtz!m-E4LWa#a&|ZE=ZeR z_be>uWC0uQotqmp(+ySAn|+s`Jh^?c#?)U-^^qVEROY9akEY4F$EfL{d=!)6%BG-- zzxb^*e?e$Rf1Wl1QT?k8F>OCoXwv?=Ung`f@oR`*z|{D)G%5h9(2EXaoVg^$f5Zm< zKZTunJXG!9$1R~Oja|ej${K1yXo$j8_FcA;rjQxV!J)?|Gj8yk6(bnRAXg-|KsQuFvOvU}1Q)$#BKFf7rFv3#c^C6nuM& zOO0Gft$Kq{^uZk+fBQMx4ywF#eZ10jN%@}^6Trc3hCtkr5v?qLPeTBZoa}i>5KfE4m^W45!H&tNIy2!R)_bi2pfs)oyorVbu+nl5 ziVqIJzcjU0;LWSXA>n4vmdvWwz`nJ(vB0=#2PO^BiHo&%ecgXrM@U_;#^7aMCflK* zu?J85J`Tl@CXG@Gz9}c1FQwCP4okOwbBpS37P8a>qfV`z9k+`X5YFPzTfu%UP!6y`Fvr_P9?4V5;X6Bf8{U9#rCkAZ zM&uVB!n66B@`9(+a&}!KKRfCf^oQNN+6$^tHoMIK!>*$7-0ZFr=x>*b-P5X-LgxBY zo2Ug*pNH%q>8qqJmtk=~7g&DYcueN3PcuE3&z~%j0gUYgSS9wn57tV0QdV~{+bxEnx{U^j4&k6Tg_t{mX$_Yq$xe=@q|jc4#`MB^ zJT!tidMB9LT+XqKk3JFN=!_dS0?dknKn##1>;EeT2o)}9LyEIBz=e4SFuw9d_vq)Y znKx|vFBXdWkaNz_)-AYMGNnQ9zLj_f%C}~7N!N>u)Lf+CfEIdIU7czh$QbcAide4T zZQJy*?<2fUv(SP%PV21I_X1kz7G8vO5oI)0xCIvcYt6{A`!}bwQlGSad^&0sE+dig ztCN-J!D2iYgG*FJ2{BPzy1^u&y=FXDd67a8y7BGP|L)Sh_Z*1ci7meUFD~utdnA|k z%FkshXa7&|yHfQ-cZaL9*88w++@nx&uAPsEVL*=wVw{~gi>(snR7!xUfN3m@nIRqe z$bxi@pG5F$L=in`nIEOo82`J5h_9j*7~_4)pr(1ea&G+SOCoJiMKDK#1^!`Tmo zu(KAj$s(@Ez}~eSFWD$y#q zslU<&-b60sArh0MhfMd8Ut(rM_CQZ8FfKQivy3;fi)0|#R9eO4o~zDAw8`&mCJBRl zL+V<9>B#dX+=Ch6E=t$PUla#aJlOiq<<`$o@7t~|m@_8YX~f5JPr8|q*x0k}KKaw) zlj4s{p!Bb0(O2I@&cJP`BT4v(=^IBCC}>G;6Pl`dvTGO(u1uHZFzBch#Oi5#?{oUA zMDhff&?FU9`${$qfOt^aXNUDLXp}!L8o++(*YdqI@rZ`e_9q$WGiZtk%BdwBGNUQLOvKhbHU?bZL0ypyF6t66gl zm;}?$LvW7=cpykxJulrHg1_Tybvk9?!FUgQFW7)ZjiG5RKh5P)A-N+a_IR~*prd%Jub(3dwV#iE zEZRnitmR!zrZDwcFZbI$fi zpQ#2NyF^|ZZxhg}_2{p|uY5RbnD8K6ZJ*(Qw2)?}wekp&yaRA|Qo#DxsS?SeI+jqSMG)is9$_pX3e;QRCk`w z6Eyf}-+>ptnm-5fB$ja02cI*FiDNlWz6!au(Hs}CGqc@Mmic~|=QFFJrG1@1hjtXy z4~e%c+1cVu*QrSvt}^-J7&3CYOFA(;0v#pDtP1!!v4p;BvW*`n{US>q(dX{NUrV`ti>sUd7L3MP0-oP`aRTgYw5brGKhov{JH8&ZnR)OJ2X6Hj z*N%E-g5%w9Tu(o3p@Ox209&F)dqM|)8ypzq@>_T7)U{4lXM#FbS?FxaC!G^bZMM9+ z4tmuQbQP|}fWbv^^L6{ks3C9Ej)`TTPs7Rx%f;*+b8A$!FHS$N0rHb7YlE-;Os=Pr zQ{twGcgc=sfxFbo@AZ<0v(i)mIIN>SayZmhz4f%!>5C|cW!)L%h17s1v)z*m@qbN( zLIG`HP@`-xc!<{bo61SZlQWVZ1OuYl!Sb-gF-ru;V-o?-65R4%f%6Z;4dlCb<*tm4 zT`7ejX`!VvI;>13$7YHQz%+8p7l(Tpo$_JB4f^W={o?Bv;zK3iLCjqj{gvE5lo;fd zHH{q|VzJ(ecLFb~dW44K((lhkhDQ$2inQ@ZcRq7Y>-^*1b>gOVEt)4}ovdHpbt^K@ z|3sf`Dm|bJwcZkK{pP34+PPS-&Y(HzYpQh%%*U0(ohJ^qYv&SPhZse79v3M#nTUb? zTTjUjU*9&)0S1{kUx6pKuPYG_c~z}evFZy5xUz{>?k8wd2OGRLnS6!W@2E;KWyJGkUt&UFTh*2NVjj=kW%jj~V001z!4 z=ACav4hf=_2vC25z)FK{a-HCIF%1b@(>NH^N7$**yWUBYO61yA32R`g-kGrQqT2&s zZ1aW~`>zx~03Uhl@0bL?Vul+mpc)cp64nzfU1rpi*eG&?8WU7Xl4Pf1!!_iKpK_${ zC;xLY0h})InNl8x8hkL6Jpz7odsa%}^mCw|17HWPhf{dC+kQ}x((i~n?<}jL=p9a@ z<9^KPtHyuVYuBL`*B7H;P2iVO8ICwx_P&$c40y;=GC7R)u@F`J-|`;#me&bZ9#xFU zJg^Th!=rFfc{Bw+ujIxWBM>U0T(6i0?6X&W^QWn?a#<*foA?<)RQJ+am_wkw5~pN- z7sfTpB>PChT4dEn1d;2VMl0o-hg^bZeAQZSZ%fT*?fK_jkzO;p1^Kn_+yjstFP#ra zNvx;BrMYSMj?`B;0sS zFuJaW4L~Ou?IWxSIxyrDP0$laaSx}5DtUOzHO?=y^m2JYfcOG)&~ws}entE=bCT7$ z=#rYt?lU1eR^i}WaqU8Z0rKPflqR^`l!q|k(Zo+khOK+ubx;hXEPh&3dhXVaKhK_5 zEWuW;iN*%L+&b5&xM}Dl-pY8w8~S%KsSYAxoEeE0RatjS6)vupzw^Mi4zR4J9^a9vEO zGsL1|=&T;B!-Hc|XANCOT4+&_Am}oQeN;)!5I#Ng%dGfD89Z`xzBJfQ5Uq?0g3AeUS9@IhE|>w~}OV)8>HvkoV#COPN{LT#vk8 zt2Z)j@{a(~lW*kv*4-rOL6sffa^(OAYdJ-0AsgF9gwSQe2wH&X@4yh*TSHt#%TNt1(?*1p$1*$&WoXj%(3D- zcQ5QJ#PkYUg9UjMs?vZCI$TX&{X=JmqECeM2>uCx|CpLx$`!gYuDe(vVX}YRkFG^k zURe>tw{_d=^mg9nvS?KtpkI=2?(iG$tPXR5QosdvzxGoCt z$$I=Gfzpq+2F3?10L^~%hk|tHo!byiu28i+0-PzrVDKCekd-_eW}(>Fp}Ancc191J z%LV{ozGVXd7!U|yD)X?cRj`u12B#u~Q22#>5x;tCwV54R+A8Kzk+(poe&f<5a*v*K zT2oU&Cy_LPGej(sedjw!v3{YylrY}sxYF)>cfp<-T!xEu)CFu&YJe?D)I%N!%*L!8 zEi#ZVi4r-oMksMF`zOoUUiq(+KVL}Vgk4zs|M2{i%LBzJSShuf5=6EJK+gfbJ})q= zG0GhyJ>s|)s`}>jgj5{06DiB8;CT5#UeEFuCDRNU65yFEh+SOUYPR?{idoz^hcctc z&442k_wYk5d(L7ZTKmy)4^n0o##7c6!_jl_B86&KbNSP0;&tq_AS1DeI66n%PR*pX zi2%0k-ZNP@3`AaRb)vJ?W}XEv*Z1a+PPd6tY;c0IY-s0=Iw-*C*soU) zC=bBofdMQRHt;f`m;%bDO+Q@6&hS8dvdDDe(V_H-k2t&!J`FL&9w2#0bHLqd5+>n8)4e;ua%TPUO&4#d!TjvD`IHe+m+wqABkj zoNs5r+GI!s>cQZx77EF%7%V;lk~d43R$%h9**@|sc6SSR>J07Anld(@sT0nyR>Qu_ zPhkc@Fj;M*AKsf3%f|p*H1HyY%3g7T%cCKt?y8k0=-`j0laL`{!mVH11jZ{=3)Zbo z21^05#asw*jiv?Hew&@KV*;teNz-jz?UZ2y0k!l8DBW^9Rj~0!uD>Ft|27Lg;_|N} z*?vvL_xnuig>$EG@^@kLoJ?zdbt0stXU1YVLJO_W zCv!h-*}a>}{Q3SZv`DX6-2%p&B;T>R%A72KsxXP5VK54m2trhI`mBmx(#zV{ zInu6zS{==2l?XBO^i7UsOK?Fk{?ekyEXECjxn| ze`kRpJim|8Q}?3d(XG1>vcoX%zs<(_g-QWYTElLe@&5AL%%^F!{2#PFiop zRz~d(ix56>b@e=g)qGNk>2`{de6Q_WxRCIF*6yQFR#bxy#Qy{EQ~~2n-V>tkL{`UY z&0Rmmuj2DpeT)jObl<7A@des_b`d1V25nwoq~e9M<^f>hHSU>co8g(*{m}-YwofiI z-mkS=3Wl~O+8MFVW{YqX8E6K**_pPc`QNK@m~X8Hg&Kle5qX4L!dd6!IWdLU*Nlkc zGiH(n$H6or(h^BfuCPB&?kP`30z;2(u1 zR+FQfD9dIbldYlRvSLo87bRrF5U656yei7F$Z+uFv&!-!9(3wD{QY)By0oUJmuQ{- zU}FV=;Y7LSZ1uxnRdzVY10dxWlIkcKoJet_HxrwC@n~W6^hFyQekJ5|pV<4XQj zka1?kZLfD%g`ld(`_Jln6>AAWt9jnwML-$NI@O($<9KJ{W`C%l?Zl4-L0J7Mr!-?21u}Dy5k;D zu}!eeZ*3?R;L}9xDghYu?{zNJxF-U5o>7it>+~T~$v2ua{;7P)^J*yJ6~TT02(a@l_L<@JIZo3wOYJ9t9BNNUnvpIZ184_1fah;Vh@r1saB z^4y@`7jq3dxmVlsiow+%)C~5)FovY6v>3pvw$J%t@r@7cp&Ec@j$@T1u-i81-!`X5 z*u0~!^hDZq+7k7};*;b~0?h1x(q(|(>8OIVD1hr(THoGWk=iwDyIPzQf69sA=(J+o zn#EcLV}QPlry2xM(Oe*&QuTxz|DO({_ui&T9ig&XSsUK?V&dy)5>MGnr6uw&*J)SR z4O5d0C2t!+(VG{Y3fFU3G4!F~;z`0^Zy$VT zlJGjGSF&$3BUtfc03n5Fp1KQfb~InA&8`q*1q&GG=||Hzpy6L2H1f*;LpyQht{w?} zDZ2kUk>FaSr)>&iD|Z|7sH6U!z%}z@JhB~OedrN<`}Lfq^UV}Y43>cn?*zZ0AOM2< zpX5w(`QSQaEYTvqHz~=NXHUjQf0o%dBkQfeAN31lR&xxOEgYHTdZp%bVXN280=Ana z^M=FH$n=5rl?&BI)^08Qe_`>YwGkkoEIR+Kv^%~Pb0k^b?3|sA#qp8cs#eTueeM2Q zRw=0&M&6mX$~YF!Y0ZBc@63#c7`f!9BKSXd@Voc{RoLU+XN*d^;RK${8T?=LBS%Bk z&gkb&o-U3d6^w6h1+IPUz|;DW zIZ;96kdsD>Qv^q=09&hp0GpEni<1IR%gvP3v%OR9*{MuRTKWHZyIbuBt)Ci`cU_&% z1T+i^Y)o{%281-<3TpPAUTzw5v;RY=>1rvxmPl96#kYc9hX!6V^nB|ad#(S+)}?8C zr_H+lT3B#So$T=?$(w3-{rbQ4R<@nsf$}$hwSO)A$8&`(j+wQf=Jwhb0`CvhR5DCf z^OgI)KQemrUFPH+UynC$Y~QHG%DbTVh-Skz{enNU)cV_hPu~{TD7TPZl>0&K>iuE| z7AYn$7)Jrb9GE&SfQW4q&G*@N|4cHI`VakFa5-C!ov&XD)J(qp$rJJ*9e z-sHv}#g*T7Cv048d1v~BEAzM5FztAse#q78WWC^BUCzQ U&wLp6h6BX&boFyt=akR{0G%$)mH+?% diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/images/widgets@2x.png deleted file mode 100644 index 4bbbd57272f3b28f47527d4951ad10f950b8ad43..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 855 zcmeAS@N?(olHy`uVBq!ia0y~yU}^xe12~w0Jcmn z@(X6T|9^jgLcx21{)7exgY)a>N6m2F0<`Rqr;B4q1>>88jUdw-7W`c)zLE*mq8W2H z-<&Jl_Hco5BuC5n@AbF5GD82~-e8-v=#zCyUX0F-o}8pPfAv`!GN$ff+TL<~@kgt} z62eO?_|&+>xBmM$@p|z`tIKEdpPf8%qI>4r7@jn<=eta*{3~?g(zz{Ke9zc-G^gr? z-7foa?LcS!hmbwzru}ICvbWLlW8;+l-}!^=c32!^nV`+`C*;0-*Y%l94pC;Cb3GXz zzSf%a!{gVr{Y_lVuUj+a)*Ca+!-Hu%xmP&&X-2CuANY8^i{D7Kg6qzP zXz_ps9+lN8ESH{K4`yu&b~I>N9xGlE&;2u*b?+Go!AhN?m-bxlLvtC#MzDF2kFzfHJ1W7ybqdefSqVhbOykd*Yi%EDuhs z4wF{ft^bv2+DDnKb8gj1FuvcV`M}luS>lO<^)8x>y1#R;a=-ZKwWTQQb)ioBbi;zh zD!f5V)8581to1LL7c9!l^PSC$NBPYif!_vAZhmL4)v4U)4UsrLYiH_9rmQDd?)(e5 z^pcH>qvBg*i0dus2r*mp4;zKvu=P#s-ti;2obl`NjjwoYd>e(oo#j_uyRb<7Pv^If zzZ|mGHmV)8^tbO%^>eqMw(@7(&3g{jEp-Najo7V75xI_ZHK*FA`elF{r5}E*d7+j_R diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js deleted file mode 100644 index dc257a868..000000000 --- a/docs/assets/js/main.js +++ /dev/null @@ -1,248 +0,0 @@ -/* - * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). - * This devtool is not neither made for production nor for readable output files. - * It uses "eval()" calls to create a separate source file in the browser devtools. - * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) - * or disable the default devtool with "devtool: false". - * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). - */ -/******/ (() => { // webpackBootstrap -/******/ var __webpack_modules__ = ({ - -/***/ "../node_modules/lunr/lunr.js": -/*!************************************!*\ - !*** ../node_modules/lunr/lunr.js ***! - \************************************/ -/***/ ((module, exports, __webpack_require__) => { - -eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); - -/***/ }), - -/***/ "./default/assets/css/main.sass": -/*!**************************************!*\ - !*** ./default/assets/css/main.sass ***! - \**************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); - -/***/ }), - -/***/ "./default/assets/js/src/bootstrap.ts": -/*!********************************************!*\ - !*** ./default/assets/js/src/bootstrap.ts ***! - \********************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Application.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/Application.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/Component.ts": -/*!****************************************************!*\ - !*** ./default/assets/js/src/typedoc/Component.ts ***! - \****************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/EventTarget.ts": -/*!******************************************************!*\ - !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! - \******************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Filter.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": -/*!*******************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! - \*******************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Search.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Search.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Signature.ts": -/*!***************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! - \***************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": -/*!************************************************************!*\ - !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! - \************************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": -/*!*********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! - \*********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); - -/***/ }), - -/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": -/*!********************************************************!*\ - !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! - \********************************************************/ -/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { - -"use strict"; -eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); - -/***/ }) - -/******/ }); -/************************************************************************/ -/******/ // The module cache -/******/ var __webpack_module_cache__ = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ // Check if module is in cache -/******/ if(__webpack_module_cache__[moduleId]) { -/******/ return __webpack_module_cache__[moduleId].exports; -/******/ } -/******/ // Create a new module (and put it into the cache) -/******/ var module = __webpack_module_cache__[moduleId] = { -/******/ // no module.id needed -/******/ // no module.loaded needed -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/************************************************************************/ -/******/ /* webpack/runtime/compat get default export */ -/******/ (() => { -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = (module) => { -/******/ var getter = module && module.__esModule ? -/******/ () => module['default'] : -/******/ () => module; -/******/ __webpack_require__.d(getter, { a: getter }); -/******/ return getter; -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/define property getters */ -/******/ (() => { -/******/ // define getter functions for harmony exports -/******/ __webpack_require__.d = (exports, definition) => { -/******/ for(var key in definition) { -/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { -/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); -/******/ } -/******/ } -/******/ }; -/******/ })(); -/******/ -/******/ /* webpack/runtime/hasOwnProperty shorthand */ -/******/ (() => { -/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) -/******/ })(); -/******/ -/******/ /* webpack/runtime/make namespace object */ -/******/ (() => { -/******/ // define __esModule on exports -/******/ __webpack_require__.r = (exports) => { -/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { -/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); -/******/ } -/******/ Object.defineProperty(exports, '__esModule', { value: true }); -/******/ }; -/******/ })(); -/******/ -/************************************************************************/ -/******/ // startup -/******/ // Load entry module -/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); -/******/ // This entry module used 'exports' so it can't be inlined -/******/ })() -; \ No newline at end of file diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js deleted file mode 100644 index 84e3326a6..000000000 --- a/docs/assets/js/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = {"kinds":{"1":"Module","4":"Enumeration","16":"Enumeration member","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":1,"name":"client","url":"modules/client.html","classes":"tsd-kind-module"},{"id":1,"kind":1,"name":"client/use-user","url":"modules/client_use_user.html","classes":"tsd-kind-module"},{"id":2,"kind":256,"name":"UserProfile","url":"interfaces/client_use_user.userprofile.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"client/use-user"},{"id":3,"kind":1024,"name":"email","url":"interfaces/client_use_user.userprofile.html#email","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":4,"kind":1024,"name":"email_verified","url":"interfaces/client_use_user.userprofile.html#email_verified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":5,"kind":1024,"name":"name","url":"interfaces/client_use_user.userprofile.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":6,"kind":1024,"name":"nickname","url":"interfaces/client_use_user.userprofile.html#nickname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":7,"kind":1024,"name":"picture","url":"interfaces/client_use_user.userprofile.html#picture","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":8,"kind":1024,"name":"sub","url":"interfaces/client_use_user.userprofile.html#sub","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":9,"kind":1024,"name":"updated_at","url":"interfaces/client_use_user.userprofile.html#updated_at","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":10,"kind":1024,"name":"org_id","url":"interfaces/client_use_user.userprofile.html#org_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/use-user.UserProfile"},{"id":11,"kind":4194304,"name":"UserContext","url":"modules/client_use_user.html#usercontext","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"client/use-user"},{"id":12,"kind":65536,"name":"__type","url":"modules/client_use_user.html#usercontext.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"client/use-user.UserContext"},{"id":13,"kind":1024,"name":"user","url":"modules/client_use_user.html#usercontext.__type.user","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"client/use-user.UserContext.__type"},{"id":14,"kind":1024,"name":"error","url":"modules/client_use_user.html#usercontext.__type.error","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"client/use-user.UserContext.__type"},{"id":15,"kind":1024,"name":"isLoading","url":"modules/client_use_user.html#usercontext.__type.isloading","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"client/use-user.UserContext.__type"},{"id":16,"kind":1024,"name":"checkSession","url":"modules/client_use_user.html#usercontext.__type.checksession","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"client/use-user.UserContext.__type"},{"id":17,"kind":65536,"name":"__type","url":"modules/client_use_user.html#usercontext.__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"client/use-user.UserContext.__type"},{"id":18,"kind":128,"name":"RequestError","url":"classes/client_use_user.requesterror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"client/use-user"},{"id":19,"kind":512,"name":"constructor","url":"classes/client_use_user.requesterror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"client/use-user.RequestError"},{"id":20,"kind":1024,"name":"status","url":"classes/client_use_user.requesterror.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"client/use-user.RequestError"},{"id":21,"kind":4194304,"name":"UserProviderProps","url":"modules/client_use_user.html#userproviderprops","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"client/use-user"},{"id":22,"kind":64,"name":"useUser","url":"modules/client_use_user.html#useuser","classes":"tsd-kind-function tsd-parent-kind-module","parent":"client/use-user"},{"id":23,"kind":4194304,"name":"UserProvider","url":"modules/client_use_user.html#userprovider","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"client/use-user"},{"id":24,"kind":65536,"name":"__type","url":"modules/client_use_user.html#userprovider.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"client/use-user.UserProvider"},{"id":25,"kind":1024,"name":"default","url":"modules/client_use_user.html#default","classes":"tsd-kind-property tsd-parent-kind-module","parent":"client/use-user"},{"id":26,"kind":65536,"name":"__type","url":"modules/client_use_user.html#__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-module","parent":"client/use-user"},{"id":27,"kind":1,"name":"client/with-page-auth-required","url":"modules/client_with_page_auth_required.html","classes":"tsd-kind-module"},{"id":28,"kind":256,"name":"WithPageAuthRequiredOptions","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"client/with-page-auth-required"},{"id":29,"kind":1024,"name":"returnTo","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html#returnto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":30,"kind":1024,"name":"onRedirecting","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html#onredirecting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":31,"kind":65536,"name":"__type","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"client/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":32,"kind":1024,"name":"onError","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html#onerror","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":33,"kind":65536,"name":"__type","url":"interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"client/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":34,"kind":256,"name":"UserProps","url":"interfaces/client_with_page_auth_required.userprops.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"client/with-page-auth-required"},{"id":35,"kind":1024,"name":"user","url":"interfaces/client_with_page_auth_required.userprops.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"client/with-page-auth-required.UserProps"},{"id":36,"kind":4194304,"name":"WithPageAuthRequired","url":"modules/client_with_page_auth_required.html#withpageauthrequired","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"client/with-page-auth-required"},{"id":37,"kind":65536,"name":"__type","url":"modules/client_with_page_auth_required.html#withpageauthrequired.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-has-type-parameter","parent":"client/with-page-auth-required.WithPageAuthRequired"},{"id":38,"kind":1,"name":"config","url":"modules/config.html","classes":"tsd-kind-module"},{"id":39,"kind":256,"name":"BaseConfig","url":"interfaces/config.baseconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"config"},{"id":40,"kind":1024,"name":"secret","url":"interfaces/config.baseconfig.html#secret","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":41,"kind":1024,"name":"session","url":"interfaces/config.baseconfig.html#session","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":42,"kind":1024,"name":"auth0Logout","url":"interfaces/config.baseconfig.html#auth0logout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":43,"kind":1024,"name":"authorizationParams","url":"interfaces/config.baseconfig.html#authorizationparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":44,"kind":1024,"name":"baseURL","url":"interfaces/config.baseconfig.html#baseurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":45,"kind":1024,"name":"clientID","url":"interfaces/config.baseconfig.html#clientid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":46,"kind":1024,"name":"clientSecret","url":"interfaces/config.baseconfig.html#clientsecret","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":47,"kind":1024,"name":"clockTolerance","url":"interfaces/config.baseconfig.html#clocktolerance","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":48,"kind":1024,"name":"httpTimeout","url":"interfaces/config.baseconfig.html#httptimeout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":49,"kind":1024,"name":"enableTelemetry","url":"interfaces/config.baseconfig.html#enabletelemetry","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":50,"kind":1024,"name":"getLoginState","url":"interfaces/config.baseconfig.html#getloginstate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":51,"kind":65536,"name":"__type","url":"interfaces/config.baseconfig.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":52,"kind":1024,"name":"identityClaimFilter","url":"interfaces/config.baseconfig.html#identityclaimfilter","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":53,"kind":1024,"name":"idpLogout","url":"interfaces/config.baseconfig.html#idplogout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":54,"kind":1024,"name":"idTokenSigningAlg","url":"interfaces/config.baseconfig.html#idtokensigningalg","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":55,"kind":1024,"name":"issuerBaseURL","url":"interfaces/config.baseconfig.html#issuerbaseurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":56,"kind":1024,"name":"legacySameSiteCookie","url":"interfaces/config.baseconfig.html#legacysamesitecookie","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":57,"kind":1024,"name":"routes","url":"interfaces/config.baseconfig.html#routes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":58,"kind":65536,"name":"__type","url":"interfaces/config.baseconfig.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"config.BaseConfig"},{"id":59,"kind":1024,"name":"postLogoutRedirect","url":"interfaces/config.baseconfig.html#__type-1.postlogoutredirect","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"config.BaseConfig.__type"},{"id":60,"kind":1024,"name":"callback","url":"interfaces/config.baseconfig.html#__type-1.callback","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"config.BaseConfig.__type"},{"id":61,"kind":256,"name":"SessionConfig","url":"interfaces/config.sessionconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"config"},{"id":62,"kind":1024,"name":"name","url":"interfaces/config.sessionconfig.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":63,"kind":1024,"name":"store","url":"interfaces/config.sessionconfig.html#store","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":64,"kind":1024,"name":"genId","url":"interfaces/config.sessionconfig.html#genid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":65,"kind":65536,"name":"__type","url":"interfaces/config.sessionconfig.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface tsd-has-type-parameter","parent":"config.SessionConfig"},{"id":66,"kind":1024,"name":"rolling","url":"interfaces/config.sessionconfig.html#rolling","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":67,"kind":1024,"name":"rollingDuration","url":"interfaces/config.sessionconfig.html#rollingduration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":68,"kind":1024,"name":"absoluteDuration","url":"interfaces/config.sessionconfig.html#absoluteduration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":69,"kind":1024,"name":"storeIDToken","url":"interfaces/config.sessionconfig.html#storeidtoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":70,"kind":1024,"name":"cookie","url":"interfaces/config.sessionconfig.html#cookie","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.SessionConfig"},{"id":71,"kind":256,"name":"CookieConfig","url":"interfaces/config.cookieconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"config"},{"id":72,"kind":1024,"name":"domain","url":"interfaces/config.cookieconfig.html#domain","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":73,"kind":1024,"name":"path","url":"interfaces/config.cookieconfig.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":74,"kind":1024,"name":"transient","url":"interfaces/config.cookieconfig.html#transient","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":75,"kind":1024,"name":"httpOnly","url":"interfaces/config.cookieconfig.html#httponly","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":76,"kind":1024,"name":"secure","url":"interfaces/config.cookieconfig.html#secure","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":77,"kind":1024,"name":"sameSite","url":"interfaces/config.cookieconfig.html#samesite","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.CookieConfig"},{"id":78,"kind":256,"name":"AuthorizationParameters","url":"interfaces/config.authorizationparameters.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"config"},{"id":79,"kind":1024,"name":"scope","url":"interfaces/config.authorizationparameters.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"config.AuthorizationParameters"},{"id":80,"kind":1024,"name":"response_mode","url":"interfaces/config.authorizationparameters.html#response_mode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"config.AuthorizationParameters"},{"id":81,"kind":1024,"name":"response_type","url":"interfaces/config.authorizationparameters.html#response_type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"config.AuthorizationParameters"},{"id":82,"kind":256,"name":"NextConfig","url":"interfaces/config.nextconfig.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"config"},{"id":83,"kind":1024,"name":"organization","url":"interfaces/config.nextconfig.html#organization","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.NextConfig"},{"id":84,"kind":1024,"name":"routes","url":"interfaces/config.nextconfig.html#routes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"config.NextConfig"},{"id":85,"kind":65536,"name":"__type","url":"interfaces/config.nextconfig.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"config.NextConfig"},{"id":86,"kind":1024,"name":"callback","url":"interfaces/config.nextconfig.html#__type.callback","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"config.NextConfig.__type"},{"id":87,"kind":1024,"name":"login","url":"interfaces/config.nextconfig.html#__type.login","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"config.NextConfig.__type"},{"id":88,"kind":1024,"name":"unauthorized","url":"interfaces/config.nextconfig.html#__type.unauthorized","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"config.NextConfig.__type"},{"id":89,"kind":1024,"name":"identityClaimFilter","url":"interfaces/config.nextconfig.html#identityclaimfilter","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"config.NextConfig"},{"id":90,"kind":4194304,"name":"ConfigParameters","url":"modules/config.html#configparameters","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"config"},{"id":91,"kind":1,"name":"edge","url":"modules/edge.html","classes":"tsd-kind-module"},{"id":92,"kind":4194304,"name":"Auth0Edge","url":"modules/edge.html#auth0edge","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"edge"},{"id":93,"kind":65536,"name":"__type","url":"modules/edge.html#auth0edge.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"edge.Auth0Edge"},{"id":94,"kind":1024,"name":"withMiddlewareAuthRequired","url":"modules/edge.html#auth0edge.__type.withmiddlewareauthrequired-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"edge.Auth0Edge.__type"},{"id":95,"kind":1024,"name":"getSession","url":"modules/edge.html#auth0edge.__type.getsession","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"edge.Auth0Edge.__type"},{"id":96,"kind":4194304,"name":"GetSession","url":"modules/edge.html#getsession-1","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"edge"},{"id":97,"kind":65536,"name":"__type","url":"modules/edge.html#getsession-1.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"edge.GetSession"},{"id":98,"kind":4194304,"name":"InitAuth0","url":"modules/edge.html#initauth0","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"edge"},{"id":99,"kind":65536,"name":"__type","url":"modules/edge.html#initauth0.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"edge.InitAuth0"},{"id":100,"kind":64,"name":"initAuth0","url":"modules/edge.html#initauth0-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"edge"},{"id":101,"kind":64,"name":"getSession","url":"modules/edge.html#getsession-2","classes":"tsd-kind-function tsd-parent-kind-module","parent":"edge"},{"id":102,"kind":64,"name":"withMiddlewareAuthRequired","url":"modules/edge.html#withmiddlewareauthrequired-2","classes":"tsd-kind-function tsd-parent-kind-module","parent":"edge"},{"id":103,"kind":1,"name":"handlers/auth","url":"modules/handlers_auth.html","classes":"tsd-kind-module"},{"id":104,"kind":4194304,"name":"Handlers","url":"modules/handlers_auth.html#handlers","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/auth"},{"id":105,"kind":4194304,"name":"HandleAuth","url":"modules/handlers_auth.html#handleauth","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/auth"},{"id":106,"kind":65536,"name":"__type","url":"modules/handlers_auth.html#handleauth.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/auth.HandleAuth"},{"id":107,"kind":4194304,"name":"OnError","url":"modules/handlers_auth.html#onerror","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/auth"},{"id":108,"kind":65536,"name":"__type","url":"modules/handlers_auth.html#onerror.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/auth.OnError"},{"id":109,"kind":1,"name":"handlers/callback","url":"modules/handlers_callback.html","classes":"tsd-kind-module"},{"id":110,"kind":4194304,"name":"AfterCallback","url":"modules/handlers_callback.html#aftercallback","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/callback"},{"id":111,"kind":65536,"name":"__type","url":"modules/handlers_callback.html#aftercallback.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/callback.AfterCallback"},{"id":112,"kind":256,"name":"CallbackOptions","url":"interfaces/handlers_callback.callbackoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"handlers/callback"},{"id":113,"kind":1024,"name":"afterCallback","url":"interfaces/handlers_callback.callbackoptions.html#aftercallback","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/callback.CallbackOptions"},{"id":114,"kind":1024,"name":"redirectUri","url":"interfaces/handlers_callback.callbackoptions.html#redirecturi","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/callback.CallbackOptions"},{"id":115,"kind":1024,"name":"organization","url":"interfaces/handlers_callback.callbackoptions.html#organization","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/callback.CallbackOptions"},{"id":116,"kind":1024,"name":"authorizationParams","url":"interfaces/handlers_callback.callbackoptions.html#authorizationparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/callback.CallbackOptions"},{"id":117,"kind":4194304,"name":"CallbackOptionsProvider","url":"modules/handlers_callback.html#callbackoptionsprovider","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/callback"},{"id":118,"kind":65536,"name":"__type","url":"modules/handlers_callback.html#callbackoptionsprovider.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/callback.CallbackOptionsProvider"},{"id":119,"kind":4194304,"name":"HandleCallback","url":"modules/handlers_callback.html#handlecallback","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/callback"},{"id":120,"kind":65536,"name":"__type","url":"modules/handlers_callback.html#handlecallback.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/callback.HandleCallback"},{"id":121,"kind":4194304,"name":"CallbackHandler","url":"modules/handlers_callback.html#callbackhandler","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/callback"},{"id":122,"kind":65536,"name":"__type","url":"modules/handlers_callback.html#callbackhandler.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/callback.CallbackHandler"},{"id":123,"kind":1,"name":"handlers","url":"modules/handlers.html","classes":"tsd-kind-module"},{"id":124,"kind":1,"name":"handlers/login","url":"modules/handlers_login.html","classes":"tsd-kind-module"},{"id":125,"kind":4194304,"name":"GetLoginState","url":"modules/handlers_login.html#getloginstate","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/login"},{"id":126,"kind":65536,"name":"__type","url":"modules/handlers_login.html#getloginstate.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/login.GetLoginState"},{"id":127,"kind":256,"name":"AuthorizationParams","url":"interfaces/handlers_login.authorizationparams.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"handlers/login"},{"id":128,"kind":1024,"name":"connection","url":"interfaces/handlers_login.authorizationparams.html#connection","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.AuthorizationParams"},{"id":129,"kind":1024,"name":"connection_scope","url":"interfaces/handlers_login.authorizationparams.html#connection_scope","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.AuthorizationParams"},{"id":130,"kind":1024,"name":"invitation","url":"interfaces/handlers_login.authorizationparams.html#invitation","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.AuthorizationParams"},{"id":131,"kind":1024,"name":"organization","url":"interfaces/handlers_login.authorizationparams.html#organization","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.AuthorizationParams"},{"id":132,"kind":1024,"name":"screen_hint","url":"interfaces/handlers_login.authorizationparams.html#screen_hint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.AuthorizationParams"},{"id":133,"kind":1024,"name":"scope","url":"interfaces/handlers_login.authorizationparams.html#scope","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"handlers/login.AuthorizationParams"},{"id":134,"kind":1024,"name":"response_mode","url":"interfaces/handlers_login.authorizationparams.html#response_mode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"handlers/login.AuthorizationParams"},{"id":135,"kind":1024,"name":"response_type","url":"interfaces/handlers_login.authorizationparams.html#response_type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"handlers/login.AuthorizationParams"},{"id":136,"kind":256,"name":"LoginOptions","url":"interfaces/handlers_login.loginoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"handlers/login"},{"id":137,"kind":1024,"name":"authorizationParams","url":"interfaces/handlers_login.loginoptions.html#authorizationparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.LoginOptions"},{"id":138,"kind":1024,"name":"returnTo","url":"interfaces/handlers_login.loginoptions.html#returnto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.LoginOptions"},{"id":139,"kind":1024,"name":"getLoginState","url":"interfaces/handlers_login.loginoptions.html#getloginstate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/login.LoginOptions"},{"id":140,"kind":4194304,"name":"LoginOptionsProvider","url":"modules/handlers_login.html#loginoptionsprovider","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/login"},{"id":141,"kind":65536,"name":"__type","url":"modules/handlers_login.html#loginoptionsprovider.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/login.LoginOptionsProvider"},{"id":142,"kind":4194304,"name":"HandleLogin","url":"modules/handlers_login.html#handlelogin","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/login"},{"id":143,"kind":65536,"name":"__type","url":"modules/handlers_login.html#handlelogin.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/login.HandleLogin"},{"id":144,"kind":4194304,"name":"LoginHandler","url":"modules/handlers_login.html#loginhandler","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/login"},{"id":145,"kind":65536,"name":"__type","url":"modules/handlers_login.html#loginhandler.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/login.LoginHandler"},{"id":146,"kind":1,"name":"handlers/logout","url":"modules/handlers_logout.html","classes":"tsd-kind-module"},{"id":147,"kind":256,"name":"LogoutOptions","url":"interfaces/handlers_logout.logoutoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"handlers/logout"},{"id":148,"kind":1024,"name":"returnTo","url":"interfaces/handlers_logout.logoutoptions.html#returnto","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/logout.LogoutOptions"},{"id":149,"kind":1024,"name":"logoutParams","url":"interfaces/handlers_logout.logoutoptions.html#logoutparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"handlers/logout.LogoutOptions"},{"id":150,"kind":65536,"name":"__type","url":"interfaces/handlers_logout.logoutoptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"handlers/logout.LogoutOptions"},{"id":151,"kind":4194304,"name":"LogoutOptionsProvider","url":"modules/handlers_logout.html#logoutoptionsprovider","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/logout"},{"id":152,"kind":65536,"name":"__type","url":"modules/handlers_logout.html#logoutoptionsprovider.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/logout.LogoutOptionsProvider"},{"id":153,"kind":4194304,"name":"HandleLogout","url":"modules/handlers_logout.html#handlelogout","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/logout"},{"id":154,"kind":65536,"name":"__type","url":"modules/handlers_logout.html#handlelogout.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/logout.HandleLogout"},{"id":155,"kind":4194304,"name":"LogoutHandler","url":"modules/handlers_logout.html#logouthandler","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/logout"},{"id":156,"kind":65536,"name":"__type","url":"modules/handlers_logout.html#logouthandler.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/logout.LogoutHandler"},{"id":157,"kind":1,"name":"handlers/profile","url":"modules/handlers_profile.html","classes":"tsd-kind-module"},{"id":158,"kind":4194304,"name":"AfterRefetch","url":"modules/handlers_profile.html#afterrefetch","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/profile"},{"id":159,"kind":65536,"name":"__type","url":"modules/handlers_profile.html#afterrefetch.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/profile.AfterRefetch"},{"id":160,"kind":4194304,"name":"ProfileOptions","url":"modules/handlers_profile.html#profileoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/profile"},{"id":161,"kind":65536,"name":"__type","url":"modules/handlers_profile.html#profileoptions.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/profile.ProfileOptions"},{"id":162,"kind":1024,"name":"refetch","url":"modules/handlers_profile.html#profileoptions.__type-3.refetch","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"handlers/profile.ProfileOptions.__type"},{"id":163,"kind":1024,"name":"afterRefetch","url":"modules/handlers_profile.html#profileoptions.__type-3.afterrefetch-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"handlers/profile.ProfileOptions.__type"},{"id":164,"kind":4194304,"name":"ProfileOptionsProvider","url":"modules/handlers_profile.html#profileoptionsprovider","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/profile"},{"id":165,"kind":65536,"name":"__type","url":"modules/handlers_profile.html#profileoptionsprovider.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/profile.ProfileOptionsProvider"},{"id":166,"kind":4194304,"name":"HandleProfile","url":"modules/handlers_profile.html#handleprofile","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/profile"},{"id":167,"kind":65536,"name":"__type","url":"modules/handlers_profile.html#handleprofile.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/profile.HandleProfile"},{"id":168,"kind":4194304,"name":"ProfileHandler","url":"modules/handlers_profile.html#profilehandler","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"handlers/profile"},{"id":169,"kind":65536,"name":"__type","url":"modules/handlers_profile.html#profilehandler.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"handlers/profile.ProfileHandler"},{"id":170,"kind":1,"name":"helpers","url":"modules/helpers.html","classes":"tsd-kind-module"},{"id":171,"kind":1,"name":"helpers/testing","url":"modules/helpers_testing.html","classes":"tsd-kind-module"},{"id":172,"kind":4194304,"name":"GenerateSessionCookieConfig","url":"modules/helpers_testing.html#generatesessioncookieconfig","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"helpers/testing"},{"id":173,"kind":64,"name":"generateSessionCookie","url":"modules/helpers_testing.html#generatesessioncookie","classes":"tsd-kind-function tsd-parent-kind-module","parent":"helpers/testing"},{"id":174,"kind":1,"name":"helpers/with-api-auth-required","url":"modules/helpers_with_api_auth_required.html","classes":"tsd-kind-module"},{"id":175,"kind":4194304,"name":"WithApiAuthRequired","url":"modules/helpers_with_api_auth_required.html#withapiauthrequired","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"helpers/with-api-auth-required"},{"id":176,"kind":65536,"name":"__type","url":"modules/helpers_with_api_auth_required.html#withapiauthrequired.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"helpers/with-api-auth-required.WithApiAuthRequired"},{"id":177,"kind":1,"name":"helpers/with-middleware-auth-required","url":"modules/helpers_with_middleware_auth_required.html","classes":"tsd-kind-module"},{"id":178,"kind":4194304,"name":"WithMiddlewareAuthRequired","url":"modules/helpers_with_middleware_auth_required.html#withmiddlewareauthrequired","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"helpers/with-middleware-auth-required"},{"id":179,"kind":65536,"name":"__type","url":"modules/helpers_with_middleware_auth_required.html#withmiddlewareauthrequired.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"helpers/with-middleware-auth-required.WithMiddlewareAuthRequired"},{"id":180,"kind":1,"name":"helpers/with-page-auth-required","url":"modules/helpers_with_page_auth_required.html","classes":"tsd-kind-module"},{"id":181,"kind":4194304,"name":"GetServerSidePropsResultWithSession","url":"modules/helpers_with_page_auth_required.html#getserversidepropsresultwithsession","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"helpers/with-page-auth-required"},{"id":182,"kind":4194304,"name":"PageRoute","url":"modules/helpers_with_page_auth_required.html#pageroute","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"helpers/with-page-auth-required"},{"id":183,"kind":65536,"name":"__type","url":"modules/helpers_with_page_auth_required.html#pageroute.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"helpers/with-page-auth-required.PageRoute"},{"id":184,"kind":4194304,"name":"WithPageAuthRequiredOptions","url":"modules/helpers_with_page_auth_required.html#withpageauthrequiredoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"helpers/with-page-auth-required"},{"id":185,"kind":65536,"name":"__type","url":"modules/helpers_with_page_auth_required.html#withpageauthrequiredoptions.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"helpers/with-page-auth-required.WithPageAuthRequiredOptions"},{"id":186,"kind":1024,"name":"getServerSideProps","url":"modules/helpers_with_page_auth_required.html#withpageauthrequiredoptions.__type-2.getserversideprops","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"helpers/with-page-auth-required.WithPageAuthRequiredOptions.__type"},{"id":187,"kind":1024,"name":"returnTo","url":"modules/helpers_with_page_auth_required.html#withpageauthrequiredoptions.__type-2.returnto","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"helpers/with-page-auth-required.WithPageAuthRequiredOptions.__type"},{"id":188,"kind":4194304,"name":"WithPageAuthRequired","url":"modules/helpers_with_page_auth_required.html#withpageauthrequired","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"helpers/with-page-auth-required"},{"id":189,"kind":65536,"name":"__type","url":"modules/helpers_with_page_auth_required.html#withpageauthrequired.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-has-type-parameter","parent":"helpers/with-page-auth-required.WithPageAuthRequired"},{"id":190,"kind":1,"name":"index","url":"modules/index.html","classes":"tsd-kind-module"},{"id":191,"kind":256,"name":"Auth0Server","url":"interfaces/index.auth0server.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"index"},{"id":192,"kind":1024,"name":"getSession","url":"interfaces/index.auth0server.html#getsession","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":193,"kind":1024,"name":"updateSession","url":"interfaces/index.auth0server.html#updatesession","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":194,"kind":1024,"name":"getAccessToken","url":"interfaces/index.auth0server.html#getaccesstoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":195,"kind":1024,"name":"handleLogin","url":"interfaces/index.auth0server.html#handlelogin","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":196,"kind":1024,"name":"handleCallback","url":"interfaces/index.auth0server.html#handlecallback","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":197,"kind":1024,"name":"handleLogout","url":"interfaces/index.auth0server.html#handlelogout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":198,"kind":1024,"name":"handleProfile","url":"interfaces/index.auth0server.html#handleprofile","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":199,"kind":1024,"name":"withApiAuthRequired","url":"interfaces/index.auth0server.html#withapiauthrequired","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":200,"kind":1024,"name":"withPageAuthRequired","url":"interfaces/index.auth0server.html#withpageauthrequired","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":201,"kind":1024,"name":"handleAuth","url":"interfaces/index.auth0server.html#handleauth","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"index.Auth0Server"},{"id":202,"kind":4194304,"name":"InitAuth0","url":"modules/index.html#initauth0","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"index"},{"id":203,"kind":65536,"name":"__type","url":"modules/index.html#initauth0.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"index.InitAuth0"},{"id":204,"kind":64,"name":"initAuth0","url":"modules/index.html#initauth0-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":205,"kind":64,"name":"_initAuth","url":"modules/index.html#_initauth","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":206,"kind":64,"name":"getSession","url":"modules/index.html#getsession-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":207,"kind":64,"name":"updateSession","url":"modules/index.html#updatesession-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":208,"kind":64,"name":"getAccessToken","url":"modules/index.html#getaccesstoken-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":209,"kind":64,"name":"withApiAuthRequired","url":"modules/index.html#withapiauthrequired-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":210,"kind":64,"name":"withPageAuthRequired","url":"modules/index.html#withpageauthrequired-1","classes":"tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter","parent":"index"},{"id":211,"kind":64,"name":"handleLogin","url":"modules/index.html#handlelogin-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":212,"kind":64,"name":"handleLogout","url":"modules/index.html#handlelogout-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":213,"kind":64,"name":"handleCallback","url":"modules/index.html#handlecallback-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":214,"kind":64,"name":"handleProfile","url":"modules/index.html#handleprofile-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":215,"kind":64,"name":"handleAuth","url":"modules/index.html#handleauth-1","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":216,"kind":4194304,"name":"SessionStore","url":"modules/index.html#sessionstore","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"index"},{"id":217,"kind":4194304,"name":"SessionStorePayload","url":"modules/index.html#sessionstorepayload","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"index"},{"id":218,"kind":1,"name":"session/get-access-token","url":"modules/session_get_access_token.html","classes":"tsd-kind-module"},{"id":219,"kind":4194304,"name":"AfterRefresh","url":"modules/session_get_access_token.html#afterrefresh","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"session/get-access-token"},{"id":220,"kind":65536,"name":"__type","url":"modules/session_get_access_token.html#afterrefresh.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"session/get-access-token.AfterRefresh"},{"id":221,"kind":256,"name":"AccessTokenRequest","url":"interfaces/session_get_access_token.accesstokenrequest.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"session/get-access-token"},{"id":222,"kind":1024,"name":"scopes","url":"interfaces/session_get_access_token.accesstokenrequest.html#scopes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"session/get-access-token.AccessTokenRequest"},{"id":223,"kind":1024,"name":"refresh","url":"interfaces/session_get_access_token.accesstokenrequest.html#refresh","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"session/get-access-token.AccessTokenRequest"},{"id":224,"kind":1024,"name":"afterRefresh","url":"interfaces/session_get_access_token.accesstokenrequest.html#afterrefresh","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"session/get-access-token.AccessTokenRequest"},{"id":225,"kind":1024,"name":"authorizationParams","url":"interfaces/session_get_access_token.accesstokenrequest.html#authorizationparams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"session/get-access-token.AccessTokenRequest"},{"id":226,"kind":256,"name":"GetAccessTokenResult","url":"interfaces/session_get_access_token.getaccesstokenresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"session/get-access-token"},{"id":227,"kind":1024,"name":"accessToken","url":"interfaces/session_get_access_token.getaccesstokenresult.html#accesstoken","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"session/get-access-token.GetAccessTokenResult"},{"id":228,"kind":4194304,"name":"GetAccessToken","url":"modules/session_get_access_token.html#getaccesstoken","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"session/get-access-token"},{"id":229,"kind":65536,"name":"__type","url":"modules/session_get_access_token.html#getaccesstoken.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"session/get-access-token.GetAccessToken"},{"id":230,"kind":1,"name":"session/get-session","url":"modules/session_get_session.html","classes":"tsd-kind-module"},{"id":231,"kind":4194304,"name":"GetSession","url":"modules/session_get_session.html#getsession","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"session/get-session"},{"id":232,"kind":65536,"name":"__type","url":"modules/session_get_session.html#getsession.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"session/get-session.GetSession"},{"id":233,"kind":1,"name":"session","url":"modules/session.html","classes":"tsd-kind-module"},{"id":234,"kind":1,"name":"session/session","url":"modules/session_session.html","classes":"tsd-kind-module"},{"id":235,"kind":256,"name":"Claims","url":"interfaces/session_session.claims.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"session/session"},{"id":236,"kind":128,"name":"default","url":"classes/session_session.default.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"session/session"},{"id":237,"kind":512,"name":"constructor","url":"classes/session_session.default.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"session/session.default"},{"id":238,"kind":1024,"name":"user","url":"classes/session_session.default.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":239,"kind":1024,"name":"idToken","url":"classes/session_session.default.html#idtoken","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":240,"kind":1024,"name":"accessToken","url":"classes/session_session.default.html#accesstoken","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":241,"kind":1024,"name":"accessTokenScope","url":"classes/session_session.default.html#accesstokenscope","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":242,"kind":1024,"name":"accessTokenExpiresAt","url":"classes/session_session.default.html#accesstokenexpiresat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":243,"kind":1024,"name":"refreshToken","url":"classes/session_session.default.html#refreshtoken","classes":"tsd-kind-property tsd-parent-kind-class","parent":"session/session.default"},{"id":244,"kind":1,"name":"session/update-session","url":"modules/session_update_session.html","classes":"tsd-kind-module"},{"id":245,"kind":4194304,"name":"UpdateSession","url":"modules/session_update_session.html#updatesession","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"session/update-session"},{"id":246,"kind":65536,"name":"__type","url":"modules/session_update_session.html#updatesession.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"session/update-session.UpdateSession"},{"id":247,"kind":1,"name":"utils/errors","url":"modules/utils_errors.html","classes":"tsd-kind-module"},{"id":248,"kind":128,"name":"AuthError","url":"classes/utils_errors.autherror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":249,"kind":512,"name":"constructor","url":"classes/utils_errors.autherror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.AuthError"},{"id":250,"kind":1024,"name":"code","url":"classes/utils_errors.autherror.html#code","classes":"tsd-kind-property tsd-parent-kind-class","parent":"utils/errors.AuthError"},{"id":251,"kind":1024,"name":"name","url":"classes/utils_errors.autherror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.AuthError"},{"id":252,"kind":1024,"name":"cause","url":"classes/utils_errors.autherror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class","parent":"utils/errors.AuthError"},{"id":253,"kind":1024,"name":"status","url":"classes/utils_errors.autherror.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"utils/errors.AuthError"},{"id":254,"kind":4,"name":"AccessTokenErrorCode","url":"enums/utils_errors.accesstokenerrorcode.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"utils/errors"},{"id":255,"kind":16,"name":"MISSING_SESSION","url":"enums/utils_errors.accesstokenerrorcode.html#missing_session","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":256,"kind":16,"name":"MISSING_ACCESS_TOKEN","url":"enums/utils_errors.accesstokenerrorcode.html#missing_access_token","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":257,"kind":16,"name":"MISSING_REFRESH_TOKEN","url":"enums/utils_errors.accesstokenerrorcode.html#missing_refresh_token","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":258,"kind":16,"name":"EXPIRED_ACCESS_TOKEN","url":"enums/utils_errors.accesstokenerrorcode.html#expired_access_token","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":259,"kind":16,"name":"INSUFFICIENT_SCOPE","url":"enums/utils_errors.accesstokenerrorcode.html#insufficient_scope","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":260,"kind":16,"name":"FAILED_REFRESH_GRANT","url":"enums/utils_errors.accesstokenerrorcode.html#failed_refresh_grant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"utils/errors.AccessTokenErrorCode"},{"id":261,"kind":128,"name":"AccessTokenError","url":"classes/utils_errors.accesstokenerror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":262,"kind":512,"name":"constructor","url":"classes/utils_errors.accesstokenerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.AccessTokenError"},{"id":263,"kind":1024,"name":"code","url":"classes/utils_errors.accesstokenerror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.AccessTokenError"},{"id":264,"kind":1024,"name":"name","url":"classes/utils_errors.accesstokenerror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.AccessTokenError"},{"id":265,"kind":1024,"name":"cause","url":"classes/utils_errors.accesstokenerror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.AccessTokenError"},{"id":266,"kind":1024,"name":"status","url":"classes/utils_errors.accesstokenerror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.AccessTokenError"},{"id":267,"kind":128,"name":"HandlerError","url":"classes/utils_errors.handlererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":268,"kind":512,"name":"constructor","url":"classes/utils_errors.handlererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.HandlerError"},{"id":269,"kind":1024,"name":"code","url":"classes/utils_errors.handlererror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.HandlerError"},{"id":270,"kind":1024,"name":"name","url":"classes/utils_errors.handlererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.HandlerError"},{"id":271,"kind":1024,"name":"cause","url":"classes/utils_errors.handlererror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.HandlerError"},{"id":272,"kind":1024,"name":"status","url":"classes/utils_errors.handlererror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.HandlerError"},{"id":273,"kind":128,"name":"CallbackHandlerError","url":"classes/utils_errors.callbackhandlererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":274,"kind":1024,"name":"code","url":"classes/utils_errors.callbackhandlererror.html#code-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"utils/errors.CallbackHandlerError"},{"id":275,"kind":512,"name":"constructor","url":"classes/utils_errors.callbackhandlererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.CallbackHandlerError"},{"id":276,"kind":1024,"name":"code","url":"classes/utils_errors.callbackhandlererror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.CallbackHandlerError"},{"id":277,"kind":1024,"name":"name","url":"classes/utils_errors.callbackhandlererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.CallbackHandlerError"},{"id":278,"kind":1024,"name":"cause","url":"classes/utils_errors.callbackhandlererror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.CallbackHandlerError"},{"id":279,"kind":1024,"name":"status","url":"classes/utils_errors.callbackhandlererror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.CallbackHandlerError"},{"id":280,"kind":128,"name":"LoginHandlerError","url":"classes/utils_errors.loginhandlererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":281,"kind":1024,"name":"code","url":"classes/utils_errors.loginhandlererror.html#code-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"utils/errors.LoginHandlerError"},{"id":282,"kind":512,"name":"constructor","url":"classes/utils_errors.loginhandlererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.LoginHandlerError"},{"id":283,"kind":1024,"name":"code","url":"classes/utils_errors.loginhandlererror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LoginHandlerError"},{"id":284,"kind":1024,"name":"name","url":"classes/utils_errors.loginhandlererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LoginHandlerError"},{"id":285,"kind":1024,"name":"cause","url":"classes/utils_errors.loginhandlererror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LoginHandlerError"},{"id":286,"kind":1024,"name":"status","url":"classes/utils_errors.loginhandlererror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LoginHandlerError"},{"id":287,"kind":128,"name":"LogoutHandlerError","url":"classes/utils_errors.logouthandlererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":288,"kind":1024,"name":"code","url":"classes/utils_errors.logouthandlererror.html#code-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"utils/errors.LogoutHandlerError"},{"id":289,"kind":512,"name":"constructor","url":"classes/utils_errors.logouthandlererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.LogoutHandlerError"},{"id":290,"kind":1024,"name":"code","url":"classes/utils_errors.logouthandlererror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LogoutHandlerError"},{"id":291,"kind":1024,"name":"name","url":"classes/utils_errors.logouthandlererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LogoutHandlerError"},{"id":292,"kind":1024,"name":"cause","url":"classes/utils_errors.logouthandlererror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LogoutHandlerError"},{"id":293,"kind":1024,"name":"status","url":"classes/utils_errors.logouthandlererror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.LogoutHandlerError"},{"id":294,"kind":128,"name":"ProfileHandlerError","url":"classes/utils_errors.profilehandlererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"utils/errors"},{"id":295,"kind":1024,"name":"code","url":"classes/utils_errors.profilehandlererror.html#code-1","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"utils/errors.ProfileHandlerError"},{"id":296,"kind":512,"name":"constructor","url":"classes/utils_errors.profilehandlererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"utils/errors.ProfileHandlerError"},{"id":297,"kind":1024,"name":"code","url":"classes/utils_errors.profilehandlererror.html#code","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.ProfileHandlerError"},{"id":298,"kind":1024,"name":"name","url":"classes/utils_errors.profilehandlererror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.ProfileHandlerError"},{"id":299,"kind":1024,"name":"cause","url":"classes/utils_errors.profilehandlererror.html#cause","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.ProfileHandlerError"},{"id":300,"kind":1024,"name":"status","url":"classes/utils_errors.profilehandlererror.html#status","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"utils/errors.ProfileHandlerError"},{"id":301,"kind":1,"name":"version","url":"modules/version.html","classes":"tsd-kind-module"},{"id":302,"kind":1024,"name":"default","url":"modules/version.html#default","classes":"tsd-kind-property tsd-parent-kind-module","parent":"version"},{"id":303,"kind":16777216,"name":"UserProvider","url":"modules/client.html#userprovider","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":304,"kind":16777216,"name":"UserProviderProps","url":"modules/client.html#userproviderprops","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":305,"kind":16777216,"name":"UserProfile","url":"modules/client.html#userprofile","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":306,"kind":16777216,"name":"RequestError","url":"modules/client.html#requesterror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":307,"kind":16777216,"name":"useUser","url":"modules/client.html#useuser","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":308,"kind":16777216,"name":"WithPageAuthRequired","url":"modules/client.html#withpageauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":309,"kind":16777216,"name":"WithPageAuthRequiredOptions","url":"modules/client.html#withpageauthrequiredoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"client"},{"id":310,"kind":16777216,"name":"WithMiddlewareAuthRequired","url":"modules/edge.html#withmiddlewareauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"edge"},{"id":311,"kind":16777216,"name":"HandleCallback","url":"modules/handlers.html#handlecallback","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":312,"kind":16777216,"name":"CallbackOptions","url":"modules/handlers.html#callbackoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":313,"kind":16777216,"name":"AfterCallback","url":"modules/handlers.html#aftercallback","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":314,"kind":16777216,"name":"HandleLogin","url":"modules/handlers.html#handlelogin","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":315,"kind":16777216,"name":"LoginOptions","url":"modules/handlers.html#loginoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":316,"kind":16777216,"name":"GetLoginState","url":"modules/handlers.html#getloginstate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":317,"kind":16777216,"name":"HandleLogout","url":"modules/handlers.html#handlelogout","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":318,"kind":16777216,"name":"LogoutOptions","url":"modules/handlers.html#logoutoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":319,"kind":16777216,"name":"HandleProfile","url":"modules/handlers.html#handleprofile","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":320,"kind":16777216,"name":"ProfileOptions","url":"modules/handlers.html#profileoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":321,"kind":16777216,"name":"AfterRefetch","url":"modules/handlers.html#afterrefetch","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":322,"kind":16777216,"name":"Handlers","url":"modules/handlers.html#handlers-1","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":323,"kind":16777216,"name":"HandleAuth","url":"modules/handlers.html#handleauth","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":324,"kind":16777216,"name":"OnError","url":"modules/handlers.html#onerror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"handlers"},{"id":325,"kind":16777216,"name":"WithApiAuthRequired","url":"modules/helpers.html#withapiauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"helpers"},{"id":326,"kind":16777216,"name":"GetServerSidePropsResultWithSession","url":"modules/helpers.html#getserversidepropsresultwithsession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"helpers"},{"id":327,"kind":16777216,"name":"WithPageAuthRequired","url":"modules/helpers.html#withpageauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"helpers"},{"id":328,"kind":16777216,"name":"WithPageAuthRequiredOptions","url":"modules/helpers.html#withpageauthrequiredoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"helpers"},{"id":329,"kind":16777216,"name":"PageRoute","url":"modules/helpers.html#pageroute","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"helpers"},{"id":330,"kind":16777216,"name":"AuthError","url":"modules/index.html#autherror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":331,"kind":16777216,"name":"AccessTokenErrorCode","url":"modules/index.html#accesstokenerrorcode","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":332,"kind":16777216,"name":"AccessTokenError","url":"modules/index.html#accesstokenerror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":333,"kind":16777216,"name":"HandlerError","url":"modules/index.html#handlererror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":334,"kind":16777216,"name":"CallbackHandlerError","url":"modules/index.html#callbackhandlererror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":335,"kind":16777216,"name":"LoginHandlerError","url":"modules/index.html#loginhandlererror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":336,"kind":16777216,"name":"LogoutHandlerError","url":"modules/index.html#logouthandlererror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":337,"kind":16777216,"name":"ProfileHandlerError","url":"modules/index.html#profilehandlererror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":338,"kind":128,"name":"MissingStateCookieError","url":"classes/index.missingstatecookieerror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"index"},{"id":339,"kind":1024,"name":"message","url":"classes/index.missingstatecookieerror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"index.MissingStateCookieError"},{"id":340,"kind":512,"name":"constructor","url":"classes/index.missingstatecookieerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"index.MissingStateCookieError"},{"id":341,"kind":128,"name":"MissingStateParamError","url":"classes/index.missingstateparamerror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"index"},{"id":342,"kind":1024,"name":"message","url":"classes/index.missingstateparamerror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"index.MissingStateParamError"},{"id":343,"kind":512,"name":"constructor","url":"classes/index.missingstateparamerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"index.MissingStateParamError"},{"id":344,"kind":128,"name":"IdentityProviderError","url":"classes/index.identityprovidererror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"index"},{"id":345,"kind":512,"name":"constructor","url":"classes/index.identityprovidererror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"index.IdentityProviderError"},{"id":346,"kind":1024,"name":"errorDescription","url":"classes/index.identityprovidererror.html#errordescription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"index.IdentityProviderError"},{"id":347,"kind":1024,"name":"error","url":"classes/index.identityprovidererror.html#error","classes":"tsd-kind-property tsd-parent-kind-class","parent":"index.IdentityProviderError"},{"id":348,"kind":128,"name":"ApplicationError","url":"classes/index.applicationerror.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"index"},{"id":349,"kind":512,"name":"constructor","url":"classes/index.applicationerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"index.ApplicationError"},{"id":350,"kind":16777216,"name":"ConfigParameters","url":"modules/index.html#configparameters","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":351,"kind":16777216,"name":"HandleAuth","url":"modules/index.html#handleauth","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":352,"kind":16777216,"name":"HandleLogin","url":"modules/index.html#handlelogin","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":353,"kind":16777216,"name":"HandleProfile","url":"modules/index.html#handleprofile","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":354,"kind":16777216,"name":"HandleLogout","url":"modules/index.html#handlelogout","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":355,"kind":16777216,"name":"HandleCallback","url":"modules/index.html#handlecallback","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":356,"kind":16777216,"name":"ProfileOptions","url":"modules/index.html#profileoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":357,"kind":16777216,"name":"Handlers","url":"modules/index.html#handlers","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":358,"kind":16777216,"name":"GetServerSidePropsResultWithSession","url":"modules/index.html#getserversidepropsresultwithsession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":359,"kind":16777216,"name":"WithPageAuthRequiredOptions","url":"modules/index.html#withpageauthrequiredoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":360,"kind":16777216,"name":"PageRoute","url":"modules/index.html#pageroute","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":361,"kind":16777216,"name":"WithApiAuthRequired","url":"modules/index.html#withapiauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":362,"kind":16777216,"name":"WithPageAuthRequired","url":"modules/index.html#withpageauthrequired","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":363,"kind":128,"name":"SessionCache","url":"classes/index.sessioncache.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"index"},{"id":364,"kind":512,"name":"constructor","url":"classes/index.sessioncache.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter","parent":"index.SessionCache"},{"id":365,"kind":2048,"name":"save","url":"classes/index.sessioncache.html#save","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":366,"kind":2048,"name":"create","url":"classes/index.sessioncache.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":367,"kind":2048,"name":"delete","url":"classes/index.sessioncache.html#delete","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":368,"kind":2048,"name":"isAuthenticated","url":"classes/index.sessioncache.html#isauthenticated","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":369,"kind":2048,"name":"getIdToken","url":"classes/index.sessioncache.html#getidtoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":370,"kind":2048,"name":"set","url":"classes/index.sessioncache.html#set","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":371,"kind":2048,"name":"get","url":"classes/index.sessioncache.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":372,"kind":2048,"name":"fromTokenSet","url":"classes/index.sessioncache.html#fromtokenset","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SessionCache"},{"id":373,"kind":16777216,"name":"GetSession","url":"modules/index.html#getsession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":374,"kind":16777216,"name":"UpdateSession","url":"modules/index.html#updatesession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":375,"kind":16777216,"name":"GetAccessToken","url":"modules/index.html#getaccesstoken","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":376,"kind":16777216,"name":"Session","url":"modules/index.html#session","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":377,"kind":16777216,"name":"Claims","url":"modules/index.html#claims","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":378,"kind":16777216,"name":"AccessTokenRequest","url":"modules/index.html#accesstokenrequest","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":379,"kind":16777216,"name":"GetAccessTokenResult","url":"modules/index.html#getaccesstokenresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":380,"kind":16777216,"name":"CallbackOptions","url":"modules/index.html#callbackoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":381,"kind":16777216,"name":"AfterCallback","url":"modules/index.html#aftercallback","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":382,"kind":16777216,"name":"AfterRefetch","url":"modules/index.html#afterrefetch","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":383,"kind":16777216,"name":"LoginOptions","url":"modules/index.html#loginoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":384,"kind":16777216,"name":"LogoutOptions","url":"modules/index.html#logoutoptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":385,"kind":16777216,"name":"GetLoginState","url":"modules/index.html#getloginstate","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":386,"kind":16777216,"name":"OnError","url":"modules/index.html#onerror","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":387,"kind":16777216,"name":"Session","url":"modules/session.html#session-1","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":388,"kind":16777216,"name":"Claims","url":"modules/session.html#claims","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":389,"kind":16777216,"name":"GetSession","url":"modules/session.html#getsession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":390,"kind":16777216,"name":"GetAccessToken","url":"modules/session.html#getaccesstoken","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":391,"kind":16777216,"name":"AccessTokenRequest","url":"modules/session.html#accesstokenrequest","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":392,"kind":16777216,"name":"GetAccessTokenResult","url":"modules/session.html#getaccesstokenresult","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":393,"kind":16777216,"name":"SessionCache","url":"modules/session.html#sessioncache","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"},{"id":394,"kind":16777216,"name":"UpdateSession","url":"modules/session.html#updatesession","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"session"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,39.073]],["parent/0",[]],["name/1",[1,19.663,2,25.126]],["parent/1",[]],["name/2",[3,51.521]],["parent/2",[1,2.165,2,2.766]],["name/3",[4,56.717]],["parent/3",[1,2.165,5,3.075]],["name/4",[6,56.717]],["parent/4",[1,2.165,5,3.075]],["name/5",[7,37.942]],["parent/5",[1,2.165,5,3.075]],["name/6",[8,56.717]],["parent/6",[1,2.165,5,3.075]],["name/7",[9,56.717]],["parent/7",[1,2.165,5,3.075]],["name/8",[10,56.717]],["parent/8",[1,2.165,5,3.075]],["name/9",[11,56.717]],["parent/9",[1,2.165,5,3.075]],["name/10",[12,56.717]],["parent/10",[1,2.165,5,3.075]],["name/11",[13,56.717]],["parent/11",[1,2.165,2,2.766]],["name/12",[14,22.466]],["parent/12",[1,2.165,15,4.464]],["name/13",[2,35.15]],["parent/13",[1,2.165,16,3.424]],["name/14",[17,51.521]],["parent/14",[1,2.165,16,3.424]],["name/15",[18,56.717]],["parent/15",[1,2.165,16,3.424]],["name/16",[19,56.717]],["parent/16",[1,2.165,16,3.424]],["name/17",[14,22.466]],["parent/17",[1,2.165,16,3.424]],["name/18",[20,51.521]],["parent/18",[1,2.165,2,2.766]],["name/19",[21,33.641]],["parent/19",[1,2.165,22,4.055]],["name/20",[23,39.073]],["parent/20",[1,2.165,22,4.055]],["name/21",[24,51.521]],["parent/21",[1,2.165,2,2.766]],["name/22",[25,51.521]],["parent/22",[1,2.165,2,2.766]],["name/23",[26,51.521]],["parent/23",[1,2.165,2,2.766]],["name/24",[14,22.466]],["parent/24",[1,2.165,27,4.464]],["name/25",[28,48.098]],["parent/25",[1,2.165,2,2.766]],["name/26",[14,22.466]],["parent/26",[1,2.165,2,2.766]],["name/27",[29,16.386,30,13.489,31,12.35,32,15.644]],["parent/27",[]],["name/28",[33,43.501]],["parent/28",[29,1.856,30,1.527,31,1.398,32,1.771]],["name/29",[34,45.542]],["parent/29",[29,1.856,30,1.527,31,1.398,35,2.155]],["name/30",[36,56.717]],["parent/30",[29,1.856,30,1.527,31,1.398,35,2.155]],["name/31",[14,22.466]],["parent/31",[29,1.856,30,1.527,31,1.398,35,2.155]],["name/32",[37,45.542]],["parent/32",[29,1.856,30,1.527,31,1.398,35,2.155]],["name/33",[14,22.466]],["parent/33",[29,1.856,30,1.527,31,1.398,35,2.155]],["name/34",[38,56.717]],["parent/34",[29,1.856,30,1.527,31,1.398,32,1.771]],["name/35",[2,35.15]],["parent/35",[29,1.856,30,1.527,31,1.398,39,2.923]],["name/36",[40,40.346]],["parent/36",[29,1.856,30,1.527,31,1.398,32,1.771]],["name/37",[14,22.466]],["parent/37",[29,1.856,30,1.527,31,1.398,41,2.656]],["name/38",[42,40.346]],["parent/38",[]],["name/39",[43,56.717]],["parent/39",[42,4.311]],["name/40",[44,56.717]],["parent/40",[45,3.273]],["name/41",[46,32.326]],["parent/41",[45,3.273]],["name/42",[47,56.717]],["parent/42",[45,3.273]],["name/43",[48,43.501]],["parent/43",[45,3.273]],["name/44",[49,56.717]],["parent/44",[45,3.273]],["name/45",[50,56.717]],["parent/45",[45,3.273]],["name/46",[51,56.717]],["parent/46",[45,3.273]],["name/47",[52,56.717]],["parent/47",[45,3.273]],["name/48",[53,56.717]],["parent/48",[45,3.273]],["name/49",[54,56.717]],["parent/49",[45,3.273]],["name/50",[55,43.501]],["parent/50",[45,3.273]],["name/51",[14,22.466]],["parent/51",[45,3.273]],["name/52",[56,51.521]],["parent/52",[45,3.273]],["name/53",[57,56.717]],["parent/53",[45,3.273]],["name/54",[58,56.717]],["parent/54",[45,3.273]],["name/55",[59,56.717]],["parent/55",[45,3.273]],["name/56",[60,56.717]],["parent/56",[45,3.273]],["name/57",[61,51.521]],["parent/57",[45,3.273]],["name/58",[14,22.466]],["parent/58",[45,3.273]],["name/59",[62,56.717]],["parent/59",[63,5.505]],["name/60",[64,51.521]],["parent/60",[63,5.505]],["name/61",[65,56.717]],["parent/61",[42,4.311]],["name/62",[7,37.942]],["parent/62",[66,4.054]],["name/63",[67,56.717]],["parent/63",[66,4.054]],["name/64",[68,56.717]],["parent/64",[66,4.054]],["name/65",[14,22.466]],["parent/65",[66,4.054]],["name/66",[69,56.717]],["parent/66",[66,4.054]],["name/67",[70,56.717]],["parent/67",[66,4.054]],["name/68",[71,56.717]],["parent/68",[66,4.054]],["name/69",[72,56.717]],["parent/69",[66,4.054]],["name/70",[73,56.717]],["parent/70",[66,4.054]],["name/71",[74,56.717]],["parent/71",[42,4.311]],["name/72",[75,56.717]],["parent/72",[76,4.467]],["name/73",[77,56.717]],["parent/73",[76,4.467]],["name/74",[78,56.717]],["parent/74",[76,4.467]],["name/75",[79,56.717]],["parent/75",[76,4.467]],["name/76",[80,56.717]],["parent/76",[76,4.467]],["name/77",[81,56.717]],["parent/77",[76,4.467]],["name/78",[82,56.717]],["parent/78",[42,4.311]],["name/79",[83,51.521]],["parent/79",[84,5.14]],["name/80",[85,51.521]],["parent/80",[84,5.14]],["name/81",[86,51.521]],["parent/81",[84,5.14]],["name/82",[87,56.717]],["parent/82",[42,4.311]],["name/83",[88,48.098]],["parent/83",[89,4.867]],["name/84",[61,51.521]],["parent/84",[89,4.867]],["name/85",[14,22.466]],["parent/85",[89,4.867]],["name/86",[64,51.521]],["parent/86",[90,5.14]],["name/87",[91,56.717]],["parent/87",[90,5.14]],["name/88",[92,56.717]],["parent/88",[90,5.14]],["name/89",[56,51.521]],["parent/89",[89,4.867]],["name/90",[93,51.521]],["parent/90",[42,4.311]],["name/91",[94,39.073]],["parent/91",[]],["name/92",[95,56.717]],["parent/92",[94,4.175]],["name/93",[14,22.466]],["parent/93",[96,6.061]],["name/94",[97,45.542]],["parent/94",[98,5.505]],["name/95",[99,39.073]],["parent/95",[98,5.505]],["name/96",[99,39.073]],["parent/96",[94,4.175]],["name/97",[14,22.466]],["parent/97",[100,6.061]],["name/98",[101,45.542]],["parent/98",[94,4.175]],["name/99",[14,22.466]],["parent/99",[102,6.061]],["name/100",[101,45.542]],["parent/100",[94,4.175]],["name/101",[99,39.073]],["parent/101",[94,4.175]],["name/102",[97,45.542]],["parent/102",[94,4.175]],["name/103",[103,45.542]],["parent/103",[]],["name/104",[104,31.162]],["parent/104",[103,4.867]],["name/105",[105,43.501]],["parent/105",[103,4.867]],["name/106",[14,22.466]],["parent/106",[106,6.061]],["name/107",[37,45.542]],["parent/107",[103,4.867]],["name/108",[14,22.466]],["parent/108",[107,6.061]],["name/109",[108,41.802]],["parent/109",[]],["name/110",[109,45.542]],["parent/110",[108,4.467]],["name/111",[14,22.466]],["parent/111",[110,6.061]],["name/112",[111,48.098]],["parent/112",[108,4.467]],["name/113",[109,45.542]],["parent/113",[112,4.867]],["name/114",[113,56.717]],["parent/114",[112,4.867]],["name/115",[88,48.098]],["parent/115",[112,4.867]],["name/116",[48,43.501]],["parent/116",[112,4.867]],["name/117",[114,56.717]],["parent/117",[108,4.467]],["name/118",[14,22.466]],["parent/118",[115,6.061]],["name/119",[116,43.501]],["parent/119",[108,4.467]],["name/120",[14,22.466]],["parent/120",[117,6.061]],["name/121",[118,56.717]],["parent/121",[108,4.467]],["name/122",[14,22.466]],["parent/122",[119,6.061]],["name/123",[104,31.162]],["parent/123",[]],["name/124",[120,40.346]],["parent/124",[]],["name/125",[55,43.501]],["parent/125",[120,4.311]],["name/126",[14,22.466]],["parent/126",[121,6.061]],["name/127",[48,43.501]],["parent/127",[120,4.311]],["name/128",[122,56.717]],["parent/128",[123,4.175]],["name/129",[124,56.717]],["parent/129",[123,4.175]],["name/130",[125,56.717]],["parent/130",[123,4.175]],["name/131",[88,48.098]],["parent/131",[123,4.175]],["name/132",[126,56.717]],["parent/132",[123,4.175]],["name/133",[83,51.521]],["parent/133",[123,4.175]],["name/134",[85,51.521]],["parent/134",[123,4.175]],["name/135",[86,51.521]],["parent/135",[123,4.175]],["name/136",[127,48.098]],["parent/136",[120,4.311]],["name/137",[48,43.501]],["parent/137",[128,5.14]],["name/138",[34,45.542]],["parent/138",[128,5.14]],["name/139",[55,43.501]],["parent/139",[128,5.14]],["name/140",[129,56.717]],["parent/140",[120,4.311]],["name/141",[14,22.466]],["parent/141",[130,6.061]],["name/142",[131,43.501]],["parent/142",[120,4.311]],["name/143",[14,22.466]],["parent/143",[132,6.061]],["name/144",[133,56.717]],["parent/144",[120,4.311]],["name/145",[14,22.466]],["parent/145",[134,6.061]],["name/146",[135,43.501]],["parent/146",[]],["name/147",[136,48.098]],["parent/147",[135,4.648]],["name/148",[34,45.542]],["parent/148",[137,5.14]],["name/149",[138,56.717]],["parent/149",[137,5.14]],["name/150",[14,22.466]],["parent/150",[137,5.14]],["name/151",[139,56.717]],["parent/151",[135,4.648]],["name/152",[14,22.466]],["parent/152",[140,6.061]],["name/153",[141,43.501]],["parent/153",[135,4.648]],["name/154",[14,22.466]],["parent/154",[142,6.061]],["name/155",[143,56.717]],["parent/155",[135,4.648]],["name/156",[14,22.466]],["parent/156",[144,6.061]],["name/157",[145,41.802]],["parent/157",[]],["name/158",[146,45.542]],["parent/158",[145,4.467]],["name/159",[14,22.466]],["parent/159",[147,6.061]],["name/160",[148,48.098]],["parent/160",[145,4.467]],["name/161",[14,22.466]],["parent/161",[149,6.061]],["name/162",[150,56.717]],["parent/162",[151,5.505]],["name/163",[146,45.542]],["parent/163",[151,5.505]],["name/164",[152,56.717]],["parent/164",[145,4.467]],["name/165",[14,22.466]],["parent/165",[153,6.061]],["name/166",[154,43.501]],["parent/166",[145,4.467]],["name/167",[14,22.466]],["parent/167",[155,6.061]],["name/168",[156,56.717]],["parent/168",[145,4.467]],["name/169",[14,22.466]],["parent/169",[157,6.061]],["name/170",[158,41.802]],["parent/170",[]],["name/171",[159,48.098]],["parent/171",[]],["name/172",[160,56.717]],["parent/172",[159,5.14]],["name/173",[161,56.717]],["parent/173",[159,5.14]],["name/174",[31,12.35,32,15.644,162,14.715,163,21.894]],["parent/174",[]],["name/175",[164,43.501]],["parent/175",[31,1.398,32,1.771,162,1.666,163,2.479]],["name/176",[14,22.466]],["parent/176",[31,1.398,162,1.666,163,2.479,165,2.923]],["name/177",[31,12.35,32,15.644,162,14.715,166,21.894]],["parent/177",[]],["name/178",[97,45.542]],["parent/178",[31,1.398,32,1.771,162,1.666,166,2.479]],["name/179",[14,22.466]],["parent/179",[31,1.398,162,1.666,166,2.479,167,2.923]],["name/180",[30,13.489,31,12.35,32,15.644,162,14.715]],["parent/180",[]],["name/181",[168,48.098]],["parent/181",[30,1.527,31,1.398,32,1.771,162,1.666]],["name/182",[169,48.098]],["parent/182",[30,1.527,31,1.398,32,1.771,162,1.666]],["name/183",[14,22.466]],["parent/183",[30,1.527,31,1.398,162,1.666,170,2.923]],["name/184",[33,43.501]],["parent/184",[30,1.527,31,1.398,32,1.771,162,1.666]],["name/185",[14,22.466]],["parent/185",[30,1.527,31,1.398,35,2.155,162,1.666]],["name/186",[171,56.717]],["parent/186",[30,1.527,31,1.398,162,1.666,172,2.656]],["name/187",[34,45.542]],["parent/187",[30,1.527,31,1.398,162,1.666,172,2.656]],["name/188",[40,40.346]],["parent/188",[30,1.527,31,1.398,32,1.771,162,1.666]],["name/189",[14,22.466]],["parent/189",[30,1.527,31,1.398,41,2.656,162,1.666]],["name/190",[173,19.628]],["parent/190",[]],["name/191",[174,56.717]],["parent/191",[173,2.097]],["name/192",[99,39.073]],["parent/192",[175,3.946]],["name/193",[176,43.501]],["parent/193",[175,3.946]],["name/194",[177,43.501]],["parent/194",[175,3.946]],["name/195",[131,43.501]],["parent/195",[175,3.946]],["name/196",[116,43.501]],["parent/196",[175,3.946]],["name/197",[141,43.501]],["parent/197",[175,3.946]],["name/198",[154,43.501]],["parent/198",[175,3.946]],["name/199",[164,43.501]],["parent/199",[175,3.946]],["name/200",[40,40.346]],["parent/200",[175,3.946]],["name/201",[105,43.501]],["parent/201",[175,3.946]],["name/202",[101,45.542]],["parent/202",[173,2.097]],["name/203",[14,22.466]],["parent/203",[178,6.061]],["name/204",[101,45.542]],["parent/204",[173,2.097]],["name/205",[179,56.717]],["parent/205",[173,2.097]],["name/206",[99,39.073]],["parent/206",[173,2.097]],["name/207",[176,43.501]],["parent/207",[173,2.097]],["name/208",[177,43.501]],["parent/208",[173,2.097]],["name/209",[164,43.501]],["parent/209",[173,2.097]],["name/210",[40,40.346]],["parent/210",[173,2.097]],["name/211",[131,43.501]],["parent/211",[173,2.097]],["name/212",[141,43.501]],["parent/212",[173,2.097]],["name/213",[116,43.501]],["parent/213",[173,2.097]],["name/214",[154,43.501]],["parent/214",[173,2.097]],["name/215",[105,43.501]],["parent/215",[173,2.097]],["name/216",[180,56.717]],["parent/216",[173,2.097]],["name/217",[181,56.717]],["parent/217",[173,2.097]],["name/218",[182,18.334,183,19.551,184,24.196]],["parent/218",[]],["name/219",[185,51.521]],["parent/219",[182,2.053,183,2.19,184,2.71]],["name/220",[14,22.466]],["parent/220",[182,2.053,183,2.19,186,3.533]],["name/221",[187,48.098]],["parent/221",[182,2.053,183,2.19,184,2.71]],["name/222",[188,56.717]],["parent/222",[182,2.053,183,2.19,189,2.837]],["name/223",[190,56.717]],["parent/223",[182,2.053,183,2.19,189,2.837]],["name/224",[185,51.521]],["parent/224",[182,2.053,183,2.19,189,2.837]],["name/225",[48,43.501]],["parent/225",[182,2.053,183,2.19,189,2.837]],["name/226",[191,48.098]],["parent/226",[182,2.053,183,2.19,184,2.71]],["name/227",[192,51.521]],["parent/227",[182,2.053,183,2.19,193,3.533]],["name/228",[177,43.501]],["parent/228",[182,2.053,183,2.19,184,2.71]],["name/229",[14,22.466]],["parent/229",[182,2.053,183,2.19,194,3.533]],["name/230",[46,23.108,182,23.562]],["parent/230",[]],["name/231",[99,39.073]],["parent/231",[46,2.544,182,2.594]],["name/232",[14,22.466]],["parent/232",[182,2.594,195,4.464]],["name/233",[46,32.326]],["parent/233",[]],["name/234",[196,48.098]],["parent/234",[]],["name/235",[197,48.098]],["parent/235",[196,5.14]],["name/236",[28,48.098]],["parent/236",[196,5.14]],["name/237",[21,33.641]],["parent/237",[198,4.311]],["name/238",[2,35.15]],["parent/238",[198,4.311]],["name/239",[199,56.717]],["parent/239",[198,4.311]],["name/240",[192,51.521]],["parent/240",[198,4.311]],["name/241",[200,56.717]],["parent/241",[198,4.311]],["name/242",[201,56.717]],["parent/242",[198,4.311]],["name/243",[202,56.717]],["parent/243",[198,4.311]],["name/244",[46,23.108,203,34.382]],["parent/244",[]],["name/245",[176,43.501]],["parent/245",[46,2.544,203,3.786]],["name/246",[14,22.466]],["parent/246",[203,3.786,204,4.464]],["name/247",[205,37.942]],["parent/247",[]],["name/248",[206,51.521]],["parent/248",[205,4.054]],["name/249",[21,33.641]],["parent/249",[207,4.648]],["name/250",[208,35.998]],["parent/250",[207,4.648]],["name/251",[7,37.942]],["parent/251",[207,4.648]],["name/252",[209,40.346]],["parent/252",[207,4.648]],["name/253",[23,39.073]],["parent/253",[207,4.648]],["name/254",[210,51.521]],["parent/254",[205,4.054]],["name/255",[211,56.717]],["parent/255",[212,4.467]],["name/256",[213,56.717]],["parent/256",[212,4.467]],["name/257",[214,56.717]],["parent/257",[212,4.467]],["name/258",[215,56.717]],["parent/258",[212,4.467]],["name/259",[216,56.717]],["parent/259",[212,4.467]],["name/260",[217,56.717]],["parent/260",[212,4.467]],["name/261",[218,51.521]],["parent/261",[205,4.054]],["name/262",[21,33.641]],["parent/262",[219,4.648]],["name/263",[208,35.998]],["parent/263",[219,4.648]],["name/264",[7,37.942]],["parent/264",[219,4.648]],["name/265",[209,40.346]],["parent/265",[219,4.648]],["name/266",[23,39.073]],["parent/266",[219,4.648]],["name/267",[220,51.521]],["parent/267",[205,4.054]],["name/268",[21,33.641]],["parent/268",[221,4.648]],["name/269",[208,35.998]],["parent/269",[221,4.648]],["name/270",[7,37.942]],["parent/270",[221,4.648]],["name/271",[209,40.346]],["parent/271",[221,4.648]],["name/272",[23,39.073]],["parent/272",[221,4.648]],["name/273",[222,51.521]],["parent/273",[205,4.054]],["name/274",[208,35.998]],["parent/274",[223,4.467]],["name/275",[21,33.641]],["parent/275",[223,4.467]],["name/276",[208,35.998]],["parent/276",[223,4.467]],["name/277",[7,37.942]],["parent/277",[223,4.467]],["name/278",[209,40.346]],["parent/278",[223,4.467]],["name/279",[23,39.073]],["parent/279",[223,4.467]],["name/280",[224,51.521]],["parent/280",[205,4.054]],["name/281",[208,35.998]],["parent/281",[225,4.467]],["name/282",[21,33.641]],["parent/282",[225,4.467]],["name/283",[208,35.998]],["parent/283",[225,4.467]],["name/284",[7,37.942]],["parent/284",[225,4.467]],["name/285",[209,40.346]],["parent/285",[225,4.467]],["name/286",[23,39.073]],["parent/286",[225,4.467]],["name/287",[226,51.521]],["parent/287",[205,4.054]],["name/288",[208,35.998]],["parent/288",[227,4.467]],["name/289",[21,33.641]],["parent/289",[227,4.467]],["name/290",[208,35.998]],["parent/290",[227,4.467]],["name/291",[7,37.942]],["parent/291",[227,4.467]],["name/292",[209,40.346]],["parent/292",[227,4.467]],["name/293",[23,39.073]],["parent/293",[227,4.467]],["name/294",[228,51.521]],["parent/294",[205,4.054]],["name/295",[208,35.998]],["parent/295",[229,4.467]],["name/296",[21,33.641]],["parent/296",[229,4.467]],["name/297",[208,35.998]],["parent/297",[229,4.467]],["name/298",[7,37.942]],["parent/298",[229,4.467]],["name/299",[209,40.346]],["parent/299",[229,4.467]],["name/300",[23,39.073]],["parent/300",[229,4.467]],["name/301",[230,51.521]],["parent/301",[]],["name/302",[28,48.098]],["parent/302",[230,5.505]],["name/303",[26,51.521]],["parent/303",[0,4.175]],["name/304",[24,51.521]],["parent/304",[0,4.175]],["name/305",[3,51.521]],["parent/305",[0,4.175]],["name/306",[20,51.521]],["parent/306",[0,4.175]],["name/307",[25,51.521]],["parent/307",[0,4.175]],["name/308",[40,40.346]],["parent/308",[0,4.175]],["name/309",[33,43.501]],["parent/309",[0,4.175]],["name/310",[97,45.542]],["parent/310",[94,4.175]],["name/311",[116,43.501]],["parent/311",[104,3.33]],["name/312",[111,48.098]],["parent/312",[104,3.33]],["name/313",[109,45.542]],["parent/313",[104,3.33]],["name/314",[131,43.501]],["parent/314",[104,3.33]],["name/315",[127,48.098]],["parent/315",[104,3.33]],["name/316",[55,43.501]],["parent/316",[104,3.33]],["name/317",[141,43.501]],["parent/317",[104,3.33]],["name/318",[136,48.098]],["parent/318",[104,3.33]],["name/319",[154,43.501]],["parent/319",[104,3.33]],["name/320",[148,48.098]],["parent/320",[104,3.33]],["name/321",[146,45.542]],["parent/321",[104,3.33]],["name/322",[104,31.162]],["parent/322",[104,3.33]],["name/323",[105,43.501]],["parent/323",[104,3.33]],["name/324",[37,45.542]],["parent/324",[104,3.33]],["name/325",[164,43.501]],["parent/325",[158,4.467]],["name/326",[168,48.098]],["parent/326",[158,4.467]],["name/327",[40,40.346]],["parent/327",[158,4.467]],["name/328",[33,43.501]],["parent/328",[158,4.467]],["name/329",[169,48.098]],["parent/329",[158,4.467]],["name/330",[206,51.521]],["parent/330",[173,2.097]],["name/331",[210,51.521]],["parent/331",[173,2.097]],["name/332",[218,51.521]],["parent/332",[173,2.097]],["name/333",[220,51.521]],["parent/333",[173,2.097]],["name/334",[222,51.521]],["parent/334",[173,2.097]],["name/335",[224,51.521]],["parent/335",[173,2.097]],["name/336",[226,51.521]],["parent/336",[173,2.097]],["name/337",[228,51.521]],["parent/337",[173,2.097]],["name/338",[231,56.717]],["parent/338",[173,2.097]],["name/339",[232,51.521]],["parent/339",[233,5.505]],["name/340",[21,33.641]],["parent/340",[233,5.505]],["name/341",[234,56.717]],["parent/341",[173,2.097]],["name/342",[232,51.521]],["parent/342",[235,5.505]],["name/343",[21,33.641]],["parent/343",[235,5.505]],["name/344",[236,56.717]],["parent/344",[173,2.097]],["name/345",[21,33.641]],["parent/345",[237,5.14]],["name/346",[238,56.717]],["parent/346",[237,5.14]],["name/347",[17,51.521]],["parent/347",[237,5.14]],["name/348",[239,56.717]],["parent/348",[173,2.097]],["name/349",[21,33.641]],["parent/349",[240,6.061]],["name/350",[93,51.521]],["parent/350",[173,2.097]],["name/351",[105,43.501]],["parent/351",[173,2.097]],["name/352",[131,43.501]],["parent/352",[173,2.097]],["name/353",[154,43.501]],["parent/353",[173,2.097]],["name/354",[141,43.501]],["parent/354",[173,2.097]],["name/355",[116,43.501]],["parent/355",[173,2.097]],["name/356",[148,48.098]],["parent/356",[173,2.097]],["name/357",[104,31.162]],["parent/357",[173,2.097]],["name/358",[168,48.098]],["parent/358",[173,2.097]],["name/359",[33,43.501]],["parent/359",[173,2.097]],["name/360",[169,48.098]],["parent/360",[173,2.097]],["name/361",[164,43.501]],["parent/361",[173,2.097]],["name/362",[40,40.346]],["parent/362",[173,2.097]],["name/363",[241,51.521]],["parent/363",[173,2.097]],["name/364",[21,33.641]],["parent/364",[242,4.054]],["name/365",[243,56.717]],["parent/365",[242,4.054]],["name/366",[244,56.717]],["parent/366",[242,4.054]],["name/367",[245,56.717]],["parent/367",[242,4.054]],["name/368",[246,56.717]],["parent/368",[242,4.054]],["name/369",[247,56.717]],["parent/369",[242,4.054]],["name/370",[248,56.717]],["parent/370",[242,4.054]],["name/371",[249,56.717]],["parent/371",[242,4.054]],["name/372",[250,56.717]],["parent/372",[242,4.054]],["name/373",[99,39.073]],["parent/373",[173,2.097]],["name/374",[176,43.501]],["parent/374",[173,2.097]],["name/375",[177,43.501]],["parent/375",[173,2.097]],["name/376",[46,32.326]],["parent/376",[173,2.097]],["name/377",[197,48.098]],["parent/377",[173,2.097]],["name/378",[187,48.098]],["parent/378",[173,2.097]],["name/379",[191,48.098]],["parent/379",[173,2.097]],["name/380",[111,48.098]],["parent/380",[173,2.097]],["name/381",[109,45.542]],["parent/381",[173,2.097]],["name/382",[146,45.542]],["parent/382",[173,2.097]],["name/383",[127,48.098]],["parent/383",[173,2.097]],["name/384",[136,48.098]],["parent/384",[173,2.097]],["name/385",[55,43.501]],["parent/385",[173,2.097]],["name/386",[37,45.542]],["parent/386",[173,2.097]],["name/387",[46,32.326]],["parent/387",[46,3.454]],["name/388",[197,48.098]],["parent/388",[46,3.454]],["name/389",[99,39.073]],["parent/389",[46,3.454]],["name/390",[177,43.501]],["parent/390",[46,3.454]],["name/391",[187,48.098]],["parent/391",[46,3.454]],["name/392",[191,48.098]],["parent/392",[46,3.454]],["name/393",[241,51.521]],["parent/393",[46,3.454]],["name/394",[176,43.501]],["parent/394",[46,3.454]]],"invertedIndex":[["__type",{"_index":14,"name":{"12":{},"17":{},"24":{},"26":{},"31":{},"33":{},"37":{},"51":{},"58":{},"65":{},"85":{},"93":{},"97":{},"99":{},"106":{},"108":{},"111":{},"118":{},"120":{},"122":{},"126":{},"141":{},"143":{},"145":{},"150":{},"152":{},"154":{},"156":{},"159":{},"161":{},"165":{},"167":{},"169":{},"176":{},"179":{},"183":{},"185":{},"189":{},"203":{},"220":{},"229":{},"232":{},"246":{}},"parent":{}}],["_initauth",{"_index":179,"name":{"205":{}},"parent":{}}],["absoluteduration",{"_index":71,"name":{"68":{}},"parent":{}}],["access",{"_index":183,"name":{"218":{}},"parent":{"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{}}}],["accesstoken",{"_index":192,"name":{"227":{},"240":{}},"parent":{}}],["accesstokenerror",{"_index":218,"name":{"261":{},"332":{}},"parent":{}}],["accesstokenerrorcode",{"_index":210,"name":{"254":{},"331":{}},"parent":{}}],["accesstokenexpiresat",{"_index":201,"name":{"242":{}},"parent":{}}],["accesstokenrequest",{"_index":187,"name":{"221":{},"378":{},"391":{}},"parent":{}}],["accesstokenscope",{"_index":200,"name":{"241":{}},"parent":{}}],["aftercallback",{"_index":109,"name":{"110":{},"113":{},"313":{},"381":{}},"parent":{}}],["afterrefetch",{"_index":146,"name":{"158":{},"163":{},"321":{},"382":{}},"parent":{}}],["afterrefresh",{"_index":185,"name":{"219":{},"224":{}},"parent":{}}],["api",{"_index":163,"name":{"174":{}},"parent":{"175":{},"176":{}}}],["applicationerror",{"_index":239,"name":{"348":{}},"parent":{}}],["auth",{"_index":31,"name":{"27":{},"174":{},"177":{},"180":{}},"parent":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"175":{},"176":{},"178":{},"179":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{}}}],["auth0edge",{"_index":95,"name":{"92":{}},"parent":{}}],["auth0logout",{"_index":47,"name":{"42":{}},"parent":{}}],["auth0server",{"_index":174,"name":{"191":{}},"parent":{}}],["autherror",{"_index":206,"name":{"248":{},"330":{}},"parent":{}}],["authorizationparameters",{"_index":82,"name":{"78":{}},"parent":{}}],["authorizationparams",{"_index":48,"name":{"43":{},"116":{},"127":{},"137":{},"225":{}},"parent":{}}],["baseconfig",{"_index":43,"name":{"39":{}},"parent":{}}],["baseurl",{"_index":49,"name":{"44":{}},"parent":{}}],["callback",{"_index":64,"name":{"60":{},"86":{}},"parent":{}}],["callbackhandler",{"_index":118,"name":{"121":{}},"parent":{}}],["callbackhandlererror",{"_index":222,"name":{"273":{},"334":{}},"parent":{}}],["callbackoptions",{"_index":111,"name":{"112":{},"312":{},"380":{}},"parent":{}}],["callbackoptionsprovider",{"_index":114,"name":{"117":{}},"parent":{}}],["cause",{"_index":209,"name":{"252":{},"265":{},"271":{},"278":{},"285":{},"292":{},"299":{}},"parent":{}}],["checksession",{"_index":19,"name":{"16":{}},"parent":{}}],["claims",{"_index":197,"name":{"235":{},"377":{},"388":{}},"parent":{}}],["client",{"_index":0,"name":{"0":{}},"parent":{"303":{},"304":{},"305":{},"306":{},"307":{},"308":{},"309":{}}}],["client/use",{"_index":1,"name":{"1":{}},"parent":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{}}}],["client/with",{"_index":29,"name":{"27":{}},"parent":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{}}}],["clientid",{"_index":50,"name":{"45":{}},"parent":{}}],["clientsecret",{"_index":51,"name":{"46":{}},"parent":{}}],["clocktolerance",{"_index":52,"name":{"47":{}},"parent":{}}],["code",{"_index":208,"name":{"250":{},"263":{},"269":{},"274":{},"276":{},"281":{},"283":{},"288":{},"290":{},"295":{},"297":{}},"parent":{}}],["config",{"_index":42,"name":{"38":{}},"parent":{"39":{},"61":{},"71":{},"78":{},"82":{},"90":{}}}],["config.authorizationparameters",{"_index":84,"name":{},"parent":{"79":{},"80":{},"81":{}}}],["config.baseconfig",{"_index":45,"name":{},"parent":{"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{}}}],["config.baseconfig.__type",{"_index":63,"name":{},"parent":{"59":{},"60":{}}}],["config.cookieconfig",{"_index":76,"name":{},"parent":{"72":{},"73":{},"74":{},"75":{},"76":{},"77":{}}}],["config.nextconfig",{"_index":89,"name":{},"parent":{"83":{},"84":{},"85":{},"89":{}}}],["config.nextconfig.__type",{"_index":90,"name":{},"parent":{"86":{},"87":{},"88":{}}}],["config.sessionconfig",{"_index":66,"name":{},"parent":{"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{}}}],["configparameters",{"_index":93,"name":{"90":{},"350":{}},"parent":{}}],["connection",{"_index":122,"name":{"128":{}},"parent":{}}],["connection_scope",{"_index":124,"name":{"129":{}},"parent":{}}],["constructor",{"_index":21,"name":{"19":{},"237":{},"249":{},"262":{},"268":{},"275":{},"282":{},"289":{},"296":{},"340":{},"343":{},"345":{},"349":{},"364":{}},"parent":{}}],["cookie",{"_index":73,"name":{"70":{}},"parent":{}}],["cookieconfig",{"_index":74,"name":{"71":{}},"parent":{}}],["create",{"_index":244,"name":{"366":{}},"parent":{}}],["default",{"_index":28,"name":{"25":{},"236":{},"302":{}},"parent":{}}],["delete",{"_index":245,"name":{"367":{}},"parent":{}}],["domain",{"_index":75,"name":{"72":{}},"parent":{}}],["edge",{"_index":94,"name":{"91":{}},"parent":{"92":{},"96":{},"98":{},"100":{},"101":{},"102":{},"310":{}}}],["edge.auth0edge",{"_index":96,"name":{},"parent":{"93":{}}}],["edge.auth0edge.__type",{"_index":98,"name":{},"parent":{"94":{},"95":{}}}],["edge.getsession",{"_index":100,"name":{},"parent":{"97":{}}}],["edge.initauth0",{"_index":102,"name":{},"parent":{"99":{}}}],["email",{"_index":4,"name":{"3":{}},"parent":{}}],["email_verified",{"_index":6,"name":{"4":{}},"parent":{}}],["enabletelemetry",{"_index":54,"name":{"49":{}},"parent":{}}],["error",{"_index":17,"name":{"14":{},"347":{}},"parent":{}}],["errordescription",{"_index":238,"name":{"346":{}},"parent":{}}],["expired_access_token",{"_index":215,"name":{"258":{}},"parent":{}}],["failed_refresh_grant",{"_index":217,"name":{"260":{}},"parent":{}}],["fromtokenset",{"_index":250,"name":{"372":{}},"parent":{}}],["generatesessioncookie",{"_index":161,"name":{"173":{}},"parent":{}}],["generatesessioncookieconfig",{"_index":160,"name":{"172":{}},"parent":{}}],["genid",{"_index":68,"name":{"64":{}},"parent":{}}],["get",{"_index":249,"name":{"371":{}},"parent":{}}],["getaccesstoken",{"_index":177,"name":{"194":{},"208":{},"228":{},"375":{},"390":{}},"parent":{}}],["getaccesstokenresult",{"_index":191,"name":{"226":{},"379":{},"392":{}},"parent":{}}],["getidtoken",{"_index":247,"name":{"369":{}},"parent":{}}],["getloginstate",{"_index":55,"name":{"50":{},"125":{},"139":{},"316":{},"385":{}},"parent":{}}],["getserversideprops",{"_index":171,"name":{"186":{}},"parent":{}}],["getserversidepropsresultwithsession",{"_index":168,"name":{"181":{},"326":{},"358":{}},"parent":{}}],["getsession",{"_index":99,"name":{"95":{},"96":{},"101":{},"192":{},"206":{},"231":{},"373":{},"389":{}},"parent":{}}],["handleauth",{"_index":105,"name":{"105":{},"201":{},"215":{},"323":{},"351":{}},"parent":{}}],["handlecallback",{"_index":116,"name":{"119":{},"196":{},"213":{},"311":{},"355":{}},"parent":{}}],["handlelogin",{"_index":131,"name":{"142":{},"195":{},"211":{},"314":{},"352":{}},"parent":{}}],["handlelogout",{"_index":141,"name":{"153":{},"197":{},"212":{},"317":{},"354":{}},"parent":{}}],["handleprofile",{"_index":154,"name":{"166":{},"198":{},"214":{},"319":{},"353":{}},"parent":{}}],["handlererror",{"_index":220,"name":{"267":{},"333":{}},"parent":{}}],["handlers",{"_index":104,"name":{"104":{},"123":{},"322":{},"357":{}},"parent":{"311":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"320":{},"321":{},"322":{},"323":{},"324":{}}}],["handlers/auth",{"_index":103,"name":{"103":{}},"parent":{"104":{},"105":{},"107":{}}}],["handlers/auth.handleauth",{"_index":106,"name":{},"parent":{"106":{}}}],["handlers/auth.onerror",{"_index":107,"name":{},"parent":{"108":{}}}],["handlers/callback",{"_index":108,"name":{"109":{}},"parent":{"110":{},"112":{},"117":{},"119":{},"121":{}}}],["handlers/callback.aftercallback",{"_index":110,"name":{},"parent":{"111":{}}}],["handlers/callback.callbackhandler",{"_index":119,"name":{},"parent":{"122":{}}}],["handlers/callback.callbackoptions",{"_index":112,"name":{},"parent":{"113":{},"114":{},"115":{},"116":{}}}],["handlers/callback.callbackoptionsprovider",{"_index":115,"name":{},"parent":{"118":{}}}],["handlers/callback.handlecallback",{"_index":117,"name":{},"parent":{"120":{}}}],["handlers/login",{"_index":120,"name":{"124":{}},"parent":{"125":{},"127":{},"136":{},"140":{},"142":{},"144":{}}}],["handlers/login.authorizationparams",{"_index":123,"name":{},"parent":{"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{}}}],["handlers/login.getloginstate",{"_index":121,"name":{},"parent":{"126":{}}}],["handlers/login.handlelogin",{"_index":132,"name":{},"parent":{"143":{}}}],["handlers/login.loginhandler",{"_index":134,"name":{},"parent":{"145":{}}}],["handlers/login.loginoptions",{"_index":128,"name":{},"parent":{"137":{},"138":{},"139":{}}}],["handlers/login.loginoptionsprovider",{"_index":130,"name":{},"parent":{"141":{}}}],["handlers/logout",{"_index":135,"name":{"146":{}},"parent":{"147":{},"151":{},"153":{},"155":{}}}],["handlers/logout.handlelogout",{"_index":142,"name":{},"parent":{"154":{}}}],["handlers/logout.logouthandler",{"_index":144,"name":{},"parent":{"156":{}}}],["handlers/logout.logoutoptions",{"_index":137,"name":{},"parent":{"148":{},"149":{},"150":{}}}],["handlers/logout.logoutoptionsprovider",{"_index":140,"name":{},"parent":{"152":{}}}],["handlers/profile",{"_index":145,"name":{"157":{}},"parent":{"158":{},"160":{},"164":{},"166":{},"168":{}}}],["handlers/profile.afterrefetch",{"_index":147,"name":{},"parent":{"159":{}}}],["handlers/profile.handleprofile",{"_index":155,"name":{},"parent":{"167":{}}}],["handlers/profile.profilehandler",{"_index":157,"name":{},"parent":{"169":{}}}],["handlers/profile.profileoptions",{"_index":149,"name":{},"parent":{"161":{}}}],["handlers/profile.profileoptions.__type",{"_index":151,"name":{},"parent":{"162":{},"163":{}}}],["handlers/profile.profileoptionsprovider",{"_index":153,"name":{},"parent":{"165":{}}}],["helpers",{"_index":158,"name":{"170":{}},"parent":{"325":{},"326":{},"327":{},"328":{},"329":{}}}],["helpers/testing",{"_index":159,"name":{"171":{}},"parent":{"172":{},"173":{}}}],["helpers/with",{"_index":162,"name":{"174":{},"177":{},"180":{}},"parent":{"175":{},"176":{},"178":{},"179":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{}}}],["httponly",{"_index":79,"name":{"75":{}},"parent":{}}],["httptimeout",{"_index":53,"name":{"48":{}},"parent":{}}],["identityclaimfilter",{"_index":56,"name":{"52":{},"89":{}},"parent":{}}],["identityprovidererror",{"_index":236,"name":{"344":{}},"parent":{}}],["idplogout",{"_index":57,"name":{"53":{}},"parent":{}}],["idtoken",{"_index":199,"name":{"239":{}},"parent":{}}],["idtokensigningalg",{"_index":58,"name":{"54":{}},"parent":{}}],["index",{"_index":173,"name":{"190":{}},"parent":{"191":{},"202":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"330":{},"331":{},"332":{},"333":{},"334":{},"335":{},"336":{},"337":{},"338":{},"341":{},"344":{},"348":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"373":{},"374":{},"375":{},"376":{},"377":{},"378":{},"379":{},"380":{},"381":{},"382":{},"383":{},"384":{},"385":{},"386":{}}}],["index.applicationerror",{"_index":240,"name":{},"parent":{"349":{}}}],["index.auth0server",{"_index":175,"name":{},"parent":{"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}}}],["index.identityprovidererror",{"_index":237,"name":{},"parent":{"345":{},"346":{},"347":{}}}],["index.initauth0",{"_index":178,"name":{},"parent":{"203":{}}}],["index.missingstatecookieerror",{"_index":233,"name":{},"parent":{"339":{},"340":{}}}],["index.missingstateparamerror",{"_index":235,"name":{},"parent":{"342":{},"343":{}}}],["index.sessioncache",{"_index":242,"name":{},"parent":{"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{}}}],["initauth0",{"_index":101,"name":{"98":{},"100":{},"202":{},"204":{}},"parent":{}}],["insufficient_scope",{"_index":216,"name":{"259":{}},"parent":{}}],["invitation",{"_index":125,"name":{"130":{}},"parent":{}}],["isauthenticated",{"_index":246,"name":{"368":{}},"parent":{}}],["isloading",{"_index":18,"name":{"15":{}},"parent":{}}],["issuerbaseurl",{"_index":59,"name":{"55":{}},"parent":{}}],["legacysamesitecookie",{"_index":60,"name":{"56":{}},"parent":{}}],["login",{"_index":91,"name":{"87":{}},"parent":{}}],["loginhandler",{"_index":133,"name":{"144":{}},"parent":{}}],["loginhandlererror",{"_index":224,"name":{"280":{},"335":{}},"parent":{}}],["loginoptions",{"_index":127,"name":{"136":{},"315":{},"383":{}},"parent":{}}],["loginoptionsprovider",{"_index":129,"name":{"140":{}},"parent":{}}],["logouthandler",{"_index":143,"name":{"155":{}},"parent":{}}],["logouthandlererror",{"_index":226,"name":{"287":{},"336":{}},"parent":{}}],["logoutoptions",{"_index":136,"name":{"147":{},"318":{},"384":{}},"parent":{}}],["logoutoptionsprovider",{"_index":139,"name":{"151":{}},"parent":{}}],["logoutparams",{"_index":138,"name":{"149":{}},"parent":{}}],["message",{"_index":232,"name":{"339":{},"342":{}},"parent":{}}],["middleware",{"_index":166,"name":{"177":{}},"parent":{"178":{},"179":{}}}],["missing_access_token",{"_index":213,"name":{"256":{}},"parent":{}}],["missing_refresh_token",{"_index":214,"name":{"257":{}},"parent":{}}],["missing_session",{"_index":211,"name":{"255":{}},"parent":{}}],["missingstatecookieerror",{"_index":231,"name":{"338":{}},"parent":{}}],["missingstateparamerror",{"_index":234,"name":{"341":{}},"parent":{}}],["name",{"_index":7,"name":{"5":{},"62":{},"251":{},"264":{},"270":{},"277":{},"284":{},"291":{},"298":{}},"parent":{}}],["nextconfig",{"_index":87,"name":{"82":{}},"parent":{}}],["nickname",{"_index":8,"name":{"6":{}},"parent":{}}],["onerror",{"_index":37,"name":{"32":{},"107":{},"324":{},"386":{}},"parent":{}}],["onredirecting",{"_index":36,"name":{"30":{}},"parent":{}}],["org_id",{"_index":12,"name":{"10":{}},"parent":{}}],["organization",{"_index":88,"name":{"83":{},"115":{},"131":{}},"parent":{}}],["page",{"_index":30,"name":{"27":{},"180":{}},"parent":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{}}}],["pageroute",{"_index":169,"name":{"182":{},"329":{},"360":{}},"parent":{}}],["path",{"_index":77,"name":{"73":{}},"parent":{}}],["picture",{"_index":9,"name":{"7":{}},"parent":{}}],["postlogoutredirect",{"_index":62,"name":{"59":{}},"parent":{}}],["profilehandler",{"_index":156,"name":{"168":{}},"parent":{}}],["profilehandlererror",{"_index":228,"name":{"294":{},"337":{}},"parent":{}}],["profileoptions",{"_index":148,"name":{"160":{},"320":{},"356":{}},"parent":{}}],["profileoptionsprovider",{"_index":152,"name":{"164":{}},"parent":{}}],["redirecturi",{"_index":113,"name":{"114":{}},"parent":{}}],["refetch",{"_index":150,"name":{"162":{}},"parent":{}}],["refresh",{"_index":190,"name":{"223":{}},"parent":{}}],["refreshtoken",{"_index":202,"name":{"243":{}},"parent":{}}],["requesterror",{"_index":20,"name":{"18":{},"306":{}},"parent":{}}],["required",{"_index":32,"name":{"27":{},"174":{},"177":{},"180":{}},"parent":{"28":{},"34":{},"36":{},"175":{},"178":{},"181":{},"182":{},"184":{},"188":{}}}],["required.pageroute",{"_index":170,"name":{},"parent":{"183":{}}}],["required.userprops",{"_index":39,"name":{},"parent":{"35":{}}}],["required.withapiauthrequired",{"_index":165,"name":{},"parent":{"176":{}}}],["required.withmiddlewareauthrequired",{"_index":167,"name":{},"parent":{"179":{}}}],["required.withpageauthrequired",{"_index":41,"name":{},"parent":{"37":{},"189":{}}}],["required.withpageauthrequiredoptions",{"_index":35,"name":{},"parent":{"29":{},"30":{},"31":{},"32":{},"33":{},"185":{}}}],["required.withpageauthrequiredoptions.__type",{"_index":172,"name":{},"parent":{"186":{},"187":{}}}],["response_mode",{"_index":85,"name":{"80":{},"134":{}},"parent":{}}],["response_type",{"_index":86,"name":{"81":{},"135":{}},"parent":{}}],["returnto",{"_index":34,"name":{"29":{},"138":{},"148":{},"187":{}},"parent":{}}],["rolling",{"_index":69,"name":{"66":{}},"parent":{}}],["rollingduration",{"_index":70,"name":{"67":{}},"parent":{}}],["routes",{"_index":61,"name":{"57":{},"84":{}},"parent":{}}],["samesite",{"_index":81,"name":{"77":{}},"parent":{}}],["save",{"_index":243,"name":{"365":{}},"parent":{}}],["scope",{"_index":83,"name":{"79":{},"133":{}},"parent":{}}],["scopes",{"_index":188,"name":{"222":{}},"parent":{}}],["screen_hint",{"_index":126,"name":{"132":{}},"parent":{}}],["secret",{"_index":44,"name":{"40":{}},"parent":{}}],["secure",{"_index":80,"name":{"76":{}},"parent":{}}],["session",{"_index":46,"name":{"41":{},"230":{},"233":{},"244":{},"376":{},"387":{}},"parent":{"231":{},"245":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"394":{}}}],["session.getsession",{"_index":195,"name":{},"parent":{"232":{}}}],["session.updatesession",{"_index":204,"name":{},"parent":{"246":{}}}],["session/get",{"_index":182,"name":{"218":{},"230":{}},"parent":{"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"231":{},"232":{}}}],["session/session",{"_index":196,"name":{"234":{}},"parent":{"235":{},"236":{}}}],["session/session.default",{"_index":198,"name":{},"parent":{"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{}}}],["session/update",{"_index":203,"name":{"244":{}},"parent":{"245":{},"246":{}}}],["sessioncache",{"_index":241,"name":{"363":{},"393":{}},"parent":{}}],["sessionconfig",{"_index":65,"name":{"61":{}},"parent":{}}],["sessionstore",{"_index":180,"name":{"216":{}},"parent":{}}],["sessionstorepayload",{"_index":181,"name":{"217":{}},"parent":{}}],["set",{"_index":248,"name":{"370":{}},"parent":{}}],["status",{"_index":23,"name":{"20":{},"253":{},"266":{},"272":{},"279":{},"286":{},"293":{},"300":{}},"parent":{}}],["store",{"_index":67,"name":{"63":{}},"parent":{}}],["storeidtoken",{"_index":72,"name":{"69":{}},"parent":{}}],["sub",{"_index":10,"name":{"8":{}},"parent":{}}],["token",{"_index":184,"name":{"218":{}},"parent":{"219":{},"221":{},"226":{},"228":{}}}],["token.accesstokenrequest",{"_index":189,"name":{},"parent":{"222":{},"223":{},"224":{},"225":{}}}],["token.afterrefresh",{"_index":186,"name":{},"parent":{"220":{}}}],["token.getaccesstoken",{"_index":194,"name":{},"parent":{"229":{}}}],["token.getaccesstokenresult",{"_index":193,"name":{},"parent":{"227":{}}}],["transient",{"_index":78,"name":{"74":{}},"parent":{}}],["unauthorized",{"_index":92,"name":{"88":{}},"parent":{}}],["updated_at",{"_index":11,"name":{"9":{}},"parent":{}}],["updatesession",{"_index":176,"name":{"193":{},"207":{},"245":{},"374":{},"394":{}},"parent":{}}],["user",{"_index":2,"name":{"1":{},"13":{},"35":{},"238":{}},"parent":{"2":{},"11":{},"18":{},"21":{},"22":{},"23":{},"25":{},"26":{}}}],["user.requesterror",{"_index":22,"name":{},"parent":{"19":{},"20":{}}}],["user.usercontext",{"_index":15,"name":{},"parent":{"12":{}}}],["user.usercontext.__type",{"_index":16,"name":{},"parent":{"13":{},"14":{},"15":{},"16":{},"17":{}}}],["user.userprofile",{"_index":5,"name":{},"parent":{"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{}}}],["user.userprovider",{"_index":27,"name":{},"parent":{"24":{}}}],["usercontext",{"_index":13,"name":{"11":{}},"parent":{}}],["userprofile",{"_index":3,"name":{"2":{},"305":{}},"parent":{}}],["userprops",{"_index":38,"name":{"34":{}},"parent":{}}],["userprovider",{"_index":26,"name":{"23":{},"303":{}},"parent":{}}],["userproviderprops",{"_index":24,"name":{"21":{},"304":{}},"parent":{}}],["useuser",{"_index":25,"name":{"22":{},"307":{}},"parent":{}}],["utils/errors",{"_index":205,"name":{"247":{}},"parent":{"248":{},"254":{},"261":{},"267":{},"273":{},"280":{},"287":{},"294":{}}}],["utils/errors.accesstokenerror",{"_index":219,"name":{},"parent":{"262":{},"263":{},"264":{},"265":{},"266":{}}}],["utils/errors.accesstokenerrorcode",{"_index":212,"name":{},"parent":{"255":{},"256":{},"257":{},"258":{},"259":{},"260":{}}}],["utils/errors.autherror",{"_index":207,"name":{},"parent":{"249":{},"250":{},"251":{},"252":{},"253":{}}}],["utils/errors.callbackhandlererror",{"_index":223,"name":{},"parent":{"274":{},"275":{},"276":{},"277":{},"278":{},"279":{}}}],["utils/errors.handlererror",{"_index":221,"name":{},"parent":{"268":{},"269":{},"270":{},"271":{},"272":{}}}],["utils/errors.loginhandlererror",{"_index":225,"name":{},"parent":{"281":{},"282":{},"283":{},"284":{},"285":{},"286":{}}}],["utils/errors.logouthandlererror",{"_index":227,"name":{},"parent":{"288":{},"289":{},"290":{},"291":{},"292":{},"293":{}}}],["utils/errors.profilehandlererror",{"_index":229,"name":{},"parent":{"295":{},"296":{},"297":{},"298":{},"299":{},"300":{}}}],["version",{"_index":230,"name":{"301":{}},"parent":{"302":{}}}],["withapiauthrequired",{"_index":164,"name":{"175":{},"199":{},"209":{},"325":{},"361":{}},"parent":{}}],["withmiddlewareauthrequired",{"_index":97,"name":{"94":{},"102":{},"178":{},"310":{}},"parent":{}}],["withpageauthrequired",{"_index":40,"name":{"36":{},"188":{},"200":{},"210":{},"308":{},"327":{},"362":{}},"parent":{}}],["withpageauthrequiredoptions",{"_index":33,"name":{"28":{},"184":{},"309":{},"328":{},"359":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 000000000..d55df0323 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n.tagName!=="SECTION";)n=n.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function fe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 000000000..bed50c263 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":256,\"name\":\"Auth0Server\",\"url\":\"interfaces/Auth0Server.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"getSession\",\"url\":\"interfaces/Auth0Server.html#getSession\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"updateSession\",\"url\":\"interfaces/Auth0Server.html#updateSession\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"getAccessToken\",\"url\":\"interfaces/Auth0Server.html#getAccessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"handleLogin\",\"url\":\"interfaces/Auth0Server.html#handleLogin\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"handleCallback\",\"url\":\"interfaces/Auth0Server.html#handleCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"handleLogout\",\"url\":\"interfaces/Auth0Server.html#handleLogout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"handleProfile\",\"url\":\"interfaces/Auth0Server.html#handleProfile\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"withApiAuthRequired\",\"url\":\"interfaces/Auth0Server.html#withApiAuthRequired\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"withPageAuthRequired\",\"url\":\"interfaces/Auth0Server.html#withPageAuthRequired\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":1024,\"name\":\"handleAuth\",\"url\":\"interfaces/Auth0Server.html#handleAuth\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0Server\"},{\"kind\":4194304,\"name\":\"InitAuth0\",\"url\":\"types/InitAuth0.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/InitAuth0.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"InitAuth0\"},{\"kind\":64,\"name\":\"initAuth0\",\"url\":\"functions/initAuth0-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"_initAuth\",\"url\":\"functions/_initAuth.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"getSession\",\"url\":\"functions/getSession-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"updateSession\",\"url\":\"functions/updateSession-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"getAccessToken\",\"url\":\"functions/getAccessToken-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"withApiAuthRequired\",\"url\":\"functions/withApiAuthRequired-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"withPageAuthRequired\",\"url\":\"functions/withPageAuthRequired-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"handleLogin\",\"url\":\"functions/handleLogin-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"handleLogout\",\"url\":\"functions/handleLogout-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"handleCallback\",\"url\":\"functions/handleCallback-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"handleProfile\",\"url\":\"functions/handleProfile-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"handleAuth\",\"url\":\"functions/handleAuth-1.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"SessionStore\",\"url\":\"types/SessionStore.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"SessionStorePayload\",\"url\":\"types/SessionStorePayload.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"AuthError\",\"url\":\"classes/AuthError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AuthError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"AuthError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/AuthError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/AuthError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/AuthError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/AuthError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthError\"},{\"kind\":8,\"name\":\"AccessTokenErrorCode\",\"url\":\"enums/AccessTokenErrorCode.html\",\"classes\":\"tsd-kind-enum\"},{\"kind\":16,\"name\":\"MISSING_SESSION\",\"url\":\"enums/AccessTokenErrorCode.html#MISSING_SESSION\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":16,\"name\":\"MISSING_ACCESS_TOKEN\",\"url\":\"enums/AccessTokenErrorCode.html#MISSING_ACCESS_TOKEN\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":16,\"name\":\"MISSING_REFRESH_TOKEN\",\"url\":\"enums/AccessTokenErrorCode.html#MISSING_REFRESH_TOKEN\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":16,\"name\":\"EXPIRED_ACCESS_TOKEN\",\"url\":\"enums/AccessTokenErrorCode.html#EXPIRED_ACCESS_TOKEN\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":16,\"name\":\"INSUFFICIENT_SCOPE\",\"url\":\"enums/AccessTokenErrorCode.html#INSUFFICIENT_SCOPE\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":16,\"name\":\"FAILED_REFRESH_GRANT\",\"url\":\"enums/AccessTokenErrorCode.html#FAILED_REFRESH_GRANT\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"AccessTokenErrorCode\"},{\"kind\":128,\"name\":\"AccessTokenError\",\"url\":\"classes/AccessTokenError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AccessTokenError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"AccessTokenError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/AccessTokenError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AccessTokenError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/AccessTokenError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AccessTokenError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/AccessTokenError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AccessTokenError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/AccessTokenError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AccessTokenError\"},{\"kind\":128,\"name\":\"HandlerError\",\"url\":\"classes/HandlerError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/HandlerError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"HandlerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/HandlerError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"HandlerError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/HandlerError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"HandlerError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/HandlerError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"HandlerError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/HandlerError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"HandlerError\"},{\"kind\":128,\"name\":\"CallbackHandlerError\",\"url\":\"classes/CallbackHandlerError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/CallbackHandlerError.html#code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CallbackHandlerError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CallbackHandlerError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"CallbackHandlerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/CallbackHandlerError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"CallbackHandlerError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/CallbackHandlerError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"CallbackHandlerError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/CallbackHandlerError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"CallbackHandlerError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/CallbackHandlerError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"CallbackHandlerError\"},{\"kind\":128,\"name\":\"LoginHandlerError\",\"url\":\"classes/LoginHandlerError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/LoginHandlerError.html#code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"LoginHandlerError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LoginHandlerError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LoginHandlerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/LoginHandlerError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LoginHandlerError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/LoginHandlerError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LoginHandlerError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/LoginHandlerError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LoginHandlerError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/LoginHandlerError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LoginHandlerError\"},{\"kind\":128,\"name\":\"LogoutHandlerError\",\"url\":\"classes/LogoutHandlerError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/LogoutHandlerError.html#code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"LogoutHandlerError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogoutHandlerError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LogoutHandlerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/LogoutHandlerError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LogoutHandlerError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/LogoutHandlerError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LogoutHandlerError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/LogoutHandlerError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LogoutHandlerError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/LogoutHandlerError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"LogoutHandlerError\"},{\"kind\":128,\"name\":\"ProfileHandlerError\",\"url\":\"classes/ProfileHandlerError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/ProfileHandlerError.html#code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"ProfileHandlerError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ProfileHandlerError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"ProfileHandlerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/ProfileHandlerError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"ProfileHandlerError\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/ProfileHandlerError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"ProfileHandlerError\"},{\"kind\":1024,\"name\":\"cause\",\"url\":\"classes/ProfileHandlerError.html#cause\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"ProfileHandlerError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/ProfileHandlerError.html#status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"ProfileHandlerError\"},{\"kind\":4194304,\"name\":\"ConfigParameters\",\"url\":\"types/ConfigParameters.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"HandleAuth\",\"url\":\"types/HandleAuth.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/HandleAuth.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"HandleAuth\"},{\"kind\":4194304,\"name\":\"HandleLogin\",\"url\":\"types/HandleLogin.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/HandleLogin.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"HandleLogin\"},{\"kind\":4194304,\"name\":\"HandleProfile\",\"url\":\"types/HandleProfile.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/HandleProfile.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"HandleProfile\"},{\"kind\":4194304,\"name\":\"HandleLogout\",\"url\":\"types/HandleLogout.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/HandleLogout.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"HandleLogout\"},{\"kind\":4194304,\"name\":\"HandleCallback\",\"url\":\"types/HandleCallback.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/HandleCallback.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"HandleCallback\"},{\"kind\":4194304,\"name\":\"ProfileOptions\",\"url\":\"types/ProfileOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ProfileOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ProfileOptions\"},{\"kind\":1024,\"name\":\"refetch\",\"url\":\"types/ProfileOptions.html#__type.refetch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ProfileOptions.__type\"},{\"kind\":1024,\"name\":\"afterRefetch\",\"url\":\"types/ProfileOptions.html#__type.afterRefetch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ProfileOptions.__type\"},{\"kind\":4194304,\"name\":\"Handlers\",\"url\":\"types/Handlers.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"GetServerSidePropsResultWithSession\",\"url\":\"types/GetServerSidePropsResultWithSession.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"WithPageAuthRequiredOptions\",\"url\":\"types/WithPageAuthRequiredOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/WithPageAuthRequiredOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"WithPageAuthRequiredOptions\"},{\"kind\":1024,\"name\":\"getServerSideProps\",\"url\":\"types/WithPageAuthRequiredOptions.html#__type.getServerSideProps\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"WithPageAuthRequiredOptions.__type\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"types/WithPageAuthRequiredOptions.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"WithPageAuthRequiredOptions.__type\"},{\"kind\":4194304,\"name\":\"PageRoute\",\"url\":\"types/PageRoute.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/PageRoute.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"PageRoute\"},{\"kind\":4194304,\"name\":\"WithApiAuthRequired\",\"url\":\"types/WithApiAuthRequired.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/WithApiAuthRequired.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"WithApiAuthRequired\"},{\"kind\":4194304,\"name\":\"WithPageAuthRequired\",\"url\":\"types/WithPageAuthRequired.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/WithPageAuthRequired.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"WithPageAuthRequired\"},{\"kind\":4194304,\"name\":\"GetSession\",\"url\":\"types/GetSession.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/GetSession.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"GetSession\"},{\"kind\":4194304,\"name\":\"UpdateSession\",\"url\":\"types/UpdateSession.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/UpdateSession.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"UpdateSession\"},{\"kind\":4194304,\"name\":\"GetAccessToken\",\"url\":\"types/GetAccessToken.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/GetAccessToken.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"GetAccessToken\"},{\"kind\":128,\"name\":\"Session\",\"url\":\"classes/Session.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Session.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"classes/Session.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"idToken\",\"url\":\"classes/Session.html#idToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"accessToken\",\"url\":\"classes/Session.html#accessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"accessTokenScope\",\"url\":\"classes/Session.html#accessTokenScope\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"accessTokenExpiresAt\",\"url\":\"classes/Session.html#accessTokenExpiresAt\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"refreshToken\",\"url\":\"classes/Session.html#refreshToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Session\"},{\"kind\":256,\"name\":\"Claims\",\"url\":\"interfaces/Claims.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":256,\"name\":\"AccessTokenRequest\",\"url\":\"interfaces/AccessTokenRequest.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"scopes\",\"url\":\"interfaces/AccessTokenRequest.html#scopes\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessTokenRequest\"},{\"kind\":1024,\"name\":\"refresh\",\"url\":\"interfaces/AccessTokenRequest.html#refresh\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessTokenRequest\"},{\"kind\":1024,\"name\":\"afterRefresh\",\"url\":\"interfaces/AccessTokenRequest.html#afterRefresh\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessTokenRequest\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/AccessTokenRequest.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessTokenRequest\"},{\"kind\":256,\"name\":\"GetAccessTokenResult\",\"url\":\"interfaces/GetAccessTokenResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"accessToken\",\"url\":\"interfaces/GetAccessTokenResult.html#accessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetAccessTokenResult\"},{\"kind\":256,\"name\":\"CallbackOptions\",\"url\":\"interfaces/CallbackOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"afterCallback\",\"url\":\"interfaces/CallbackOptions.html#afterCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":1024,\"name\":\"redirectUri\",\"url\":\"interfaces/CallbackOptions.html#redirectUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":1024,\"name\":\"organization\",\"url\":\"interfaces/CallbackOptions.html#organization\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/CallbackOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":4194304,\"name\":\"AfterCallback\",\"url\":\"types/AfterCallback.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AfterCallback.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AfterCallback\"},{\"kind\":4194304,\"name\":\"AfterRefetch\",\"url\":\"types/AfterRefetch.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AfterRefetch.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AfterRefetch\"},{\"kind\":256,\"name\":\"LoginOptions\",\"url\":\"interfaces/LoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/LoginOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LoginOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":1024,\"name\":\"getLoginState\",\"url\":\"interfaces/LoginOptions.html#getLoginState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LogoutOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":1024,\"name\":\"logoutParams\",\"url\":\"interfaces/LogoutOptions.html#logoutParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutOptions.html#logoutParams.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"LogoutOptions.logoutParams\"},{\"kind\":4194304,\"name\":\"GetLoginState\",\"url\":\"types/GetLoginState.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/GetLoginState.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"GetLoginState\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/GetLoginState.html#__type.__type-1.__type-2\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"GetLoginState.__type.__type\"},{\"kind\":4194304,\"name\":\"OnError\",\"url\":\"types/OnError.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/OnError.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"OnError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,46.184]],[\"comment/0\",[]],[\"name/1\",[1,37.711]],[\"comment/1\",[]],[\"name/2\",[2,37.711]],[\"comment/2\",[]],[\"name/3\",[3,37.711]],[\"comment/3\",[]],[\"name/4\",[4,37.711]],[\"comment/4\",[]],[\"name/5\",[5,37.711]],[\"comment/5\",[]],[\"name/6\",[6,37.711]],[\"comment/6\",[]],[\"name/7\",[7,37.711]],[\"comment/7\",[]],[\"name/8\",[8,37.711]],[\"comment/8\",[]],[\"name/9\",[9,37.711]],[\"comment/9\",[]],[\"name/10\",[10,37.711]],[\"comment/10\",[]],[\"name/11\",[11,41.076]],[\"comment/11\",[]],[\"name/12\",[12,20.035]],[\"comment/12\",[]],[\"name/13\",[11,41.076]],[\"comment/13\",[]],[\"name/14\",[13,46.184]],[\"comment/14\",[]],[\"name/15\",[1,37.711]],[\"comment/15\",[]],[\"name/16\",[2,37.711]],[\"comment/16\",[]],[\"name/17\",[3,37.711]],[\"comment/17\",[]],[\"name/18\",[8,37.711]],[\"comment/18\",[]],[\"name/19\",[9,37.711]],[\"comment/19\",[]],[\"name/20\",[4,37.711]],[\"comment/20\",[]],[\"name/21\",[6,37.711]],[\"comment/21\",[]],[\"name/22\",[5,37.711]],[\"comment/22\",[]],[\"name/23\",[7,37.711]],[\"comment/23\",[]],[\"name/24\",[10,37.711]],[\"comment/24\",[]],[\"name/25\",[14,46.184]],[\"comment/25\",[]],[\"name/26\",[15,46.184]],[\"comment/26\",[]],[\"name/27\",[16,46.184]],[\"comment/27\",[]],[\"name/28\",[17,28.838]],[\"comment/28\",[]],[\"name/29\",[18,25.815]],[\"comment/29\",[]],[\"name/30\",[19,30.09]],[\"comment/30\",[]],[\"name/31\",[20,30.09]],[\"comment/31\",[]],[\"name/32\",[21,30.09]],[\"comment/32\",[]],[\"name/33\",[22,46.184]],[\"comment/33\",[]],[\"name/34\",[23,46.184]],[\"comment/34\",[]],[\"name/35\",[24,46.184]],[\"comment/35\",[]],[\"name/36\",[25,46.184]],[\"comment/36\",[]],[\"name/37\",[26,46.184]],[\"comment/37\",[]],[\"name/38\",[27,46.184]],[\"comment/38\",[]],[\"name/39\",[28,46.184]],[\"comment/39\",[]],[\"name/40\",[29,46.184]],[\"comment/40\",[]],[\"name/41\",[17,28.838]],[\"comment/41\",[]],[\"name/42\",[18,25.815]],[\"comment/42\",[]],[\"name/43\",[19,30.09]],[\"comment/43\",[]],[\"name/44\",[20,30.09]],[\"comment/44\",[]],[\"name/45\",[21,30.09]],[\"comment/45\",[]],[\"name/46\",[30,46.184]],[\"comment/46\",[]],[\"name/47\",[17,28.838]],[\"comment/47\",[]],[\"name/48\",[18,25.815]],[\"comment/48\",[]],[\"name/49\",[19,30.09]],[\"comment/49\",[]],[\"name/50\",[20,30.09]],[\"comment/50\",[]],[\"name/51\",[21,30.09]],[\"comment/51\",[]],[\"name/52\",[31,46.184]],[\"comment/52\",[]],[\"name/53\",[18,25.815]],[\"comment/53\",[]],[\"name/54\",[17,28.838]],[\"comment/54\",[]],[\"name/55\",[18,25.815]],[\"comment/55\",[]],[\"name/56\",[19,30.09]],[\"comment/56\",[]],[\"name/57\",[20,30.09]],[\"comment/57\",[]],[\"name/58\",[21,30.09]],[\"comment/58\",[]],[\"name/59\",[32,46.184]],[\"comment/59\",[]],[\"name/60\",[18,25.815]],[\"comment/60\",[]],[\"name/61\",[17,28.838]],[\"comment/61\",[]],[\"name/62\",[18,25.815]],[\"comment/62\",[]],[\"name/63\",[19,30.09]],[\"comment/63\",[]],[\"name/64\",[20,30.09]],[\"comment/64\",[]],[\"name/65\",[21,30.09]],[\"comment/65\",[]],[\"name/66\",[33,46.184]],[\"comment/66\",[]],[\"name/67\",[18,25.815]],[\"comment/67\",[]],[\"name/68\",[17,28.838]],[\"comment/68\",[]],[\"name/69\",[18,25.815]],[\"comment/69\",[]],[\"name/70\",[19,30.09]],[\"comment/70\",[]],[\"name/71\",[20,30.09]],[\"comment/71\",[]],[\"name/72\",[21,30.09]],[\"comment/72\",[]],[\"name/73\",[34,46.184]],[\"comment/73\",[]],[\"name/74\",[18,25.815]],[\"comment/74\",[]],[\"name/75\",[17,28.838]],[\"comment/75\",[]],[\"name/76\",[18,25.815]],[\"comment/76\",[]],[\"name/77\",[19,30.09]],[\"comment/77\",[]],[\"name/78\",[20,30.09]],[\"comment/78\",[]],[\"name/79\",[21,30.09]],[\"comment/79\",[]],[\"name/80\",[35,46.184]],[\"comment/80\",[]],[\"name/81\",[10,37.711]],[\"comment/81\",[]],[\"name/82\",[12,20.035]],[\"comment/82\",[]],[\"name/83\",[4,37.711]],[\"comment/83\",[]],[\"name/84\",[12,20.035]],[\"comment/84\",[]],[\"name/85\",[7,37.711]],[\"comment/85\",[]],[\"name/86\",[12,20.035]],[\"comment/86\",[]],[\"name/87\",[6,37.711]],[\"comment/87\",[]],[\"name/88\",[12,20.035]],[\"comment/88\",[]],[\"name/89\",[5,37.711]],[\"comment/89\",[]],[\"name/90\",[12,20.035]],[\"comment/90\",[]],[\"name/91\",[36,46.184]],[\"comment/91\",[]],[\"name/92\",[12,20.035]],[\"comment/92\",[]],[\"name/93\",[37,46.184]],[\"comment/93\",[]],[\"name/94\",[38,41.076]],[\"comment/94\",[]],[\"name/95\",[39,46.184]],[\"comment/95\",[]],[\"name/96\",[40,46.184]],[\"comment/96\",[]],[\"name/97\",[41,46.184]],[\"comment/97\",[]],[\"name/98\",[12,20.035]],[\"comment/98\",[]],[\"name/99\",[42,46.184]],[\"comment/99\",[]],[\"name/100\",[43,37.711]],[\"comment/100\",[]],[\"name/101\",[44,46.184]],[\"comment/101\",[]],[\"name/102\",[12,20.035]],[\"comment/102\",[]],[\"name/103\",[8,37.711]],[\"comment/103\",[]],[\"name/104\",[12,20.035]],[\"comment/104\",[]],[\"name/105\",[9,37.711]],[\"comment/105\",[]],[\"name/106\",[12,20.035]],[\"comment/106\",[]],[\"name/107\",[1,37.711]],[\"comment/107\",[]],[\"name/108\",[12,20.035]],[\"comment/108\",[]],[\"name/109\",[2,37.711]],[\"comment/109\",[]],[\"name/110\",[12,20.035]],[\"comment/110\",[]],[\"name/111\",[3,37.711]],[\"comment/111\",[]],[\"name/112\",[12,20.035]],[\"comment/112\",[]],[\"name/113\",[45,46.184]],[\"comment/113\",[]],[\"name/114\",[17,28.838]],[\"comment/114\",[]],[\"name/115\",[46,46.184]],[\"comment/115\",[]],[\"name/116\",[47,46.184]],[\"comment/116\",[]],[\"name/117\",[48,41.076]],[\"comment/117\",[]],[\"name/118\",[49,46.184]],[\"comment/118\",[]],[\"name/119\",[50,46.184]],[\"comment/119\",[]],[\"name/120\",[51,46.184]],[\"comment/120\",[]],[\"name/121\",[52,46.184]],[\"comment/121\",[]],[\"name/122\",[53,46.184]],[\"comment/122\",[]],[\"name/123\",[54,46.184]],[\"comment/123\",[]],[\"name/124\",[55,46.184]],[\"comment/124\",[]],[\"name/125\",[56,46.184]],[\"comment/125\",[]],[\"name/126\",[57,37.711]],[\"comment/126\",[]],[\"name/127\",[58,46.184]],[\"comment/127\",[]],[\"name/128\",[48,41.076]],[\"comment/128\",[]],[\"name/129\",[59,46.184]],[\"comment/129\",[]],[\"name/130\",[60,41.076]],[\"comment/130\",[]],[\"name/131\",[61,46.184]],[\"comment/131\",[]],[\"name/132\",[62,46.184]],[\"comment/132\",[]],[\"name/133\",[57,37.711]],[\"comment/133\",[]],[\"name/134\",[60,41.076]],[\"comment/134\",[]],[\"name/135\",[12,20.035]],[\"comment/135\",[]],[\"name/136\",[38,41.076]],[\"comment/136\",[]],[\"name/137\",[12,20.035]],[\"comment/137\",[]],[\"name/138\",[63,46.184]],[\"comment/138\",[]],[\"name/139\",[57,37.711]],[\"comment/139\",[]],[\"name/140\",[43,37.711]],[\"comment/140\",[]],[\"name/141\",[64,41.076]],[\"comment/141\",[]],[\"name/142\",[65,46.184]],[\"comment/142\",[]],[\"name/143\",[43,37.711]],[\"comment/143\",[]],[\"name/144\",[66,46.184]],[\"comment/144\",[]],[\"name/145\",[12,20.035]],[\"comment/145\",[]],[\"name/146\",[64,41.076]],[\"comment/146\",[]],[\"name/147\",[12,20.035]],[\"comment/147\",[]],[\"name/148\",[12,20.035]],[\"comment/148\",[]],[\"name/149\",[67,46.184]],[\"comment/149\",[]],[\"name/150\",[12,20.035]],[\"comment/150\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":12,\"name\":{\"12\":{},\"82\":{},\"84\":{},\"86\":{},\"88\":{},\"90\":{},\"92\":{},\"98\":{},\"102\":{},\"104\":{},\"106\":{},\"108\":{},\"110\":{},\"112\":{},\"135\":{},\"137\":{},\"145\":{},\"147\":{},\"148\":{},\"150\":{}},\"comment\":{}}],[\"_initauth\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"accesstoken\",{\"_index\":48,\"name\":{\"117\":{},\"128\":{}},\"comment\":{}}],[\"accesstokenerror\",{\"_index\":29,\"name\":{\"40\":{}},\"comment\":{}}],[\"accesstokenerrorcode\",{\"_index\":22,\"name\":{\"33\":{}},\"comment\":{}}],[\"accesstokenexpiresat\",{\"_index\":50,\"name\":{\"119\":{}},\"comment\":{}}],[\"accesstokenrequest\",{\"_index\":53,\"name\":{\"122\":{}},\"comment\":{}}],[\"accesstokenscope\",{\"_index\":49,\"name\":{\"118\":{}},\"comment\":{}}],[\"aftercallback\",{\"_index\":60,\"name\":{\"130\":{},\"134\":{}},\"comment\":{}}],[\"afterrefetch\",{\"_index\":38,\"name\":{\"94\":{},\"136\":{}},\"comment\":{}}],[\"afterrefresh\",{\"_index\":56,\"name\":{\"125\":{}},\"comment\":{}}],[\"auth0server\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"autherror\",{\"_index\":16,\"name\":{\"27\":{}},\"comment\":{}}],[\"authorizationparams\",{\"_index\":57,\"name\":{\"126\":{},\"133\":{},\"139\":{}},\"comment\":{}}],[\"callbackhandlererror\",{\"_index\":31,\"name\":{\"52\":{}},\"comment\":{}}],[\"callbackoptions\",{\"_index\":59,\"name\":{\"129\":{}},\"comment\":{}}],[\"cause\",{\"_index\":20,\"name\":{\"31\":{},\"44\":{},\"50\":{},\"57\":{},\"64\":{},\"71\":{},\"78\":{}},\"comment\":{}}],[\"claims\",{\"_index\":52,\"name\":{\"121\":{}},\"comment\":{}}],[\"code\",{\"_index\":18,\"name\":{\"29\":{},\"42\":{},\"48\":{},\"53\":{},\"55\":{},\"60\":{},\"62\":{},\"67\":{},\"69\":{},\"74\":{},\"76\":{}},\"comment\":{}}],[\"configparameters\",{\"_index\":35,\"name\":{\"80\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":17,\"name\":{\"28\":{},\"41\":{},\"47\":{},\"54\":{},\"61\":{},\"68\":{},\"75\":{},\"114\":{}},\"comment\":{}}],[\"expired_access_token\",{\"_index\":26,\"name\":{\"37\":{}},\"comment\":{}}],[\"failed_refresh_grant\",{\"_index\":28,\"name\":{\"39\":{}},\"comment\":{}}],[\"getaccesstoken\",{\"_index\":3,\"name\":{\"3\":{},\"17\":{},\"111\":{}},\"comment\":{}}],[\"getaccesstokenresult\",{\"_index\":58,\"name\":{\"127\":{}},\"comment\":{}}],[\"getloginstate\",{\"_index\":64,\"name\":{\"141\":{},\"146\":{}},\"comment\":{}}],[\"getserversideprops\",{\"_index\":42,\"name\":{\"99\":{}},\"comment\":{}}],[\"getserversidepropsresultwithsession\",{\"_index\":40,\"name\":{\"96\":{}},\"comment\":{}}],[\"getsession\",{\"_index\":1,\"name\":{\"1\":{},\"15\":{},\"107\":{}},\"comment\":{}}],[\"handleauth\",{\"_index\":10,\"name\":{\"10\":{},\"24\":{},\"81\":{}},\"comment\":{}}],[\"handlecallback\",{\"_index\":5,\"name\":{\"5\":{},\"22\":{},\"89\":{}},\"comment\":{}}],[\"handlelogin\",{\"_index\":4,\"name\":{\"4\":{},\"20\":{},\"83\":{}},\"comment\":{}}],[\"handlelogout\",{\"_index\":6,\"name\":{\"6\":{},\"21\":{},\"87\":{}},\"comment\":{}}],[\"handleprofile\",{\"_index\":7,\"name\":{\"7\":{},\"23\":{},\"85\":{}},\"comment\":{}}],[\"handlererror\",{\"_index\":30,\"name\":{\"46\":{}},\"comment\":{}}],[\"handlers\",{\"_index\":39,\"name\":{\"95\":{}},\"comment\":{}}],[\"idtoken\",{\"_index\":47,\"name\":{\"116\":{}},\"comment\":{}}],[\"initauth0\",{\"_index\":11,\"name\":{\"11\":{},\"13\":{}},\"comment\":{}}],[\"insufficient_scope\",{\"_index\":27,\"name\":{\"38\":{}},\"comment\":{}}],[\"loginhandlererror\",{\"_index\":32,\"name\":{\"59\":{}},\"comment\":{}}],[\"loginoptions\",{\"_index\":63,\"name\":{\"138\":{}},\"comment\":{}}],[\"logouthandlererror\",{\"_index\":33,\"name\":{\"66\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":65,\"name\":{\"142\":{}},\"comment\":{}}],[\"logoutparams\",{\"_index\":66,\"name\":{\"144\":{}},\"comment\":{}}],[\"missing_access_token\",{\"_index\":24,\"name\":{\"35\":{}},\"comment\":{}}],[\"missing_refresh_token\",{\"_index\":25,\"name\":{\"36\":{}},\"comment\":{}}],[\"missing_session\",{\"_index\":23,\"name\":{\"34\":{}},\"comment\":{}}],[\"name\",{\"_index\":19,\"name\":{\"30\":{},\"43\":{},\"49\":{},\"56\":{},\"63\":{},\"70\":{},\"77\":{}},\"comment\":{}}],[\"onerror\",{\"_index\":67,\"name\":{\"149\":{}},\"comment\":{}}],[\"organization\",{\"_index\":62,\"name\":{\"132\":{}},\"comment\":{}}],[\"pageroute\",{\"_index\":44,\"name\":{\"101\":{}},\"comment\":{}}],[\"profilehandlererror\",{\"_index\":34,\"name\":{\"73\":{}},\"comment\":{}}],[\"profileoptions\",{\"_index\":36,\"name\":{\"91\":{}},\"comment\":{}}],[\"redirecturi\",{\"_index\":61,\"name\":{\"131\":{}},\"comment\":{}}],[\"refetch\",{\"_index\":37,\"name\":{\"93\":{}},\"comment\":{}}],[\"refresh\",{\"_index\":55,\"name\":{\"124\":{}},\"comment\":{}}],[\"refreshtoken\",{\"_index\":51,\"name\":{\"120\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":43,\"name\":{\"100\":{},\"140\":{},\"143\":{}},\"comment\":{}}],[\"scopes\",{\"_index\":54,\"name\":{\"123\":{}},\"comment\":{}}],[\"session\",{\"_index\":45,\"name\":{\"113\":{}},\"comment\":{}}],[\"sessionstore\",{\"_index\":14,\"name\":{\"25\":{}},\"comment\":{}}],[\"sessionstorepayload\",{\"_index\":15,\"name\":{\"26\":{}},\"comment\":{}}],[\"status\",{\"_index\":21,\"name\":{\"32\":{},\"45\":{},\"51\":{},\"58\":{},\"65\":{},\"72\":{},\"79\":{}},\"comment\":{}}],[\"updatesession\",{\"_index\":2,\"name\":{\"2\":{},\"16\":{},\"109\":{}},\"comment\":{}}],[\"user\",{\"_index\":46,\"name\":{\"115\":{}},\"comment\":{}}],[\"withapiauthrequired\",{\"_index\":8,\"name\":{\"8\":{},\"18\":{},\"103\":{}},\"comment\":{}}],[\"withpageauthrequired\",{\"_index\":9,\"name\":{\"9\":{},\"19\":{},\"105\":{}},\"comment\":{}}],[\"withpageauthrequiredoptions\",{\"_index\":41,\"name\":{\"97\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 000000000..2d02570d0 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1280 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-ts: #db1373; + --light-color-ts-interface: #139d2c; + --light-color-ts-enum: #9c891a; + --light-color-ts-class: #2484e5; + --light-color-ts-function: #572be7; + --light-color-ts-namespace: #b111c9; + --light-color-ts-private: #707070; + --light-color-ts-variable: #4d68ff; + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-ts: #ff6492; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-class: #61b0ff; + --dark-color-ts-function: #9772ff; + --dark-color-ts-namespace: #e14dff; + --dark-color-ts-private: #e2e2e2; + --dark-color-ts-variable: #4d68ff; + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } +} +@media (min-width: 1200px) { + .container { + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; + } +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + display: flex; + justify-content: space-between; + position: relative; + margin: 0 auto; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 2rem 1rem; +} + +.col-4 { + flex: 0 0 25%; +} +.col-8 { + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + padding: 10px; + border: 0.1em solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (max-width: 1024px) { + html .col-content { + float: none; + max-width: 100%; + width: 100%; + padding-top: 3rem; + } + html .col-menu { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + align-items: center; + grid-template-rows: auto 1fr; + grid-gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel a.tsd-parent-kind-module { + color: var(--color-ts); +} +.tsd-index-panel a.tsd-parent-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-parent-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-parent-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-index-panel a.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-index-panel a.tsd-is-private { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation a { + display: block; + margin: 0.4rem 0; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; +} +.tsd-navigation.primary a { + padding: 0.75rem 0.5rem; + margin: 0; +} +.tsd-navigation.primary ul li a { + margin-left: 0.5rem; +} +.tsd-navigation.primary ul li li a { + margin-left: 1.5rem; +} +.tsd-navigation.primary ul li li li a { + margin-left: 2.5rem; +} +.tsd-navigation.primary ul li li li li a { + margin-left: 3.5rem; +} +.tsd-navigation.primary ul li li li li li a { + margin-left: 4.5rem; +} +.tsd-navigation.primary ul li li li li li li a { + margin-left: 5.5rem; +} +.tsd-navigation.primary li.current > a { + border-left: 0.15rem var(--color-text) solid; +} +.tsd-navigation.primary li.selected > a { + font-weight: bold; + border-left: 0.2rem var(--color-text) solid; +} +.tsd-navigation.primary ul li a:hover { + border-left: 0.2rem var(--color-text-aside) solid; +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 0; +} +.tsd-navigation.secondary ul li li a { + padding-left: 1.1rem; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 2.2rem; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 3.3rem; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 4.4rem; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 5.5rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + margin: 0.25rem 0; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; +} +.tsd-accordion-summary > h1, +.tsd-accordion-summary > h2, +.tsd-accordion-summary > h3, +.tsd-accordion-summary > h4, +.tsd-accordion-summary > h5 { + display: inline-flex; + align-items: center; + vertical-align: middle; + margin-bottom: 0; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; +} +.tsd-accordion-summary { + display: block; + cursor: pointer; +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; +} +.tsd-index-accordion .tsd-accordion-summary svg { + margin-right: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +@media (min-width: 1024px) { + .col-content { + margin: 2rem auto; + } + + .menu-sticky-wrap { + position: sticky; + height: calc(100vh - 2rem); + top: 4rem; + right: 0; + padding: 0 1.5rem; + padding-top: 1rem; + margin-top: 3rem; + transition: 0.3s ease-in-out; + transition-property: top, padding-top, padding, height; + overflow-y: auto; + } + .col-menu { + border-left: 1px solid var(--color-accent); + } + .col-menu--hide { + top: 1rem; + } + .col-menu .tsd-navigation:not(:last-child) { + padding-bottom: 1.75rem; + } +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 1024px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/docs/classes/AccessTokenError.html b/docs/classes/AccessTokenError.html new file mode 100644 index 000000000..e3a7a05f1 --- /dev/null +++ b/docs/classes/AccessTokenError.html @@ -0,0 +1,142 @@ +AccessTokenError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class AccessTokenError

+
+

The error thrown by GetAccessToken.

+ +

See

    +
  • the code property contains a machine-readable error code that +remains stable within a major version of the SDK. You should rely on this error code to handle +errors. In contrast, the error message is not part of the API and can change anytime. Do not +parse or otherwise rely on the error message to handle errors.
    • +
  • AccessTokenErrorCode for the list of all possible error codes.
    • +
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/AuthError.html b/docs/classes/AuthError.html new file mode 100644 index 000000000..a96fb0060 --- /dev/null +++ b/docs/classes/AuthError.html @@ -0,0 +1,136 @@ +AuthError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class AuthErrorAbstract

+
+

The base class for all SDK errors.

+

Because part of the error message can come from the OpenID Connect error query parameter we +do some basic escaping which makes sure the default error handler is safe from XSS.

+

IMPORTANT If you write your own error handler, you should not render the error +without using a templating engine that will properly escape it for other HTML contexts first.

+

Note that the error message of the underlying error is not escaped +in any way, so do not render it without escaping it first!

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      options: AuthErrorOptions
    +

    Returns AuthError

+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/CallbackHandlerError.html b/docs/classes/CallbackHandlerError.html new file mode 100644 index 000000000..176f8e98c --- /dev/null +++ b/docs/classes/CallbackHandlerError.html @@ -0,0 +1,151 @@ +CallbackHandlerError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class CallbackHandlerError

+
+

The error thrown by the callback API route handler. It extends HandlerError.

+

Because part of the error message can come from the OpenID Connect error query parameter we +do some basic escaping which makes sure the default error handler is safe from XSS.

+

IMPORTANT If you write your own error handler, you should not render the error message +without using a templating engine that will properly escape it for other HTML contexts first.

+ +

See

    +
  • the cause property contains the underlying error. +IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body. +You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.
    • +
  • the status property contains the HTTP status code of the error, +if any.
    • +
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +code +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+

Static Readonly code

+
code: string = 'ERR_CALLBACK_HANDLER_FAILURE'
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/HandlerError.html b/docs/classes/HandlerError.html new file mode 100644 index 000000000..a557cad82 --- /dev/null +++ b/docs/classes/HandlerError.html @@ -0,0 +1,149 @@ +HandlerError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class HandlerError

+
+

The base class for errors thrown by API route handlers. It extends AuthError.

+

Because part of the error message can come from the OpenID Connect error query parameter we +do some basic escaping which makes sure the default error handler is safe from XSS.

+

IMPORTANT If you write your own error handler, you should not render the error message +without using a templating engine that will properly escape it for other HTML contexts first.

+ +

See

    +
  • the cause property contains the underlying error. +IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body. +You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.
    • +
  • the status property contains the HTTP status code of the error, +if any.
    • +
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/LoginHandlerError.html b/docs/classes/LoginHandlerError.html new file mode 100644 index 000000000..dc37fa819 --- /dev/null +++ b/docs/classes/LoginHandlerError.html @@ -0,0 +1,139 @@ +LoginHandlerError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class LoginHandlerError

+
+

The error thrown by the login API route handler. It extends HandlerError.

+ +

See

the cause property contains the underlying error.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +code +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+

Static Readonly code

+
code: string = 'ERR_LOGIN_HANDLER_FAILURE'
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/LogoutHandlerError.html b/docs/classes/LogoutHandlerError.html new file mode 100644 index 000000000..41846f569 --- /dev/null +++ b/docs/classes/LogoutHandlerError.html @@ -0,0 +1,139 @@ +LogoutHandlerError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class LogoutHandlerError

+
+

The error thrown by the logout API route handler. It extends HandlerError.

+ +

See

the cause property contains the underlying error.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +code +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+

Static Readonly code

+
code: string = 'ERR_LOGOUT_HANDLER_FAILURE'
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/ProfileHandlerError.html b/docs/classes/ProfileHandlerError.html new file mode 100644 index 000000000..c119dbe14 --- /dev/null +++ b/docs/classes/ProfileHandlerError.html @@ -0,0 +1,139 @@ +ProfileHandlerError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class ProfileHandlerError

+
+

The error thrown by the profile API route handler. It extends HandlerError.

+ +

See

the cause property contains the underlying error.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +code +name +status? +code +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: Error
+

The underlying error, if any.

+

IMPORTANT When this error is from the Identity Provider ({@Link IdentityProviderError}) it can contain user +input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

+

You should not render this error without using a templating engine that will properly escape it for other +HTML contexts first.

+
+
+

Readonly code

+
code: string
+

A machine-readable error code that remains stable within a major version of the SDK. You +should rely on this error code to handle errors. In contrast, the error message is not part of +the API and can change anytime. Do not parse or otherwise rely on the error message to +handle errors.

+
+
+

Readonly name

+
name: string
+

The error class name.

+
+
+

Optional Readonly status

+
status?: number
+

The HTTP status code, if any.

+
+
+

Static Readonly code

+
code: string = 'ERR_PROFILE_HANDLER_FAILURE'
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/Session.html b/docs/classes/Session.html new file mode 100644 index 000000000..6fab492ca --- /dev/null +++ b/docs/classes/Session.html @@ -0,0 +1,139 @@ +Session | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Class Session

+
+

The user's session.

+
+
+

Hierarchy

+
    +
  • Session
+
+

Indexable

+
[key: string]: any
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessToken? +accessTokenExpiresAt? +accessTokenScope? +idToken? +refreshToken? +user +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional accessToken

+
accessToken?: string
+

The access token.

+
+
+

Optional accessTokenExpiresAt

+
accessTokenExpiresAt?: number
+

The expiration of the access token.

+
+
+

Optional accessTokenScope

+
accessTokenScope?: string
+

The access token scopes.

+
+
+

Optional idToken

+
idToken?: string
+

The ID token.

+
+
+

Optional refreshToken

+
refreshToken?: string
+

The refresh token, which is used to request a new access token.

+

IMPORTANT You need to request the offline_access scope on login to get a refresh token +from Auth0.

+
+
+

user

+
user: Claims
+

Any of the claims from the id_token.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/client_use_user.requesterror.html b/docs/classes/client_use_user.requesterror.html deleted file mode 100644 index 87c805b32..000000000 --- a/docs/classes/client_use_user.requesterror.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - RequestError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class RequestError

-
-
-
-
-
-
-
-
-
-

The error thrown by the default {@link UserFetcher}.

-
-

The status property contains the status code of the response. It is 0 when the request - fails, for example due to being offline.

-

This error is not thrown when the status code of the response is 204, because that means the - user is not authenticated.

-
-
-
-

Hierarchy

-
    -
  • - Error -
      -
    • - RequestError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

status

-
status: number
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/index.applicationerror.html b/docs/classes/index.applicationerror.html deleted file mode 100644 index ef2c7c76c..000000000 --- a/docs/classes/index.applicationerror.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - ApplicationError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class ApplicationError

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - EscapedError -
      -
    • - ApplicationError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -
    -
    -

    WARNING The message can contain user input and is only escaped using basic escaping for putting untrusted data - directly into the HTML body

    -
    -
    -

    Parameters

    -
      -
    • -
      rpError: RPError
      -
      • -
    -

    Returns ApplicationError

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/index.identityprovidererror.html b/docs/classes/index.identityprovidererror.html deleted file mode 100644 index d7a753c19..000000000 --- a/docs/classes/index.identityprovidererror.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - IdentityProviderError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class IdentityProviderError

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - EscapedError -
      -
    • - IdentityProviderError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- -
    -
  • - -
    -
    -

    WARNING The message can contain user input and is only escaped using basic escaping for putting untrusted data - directly into the HTML body

    -
    -
    -

    Parameters

    -
      -
    • -
      rpError: OPError
      -
      • -
    -

    Returns IdentityProviderError

    -
    • -
-
-
-
-

Properties

-
- -

Optional error

-
error: string
- -
-
-

The 'error' parameter from the AS response - WARNING This can contain user input and is only escaped using basic escaping for putting untrusted data - directly into the HTML body

-
-
-
-
- -

Optional errorDescription

-
errorDescription: string
- -
-
-

The 'error_description' parameter from the AS response. - WARNING This can contain user input and is only escaped using basic escaping for putting untrusted data - directly into the HTML body

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/index.missingstatecookieerror.html b/docs/classes/index.missingstatecookieerror.html deleted file mode 100644 index 48b106182..000000000 --- a/docs/classes/index.missingstatecookieerror.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - MissingStateCookieError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class MissingStateCookieError

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Error -
      -
    • - MissingStateCookieError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Static message

-
message: string = 'Missing state cookie from login request (check login URL, callback URL and cookie config).'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/index.missingstateparamerror.html b/docs/classes/index.missingstateparamerror.html deleted file mode 100644 index 1a8730227..000000000 --- a/docs/classes/index.missingstateparamerror.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - MissingStateParamError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class MissingStateParamError

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Error -
      -
    • - MissingStateParamError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Static message

-
message: string = 'Missing state parameter in Authorization Response.'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/index.sessioncache.html b/docs/classes/index.sessioncache.html deleted file mode 100644 index b4ce36205..000000000 --- a/docs/classes/index.sessioncache.html +++ /dev/null @@ -1,528 +0,0 @@ - - - - - - SessionCache | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class SessionCache<Req, Res>

-
-
-
-
-
-
-
-

Type parameters

-
    -
  • -

    Req: object = IncomingMessage | NextApiRequest

    -
    • -
  • -

    Res: object = ServerResponse | NextApiResponse

    -
    • -
-
-
-

Hierarchy

-
    -
  • - SessionCache -
    • -
-
-
-

Implements

-
    -
  • ISessionCache<Req, Res, default>
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new SessionCache<Req, Res>(config: Config, sessionStore: AbstractSession<Req, Res, default>): SessionCache<Req, Res>
    • -
-
    -
  • - -

    Type parameters

    -
      -
    • -

      Req: object = IncomingMessage | NextApiRequest

      -
      • -
    • -

      Res: object = ServerResponse | NextApiResponse<any>

      -
      • -
    -

    Parameters

    -
      -
    • -
      config: Config
      -
      • -
    • -
      sessionStore: AbstractSession<Req, Res, default>
      -
      • -
    -

    Returns SessionCache<Req, Res>

    -
    • -
-
-
-
-

Methods

-
- -

create

-
    -
  • create(req: Req, res: Res, session: default): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    • -
      session: default
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

delete

-
    -
  • delete(req: Req, res: Res): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

fromTokenSet

-
    -
  • fromTokenSet(tokenSet: TokenSet): default
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      tokenSet: TokenSet
      -
      • -
    -

    Returns default

    -
    • -
-
-
- -

get

-
    -
  • get(req: Req, res: Res): Promise<undefined | null | default>
    • -
- -
-
- -

getIdToken

-
    -
  • getIdToken(req: Req, res: Res): Promise<undefined | string>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    -

    Returns Promise<undefined | string>

    -
    • -
-
-
- -

isAuthenticated

-
    -
  • isAuthenticated(req: Req, res: Res): Promise<boolean>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    -

    Returns Promise<boolean>

    -
    • -
-
-
- -

save

-
    -
  • save(req: Req, res: Res): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

set

-
    -
  • set(req: Req, res: Res, session: null | default): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: Req
      -
      • -
    • -
      res: Res
      -
      • -
    • -
      session: null | default
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Method
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html deleted file mode 100644 index a17193a34..000000000 --- a/docs/classes/session_session.default.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - - default | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class default

-
-
-
-
-
-
-
-
-
-

The user's session.

-
-
-
-
-

Hierarchy

-
    -
  • - default -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

The user's session.

-
-
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional accessToken

-
accessToken: string
- -
-
-

The access token.

-
-
-
-
- -

Optional accessTokenExpiresAt

-
accessTokenExpiresAt: number
- -
-
-

The expiration of the access token.

-
-
-
-
- -

Optional accessTokenScope

-
accessTokenScope: string
- -
-
-

The access token scopes.

-
-
-
-
- -

Optional idToken

-
idToken: string
- -
-
-

The ID token.

-
-
-
-
- -

Optional refreshToken

-
refreshToken: string
- -
-
-

The refresh token, which is used to request a new access token.

-
-

IMPORTANT You need to request the offline_access scope on login to get a refresh token - from Auth0.

-
-
-
- -

user

-
user: Claims
- -
-
-

Any of the claims from the id_token.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.accesstokenerror.html b/docs/classes/utils_errors.accesstokenerror.html deleted file mode 100644 index 57a62b178..000000000 --- a/docs/classes/utils_errors.accesstokenerror.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - AccessTokenError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class AccessTokenError

-
-
-
-
-
-
-
-
-
-

The error thrown by GetAccessToken.

-
-
-
see
-

the code property contains a machine-readable error code that - remains stable within a major version of the SDK. You should rely on this error code to handle - errors. In contrast, the error message is not part of the API and can change anytime. Do not - parse or otherwise rely on the error message to handle errors.

-
-
see
-

AccessTokenErrorCode for the list of all possible error codes.

-
-
-
-
-
-

Hierarchy

-
    -
  • - AuthError -
      -
    • - AccessTokenError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.autherror.html b/docs/classes/utils_errors.autherror.html deleted file mode 100644 index 54943b4b2..000000000 --- a/docs/classes/utils_errors.autherror.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - - AuthError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class AuthError

-
-
-
-
-
-
-
-
-
-

The base class for all SDK errors.

-
-

Because part of the error message can come from the OpenID Connect error query parameter we - do some basic escaping which makes sure the default error handler is safe from XSS.

-

IMPORTANT If you write your own error handler, you should not render the error - without using a templating engine that will properly escape it for other HTML contexts first.

-

Note that the error message of the underlying error is not escaped - in any way, so do not render it without escaping it first!

-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new AuthError(options: AuthErrorOptions): AuthError
    • -
- -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.callbackhandlererror.html b/docs/classes/utils_errors.callbackhandlererror.html deleted file mode 100644 index e6af58b35..000000000 --- a/docs/classes/utils_errors.callbackhandlererror.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - CallbackHandlerError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class CallbackHandlerError

-
-
-
-
-
-
-
-
-
-

The error thrown by the callback API route handler. It extends HandlerError.

-
-

Because part of the error message can come from the OpenID Connect error query parameter we - do some basic escaping which makes sure the default error handler is safe from XSS.

-

IMPORTANT If you write your own error handler, you should not render the error message - without using a templating engine that will properly escape it for other HTML contexts first.

-
-
see
-

the cause property contains the underlying error. - IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body. - You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
see
-

the status property contains the HTTP status code of the error, - if any.

-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
- -

Static Readonly code

-
code: string = 'ERR_CALLBACK_HANDLER_FAILURE'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.handlererror.html b/docs/classes/utils_errors.handlererror.html deleted file mode 100644 index ace082799..000000000 --- a/docs/classes/utils_errors.handlererror.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - HandlerError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class HandlerError

-
-
-
-
-
-
-
-
-
-

The base class for errors thrown by API route handlers. It extends AuthError.

-
-

Because part of the error message can come from the OpenID Connect error query parameter we - do some basic escaping which makes sure the default error handler is safe from XSS.

-

IMPORTANT If you write your own error handler, you should not render the error message - without using a templating engine that will properly escape it for other HTML contexts first.

-
-
see
-

the cause property contains the underlying error. - IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body. - You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
see
-

the status property contains the HTTP status code of the error, - if any.

-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new HandlerError(options: HandlerErrorOptions): HandlerError
    • -
- -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.loginhandlererror.html b/docs/classes/utils_errors.loginhandlererror.html deleted file mode 100644 index 2b3559e7f..000000000 --- a/docs/classes/utils_errors.loginhandlererror.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - LoginHandlerError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class LoginHandlerError

-
-
-
-
-
-
-
-
-
-

The error thrown by the login API route handler. It extends HandlerError.

-
-
-
see
-

the cause property contains the underlying error.

-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
- -

Static Readonly code

-
code: string = 'ERR_LOGIN_HANDLER_FAILURE'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.logouthandlererror.html b/docs/classes/utils_errors.logouthandlererror.html deleted file mode 100644 index 6fca2bd89..000000000 --- a/docs/classes/utils_errors.logouthandlererror.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - LogoutHandlerError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class LogoutHandlerError

-
-
-
-
-
-
-
-
-
-

The error thrown by the logout API route handler. It extends HandlerError.

-
-
-
see
-

the cause property contains the underlying error.

-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
- -

Static Readonly code

-
code: string = 'ERR_LOGOUT_HANDLER_FAILURE'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/utils_errors.profilehandlererror.html b/docs/classes/utils_errors.profilehandlererror.html deleted file mode 100644 index eb0a1e513..000000000 --- a/docs/classes/utils_errors.profilehandlererror.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - ProfileHandlerError | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Class ProfileHandlerError

-
-
-
-
-
-
-
-
-
-

The error thrown by the profile API route handler. It extends HandlerError.

-
-
-
see
-

the cause property contains the underlying error.

-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional Readonly cause

-
cause: Error
- -
-
-

The underlying error, if any.

-
-

IMPORTANT When this error is from the Identity Provider (IdentityProviderError) it can contain user - input and is only escaped using basic escaping for putting untrusted data directly into the HTML body.

-

You should not render this error without using a templating engine that will properly escape it for other - HTML contexts first.

-
-
-
- -

Readonly code

-
code: string
- -
-
-

A machine-readable error code that remains stable within a major version of the SDK. You - should rely on this error code to handle errors. In contrast, the error message is not part of - the API and can change anytime. Do not parse or otherwise rely on the error message to - handle errors.

-
-
-
-
- -

Readonly name

-
name: string
- -
-
-

The error class name.

-
-
-
-
- -

Optional Readonly status

-
status: number
- -
-
-

The HTTP status code, if any.

-
-
-
-
- -

Static Readonly code

-
code: string = 'ERR_PROFILE_HANDLER_FAILURE'
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
    -
  • Static property
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/enums/AccessTokenErrorCode.html b/docs/enums/AccessTokenErrorCode.html new file mode 100644 index 000000000..8e0451073 --- /dev/null +++ b/docs/enums/AccessTokenErrorCode.html @@ -0,0 +1,98 @@ +AccessTokenErrorCode | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Enumeration AccessTokenErrorCode

+
+

Error codes for AccessTokenError.

+
+
+
+
+ +
+
+

Enumeration Members

+
EXPIRED_ACCESS_TOKEN +FAILED_REFRESH_GRANT +INSUFFICIENT_SCOPE +MISSING_ACCESS_TOKEN +MISSING_REFRESH_TOKEN +MISSING_SESSION +
+
+

Enumeration Members

+
+

EXPIRED_ACCESS_TOKEN

+
EXPIRED_ACCESS_TOKEN: "ERR_EXPIRED_ACCESS_TOKEN"
+
+

FAILED_REFRESH_GRANT

+
FAILED_REFRESH_GRANT: "ERR_FAILED_REFRESH_GRANT"
+
+

INSUFFICIENT_SCOPE

+
INSUFFICIENT_SCOPE: "ERR_INSUFFICIENT_SCOPE"
+
+

MISSING_ACCESS_TOKEN

+
MISSING_ACCESS_TOKEN: "ERR_MISSING_ACCESS_TOKEN"
+
+

MISSING_REFRESH_TOKEN

+
MISSING_REFRESH_TOKEN: "ERR_MISSING_REFRESH_TOKEN"
+
+

MISSING_SESSION

+
MISSING_SESSION: "ERR_MISSING_SESSION"
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/enums/utils_errors.accesstokenerrorcode.html b/docs/enums/utils_errors.accesstokenerrorcode.html deleted file mode 100644 index a8a3f15fd..000000000 --- a/docs/enums/utils_errors.accesstokenerrorcode.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - AccessTokenErrorCode | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Enumeration AccessTokenErrorCode

-
-
-
-
-
-
-
-
-
-

Error codes for AccessTokenError.

-
-
-
-
-

Index

-
-
-
-

Enumeration members

- -
-
-
-
-
-

Enumeration members

-
- -

EXPIRED_ACCESS_TOKEN

-
EXPIRED_ACCESS_TOKEN: = "ERR_EXPIRED_ACCESS_TOKEN"
- -
-
- -

FAILED_REFRESH_GRANT

-
FAILED_REFRESH_GRANT: = "ERR_FAILED_REFRESH_GRANT"
- -
-
- -

INSUFFICIENT_SCOPE

-
INSUFFICIENT_SCOPE: = "ERR_INSUFFICIENT_SCOPE"
- -
-
- -

MISSING_ACCESS_TOKEN

-
MISSING_ACCESS_TOKEN: = "ERR_MISSING_ACCESS_TOKEN"
- -
-
- -

MISSING_REFRESH_TOKEN

-
MISSING_REFRESH_TOKEN: = "ERR_MISSING_REFRESH_TOKEN"
- -
-
- -

MISSING_SESSION

-
MISSING_SESSION: = "ERR_MISSING_SESSION"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/functions/_initAuth.html b/docs/functions/_initAuth.html new file mode 100644 index 000000000..6eb5c17dc --- /dev/null +++ b/docs/functions/_initAuth.html @@ -0,0 +1,102 @@ +_initAuth | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function _initAuth

+
+
    +
  • _initAuth(params?: DeepPartial<BaseConfig & NextConfig>): Auth0Server & {
        sessionCache: default<IncomingMessage | NextApiRequest, ServerResponse<IncomingMessage> | NextApiResponse<any>>;
    }
    • +
  • +
    +

    Parameters

    +
      +
    • +
      Optional params: DeepPartial<BaseConfig & NextConfig>
    +

    Returns Auth0Server & {
        sessionCache: default<IncomingMessage | NextApiRequest, ServerResponse<IncomingMessage> | NextApiResponse<any>>;
    }

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/getAccessToken-1.html b/docs/functions/getAccessToken-1.html new file mode 100644 index 000000000..b7e01d2f8 --- /dev/null +++ b/docs/functions/getAccessToken-1.html @@ -0,0 +1,110 @@ +getAccessToken | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function getAccessToken

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/getSession-1.html b/docs/functions/getSession-1.html new file mode 100644 index 000000000..cc0f6cc28 --- /dev/null +++ b/docs/functions/getSession-1.html @@ -0,0 +1,106 @@ +getSession | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function getSession

+
+
    + +
  • +

    Get the user's session from the request.

    +
    +
    +

    Parameters

    +
      +
    • +
      req: IncomingMessage | NextApiRequest
      • +
    • +
      res: ServerResponse<IncomingMessage> | NextApiResponse<any>
    +

    Returns Promise<undefined | null | Session>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/handleAuth-1.html b/docs/functions/handleAuth-1.html new file mode 100644 index 000000000..2ee3d7424 --- /dev/null +++ b/docs/functions/handleAuth-1.html @@ -0,0 +1,116 @@ +handleAuth | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function handleAuth

+
+
    + +
  • +

    The main way to use the server SDK.

    +

    Simply set the environment variables per ConfigParameters then create the file +pages/api/auth/[...auth0].js. For example:

    +
    // pages/api/auth/[...auth0].js
    import { handleAuth } from '@auth0/nextjs-auth0';

    export default handleAuth();
+
    +

    This will create 5 handlers for the following urls:

    +
      +
    • /api/auth/login: log the user in to your app by redirecting them to your identity provider.
      • +
    • /api/auth/callback: The page that your identity provider will redirect the user back to on login.
      • +
    • /api/auth/logout: log the user out of your app.
      • +
    • /api/auth/me: View the user profile JSON (used by the UseUser hook).
      • +
    • /api/auth/unauthorized: Returns a 401 for use by WithMiddlewareAuthRequired when protecting API routes.
      • +
    +
    +
    +

    Parameters

    +
    +

    Returns NextApiHandler<any>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/handleCallback-1.html b/docs/functions/handleCallback-1.html new file mode 100644 index 000000000..898f2fe88 --- /dev/null +++ b/docs/functions/handleCallback-1.html @@ -0,0 +1,126 @@ +handleCallback | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function handleCallback

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/handleLogin-1.html b/docs/functions/handleLogin-1.html new file mode 100644 index 000000000..f04b3b1a3 --- /dev/null +++ b/docs/functions/handleLogin-1.html @@ -0,0 +1,126 @@ +handleLogin | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function handleLogin

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      req: NextApiRequest
      • +
    • +
      res: NextApiResponse<any>
      • +
    • +
      Optional options: LoginOptions
    +

    Returns Promise<void>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      provider: LoginOptionsProvider
    +

    Returns LoginHandler

    • + +
  • +
    +

    Parameters

    +
    +

    Returns LoginHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/handleLogout-1.html b/docs/functions/handleLogout-1.html new file mode 100644 index 000000000..2cff36221 --- /dev/null +++ b/docs/functions/handleLogout-1.html @@ -0,0 +1,126 @@ +handleLogout | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function handleLogout

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      req: NextApiRequest
      • +
    • +
      res: NextApiResponse<any>
      • +
    • +
      Optional options: LogoutOptions
    +

    Returns Promise<void>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      provider: LogoutOptionsProvider
    +

    Returns LogoutHandler

    • + +
  • +
    +

    Parameters

    +
    +

    Returns LogoutHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/handleProfile-1.html b/docs/functions/handleProfile-1.html new file mode 100644 index 000000000..ddc8e0959 --- /dev/null +++ b/docs/functions/handleProfile-1.html @@ -0,0 +1,126 @@ +handleProfile | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function handleProfile

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      req: NextApiRequest
      • +
    • +
      res: NextApiResponse<any>
      • +
    • +
      Optional options: ProfileOptions
    +

    Returns Promise<void>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      provider: ProfileOptionsProvider
    +

    Returns ProfileHandler

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ProfileHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/initAuth0-1.html b/docs/functions/initAuth0-1.html new file mode 100644 index 000000000..5e8698e4a --- /dev/null +++ b/docs/functions/initAuth0-1.html @@ -0,0 +1,105 @@ +initAuth0 | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function initAuth0

+
+
    + +
  • +

    Initialise your own instance of the SDK.

    +

    See ConfigParameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional params: DeepPartial<BaseConfig & NextConfig>
    +

    Returns Auth0Server

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/updateSession-1.html b/docs/functions/updateSession-1.html new file mode 100644 index 000000000..cc90bf93d --- /dev/null +++ b/docs/functions/updateSession-1.html @@ -0,0 +1,112 @@ +updateSession | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function updateSession

+
+
    + +
  • +

    Update the session object. The provided session object will replace the existing session.

    +

    Note you can't use this method to login or logout - you should use the login and logout handlers for this. +If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

    +
    // pages/api/update-user.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function updateSession(req, res) {
      if (req.method === 'PUT') {
        const session = await getSession(req, res);
        updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
        res.json({ success: true });
      }
    };
+
    +
    +
    +

    Parameters

    +
      +
    • +
      req: IncomingMessage | NextApiRequest
      • +
    • +
      res: ServerResponse<IncomingMessage> | NextApiResponse<any>
      • +
    • +
      user: Session
    +

    Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/withApiAuthRequired-1.html b/docs/functions/withApiAuthRequired-1.html new file mode 100644 index 000000000..982b5b837 --- /dev/null +++ b/docs/functions/withApiAuthRequired-1.html @@ -0,0 +1,108 @@ +withApiAuthRequired | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function withApiAuthRequired

+
+
    + +
  • +

    Wrap an API route to check that the user has a valid session. If they're not logged in the +handler will return a 401 Unauthorized.

    +
    // pages/api/protected-route.js
    import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';

    export default withApiAuthRequired(function ProtectedRoute(req, res) {
      const session = getSession(req, res);
      ...
    });
+
    +

    If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

    +
    +
    +

    Parameters

    +
      +
    • +
      apiRoute: NextApiHandler<any>
    +

    Returns NextApiHandler<any>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/withPageAuthRequired-1.html b/docs/functions/withPageAuthRequired-1.html new file mode 100644 index 000000000..218c99920 --- /dev/null +++ b/docs/functions/withPageAuthRequired-1.html @@ -0,0 +1,116 @@ +withPageAuthRequired | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Function withPageAuthRequired

+
+
    + +
  • +

    Wrap your getServerSideProps with this method to make sure the user is authenticated before +visiting the page.

    +
    // pages/protected-page.js
    import { withPageAuthRequired } from '@auth0/nextjs-auth0';

    export default function ProtectedPage() {
      return <div>Protected content</div>;
    }

    export const getServerSideProps = withPageAuthRequired();
+
    +

    If the user visits /protected-page without a valid session, it will redirect the user to the +login page. Then they will be returned to /protected-page after login.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      P extends {
          [key: string]: any;
      } = {
          [key: string]: any;
      }

      • +
    • +

      Q extends ParsedUrlQuery<Q> = ParsedUrlQuery

    +
    +

    Parameters

    +
    +

    Returns PageRoute<P, Q>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 736242d2e..61bea0042 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,208 +1,162 @@ - - - - - - @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
-

@auth0/nextjs-auth0

-
-
-
+@auth0/nextjs-auth0
+
+ +
-
-
-
-

Index

-
-
-
-

Modules

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file +
+
+

@auth0/nextjs-auth0

+
+
+

Index

+
+

Enumerations - Server

+
AccessTokenErrorCode +
+
+

Classes - Server

+
AccessTokenError +AuthError +CallbackHandlerError +HandlerError +LoginHandlerError +LogoutHandlerError +ProfileHandlerError +Session +
+
+

Interfaces - Server

+
AccessTokenRequest +Auth0Server +CallbackOptions +Claims +GetAccessTokenResult +LoginOptions +LogoutOptions +
+
+

Type Aliases - Other

+
AfterRefetch +SessionStore +SessionStorePayload +
+
+

Type Aliases - Server

+
AfterCallback +ConfigParameters +GetAccessToken +GetLoginState +GetServerSidePropsResultWithSession +GetSession +HandleAuth +HandleCallback +HandleLogin +HandleLogout +HandleProfile +Handlers +InitAuth0 +OnError +PageRoute +ProfileOptions +UpdateSession +WithApiAuthRequired +WithPageAuthRequired +WithPageAuthRequiredOptions +
+
+

Functions - Other

+
_initAuth +handleCallback +handleLogin +handleLogout +handleProfile +
+
+

Functions - Server

+
getAccessToken +getSession +handleAuth +initAuth0 +updateSession +withApiAuthRequired +withPageAuthRequired +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/AccessTokenRequest.html b/docs/interfaces/AccessTokenRequest.html new file mode 100644 index 000000000..78c8f267d --- /dev/null +++ b/docs/interfaces/AccessTokenRequest.html @@ -0,0 +1,107 @@ +AccessTokenRequest | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface AccessTokenRequest

+
+

Custom options to get an access token.

+
+
+

Hierarchy

+
    +
  • AccessTokenRequest
+
+
+
+ +
+
+

Properties

+
afterRefresh? +authorizationParams? +refresh? +scopes? +
+
+

Properties

+
+

Optional afterRefresh

+
afterRefresh?: AfterRefresh
+

When the access token request refreshes the tokens using the refresh grant the session is updated with new tokens. +Use this to modify the session after it is refreshed. +Usually used to keep updates in sync with the AfterCallback hook.

+ +

See

also the AfterRefetch hook.

+ +

Example

Modify the session after refresh

+
// pages/api/my-handler.js
import { getAccessToken } from '@auth0/nextjs-auth0';

const afterRefresh = (req, res, session) => {
  session.user.customProperty = 'foo';
  delete session.idToken;
  return session;
};

export default async function MyHandler(req, res) {
  const accessToken = await getAccessToken(req, res, {
    refresh: true,
    afterRefresh,
  });
};
+
+
+
+

Optional authorizationParams

+
authorizationParams?: Partial<AuthorizationParameters>
+

This is useful for sending custom query parameters in the body of the refresh grant request for use in rules.

+
+
+

Optional refresh

+
refresh?: boolean
+

If set to true, a new access token will be requested with the refresh token grant, regardless of whether +the access token has expired or not.

+

IMPORTANT You need to request the offline_access scope on login to get a refresh token +from Auth0.

+
+
+

Optional scopes

+
scopes?: string[]
+

A list of desired scopes for your access token.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/Auth0Server.html b/docs/interfaces/Auth0Server.html new file mode 100644 index 000000000..180b7660c --- /dev/null +++ b/docs/interfaces/Auth0Server.html @@ -0,0 +1,152 @@ +Auth0Server | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface Auth0Server

+
+

The SDK server instance.

+

This is created for you when you use the named exports, or you can create your own using InitAuth0.

+

See ConfigParameters for more info.

+
+
+

Hierarchy

+
    +
  • Auth0Server
+
+
+
+ +
+
+

Properties

+
getAccessToken +getSession +handleAuth +handleCallback +handleLogin +handleLogout +handleProfile +updateSession +withApiAuthRequired +withPageAuthRequired +
+
+

Properties

+
+

getAccessToken

+
getAccessToken: GetAccessToken
+

Access token getter.

+
+
+

getSession

+
getSession: GetSession
+

Session getter.

+
+
+

handleAuth

+
handleAuth: HandleAuth
+

Create the main handlers for your api routes.

+
+
+

handleCallback

+
handleCallback: HandleCallback
+

Callback handler which will complete the transaction and create a local session.

+
+
+

handleLogin

+
handleLogin: HandleLogin
+

Login handler which will redirect the user to Auth0.

+
+
+

handleLogout

+
handleLogout: HandleLogout
+

Logout handler which will clear the local session and the Auth0 session.

+
+
+

handleProfile

+
handleProfile: HandleProfile
+

Profile handler which return profile information about the user.

+
+
+

updateSession

+
updateSession: UpdateSession
+

Append properties to the user.

+
+
+

withApiAuthRequired

+
withApiAuthRequired: WithApiAuthRequired
+

Helper that adds auth to an API route.

+
+
+

withPageAuthRequired

+
withPageAuthRequired: WithPageAuthRequired
+

Helper that adds auth to a Page route.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/CallbackOptions.html b/docs/interfaces/CallbackOptions.html new file mode 100644 index 000000000..0509e7637 --- /dev/null +++ b/docs/interfaces/CallbackOptions.html @@ -0,0 +1,99 @@ +CallbackOptions | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface CallbackOptions

+
+

Options to customize the callback handler.

+ +

See

HandleCallback

+
+
+

Hierarchy

+
    +
  • CallbackOptions
+
+
+
+ +
+
+

Properties

+
afterCallback? +authorizationParams? +organization? +redirectUri? +
+
+

Properties

+
+

Optional afterCallback

+
afterCallback?: AfterCallback
+
+

Optional authorizationParams

+
authorizationParams?: Partial<AuthorizationParameters>
+

This is useful for sending custom query parameters in the body of the code exchange request +for use in Actions/Rules.

+
+
+

Optional organization

+
organization?: string
+

This is useful to specify instead of NextConfig.organization when your app has multiple +organizations, it should match authorizationParams.

+
+
+

Optional redirectUri

+
redirectUri?: string
+

This is useful to specify in addition to BaseConfig.baseURL when your app runs on multiple domains, +it should match LoginOptions.authorizationParams.redirect_uri.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/Claims.html b/docs/interfaces/Claims.html new file mode 100644 index 000000000..db4ebd3f2 --- /dev/null +++ b/docs/interfaces/Claims.html @@ -0,0 +1,102 @@ +Claims | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface Claims

+
+

Key-value store for the user's claims.

+
+
+

Hierarchy

+
    +
  • Claims
+
+

Indexable

+
[key: string]: any
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/GetAccessTokenResult.html b/docs/interfaces/GetAccessTokenResult.html new file mode 100644 index 000000000..06b19bd28 --- /dev/null +++ b/docs/interfaces/GetAccessTokenResult.html @@ -0,0 +1,69 @@ +GetAccessTokenResult | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface GetAccessTokenResult

+
+

Response from requesting an access token.

+
+
+

Hierarchy

+
    +
  • GetAccessTokenResult
+
+
+
+ +
+
+

Properties

+
accessToken? +
+
+

Properties

+
+

Optional accessToken

+
accessToken?: string
+

Access token returned from the token cache.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/LoginOptions.html b/docs/interfaces/LoginOptions.html new file mode 100644 index 000000000..5df0bd695 --- /dev/null +++ b/docs/interfaces/LoginOptions.html @@ -0,0 +1,89 @@ +LoginOptions | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface LoginOptions

+
+

Options to customize the login handler.

+ +

See

HandleLogin

+
+
+

Hierarchy

+
    +
  • LoginOptions
+
+
+
+ +
+
+

Properties

+
authorizationParams? +getLoginState? +returnTo? +
+
+

Properties

+
+

Optional authorizationParams

+
authorizationParams?: AuthorizationParams
+

Override the default BaseConfig.authorizationParams authorizationParams.

+
+
+

Optional getLoginState

+
getLoginState?: GetLoginState
+

Generate a unique state value for use during login transactions.

+
+
+

Optional returnTo

+
returnTo?: string
+

URL to return to after login. Overrides the default in BaseConfig.baseURL.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html new file mode 100644 index 000000000..68201b4af --- /dev/null +++ b/docs/interfaces/LogoutOptions.html @@ -0,0 +1,86 @@ +LogoutOptions | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Interface LogoutOptions

+
+

Options to customize the logout handler.

+ +

See

HandleLogout

+
+
+

Hierarchy

+
    +
  • LogoutOptions
+
+
+
+ +
+
+

Properties

+
logoutParams? +returnTo? +
+
+

Properties

+
+

Optional logoutParams

+
logoutParams?: {
    [key: string]: any;
}
+

Additional custom parameters to pass to the logout endpoint.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
+
+

Optional returnTo

+
returnTo?: string
+

URL to return to after logout. Overrides the default +in BaseConfig.routes.postLogoutRedirect routes.postLogoutRedirect.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/client_use_user.userprofile.html b/docs/interfaces/client_use_user.userprofile.html deleted file mode 100644 index 944eb1e06..000000000 --- a/docs/interfaces/client_use_user.userprofile.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - UserProfile | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface UserProfile

-
-
-
-
-
-
-
-
-
-

The user claims returned from the useUser hook.

-
-
-
-
-

Hierarchy

-
    -
  • - UserProfile -
    • -
-
-
-

Indexable

-
[key: string]: unknown
-
-
-

The user claims returned from the useUser hook.

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional email

-
email: null | string
- -
-
- -

Optional email_verified

-
email_verified: null | boolean
- -
-
- -

Optional name

-
name: null | string
- -
-
- -

Optional nickname

-
nickname: null | string
- -
-
- -

Optional org_id

-
org_id: null | string
- -
-
- -

Optional picture

-
picture: null | string
- -
-
- -

Optional sub

-
sub: null | string
- -
-
- -

Optional updated_at

-
updated_at: null | string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/client_with_page_auth_required.userprops.html b/docs/interfaces/client_with_page_auth_required.userprops.html deleted file mode 100644 index 99357de5f..000000000 --- a/docs/interfaces/client_with_page_auth_required.userprops.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - UserProps | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface UserProps

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - UserProps -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

user

-
user: UserProfile
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html b/docs/interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html deleted file mode 100644 index eec8a60bf..000000000 --- a/docs/interfaces/client_with_page_auth_required.withpageauthrequiredoptions.html +++ /dev/null @@ -1,334 +0,0 @@ - - - - - - WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface WithPageAuthRequiredOptions

-
-
-
-
-
-
-
-
-
-

Options to customize the withPageAuthRequired higher order component.

-
-
-
-
-

Hierarchy

-
    -
  • - WithPageAuthRequiredOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional onError

-
onError: (error: Error) => Element
- -
-
- 
withPageAuthRequired(Profile, {
-  onError: error => <div>Error: {error.message}</div>
-});
-
-
-

Render a fallback in case of error fetching the user from the profile API route.

-
-
-

Type declaration

-
    -
  • -
      -
    • (error: Error): Element
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        error: Error
        -
        • -
      -

      Returns Element

      -
      • -
    -
    • -
-
-
-
- -

Optional onRedirecting

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

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

-
-
-

Type declaration

-
    -
  • -
      -
    • (): Element
      • -
    -
      -
    • -

      Returns Element

      -
      • -
    -
    • -
-
-
-
- -

Optional returnTo

-
returnTo: string
- -
-
- 
withPageAuthRequired(Profile, {
-  returnTo: '/profile'
-});
-
-
-

Add a path to return the user to after login.

-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/config.authorizationparameters.html b/docs/interfaces/config.authorizationparameters.html deleted file mode 100644 index 0f3649daa..000000000 --- a/docs/interfaces/config.authorizationparameters.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - AuthorizationParameters | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface AuthorizationParameters

-
-
-
-
-
-
-
-
-
-

Authorization parameters that will be passed to the identity provider on login.

-
-

The library uses response_mode: 'query' and response_type: 'code' (with PKCE) by default.

-
-
-
-

Hierarchy

-
    -
  • - OidcAuthorizationParameters -
      -
    • - AuthorizationParameters -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

response_mode

-
response_mode: "query" | "form_post"
- -
-
- -

response_type

-
response_type: "id_token" | "code id_token" | "code"
- -
-
- -

scope

-
scope: string
- -
-
-

A space-separated list of scopes that will be requested during authentication. For example, - openid profile email offline_access. - Defaults to openid profile email.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/config.baseconfig.html b/docs/interfaces/config.baseconfig.html deleted file mode 100644 index c55bd9001..000000000 --- a/docs/interfaces/config.baseconfig.html +++ /dev/null @@ -1,657 +0,0 @@ - - - - - - BaseConfig | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface BaseConfig

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - BaseConfig -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

auth0Logout

-
auth0Logout: boolean
- -
-
-

Boolean value to enable Auth0's proprietary logout feature. - Since this SDK is for Auth0, it's set to trueby default.

-
-
-
-
- -

authorizationParams

-
authorizationParams: AuthorizationParameters
- -
-
-

URL parameters used when redirecting users to the authorization server to log in.

-
-

If this property is not provided by your application, its default values will be:

- 
{
-  response_type: 'code',
-  scope: 'openid profile email'
-}
-
-

New values can be passed in to change what is returned from the authorization server - depending on your specific scenario. Additional custom parameters can be added as well.

-

Note: You must provide the required parameters if this object is set.

- 
{
-  response_type: 'code',
-  scope: 'openid profile email',
-
-  // Additional parameters
-  acr_value: 'tenant:test-tenant',
-  custom_param: 'custom-value'
-};
-
-
-
-
- -

baseURL

-
baseURL: string
- -
-
-

The root URL for the application router, for example https://localhost. - You can also use the AUTH0_BASE_URL environment variable. - If you provide a domain, we will prefix it with https://. This can be useful when assigning it to - VERCEL_URL for Vercel deploys.

-
-
-
-
- -

clientID

-
clientID: string
- -
-
-

The Client ID for your application. - You can also use the AUTH0_CLIENT_ID environment variable.

-
-
-
-
- -

Optional clientSecret

-
clientSecret: string
- -
-
-

The Client Secret for your application. - Required when requesting access tokens. - You can also use the AUTH0_CLIENT_SECRET environment variable.

-
-
-
-
- -

clockTolerance

-
clockTolerance: number
- -
-
-

Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.Defaults to60seconds. You can also use theAUTH0_CLOCK_TOLERANCE` environment variable.

-
-
-
-
- -

enableTelemetry

-
enableTelemetry: boolean
- -
-
-

Boolean value to opt-out of sending the library and node version to your authorization server - via the Auth0-Client header. Defaults to true. - You can also use the AUTH0_ENABLE_TELEMETRY environment variable.

-
-
-
-
- -

getLoginState

-
getLoginState: (req: IncomingMessage, options: LoginOptions) => Record<string, any>
- -
-
-

Function that returns an object with URL-safe state values for login. - Used for passing custom state parameters to your authorization server. - Can also be passed in to HandleLogin.

-
- 
{
-  ...
-  getLoginState(req, options) {
-    return {
-      returnTo: options.returnTo || req.originalUrl,
-      customState: 'foo'
-    };
-  }
-}
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: IncomingMessage, options: LoginOptions): Record<string, any>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: IncomingMessage
        -
        • -
      • -
        options: LoginOptions
        -
        • -
      -

      Returns Record<string, any>

      -
      • -
    -
    • -
-
-
-
- -

httpTimeout

-
httpTimeout: number
- -
-
-

Integer value for the HTTP timeout in milliseconds for authentication requests. - Defaults to 5000 ms. - You can also use the AUTH0_HTTP_TIMEOUT environment variable.

-
-
-
-
- -

idTokenSigningAlg

-
idTokenSigningAlg: string
- -
-
-

String value for the expected ID token algorithm. Defaults to 'RS256'. - You can also use the AUTH0_ID_TOKEN_SIGNING_ALG environment variable.

-
-
-
-
- -

identityClaimFilter

-
identityClaimFilter: string[]
- -
-
-

Array value of claims to remove from the ID token before storing the cookie session. - Defaults to ['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash']. - You can also use the AUTH0_IDENTITY_CLAIM_FILTER environment variable.

-
-
-
-
- -

idpLogout

-
idpLogout: boolean
- -
-
-

Boolean value to log the user out from the identity provider on application logout. Defaults to true. - You can also use the AUTH0_IDP_LOGOUT environment variable.

-
-
-
-
- -

issuerBaseURL

-
issuerBaseURL: string
- -
-
-

REQUIRED The root URL for the token issuer with no trailing slash. - This is https:// plus your Auth0 domain. - You can also use the AUTH0_ISSUER_BASE_URL environment variable.

-
-
-
-
- -

legacySameSiteCookie

-
legacySameSiteCookie: boolean
- -
-
-

Set a fallback cookie with no SameSite attribute when response_mode is form_post. - The default response_mode for this SDK is query so this defaults to false - You can also use the AUTH0_LEGACY_SAME_SITE_COOKIE environment variable.

-
-
-
-
- -

routes

-
routes: { callback: string; postLogoutRedirect: string }
- -
-
-

Boolean value to automatically install the login and logout routes.

-
-
-
-

Type declaration

-
    -
  • -
    callback: string
    -
    -
    -

    Relative path to the application callback to process the response from the authorization server. - Defaults to /api/auth/callback. - You can also use the AUTH0_CALLBACK environment variable.

    -
    -
    -
    • -
  • -
    postLogoutRedirect: string
    -
    -
    -

    Either a relative path to the application or a valid URI to an external domain. - This value must be registered on the authorization server. - The user will be redirected to this after a logout has been performed. - You can also use the AUTH0_POST_LOGOUT_REDIRECT environment variable.

    -
    -
    -
    • -
-
-
-
- -

secret

-
secret: string | string[]
- -
-
-

The secret(s) used to derive an encryption key for the user identity in a session cookie and - to sign the transient cookies used by the login callback. - Provide a single string secret, but if you want to rotate the secret you can provide an array putting - the new secret first. - You can also use the AUTH0_SECRET environment variable.

-
-
-
-
- -

session

-
session: SessionConfig
- -
-
-

Object defining application session cookie attributes.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/config.cookieconfig.html b/docs/interfaces/config.cookieconfig.html deleted file mode 100644 index 087a091c3..000000000 --- a/docs/interfaces/config.cookieconfig.html +++ /dev/null @@ -1,364 +0,0 @@ - - - - - - CookieConfig | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface CookieConfig

-
-
-
-
-
-
-
-
-
-

Configure how the session cookie and transient cookies are stored.

-
-
-
-
-

Hierarchy

-
    -
  • - CookieConfig -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional domain

-
domain: string
- -
-
-

Domain name for the cookie. - You can also use the AUTH0_COOKIE_DOMAIN environment variable.

-
-
-
-
- -

httpOnly

-
httpOnly: boolean
- -
-
-

Flags the cookie to be accessible only by the web server. - Defaults to true. - You can also use the AUTH0_COOKIE_HTTP_ONLY environment variable.

-
-
-
-
- -

Optional path

-
path: string
- -
-
-

Path for the cookie. - Defaults to /. - You should change this to be more restrictive if you application shares a domain with other apps. - You can also use the AUTH0_COOKIE_PATH environment variable.

-
-
-
-
- -

sameSite

-
sameSite: "lax" | "strict" | "none"
- -
-
-

Value of the SameSite Set-Cookie attribute. - Defaults to lax but will be adjusted based on AuthorizationParameters.response_type. - You can also use the AUTH0_COOKIE_SAME_SITE environment variable.

-
-
-
-
- -

Optional secure

-
secure: boolean
- -
-
-

Marks the cookie to be used over secure channels only. - Defaults to the protocol of BaseConfig.baseURL. - You can also use the AUTH0_COOKIE_SECURE environment variable.

-
-
-
-
- -

transient

-
transient: boolean
- -
-
-

Set to true to use a transient cookie (cookie without an explicit expiration). - Defaults to false. - You can also use the AUTH0_COOKIE_TRANSIENT environment variable.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/config.nextconfig.html b/docs/interfaces/config.nextconfig.html deleted file mode 100644 index 7f13158ba..000000000 --- a/docs/interfaces/config.nextconfig.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - NextConfig | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface NextConfig

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Pick<BaseConfig, "identityClaimFilter"> -
      -
    • - NextConfig -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

identityClaimFilter

-
identityClaimFilter: string[]
- -
-
-

Array value of claims to remove from the ID token before storing the cookie session. - Defaults to ['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash']. - You can also use the AUTH0_IDENTITY_CLAIM_FILTER environment variable.

-
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

Log users in to a specific organization.

-
-

This will specify an organization parameter in your user's login request and will add a step to validate - the org_id claim in your user's ID token.

-

If your app supports multiple organizations, you should take a look at AuthorizationParams.organization.

-
-
-
- -

routes

-
routes: { callback: string; login: string; unauthorized: string }
- -
-

Type declaration

-
    -
  • -
    callback: string
    -
    • -
  • -
    login: string
    -
    • -
  • -
    unauthorized: string
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/config.sessionconfig.html b/docs/interfaces/config.sessionconfig.html deleted file mode 100644 index f65528f88..000000000 --- a/docs/interfaces/config.sessionconfig.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - - SessionConfig | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface SessionConfig

-
-
-
-
-
-
-
-
-
-

Configuration parameters used for the application session.

-
-
-
-
-

Hierarchy

-
    -
  • - SessionConfig -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

absoluteDuration

-
absoluteDuration: number | boolean
- -
-
-

Integer value, in seconds, for application absolute rolling duration. - The amount of time after the user has logged in that they will be logged out. - Set this to false if you don't want an absolute duration on your session. - Defaults to 604800 seconds (7 days). - You can also use the AUTH0_SESSION_ABSOLUTE_DURATION environment variable.

-
-
-
-
- -

cookie

-
cookie: CookieConfig
- -
-
- -

Optional genId

-
genId: <Req>(req: Req) => string | Promise<string>
- -
-
-

A Function for generating a session id when using a custom session store.

-
-

IMPORTANT If you override this, you must use a suitable value from your platform to - prevent collisions. For example, for Node: require('crypto').randomBytes(16).toString('hex').

-
-
-

Type declaration

-
    -
  • -
      -
    • <Req>(req: Req): string | Promise<string>
      • -
    -
      -
    • -

      Type parameters

      -
        -
      • -

        Req = any

        -
        • -
      -

      Parameters

      -
        -
      • -
        req: Req
        -
        • -
      -

      Returns string | Promise<string>

      -
      • -
    -
    • -
-
-
-
- -

name

-
name: string
- -
-
-

String value for the cookie name used for the internal session. - This value must only include letters, numbers, and underscores. - Defaults to appSession. - You can also use the AUTH0_SESSION_NAME environment variable.

-
-
-
-
- -

rolling

-
rolling: boolean
- -
-
-

If you want your session duration to be rolling, resetting everytime the - user is active on your site, set this to true. If you want the session - duration to be absolute, where the user gets logged out a fixed time after login - regardless of activity, set this to false. - Defaults to true. - You can also use the AUTH0_SESSION_ROLLING environment variable.

-
-
-
-
- -

rollingDuration

-
rollingDuration: number | false
- -
-
-

Integer value, in seconds, for application session rolling duration. - The amount of time for which the user must be idle for then to be logged out. - Should be false when rolling is false. - Defaults to 86400 seconds (1 day). - You can also use the AUTH0_SESSION_ROLLING_DURATION environment variable.

-
-
-
-
- -

Optional store

-
store: SessionStore<default>
- -
-
-

By default, the session is stateless and stored in an encrypted cookie. But if you want a stateful session - you can provide a store with get, set and destroy methods to store the session on the server.

-
-
-
-
- -

storeIDToken

-
storeIDToken: boolean
- -
-
-

Boolean value to store the ID token in the session. Storing it can make the session cookie too - large. - Defaults to true.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/handlers_callback.callbackoptions.html b/docs/interfaces/handlers_callback.callbackoptions.html deleted file mode 100644 index 31caa8c9b..000000000 --- a/docs/interfaces/handlers_callback.callbackoptions.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - CallbackOptions | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface CallbackOptions

-
-
-
-
-
-
-
-
-
-

Options to customize the callback handler.

-
-
-
see
-

HandleCallback

-
-
-
-
-
-

Hierarchy

-
    -
  • - CallbackOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional afterCallback

-
afterCallback: AfterCallback
- -
-
- -

Optional authorizationParams

-
authorizationParams: Partial<AuthorizationParameters>
- -
-
-

This is useful for sending custom query parameters in the body of the code exchange request - for use in Actions/Rules.

-
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

This is useful to specify instead of NextConfig.organization when your app has multiple - organizations, it should match LoginOptions.authorizationParams.

-
-
-
-
- -

Optional redirectUri

-
redirectUri: string
- -
-
-

This is useful to specify in addition to BaseConfig.baseURL when your app runs on multiple domains, - it should match {@link LoginOptions.authorizationParams.redirect_uri}.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/handlers_login.authorizationparams.html b/docs/interfaces/handlers_login.authorizationparams.html deleted file mode 100644 index f7732ba91..000000000 --- a/docs/interfaces/handlers_login.authorizationparams.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - AuthorizationParams | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface AuthorizationParams

-
-
-
-
-
-
-
-
-
-

Authorization params to pass to the login handler.

-
-
-
-
-

Hierarchy

-
    -
  • - Partial<AuthorizationParameters> -
      -
    • - AuthorizationParams -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional connection

-
connection: string
- -
-
-

The name of an OAuth2/social connection. Use it to directly show that - identity provider's login page, skipping the Universal Login page itself. - By default no connection is specified, so the Universal Login page will be displayed.

-
- 
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: async (req, res) => {
-    try {
-      await handleLogin(req, res, {
-        // Get the connection name from the Auth0 Dashboard
-        authorizationParams: { connection: 'github' }
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
- -

Optional connection_scope

-
connection_scope: string
- -
-
-

Provider scopes for OAuth2/social connections, such as GitHub or Google.

-
- 
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: async (req, res) => {
-    try {
-      await handleLogin(req, res, {
-        authorizationParams: {
-          connection: 'github',
-          connection_scope: 'public_repo read:user'
-        }
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
- -

Optional invitation

-
invitation: string
- -
-
-

The invitation id to join an organization.

-
-

To create a link for your user's to accept an organization invite, read the invitation and organization - query params and pass them to the authorization server to log the user in:

- 
// pages/api/invite.js
-import { handleLogin } from '@auth0/nextjs-auth0';
-
-export default async function invite(req, res) {
-  try {
-    const { invitation, organization } = req.query;
-    if (!invitation) {
-      res.status(400).end('Missing "invitation" parameter');
-    }
-    await handleLogin(req, res, {
-      authorizationParams: {
-        invitation,
-        organization
-      }
-    });
-  } catch (error) {
-    res.status(error.status || 500).end();
-  }
-} ;
-
-

Your invite url can then take the format: - https://example.com/api/invite?invitation=invitation_id&organization=org_id.

-
-
-
- -

Optional organization

-
organization: string
- -
-
-

This is useful to specify instead of NextConfig.organization when your app has multiple - organizations. It should match CallbackOptions.organization.

-
-
-
-
- -

Optional response_mode

-
response_mode: "query" | "form_post"
- -
-
- -

Optional response_type

-
response_type: "id_token" | "code id_token" | "code"
- -
-
- -

Optional scope

-
scope: string
- -
-
- -

Optional screen_hint

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

-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/handlers_login.loginoptions.html b/docs/interfaces/handlers_login.loginoptions.html deleted file mode 100644 index c6748c2d2..000000000 --- a/docs/interfaces/handlers_login.loginoptions.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - LoginOptions | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface LoginOptions

-
-
-
-
-
-
-
-
-
-

Options to customize the login handler.

-
-
-
see
-

HandleLogin

-
-
-
-
-
-

Hierarchy

-
    -
  • - LoginOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional authorizationParams

-
authorizationParams: AuthorizationParams
- -
-
-

Override the default authorizationParams.

-
-
-
-
- -

Optional getLoginState

-
getLoginState: GetLoginState
- -
-
-

Generate a unique state value for use during login transactions.

-
-
-
-
- -

Optional returnTo

-
returnTo: string
- -
-
-

URL to return to after login. Overrides the default in BaseConfig.baseURL.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/handlers_logout.logoutoptions.html b/docs/interfaces/handlers_logout.logoutoptions.html deleted file mode 100644 index 1c762dda9..000000000 --- a/docs/interfaces/handlers_logout.logoutoptions.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - LogoutOptions | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface LogoutOptions

-
-
-
-
-
-
-
-
-
-

Options to customize the logout handler.

-
-
-
see
-

HandleLogout

-
-
-
-
-
-

Hierarchy

-
    -
  • - LogoutOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional logoutParams

-
logoutParams: {}
- -
-
-

Additional custom parameters to pass to the logout endpoint.

-
-
-
-

Type declaration

-
    -
  • -
    [key: string]: any
    -
    • -
-
-
-
- -

Optional returnTo

-
returnTo: string
- -
-
-

URL to return to after logout. Overrides the default - in {@link BaseConfig.routes.postLogoutRedirect routes.postLogoutRedirect}.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/index.auth0server.html b/docs/interfaces/index.auth0server.html deleted file mode 100644 index 3dcdcd975..000000000 --- a/docs/interfaces/index.auth0server.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - Auth0Server | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface Auth0Server

-
-
-
-
-
-
-
-
-
-

The SDK server instance.

-
-

This is created for you when you use the named exports, or you can create your own using InitAuth0.

-

See ConfigParameters for more info.

-
-
-
-

Hierarchy

-
    -
  • - Auth0Server -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

getAccessToken

-
getAccessToken: GetAccessToken
- -
-
-

Access token getter.

-
-
-
-
- -

getSession

-
getSession: GetSession
- -
-
-

Session getter.

-
-
-
-
- -

handleAuth

-
handleAuth: HandleAuth
- -
-
-

Create the main handlers for your api routes.

-
-
-
-
- -

handleCallback

-
handleCallback: HandleCallback
- -
-
-

Callback handler which will complete the transaction and create a local session.

-
-
-
-
- -

handleLogin

-
handleLogin: HandleLogin
- -
-
-

Login handler which will redirect the user to Auth0.

-
-
-
-
- -

handleLogout

-
handleLogout: HandleLogout
- -
-
-

Logout handler which will clear the local session and the Auth0 session.

-
-
-
-
- -

handleProfile

-
handleProfile: HandleProfile
- -
-
-

Profile handler which return profile information about the user.

-
-
-
-
- -

updateSession

-
updateSession: UpdateSession
- -
-
-

Append properties to the user.

-
-
-
-
- -

withApiAuthRequired

-
withApiAuthRequired: WithApiAuthRequired
- -
-
-

Helper that adds auth to an API route.

-
-
-
-
- -

withPageAuthRequired

-
withPageAuthRequired: WithPageAuthRequired
- -
-
-

Helper that adds auth to a Page route.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/session_get_access_token.accesstokenrequest.html b/docs/interfaces/session_get_access_token.accesstokenrequest.html deleted file mode 100644 index 3cca4c530..000000000 --- a/docs/interfaces/session_get_access_token.accesstokenrequest.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - AccessTokenRequest | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface AccessTokenRequest

-
-
-
-
-
-
-
-
-
-

Custom options to get an access token.

-
-
-
-
-

Hierarchy

-
    -
  • - AccessTokenRequest -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional afterRefresh

-
afterRefresh: AfterRefresh
- -
-
-

When the access token request refreshes the tokens using the refresh grant the session is updated with new tokens. - Use this to modify the session after it is refreshed. - Usually used to keep updates in sync with the AfterCallback hook.

-
-
-
see
-

also the AfterRefetch hook.

-
-
example
-

Modify the session after refresh

- 
// pages/api/my-handler.js
-import { getAccessToken } from '@auth0/nextjs-auth0';
-
-const afterRefresh = (req, res, session) => {
-  session.user.customProperty = 'foo';
-  delete session.idToken;
-  return session;
-};
-
-export default async function MyHandler(req, res) {
-  const accessToken = await getAccessToken(req, res, {
-    refresh: true,
-    afterRefresh,
-  });
-};
-
-
-
-
-
-
- -

Optional authorizationParams

-
authorizationParams: Partial<AuthorizationParameters>
- -
-
-

This is useful for sending custom query parameters in the body of the refresh grant request for use in rules.

-
-
-
-
- -

Optional refresh

-
refresh: boolean
- -
-
-

If set to true, a new access token will be requested with the refresh token grant, regardless of whether - the access token has expired or not.

-
-

IMPORTANT You need to request the offline_access scope on login to get a refresh token - from Auth0.

-
-
-
- -

Optional scopes

-
scopes: string[]
- -
-
-

A list of desired scopes for your access token.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/session_get_access_token.getaccesstokenresult.html b/docs/interfaces/session_get_access_token.getaccesstokenresult.html deleted file mode 100644 index dde51cf9f..000000000 --- a/docs/interfaces/session_get_access_token.getaccesstokenresult.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - GetAccessTokenResult | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface GetAccessTokenResult

-
-
-
-
-
-
-
-
-
-

Response from requesting an access token.

-
-
-
-
-

Hierarchy

-
    -
  • - GetAccessTokenResult -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional accessToken

-
accessToken: string
- -
-
-

Access token returned from the token cache.

-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/session_session.claims.html b/docs/interfaces/session_session.claims.html deleted file mode 100644 index f8142f792..000000000 --- a/docs/interfaces/session_session.claims.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - Claims | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Interface Claims

-
-
-
-
-
-
-
-
-
-

Key-value store for the user's claims.

-
-
-
-
-

Hierarchy

-
    -
  • - Claims -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

Key-value store for the user's claims.

-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html deleted file mode 100644 index 08c2bd2f6..000000000 --- a/docs/modules/client.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - client | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module client

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

RequestError

- Re-exports RequestError -
-
- -

UserProfile

- Re-exports UserProfile -
-
- -

UserProvider

- Renames and exports default -
-
- -

UserProviderProps

- Re-exports UserProviderProps -
-
- -

WithPageAuthRequired

- Re-exports WithPageAuthRequired -
-
- -

WithPageAuthRequiredOptions

- Re-exports WithPageAuthRequiredOptions -
-
- -

useUser

- Re-exports useUser -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/client_use_user.html b/docs/modules/client_use_user.html deleted file mode 100644 index ede013ad4..000000000 --- a/docs/modules/client_use_user.html +++ /dev/null @@ -1,434 +0,0 @@ - - - - - - client/use-user | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module client/use-user

-
-
-
-
-
-
-
-

Index

-
-
-
-

Client Classes

- -
-
-

Client Interfaces

- -
-
-

Client Type aliases

- -
-
-

Properties

- -
-
-

Client Functions

- -
-
-
-
-
-

Client Type aliases

-
- -

UserContext

-
UserContext: { checkSession: () => Promise<void>; error?: Error; isLoading: boolean; user?: UserProfile }
- -
-
-

The user context returned from the useUser hook.

-
-
-
-

Type declaration

-
    -
  • -
    checkSession: () => Promise<void>
    -
      -
    • -
        -
      • (): Promise<void>
        • -
      -
        -
      • -

        Returns Promise<void>

        -
        • -
      -
      • -
    -
    • -
  • -
    Optional error?: Error
    -
    • -
  • -
    isLoading: boolean
    -
    • -
  • -
    Optional user?: UserProfile
    -
    • -
-
-
-
- -

UserProvider

-
UserProvider: (props: UserProviderProps) => ReactElement<UserContext>
- -
-
-

To use the useUser hook, you must wrap your application in a <UserProvider> component.

-
-
-
-

Type declaration

- -
-
-
- -

UserProviderProps

-
UserProviderProps: React.PropsWithChildren<{ fetcher?: UserFetcher; profileUrl?: string; user?: UserProfile } & ConfigContext>
- -
-
-

Configure the UserProvider component.

-
-

If you have any server-side rendered pages (using getServerSideProps), you should get the - user from the server-side session and pass it to the <UserProvider> component via the user - prop. This will prefill the useUser hook with the UserProfile object. - For example:

- 
// pages/_app.js
-import React from 'react';
-import { UserProvider } from '@auth0/nextjs-auth0/client';
-
-export default function App({ Component, pageProps }) {
-  // If you've used `withPageAuthRequired`, `pageProps.user` can prefill the hook
-  // if you haven't used `withPageAuthRequired`, `pageProps.user` is undefined so the hook
-  // fetches the user from the API route
-  const { user } = pageProps;
-
-  return (
-    <UserProvider user={user}>
-      <Component {...pageProps} />
-    </UserProvider>
-  );
-}
-
-

In client-side rendered pages, the useUser hook uses a {@link UserFetcher} to fetch the - user from the profile API route. If needed, you can specify a custom fetcher here in the - fetcher option.

-

IMPORTANT If you have used a custom url for your HandleProfile API route handler - (the default is /api/auth/me) then you need to specify it here in the profileUrl option.

-
-
-
-
-

Properties

-
- -

default

-
default: (__namedParameters: PropsWithChildren<{ fetcher?: UserFetcher; profileUrl?: string; user?: UserProfile } & ConfigContext>) => ReactElement<UserContext, string | ((props: any) => null | ReactElement<any, any>) | (new (props: any) => Component<any, any, any>)>
- -
-

Type declaration

-
    -
  • -
      -
    • (__namedParameters: PropsWithChildren<{ fetcher?: UserFetcher; profileUrl?: string; user?: UserProfile } & ConfigContext>): ReactElement<UserContext, string | ((props: any) => null | ReactElement<any, any>) | (new (props: any) => Component<any, any, any>)>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        __namedParameters: PropsWithChildren<{ fetcher?: UserFetcher; profileUrl?: string; user?: UserProfile } & ConfigContext>
        -
        • -
      -

      Returns ReactElement<UserContext, string | ((props: any) => null | ReactElement<any, any>) | (new (props: any) => Component<any, any, any>)>

      -
      • -
    -
    • -
-
-
-
-
-

Client Functions

-
- -

Const useUser

-
    -
  • useUser(): UserContext
    • -
-
    -
  • - -
    -
    -

    The useUser hook, which will get you the UserProfile object from the server-side session by fetching it - from the HandleProfile API route.

    -
    - 
    // pages/profile.js
-import Link from 'next/link';
-import { useUser } from '@auth0/nextjs-auth0/client';
-
-export default function Profile() {
-  const { user, error, isLoading } = useUser();
-
-  if (isLoading) return <div>Loading...</div>;
-  if (error) return <div>{error.message}</div>;
-  if (!user) return <Link href="/api/auth/login"><a>Login</a></Link>;
-  return <div>Hello {user.name}, <Link href="/api/auth/logout"><a>Logout</a></Link></div>;
-}
-
    -
    -

    Returns UserContext

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/client_with_page_auth_required.html b/docs/modules/client_with_page_auth_required.html deleted file mode 100644 index 2edcc11ff..000000000 --- a/docs/modules/client_with_page_auth_required.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - client/with-page-auth-required | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module client/with-page-auth-required

-
-
-
-
-
-
-
-

Index

-
-
-
-

Client Interfaces

- -

Other Interfaces

- -
-
-

Client Type aliases

- -
-
-
-
-
-

Client Type aliases

-
- -

WithPageAuthRequired

-
WithPageAuthRequired: <P>(Component: ComponentType<P & UserProps>, options?: WithPageAuthRequiredOptions) => React.FC<P>
- -
-
- 
const MyProtectedPage = withPageAuthRequired(MyPage);
-
-
-

When you wrap your pages in this higher order component and an anonymous user visits your page, - they will be redirected to the login page and then returned to the page they were redirected from (after login).

-
-
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/config.html b/docs/modules/config.html deleted file mode 100644 index 1cd5784c7..000000000 --- a/docs/modules/config.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - config | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module config

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Interfaces

- -

server Interfaces

- -
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

ConfigParameters

-
ConfigParameters: DeepPartial<BaseConfig & NextConfig>
- -
-
- -

Configuration properties.

- -
-

The Server part of the SDK can be configured in 2 ways.

- -

1. Environment Variables

- -

The simplest way to use the SDK is to use the named exports (HandleAuth, HandleLogin, - HandleLogout, HandleCallback, HandleProfile, GetSession, GetAccessToken, - WithApiAuthRequired, and WithPageAuthRequired).

- 
// pages/api/auth/[...auth0].js
-import { handleAuth } from '@auth0/nextjs-auth0';
-
-return handleAuth();
-
-

When you use these named exports, an instance of the SDK is created for you which you can configure using - environment variables:

- -

Required

- - - -

Optional

- - - -

2. Create your own instance using InitAuth0

- -

If you don't want to configure the SDK with environment variables or you want more fine grained control over the - instance, you can create an instance yourself and use the handlers and helpers from that.

-

First, export your configured instance from another module:

- 
// utils/auth0.js
-import { initAuth0 } from '@auth0/nextjs-auth0';
-
-export default initAuth0({ ...ConfigParameters... });
-
-

Then import it into your route handler:

- 
// pages/api/auth/[...auth0].js
-import auth0 from '../../../../utils/auth0';
-
-return auth0.handleAuth();
-
-

IMPORTANT If you use InitAuth0, you should not use the other named exports as they will use a different - instance of the SDK. Also note - this is for the server side part of the SDK - you will always use named exports for - the front end components: UserProvider, {@Link UseUser} and the - front end version of WithPageAuthRequired

-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/edge.html b/docs/modules/edge.html deleted file mode 100644 index afc01c455..000000000 --- a/docs/modules/edge.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - edge | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module edge

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Type aliases

- -
-
-

Functions

- -
-
-
-
-
-

References

-
- -

WithMiddlewareAuthRequired

- Re-exports WithMiddlewareAuthRequired -
-
-
-

Type aliases

-
- -

Auth0Edge

-
Auth0Edge: { getSession: GetSession; withMiddlewareAuthRequired: WithMiddlewareAuthRequired }
- -
-

Type declaration

- -
-
-
- -

GetSession

-
GetSession: (req: NextRequest, res: NextResponse) => Promise<default | null | undefined>
- -
-

Type declaration

-
    -
  • -
      -
    • (req: NextRequest, res: NextResponse): Promise<default | null | undefined>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextRequest
        -
        • -
      • -
        res: NextResponse
        -
        • -
      -

      Returns Promise<default | null | undefined>

      -
      • -
    -
    • -
-
-
-
- -

InitAuth0

-
InitAuth0: (params?: ConfigParameters) => Auth0Edge
- -
-

Type declaration

- -
-
-
-
-

Functions

-
- -

Const getSession

-
    -
  • getSession(req: NextRequest, res: NextResponse): Promise<undefined | null | default>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: NextRequest
      -
      • -
    • -
      res: NextResponse
      -
      • -
    -

    Returns Promise<undefined | null | default>

    -
    • -
-
-
- -

Const initAuth0

- - -
-
- -

Const withMiddlewareAuthRequired

-
    -
  • withMiddlewareAuthRequired(middleware?: NextMiddleware): NextMiddleware
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional middleware: NextMiddleware
      -
      • -
    -

    Returns NextMiddleware

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers.html b/docs/modules/handlers.html deleted file mode 100644 index f081c8342..000000000 --- a/docs/modules/handlers.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - handlers | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

AfterCallback

- Re-exports AfterCallback -
-
- -

AfterRefetch

- Re-exports AfterRefetch -
-
- -

CallbackOptions

- Re-exports CallbackOptions -
-
- -

GetLoginState

- Re-exports GetLoginState -
-
- -

HandleAuth

- Re-exports HandleAuth -
-
- -

HandleCallback

- Re-exports HandleCallback -
-
- -

HandleLogin

- Re-exports HandleLogin -
-
- -

HandleLogout

- Re-exports HandleLogout -
-
- -

HandleProfile

- Re-exports HandleProfile -
-
- -

Handlers

- Re-exports Handlers -
-
- -

LoginOptions

- Re-exports LoginOptions -
-
- -

LogoutOptions

- Re-exports LogoutOptions -
-
- -

OnError

- Re-exports OnError -
-
- -

ProfileOptions

- Re-exports ProfileOptions -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers_auth.html b/docs/modules/handlers_auth.html deleted file mode 100644 index d0044704f..000000000 --- a/docs/modules/handlers_auth.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - handlers/auth | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers/auth

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

HandleAuth

-
HandleAuth: (userHandlers?: Handlers) => NextApiHandler
- -
-
-

The main way to use the server SDK.

-
-

Simply set the environment variables per ConfigParameters then create the file - pages/api/auth/[...auth0].js. For example:

- 
// pages/api/auth/[...auth0].js
-import { handleAuth } from '@auth0/nextjs-auth0';
-
-export default handleAuth();
-
-

This will create 5 handlers for the following urls:

-
    -
  • /api/auth/login: log the user in to your app by redirecting them to your identity provider.
    • -
  • /api/auth/callback: The page that your identity provider will redirect the user back to on login.
    • -
  • /api/auth/logout: log the user out of your app.
    • -
  • /api/auth/me: View the user profile JSON (used by the {@link UseUser} hook).
    • -
  • /api/auth/unauthorized: Returns a 401 for use by WithMiddlewareAuthRequired when protecting API routes.
    • -
-
-
-

Type declaration

-
    -
  • -
      -
    • (userHandlers?: Handlers): NextApiHandler
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        Optional userHandlers: Handlers
        -
        • -
      -

      Returns NextApiHandler

      -
      • -
    -
    • -
-
-
-
- -

Handlers

-
Handlers: ApiHandlers | ErrorHandlers
- -
-
-

If you want to add some custom behavior to the default auth handlers, you can pass in custom handlers for - login, logout, callback, and profile. For example:

-
- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-import { errorReporter, logger } from '../../../utils';
-
-export default handleAuth({
-  async login(req, res) {
-    try {
-       // Pass in custom params to your handler
-      await handleLogin(req, res, { authorizationParams: { customParam: 'foo' } });
-      // Add your own custom logging.
-      logger('Redirecting to login');
-    } catch (error) {
-      // Add you own custom error logging.
-      errorReporter(error);
-      res.status(error.status || 500).end();
-    }
-  }
-});
-
-

Alternatively, you can customize the default handlers without overriding them. For example:

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: handleLogin({
-    authorizationParams: { customParam: 'foo' } // Pass in custom params
-  })
-});
-
-

You can also create new handlers by customizing the default ones. For example:

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  signup: handleLogin({
-    authorizationParams: { screen_hint: 'signup' }
-  })
-});
-
-
-
-
- -

OnError

-
OnError: (req: NextApiRequest, res: NextApiResponse, error: HandlerError) => Promise<void> | void
- -
-
-

Error handler for the default auth routes.

-
-

Use this to define an error handler for all the default routes in a single place. For example:

- 
export default handleAuth({
-  onError(req, res, error) {
-    errorLogger(error);
-    // You can finish the response yourself if you want to customize
-    // the status code or redirect the user
-    // res.writeHead(302, {
-    //     Location: '/custom-error-page'
-    // });
-    // res.end();
-  }
-});
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, error: HandlerError): Promise<void> | void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        error: HandlerError
        -
        • -
      -

      Returns Promise<void> | void

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers_callback.html b/docs/modules/handlers_callback.html deleted file mode 100644 index eff3fbf8c..000000000 --- a/docs/modules/handlers_callback.html +++ /dev/null @@ -1,534 +0,0 @@ - - - - - - handlers/callback | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers/callback

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Interfaces

- -
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

AfterCallback

-
AfterCallback: (req: NextApiRequest, res: NextApiResponse, session: default, state?: {}) => Promise<default | undefined> | default | undefined
- -
-
-

Use this function for validating additional claims on the user's ID token or adding removing items from - the session after login.

-
-
-
example
-

Validate additional claims

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-const afterCallback = (req, res, session, state) => {
-  if (session.user.isAdmin) {
-    return session;
-  } else {
-    res.status(401).end('User is not admin');
-  }
-};
-
-export default handleAuth({
-  async callback(req, res) {
-    try {
-      await handleCallback(req, res, { afterCallback });
-    } catch (error) {
-      res.status(error.status || 500).end();
-    }
-  }
-});
-
-
-
example
-

Modify the session after login

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-const afterCallback = (req, res, session, state) => {
-  session.user.customProperty = 'foo';
-  delete session.refreshToken;
-  return session;
-};
-
-export default handleAuth({
-  async callback(req, res) {
-    try {
-      await handleCallback(req, res, { afterCallback });
-    } catch (error) {
-      res.status(error.status || 500).end();
-    }
-  }
-});
-
-
-
example
-

Redirect successful login based on claim

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-const afterCallback = (req, res, session, state) => {
-  if (!session.user.isAdmin) {
-    res.setHeader('Location', '/admin');
-  }
-  return session;
-};
-
-export default handleAuth({
-  async callback(req, res) {
-    try {
-      await handleCallback(req, res, { afterCallback });
-    } catch (error) {
-      res.status(error.status || 500).end(error.message);
-    }
-  }
-});
-
-
-
throws
-

HandlerError

-
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, session: default, state?: {}): Promise<default | undefined> | default | undefined
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        session: default
        -
        • -
      • -
        Optional state: {}
        -
          -
        • -
          [key: string]: any
          -
          • -
        -
        • -
      -

      Returns Promise<default | undefined> | default | undefined

      -
      • -
    -
    • -
-
-
-
- -

CallbackHandler

-
CallbackHandler: (req: NextApiRequest, res: NextApiResponse, options?: CallbackOptions) => Promise<void>
- -
-
-

The handler for the /api/auth/callback API route.

-
-
-
throws
-

HandlerError

-
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, options?: CallbackOptions): Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        Optional options: CallbackOptions
        -
        • -
      -

      Returns Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

CallbackOptionsProvider

-
CallbackOptionsProvider: (req: NextApiRequest) => CallbackOptions
- -
-
-

Options provider for the default callback handler. - Use this to generate options that depend on values from the request.

-
-
-
-

Type declaration

- -
-
-
- -

HandleCallback

-
HandleCallback: { (req: NextApiRequest, res: NextApiResponse<any>, options?: CallbackOptions): Promise<void>; (provider: CallbackOptionsProvider): CallbackHandler; (options: CallbackOptions): CallbackHandler }
- -
-
-

Use this to customize the default callback handler without overriding it. - You can still override the handler if needed.

-
-
-
example
-

Pass an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  callback: handleCallback({ redirectUri: 'https://example.com' })
-});
-
-
-
example
-

Pass a function that receives the request and returns an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  callback: handleCallback((req) => {
-    return { redirectUri: 'https://example.com' };
-  })
-});
-
-

This is useful for generating options that depend on values from the request.

-
-
example
-

Override the callback handler

- 
import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  callback: async (req, res) => {
-    try {
-      await handleCallback(req, res, {
-        redirectUri: 'https://example.com'
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
-
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers_login.html b/docs/modules/handlers_login.html deleted file mode 100644 index 4bc30bcf1..000000000 --- a/docs/modules/handlers_login.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - handlers/login | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers/login

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Interfaces

- -
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

GetLoginState

-
GetLoginState: (req: NextApiRequest, options: LoginOptions) => {}
- -
-
-

Use this to store additional state for the user before they visit the identity provider to log in.

-
- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-const getLoginState = (req, loginOptions) => {
-  return { basket_id: getBasketId(req) };
-};
-
-export default handleAuth({
-  async login(req, res) {
-    try {
-      await handleLogin(req, res, { getLoginState });
-    } catch (error) {
-      res.status(error.status || 500).end();
-    }
-  }
-});
-
-
-
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      - -

      Returns {}

      -
        -
      • -
        [key: string]: any
        -
        • -
      -
      • -
    -
    • -
-
-
-
- -

HandleLogin

-
HandleLogin: { (req: NextApiRequest, res: NextApiResponse<any>, options?: LoginOptions): Promise<void>; (provider: LoginOptionsProvider): LoginHandler; (options: LoginOptions): LoginHandler }
- -
-
-

Use this to customize the default login handler without overriding it. - You can still override the handler if needed.

-
-
-
example
-

Pass an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: handleLogin({
-    authorizationParams: { connection: 'github' }
-  })
-});
-
-
-
example
-

Pass a function that receives the request and returns an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: handleLogin((req) => {
-    return {
-      authorizationParams: { connection: 'github' }
-    };
-  })
-});
-
-

This is useful for generating options that depend on values from the request.

-
-
example
-

Override the login handler

- 
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  login: async (req, res) => {
-    try {
-      await handleLogin(req, res, {
-        authorizationParams: { connection: 'github' }
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
-
-

Type declaration

- -
-
-
- -

LoginHandler

-
LoginHandler: (req: NextApiRequest, res: NextApiResponse, options?: LoginOptions) => Promise<void>
- -
-
-

The handler for the /api/auth/login API route.

-
-
-
throws
-

HandlerError

-
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, options?: LoginOptions): Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        Optional options: LoginOptions
        -
        • -
      -

      Returns Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

LoginOptionsProvider

-
LoginOptionsProvider: (req: NextApiRequest) => LoginOptions
- -
-
-

Options provider for the default login handler. - Use this to generate options that depend on values from the request.

-
-
-
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      -

      Returns LoginOptions

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers_logout.html b/docs/modules/handlers_logout.html deleted file mode 100644 index 927d10572..000000000 --- a/docs/modules/handlers_logout.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - - handlers/logout | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers/logout

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Interfaces

- -
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

HandleLogout

-
HandleLogout: { (req: NextApiRequest, res: NextApiResponse<any>, options?: LogoutOptions): Promise<void>; (provider: LogoutOptionsProvider): LogoutHandler; (options: LogoutOptions): LogoutHandler }
- -
-
-

Use this to customize the default logout handler without overriding it. - You can still override the handler if needed.

-
-
-
example
-

Pass an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  logout: handleLogout({ returnTo: 'https://example.com' })
-});
-
-
-
example
-

Pass a function that receives the request and returns an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  logout: handleLogout((req) => {
-    return { returnTo: 'https://example.com' };
-  })
-});
-
-

This is useful for generating options that depend on values from the request.

-
-
example
-

Override the logout handler

- 
import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  logout: async (req, res) => {
-    try {
-      await handleLogout(req, res, {
-        returnTo: 'https://example.com'
-      });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
-
-

Type declaration

- -
-
-
- -

LogoutHandler

-
LogoutHandler: (req: NextApiRequest, res: NextApiResponse, options?: LogoutOptions) => Promise<void>
- -
-
-

The handler for the /api/auth/logout API route.

-
-
-
throws
-

HandlerError

-
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, options?: LogoutOptions): Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        Optional options: LogoutOptions
        -
        • -
      -

      Returns Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

LogoutOptionsProvider

-
LogoutOptionsProvider: (req: NextApiRequest) => LogoutOptions
- -
-
-

Options provider for the default logout handler. - Use this to generate options that depend on values from the request.

-
-
-
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/handlers_profile.html b/docs/modules/handlers_profile.html deleted file mode 100644 index 86d6103a2..000000000 --- a/docs/modules/handlers_profile.html +++ /dev/null @@ -1,489 +0,0 @@ - - - - - - handlers/profile | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module handlers/profile

-
-
-
-
-
-
-
-

Index

-
-
-
-

Other Type aliases

- -

Server Type aliases

- -
-
-
-
-
-

Other Type aliases

-
- -

AfterRefetch

-
AfterRefetch: (req: NextApiRequest, res: NextApiResponse, session: default) => Promise<default> | default
- -
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        session: default
        -
        • -
      -

      Returns Promise<default> | default

      -
      • -
    -
    • -
-
-
-
-
-

Server Type aliases

-
- -

HandleProfile

-
HandleProfile: { (req: NextApiRequest, res: NextApiResponse<any>, options?: ProfileOptions): Promise<void>; (provider: ProfileOptionsProvider): ProfileHandler; (options: ProfileOptions): ProfileHandler }
- -
-
-

Use this to customize the default profile handler without overriding it. - You can still override the handler if needed.

-
-
-
example
-

Pass an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  profile: handleProfile({ refetch: true })
-});
-
-
-
example
-

Pass a function that receives the request and returns an options object

- 
// pages/api/auth/[...auth0].js
-import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  profile: handleProfile((req) => {
-    return { refetch: true };
-  })
-});
-
-

This is useful for generating options that depend on values from the request.

-
-
example
-

Override the profile handler

- 
import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';
-
-export default handleAuth({
-  profile: async (req, res) => {
-    try {
-      await handleProfile(req, res, { refetch: true });
-    } catch (error) {
-      console.error(error);
-    }
-  }
-});
-
-
-
-
-
-

Type declaration

- -
-
-
- -

ProfileHandler

-
ProfileHandler: (req: NextApiRequest, res: NextApiResponse, options?: ProfileOptions) => Promise<void>
- -
-
-

The handler for the /api/auth/me API route.

-
-
-
throws
-

HandlerError

-
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: NextApiRequest, res: NextApiResponse, options?: ProfileOptions): Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        Optional options: ProfileOptions
        -
        • -
      -

      Returns Promise<void>

      -
      • -
    -
    • -
-
-
-
- -

ProfileOptions

-
ProfileOptions: { afterRefetch?: AfterRefetch; refetch?: boolean }
- -
-
-

Options to customize the profile handler.

-
-
-
see
-

HandleProfile

-
-
-
-
-

Type declaration

-
    -
  • -
    Optional afterRefetch?: AfterRefetch
    -
    -
    -

    Like AfterCallback and AfterRefresh when a session is created, you can use - this function to validate or add/remove claims after the session is updated. Will only run if - {@link ProfileOptions.refetch} is true.

    -
    -
    -
    • -
  • -
    Optional refetch?: boolean
    -
    -
    -

    If set to true this will refetch the user profile information from /userinfo and save it - to the session.

    -
    -
    -
    • -
-
-
-
- -

ProfileOptionsProvider

-
ProfileOptionsProvider: (req: NextApiRequest) => ProfileOptions
- -
-
-

Options provider for the default profile handler. - Use this to generate options that depend on values from the request.

-
-
-
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html deleted file mode 100644 index 0197aa8a6..000000000 --- a/docs/modules/helpers.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - helpers | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module helpers

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

GetServerSidePropsResultWithSession

- Re-exports GetServerSidePropsResultWithSession -
-
- -

PageRoute

- Re-exports PageRoute -
-
- -

WithApiAuthRequired

- Re-exports WithApiAuthRequired -
-
- -

WithPageAuthRequired

- Re-exports WithPageAuthRequired -
-
- -

WithPageAuthRequiredOptions

- Re-exports WithPageAuthRequiredOptions -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/helpers_testing.html b/docs/modules/helpers_testing.html deleted file mode 100644 index 080d676d3..000000000 --- a/docs/modules/helpers_testing.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - helpers/testing | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module helpers/testing

-
-
-
-
-
-
-
-

Index

-
-
-
-

Type aliases

- -
-
-

Functions

- -
-
-
-
-
-

Type aliases

-
- -

GenerateSessionCookieConfig

-
GenerateSessionCookieConfig: { duration?: number; secret: string } & Partial<CookieConfig>
- -
-
-

Configuration parameters used by generateSessionCookie.

-
-
-
-
-
-

Functions

-
- -

Const generateSessionCookie

- - -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/helpers_with_api_auth_required.html b/docs/modules/helpers_with_api_auth_required.html deleted file mode 100644 index c2cd8bcda..000000000 --- a/docs/modules/helpers_with_api_auth_required.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - helpers/with-api-auth-required | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module helpers/with-api-auth-required

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

WithApiAuthRequired

-
WithApiAuthRequired: (apiRoute: NextApiHandler) => NextApiHandler
- -
-
-

Wrap an API route to check that the user has a valid session. If they're not logged in the - handler will return a 401 Unauthorized.

-
- 
// pages/api/protected-route.js
-import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';
-
-export default withApiAuthRequired(function ProtectedRoute(req, res) {
-  const session = getSession(req, res);
-  ...
-});
-
-

If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

-
-
-

Type declaration

-
    -
  • -
      -
    • (apiRoute: NextApiHandler): NextApiHandler
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        apiRoute: NextApiHandler
        -
        • -
      -

      Returns NextApiHandler

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/helpers_with_middleware_auth_required.html b/docs/modules/helpers_with_middleware_auth_required.html deleted file mode 100644 index 860f3dbc2..000000000 --- a/docs/modules/helpers_with_middleware_auth_required.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - helpers/with-middleware-auth-required | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module helpers/with-middleware-auth-required

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

WithMiddlewareAuthRequired

-
WithMiddlewareAuthRequired: (middleware?: NextMiddleware) => NextMiddleware
- -
-
-

Protect your pages with Next.js Middleware. For example:

-
-

To protect all your routes:

- 
// middleware.js
-import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/middleware';
-
-export default withMiddlewareAuthRequired();
-
-

To protect specific routes:

- 
// middleware.js
-import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/middleware';
-
-export default withMiddlewareAuthRequired();
-
-export const config = {
-  matcher: '/about/:path*',
-};
-
-

For more info see: https://nextjs.org/docs/advanced-features/middleware#matching-paths

-

To run custom middleware for authenticated users:

- 
// middleware.js
-import { withMiddlewareAuthRequired, getSession } from '@auth0/nextjs-auth0/middleware';
-
-export default withMiddlewareAuthRequired(async function middleware(req) {
-  const res = NextResponse.next();
-  const user = await getSession(req, res);
-  res.cookies.set('hl', user.language);
-  return res;
-});
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (middleware?: NextMiddleware): NextMiddleware
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        Optional middleware: NextMiddleware
        -
        • -
      -

      Returns NextMiddleware

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/helpers_with_page_auth_required.html b/docs/modules/helpers_with_page_auth_required.html deleted file mode 100644 index 939d77628..000000000 --- a/docs/modules/helpers_with_page_auth_required.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - helpers/with-page-auth-required | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module helpers/with-page-auth-required

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

GetServerSidePropsResultWithSession

-
GetServerSidePropsResultWithSession<P>: GetServerSidePropsResult<P & { user?: Claims | null }>
- -
-
-

If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with - the user property, which will be the user's Claims.

-
- 
// pages/profile.js
-import { withPageAuthRequired } from '@auth0/nextjs-auth0';
-
-export default function Profile({ user }) {
-  return <div>Hello {user.name}</div>;
-}
-
-export const getServerSideProps = withPageAuthRequired();
-
-
-

Type parameters

-
    -
  • -

    P = any

    -
    • -
-
-
- -

PageRoute

-
PageRoute<P, Q>: (cts: GetServerSidePropsContext<Q>) => Promise<GetServerSidePropsResultWithSession<P>>
- -
-
-

A page route that has been augmented with WithPageAuthRequired.

-
-
-

Type parameters

-
    -
  • -

    P

    -
    • -
  • -

    Q: ParsedUrlQuery = ParsedUrlQuery

    -
    • -
-
-

Type declaration

- -
-
-
- -

WithPageAuthRequired

-
WithPageAuthRequired: <P, Q>(opts?: WithPageAuthRequiredOptions<P, Q>) => PageRoute<P, Q>
- -
-
-

Wrap your getServerSideProps with this method to make sure the user is authenticated before - visiting the page.

-
- 
// pages/protected-page.js
-import { withPageAuthRequired } from '@auth0/nextjs-auth0';
-
-export default function ProtectedPage() {
-  return <div>Protected content</div>;
-}
-
-export const getServerSideProps = withPageAuthRequired();
-
-

If the user visits /protected-page without a valid session, it will redirect the user to the - login page. Then they will be returned to /protected-page after login.

-
-
-

Type declaration

- -
-
-
- -

WithPageAuthRequiredOptions

-
WithPageAuthRequiredOptions<P, Q>: { getServerSideProps?: GetServerSideProps<P, Q>; returnTo?: string }
- -
-
-

If you have a custom returnTo url you should specify it in returnTo.

-
-

You can pass in your own getServerSideProps method, the props returned from this will be - merged with the user props. You can also access the user session data by calling getSession - inside of this method. For example:

- 
// pages/protected-page.js
-import { getSession, withPageAuthRequired } from '@auth0/nextjs-auth0';
-
-export default function ProtectedPage({ user, customProp }) {
-  return <div>Protected content</div>;
-}
-
-export const getServerSideProps = withPageAuthRequired({
-  // returnTo: '/unauthorized',
-  async getServerSideProps(ctx) {
-    // access the user session if needed
-    // const session = await getSession(ctx.req, ctx.res);
-    return { 
-      props: { 
-        // customProp: 'bar',
-      }
-    };
-  }
-});
-
-
-

Type parameters

-
    -
  • -

    P = any

    -
    • -
  • -

    Q: ParsedUrlQuery = ParsedUrlQuery

    -
    • -
-
-

Type declaration

-
    -
  • -
    Optional getServerSideProps?: GetServerSideProps<P, Q>
    -
    • -
  • -
    Optional returnTo?: string
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html deleted file mode 100644 index 270c33364..000000000 --- a/docs/modules/index.html +++ /dev/null @@ -1,1127 +0,0 @@ - - - - - - index | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module index

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-

Classes

- -
-
-

Server Interfaces

- -
-
-

Other Type aliases

- -

Server Type aliases

- -
-
-

Functions

- -
-
-
-
-
-

References

-
- -

AccessTokenError

- Re-exports AccessTokenError -
-
- -

AccessTokenErrorCode

- Re-exports AccessTokenErrorCode -
-
- -

AccessTokenRequest

- Re-exports AccessTokenRequest -
-
- -

AfterCallback

- Re-exports AfterCallback -
-
- -

AfterRefetch

- Re-exports AfterRefetch -
-
- -

AuthError

- Re-exports AuthError -
-
- -

CallbackHandlerError

- Re-exports CallbackHandlerError -
-
- -

CallbackOptions

- Re-exports CallbackOptions -
-
- -

Claims

- Re-exports Claims -
-
- -

ConfigParameters

- Re-exports ConfigParameters -
-
- -

GetAccessToken

- Re-exports GetAccessToken -
-
- -

GetAccessTokenResult

- Re-exports GetAccessTokenResult -
-
- -

GetLoginState

- Re-exports GetLoginState -
-
- -

GetServerSidePropsResultWithSession

- Re-exports GetServerSidePropsResultWithSession -
-
- -

GetSession

- Re-exports GetSession -
-
- -

HandleAuth

- Re-exports HandleAuth -
-
- -

HandleCallback

- Re-exports HandleCallback -
-
- -

HandleLogin

- Re-exports HandleLogin -
-
- -

HandleLogout

- Re-exports HandleLogout -
-
- -

HandleProfile

- Re-exports HandleProfile -
-
- -

HandlerError

- Re-exports HandlerError -
-
- -

Handlers

- Re-exports Handlers -
-
- -

LoginHandlerError

- Re-exports LoginHandlerError -
-
- -

LoginOptions

- Re-exports LoginOptions -
-
- -

LogoutHandlerError

- Re-exports LogoutHandlerError -
-
- -

LogoutOptions

- Re-exports LogoutOptions -
-
- -

OnError

- Re-exports OnError -
-
- -

PageRoute

- Re-exports PageRoute -
-
- -

ProfileHandlerError

- Re-exports ProfileHandlerError -
-
- -

ProfileOptions

- Re-exports ProfileOptions -
-
- -

Session

- Renames and exports default -
-
- -

UpdateSession

- Re-exports UpdateSession -
-
- -

WithApiAuthRequired

- Re-exports WithApiAuthRequired -
-
- -

WithPageAuthRequired

- Re-exports WithPageAuthRequired -
-
- -

WithPageAuthRequiredOptions

- Re-exports WithPageAuthRequiredOptions -
-
-
-

Other Type aliases

-
- -

SessionStore

-
SessionStore: GenericSessionStore<default>
- -
-
- -

SessionStorePayload

-
SessionStorePayload: SessionPayload<default>
- -
-
-
-

Server Type aliases

-
- -

InitAuth0

-
InitAuth0: (params?: ConfigParameters) => Auth0Server
- -
-
-

Initialise your own instance of the SDK.

-
-

See ConfigParameters.

-
-
-

Type declaration

- -
-
-
-
-

Functions

-
- -

Const _initAuth

- - -
-
- -

Const getAccessToken

- - -
-
- -

Const getSession

-
    -
  • getSession(req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse<any>): Promise<undefined | null | default>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: IncomingMessage | NextApiRequest
      -
      • -
    • -
      res: ServerResponse | NextApiResponse<any>
      -
      • -
    -

    Returns Promise<undefined | null | default>

    -
    • -
-
-
- -

Const handleAuth

-
    -
  • handleAuth(userHandlers?: ApiHandlers | ErrorHandlers): NextApiHandler<any>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      Optional userHandlers: ApiHandlers | ErrorHandlers
      -
      • -
    -

    Returns NextApiHandler<any>

    -
    • -
-
-
- -

Const handleCallback

- - -
-
- -

Const handleLogin

- - -
-
- -

Const handleLogout

- - -
-
- -

Const handleProfile

- - -
-
- -

Const initAuth0

- - -
-
- -

Const updateSession

-
    -
  • updateSession(req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse<any>, user: default): Promise<void>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      req: IncomingMessage | NextApiRequest
      -
      • -
    • -
      res: ServerResponse | NextApiResponse<any>
      -
      • -
    • -
      user: default
      -
      • -
    -

    Returns Promise<void>

    -
    • -
-
-
- -

Const withApiAuthRequired

-
    -
  • withApiAuthRequired(apiRoute: NextApiHandler<any>): NextApiHandler<any>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      apiRoute: NextApiHandler<any>
      -
      • -
    -

    Returns NextApiHandler<any>

    -
    • -
-
-
- -

Const withPageAuthRequired

- - -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/session.html b/docs/modules/session.html deleted file mode 100644 index 1a2da552e..000000000 --- a/docs/modules/session.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - - session | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module session

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

AccessTokenRequest

- Re-exports AccessTokenRequest -
-
- -

Claims

- Re-exports Claims -
-
- -

GetAccessToken

- Re-exports GetAccessToken -
-
- -

GetAccessTokenResult

- Re-exports GetAccessTokenResult -
-
- -

GetSession

- Re-exports GetSession -
-
- -

Session

- Renames and exports default -
-
- -

SessionCache

- Re-exports SessionCache -
-
- -

UpdateSession

- Re-exports UpdateSession -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/session_get_access_token.html b/docs/modules/session_get_access_token.html deleted file mode 100644 index 5e3602667..000000000 --- a/docs/modules/session_get_access_token.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - session/get-access-token | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module session/get-access-token

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Interfaces

- -
-
-

Other Type aliases

- -

Server Type aliases

- -
-
-
-
-
-

Other Type aliases

-
- -

AfterRefresh

-
AfterRefresh: (req: NextApiRequest, res: NextApiResponse, session: default) => Promise<default> | default
- -
-

Type declaration

-
    -
  • - -
      -
    • -

      Parameters

      -
        -
      • -
        req: NextApiRequest
        -
        • -
      • -
        res: NextApiResponse
        -
        • -
      • -
        session: default
        -
        • -
      -

      Returns Promise<default> | default

      -
      • -
    -
    • -
-
-
-
-
-

Server Type aliases

-
- -

GetAccessToken

-
GetAccessToken: (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, accessTokenRequest?: AccessTokenRequest) => Promise<GetAccessTokenResult>
- -
-
-

Get an access token to access an external API.

-
-
-
throws
-

AccessTokenError

-
-
-
-
-

Type declaration

- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/session_get_session.html b/docs/modules/session_get_session.html deleted file mode 100644 index 76da2e402..000000000 --- a/docs/modules/session_get_session.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - session/get-session | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module session/get-session

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

GetSession

-
GetSession: (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse) => Promise<default | null | undefined>
- -
-
-

Get the user's session from the request.

-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse): Promise<default | null | undefined>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: IncomingMessage | NextApiRequest
        -
        • -
      • -
        res: ServerResponse | NextApiResponse
        -
        • -
      -

      Returns Promise<default | null | undefined>

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/session_session.html b/docs/modules/session_session.html deleted file mode 100644 index 766358641..000000000 --- a/docs/modules/session_session.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - session/session | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module session/session

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Classes

- -
-
-

Server Interfaces

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/session_update_session.html b/docs/modules/session_update_session.html deleted file mode 100644 index 1ac9179a4..000000000 --- a/docs/modules/session_update_session.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - session/update-session | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module session/update-session

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Type aliases

- -
-
-
-
-
-

Server Type aliases

-
- -

UpdateSession

-
UpdateSession: (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, user: default) => Promise<void>
- -
-
-

Update the session object. The provided session object will replace the existing session.

-
-

Note you can't use this method to login or logout - you should use the login and logout handlers for this. - If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

- 
// pages/api/update-user.js
-import { getSession, updateSession } from '@auth0/nextjs-auth0';
-
-export default async function updateSession(req, res) {
-  if (req.method === 'PUT') {
-    const session = await getSession(req, res);
-    updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
-    res.json({ success: true });
-  }
-};
-
-
-
-

Type declaration

-
    -
  • -
      -
    • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, user: default): Promise<void>
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        req: IncomingMessage | NextApiRequest
        -
        • -
      • -
        res: ServerResponse | NextApiResponse
        -
        • -
      • -
        user: default
        -
        • -
      -

      Returns Promise<void>

      -
      • -
    -
    • -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/utils_errors.html b/docs/modules/utils_errors.html deleted file mode 100644 index 171e27de8..000000000 --- a/docs/modules/utils_errors.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - utils/errors | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module utils/errors

-
-
-
-
-
-
-
-

Index

-
-
-
-

Server Enumerations

- -
-
-

Server Classes

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/modules/version.html b/docs/modules/version.html deleted file mode 100644 index e508205d5..000000000 --- a/docs/modules/version.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - version | @auth0/nextjs-auth0 - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - -
-
- Menu -
-
-
-
-
-
- -

Module version

-
-
-
-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

default

-
default: "2.1.0"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Function
    • -
  • Function with type parameter
    • -
  • Type alias
    • -
  • Type alias with type parameter
    • -
-
    -
  • Class
    • -
  • Class with type parameter
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/types/AfterCallback.html b/docs/types/AfterCallback.html new file mode 100644 index 000000000..ea8618713 --- /dev/null +++ b/docs/types/AfterCallback.html @@ -0,0 +1,132 @@ +AfterCallback | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias AfterCallback

+
AfterCallback: ((req: NextApiRequest, res: NextApiResponse, session: Session, state?: {
    [key: string]: any;
}) => Promise<Session | undefined> | Session | undefined)
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse, session: Session, state?: {
          [key: string]: any;
      }): Promise<Session | undefined> | Session | undefined
      • +
    • +

      Use this function for validating additional claims on the user's ID token or adding removing items from +the session after login.

      + +

      Example

      Validate additional claims

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      const afterCallback = (req, res, session, state) => {
        if (session.user.isAdmin) {
          return session;
        } else {
          res.status(401).end('User is not admin');
        }
      };

      export default handleAuth({
        async callback(req, res) {
          try {
            await handleCallback(req, res, { afterCallback });
          } catch (error) {
            res.status(error.status || 500).end();
          }
        }
      });
+
      + +

      Example

      Modify the session after login

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      const afterCallback = (req, res, session, state) => {
        session.user.customProperty = 'foo';
        delete session.refreshToken;
        return session;
      };

      export default handleAuth({
        async callback(req, res) {
          try {
            await handleCallback(req, res, { afterCallback });
          } catch (error) {
            res.status(error.status || 500).end();
          }
        }
      });
+
      + +

      Example

      Redirect successful login based on claim

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      const afterCallback = (req, res, session, state) => {
        if (!session.user.isAdmin) {
          res.setHeader('Location', '/admin');
        }
        return session;
      };

      export default handleAuth({
        async callback(req, res) {
          try {
            await handleCallback(req, res, { afterCallback });
          } catch (error) {
            res.status(error.status || 500).end(error.message);
          }
        }
      });
+
      + +

      Throws

      HandlerError

      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse
        • +
      • +
        session: Session
        • +
      • +
        Optional state: {
            [key: string]: any;
        }
        +
          +
        • +
          [key: string]: any
      +

      Returns Promise<Session | undefined> | Session | undefined

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/AfterRefetch.html b/docs/types/AfterRefetch.html new file mode 100644 index 000000000..a2613140d --- /dev/null +++ b/docs/types/AfterRefetch.html @@ -0,0 +1,110 @@ +AfterRefetch | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias AfterRefetch

+
AfterRefetch: ((req: NextApiRequest, res: NextApiResponse, session: Session) => Promise<Session> | Session)
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse, session: Session): Promise<Session> | Session
      • +
    • +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse
        • +
      • +
        session: Session
      +

      Returns Promise<Session> | Session

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/ConfigParameters.html b/docs/types/ConfigParameters.html new file mode 100644 index 000000000..ffeb8096c --- /dev/null +++ b/docs/types/ConfigParameters.html @@ -0,0 +1,168 @@ +ConfigParameters | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias ConfigParameters

+
ConfigParameters: DeepPartial<BaseConfig & NextConfig>
+
+ +

Configuration properties.

+ +

The Server part of the SDK can be configured in 2 ways.

+ + +

1. Environment Variables

+ +

The simplest way to use the SDK is to use the named exports (HandleAuth, HandleLogin, +HandleLogout, HandleCallback, HandleProfile, GetSession, GetAccessToken, +WithApiAuthRequired, and WithPageAuthRequired).

+
// pages/api/auth/[...auth0].js
import { handleAuth } from '@auth0/nextjs-auth0';

return handleAuth();
+
+

When you use these named exports, an instance of the SDK is created for you which you can configure using +environment variables:

+ + +

Required

+ +
    +
  • AUTH0_SECRET: See secret.
    • +
  • AUTH0_ISSUER_BASE_URL: See issuerBaseURL.
    • +
  • AUTH0_BASE_URL: See baseURL.
    • +
  • AUTH0_CLIENT_ID: See clientID.
    • +
  • AUTH0_CLIENT_SECRET: See clientSecret.
    • +
+ + +

Optional

+ +
    +
  • AUTH0_CLOCK_TOLERANCE: See clockTolerance.
    • +
  • AUTH0_HTTP_TIMEOUT: See httpTimeout.
    • +
  • AUTH0_ENABLE_TELEMETRY: See enableTelemetry.
    • +
  • AUTH0_IDP_LOGOUT: See idpLogout.
    • +
  • AUTH0_ID_TOKEN_SIGNING_ALG: See idTokenSigningAlg.
    • +
  • AUTH0_LEGACY_SAME_SITE_COOKIE: See legacySameSiteCookie.
    • +
  • AUTH0_IDENTITY_CLAIM_FILTER: See identityClaimFilter.
    • +
  • NEXT_PUBLIC_AUTH0_LOGIN: See NextConfig.routes.
    • +
  • AUTH0_CALLBACK: See BaseConfig.routes.
    • +
  • AUTH0_POST_LOGOUT_REDIRECT: See BaseConfig.routes.
    • +
  • AUTH0_AUDIENCE: See BaseConfig.authorizationParams.
    • +
  • AUTH0_SCOPE: See BaseConfig.authorizationParams.
    • +
  • AUTH0_ORGANIZATION: See NextConfig.organization.
    • +
  • AUTH0_SESSION_NAME: See SessionConfig.name.
    • +
  • AUTH0_SESSION_ROLLING: See SessionConfig.rolling.
    • +
  • AUTH0_SESSION_ROLLING_DURATION: See SessionConfig.rollingDuration.
    • +
  • AUTH0_SESSION_ABSOLUTE_DURATION: See SessionConfig.absoluteDuration.
    • +
  • AUTH0_COOKIE_DOMAIN: See CookieConfig.domain.
    • +
  • AUTH0_COOKIE_PATH: See CookieConfig.path.
    • +
  • AUTH0_COOKIE_TRANSIENT: See CookieConfig.transient.
    • +
  • AUTH0_COOKIE_HTTP_ONLY: See CookieConfig.httpOnly.
    • +
  • AUTH0_COOKIE_SECURE: See CookieConfig.secure.
    • +
  • AUTH0_COOKIE_SAME_SITE: See CookieConfig.sameSite.
    • +
  • AUTH0_CLIENT_ASSERTION_SIGNING_KEY: See BaseConfig.clientAssertionSigningKey
    • +
  • AUTH0_CLIENT_ASSERTION_SIGNING_ALG: See BaseConfig.clientAssertionSigningAlg
    • +
+ + +

2. Create your own instance using InitAuth0

+ +

If you don't want to configure the SDK with environment variables or you want more fine grained control over the +instance, you can create an instance yourself and use the handlers and helpers from that.

+

First, export your configured instance from another module:

+
// utils/auth0.js
import { initAuth0 } from '@auth0/nextjs-auth0';

export default initAuth0({ ...ConfigParameters... });
+
+

Then import it into your route handler:

+
// pages/api/auth/[...auth0].js
import auth0 from '../../../../utils/auth0';

return auth0.handleAuth();
+
+

IMPORTANT If you use InitAuth0, you should not use the other named exports as they will use a different +instance of the SDK. Also note - this is for the server side part of the SDK - you will always use named exports for +the front end components: {@Link UserProvider}, {@Link UseUser} and the +front end version of {@Link WithPageAuthRequired}

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/GetAccessToken.html b/docs/types/GetAccessToken.html new file mode 100644 index 000000000..03e2ea861 --- /dev/null +++ b/docs/types/GetAccessToken.html @@ -0,0 +1,114 @@ +GetAccessToken | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias GetAccessToken

+
GetAccessToken: ((req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, accessTokenRequest?: AccessTokenRequest) => Promise<GetAccessTokenResult>)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/GetLoginState.html b/docs/types/GetLoginState.html new file mode 100644 index 000000000..597ed07e7 --- /dev/null +++ b/docs/types/GetLoginState.html @@ -0,0 +1,115 @@ +GetLoginState | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias GetLoginState

+
GetLoginState: ((req: NextApiRequest, options: LoginOptions) => {
    [key: string]: any;
})
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, options: LoginOptions): {
          [key: string]: any;
      }
      • +
    • +

      Use this to store additional state for the user before they visit the identity provider to log in.

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      const getLoginState = (req, loginOptions) => {
        return { basket_id: getBasketId(req) };
      };

      export default handleAuth({
        async login(req, res) {
          try {
            await handleLogin(req, res, { getLoginState });
          } catch (error) {
            res.status(error.status || 500).end();
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
      +

      Returns {
          [key: string]: any;
      }

      +
        +
      • +
        [key: string]: any
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/GetServerSidePropsResultWithSession.html b/docs/types/GetServerSidePropsResultWithSession.html new file mode 100644 index 000000000..7cadea37a --- /dev/null +++ b/docs/types/GetServerSidePropsResultWithSession.html @@ -0,0 +1,103 @@ +GetServerSidePropsResultWithSession | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias GetServerSidePropsResultWithSession<P>

+
GetServerSidePropsResultWithSession<P>: GetServerSidePropsResult<P & {
    user: Claims;
}>
+

If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with +the user property, which will be the user's Claims.

+
// pages/profile.js
import { withPageAuthRequired } from '@auth0/nextjs-auth0';

export default function Profile({ user }) {
  return <div>Hello {user.name}</div>;
}

export const getServerSideProps = withPageAuthRequired();
+
+
+
+

Type Parameters

+
    +
  • +

    P = any

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/GetSession.html b/docs/types/GetSession.html new file mode 100644 index 000000000..31a8b46a9 --- /dev/null +++ b/docs/types/GetSession.html @@ -0,0 +1,110 @@ +GetSession | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias GetSession

+
GetSession: ((req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse) => Promise<Session | null | undefined>)
+
+

Type declaration

+
    +
  • +
      +
    • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse): Promise<Session | null | undefined>
      • +
    • +

      Get the user's session from the request.

      +
      +
      +

      Parameters

      +
        +
      • +
        req: IncomingMessage | NextApiRequest
        • +
      • +
        res: ServerResponse | NextApiResponse
      +

      Returns Promise<Session | null | undefined>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/HandleAuth.html b/docs/types/HandleAuth.html new file mode 100644 index 000000000..0c19481ac --- /dev/null +++ b/docs/types/HandleAuth.html @@ -0,0 +1,120 @@ +HandleAuth | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias HandleAuth

+
HandleAuth: ((userHandlers?: Handlers) => NextApiHandler)
+
+

Type declaration

+
    +
  • +
      +
    • (userHandlers?: Handlers): NextApiHandler
      • +
    • +

      The main way to use the server SDK.

      +

      Simply set the environment variables per ConfigParameters then create the file +pages/api/auth/[...auth0].js. For example:

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth } from '@auth0/nextjs-auth0';

      export default handleAuth();
+
      +

      This will create 5 handlers for the following urls:

      +
        +
      • /api/auth/login: log the user in to your app by redirecting them to your identity provider.
        • +
      • /api/auth/callback: The page that your identity provider will redirect the user back to on login.
        • +
      • /api/auth/logout: log the user out of your app.
        • +
      • /api/auth/me: View the user profile JSON (used by the UseUser hook).
        • +
      • /api/auth/unauthorized: Returns a 401 for use by WithMiddlewareAuthRequired when protecting API routes.
        • +
      +
      +
      +

      Parameters

      +
      +

      Returns NextApiHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/HandleCallback.html b/docs/types/HandleCallback.html new file mode 100644 index 000000000..50a076a2c --- /dev/null +++ b/docs/types/HandleCallback.html @@ -0,0 +1,174 @@ +HandleCallback | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias HandleCallback

+
HandleCallback: {
    (req: NextApiRequest, res: NextApiResponse<any>, options?: CallbackOptions): Promise<void>;
    (provider: CallbackOptionsProvider): CallbackHandler;
    (options: CallbackOptions): CallbackHandler;
}
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse<any>, options?: CallbackOptions): Promise<void>
      • +
    • +

      Use this to customize the default callback handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback({ redirectUri: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback((req) => {
          return { redirectUri: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the callback handler

      +
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: async (req, res) => {
          try {
            await handleCallback(req, res, {
              redirectUri: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse<any>
        • +
      • +
        Optional options: CallbackOptions
      +

      Returns Promise<void>

      • +
    • (provider: CallbackOptionsProvider): CallbackHandler
      • +
    • +

      Use this to customize the default callback handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback({ redirectUri: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback((req) => {
          return { redirectUri: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the callback handler

      +
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: async (req, res) => {
          try {
            await handleCallback(req, res, {
              redirectUri: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        provider: CallbackOptionsProvider
      +

      Returns CallbackHandler

      • +
    • (options: CallbackOptions): CallbackHandler
      • +
    • +

      Use this to customize the default callback handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback({ redirectUri: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: handleCallback((req) => {
          return { redirectUri: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the callback handler

      +
      import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

      export default handleAuth({
        callback: async (req, res) => {
          try {
            await handleCallback(req, res, {
              redirectUri: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
      +

      Returns CallbackHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/HandleLogin.html b/docs/types/HandleLogin.html new file mode 100644 index 000000000..8ce2b4dcc --- /dev/null +++ b/docs/types/HandleLogin.html @@ -0,0 +1,174 @@ +HandleLogin | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias HandleLogin

+
HandleLogin: {
    (req: NextApiRequest, res: NextApiResponse<any>, options?: LoginOptions): Promise<void>;
    (provider: LoginOptionsProvider): LoginHandler;
    (options: LoginOptions): LoginHandler;
}
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse<any>, options?: LoginOptions): Promise<void>
      • +
    • +

      Use this to customize the default login handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin({
          authorizationParams: { connection: 'github' }
        })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin((req) => {
          return {
            authorizationParams: { connection: 'github' }
          };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the login handler

      +
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: async (req, res) => {
          try {
            await handleLogin(req, res, {
              authorizationParams: { connection: 'github' }
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse<any>
        • +
      • +
        Optional options: LoginOptions
      +

      Returns Promise<void>

      • +
    • (provider: LoginOptionsProvider): LoginHandler
      • +
    • +

      Use this to customize the default login handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin({
          authorizationParams: { connection: 'github' }
        })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin((req) => {
          return {
            authorizationParams: { connection: 'github' }
          };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the login handler

      +
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: async (req, res) => {
          try {
            await handleLogin(req, res, {
              authorizationParams: { connection: 'github' }
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        provider: LoginOptionsProvider
      +

      Returns LoginHandler

      • +
    • (options: LoginOptions): LoginHandler
      • +
    • +

      Use this to customize the default login handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin({
          authorizationParams: { connection: 'github' }
        })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: handleLogin((req) => {
          return {
            authorizationParams: { connection: 'github' }
          };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the login handler

      +
      import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

      export default handleAuth({
        login: async (req, res) => {
          try {
            await handleLogin(req, res, {
              authorizationParams: { connection: 'github' }
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
      +

      Returns LoginHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/HandleLogout.html b/docs/types/HandleLogout.html new file mode 100644 index 000000000..d5dc31fe4 --- /dev/null +++ b/docs/types/HandleLogout.html @@ -0,0 +1,174 @@ +HandleLogout | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias HandleLogout

+
HandleLogout: {
    (req: NextApiRequest, res: NextApiResponse<any>, options?: LogoutOptions): Promise<void>;
    (provider: LogoutOptionsProvider): LogoutHandler;
    (options: LogoutOptions): LogoutHandler;
}
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse<any>, options?: LogoutOptions): Promise<void>
      • +
    • +

      Use this to customize the default logout handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout({ returnTo: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout((req) => {
          return { returnTo: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the logout handler

      +
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: async (req, res) => {
          try {
            await handleLogout(req, res, {
              returnTo: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse<any>
        • +
      • +
        Optional options: LogoutOptions
      +

      Returns Promise<void>

      • +
    • (provider: LogoutOptionsProvider): LogoutHandler
      • +
    • +

      Use this to customize the default logout handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout({ returnTo: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout((req) => {
          return { returnTo: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the logout handler

      +
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: async (req, res) => {
          try {
            await handleLogout(req, res, {
              returnTo: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        provider: LogoutOptionsProvider
      +

      Returns LogoutHandler

      • +
    • (options: LogoutOptions): LogoutHandler
      • +
    • +

      Use this to customize the default logout handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout({ returnTo: 'https://example.com' })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: handleLogout((req) => {
          return { returnTo: 'https://example.com' };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the logout handler

      +
      import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

      export default handleAuth({
        logout: async (req, res) => {
          try {
            await handleLogout(req, res, {
              returnTo: 'https://example.com'
            });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
      +

      Returns LogoutHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/HandleProfile.html b/docs/types/HandleProfile.html new file mode 100644 index 000000000..44c557aa3 --- /dev/null +++ b/docs/types/HandleProfile.html @@ -0,0 +1,174 @@ +HandleProfile | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias HandleProfile

+
HandleProfile: {
    (req: NextApiRequest, res: NextApiResponse<any>, options?: ProfileOptions): Promise<void>;
    (provider: ProfileOptionsProvider): ProfileHandler;
    (options: ProfileOptions): ProfileHandler;
}
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse<any>, options?: ProfileOptions): Promise<void>
      • +
    • +

      Use this to customize the default profile handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile({ refetch: true })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile((req) => {
          return { refetch: true };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the profile handler

      +
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: async (req, res) => {
          try {
            await handleProfile(req, res, { refetch: true });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse<any>
        • +
      • +
        Optional options: ProfileOptions
      +

      Returns Promise<void>

      • +
    • (provider: ProfileOptionsProvider): ProfileHandler
      • +
    • +

      Use this to customize the default profile handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile({ refetch: true })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile((req) => {
          return { refetch: true };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the profile handler

      +
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: async (req, res) => {
          try {
            await handleProfile(req, res, { refetch: true });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        provider: ProfileOptionsProvider
      +

      Returns ProfileHandler

      • +
    • (options: ProfileOptions): ProfileHandler
      • +
    • +

      Use this to customize the default profile handler without overriding it. +You can still override the handler if needed.

      + +

      Example

      Pass an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile({ refetch: true })
      });
+
      + +

      Example

      Pass a function that receives the request and returns an options object

      +
      // pages/api/auth/[...auth0].js
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: handleProfile((req) => {
          return { refetch: true };
        })
      });
+
      +

      This is useful for generating options that depend on values from the request.

      + +

      Example

      Override the profile handler

      +
      import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

      export default handleAuth({
        profile: async (req, res) => {
          try {
            await handleProfile(req, res, { refetch: true });
          } catch (error) {
            console.error(error);
          }
        }
      });
+
      +
      +
      +

      Parameters

      +
      +

      Returns ProfileHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/Handlers.html b/docs/types/Handlers.html new file mode 100644 index 000000000..7b1eadaac --- /dev/null +++ b/docs/types/Handlers.html @@ -0,0 +1,104 @@ +Handlers | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias Handlers

+
Handlers: ApiHandlers | ErrorHandlers
+

If you want to add some custom behavior to the default auth handlers, you can pass in custom handlers for +login, logout, callback, and profile. For example:

+
// pages/api/auth/[...auth0].js
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
import { errorReporter, logger } from '../../../utils';

export default handleAuth({
  async login(req, res) {
    try {
       // Pass in custom params to your handler
      await handleLogin(req, res, { authorizationParams: { customParam: 'foo' } });
      // Add your own custom logging.
      logger('Redirecting to login');
    } catch (error) {
      // Add you own custom error logging.
      errorReporter(error);
      res.status(error.status || 500).end();
    }
  }
});
+
+

Alternatively, you can customize the default handlers without overriding them. For example:

+
// pages/api/auth/[...auth0].js
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

export default handleAuth({
  login: handleLogin({
    authorizationParams: { customParam: 'foo' } // Pass in custom params
  })
});
+
+

You can also create new handlers by customizing the default ones. For example:

+
// pages/api/auth/[...auth0].js
import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

export default handleAuth({
  signup: handleLogin({
    authorizationParams: { screen_hint: 'signup' }
  })
});
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/InitAuth0.html b/docs/types/InitAuth0.html new file mode 100644 index 000000000..dea3c04d8 --- /dev/null +++ b/docs/types/InitAuth0.html @@ -0,0 +1,109 @@ +InitAuth0 | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias InitAuth0

+
InitAuth0: ((params?: ConfigParameters) => Auth0Server)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/OnError.html b/docs/types/OnError.html new file mode 100644 index 000000000..7534a171c --- /dev/null +++ b/docs/types/OnError.html @@ -0,0 +1,115 @@ +OnError | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias OnError

+
OnError: ((req: NextApiRequest, res: NextApiResponse, error: HandlerError) => Promise<void> | void)
+
+

Type declaration

+
    +
  • +
      +
    • (req: NextApiRequest, res: NextApiResponse, error: HandlerError): Promise<void> | void
      • +
    • +

      Error handler for the default auth routes.

      +

      Use this to define an error handler for all the default routes in a single place. For example:

      +
      export default handleAuth({
        onError(req, res, error) {
          errorLogger(error);
          // You can finish the response yourself if you want to customize
          // the status code or redirect the user
          // res.writeHead(302, {
          //     Location: '/custom-error-page'
          // });
          // res.end();
        }
      });
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: NextApiRequest
        • +
      • +
        res: NextApiResponse
        • +
      • +
        error: HandlerError
      +

      Returns Promise<void> | void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/PageRoute.html b/docs/types/PageRoute.html new file mode 100644 index 000000000..9947780d7 --- /dev/null +++ b/docs/types/PageRoute.html @@ -0,0 +1,115 @@ +PageRoute | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias PageRoute<P, Q>

+
PageRoute<P, Q>: ((cts: GetServerSidePropsContext<Q>) => Promise<GetServerSidePropsResultWithSession<P>>)
+
+

Type Parameters

+
    +
  • +

    P

    • +
  • +

    Q extends ParsedUrlQuery = ParsedUrlQuery

+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/ProfileOptions.html b/docs/types/ProfileOptions.html new file mode 100644 index 000000000..7586d01f2 --- /dev/null +++ b/docs/types/ProfileOptions.html @@ -0,0 +1,111 @@ +ProfileOptions | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias ProfileOptions

+
ProfileOptions: {
    afterRefetch?: AfterRefetch;
    refetch?: boolean;
}
+

Options to customize the profile handler.

+ +

See

HandleProfile

+
+
+

Type declaration

+
    +
  • +
    Optional afterRefetch?: AfterRefetch
    +

    Like AfterCallback and AfterRefresh when a session is created, you can use +this function to validate or add/remove claims after the session is updated. Will only run if +ProfileOptions.refetch is true.

    +
    • +
  • +
    Optional refetch?: boolean
    +

    If set to true this will refetch the user profile information from /userinfo and save it +to the session.

    +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/SessionStore.html b/docs/types/SessionStore.html new file mode 100644 index 000000000..add9d5692 --- /dev/null +++ b/docs/types/SessionStore.html @@ -0,0 +1,93 @@ +SessionStore | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias SessionStore

+
SessionStore: GenericSessionStore<Session>
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/SessionStorePayload.html b/docs/types/SessionStorePayload.html new file mode 100644 index 000000000..0e7502dca --- /dev/null +++ b/docs/types/SessionStorePayload.html @@ -0,0 +1,93 @@ +SessionStorePayload | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias SessionStorePayload

+
SessionStorePayload: SessionPayload<Session>
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/UpdateSession.html b/docs/types/UpdateSession.html new file mode 100644 index 000000000..3939bc377 --- /dev/null +++ b/docs/types/UpdateSession.html @@ -0,0 +1,116 @@ +UpdateSession | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias UpdateSession

+
UpdateSession: ((req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, user: Session) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, user: Session): Promise<void>
      • +
    • +

      Update the session object. The provided session object will replace the existing session.

      +

      Note you can't use this method to login or logout - you should use the login and logout handlers for this. +If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

      +
      // pages/api/update-user.js
      import { getSession, updateSession } from '@auth0/nextjs-auth0';

      export default async function updateSession(req, res) {
        if (req.method === 'PUT') {
          const session = await getSession(req, res);
          updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
          res.json({ success: true });
        }
      };
+
      +
      +
      +

      Parameters

      +
        +
      • +
        req: IncomingMessage | NextApiRequest
        • +
      • +
        res: ServerResponse | NextApiResponse
        • +
      • +
        user: Session
      +

      Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/WithApiAuthRequired.html b/docs/types/WithApiAuthRequired.html new file mode 100644 index 000000000..e96850899 --- /dev/null +++ b/docs/types/WithApiAuthRequired.html @@ -0,0 +1,112 @@ +WithApiAuthRequired | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias WithApiAuthRequired

+
WithApiAuthRequired: ((apiRoute: NextApiHandler) => NextApiHandler)
+
+

Type declaration

+
    +
  • +
      +
    • (apiRoute: NextApiHandler): NextApiHandler
      • +
    • +

      Wrap an API route to check that the user has a valid session. If they're not logged in the +handler will return a 401 Unauthorized.

      +
      // pages/api/protected-route.js
      import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';

      export default withApiAuthRequired(function ProtectedRoute(req, res) {
        const session = getSession(req, res);
        ...
      });
+
      +

      If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

      +
      +
      +

      Parameters

      +
        +
      • +
        apiRoute: NextApiHandler
      +

      Returns NextApiHandler

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/WithPageAuthRequired.html b/docs/types/WithPageAuthRequired.html new file mode 100644 index 000000000..14963096b --- /dev/null +++ b/docs/types/WithPageAuthRequired.html @@ -0,0 +1,120 @@ +WithPageAuthRequired | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias WithPageAuthRequired

+
WithPageAuthRequired: (<P, Q>(opts?: WithPageAuthRequiredOptions<P, Q>) => PageRoute<P, Q>)
+
+

Type declaration

+
    +
  • +
      +
    • <P, Q>(opts?: WithPageAuthRequiredOptions<P, Q>): PageRoute<P, Q>
      • +
    • +

      Wrap your getServerSideProps with this method to make sure the user is authenticated before +visiting the page.

      +
      // pages/protected-page.js
      import { withPageAuthRequired } from '@auth0/nextjs-auth0';

      export default function ProtectedPage() {
        return <div>Protected content</div>;
      }

      export const getServerSideProps = withPageAuthRequired();
+
      +

      If the user visits /protected-page without a valid session, it will redirect the user to the +login page. Then they will be returned to /protected-page after login.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        P extends {
            [key: string]: any;
        } = {
            [key: string]: any;
        }

        • +
      • +

        Q extends ParsedUrlQuery = ParsedUrlQuery

      +
      +

      Parameters

      +
      +

      Returns PageRoute<P, Q>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/WithPageAuthRequiredOptions.html b/docs/types/WithPageAuthRequiredOptions.html new file mode 100644 index 000000000..e46b0b48c --- /dev/null +++ b/docs/types/WithPageAuthRequiredOptions.html @@ -0,0 +1,114 @@ +WithPageAuthRequiredOptions | @auth0/nextjs-auth0
+
+ +
+
+
+
+ +

Type alias WithPageAuthRequiredOptions<P, Q>

+
WithPageAuthRequiredOptions<P, Q>: {
    getServerSideProps?: GetServerSideProps<P, Q>;
    returnTo?: string;
}
+

If you have a custom returnTo url you should specify it in returnTo.

+

You can pass in your own getServerSideProps method, the props returned from this will be +merged with the user props. You can also access the user session data by calling getSession +inside of this method. For example:

+
// pages/protected-page.js
import { getSession, withPageAuthRequired } from '@auth0/nextjs-auth0';

export default function ProtectedPage({ user, customProp }) {
  return <div>Protected content</div>;
}

export const getServerSideProps = withPageAuthRequired({
  // returnTo: '/unauthorized',
  async getServerSideProps(ctx) {
    // access the user session if needed
    // const session = await getSession(ctx.req, ctx.res);
    return {
      props: {
        // customProp: 'bar',
      }
    };
  }
});
+
+
+
+

Type Parameters

+
    +
  • +

    P extends {
        [key: string]: any;
    } = {
        [key: string]: any;
    }

    • +
  • +

    Q extends ParsedUrlQuery = ParsedUrlQuery

+
+

Type declaration

+
    +
  • +
    Optional getServerSideProps?: GetServerSideProps<P, Q>
    • +
  • +
    Optional returnTo?: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index f4a60a5e0..b11aee9ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/nextjs-auth0", - "version": "2.1.0", + "version": "2.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/nextjs-auth0", - "version": "2.1.0", + "version": "2.2.0", "license": "MIT", "dependencies": { "@panva/hkdf": "^1.0.2", diff --git a/package.json b/package.json index c4453711a..f0aa65708 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/nextjs-auth0", - "version": "2.1.0", + "version": "2.2.0", "description": "Next.js SDK for signing in with Auth0", "exports": { ".": "./dist/index.js", diff --git a/src/version.ts b/src/version.ts index 6bbb04c10..d6aa1be8a 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.1.0'; +export default '2.2.0';