diff --git a/.circleci/config.yml b/.circleci/config.yml index 9af1ecb5..a5da8ba3 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -62,7 +62,7 @@ workflows: context: - browserstack-env - ship/node-publish: - publish-command: npm publish --tag beta + publish-command: npm publish node-version: 18.12.1 context: - publish-npm @@ -71,6 +71,5 @@ workflows: branches: only: - master - - beta requires: - browserstack diff --git a/CHANGELOG.md b/CHANGELOG.md index 66e4323d..32c2f4d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Change Log +## [v2.0.0](https://github.com/auth0/auth0-react/tree/v2.0.0) (2023-01-19) + +Auth0-React v2 includes many significant changes compared to v1: + +- Removal of polyfills from bundles +- Introduction of `authorizationParams` and `logoutParams` for properties sent to Auth0 +- Removal of `buildAuthorizeUrl` and `buildLogoutUrl` +- Removal of `redirectMethod` on `loginWithRedirect` in favour of `openUrl` +- Removal of `localOnly` from `logout` in favour of `openUrl` +- Renaming of `ignoreCache` to `cacheMode` and introduction of `cache-only` +- Use `application/x-www-form-urlencoded` by default +- Do not fallback to refreshing tokens via iframe by default +- Changes to default scopes and removal of `advancedOptions.defaultScope` +- Removal of `claimCheck` on `withAuthenticationRequired` + +As with any major version bump, v2 of Auth0-React 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.0](https://github.com/auth0/auth0-react/tree/v2.0.0-beta.0) (2022-12-12) Auth0-React v2 includes many significant changes compared to v1: diff --git a/README.md b/README.md index 3bc0fb1c..516a93c0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ ![Auth0 SDK for React Single Page Applications](https://cdn.auth0.com/website/sdks/banners/auth0-react-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. - [![npm](https://img.shields.io/npm/v/@auth0/auth0-react.svg?style=flat)](https://www.npmjs.com/package/@auth0/auth0-react) [![codecov](https://img.shields.io/codecov/c/github/auth0/auth0-react/master.svg?style=flat)](https://codecov.io/gh/auth0/auth0-react) ![Downloads](https://img.shields.io/npm/dw/@auth0/auth0-react) @@ -25,13 +23,13 @@ Using [npm](https://npmjs.org/) ```bash -npm install @auth0/auth0-react@beta +npm install @auth0/auth0-react ``` Using [yarn](https://yarnpkg.com/) ```bash -yarn add @auth0/auth0-react@beta +yarn add @auth0/auth0-react ``` ### Configure Auth0 diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 386ace89..61f638bb 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,33 +1,33 @@ :root { - --light-hl-0: #800000; - --dark-hl-0: #808080; - --light-hl-1: #267F99; - --dark-hl-1: #4EC9B0; - --light-hl-2: #000000; - --dark-hl-2: #D4D4D4; - --light-hl-3: #FF0000; - --dark-hl-3: #9CDCFE; - --light-hl-4: #0000FF; - --dark-hl-4: #569CD6; - --light-hl-5: #001080; - --dark-hl-5: #9CDCFE; - --light-hl-6: #000000FF; - --dark-hl-6: #D4D4D4; - --light-hl-7: #008000; - --dark-hl-7: #6A9955; - --light-hl-8: #0070C1; - --dark-hl-8: #4FC1FF; - --light-hl-9: #795E26; - --dark-hl-9: #DCDCAA; - --light-hl-10: #AF00DB; - --dark-hl-10: #C586C0; - --light-hl-11: #800000; - --dark-hl-11: #569CD6; - --light-hl-12: #A31515; - --dark-hl-12: #CE9178; + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #008000; + --dark-hl-2: #6A9955; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #795E26; + --dark-hl-5: #DCDCAA; + --light-hl-6: #800000; + --dark-hl-6: #808080; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #E50000; + --dark-hl-8: #9CDCFE; + --light-hl-9: #0000FF; + --dark-hl-9: #569CD6; + --light-hl-10: #000000FF; + --dark-hl-10: #D4D4D4; + --light-hl-11: #0070C1; + --dark-hl-11: #4FC1FF; + --light-hl-12: #800000; + --dark-hl-12: #569CD6; --light-hl-13: #098658; --dark-hl-13: #B5CEA8; - --light-code-background: #F5F5F5; + --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -67,7 +67,7 @@ --code-background: var(--dark-code-background); } } -body.light { +:root[data-theme='light'] { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); @@ -85,7 +85,7 @@ body.light { --code-background: var(--light-code-background); } -body.dark { +:root[data-theme='dark'] { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); diff --git a/docs/assets/icons.css b/docs/assets/icons.css deleted file mode 100644 index 776a3562..00000000 --- a/docs/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.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(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./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; -} diff --git a/docs/assets/icons.png b/docs/assets/icons.png deleted file mode 100644 index 3836d5fe..00000000 Binary files a/docs/assets/icons.png and /dev/null differ diff --git a/docs/assets/icons@2x.png b/docs/assets/icons@2x.png deleted file mode 100644 index 5a209e2f..00000000 Binary files a/docs/assets/icons@2x.png and /dev/null differ diff --git a/docs/assets/main.js b/docs/assets/main.js index 54869f42..d55df032 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,52 +1,58 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{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.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(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 r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.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 ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);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 p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * 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 - */ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n.tagName!=="SECTION";)n=n.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function fe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/search.js b/docs/assets/search.js index 8ae063ff..4afc3962 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":64,\"name\":\"Auth0Provider\",\"url\":\"modules.html#Auth0Provider\",\"classes\":\"tsd-kind-function\"},{\"id\":1,\"kind\":256,\"name\":\"Auth0ProviderOptions\",\"url\":\"interfaces/Auth0ProviderOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":2,\"kind\":1024,\"name\":\"children\",\"url\":\"interfaces/Auth0ProviderOptions.html#children\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":3,\"kind\":2048,\"name\":\"onRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":4,\"kind\":1024,\"name\":\"skipRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#skipRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":5,\"kind\":1024,\"name\":\"domain\",\"url\":\"interfaces/Auth0ProviderOptions.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":6,\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/Auth0ProviderOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":7,\"kind\":1024,\"name\":\"clientId\",\"url\":\"interfaces/Auth0ProviderOptions.html#clientId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":8,\"kind\":1024,\"name\":\"redirectUri\",\"url\":\"interfaces/Auth0ProviderOptions.html#redirectUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":9,\"kind\":1024,\"name\":\"leeway\",\"url\":\"interfaces/Auth0ProviderOptions.html#leeway\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":10,\"kind\":1024,\"name\":\"cacheLocation\",\"url\":\"interfaces/Auth0ProviderOptions.html#cacheLocation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":11,\"kind\":1024,\"name\":\"cache\",\"url\":\"interfaces/Auth0ProviderOptions.html#cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":12,\"kind\":1024,\"name\":\"useRefreshTokens\",\"url\":\"interfaces/Auth0ProviderOptions.html#useRefreshTokens\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":13,\"kind\":1024,\"name\":\"authorizeTimeoutInSeconds\",\"url\":\"interfaces/Auth0ProviderOptions.html#authorizeTimeoutInSeconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":14,\"kind\":1024,\"name\":\"advancedOptions\",\"url\":\"interfaces/Auth0ProviderOptions.html#advancedOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":15,\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ProviderOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":16,\"kind\":1024,\"name\":\"defaultScope\",\"url\":\"interfaces/Auth0ProviderOptions.html#__type.defaultScope\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Auth0ProviderOptions.__type\"},{\"id\":17,\"kind\":1024,\"name\":\"maxAge\",\"url\":\"interfaces/Auth0ProviderOptions.html#maxAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":18,\"kind\":1024,\"name\":\"scope\",\"url\":\"interfaces/Auth0ProviderOptions.html#scope\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":19,\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/Auth0ProviderOptions.html#audience\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":20,\"kind\":1024,\"name\":\"organization\",\"url\":\"interfaces/Auth0ProviderOptions.html#organization\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":21,\"kind\":1024,\"name\":\"invitation\",\"url\":\"interfaces/Auth0ProviderOptions.html#invitation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":22,\"kind\":1024,\"name\":\"connection\",\"url\":\"interfaces/Auth0ProviderOptions.html#connection\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":23,\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/Auth0ProviderOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"id\":24,\"kind\":4194304,\"name\":\"AppState\",\"url\":\"modules.html#AppState\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":25,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#AppState.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AppState\"},{\"id\":26,\"kind\":1024,\"name\":\"returnTo\",\"url\":\"modules.html#AppState.__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppState.__type\"},{\"id\":27,\"kind\":64,\"name\":\"useAuth0\",\"url\":\"modules.html#useAuth0\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":28,\"kind\":64,\"name\":\"withAuth0\",\"url\":\"modules.html#withAuth0\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":29,\"kind\":256,\"name\":\"WithAuth0Props\",\"url\":\"interfaces/WithAuth0Props.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":30,\"kind\":1024,\"name\":\"auth0\",\"url\":\"interfaces/WithAuth0Props.html#auth0\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuth0Props\"},{\"id\":31,\"kind\":64,\"name\":\"withAuthenticationRequired\",\"url\":\"modules.html#withAuthenticationRequired\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":32,\"kind\":256,\"name\":\"WithAuthenticationRequiredOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":33,\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"id\":34,\"kind\":2048,\"name\":\"onRedirecting\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"id\":35,\"kind\":1024,\"name\":\"loginOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#loginOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"id\":36,\"kind\":2048,\"name\":\"claimCheck\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#claimCheck\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"id\":37,\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"id\":38,\"kind\":32,\"name\":\"Auth0Context\",\"url\":\"modules.html#Auth0Context\",\"classes\":\"tsd-kind-variable\"},{\"id\":39,\"kind\":256,\"name\":\"Auth0ContextInterface\",\"url\":\"interfaces/Auth0ContextInterface.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":40,\"kind\":1024,\"name\":\"getAccessTokenSilently\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":41,\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":42,\"kind\":2048,\"name\":\"getAccessTokenWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":43,\"kind\":2048,\"name\":\"getIdTokenClaims\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":44,\"kind\":2048,\"name\":\"loginWithRedirect\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":45,\"kind\":2048,\"name\":\"loginWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":46,\"kind\":2048,\"name\":\"logout\",\"url\":\"interfaces/Auth0ContextInterface.html#logout\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":47,\"kind\":2048,\"name\":\"buildAuthorizeUrl\",\"url\":\"interfaces/Auth0ContextInterface.html#buildAuthorizeUrl\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":48,\"kind\":2048,\"name\":\"buildLogoutUrl\",\"url\":\"interfaces/Auth0ContextInterface.html#buildLogoutUrl\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":49,\"kind\":2048,\"name\":\"handleRedirectCallback\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"id\":50,\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/Auth0ContextInterface.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"id\":51,\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/Auth0ContextInterface.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"id\":52,\"kind\":1024,\"name\":\"isLoading\",\"url\":\"interfaces/Auth0ContextInterface.html#isLoading\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"id\":53,\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/Auth0ContextInterface.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"id\":54,\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":55,\"kind\":1024,\"name\":\"redirectUri\",\"url\":\"interfaces/RedirectLoginOptions.html#redirectUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"id\":56,\"kind\":1024,\"name\":\"appState\",\"url\":\"interfaces/RedirectLoginOptions.html#appState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"id\":57,\"kind\":1024,\"name\":\"fragment\",\"url\":\"interfaces/RedirectLoginOptions.html#fragment\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"id\":58,\"kind\":128,\"name\":\"OAuthError\",\"url\":\"classes/OAuthError.html\",\"classes\":\"tsd-kind-class\"},{\"id\":59,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/OAuthError.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"id\":60,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/OAuthError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"OAuthError\"},{\"id\":61,\"kind\":1024,\"name\":\"error\",\"url\":\"classes/OAuthError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"id\":62,\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/OAuthError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,37.534]],[\"parent/0\",[]],[\"name/1\",[1,10.454]],[\"parent/1\",[]],[\"name/2\",[2,37.534]],[\"parent/2\",[1,0.954]],[\"name/3\",[3,37.534]],[\"parent/3\",[1,0.954]],[\"name/4\",[4,37.534]],[\"parent/4\",[1,0.954]],[\"name/5\",[5,37.534]],[\"parent/5\",[1,0.954]],[\"name/6\",[6,37.534]],[\"parent/6\",[1,0.954]],[\"name/7\",[7,37.534]],[\"parent/7\",[1,0.954]],[\"name/8\",[8,32.426]],[\"parent/8\",[1,0.954]],[\"name/9\",[9,37.534]],[\"parent/9\",[1,0.954]],[\"name/10\",[10,37.534]],[\"parent/10\",[1,0.954]],[\"name/11\",[11,37.534]],[\"parent/11\",[1,0.954]],[\"name/12\",[12,37.534]],[\"parent/12\",[1,0.954]],[\"name/13\",[13,37.534]],[\"parent/13\",[1,0.954]],[\"name/14\",[14,37.534]],[\"parent/14\",[1,0.954]],[\"name/15\",[15,26.548]],[\"parent/15\",[1,0.954]],[\"name/16\",[16,37.534]],[\"parent/16\",[17,3.424]],[\"name/17\",[18,37.534]],[\"parent/17\",[1,0.954]],[\"name/18\",[19,37.534]],[\"parent/18\",[1,0.954]],[\"name/19\",[20,37.534]],[\"parent/19\",[1,0.954]],[\"name/20\",[21,37.534]],[\"parent/20\",[1,0.954]],[\"name/21\",[22,37.534]],[\"parent/21\",[1,0.954]],[\"name/22\",[23,37.534]],[\"parent/22\",[1,0.954]],[\"name/23\",[24,32.426]],[\"parent/23\",[1,0.954]],[\"name/24\",[25,29.061]],[\"parent/24\",[]],[\"name/25\",[15,26.548]],[\"parent/25\",[25,2.651]],[\"name/26\",[26,32.426]],[\"parent/26\",[27,3.424]],[\"name/27\",[28,37.534]],[\"parent/27\",[]],[\"name/28\",[29,37.534]],[\"parent/28\",[]],[\"name/29\",[30,32.426]],[\"parent/29\",[]],[\"name/30\",[31,37.534]],[\"parent/30\",[30,2.958]],[\"name/31\",[32,37.534]],[\"parent/31\",[]],[\"name/32\",[33,22.871]],[\"parent/32\",[]],[\"name/33\",[26,32.426]],[\"parent/33\",[33,2.086]],[\"name/34\",[34,37.534]],[\"parent/34\",[33,2.086]],[\"name/35\",[35,37.534]],[\"parent/35\",[33,2.086]],[\"name/36\",[36,37.534]],[\"parent/36\",[33,2.086]],[\"name/37\",[24,32.426]],[\"parent/37\",[33,2.086]],[\"name/38\",[37,37.534]],[\"parent/38\",[]],[\"name/39\",[38,14.18]],[\"parent/39\",[]],[\"name/40\",[39,37.534]],[\"parent/40\",[38,1.294]],[\"name/41\",[15,26.548]],[\"parent/41\",[38,1.294]],[\"name/42\",[40,37.534]],[\"parent/42\",[38,1.294]],[\"name/43\",[41,37.534]],[\"parent/43\",[38,1.294]],[\"name/44\",[42,37.534]],[\"parent/44\",[38,1.294]],[\"name/45\",[43,37.534]],[\"parent/45\",[38,1.294]],[\"name/46\",[44,37.534]],[\"parent/46\",[38,1.294]],[\"name/47\",[45,37.534]],[\"parent/47\",[38,1.294]],[\"name/48\",[46,37.534]],[\"parent/48\",[38,1.294]],[\"name/49\",[47,37.534]],[\"parent/49\",[38,1.294]],[\"name/50\",[48,32.426]],[\"parent/50\",[38,1.294]],[\"name/51\",[49,37.534]],[\"parent/51\",[38,1.294]],[\"name/52\",[50,37.534]],[\"parent/52\",[38,1.294]],[\"name/53\",[51,37.534]],[\"parent/53\",[38,1.294]],[\"name/54\",[52,26.548]],[\"parent/54\",[]],[\"name/55\",[8,32.426]],[\"parent/55\",[52,2.422]],[\"name/56\",[25,29.061]],[\"parent/56\",[52,2.422]],[\"name/57\",[53,37.534]],[\"parent/57\",[52,2.422]],[\"name/58\",[54,24.541]],[\"parent/58\",[]],[\"name/59\",[15,26.548]],[\"parent/59\",[54,2.239]],[\"name/60\",[55,37.534]],[\"parent/60\",[54,2.239]],[\"name/61\",[48,32.426]],[\"parent/61\",[54,2.239]],[\"name/62\",[56,37.534]],[\"parent/62\",[54,2.239]]],\"invertedIndex\":[[\"__type\",{\"_index\":15,\"name\":{\"15\":{},\"25\":{},\"41\":{},\"59\":{}},\"parent\":{}}],[\"advancedoptions\",{\"_index\":14,\"name\":{\"14\":{}},\"parent\":{}}],[\"appstate\",{\"_index\":25,\"name\":{\"24\":{},\"56\":{}},\"parent\":{\"25\":{}}}],[\"appstate.__type\",{\"_index\":27,\"name\":{},\"parent\":{\"26\":{}}}],[\"audience\",{\"_index\":20,\"name\":{\"19\":{}},\"parent\":{}}],[\"auth0\",{\"_index\":31,\"name\":{\"30\":{}},\"parent\":{}}],[\"auth0context\",{\"_index\":37,\"name\":{\"38\":{}},\"parent\":{}}],[\"auth0contextinterface\",{\"_index\":38,\"name\":{\"39\":{}},\"parent\":{\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{}}}],[\"auth0provider\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{}}],[\"auth0provideroptions\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{},\"11\":{},\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{}}}],[\"auth0provideroptions.__type\",{\"_index\":17,\"name\":{},\"parent\":{\"16\":{}}}],[\"authorizetimeoutinseconds\",{\"_index\":13,\"name\":{\"13\":{}},\"parent\":{}}],[\"buildauthorizeurl\",{\"_index\":45,\"name\":{\"47\":{}},\"parent\":{}}],[\"buildlogouturl\",{\"_index\":46,\"name\":{\"48\":{}},\"parent\":{}}],[\"cache\",{\"_index\":11,\"name\":{\"11\":{}},\"parent\":{}}],[\"cachelocation\",{\"_index\":10,\"name\":{\"10\":{}},\"parent\":{}}],[\"children\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"claimcheck\",{\"_index\":36,\"name\":{\"36\":{}},\"parent\":{}}],[\"clientid\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"connection\",{\"_index\":23,\"name\":{\"22\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":55,\"name\":{\"60\":{}},\"parent\":{}}],[\"context\",{\"_index\":24,\"name\":{\"23\":{},\"37\":{}},\"parent\":{}}],[\"defaultscope\",{\"_index\":16,\"name\":{\"16\":{}},\"parent\":{}}],[\"domain\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"error\",{\"_index\":48,\"name\":{\"50\":{},\"61\":{}},\"parent\":{}}],[\"error_description\",{\"_index\":56,\"name\":{\"62\":{}},\"parent\":{}}],[\"fragment\",{\"_index\":53,\"name\":{\"57\":{}},\"parent\":{}}],[\"getaccesstokensilently\",{\"_index\":39,\"name\":{\"40\":{}},\"parent\":{}}],[\"getaccesstokenwithpopup\",{\"_index\":40,\"name\":{\"42\":{}},\"parent\":{}}],[\"getidtokenclaims\",{\"_index\":41,\"name\":{\"43\":{}},\"parent\":{}}],[\"handleredirectcallback\",{\"_index\":47,\"name\":{\"49\":{}},\"parent\":{}}],[\"invitation\",{\"_index\":22,\"name\":{\"21\":{}},\"parent\":{}}],[\"isauthenticated\",{\"_index\":49,\"name\":{\"51\":{}},\"parent\":{}}],[\"isloading\",{\"_index\":50,\"name\":{\"52\":{}},\"parent\":{}}],[\"issuer\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"leeway\",{\"_index\":9,\"name\":{\"9\":{}},\"parent\":{}}],[\"loginoptions\",{\"_index\":35,\"name\":{\"35\":{}},\"parent\":{}}],[\"loginwithpopup\",{\"_index\":43,\"name\":{\"45\":{}},\"parent\":{}}],[\"loginwithredirect\",{\"_index\":42,\"name\":{\"44\":{}},\"parent\":{}}],[\"logout\",{\"_index\":44,\"name\":{\"46\":{}},\"parent\":{}}],[\"maxage\",{\"_index\":18,\"name\":{\"17\":{}},\"parent\":{}}],[\"oautherror\",{\"_index\":54,\"name\":{\"58\":{}},\"parent\":{\"59\":{},\"60\":{},\"61\":{},\"62\":{}}}],[\"onredirectcallback\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"onredirecting\",{\"_index\":34,\"name\":{\"34\":{}},\"parent\":{}}],[\"organization\",{\"_index\":21,\"name\":{\"20\":{}},\"parent\":{}}],[\"redirectloginoptions\",{\"_index\":52,\"name\":{\"54\":{}},\"parent\":{\"55\":{},\"56\":{},\"57\":{}}}],[\"redirecturi\",{\"_index\":8,\"name\":{\"8\":{},\"55\":{}},\"parent\":{}}],[\"returnto\",{\"_index\":26,\"name\":{\"26\":{},\"33\":{}},\"parent\":{}}],[\"scope\",{\"_index\":19,\"name\":{\"18\":{}},\"parent\":{}}],[\"skipredirectcallback\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}],[\"useauth0\",{\"_index\":28,\"name\":{\"27\":{}},\"parent\":{}}],[\"user\",{\"_index\":51,\"name\":{\"53\":{}},\"parent\":{}}],[\"userefreshtokens\",{\"_index\":12,\"name\":{\"12\":{}},\"parent\":{}}],[\"withauth0\",{\"_index\":29,\"name\":{\"28\":{}},\"parent\":{}}],[\"withauth0props\",{\"_index\":30,\"name\":{\"29\":{}},\"parent\":{\"30\":{}}}],[\"withauthenticationrequired\",{\"_index\":32,\"name\":{\"31\":{}},\"parent\":{}}],[\"withauthenticationrequiredoptions\",{\"_index\":33,\"name\":{\"32\":{}},\"parent\":{\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{}}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"Auth0Provider\",\"url\":\"functions/Auth0Provider.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"Auth0ProviderOptions\",\"url\":\"interfaces/Auth0ProviderOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"children\",\"url\":\"interfaces/Auth0ProviderOptions.html#children\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"onRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ProviderOptions.html#onRedirectCallback.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ProviderOptions.onRedirectCallback\"},{\"kind\":1024,\"name\":\"skipRedirectCallback\",\"url\":\"interfaces/Auth0ProviderOptions.html#skipRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/Auth0ProviderOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ProviderOptions\"},{\"kind\":4194304,\"name\":\"AppState\",\"url\":\"types/AppState.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AppState.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AppState\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"types/AppState.html#__type.returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppState.__type\"},{\"kind\":64,\"name\":\"useAuth0\",\"url\":\"functions/useAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"withAuth0\",\"url\":\"functions/withAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuth0Props\",\"url\":\"interfaces/WithAuth0Props.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"auth0\",\"url\":\"interfaces/WithAuth0Props.html#auth0\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuth0Props\"},{\"kind\":64,\"name\":\"withAuthenticationRequired\",\"url\":\"functions/withAuthenticationRequired.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"WithAuthenticationRequiredOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"onRedirecting\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#onRedirecting.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"WithAuthenticationRequiredOptions.onRedirecting\"},{\"kind\":1024,\"name\":\"loginOptions\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#loginOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":1024,\"name\":\"context\",\"url\":\"interfaces/WithAuthenticationRequiredOptions.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"WithAuthenticationRequiredOptions\"},{\"kind\":32,\"name\":\"Auth0Context\",\"url\":\"variables/Auth0Context.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"Auth0ContextInterface\",\"url\":\"interfaces/Auth0ContextInterface.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"getAccessTokenSilently\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenSilently.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenSilently\"},{\"kind\":1024,\"name\":\"getAccessTokenWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getAccessTokenWithPopup.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getAccessTokenWithPopup\"},{\"kind\":1024,\"name\":\"getIdTokenClaims\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#getIdTokenClaims.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.getIdTokenClaims\"},{\"kind\":1024,\"name\":\"loginWithRedirect\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithRedirect.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithRedirect\"},{\"kind\":1024,\"name\":\"loginWithPopup\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#loginWithPopup.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.loginWithPopup\"},{\"kind\":1024,\"name\":\"logout\",\"url\":\"interfaces/Auth0ContextInterface.html#logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#logout.__type-14\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.logout\"},{\"kind\":1024,\"name\":\"handleRedirectCallback\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0ContextInterface.html#handleRedirectCallback.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Auth0ContextInterface.handleRedirectCallback\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/Auth0ContextInterface.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/Auth0ContextInterface.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"isLoading\",\"url\":\"interfaces/Auth0ContextInterface.html#isLoading\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/Auth0ContextInterface.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"Auth0ContextInterface\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":128,\"name\":\"OAuthError\",\"url\":\"classes/OAuthError.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/OAuthError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/OAuthError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"},{\"kind\":1024,\"name\":\"error_description\",\"url\":\"classes/OAuthError.html#error_description\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"OAuthError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.657]],[\"comment/0\",[]],[\"name/1\",[1,34.657]],[\"comment/1\",[]],[\"name/2\",[2,34.657]],[\"comment/2\",[]],[\"name/3\",[3,34.657]],[\"comment/3\",[]],[\"name/4\",[4,15.198]],[\"comment/4\",[]],[\"name/5\",[5,34.657]],[\"comment/5\",[]],[\"name/6\",[6,29.549]],[\"comment/6\",[]],[\"name/7\",[7,34.657]],[\"comment/7\",[]],[\"name/8\",[4,15.198]],[\"comment/8\",[]],[\"name/9\",[8,29.549]],[\"comment/9\",[]],[\"name/10\",[9,34.657]],[\"comment/10\",[]],[\"name/11\",[10,34.657]],[\"comment/11\",[]],[\"name/12\",[11,34.657]],[\"comment/12\",[]],[\"name/13\",[12,34.657]],[\"comment/13\",[]],[\"name/14\",[13,34.657]],[\"comment/14\",[]],[\"name/15\",[14,34.657]],[\"comment/15\",[]],[\"name/16\",[8,29.549]],[\"comment/16\",[]],[\"name/17\",[15,34.657]],[\"comment/17\",[]],[\"name/18\",[4,15.198]],[\"comment/18\",[]],[\"name/19\",[16,34.657]],[\"comment/19\",[]],[\"name/20\",[6,29.549]],[\"comment/20\",[]],[\"name/21\",[17,34.657]],[\"comment/21\",[]],[\"name/22\",[18,34.657]],[\"comment/22\",[]],[\"name/23\",[19,34.657]],[\"comment/23\",[]],[\"name/24\",[4,15.198]],[\"comment/24\",[]],[\"name/25\",[20,34.657]],[\"comment/25\",[]],[\"name/26\",[4,15.198]],[\"comment/26\",[]],[\"name/27\",[21,34.657]],[\"comment/27\",[]],[\"name/28\",[4,15.198]],[\"comment/28\",[]],[\"name/29\",[22,34.657]],[\"comment/29\",[]],[\"name/30\",[4,15.198]],[\"comment/30\",[]],[\"name/31\",[23,34.657]],[\"comment/31\",[]],[\"name/32\",[4,15.198]],[\"comment/32\",[]],[\"name/33\",[24,34.657]],[\"comment/33\",[]],[\"name/34\",[4,15.198]],[\"comment/34\",[]],[\"name/35\",[25,34.657]],[\"comment/35\",[]],[\"name/36\",[4,15.198]],[\"comment/36\",[]],[\"name/37\",[26,29.549]],[\"comment/37\",[]],[\"name/38\",[27,34.657]],[\"comment/38\",[]],[\"name/39\",[28,34.657]],[\"comment/39\",[]],[\"name/40\",[29,34.657]],[\"comment/40\",[]],[\"name/41\",[30,34.657]],[\"comment/41\",[]],[\"name/42\",[31,34.657]],[\"comment/42\",[]],[\"name/43\",[32,34.657]],[\"comment/43\",[]],[\"name/44\",[33,34.657]],[\"comment/44\",[]],[\"name/45\",[26,29.549]],[\"comment/45\",[]],[\"name/46\",[34,34.657]],[\"comment/46\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"8\":{},\"18\":{},\"24\":{},\"26\":{},\"28\":{},\"30\":{},\"32\":{},\"34\":{},\"36\":{}},\"comment\":{}}],[\"appstate\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"auth0\",{\"_index\":12,\"name\":{\"13\":{}},\"comment\":{}}],[\"auth0context\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"auth0contextinterface\",{\"_index\":18,\"name\":{\"22\":{}},\"comment\":{}}],[\"auth0provider\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"auth0provideroptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"children\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":33,\"name\":{\"44\":{}},\"comment\":{}}],[\"context\",{\"_index\":6,\"name\":{\"6\":{},\"20\":{}},\"comment\":{}}],[\"error\",{\"_index\":26,\"name\":{\"37\":{},\"45\":{}},\"comment\":{}}],[\"error_description\",{\"_index\":34,\"name\":{\"46\":{}},\"comment\":{}}],[\"getaccesstokensilently\",{\"_index\":19,\"name\":{\"23\":{}},\"comment\":{}}],[\"getaccesstokenwithpopup\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}],[\"getidtokenclaims\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"handleredirectcallback\",{\"_index\":25,\"name\":{\"35\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":27,\"name\":{\"38\":{}},\"comment\":{}}],[\"isloading\",{\"_index\":28,\"name\":{\"39\":{}},\"comment\":{}}],[\"loginoptions\",{\"_index\":16,\"name\":{\"19\":{}},\"comment\":{}}],[\"loginwithpopup\",{\"_index\":23,\"name\":{\"31\":{}},\"comment\":{}}],[\"loginwithredirect\",{\"_index\":22,\"name\":{\"29\":{}},\"comment\":{}}],[\"logout\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":30,\"name\":{\"41\":{}},\"comment\":{}}],[\"oautherror\",{\"_index\":32,\"name\":{\"43\":{}},\"comment\":{}}],[\"onredirectcallback\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"onredirecting\",{\"_index\":15,\"name\":{\"17\":{}},\"comment\":{}}],[\"redirectloginoptions\",{\"_index\":31,\"name\":{\"42\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":8,\"name\":{\"9\":{},\"16\":{}},\"comment\":{}}],[\"skipredirectcallback\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"useauth0\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"user\",{\"_index\":29,\"name\":{\"40\":{}},\"comment\":{}}],[\"withauth0\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"withauth0props\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"withauthenticationrequired\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"withauthenticationrequiredoptions\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index a16ed029..2d02570d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,155 +1,150 @@ -@import url("./icons.css"); - :root { /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; --light-color-text: #222; --light-color-text-aside: #707070; --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; + --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-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); + --light-color-ts-variable: #4d68ff; --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; + --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-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); + --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-secondary-background: var(--light-color-secondary-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); --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-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); + --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-secondary-background: var(--dark-color-secondary-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); --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-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); + --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; } -body.light { +:root[data-theme="light"] { --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); --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-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); + --color-ts-variable: var(--light-color-ts-variable); --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); } -body.dark { +:root[data-theme="dark"] { --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); --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-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); + --color-ts-variable: var(--dark-color-ts-variable); --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; } h1, @@ -162,34 +157,37 @@ h6 { } h1 { - font-size: 2em; - margin: 0.67em 0; + font-size: 1.875rem; + margin: 0.67rem 0; } h2 { - font-size: 1.5em; - margin: 0.83em 0; + font-size: 1.5rem; + margin: 0.83rem 0; } h3 { - font-size: 1.17em; - margin: 1em 0; + font-size: 1.25rem; + margin: 1rem 0; } -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; } h5 { - font-size: 0.83em; - margin: 1.67em 0; + font-size: 1rem; + margin: 1.5rem 0; } h6 { - font-size: 0.67em; - margin: 2.33em 0; + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; } pre { @@ -210,74 +208,61 @@ dd { } .container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } } -@media (max-width: 640px) { +@media (min-width: 1200px) { .container { - padding: 0 20px; + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; } } -.container-main { - padding-bottom: 200px; +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; } -.row { +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { display: flex; + justify-content: space-between; position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; + margin: 0 auto; } .col-4, .col-8 { box-sizing: border-box; float: left; - padding: 0 10px; + padding: 2rem 1rem; } .col-4 { - width: 33.3333333333%; + flex: 0 0 25%; } .col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; } @keyframes fade-in { @@ -379,11 +364,13 @@ pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; padding: 0.2em; margin: 0; - font-size: 14px; + font-size: 0.875rem; + border-radius: 0.8em; } pre { padding: 10px; + border: 0.1em solid var(--color-accent); } pre code { padding: 0; @@ -422,36 +409,26 @@ blockquote { margin: 1em 0; } -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { +@media (max-width: 1024px) { html .col-content { float: none; + max-width: 100%; width: 100%; + padding-top: 3rem; } html .col-menu { position: fixed !important; - overflow: auto; + overflow-y: 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; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; visibility: hidden; - background-color: var(--color-panel); + background-color: var(--color-background); transform: translate(100%, 0); } html .col-menu > *:last-child { @@ -507,24 +484,17 @@ blockquote { 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-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - .tsd-breadcrumb { margin: 0; padding: 0; @@ -544,32 +514,44 @@ blockquote { content: " / "; } -dl.tsd-comment-tags { +.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-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; font-weight: normal; } -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; +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%; } -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; +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-tags dd pre, -dl.tsd-comment-tags dd:after { +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { clear: both; } -dl.tsd-comment-tags p { +dl.tsd-comment-tag-group p { margin: 0; } @@ -582,153 +564,109 @@ dl.tsd-comment-tags p { margin-bottom: 0; } -.toggle-protected .tsd-is-private { - display: none; +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; } - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; } - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; +.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 { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; } -.no-filter #tsd-filter { - display: none; +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; } -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; +.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 { - display: none; +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); } -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); } - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); +.tsd-checkbox-background { + fill: var(--color-accent); } -footer:after { - content: ""; - display: table; +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); } -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; } -footer .tsd-legend-group { - font-size: 0; +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); } -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; + +.tsd-theme-toggle { + padding-top: 0.75rem; } -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; } .tsd-hierarchy { list-style: square; - padding: 0 0 0 20px; margin: 0; } .tsd-hierarchy .target { font-weight: bold; } -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { list-style: none; line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; + 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 (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); } } -.tsd-index-panel ul.tsd-index-list li { +.tsd-index-panel .tsd-index-list li { -webkit-page-break-inside: avoid; -moz-page-break-inside: avoid; -ms-page-break-inside: avoid; @@ -736,42 +674,52 @@ footer .tsd-legend { page-break-inside: avoid; } .tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { +.tsd-index-panel a.tsd-parent-kind-module { color: var(--color-ts); } -.tsd-index-panel .tsd-parent-kind-interface a { +.tsd-index-panel a.tsd-parent-kind-interface { color: var(--color-ts-interface); } -.tsd-index-panel .tsd-parent-kind-enum a { +.tsd-index-panel a.tsd-parent-kind-enum { color: var(--color-ts-enum); } -.tsd-index-panel .tsd-parent-kind-class a { +.tsd-index-panel a.tsd-parent-kind-class { color: var(--color-ts-class); } -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); } -.tsd-index-panel .tsd-kind-interface a { +.tsd-index-panel a.tsd-kind-interface { color: var(--color-ts-interface); } -.tsd-index-panel .tsd-kind-enum a { +.tsd-index-panel a.tsd-kind-enum { color: var(--color-ts-enum); } -.tsd-index-panel .tsd-kind-class a { +.tsd-index-panel a.tsd-kind-class { color: var(--color-ts-class); } -.tsd-index-panel .tsd-is-private a { +.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: 1px 5px; + 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: 14px; + font-size: 75%; + line-height: 1; font-weight: normal; } @@ -784,6 +732,8 @@ footer .tsd-legend { position: relative; } .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; margin-top: 0; margin-bottom: 0; border-bottom: none; @@ -804,13 +754,9 @@ footer .tsd-legend { color: var(--color-ts-private); } -.tsd-navigation { - margin: 0 0 0 40px; -} .tsd-navigation a { display: block; - padding-top: 2px; - padding-bottom: 2px; + margin: 0.4rem 0; border-left: 2px solid transparent; color: var(--color-text); text-decoration: none; @@ -828,110 +774,176 @@ footer .tsd-legend { padding: 0; } -.tsd-navigation.primary { - padding-bottom: 40px; +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; } .tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; + padding: 0.75rem 0.5rem; + margin: 0; } .tsd-navigation.primary ul li a { - padding-left: 5px; + margin-left: 0.5rem; } .tsd-navigation.primary ul li li a { - padding-left: 25px; + margin-left: 1.5rem; } .tsd-navigation.primary ul li li li a { - padding-left: 45px; + margin-left: 2.5rem; } .tsd-navigation.primary ul li li li li a { - padding-left: 65px; + margin-left: 3.5rem; } .tsd-navigation.primary ul li li li li li a { - padding-left: 85px; + margin-left: 4.5rem; } .tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); + 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 li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); +.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 { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} .tsd-navigation.secondary.tsd-navigation--toolbar-hide { max-height: calc(100vh - 1rem); top: 0.5rem; } -.tsd-navigation.secondary ul { +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; transition: opacity 0.2s; } .tsd-navigation.secondary ul li a { - padding-left: 25px; + padding-left: 0; } .tsd-navigation.secondary ul li li a { - padding-left: 45px; + padding-left: 1.1rem; } .tsd-navigation.secondary ul li li li a { - padding-left: 65px; + padding-left: 2.2rem; } .tsd-navigation.secondary ul li li li li a { - padding-left: 85px; + padding-left: 3.3rem; } .tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; + padding-left: 4.4rem; } .tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; + 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; } -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); + +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-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); +.tsd-accordion-summary { + display: block; + cursor: pointer; } -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; } -.tsd-navigation.secondary li.current > a { - font-weight: bold; +.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; + } -@media (min-width: 901px) { .menu-sticky-wrap { - position: static; + 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: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; } .tsd-panel:empty { display: none; @@ -939,48 +951,24 @@ footer .tsd-legend { .tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); + 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: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); + border-bottom: none; } .tsd-panel-group { - margin: 60px 0; + margin: 4rem 0; } -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; } #tsd-search { @@ -994,8 +982,8 @@ footer .tsd-legend { position: absolute; left: 0; top: 0; - right: 40px; - height: 40px; + right: 2.5rem; + height: 100%; } #tsd-search .field input { box-sizing: border-box; @@ -1016,7 +1004,8 @@ footer .tsd-legend { right: -40px; } #tsd-search .field input, -#tsd-search .title { +#tsd-search .title, +#tsd-toolbar-links a { transition: opacity 0.2s; } #tsd-search .results { @@ -1034,14 +1023,14 @@ footer .tsd-legend { background-color: var(--color-background); } #tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); + 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-panel-divider); + background-color: var(--color-accent); } #tsd-search .results a { display: block; @@ -1054,13 +1043,14 @@ footer .tsd-legend { font-weight: normal; } #tsd-search.has-focus { - background-color: var(--color-panel-divider); + background-color: var(--color-accent); } #tsd-search.has-focus .field input { top: 0; opacity: 1; } -#tsd-search.has-focus .title { +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { z-index: 0; opacity: 0; } @@ -1074,32 +1064,30 @@ footer .tsd-legend { 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 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); + 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.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} .tsd-signature-symbol { color: var(--color-text-aside); @@ -1114,104 +1102,42 @@ footer .tsd-legend { .tsd-signatures { padding: 0; margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); + list-style-type: none; } .tsd-signatures .tsd-signature { margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; + border-color: var(--color-accent); border-width: 1px 0; + transition: background-color 0.1s; } -.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; +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; } -ul.tsd-parameters, -ul.tsd-type-parameters { +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { list-style: square; margin: 0; padding-left: 20px; } -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { +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-parameters h5, -ul.tsd-type-parameters h5 { +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { font-size: 16px; margin: 1em 0 0.5em 0; } -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - .tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; + margin-top: 1rem; + font-size: 0.875em; } .tsd-sources a { color: var(--color-text-aside); text-decoration: underline; } -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} .tsd-sources ul { list-style: none; padding: 0; @@ -1223,14 +1149,13 @@ ul.tsd-type-parameters .tsd-comment { top: 0; left: 0; width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; + 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-toolbar-text); + color: var(--color-text); text-decoration: none; } .tsd-page-toolbar a.title { @@ -1239,13 +1164,13 @@ ul.tsd-type-parameters .tsd-comment { .tsd-page-toolbar a.title:hover { text-decoration: underline; } -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { - display: table-cell; position: relative; white-space: nowrap; line-height: 40px; @@ -1253,34 +1178,16 @@ ul.tsd-type-parameters .tsd-comment { .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-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(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@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(./widgets@2x.png); - background-size: 320px 40px; - } -} - .tsd-widget { display: inline-block; overflow: hidden; @@ -1295,7 +1202,7 @@ ul.tsd-type-parameters .tsd-comment { } .tsd-widget.active { opacity: 1; - background-color: var(--color-panel-divider); + background-color: var(--color-accent); } .tsd-widget.no-caption { width: 40px; @@ -1303,20 +1210,12 @@ ul.tsd-type-parameters .tsd-comment { .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) { +@media (max-width: 1024px) { .tsd-widget.options, .tsd-widget.menu { display: inline-block; @@ -1329,75 +1228,14 @@ input[type="checkbox"]:checked + .tsd-widget:before { background-position: -160px 0; } -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - img { max-width: 100%; } .tsd-anchor-icon { - margin-left: 10px; + display: inline-flex; + align-items: center; + margin-left: 0.5rem; vertical-align: middle; color: var(--color-text); } @@ -1411,3 +1249,32 @@ img { .tsd-anchor-link:hover > .tsd-anchor-icon svg { visibility: visible; } + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/docs/assets/widgets.png b/docs/assets/widgets.png deleted file mode 100644 index c7380532..00000000 Binary files a/docs/assets/widgets.png and /dev/null differ diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png deleted file mode 100644 index 4bbbd572..00000000 Binary files a/docs/assets/widgets@2x.png and /dev/null differ diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index a90a7caf..6849c5d4 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1 +1,78 @@ -InMemoryCache | @auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InMemoryCache

