From 9160ac2b01cb59c64d9569d75922cd406103713b Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Tue, 23 Dec 2025 10:14:20 +0530 Subject: [PATCH] Release v2.4.0 --- .version | 2 +- CHANGELOG.md | 8 + docs/assets/hierarchy.js | 2 + docs/assets/highlight.css | 9 + docs/assets/icons.js | 37 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 1563 +++++--- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 2650 ++++++------ docs/classes/AbstractNavigator.html | 757 ++-- docs/classes/Auth0ClientFactory.html | 681 ++-- docs/classes/AuthClientConfig.html | 891 ++-- docs/classes/AuthGuard.html | 1095 ++--- docs/classes/AuthHttpInterceptor.html | 883 ++-- docs/classes/AuthModule.html | 713 ++-- docs/classes/AuthService.html | 3566 +++++++++++------ docs/classes/AuthState.html | 1692 ++++---- docs/classes/AuthenticationError.html | 2003 +++++---- docs/classes/Fetcher.html | 2122 ++++++++++ docs/classes/GenericError.html | 1697 ++++---- docs/classes/InMemoryCache.html | 602 +-- docs/classes/LocalStorageCache.html | 1205 +++--- docs/classes/MfaRequiredError.html | 1910 +++++---- docs/classes/MissingRefreshTokenError.html | 1968 +++++---- docs/classes/PopupCancelledError.html | 1867 +++++---- docs/classes/PopupTimeoutError.html | 1864 +++++---- docs/classes/TimeoutError.html | 1769 ++++---- docs/classes/UseDpopNonceError.html | 1273 ++++++ docs/classes/User.html | 1977 +++++---- docs/enums/HttpMethod.html | 832 ++-- docs/functions/authGuardFn.html | 487 +-- docs/functions/authHttpInterceptorFn.html | 590 ++- .../isHttpInterceptorRouteConfig.html | 460 ++- docs/functions/provideAuth0.html | 466 ++- docs/hierarchy.html | 450 ++- docs/index.html | 581 +-- docs/interfaces/AppState.html | 534 +-- docs/interfaces/AuthConfig.html | 3261 ++++++++------- docs/interfaces/AuthorizationParams.html | 1934 ++++----- docs/interfaces/GetTokenSilentlyOptions.html | 1049 ++--- docs/interfaces/GetTokenWithPopupOptions.html | 663 +-- docs/interfaces/HttpInterceptorConfig.html | 498 ++- .../HttpInterceptorRouteConfig.html | 1055 ++--- docs/interfaces/ICache.html | 1146 +++--- docs/interfaces/IdToken.html | 3493 ++++++++-------- docs/interfaces/LogoutOptions.html | 1097 ++--- docs/interfaces/PopupConfigOptions.html | 589 +-- docs/interfaces/PopupLoginOptions.html | 530 +-- docs/interfaces/RedirectLoginOptions.html | 951 ++--- docs/modules.html | 2033 ++++++++-- docs/types/ApiRouteDefinition.html | 329 +- docs/types/Cacheable.html | 326 +- docs/types/CustomFetchMinimalOutput.html | 426 ++ docs/types/FetcherConfig.html | 561 +++ docs/variables/Auth0ClientService.html | 326 +- docs/variables/AuthConfigService.html | 348 +- projects/auth0-angular/package.json | 2 +- 58 files changed, 35981 insertions(+), 23848 deletions(-) create mode 100644 docs/assets/hierarchy.js create mode 100644 docs/classes/Fetcher.html create mode 100644 docs/classes/UseDpopNonceError.html create mode 100644 docs/types/CustomFetchMinimalOutput.html create mode 100644 docs/types/FetcherConfig.html diff --git a/.version b/.version index a6316f06..fa49670c 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.3.0 \ No newline at end of file +v2.4.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 820d6277..1324aa2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Change Log +## [v2.4.0](https://github.com/auth0/auth0-angular/tree/v2.4.0) (2025-12-23) + +[Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.3.0...v2.4.0) + +**Added** + +- feat: add DPoP support with fetcher API [\#732](https://github.com/auth0/auth0-angular/pull/732) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.3.0](https://github.com/auth0/auth0-angular/tree/v2.3.0) (2025-09-10) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.2.3...v2.3.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js new file mode 100644 index 00000000..183dcd38 --- /dev/null +++ b/docs/assets/hierarchy.js @@ -0,0 +1,2 @@ +window.hierarchyData = + 'eJyVk81uwjAQhN9lz6aQxElIbhWtqkr0R5SqB8TBMguxCHZqOyfEu1cJamUI1OFkKZ7NN7Pr3YNWyhrIFzTISBQkJMzSJQGN6xK5FUoayPcQZmlzSLZDyOFdVXU1VRsh36qjhMBWyBXkYZwQqHUJOQhpUa8ZRzPs6O8KuyuBAC+ZMZCDNatB84PBX1FzWYhypVFCvohG4fJAIBqFjosntHO1RfklbNES+pm5VtbDU2MhSBwLzxPGC/QAj6KbI0fHyJEbeao4Kz+s0myDp+ggHP+iWwKaYUd81cLxw4EADbKTBkvUgj9qrfR/IFfnYZxEpJQSmqQkDjIS0zGJ04gkaRubUuoYmYsdqtp6jbi6m4xktIUm7iN/WbMZftdC48oLPtf26HRGzxeqb8qO2E+LT+Z6X9sCpRWcNQ/fy7sg70Gk4/N8EyY5lmWPdl6Q9yCmkTs9YYyQmxmuNZqiXXj/FK/U+NlJ6m7pp8GHSlWvSnL0QjtiH+1w+AEfCOVe'; diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 940fbfe8..a58fd388 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -19,6 +19,8 @@ --dark-hl-8: #c8c8c8; --light-hl-9: #0070c1; --dark-hl-9: #4fc1ff; + --light-hl-10: #098658; + --dark-hl-10: #b5cea8; --light-code-background: #ffffff; --dark-code-background: #1e1e1e; } @@ -35,6 +37,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } } @@ -51,6 +54,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } } @@ -66,6 +70,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } @@ -80,6 +85,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } @@ -113,6 +119,9 @@ .hl-9 { color: var(--hl-9); } +.hl-10 { + color: var(--hl-10); +} pre, code { background: var(--code-background); diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 0d1c044c..20caa56f 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,20 +1,21 @@ -(function (svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { +(function () { + addIcons(); + function addIcons() { if (document.readyState === 'loading') - document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements(); - function updateUseElements() { - document.querySelectorAll('use').forEach((el) => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } + return document.addEventListener('DOMContentLoaded', addIcons); + const svg = document.body.appendChild( + document.createElementNS('http://www.w3.org/2000/svg', 'svg') + ); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = 'none'; + if (location.protocol === 'file:') updateUseElements(); } -})( - document.body.appendChild( - document.createElementNS('http://www.w3.org/2000/svg', 'svg') - ) -); + + function updateUseElements() { + document.querySelectorAll('use').forEach((el) => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } +})(); diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 7dead611..50ad5799 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 623d0d17..f831c885 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,36 +1,71 @@ 'use strict'; -'use strict'; +window.translations = { + copy: 'Copy', + copied: 'Copied!', + normally_hidden: + 'This member is normally hidden due to your filter settings.', + hierarchy_expand: 'Expand', + hierarchy_collapse: 'Collapse', + folder: 'Folder', + search_index_not_available: 'The search index is not available', + search_no_results_found_for_0: 'No results found for {0}', + kind_1: 'Project', + kind_2: 'Module', + kind_4: 'Namespace', + kind_8: 'Enumeration', + kind_16: 'Enumeration Member', + kind_32: 'Variable', + kind_64: 'Function', + kind_128: 'Class', + kind_256: 'Interface', + kind_512: 'Constructor', + kind_1024: 'Property', + kind_2048: 'Method', + kind_4096: 'Call Signature', + kind_8192: 'Index Signature', + kind_16384: 'Constructor Signature', + kind_32768: 'Parameter', + kind_65536: 'Type Literal', + kind_131072: 'Type Parameter', + kind_262144: 'Accessor', + kind_524288: 'Get Signature', + kind_1048576: 'Set Signature', + kind_2097152: 'Type Alias', + kind_4194304: 'Reference', + kind_8388608: 'Document', +}; +('use strict'); (() => { - var Ce = Object.create; - var ne = Object.defineProperty; - var Pe = Object.getOwnPropertyDescriptor; - var Oe = Object.getOwnPropertyNames; - var _e = Object.getPrototypeOf, - Re = Object.prototype.hasOwnProperty; - var Me = (t, e) => () => ( + var Ke = Object.create; + var he = Object.defineProperty; + var Ge = Object.getOwnPropertyDescriptor; + var Ze = Object.getOwnPropertyNames; + var Xe = Object.getPrototypeOf, + Ye = Object.prototype.hasOwnProperty; + var et = (t, e) => () => ( e || t((e = { exports: {} }).exports, e), e.exports ); - var Fe = (t, e, n, r) => { + var tt = (t, e, n, r) => { if ((e && typeof e == 'object') || typeof e == 'function') - for (let i of Oe(e)) - !Re.call(t, i) && + for (let i of Ze(e)) + !Ye.call(t, i) && i !== n && - ne(t, i, { + he(t, i, { get: () => e[i], - enumerable: !(r = Pe(e, i)) || r.enumerable, + enumerable: !(r = Ge(e, i)) || r.enumerable, }); return t; }; - var De = (t, e, n) => ( - (n = t != null ? Ce(_e(t)) : {}), - Fe( + var nt = (t, e, n) => ( + (n = t != null ? Ke(Xe(t)) : {}), + tt( e || !t || !t.__esModule - ? ne(n, 'default', { value: t, enumerable: !0 }) + ? he(n, 'default', { value: t, enumerable: !0 }) : n, t ) ); - var ae = Me((se, oe) => { + var ye = et((me, ge) => { (function () { var t = function (e) { var n = new t.Builder(); @@ -182,9 +217,9 @@ (t.tokenizer = function (e, n) { if (e == null || e == null) return []; if (Array.isArray(e)) - return e.map(function (y) { + return e.map(function (f) { return new t.Token( - t.utils.asString(y).toLowerCase(), + t.utils.asString(f).toLowerCase(), t.utils.clone(n) ); }); @@ -197,12 +232,12 @@ o <= i; o++ ) { - var l = r.charAt(o), - u = o - a; - if (l.match(t.tokenizer.separator) || o == i) { - if (u > 0) { + var c = r.charAt(o), + l = o - a; + if (c.match(t.tokenizer.separator) || o == i) { + if (l > 0) { var d = t.utils.clone(n) || {}; - (d.position = [a, u]), + (d.position = [a, l]), (d.index = s.length), s.push(new t.Token(r.slice(a, o), d)); } @@ -270,7 +305,7 @@ var a = i(e[o], o, e); if (!(a == null || a === '')) if (Array.isArray(a)) - for (var l = 0; l < a.length; l++) s.push(a[l]); + for (var c = 0; c < a.length; c++) s.push(a[c]); else s.push(a); } e = s; @@ -339,19 +374,19 @@ s = r.length, o = i.length, a = 0, + c = 0, l = 0, - u = 0, d = 0; - u < s && d < o; + l < s && d < o; ) - (a = r[u]), - (l = i[d]), - a < l - ? (u += 2) - : a > l + (a = r[l]), + (c = i[d]), + a < c + ? (l += 2) + : a > c ? (d += 2) - : a == l && ((n += r[u + 1] * i[d + 1]), (u += 2), (d += 2)); + : a == c && ((n += r[l + 1] * i[d + 1]), (l += 2), (d += 2)); return n; }), (t.Vector.prototype.similarity = function (e) { @@ -407,100 +442,100 @@ s = r + '[^aeiouy]*', o = i + '[aeiou]*', a = '^(' + s + ')?' + o + s, - l = '^(' + s + ')?' + o + s + '(' + o + ')?$', - u = '^(' + s + ')?' + o + s + o + s, + c = '^(' + s + ')?' + o + s + '(' + o + ')?$', + l = '^(' + s + ')?' + o + s + o + s, d = '^(' + s + ')?' + i, - y = new RegExp(a), - p = new RegExp(u), - b = new RegExp(l), - g = new RegExp(d), - L = /^(.+?)(ss|i)es$/, - f = /^(.+?)([^s])s$/, - m = /^(.+?)eed$/, - S = /^(.+?)(ed|ing)$/, - w = /.$/, - k = /(at|bl|iz)$/, - _ = new RegExp('([^aeiouylsz])\\1$'), - B = new RegExp('^' + s + i + '[^aeiouwxy]$'), - A = /^(.+?[^aeiou])y$/, - j = + f = new RegExp(a), + p = new RegExp(l), + v = new RegExp(c), + x = new RegExp(d), + w = /^(.+?)(ss|i)es$/, + m = /^(.+?)([^s])s$/, + g = /^(.+?)eed$/, + T = /^(.+?)(ed|ing)$/, + L = /.$/, + C = /(at|bl|iz)$/, + O = new RegExp('([^aeiouylsz])\\1$'), + j = new RegExp('^' + s + i + '[^aeiouwxy]$'), + N = /^(.+?[^aeiou])y$/, + q = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/, - $ = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, - V = + W = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, + B = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, - q = /^(.+?)(s|t)(ion)$/, - C = /^(.+?)e$/, - z = /ll$/, - W = new RegExp('^' + s + i + '[^aeiouwxy]$'), - N = function (c) { - var v, P, T, h, x, O, M; - if (c.length < 3) return c; + z = /^(.+?)(s|t)(ion)$/, + _ = /^(.+?)e$/, + U = /ll$/, + J = new RegExp('^' + s + i + '[^aeiouwxy]$'), + V = function (u) { + var y, P, k, h, E, Q, H; + if (u.length < 3) return u; if ( - ((T = c.substr(0, 1)), - T == 'y' && (c = T.toUpperCase() + c.substr(1)), - (h = L), - (x = f), - h.test(c) - ? (c = c.replace(h, '$1$2')) - : x.test(c) && (c = c.replace(x, '$1$2')), - (h = m), - (x = S), - h.test(c)) + ((k = u.substr(0, 1)), + k == 'y' && (u = k.toUpperCase() + u.substr(1)), + (h = w), + (E = m), + h.test(u) + ? (u = u.replace(h, '$1$2')) + : E.test(u) && (u = u.replace(E, '$1$2')), + (h = g), + (E = T), + h.test(u)) ) { - var E = h.exec(c); - (h = y), h.test(E[1]) && ((h = w), (c = c.replace(h, ''))); - } else if (x.test(c)) { - var E = x.exec(c); - (v = E[1]), - (x = g), - x.test(v) && - ((c = v), - (x = k), - (O = _), - (M = B), - x.test(c) - ? (c = c + 'e') - : O.test(c) - ? ((h = w), (c = c.replace(h, ''))) - : M.test(c) && (c = c + 'e')); + var b = h.exec(u); + (h = f), h.test(b[1]) && ((h = L), (u = u.replace(h, ''))); + } else if (E.test(u)) { + var b = E.exec(u); + (y = b[1]), + (E = x), + E.test(y) && + ((u = y), + (E = C), + (Q = O), + (H = j), + E.test(u) + ? (u = u + 'e') + : Q.test(u) + ? ((h = L), (u = u.replace(h, ''))) + : H.test(u) && (u = u + 'e')); } - if (((h = A), h.test(c))) { - var E = h.exec(c); - (v = E[1]), (c = v + 'i'); + if (((h = N), h.test(u))) { + var b = h.exec(u); + (y = b[1]), (u = y + 'i'); } - if (((h = j), h.test(c))) { - var E = h.exec(c); - (v = E[1]), (P = E[2]), (h = y), h.test(v) && (c = v + e[P]); + if (((h = q), h.test(u))) { + var b = h.exec(u); + (y = b[1]), (P = b[2]), (h = f), h.test(y) && (u = y + e[P]); } - if (((h = $), h.test(c))) { - var E = h.exec(c); - (v = E[1]), (P = E[2]), (h = y), h.test(v) && (c = v + n[P]); + if (((h = W), h.test(u))) { + var b = h.exec(u); + (y = b[1]), (P = b[2]), (h = f), h.test(y) && (u = y + n[P]); } - if (((h = V), (x = q), h.test(c))) { - var E = h.exec(c); - (v = E[1]), (h = p), h.test(v) && (c = v); - } else if (x.test(c)) { - var E = x.exec(c); - (v = E[1] + E[2]), (x = p), x.test(v) && (c = v); + if (((h = B), (E = z), h.test(u))) { + var b = h.exec(u); + (y = b[1]), (h = p), h.test(y) && (u = y); + } else if (E.test(u)) { + var b = E.exec(u); + (y = b[1] + b[2]), (E = p), E.test(y) && (u = y); } - if (((h = C), h.test(c))) { - var E = h.exec(c); - (v = E[1]), + if (((h = _), h.test(u))) { + var b = h.exec(u); + (y = b[1]), (h = p), - (x = b), - (O = W), - (h.test(v) || (x.test(v) && !O.test(v))) && (c = v); + (E = v), + (Q = J), + (h.test(y) || (E.test(y) && !Q.test(y))) && (u = y); } return ( - (h = z), - (x = p), - h.test(c) && x.test(c) && ((h = w), (c = c.replace(h, ''))), - T == 'y' && (c = T.toLowerCase() + c.substr(1)), - c + (h = U), + (E = p), + h.test(u) && E.test(u) && ((h = L), (u = u.replace(h, ''))), + k == 'y' && (u = k.toLowerCase() + u.substr(1)), + u ); }; - return function (R) { - return R.update(N); + return function (A) { + return A.update(V); }; })()), t.Pipeline.registerFunction(t.stemmer, 'stemmer'); @@ -683,15 +718,15 @@ }); } if (s.editsRemaining != 0) { - if ('*' in s.node.edges) var l = s.node.edges['*']; + if ('*' in s.node.edges) var c = s.node.edges['*']; else { - var l = new t.TokenSet(); - s.node.edges['*'] = l; + var c = new t.TokenSet(); + s.node.edges['*'] = c; } if ( - (s.str.length == 0 && (l.final = !0), + (s.str.length == 0 && (c.final = !0), i.push({ - node: l, + node: c, editsRemaining: s.editsRemaining - 1, str: s.str, }), @@ -704,25 +739,25 @@ s.str.length == 1 && (s.node.final = !0), s.str.length >= 1) ) { - if ('*' in s.node.edges) var u = s.node.edges['*']; + if ('*' in s.node.edges) var l = s.node.edges['*']; else { - var u = new t.TokenSet(); - s.node.edges['*'] = u; + var l = new t.TokenSet(); + s.node.edges['*'] = l; } - s.str.length == 1 && (u.final = !0), + s.str.length == 1 && (l.final = !0), i.push({ - node: u, + node: l, editsRemaining: s.editsRemaining - 1, str: s.str.slice(1), }); } if (s.str.length > 1) { var d = s.str.charAt(0), - y = s.str.charAt(1), + f = s.str.charAt(1), p; - y in s.node.edges - ? (p = s.node.edges[y]) - : ((p = new t.TokenSet()), (s.node.edges[y] = p)), + f in s.node.edges + ? (p = s.node.edges[f]) + : ((p = new t.TokenSet()), (s.node.edges[f] = p)), s.str.length == 1 && (p.final = !0), i.push({ node: p, @@ -744,8 +779,8 @@ a = i == s - 1; if (o == '*') (n.edges[o] = n), (n.final = a); else { - var l = new t.TokenSet(); - (l.final = a), (n.edges[o] = l), (n = l); + var c = new t.TokenSet(); + (c.final = a), (n.edges[o] = c), (n = c); } } return r; @@ -792,24 +827,24 @@ var s = Object.keys(r.qNode.edges), o = s.length, a = Object.keys(r.node.edges), - l = a.length, - u = 0; - u < o; - u++ + c = a.length, + l = 0; + l < o; + l++ ) - for (var d = s[u], y = 0; y < l; y++) { - var p = a[y]; + for (var d = s[l], f = 0; f < c; f++) { + var p = a[f]; if (p == d || d == '*') { - var b = r.node.edges[p], - g = r.qNode.edges[d], - L = b.final && g.final, - f = void 0; + var v = r.node.edges[p], + x = r.qNode.edges[d], + w = v.final && x.final, + m = void 0; p in r.output.edges - ? ((f = r.output.edges[p]), (f.final = f.final || L)) - : ((f = new t.TokenSet()), - (f.final = L), - (r.output.edges[p] = f)), - i.push({ qNode: g, output: f, node: b }); + ? ((m = r.output.edges[p]), (m.final = m.final || w)) + : ((m = new t.TokenSet()), + (m.final = w), + (r.output.edges[p] = m)), + i.push({ qNode: x, output: m, node: v }); } } } @@ -881,113 +916,113 @@ s = Object.create(null), o = Object.create(null), a = Object.create(null), - l = 0; - l < this.fields.length; - l++ + c = 0; + c < this.fields.length; + c++ ) - i[this.fields[l]] = new t.Vector(); + i[this.fields[c]] = new t.Vector(); e.call(n, n); - for (var l = 0; l < n.clauses.length; l++) { - var u = n.clauses[l], + for (var c = 0; c < n.clauses.length; c++) { + var l = n.clauses[c], d = null, - y = t.Set.empty; - u.usePipeline - ? (d = this.pipeline.runString(u.term, { fields: u.fields })) - : (d = [u.term]); + f = t.Set.empty; + l.usePipeline + ? (d = this.pipeline.runString(l.term, { fields: l.fields })) + : (d = [l.term]); for (var p = 0; p < d.length; p++) { - var b = d[p]; - u.term = b; - var g = t.TokenSet.fromClause(u), - L = this.tokenSet.intersect(g).toArray(); - if (L.length === 0 && u.presence === t.Query.presence.REQUIRED) { - for (var f = 0; f < u.fields.length; f++) { - var m = u.fields[f]; - o[m] = t.Set.empty; + var v = d[p]; + l.term = v; + var x = t.TokenSet.fromClause(l), + w = this.tokenSet.intersect(x).toArray(); + if (w.length === 0 && l.presence === t.Query.presence.REQUIRED) { + for (var m = 0; m < l.fields.length; m++) { + var g = l.fields[m]; + o[g] = t.Set.empty; } break; } - for (var S = 0; S < L.length; S++) + for (var T = 0; T < w.length; T++) for ( - var w = L[S], k = this.invertedIndex[w], _ = k._index, f = 0; - f < u.fields.length; - f++ + var L = w[T], C = this.invertedIndex[L], O = C._index, m = 0; + m < l.fields.length; + m++ ) { - var m = u.fields[f], - B = k[m], - A = Object.keys(B), - j = w + '/' + m, - $ = new t.Set(A); + var g = l.fields[m], + j = C[g], + N = Object.keys(j), + q = L + '/' + g, + W = new t.Set(N); if ( - (u.presence == t.Query.presence.REQUIRED && - ((y = y.union($)), - o[m] === void 0 && (o[m] = t.Set.complete)), - u.presence == t.Query.presence.PROHIBITED) + (l.presence == t.Query.presence.REQUIRED && + ((f = f.union(W)), + o[g] === void 0 && (o[g] = t.Set.complete)), + l.presence == t.Query.presence.PROHIBITED) ) { - a[m] === void 0 && (a[m] = t.Set.empty), - (a[m] = a[m].union($)); + a[g] === void 0 && (a[g] = t.Set.empty), + (a[g] = a[g].union(W)); continue; } if ( - (i[m].upsert(_, u.boost, function (Qe, Ie) { - return Qe + Ie; + (i[g].upsert(O, l.boost, function (Ue, Je) { + return Ue + Je; }), - !s[j]) + !s[q]) ) { - for (var V = 0; V < A.length; V++) { - var q = A[V], - C = new t.FieldRef(q, m), - z = B[q], - W; - (W = r[C]) === void 0 - ? (r[C] = new t.MatchData(w, m, z)) - : W.add(w, m, z); + for (var B = 0; B < N.length; B++) { + var z = N[B], + _ = new t.FieldRef(z, g), + U = j[z], + J; + (J = r[_]) === void 0 + ? (r[_] = new t.MatchData(L, g, U)) + : J.add(L, g, U); } - s[j] = !0; + s[q] = !0; } } } - if (u.presence === t.Query.presence.REQUIRED) - for (var f = 0; f < u.fields.length; f++) { - var m = u.fields[f]; - o[m] = o[m].intersect(y); + if (l.presence === t.Query.presence.REQUIRED) + for (var m = 0; m < l.fields.length; m++) { + var g = l.fields[m]; + o[g] = o[g].intersect(f); } } for ( - var N = t.Set.complete, R = t.Set.empty, l = 0; - l < this.fields.length; - l++ + var V = t.Set.complete, A = t.Set.empty, c = 0; + c < this.fields.length; + c++ ) { - var m = this.fields[l]; - o[m] && (N = N.intersect(o[m])), a[m] && (R = R.union(a[m])); + var g = this.fields[c]; + o[g] && (V = V.intersect(o[g])), a[g] && (A = A.union(a[g])); } - var c = Object.keys(r), - v = [], + var u = Object.keys(r), + y = [], P = Object.create(null); if (n.isNegated()) { - c = Object.keys(this.fieldVectors); - for (var l = 0; l < c.length; l++) { - var C = c[l], - T = t.FieldRef.fromString(C); - r[C] = new t.MatchData(); + u = Object.keys(this.fieldVectors); + for (var c = 0; c < u.length; c++) { + var _ = u[c], + k = t.FieldRef.fromString(_); + r[_] = new t.MatchData(); } } - for (var l = 0; l < c.length; l++) { - var T = t.FieldRef.fromString(c[l]), - h = T.docRef; - if (N.contains(h) && !R.contains(h)) { - var x = this.fieldVectors[T], - O = i[T.fieldName].similarity(x), - M; - if ((M = P[h]) !== void 0) - (M.score += O), M.matchData.combine(r[T]); + for (var c = 0; c < u.length; c++) { + var k = t.FieldRef.fromString(u[c]), + h = k.docRef; + if (V.contains(h) && !A.contains(h)) { + var E = this.fieldVectors[k], + Q = i[k.fieldName].similarity(E), + H; + if ((H = P[h]) !== void 0) + (H.score += Q), H.matchData.combine(r[k]); else { - var E = { ref: h, score: O, matchData: r[T] }; - (P[h] = E), v.push(E); + var b = { ref: h, score: Q, matchData: r[k] }; + (P[h] = b), y.push(b); } } } - return v.sort(function (Te, ke) { - return ke.score - Te.score; + return y.sort(function (We, ze) { + return ze.score - We.score; }); }), (t.Index.prototype.toJSON = function () { @@ -1014,7 +1049,7 @@ s = Object.create(null), o = e.invertedIndex, a = new t.TokenSet.Builder(), - l = t.Pipeline.load(e.pipeline); + c = t.Pipeline.load(e.pipeline); e.version != t.version && t.utils.warn( "Version mismatch when loading serialised index. Current version of lunr '" + @@ -1023,17 +1058,17 @@ e.version + "'" ); - for (var u = 0; u < i.length; u++) { - var d = i[u], - y = d[0], + for (var l = 0; l < i.length; l++) { + var d = i[l], + f = d[0], p = d[1]; - r[y] = new t.Vector(p); + r[f] = new t.Vector(p); } - for (var u = 0; u < o.length; u++) { - var d = o[u], - b = d[0], - g = d[1]; - a.insert(b), (s[b] = g); + for (var l = 0; l < o.length; l++) { + var d = o[l], + v = d[0], + x = d[1]; + a.insert(v), (s[v] = x); } return ( a.finish(), @@ -1041,7 +1076,7 @@ (n.fieldVectors = r), (n.invertedIndex = s), (n.tokenSet = a.root), - (n.pipeline = l), + (n.pipeline = c), new t.Index(n) ); }); @@ -1084,35 +1119,35 @@ for (var s = 0; s < i.length; s++) { var o = i[s], a = this._fields[o].extractor, - l = a ? a(e) : e[o], - u = this.tokenizer(l, { fields: [o] }), - d = this.pipeline.run(u), - y = new t.FieldRef(r, o), + c = a ? a(e) : e[o], + l = this.tokenizer(c, { fields: [o] }), + d = this.pipeline.run(l), + f = new t.FieldRef(r, o), p = Object.create(null); - (this.fieldTermFrequencies[y] = p), - (this.fieldLengths[y] = 0), - (this.fieldLengths[y] += d.length); - for (var b = 0; b < d.length; b++) { - var g = d[b]; + (this.fieldTermFrequencies[f] = p), + (this.fieldLengths[f] = 0), + (this.fieldLengths[f] += d.length); + for (var v = 0; v < d.length; v++) { + var x = d[v]; if ( - (p[g] == null && (p[g] = 0), - (p[g] += 1), - this.invertedIndex[g] == null) + (p[x] == null && (p[x] = 0), + (p[x] += 1), + this.invertedIndex[x] == null) ) { - var L = Object.create(null); - (L._index = this.termIndex), (this.termIndex += 1); - for (var f = 0; f < i.length; f++) - L[i[f]] = Object.create(null); - this.invertedIndex[g] = L; + var w = Object.create(null); + (w._index = this.termIndex), (this.termIndex += 1); + for (var m = 0; m < i.length; m++) + w[i[m]] = Object.create(null); + this.invertedIndex[x] = w; } - this.invertedIndex[g][o][r] == null && - (this.invertedIndex[g][o][r] = Object.create(null)); - for (var m = 0; m < this.metadataWhitelist.length; m++) { - var S = this.metadataWhitelist[m], - w = g.metadata[S]; - this.invertedIndex[g][o][r][S] == null && - (this.invertedIndex[g][o][r][S] = []), - this.invertedIndex[g][o][r][S].push(w); + this.invertedIndex[x][o][r] == null && + (this.invertedIndex[x][o][r] = Object.create(null)); + for (var g = 0; g < this.metadataWhitelist.length; g++) { + var T = this.metadataWhitelist[g], + L = x.metadata[T]; + this.invertedIndex[x][o][r][T] == null && + (this.invertedIndex[x][o][r][T] = []), + this.invertedIndex[x][o][r][T].push(L); } } } @@ -1134,9 +1169,9 @@ r[a] || (r[a] = 0), (r[a] += this.fieldLengths[o]); } - for (var l = Object.keys(this._fields), s = 0; s < l.length; s++) { - var u = l[s]; - r[u] = r[u] / i[u]; + for (var c = Object.keys(this._fields), s = 0; s < c.length; s++) { + var l = c[s]; + r[l] = r[l] / i[l]; } this.averageFieldLength = r; }), @@ -1153,38 +1188,38 @@ for ( var o = t.FieldRef.fromString(n[s]), a = o.fieldName, - l = this.fieldLengths[o], - u = new t.Vector(), + c = this.fieldLengths[o], + l = new t.Vector(), d = this.fieldTermFrequencies[o], - y = Object.keys(d), - p = y.length, - b = this._fields[a].boost || 1, - g = this._documents[o.docRef].boost || 1, - L = 0; - L < p; - L++ + f = Object.keys(d), + p = f.length, + v = this._fields[a].boost || 1, + x = this._documents[o.docRef].boost || 1, + w = 0; + w < p; + w++ ) { - var f = y[L], - m = d[f], - S = this.invertedIndex[f]._index, - w, - k, - _; - i[f] === void 0 - ? ((w = t.idf(this.invertedIndex[f], this.documentCount)), - (i[f] = w)) - : (w = i[f]), - (k = - (w * ((this._k1 + 1) * m)) / + var m = f[w], + g = d[m], + T = this.invertedIndex[m]._index, + L, + C, + O; + i[m] === void 0 + ? ((L = t.idf(this.invertedIndex[m], this.documentCount)), + (i[m] = L)) + : (L = i[m]), + (C = + (L * ((this._k1 + 1) * g)) / (this._k1 * - (1 - this._b + this._b * (l / this.averageFieldLength[a])) + - m)), - (k *= b), - (k *= g), - (_ = Math.round(k * 1e3) / 1e3), - u.insert(S, _); + (1 - this._b + this._b * (c / this.averageFieldLength[a])) + + g)), + (C *= v), + (C *= x), + (O = Math.round(C * 1e3) / 1e3), + l.insert(T, O); } - e[o] = u; + e[o] = l; } this.fieldVectors = e; }), @@ -1233,11 +1268,11 @@ (this.metadata[i] = Object.create(null)); for (var o = 0; o < s.length; o++) { var a = s[o], - l = Object.keys(e.metadata[i][a]); + c = Object.keys(e.metadata[i][a]); this.metadata[i][a] == null && (this.metadata[i][a] = Object.create(null)); - for (var u = 0; u < l.length; u++) { - var d = l[u]; + for (var l = 0; l < c.length; l++) { + var d = c[l]; this.metadata[i][a][d] == null ? (this.metadata[i][a][d] = e.metadata[i][a][d]) : (this.metadata[i][a][d] = this.metadata[i][a][d].concat( @@ -1631,21 +1666,93 @@ (function (e, n) { typeof define == 'function' && define.amd ? define(n) - : typeof se == 'object' - ? (oe.exports = n()) + : typeof me == 'object' + ? (ge.exports = n()) : (e.lunr = n()); })(this, function () { return t; }); })(); }); - var re = []; - function G(t, e) { - re.push({ selector: e, constructor: t }); + var M, + G = { + getItem() { + return null; + }, + setItem() {}, + }, + K; + try { + (K = localStorage), (M = K); + } catch { + (K = G), (M = G); + } + var S = { + getItem: (t) => M.getItem(t), + setItem: (t, e) => M.setItem(t, e), + disableWritingLocalStorage() { + M = G; + }, + disable() { + localStorage.clear(), (M = G); + }, + enable() { + M = K; + }, + }; + window.TypeDoc ||= { + disableWritingLocalStorage() { + S.disableWritingLocalStorage(); + }, + disableLocalStorage: () => { + S.disable(); + }, + enableLocalStorage: () => { + S.enable(); + }, + }; + window.translations ||= { + copy: 'Copy', + copied: 'Copied!', + normally_hidden: + 'This member is normally hidden due to your filter settings.', + hierarchy_expand: 'Expand', + hierarchy_collapse: 'Collapse', + search_index_not_available: 'The search index is not available', + search_no_results_found_for_0: 'No results found for {0}', + folder: 'Folder', + kind_1: 'Project', + kind_2: 'Module', + kind_4: 'Namespace', + kind_8: 'Enumeration', + kind_16: 'Enumeration Member', + kind_32: 'Variable', + kind_64: 'Function', + kind_128: 'Class', + kind_256: 'Interface', + kind_512: 'Constructor', + kind_1024: 'Property', + kind_2048: 'Method', + kind_4096: 'Call Signature', + kind_8192: 'Index Signature', + kind_16384: 'Constructor Signature', + kind_32768: 'Parameter', + kind_65536: 'Type Literal', + kind_131072: 'Type Parameter', + kind_262144: 'Accessor', + kind_524288: 'Get Signature', + kind_1048576: 'Set Signature', + kind_2097152: 'Type Alias', + kind_4194304: 'Reference', + kind_8388608: 'Document', + }; + var pe = []; + function X(t, e) { + pe.push({ selector: e, constructor: t }); } - var U = class { + var Z = class { + alwaysVisibleMember = null; constructor() { - this.alwaysVisibleMember = null; this.createComponents(document.body), this.ensureFocusedElementVisible(), this.listenForCodeCopies(), @@ -1658,7 +1765,7 @@ this.scrollToHash()); } createComponents(e) { - re.forEach((n) => { + pe.forEach((n) => { e.querySelectorAll(n.selector).forEach((r) => { r.dataset.hasInstance || (new n.constructor({ el: r, app: this }), @@ -1671,15 +1778,13 @@ } showPage() { document.body.style.display && - (console.log('Show page'), - document.body.style.removeProperty('display'), + (document.body.style.removeProperty('display'), this.ensureFocusedElementVisible(), this.updateIndexVisibility(), this.scrollToHash()); } scrollToHash() { if (location.hash) { - console.log('Scorlling'); let e = document.getElementById(location.hash.substring(1)); if (!e) return; e.scrollIntoView({ behavior: 'instant', block: 'start' }); @@ -1690,11 +1795,12 @@ n = e?.parentElement; for (; n && !n.classList.contains('.tsd-navigation'); ) n instanceof HTMLDetailsElement && (n.open = !0), (n = n.parentElement); - if (e && !e.checkVisibility()) { + if (e && !rt(e)) { let r = e.getBoundingClientRect().top - document.documentElement.clientHeight / 4; - document.querySelector('.site-menu').scrollTop = r; + (document.querySelector('.site-menu').scrollTop = r), + (document.querySelector('.col-sidebar').scrollTop = r); } } updateIndexVisibility() { @@ -1723,14 +1829,19 @@ if (!e) return; let n = e.parentElement; for (; n && n.tagName !== 'SECTION'; ) n = n.parentElement; - if (n && n.offsetParent == null) { + if (!n) return; + let r = n.offsetParent == null, + i = n; + for (; i !== document.body; ) + i instanceof HTMLDetailsElement && (i.open = !0), (i = i.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); + let s = document.createElement('p'); + s.classList.add('warning'), + (s.textContent = window.translations.normally_hidden), + n.prepend(s); } + r && e.scrollIntoView(); } listenForCodeCopies() { document.querySelectorAll('pre > button').forEach((e) => { @@ -1740,170 +1851,299 @@ navigator.clipboard.writeText( e.previousElementSibling.innerText.trim() ), - (e.textContent = 'Copied!'), + (e.textContent = window.translations.copied), e.classList.add('visible'), clearTimeout(n), (n = setTimeout(() => { e.classList.remove('visible'), (n = setTimeout(() => { - e.textContent = 'Copy'; + e.textContent = window.translations.copy; }, 100)); }, 1e3)); }); }); } }; - var ie = (t, e = 100) => { + function rt(t) { + let e = t.getBoundingClientRect(), + n = Math.max(document.documentElement.clientHeight, window.innerHeight); + return !(e.bottom < 0 || e.top - n >= 0); + } + var fe = (t, e = 100) => { let n; return () => { clearTimeout(n), (n = setTimeout(() => t(), e)); }; }; - var de = De(ae()); - async function le(t, e) { - if (!window.searchData) return; - let n = await fetch(window.searchData), - r = new Blob([await n.arrayBuffer()]) + var Ie = nt(ye(), 1); + async function R(t) { + let e = Uint8Array.from(atob(t), (s) => s.charCodeAt(0)), + r = new Blob([e]) .stream() - .pipeThrough(new DecompressionStream('gzip')), - i = await new Response(r).json(); - (t.data = i), - (t.index = de.Index.load(i.index)), - e.classList.remove('loading'), - e.classList.add('ready'); + .pipeThrough(new DecompressionStream('deflate')), + i = await new Response(r).text(); + return JSON.parse(i); } - function he() { - let t = document.getElementById('tsd-search'); - if (!t) return; - let e = { base: t.dataset.base + '/' }, - n = document.getElementById('tsd-search-script'); - t.classList.add('loading'), - n && - (n.addEventListener('error', () => { - t.classList.remove('loading'), t.classList.add('failure'); - }), - n.addEventListener('load', () => { - le(e, t); - }), - le(e, t)); - let r = document.querySelector('#tsd-search input'), - i = document.querySelector('#tsd-search .results'); - if (!r || !i) - throw new Error( - 'The input field or the result list wrapper was not found' - ); - let s = !1; - i.addEventListener('mousedown', () => (s = !0)), - i.addEventListener('mouseup', () => { - (s = !1), t.classList.remove('has-focus'); - }), - r.addEventListener('focus', () => t.classList.add('has-focus')), - r.addEventListener('blur', () => { - s || ((s = !1), t.classList.remove('has-focus')); - }), - Ae(t, i, r, e); + var Y = 'closing', + ae = 'tsd-overlay'; + function it() { + let t = Math.abs(window.innerWidth - document.documentElement.clientWidth); + (document.body.style.overflow = 'hidden'), + (document.body.style.paddingRight = `${t}px`); } - function Ae(t, e, n, r) { - n.addEventListener( - 'input', - ie(() => { - Ve(t, e, n, r); - }, 200) - ); - let i = !1; - n.addEventListener('keydown', (s) => { - (i = !0), - s.key == 'Enter' - ? Ne(e, n) - : s.key == 'Escape' - ? n.blur() - : s.key == 'ArrowUp' - ? ue(e, -1) - : s.key === 'ArrowDown' - ? ue(e, 1) - : (i = !1); + function st() { + document.body.style.removeProperty('overflow'), + document.body.style.removeProperty('padding-right'); + } + function xe(t, e) { + t.addEventListener('animationend', () => { + t.classList.contains(Y) && + (t.classList.remove(Y), + document.getElementById(ae)?.remove(), + t.close(), + st()); }), - n.addEventListener('keypress', (s) => { - i && s.preventDefault(); + t.addEventListener('cancel', (n) => { + n.preventDefault(), ve(t); }), - document.body.addEventListener('keydown', (s) => { - s.altKey || - s.ctrlKey || - s.metaKey || - (!n.matches(':focus') && - s.key === '/' && - (n.focus(), s.preventDefault())); + e?.closeOnClick && + document.addEventListener( + 'click', + (n) => { + t.open && !t.contains(n.target) && ve(t); + }, + !0 + ); + } + function Ee(t) { + if (t.open) return; + let e = document.createElement('div'); + (e.id = ae), document.body.appendChild(e), t.showModal(), it(); + } + function ve(t) { + if (!t.open) return; + document.getElementById(ae)?.classList.add(Y), t.classList.add(Y); + } + var I = class { + el; + app; + constructor(e) { + (this.el = e.el), (this.app = e.app); + } + }; + var be = document.head.appendChild(document.createElement('style')); + be.dataset.for = 'filters'; + var le = {}; + function we(t) { + for (let e of t.split(/\s+/)) if (le.hasOwnProperty(e) && !le[e]) return !0; + return !1; + } + var ee = class extends I { + key; + value; + constructor(e) { + super(e), + (this.key = `filter-${this.el.name}`), + (this.value = this.el.checked), + this.el.addEventListener('change', () => { + this.setLocalStorage(this.el.checked); + }), + this.setLocalStorage(this.fromLocalStorage()), + (be.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`), + this.app.updateIndexVisibility(); + } + fromLocalStorage() { + let e = S.getItem(this.key); + return e ? e === 'true' : this.el.checked; + } + setLocalStorage(e) { + S.setItem(this.key, e.toString()), + (this.value = e), + this.handleValueChange(); + } + handleValueChange() { + (this.el.checked = this.value), + document.documentElement.classList.toggle(this.key, this.value), + (le[`tsd-is-${this.el.name}`] = this.value), + this.app.filterChanged(), + this.app.updateIndexVisibility(); + } + }; + var Le = 0; + async function Se(t, e) { + if (!window.searchData) return; + let n = await R(window.searchData); + (t.data = n), (t.index = Ie.Index.load(n.index)), (e.innerHTML = ''); + } + function _e() { + let t = document.getElementById('tsd-search-trigger'), + e = document.getElementById('tsd-search'), + n = document.getElementById('tsd-search-input'), + r = document.getElementById('tsd-search-results'), + i = document.getElementById('tsd-search-script'), + s = document.getElementById('tsd-search-status'); + if (!(t && e && n && r && i && s)) + throw new Error('Search controls missing'); + let o = { base: document.documentElement.dataset.base }; + o.base.endsWith('/') || (o.base += '/'), + i.addEventListener('error', () => { + let a = window.translations.search_index_not_available; + Pe(s, a); + }), + i.addEventListener('load', () => { + Se(o, s); + }), + Se(o, s), + ot({ trigger: t, searchEl: e, results: r, field: n, status: s }, o); + } + function ot(t, e) { + let { field: n, results: r, searchEl: i, status: s, trigger: o } = t; + xe(i, { closeOnClick: !0 }); + function a() { + Ee(i), n.setSelectionRange(0, n.value.length); + } + o.addEventListener('click', a), + n.addEventListener( + 'input', + fe(() => { + at(r, n, s, e); + }, 200) + ), + n.addEventListener('keydown', (l) => { + if (r.childElementCount === 0 || l.ctrlKey || l.metaKey || l.altKey) + return; + let d = n.getAttribute('aria-activedescendant'), + f = d ? document.getElementById(d) : null; + if (f) { + let p = !1, + v = !1; + switch (l.key) { + case 'Home': + case 'End': + case 'ArrowLeft': + case 'ArrowRight': + v = !0; + break; + case 'ArrowDown': + case 'ArrowUp': + p = l.shiftKey; + break; + } + (p || v) && ke(n); + } + if (!l.shiftKey) + switch (l.key) { + case 'Enter': + f?.querySelector('a')?.click(); + break; + case 'ArrowUp': + Te(r, n, f, -1), l.preventDefault(); + break; + case 'ArrowDown': + Te(r, n, f, 1), l.preventDefault(); + break; + } + }); + function c() { + ke(n); + } + n.addEventListener('change', c), + n.addEventListener('blur', c), + n.addEventListener('click', c), + document.body.addEventListener('keydown', (l) => { + if (l.altKey || l.metaKey || l.shiftKey) return; + let d = l.ctrlKey && l.key === 'k', + f = !l.ctrlKey && !ut() && l.key === '/'; + (d || f) && (l.preventDefault(), a()); }); } - function Ve(t, e, n, r) { + function at(t, e, n, r) { if (!r.index || !r.data) return; - e.textContent = ''; - let i = n.value.trim(), + (t.innerHTML = ''), (n.innerHTML = ''), (Le += 1); + let i = e.value.trim(), s; if (i) { - let o = i + let a = i .split(' ') - .map((a) => (a.length ? `*${a}*` : '')) + .map((c) => (c.length ? `*${c}*` : '')) .join(' '); - s = r.index.search(o); + s = r.index.search(a).filter(({ ref: c }) => { + let l = r.data.rows[Number(c)].classes; + return !l || !we(l); + }); } else s = []; - for (let o = 0; o < s.length; o++) { - let a = s[o], - l = r.data.rows[Number(a.ref)], - u = 1; - l.name.toLowerCase().startsWith(i.toLowerCase()) && - (u *= 1 + 1 / (1 + Math.abs(l.name.length - i.length))), - (a.score *= u); + if (s.length === 0 && i) { + let a = window.translations.search_no_results_found_for_0.replace( + '{0}', + ` "${te(i)}" ` + ); + Pe(n, a); + return; } - if (s.length === 0) { - let o = document.createElement('li'); - o.classList.add('no-results'); - let a = document.createElement('span'); - (a.textContent = 'No results found'), o.appendChild(a), e.appendChild(o); + for (let a = 0; a < s.length; a++) { + let c = s[a], + l = r.data.rows[Number(c.ref)], + d = 1; + l.name.toLowerCase().startsWith(i.toLowerCase()) && + (d *= 10 / (1 + Math.abs(l.name.length - i.length))), + (c.score *= d); } - s.sort((o, a) => a.score - o.score); - for (let o = 0, a = Math.min(10, s.length); o < a; o++) { - let l = r.data.rows[Number(s[o].ref)], - u = ``, - d = ce(l.name, i); + s.sort((a, c) => c.score - a.score); + let o = Math.min(10, s.length); + for (let a = 0; a < o; a++) { + let c = r.data.rows[Number(s[a].ref)], + d = ``, + f = Ce(c.name, i); globalThis.DEBUG_SEARCH_WEIGHTS && - (d += ` (score: ${s[o].score.toFixed(2)})`), - l.parent && - (d = ` - ${ce(l.parent, i)}.${d}`); - let y = document.createElement('li'); - y.classList.value = l.classes ?? ''; - let p = document.createElement('a'); - (p.href = r.base + l.url), - (p.innerHTML = u + d), - y.append(p), - e.appendChild(y); + (f += ` (score: ${s[a].score.toFixed(2)})`), + c.parent && + (f = ` + ${Ce(c.parent, i)}.${f}`); + let p = document.createElement('li'); + (p.id = `tsd-search:${Le}-${a}`), + (p.role = 'option'), + (p.ariaSelected = 'false'), + (p.classList.value = c.classes ?? ''); + let v = document.createElement('a'); + (v.tabIndex = -1), + (v.href = r.base + c.url), + (v.innerHTML = d + `${f}`), + p.append(v), + t.appendChild(p); } } - function ue(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 Te(t, e, n, r) { + let i; + if ( + (r === 1 + ? (i = n?.nextElementSibling || t.firstElementChild) + : (i = n?.previousElementSibling || t.lastElementChild), + i !== n) + ) { + if (!i || i.role !== 'option') { + console.error('Option missing'); + return; + } + (i.ariaSelected = 'true'), + i.scrollIntoView({ behavior: 'smooth', block: 'nearest' }), + e.setAttribute('aria-activedescendant', i.id), + n?.setAttribute('aria-selected', 'false'); } } - function Ne(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 ke(t) { + let e = t.getAttribute('aria-activedescendant'); + (e ? document.getElementById(e) : null)?.setAttribute( + 'aria-selected', + 'false' + ), + t.setAttribute('aria-activedescendant', ''); } - function ce(t, e) { + function Ce(t, e) { if (e === '') return t; let n = t.toLocaleLowerCase(), r = e.toLocaleLowerCase(), @@ -1911,68 +2151,92 @@ s = 0, o = n.indexOf(r); for (; o != -1; ) - i.push(K(t.substring(s, o)), `${K(t.substring(o, o + r.length))}`), + i.push( + te(t.substring(s, o)), + `${te(t.substring(o, o + r.length))}` + ), (s = o + r.length), (o = n.indexOf(r, s)); - return i.push(K(t.substring(s))), i.join(''); + return i.push(te(t.substring(s))), i.join(''); } - var He = { + var lt = { '&': '&', '<': '<', '>': '>', "'": ''', '"': '"', }; - function K(t) { - return t.replace(/[&<>"'"]/g, (e) => He[e]); + function te(t) { + return t.replace(/[&<>"'"]/g, (e) => lt[e]); } - var I = class { - constructor(e) { - (this.el = e.el), (this.app = e.app); - } - }; - var F = 'mousedown', - fe = 'mousemove', - H = 'mouseup', - J = { x: 0, y: 0 }, - pe = !1, - ee = !1, - Be = !1, - D = !1, - me = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( + function Pe(t, e) { + t.innerHTML = e ? `
${e}
` : ''; + } + var ct = [ + 'button', + 'checkbox', + 'file', + 'hidden', + 'image', + 'radio', + 'range', + 'reset', + 'submit', + ]; + function ut() { + let t = document.activeElement; + return t + ? t.isContentEditable || + t.tagName === 'TEXTAREA' || + t.tagName === 'SEARCH' + ? !0 + : t.tagName === 'INPUT' && !ct.includes(t.type) + : !1; + } + var D = 'mousedown', + Me = 'mousemove', + $ = 'mouseup', + ne = { x: 0, y: 0 }, + Qe = !1, + ce = !1, + dt = !1, + F = !1, + Oe = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( navigator.userAgent ); - document.documentElement.classList.add(me ? 'is-mobile' : 'not-mobile'); - me && + document.documentElement.classList.add(Oe ? 'is-mobile' : 'not-mobile'); + Oe && 'ontouchstart' in document.documentElement && - ((Be = !0), (F = 'touchstart'), (fe = 'touchmove'), (H = 'touchend')); - document.addEventListener(F, (t) => { - (ee = !0), (D = !1); - let e = F == 'touchstart' ? t.targetTouches[0] : t; - (J.y = e.pageY || 0), (J.x = e.pageX || 0); + ((dt = !0), (D = 'touchstart'), (Me = 'touchmove'), ($ = 'touchend')); + document.addEventListener(D, (t) => { + (ce = !0), (F = !1); + let e = D == 'touchstart' ? t.targetTouches[0] : t; + (ne.y = e.pageY || 0), (ne.x = e.pageX || 0); }); - document.addEventListener(fe, (t) => { - if (ee && !D) { - let e = F == 'touchstart' ? t.targetTouches[0] : t, - n = J.x - (e.pageX || 0), - r = J.y - (e.pageY || 0); - D = Math.sqrt(n * n + r * r) > 10; + document.addEventListener(Me, (t) => { + if (ce && !F) { + let e = D == 'touchstart' ? t.targetTouches[0] : t, + n = ne.x - (e.pageX || 0), + r = ne.y - (e.pageY || 0); + F = Math.sqrt(n * n + r * r) > 10; } }); - document.addEventListener(H, () => { - ee = !1; + document.addEventListener($, () => { + ce = !1; }); document.addEventListener('click', (t) => { - pe && (t.preventDefault(), t.stopImmediatePropagation(), (pe = !1)); + Qe && (t.preventDefault(), t.stopImmediatePropagation(), (Qe = !1)); }); - var X = class extends I { + var re = class extends I { + active; + className; constructor(e) { super(e), (this.className = this.el.dataset.toggle || ''), - this.el.addEventListener(H, (n) => this.onPointerUp(n)), + this.el.addEventListener($, (n) => this.onPointerUp(n)), this.el.addEventListener('click', (n) => n.preventDefault()), - document.addEventListener(F, (n) => this.onDocumentPointerDown(n)), - document.addEventListener(H, (n) => this.onDocumentPointerUp(n)); + document.addEventListener(D, (n) => this.onDocumentPointerDown(n)), + document.addEventListener($, (n) => this.onDocumentPointerUp(n)); } setActive(e) { if (this.active == e) return; @@ -1984,7 +2248,7 @@ setTimeout(() => document.documentElement.classList.remove(n), 500); } onPointerUp(e) { - D || (this.setActive(!0), e.preventDefault()); + F || (this.setActive(!0), e.preventDefault()); } onDocumentPointerDown(e) { if (this.active) { @@ -1993,7 +2257,7 @@ } } onDocumentPointerUp(e) { - if (!D && this.active && e.target.closest('.col-sidebar')) { + if (!F && this.active && e.target.closest('.col-sidebar')) { let n = e.target.closest('a'); if (n) { let r = window.location.href; @@ -2004,142 +2268,279 @@ } } }; - var te; - try { - te = localStorage; - } catch { - te = { - getItem() { - return null; - }, - setItem() {}, + var ue = new Map(), + de = class { + open; + accordions = []; + key; + constructor(e, n) { + (this.key = e), (this.open = n); + } + add(e) { + this.accordions.push(e), + (e.open = this.open), + e.addEventListener('toggle', () => { + this.toggle(e.open); + }); + } + toggle(e) { + for (let n of this.accordions) n.open = e; + S.setItem(this.key, e.toString()); + } + }, + ie = class extends I { + constructor(e) { + super(e); + let n = this.el.querySelector('summary'), + r = n.querySelector('a'); + r && + r.addEventListener('click', () => { + location.assign(r.href); + }); + let i = `tsd-accordion-${ + n.dataset.key ?? + n.textContent.trim().replace(/\s+/g, '-').toLowerCase() + }`, + s; + if (ue.has(i)) s = ue.get(i); + else { + let o = S.getItem(i), + a = o ? o === 'true' : this.el.open; + (s = new de(i, a)), ue.set(i, s); + } + s.add(this.el); + } }; - } - var Q = te; - var ye = document.head.appendChild(document.createElement('style')); - ye.dataset.for = 'filters'; - var Y = class extends I { - constructor(e) { - super(e), - (this.key = `filter-${this.el.name}`), - (this.value = this.el.checked), - this.el.addEventListener('change', () => { - this.setLocalStorage(this.el.checked); - }), - this.setLocalStorage(this.fromLocalStorage()), - (ye.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`), - this.app.updateIndexVisibility(); - } - fromLocalStorage() { - let e = Q.getItem(this.key); - return e ? e === 'true' : this.el.checked; - } - setLocalStorage(e) { - Q.setItem(this.key, e.toString()), - (this.value = e), - this.handleValueChange(); - } - handleValueChange() { - (this.el.checked = this.value), - document.documentElement.classList.toggle(this.key, this.value), - this.app.filterChanged(), - this.app.updateIndexVisibility(); - } - }; - var Z = class extends I { - constructor(e) { - super(e), - (this.summary = this.el.querySelector('.tsd-accordion-summary')), - (this.icon = this.summary.querySelector('svg')), - (this.key = `tsd-accordion-${ - this.summary.dataset.key ?? - this.summary.textContent.trim().replace(/\s+/g, '-').toLowerCase() - }`); - let n = Q.getItem(this.key); - (this.el.open = n ? n === 'true' : this.el.open), - this.el.addEventListener('toggle', () => this.update()); - let r = this.summary.querySelector('a'); - r && - r.addEventListener('click', () => { - location.assign(r.href); - }), - this.update(); - } - update() { - (this.icon.style.transform = `rotate(${this.el.open ? 0 : -90}deg)`), - Q.setItem(this.key, this.el.open.toString()); - } - }; - function ge(t) { - let e = Q.getItem('tsd-theme') || 'os'; + function He(t) { + let e = S.getItem('tsd-theme') || 'os'; (t.value = e), - ve(e), + Ae(e), t.addEventListener('change', () => { - Q.setItem('tsd-theme', t.value), ve(t.value); + S.setItem('tsd-theme', t.value), Ae(t.value); }); } - function ve(t) { + function Ae(t) { document.documentElement.dataset.theme = t; } - var Le; - function be() { + var se; + function Ne() { let t = document.getElementById('tsd-nav-script'); - t && (t.addEventListener('load', xe), xe()); + t && (t.addEventListener('load', Re), Re()); } - async function xe() { + async function Re() { let t = document.getElementById('tsd-nav-container'); if (!t || !window.navigationData) return; - let n = await (await fetch(window.navigationData)).arrayBuffer(), - r = new Blob([n]).stream().pipeThrough(new DecompressionStream('gzip')), - i = await new Response(r).json(); - (Le = t.dataset.base + '/'), (t.innerHTML = ''); - for (let s of i) we(s, t, []); + let e = await R(window.navigationData); + (se = document.documentElement.dataset.base), + se.endsWith('/') || (se += '/'), + (t.innerHTML = ''); + for (let n of e) Be(n, t, []); window.app.createComponents(t), window.app.showPage(), window.app.ensureActivePageVisible(); } - function we(t, e, n) { + function Be(t, e, n) { let r = e.appendChild(document.createElement('li')); if (t.children) { let i = [...n, t.text], s = r.appendChild(document.createElement('details')); - (s.className = t.class - ? `${t.class} tsd-index-accordion` - : 'tsd-index-accordion'), - (s.dataset.key = i.join('$')); + s.className = t.class ? `${t.class} tsd-accordion` : 'tsd-accordion'; let o = s.appendChild(document.createElement('summary')); (o.className = 'tsd-accordion-summary'), + (o.dataset.key = i.join('$')), (o.innerHTML = ''), - Ee(t, o); + De(t, o); let a = s.appendChild(document.createElement('div')); a.className = 'tsd-accordion-details'; - let l = a.appendChild(document.createElement('ul')); - l.className = 'tsd-nested-navigation'; - for (let u of t.children) we(u, l, i); - } else Ee(t, r, t.class); + let c = a.appendChild(document.createElement('ul')); + c.className = 'tsd-nested-navigation'; + for (let l of t.children) Be(l, c, i); + } else De(t, r, t.class); } - function Ee(t, e, n) { + function De(t, e, n) { if (t.path) { let r = e.appendChild(document.createElement('a')); - (r.href = Le + t.path), + if ( + ((r.href = se + t.path), n && (r.className = n), - location.pathname === r.pathname && r.classList.add('current'), - t.kind && - (r.innerHTML = ``), - (r.appendChild(document.createElement('span')).textContent = t.text); - } else e.appendChild(document.createElement('span')).textContent = t.text; + location.pathname === r.pathname && + !r.href.includes('#') && + (r.classList.add('current'), (r.ariaCurrent = 'page')), + t.kind) + ) { + let i = window.translations[`kind_${t.kind}`].replaceAll('"', '"'); + r.innerHTML = ``; + } + r.appendChild(Fe(t.text, document.createElement('span'))); + } else { + let r = e.appendChild(document.createElement('span')), + i = window.translations.folder.replaceAll('"', '"'); + (r.innerHTML = ``), + r.appendChild(Fe(t.text, document.createElement('span'))); + } + } + function Fe(t, e) { + let n = t.split( + /(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/ + ); + for (let r = 0; r < n.length; ++r) + r !== 0 && e.appendChild(document.createElement('wbr')), + e.appendChild(document.createTextNode(n[r])); + return e; + } + var oe = document.documentElement.dataset.base; + oe.endsWith('/') || (oe += '/'); + function $e() { + document.querySelector('.tsd-full-hierarchy') + ? ht() + : document.querySelector('.tsd-hierarchy') && pt(); + } + function ht() { + document.addEventListener('click', (r) => { + let i = r.target; + for (; i.parentElement && i.parentElement.tagName != 'LI'; ) + i = i.parentElement; + i.dataset.dropdown && + (i.dataset.dropdown = String(i.dataset.dropdown !== 'true')); + }); + let t = new Map(), + e = new Set(); + for (let r of document.querySelectorAll( + '.tsd-full-hierarchy [data-refl]' + )) { + let i = r.querySelector('ul'); + t.has(r.dataset.refl) + ? e.add(r.dataset.refl) + : i && t.set(r.dataset.refl, i); + } + for (let r of e) n(r); + function n(r) { + let i = t.get(r).cloneNode(!0); + i.querySelectorAll('[id]').forEach((s) => { + s.removeAttribute('id'); + }), + i.querySelectorAll('[data-dropdown]').forEach((s) => { + s.dataset.dropdown = 'false'; + }); + for (let s of document.querySelectorAll(`[data-refl="${r}"]`)) { + let o = gt(), + a = s.querySelector('ul'); + s.insertBefore(o, a), + (o.dataset.dropdown = String(!!a)), + a || s.appendChild(i.cloneNode(!0)); + } + } + } + function pt() { + let t = document.getElementById('tsd-hierarchy-script'); + t && (t.addEventListener('load', Ve), Ve()); + } + async function Ve() { + let t = document.querySelector('.tsd-panel.tsd-hierarchy:has(h4 a)'); + if (!t || !window.hierarchyData) return; + let e = +t.dataset.refl, + n = await R(window.hierarchyData), + r = t.querySelector('ul'), + i = document.createElement('ul'); + if ( + (i.classList.add('tsd-hierarchy'), + ft(i, n, e), + r.querySelectorAll('li').length == i.querySelectorAll('li').length) + ) + return; + let s = document.createElement('span'); + s.classList.add('tsd-hierarchy-toggle'), + (s.textContent = window.translations.hierarchy_expand), + t.querySelector('h4 a')?.insertAdjacentElement('afterend', s), + s.insertAdjacentText('beforebegin', ', '), + s.addEventListener('click', () => { + s.textContent === window.translations.hierarchy_expand + ? (r.insertAdjacentElement('afterend', i), + r.remove(), + (s.textContent = window.translations.hierarchy_collapse)) + : (i.insertAdjacentElement('afterend', r), + i.remove(), + (s.textContent = window.translations.hierarchy_expand)); + }); + } + function ft(t, e, n) { + let r = e.roots.filter((i) => mt(e, i, n)); + for (let i of r) t.appendChild(je(e, i, n)); + } + function je(t, e, n, r = new Set()) { + if (r.has(e)) return; + r.add(e); + let i = t.reflections[e], + s = document.createElement('li'); + if ((s.classList.add('tsd-hierarchy-item'), e === n)) { + let o = s.appendChild(document.createElement('span')); + (o.textContent = i.name), o.classList.add('tsd-hierarchy-target'); + } else { + for (let a of i.uniqueNameParents || []) { + let c = t.reflections[a], + l = s.appendChild(document.createElement('a')); + (l.textContent = c.name), + (l.href = oe + c.url), + (l.className = c.class + ' tsd-signature-type'), + s.append(document.createTextNode('.')); + } + let o = s.appendChild(document.createElement('a')); + (o.textContent = t.reflections[e].name), + (o.href = oe + i.url), + (o.className = i.class + ' tsd-signature-type'); + } + if (i.children) { + let o = s.appendChild(document.createElement('ul')); + o.classList.add('tsd-hierarchy'); + for (let a of i.children) { + let c = je(t, a, n, r); + c && o.appendChild(c); + } + } + return r.delete(e), s; + } + function mt(t, e, n) { + if (e === n) return !0; + let r = new Set(), + i = [t.reflections[e]]; + for (; i.length; ) { + let s = i.pop(); + if (!r.has(s)) { + r.add(s); + for (let o of s.children || []) { + if (o === n) return !0; + i.push(t.reflections[o]); + } + } + } + return !1; + } + function gt() { + let t = document.createElementNS('http://www.w3.org/2000/svg', 'svg'); + return ( + t.setAttribute('width', '20'), + t.setAttribute('height', '20'), + t.setAttribute('viewBox', '0 0 24 24'), + t.setAttribute('fill', 'none'), + (t.innerHTML = ''), + t + ); } - G(X, 'a[data-toggle]'); - G(Z, '.tsd-index-accordion'); - G(Y, '.tsd-filter-item input[type=checkbox]'); - var Se = document.getElementById('tsd-theme'); - Se && ge(Se); - var je = new U(); - Object.defineProperty(window, 'app', { value: je }); - he(); - be(); + X(re, 'a[data-toggle]'); + X(ie, '.tsd-accordion'); + X(ee, '.tsd-filter-item input[type=checkbox]'); + var qe = document.getElementById('tsd-theme'); + qe && He(qe); + var yt = new Z(); + Object.defineProperty(window, 'app', { value: yt }); + _e(); + Ne(); + $e(); + 'virtualKeyboard' in navigator && + (navigator.virtualKeyboard.overlaysContent = !0); })(); /*! Bundled license information: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 79c530f9..d778cfbf 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1,2 @@ window.navigationData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAE6WWUW/TMBSF/4ufO7oVNqBvU2GjUgtTt4kHxIPn3CRXS+1g31QriP+OkozWcRwnSl97jr/TXDsn/vGHEbwQm7MvRPkaKFURm7CcU8rmDGSxNdOj8ialbcYm7BllxOYf/k4Oq6+fDGku6CvfYcJJ6SNEZNwYMNOWpUm7mDV4BaXniwxB0g0XpPTeA2x5+oi1eaFkjImfZzv6aLcF15EfU0l968u5LiWBFpD7J9Y29THXKioy8KNqrY9wD3qHogPxKvYyiFMXoZT61oMkFJxQyc9ad03GMbWYk9rN5oxMdIbmDF4ItOQZs9JuQYJG0RFjq+P4S7mGrdL7BRepZyINeVzCSgme3ZPSPIGOlJZlXNI65hv4VaCGqGNermNkDhqDMtlArMGkD+oZuo5Bl3Nc7p3Ki3zBpYAs63xEj+mEtAfcgioolGVbxiWFQ07nPxrwcMtfx/Gu89wpECwLMOaifPNfxSZ6dnnlVr1T8jbiIPdBlMbfVcPccc23ppPm+FrYgVVE1Qm+xwwkZftveUn0h3Z4Twv+jpRWR25IsmseF+183QKb5nWG9s9ZsFEFwXC+ZQ+FLJ3GtYBLT9MOHcsyqmbs59baOPBKJaqg0P42HKFHr4uwmlCI17aN++cVZ6USlL1ptmtc2AYi1CCoN89nDJZKjtXJ+gQxSiztRyzt86rfXIfDO//4/uJyZjGrc8af7FtfjToIXsKwKj5esVv3wh3XWNIbF3HvBfHtzFvOPcSGKQDk/+/bN9Yw40KKajemltyEXL1zIE4FdONaxgAYzZAiOvJD/kBMrtUOI6h2woe19Rbm5z91KrDXBg4AAA=='; + 'eJyll0FT2zAQhf+Lz6GBtNA2t04oNDMJMAGmh04PQt7EO9iSKq0zpJ3+947tlNiSLGfE+T1/z9qVV/KPPwnBCyXT5BuRWgJlMk1GiWKUJdMERFmY8UF5l1GRJ6PkGUWaTD/9Hb0+/eXJkGacbtgWN4ykPkB4zowBM3YsXdrZpMMrKTud5QiCrhgnqXceoOMZIjbmmRRr3Ph5bccQDQQhZ4RSfNXau2LX5DBHjTuZJmTSEzQn8EKgBcsTK+26ZDr1Z9TS0NtWXZwLAs1B+fvjmoaYS5mWOfhRjTZEuAe9Rd6D2IuDDGLUR6ik0PNXQDwDTzX2Qly/rkGARt6zLdpqHH8ullBIvZsxnnlW3pHjEhaSs/yepGYb6ElxLHFJyzVbwa8SNaQ99bIdkTloDIrNCtYaTPYgn6Hvs+1zxuXeSVWqGRMc8rx3iR7TG9IesABZUiirbYlLCoe8nf9o4FJJdSMFh54QxxKd5IfHTmulrJGE1UhdM15Npb3YRU/OL+yjyjqk2ohXeQgiNf6uz547pllhemmWz8EeOfSo/lbuMQdB+e5WVUR/aI/3bcHfkbJ6cx+TbJvjoq3zMtA0rzPUP+uBlSwJjue37KGQuTXbW8C5Z6YfW5Z5WtfYz220OPBCbmRJof52HKGlNyO3rlCI59ri3rzmLOQGxWBa2xUXtoIUNXAazPMZg0NFYb2zLmGNAiv7AUs7Vc8322HxTj9/PDuftJj1PmNP7Xtkg3oVvISjCjErDcmivsstUWDB8tuSVElOVI8vPnl/f7S/2CauI8ZntH6AnHv0lmmsatf5TfJeqN9PvEfPALFjCgDZ//+Tq9ZWWZeC13tt3JK7kIsPFsQacP04xxgAozlmzB74IX8gRmm5xRTqTviwbd3B/PwHJDRogw=='; diff --git a/docs/assets/search.js b/docs/assets/search.js index 91da3b01..f892e2aa 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1,2 @@ window.searchData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAE61b227bSBL9F3ofCcfsC2n5LZPszARIdoJkd+dBMAKGaktEaFIgKWcDw/++6CYpVlFVVEvyk5Gwbn1OVd+q9RzU1c8muFs+Bz/ychXcReI2DMr00QR3wdtdu/lq6qc8M0EY7OoiuAuyIm0a07wB36437WMRhMOn4C4IXsLBno7E3l5WlU1b77K2qo/au8LCwHYYbNPalO0kwNFldCPU3mfefKzSVV6u/3Hc5V7222UerZAp2zxLW7Py8os0LvK+a0zt4dKKXTbK1b+rH6Z8V6T5Y+MzRih/kWdT15XPEJ3cRZ7S7fZrm7bGw9kgeqo/caPGeivXf5XvTdPW1a/jHrHw2T6Lap2Xf+ft5otZ5bXJ2uOeKZXL/X+utrvtCc4H+Us8Vzu/4XZyZ3tam/ZtlpmmcSXwNS9M2RYeFLN6rxTJCbDzimfHsknLVWGGHHqXFsX3NPtxPBRW76Q6nyxzn6rVrqBXue7T7CKHxvVQ1V+qik4sYOtqlOMD78M6bzmFznxX0wOHU6D+2KX1inTnvrzaXmC05h17FxrDSpaWdnE/6msvdr6ft1mbP6UtnU3YFxC93N+7TV74DHAq7+95mgx/tu32Q9maOjNbjsiJzKslCGXXO1WmgTPg5oOIfwRQ5Rz/MdxITsS+VLvWvKvKh3y9D+hhV2ZtXpXNmznxWdTH8VoDn0y7qcY0MuXusXkzfpi1FMV7U3+Ydt7GVSdBYwQCIa1/rppj5nuRM+3vjpqf2RIctZ622eaY/V7mPA/vTWHABES72Aud5+NPkx5Jk6te5AT74maRRHqcBd5uc5fG781DXuY20fcu219bW4gHAvMrtY5RtoNymRSWK+SHNDPdsA4E5wsBHSOKovppVh9zkLNe1q+wJg/j4Si8RkzNJ3xgvtMJPo7W+Rmmrzo1rwHDQfBBfLLlZOozYxm1Lwgp1lqOVHz7ZvP3sniu90ZODesaDIoBrbUb/b+2bm05J8yJ/mtxuTlcok4ICmm/VkiuSt+WVfnrsdqdhdWBhQtCg/Vutxp8fY9f/eu5+ZFv2SMbb/uK0eN3SMezgNp4zkRwqHKuc3ex9DltNz5uofAJDhGL/d0S6a7/5s9gm9ZrQy5EyNbVXo6JeghqdCMFkXjT++OntM7T7wVCyuceeXr0eFfkpmwnyQ1351Dg1Q4dB0a9TxwoXua40Rj6oHHotZljxtPb2tvbbB7w3qaU3XRyv6cWLPr6C4v437lktbEHWqfsa/hqosSPbxL4ealDRuCZPGwAk5Lr5eZrDgudVHR4GkI3dEcnoZMaQeM05N0GmkxGJzWBRne+LaB5bz4NIOjzlPbPnOeZ5s/ozqP1Mzs6j8YPGNsJbZ85r3NNn9GbT8tn4mU6AX8YEuCYr4nsmR5r81CbZnPM2Sh2/sjA/b3H2LD0+V7/aSnx8DfIneAJbJGGreVH2x2aObRQct73BR9dI2jGOhKYNQtu+bZ19ZSvjJuZiVs9+NnXZDpc3f5eEhbB11MMTg4frOkDOf8V5nvT1mnW/it9ytcpuTZMJV5nxSGt+q08ByFzrd1OwPz26z914RvBVMk7hvswyMuV+V9w9xw8mbqx12Z3gbiW14sgDB5yU6zsm48uuDDIqsdHa+u+//ZfYwdtJTqRNzdBuLwJ5eI6Vvf34XJQcP/v/sNJRUG4jEIhrsUCi0VITAThUoRSXWspkJhAYjIIl5ISk0hMBeFSUWIKiekgXGpKTCOxOAiXMSUWI7EkCJcJJZYgsdsgXN4SsN0iqUUQLheE1AKDa7GOKBKiCQuOhogSxDxEFu9IUIKYicgiHklKEHMRWcwjRQliNiKLeqQpQcxHZHGPYkoQMxIlbPJhTiILfpRQFjEt0YK1iJkRjhmKZ4GZEY4ZimoxqRBXIhTXAjMjLP6C4lpgZoTiBiMwM8LiL6ikEJgZYfEXVFIIzIyw+AuyRAWmRlgCBFmlAnMjLAOCSguBuZGWAUGxLTE30jIgKBIl5kY6bigS5WT+chMYRaLE3EjLgKRIlJgbaRmQFDcScyMtA5LiRmJupCVAUgUrMTXS4i+pgpWYGWnxlxQzEjOjLP6SYkZhZpTFX1LMKMyMEmyiKUyNctRQHKrJ4uJWF4pDhalRlgBFcagwNcoSoCgOFaZGWQIUxaHC1KhbbjFSmBplCVAU2QpToy0BiiJbY2q0JUBRZGtMjRbc9KMxM9rir6is0JgZrdi5Qk9WfkcNlT8aU6MdNVRWaEyNZtcajanRlgBNpY/G1GhLgKbSR2Nq4hvOdYypiSNulxVjamLB7bNiTE0suZ1WjKmJFbfXijEzsWZ3W5NdmcVfU0UTY2Zii7+miibGzMSOGaoWYsxM7JihaiHGzCQWf03VQoKZSSz+mkrxBDOTWPw1lbgJZiax+GsqcRPMTGLxj6l8TDAziWOGyscEM5PEXD4mkx2zxT+mKEw6ZtyR5cnUrVl96I4uy+W+SfocfOvPMzIZjlTPgboJ7p5fXsbzi/2XNZ32J6JyPEiOFuJotJBozoJtyKVjQw4EsAAByDl1sypc3x7oylFXxpzuNq9tY28FXjwAEyB6qVgT26a7qR0VAW6JFQwDdcup27uGzF0SPwx39aOh8VD7HGgWv9FEM1xGjyb0DTAxF0VnIeubPCCGGBiI5gwcqgLfigVwr0pErzRwzqbgrt2su6eSo2YESIjmxu00HxDxGuRdwubdrt3YPmcO+5yjDQGSR5xgA0cSAwSTOQQf+ze1AAAAXTSXOwTswOsc6AeJr8Gg9YLRzNIy3T/FBPEC0AWXZ0A3615UAsRB1ELwBgr35hQ4BkUmuOGiCyqgCzDuKj3qKz5adH+F6v5q0f/tv8c33d+Em5u6jlnWd8xASQCcNKe86p+bAXSAmuTQMd3FMMi/USnu4+ZSyeluXfMdBAtmYZUwmg9VXbvH2QBX4DjiBulapWCEIOHFbY82VzNr06bu1t09nWn2z/1BCAKEwAGGzfzM2822e6oP7AAIIm4i6N7Z1/2NebZ/tAHMKGCGG9XG4NSWoCQk65ufxBTAQHE0TPQPlwEJrEgufSZW3LJMmAIoSC6frKnH/uERSA+gKoZlmeM1XzlCM9dKQzMcKL6+IDgywOtkEAXAQnBY5E0Km5QIADD+3j87hsYPUwFsCo7kvCmG9hvQBIp9MNzE7X5KRNcHyNGIm3736vX+Z1CjBTCzcWvO8Lsi4BZO3TNRV7u2GrpQIA3gFo/THloK33/ZDgScVQFwCZfF5boqV8NvzkZdsFhxu5pt95wZ8ASUJBfttsIbaAGmYMHh2nfM0q6hBvABHhMuQbeYEQEwlVwiDPy7hKCIAVEnvJG+wwv0QBHEHCUNXnAUCFhzs2uDVgjkEkxIMcdlY9qDRVmDSSjmmGlMS9asBrkXc9VuXxDOLUYKFI/iZrHhURtQAyNWXOAOJ4JZCVJKcUns3jIDHYCU5CDe1fnj8OYYqIJEklys9nkHGiAIsZ8Qyby4D4NtvjVFXprgbnn/8vJ/CnfJxhs+AAA='; + 'eJytnFtv2zoSx7+Luo9Cal5l563bbs8p0J5TtHt5MIKFKjOxUEUSJDlniyDffUFdrBmRkseOn1zEM/8ZDn+8iKb6HFTFX3Vwu30Ofqb5Lrhdh0EeP5rgNvi9acovptkXuyAMDlUW3AYmPzzWb8cvbvbNYxaEQZLFdW3q4DYIXsJBiemj1AeTmcYsy7zZDUZALQzKuDJ5g9PxxvjNNCcCPLQWl6n/buITZXiz70wu0/8aN8n+RICyt7kwQlGfKlDZmVyofzgpfzhXnY80vvtRN1WcNH/ET+lD3BTVMVgv+NaxWKRTMX7UToq8bqpDQld9g138bXJTHsPzlRzblncG5u+//lVl1AwGpx+/DlV2UQ6ovIdmv3qfpSZvPsa2Vb/cPByT6xTYL0ursJv1TImTysSN6UzpKbROyeB0QQ7TEnd274v8Pn3wpgENrlZeR5RcXJTvTGkfjL+ibtSlCZgarSZHqy+LNu2y3w5xtfOGbL+5WieNauTe6VKbIz7O3yVN+hSDhXcuXpzHo+nr473fp9mpksGgSW9/eeTPRUwJmBULS7QvzhQGu0x9yhtTJaac68iJzdUA8emSUZkmPlPKdDChZwBdLok/LfGXYnfI/Mh2X12toECOXMc+u5ny3RfVt6LwFw9Guy+qqrM7I9K0UN9N9ZQm/kr1312tVFCPXKshQdCEFZfHmHFZfm/ixvztdMS4LOvm1Ox0IpypqqIixGrtXhMo3f2z+Gny91mcPtaEgOmusfZJa/+qwLU1MnmTJnFjdpTQdQw9XhfczsFp/kAKm3W2rwl4qA2lO63ZmWE8G8ePpkn2hjI2WvP7o/nFcR9Mbqq4MR/KovxaFcX96diDy64syrJ3eUX85l2SmLpuYf6eZiZvMv9DwSSJJm79Wqjr0e9KmfwnbfZfi/JQnpvKX2mzL3vH1+RiO+SPIidMvDYB2xd5b31x1H2c7zLzzezSyiTN+zjLfsTJz9PxO7+q90tGv4szyYqH9JwuaO2vUvlj5KEMZwSvRpfXxC8OtKDFwjkHIVL+8Gf+wdRNVRCGW/5Q5Luj8cUx67O4ri/n2tnENHPPJ+0319vAHNXo25c2tQt2E2Mowl5iKQhlJzEGO2MfsRiUtIsAYc/ZQywHXt5BwJCk/cNSsIXdwxjn9N5hEgKNqcrcV6benwoyml0Yp0br46lwNVoUXxX1Hz3dp+KdPwqmkT4NaBCiXQYHV+NJ9rv+weQYrH3EvY8TG6//bvmXD0haE1fwhGxO683RbibpIamZnO2BFj5WhJGO39Lzbnvta9zsCYLdRFd2xgsnbs5ZGwy4nzlbWQhrXVLkcmnw+mdazm6wFjKwfmdtsNzTTdCLk1OS+Q71GtL7Ns6y4i+z+5zWXjDn1d/0nll64pcitxWkFn8rDo0hNxtYn9n2d3mR/3osDvUFUboaxECBVAbYtIURMPnF9Yy0rPfj4H2tlNpV4s+ySYv8olq1/sXR/1ppHar0kmw6tysm8SXG5wLn5fIYLx8TkFKCo+lz+/Cx0F3IYHHMQNlhYvxsH6gW1H12y0FWm4gpDlbetG3kB3Of5qn1P4ZpfpXtkjk1WNQXHC2Q/c9004PTp7hK4x8Z/iGQcoI6ke+6Zlkd2SyKazBlDb9MfBzrcX/Ik7bAb8G35whO4JqVduyoQdKaMLmPsZbMqSHLqnhKd6btRk8I+LVP8i4M0nxn/hfcPgdPpqotf7cBvxE3myAM7lOT7exVmS5aGCTF42P3y/CuSA7tP+96s38b+3hpjTvrt6sg3K5CIW82K3l3F24H5/aL9g+DxviX1pEF4ZaFcnWzYgI5MseRIUcehFvui8gdR44cRRBuhS+icBwFcpRBuJU+R+k4SuSognCrfI7KcVTIUQfhVvscteOokWMUhNvI5xg5jhFyXAfhdh1yfqN1hBzXjuMaOW6CcLvxRdw4jhsMgOWBrbwIuPCwCT1sLl/m4QcDxCwWzM+eyxDDEDGLBuNeZ5cjhkFicjZrFyWGWWJqjnvm0sQwTsxCwrzsM5cohpFiFhTm5Z+5VDGMFZvlirlgMUwWs7ww7/hhLlwM08VburxjiLt0cUwXbycn7zjiLl58Mj+1eK29zp4pCuPFxVy9uEsXx3RxCwzzjkXu4sUxXrzFyzsaucsXx3xxPZu1ixfHeHELDPeORu7ixTFe3BLDvaORu3xxzBffzGbt4sUxXsICw4VvOAoXL4HxEhYYLr3OLl4C4yXa9U95nV28xGQJtMRw7XX2rIKYL2GJ4ZHX2eVLYL5Ey9fa6+zyJTBfwiLDvWQLFzCBARMWGeElW7iACQyYsMgIL53CBUxgwIRlRnjpFC5hAhMmLTPCO2dLlzCJCZOWGeHfs7iESUyYtMwI77wrXcIkJky2uyzvvCtdwuRko2WZEd55V3r2WpgwaZkR3nlXuoRJTJi0zAgvYdIlTGLCpGVGegmTLmESEyZnV0jpAiYxYHIzO5FIFzCJAVOr2YlEuYApDJhisxOJcgFTGDDFZycS5QKmMGBKzE4kygVMYcBUu5X3DmflAqYmu3mLjPQOZ+XZ0GPAlEVGeoezcgFTGDDVAuYdzsoFTGHA1Hp2qVIuYQoTpiwz0v8M4xKmMGHaMiP9zzEuYRoTpi0z0jsXaJcwjQnTlhnpnQu0S5jGhGnLjPTOBdolTGPCtGVGeecC7RKmMWG6fWD04qldwvTkmdEyo7x4as9jIyZMW2aUF0/tEqYxYXo9dwigXcA0BkxbZJQXbe0CpjFgkUVGeemMXMAiDFhkkVFeOiMXsAgDFllklP9J2wUswoBFFhnlpTNyAYswYFELmJfOyAUswoBFFhntpTNyAYswYFF7KuGlM3IBiyYHExYZ7aUz8pxNYMAiy4z20hm5hEWYsMgyo72ERS5hESZsbZnRXsLWLmH9n9rjtidTNWb3qTt2226DuH9hJR/f83kO/tsfy0XDSd9zEAW3zy8v4yHc7fMLOIez39mQ059qRiklRi19htjw2xdQYkBJ0ZTKtLKnmztwzg0EN6CZkig4XJAdZThooVh1jmpNk7MnpN17L/fD20CjMFuNwmx1rmA9nI+PghoIRsQKHpp9p5f0B8ogPw7yE3Q5R0hq0LP0hnZCvnYCUiJN1nvo3kABDZSggUR2B517hJoGpYroSs7v7iC39ajI+aWKkywByRGd4Mf+TQIwJABonA6apys5KBynp+QMUgkykrQOQG/rgMIrAMXmXKX+FRwgB9jnNPaPL9gAFTBjc0ZTgdfzRiWA1brzZKz/lP1n/3cu+k/df266T0nrJvzSH2gKGLyMBvbkMjigB8zwgjYRDG9Hg4RAPiSJ/h4WSAPMI6KvpqShAy78AJhBb2taTsc3YUBWoGGcNiQ8N99HPQGGmKDq4YxAQj1rtMlj7jI8SA40VtAAnb3WDlRBxoLWofiuOpACc6+kzQNz186BKABP0kDp3q4HEqCFNIH5NUuCyUXThvZEzd07KECdpm3iJprtDtEjDPpW0+YOeDNoFAIJ9rtDTQNwctEYjBOwBIl+pCgaM+AtQjDDgWmS02ro3EYG2YEVTfRrhKLBl9a0vtGA64g27sB1VZAqmEhFv7wpGpjTNy7AiAG9I88UG9+gAHqgnpI2BoeXI4AIaKmkdXEncrxTBkYGfDykNXDynyiMWoA8Wj+iFzFA+8DUImmLRv/ffIDpCUjQFIrJE+ooQEyhuygTd/doAN9AaU0b2CXub/hERfIfyGtR9HU6KHBEo/B44x6UGCzDilbkGu8RGFiQGK1p06v4IB0wxytal9Vz6zcgWZLzcraKEjRPkWW8k5sEPCvafsx/yxpIgkZqGgTDdXsgAocJbdDj260AStBETZNqr6YCBZBMRBtp8EIpEAIjLqKtdt1rL2A1AkNMqH41IlT5LgzKtDRZmpvgdnv38vJ/YcJJkQ=='; diff --git a/docs/assets/style.css b/docs/assets/style.css index bcb7d05c..200ca34d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,99 +1,282 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} +@layer typedoc { + :root { + --dim-toolbar-contents-height: 2.5rem; + --dim-toolbar-border-bottom-width: 1px; + --dim-header-height: calc( + var(--dim-toolbar-border-bottom-width) + + var(--dim-toolbar-contents-height) + ); + + /* 0rem For mobile; unit is required for calculation in `calc` */ + --dim-container-main-margin-y: 0rem; + + --dim-footer-height: 3.5rem; + + --modal-animation-duration: 0.2s; + } + + :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --light-color-background-active: #d6d8da; + --light-color-background-warning: #e6e600; + --light-color-warning-text: #222; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-background-active); + --light-color-text: #222; + --light-color-contrast-text: #000; + --light-color-text-aside: #5e5e5e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + } -@media (prefers-color-scheme: light) { :root { + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --dark-color-background-active: #5d5d6a; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: var(--dark-color-background-active); + --dark-color-text: #f5f5f5; + --dark-color-contrast-text: #ffffff; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + :root[data-theme='light'] { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); --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-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -105,6 +288,7 @@ --color-ts-constructor: var(--light-color-ts-constructor); --color-ts-property: var(--light-color-ts-property); --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); --color-ts-call-signature: var(--light-color-ts-call-signature); --color-ts-index-signature: var(--light-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -116,26 +300,40 @@ --color-ts-get-signature: var(--light-color-ts-get-signature); --color-ts-set-signature: var(--light-color-ts-set-signature); --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } -} -@media (prefers-color-scheme: dark) { - :root { + :root[data-theme='dark'] { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); --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-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -147,6 +345,7 @@ --color-ts-constructor: var(--dark-color-ts-constructor); --color-ts-property: var(--dark-color-ts-property); --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); --color-ts-call-signature: var(--dark-color-ts-call-signature); --color-ts-index-signature: var(--dark-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -158,1249 +357,1262 @@ --color-ts-get-signature: var(--dark-color-ts-get-signature); --color-ts-set-signature: var(--dark-color-ts-set-signature); --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } -} - -html { - color-scheme: var(--color-scheme); -} -body { - margin: 0; -} + html { + color-scheme: var(--color-scheme); + @media (prefers-reduced-motion: no-preference) { + scroll-behavior: smooth; + } + } -:root[data-theme='light'] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var(--light-color-ts-constructor-signature); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } -:root[data-theme='dark'] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var(--dark-color-ts-constructor-signature); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} + dl, + menu, + ol, + ul { + margin: 1em 0; + } -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} + dd { + margin: 0 0 0 34px; + } -.uppercase { - text-transform: uppercase; -} + .container { + max-width: 1700px; + padding: 0 2rem; + } -dl, -menu, -ol, -ul { - margin: 1em 0; -} + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: var(--dim-footer-height); + } + footer > p { + margin: 0 1em; + } -dd { - margin: 0 0 0 40px; -} + .container-main { + margin: var(--dim-container-main-margin-y) auto; + /* toolbar, footer, margin */ + min-height: calc( + 100svh - var(--dim-header-height) - var(--dim-footer-height) - 2 * + var(--dim-container-main-margin-y) + ); + } -.container { - max-width: 1700px; - padding: 0 2rem; -} + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', + Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji'; + font-size: 16px; + color: var(--color-text); + margin: 0; + } -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -.tsd-generator { - margin: 0 1em; -} + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target='_blank'] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + :target { + scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); + } -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} + code, + pre { + font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } -@keyframes fade-in { - from { + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } - to { + pre:hover > button, + pre > button.visible, + pre > button:focus-visible { opacity: 1; } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } - to { - opacity: 0; + + img { + max-width: 100%; } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } - 33% { - opacity: 0; + + *::-webkit-scrollbar { + width: 0.75rem; } - 100% { - opacity: 1; + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } - 66% { - opacity: 0; + + dialog { + border: none; + outline: none; + padding: 0; + background-color: var(--color-background); } - 100% { - opacity: 0; + dialog::backdrop { + display: none; } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); + #tsd-overlay { + background-color: rgba(0, 0, 0, 0.5); + position: fixed; + z-index: 9999; + top: 0; + left: 0; + right: 0; + bottom: 0; + animation: fade-in var(--modal-animation-duration) forwards; } - to { - transform: translate(0, 0); + #tsd-overlay.closing { + animation-name: fade-out; } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; + + .tsd-typography { + line-height: 1.333em; } - to { - transform: translate(100%, 0); + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', - Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji'; - font-size: 16px; - color: var(--color-text); -} -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target='_blank'] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } -code, -pre { - font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} + .tsd-breadcrumb { + margin: 0; + margin-top: 1rem; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: ' / '; + } -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: ' '; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: ' / '; -} + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type='checkbox'] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type='checkbox']:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type='checkbox']:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: ' '; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type='checkbox'] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type='checkbox']:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type='checkbox']:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type='checkbox']:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown='false'] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown='false'] ~ ul { + display: none; + } -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; } -} -@media (max-width: 768px) { .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } -.tsd-anchor { - position: relative; - top: -100px; -} + .tsd-anchor { + position: relative; + top: -100px; + } -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 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; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type='checkbox'] + .tsd-widget:before { - background-position: -120px 0; -} -input[type='checkbox']:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} + .tsd-navigation.settings { + margin: 0; + margin-bottom: 1rem; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + color: var(--color-contrast-text); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > summary > svg { + margin-right: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 30px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} + #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; + } -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + display: flex; + align-items: center; + gap: 0.25rem; + box-sizing: border-box; + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + /* + * We need to be careful to target the arrow indicating whether the accordion + * is open, but not any other SVGs included in the details element. + */ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-summary { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + display: flex; + align-content: center; + } -*::-webkit-scrollbar { - width: 0.75rem; -} + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; + #tsd-search[open] { + animation: fade-in var(--modal-animation-duration) ease-out forwards; + } + #tsd-search[open].closing { + animation-name: fade-out; } - .container-main { + /* Avoid setting `display` on closed dialog */ + #tsd-search[open] { display: flex; + flex-direction: column; + padding: 1rem; + width: 32rem; + max-width: 90vw; + max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); + /* Anchor dialog to top */ + margin-top: 10vh; + border-radius: 6px; + will-change: max-height; } - html .col-content { - float: none; - max-width: 100%; + #tsd-search-input { + box-sizing: border-box; width: 100%; + padding: 0 0.625rem; /* 10px */ + outline: 0; + border: 2px solid var(--color-accent); + background-color: transparent; + color: var(--color-text); + border-radius: 4px; + height: 2.5rem; + flex: 0 0 auto; + font-size: 0.875rem; + transition: border-color 0.2s, background-color 0.2s; + } + #tsd-search-input:focus-visible { + background-color: var(--color-background-active); + border-color: transparent; + color: var(--color-contrast-text); } - html .col-sidebar { - position: fixed !important; + #tsd-search-input::placeholder { + color: inherit; + opacity: 0.8; + } + #tsd-search-results { + margin: 0; + padding: 0; + list-style: none; + flex: 1 1 auto; + display: flex; + flex-direction: column; overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; + } + #tsd-search-results:not(:empty) { + margin-top: 0.5rem; + } + #tsd-search-results > li { background-color: var(--color-background); - transform: translate(100%, 0); + line-height: 1.5; + box-sizing: border-box; + border-radius: 4px; } - html .col-sidebar > *:last-child { - padding-bottom: 20px; + #tsd-search-results > li:nth-child(even) { + background-color: var(--color-background-secondary); } - html .overlay { - content: ''; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; + #tsd-search-results > li:is(:hover, [aria-selected='true']) { + background-color: var(--color-background-active); + color: var(--color-contrast-text); + } + /* It's important that this takes full size of parent `li`, to capture a click on `li` */ + #tsd-search-results > li > a { + display: flex; + align-items: center; + padding: 0.5rem 0.25rem; + box-sizing: border-box; + width: 100%; + } + #tsd-search-results > li > a > .text { + flex: 1 1 auto; + min-width: 0; + overflow-wrap: anywhere; + } + #tsd-search-results > li > a .parent { + color: var(--color-text-aside); + } + #tsd-search-results > li > a mark { + color: inherit; + background-color: inherit; + font-weight: bold; + } + #tsd-search-status { + flex: 1; + display: grid; + place-content: center; + text-align: center; + overflow-wrap: anywhere; + } + #tsd-search-status:not(:empty) { + min-height: 6rem; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; + font-size: 14px; + overflow-x: auto; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-signature-type { + font-style: italic; + font-weight: normal; } - .has-menu body { - overflow: hidden; + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; } - .has-menu .overlay { - visibility: visible; + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } + + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } + + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: var(--dim-toolbar-border-bottom-width) var(--color-accent) + solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + } + .tsd-toolbar-contents { display: flex; - flex-direction: column; + align-items: center; + height: var(--dim-toolbar-contents-height); + margin: 0 auto; + } + .tsd-toolbar-contents > .title { + font-weight: bold; + margin-right: auto; + } + #tsd-toolbar-links { + display: flex; + align-items: center; gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + margin-right: 1rem; } - .has-menu .tsd-navigation { - max-height: 100%; + + .tsd-widget { + box-sizing: border-box; + display: inline-block; + opacity: 0.8; + height: 2.5rem; + width: 2.5rem; + transition: opacity 0.1s, background-color 0.1s; + text-align: center; + cursor: pointer; + border: none; + background-color: transparent; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget:active { + opacity: 1; + background-color: var(--color-accent); + } + #tsd-toolbar-menu-trigger { + display: none; } -} -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: 'sidebar content'; - margin: 2rem auto; + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - .col-sidebar { - grid-area: sidebar; + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + vertical-align: middle; } - .col-content { - grid-area: content; - padding: 0 1rem; + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg, + .tsd-anchor-icon:focus-visible svg { + visibility: visible; } - .site-menu { - margin-top: 1rem; + + .deprecated { + text-decoration: line-through !important; } -} -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: 'sidebar content toc'; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } - .col-sidebar { - display: contents; + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); } - .page-menu { - grid-area: toc; - padding-left: 1rem; + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); } - .site-menu { - grid-area: sidebar; + + /* mobile */ + @media (max-width: 769px) { + #tsd-toolbar-menu-trigger { + display: inline-block; + /* temporary fix to vertically align, for compatibility */ + line-height: 2.5; + } + #tsd-toolbar-links { + display: none; + } + + .container-main { + display: flex; + } + .col-content { + float: none; + max-width: 100%; + width: 100%; + } + .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + .col-sidebar > *:last-child { + padding-bottom: 20px; + } + .overlay { + content: ''; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } } - .site-menu { - margin-top: 1rem 0; + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: 'sidebar content'; + --dim-container-main-margin-y: 2rem; + } + + .tsd-breadcrumb { + margin-top: 0; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - 2 * + var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc(var(--dim-header-height) + var(--dim-container-main-margin-y)); + } + .site-menu { + margin-top: 1rem; + } } - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: 'sidebar content toc'; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 0rem; + } + + .page-menu, + .site-menu { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - 2 * + var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc(var(--dim-header-height) + var(--dim-container-main-margin-y)); + } } } diff --git a/docs/classes/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index 56713b3f..1158fcee 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
-
-
@@ -68,7 +93,7 @@

Class AbstractNavigator

  • Defined in projects/auth0-angular/src/lib/abstract-navigator.ts:8
    • @@ -76,28 +101,29 @@

    Class AbstractNavigator

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -106,10 +132,12 @@

    Constructors

    Methods

    - + navigateByUrl @@ -119,278 +147,325 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    -
    +
    +
    +

    Parameters

    +
      +
    • + location: + Location_2 +
      • +
    • + injector: + Injector +
      • +
    +
    +

    + Returns + AbstractNavigator - - - - - +

    + +
    + + + - -
    -

    Methods

    -
    - -

    - navigateByUrl - -

    -
      -
    • - navigateByUrl(url): void +
      + + +

      Methods

      +       +
      +
      +
      • -
    • -
      -

      - Navigates to the specified url. The router will be used if - one is available, otherwise it falls back to - window.history.replaceState. -

      -
      -
      -

      Parameters

      -
        -
      • - url: - string -
        -

        The url to navigate to

        -
        -
        -
        • -
      -
      -

      - Returns void -

      -
      - -
      • -
    + +
      +
    • + +
      +
      +

      + Navigates to the specified url. The router will be used + if one is available, otherwise it falls back to + window.history.replaceState. +

      +
      +
      +

      Parameters

      +
        +
      • + url: + string +
        +

        The url to navigate to

        +
        +
        • +
      +
      +

      + Returns void +

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -399,39 +474,81 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - navigateByUrl +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/Auth0ClientFactory.html b/docs/classes/Auth0ClientFactory.html index d9b05435..a0eff6eb 100644 --- a/docs/classes/Auth0ClientFactory.html +++ b/docs/classes/Auth0ClientFactory.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -68,7 +93,7 @@

    Class Auth0ClientFactory

  • Defined in projects/auth0-angular/src/lib/auth.client.ts:6
    • @@ -76,28 +101,29 @@

    Class Auth0ClientFactory

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -106,10 +132,12 @@

    Constructors

    Methods

    - + createClient @@ -119,243 +147,282 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    - + new + Auth0ClientFactory(): + Auth0ClientFactory +
    +
    +

    + Returns + Auth0ClientFactory +

    +
    + + + - -
    -

    Methods

    -
    - -

    - Static - createClient - -

    - + + +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -364,39 +431,81 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - createClient +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthClientConfig.html b/docs/classes/AuthClientConfig.html index 2ec45115..310eed1c 100644 --- a/docs/classes/AuthClientConfig.html +++ b/docs/classes/AuthClientConfig.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -73,9 +98,19 @@

    Class AuthClientConfig

    -

    Usage

    - 
    // app.module.ts
    // ---------------------------
    import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

    // Provide an initializer function that returns a Promise
    function configInitializer(
      http: HttpClient,
      config: AuthClientConfig
    ) {
      return () =>
        http
          .get('/config')
          .toPromise()
          .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
    }

    // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
    imports: [
      // other imports..

      HttpClientModule,
      AuthModule.forRoot(),   //<- don't pass any config here
    ],
    providers: [
      {
        provide: APP_INITIALIZER,
        useFactory: configInitializer,    // <- pass your initializer function here
        deps: [HttpClient, AuthClientConfig],
        multi: true,
      },
    ],
-
    +
    + + 
    // app.module.ts
    // ---------------------------
    import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

    // Provide an initializer function that returns a Promise
    function configInitializer(
      http: HttpClient,
      config: AuthClientConfig
    ) {
      return () =>
        http
          .get('/config')
          .toPromise()
          .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
    }

    // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
    imports: [
      // other imports..

      HttpClientModule,
      AuthModule.forRoot(),   //<- don't pass any config here
    ],
    providers: [
      {
        provide: APP_INITIALIZER,
        useFactory: configInitializer,    // <- pass your initializer function here
        deps: [HttpClient, AuthClientConfig],
        multi: true,
      },
    ],
+
    +
    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -121,13 +157,21 @@

    Constructors

    Methods

    - + get - + set @@ -137,334 +181,371 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    -
    +
    +
    +

    Parameters

    + +
    +

    + Returns + AuthClientConfig - - - - - +

    + +
    + + + - -
    -

    Methods

    -
    - -

    - get - -

    - -
    -
    - -

    - set - -

    -
    + + + +
    + + +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -473,43 +554,89 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - get - set +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthGuard.html b/docs/classes/AuthGuard.html index 6205a335..7c45ec87 100644 --- a/docs/classes/AuthGuard.html +++ b/docs/classes/AuthGuard.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -68,7 +93,7 @@

    Class AuthGuard

  • Defined in projects/auth0-angular/src/lib/auth.guard.ts:15
    • @@ -76,26 +101,29 @@

    Class AuthGuard

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -104,20 +132,30 @@

    Constructors

    Methods

    - + canActivate - + canActivateChild - + canLoad @@ -127,432 +165,491 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    -
    +
    +
    +

    Parameters

    + +
    +

    + Returns + AuthGuard - - - - - +

    + +
    + + + - -
    -

    Methods

    -
    - -

    - canActivate - -

    -
      -
    • - canActivate(next, - state): Observable<boolean> +
      + + +

      Methods

      +       +
      +
      +
      • -
    • -
      -

      Parameters

      -
        -
      • - next: - ActivatedRouteSnapshot -
        • -
      • - state: - RouterStateSnapshot -
        • -
      -
      -

      - Returns Observable<boolean> -

      - -
      • -
    -
    -
    - -

    - canActivateChild - -

    -
      -
    • - canActivateChild(childRoute, - state): Observable<boolean> +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + next: + ActivatedRouteSnapshot +
          • +
        • + state: + RouterStateSnapshot +
          • +
        +
        +

        + Returns Observable<boolean> +

        + +
        +
        • +
      +
    +
    +
    -
    - -

    - canLoad - -

    -
      -
    • - canLoad(route, - segments): Observable<boolean> +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + childRoute: + ActivatedRouteSnapshot +
          • +
        • + state: + RouterStateSnapshot +
          • +
        +
        +

        + Returns Observable<boolean> +

        + +
        +
        • +
      +
    +
    + +
      +
    • + +
      +
      +

      Parameters

      +
        +
      • + route: + Route +
        • +
      • + segments: + UrlSegment[] +
        • +
      +
      +

      + Returns Observable<boolean> +

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -561,47 +658,97 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - canActivate - canActivateChild - canLoad +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthHttpInterceptor.html b/docs/classes/AuthHttpInterceptor.html index 8618e324..51d6c900 100644 --- a/docs/classes/AuthHttpInterceptor.html +++ b/docs/classes/AuthHttpInterceptor.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -74,7 +99,7 @@

    Implements

  • Defined in projects/auth0-angular/src/lib/auth.interceptor.ts:40
    • @@ -82,28 +107,29 @@

    Implements

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -112,10 +138,12 @@

    Constructors

    Methods

    - + intercept @@ -125,326 +153,403 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    -
    +
    +
    +

    Parameters

    + +
    +

    + Returns + AuthHttpInterceptor - - - - - +

    + +
    + + + - -
    -

    Methods

    -
    - -

    - intercept - -

    -
      -
    • - intercept(req, - next): Observable<HttpEvent<any>> +
      + + +

      Methods

      +       +
      +
      +
      • -
    • -
      -

      Parameters

      -
        -
      • - req: - HttpRequest<any> -
        • -
      • - next: - HttpHandler -
        • -
      -
      -

      - Returns Observable<HttpEvent<any>> -

      - -
      • -
    + +
      +
    • + +
      +
      +

      Identifies and handles a given HTTP request.

      +
      +
      +

      Parameters

      +
        +
      • + req: + HttpRequest<any> +
        +

        The outgoing request object to handle.

        +
        +
        • +
      • + next: + HttpHandler +
        +

        + The next interceptor in the chain, or the backend + if no interceptors remain in the chain. +

        +
        +
        • +
      +
      +

      + Returns Observable<HttpEvent<any>> +

      +

      An observable of the event stream.

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -453,39 +558,81 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - intercept +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthModule.html b/docs/classes/AuthModule.html index 0a71bd94..dad740ef 100644 --- a/docs/classes/AuthModule.html +++ b/docs/classes/AuthModule.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -68,7 +93,7 @@

    Class AuthModule

  • Defined in projects/auth0-angular/src/lib/auth.module.ts:8
    • @@ -76,26 +101,29 @@

    Class AuthModule

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -104,8 +132,12 @@

    Constructors

    Methods

    - + forRoot @@ -115,265 +147,296 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    - + new + AuthModule(): + AuthModule +
    +
    +

    + Returns + AuthModule +

    +
    + + + - -
    -

    Methods

    -
    - -

    - Static - forRoot - -

    -
      -
    • - forRoot(config?): ModuleWithProviders<AuthModule> +
      + + +

      Methods

      +       +
      +
      +
      • -
    • -
      -

      - Initialize the authentication module system. Configuration - can either be specified here, or by calling - AuthClientConfig.set (perhaps from an APP_INITIALIZER - factory function). -

      -
      -
      -

      Parameters

      -
        -
      • - Optional - config: - AuthConfig -
        -

        The optional configuration for the SDK.

        -
        -
        -
        • -
      -
      -

      - Returns - ModuleWithProviders<AuthModule> -

      -
      - -
      • -
    + +
      +
    • + +
      +
      +

      + Initialize the authentication module system. + Configuration can either be specified here, or by + calling AuthClientConfig.set (perhaps from an + APP_INITIALIZER factory function). +

      +
      +
      +

      Parameters

      +
        +
      • + Optionalconfig: + AuthConfig +
        +

        The optional configuration for the SDK.

        +
        +
        • +
      +
      +

      + Returns + ModuleWithProviders<AuthModule> +

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -382,39 +445,81 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - forRoot +
    + + Constructors + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthService.html b/docs/classes/AuthService.html index 1155b9f0..dd683d47 100644 --- a/docs/classes/AuthService.html +++ b/docs/classes/AuthService.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -67,11 +92,10 @@

    Class AuthService<TAppState>

    Type Parameters

    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -135,37 +160,57 @@

    Constructors

    Properties

    - + appState$ - + error$ - + idTokenClaims$ - + isAuthenticated$ - + isLoading$ - + user$ @@ -174,1300 +219,2030 @@

    Properties

    Methods

    - + + createFetcher + + generateDpopProof + getAccessTokenSilently - + getAccessTokenWithPopup - + + getDpopNonce + handleRedirectCallback - + loginWithPopup - + loginWithRedirect - + logout - + ngOnDestroy + + setDpopNonce
    -
    -

    Constructors

    -
    - -

    - constructor - -

    - -
    -
    -
    -

    Properties

    -
    - -

    - Readonly - appState$ - -

    -
    - appState$: - Observable<TAppState> = ... -
    -
    -

    - Emits the value (if any) that was passed to the - loginWithRedirect method call but only - after handleRedirectCallback is - first called -

    -
    -
    - -
    -
    - -

    - Readonly - error$ - -

    -
    - error$: - Observable<Error> = ... -
    -
    -

    - Emits errors that occur during login, or when checking for an - active session on startup. -

    -
    -
    - + +
    + isAuthenticated$: + Observable<boolean> = ... +
    +
    +

    + Emits boolean values indicating the authentication state of + the user. If true, it means a user has + authenticated. This depends on the value of + isLoading$, so there is no need to manually check + the loading state of the SDK. +

    +
    + +
    +
    + +
    + isLoading$: + Observable<boolean> = ... +
    +
    +

    + Emits boolean values indicating the loading state of the SDK. +

    +
    + +
    +
    + +
    + user$: + Observable<User + | + null + | + undefined> = ... +
    +
    +

    + Emits details about the authenticated user, or null if not + authenticated. +

    +
    + +
    -
    - -

    - Readonly - idTokenClaims$ - -

    -
    - idTokenClaims$: - Observable<undefined | null | IdToken> = ... -
    -
    -

    - Emits ID token claims when authenticated, or null if not - authenticated. -

    -
    -
    - -
    -
    - -

    - Readonly - isAuthenticated$ - -

    -
    - isAuthenticated$: - Observable<boolean> = ... -
    -
    -

    - Emits boolean values indicating the authentication state of the - user. If true, it means a user has authenticated. - This depends on the value of isLoading$, so there - is no need to manually check the loading state of the SDK. -

    -
    -
    - -
    -
    - -

    - Readonly - isLoading$ - -

    -
    - isLoading$: - Observable<boolean> = ... -
    -
    -

    - Emits boolean values indicating the loading state of the SDK. -

    -
    -
    - -
    -
    - -

    - Readonly - user$ - -

    -
    - user$: - Observable<undefined | null | User> = ... -
    -
    -

    - Emits details about the authenticated user, or null if not - authenticated. -

    -
    -
    - -
    - -
    -

    Methods

    -
    - -

    - getAccessTokenSilently - -

    -
      -
    • - getAccessTokenSilently(options): Observable<GetTokenSilentlyVerboseResponse> +
      +
      • -
    • -
      -

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

      -
      -
      -

      Parameters

      -
        -
      • - options: - GetTokenSilentlyOptions & {
            detailedResponse: true;
        }         -
        -

        The options for configuring the token fetch.

        -
        -
        -
        • -
      -
      -

      - Returns Observable<GetTokenSilentlyVerboseResponse> -

      -
      - -
      • -
    • - getAccessTokenSilently(options?): Observable<string> +
        +
      • + +
        +
        + 
        getTokenWithPopup(options).subscribe(token => ...)
+
        + +

        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 Observable<string + | + undefined> +

        + +
        +
        • +
      +
    +
    +
    -
    - -

    - getAccessTokenWithPopup - -

    -
      -
    • - getAccessTokenWithPopup(options?): Observable<undefined | string> +
        +
      • + +
        +
        + 
        getDpopNonce(id).subscribe(nonce => ...)
+
        + +

        + Gets the DPoP nonce for the specified domain or the + default domain. The nonce is used in DPoP proof + generation for token binding. +

        +
        +
        +

        Parameters

        +
          +
        • + Optionalid: + string +
          +

          + Optional identifier for the domain. If not + provided, uses the default domain. +

          +
          +
          • +
        +
        +

        + Returns Observable<string + | + undefined> +

        +

        + An Observable that emits the DPoP nonce string or + undefined if not available. +

        + +
        +
        • +
      +
    +
    +
    -
    - -

    - handleRedirectCallback - -

    -
    + + + +
    +
    -
    - -

    - loginWithPopup - -

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

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

        +

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

        +
        +
        +

        Parameters

        + +
        +

        + Returns Observable<void> +

        + +
        +
        • +
      +
    +
    +
    -
    - -

    - loginWithRedirect - -

    -
      -
    • - loginWithRedirect(options?): Observable<void> + +
    +
    +
    -
    - -

    - logout - -

    -
      -
    • - logout(options?): Observable<void> +
        +
      • + +
        +
        + 
        logout();
+
        + +

        + 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 + openUrl option is set to false, it only + clears the application session. It is invalid to set + both the federated to true and + openUrl to false, and an error + will be thrown if you do. + Read more about how Logout works at Auth0. +

        +
        +
        +

        Parameters

        +
          +
        • + Optionaloptions: + LogoutOptions +
          +

          The logout options

          +
          +
          • +
        +
        +

        + Returns Observable<void> +

        + +
        +
        • +
      +
    +
    +
    -
    - -

    - ngOnDestroy - -

    -
    +
    + +
      +
    • + +
      +
      + 
      setDpopNonce(nonce, id).subscribe(() => ...)
+
      + +

      + Sets the DPoP nonce for the specified domain or the + default domain. This is typically used after receiving a + new nonce from the authorization server. +

      +
      +
      +

      Parameters

      +
        +
      • + nonce: + string +
        +

        The DPoP nonce value to set.

        +
        +
        • +
      • + Optionalid: + string +
        +

        + Optional identifier for the domain. If not + provided, uses the default domain. +

        +
        +
        • +
      +
      +

      + Returns Observable<void> +

      +

      An Observable that completes when the nonce is set.

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -1476,89 +2251,230 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - appState$ - error$ - idTokenClaims$ - isAuthenticated$ - isLoading$ - user$ - getAccessTokenSilently - getAccessTokenWithPopup - handleRedirectCallback - loginWithPopup - loginWithRedirect - logout - ngOnDestroy +
    + + Constructors + + +
    +
    + + Properties + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthState.html b/docs/classes/AuthState.html index 8ab979b6..f2d103d0 100644 --- a/docs/classes/AuthState.html +++ b/docs/classes/AuthState.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -67,14 +92,13 @@

    Class AuthState

    Tracks the Authentication State for the SDK

    -
    -
    +
    - + + +
    Index

    Constructors

    - + constructor @@ -110,32 +137,48 @@

    Constructors

    Properties

    - + error$ - + idTokenClaims$ - + isAuthenticated$ - + isLoading$ - + user$ @@ -144,25 +187,39 @@

    Properties

    Methods

    - + refresh - + setAccessToken - + setError - + setIsLoading @@ -172,672 +229,720 @@

    Methods

    -
    -

    Constructors

    -
    - -

    - constructor - -

    -
    +
    +
    +

    Parameters

    +
      +
    • + auth0Client: + Auth0Client +
      • +
    +
    +

    + Returns + AuthState - - - - - - - -
    -

    Properties

    -
    - -

    - Readonly - error$ - -

    -
    - error$: - Observable<Error> = ... -
    -
    -

    - Emits errors that occur during login, or when checking for an - active session on startup. -

    -
    -
    - -
    -
    - -

    - Readonly - idTokenClaims$ - -

    -
    - idTokenClaims$: - Observable<undefined | null | IdToken> = ... -
    -
    -

    - Emits ID token claims when authenticated, or null if not - authenticated. -

    -
    -
    - -
    -
    - -

    - Readonly - isAuthenticated$ - -

    -
    - isAuthenticated$: - Observable<boolean> = ... -
    -
    -

    - Emits boolean values indicating the authentication state of the - user. If true, it means a user has authenticated. - This depends on the value of isLoading$, so there - is no need to manually check the loading state of the SDK. -

    -
    -
    - -
    -
    - -

    - Readonly - isLoading$ - -

    -
    - isLoading$: - Observable<boolean> = ... -
    -
    -

    - Emits boolean values indicating the loading state of the SDK. -

    -
    -
    - -
    -
    - -

    - Readonly - user$ - -

    -
    - user$: - Observable<undefined | null | User> = ... -
    -
    -

    - Emits details about the authenticated user, or null if not - authenticated. -

    -
    -
    -

    + +
    - + - -
    -

    Methods

    -
    - -

    - refresh - -

    -
      -
    • - refresh(): void +
      + + +

      Properties

      +       +
      +
      + +
      + error$: + Observable<Error> = ... +
      +
      +

      + Emits errors that occur during login, or when checking for an + active session on startup. +

      +
      + +
      +
      +
      • -
    • -
      -

      - Refresh the state to ensure the - isAuthenticated, user$ and - idTokenClaims$ reflect the most up-to-date - values from Auth0Client. -

      -
      -

      - Returns void -

      -
      - -
      • -
    -
    -
    - -

    - setAccessToken - -

    -
      -
    • - setAccessToken(accessToken): void +
      + idTokenClaims$: + Observable<IdToken + | + null + | + undefined> = ... +
      +
      +

      + Emits ID token claims when authenticated, or null if not + authenticated. +

      +
      + +
    +
    +
    -
    - -

    - setError - -

    -
      -
    • - setError(error): void +
      + isAuthenticated$: + Observable<boolean> = ... +
      +
      +

      + Emits boolean values indicating the authentication state of + the user. If true, it means a user has + authenticated. This depends on the value of + isLoading$, so there is no need to manually check + the loading state of the SDK. +

      +
      + +
    +
    + +
    + isLoading$: + Observable<boolean> = ... +
    +
    +

    + Emits boolean values indicating the loading state of the SDK. +

    +
    + +
    +
    + +
    + user$: + Observable<User + | + null + | + undefined> = ... +
    +
    +

    + Emits details about the authenticated user, or null if not + authenticated. +

    +
    + +
    -
    - -

    - setIsLoading - -

    -
      -
    • - setIsLoading(isLoading): void +
      + + +

      Methods

      +       +
      +
      +
      • -
    • -
      -

      Update the isLoading state using the provided value

      -
      -
      -

      Parameters

      -
        -
      • - isLoading: - boolean -
        -

        The new value for isLoading

        -
        -
        -
        • -
      -
      -

      - Returns void -

      -
      - -
      • -
    + +
      +
    • + +
      +
      +

      + Refresh the state to ensure the + isAuthenticated, user$ and + idTokenClaims$ reflect the most up-to-date + values from Auth0Client. +

      +
      +

      + Returns void +

      + +
      +
      • +
    +
    +
    + +
      +
    • + +
      +
      +

      + Update the access token, doing so will also refresh the + state. +

      +
      +
      +

      Parameters

      +
        +
      • + accessToken: + string +
        +

        The new Access Token

        +
        +
        • +
      +
      +

      + Returns void +

      + +
      +
      • +
    +
    +
    + +
      +
    • + +
      +
      +

      + Emits the error in the error$ observable. +

      +
      +
      +

      Parameters

      +
        +
      • + error: + any +
        +

        The new error

        +
        +
        • +
      +
      +

      + Returns void +

      + +
      +
      • +
    +
    +
    + +
      +
    • + +
      +
      +

      Update the isLoading state using the provided value

      +
      +
      +

      Parameters

      +
        +
      • + isLoading: + boolean +
        +

        The new value for isLoading

        +
        +
        • +
      +
      +

      + Returns void +

      + +
      +
      • +
    +
    - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -846,71 +951,164 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - error$ - idTokenClaims$ - isAuthenticated$ - isLoading$ - user$ - refresh - setAccessToken - setError - setIsLoading +
    + + Constructors + + +
    +
    + + Properties + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 73d9b718..f4c8357e 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
    -
    -
    @@ -67,32 +92,31 @@

    Class AuthenticationError

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

    -
    -
    +

    - Hierarchy (view fullView Summary)

      -
    • +
    • GenericError
        -
      • AuthenticationError
        • +
      • + AuthenticationError +
    @@ -107,28 +131,31 @@

    -
    +
    - + + +
    Index

    Constructors

    + > constructor @@ -137,66 +164,87 @@

    Constructors

    Properties

    - + appState + > error + > error_description + > message + > name + > stack? - + state - prepareStackTrace? - + > stackTraceLimit @@ -206,777 +254,893 @@

    Properties

    Methods

    + > captureStackTrace + > fromPayload + + prepareStackTrace
    -
    -

    Constructors

    -
    - -

    - constructor - -

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

      Constructors

      +       +
      +
      +
      • -
    • -
      -

      Parameters

      -
        -
      • - error: - string -
        • -
      • - error_description: string -
        • -
      • - state: - string -
        • -
      • - Optional - appState: - any -
        • -
      -
      -

      - Returns - AuthenticationError +
        +
      • +

      - -
      • -
    -
    -
    -
    -

    Properties

    -
    - -

    - appState - -

    -
    - appState: - any -
    - -
    -
    - -

    - error - -

    -
    - error: - string -
    - -
    -
    - -

    - error_description - -

    -
    - error_description: - string -
    - -
    -
    - -

    - message - -

    -
    - message: - string -
    - -
    -
    - -

    - name - -

    -
    - name: - string -
    - -
    -
    - -

    - Optional - stack - -

    -
    - stack?: - string -
    - -
    -
    - -

    - state - -

    -
    - state: - string -
    -

    +
    +
    +

    Parameters

    +
      +
    • + error: + string +
      • +
    • + error_description: + string +
      • +
    • + state: + string +
      • +
    • + OptionalappState: + any +
      • +
    +
    +

    + Returns + AuthenticationError +

    + +
    - + -
    - -

    - Static - Optional - prepareStackTrace - -

    -
    - prepareStackTrace?: - ((err, - stackTraces) => any) -
    -
    -

    Optional override for formatting stack traces

    -
    -
    -

    Type declaration

    -
      -
    • -
        -
      • - (err, - stackTraces): any -
        • -
      • -
        -

        Parameters

        -
          -
        • - err: - Error -
          • -
        • - stackTraces: CallSite[] -
          • -
        -
        -

        - Returns any -

        -
        • -
      -
      • -
    -
    -
    -

    See

    -

    - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

    -
    - -
    -
    - -

    - Static - stackTraceLimit - -

    -
    - stackTraceLimit: - number -
    - -
    - -
    -

    Methods

    -
    - -

    - Static - captureStackTrace - -

    -
      -
    • - captureStackTrace(targetObject, - constructorOpt?): void +
      + + +

      Properties

      +       +
      +
      +
      • -
    • -
      -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • - targetObject: - Object -
        • -
      • - Optional - constructorOpt: - Function -
        • -
      -
      -

      - Returns void -

      -
      - -
      • -
    + +
    + appState: + any +
    + +
    +
    + +
    + error: + string +
    + +
    +
    + +
    + error_description: + string +
    + +
    +
    + +
    + message: + string +
    + +
    +
    + +
    + name: + string +
    + +
    +
    + +
    + stack?: + string +
    + +
    +
    + +
    + state: + string +
    + +
    +
    + +
    + stackTraceLimit: + number +
    +
    +

    + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

    +

    + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

    +

    + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

    +
    + +
    -
    - -

    - Static - fromPayload - -

    -
      -
    • - fromPayload(__namedParameters): +
      + + +

      Methods

      +       +
      +
      + +
        +
      • + +
        +
        +

        + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

        + 
        const myObject = {};
        Error.captureStackTrace(myObject);
        myObject.stack;  // Similar to `new Error().stack`
+
        + +

        + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

        +

        + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

        +

        + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

        + 
        function a() {
          b();
        }

        function b() {
          c();
        }

        function c() {
          // Create an error without stack trace to avoid calculating the stack trace twice.
          const { stackTraceLimit } = Error;
          Error.stackTraceLimit = 0;
          const error = new Error();
          Error.stackTraceLimit = stackTraceLimit;

          // Capture the stack trace above function b
          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
          throw error;
        }

        a();
+
        +
        +
        +

        Parameters

        +
          +
        • + targetObject: + object +
          • +
        • + OptionalconstructorOpt: + Function +
          • +
        +
        +

        + Returns void +

        + +
        +
        • +
      +
      +
      +
      • -
    • -
      -

      Parameters

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

            Parameters

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

      - Returns - GenericError +

      + Returns + GenericError +

      + +
    + + + +
    + +
      +
    • +
      • -
    + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
    +
    +
    +

    Parameters

    +
      +
    • + err: + Error +
      • +
    • + stackTraces: CallSite[] +
      • +
    +
    +

    + Returns any +

    +
    +
    + +

    + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

    +
    +
    + +
    + + + - +
    -
    +
    -

    - - Settings -

    + +

    Settings
    -

    Member Visibility

    -
    -
      -
    • - Member Visibility +
        +
      • +
        • -
      • - + Protected +
        • +
      • +
        • -
      • - + Inherited +
        • +
      • +
        • -
      -
      • + + External + +
    -

    Theme

    - @@ -985,87 +1149,190 @@

    Theme

    -
    +
    -

    - - On This Page -

    + +

    On This Page
    - - constructor - appState - error - error_description - message - name - stack - state - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
    + + Constructors + + +
    +
    + + Properties + + +
    +
    + + Methods + + +
    diff --git a/docs/classes/Fetcher.html b/docs/classes/Fetcher.html new file mode 100644 index 00000000..9407a2fb --- /dev/null +++ b/docs/classes/Fetcher.html @@ -0,0 +1,2122 @@ + + + + + + Fetcher | @auth0/auth0-angular + + + + + + + + + + + + +
    +
    + @auth0/auth0-angular + + + + +
      +
      +
      Preparing search index...
      +
      +       + +
      +
      +
      +
      +
      + +

      Class Fetcher<TOutput>

      +
      +
      +

      Type Parameters

      + +
      + +
      +
      +
      + + +
      Index
      +       +
      +
      +

      Constructors

      +
      + + constructor +
      +
      +
      +

      Properties

      +
      + + config + + hooks +
      +
      +
      +

      Methods

      +
      + + buildBaseRequest + + buildUrl + + extractUrl + + fetchWithAuth + + getAccessToken + + getHeader + + handleResponse + + hasUseDpopNonceError + + internalFetchWithAuth + + isAbsoluteUrl + + prepareRequest + + setAuthorizationHeader + + setDpopProofHeader +
      +
      +
      +
      +
      +
      +
      + + +

      Constructors

      +       +
      +
      + + +
      +
      +
      +
      + + +

      Properties

      +       +
      +
      + +
      + config: + Omit<FetcherConfig<TOutput>, + "fetch"> + & + Required<
          Pick<FetcherConfig<TOutput>, + "fetch">,
      > +
      + +
      +
      + +
      + hooks: + FetcherHooks +
      + +
      +
      +
      +
      + + +

      Methods

      +       +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + info: + RequestInfo + | + URL +
          • +
        • + init: + RequestInit + | + undefined +
          • +
        +
        +

        + Returns Request +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + baseUrl: + string + | + undefined +
          • +
        • + url: + string + | + undefined +
          • +
        +
        +

        + Returns string +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + info: + RequestInfo + | + URL +
          • +
        +
        +

        + Returns string +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + info: + RequestInfo + | + URL +
          • +
        • + Optionalinit: + RequestInit +
          • +
        • + OptionalauthParams: + AuthParams +
          • +
        +
        +

        + Returns Promise<TOutput> +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + OptionalauthParams: + AuthParams +
          • +
        +
        +

        + Returns Promise<string + | + GetTokenSilentlyVerboseResponse> +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + headers: + ResponseHeaders +
          • +
        • + name: + string +
          • +
        +
        +

        + Returns string +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + response: + TOutput +
          • +
        • + callbacks: + FetchWithAuthCallbacks<TOutput> +
          • +
        +
        +

        + Returns Promise<TOutput> +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        + +
        +

        + Returns boolean +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + info: + RequestInfo + | + URL +
          • +
        • + init: + RequestInit + | + undefined +
          • +
        • + callbacks: + FetchWithAuthCallbacks<TOutput> +
          • +
        • + OptionalauthParams: + AuthParams +
          • +
        +
        +

        + Returns Promise<TOutput> +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + url: + string +
          • +
        +
        +

        + Returns boolean +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + request: + Request +
          • +
        • + OptionalauthParams: + AuthParams +
          • +
        +
        +

        + Returns Promise<void> +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + request: + Request +
          • +
        • + accessToken: + string +
          • +
        • + OptionaltokenType: + string +
          • +
        +
        +

        + Returns void +

        + +
        +
        • +
      +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • + request: + Request +
          • +
        • + accessToken: + string +
          • +
        +
        +

        + Returns Promise<void> +

        + +
        +
        • +
      +
      +
      +
      +
      +
      +
      +
      +
      + + +

      Settings

      +       +
      +
      + Member Visibility +
        +
      • + +
        • +
      • + +
        • +
      • + +
        • +
      +
      +
      + +
      +
      +
      +
      +
      + + +

      On This Page

      +       +
      +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      +
      +
      +
      +
      + +
      +
      +
      +
      +
      + + diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index fbf9eb1c..95db2aa8 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -67,56 +92,61 @@

      Class GenericError

      Thrown when network requests to the Auth server fail.

      -
      -
      +

      - Hierarchy (view fullView Summary)

        -
      • +
      • Error @@ -133,28 +163,31 @@

        -
        +
        - + + +
        Index

        Constructors

        + > constructor @@ -163,52 +196,67 @@

        Constructors

        Properties

        - + error + > error_description + > message + > name + > stack? - prepareStackTrace? - + > stackTraceLimit @@ -218,648 +266,752 @@

        Properties

        Methods

        + > captureStackTrace + > fromPayload + + prepareStackTrace
        -
        -

        Constructors

        -
        - -

        - constructor - -

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

          Constructors

          +           +
          +
          +
          • -
        • -
          -

          Parameters

          -
            -
          • - error: - string -
            • -
          • - error_description: string -
            • -
          -
          -

          - Returns - GenericError +
            +
          • +

          - -
          • -
        -
        -
        -
        -

        Properties

        -
        - -

        - error - -

        -
        - error: - string -
        - -
        -
        - -

        - error_description - -

        -
        - error_description: - string -
        - -
        -
        - -

        - message - -

        -
        - message: - string -
        - -
        -
        - -

        - name - -

        -
        - name: - string -
        - -
        -
        - -

        - Optional - stack - -

        -
        - stack?: - string -
        - -
        -
        - -

        - Static - Optional - prepareStackTrace - -

        -
        - prepareStackTrace?: - ((err, - stackTraces) => any) -
        -
        -

        Optional override for formatting stack traces

        -
        -
        -

        Type declaration

        -
          -
        • -
            -
          • - (err, - stackTraces): any -
            • -
          • -
            -

            Parameters

            -
              -
            • - err: - Error -
              • -
            • - stackTraces: CallSite[] -
              • -
            -
            -

            - Returns any -

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

        Parameters

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

        + Returns + GenericError +

        + +

      -
      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - + -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - -
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -868,77 +1020,170 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - error - error_description - message - name - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index a899f55d..c6a81cb5 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -73,28 +98,31 @@

      Class InMemoryCache

      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -104,9 +132,13 @@

      Constructors

      Properties

      + > enclosedCache @@ -116,207 +148,237 @@

      Properties

      -
      -

      Constructors

      -
      - -

      - constructor - -

      - -
      -
      -
      -

      Properties

      -
      - -

      - enclosedCache - -

      -
      - enclosedCache: - ICache -
      -
      +
      +

      + Returns + InMemoryCache +

      +
      - + - + +
      + + +

      Properties

      +       +
      +
      + +
      + enclosedCache: + ICache +
      + +
      +
      +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -325,39 +387,81 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - enclosedCache +
      + + Constructors + + +
      +
      + + Properties + + +
      diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index 78cbfbe5..c80744c9 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -85,28 +110,31 @@

      Implements

      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -115,31 +143,39 @@

      Constructors

      Methods

      - + allKeys - + get - + remove - + set @@ -149,474 +185,535 @@

      Methods

      -
      -

      Constructors

      -
      - -

      - constructor - -

      - + new + LocalStorageCache(): + LocalStorageCache +
      +
      +

      + Returns + LocalStorageCache +

      +
      + + + - -
      -

      Methods

      -
      - -

      - allKeys - -

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

        Methods

        +         +
        +
        +
        • -
      • -

        - Returns string[] -

        - -
        • -
      -
      -
      - -

      - get - -

      -
      +
      +
      -
      - -

      - remove - -

      -
        -
      • - remove(key): void= + Cacheable>(key: + string): + MaybePromise<T + | + undefined> +
      +
      +
      +

      Type Parameters

      + +
      +
      +

      Parameters

      +
        +
      • + key: + string +
        • +
      +
      +

      + Returns + MaybePromise<T + | + undefined> +

      + +
      + + + +
      +
      -
      - -

      - set - -

      -
      +
      +
      +
      +
      +

      Type Parameters

      + +
      +
      +

      Parameters

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

      + Returns void +

      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -625,51 +722,105 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - allKeys - get - remove - set +
      + + Constructors + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 5c715510..26c73a2d 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -70,23 +95,24 @@

      Class MfaRequiredError

      mfa_required error

      -
      -
      +

      - Hierarchy (view fullView Summary)

        -
      • +
      • GenericError
          -
        • MfaRequiredError
          • +
        • + MfaRequiredError +
      @@ -95,34 +121,37 @@

      • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:43 + node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:56
      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -132,58 +161,77 @@

      Constructors

      Properties

      + > error + > error_description + > message - + mfa_token + > name + > stack? - prepareStackTrace? - + > stackTraceLimit @@ -193,742 +241,859 @@

      Properties

      Methods

      + > captureStackTrace + > fromPayload + + prepareStackTrace
      -
      -

      Constructors

      -
      - -

      - constructor - -

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

        Constructors

        +         +
        +
        +
        • -
      • -
        -

        Parameters

        -
          -
        • - error: - string -
          • -
        • - error_description: string -
          • -
        • - mfa_token: - string -
          • -
        -
        -

        - Returns - MfaRequiredError +
          +
        • +

        - -
        • -
      -
      -
      -
      -

      Properties

      -
      - -

      - error - -

      -
      - error: - string -
      - -
      -
      - -

      - error_description - -

      -
      - error_description: - string -
      - -
      -
      - -

      - message - -

      -
      - message: - string -
      - -
      -
      - -

      - mfa_token - -

      -
      - mfa_token: - string -
      - -
      -
      - -

      - name - -

      -
      - name: - string -
      - -
      -
      - -

      - Optional - stack - -

      -
      - stack?: - string -
      - -
      -
      - -

      - Static - Optional - prepareStackTrace - -

      -
      - prepareStackTrace?: - ((err, - stackTraces) => any) -
      -
      -

      Optional override for formatting stack traces

      -
      -
      -

      Type declaration

      -
        -
      • -
          -
        • - (err, - stackTraces): any -
          • -
        • -
          -

          Parameters

          -
            -
          • - err: - Error -
            • -
          • - stackTraces: CallSite[] -
            • -
          -
          -

          - Returns any -

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

      Parameters

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

      + Returns + MfaRequiredError +

      + +
      -

      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - + -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - -
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + mfa_token: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -937,83 +1102,182 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - error - error_description - message - mfa_token - name - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 11a1c37a..cc7b2d25 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -71,25 +92,26 @@

      Class MissingRefreshTokenError

      Error thrown when there is no refresh token to use

      -
      -
      +

      - Hierarchy (view fullView Summary)

        -
      • +
      • GenericError
          -
        • MissingRefreshTokenError
          • +
        • + MissingRefreshTokenError +
      @@ -98,34 +120,37 @@

      • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:50 + node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:63
      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -134,66 +159,87 @@

      Constructors

      Properties

      - + audience + > error + > error_description + > message + > name - + scope + > stack? - prepareStackTrace? - + > stackTraceLimit @@ -203,761 +249,868 @@

      Properties

      Methods

      + > captureStackTrace + > fromPayload + + prepareStackTrace
      -
      -

      Constructors

      -
      - -

      - constructor - -

      -
        -
      • - new - MissingRefreshTokenError(audience, - scope): MissingRefreshTokenError + + +

        Constructors

        +         +
        +
        +
        • -
      • -
        -

        Parameters

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

        - Returns - MissingRefreshTokenError +
          +
        • +

        - -
        • -
      -
      -
      -
      -

      Properties

      -
      - -

      - audience - -

      -
      - audience: - string -
      - -
      -
      - -

      - error - -

      -
      - error: - string -
      - -
      -
      - -

      - error_description - -

      -
      - error_description: - string -
      - -
      -
      - -

      - message - -

      -
      - message: - string -
      - -
      -
      - -

      - name - -

      -
      - name: - string -
      - -
      -
      - -

      - scope - -

      -
      - scope: - string -
      - -
      -
      - -

      - Optional - stack - -

      -
      - stack?: - string -
      - -
      -
      - -

      - Static - Optional - prepareStackTrace - -

      -
      - prepareStackTrace?: - ((err, - stackTraces) => any) -
      -
      -

      Optional override for formatting stack traces

      -
      -
      -

      Type declaration

      -
        -
      • -
          -
        • - (err, - stackTraces): any -
          • -
        • -
          -

          Parameters

          -
            -
          • - err: - Error -
            • -
          • - stackTraces: CallSite[] -
            • -
          -
          -

          - Returns any -

          -
          • -
        + new + MissingRefreshTokenError(
            audience: + string,
            scope: + string,
        ): + MissingRefreshTokenError +
      +
      +
      +

      Parameters

      +
        +
      • + audience: + string +
        • +
      • + scope: + string +
        • +
      +
      +

      + Returns + MissingRefreshTokenError +

      + +
      -

      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - - -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - +
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + audience: + string +
      + +
      +
      + +
      + error: + string +
      + +
      +
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + scope: + string +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -966,87 +1119,190 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - audience - error - error_description - message - name - scope - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 770eba2f..f1ee887a 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -67,25 +92,24 @@

      Class PopupCancelledError

      Thrown when network requests to the Auth server fail.

      -
      -
      +

      - Hierarchy (view fullView Summary)

        -
      • +
      • GenericError
          -
        • PopupCancelledError
          • +
        • + PopupCancelledError +
      @@ -94,34 +118,37 @@

      • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:36 + node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:46
      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -131,58 +158,77 @@

      Constructors

      Properties

      + > error + > error_description + > message + > name - + popup + > stack? - prepareStackTrace? - + > stackTraceLimit @@ -192,727 +238,829 @@

      Properties

      Methods

      + > captureStackTrace + > fromPayload + + prepareStackTrace
      -
      -

      Constructors

      -
      - -

      - constructor - -

      - -
      -
      -
      -

      Properties

      -
      - -

      - error - -

      -
      - error: - string -
      - -
      -
      - -

      - error_description - -

      -
      - error_description: - string -
      - -
      -
      - -

      - message - -

      -
      - message: - string -
      - -
      -
      - -

      - name - -

      -
      - name: - string -
      - -
      -
      - -

      - popup - -

      -
      - popup: - Window -
      - -
      -
      - -

      - Optional - stack - -

      -
      - stack?: - string -
      - -
      -
      - -

      - Static - Optional - prepareStackTrace - -

      -
      - prepareStackTrace?: - ((err, - stackTraces) => any) -
      -
      -

      Optional override for formatting stack traces

      -
      -
      -

      Type declaration

      -
        -
      • -
          -
        • - (err, - stackTraces): any -
          • -
        • -
          -

          Parameters

          -
            -
          • - err: - Error -
            • -
          • - stackTraces: CallSite[] -
            • -
          -
          -

          - Returns any -

          -
          • -
        + new + PopupCancelledError(popup: + Window): + PopupCancelledError +
      +
      +
      +

      Parameters

      +
        +
      • + popup: + Window +
        • +
      +
      +

      + Returns + PopupCancelledError +

      + +
      -

      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - - -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - +
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + popup: + Window +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -921,83 +1069,182 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - error - error_description - message - name - popup - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 7246cfbd..0d04c6d6 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -70,25 +95,24 @@

      Class PopupTimeoutError

      complete auth)

      -
      -
      +

      - Hierarchy (view fullView Summary)

        -
      • +
      • TimeoutError
          -
        • PopupTimeoutError
          • +
        • + PopupTimeoutError +
      @@ -97,34 +121,37 @@

      • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:32 + node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:42
      -
      +
      - + + +
      Index

      Constructors

      + > constructor @@ -134,58 +161,77 @@

      Constructors

      Properties

      + > error + > error_description + > message + > name - + popup + > stack? - prepareStackTrace? - + > stackTraceLimit @@ -195,724 +241,829 @@

      Properties

      Methods

      + > captureStackTrace + > fromPayload + + prepareStackTrace
      -
      -

      Constructors

      -
      - -

      - constructor - -

      -
        -
      • - new PopupTimeoutError(popup): PopupTimeoutError + + +

        Constructors

        +         +
        +
        +
        • -
      • -
        -

        Parameters

        -
          -
        • - popup: - Window -
          • -
        -
        -

        - Returns - PopupTimeoutError +
          +
        • +

        - -
        • -
      -
      -
      -
      -

      Properties

      -
      - -

      - error - -

      -
      - error: - string -
      - -
      -
      - -

      - error_description - -

      -
      - error_description: - string -
      - -
      -
      - -

      - message - -

      -
      - message: - string -
      - -
      -
      - -

      - name - -

      -
      - name: - string -
      - -
      -
      - -

      - popup - -

      -
      - popup: - Window -
      - -
      -
      - -

      - Optional - stack - -

      -
      - stack?: - string -
      - -
      -
      - -

      - Static - Optional - prepareStackTrace - -

      -
      - prepareStackTrace?: - ((err, - stackTraces) => any) -
      -
      -

      Optional override for formatting stack traces

      -
      -
      -

      Type declaration

      -
        -
      • -
          -
        • - (err, - stackTraces): any -
          • -
        • -
          -

          Parameters

          -
            -
          • - err: - Error -
            • -
          • - stackTraces: CallSite[] -
            • -
          -
          -

          - Returns any -

          -
          • -
        + new + PopupTimeoutError(popup: + Window): + PopupTimeoutError +
      +
      +
      +

      Parameters

      +
        +
      • + popup: + Window +
        • +
      +
      +

      + Returns + PopupTimeoutError +

      + +
      -

      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - - -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - +
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + popup: + Window +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -921,83 +1072,182 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - error - error_description - message - name - popup - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 1c2fb050..ce880b35 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
      -
      -
      @@ -70,26 +95,24 @@

      Class TimeoutError

      issue) or when network requests to the Auth server timeout.

      -
      -
      +

      - Hierarchy (view fullView Summary)

      -
      -

      See

      -

      - https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces -

      -
      - - -
      - -

      - Static - stackTraceLimit - -

      -
      - stackTraceLimit: - number -
      - +
      - -
      -

      Methods

      -
      - -

      - Static - captureStackTrace - -

      -
        -
      • - captureStackTrace(targetObject, - constructorOpt?): void +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        +
        • -
      • -
        -

        Create .stack property on a target object

        -
        -
        -

        Parameters

        -
          -
        • - targetObject: - Object -
          • -
        • - Optional - constructorOpt: - Function -
          • -
        -
        -

        - Returns void -

        -
        - -
        • -
      + +
      + error_description: + string +
      + +
      +
      + +
      + message: + string +
      + +
      +
      + +
      + name: + string +
      + +
      +
      + +
      + stack?: + string +
      + +
      +
      + +
      + stackTraceLimit: + number +
      +
      +

      + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

      +

      + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

      +

      + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

      +
      + +
      -
      - -

      - Static - fromPayload - -

      -
        -
      • - fromPayload(__namedParameters): +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        +
        • -
      • -
        -

        Parameters

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

              Parameters

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

        - Returns - GenericError +

        + Returns + GenericError +

        + +
      + + + +
      + +
        +
      • +
        • -
      + prepareStackTrace(err: + Error, + stackTraces: + CallSite[]): + any +
      +
      +
      +

      Parameters

      +
        +
      • + err: + Error +
        • +
      • + stackTraces: CallSite[] +
        • +
      +
      +

      + Returns any +

      +
      +
      + +

      + https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

      +
      +
      + +
      + + + - +
      -
      +
      -

      - - Settings -

      + +

      Settings
      -

      Member Visibility

      -
      -
        -
      • - Member Visibility +
          +
        • +
          • -
        • - + Protected +
          • +
        • +
          • -
        • - + Inherited +
          • +
        • +
          • -
        -
        • + + External + +
      -

      Theme

      - @@ -888,79 +1034,174 @@

      Theme

      -
      +
      -

      - - On This Page -

      + +

      On This Page
      - - constructor - error - error_description - message - name - stack - prepareStackTrace - stackTraceLimit - captureStackTrace - fromPayload +
      + + Constructors + + +
      +
      + + Properties + + +
      +
      + + Methods + + +
      diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html new file mode 100644 index 00000000..431d1cae --- /dev/null +++ b/docs/classes/UseDpopNonceError.html @@ -0,0 +1,1273 @@ + + + + + + UseDpopNonceError | @auth0/auth0-angular + + + + + + + + + + + + +
      +
      + @auth0/auth0-angular + + + + +
        +
        +
        Preparing search index...
        +
        +         + +
        +
        +
        +
        +
        + +

        Class UseDpopNonceError

        +
        +
        +
        +

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

        +
        +
        +
        +

        + Hierarchy (View Summary) +

        + +
        + +
        +
        +
        + + +
        Index
        +         +
        +
        +

        Constructors

        +
        + + constructor +
        +
        +
        +

        Properties

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

        Methods

        +
        + + captureStackTrace + + fromPayload + + prepareStackTrace +
        +
        +
        +
        +
        +
        +
        + + +

        Constructors

        +         +
        +
        + +
          +
        • + +
          +
          +

          Parameters

          +
            +
          • + newDpopNonce: string + | + undefined +
            • +
          +
          +

          + Returns + UseDpopNonceError +

          + +
          +
          • +
        +
        +
        +
        +
        + + +

        Properties

        +         +
        +
        + +
        + error: + string +
        + +
        +
        + +
        + error_description: + string +
        + +
        +
        + +
        + message: + string +
        + +
        +
        + +
        + name: + string +
        + +
        +
        + +
        + newDpopNonce: + string + | + undefined +
        + +
        +
        + +
        + stack?: + string +
        + +
        +
        + +
        + stackTraceLimit: + number +
        +
        +

        + The Error.stackTraceLimit property specifies the + number of stack frames collected by a stack trace (whether + generated by new Error().stack or + Error.captureStackTrace(obj)). +

        +

        + The default value is 10 but may be set to any + valid JavaScript number. Changes will affect any stack trace + captured after the value has been changed. +

        +

        + If set to a non-number value, or set to a negative number, + stack traces will not capture any frames. +

        +
        + +
        +
        +
        +
        + + +

        Methods

        +         +
        +
        + +
          +
        • + +
          +
          +

          + Creates a .stack property on + targetObject, which when accessed returns a + string representing the location in the code at which + Error.captureStackTrace() was called. +

          + 
          const myObject = {};
          Error.captureStackTrace(myObject);
          myObject.stack;  // Similar to `new Error().stack`
