diff --git a/.circleci/config.yml b/.circleci/config.yml index b5c421776..a5897850d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -193,7 +193,6 @@ workflows: requires: - build - ship/node-publish: - publish-command: npm publish --tag beta context: - publish-npm - publish-gh diff --git a/CHANGELOG.md b/CHANGELOG.md index d27c902c0..fe60ac96b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,31 @@ # Change Log +## [v2.0.0](https://github.com/auth0/auth0-spa-js/tree/v2.0.0) (2022-10-27) + +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.22.5...v2.0.0) + +Auth0-SPA-JS v2 includes many significant changes compared to v1: + +- Refactor module output and avoid default export [#942](https://github.com/auth0/auth0-spa-js/pull/942) ([frederikprijck](https://github.com/frederikprijck)) +- Do not throw from `checkSession` [#943](https://github.com/auth0/auth0-spa-js/pull/943) ([frederikprijck](https://github.com/frederikprijck)) +- Rework `ignoreCache` to `cacheMode` and introduce `cache-only` [#950](https://github.com/auth0/auth0-spa-js/pull/950) ([ewanharris](https://github.com/ewanharris)) +- Do not fallback to refreshing tokens via iframe method by default [#946](https://github.com/auth0/auth0-spa-js/pull/946) ([ewanharris](https://github.com/ewanharris)) +- Use form-encoded data by default [#945](https://github.com/auth0/auth0-spa-js/pull/945) ([frederikprijck](https://github.com/frederikprijck)) +- Remove `getIdTokenClaimsOptions` type [#960](https://github.com/auth0/auth0-spa-js/pull/960) ([ewanharris](https://github.com/ewanharris)) +- Rename `client_id` to `clientId` [#956](https://github.com/auth0/auth0-spa-js/pull/956) ([ewanharris](https://github.com/ewanharris)) +- Remove polyfills from bundles [#951](https://github.com/auth0/auth0-spa-js/pull/951) ([frederikprijck](https://github.com/frederikprijck)) +- Update output target to **ES2017** [#953](https://github.com/auth0/auth0-spa-js/pull/953) ([frederikprijck](https://github.com/frederikprijck)) +- Introduce `authorizationParams` to hold properties sent to Auth0 [#959](https://github.com/auth0/auth0-spa-js/pull/959) ([ewanharris](https://github.com/ewanharris)) +- Do not build Common JS module with externals [#971](https://github.com/auth0/auth0-spa-js/pull/971) ([frederikprijck](https://github.com/frederikprijck)) +- De-dupe Id token; getUser and getIdTokenClaims no longer take any arguments [#967](https://github.com/auth0/auth0-spa-js/pull/967) ([frederikprijck](https://github.com/frederikprijck)) +- Remove `advancedOptions.defaultScope` and replace with `scope` [#972](https://github.com/auth0/auth0-spa-js/pull/972) ([ewanharris](https://github.com/ewanharris)) +- Cache and return id token from memory [#975](https://github.com/auth0/auth0-spa-js/pull/975) ([ewanharris](https://github.com/ewanharris)) +- Remove `buildAuthorizeUrl` [#980](https://github.com/auth0/auth0-spa-js/pull/980) ([frederikprijck](https://github.com/frederikprijck)) +- Make `buildLogoutUrl` internal [#982](https://github.com/auth0/auth0-spa-js/pull/982) ([ewanharris](https://github.com/ewanharris)) +- Fix spelling mistakes in id token validation messages [#940](https://github.com/auth0/auth0-spa-js/pull/940) ([frederikprijck](https://github.com/frederikprijck)) + +As with any major version bump, v2 of Auth0-SPA-JS contains a set of breaking changes. **Please review [the migration guide](./MIGRATION_GUIDE.md) thoroughly to understand the changes required to migrate your application to v2.** + ## [v2.0.0-beta.1](https://github.com/auth0/auth0-spa-js/tree/v2.0.0-beta.1) (2022-10-12) [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.0-beta.0...v2.0.0-beta.1) @@ -11,7 +37,7 @@ ## [v2.0.0-beta.0](https://github.com/auth0/auth0-spa-js/tree/v2.0.0-beta.0) (2022-10-01) -[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/master...v2.0.0-beta.0) +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.22.5...v2.0.0-beta.0) Auth0-SPA-JS v2 includes many significant changes compared to v1: diff --git a/README.md b/README.md index 5a69c23dd..469a3ff94 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ ![Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE.](https://cdn.auth0.com/website/sdks/banners/spa-js-banner.png) -> :warning: Please be aware that v2 is currently in [**Beta**](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages). Whilst we encourage you to test the update within your applications, we do no recommend using this version in production yet. Please follow the [migration guide](./MIGRATION_GUIDE.md) when updating your application. - -![Stage: Beta Release](https://img.shields.io/badge/stage-fa-yellow) ![Release](https://img.shields.io/npm/v/@auth0/auth0-spa-js) [![Codecov](https://img.shields.io/codecov/c/github/auth0/auth0-spa-js)](https://codecov.io/gh/auth0/auth0-spa-js) ![Downloads](https://img.shields.io/npm/dw/@auth0/auth0-spa-js) @@ -26,7 +23,7 @@ Using [npm](https://npmjs.org) in your project directory run the following command: ```sh -npm install @auth0/auth0-spa-js@beta +npm install @auth0/auth0-spa-js ``` From the CDN: 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 959edd732..000000000 --- a/docs/assets/css/main.css +++ /dev/null @@ -1,2679 +0,0 @@ -/*! 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 { - 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 */ - /* 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; -} - -/* * - * *Visual Studio-like style based on original C# coloring by Jason Diamond */ -.hljs { - display: inline-block; - padding: 0.5em; - background: white; - color: black; -} - -.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { - color: #008000; -} - -.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { - color: #00f; -} - -.xml .hljs-tag { - color: #00f; -} -.xml .hljs-tag .hljs-value { - color: #00f; -} - -.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { - color: #a31515; -} - -.ruby .hljs-symbol { - color: #a31515; -} -.ruby .hljs-symbol .hljs-string { - color: #a31515; -} - -.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { - color: #a31515; -} - -.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { - color: #2b91af; -} - -.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { - color: #808080; -} - -.vhdl .hljs-typename { - font-weight: bold; -} -.vhdl .hljs-string { - color: #666666; -} -.vhdl .hljs-literal { - color: #a31515; -} -.vhdl .hljs-attribute { - color: #00b0e8; -} - -.xml .hljs-attribute { - color: #f00; -} - -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: -ms-flexbox; - 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: #fdfdfd; - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: #222; -} - -a { - color: #4da6ff; - 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: rgba(0, 0, 0, 0.04); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -.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: #fff; - 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: #fff; - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: #808080; -} -.tsd-breadcrumb a { - color: #808080; - 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 #808080; - color: #808080; - 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-only-exported .tsd-is-not-exported { - 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: #fff; - 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 #eee; - background-color: #fff; -} -footer.with-border-bottom { - border-bottom: 1px solid #eee; -} -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 #eee; -} -.tsd-index-panel ul.tsd-index-list { - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -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 { - -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 { - -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: #9600ff; -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: #7da01f; -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: #cc9900; -} -.tsd-index-panel .tsd-parent-kind-class a { - color: #4da6ff; -} -.tsd-index-panel .tsd-kind-module a { - color: #9600ff; -} -.tsd-index-panel .tsd-kind-interface a { - color: #7da01f; -} -.tsd-index-panel .tsd-kind-enum a { - color: #cc9900; -} -.tsd-index-panel .tsd-kind-class a { - color: #4da6ff; -} -.tsd-index-panel .tsd-is-private a { - color: #808080; -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: #fff; - background-color: #808080; - 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-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: #222; - 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 #eee; -} -.tsd-navigation.primary li { - border-top: 1px solid #eee; -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: #808080; -} -.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: #eee; -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: #000; -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: #eee; -} -.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: #fff; - 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 #eee; -} -.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: #222; -} -#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: #fdfdfd; -} -#tsd-search .results li:nth-child(even) { - background-color: #fff; -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: #eee; -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: #808080; - font-weight: normal; -} -#tsd-search.has-focus { - background-color: #eee; -} -#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 #eee; - 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: #808080; - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid #eee; -} -.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: #eee; -} -.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: #808080; - margin: 0 0 1em 0; -} -.tsd-sources a { - color: #808080; - 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: #333; - background: #fff; - border-bottom: 1px solid #eee; - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: #333; - 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: #eee; -} -.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: #fdfdfd; -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: #fff; -} -.tsd-select .tsd-select-list li:hover { - background-color: #eee; -} -.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%; -} \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 000000000..946807a59 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,120 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #800000; + --dark-hl-1: #808080; + --light-hl-2: #800000; + --dark-hl-2: #569CD6; + --light-hl-3: #000000FF; + --dark-hl-3: #D4D4D4; + --light-hl-4: #FF0000; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #CE9178; + --light-hl-6: #AF00DB; + --dark-hl-6: #C586C0; + --light-hl-7: #001080; + --dark-hl-7: #9CDCFE; + --light-hl-8: #A31515; + --dark-hl-8: #CE9178; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; + --light-hl-10: #0000FF; + --dark-hl-10: #569CD6; + --light-hl-11: #0070C1; + --dark-hl-11: #4FC1FF; + --light-hl-12: #795E26; + --dark-hl-12: #DCDCAA; + --light-hl-13: #267F99; + --dark-hl-13: #4EC9B0; + --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); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --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); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --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); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --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); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --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); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +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 3836d5fe4..000000000 Binary files a/docs/assets/images/icons.png and /dev/null differ diff --git a/docs/assets/images/icons@2x.png b/docs/assets/images/icons@2x.png deleted file mode 100644 index 5a209e2f6..000000000 Binary files a/docs/assets/images/icons@2x.png and /dev/null differ diff --git a/docs/assets/images/widgets.png b/docs/assets/images/widgets.png deleted file mode 100644 index c7380532a..000000000 Binary files a/docs/assets/images/widgets.png and /dev/null differ diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/images/widgets@2x.png deleted file mode 100644 index 4bbbd5727..000000000 Binary files a/docs/assets/images/widgets@2x.png and /dev/null differ diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js deleted file mode 100644 index 39a806694..000000000 --- a/docs/assets/js/main.js +++ /dev/null @@ -1 +0,0 @@ -!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return null==e?"":e.toString()},e.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){for(var t,r;47<(r=(t=this.next()).charCodeAt(0))&&r<58;);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos=this.scrollTop||0===this.scrollTop,isShown!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},Viewport}(typedoc.EventTarget);typedoc.Viewport=Viewport,typedoc.registerService(Viewport,"viewport")}(typedoc||(typedoc={})),function(typedoc){function Component(options){this.el=options.el}typedoc.Component=Component}(typedoc||(typedoc={})),function(typedoc){typedoc.pointerDown="mousedown",typedoc.pointerMove="mousemove",typedoc.pointerUp="mouseup",typedoc.pointerDownPosition={x:0,y:0},typedoc.preventNextClick=!1,typedoc.isPointerDown=!1,typedoc.isPointerTouch=!1,typedoc.hasPointerMoved=!1,typedoc.isMobile=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent),document.documentElement.classList.add(typedoc.isMobile?"is-mobile":"not-mobile"),typedoc.isMobile&&"ontouchstart"in document.documentElement&&(typedoc.isPointerTouch=!0,typedoc.pointerDown="touchstart",typedoc.pointerMove="touchmove",typedoc.pointerUp="touchend"),document.addEventListener(typedoc.pointerDown,function(e){typedoc.isPointerDown=!0,typedoc.hasPointerMoved=!1;var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e;typedoc.pointerDownPosition.y=t.pageY||0,typedoc.pointerDownPosition.x=t.pageX||0}),document.addEventListener(typedoc.pointerMove,function(e){if(typedoc.isPointerDown&&!typedoc.hasPointerMoved){var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e,x=typedoc.pointerDownPosition.x-(t.pageX||0),y=typedoc.pointerDownPosition.y-(t.pageY||0);typedoc.hasPointerMoved=10scrollTop;)index-=1;for(;index"+match+""}),parent=row.parent||"";(parent=parent.replace(new RegExp(this.query,"i"),function(match){return""+match+""}))&&(name=''+parent+"."+name);var item=document.createElement("li");item.classList.value=row.classes,item.innerHTML='\n '+name+"\n ",this.results.appendChild(item)}}},Search.prototype.setLoadingState=function(value){this.loadingState!=value&&(this.el.classList.remove(SearchLoadingState[this.loadingState].toLowerCase()),this.loadingState=value,this.el.classList.add(SearchLoadingState[this.loadingState].toLowerCase()),this.updateResults())},Search.prototype.setHasFocus=function(value){this.hasFocus!=value&&(this.hasFocus=value,this.el.classList.toggle("has-focus"),value?(this.setQuery(""),this.field.value=""):this.field.value=this.query)},Search.prototype.setQuery=function(value){this.query=value.trim(),this.updateResults()},Search.prototype.setCurrentResult=function(dir){var current=this.results.querySelector(".current");if(current){var rel=1==dir?current.nextElementSibling:current.previousElementSibling;rel&&(current.classList.remove("current"),rel.classList.add("current"))}else(current=this.results.querySelector(1==dir?"li:first-child":"li:last-child"))&¤t.classList.add("current")},Search.prototype.gotoCurrentResult=function(){var current=this.results.querySelector(".current");if(current||(current=this.results.querySelector("li:first-child")),current){var link=current.querySelector("a");link&&(window.location.href=link.href),this.field.blur()}},Search.prototype.bindEvents=function(){var _this=this;this.results.addEventListener("mousedown",function(){_this.resultClicked=!0}),this.results.addEventListener("mouseup",function(){_this.resultClicked=!1,_this.setHasFocus(!1)}),this.field.addEventListener("focusin",function(){_this.setHasFocus(!0),_this.loadIndex()}),this.field.addEventListener("focusout",function(){_this.resultClicked?_this.resultClicked=!1:setTimeout(function(){return _this.setHasFocus(!1)},100)}),this.field.addEventListener("input",function(){_this.setQuery(_this.field.value)}),this.field.addEventListener("keydown",function(e){13==e.keyCode||27==e.keyCode||38==e.keyCode||40==e.keyCode?(_this.preventPress=!0,e.preventDefault(),13==e.keyCode?_this.gotoCurrentResult():27==e.keyCode?_this.field.blur():38==e.keyCode?_this.setCurrentResult(-1):40==e.keyCode&&_this.setCurrentResult(1)):_this.preventPress=!1}),this.field.addEventListener("keypress",function(e){_this.preventPress&&e.preventDefault()}),document.body.addEventListener("keydown",function(e){e.altKey||e.ctrlKey||e.metaKey||!_this.hasFocus&&47this.groups.length-1&&(index=this.groups.length-1),this.index!=index){var to=this.groups[index];if(-1{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 j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};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 k{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(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),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(()=>{Ae(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"?fe(e,-1):s.key==="ArrowDown"?fe(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 He(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 Ae(t,e,n,r){if(He(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${pe(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 fe(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 pe(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",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!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&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!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&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,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){H||(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(!H&&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 k{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),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 k{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();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * 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.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * 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 + */ diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 000000000..8cf62a0b9 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"createAuth0Client\",\"url\":\"functions/createAuth0Client.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":128,\"name\":\"Auth0Client\",\"url\":\"classes/Auth0Client.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Auth0Client.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"loginWithPopup\",\"url\":\"classes/Auth0Client.html#loginWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"getUser\",\"url\":\"classes/Auth0Client.html#getUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"getIdTokenClaims\",\"url\":\"classes/Auth0Client.html#getIdTokenClaims\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"loginWithRedirect\",\"url\":\"classes/Auth0Client.html#loginWithRedirect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"handleRedirectCallback\",\"url\":\"classes/Auth0Client.html#handleRedirectCallback\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"checkSession\",\"url\":\"classes/Auth0Client.html#checkSession\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"getTokenSilently\",\"url\":\"classes/Auth0Client.html#getTokenSilently\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"getTokenWithPopup\",\"url\":\"classes/Auth0Client.html#getTokenWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/Auth0Client.html#isAuthenticated\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":2048,\"name\":\"logout\",\"url\":\"classes/Auth0Client.html#logout\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Auth0Client\"},{\"kind\":128,\"name\":\"GenericError\",\"url\":\"classes/GenericError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/GenericError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"GenericError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/GenericError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"GenericError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/GenericError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"GenericError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/GenericError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"GenericError\"},{\"kind\":128,\"name\":\"AuthenticationError\",\"url\":\"classes/AuthenticationError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/AuthenticationError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AuthenticationError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AuthenticationError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"AuthenticationError\"},{\"kind\":1024,\"name\":\"state\",\"url\":\"classes/AuthenticationError.html#state\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthenticationError\"},{\"kind\":1024,\"name\":\"appState\",\"url\":\"classes/AuthenticationError.html#appState\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"AuthenticationError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/AuthenticationError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AuthenticationError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/AuthenticationError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"AuthenticationError\"},{\"kind\":128,\"name\":\"TimeoutError\",\"url\":\"classes/TimeoutError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/TimeoutError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TimeoutError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/TimeoutError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"TimeoutError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/TimeoutError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TimeoutError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/TimeoutError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TimeoutError\"},{\"kind\":128,\"name\":\"PopupTimeoutError\",\"url\":\"classes/PopupTimeoutError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/PopupTimeoutError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupTimeoutError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PopupTimeoutError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"PopupTimeoutError\"},{\"kind\":1024,\"name\":\"popup\",\"url\":\"classes/PopupTimeoutError.html#popup\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"PopupTimeoutError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/PopupTimeoutError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupTimeoutError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/PopupTimeoutError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupTimeoutError\"},{\"kind\":128,\"name\":\"PopupCancelledError\",\"url\":\"classes/PopupCancelledError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/PopupCancelledError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupCancelledError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PopupCancelledError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"PopupCancelledError\"},{\"kind\":1024,\"name\":\"popup\",\"url\":\"classes/PopupCancelledError.html#popup\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"PopupCancelledError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/PopupCancelledError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupCancelledError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/PopupCancelledError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"PopupCancelledError\"},{\"kind\":128,\"name\":\"MfaRequiredError\",\"url\":\"classes/MfaRequiredError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromPayload\",\"url\":\"classes/MfaRequiredError.html#fromPayload\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"MfaRequiredError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/MfaRequiredError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"MfaRequiredError\"},{\"kind\":1024,\"name\":\"mfa_token\",\"url\":\"classes/MfaRequiredError.html#mfa_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"MfaRequiredError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/MfaRequiredError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"MfaRequiredError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/MfaRequiredError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"MfaRequiredError\"},{\"kind\":256,\"name\":\"ICache\",\"url\":\"interfaces/ICache.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"set\",\"url\":\"interfaces/ICache.html#set\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"ICache\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/ICache.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"ICache\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"interfaces/ICache.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"ICache\"},{\"kind\":2048,\"name\":\"allKeys\",\"url\":\"interfaces/ICache.html#allKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"ICache\"},{\"kind\":128,\"name\":\"LocalStorageCache\",\"url\":\"classes/LocalStorageCache.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LocalStorageCache.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LocalStorageCache\"},{\"kind\":2048,\"name\":\"set\",\"url\":\"classes/LocalStorageCache.html#set\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"LocalStorageCache\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/LocalStorageCache.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"LocalStorageCache\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"classes/LocalStorageCache.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"LocalStorageCache\"},{\"kind\":2048,\"name\":\"allKeys\",\"url\":\"classes/LocalStorageCache.html#allKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"LocalStorageCache\"},{\"kind\":128,\"name\":\"InMemoryCache\",\"url\":\"classes/InMemoryCache.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InMemoryCache.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InMemoryCache\"},{\"kind\":1024,\"name\":\"enclosedCache\",\"url\":\"classes/InMemoryCache.html#enclosedCache\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"InMemoryCache\"},{\"kind\":4194304,\"name\":\"Cacheable\",\"url\":\"types/Cacheable.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"DecodedToken\",\"url\":\"interfaces/DecodedToken.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"interfaces/DecodedToken.html#claims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"DecodedToken\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/DecodedToken.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"DecodedToken\"},{\"kind\":4194304,\"name\":\"CacheEntry\",\"url\":\"types/CacheEntry.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/CacheEntry.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"CacheEntry\"},{\"kind\":1024,\"name\":\"id_token\",\"url\":\"types/CacheEntry.html#__type.id_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"access_token\",\"url\":\"types/CacheEntry.html#__type.access_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"expires_in\",\"url\":\"types/CacheEntry.html#__type.expires_in\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"decodedToken\",\"url\":\"types/CacheEntry.html#__type.decodedToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"types/CacheEntry.html#__type.audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"types/CacheEntry.html#__type.scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"client_id\",\"url\":\"types/CacheEntry.html#__type.client_id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"refresh_token\",\"url\":\"types/CacheEntry.html#__type.refresh_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":1024,\"name\":\"oauthTokenScope\",\"url\":\"types/CacheEntry.html#__type.oauthTokenScope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheEntry.__type\"},{\"kind\":4194304,\"name\":\"WrappedCacheEntry\",\"url\":\"types/WrappedCacheEntry.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/WrappedCacheEntry.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"WrappedCacheEntry\"},{\"kind\":1024,\"name\":\"body\",\"url\":\"types/WrappedCacheEntry.html#__type.body\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"WrappedCacheEntry.__type\"},{\"kind\":1024,\"name\":\"expiresAt\",\"url\":\"types/WrappedCacheEntry.html#__type.expiresAt\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"WrappedCacheEntry.__type\"},{\"kind\":4194304,\"name\":\"KeyManifestEntry\",\"url\":\"types/KeyManifestEntry.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/KeyManifestEntry.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"KeyManifestEntry\"},{\"kind\":1024,\"name\":\"keys\",\"url\":\"types/KeyManifestEntry.html#__type.keys\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"KeyManifestEntry.__type\"},{\"kind\":4194304,\"name\":\"MaybePromise\",\"url\":\"types/MaybePromise.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"CacheKey\",\"url\":\"classes/CacheKey.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"fromKey\",\"url\":\"classes/CacheKey.html#fromKey\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":2048,\"name\":\"fromCacheEntry\",\"url\":\"classes/CacheKey.html#fromCacheEntry\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CacheKey.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":1024,\"name\":\"clientId\",\"url\":\"classes/CacheKey.html#clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"classes/CacheKey.html#scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"classes/CacheKey.html#audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":1024,\"name\":\"prefix\",\"url\":\"classes/CacheKey.html#prefix\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":1024,\"name\":\"suffix\",\"url\":\"classes/CacheKey.html#suffix\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":2048,\"name\":\"toKey\",\"url\":\"classes/CacheKey.html#toKey\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CacheKey\"},{\"kind\":4194304,\"name\":\"CacheKeyData\",\"url\":\"types/CacheKeyData.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/CacheKeyData.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"CacheKeyData\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"types/CacheKeyData.html#__type.audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheKeyData.__type\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"types/CacheKeyData.html#__type.scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheKeyData.__type\"},{\"kind\":1024,\"name\":\"clientId\",\"url\":\"types/CacheKeyData.html#__type.clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"CacheKeyData.__type\"},{\"kind\":256,\"name\":\"AuthorizationParams\",\"url\":\"interfaces/AuthorizationParams.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"display\",\"url\":\"interfaces/AuthorizationParams.html#display\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"prompt\",\"url\":\"interfaces/AuthorizationParams.html#prompt\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"max_age\",\"url\":\"interfaces/AuthorizationParams.html#max_age\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"ui_locales\",\"url\":\"interfaces/AuthorizationParams.html#ui_locales\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"id_token_hint\",\"url\":\"interfaces/AuthorizationParams.html#id_token_hint\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"screen_hint\",\"url\":\"interfaces/AuthorizationParams.html#screen_hint\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"login_hint\",\"url\":\"interfaces/AuthorizationParams.html#login_hint\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"acr_values\",\"url\":\"interfaces/AuthorizationParams.html#acr_values\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"interfaces/AuthorizationParams.html#scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/AuthorizationParams.html#audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"connection\",\"url\":\"interfaces/AuthorizationParams.html#connection\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"organization\",\"url\":\"interfaces/AuthorizationParams.html#organization\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"invitation\",\"url\":\"interfaces/AuthorizationParams.html#invitation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":1024,\"name\":\"redirect_uri\",\"url\":\"interfaces/AuthorizationParams.html#redirect_uri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthorizationParams\"},{\"kind\":256,\"name\":\"Auth0ClientOptions\",\"url\":\"interfaces/Auth0ClientOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"domain\",\"url\":\"interfaces/Auth0ClientOptions.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/Auth0ClientOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"clientId\",\"url\":\"interfaces/Auth0ClientOptions.html#clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"leeway\",\"url\":\"interfaces/Auth0ClientOptions.html#leeway\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"cacheLocation\",\"url\":\"interfaces/Auth0ClientOptions.html#cacheLocation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"interfaces/Auth0ClientOptions.html#cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"useRefreshTokens\",\"url\":\"interfaces/Auth0ClientOptions.html#useRefreshTokens\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"useRefreshTokensFallback\",\"url\":\"interfaces/Auth0ClientOptions.html#useRefreshTokensFallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"authorizeTimeoutInSeconds\",\"url\":\"interfaces/Auth0ClientOptions.html#authorizeTimeoutInSeconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"httpTimeoutInSeconds\",\"url\":\"interfaces/Auth0ClientOptions.html#httpTimeoutInSeconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"auth0Client\",\"url\":\"interfaces/Auth0ClientOptions.html#auth0Client\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ClientOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/Auth0ClientOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Auth0ClientOptions.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/Auth0ClientOptions.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Auth0ClientOptions.__type\"},{\"kind\":1024,\"name\":\"env\",\"url\":\"interfaces/Auth0ClientOptions.html#__type.env\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Auth0ClientOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ClientOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"Auth0ClientOptions.__type\"},{\"kind\":1024,\"name\":\"legacySameSiteCookie\",\"url\":\"interfaces/Auth0ClientOptions.html#legacySameSiteCookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"useCookiesForTransactions\",\"url\":\"interfaces/Auth0ClientOptions.html#useCookiesForTransactions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"sessionCheckExpiryDays\",\"url\":\"interfaces/Auth0ClientOptions.html#sessionCheckExpiryDays\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"cookieDomain\",\"url\":\"interfaces/Auth0ClientOptions.html#cookieDomain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"useFormData\",\"url\":\"interfaces/Auth0ClientOptions.html#useFormData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"nowProvider\",\"url\":\"interfaces/Auth0ClientOptions.html#nowProvider\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ClientOptions.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/Auth0ClientOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ClientOptions\"},{\"kind\":4194304,\"name\":\"CacheLocation\",\"url\":\"types/CacheLocation.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"appState\",\"url\":\"interfaces/RedirectLoginOptions.html#appState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":1024,\"name\":\"fragment\",\"url\":\"interfaces/RedirectLoginOptions.html#fragment\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":1024,\"name\":\"onRedirect\",\"url\":\"interfaces/RedirectLoginOptions.html#onRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/RedirectLoginOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/RedirectLoginOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":256,\"name\":\"RedirectLoginResult\",\"url\":\"interfaces/RedirectLoginResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"appState\",\"url\":\"interfaces/RedirectLoginResult.html#appState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginResult\"},{\"kind\":256,\"name\":\"PopupLoginOptions\",\"url\":\"interfaces/PopupLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/PopupLoginOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"PopupLoginOptions\"},{\"kind\":256,\"name\":\"PopupConfigOptions\",\"url\":\"interfaces/PopupConfigOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"timeoutInSeconds\",\"url\":\"interfaces/PopupConfigOptions.html#timeoutInSeconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PopupConfigOptions\"},{\"kind\":1024,\"name\":\"popup\",\"url\":\"interfaces/PopupConfigOptions.html#popup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PopupConfigOptions\"},{\"kind\":256,\"name\":\"GetTokenSilentlyOptions\",\"url\":\"interfaces/GetTokenSilentlyOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"cacheMode\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#cacheMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetTokenSilentlyOptions\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetTokenSilentlyOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"GetTokenSilentlyOptions\"},{\"kind\":1024,\"name\":\"redirect_uri\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#__type.redirect_uri\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GetTokenSilentlyOptions.__type\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#__type.scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GetTokenSilentlyOptions.__type\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#__type.audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GetTokenSilentlyOptions.__type\"},{\"kind\":1024,\"name\":\"timeoutInSeconds\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#timeoutInSeconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetTokenSilentlyOptions\"},{\"kind\":1024,\"name\":\"detailedResponse\",\"url\":\"interfaces/GetTokenSilentlyOptions.html#detailedResponse\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetTokenSilentlyOptions\"},{\"kind\":256,\"name\":\"GetTokenWithPopupOptions\",\"url\":\"interfaces/GetTokenWithPopupOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"cacheMode\",\"url\":\"interfaces/GetTokenWithPopupOptions.html#cacheMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GetTokenWithPopupOptions\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/GetTokenWithPopupOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"GetTokenWithPopupOptions\"},{\"kind\":256,\"name\":\"LogoutUrlOptions\",\"url\":\"interfaces/LogoutUrlOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"clientId\",\"url\":\"interfaces/LogoutUrlOptions.html#clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutUrlOptions\"},{\"kind\":1024,\"name\":\"logoutParams\",\"url\":\"interfaces/LogoutUrlOptions.html#logoutParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutUrlOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutUrlOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LogoutUrlOptions\"},{\"kind\":1024,\"name\":\"federated\",\"url\":\"interfaces/LogoutUrlOptions.html#__type.federated\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LogoutUrlOptions.__type\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LogoutUrlOptions.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LogoutUrlOptions.__type\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"onRedirect\",\"url\":\"interfaces/LogoutOptions.html#onRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutOptions.html#__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":1024,\"name\":\"clientId\",\"url\":\"interfaces/LogoutOptions.html#clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"LogoutOptions\"},{\"kind\":1024,\"name\":\"logoutParams\",\"url\":\"interfaces/LogoutOptions.html#logoutParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"LogoutOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":1024,\"name\":\"federated\",\"url\":\"interfaces/LogoutOptions.html#__type.federated\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LogoutOptions.__type\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LogoutOptions.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LogoutOptions.__type\"},{\"kind\":4194304,\"name\":\"TokenEndpointResponse\",\"url\":\"types/TokenEndpointResponse.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/TokenEndpointResponse.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"TokenEndpointResponse\"},{\"kind\":1024,\"name\":\"id_token\",\"url\":\"types/TokenEndpointResponse.html#__type.id_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenEndpointResponse.__type\"},{\"kind\":1024,\"name\":\"access_token\",\"url\":\"types/TokenEndpointResponse.html#__type.access_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenEndpointResponse.__type\"},{\"kind\":1024,\"name\":\"refresh_token\",\"url\":\"types/TokenEndpointResponse.html#__type.refresh_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenEndpointResponse.__type\"},{\"kind\":1024,\"name\":\"expires_in\",\"url\":\"types/TokenEndpointResponse.html#__type.expires_in\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenEndpointResponse.__type\"},{\"kind\":1024,\"name\":\"scope\",\"url\":\"types/TokenEndpointResponse.html#__type.scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenEndpointResponse.__type\"},{\"kind\":256,\"name\":\"IdToken\",\"url\":\"interfaces/IdToken.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"__raw\",\"url\":\"interfaces/IdToken.html#__raw\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/IdToken.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"given_name\",\"url\":\"interfaces/IdToken.html#given_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"family_name\",\"url\":\"interfaces/IdToken.html#family_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"middle_name\",\"url\":\"interfaces/IdToken.html#middle_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"nickname\",\"url\":\"interfaces/IdToken.html#nickname\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"preferred_username\",\"url\":\"interfaces/IdToken.html#preferred_username\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"profile\",\"url\":\"interfaces/IdToken.html#profile\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"picture\",\"url\":\"interfaces/IdToken.html#picture\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"website\",\"url\":\"interfaces/IdToken.html#website\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"interfaces/IdToken.html#email\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"email_verified\",\"url\":\"interfaces/IdToken.html#email_verified\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"gender\",\"url\":\"interfaces/IdToken.html#gender\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"birthdate\",\"url\":\"interfaces/IdToken.html#birthdate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"zoneinfo\",\"url\":\"interfaces/IdToken.html#zoneinfo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"interfaces/IdToken.html#locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"phone_number\",\"url\":\"interfaces/IdToken.html#phone_number\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"phone_number_verified\",\"url\":\"interfaces/IdToken.html#phone_number_verified\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"address\",\"url\":\"interfaces/IdToken.html#address\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"updated_at\",\"url\":\"interfaces/IdToken.html#updated_at\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"iss\",\"url\":\"interfaces/IdToken.html#iss\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"aud\",\"url\":\"interfaces/IdToken.html#aud\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"exp\",\"url\":\"interfaces/IdToken.html#exp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"nbf\",\"url\":\"interfaces/IdToken.html#nbf\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"iat\",\"url\":\"interfaces/IdToken.html#iat\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"jti\",\"url\":\"interfaces/IdToken.html#jti\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"azp\",\"url\":\"interfaces/IdToken.html#azp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"nonce\",\"url\":\"interfaces/IdToken.html#nonce\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"auth_time\",\"url\":\"interfaces/IdToken.html#auth_time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"at_hash\",\"url\":\"interfaces/IdToken.html#at_hash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"c_hash\",\"url\":\"interfaces/IdToken.html#c_hash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"acr\",\"url\":\"interfaces/IdToken.html#acr\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"amr\",\"url\":\"interfaces/IdToken.html#amr\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"sub_jwk\",\"url\":\"interfaces/IdToken.html#sub_jwk\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"cnf\",\"url\":\"interfaces/IdToken.html#cnf\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"sid\",\"url\":\"interfaces/IdToken.html#sid\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":1024,\"name\":\"org_id\",\"url\":\"interfaces/IdToken.html#org_id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IdToken\"},{\"kind\":128,\"name\":\"User\",\"url\":\"classes/User.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/User.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/User.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"given_name\",\"url\":\"classes/User.html#given_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"family_name\",\"url\":\"classes/User.html#family_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"middle_name\",\"url\":\"classes/User.html#middle_name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"nickname\",\"url\":\"classes/User.html#nickname\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"preferred_username\",\"url\":\"classes/User.html#preferred_username\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"profile\",\"url\":\"classes/User.html#profile\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"picture\",\"url\":\"classes/User.html#picture\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"website\",\"url\":\"classes/User.html#website\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"classes/User.html#email\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"email_verified\",\"url\":\"classes/User.html#email_verified\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"gender\",\"url\":\"classes/User.html#gender\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"birthdate\",\"url\":\"classes/User.html#birthdate\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"zoneinfo\",\"url\":\"classes/User.html#zoneinfo\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"classes/User.html#locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"phone_number\",\"url\":\"classes/User.html#phone_number\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"phone_number_verified\",\"url\":\"classes/User.html#phone_number_verified\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"address\",\"url\":\"classes/User.html#address\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"updated_at\",\"url\":\"classes/User.html#updated_at\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":1024,\"name\":\"sub\",\"url\":\"classes/User.html#sub\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"User\"},{\"kind\":4194304,\"name\":\"GetTokenSilentlyVerboseResponse\",\"url\":\"types/GetTokenSilentlyVerboseResponse.html\",\"classes\":\"tsd-kind-type-alias\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,51.12]],[\"comment/0\",[]],[\"name/1\",[1,46.012]],[\"comment/1\",[]],[\"name/2\",[2,30.751]],[\"comment/2\",[]],[\"name/3\",[3,51.12]],[\"comment/3\",[]],[\"name/4\",[4,51.12]],[\"comment/4\",[]],[\"name/5\",[5,51.12]],[\"comment/5\",[]],[\"name/6\",[6,51.12]],[\"comment/6\",[]],[\"name/7\",[7,51.12]],[\"comment/7\",[]],[\"name/8\",[8,51.12]],[\"comment/8\",[]],[\"name/9\",[9,51.12]],[\"comment/9\",[]],[\"name/10\",[10,51.12]],[\"comment/10\",[]],[\"name/11\",[11,51.12]],[\"comment/11\",[]],[\"name/12\",[12,51.12]],[\"comment/12\",[]],[\"name/13\",[13,51.12]],[\"comment/13\",[]],[\"name/14\",[14,36.457]],[\"comment/14\",[]],[\"name/15\",[2,30.751]],[\"comment/15\",[]],[\"name/16\",[15,36.457]],[\"comment/16\",[]],[\"name/17\",[16,36.457]],[\"comment/17\",[]],[\"name/18\",[17,51.12]],[\"comment/18\",[]],[\"name/19\",[14,36.457]],[\"comment/19\",[]],[\"name/20\",[2,30.751]],[\"comment/20\",[]],[\"name/21\",[18,51.12]],[\"comment/21\",[]],[\"name/22\",[19,42.647]],[\"comment/22\",[]],[\"name/23\",[15,36.457]],[\"comment/23\",[]],[\"name/24\",[16,36.457]],[\"comment/24\",[]],[\"name/25\",[20,51.12]],[\"comment/25\",[]],[\"name/26\",[14,36.457]],[\"comment/26\",[]],[\"name/27\",[2,30.751]],[\"comment/27\",[]],[\"name/28\",[15,36.457]],[\"comment/28\",[]],[\"name/29\",[16,36.457]],[\"comment/29\",[]],[\"name/30\",[21,51.12]],[\"comment/30\",[]],[\"name/31\",[14,36.457]],[\"comment/31\",[]],[\"name/32\",[2,30.751]],[\"comment/32\",[]],[\"name/33\",[22,42.647]],[\"comment/33\",[]],[\"name/34\",[15,36.457]],[\"comment/34\",[]],[\"name/35\",[16,36.457]],[\"comment/35\",[]],[\"name/36\",[23,51.12]],[\"comment/36\",[]],[\"name/37\",[14,36.457]],[\"comment/37\",[]],[\"name/38\",[2,30.751]],[\"comment/38\",[]],[\"name/39\",[22,42.647]],[\"comment/39\",[]],[\"name/40\",[15,36.457]],[\"comment/40\",[]],[\"name/41\",[16,36.457]],[\"comment/41\",[]],[\"name/42\",[24,51.12]],[\"comment/42\",[]],[\"name/43\",[14,36.457]],[\"comment/43\",[]],[\"name/44\",[2,30.751]],[\"comment/44\",[]],[\"name/45\",[25,51.12]],[\"comment/45\",[]],[\"name/46\",[15,36.457]],[\"comment/46\",[]],[\"name/47\",[16,36.457]],[\"comment/47\",[]],[\"name/48\",[26,51.12]],[\"comment/48\",[]],[\"name/49\",[27,46.012]],[\"comment/49\",[]],[\"name/50\",[28,46.012]],[\"comment/50\",[]],[\"name/51\",[29,46.012]],[\"comment/51\",[]],[\"name/52\",[30,46.012]],[\"comment/52\",[]],[\"name/53\",[31,51.12]],[\"comment/53\",[]],[\"name/54\",[2,30.751]],[\"comment/54\",[]],[\"name/55\",[27,46.012]],[\"comment/55\",[]],[\"name/56\",[28,46.012]],[\"comment/56\",[]],[\"name/57\",[29,46.012]],[\"comment/57\",[]],[\"name/58\",[30,46.012]],[\"comment/58\",[]],[\"name/59\",[32,51.12]],[\"comment/59\",[]],[\"name/60\",[2,30.751]],[\"comment/60\",[]],[\"name/61\",[33,51.12]],[\"comment/61\",[]],[\"name/62\",[34,51.12]],[\"comment/62\",[]],[\"name/63\",[35,46.012]],[\"comment/63\",[]],[\"name/64\",[36,51.12]],[\"comment/64\",[]],[\"name/65\",[37,46.012]],[\"comment/65\",[]],[\"name/66\",[38,51.12]],[\"comment/66\",[]],[\"name/67\",[39,29.148]],[\"comment/67\",[]],[\"name/68\",[40,46.012]],[\"comment/68\",[]],[\"name/69\",[41,46.012]],[\"comment/69\",[]],[\"name/70\",[42,46.012]],[\"comment/70\",[]],[\"name/71\",[35,46.012]],[\"comment/71\",[]],[\"name/72\",[43,38.127]],[\"comment/72\",[]],[\"name/73\",[44,36.457]],[\"comment/73\",[]],[\"name/74\",[45,51.12]],[\"comment/74\",[]],[\"name/75\",[46,46.012]],[\"comment/75\",[]],[\"name/76\",[47,51.12]],[\"comment/76\",[]],[\"name/77\",[48,51.12]],[\"comment/77\",[]],[\"name/78\",[39,29.148]],[\"comment/78\",[]],[\"name/79\",[49,51.12]],[\"comment/79\",[]],[\"name/80\",[50,51.12]],[\"comment/80\",[]],[\"name/81\",[51,51.12]],[\"comment/81\",[]],[\"name/82\",[39,29.148]],[\"comment/82\",[]],[\"name/83\",[52,51.12]],[\"comment/83\",[]],[\"name/84\",[53,51.12]],[\"comment/84\",[]],[\"name/85\",[54,51.12]],[\"comment/85\",[]],[\"name/86\",[55,51.12]],[\"comment/86\",[]],[\"name/87\",[56,51.12]],[\"comment/87\",[]],[\"name/88\",[2,30.751]],[\"comment/88\",[]],[\"name/89\",[57,38.127]],[\"comment/89\",[]],[\"name/90\",[44,36.457]],[\"comment/90\",[]],[\"name/91\",[43,38.127]],[\"comment/91\",[]],[\"name/92\",[58,51.12]],[\"comment/92\",[]],[\"name/93\",[59,51.12]],[\"comment/93\",[]],[\"name/94\",[60,51.12]],[\"comment/94\",[]],[\"name/95\",[61,51.12]],[\"comment/95\",[]],[\"name/96\",[39,29.148]],[\"comment/96\",[]],[\"name/97\",[43,38.127]],[\"comment/97\",[]],[\"name/98\",[44,36.457]],[\"comment/98\",[]],[\"name/99\",[57,38.127]],[\"comment/99\",[]],[\"name/100\",[62,36.457]],[\"comment/100\",[]],[\"name/101\",[63,51.12]],[\"comment/101\",[]],[\"name/102\",[64,51.12]],[\"comment/102\",[]],[\"name/103\",[65,51.12]],[\"comment/103\",[]],[\"name/104\",[66,51.12]],[\"comment/104\",[]],[\"name/105\",[67,51.12]],[\"comment/105\",[]],[\"name/106\",[68,51.12]],[\"comment/106\",[]],[\"name/107\",[69,51.12]],[\"comment/107\",[]],[\"name/108\",[70,51.12]],[\"comment/108\",[]],[\"name/109\",[44,36.457]],[\"comment/109\",[]],[\"name/110\",[43,38.127]],[\"comment/110\",[]],[\"name/111\",[71,51.12]],[\"comment/111\",[]],[\"name/112\",[72,51.12]],[\"comment/112\",[]],[\"name/113\",[73,51.12]],[\"comment/113\",[]],[\"name/114\",[74,46.012]],[\"comment/114\",[]],[\"name/115\",[75,51.12]],[\"comment/115\",[]],[\"name/116\",[76,51.12]],[\"comment/116\",[]],[\"name/117\",[77,51.12]],[\"comment/117\",[]],[\"name/118\",[57,38.127]],[\"comment/118\",[]],[\"name/119\",[78,51.12]],[\"comment/119\",[]],[\"name/120\",[79,46.012]],[\"comment/120\",[]],[\"name/121\",[80,51.12]],[\"comment/121\",[]],[\"name/122\",[81,51.12]],[\"comment/122\",[]],[\"name/123\",[82,51.12]],[\"comment/123\",[]],[\"name/124\",[83,51.12]],[\"comment/124\",[]],[\"name/125\",[84,51.12]],[\"comment/125\",[]],[\"name/126\",[1,46.012]],[\"comment/126\",[]],[\"name/127\",[39,29.148]],[\"comment/127\",[]],[\"name/128\",[85,42.647]],[\"comment/128\",[]],[\"name/129\",[86,51.12]],[\"comment/129\",[]],[\"name/130\",[87,51.12]],[\"comment/130\",[]],[\"name/131\",[39,29.148]],[\"comment/131\",[]],[\"name/132\",[88,51.12]],[\"comment/132\",[]],[\"name/133\",[89,51.12]],[\"comment/133\",[]],[\"name/134\",[90,51.12]],[\"comment/134\",[]],[\"name/135\",[91,51.12]],[\"comment/135\",[]],[\"name/136\",[92,51.12]],[\"comment/136\",[]],[\"name/137\",[93,51.12]],[\"comment/137\",[]],[\"name/138\",[39,29.148]],[\"comment/138\",[]],[\"name/139\",[62,36.457]],[\"comment/139\",[]],[\"name/140\",[79,46.012]],[\"comment/140\",[]],[\"name/141\",[94,51.12]],[\"comment/141\",[]],[\"name/142\",[19,42.647]],[\"comment/142\",[]],[\"name/143\",[95,51.12]],[\"comment/143\",[]],[\"name/144\",[96,46.012]],[\"comment/144\",[]],[\"name/145\",[39,29.148]],[\"comment/145\",[]],[\"name/146\",[62,36.457]],[\"comment/146\",[]],[\"name/147\",[97,51.12]],[\"comment/147\",[]],[\"name/148\",[19,42.647]],[\"comment/148\",[]],[\"name/149\",[98,51.12]],[\"comment/149\",[]],[\"name/150\",[62,36.457]],[\"comment/150\",[]],[\"name/151\",[99,51.12]],[\"comment/151\",[]],[\"name/152\",[100,46.012]],[\"comment/152\",[]],[\"name/153\",[22,42.647]],[\"comment/153\",[]],[\"name/154\",[101,51.12]],[\"comment/154\",[]],[\"name/155\",[102,46.012]],[\"comment/155\",[]],[\"name/156\",[62,36.457]],[\"comment/156\",[]],[\"name/157\",[39,29.148]],[\"comment/157\",[]],[\"name/158\",[74,46.012]],[\"comment/158\",[]],[\"name/159\",[44,36.457]],[\"comment/159\",[]],[\"name/160\",[43,38.127]],[\"comment/160\",[]],[\"name/161\",[100,46.012]],[\"comment/161\",[]],[\"name/162\",[103,51.12]],[\"comment/162\",[]],[\"name/163\",[104,51.12]],[\"comment/163\",[]],[\"name/164\",[102,46.012]],[\"comment/164\",[]],[\"name/165\",[62,36.457]],[\"comment/165\",[]],[\"name/166\",[105,51.12]],[\"comment/166\",[]],[\"name/167\",[57,38.127]],[\"comment/167\",[]],[\"name/168\",[106,46.012]],[\"comment/168\",[]],[\"name/169\",[39,29.148]],[\"comment/169\",[]],[\"name/170\",[107,46.012]],[\"comment/170\",[]],[\"name/171\",[108,46.012]],[\"comment/171\",[]],[\"name/172\",[109,51.12]],[\"comment/172\",[]],[\"name/173\",[96,46.012]],[\"comment/173\",[]],[\"name/174\",[39,29.148]],[\"comment/174\",[]],[\"name/175\",[57,38.127]],[\"comment/175\",[]],[\"name/176\",[106,46.012]],[\"comment/176\",[]],[\"name/177\",[39,29.148]],[\"comment/177\",[]],[\"name/178\",[107,46.012]],[\"comment/178\",[]],[\"name/179\",[108,46.012]],[\"comment/179\",[]],[\"name/180\",[110,51.12]],[\"comment/180\",[]],[\"name/181\",[39,29.148]],[\"comment/181\",[]],[\"name/182\",[40,46.012]],[\"comment/182\",[]],[\"name/183\",[41,46.012]],[\"comment/183\",[]],[\"name/184\",[46,46.012]],[\"comment/184\",[]],[\"name/185\",[42,46.012]],[\"comment/185\",[]],[\"name/186\",[44,36.457]],[\"comment/186\",[]],[\"name/187\",[111,51.12]],[\"comment/187\",[]],[\"name/188\",[112,51.12]],[\"comment/188\",[]],[\"name/189\",[85,42.647]],[\"comment/189\",[]],[\"name/190\",[113,46.012]],[\"comment/190\",[]],[\"name/191\",[114,46.012]],[\"comment/191\",[]],[\"name/192\",[115,46.012]],[\"comment/192\",[]],[\"name/193\",[116,46.012]],[\"comment/193\",[]],[\"name/194\",[117,46.012]],[\"comment/194\",[]],[\"name/195\",[118,46.012]],[\"comment/195\",[]],[\"name/196\",[119,46.012]],[\"comment/196\",[]],[\"name/197\",[120,46.012]],[\"comment/197\",[]],[\"name/198\",[121,46.012]],[\"comment/198\",[]],[\"name/199\",[122,46.012]],[\"comment/199\",[]],[\"name/200\",[123,46.012]],[\"comment/200\",[]],[\"name/201\",[124,46.012]],[\"comment/201\",[]],[\"name/202\",[125,46.012]],[\"comment/202\",[]],[\"name/203\",[126,46.012]],[\"comment/203\",[]],[\"name/204\",[127,46.012]],[\"comment/204\",[]],[\"name/205\",[128,46.012]],[\"comment/205\",[]],[\"name/206\",[129,46.012]],[\"comment/206\",[]],[\"name/207\",[130,46.012]],[\"comment/207\",[]],[\"name/208\",[131,51.12]],[\"comment/208\",[]],[\"name/209\",[132,51.12]],[\"comment/209\",[]],[\"name/210\",[133,51.12]],[\"comment/210\",[]],[\"name/211\",[134,51.12]],[\"comment/211\",[]],[\"name/212\",[135,51.12]],[\"comment/212\",[]],[\"name/213\",[136,51.12]],[\"comment/213\",[]],[\"name/214\",[137,51.12]],[\"comment/214\",[]],[\"name/215\",[138,51.12]],[\"comment/215\",[]],[\"name/216\",[139,51.12]],[\"comment/216\",[]],[\"name/217\",[140,51.12]],[\"comment/217\",[]],[\"name/218\",[141,51.12]],[\"comment/218\",[]],[\"name/219\",[142,51.12]],[\"comment/219\",[]],[\"name/220\",[143,51.12]],[\"comment/220\",[]],[\"name/221\",[144,51.12]],[\"comment/221\",[]],[\"name/222\",[145,51.12]],[\"comment/222\",[]],[\"name/223\",[146,51.12]],[\"comment/223\",[]],[\"name/224\",[147,51.12]],[\"comment/224\",[]],[\"name/225\",[37,46.012]],[\"comment/225\",[]],[\"name/226\",[2,30.751]],[\"comment/226\",[]],[\"name/227\",[85,42.647]],[\"comment/227\",[]],[\"name/228\",[113,46.012]],[\"comment/228\",[]],[\"name/229\",[114,46.012]],[\"comment/229\",[]],[\"name/230\",[115,46.012]],[\"comment/230\",[]],[\"name/231\",[116,46.012]],[\"comment/231\",[]],[\"name/232\",[117,46.012]],[\"comment/232\",[]],[\"name/233\",[118,46.012]],[\"comment/233\",[]],[\"name/234\",[119,46.012]],[\"comment/234\",[]],[\"name/235\",[120,46.012]],[\"comment/235\",[]],[\"name/236\",[121,46.012]],[\"comment/236\",[]],[\"name/237\",[122,46.012]],[\"comment/237\",[]],[\"name/238\",[123,46.012]],[\"comment/238\",[]],[\"name/239\",[124,46.012]],[\"comment/239\",[]],[\"name/240\",[125,46.012]],[\"comment/240\",[]],[\"name/241\",[126,46.012]],[\"comment/241\",[]],[\"name/242\",[127,46.012]],[\"comment/242\",[]],[\"name/243\",[128,46.012]],[\"comment/243\",[]],[\"name/244\",[129,46.012]],[\"comment/244\",[]],[\"name/245\",[130,46.012]],[\"comment/245\",[]],[\"name/246\",[148,51.12]],[\"comment/246\",[]],[\"name/247\",[149,51.12]],[\"comment/247\",[]]],\"invertedIndex\":[[\"__raw\",{\"_index\":112,\"name\":{\"188\":{}},\"comment\":{}}],[\"__type\",{\"_index\":39,\"name\":{\"67\":{},\"78\":{},\"82\":{},\"96\":{},\"127\":{},\"131\":{},\"138\":{},\"145\":{},\"157\":{},\"169\":{},\"174\":{},\"177\":{},\"181\":{}},\"comment\":{}}],[\"access_token\",{\"_index\":41,\"name\":{\"69\":{},\"183\":{}},\"comment\":{}}],[\"acr\",{\"_index\":142,\"name\":{\"219\":{}},\"comment\":{}}],[\"acr_values\",{\"_index\":70,\"name\":{\"108\":{}},\"comment\":{}}],[\"address\",{\"_index\":129,\"name\":{\"206\":{},\"244\":{}},\"comment\":{}}],[\"allkeys\",{\"_index\":30,\"name\":{\"52\":{},\"58\":{}},\"comment\":{}}],[\"amr\",{\"_index\":143,\"name\":{\"220\":{}},\"comment\":{}}],[\"appstate\",{\"_index\":19,\"name\":{\"22\":{},\"142\":{},\"148\":{}},\"comment\":{}}],[\"at_hash\",{\"_index\":140,\"name\":{\"217\":{}},\"comment\":{}}],[\"aud\",{\"_index\":132,\"name\":{\"209\":{}},\"comment\":{}}],[\"audience\",{\"_index\":43,\"name\":{\"72\":{},\"91\":{},\"97\":{},\"110\":{},\"160\":{}},\"comment\":{}}],[\"auth0client\",{\"_index\":1,\"name\":{\"1\":{},\"126\":{}},\"comment\":{}}],[\"auth0clientoptions\",{\"_index\":75,\"name\":{\"115\":{}},\"comment\":{}}],[\"auth_time\",{\"_index\":139,\"name\":{\"216\":{}},\"comment\":{}}],[\"authenticationerror\",{\"_index\":17,\"name\":{\"18\":{}},\"comment\":{}}],[\"authorizationparams\",{\"_index\":62,\"name\":{\"100\":{},\"139\":{},\"146\":{},\"150\":{},\"156\":{},\"165\":{}},\"comment\":{}}],[\"authorizetimeoutinseconds\",{\"_index\":83,\"name\":{\"124\":{}},\"comment\":{}}],[\"azp\",{\"_index\":137,\"name\":{\"214\":{}},\"comment\":{}}],[\"birthdate\",{\"_index\":124,\"name\":{\"201\":{},\"239\":{}},\"comment\":{}}],[\"body\",{\"_index\":49,\"name\":{\"79\":{}},\"comment\":{}}],[\"c_hash\",{\"_index\":141,\"name\":{\"218\":{}},\"comment\":{}}],[\"cache\",{\"_index\":80,\"name\":{\"121\":{}},\"comment\":{}}],[\"cacheable\",{\"_index\":34,\"name\":{\"62\":{}},\"comment\":{}}],[\"cacheentry\",{\"_index\":38,\"name\":{\"66\":{}},\"comment\":{}}],[\"cachekey\",{\"_index\":54,\"name\":{\"85\":{}},\"comment\":{}}],[\"cachekeydata\",{\"_index\":61,\"name\":{\"95\":{}},\"comment\":{}}],[\"cachelocation\",{\"_index\":79,\"name\":{\"120\":{},\"140\":{}},\"comment\":{}}],[\"cachemode\",{\"_index\":102,\"name\":{\"155\":{},\"164\":{}},\"comment\":{}}],[\"checksession\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"claims\",{\"_index\":36,\"name\":{\"64\":{}},\"comment\":{}}],[\"client_id\",{\"_index\":45,\"name\":{\"74\":{}},\"comment\":{}}],[\"clientid\",{\"_index\":57,\"name\":{\"89\":{},\"99\":{},\"118\":{},\"167\":{},\"175\":{}},\"comment\":{}}],[\"cnf\",{\"_index\":145,\"name\":{\"222\":{}},\"comment\":{}}],[\"connection\",{\"_index\":71,\"name\":{\"111\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":2,\"name\":{\"2\":{},\"15\":{},\"20\":{},\"27\":{},\"32\":{},\"38\":{},\"44\":{},\"54\":{},\"60\":{},\"88\":{},\"226\":{}},\"comment\":{}}],[\"cookiedomain\",{\"_index\":91,\"name\":{\"135\":{}},\"comment\":{}}],[\"createauth0client\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"decodedtoken\",{\"_index\":35,\"name\":{\"63\":{},\"71\":{}},\"comment\":{}}],[\"detailedresponse\",{\"_index\":103,\"name\":{\"162\":{}},\"comment\":{}}],[\"display\",{\"_index\":63,\"name\":{\"101\":{}},\"comment\":{}}],[\"domain\",{\"_index\":76,\"name\":{\"116\":{}},\"comment\":{}}],[\"email\",{\"_index\":121,\"name\":{\"198\":{},\"236\":{}},\"comment\":{}}],[\"email_verified\",{\"_index\":122,\"name\":{\"199\":{},\"237\":{}},\"comment\":{}}],[\"enclosedcache\",{\"_index\":33,\"name\":{\"61\":{}},\"comment\":{}}],[\"env\",{\"_index\":87,\"name\":{\"130\":{}},\"comment\":{}}],[\"error\",{\"_index\":15,\"name\":{\"16\":{},\"23\":{},\"28\":{},\"34\":{},\"40\":{},\"46\":{}},\"comment\":{}}],[\"error_description\",{\"_index\":16,\"name\":{\"17\":{},\"24\":{},\"29\":{},\"35\":{},\"41\":{},\"47\":{}},\"comment\":{}}],[\"exp\",{\"_index\":133,\"name\":{\"210\":{}},\"comment\":{}}],[\"expires_in\",{\"_index\":42,\"name\":{\"70\":{},\"185\":{}},\"comment\":{}}],[\"expiresat\",{\"_index\":50,\"name\":{\"80\":{}},\"comment\":{}}],[\"family_name\",{\"_index\":114,\"name\":{\"191\":{},\"229\":{}},\"comment\":{}}],[\"federated\",{\"_index\":107,\"name\":{\"170\":{},\"178\":{}},\"comment\":{}}],[\"fragment\",{\"_index\":95,\"name\":{\"143\":{}},\"comment\":{}}],[\"fromcacheentry\",{\"_index\":56,\"name\":{\"87\":{}},\"comment\":{}}],[\"fromkey\",{\"_index\":55,\"name\":{\"86\":{}},\"comment\":{}}],[\"frompayload\",{\"_index\":14,\"name\":{\"14\":{},\"19\":{},\"26\":{},\"31\":{},\"37\":{},\"43\":{}},\"comment\":{}}],[\"gender\",{\"_index\":123,\"name\":{\"200\":{},\"238\":{}},\"comment\":{}}],[\"genericerror\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"get\",{\"_index\":28,\"name\":{\"50\":{},\"56\":{}},\"comment\":{}}],[\"getidtokenclaims\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"gettokensilently\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"gettokensilentlyoptions\",{\"_index\":101,\"name\":{\"154\":{}},\"comment\":{}}],[\"gettokensilentlyverboseresponse\",{\"_index\":149,\"name\":{\"247\":{}},\"comment\":{}}],[\"gettokenwithpopup\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"gettokenwithpopupoptions\",{\"_index\":104,\"name\":{\"163\":{}},\"comment\":{}}],[\"getuser\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"given_name\",{\"_index\":113,\"name\":{\"190\":{},\"228\":{}},\"comment\":{}}],[\"handleredirectcallback\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"httptimeoutinseconds\",{\"_index\":84,\"name\":{\"125\":{}},\"comment\":{}}],[\"iat\",{\"_index\":135,\"name\":{\"212\":{}},\"comment\":{}}],[\"icache\",{\"_index\":26,\"name\":{\"48\":{}},\"comment\":{}}],[\"id_token\",{\"_index\":40,\"name\":{\"68\":{},\"182\":{}},\"comment\":{}}],[\"id_token_hint\",{\"_index\":67,\"name\":{\"105\":{}},\"comment\":{}}],[\"idtoken\",{\"_index\":111,\"name\":{\"187\":{}},\"comment\":{}}],[\"inmemorycache\",{\"_index\":32,\"name\":{\"59\":{}},\"comment\":{}}],[\"invitation\",{\"_index\":73,\"name\":{\"113\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"iss\",{\"_index\":131,\"name\":{\"208\":{}},\"comment\":{}}],[\"issuer\",{\"_index\":77,\"name\":{\"117\":{}},\"comment\":{}}],[\"jti\",{\"_index\":136,\"name\":{\"213\":{}},\"comment\":{}}],[\"keymanifestentry\",{\"_index\":51,\"name\":{\"81\":{}},\"comment\":{}}],[\"keys\",{\"_index\":52,\"name\":{\"83\":{}},\"comment\":{}}],[\"leeway\",{\"_index\":78,\"name\":{\"119\":{}},\"comment\":{}}],[\"legacysamesitecookie\",{\"_index\":88,\"name\":{\"132\":{}},\"comment\":{}}],[\"locale\",{\"_index\":126,\"name\":{\"203\":{},\"241\":{}},\"comment\":{}}],[\"localstoragecache\",{\"_index\":31,\"name\":{\"53\":{}},\"comment\":{}}],[\"login_hint\",{\"_index\":69,\"name\":{\"107\":{}},\"comment\":{}}],[\"loginwithpopup\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"loginwithredirect\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"logout\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":109,\"name\":{\"172\":{}},\"comment\":{}}],[\"logoutparams\",{\"_index\":106,\"name\":{\"168\":{},\"176\":{}},\"comment\":{}}],[\"logouturloptions\",{\"_index\":105,\"name\":{\"166\":{}},\"comment\":{}}],[\"max_age\",{\"_index\":65,\"name\":{\"103\":{}},\"comment\":{}}],[\"maybepromise\",{\"_index\":53,\"name\":{\"84\":{}},\"comment\":{}}],[\"mfa_token\",{\"_index\":25,\"name\":{\"45\":{}},\"comment\":{}}],[\"mfarequirederror\",{\"_index\":24,\"name\":{\"42\":{}},\"comment\":{}}],[\"middle_name\",{\"_index\":115,\"name\":{\"192\":{},\"230\":{}},\"comment\":{}}],[\"name\",{\"_index\":85,\"name\":{\"128\":{},\"189\":{},\"227\":{}},\"comment\":{}}],[\"nbf\",{\"_index\":134,\"name\":{\"211\":{}},\"comment\":{}}],[\"nickname\",{\"_index\":116,\"name\":{\"193\":{},\"231\":{}},\"comment\":{}}],[\"nonce\",{\"_index\":138,\"name\":{\"215\":{}},\"comment\":{}}],[\"nowprovider\",{\"_index\":93,\"name\":{\"137\":{}},\"comment\":{}}],[\"oauthtokenscope\",{\"_index\":47,\"name\":{\"76\":{}},\"comment\":{}}],[\"onredirect\",{\"_index\":96,\"name\":{\"144\":{},\"173\":{}},\"comment\":{}}],[\"org_id\",{\"_index\":147,\"name\":{\"224\":{}},\"comment\":{}}],[\"organization\",{\"_index\":72,\"name\":{\"112\":{}},\"comment\":{}}],[\"phone_number\",{\"_index\":127,\"name\":{\"204\":{},\"242\":{}},\"comment\":{}}],[\"phone_number_verified\",{\"_index\":128,\"name\":{\"205\":{},\"243\":{}},\"comment\":{}}],[\"picture\",{\"_index\":119,\"name\":{\"196\":{},\"234\":{}},\"comment\":{}}],[\"popup\",{\"_index\":22,\"name\":{\"33\":{},\"39\":{},\"153\":{}},\"comment\":{}}],[\"popupcancellederror\",{\"_index\":23,\"name\":{\"36\":{}},\"comment\":{}}],[\"popupconfigoptions\",{\"_index\":99,\"name\":{\"151\":{}},\"comment\":{}}],[\"popuploginoptions\",{\"_index\":98,\"name\":{\"149\":{}},\"comment\":{}}],[\"popuptimeouterror\",{\"_index\":21,\"name\":{\"30\":{}},\"comment\":{}}],[\"preferred_username\",{\"_index\":117,\"name\":{\"194\":{},\"232\":{}},\"comment\":{}}],[\"prefix\",{\"_index\":58,\"name\":{\"92\":{}},\"comment\":{}}],[\"profile\",{\"_index\":118,\"name\":{\"195\":{},\"233\":{}},\"comment\":{}}],[\"prompt\",{\"_index\":64,\"name\":{\"102\":{}},\"comment\":{}}],[\"redirect_uri\",{\"_index\":74,\"name\":{\"114\":{},\"158\":{}},\"comment\":{}}],[\"redirectloginoptions\",{\"_index\":94,\"name\":{\"141\":{}},\"comment\":{}}],[\"redirectloginresult\",{\"_index\":97,\"name\":{\"147\":{}},\"comment\":{}}],[\"refresh_token\",{\"_index\":46,\"name\":{\"75\":{},\"184\":{}},\"comment\":{}}],[\"remove\",{\"_index\":29,\"name\":{\"51\":{},\"57\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":108,\"name\":{\"171\":{},\"179\":{}},\"comment\":{}}],[\"scope\",{\"_index\":44,\"name\":{\"73\":{},\"90\":{},\"98\":{},\"109\":{},\"159\":{},\"186\":{}},\"comment\":{}}],[\"screen_hint\",{\"_index\":68,\"name\":{\"106\":{}},\"comment\":{}}],[\"sessioncheckexpirydays\",{\"_index\":90,\"name\":{\"134\":{}},\"comment\":{}}],[\"set\",{\"_index\":27,\"name\":{\"49\":{},\"55\":{}},\"comment\":{}}],[\"sid\",{\"_index\":146,\"name\":{\"223\":{}},\"comment\":{}}],[\"state\",{\"_index\":18,\"name\":{\"21\":{}},\"comment\":{}}],[\"sub\",{\"_index\":148,\"name\":{\"246\":{}},\"comment\":{}}],[\"sub_jwk\",{\"_index\":144,\"name\":{\"221\":{}},\"comment\":{}}],[\"suffix\",{\"_index\":59,\"name\":{\"93\":{}},\"comment\":{}}],[\"timeouterror\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"timeoutinseconds\",{\"_index\":100,\"name\":{\"152\":{},\"161\":{}},\"comment\":{}}],[\"tokenendpointresponse\",{\"_index\":110,\"name\":{\"180\":{}},\"comment\":{}}],[\"tokey\",{\"_index\":60,\"name\":{\"94\":{}},\"comment\":{}}],[\"ui_locales\",{\"_index\":66,\"name\":{\"104\":{}},\"comment\":{}}],[\"updated_at\",{\"_index\":130,\"name\":{\"207\":{},\"245\":{}},\"comment\":{}}],[\"usecookiesfortransactions\",{\"_index\":89,\"name\":{\"133\":{}},\"comment\":{}}],[\"useformdata\",{\"_index\":92,\"name\":{\"136\":{}},\"comment\":{}}],[\"user\",{\"_index\":37,\"name\":{\"65\":{},\"225\":{}},\"comment\":{}}],[\"userefreshtokens\",{\"_index\":81,\"name\":{\"122\":{}},\"comment\":{}}],[\"userefreshtokensfallback\",{\"_index\":82,\"name\":{\"123\":{}},\"comment\":{}}],[\"version\",{\"_index\":86,\"name\":{\"129\":{}},\"comment\":{}}],[\"website\",{\"_index\":120,\"name\":{\"197\":{},\"235\":{}},\"comment\":{}}],[\"wrappedcacheentry\",{\"_index\":48,\"name\":{\"77\":{}},\"comment\":{}}],[\"zoneinfo\",{\"_index\":125,\"name\":{\"202\":{},\"240\":{}},\"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..e5093854c --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1257 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --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-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-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-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-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-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); +} + +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; +} + +* { + 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/auth0client.html b/docs/classes/auth0client.html index d9e99b84d..fe0bf5851 100644 --- a/docs/classes/auth0client.html +++ b/docs/classes/auth0client.html @@ -1,3409 +1,317 @@ - - - - - - Auth0Client | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +Auth0Client | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

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