Hierarchy

  • InMemoryCache

Index

Constructors

Properties

Constructors

constructor

Properties

enclosedCache

enclosedCache: ICache

Legend

  • Property
  • Method
  • Constructor
  • Property

Settings

Theme

\ No newline at end of file +InMemoryCache | @auth0/auth0-react
+
+ +
+
+
+
+ +

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 0f495a1b..757abedc 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1 +1,146 @@ -LocalStorageCache | @auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalStorageCache

Hierarchy

  • LocalStorageCache

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

allKeys

  • allKeys(): string[]

  • Returns string[]

get

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

  • Type parameters

    Parameters

    • key: string

    Returns T

remove

  • remove(key: string): void

  • Parameters

    • key: string

    Returns void

set

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

  • Type parameters

    Parameters

    • key: string
    • entry: T

    Returns void

Legend

  • Property
  • Method
  • Constructor
  • Property

Settings

Theme

\ No newline at end of file +LocalStorageCache | @auth0/auth0-react
+
+ +
+
+
+
+ +

Class LocalStorageCache

+
+

Hierarchy

+
    +
  • LocalStorageCache
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
allKeys +get +remove +set +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

allKeys

+
    + +
  • +

    Returns string[]

+
+

get

+
    + +
  • +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns MaybePromise<undefined | T>