+
          + +

          + The first line of the trace will be prefixed with + ${myObject.name}: ${myObject.message}. +

          +

          + The optional constructorOpt argument + accepts a function. If given, all frames above + constructorOpt, including + constructorOpt, will be omitted from the + generated stack trace. +

          +

          + The constructorOpt argument is useful for + hiding implementation details of error generation from + the user. For instance: +

          + 
          function a() {
            b();
          }

          function b() {
            c();
          }

          function c() {
            // Create an error without stack trace to avoid calculating the stack trace twice.
            const { stackTraceLimit } = Error;
            Error.stackTraceLimit = 0;
            const error = new Error();
            Error.stackTraceLimit = stackTraceLimit;

            // Capture the stack trace above function b
            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
            throw error;
          }

          a();
+
          +
          +
          +

          Parameters

          +
            +
          • + targetObject: + object +
            • +
          • + OptionalconstructorOpt: + Function +
            • +
          +
          +

          + Returns void +

          + +
          +
          • +
        +
        +
        + +
          +
        • + +
          +
          +

          Parameters

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

          + Returns + GenericError +

          + +
          +
          • +
        +
        +
        + + +
        +
        +
        +
        +
        +
        +
        +
        + + +

        Settings

        +         +
        +
        + Member Visibility +
          +
        • + +
          • +
        • + +
          • +
        • + +
          • +
        +
        +
        + +
        +
        +
        +
        +
        + + +

        On This Page

        +         +
        +
        + + Constructors + + +
        +
        + + Properties + + +
        +
        + + Methods + + +
        +
        +
        +
        +
        + +
        +
        +
        +
        +
        + + diff --git a/docs/classes/User.html b/docs/classes/User.html index b324427c..71429d18 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        -
        +

        Indexable

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

        Constructors

        + > constructor @@ -112,143 +145,195 @@

        Constructors

        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? @@ -258,687 +343,705 @@

        Properties

        -
        -

        Constructors

        -
        - -

        - constructor - -

        -
          -
        • - new User(): User + + +

          Constructors

          +           +
          +
          +
          • -
        • -

          - Returns - User +
            +
          • +

          -
          • -
        -
        -
        -
        -

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

        + Returns + User +

        +
        - + -
        - -

        - Optional - zoneinfo - -

        -
        - zoneinfo?: - string -
        - + +
        + + +

        Properties

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

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -947,115 +1050,233 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - constructor - 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 + + +
        +
        + + Properties + + +
        diff --git a/docs/enums/HttpMethod.html b/docs/enums/HttpMethod.html index 94c7e4fc..162187b8 100644 --- a/docs/enums/HttpMethod.html +++ b/docs/enums/HttpMethod.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -

        Defines a common set of HTTP methods.

        -
        -
        +
        - + + +
        Index

        Enumeration Members

        - + Delete - + Get - + Head - + Patch - + Post - + Put @@ -140,286 +183,302 @@

        Enumeration Members

        -
        -

        Enumeration Members

        -
        - -

        - Delete - -

        -
        - Delete: - "DELETE" -
        - -
        -
        - -

        - Get - -

        -
        - Get: - "GET" -
        - -
        -
        - -

        - Head - -

        -
        - Head: - "HEAD" -
        - -
        -
        - -

        - Patch - -

        -
        - Patch: - "PATCH" -
        - -
        -
        - -

        - Post - -

        -
        - Post: - "POST" -
        - -
        -
        - -

        - Put - -

        -
        - Put: - "PUT" -
        - +
        + + +

        Enumeration Members

        +         +
        +
        + +
        + Delete: + "DELETE" +
        + +
        +
        + +
        + Get: + "GET" +
        + +
        +
        + +
        + Head: + "HEAD" +
        + +
        +
        + +
        + Patch: + "PATCH" +
        + +
        +
        +

        + Post +

        +
        + Post: + "POST" +
        + +
        +
        + +
        + Put: + "PUT" +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -428,55 +487,94 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - Delete - Get - Head - Patch - Post - Put +
        + + Enumeration Members + + +
        diff --git a/docs/functions/authGuardFn.html b/docs/functions/authGuardFn.html index 949e79f4..e8c6860e 100644 --- a/docs/functions/authGuardFn.html +++ b/docs/functions/authGuardFn.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
          -
        • - authGuardFn(route, - state): Observable<boolean> - -
          • -
        • -
          +
        • + +
          +
          +

          + Functional AuthGuard to ensure routes can only be accessed + when authenticated. +

          +

          Note: Should only be used as of Angular 15

          +
          +
          +

          Parameters

          +
            +
          • + route: + ActivatedRouteSnapshot +
            +

            + Contains the information about a route associated with + a component loaded in an outlet at a particular moment + in time. +

            +
            +
            • +
          • + state: + RouterStateSnapshot +
            +

            + Represents the state of the router at a moment in + time. +

            +
            +
            • +
          +
          +

          + Returns Observable<boolean> +

          - Functional AuthGuard to ensure routes can only be accessed - when authenticated. + An Observable, indicating if the route can be accessed or not

          -

          Note: Should only be used as of Angular 15

          +
          -
          -

          Parameters

          -
            -
          • - route: - ActivatedRouteSnapshot -
            -

            - Contains the information about a route associated with a - component loaded in an outlet at a particular moment in - time. -

            -
            -
            -
            • -
          • - state: - RouterStateSnapshot -
            -

            - Represents the state of the router at a moment in time. -

            -
            -
            -
            • -
          -
          -

          - Returns Observable<boolean> -

          -

          - An Observable, indicating if the route can be accessed or not -

          -
          -
        @@ -157,123 +189,126 @@

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -285,16 +320,8 @@

        Theme

        diff --git a/docs/functions/authHttpInterceptorFn.html b/docs/functions/authHttpInterceptorFn.html index a980cb15..9b04428a 100644 --- a/docs/functions/authHttpInterceptorFn.html +++ b/docs/functions/authHttpInterceptorFn.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
          -
        • - authHttpInterceptorFn(req, - handle): Observable<HttpEvent<any>> - -
          • -
        • -
          -

          - Functional AuthHttpInterceptor to include the access token in - matching requests. -

          -

          Note: Should only be used as of Angular 15

          -
          -
          -

          Parameters

          -
            -
          • - req: - HttpRequest<any> -
            -

            - An outgoing HTTP request with an optional typed body. -

            -
            -
            -
            • -
          • - handle: - ((req) => Observable<HttpEvent<unknown>>) -
            -

            - Represents the next interceptor in an interceptor chain, - or the real backend if there are no further - interceptors. -

            -
            -
            -
              -
            • -
                -
              • - (req): Observable<HttpEvent<unknown>> -
                • -
              • -
                -

                Parameters

                -
                  -
                • - req: - HttpRequest<unknown> -
                  • -
                -
                -

                - Returns - Observable<HttpEvent<unknown>> -

                -
                • -
              -
              • -
            -
            • -
          -
          -

          - Returns Observable +

          -

          An Observable representing the intercepted HttpRequest

          -
          - + >> +
        +
        +
        +

        + Functional AuthHttpInterceptor to include the access token + in matching requests. +

        +

        Note: Should only be used as of Angular 15

        +
        +
        +

        Parameters

        +
          +
        • + req: + HttpRequest<any> +
          +

          + An outgoing HTTP request with an optional typed body. +

          +
          +
          • +
        • + handle: + (req: + HttpRequest<unknown>) + => + Observable<HttpEvent<unknown>> +
          +

          + Represents the next interceptor in an interceptor + chain, or the real backend if there are no further + interceptors. +

          +
          +
          • +
        +
        +

        + Returns Observable<HttpEvent<any>> +

        +

        An Observable representing the intercepted HttpRequest

        + +
        @@ -225,123 +228,126 @@

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -353,16 +359,8 @@

        Theme

        diff --git a/docs/functions/isHttpInterceptorRouteConfig.html b/docs/functions/isHttpInterceptorRouteConfig.html index 7287cfd3..ddbf0a38 100644 --- a/docs/functions/isHttpInterceptorRouteConfig.html +++ b/docs/functions/isHttpInterceptorRouteConfig.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        +
        +
        +

        + A custom type guard to help identify route definitions that + are actually HttpInterceptorRouteConfig types. +

        +
        +
        +

        Parameters

        + +
        +

        + Returns def + is + HttpInterceptorRouteConfig +

        + +
        @@ -145,123 +178,126 @@

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -273,16 +309,8 @@

        Theme

        diff --git a/docs/functions/provideAuth0.html b/docs/functions/provideAuth0.html index 22869ec0..5f7c773f 100644 --- a/docs/functions/provideAuth0.html +++ b/docs/functions/provideAuth0.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
          -
        • - provideAuth0(config?): Provider[] - -
          • -
        • -
          -

          - Initialize the authentication system. Configuration can either - be specified here, or by calling AuthClientConfig.set (perhaps - from an APP_INITIALIZER factory function). -

          -

          - Note: Should only be used as of Angular 15, and should not be - added to a component's providers. -

          +
        • + -
          -

          Parameters

          -
            -
          • - Optional - config: +
            +
            +

            + Initialize the authentication system. Configuration can + either be specified here, or by calling AuthClientConfig.set + (perhaps from an APP_INITIALIZER factory function). +

            +

            + Note: Should only be used as of Angular 15, and should not + be added to a component's providers. +

            +
            +
            +

            Parameters

            +
              +
            • + Optionalconfig: + AuthConfig +
              +

              The optional configuration for the SDK.

              +
              +
              • +
            +
            +

            + Returns Provider[] +

            +
            +
            + + 
            bootstrapApplication(AppComponent, {
              providers: [
                provideAuth0(),
              ],
            });