-
-
-
-
-

Hierarchy

-
    -
  • - Auth0Client -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

cacheLocation

-
cacheLocation: CacheLocation
- -
-
-
-

Methods

-
- -

buildAuthorizeUrl

- - -
-
- -

buildLogoutUrl

- -
    -
  • - -
    -
    - 
    await auth0.buildLogoutUrl(options);
-
    -
    -

    Builds a URL to the logout endpoint using the parameters provided as arguments.

    -
    -

    Parameters

    - -

    Returns string

    -
    • -
-
-
- -

checkSession

- -
    -
  • - -
    -
    - 
    await auth0.checkSession();
-
    -
    -

    Check if the user is logged in using getTokenSilently. The difference - with getTokenSilently is that this doesn't return a token, but it will - pre-fill the token cache.

    -

    This method also heeds the auth0.{clientId}.is.authenticated cookie, as an optimization - to prevent calling Auth0 unnecessarily. If the cookie is not present because - there was no previous login (or it has expired) then tokens will not be refreshed.

    -

    It should be used for silently logging in the user when you instantiate the - Auth0Client constructor. You should not need this if you are using the - createAuth0Client factory.

    -

    Note: the cookie may not be present if running an app using a private tab, as some - browsers clear JS cookie data and local storage when the tab or page is closed, or on page reload. This effectively - means that checkSession could silently return without authenticating the user on page refresh when - using a private tab, despite having previously logged in. As a workaround, use getTokenSilently instead - and handle the possible login_required error as shown in the readme.

    -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