+
+

remove

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns void

+
+

set

+
    + +
  • +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      • +
    • +
      entry: T
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 61d63c1f..50392885 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -1,10 +1,186 @@ -OAuthError | @auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OAuthError

-

An OAuth2 error will come from the authorization server and will have at least an error property which will +OAuthError | @auth0/auth0-react

+
+ +
+
+
+
+ +

Class OAuthError

+
+

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

-

Hierarchy

  • Error
    • OAuthError

Index

Constructors

Properties

Methods

Constructors

constructor

  • new OAuthError(error: string, error_description?: string): OAuthError

Properties

error

error: string

Optional error_description

error_description?: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • -

    Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Legend

  • Property
  • Method
  • Constructor
  • Property

Settings

Theme

\ No newline at end of file +

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

+ +
+

Hierarchy

+
    +
  • Error +
      +
    • OAuthError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +error_description? +message +name +stack? +prepareStackTrace? +stackTraceLimit +
+
+

Methods

+
captureStackTrace +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

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

    Returns OAuthError

+
+

Properties

+
+

error

+
error: string
+
+

Optional error_description

+
error_description?: string
+
+

message

+
message: string
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Static Optional prepareStackTrace

+
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
+
+

Type declaration

+
+
+

Static stackTraceLimit

+
stackTraceLimit: number
+
+