+
            +
            +
            +
            -

            - Returns Provider[] -

            -
            -

            Example

            - 
            bootstrapApplication(AppComponent, {
              providers: [
                provideAuth0(),
              ],
            });
-
            + href="https://github.com/auth0/auth0-angular/blob/74b44d4137f4435d3fab3377043ac68e268ae6b8/projects/auth0-angular/src/lib/provide.ts#L23" + >projects/auth0-angular/src/lib/provide.ts:23 +
            • +
          +
          -
        @@ -142,123 +183,126 @@

        Example

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -270,16 +314,8 @@

        Theme

        diff --git a/docs/hierarchy.html b/docs/hierarchy.html index a1ad5c2a..7447dc67 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,7 @@ +
        -
        -

        @auth0/auth0-angular

        -

        Class Hierarchy

        +

        @auth0/auth0-angular

        +

        Hierarchy Summary

        href="https://github.com/auth0/auth0-angular/tree/main/EXAMPLES.md" >Examples - - code samples for common Angular authentication scenario's. + - code samples for common Angular authentication scenario's.
      • Docs site - explore our docs site and learn more about Auth0.
        • - -

        Getting started

        - -

        Requirements

        + +

        This project only supports the Requirements

        >. Whilst other versions might be compatible they are not actively supported.

        - -

        Installation

        +

        Using npm:

        - 
        npm install @auth0/auth0-angular