getIdTokenClaims

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

    Returns all claims from the id_token if available.

    -

    If you provide an audience or scope, they should match an existing Access Token - (the SDK stores a corresponding ID Token with every Access Token, and uses the - scope and audience to look up the ID Token)

    -
    -

    Parameters

    - -

    Returns Promise<IdToken | undefined>

    -
    • -
-
-
- -

getTokenSilently

- -
    -
  • - -
    -
    -

    Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.

    -
    - 
    const token = await auth0.getTokenSilently(options);
-
    -

    If there's a valid token stored and it has more than 60 seconds - remaining before expiration, return the token. Otherwise, attempt - to obtain a new token.

    -

    A new token will be obtained either by opening an iframe or a - refresh token (if useRefreshTokens is true)

    -

    If iframes are used, opens an iframe with the /authorize URL - using the parameters provided as arguments. Random and secure state - and nonce parameters will be auto-generated. If the response is successful, - results will be validated according to their expiration times.

    -

    If refresh tokens are used, the token endpoint is called directly with the - 'refresh_token' grant. If no refresh token is available to make this call, - the SDK falls back to using an iframe to the '/authorize' URL.

    -

    This method may use a web worker to perform the token call if the in-memory - cache is used.

    -

    If an audience value is given to this function, the SDK always falls - back to using an iframe to make the token exchange.

    -

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

    -
    -

    Parameters

    - -

    Returns Promise<GetTokenSilentlyVerboseResponse>

    -
    • -
  • - -
    -
    -

    Fetches a new access token and returns it.

    -
    - 
    const token = await auth0.getTokenSilently(options);