Methods

+
+

Static captureStackTrace

+
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
      • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/classes/User.html b/docs/classes/User.html index 44bebbc6..efe0e659 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1 +1,214 @@ -User | @auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Hierarchy

  • User

Indexable

[key: string]: any

Index

Constructors

Properties

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

Legend

  • Property
  • Method
  • Constructor
  • Property

Settings

Theme

\ No newline at end of file +User | @auth0/auth0-react
+
+ +
+
+
+
+ +

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/Auth0Provider.html b/docs/functions/Auth0Provider.html new file mode 100644 index 00000000..a2311782 --- /dev/null +++ b/docs/functions/Auth0Provider.html @@ -0,0 +1,82 @@ +Auth0Provider | @auth0/auth0-react
+
+ +
+
+
+
+ +

Function Auth0Provider

+
+
    + +
  • +
    <Auth0Provider
      domain={domain}
      clientId={clientId}
      redirectUri={window.location.origin}>
      <MyApp />
    </Auth0Provider>
+
    +

    Provides the Auth0Context to its child components.

    +
    +
    +

    Parameters

    +
    +

    Returns Element

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html new file mode 100644 index 00000000..894eba68 --- /dev/null +++ b/docs/functions/useAuth0.html @@ -0,0 +1,88 @@ +useAuth0 | @auth0/auth0-react
+
+ +
+
+
+
+ +