-
        + 
        npm install @auth0/auth0-angular
+
        +

        We also have ng-add support, so the library can also be installed using the Angular CLI:

        - 
        ng add @auth0/auth0-angular
-
        - -

        Configure Auth0

        + 
        ng add @auth0/auth0-angular
+
        + +

        Create a Single Page Application in the Auth0 DashboardConfigure Auth0

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

        • - Click on the "Settings" tab of your application's + Click on the "Settings" tab of your application's page.
        • @@ -214,30 +276,51 @@

          Configure Auth0

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

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

        - -

        Configure the SDK

        - -

        Static configuration

        + +

        Install the SDK into your application by importing AuthModule.forRoot() and configuring with your Auth0 domain and client id, as well as the URL to which Auth0 should redirect back after succesful authentication:

        - 
        import { NgModule } from '@angular/core';
        import { AuthModule } from '@auth0/auth0-angular';

        @NgModule({
          // ...
          imports: [
            AuthModule.forRoot({
              domain: 'YOUR_AUTH0_DOMAIN',
              clientId: 'YOUR_AUTH0_CLIENT_ID',
              authorizationParams: {
                redirect_uri: window.location.origin,
              },
            }),
          ],
          // ...
        })
        export class AppModule {}
-
        - -

        Dynamic configuration

        + 
        import { NgModule } from '@angular/core';
        import { AuthModule } from '@auth0/auth0-angular';

        @NgModule({
          // ...
          imports: [
            AuthModule.forRoot({
              domain: 'YOUR_AUTH0_DOMAIN',
              clientId: 'YOUR_AUTH0_CLIENT_ID',
              authorizationParams: {
                redirect_uri: window.location.origin,
              },
            }),
          ],
          // ...
        })
        export class AppModule {}