+
    Check if the user is logged in using getTokenSilently. The difference
+with getTokenSilently is that this doesn't return a token, but it will
+pre-fill the token cache.
    
+
    This method also heeds the auth0.{clientId}.is.authenticated cookie, as an optimization
+ to prevent calling Auth0 unnecessarily. If the cookie is not present because
+there was no previous login (or it has expired) then tokens will not be refreshed.
    
+
    It should be used for silently logging in the user when you instantiate the
+Auth0Client constructor. You should not need this if you are using the
+createAuth0Client factory.
    
+
    Note: the cookie may not be present if running an app using a private tab, as some
+browsers clear JS cookie data and local storage when the tab or page is closed, or on page reload. This effectively
+means that checkSession could silently return without authenticating the user on page refresh when
+using a private tab, despite having previously logged in. As a workaround, use getTokenSilently instead
+and handle the possible login_required error as shown in the readme.
    
+
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

+
+

getIdTokenClaims

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

    If there's a valid token stored and it has more than 60 seconds - remaining before expiration, return the token. Otherwise, attempt - to obtain a new token.

    -

    A new token will be obtained either by opening an iframe or a - refresh token (if useRefreshTokens is true)

    -

    If iframes are used, opens an iframe with the /authorize URL - using the parameters provided as arguments. Random and secure state - and nonce parameters will be auto-generated. If the response is successful, - results will be validated according to their expiration times.

    -

    If refresh tokens are used, the token endpoint is called directly with the - 'refresh_token' grant. If no refresh token is available to make this call, - the SDK falls back to using an iframe to the '/authorize' URL.

    -

    This method may use a web worker to perform the token call if the in-memory - cache is used.

    -

    If an audience value is given to this function, the SDK always falls - back to using an iframe to make the token exchange.

    -

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

    -
    -

    Parameters

    - -

    Returns Promise<string>

    -
    • -