Function useAuth0

+
+
    + +
  • +
    const {
      // Auth state:
      error,
      isAuthenticated,
      isLoading,
      user,
      // Auth methods:
      getAccessTokenSilently,
      getAccessTokenWithPopup,
      getIdTokenClaims,
      loginWithRedirect,
      loginWithPopup,
      logout,
    } = useAuth0<TUser>();
+
    +

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

    +

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

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
    +

    Returns Auth0ContextInterface<TUser>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html new file mode 100644 index 00000000..a3cbec03 --- /dev/null +++ b/docs/functions/withAuth0.html @@ -0,0 +1,91 @@ +withAuth0 | @auth0/auth0-react
+
+ +
+
+
+
+ +

Function withAuth0

+
+
    + +
  • +
    class MyComponent extends Component {
      render() {
        // Access the auth context from the `auth0` prop
        const { user } = this.props.auth0;
        return <div>Hello {user.name}!</div>
      }
    }
    // Wrap your class component in withAuth0
    export default withAuth0(MyComponent);
+
    +

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

    +

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

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
    +

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

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html new file mode 100644 index 00000000..e6239f6d --- /dev/null +++ b/docs/functions/withAuthenticationRequired.html @@ -0,0 +1,90 @@ +withAuthenticationRequired | @auth0/auth0-react
+
+ +
+
+
+
+ +