+
        + +

        Instead of using AuthModule.forRoot to specify auth configuration, you can provide a factory function using @@ -249,10 +332,10 @@

        Dynamic configuration

        The configuration will only be used initially when the SDK is instantiated. Any changes made to the configuration at a later moment in time will have no effect on the default options used when - calling the SDK's methods. This is also the reason why the - dynamic configuration should be set using an - APP_INITIALIZER, because doing so ensures the - configuration is available prior to instantiating the SDK. + calling the SDK's methods. This is also the reason why the dynamic + configuration should be set using an APP_INITIALIZER, + because doing so ensures the configuration is available prior to + instantiating the SDK.

        @@ -262,27 +345,32 @@

        Dynamic configuration

        AuthHttpInterceptor. Because the AuthHttpInterceptor requires the existence of configuration settings, the request for retrieving those dynamic - configuration settings should ensure it's not using any of - those interceptors. In Angular, this can be done by manually + configuration settings should ensure it's not using any of those + interceptors. In Angular, this can be done by manually instantiating HttpClient using an injected HttpBackend instance.

        - 
        import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

        // Provide an initializer function that returns a Promise
        function configInitializer(
          handler: HttpBackend,
          config: AuthClientConfig
        ) {
          return () =>
            new HttpClient(handler)
              .get('/config')
              .toPromise()
              // Set the config that was loaded asynchronously here
              .then((loadedConfig: any) => config.set(loadedConfig));
        }

        export class AppModule {
          // ...
          imports: [
            HttpClientModule,
            AuthModule.forRoot(), // <- don't pass any config here
          ],
          providers: [
            {
              provide: APP_INITIALIZER,
              useFactory: configInitializer, // <- pass your initializer function here
              deps: [HttpBackend, AuthClientConfig],
              multi: true,
            },
          ],
          // ...
        }