-
-
- -

getTokenWithPopup

- -
+
+

getTokenSilently

+
+
+

getTokenWithPopup

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

    Opens a popup with the /authorize URL using the parameters - provided as arguments. Random and secure state and nonce - parameters will be auto-generated. If the response is successful, - results will be valid according to their expiration times.

    -
    -
-

Parameters

- -

Returns Promise<string>

- - - -
- -

getUser

-
    -
  • getUser<TUser>(options?: GetUserOptions): Promise<TUser | undefined>
    • -
-
    -
  • - -
    -
    - 
    const user = await auth0.getUser();
+
    Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
    
+
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | string>

+
+

getUser

+
    + +
  • +
    const user = await auth0.getUser();
    -
    -

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

    -

    If you provide an audience or scope, they should match an existing Access Token - (the SDK stores a corresponding ID Token with every Access Token, and uses the - scope and audience to look up the ID Token)

    -
-

Type parameters

-
    -
  • -

    TUser: User

    -
    -

    The type to return, has to extend User.

    -
    -
    • -
-

Parameters

- -

Returns Promise<TUser | undefined>

- - - -
- -

handleRedirectCallback

- -
    -
  • - -
    -
    -

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

    -
    -
    -

    Type parameters

    -
      -
    • -

      TAppState

      -
      • -
    -

    Parameters

    -
      -
    • -
      Default value url: string = window.location.href
      -
      • -
    -

    Returns Promise<RedirectLoginResult<TAppState>>

    -
    • -
-
-
- -

isAuthenticated

-
    -
  • isAuthenticated(): Promise<boolean>
    • -
-
    -
  • - -
    -
    - 
    const isAuthenticated = await auth0.isAuthenticated();
+
    Returns the user information if available (decoded
+from the id_token).
    
+
+
    Typeparam
    TUser The type to return, has to extend User.
    
+
    +
    +

    Type Parameters

    +
      +
    • +

      TUser extends User<TUser>

    +

    Returns Promise<undefined | TUser>

+
+

handleRedirectCallback

+
    + +
  • +

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

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TAppState = any

    +
    +

    Parameters

    +
      +
    • +
      url: string = window.location.href
    +

    Returns Promise<RedirectLoginResult<TAppState>>

+
+

isAuthenticated

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

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

    - -

    Returns Promise<boolean>

    -
    • -
-
-
- -

loginWithPopup

- -
    -
  • - -
    -
    - 
    try {
- await auth0.loginWithPopup(options);
-} catch(e) {
- if (e instanceof PopupCancelledError) {
-   // Popup was closed before login completed
- }
-}
+
    Returns true if there's valid information stored,
+otherwise returns false.
    
+
    +

    Returns Promise<boolean>

+
+

loginWithPopup

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

    Opens a popup with the /authorize URL using the parameters - provided as arguments. Random and secure state and nonce - parameters will be auto-generated. If the response is successful, - results will be valid according to their expiration times.

    -

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

    - -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

loginWithRedirect

- -
    -
  • - -
    -
    - 
    await auth0.loginWithRedirect(options);
+
    Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
    
+
    IMPORTANT: This method has to be called from an event handler
+that was started by the user like a button click, for example,
+otherwise the popup will be blocked in most browsers.
    
+
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

+
+

loginWithRedirect

+
    + +
  • +
    await auth0.loginWithRedirect(options);
    -
    -

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

    - -

    Type parameters

    -
      -
    • -

      TAppState

      -
      • -
    -

    Parameters

    - -

    Returns Promise<void>

    -
    • -
-
-
- -

logout

- -
    -
  • - -
    -
    - 
    auth0.logout();
+
    Performs a redirect to /authorize using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated.
    
+
    +
    +

    Type Parameters

    +
      +
    • +

      TAppState = any

    +
    +

    Parameters

    +
    +

    Returns Promise<void>

+
+

logout

+
    + +
  • +
    await auth0.logout(options);
    -
    -

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

    -

    Note: If you are using a custom cache, and specifying localOnly: true, and you want to perform actions or read state from the SDK immediately after logout, you should await the result of calling logout.

    -

    If the federated option is specified it also clears the Identity Provider session. - If the localOnly option is specified, it only clears the application session. - It is invalid to set both the federated and localOnly options to true, - and an error will be thrown if you do. - Read more about how Logout works at Auth0.

    - -

    Parameters

    - -

    Returns Promise<void> | void

    -
    • -
-
- -
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
- +

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

+

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

- - - \ No newline at end of file +
+

Parameters

+
+

Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html index 6d9b44edc..58231109f 100644 --- a/docs/classes/authenticationerror.html +++ b/docs/classes/authenticationerror.html @@ -1,2989 +1,147 @@ - - - - - - AuthenticationError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +AuthenticationError | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

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

-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new AuthenticationError(error: string, error_description: string, state: string, appState?: any): AuthenticationError
    • -
- -
-
-
-

Properties

-
- -

appState

-
appState: any
- -
-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
- -

state

-
state: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class AuthenticationError

+
+

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

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
appState +error +error_description +state +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

appState

+
appState: any = null
+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

state

+
state: string
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/cachekey.html b/docs/classes/cachekey.html index 90fc61827..fe6dc5ada 100644 --- a/docs/classes/cachekey.html +++ b/docs/classes/cachekey.html @@ -1,2985 +1,178 @@ - - - - - - CacheKey | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +CacheKey | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - CacheKey -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

audience

-
audience: string
- -
-
- -

client_id

-
client_id: string
- -
-
- -

prefix

-
prefix: string
- -
-
- -

scope

-
scope: string
- -
-
-
-

Methods

-
- -

toKey

-
    -
  • toKey(): string
    • -
-
    -
  • - -
    -
    -

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

    -
    -
    -

    Returns string

    -

    A string representation of the key

    -
    • -
-
-
- -

Static fromCacheEntry

- -
    -
  • - -
    -
    -

    Utility function to build a CacheKey instance from a cache entry

    -
    -
    -

    Parameters

    - -

    Returns CacheKey

    -

    An instance of CacheKey

    -
    • -
-
-
- -

Static fromKey

- -
    -
  • - -
    -
    -

    Converts a cache key string into a CacheKey instance.

    -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -
      -

      The key to convert

      -
      -
      • -
    -

    Returns CacheKey

    -

    An instance of CacheKey

    -
    • -
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Class CacheKey

+
+

Hierarchy

+
    +
  • CacheKey
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
audience? +clientId +prefix +scope? +suffix? +
+
+

Methods

+
toKey +fromCacheEntry +fromKey +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional audience

+
audience?: string
+
+

clientId

+
clientId: string
+
+

prefix

+
prefix: string = CACHE_KEY_PREFIX
+
+

Optional scope

+
scope?: string
+
+

Optional suffix

+
suffix?: string
+
+

Methods

+
+

toKey

+
    + +
  • +

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

    + +

    Returns

    A string representation of the key

    +
    +

    Returns string

+
+

Static fromCacheEntry

+
+
+

Static fromKey

+
    + +
  • +

    Converts a cache key string into a CacheKey instance.

    + +

    Returns

    An instance of CacheKey

    - - - \ No newline at end of file +
    +

    Parameters

    +
      +
    • +
      key: string
      +

      The key to convert

      +
    +

    Returns CacheKey

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/cachekeymanifest.html b/docs/classes/cachekeymanifest.html deleted file mode 100644 index 5b555db22..000000000 --- a/docs/classes/cachekeymanifest.html +++ /dev/null @@ -1,2918 +0,0 @@ - - - - - - CacheKeyManifest | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - CacheKeyManifest -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Methods

-
- -

add

-
    -
  • add(key: string): Promise<void>
    • -
- -
-
- -

clear

- - -
-
- -

get

- - -
-
- -

remove

-
    -
  • remove(key: string): Promise<void>
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/cachemanager.html b/docs/classes/cachemanager.html deleted file mode 100644 index f6e0df5ae..000000000 --- a/docs/classes/cachemanager.html +++ /dev/null @@ -1,2953 +0,0 @@ - - - - - - CacheManager | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - CacheManager -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Methods

-
- -

clear

-
    -
  • clear(clientId?: string): Promise<void>
    • -
- -
-
- -

clearSync

-
    -
  • clearSync(clientId?: string): void
    • -
-
    -
  • - -
    -
    -

    Note: only call this if you're sure one of our internal (synchronous) caches are being used.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional clientId: string
      -
      • -
    -

    Returns void

    -
    • -
-
-
- -

get

-
    -
  • get(cacheKey: CacheKey, expiryAdjustmentSeconds?: number): Promise<Partial<CacheEntry> | undefined>
    • -
-
    -
  • - -

    Parameters

    -
      -
    • -
      cacheKey: CacheKey
      -
      • -
    • -
      Default value expiryAdjustmentSeconds: number = DEFAULT_EXPIRY_ADJUSTMENT_SECONDS
      -
      • -
    -

    Returns Promise<Partial<CacheEntry> | undefined>

    -
    • -
-
-
- -

set

- - -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/genericerror.html b/docs/classes/genericerror.html index 5ed1f2e67..48192da9b 100644 --- a/docs/classes/genericerror.html +++ b/docs/classes/genericerror.html @@ -1,2981 +1,130 @@ - - - - - - GenericError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +GenericError | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

Thrown when network requests to the Auth server fail.

-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new GenericError(error: string, error_description: string): GenericError
    • -
- -
-
-
-

Properties

-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
- -

Static Error

-
Error: ErrorConstructor
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
-
    -
  • - -

    Parameters

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

    Returns GenericError

    -
    • -
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class GenericError

+
+

Thrown when network requests to the Auth server fail.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      error: string
      • +
    • +
      error_description: string
    +

    Returns GenericError

+
+

Properties

+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/inmemorycache.html b/docs/classes/inmemorycache.html index 890edc74c..24f771c13 100644 --- a/docs/classes/inmemorycache.html +++ b/docs/classes/inmemorycache.html @@ -1,2798 +1,78 @@ - - - - - - InMemoryCache | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +InMemoryCache | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - InMemoryCache -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

enclosedCache

-
enclosedCache: ICache = (function () {let cache: Record<string, unknown> = {};return {set<T = Cacheable>(key: string, entry: T) {cache[key] = entry;},get<T = Cacheable>(key: string) {const cacheEntry = cache[key] as T;if (!cacheEntry) {return;}return cacheEntry;},remove(key: string) {delete cache[key];},allKeys(): string[] {return Object.keys(cache);}};})()
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class InMemoryCache

+
+

Hierarchy

+
    +
  • InMemoryCache
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
enclosedCache +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

enclosedCache

+
enclosedCache: ICache = ...
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/localstoragecache.html b/docs/classes/localstoragecache.html index 15819b11c..54cf0bb67 100644 --- a/docs/classes/localstoragecache.html +++ b/docs/classes/localstoragecache.html @@ -1,2911 +1,146 @@ - - - - - - LocalStorageCache | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +LocalStorageCache | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - LocalStorageCache -
    • -
-
-
-

Implements

- -
-
-

Index

-
-
-
-

Methods

- -
-
-
-
-
-

Methods

-
- -

allKeys

-
    -
  • allKeys(): string[]
    • -
- -
-
- -

get

-
    -
  • get<T>(key: string): T
    • -
- -
-
- -

remove

-
    -
  • remove(key: string): void
    • -
- -
-
- -

set

-
    -
  • set<T>(key: string, entry: T): void
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class LocalStorageCache

+
+

Hierarchy

+
    +
  • LocalStorageCache
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
allKeys +get +remove +set +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

allKeys

+
+
+

get

+
+
+

remove

+
+
+

set

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/mfarequirederror.html b/docs/classes/mfarequirederror.html index 4d20d9331..7a0a7a0aa 100644 --- a/docs/classes/mfarequirederror.html +++ b/docs/classes/mfarequirederror.html @@ -1,2971 +1,137 @@ - - - - - - MfaRequiredError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +MfaRequiredError | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

Error thrown when the token exchange results in a mfa_required error

-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new MfaRequiredError(error: string, error_description: string, mfa_token: string): MfaRequiredError
    • -
- -
-
-
-

Properties

-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

mfa_token

-
mfa_token: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class MfaRequiredError

+
+

Error thrown when the token exchange results in a mfa_required error

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description +mfa_token +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

mfa_token

+
mfa_token: string
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/missingrefreshtokenerror.html b/docs/classes/missingrefreshtokenerror.html deleted file mode 100644 index 7fdc842ba..000000000 --- a/docs/classes/missingrefreshtokenerror.html +++ /dev/null @@ -1,2975 +0,0 @@ - - - - - - MissingRefreshTokenError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

audience

-
audience: string
- -
-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

scope

-
scope: string
- -
-
- -

Optional stack

-
stack: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/classes/popupcancellederror.html b/docs/classes/popupcancellederror.html index 53e0ad1bd..b370f46f6 100644 --- a/docs/classes/popupcancellederror.html +++ b/docs/classes/popupcancellederror.html @@ -1,2958 +1,133 @@ - - - - - - PopupCancelledError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +PopupCancelledError | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

popup

-
popup: Window
- -
-
- -

Optional stack

-
stack: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class PopupCancelledError

+
+

Thrown when network requests to the Auth server fail.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description +popup +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

popup

+
popup: Window
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/popuptimeouterror.html b/docs/classes/popuptimeouterror.html index 579708186..d76003e3c 100644 --- a/docs/classes/popuptimeouterror.html +++ b/docs/classes/popuptimeouterror.html @@ -1,2965 +1,133 @@ - - - - - - PopupTimeoutError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +PopupTimeoutError | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

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

-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

popup

-
popup: Window
- -
-
- -

Optional stack

-
stack: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class PopupTimeoutError

+
+

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

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description +popup +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

popup

+
popup: Window
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/timeouterror.html b/docs/classes/timeouterror.html index 295989621..88fe6e198 100644 --- a/docs/classes/timeouterror.html +++ b/docs/classes/timeouterror.html @@ -1,2951 +1,124 @@ - - - - - - TimeoutError | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +TimeoutError | @auth0/auth0-spa-js
+
+ +
-
-
-
-
-

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

-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

error

-
error: string
- -
-
- -

error_description

-
error_description: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: string
- -
-
- -

Optional stack

-
stack: string
- -
-
-
-

Methods

-
- -

Static fromPayload

-
    -
  • fromPayload(__namedParameters: { error: string; error_description: string }): GenericError
    • -
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class TimeoutError

+
+

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

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description +
+
+

Methods

+
fromPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

error

+
error: string
+
+

error_description

+
error_description: string
+
+

Methods

+
+

Static fromPayload

+
    + +
  • +
    +

    Parameters

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

    Returns GenericError

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/user.html b/docs/classes/user.html index a90f42d5a..693b59109 100644 --- a/docs/classes/user.html +++ b/docs/classes/user.html @@ -1,3068 +1,214 @@ - - - - - - User | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +User | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - User -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional address

-
address: string
- -
-
- -

Optional birthdate

-
birthdate: string
- -
-
- -

Optional email

-
email: string
- -
-
- -

Optional email_verified

-
email_verified: boolean
- -
-
- -

Optional family_name

-
family_name: string
- -
-
- -

Optional gender

-
gender: string
- -
-
- -

Optional given_name

-
given_name: string
- -
-
- -

Optional locale

-
locale: string
- -
-
- -

Optional middle_name

-
middle_name: string
- -
-
- -

Optional name

-
name: string
- -
-
- -

Optional nickname

-
nickname: string
- -
-
- -

Optional phone_number

-
phone_number: string
- -
-
- -

Optional phone_number_verified

-
phone_number_verified: boolean
- -
-
- -

Optional picture

-
picture: string
- -
-
- -

Optional preferred_username

-
preferred_username: string
- -
-
- -

Optional profile

-
profile: string
- -
-
- -

Optional sub

-
sub: string
- -
-
- -

Optional updated_at

-
updated_at: string
- -
-
- -

Optional website

-
website: string
- -
-
- -

Optional zoneinfo

-
zoneinfo: string
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Class User

+
+

Hierarchy

+
    +
  • User
+
+

Indexable

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

Constructors

+
constructor +
+
+

Properties

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

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional address

+
address?: string
+
+

Optional birthdate

+
birthdate?: string
+
+

Optional email

+
email?: string
+
+

Optional email_verified

+
email_verified?: boolean
+
+

Optional family_name

+
family_name?: string
+
+

Optional gender

+
gender?: string
+
+

Optional given_name

+
given_name?: string
+
+

Optional locale

+
locale?: string
+
+

Optional middle_name

+
middle_name?: string
+
+

Optional name

+
name?: string
+
+

Optional nickname

+
nickname?: string
+
+

Optional phone_number

+
phone_number?: string
+
+

Optional phone_number_verified

+
phone_number_verified?: boolean
+
+

Optional picture

+
picture?: string
+
+

Optional preferred_username

+
preferred_username?: string
+
+

Optional profile

+
profile?: string
+
+

Optional sub

+
sub?: string
+
+

Optional updated_at

+
updated_at?: string
+
+

Optional website

+
website?: string
+
+

Optional zoneinfo

+
zoneinfo?: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/createAuth0Client.html b/docs/functions/createAuth0Client.html new file mode 100644 index 000000000..577ed204b --- /dev/null +++ b/docs/functions/createAuth0Client.html @@ -0,0 +1,94 @@ +createAuth0Client | @auth0/auth0-spa-js
+
+ +
+
+
+
+ +

Function createAuth0Client

+
+
    + +
  • +

    Asynchronously creates the Auth0Client instance and calls checkSession.

    +

    Note: There are caveats to using this in a private browser tab, which may not silently authenticae +a user on page refresh. Please see the checkSession docs for more info.

    + +

    Returns

    An instance of Auth0Client

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Auth0Client>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/globals.html b/docs/globals.html deleted file mode 100644 index ee803e1a4..000000000 --- a/docs/globals.html +++ /dev/null @@ -1,3383 +0,0 @@ - - - - - - @auth0/auth0-spa-js | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

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

-

Release - Codecov - Downloads - License - CircleCI

-
-