Function withAuthenticationRequired

+
+
    + +
  • +
    const MyProtectedComponent = withAuthenticationRequired(MyComponent);
+
    +

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

    +
    +
    +

    Type Parameters

    +
      +
    • +

      P extends object

    +
    +

    Parameters

    +
    +

    Returns FC<P>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index d41905c4..ab4c1377 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,18 @@ -@auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

@auth0/auth0-react

Auth0 SDK for React Single Page Applications

+@auth0/auth0-react
+
+ +
+
+
+
+

@auth0/auth0-react

+

Auth0 SDK for React Single Page Applications

npm codecov Downloads @@ -25,10 +39,10 @@

Getting started

Installation

Using npm

-
npm install @auth0/auth0-react
+
npm install @auth0/auth0-react
 

 
Using yarn

-
yarn add @auth0/auth0-react
+
yarn add @auth0/auth0-react
 

 
 
@@ -60,10 +74,10 @@ 
Configure Auth0

   
Configure the SDK

 
 
Configure the SDK by wrapping your application in Auth0Provider:

-
// src/index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { Auth0Provider } from '@auth0/auth0-react';
import App from './App';

ReactDOM.render(
  <Auth0Provider
    domain="YOUR_AUTH0_DOMAIN"
    clientId="YOUR_AUTH0_CLIENT_ID"
    redirectUri={window.location.origin}
  >
    <App />
  </Auth0Provider>,
  document.getElementById('app')
);
+
// src/index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { Auth0Provider } from '@auth0/auth0-react';
import App from './App';

ReactDOM.render(
  <Auth0Provider
    domain="YOUR_AUTH0_DOMAIN"
    clientId="YOUR_AUTH0_CLIENT_ID"
    authorizationParams={{
      redirect_uri: window.location.origin,
    }}
  >
    <App />
  </Auth0Provider>,
  document.getElementById('app')
);
 

 
Use the useAuth0 hook in your components to access authentication state (isLoading, isAuthenticated and user) and authentication methods (loginWithRedirect and logout):

-
// src/App.js
import React from 'react';
import { useAuth0 } from '@auth0/auth0-react';

function App() {
  const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
    useAuth0();

  if (isLoading) {
    return <div>Loading...</div>;
  }
  if (error) {
    return <div>Oops... {error.message}</div>;
  }

  if (isAuthenticated) {
    return (
      <div>
        Hello {user.name}{' '}
        <button onClick={() => logout({ returnTo: window.location.origin })}>
          Log out
        </button>
      </div>
    );
  } else {
    return <button onClick={loginWithRedirect}>Log in</button>;
  }
}

export default App;
+
// src/App.js
import React from 'react';
import { useAuth0 } from '@auth0/auth0-react';

function App() {
  const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
    useAuth0();

  if (isLoading) {
    return <div>Loading...</div>;
  }
  if (error) {
    return <div>Oops... {error.message}</div>;
  }

  if (isAuthenticated) {
    return (
      <div>
        Hello {user.name}{' '}
        <button onClick={() => logout({ returnTo: window.location.origin })}>
          Log out
        </button>
      </div>
    );
  } else {
    return <button onClick={loginWithRedirect}>Log in</button>;
  }
}

export default App;
 

 
For more code samples on how to integrate auth0-react SDK in your React application, have a look at our examples.

 
@@ -112,5 +126,53 @@ 
Vulnerability Reporting

 

 
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.

-

Legend

  • Property
  • Method
  • Constructor
  • Property

Settings

Theme

\ No newline at end of file +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/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 20086bcc..6e42ab17 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,9 +1,76 @@ -Auth0ContextInterface | @auth0/auth0-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Auth0ContextInterface<TUser>

-

Contains the authenticated state and authentication methods provided by the useAuth0 hook.

-

Type parameters

Hierarchy

  • AuthState<TUser>
    • Auth0ContextInterface

Index

Properties

Methods

Properties

Optional error

error?: Error

getAccessTokenSilently

getAccessTokenSilently: { (options: GetTokenSilentlyOptions & { detailedResponse: true }): Promise<GetTokenSilentlyVerboseResponse>; (options?: GetTokenSilentlyOptions): Promise<string>; (options: GetTokenSilentlyOptions): Promise<string | GetTokenSilentlyVerboseResponse> }

Type declaration

    • -
      const token = await getAccessTokenSilently(options);
+Auth0ContextInterface | @auth0/auth0-react
      
+
      
+
+
      
+
      
+
      
+
      
+
+
      Interface Auth0ContextInterface<TUser>
      
+
      
+
      Contains the authenticated state and authentication methods provided by the useAuth0 hook.
      
+
       
+
      
+
      Type Parameters
      
+
       
+
      
+
      Hierarchy
      
+
        
+
      • AuthState<TUser>
+
          
+
        • Auth0ContextInterface
      
+
      
+
      
+
      
+
+
      
+
      
+
      Properties
      
+
      error?
+getAccessTokenSilently
+getAccessTokenWithPopup
+getIdTokenClaims
+handleRedirectCallback
+isAuthenticated
+isLoading
+loginWithPopup
+loginWithRedirect
+logout
+user?
+
      
+
      
+
      Properties
      
+
      
+
      Optional error
      
+
      error?: Error
      
+
      
+
      getAccessTokenSilently
      
+
      getAccessTokenSilently: { 
          (options: GetTokenSilentlyOptions & { 
              detailedResponse: true; 
          }): Promise<GetTokenSilentlyVerboseResponse>; 
          (options?: GetTokenSilentlyOptions): Promise<string>; 
          (options: GetTokenSilentlyOptions): Promise<string | GetTokenSilentlyVerboseResponse>; 
      }
      
+
      
+
      Type declaration
      
+
        
+
      • 
+
          
+
        • (options: GetTokenSilentlyOptions & { 
              detailedResponse: true; 
          }): Promise<GetTokenSilentlyVerboseResponse>
          • 
+
        • 
+
          const token = await getAccessTokenSilently(options);
 
          
-
          If there's a valid token stored, return it. Otherwise, opens an
+
          If there's a valid token stored, return it. Otherwise, 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
@@ -17,10 +84,18 @@
 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>
    • -
      const token = await getAccessTokenSilently(options);
+
      +
      +

      Parameters

      +
      +

      Returns Promise<GetTokenSilentlyVerboseResponse>

      • +
    • (options?: GetTokenSilentlyOptions): Promise<string>
      • +
    • +
      const token = await getAccessTokenSilently(options);
      -

      If there's a valid token stored, return it. Otherwise, opens an +

      If there's a valid token stored, return it. Otherwise, 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 @@ -34,10 +109,18 @@ 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>

  • -
    const token = await getAccessTokenSilently(options);
+
    +
    +

    Parameters

    +
    +

    Returns Promise<string>

    • +
  • (options: GetTokenSilentlyOptions): Promise<string | GetTokenSilentlyVerboseResponse>
    • +
  • +
    const token = await getAccessTokenSilently(options);
    -

    If there's a valid token stored, return it. Otherwise, opens an +

    If there's a valid token stored, return it. Otherwise, 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 @@ -51,60 +134,215 @@ 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 | GetTokenSilentlyVerboseResponse>

    isAuthenticated

    isAuthenticated: boolean

    isLoading

    isLoading: boolean

    Optional user

    user?: TUser

    Methods

    buildAuthorizeUrl

    • buildAuthorizeUrl(options?: RedirectLoginOptions<any>): Promise<string>
    +
    +

    getAccessTokenWithPopup

    +
    getAccessTokenWithPopup: ((options?: GetTokenWithPopupOptions, config?: PopupConfigOptions) => Promise<undefined | string>)
    +
    +

    Type declaration

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

        Builds an /authorize URL for loginWithRedirect using the parameters -provided as arguments. Random and secure state and nonce -parameters will be auto-generated.

        -

    Parameters

    • Optional options: RedirectLoginOptions<any>

    Returns Promise<string>

    buildLogoutUrl

    • -
      const logoutUrl = buildLogoutUrl();