-
        - -

        - Add login to your application + 
        import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

        // Provide an initializer function that returns a Promise
        function configInitializer(
          handler: HttpBackend,
          config: AuthClientConfig
        ) {
          return () =>
            new HttpClient(handler)
              .get('/config')
              .toPromise()
              // Set the config that was loaded asynchronously here
              .then((loadedConfig: any) => config.set(loadedConfig));
        }

        export class AppModule {
          // ...
          imports: [
            HttpClientModule,
            AuthModule.forRoot(), // <- don't pass any config here
          ],
          providers: [
            {
              provide: APP_INITIALIZER,
              useFactory: configInitializer, // <- pass your initializer function here
              deps: [HttpBackend, AuthClientConfig],
              multi: true,
            },
          ],
          // ...
        }
+
        + +

        To log the user into the application, inject the AuthService and call its loginWithRedirect method.

        - 
        import { Component } from '@angular/core';
        import { AuthService } from '@auth0/auth0-angular';

        @Component({
          selector: 'app-root',
          templateUrl: './app.component.html',
          styleUrls: ['./app.component.css'],
        })
        export class AppComponent {
          constructor(public auth: AuthService) {}

          loginWithRedirect() {
            this.auth.loginWithRedirect();
          }
-
        + 
        import { Component } from '@angular/core';
        import { AuthService } from '@auth0/auth0-angular';

        @Component({
          selector: 'app-root',
          templateUrl: './app.component.html',
          styleUrls: ['./app.component.css'],
        })
        export class AppComponent {
          constructor(public auth: AuthService) {}

          loginWithRedirect() {
            this.auth.loginWithRedirect();
          }
+
        +

        By default the application will ask Auth0 to redirect back to the root URL of your application after authentication. This can be @@ -303,9 +391,16 @@

        >examples.

        - -

        API reference

        -

        Explore public API's available in auth0-angular.

        + +

        Explore public API's available in auth0-angular.

        - -

        Feedback

        - -

        Contributing

        + +

        We appreciate feedback and contribution to this repo! Before you get started, please see the following: @@ -334,27 +443,39 @@

        Contributing

      • Auth0's general contribution guidelinesAuth0's general contribution guidelines
      • Auth0's code of conduct guidelinesAuth0's code of conduct guidelines
        • - -

        Raise an issue

        +

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

        - -

        - Vulnerability Reporting +

        Please do not report security vulnerabilities on the public GitHub @@ -404,123 +525,126 @@

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -529,65 +653,70 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - DocumentationGetting started + DocumentationGetting started - API referenceFeedback + API referenceFeedback
        diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index 0b17d4b6..7ec07920 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        @@ -67,45 +92,52 @@

        Interface AppState

        Angular specific state to be stored before redirect

        -
        - interface AppState - {
            target?: string;
            [key: - string]interface + AppState + {
            target?: + string;
            : any;
        [key: + string]: + any;
        }

        Indexable

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

        Any custom parameter to be stored in appState

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

          Any custom parameter to be stored in appState

          +
          +
          • +
        -
        +
        - + + +
        Index

        Properties

        - + target? @@ -142,164 +177,180 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - target - -

        -
        - target?: - string -
        -
        -

        - Target path the app gets routed to after handling the callback - from Auth0 (defaults to '/') -

        -
        -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + target?: + string +
        +
        +

        + Target path the app gets routed to after handling the callback + from Auth0 (defaults to '/') +

        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -308,35 +359,54 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - target +
        + + Properties + + +
        diff --git a/docs/interfaces/AuthConfig.html b/docs/interfaces/AuthConfig.html index 89df05c9..5c688f1e 100644 --- a/docs/interfaces/AuthConfig.html +++ b/docs/interfaces/AuthConfig.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        @@ -67,187 +92,203 @@

        Interface AuthConfig

        Configuration for the authentication service

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

        Hierarchy

          -
        • +
        • Auth0ClientOptions
            -
          • AuthConfig
            • +
          • + AuthConfig +
        @@ -257,7 +298,7 @@

        Hierarchy

      • Defined in projects/auth0-angular/src/lib/auth.config.ts:107
        • @@ -265,185 +306,290 @@

        Hierarchy

        -
        +
        - + + +
        Index

        Properties

        + > auth0Client? + > authorizationParams? + > authorizeTimeoutInSeconds? + > cache? + > cacheLocation? + > clientId + > cookieDomain? + > domain - + errorPath? - + httpInterceptor? + > httpTimeoutInSeconds? + > issuer? + > leeway? + > legacySameSiteCookie? + > nowProvider? + > sessionCheckExpiryDays? - + skipRedirectCallback? + > useCookiesForTransactions? + useDpop? + + > useFormData? + useMrrt? + + > useRefreshTokens? + > useRefreshTokensFallback? + > workerUrl? @@ -453,1181 +599,1161 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - Internal - auth0Client - -

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

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

        -
        -
        -

        Type declaration

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

        - Optional - authorizationParams - -

        -
        - authorizationParams?: - AuthorizationParams -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - authorizeTimeoutInSeconds - -

        -
        - authorizeTimeoutInSeconds?: - number -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - cache - -

        -
        - cache?: - ICache -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - cacheLocation - -

        -
        - cacheLocation?: - CacheLocation -
        -
        -

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

        -

        - Read more about +

        + + +

        Properties

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

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

        +
        + +
        +
        + +
        + authorizationParams?: + ClientAuthorizationParams +
        +
        +

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

        +
        + +
        +
        + +
        + authorizeTimeoutInSeconds?: + number +
        +
        +

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

        +
        + +
        +
        + +
        + cache?: changing storage options in the Auth0 docsICache -

        -
        -
        - -
        -
        - -

        - clientId - -

        -
        - clientId: - string -
        -
        -

        The Client ID found on your Application settings page

        -
        -
        - -
        -
        - -

        - Optional - cookieDomain - -

        -
        - cookieDomain?: - string -
        -
        -

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

        -

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

        -

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

        -
        -
        - -
        -
        - -

        - domain - -

        -
        - domain: - string -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - errorPath - -

        -
        - errorPath?: - string -
        -
        -

        - Path in your application to redirect to when the Authorization - server returns an error. Defaults to / -

        -
        -
        - -
        -
        - -

        - Optional - httpInterceptor - -

        -
        - httpInterceptor?: - HttpInterceptorConfig -
        -
        -

        - Configuration for the built-in Http Interceptor, used for - automatically attaching access tokens. -

        -
        -
        -
        +
        +

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

        +
        + +
        +
        + +
        + cacheLocation?: + CacheLocation +
        +
        +

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

        +

        + Read more about projects/auth0-angular/src/lib/auth.config.ts:130changing storage options in the Auth0 docs - - - -

        -
        - -

        - Optional - httpTimeoutInSeconds - -

        -
        - httpTimeoutInSeconds?: - number -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - issuer - -

        -
        - issuer?: - string -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - leeway - -

        -
        - leeway?: - number -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - legacySameSiteCookie - -

        -
        - legacySameSiteCookie?: - boolean -
        -
        -

        - Sets an additional cookie with no SameSite attribute to support - legacy browsers that are not compatible with the latest SameSite - changes. This will log a warning on modern browsers, you can - disable the warning by setting this to false but be aware that - some older useragents will not work, See +

        +
        + +
        +
        + +
        + clientId: + string +
        +
        +

        The Client ID found on your Application settings page

        +
        + +
        +
        + +
        + cookieDomain?: + string +
        +
        +

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

        +

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

        +

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

        +
        + +
        +
        + +
        + domain: + string +
        +
        +

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

        +
        + +
        +
        + +
        + errorPath?: + string +
        +
        +

        + Path in your application to redirect to when the Authorization + server returns an error. Defaults to / +

        +
        + +
        +
        + +
        + httpInterceptor?: https://www.chromium.org/updates/same-site/incompatible-clientsHttpInterceptorConfig - Defaults to true -

        -
        -
        - -
        -
        - -

        - Optional - nowProvider - -

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

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

        -

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

        -
        -
        -

        Type declaration

        -
          -
        • -
            -
          • +
            +

            + Configuration for the built-in Http Interceptor, used for + automatically attaching access tokens. +

            +
            +
            • -
          -
        -
        - -
        -
        - -

        - 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 and state parameters, the - SDK will assume they are for an Auth0 application and attempt to - exchange the code for a token. In some cases the code might be - for something else (e.g. another OAuth SDK). In these instances - you can instruct the client to ignore them by setting - skipRedirectCallback. -

        - 
        AuthModule.forRoot({
          skipRedirectCallback: window.location.pathname === '/other-callback'
        })
-
        -

        - Note: In the above example, - /other-callback is an existing route that will be - called by any other OAuth provider with a code (or - error in case when something went wrong) and - state. -

        -
        -
        - +
        +
        + +
        + httpTimeoutInSeconds?: + number +
        +
        +

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

        +
        + +
        +
        + +
        + issuer?: + string +
        +
        +

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

        +
        + +
        +
        + +
        + leeway?: + number +
        +
        +

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

        +
        + +
        +
        + +
        + legacySameSiteCookie?: + boolean +
        +
        +

        + Sets an additional cookie with no SameSite attribute to + support legacy browsers 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 projects/auth0-angular/src/lib/auth.config.ts:124https://www.chromium.org/updates/same-site/incompatible-clients - - - -

        -
        - -

        - Optional - useCookiesForTransactions - -

        -
        - useCookiesForTransactions?: - boolean -
        -
        -

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

        -

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

        -
        -
        -

        Notes

        -

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

        -
        - -
        -
        - -

        - Optional - useFormData - -

        -
        - useFormData?: - boolean -
        -
        -

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

        -

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

        -
        -
        - -
        -
        - -

        - Optional - useRefreshTokens - -

        -
        - useRefreshTokens?: - boolean -
        -
        -

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

        -

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

        -
        -
        - -
        -
        - -

        - Optional - useRefreshTokensFallback - -

        -
        - useRefreshTokensFallback?: - boolean -
        -
        -

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

        -

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

        -

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

        -
        -
        -

        Example

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

        - Optional - workerUrl - -

        -
        - workerUrl?: - string -
        -
        -

        - If provided, the SDK will load the token worker from this URL - instead of the integrated blob. An example of when - this is useful is if you have strict Content-Security-Policy - (CSP) and wish to avoid needing to set - worker-src: blob:. We recommend either serving the - worker, which you can find in the module at - <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN - https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js. -

        -

        - Note: The worker is only used when - useRefreshTokens: true, - cacheLocation: 'memory', and the - cache is not custom. -

        -
        -
        - + Defaults to true +

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

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

        +

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

        +
        + +
        +
        + +
        + sessionCheckExpiryDays?: + number +
        +
        +

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

        +
        + +
        +
        + +
        + skipRedirectCallback?: + boolean +
        +
        +

        + By default, if the page URL has code and state parameters, the + SDK will assume they are for an Auth0 application and attempt + to exchange the code for a token. In some cases the code might + be for something else (e.g. another OAuth SDK). In these + instances you can instruct the client to ignore them by + setting skipRedirectCallback. +

        + 
        AuthModule.forRoot({
          skipRedirectCallback: window.location.pathname === '/other-callback'
        })
+
        + +

        + Note: In the above example, + /other-callback is an existing route that will be + called by any other OAuth provider with a + code (or error in case when + something went wrong) and state. +

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

        +
        +
        +
        + +

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

        +
        +
        + +
        +
        + +
        + useDpop?: + boolean +
        +
        +

        + If true, DPoP (OAuth 2.0 Demonstrating Proof of + Possession, RFC9449) will be used to cryptographically bind + tokens to this specific browser so they can't be used from a + different device in case of a leak. +

        +

        The default setting is false.

        +
        + +
        +
        + +
        + useFormData?: + boolean +
        +
        +

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

        +

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

        +
        + +
        +
        + +
        + useMrrt?: + boolean +
        +
        +

        + If true, the SDK will allow the refreshing of + tokens using MRRT +

        +
        + +
        +
        + +
        + useRefreshTokens?: + boolean +
        +
        +

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

        +

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

        +
        + +
        +
        + +
        + useRefreshTokensFallback?: + boolean +
        +
        +

        + If true, fallback to the technique of using a hidden iframe + and the authorization_code grant with + prompt=none when unable to use refresh tokens. If + false, the iframe fallback is not used and 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. +

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

        + If provided, the SDK will load the token worker from this URL + instead of the integrated blob. An example of + when this is useful is if you have strict + Content-Security-Policy (CSP) and wish to avoid needing to set + worker-src: blob:. We recommend either serving + the worker, which you can find in the module at + <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 + CDN + https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js. +

        +

        + Note: The worker is only used when + useRefreshTokens: true, + cacheLocation: 'memory', and the + cache is not custom. +

        +
        + +
        - +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -1636,135 +1762,270 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - auth0Client - authorizationParams - authorizeTimeoutInSeconds - cache - cacheLocation - clientId - cookieDomain - domain - errorPath - httpInterceptor - httpTimeoutInSeconds - issuer - leeway - legacySameSiteCookie - nowProvider - sessionCheckExpiryDays - skipRedirectCallback - useCookiesForTransactions - useFormData - useRefreshTokens - useRefreshTokensFallback - workerUrl +
        + + Properties + + +
        diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 3d4f4942..2a8fa236 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface AuthorizationParams - {
            interface + AuthorizationParams + {
                    acr_values?: string;
            ?: + string;
                    audience?: string;
            ?: + string;
                    connection?: string;
            ?: + string;
                    display?: "page" | "popup" | "touch" | "wap";
            ?: + "page" + | + "popup" + | + "touch" + | + "wap";
                    id_token_hint?: string;
            ?: + string;
                    invitation?: string;
            ?: + string;
                    login_hint?: string;
            ?: + string;
                    max_age?: string | number;
            ?: + string + | + number;
                    organization?: string;
            ?: + string;
                    prompt?: "none" | "login" | "consent" | "select_account";
            ?: + "none" + | + "login" + | + "consent" + | + "select_account";
                    redirect_uri?: string;
            ?: + string;
                    scope?: string;
            ?: + string;
                    screen_hint?: string;
            ?: + string;
                    ui_locales?: string;
            [key: - string]?: + string;
            : any;
        [key: + string]: + any;
        }
        -
        +

        Indexable

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

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

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

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

          +
          +
          • +
        -
        +
        - + + +
        Index

        Properties

        - + acr_values? - + audience? - + connection? - + display? + > id_token_hint? - + invitation? - + login_hint? - + max_age? + > organization? - + prompt? + > redirect_uri? - + scope? + > screen_hint? - + ui_locales? @@ -327,658 +389,655 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - acr_values - -

        -
        - acr_values?: - string -
        - -
        -
        - -

        - Optional - audience - -

        -
        - audience?: - string -
        -
        -

        The default audience to be used for requesting API access.

        -
        -
        - -
        -
        - -

        - Optional - connection - -

        -
        - connection?: - string -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - display - -

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

        - Optional - id_token_hint - -

        -
        - id_token_hint?: - string -
        -
        -

        Previously issued ID Token.

        -
        -
        - -
        -
        - -

        - Optional - invitation - -

        -
        - invitation?: - string -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - login_hint - -

        -
        - login_hint?: - string -
        -
        -

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

        -

        This currently only affects the classic Lock experience.

        -
        -
        - -
        -
        - -

        - Optional - max_age - -

        -
        - max_age?: - string | number -
        -
        -

        - Maximum allowable 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 organization to log in to.

        -

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

        -
          -
        • - If you provide an Organization ID (a string with the prefix - org_), it will be validated against the - org_id claim of your user's ID Token. The - validation is case-sensitive. -
          • -
        • - If you provide an Organization Name (a string - without the prefix org_), it will be - validated against the org_name claim of your - user's ID Token. The validation is case-insensitive. -
          • -
        -
        -
        - -
        -
        - -

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

        -
        -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + acr_values?: + string +
        + +
        +
        + +
        + audience?: + string +
        +
        +

        + The default audience to be used for requesting API access. +

        +
        + +
        +
        + +
        + connection?: + string +
        +
        +

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

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

        Previously issued ID Token.

        +
        + +
        +
        + +
        + invitation?: + string +
        +
        +

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

        +
        + +
        +
        + +
        + login_hint?: + string +
        +
        +

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

        +

        This currently only affects the classic Lock experience.

        +
        + +
        +
        + +
        + max_age?: + string + | + number +
        +
        +

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

        +
        + +
        +
        + +
        + organization?: + string +
        +
        +

        The organization to log in to.

        +

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

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

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

        +
        + +
        +
        + +
        + scope?: + string +
        +
        +

        The default scope to be used on authentication requests.

        +

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

        +

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

        +
        + +
        +
        + +
        + screen_hint?: + string +
        +
        +

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

        +

        This only affects the New Universal Login Experience.

        +
        + +
        +
        + +
        + ui_locales?: + string +
        +
        +

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

        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -987,87 +1046,158 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - acr_values - audience - connection - display - id_token_hint - invitation - login_hint - max_age - organization - prompt - redirect_uri - scope - screen_hint - ui_locales +
        + + Properties + + +
        diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index dfff72ac..9c13f31f 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface GetTokenSilentlyOptions - {
            interface + GetTokenSilentlyOptions + {
                    authorizationParams?: {
                audience?: string;
                redirect_uri?: string;
                scope?: string;
                [key: - string]?: + {
                audience?: + string;
                redirect_uri?: + string;
                scope?: + string;
                [key: + string]: + any;
            : any;
            };
            }        ;
                    cacheMode?: "off" | "on" | "cache-only";
            ?: + "off"
            | + "on"
            | + "cache-only";
                    detailedResponse?: boolean;
            ?: + boolean;
                    timeoutInSeconds?: number;
        ?: + number;
        } @@ -132,55 +157,68 @@

        Interface GetTokenSilentlyOptions

        • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:324 + node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:361
        -
        +
        - + + +
        Index

        Properties

        + > authorizationParams? - + cacheMode? + > detailedResponse? + > timeoutInSeconds? @@ -190,369 +228,379 @@

        Properties

        -
        -

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

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

          -
          -
          -
          • -
        • -
          - Optional - audience?: string -
          -
          -

          - The audience that was used in the authentication request -

          -
          -
          -
          • -
        • -
          - Optional - redirect_uri?: string -
          -
          -

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

          -
          -
          -
          • -
        • -
          - Optional - scope?: string -
          -
          -

          The scope that was used in the authentication request

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

        - Optional - cacheMode - -

        -
        - cacheMode?: - "off" | "on" | "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. -

        -
        -
        - +
        + + +

        Properties

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

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

          +
          +
          • +
        • +
          + Optionalaudience?: string +
          +
          +

          + The audience that was used in the authentication request +

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

          +
          +
          • +
        • +
          + Optionalscope?: string +
          +
          +

          + The scope that was used in the authentication request +

          +
          +
          • +
        +
        + +
        +
        + +
        + cacheMode?: + "off" + | + "on" + | + "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. +

        +
        + +
        +
        + +
        + detailedResponse?: + boolean +
        +
        +

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

        +

        The default is false.

        +
        + +
        +
        + +
        + timeoutInSeconds?: + number +
        +
        +

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

        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -561,47 +609,78 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - authorizationParams - cacheMode - detailedResponse - timeoutInSeconds +
        + + Properties + + +
        diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 64d5d5a8..5371c091 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface GetTokenWithPopupOptions - {
            interface + GetTokenWithPopupOptions + {
                    authorizationParams?: ?: + AuthorizationParams;
            ;
                    cacheMode?: "off" | "on" | "cache-only";
        ?: + "off" + | + "on" + | + "cache-only";
        }
        -
        +

        - Hierarchy (view fullView Summary)

        @@ -121,41 +142,46 @@

        • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:371 + node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:408
        -
        +
        - + + +
        Index

        Properties

        + > authorizationParams? - + cacheMode? @@ -165,219 +191,231 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - authorizationParams - -

        -
        - authorizationParams?: - AuthorizationParams -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - cacheMode - -

        -
        - cacheMode?: - "off" | "on" | "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. -

        -
        -
        - +

        +
        +

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

        +
        + + +
        + +
        + cacheMode?: + "off" + | + "on" + | + "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 -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -386,41 +424,64 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - authorizationParams - cacheMode +
        + + Properties + + +
        diff --git a/docs/interfaces/HttpInterceptorConfig.html b/docs/interfaces/HttpInterceptorConfig.html index 968f1357..a4954c31 100644 --- a/docs/interfaces/HttpInterceptorConfig.html +++ b/docs/interfaces/HttpInterceptorConfig.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        @@ -69,23 +92,21 @@

        Interface HttpInterceptorConfig

        Configuration for the HttpInterceptor

        -
        - interface HttpInterceptorConfig - {
            interface + HttpInterceptorConfig + {
                    allowedList: : + ApiRouteDefinition[];
        ;
        } @@ -95,7 +116,7 @@

        Interface HttpInterceptorConfig

      • Defined in projects/auth0-angular/src/lib/auth.config.ts:44
        • @@ -103,28 +124,29 @@

        Interface HttpInterceptorConfig

        -
        +
        - + + +
        Index

        Properties

        - + allowedList @@ -134,163 +156,178 @@

        Properties

        -
        -

        Properties

        -
        - -

        - allowedList - -

        -
        - allowedList: - ApiRouteDefinition[] -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + allowedList: + ApiRouteDefinition[] +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -299,35 +336,54 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - allowedList +
        + + Properties + + +
        diff --git a/docs/interfaces/HttpInterceptorRouteConfig.html b/docs/interfaces/HttpInterceptorRouteConfig.html index d4d26ded..94aed57e 100644 --- a/docs/interfaces/HttpInterceptorRouteConfig.html +++ b/docs/interfaces/HttpInterceptorRouteConfig.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        - - - -
        - -

        - Optional - uriMatcher - -

        -
        - uriMatcher?: - ((uri) => boolean) -
        -
        -

        - A function that will be called with the HttpRequest.url value, - allowing you to do any kind of flexible matching. -

        -

        - If this function returns true, then an access token is attached - to the request in the - "Authorization" header. -

        -

        - If it returns false, the request proceeds without the access - token attached. -

        -
        -
        -

        Type declaration

        -
          -
        • -
            -
          • - (uri): boolean -
            • -
          • -
            -

            Parameters

            -
              -
            • - uri: - string -
              • -
            -
            -

            - Returns boolean -

            -
            • -
          -
          • -
        -
        -
        -
        +
        +
        + +

        + '/api' - exactly match the route /api '/api/*' - match any + route that starts with /api/ +

        +
        +
        + + +
        + +
        + uriMatcher?: + (uri: + string) + => + boolean +
        +
        +

        + A function that will be called with the HttpRequest.url value, + allowing you to do any kind of flexible matching. +

        +

        + If this function returns true, then an access token is + attached to the request in the projects/auth0-angular/src/lib/auth.config.ts:79 - - - + href="https://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-20#section-2.1" + >"Authorization" header. +

        +

        + If it returns false, the request proceeds without the access + token attached. +

        +
        + +
        - +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -593,51 +601,86 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - allowAnonymous - httpMethod - tokenOptions - uri - uriMatcher +
        + + Properties + + +
        diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 62b755b4..c8558514 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface ICache - {
            interface + ICache + {
                    allKeys?(): MaybePromise(): + MaybePromise<string[]>;
            ;
                    get<T + = + Cacheable>(key: + string): MaybePromise: + MaybePromise<undefined | T + | + undefined>;
            ;
                    remove(key: + string): MaybePromise: + MaybePromise<void>;
            ;
                    set<T + = + Cacheable>(key, + >key: + string, entry: + T): MaybePromise: + MaybePromise<void>;
        ;
        } @@ -152,55 +195,62 @@

        Implemented by

        • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:62 + node_modules/@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts:63
        -
        +
        - + + +
        Index

        Methods

        - + allKeys? - + get - + remove - + set @@ -210,418 +260,467 @@

        Methods

        -
        -

        Methods

        -
        - -

        - Optional - allKeys - -

        -
          -
        • - allKeys(): MaybePromise<string[]> + + +

          Methods

          +           +
          +
          +
          • -
        • -

          - Returns MaybePromise<string[]> -

          - -
          • -
        -
        -
        - -

        - get - -

        -
          -
        • - get<T>(key): MaybePromise<undefined | T> +

        + + +
        +
        -
        - -

        - remove - -

        -
          -
        • - remove(key): MaybePromise<void>| + undefined> + + +
        + + + +
        +
        -
        - -

        - set - -

        -
        +
        + +
          +
        • + +
          +
          +

          Type Parameters

          + +
          +
          +

          Parameters

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

          + Returns + MaybePromise<void> +

          + +
          +
          • +
        +
        - +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -630,47 +729,78 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - allKeys - get - remove - set +
        + + Methods + + +
        diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 976aa87b..0f15c467 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface IdToken - {
            __raw: string;
            acr?: string;
            address?: string;
            amr?: stringinterface + IdToken + {
            __raw: + string;
            acr?: + string;
            address?: + string;
            amr?: + string[];
            at_hash?: string;
            aud?: string;
            ;
                    at_hash?: + string;
            aud?: + string;
            auth_time?: string;
            azp?: string;
            ?: + string;
                    azp?: + string;
            birthdate?: string;
            c_hash?: string;
            cnf?: string;
            email?: string;
            ?: + string;
                    c_hash?: + string;
            cnf?: + string;
            email?: + string;
            email_verified?: boolean;
            exp?: number;
            ?: + boolean;
                    exp?: + number;
            family_name?: string;
            gender?: string;
            ?: + string;
                    gender?: + string;
            given_name?: string;
            iat?: number;
            iss?: string;
            jti?: string;
            locale?: string;
            ?: + string;
                    iat?: + number;
            iss?: + string;
            jti?: + string;
            locale?: + string;
            middle_name?: string;
            name?: string;
            nbf?: number;
            nickname?: string;
            nonce?: string;
            org_id?: string;
            org_name?: string;
            ?: + string;
                    name?: + string;
            nbf?: + number;
            nickname?: + string;
            nonce?: + string;
            org_id?: + string;
            org_name?: + string;
            phone_number?: string;
            ?: + string;
                    phone_number_verified?: boolean;
            picture?: string;
            ?: + boolean;
                    picture?: + string;
            preferred_username?: string;
            profile?: string;
            sid?: string;
            sub_jwk?: string;
            ?: + string;
                    profile?: + string;
            sid?: + string;
            sub_jwk?: + string;
            updated_at?: string;
            website?: string;
            zoneinfo?: string;
            [key: - string]?: + string;
            website?: + string;
            zoneinfo?: + string;
            : any;
        [key: + string]: + any;
        }
        -
        +

        Indexable

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

        Properties

        - + __raw__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? - + org_name? + > phone_number? + > phone_number_verified? - + picture? + > preferred_username? - + profile? - + sid? - + sub_jwk? - + updated_at? - + website? - + zoneinfo? @@ -551,1082 +734,1061 @@

        Properties

        -
        -

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

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

        Properties

        +         +
        +
        +

        + __raw +

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

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -1635,183 +1797,350 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - __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 - org_name - phone_number - phone_number_verified - picture - preferred_username - profile - sid - sub_jwk - updated_at - website - zoneinfo +
        + + Properties + + +
        diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index b8840710..2d7d4877 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface LogoutOptions - {
            interface + LogoutOptions + {
                    clientId?: null | string;
            ?: + string + | + null;
                    logoutParams?: {
                federated?: boolean;
                returnTo?: string;
                [key: - string]?: + {
                federated?: + boolean;
                returnTo?: + string;
                [key: + string]: + any;
            : any;
            };
            }        ;
                    openUrl?: false | ((?: + false
            | + ((url) => void | Promise: + string) + => + void + | + Promise<void>);
        >)} + >;
        }
        -
        +

        Hierarchy

          -
        • +
        • Omit<SPALogoutOptions, "onRedirect", + "onRedirect">
            -
          • LogoutOptions
            • +
          • + LogoutOptions +
        @@ -140,7 +173,7 @@

        Hierarchy

      • Defined in projects/auth0-angular/src/lib/interfaces.ts:9
        • @@ -148,42 +181,53 @@

        Hierarchy

        -
        +
        - + + +
        Index

        Properties

        + > clientId? + > logoutParams? + > openUrl? @@ -193,412 +237,396 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - clientId - -

        -
        - clientId?: - null | string -
        -
        -

        The clientId of your application.

        -

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

        -

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

        -

        - Read more about how redirecting after logout works -

        -
        -
        - -
        -
        - -

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

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

          -
          -
          -
          • -
        • -
          - Optional - federated?: boolean -
          -
          -

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

          -
          -
          -
          • -
        • -
          - Optional - returnTo?: string -
          -
          -

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

          -

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

          -

          - Read more about how redirecting after logout works -

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

        - Optional - openUrl - -

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

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

        -

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

        -
        -
        -

        Type declaration

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

            Parameters

            -
              -
            • - url: - string -
              • -
            -
            -

            - Returns void | Promise<void> -

            -
            • -
          -
          • -
        -
        -
        -

        Example

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

        Example

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

        await auth0.logout({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
-
        -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + clientId?: + string + | + null +
        +
        +

        The clientId of your application.

        +

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

        +

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

        +

        + Read more about how redirecting after logout works +

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

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

        +
        +
        +

        Type Declaration

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

          + If you need to send custom parameters to the logout + endpoint, make sure to use the original parameter name. +

          +
          +
          • +
        • +
          + Optionalfederated?: boolean +
          +
          +

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

          +
          +
          • +
        • +
          + OptionalreturnTo?: 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 +

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

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

        +

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

        +
        +
        +
        + + 
        await auth0.logout({
          openUrl(url) {
            window.location.replace(url);
          }
        });
+
        +
        +
        + + 
        import { Browser } from '@capacitor/browser';

        await auth0.logout({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
+
        +
        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -607,43 +635,72 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - clientId - logoutParams - openUrl +
        + + Properties + + +
        diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 714cfc59..222978a6 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface PopupConfigOptions - {
            interface + PopupConfigOptions + {
                    popup?: any;
            ?: + any;
                    timeoutInSeconds?: number;
        ?: + number;
        } @@ -87,41 +112,46 @@

        Interface PopupConfigOptions

        • Defined in - node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:311 + node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:348
        -
        +
        - + + +
        Index

        Properties

        - + popup? + > timeoutInSeconds? @@ -131,198 +161,208 @@

        Properties

        -
        -

        Properties

        -
        - -

        - Optional - popup - -

        -
        - popup?: - any -
        -
        -

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

        -
        -
        - -
        -
        - -

        - Optional - timeoutInSeconds - -

        -
        - timeoutInSeconds?: - number -
        -
        -

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

        -
        -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + popup?: + any +
        +
        +

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

        +
        + +
        +
        + +
        + timeoutInSeconds?: + number +
        +
        +

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

        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -331,39 +371,62 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - popup - timeoutInSeconds +
        + + Properties + + +
        diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 0e7ab602..ea63882d 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface PopupLoginOptions - {
            interface + PopupLoginOptions + {
                    authorizationParams?: ?: + AuthorizationParams;
        ;
        }
        -
        +

        - Hierarchy (view fullView Summary)

        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -324,37 +363,56 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - authorizationParams +
        + + Properties + + +
        diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 167545a9..488f28a6 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
        -
        -
        - interface RedirectLoginOptionsinterface + RedirectLoginOptions<TAppState> - {
            {
                    appState?: ?: + TAppState;
            ;
                    authorizationParams?: ?: + AuthorizationParams;
            ;
                    fragment?: string;
            ?: + string;
                    openUrl?: ((?: + (url) => void | Promise: + string) + => + void + | + Promise<void>);
        ;
        } @@ -126,31 +147,32 @@

        Interface RedirectLoginOptions<TAppState>

        Type Parameters

        • - TAppState
        -
        +

        Hierarchy

          -
        • +
        • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect", + "onRedirect">
            -
          • RedirectLoginOptions
            • +
          • + RedirectLoginOptions +
        @@ -160,7 +182,7 @@

        Hierarchy

      • Defined in projects/auth0-angular/src/lib/interfaces.ts:6
        • @@ -168,49 +190,64 @@

        Hierarchy

        -
        +
        - + + +
        Index

        Properties

        + > appState? + > authorizationParams? + > fragment? + > openUrl? @@ -220,340 +257,331 @@

        Properties

        -
        -

        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) => void | Promise<void>) -
        -
        -

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

        -
        -
        -

        Type declaration

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

            Parameters

            -
              -
            • - url: - string -
              • -
            -
            -

            - Returns void | Promise<void> -

            -
            • -
          -
          • -
        -
        -
        -

        Example

        - 
        const client = new Auth0Client({
          openUrl(url) {
            window.location.replace(url);
          }
        });
-
        -

        Example

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

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
-
        -
        - +
        + + +

        Properties

        +         +
        +
        + +
        + appState?: + TAppState +
        +
        +

        Used to store state before doing the redirect

        +
        + +
        +
        + +
        + authorizationParams?: + AuthorizationParams +
        +
        +

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

        +
        + +
        +
        + +
        + fragment?: + string +
        +
        +

        Used to add to the URL fragment before redirecting

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

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

        +
        +
        +
        + + 
        const client = new Auth0Client({
          openUrl(url) {
            window.location.replace(url);
          }
        });
+
        +
        +
        + + 
        import { Browser } from '@capacitor/browser';

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
+
        +
        +
        + +
        -
        +
        -
        +
        -

        - - Settings -

        + +

        Settings
        -

        Member Visibility

        -
        -
          -
        • - Member Visibility +
            +
          • +
            • -
          • - + Protected +
            • +
          • +
            • -
          • - + Inherited +
            • +
          • +
            • -
          -
          • + + External + +
        -

        Theme

        - @@ -562,49 +590,80 @@

        Theme

        -
        +
        -

        - - On This Page -

        + +

        On This Page
        - - appState - authorizationParams - fragment - openUrl +
        + + Properties + + +
        diff --git a/docs/modules.html b/docs/modules.html index 27057dda..e8c0426d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,7 @@ +
        -
        -

        @auth0/auth0-angular

        -
        -
        -

        Index

        -
        -

        Enumerations

        -
        - - HttpMethod +
          +

          @auth0/auth0-angular

          +
          +
          + + +

          Enumerations

          +           +
          +
          + -
          - -
          -

          Classes

          -
          - - AbstractNavigator - - Auth0ClientFactory - - AuthClientConfig - - AuthGuard - - AuthHttpInterceptor - - AuthModule - - AuthService - - AuthState - - AuthenticationError - - GenericError - - InMemoryCache - - LocalStorageCache - - MfaRequiredError - - MissingRefreshTokenError - - PopupCancelledError - - PopupTimeoutError - - TimeoutError - - UserHttpMethod + +
          + + +
          + + +

          Classes

          +           +
          +
          + -
          -
          -
          -

          Interfaces

          -
          - - AppState - - AuthConfig - - AuthorizationParams - - GetTokenSilentlyOptions - - GetTokenWithPopupOptions - - HttpInterceptorConfig - - HttpInterceptorRouteConfig - - ICache - - IdToken - - LogoutOptions - - PopupConfigOptions - - PopupLoginOptions - - RedirectLoginOptionsAbstractNavigator + +
          +
          + -
          -
          -
          -

          Type Aliases

          -
          - - ApiRouteDefinition - - CacheableAuth0ClientFactory + +
          +
          + -
          -
          -
          -

          Variables

          -
          - - Auth0ClientService - - AuthConfigServiceAuthClientConfig + +
          +
          + -
          -
          -
          -

          Functions

          -
          - - authGuardFn - - authHttpInterceptorFn - - isHttpInterceptorRouteConfig - - provideAuth0AuthenticationError + +
          +
          + -
          -
          - - + AuthGuard + +
          +
          + + AuthHttpInterceptor +
          +
          +
          + + AuthModule +
          +
          +
          + + AuthService +
          +
          +
          + + AuthState +
          +
          +
          + + Fetcher +
          +
          +
          + + GenericError +
          +
          +
          + + InMemoryCache +
          +
          +
          + + LocalStorageCache +
          +
          +
          + + MfaRequiredError +
          +
          +
          + + MissingRefreshTokenError +
          +
          +
          + + PopupCancelledError +
          +
          +
          + + PopupTimeoutError +
          +
          +
          + + TimeoutError +
          +
          +
          + + UseDpopNonceError +
          +
          +
          + + User +
          +
          + + +
          + + +

          Interfaces

          +           +
          +
          + + AppState +
          +
          +
          + + AuthConfig +
          +
          +
          + + AuthorizationParams +
          +
          +
          + + GetTokenSilentlyOptions +
          +
          +
          + + GetTokenWithPopupOptions +
          +
          +
          + + HttpInterceptorConfig +
          +
          +
          + + HttpInterceptorRouteConfig +
          +
          +
          + + ICache +
          +
          +
          + + IdToken +
          +
          +
          + + LogoutOptions +
          +
          +
          + + PopupConfigOptions +
          +
          +
          + + PopupLoginOptions +
          +
          +
          + + RedirectLoginOptions +
          +
          +
          +
          +
          + + +

          Type Aliases

          +           +
          +
          + + ApiRouteDefinition +
          +
          +
          + + Cacheable +
          +
          +
          + + CustomFetchMinimalOutput +
          +
          +
          + + FetcherConfig +
          +
          +
          +
          +
          + + +

          Variables

          +           +
          +
          + + Auth0ClientService +
          +
          +
          + + AuthConfigService +
          +
          +
          +
          +
          + + +

          Functions

          +           +
          +
          + + authGuardFn +
          +
          +
          + + authHttpInterceptorFn +
          +
          +
          + + isHttpInterceptorRouteConfig +
          +
          +
          + + provideAuth0 +
          +
          +
          +
          -
          +
          -

          - - Settings -

          + +

          Settings
          -

          Member Visibility

          -
          -
            -
          • - Member Visibility +
              +
            • +
              • -
            • - + Protected +
              • +
            • +
              • -
            • - + Inherited +
              • +
            • +
              • -
            -
            • + + External + +
          -

          Theme

          - @@ -479,19 +1160,505 @@

          Theme

          +
          + + +

          On This Page

          +           +
          +
          + + Enumerations + + +
          +
          + + Classes + + +
          +
          + + Interfaces + + +
          +
          + + Type Aliases + + +
          +
          + + Variables + + +
          +
          + + Functions + + +
          +
          +
          diff --git a/docs/types/ApiRouteDefinition.html b/docs/types/ApiRouteDefinition.html index cd431a57..d267650b 100644 --- a/docs/types/ApiRouteDefinition.html +++ b/docs/types/ApiRouteDefinition.html @@ -1,5 +1,5 @@ - + @@ -12,6 +12,11 @@ +
          -
          -
          - ApiRouteDefinitionApiRouteDefinition: HttpInterceptorRouteConfig | string + > + | + string

          Defines the type for a route config entry. Can either be:

          @@ -81,13 +106,12 @@

          Type alias ApiRouteDefinition

        • a string
          • -