ℹ️ A new major version of Auth0-SPA-JS is available in Beta! Try it out today, any feedback is appreciated. Read all about it on the beta branch.

-
-

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

- -

Documentation

- -
    -
  • Quickstart - our interactive guide for quickly adding login, logout and user information to your app using Auth0.
    • -
  • Sample app - a full-fledged sample app integrated with Auth0.
    • -
  • FAQs - frequently asked questions about auth0-spa-js SDK.
    • -
  • Examples - code samples for common scenarios.
    • -
  • Docs Site - explore our Docs site and learn more about Auth0.
    • -
- -

Getting Started

- - -

Installation

- -

Using npm in your project directory run the following command:

- 
npm install @auth0/auth0-spa-js
-
-

From the CDN:

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

Configure Auth0

- -

Create a Single Page Application in the Auth0 Dashboard.

-
-

If you're using an existing application, verify that you have configured the following settings in your Single Page Application:

-
    -
  • Click on the "Settings" tab of your application's page.
    • -
  • Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
    • -
  • Scroll down and click on the "Show Advanced Settings" link.
    • -
  • Under "Advanced Settings", click on the "OAuth" tab.
    • -
  • Ensure that "JsonWebToken Signature Algorithm" is set to RS256 and that "OIDC Conformant" is enabled.
    • -
-
-

Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:

-
    -
  • Allowed Callback URLs: http://localhost:3000
    • -
  • Allowed Logout URLs: http://localhost:3000
    • -
  • Allowed Web Origins: http://localhost:3000
    • -
-
-

These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).

-
-

Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.

- -

Configure the SDK

- -

Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.

- 
import createAuth0Client from '@auth0/auth0-spa-js';
-
-//with async/await
-const auth0 = await createAuth0Client({
-  domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
-});
-
-//or, you can just instantiate the client on it's own
-import { Auth0Client } from '@auth0/auth0-spa-js';
-
-const auth0 = new Auth0Client({
-  domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
-});
-
-//if you do this, you'll need to check the session yourself
-try {
-  await auth0.getTokenSilently();
-} catch (error) {
-  if (error.error !== 'login_required') {
-    throw error;
-  }
-}
-
- -

Logging In

- -

You can then use login using the Auth0Client instance you created:

- 
<button id="login">Click to Login</button>
-
- 
//redirect to the Universal Login Page
-document.getElementById('login').addEventListener('click', async () => {
-  await auth0.loginWithRedirect();
-});
-
-//in your callback route (<MY_CALLBACK_URL>)
-window.addEventListener('load', async () => {
-  const redirectResult = await auth0.handleRedirectCallback();
-  //logged in. you can get the user profile like this:
-  const user = await auth0.getUser();
-  console.log(user);
-});
-
-

For other comprehensive examples, see the EXAMPLES.md document.

- -

API Reference

- -

Explore API Methods available in auth0-spa-js.

- - -

Feedback

- - -

Contributing

- -

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

- - -

Raise an issue

- -

To provide feedback or report a bug, please raise an issue on our issue tracker.

- -

Vulnerability Reporting

- -

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

- -

What is Auth0?

- -

- - - - Auth0 Logo - -

-

- Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0? -

-

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

-
-
-

Index

-
-
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Type aliases

- -
-
-

Variables

- -
-
-

Functions

- -
-
-
-
-
-

Type aliases

-
- -

CacheEntry

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

Type declaration

-
    -
  • -
    access_token: string
    -
    • -
  • -
    audience: string
    -
    • -
  • -
    client_id: string
    -
    • -
  • -
    decodedToken: DecodedToken
    -
    • -
  • -
    expires_in: number
    -
    • -
  • -
    id_token: string
    -
    • -
  • -
    Optional oauthTokenScope?: string
    -
    • -
  • -
    Optional refresh_token?: string
    -
    • -
  • -
    scope: string
    -
    • -
-
-
-
- -

CacheKeyData

-
CacheKeyData: { audience: string; client_id: string; scope: string }
- -
-

Type declaration

-
    -
  • -
    audience: string
    -
    • -
  • -
    client_id: string
    -
    • -
  • -
    scope: string
    -
    • -
-
-
-
- -

CacheLocation

-
CacheLocation: "memory" | "localstorage"
- -
-
-

The possible locations where tokens can be stored

-
-
-
-
- -

Cacheable

-
Cacheable: WrappedCacheEntry | KeyManifestEntry
- -
-
- -

GetTokenSilentlyVerboseResponse

-
GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">
- -
-
- -

KeyManifestEntry

-
KeyManifestEntry: { keys: string[] }
- -
-

Type declaration

-
    -
  • -
    keys: string[]
    -
    • -
-
-
-
- -

MaybePromise

-
MaybePromise<T>: Promise<T> | T
- -

Type parameters

-
    -
  • -

    T

    -
    • -
-
-
- -

WrappedCacheEntry

-
WrappedCacheEntry: { body: Partial<CacheEntry>; expiresAt: number }
- -
-

Type declaration

-
    -
  • -
    body: Partial<CacheEntry>
    -
    • -
  • -
    expiresAt: number
    -
    • -
-
-
-
- -

getIdTokenClaimsOptions

-
getIdTokenClaimsOptions: GetIdTokenClaimsOptions
- -
-
-
-

Variables

-
- -

Const CACHE_KEY_PREFIX

-
CACHE_KEY_PREFIX: "@@auth0spajs@@" = "@@auth0spajs@@"
- -
-
- -

Const CACHE_LOCATION_LOCAL_STORAGE

-
CACHE_LOCATION_LOCAL_STORAGE: "localstorage" = "localstorage"
- -
-
- -

Const CACHE_LOCATION_MEMORY

-
CACHE_LOCATION_MEMORY: "memory" = "memory"
- -
-
- -

Const DEFAULT_EXPIRY_ADJUSTMENT_SECONDS

-
DEFAULT_EXPIRY_ADJUSTMENT_SECONDS: 0 = 0
- -
-
-
-

Functions

-
- -

Const DEFAULT_NOW_PROVIDER

-
    -
  • DEFAULT_NOW_PROVIDER(): number
    • -
- -
-
- -

createAuth0Client

- -
    -
  • - -
    -
    -

    Asynchronously creates the Auth0Client instance and calls checkSession.

    -
    -

    Note: There are caveats to using this in a private browser tab, which may not silently authenticae - a user on page refresh. Please see the checkSession docs for more info.

    -
    -

    Parameters

    - -

    Returns Promise<Auth0Client>

    -

    An instance of Auth0Client

    -
    • -
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 0021679fe..cecf0550a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,3384 +1,199 @@ - - - - - - @auth0/auth0-spa-js | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +@auth0/auth0-spa-js
+
+ +
-
-
-

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

-

Release - Codecov - Downloads - License - CircleCI

-
-

ℹ️ A new major version of Auth0-SPA-JS is available in Beta! Try it out today, any feedback is appreciated. Read all about it on the beta branch.

-
-

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

- -

Documentation

- -
    -
  • Quickstart - our interactive guide for quickly adding login, logout and user information to your app using Auth0.
    • -
  • Sample app - a full-fledged sample app integrated with Auth0.
    • -
  • FAQs - frequently asked questions about auth0-spa-js SDK.
    • -
  • Examples - code samples for common scenarios.
    • -
  • Docs Site - explore our Docs site and learn more about Auth0.
    • -
- -

Getting Started

- - -

Installation

- -

Using npm in your project directory run the following command:

- 
npm install @auth0/auth0-spa-js
+

+

+
@auth0/auth0-spa-js

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

+
Release
+Codecov
+Downloads
+License
+CircleCI

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

+
+
+  
Documentation

+
+
    
+
  • Quickstart - our interactive guide for quickly adding login, logout and user information to your app using Auth0.
    • 
+
  • Sample app - a full-fledged sample app integrated with Auth0.
    • 
+
  • FAQs - frequently asked questions about auth0-spa-js SDK.
    • 
+
  • Examples - code samples for common scenarios.
    • 
+
  • Docs Site - explore our Docs site and learn more about Auth0.
    • 
+

+
+
+  
Getting Started

+
+
+
+  
Installation

+
+
Using npm in your project directory run the following command:

+
npm install @auth0/auth0-spa-js
 

-			
From the CDN:

-			
<script src="https://cdn.auth0.com/js/auth0-spa-js/1.22/auth0-spa-js.production.js"></script>
+
From the CDN:

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

-			
-				
Configure Auth0

-			
-			
Create a Single Page Application in the Auth0 Dashboard.

-			

-				
If you're using an existing application, verify that you have configured the following settings in your Single Page Application:

-				
    
-					
  • Click on the "Settings" tab of your application's page.
    • 
-					
  • Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
    • 
-					
  • Scroll down and click on the "Show Advanced Settings" link.
    • 
-					
  • Under "Advanced Settings", click on the "OAuth" tab.
    • 
-					
  • Ensure that "JsonWebToken Signature Algorithm" is set to RS256 and that "OIDC Conformant" is enabled.
    • 
-				

-			

-			
Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:

-			
    
-				
  • Allowed Callback URLs: http://localhost:3000
    • 
-				
  • Allowed Logout URLs: http://localhost:3000
    • 
-				
  • Allowed Web Origins: http://localhost:3000
    • 
-			

-			

-				
These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).

-			

-			
Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.

-			
-				
Configure the SDK

-			
-			
Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.

-			
import createAuth0Client from '@auth0/auth0-spa-js';
 
-//with async/await
-const auth0 = await createAuth0Client({
-  domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
-});
-
-//or, you can just instantiate the client on it's own
-import { Auth0Client } from '@auth0/auth0-spa-js';
-
-const auth0 = new Auth0Client({
-  domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
-});
-
-//if you do this, you'll need to check the session yourself
-try {
-  await auth0.getTokenSilently();
-} catch (error) {
-  if (error.error !== 'login_required') {
-    throw error;
-  }
-}
+
+  
Configure Auth0

+
+
Create a Single Page Application in the Auth0 Dashboard.

+

+
If you're using an existing application, verify that you have configured the following settings in your Single Page Application:

+
    
+
  • Click on the "Settings" tab of your application's page.
    • 
+
  • Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
    • 
+
  • Scroll down and click on the "Show Advanced Settings" link.
    • 
+
  • Under "Advanced Settings", click on the "OAuth" tab.
    • 
+
  • Ensure that "JsonWebToken Signature Algorithm" is set to RS256 and that "OIDC Conformant" is enabled.
    • 
+

+

+
Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:

+
    
+
  • Allowed Callback URLs: http://localhost:3000
    • 
+
  • Allowed Logout URLs: http://localhost:3000
    • 
+
  • Allowed Web Origins: http://localhost:3000
    • 
+

+

+
These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback (see below).

+

+
Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.

+
+
+  
Configure the SDK

+
+
Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.

+
import { createAuth0Client } from '@auth0/auth0-spa-js';

//with async/await
const auth0 = await createAuth0Client({
  domain: '<AUTH0_DOMAIN>',
  clientId: '<AUTH0_CLIENT_ID>',
  authorizationParams: {
    redirect_uri: '<MY_CALLBACK_URL>'
  }
});

//or, you can just instantiate the client on it's own
import { Auth0Client } from '@auth0/auth0-spa-js';

const auth0 = new Auth0Client({
  domain: '<AUTH0_DOMAIN>',
  clientId: '<AUTH0_CLIENT_ID>',
  authorizationParams: {
    redirect_uri: '<MY_CALLBACK_URL>'
  }
});

//if you do this, you'll need to check the session yourself
try {
  await auth0.getTokenSilently();
} catch (error) {
  if (error.error !== 'login_required') {
    throw error;
  }
}
 

-			
-				
Logging In

-			
-			
You can then use login using the Auth0Client instance you created:

-			
<button id="login">Click to Login</button>
-

-			
//redirect to the Universal Login Page
-document.getElementById('login').addEventListener('click', async () => {
-  await auth0.loginWithRedirect();
-});
 
-//in your callback route (<MY_CALLBACK_URL>)
-window.addEventListener('load', async () => {
-  const redirectResult = await auth0.handleRedirectCallback();
-  //logged in. you can get the user profile like this:
-  const user = await auth0.getUser();
-  console.log(user);
-});
+
+  
Logging In

+
+
You can then use login using the Auth0Client instance you created:

+
<button id="login">Click to Login</button>
+

+
//redirect to the Universal Login Page
document.getElementById('login').addEventListener('click', async () => {
  await auth0.loginWithRedirect();
});

//in your callback route (<MY_CALLBACK_URL>)
window.addEventListener('load', async () => {
  const redirectResult = await auth0.handleRedirectCallback();
  //logged in. you can get the user profile like this:
  const user = await auth0.getUser();
  console.log(user);
});
 

-			
For other comprehensive examples, see the EXAMPLES.md document.

-			
-				
API Reference

-			
-			
Explore API Methods available in auth0-spa-js.

-			
-			
-				
Feedback

-			
-			
-				
Contributing

-			
-			
We appreciate feedback and contribution to this repo! Before you get started, please see the following:

-			
-			
-				
Raise an issue

-			
-			
To provide feedback or report a bug, please raise an issue on our issue tracker.

-			
-				
Vulnerability Reporting

-			
-			
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

-			
-				
What is Auth0?

-			
-			

-				
-					
-					
-					Auth0 Logo
-				
-			

-			

-				Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
-			

-			

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

-		

-		

-		

-			
Index

-			

-				

-					

-						
Classes

-						
-					

-					

-						
Interfaces

-						
-					

-					

-						
Type aliases

-						
-					

-					

-						
Variables

-						
-					

-					

-						
Functions

-						
-					

-				

-			

-		

-		

-			
Type aliases

-			

-				
-				
CacheEntry

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

-				
-				

-					
Type declaration

-					
    
-						
  • 
-							
    access_token: string
    
-						
    • 
-						
  • 
-							
    audience: string
    
-						
    • 
-						
  • 
-							
    client_id: string
    
-						
    • 
-						
  • 
-							
    decodedToken: DecodedToken
    
-						
    • 
-						
  • 
-							
    expires_in: number
    
-						
    • 
-						
  • 
-							
    id_token: string
    
-						
    • 
-						
  • 
-							
    Optional oauthTokenScope?: string
    
-						
    • 
-						
  • 
-							
    Optional refresh_token?: string
    
-						
    • 
-						
  • 
-							
    scope: string
    
-						
    • 
-					

-				

-			

-			

-				
-				
CacheKeyData

-				
CacheKeyData: { audience: string; client_id: string; scope: string }

-				
-				

-					
Type declaration

-					
    
-						
  • 
-							
    audience: string
    
-						
    • 
-						
  • 
-							
    client_id: string
    
-						
    • 
-						
  • 
-							
    scope: string
    
-						
    • 
-					

-				

-			

-			

-				
-				
CacheLocation

-				
CacheLocation: "memory" | "localstorage"

-				
-				

-					

-						
The possible locations where tokens can be stored

-					

-				

-			

-			

-				
-				
Cacheable

-				
Cacheable: WrappedCacheEntry | KeyManifestEntry

-				
-			

-			

-				
-				
GetTokenSilentlyVerboseResponse

-				
GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">

-				
-			

-			

-				
-				
KeyManifestEntry

-				
KeyManifestEntry: { keys: string[] }

-				
-				

-					
Type declaration

-					
    
-						
  • 
-							
    keys: string[]
    
-						
    • 
-					

-				

-			

-			

-				
-				
MaybePromise

-				
MaybePromise<T>: Promise<T> | T

-				
-				
Type parameters

-				
    
-					
  • 
-						
    T
    
-					
    • 
-				

-			

-			

-				
-				
WrappedCacheEntry

-				
WrappedCacheEntry: { body: Partial<CacheEntry>; expiresAt: number }

-				
-				

-					
Type declaration

-					
    
-						
  • 
-							
    body: Partial<CacheEntry>
    
-						
    • 
-						
  • 
-							
    expiresAt: number
    
-						
    • 
-					

-				

-			

-			

-				
-				
getIdTokenClaimsOptions

-				
getIdTokenClaimsOptions: GetIdTokenClaimsOptions

-				
-			

-		

-		

-			
Variables

-			

-				
-				
Const CACHE_KEY_PREFIX

-				
CACHE_KEY_PREFIX: "@@auth0spajs@@" = "@@auth0spajs@@"

-				
-			

-			

-				
-				
Const CACHE_LOCATION_LOCAL_STORAGE

-				
CACHE_LOCATION_LOCAL_STORAGE: "localstorage" = "localstorage"

-				
-			

-			

-				
-				
Const CACHE_LOCATION_MEMORY

-				
CACHE_LOCATION_MEMORY: "memory" = "memory"

-				
-			

-			

-				
-				
Const DEFAULT_EXPIRY_ADJUSTMENT_SECONDS

-				
DEFAULT_EXPIRY_ADJUSTMENT_SECONDS: 0 = 0

-				
-			

-		

-		

-			
Functions

-			

-				
-				
Const DEFAULT_NOW_PROVIDER

-				
    
-					
  • DEFAULT_NOW_PROVIDER(): number
    • 
-				

-				
-			

-			

-				
-				
createAuth0Client

-				
-				
    
-					
  • 
-						
-						
    
-							
    
-								
    Asynchronously creates the Auth0Client instance and calls checkSession.
    
-							
    
-							
    Note: There are caveats to using this in a private browser tab, which may not silently authenticae
-							a user on page refresh. Please see the checkSession docs for more info.
    
-						
    
-						
    Parameters
    
-						
-						
    Returns Promise<Auth0Client>
    
-						
    An instance of Auth0Client
    
-					
    • 
-				

-			

-		

-		

-			

-				
Legend

-				

-					
    
-						
  • Constructor
    • 
-						
  • Property
    • 
-						
  • Method
    • 
-					

-					
    
-						
  • Property
    • 
-						
  • Method
    • 
-					

-					
    
-						
  • Static property
    • 
-						
  • Static method
    • 
-					

-					
    
-						
  • Inherited property
    • 
-					

-				

-			

-		

-	

-
- - - \ No newline at end of file +

For other comprehensive examples, see the EXAMPLES.md document.

+ + +

API Reference

+ +

Explore API Methods available in auth0-spa-js.

+ + + +

Feedback

+ + + +

Contributing

+ +

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

+ + + +

Raise an issue

+ +

To provide feedback or report a bug, please raise an issue on our issue tracker.

+ + +

Vulnerability Reporting

+ +

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