-
      -

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

      -

      Parameters

      Returns string

    getAccessTokenWithPopup

    • -
      const token = await getTokenWithPopup(options, config);
-
      -

      Get an access token interactively.

      +

      Get an access token interactively.

      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>

    getIdTokenClaims

    +
    +

    getIdTokenClaims

    +
    getIdTokenClaims: (() => Promise<undefined | IdToken>)
    +
    +

    Type declaration

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

        Returns all claims from the id_token if available.

        -

    Parameters

    Returns Promise<undefined | IdToken>

    handleRedirectCallback

    • handleRedirectCallback(url?: string): Promise<RedirectLoginResult<any>>
    • -

      After the browser redirects back to the callback page, +

      Returns all claims from the id_token if available.

      +
      +

      Returns Promise<undefined | IdToken>

    +
    +

    handleRedirectCallback

    +
    handleRedirectCallback: ((url?: string) => Promise<RedirectLoginResult<any>>)
    +
    +

    Type declaration

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

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

        -

    Parameters

    • Optional url: string
      -

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

      -

    Returns Promise<RedirectLoginResult<any>>

    loginWithPopup

    • -
      await loginWithPopup(options, config);
+
      +
      +

      Parameters

      +
        +
      • +
        Optional url: string
        +

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

        +
      +

      Returns Promise<RedirectLoginResult<any>>

    +
    +

    isAuthenticated

    +
    isAuthenticated: boolean
    +
    +

    isLoading

    +
    isLoading: boolean
    +
    +

    loginWithPopup

    +
    loginWithPopup: ((options?: PopupLoginOptions, config?: PopupConfigOptions) => Promise<void>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (options?: PopupLoginOptions, config?: PopupConfigOptions): Promise<void>
        • +
      • +
        await loginWithPopup(options, config);
        -

        Opens a popup with the /authorize URL using the parameters +

        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

    +
    +

    loginWithRedirect

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

    Type declaration

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

        Performs a redirect to /authorize using the parameters +

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

        -

    Parameters

    Returns Promise<void>

    logout

    +
    +

    logout

    +
    logout: ((options?: LogoutOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (options?: LogoutOptions): void
        • +
      • +
        auth0.logout({ returnTo: window.location.origin });
        -

        Clears the application session and performs a redirect to /v2/logout, using +

        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. -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. +If the logoutParams.federated option is specified, it also clears the Identity Provider session. Read more about how Logout works at Auth0.

        -

    Parameters

    Returns void

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file + +
    +

    Parameters

    +
    +

    Returns void

    +
    +

    Optional user

    +
    user?: TUser
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html index c583b525..48de911f 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -1,37 +1,139 @@ -Auth0ProviderOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Auth0ProviderOptions

    -

    The main configuration to instantiate the Auth0Provider.

    -

    Hierarchy

    • Auth0ProviderOptions

    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

    Methods

    Properties

    Optional advancedOptions

    advancedOptions?: { defaultScope?: string }
    -

    Changes to recommended defaults, like defaultScope

    -

    Type declaration

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

      -

    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 +Auth0ProviderOptions | @auth0/auth0-react

    +
    + +
    +
    +
    +
    + +

    Interface Auth0ProviderOptions

    +
    +

    The main configuration to instantiate the Auth0Provider.

    +
    +
    +

    Hierarchy

    +
      +
    • Auth0ClientOptions +
        +
      • Auth0ProviderOptions
    +
    +
    +
    + +
    +
    +

    Properties

    +
    auth0Client? +authorizationParams? +authorizeTimeoutInSeconds? +cache? +cacheLocation? +children? +clientId +context? +cookieDomain? +domain +httpTimeoutInSeconds? +issuer? +leeway? +legacySameSiteCookie? +nowProvider? +onRedirectCallback? +sessionCheckExpiryDays? +skipRedirectCallback? +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.

    -

    Read more about creating a custom cache

    -

    Optional cacheLocation

    cacheLocation?: CacheLocation
    -

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

    +
    +

    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.

    -

    Optional children

    children?: ReactNode
    -

    The child nodes your Provider has wrapped

    -

    clientId

    clientId: 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 context

    context?: Context<Auth0ContextInterface<User>>
    -

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

    -

    This allows multiple Auth0Providers to be nested within the same application, the context value can then be +

    Read more about changing storage options in the Auth0 docs

    +
    +
    +

    Optional children

    +
    children?: ReactNode
    +

    The child nodes your Provider has wrapped

    +
    +
    +

    clientId

    +
    clientId: string
    +

    The Client ID found on your Application settings page

    +
    +
    +

    Optional context

    +
    context?: Context<Auth0ContextInterface<User>>
    +

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

    +

    This allows multiple Auth0Providers to be nested within the same application, the context value can then be passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access auth state and methods specifically tied to the provider that the context belongs to.

    When using multiple Auth0Providers in a single application you should do the following to ensure sessions are not @@ -43,48 +145,225 @@ used to store data is different

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

    -

    domain

    domain: string
    -

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

    +
    +

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

    +
    +

    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 maxAge

    maxAge?: 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 redirectUri

    redirectUri?: 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 skipRedirectCallback

    skipRedirectCallback?: boolean
    -

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

    +
    +

    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.

        +
        +

        Returns number | Promise<number>

    +
    +

    Optional onRedirectCallback

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

    Type declaration

    +
      +
    • +
        +
      • (appState?: AppState, user?: User): void
        • +
      • +

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

        +
        +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Optional sessionCheckExpiryDays

    +
    sessionCheckExpiryDays?: number
    +

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

    +
    +
    +

    Optional skipRedirectCallback

    +
    skipRedirectCallback?: boolean
    +

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

    -
    <Auth0Provider
      clientId={clientId}
      domain={domain}
      skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
    >
+
    <Auth0Provider
      clientId={clientId}
      domain={domain}
      skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
    >
 
    
-

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

    +
    +

    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.

    -

    Methods

    Optional onRedirectCallback

    • -

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

      -

      Parameters

      Returns void

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +

    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/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html new file mode 100644 index 00000000..31900050 --- /dev/null +++ b/docs/interfaces/AuthorizationParams.html @@ -0,0 +1,215 @@ +AuthorizationParams | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    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/GetIdTokenClaimsOptions.html b/docs/interfaces/GetIdTokenClaimsOptions.html deleted file mode 100644 index 82aae2e0..00000000 --- a/docs/interfaces/GetIdTokenClaimsOptions.html +++ /dev/null @@ -1,5 +0,0 @@ -GetIdTokenClaimsOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GetIdTokenClaimsOptions

    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

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 07c08898..c5d2179c 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,25 +1,122 @@ -GetTokenSilentlyOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GetTokenSilentlyOptions

    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, +GetTokenSilentlyOptions | @auth0/auth0-react

    +
    + +
    +
    +
    +
    + +

    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.

    +
    +
    +

    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

    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 +

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

    -

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

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

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 1e343412..8edfd9e3 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,53 +1,82 @@ -GetTokenWithPopupOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GetTokenWithPopupOptions

    Hierarchy

    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"
    +GetTokenWithPopupOptions | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface GetTokenWithPopupOptions

    +
    +

    Hierarchy

    +

    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"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:350
    • +
    +
    +
    + +
    +
    +

    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 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?: 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

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:98
    • +
    +

    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/ICache.html b/docs/interfaces/ICache.html index 73159ab9..68258559 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1 +1,129 @@ -ICache | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ICache

    Hierarchy

    • ICache

    Implemented by

    Index

    Methods

    Methods

    Optional allKeys

    • allKeys(): MaybePromise<string[]>

    • Returns MaybePromise<string[]>

    get

    • get<T>(key: string): MaybePromise<null | T>

    • Type parameters

      Parameters

      • key: string

      Returns MaybePromise<null | T>

    remove

    • remove(key: string): MaybePromise<void>

    • Parameters

      • key: string

      Returns MaybePromise<void>

    set

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

    • Type parameters

      Parameters

      • key: string
      • entry: T

      Returns MaybePromise<void>

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +ICache | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface ICache

    +
    +

    Hierarchy

    +
      +
    • ICache
    +
    +

    Implemented by

    +
    +
    +
    +
    + +
    +
    +

    Methods

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

    Methods

    +
    +

    Optional allKeys

    +
      + +
    • +

      Returns MaybePromise<string[]>

    +
    +

    get

    +
      + +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
      +

      Returns MaybePromise<undefined | T>

    +
    +

    remove

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        key: string
      +

      Returns MaybePromise<void>

    +
    +

    set

    +
      + +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
        +
      • +
        key: string
        • +
      • +
        entry: T
      +

      Returns MaybePromise<void>

    +
    +
    +
    +

    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 00000000..dbe8a62f --- /dev/null +++ b/docs/interfaces/IdToken.html @@ -0,0 +1,320 @@ +IdToken | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    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/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index ee75858c..34f67a4d 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,26 +1,121 @@ -LogoutOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LogoutOptions

    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.

    +LogoutOptions | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface LogoutOptions

    +
    +

    Hierarchy

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

    Properties

    +
    clientId? +logoutParams? +openUrl? +
    +
    +

    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 federated

    federated?: boolean
    -

    When supported by the upstream identity provider, +

    +
    +

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

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

    -

    • Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file + +
    +

    Optional openUrl

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

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

    +

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

    + +

    Example

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

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 17e261da..418ccbff 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,20 +1,103 @@ -LogoutUrlOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LogoutUrlOptions

    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.

    +LogoutUrlOptions | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface LogoutUrlOptions

    +
    +

    Hierarchy

    +
      +
    • LogoutUrlOptions
    +
    +
    +
    + +
    +
    +

    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 federated

    federated?: boolean
    -

    When supported by the upstream identity provider, +

    +
    +

    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

    +

    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 +

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

    -

    • Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

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

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index be90ee54..18ae994c 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,8 +1,79 @@ -PopupConfigOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PopupConfigOptions

    Hierarchy

    • PopupConfigOptions

    Index

    Properties

    Properties

    Optional popup

    popup?: any
    -

    Accepts an already-created popup window to use. If not specified, the SDK +PopupConfigOptions | @auth0/auth0-react

    +
    + +
    +
    +
    +
    + +

    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 +

    +
    +

    Optional timeoutInSeconds

    +
    timeoutInSeconds?: number
    +

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

    -

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

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

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 299a2ffc..580f6c01 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,50 +1,73 @@ -PopupLoginOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PopupLoginOptions

    Hierarchy

    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"
    +PopupLoginOptions | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface PopupLoginOptions

    +
    +

    Hierarchy

    +

    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"
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:288
    • +
    +
    +
    + +
    +
    +

    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.

    +

    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?: 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

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:98
    • +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 03f8c185..5ed91a9f 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,59 +1,122 @@ -RedirectLoginOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RedirectLoginOptions

    Hierarchy

    • BaseLoginOptions
      • RedirectLoginOptions

    Index

    Properties

    Properties

    Optional acr_values

    acr_values?: string

    Optional appState

    appState?: any
    -

    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 redirectUri

    redirectUri?: 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?: 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

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +RedirectLoginOptions | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface RedirectLoginOptions<TAppState>

    +
    +

    Type Parameters

    +
    +
    +

    Hierarchy

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

    Properties

    +
    appState? +authorizationParams? +fragment? +openUrl? +
    +
    +

    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 openUrl

    +
    openUrl?: ((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 openUrl(url) {
            window.location.replace(url);
          }
        });
+
        +
        +
        +

        Parameters

        +
          +
        • +
          url: string
        +

        Returns Promise<void>

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 365c7ba0..9c9e1366 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -1,3 +1,68 @@ -WithAuth0Props | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface WithAuth0Props

    -

    Components wrapped in withAuth0 will have an additional auth0 prop

    -

    Hierarchy

    • WithAuth0Props

    Index

    Properties

    Properties

    auth0

    auth0: Auth0ContextInterface<User>

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +WithAuth0Props | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Interface WithAuth0Props

    +
    +

    Components wrapped in withAuth0 will have an additional auth0 prop

    +
    +
    +

    Hierarchy

    +
      +
    • WithAuth0Props
    +
    +
    +
    + +
    +
    +

    Properties

    +
    auth0 +
    +
    +

    Properties

    +
    +

    auth0

    +
    auth0: Auth0ContextInterface<User>
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 302f9368..654c00d0 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -1,26 +1,117 @@ -WithAuthenticationRequiredOptions | @auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface WithAuthenticationRequiredOptions

    -

    Options for the withAuthenticationRequired Higher Order Component

    -

    Hierarchy

    • WithAuthenticationRequiredOptions

    Index

    Properties

    Methods

    Properties

    Optional context

    context?: Context<Auth0ContextInterface<User>>
    -

    The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers +WithAuthenticationRequiredOptions | @auth0/auth0-react

    +
    + +
    +
    +
    +
    + +

    Interface WithAuthenticationRequiredOptions

    +
    +

    Options for the withAuthenticationRequired Higher Order Component

    +
    +
    +

    Hierarchy

    +
      +
    • WithAuthenticationRequiredOptions
    +
    +
    +
    + +
    +
    +

    Properties

    +
    context? +loginOptions? +onRedirecting? +returnTo? +
    +
    +

    Properties

    +
    +

    Optional context

    +
    context?: Context<Auth0ContextInterface<User>>
    +

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

    -

    Optional loginOptions

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

    Optional loginOptions

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

    Pass additional login options, like extra appState to the login page. +

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

    -

    Optional returnTo

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

    Optional onRedirecting

    +
    onRedirecting?: (() => Element)
    +
    +

    Type declaration

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

        or

        -
        withAuthenticationRequired(Profile, {
          returnTo: () => window.location.hash.substr(1)
        })
+
        Render a message to show that the user is being redirected to the login.
        
+
        +

        Returns Element

    +
    +

    Optional returnTo

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

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

    -

    Methods

    Optional claimCheck

    • claimCheck(claims?: User): boolean
    • -

      Check the user object for JWT claims and return a boolean indicating -whether or not they are authorized to view the component.

      -

      Parameters

      • Optional claims: User

      Returns boolean

    Optional onRedirecting

    • onRedirecting(): Element
    • -
      withAuthenticationRequired(Profile, {
        onRedirecting: () => <div>Redirecting you to the login...</div>
      })
+
      or
      
+
      withAuthenticationRequired(Profile, {
        returnTo: () => window.location.hash.substr(1)
      })
 
      
-

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

      -

      Returns Element

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +

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

    + +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 367638b4..cc9ed327 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,27 +1,107 @@ -@auth0/auth0-react
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @auth0/auth0-react

    Index

    Classes

    Interfaces

    Type aliases

    Variables

    Functions

    Type aliases

    AppState

    AppState: { returnTo?: string }
    -

    The state of the application before the user was redirected to the login page.

    -

    Type declaration

    • [key: string]: any
    • Optional returnTo?: string

    CacheLocation

    CacheLocation: "memory" | "localstorage"
    -

    The possible locations where tokens can be stored

    -

    Cacheable

    Cacheable: WrappedCacheEntry | KeyManifestEntry

    Variables

    Const Auth0Context

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

    The Auth0 Context

    -

    Functions

    Auth0Provider

    • -
      <Auth0Provider
        domain={domain}
        clientId={clientId}
        redirectUri={window.location.origin}>
        <MyApp />
      </Auth0Provider>
-
      -

      Provides the Auth0Context to its child components.

      -

      Parameters

      Returns Element

    useAuth0

    • -
      const {
        // Auth state:
        error,
        isAuthenticated,
        isLoading,
        user,
        // Auth methods:
        getAccessTokenSilently,
        getAccessTokenWithPopup,
        getIdTokenClaims,
        loginWithRedirect,
        loginWithPopup,
        logout,
      } = useAuth0<TUser>();
-
      -

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

      -

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

      -

      Type parameters

      Parameters

      Returns Auth0ContextInterface<TUser>

    withAuth0

    • -
      class MyComponent extends Component {
        render() {
          // Access the auth context from the `auth0` prop
          const { user } = this.props.auth0;
          return <div>Hello {user.name}!</div>
        }
      }
      // Wrap your class component in withAuth0
      export default withAuth0(MyComponent);
-
      -

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

      -

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

      -

      Type parameters

      Parameters

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

    withAuthenticationRequired

    • -
      const MyProtectedComponent = withAuthenticationRequired(MyComponent);
-
      -

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

      -

      Type parameters

      • P: object

      Parameters

      Returns FC<P>

    Legend

    • Property
    • Method
    • Constructor
    • Property

    Settings

    Theme

    \ No newline at end of file +@auth0/auth0-react
    +
    + +
    +
    +
    +
    +

    @auth0/auth0-react

    +
    +
    +

    Index

    +
    +

    Classes

    +
    InMemoryCache +LocalStorageCache +OAuthError +User +
    +
    +

    Interfaces

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

    Type Aliases

    +
    AppState +CacheLocation +Cacheable +
    +
    +

    Variables

    +
    Auth0Context +
    +
    +

    Functions

    +
    Auth0Provider +useAuth0 +withAuth0 +withAuthenticationRequired +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/types/AppState.html b/docs/types/AppState.html new file mode 100644 index 00000000..e8dde5c0 --- /dev/null +++ b/docs/types/AppState.html @@ -0,0 +1,78 @@ +AppState | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Type alias AppState

    +
    AppState: {
        returnTo?: string;
        [key: string]: any;
    }
    +

    The state of the application before the user was redirected to the login page.

    +
    +
    +

    Type declaration

    +
      +
    • +
      [key: string]: any
      • +
    • +
      Optional returnTo?: 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 00000000..c849015f --- /dev/null +++ b/docs/types/CacheLocation.html @@ -0,0 +1,71 @@ +CacheLocation | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    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 00000000..44b688bd --- /dev/null +++ b/docs/types/Cacheable.html @@ -0,0 +1,69 @@ +Cacheable | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Type alias Cacheable

    +
    Cacheable: WrappedCacheEntry | KeyManifestEntry
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html new file mode 100644 index 00000000..f19f4aa8 --- /dev/null +++ b/docs/variables/Auth0Context.html @@ -0,0 +1,71 @@ +Auth0Context | @auth0/auth0-react
    +
    + +
    +
    +
    +
    + +

    Variable Auth0ContextConst

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

    The Auth0 Context

    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index ee8d62e8..3223a420 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.0.0-beta.0", + "version": "2.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.0.0-beta.0", + "version": "2.0.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.0.2" diff --git a/package.json b/package.json index fc9db18b..f072fcae 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.0.0-beta.0", + "version": "2.0.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",