+ + +

What is Auth0?

+ +

+ + + + Auth0 Logo + +

+

+ Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0? +

+

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

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Interface AuthorizationParams

+
+

Hierarchy

+
    +
  • AuthorizationParams
+
+

Indexable

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

Properties

+
acr_values? +audience? +connection? +display? +id_token_hint? +invitation? +login_hint? +max_age? +organization? +prompt? +redirect_uri? +scope? +screen_hint? +ui_locales? +
+
+

Properties

+
+

Optional acr_values

+
acr_values?: string
+
+

Optional audience

+
audience?: string
+

The default audience to be used for requesting API access.

+
+
+

Optional connection

+
connection?: string
+

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

+
+
+

Optional display

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

Optional id_token_hint

+
id_token_hint?: string
+

Previously issued ID Token.

+
+
+

Optional invitation

+
invitation?: string
+

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

+
+
+

Optional login_hint

+
login_hint?: string
+

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

+

This currently only affects the classic Lock experience.

+
+
+

Optional max_age

+
max_age?: string | number
+

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

+
+
+

Optional organization

+
organization?: string
+

The Id of an organization to log in to.

+

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.

+
+
+

Optional prompt

+
prompt?: "none" | "login" | "consent" | "select_account"
+
    +
  • 'none': do not prompt user for login or consent on reauthentication
    • +
  • 'login': prompt user for reauthentication
    • +
  • 'consent': prompt user for consent before processing request
    • +
  • 'select_account': prompt user to select an account
    • +
+
+
+

Optional redirect_uri

+
redirect_uri?: string
+

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

+
+
+

Optional scope

+
scope?: string
+

The default scope to be used on authentication requests.

+

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

+

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

+
+
+

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.

+
+
+

Optional ui_locales

+
ui_locales?: string
+

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Interface IdToken

+
+

Hierarchy

+
    +
  • IdToken
+
+

Indexable

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

Properties

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

Properties

+
+

__raw

+
__raw: string
+
+

Optional acr

+
acr?: string
+
+

Optional address

+
address?: string
+
+

Optional amr

+
amr?: string
+
+

Optional at_hash

+
at_hash?: string
+
+

Optional aud

+
aud?: string
+
+

Optional auth_time

+
auth_time?: string
+
+

Optional azp

+
azp?: string
+
+

Optional birthdate

+
birthdate?: string
+
+

Optional c_hash

+
c_hash?: string
+
+

Optional cnf

+
cnf?: string
+
+

Optional email

+
email?: string
+
+

Optional email_verified

+
email_verified?: boolean
+
+

Optional exp

+
exp?: number
+
+

Optional family_name

+
family_name?: string
+
+

Optional gender

+
gender?: string
+
+

Optional given_name

+
given_name?: string
+
+

Optional iat

+
iat?: number
+
+

Optional iss

+
iss?: string
+
+

Optional jti

+
jti?: string
+
+

Optional locale

+
locale?: string
+
+

Optional middle_name

+
middle_name?: string
+
+

Optional name

+
name?: string
+
+

Optional nbf

+
nbf?: number
+
+

Optional nickname

+
nickname?: string
+
+

Optional nonce

+
nonce?: string
+
+

Optional org_id

+
org_id?: string
+
+

Optional phone_number

+
phone_number?: string
+
+

Optional phone_number_verified

+
phone_number_verified?: boolean
+
+

Optional picture

+
picture?: string
+
+

Optional preferred_username

+
preferred_username?: string
+
+

Optional profile

+
profile?: string
+
+

Optional sid

+
sid?: string
+
+

Optional sub_jwk

+
sub_jwk?: string
+
+

Optional updated_at

+
updated_at?: string
+
+

Optional website

+
website?: string
+
+

Optional zoneinfo

+
zoneinfo?: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/advancedoptions.html b/docs/interfaces/advancedoptions.html deleted file mode 100644 index e5a673ef4..000000000 --- a/docs/interfaces/advancedoptions.html +++ /dev/null @@ -1,2805 +0,0 @@ - - - - - - AdvancedOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - AdvancedOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional defaultScope

-
defaultScope: string
- -
-
-

The default scope to be included with all requests. - If not provided, 'openid profile email' is used. This can be set to null in order to effectively remove the default scopes.

-
-

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

-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/auth0clientoptions.html b/docs/interfaces/auth0clientoptions.html index 7dff5d24f..d5f0cc432 100644 --- a/docs/interfaces/auth0clientoptions.html +++ b/docs/interfaces/auth0clientoptions.html @@ -1,3485 +1,280 @@ - - - - - - Auth0ClientOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +Auth0ClientOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - BaseLoginOptions -
      -
    • - Auth0ClientOptions -
      • -
    -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

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

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional acr_values

-
acr_values: string
- -
-
- -

Optional advancedOptions

-
advancedOptions: AdvancedOptions
- -
-
-

Changes to recommended defaults, like defaultScope

-
-
-
-
- -

Optional audience

-
audience: string
- -
-
-

The default audience to be used for requesting API access.

-
-
-
-
- -

Optional authorizeTimeoutInSeconds

-
authorizeTimeoutInSeconds: number
- -
-
-

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

-
-
-
-
- -

Optional cache

-
cache: ICache
- -
-
-

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

-
-
-
-
- -

Optional cacheLocation

-
cacheLocation: CacheLocation
- -
-
-

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

-
-

Read more about changing storage options in the Auth0 docs

-
-
-
- -

client_id

-
client_id: string
- -
-
-

The Client ID found on your Application settings page

-
-
-
-
- -

Optional connection

-
connection: string
- -
-
-

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

-
-
-
-
- -

Optional cookieDomain

-
cookieDomain: string
- -
-
-

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

-
-

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

-

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

-
-
-
- -

Optional display

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

domain

-
domain: string
- -
-
-

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

-
-
-
-
- -

Optional httpTimeoutInSeconds

-
httpTimeoutInSeconds: number
- -
-
-

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

-
-
-
-
- -

Optional id_token_hint

-
id_token_hint: string
- -
-
-

Previously issued ID Token.

-
-
-
-
- -

Optional invitation

-
invitation: string
- -
-
-

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

-
-
-
-
- -

Optional issuer

-
issuer: string
- -
-
-

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

-
-
-
-
- -

Optional leeway

-
leeway: number
- -
-
-

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

-
-
-
-
- -

Optional legacySameSiteCookie

-
legacySameSiteCookie: boolean
- -
-
-

Sets an additional cookie with no SameSite attribute to support legacy browsers - that are not compatible with the latest SameSite changes. - This will log a warning on modern browsers, you can disable the warning by setting - this to false but be aware that some older useragents will not work, - See https://www.chromium.org/updates/same-site/incompatible-clients - Defaults to true

-
-
-
-
- -

Optional login_hint

-
login_hint: string
- -
-
-

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

-
-

This currently only affects the classic Lock experience.

-
-
-
- -

Optional max_age

-
max_age: string | number
- -
-
-

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

-
-
-
-
- -

Optional nowProvider

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

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

-
-

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

-
-
-

Type declaration

-
    -
  • -
      -
    • (): Promise<number> | number
      • -
    -
      -
    • -

      Returns Promise<number> | number

      -
      • -
    -
    • -
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

The Id of an organization to log in to.

-
-

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.

-
-
-
- -

Optional prompt

-
prompt: "none" | "login" | "consent" | "select_account"
- -
-
-
    -
  • 'none': do not prompt user for login or consent on reauthentication
    • -
  • 'login': prompt user for reauthentication
    • -
  • 'consent': prompt user for consent before processing request
    • -
  • 'select_account': prompt user to select an account
    • -
-
-
-
-
- -

Optional redirect_uri

-
redirect_uri: string
- -
-
-

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

-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The default scope to be used on authentication requests. - The defaultScope defined in the Auth0Client is included - along with this scope

-
-
-
-
- -

Optional screen_hint

-
screen_hint: "signup" | "login" | 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.

-
-
-
- -

Optional sessionCheckExpiryDays

-
sessionCheckExpiryDays: number
- -
-
-

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

-
-
-
-
- -

Optional ui_locales

-
ui_locales: string
- -
-
-

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

-
-
-
-
- -

Optional useCookiesForTransactions

-
useCookiesForTransactions: boolean
- -
-
-

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

-
-

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

-
-
notes
-

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

-
-
-
-
-
- -

Optional useFormData

-
useFormData: boolean
- -
-
-

When true, data to the token endpoint is transmitted as x-www-form-urlencoded data instead of JSON. The default is false, but will default to true in a - future major version.

-
-

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

-
-
-
- -

Optional useRefreshTokens

-
useRefreshTokens: boolean
- -
-
-

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

-
-

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

-
-
-
- -

Optional useRefreshTokensFallback

-
useRefreshTokensFallback: boolean
- -
-
-

If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. - The default setting is true.

-
-

Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, - like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). - In situations like this you can disable the iframe fallback and handle the failed Refresh Grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."

-

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

-

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

-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Interface Auth0ClientOptions

+
+

Hierarchy

+
    +
  • BaseLoginOptions +
      +
    • Auth0ClientOptions
+
+
+
+ +
+
+

Properties

+
auth0Client? +authorizationParams? +authorizeTimeoutInSeconds? +cache? +cacheLocation? +clientId +cookieDomain? +domain +httpTimeoutInSeconds? +issuer? +leeway? +legacySameSiteCookie? +nowProvider? +sessionCheckExpiryDays? +useCookiesForTransactions? +useFormData? +useRefreshTokens? +useRefreshTokensFallback? +
+
+

Properties

+
+

Optional Internal auth0Client

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

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

+
+
+

Type declaration

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

Optional authorizationParams

+
authorizationParams?: AuthorizationParams
+

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

+
+
+

Optional authorizeTimeoutInSeconds

+
authorizeTimeoutInSeconds?: number
+

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

+
+
+

Optional cache

+
cache?: ICache
+

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

+
+
+

Optional cacheLocation

+
cacheLocation?: CacheLocation
+

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

+

Read more about changing storage options in the Auth0 docs

+
+
+

clientId

+
clientId: string
+

The Client ID found on your Application settings page

+
+
+

Optional cookieDomain

+
cookieDomain?: string
+

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

+

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

+

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

+
+
+

domain

+
domain: string
+

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

+
+
+

Optional httpTimeoutInSeconds

+
httpTimeoutInSeconds?: number
+

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

+
+
+

Optional issuer

+
issuer?: string
+

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

+
+
+

Optional leeway

+
leeway?: number
+

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

+
+
+

Optional legacySameSiteCookie

+
legacySameSiteCookie?: boolean
+

Sets an additional cookie with no SameSite attribute to support legacy browsers +that are not compatible with the latest SameSite changes. +This will log a warning on modern browsers, you can disable the warning by setting +this to false but be aware that some older useragents will not work, +See https://www.chromium.org/updates/same-site/incompatible-clients +Defaults to true

+
+
+

Optional nowProvider

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

Type declaration

+
    +
  • +
      +
    • (): number | Promise<number>
      • +
    • +

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

      +

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

      - - - \ No newline at end of file +

      Returns number | Promise<number>

+
+

Optional sessionCheckExpiryDays

+
sessionCheckExpiryDays?: number
+

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

+
+
+

Optional useCookiesForTransactions

+
useCookiesForTransactions?: boolean
+

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

+

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

+ +

Notes

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

+
+
+

Optional useFormData

+
useFormData?: boolean
+

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

+

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

+
+
+

Optional useRefreshTokens

+
useRefreshTokens?: boolean
+

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

+

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

+
+
+

Optional useRefreshTokensFallback

+
useRefreshTokensFallback?: boolean
+

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

+

Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, +like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). +In situations like this you can disable the iframe fallback and handle the failed refresh_token grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."

+

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

+ +

Example

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

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/decodedtoken.html b/docs/interfaces/decodedtoken.html index 46d84bc44..9203c1426 100644 --- a/docs/interfaces/decodedtoken.html +++ b/docs/interfaces/decodedtoken.html @@ -1,2812 +1,72 @@ - - - - - - DecodedToken | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +DecodedToken | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - DecodedToken -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

claims

-
claims: IdToken
- -
-
- -

user

-
user: User
- -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface DecodedToken

+
+

Hierarchy

+
    +
  • DecodedToken
+
+
+
+ +
+
+

Properties

+
claims +user +
+
+

Properties

+
+

claims

+
claims: IdToken
+
+

user

+
user: User
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/getidtokenclaimsoptions.html b/docs/interfaces/getidtokenclaimsoptions.html deleted file mode 100644 index 6be4b1bb3..000000000 --- a/docs/interfaces/getidtokenclaimsoptions.html +++ /dev/null @@ -1,2822 +0,0 @@ - - - - - - GetIdTokenClaimsOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - GetIdTokenClaimsOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional audience

-
audience: string
- -
-
-

The audience that was used in the authentication request

-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The scope that was used in the authentication request

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/gettokensilentlyoptions.html b/docs/interfaces/gettokensilentlyoptions.html index e0fb2d9bc..163557313 100644 --- a/docs/interfaces/gettokensilentlyoptions.html +++ b/docs/interfaces/gettokensilentlyoptions.html @@ -1,2917 +1,122 @@ - - - - - - GetTokenSilentlyOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +GetTokenSilentlyOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - GetTokenSilentlyOptions -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

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

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional audience

-
audience: string
- -
-
-

The audience that was used in the authentication request

-
-
-
-
- -

Optional detailedResponse

-
detailedResponse: boolean
- -
-
-

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

-
-

The default is false.

-
-
-
- -

Optional ignoreCache

-
ignoreCache: boolean
- -
-
-

When true, ignores the cache and always sends a - request to Auth0.

-
-
-
-
- -

Optional redirect_uri

-
redirect_uri: string
- -
-
-

There's no actual redirect when getting a token silently, - but, according to the spec, a redirect_uri param is required. - Auth0 uses this parameter to validate that the current origin - matches the redirect_uri origin when sending the response. - It must be whitelisted in the "Allowed Web Origins" in your - Auth0 Application's settings.

-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The scope that was used in the authentication request

-
-
-
-
- -

Optional timeoutInSeconds

-
timeoutInSeconds: number
- -
-
-

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

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Interface GetTokenSilentlyOptions

+
+

Hierarchy

+
    +
  • GetTokenSilentlyOptions
+
+
+
+ +
+
+

Properties

+
authorizationParams? +cacheMode? +detailedResponse? +timeoutInSeconds? +
+
+

Properties

+
+

Optional authorizationParams

+
authorizationParams?: {
    audience?: string;
    redirect_uri?: string;
    scope?: string;
    [key: string]: any;
}
+

Parameters that will be sent back to Auth0 as part of a request.

- - - \ No newline at end of file +
+

Type declaration

+
    +
  • +
    [key: string]: any
    • +
  • +
    Optional audience?: string
    +

    The audience that was used in the authentication request

    +
    • +
  • +
    Optional redirect_uri?: string
    +

    There's no actual redirect when getting a token silently, +but, according to the spec, a redirect_uri param is required. +Auth0 uses this parameter to validate that the current origin +matches the redirect_uri origin when sending the response. +It must be whitelisted in the "Allowed Web Origins" in your +Auth0 Application's settings.

    +
    • +
  • +
    Optional scope?: string
    +

    The scope that was used in the authentication request

    +
+
+

Optional cacheMode

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

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

+
+
+

Optional detailedResponse

+
detailedResponse?: boolean
+

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

+

The default is false.

+
+
+

Optional timeoutInSeconds

+
timeoutInSeconds?: number
+

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/gettokenwithpopupoptions.html b/docs/interfaces/gettokenwithpopupoptions.html index c798f87d6..41986b9cf 100644 --- a/docs/interfaces/gettokenwithpopupoptions.html +++ b/docs/interfaces/gettokenwithpopupoptions.html @@ -1,3099 +1,82 @@ - - - - - - GetTokenWithPopupOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +GetTokenWithPopupOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

- -
-
-

Indexable

-
[key: string]: any
-
-
-

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

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional acr_values

-
acr_values: string
- -
-
- -

Optional audience

-
audience: string
- -
-
-

The default audience to be used for requesting API access.

-
-
-
-
- -

Optional connection

-
connection: string
- -
-
-

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

-
-
-
-
- -

Optional display

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

Optional id_token_hint

-
id_token_hint: string
- -
-
-

Previously issued ID Token.

-
-
-
-
- -

Optional ignoreCache

-
ignoreCache: boolean
- -
-
-

When true, ignores the cache and always sends a - request to Auth0.

-
-
-
-
- -

Optional invitation

-
invitation: string
- -
-
-

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

-
-
-
-
- -

Optional login_hint

-
login_hint: string
- -
-
-

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

-
-

This currently only affects the classic Lock experience.

-
-
-
- -

Optional max_age

-
max_age: string | number
- -
-
-

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

-
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

The Id of an organization to log in to.

-
-

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.

-
-
-
- -

Optional prompt

-
prompt: "none" | "login" | "consent" | "select_account"
- -
-
-
    -
  • 'none': do not prompt user for login or consent on reauthentication
    • -
  • 'login': prompt user for reauthentication
    • -
  • 'consent': prompt user for consent before processing request
    • -
  • 'select_account': prompt user to select an account
    • -
-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The default scope to be used on authentication requests. - The defaultScope defined in the Auth0Client is included - along with this scope

-
-
-
-
- -

Optional screen_hint

-
screen_hint: "signup" | "login" | 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.

-
-
-
- -

Optional ui_locales

-
ui_locales: string
- -
-
-

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

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface GetTokenWithPopupOptions

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
authorizationParams? +cacheMode? +
+
+

Properties

+
+

Optional authorizationParams

+
authorizationParams?: AuthorizationParams
+

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

+
+
+

Optional cacheMode

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

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/getuseroptions.html b/docs/interfaces/getuseroptions.html deleted file mode 100644 index 35f336b68..000000000 --- a/docs/interfaces/getuseroptions.html +++ /dev/null @@ -1,2822 +0,0 @@ - - - - - - GetUserOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- -
-
-
-

Hierarchy

-
    -
  • - GetUserOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional audience

-
audience: string
- -
-
-

The audience that was used in the authentication request

-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The scope that was used in the authentication request

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/icache.html b/docs/interfaces/icache.html index b19624a2f..da7d7f9ef 100644 --- a/docs/interfaces/icache.html +++ b/docs/interfaces/icache.html @@ -1,2907 +1,129 @@ - - - - - - ICache | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +ICache | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - ICache -
    • -
-
-
-

Implemented by

- -
-
-

Index

-
-
-
-

Methods

- -
-
-
-
-
-

Methods

-
- -

Optional allKeys

- - -
-
- -

get

- - -
-
- -

remove

- - -
-
- -

set

- - -
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface ICache

+
+

Hierarchy

+
    +
  • ICache
+
+

Implemented by

+
+
+
+
+ +
+
+

Methods

+
allKeys? +get +remove +set +
+
+

Methods

+
+

Optional allKeys

+
+
+

get

+
+
+

remove

+
+
+

set

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/logoutoptions.html b/docs/interfaces/logoutoptions.html index 0e98c6b1c..e3ee5373a 100644 --- a/docs/interfaces/logoutoptions.html +++ b/docs/interfaces/logoutoptions.html @@ -1,2877 +1,132 @@ - - - - - - LogoutOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +LogoutOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - LogoutOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional client_id

-
client_id: string
- -
-
-

The client_id of your application.

-
-

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

-

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

-

Read more about how redirecting after logout works

-
-
-
- -

Optional federated

-
federated: boolean
- -
-
-

When supported by the upstream identity provider, - forces the user to logout of their identity provider - and from Auth0. - This option cannot be specified along with the localOnly option. - Read more about how federated logout works at Auth0

-
-
-
-
- -

Optional localOnly

-
localOnly: boolean
- -
-
-

When true, this skips the request to the logout endpoint on the authorization server, - effectively performing a "local" logout of the application. No redirect should take place, - you should update local logged in state. - This option cannot be specified along with the federated option.

-
-
-
-
- -

Optional returnTo

-
returnTo: string
- -
-
-

The URL where Auth0 will redirect your browser to after the logout.

-
-

Note: If the client_id parameter is included, the - returnTo URL that is provided must be listed in the - Application's "Allowed Logout URLs" in the Auth0 dashboard. - However, if the client_id parameter is not included, the - returnTo URL must be listed in the "Allowed Logout URLs" at - the account level in the Auth0 dashboard.

-

Read more about how redirecting after logout works

-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Interface LogoutOptions

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
clientId? +logoutParams? +onRedirect? +
+
+

Properties

+
+

Optional clientId

+
clientId?: string
+

The clientId of your application.

+

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

+

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

+

Read more about how redirecting after logout works

+
+
+

Optional logoutParams

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

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

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
    • +
  • +
    Optional federated?: boolean
    +

    When supported by the upstream identity provider, +forces the user to logout of their identity provider +and from Auth0. +Read more about how federated logout works at Auth0

    +
    • +
  • +
    Optional returnTo?: string
    +

    The URL where Auth0 will redirect your browser to after the logout.

    +

    Note: If the client_id parameter is included, the +returnTo URL that is provided must be listed in the +Application's "Allowed Logout URLs" in the Auth0 dashboard. +However, if the client_id parameter is not included, the +returnTo URL must be listed in the "Allowed Logout URLs" at +the account level in the Auth0 dashboard.

    +

    Read more about how redirecting after logout works

    +
+
+

Optional onRedirect

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

Type declaration

+
    +
  • +
      +
    • (url: string): Promise<void>
      • +
    • +

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

      + +

      Example

      await auth0.logout({
        async onRedirect(url) {
          window.location.replace(url);
        }
      });
+
      - - - \ No newline at end of file +
      +

      Parameters

      +
        +
      • +
        url: string
      +

      Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/logouturloptions.html b/docs/interfaces/logouturloptions.html index ad706821a..91dbf9b31 100644 --- a/docs/interfaces/logouturloptions.html +++ b/docs/interfaces/logouturloptions.html @@ -1,2854 +1,105 @@ - - - - - - LogoutUrlOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +LogoutUrlOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - LogoutUrlOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional client_id

-
client_id: string
- -
-
-

The client_id of your application.

-
-

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

-

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

-

Read more about how redirecting after logout works

-
-
-
- -

Optional federated

-
federated: boolean
- -
-
-

When supported by the upstream identity provider, - forces the user to logout of their identity provider - and from Auth0. - Read more about how federated logout works at Auth0

-
-
-
-
- -

Optional returnTo

-
returnTo: string
- -
-
-

The URL where Auth0 will redirect your browser to after the logout.

-
-

Note: If the client_id parameter is included, the - returnTo URL that is provided must be listed in the - Application's "Allowed Logout URLs" in the Auth0 dashboard. - However, if the client_id parameter is not included, the - returnTo URL must be listed in the "Allowed Logout URLs" at - the account level in the Auth0 dashboard.

-

Read more about how redirecting after logout works

-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Interface LogoutUrlOptions

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
clientId? +logoutParams? +
+
+

Properties

+
+

Optional clientId

+
clientId?: string
+

The clientId of your application.

+

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

+

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

+

Read more about how redirecting after logout works

+
+
+

Optional logoutParams

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

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

- - - \ No newline at end of file +
+

Type declaration

+
    +
  • +
    [key: string]: any
    • +
  • +
    Optional federated?: boolean
    +

    When supported by the upstream identity provider, +forces the user to logout of their identity provider +and from Auth0. +Read more about how federated logout works at Auth0

    +
    • +
  • +
    Optional returnTo?: string
    +

    The URL where Auth0 will redirect your browser to after the logout.

    +

    Note: If the client_id parameter is included, the +returnTo URL that is provided must be listed in the +Application's "Allowed Logout URLs" in the Auth0 dashboard. +However, if the client_id parameter is not included, the +returnTo URL must be listed in the "Allowed Logout URLs" at +the account level in the Auth0 dashboard.

    +

    Read more about how redirecting after logout works

    +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/popupconfigoptions.html b/docs/interfaces/popupconfigoptions.html index 3536a008f..3d49e8d82 100644 --- a/docs/interfaces/popupconfigoptions.html +++ b/docs/interfaces/popupconfigoptions.html @@ -1,2825 +1,79 @@ - - - - - - PopupConfigOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +PopupConfigOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

-
    -
  • - PopupConfigOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional popup

-
popup: any
- -
-
-

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

-
-
-
-
- -

Optional timeoutInSeconds

-
timeoutInSeconds: number
- -
-
-

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

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface PopupConfigOptions

+
+

Hierarchy

+
    +
  • PopupConfigOptions
+
+
+
+ +
+
+

Properties

+
popup? +timeoutInSeconds? +
+
+

Properties

+
+

Optional popup

+
popup?: any
+

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

+
+
+

Optional timeoutInSeconds

+
timeoutInSeconds?: number
+

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/popuploginoptions.html b/docs/interfaces/popuploginoptions.html index b2ca35de7..729b4ead2 100644 --- a/docs/interfaces/popuploginoptions.html +++ b/docs/interfaces/popuploginoptions.html @@ -1,3084 +1,73 @@ - - - - - - PopupLoginOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +PopupLoginOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Hierarchy

- -
-
-

Indexable

-
[key: string]: any
-
-
-

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

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional acr_values

-
acr_values: string
- -
-
- -

Optional audience

-
audience: string
- -
-
-

The default audience to be used for requesting API access.

-
-
-
-
- -

Optional connection

-
connection: string
- -
-
-

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

-
-
-
-
- -

Optional display

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

Optional id_token_hint

-
id_token_hint: string
- -
-
-

Previously issued ID Token.

-
-
-
-
- -

Optional invitation

-
invitation: string
- -
-
-

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

-
-
-
-
- -

Optional login_hint

-
login_hint: string
- -
-
-

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

-
-

This currently only affects the classic Lock experience.

-
-
-
- -

Optional max_age

-
max_age: string | number
- -
-
-

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

-
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

The Id of an organization to log in to.

-
-

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.

-
-
-
- -

Optional prompt

-
prompt: "none" | "login" | "consent" | "select_account"
- -
-
-
    -
  • 'none': do not prompt user for login or consent on reauthentication
    • -
  • 'login': prompt user for reauthentication
    • -
  • 'consent': prompt user for consent before processing request
    • -
  • 'select_account': prompt user to select an account
    • -
-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The default scope to be used on authentication requests. - The defaultScope defined in the Auth0Client is included - along with this scope

-
-
-
-
- -

Optional screen_hint

-
screen_hint: "signup" | "login" | 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.

-
-
-
- -

Optional ui_locales

-
ui_locales: string
- -
-
-

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

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface PopupLoginOptions

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
authorizationParams? +
+
+

Properties

+
+

Optional authorizationParams

+
authorizationParams?: AuthorizationParams
+

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/redirectloginoptions.html b/docs/interfaces/redirectloginoptions.html index 5de8c65c5..20b5877fc 100644 --- a/docs/interfaces/redirectloginoptions.html +++ b/docs/interfaces/redirectloginoptions.html @@ -1,3166 +1,119 @@ - - - - - - RedirectLoginOptions | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +RedirectLoginOptions | @auth0/auth0-spa-js
+
+ +
-
-
-

Type parameters

-
    -
  • -

    TAppState

    -
    • -
-
-
-

Hierarchy

-
    -
  • - BaseLoginOptions -
      -
    • - RedirectLoginOptions -
      • -
    -
    • -
-
-
-

Indexable

-
[key: string]: any
-
-
-

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

-
-
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional acr_values

-
acr_values: string
- -
-
- -

Optional appState

-
appState: TAppState
- -
-
-

Used to store state before doing the redirect

-
-
-
-
- -

Optional audience

-
audience: string
- -
-
-

The default audience to be used for requesting API access.

-
-
-
-
- -

Optional connection

-
connection: string
- -
-
-

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

-
-
-
-
- -

Optional display

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

Optional fragment

-
fragment: string
- -
-
-

Used to add to the URL fragment before redirecting

-
-
-
-
- -

Optional id_token_hint

-
id_token_hint: string
- -
-
-

Previously issued ID Token.

-
-
-
-
- -

Optional invitation

-
invitation: string
- -
-
-

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

-
-
-
-
- -

Optional login_hint

-
login_hint: string
- -
-
-

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

-
-

This currently only affects the classic Lock experience.

-
-
-
- -

Optional max_age

-
max_age: string | number
- -
-
-

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

-
-
-
-
- -

Optional organization

-
organization: string
- -
-
-

The Id of an organization to log in to.

-
-

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.

-
-
-
- -

Optional prompt

-
prompt: "none" | "login" | "consent" | "select_account"
- -
-
-
    -
  • 'none': do not prompt user for login or consent on reauthentication
    • -
  • 'login': prompt user for reauthentication
    • -
  • 'consent': prompt user for consent before processing request
    • -
  • 'select_account': prompt user to select an account
    • -
-
-
-
-
- -

Optional redirectMethod

-
redirectMethod: "replace" | "assign"
- -
-
-

Used to select the window.location method used to redirect

-
-
-
-
- -

Optional redirect_uri

-
redirect_uri: string
- -
-
-

The URL where Auth0 will redirect your browser to with - the authentication result. It must be whitelisted in - the "Allowed Callback URLs" field in your Auth0 Application's - settings.

-
-
-
-
- -

Optional scope

-
scope: string
- -
-
-

The default scope to be used on authentication requests. - The defaultScope defined in the Auth0Client is included - along with this scope

-
-
-
-
- -

Optional screen_hint

-
screen_hint: "signup" | "login" | 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.

-
-
-
- -

Optional ui_locales

-
ui_locales: string
- -
-
-

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

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
+
+
+ +

Interface RedirectLoginOptions<TAppState>

+
+

Type Parameters

+
    +
  • +

    TAppState = any

+
+

Hierarchy

+
    +
  • BaseLoginOptions +
      +
    • RedirectLoginOptions
+
+
+
+ +
+
+

Properties

+
appState? +authorizationParams? +fragment? +onRedirect? +
+
+

Properties

+
+

Optional appState

+
appState?: TAppState
+

Used to store state before doing the redirect

+
+
+

Optional authorizationParams

+
authorizationParams?: AuthorizationParams
+

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

+
+
+

Optional fragment

+
fragment?: string
+

Used to add to the URL fragment before redirecting

+
+
+

Optional onRedirect

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

Type declaration

+
    +
  • +
      +
    • (url: string): Promise<void>
      • +
    • +

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

      + +

      Example

      const client = new Auth0Client({
        async onRedirect(url) {
          window.location.replace(url);
        }
      });
+
      - - - \ No newline at end of file +
      +

      Parameters

      +
        +
      • +
        url: string
      +

      Returns Promise<void>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/interfaces/redirectloginresult.html b/docs/interfaces/redirectloginresult.html index 316470518..6515f0179 100644 --- a/docs/interfaces/redirectloginresult.html +++ b/docs/interfaces/redirectloginresult.html @@ -1,2811 +1,72 @@ - - - - - - RedirectLoginResult | @auth0/auth0-spa-js - - - - - -
-
-
-
-
- @auth0/auth0-spa-js -
-
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
- +RedirectLoginResult | @auth0/auth0-spa-js
+
+ +
-
-
-

Type parameters

-
    -
  • -

    TAppState

    -
    • -
-
-
-

Hierarchy

-
    -
  • - RedirectLoginResult -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional appState

-
appState: TAppState
- -
-
-

State stored when the redirect request was made

-
-
-
-
-
-
-

Legend

-
-
    -
  • Constructor
    • -
  • Property
    • -
  • Method
    • -
-
    -
  • Property
    • -
  • Method
    • -
-
    -
  • Static property
    • -
  • Static method
    • -
-
    -
  • Inherited property
    • -
-
-
-
-
-
- - - \ No newline at end of file +
+
+ +

Interface RedirectLoginResult<TAppState>

+
+

Type Parameters

+
    +
  • +

    TAppState = any

+
+

Hierarchy

+
    +
  • RedirectLoginResult
+
+
+
+ +
+
+

Properties

+
appState? +
+
+

Properties

+
+

Optional appState

+
appState?: TAppState
+

State stored when the redirect request was made

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 000000000..dc93031a4 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,120 @@ +@auth0/auth0-spa-js
+
+ +
+
+
+
+

@auth0/auth0-spa-js

+
+
+

Index

+
+

Classes

+
Auth0Client +AuthenticationError +CacheKey +GenericError +InMemoryCache +LocalStorageCache +MfaRequiredError +PopupCancelledError +PopupTimeoutError +TimeoutError +User +
+
+

Interfaces

+
Auth0ClientOptions +AuthorizationParams +DecodedToken +GetTokenSilentlyOptions +GetTokenWithPopupOptions +ICache +IdToken +LogoutOptions +LogoutUrlOptions +PopupConfigOptions +PopupLoginOptions +RedirectLoginOptions +RedirectLoginResult +
+
+

Type Aliases

+
CacheEntry +CacheKeyData +CacheLocation +Cacheable +GetTokenSilentlyVerboseResponse +KeyManifestEntry +MaybePromise +TokenEndpointResponse +WrappedCacheEntry +
+
+

Functions

+
createAuth0Client +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/CacheEntry.html b/docs/types/CacheEntry.html new file mode 100644 index 000000000..51f78e16e --- /dev/null +++ b/docs/types/CacheEntry.html @@ -0,0 +1,98 @@ +CacheEntry | @auth0/auth0-spa-js
+
+ +
+
+
+
+ +

Type alias CacheEntry

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

Type declaration

+
    +
  • +
    access_token: string
    • +
  • +
    audience: string
    • +
  • +
    client_id: string
    • +
  • +
    Optional decodedToken?: DecodedToken
    • +
  • +
    expires_in: number
    • +
  • +
    Optional id_token?: string
    • +
  • +
    Optional oauthTokenScope?: string
    • +
  • +
    Optional refresh_token?: string
    • +
  • +
    scope: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias CacheKeyData

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

Type declaration

+
    +
  • +
    Optional audience?: string
    • +
  • +
    clientId: string
    • +
  • +
    Optional scope?: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias CacheLocation

+
CacheLocation: "memory" | "localstorage"
+

The possible locations where tokens can be stored

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html new file mode 100644 index 000000000..51dd1153c --- /dev/null +++ b/docs/types/Cacheable.html @@ -0,0 +1,77 @@ +Cacheable | @auth0/auth0-spa-js
+
+ +
+
+
+
+ +

Type alias Cacheable

+
Cacheable: WrappedCacheEntry | KeyManifestEntry
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/types/GetTokenSilentlyVerboseResponse.html b/docs/types/GetTokenSilentlyVerboseResponse.html new file mode 100644 index 000000000..9ac726c62 --- /dev/null +++ b/docs/types/GetTokenSilentlyVerboseResponse.html @@ -0,0 +1,77 @@ +GetTokenSilentlyVerboseResponse | @auth0/auth0-spa-js
+
+ +
+
+
+
+ +

Type alias GetTokenSilentlyVerboseResponse

+
GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias KeyManifestEntry

+
KeyManifestEntry: {
    keys: string[];
}
+
+

Type declaration

+
    +
  • +
    keys: string[]
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias MaybePromise<T>

+
MaybePromise<T>: Promise<T> | T
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias TokenEndpointResponse

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

Type declaration

+
    +
  • +
    access_token: string
    • +
  • +
    expires_in: number
    • +
  • +
    id_token: string
    • +
  • +
    Optional refresh_token?: string
    • +
  • +
    Optional scope?: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

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

Type alias WrappedCacheEntry

+
WrappedCacheEntry: {
    body: Partial<CacheEntry>;
    expiresAt: number;
}
+
+

Type declaration

+
    +
  • +
    body: Partial<CacheEntry>
    • +
  • +
    expiresAt: number
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index d44852d18..49b674ff5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-spa-js", - "version": "2.0.0-beta.1", + "version": "2.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-spa-js", - "version": "2.0.0-beta.1", + "version": "2.0.0", "license": "MIT", "devDependencies": { "@auth0/component-cdn-uploader": "github:auth0/component-cdn-uploader#v2.2.2", diff --git a/package.json b/package.json index cdc27fdf8..13d6e6b9b 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "@auth0/auth0-spa-js", "description": "Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE", "license": "MIT", - "version": "2.0.0-beta.1", + "version": "2.0.0", "main": "dist/lib/auth0-spa-js.cjs.js", "types": "dist/typings/index.d.ts", "module": "dist/auth0-spa-js.production.esm.js", diff --git a/src/version.ts b/src/version.ts index c8798deb3..ff603d700 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.0.0-beta.1'; +export default '2.0.0';