From dc15c7ca10fed0fcd9a33671012888be3fc1697a Mon Sep 17 00:00:00 2001 From: Gyanesh Gouraw Date: Wed, 10 Sep 2025 18:53:37 +0530 Subject: [PATCH] Release v2.3.0 --- .version | 2 +- CHANGELOG.md | 10 + docs/assets/icons.js | 20 + docs/assets/icons.svg | 1 + docs/assets/main.js | 415 +++--- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 62 +- docs/classes/AbstractNavigator.html | 654 +-------- docs/classes/Auth0ClientFactory.html | 636 +-------- docs/classes/AuthClientConfig.html | 667 +-------- docs/classes/AuthGuard.html | 749 ++-------- docs/classes/AuthHttpInterceptor.html | 682 +--------- docs/classes/AuthModule.html | 636 +-------- docs/classes/AuthService.html | 1037 ++++---------- docs/classes/AuthState.html | 817 ++--------- docs/classes/AuthenticationError.html | 924 +++---------- docs/classes/GenericError.html | 866 +++--------- docs/classes/InMemoryCache.html | 621 +-------- docs/classes/LocalStorageCache.html | 761 ++--------- docs/classes/MfaRequiredError.html | 896 +++--------- docs/classes/MissingRefreshTokenError.html | 907 +++--------- docs/classes/PopupCancelledError.html | 883 +++--------- docs/classes/PopupTimeoutError.html | 881 +++--------- docs/classes/TimeoutError.html | 855 ++---------- docs/classes/User.html | 925 +++---------- docs/enums/HttpMethod.html | 708 +--------- docs/functions/authGuardFn.html | 612 +-------- docs/functions/authHttpInterceptorFn.html | 621 +-------- .../isHttpInterceptorRouteConfig.html | 604 +------- docs/functions/provideAuth0.html | 604 +------- docs/hierarchy.html | 321 +++++ docs/index.html | 711 +--------- docs/interfaces/AppState.html | 622 +-------- docs/interfaces/AuthConfig.html | 1032 +++----------- docs/interfaces/AuthorizationParams.html | 826 ++--------- docs/interfaces/GetTokenSilentlyOptions.html | 674 +-------- docs/interfaces/GetTokenWithPopupOptions.html | 654 +-------- docs/interfaces/HttpInterceptorConfig.html | 622 +-------- .../HttpInterceptorRouteConfig.html | 743 ++-------- docs/interfaces/ICache.html | 773 ++--------- docs/interfaces/IdToken.html | 1210 ++++------------- docs/interfaces/LogoutOptions.html | 666 +-------- docs/interfaces/PopupConfigOptions.html | 634 +-------- docs/interfaces/PopupLoginOptions.html | 630 +-------- docs/interfaces/RedirectLoginOptions.html | 741 ++-------- docs/modules.html | 665 +-------- docs/types/ApiRouteDefinition.html | 593 +------- docs/types/Cacheable.html | 591 +------- docs/variables/Auth0ClientService.html | 593 +------- docs/variables/AuthConfigService.html | 593 +------- projects/auth0-angular/package.json | 2 +- 52 files changed, 4196 insertions(+), 27760 deletions(-) create mode 100644 docs/assets/icons.js create mode 100644 docs/assets/icons.svg create mode 100644 docs/hierarchy.html diff --git a/.version b/.version index 93de778c..a6316f06 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.2.3 \ No newline at end of file +v2.3.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 01f5983f..820d6277 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [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) + +**Added** + +- Update Angular to Angular 18 [\#675](https://github.com/auth0/auth0-angular/pull/675) ([frederikprijck](https://github.com/frederikprijck)) +- Incorporate observable of loginWithRedirect in observable returned by AuthGuard [\#660](https://github.com/auth0/auth0-angular/pull/660) ([Mobe91](https://github.com/Mobe91)) +- Add Skip the Auth0 login page to FAQ [\#661](https://github.com/auth0/auth0-angular/pull/661) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.2.3](https://github.com/auth0/auth0-angular/tree/v2.2.3) (2024-01-15) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.2.2...v2.2.3) diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 00000000..0d1c044c --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,20 @@ +(function (svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + 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(/.*#/, '#')); + } + }); + } + } +})( + document.body.appendChild( + document.createElementNS('http://www.w3.org/2000/svg', 'svg') + ) +); diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 00000000..7dead611 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 994f4747..623d0d17 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,9 +1,9 @@ 'use strict'; 'use strict'; (() => { - var Pe = Object.create; + var Ce = Object.create; var ne = Object.defineProperty; - var Ie = Object.getOwnPropertyDescriptor; + var Pe = Object.getOwnPropertyDescriptor; var Oe = Object.getOwnPropertyNames; var _e = Object.getPrototypeOf, Re = Object.prototype.hasOwnProperty; @@ -17,12 +17,12 @@ i !== n && ne(t, i, { get: () => e[i], - enumerable: !(r = Ie(e, i)) || r.enumerable, + enumerable: !(r = Pe(e, i)) || r.enumerable, }); return t; }; var De = (t, e, n) => ( - (n = t != null ? Pe(_e(t)) : {}), + (n = t != null ? Ce(_e(t)) : {}), Fe( e || !t || !t.__esModule ? ne(n, 'default', { value: t, enumerable: !0 }) @@ -182,9 +182,9 @@ (t.tokenizer = function (e, n) { if (e == null || e == null) return []; if (Array.isArray(e)) - return e.map(function (v) { + return e.map(function (y) { return new t.Token( - t.utils.asString(v).toLowerCase(), + t.utils.asString(y).toLowerCase(), t.utils.clone(n) ); }); @@ -410,36 +410,36 @@ l = '^(' + s + ')?' + o + s + '(' + o + ')?$', u = '^(' + s + ')?' + o + s + o + s, d = '^(' + s + ')?' + i, - v = new RegExp(a), - f = new RegExp(u), + y = new RegExp(a), + p = new RegExp(u), b = new RegExp(l), g = new RegExp(d), L = /^(.+?)(ss|i)es$/, - p = /^(.+?)([^s])s$/, + f = /^(.+?)([^s])s$/, m = /^(.+?)eed$/, S = /^(.+?)(ed|ing)$/, w = /.$/, k = /(at|bl|iz)$/, _ = new RegExp('([^aeiouylsz])\\1$'), - H = new RegExp('^' + s + i + '[^aeiouwxy]$'), + B = new RegExp('^' + s + i + '[^aeiouwxy]$'), A = /^(.+?[^aeiou])y$/, j = /^(.+?)(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)$/, - N = + V = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, q = /^(.+?)(s|t)(ion)$/, - P = /^(.+?)e$/, + C = /^(.+?)e$/, z = /ll$/, W = new RegExp('^' + s + i + '[^aeiouwxy]$'), - V = function (c) { - var y, I, T, h, x, O, M; + N = function (c) { + var v, P, T, h, x, O, M; if (c.length < 3) return c; if ( ((T = c.substr(0, 1)), T == 'y' && (c = T.toUpperCase() + c.substr(1)), (h = L), - (x = p), + (x = f), h.test(c) ? (c = c.replace(h, '$1$2')) : x.test(c) && (c = c.replace(x, '$1$2')), @@ -448,16 +448,16 @@ h.test(c)) ) { var E = h.exec(c); - (h = v), h.test(E[1]) && ((h = w), (c = c.replace(h, ''))); + (h = y), h.test(E[1]) && ((h = w), (c = c.replace(h, ''))); } else if (x.test(c)) { var E = x.exec(c); - (y = E[1]), + (v = E[1]), (x = g), - x.test(y) && - ((c = y), + x.test(v) && + ((c = v), (x = k), (O = _), - (M = H), + (M = B), x.test(c) ? (c = c + 'e') : O.test(c) @@ -466,41 +466,41 @@ } if (((h = A), h.test(c))) { var E = h.exec(c); - (y = E[1]), (c = y + 'i'); + (v = E[1]), (c = v + 'i'); } if (((h = j), h.test(c))) { var E = h.exec(c); - (y = E[1]), (I = E[2]), (h = v), h.test(y) && (c = y + e[I]); + (v = E[1]), (P = E[2]), (h = y), h.test(v) && (c = v + e[P]); } if (((h = $), h.test(c))) { var E = h.exec(c); - (y = E[1]), (I = E[2]), (h = v), h.test(y) && (c = y + n[I]); + (v = E[1]), (P = E[2]), (h = y), h.test(v) && (c = v + n[P]); } - if (((h = N), (x = q), h.test(c))) { + if (((h = V), (x = q), h.test(c))) { var E = h.exec(c); - (y = E[1]), (h = f), h.test(y) && (c = y); + (v = E[1]), (h = p), h.test(v) && (c = v); } else if (x.test(c)) { var E = x.exec(c); - (y = E[1] + E[2]), (x = f), x.test(y) && (c = y); + (v = E[1] + E[2]), (x = p), x.test(v) && (c = v); } - if (((h = P), h.test(c))) { + if (((h = C), h.test(c))) { var E = h.exec(c); - (y = E[1]), - (h = f), + (v = E[1]), + (h = p), (x = b), (O = W), - (h.test(y) || (x.test(y) && !O.test(y))) && (c = y); + (h.test(v) || (x.test(v) && !O.test(v))) && (c = v); } return ( (h = z), - (x = f), + (x = p), h.test(c) && x.test(c) && ((h = w), (c = c.replace(h, ''))), T == 'y' && (c = T.toLowerCase() + c.substr(1)), c ); }; return function (R) { - return R.update(V); + return R.update(N); }; })()), t.Pipeline.registerFunction(t.stemmer, 'stemmer'); @@ -718,14 +718,14 @@ } if (s.str.length > 1) { var d = s.str.charAt(0), - v = s.str.charAt(1), - f; - v in s.node.edges - ? (f = s.node.edges[v]) - : ((f = new t.TokenSet()), (s.node.edges[v] = f)), - s.str.length == 1 && (f.final = !0), + y = s.str.charAt(1), + p; + y in s.node.edges + ? (p = s.node.edges[y]) + : ((p = new t.TokenSet()), (s.node.edges[y] = p)), + s.str.length == 1 && (p.final = !0), i.push({ - node: f, + node: p, editsRemaining: s.editsRemaining - 1, str: d + s.str.slice(2), }); @@ -797,19 +797,19 @@ u < o; u++ ) - for (var d = s[u], v = 0; v < l; v++) { - var f = a[v]; - if (f == d || d == '*') { - var b = r.node.edges[f], + for (var d = s[u], y = 0; y < l; y++) { + var p = a[y]; + if (p == d || d == '*') { + var b = r.node.edges[p], g = r.qNode.edges[d], L = b.final && g.final, - p = void 0; - f in r.output.edges - ? ((p = r.output.edges[f]), (p.final = p.final || L)) - : ((p = new t.TokenSet()), - (p.final = L), - (r.output.edges[f] = p)), - i.push({ qNode: g, output: p, node: b }); + f = 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 }); } } } @@ -890,36 +890,36 @@ for (var l = 0; l < n.clauses.length; l++) { var u = n.clauses[l], d = null, - v = t.Set.empty; + y = t.Set.empty; u.usePipeline ? (d = this.pipeline.runString(u.term, { fields: u.fields })) : (d = [u.term]); - for (var f = 0; f < d.length; f++) { - var b = d[f]; + 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 p = 0; p < u.fields.length; p++) { - var m = u.fields[p]; + for (var f = 0; f < u.fields.length; f++) { + var m = u.fields[f]; o[m] = t.Set.empty; } break; } for (var S = 0; S < L.length; S++) for ( - var w = L[S], k = this.invertedIndex[w], _ = k._index, p = 0; - p < u.fields.length; - p++ + var w = L[S], k = this.invertedIndex[w], _ = k._index, f = 0; + f < u.fields.length; + f++ ) { - var m = u.fields[p], - H = k[m], - A = Object.keys(H), + var m = u.fields[f], + B = k[m], + A = Object.keys(B), j = w + '/' + m, $ = new t.Set(A); if ( (u.presence == t.Query.presence.REQUIRED && - ((v = v.union($)), + ((y = y.union($)), o[m] === void 0 && (o[m] = t.Set.complete)), u.presence == t.Query.presence.PROHIBITED) ) { @@ -928,18 +928,18 @@ continue; } if ( - (i[m].upsert(_, u.boost, function (Qe, Ce) { - return Qe + Ce; + (i[m].upsert(_, u.boost, function (Qe, Ie) { + return Qe + Ie; }), !s[j]) ) { - for (var N = 0; N < A.length; N++) { - var q = A[N], - P = new t.FieldRef(q, m), - z = H[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[P]) === void 0 - ? (r[P] = new t.MatchData(w, m, z)) + (W = r[C]) === void 0 + ? (r[C] = new t.MatchData(w, m, z)) : W.add(w, m, z); } s[j] = !0; @@ -947,46 +947,46 @@ } } if (u.presence === t.Query.presence.REQUIRED) - for (var p = 0; p < u.fields.length; p++) { - var m = u.fields[p]; - o[m] = o[m].intersect(v); + for (var f = 0; f < u.fields.length; f++) { + var m = u.fields[f]; + o[m] = o[m].intersect(y); } } for ( - var V = t.Set.complete, R = t.Set.empty, l = 0; + var N = t.Set.complete, R = t.Set.empty, l = 0; l < this.fields.length; l++ ) { var m = this.fields[l]; - o[m] && (V = V.intersect(o[m])), a[m] && (R = R.union(a[m])); + o[m] && (N = N.intersect(o[m])), a[m] && (R = R.union(a[m])); } var c = Object.keys(r), - y = [], - I = Object.create(null); + v = [], + P = Object.create(null); if (n.isNegated()) { c = Object.keys(this.fieldVectors); for (var l = 0; l < c.length; l++) { - var P = c[l], - T = t.FieldRef.fromString(P); - r[P] = new t.MatchData(); + var C = c[l], + T = t.FieldRef.fromString(C); + r[C] = new t.MatchData(); } } for (var l = 0; l < c.length; l++) { var T = t.FieldRef.fromString(c[l]), h = T.docRef; - if (V.contains(h) && !R.contains(h)) { + if (N.contains(h) && !R.contains(h)) { var x = this.fieldVectors[T], O = i[T.fieldName].similarity(x), M; - if ((M = I[h]) !== void 0) + if ((M = P[h]) !== void 0) (M.score += O), M.matchData.combine(r[T]); else { var E = { ref: h, score: O, matchData: r[T] }; - (I[h] = E), y.push(E); + (P[h] = E), v.push(E); } } } - return y.sort(function (Te, ke) { + return v.sort(function (Te, ke) { return ke.score - Te.score; }); }), @@ -1025,9 +1025,9 @@ ); for (var u = 0; u < i.length; u++) { var d = i[u], - v = d[0], - f = d[1]; - r[v] = new t.Vector(f); + y = d[0], + p = d[1]; + r[y] = new t.Vector(p); } for (var u = 0; u < o.length; u++) { var d = o[u], @@ -1087,22 +1087,22 @@ l = a ? a(e) : e[o], u = this.tokenizer(l, { fields: [o] }), d = this.pipeline.run(u), - v = new t.FieldRef(r, o), - f = Object.create(null); - (this.fieldTermFrequencies[v] = f), - (this.fieldLengths[v] = 0), - (this.fieldLengths[v] += d.length); + y = 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]; if ( - (f[g] == null && (f[g] = 0), - (f[g] += 1), + (p[g] == null && (p[g] = 0), + (p[g] += 1), this.invertedIndex[g] == null) ) { var L = Object.create(null); (L._index = this.termIndex), (this.termIndex += 1); - for (var p = 0; p < i.length; p++) - L[i[p]] = Object.create(null); + for (var f = 0; f < i.length; f++) + L[i[f]] = Object.create(null); this.invertedIndex[g] = L; } this.invertedIndex[g][o][r] == null && @@ -1156,24 +1156,24 @@ l = this.fieldLengths[o], u = new t.Vector(), d = this.fieldTermFrequencies[o], - v = Object.keys(d), - f = v.length, + y = Object.keys(d), + p = y.length, b = this._fields[a].boost || 1, g = this._documents[o.docRef].boost || 1, L = 0; - L < f; + L < p; L++ ) { - var p = v[L], - m = d[p], - S = this.invertedIndex[p]._index, + var f = y[L], + m = d[f], + S = this.invertedIndex[f]._index, w, k, _; - i[p] === void 0 - ? ((w = t.idf(this.invertedIndex[p], this.documentCount)), - (i[p] = w)) - : (w = i[p]), + i[f] === void 0 + ? ((w = t.idf(this.invertedIndex[f], this.documentCount)), + (i[f] = w)) + : (w = i[f]), (k = (w * ((this._k1 + 1) * m)) / (this._k1 * @@ -1647,12 +1647,15 @@ constructor() { this.alwaysVisibleMember = null; this.createComponents(document.body), - this.ensureActivePageVisible(), this.ensureFocusedElementVisible(), this.listenForCodeCopies(), window.addEventListener('hashchange', () => this.ensureFocusedElementVisible() - ); + ), + document.body.style.display || + (this.ensureFocusedElementVisible(), + this.updateIndexVisibility(), + this.scrollToHash()); } createComponents(e) { re.forEach((n) => { @@ -1666,18 +1669,47 @@ filterChanged() { this.ensureFocusedElementVisible(); } + showPage() { + document.body.style.display && + (console.log('Show page'), + 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' }); + } + } ensureActivePageVisible() { let e = document.querySelector('.tsd-navigation .current'), n = e?.parentElement; for (; n && !n.classList.contains('.tsd-navigation'); ) n instanceof HTMLDetailsElement && (n.open = !0), (n = n.parentElement); - if (e) { + if (e && !e.checkVisibility()) { let r = e.getBoundingClientRect().top - document.documentElement.clientHeight / 4; document.querySelector('.site-menu').scrollTop = r; } } + updateIndexVisibility() { + let e = document.querySelector('.tsd-index-content'), + n = e?.open; + e && (e.open = !0), + document.querySelectorAll('.tsd-index-section').forEach((r) => { + r.style.display = 'block'; + let i = Array.from(r.querySelectorAll('.tsd-index-link')).every( + (s) => s.offsetParent == null + ); + r.style.display = i ? 'none' : 'block'; + }), + e && (e.open = n); + } ensureFocusedElementVisible() { if ( (this.alwaysVisibleMember && @@ -1775,14 +1807,14 @@ n.addEventListener( 'input', ie(() => { - Ne(t, e, n, r); + Ve(t, e, n, r); }, 200) ); let i = !1; n.addEventListener('keydown', (s) => { (i = !0), s.key == 'Enter' - ? Ve(e, n) + ? Ne(e, n) : s.key == 'Escape' ? n.blur() : s.key == 'ArrowUp' @@ -1803,7 +1835,7 @@ (n.focus(), s.preventDefault())); }); } - function Ne(t, e, n, r) { + function Ve(t, e, n, r) { if (!r.index || !r.data) return; e.textContent = ''; let i = n.value.trim(), @@ -1839,13 +1871,13 @@ l.parent && (d = ` ${ce(l.parent, i)}.${d}`); - let v = document.createElement('li'); - v.classList.value = l.classes ?? ''; - let f = document.createElement('a'); - (f.href = r.base + l.url), - (f.innerHTML = u + d), - v.append(f), - e.appendChild(v); + 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); } } function ue(t, e) { @@ -1864,7 +1896,7 @@ r && (n.classList.remove('current'), r.classList.add('current')); } } - function Ve(t, e) { + function Ne(t, e) { let n = t.querySelector('.current'); if ((n || (n = t.querySelector('li:first-child')), n)) { let r = n.querySelector('a'); @@ -1884,7 +1916,7 @@ (o = n.indexOf(r, s)); return i.push(K(t.substring(s))), i.join(''); } - var Be = { + var He = { '&': '&', '<': '<', '>': '>', @@ -1892,20 +1924,20 @@ '"': '"', }; function K(t) { - return t.replace(/[&<>"'"]/g, (e) => Be[e]); + return t.replace(/[&<>"'"]/g, (e) => He[e]); } - var C = class { + var I = class { constructor(e) { (this.el = e.el), (this.app = e.app); } }; var F = 'mousedown', - pe = 'mousemove', - B = 'mouseup', + fe = 'mousemove', + H = 'mouseup', J = { x: 0, y: 0 }, - fe = !1, + pe = !1, ee = !1, - He = !1, + Be = !1, D = !1, me = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( navigator.userAgent @@ -1913,13 +1945,13 @@ document.documentElement.classList.add(me ? 'is-mobile' : 'not-mobile'); me && 'ontouchstart' in document.documentElement && - ((He = !0), (F = 'touchstart'), (pe = 'touchmove'), (B = 'touchend')); + ((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); }); - document.addEventListener(pe, (t) => { + document.addEventListener(fe, (t) => { if (ee && !D) { let e = F == 'touchstart' ? t.targetTouches[0] : t, n = J.x - (e.pageX || 0), @@ -1927,46 +1959,46 @@ D = Math.sqrt(n * n + r * r) > 10; } }); - document.addEventListener(B, () => { + document.addEventListener(H, () => { ee = !1; }); document.addEventListener('click', (t) => { - fe && (t.preventDefault(), t.stopImmediatePropagation(), (fe = !1)); + pe && (t.preventDefault(), t.stopImmediatePropagation(), (pe = !1)); }); - var X = class extends C { - constructor(n) { - super(n); - (this.className = this.el.dataset.toggle || ''), - this.el.addEventListener(B, (r) => this.onPointerUp(r)), - this.el.addEventListener('click', (r) => r.preventDefault()), - document.addEventListener(F, (r) => this.onDocumentPointerDown(r)), - document.addEventListener(B, (r) => this.onDocumentPointerUp(r)); + var X = class extends I { + constructor(e) { + super(e), + (this.className = this.el.dataset.toggle || ''), + this.el.addEventListener(H, (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)); } - setActive(n) { - if (this.active == n) return; - (this.active = n), - document.documentElement.classList.toggle('has-' + this.className, n), - this.el.classList.toggle('active', n); - let r = (this.active ? 'to-has-' : 'from-has-') + this.className; - document.documentElement.classList.add(r), - setTimeout(() => document.documentElement.classList.remove(r), 500); + setActive(e) { + if (this.active == e) return; + (this.active = e), + document.documentElement.classList.toggle('has-' + this.className, e), + this.el.classList.toggle('active', e); + let n = (this.active ? 'to-has-' : 'from-has-') + this.className; + document.documentElement.classList.add(n), + setTimeout(() => document.documentElement.classList.remove(n), 500); } - onPointerUp(n) { - D || (this.setActive(!0), n.preventDefault()); + onPointerUp(e) { + D || (this.setActive(!0), e.preventDefault()); } - onDocumentPointerDown(n) { + onDocumentPointerDown(e) { if (this.active) { - if (n.target.closest('.col-sidebar, .tsd-filter-group')) return; + if (e.target.closest('.col-sidebar, .tsd-filter-group')) return; this.setActive(!1); } } - onDocumentPointerUp(n) { - if (!D && this.active && n.target.closest('.col-sidebar')) { - let r = n.target.closest('a'); - if (r) { - let i = window.location.href; - i.indexOf('#') != -1 && (i = i.substring(0, i.indexOf('#'))), - r.href.substring(0, i.length) == i && + onDocumentPointerUp(e) { + if (!D && this.active && e.target.closest('.col-sidebar')) { + let n = e.target.closest('a'); + if (n) { + let r = window.location.href; + r.indexOf('#') != -1 && (r = r.substring(0, r.indexOf('#'))), + n.href.substring(0, r.length) == r && setTimeout(() => this.setActive(!1), 250); } } @@ -1984,58 +2016,53 @@ }; } var Q = te; - var ve = document.head.appendChild(document.createElement('style')); - ve.dataset.for = 'filters'; - var Y = class extends C { - constructor(n) { - super(n); - (this.key = `filter-${this.el.name}`), + 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()), - (ve.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`); + (ye.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`), + this.app.updateIndexVisibility(); } fromLocalStorage() { - let n = Q.getItem(this.key); - return n ? n === 'true' : this.el.checked; + let e = Q.getItem(this.key); + return e ? e === 'true' : this.el.checked; } - setLocalStorage(n) { - Q.setItem(this.key, n.toString()), - (this.value = n), + 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(), - document.querySelectorAll('.tsd-index-section').forEach((n) => { - n.style.display = 'block'; - let r = Array.from(n.querySelectorAll('.tsd-index-link')).every( - (i) => i.offsetParent == null - ); - n.style.display = r ? 'none' : 'block'; - }); + this.app.updateIndexVisibility(); } }; - var Z = class extends C { - constructor(n) { - super(n); - (this.summary = this.el.querySelector('.tsd-accordion-summary')), + 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 r = Q.getItem(this.key); - (this.el.open = r ? r === 'true' : this.el.open), + let n = Q.getItem(this.key); + (this.el.open = n ? n === 'true' : this.el.open), this.el.addEventListener('toggle', () => this.update()); - let i = this.summary.querySelector('a'); - i && - i.addEventListener('click', () => { - location.assign(i.href); + let r = this.summary.querySelector('a'); + r && + r.addEventListener('click', () => { + location.assign(r.href); }), this.update(); } @@ -2047,12 +2074,12 @@ function ge(t) { let e = Q.getItem('tsd-theme') || 'os'; (t.value = e), - ye(e), + ve(e), t.addEventListener('change', () => { - Q.setItem('tsd-theme', t.value), ye(t.value); + Q.setItem('tsd-theme', t.value), ve(t.value); }); } - function ye(t) { + function ve(t) { document.documentElement.dataset.theme = t; } var Le; @@ -2068,7 +2095,9 @@ i = await new Response(r).json(); (Le = t.dataset.base + '/'), (t.innerHTML = ''); for (let s of i) we(s, t, []); - window.app.createComponents(t), window.app.ensureActivePageVisible(); + window.app.createComponents(t), + window.app.showPage(), + window.app.ensureActivePageVisible(); } function we(t, e, n) { let r = e.appendChild(document.createElement('li')); @@ -2096,7 +2125,7 @@ let r = e.appendChild(document.createElement('a')); (r.href = Le + t.path), n && (r.className = n), - location.href === r.href && r.classList.add('current'), + location.pathname === r.pathname && r.classList.add('current'), t.kind && (r.innerHTML = ``), (r.appendChild(document.createElement('span')).textContent = t.text); diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 12e63c60..79c530f9 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1,2 @@ window.navigationData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAE6WWQXPTMBCF/4vPKWkDLdBbJ9CSmQY6SRkODAdVXsc7dSQjyRkCw39Hlksiy5Lsca7ep+9Zq/Wzvv9JFPxSyXXySalyCSrnaTJJSqJy/QxYtZXTY+VVrraFLj8jS5Prd38nh9U3T1IJQtVnssMNUVwcIbQgUoKcdiRt2sWsxatUfj4vEJi61Wu42HuAHU0fsRHPOctw4+fZij7aXUVE6seYUt/6uq8LpkBQKP0d64r6mEueVgX4UU2tj7AGsUMaQLwUexmKqBChLvWt10eAlCjk7KMQoc44og5z0qj1KiXTM5Rnmg+CkSKx3O6AgUAasLGr4/gLtoStnsw5obmnI63yOId7Tkmx1qNBNhBw6UjGOS0zsoKfFQpIA/1yFSN9UEpkmxVkAmT+yJ8hNAYh5TjfB15W5ZwwCkUR3KJHdILbI26BVyrmZUvGOcVNTud/leDh1k/H8W7K0gkQrAMwI7T+8l+KbfTs8sqNeifkbcSh3AfhAn+bhHkggmxlkOboOtiBUaTMBK+x0NFW7L+UNdFvGtCeZvwNVW5GboizKx5n7fzdIofmVcbOz1mw0jMOw/mWPGaycBLXAi48STu0LYvU9NjPbWrjwPd8ozcWO9+WIrb1JghNh2K8rmzcmxuOfjlkvW62apzZClL9D6Oq188njIZKiWayPkCGDGv5Eav2pck3V+Hwzt+/vbicWUwzZ+TJvvU1qEPBSxgWxccrdudeuCMCa3rrIu69IL6eecO5h9gSRYDk/3371mpmVjFqTmNqlduQqzcOxImAMK4jjIBRDgmiIz+mj9iUgu8wBXMSPqxd72B+/AN1KrDXBg4AAA=='; + '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=='; diff --git a/docs/assets/search.js b/docs/assets/search.js index 2201de8e..91da3b01 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1,2 @@ window.searchData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAE61b227bSBL9F3kfDcfsC2n7LZvszARIdgbJXh6CIGCotkWEJgmScjYw8u/b3STFKqqKakl+MmSdunSdqq6+6XnVVD/a1d3n59X3vFyv7iJxc7kq00ezulu93nabT6Z5yjOzulxtm8L+LyvStjXtK/Dd1aZ7LCxg+MqCVr8uR306Ejt9WVW2XbPNuqo5qO8Cg4Huy1WdNqbsZg5OJqNroXY28/Z9la7z8uFvh03usF/Ps+hAFp5naWfWQXaRxFnWt61pAkw62HmjXP+r+m7KN0WaP7YhY4T4syybpqlChuhxZ1lK6/pTZxkJMDZCj7UnrtVUb+XDn+VbY7O++nnYIgafbLOoHvLyv3m3+WjWeWOy7rBlSuR8+39V9bY+wviIP8dytQ0bbo872dKD6V5nmWlbXwKf8sJKFgEUs3Iv5MkRYecFT/Zlk5brwow59CYtim9p9v2wK6zcUXU+a3MfqvW2oLtc/9Vik0Pjuq+aj1VFJxbQdTHheMcHt05rp9BYaDfdMzgP1O/btFmT5vw3L7YWmLQF+967xrCSpaVr7gdt7WCn23mddfmT7QUBtgD0fHtvNnkRMsA5PtzyPBn+6Lr6XdmZJjM1R+QM82IJQukNTpW540xw8xES7gEUOcV+DBeSM9hH24fMm6q8zx92Dt1vS0unHfarJfhi1KfxOgUfTLeppjQy5faxfTV9sagpineqfjfdso6LHkHHCDhCav+rag+pHyAn6t8eVL+wJDioPe2yzSH9A+Y0C29NYcAERJvYgU6z8YdJD6TJxQA5Qr+4vk0iPc0Cr+vcp/Fbc5+XuUv0ncnuZ+0KcQ+w3Kl1jLIdlMussHwh36d2zfOKBC4XAtpGFEX1w6zf5yBng7RfYEk+jPujCBoxNZ/wjoVOJ3g72uQnqL7oxYIGDAfBO/HBlZNpTvRlkj7DpVhrOVHx9avL3/P8udopOdatKzAoJmidW+j/WfvecoqbM/mX4nKz36KOcApJv5RLvkpfl1X587HanhSrPQ1nuAbr3S01+Pqevg2v5/Z7XrNbNl73BSPHr5AOZwG18FzwYF/kVOP+YMn2502IWQg+wiBicThbIs0N34Uz2KXNgyEbEdJ1scMxXo9OTWakIBJvfn78lDZ5+q1AkQo5R55vPd4UuXVkltxwdQ4BL7bp2FMavONA/jLbjdbQG419q+0SM4HWHoKtLeYBb21O2XWP+y11waKPvzAk/Mwla4zb0HrhUMUXMyF+fDPHT0sd0oPA5GEdmJXcgFuuOQw6qujwNIRO6A5OQkddBE3TUPA10GwyOuoSaDIXegW0bC3kAgjaPOb6Z8nywuXPZC7g6mdxdAEXP2BsR1z7LFlduvSZrIVc+cyszCfgd2MCHLI1w55osTH3jWk3h4xNsNNHBs7vA8aG0adb/YejJMDeiDvCElgijUvL9+52aGHTQuGCzwve+4ugBe0IsKgWnPLVTfWUr42fmYlTPfh1qMp0PLr9rSQ0gm+PUTjbfLCq93DhHeabnelti/tn+pQ/pGRvmCNepuOQWsM6z57L3NVuDzB///nvpgj1YC4U7MOXS5uWa/O/1d3z6sk0rTs2u1uJK3l1ayXvc1Os3ZuP3jmrt3p8dLq+DN/9x7hBO0QPeWUT8/P1pby9itWXL5efRwH/f/8Pj4rsp+hSiCtxi2ERggn7SVxKdaWlQDCBYNJ+khRMIpiynxQFUwim7SdNwTSCxfZTTMFiBEvsp4SCJQh2Yz/dEGG7QShLyedbAnWLg+tiHVEkRDMWPA0RBcQ8RC7etkQIIGYichGPJAXEXEQu5pGigJiNyEU90hQQ8xG5uEcxBcSMRAmbfJiTyAU/SiiNmJboltWImRGeGYpngZkRnhmKajGrEF8iFNcCMyNc/AXFtcDMCMUNRmBmhIu/oJJCYGaEi7+gkkJgZoSLvyBLVGBqhCNAkFUqMDfCMSCotBCYG+kYEBTbEnMjHQOCIlFibqTnhiJRzuYvP4FRJErMjXQMSIpEibmRjgFJcSMxN9IxICluJOZGOgIkVbASUyNd/CVVsBIzI138JcWMxMwoF39JMaMwM8rFX1LMKMyMEmyiKUyN8tRQHKpZc/HdheJQYWqUI0BRHCpMjXIEKIpDhalRjgBFcagwNeqGa0YKU6McAYoiW2FqtCNAUWRrTI12BCiKbI2p0YKbfjRmRrv4KyorNGZGK3au0LPO76mh8kdjarSnhsoKjanRbK/RmBrtCNBU+mhMjXYEaCp9NKYmvuZMx5iaOOJWWTGmJhbcOivG1MSSW2nFmJpYcWutGDMTa3a1NVuVufhrqmhizEzs4q+pookxM7FnhqqFGDMTe2aoWogxM4mLv6ZqIcHMJC7+mkrxBDOTuPhrKnETzEzi4q+pxE0wM4mLf0zlY4KZSTwzVD4mmJkk5vIxma2YXfxjisKkZ8ZvWexepTPrd/3WxW4+xvvN59XXYT9jO8awpXpe2UZx9/zr17R/cZ+c6nTYEZXTRnLSYIe102BHw2hwF3LpdCEHHLgFDsglcbMu/L09kJWTrO3EjGydN+5ibw1ePAAVwHu7POBU1G1/UjsJgrglDni5su2BEXdnDZk/JL4fz+onRdOm9nml2fhNKtrxMHpSYafEScWSF72GbLjkAT7EQEG0pGBfFNhWbAB3ooT3tjNOxtkUtBoe+qeSk2QESIiWxu0l7xHxGuRdwuadlXX3nDm855x0CJA84ggd2JMYRDBZiuDj8KYWBACELlrKHSLswOpS0PcSX4NB225KS2Zpme6eYgJ/QdAFl2dANutfVIKIA6/t3o1VUPg3p8AwKDLBDRcdUAFZEOO+0qOh4qPb/q9Q/V8thr/D9/F1/zfh5qb+xiwbbsxASYA4aU54PTw3A9EBYpKLjukPhkH+TULx4DeXSl629pfvwFkwC6uEkbyvrGiFBhkBwxE3SH9VCkYIEl7cDNHmasbKpv7U3T+daXfP/YELArjABQyr+ZF3m7p/qg/0gBBE3ETQv7NvhhPzbPdoA6hRQA03qo3BqS1BSUjWNj+JKRADxdEwk99vAxJokVz6zLT4tkyoAlGQXD45VY/DwyOQHkBUjG2Z4zVfe0Izf5WGZjhQfENBcGSA18nACxALwcUib1N4SYkCAMY/2GfH0IbFVACdgiM5b4vx+g1IAsHBGW7i9j8lousD5GjETb878Wb3M6hJA5jZuJ4z/q4ImIVT94LXVqwab6FAGsAlHic9Xil8++luIOCsCgKXcFlcPlQWPfzmbJIFzYpb1dT9c2bAExCSnLd1hRfQAkzBgovrcGOW9hdqID7AYsIlaI0ZESCmkkuEkX+fEBQxwOuEVzLc8AI5UAQxR0mLG44CDmtudm1Rh0AmwYQUc1xa8b2mrMEkFHPMWEGyZjXIvZirdveCcKkZKVA8ipvFxkdtQAyMWHGO+zgRzEqQUopLYv+WGciASEkuxFbmcXxzDERBIknOV/e8Aw0QuDhMiGRe2A14ndemyEuL/fzl16//Awp3ycYbPgAA'; + '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='; diff --git a/docs/assets/style.css b/docs/assets/style.css index 272877ee..bcb7d05c 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -29,7 +29,7 @@ --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: var(--light-color-ts-type-alias); + --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); @@ -69,7 +69,7 @@ --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: var(--dark-color-ts-type-alias); + --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); @@ -262,12 +262,12 @@ h6 { line-height: 1.2; } -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { +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); } @@ -323,17 +323,14 @@ dd { } /* Footer */ -.tsd-generator { +footer { border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; max-height: 3.5rem; } - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; +.tsd-generator { + margin: 0 1em; } .container-main { @@ -401,7 +398,8 @@ dd { } body { background: var(--color-background); - font-family: 'Segoe UI', sans-serif; + 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); } @@ -645,6 +643,28 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { font-weight: bold; } +.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-panel-group.tsd-index-group { margin-bottom: 0; } @@ -710,12 +730,15 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; + display: flex; + width: calc(100% - 0.25rem); align-items: center; padding: 0.25rem; color: var(--color-text); @@ -755,11 +778,6 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - .tsd-page-navigation ul { padding-left: 1.75rem; } diff --git a/docs/classes/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index bfd7de66..56713b3f 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
@@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
@@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -61,7 +68,7 @@

Class AbstractNavigator

  • Defined in projects/auth0-angular/src/lib/abstract-navigator.ts:8
    • @@ -78,7 +85,7 @@

    Class AbstractNavigator

    tabindex="0" > - + Index @@ -91,7 +98,7 @@

    Constructors

    href="AbstractNavigator.html#constructor" class="tsd-index-link" > - constructor @@ -103,7 +110,7 @@

    Methods

    href="AbstractNavigator.html#navigateByUrl" class="tsd-index-link" > - navigateByUrl @@ -122,7 +129,8 @@

    href="#constructor" aria-label="Permalink" class="tsd-anchor-icon" - > +

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 00000000..a1ad5c2a --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1,321 @@ + + + + + + @auth0/auth0-angular + + + + + + + + + + + +
    +
    + +
    + + +
    +
    +
    +
    +
    +

    @auth0/auth0-angular

    +

    Class Hierarchy

    + + + +
    +
    +
    +
    +
    + +

    + + Settings +

    +     +
    +
    +

    Member Visibility

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

    Theme

    + +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +
    + + diff --git a/docs/index.html b/docs/index.html index a554dce0..e81d9a66 100644 --- a/docs/index.html +++ b/docs/index.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -134,7 +141,7 @@

    Requirements

    This project only supports the actively supported versions of Angular as stated in the Angular documentation. Whilst other versions might be compatible they are not actively @@ -401,7 +408,7 @@

    - Settings

    @@ -526,98 +533,64 @@

    Theme

    - On This Page

    + DocumentationGetting started + API referenceFeedback +
    @@ -626,7 +599,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index fc7d231e..0b17d4b6 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -64,8 +71,8 @@

    Interface AppState

    interface AppState {
        AppState + {
        target?: stringIndexable

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:142
    • @@ -115,7 +122,7 @@

    Indexable

    tabindex="0" > - + Index @@ -126,7 +133,7 @@

    Properties

    - target?
    @@ -143,7 +150,8 @@

    Optional target +

    @@ -163,7 +171,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:147
    • @@ -179,7 +187,7 @@

    - Settings

    @@ -304,20 +312,16 @@

    Theme

    - On This Page

    - + + target
    @@ -325,7 +329,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/AuthConfig.html b/docs/interfaces/AuthConfig.html index 2c7bcbda..89df05c9 100644 --- a/docs/interfaces/AuthConfig.html +++ b/docs/interfaces/AuthConfig.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -64,8 +71,8 @@

    Interface AuthConfig

    interface AuthConfig {
        AuthConfig + {
        auth0Client?: Hierarchy

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:107
    • @@ -267,7 +274,7 @@

    Hierarchy

    tabindex="0" > - + Index @@ -280,21 +287,21 @@

    Properties

    href="AuthConfig.html#auth0Client" class="tsd-index-link tsd-is-inherited tsd-is-external" > - auth0Client? - authorizationParams? - authorizeTimeoutInSeconds?Properties href="AuthConfig.html#cache" class="tsd-index-link tsd-is-inherited tsd-is-external" > - cache? - cacheLocation? - clientId - cookieDomain? - domain - errorPath? - httpInterceptor? - httpTimeoutInSeconds?Properties href="AuthConfig.html#issuer" class="tsd-index-link tsd-is-inherited tsd-is-external" > - issuer? - leeway? - legacySameSiteCookie?Properties href="AuthConfig.html#nowProvider" class="tsd-index-link tsd-is-inherited tsd-is-external" > - nowProvider? - sessionCheckExpiryDays?Properties href="AuthConfig.html#skipRedirectCallback" class="tsd-index-link" > - skipRedirectCallback? - useCookiesForTransactions?Properties href="AuthConfig.html#useFormData" class="tsd-index-link tsd-is-inherited tsd-is-external" > - useFormData? - useRefreshTokens? - useRefreshTokensFallback?Properties href="AuthConfig.html#workerUrl" class="tsd-index-link tsd-is-inherited tsd-is-external" > - workerUrl? @@ -460,7 +467,8 @@

    href="#auth0Client" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -570,7 +578,8 @@

    href="#authorizationParams" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -611,7 +620,8 @@

    href="#authorizeTimeoutInSeconds" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -645,7 +655,8 @@

    Optional cache +

    @@ -686,7 +697,8 @@

    href="#cacheLocation" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -729,7 +741,8 @@

    href="#clientId" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -762,7 +775,8 @@

    href="#cookieDomain" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -803,7 +817,8 @@

    domain +

    @@ -842,7 +857,8 @@

    href="#errorPath" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -862,7 +878,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:136
    • @@ -878,7 +894,8 @@

    href="#httpInterceptor" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -902,7 +919,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:130
    • @@ -920,7 +937,8 @@

    href="#httpTimeoutInSeconds" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -954,7 +972,8 @@

    Optional issuer +

    @@ -987,7 +1006,8 @@

    Optional leeway +

    @@ -1024,7 +1044,8 @@

    href="#legacySameSiteCookie" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1069,7 +1090,8 @@

    href="#nowProvider" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1087,6 +1109,16 @@

    >>)

    +
    +

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

    +

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

    +

    Type declaration

      @@ -1107,16 +1139,6 @@

      Type declaration

      >>
    • -
      -

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

      -

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

      -

      Returns number | >number>

      -
    +
    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/HttpInterceptorConfig.html b/docs/interfaces/HttpInterceptorConfig.html index cc0ffbd9..968f1357 100644 --- a/docs/interfaces/HttpInterceptorConfig.html +++ b/docs/interfaces/HttpInterceptorConfig.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -66,8 +73,8 @@

    Interface HttpInterceptorConfig

    interface HttpInterceptorConfig {
        HttpInterceptorConfig + {
        Interface HttpInterceptorConfig
  • Defined in projects/auth0-angular/src/lib/auth.config.ts:44
    • @@ -105,7 +112,7 @@

    Interface HttpInterceptorConfig

    tabindex="0" > - + Index @@ -118,7 +125,7 @@

    Properties

    href="HttpInterceptorConfig.html#allowedList" class="tsd-index-link" > - allowedList
    @@ -137,7 +144,8 @@

    href="#allowedList" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -154,7 +162,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:45
    • @@ -170,7 +178,7 @@

    - Settings

    @@ -295,20 +303,16 @@

    Theme

    - On This Page

    - + + allowedList
    @@ -316,7 +320,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/HttpInterceptorRouteConfig.html b/docs/interfaces/HttpInterceptorRouteConfig.html index 150b3b70..d4d26ded 100644 --- a/docs/interfaces/HttpInterceptorRouteConfig.html +++ b/docs/interfaces/HttpInterceptorRouteConfig.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -68,8 +75,8 @@

    Interface HttpInterceptorRouteConfig

    interface HttpInterceptorRouteConfig {
        HttpInterceptorRouteConfig + {
        Interface HttpInterceptorRouteConfig
  • Defined in projects/auth0-angular/src/lib/auth.config.ts:51
    • @@ -140,7 +147,7 @@

    Interface HttpInterceptorRouteConfig

    tabindex="0" > - + Index @@ -153,35 +160,35 @@

    Properties

    href="HttpInterceptorRouteConfig.html#allowAnonymous" class="tsd-index-link" > - allowAnonymous? - httpMethod? - tokenOptions? - uri? - uriMatcher?
    @@ -201,7 +208,8 @@

    href="#allowAnonymous" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -225,7 +233,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:101
    • @@ -241,7 +249,8 @@

    href="#httpMethod" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -263,7 +272,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:94
    • @@ -279,7 +288,8 @@

    href="#tokenOptions" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -303,7 +313,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:85
    • @@ -316,7 +326,8 @@

    Optional uri +

    @@ -356,7 +367,7 @@

    Usagenotes

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:67
    • @@ -372,7 +383,8 @@

    href="#uriMatcher" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -386,6 +398,24 @@

    >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

      @@ -399,51 +429,34 @@

      Type declaration

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

      -

      Parameters

      • -
        - uri: - string -
        + uri: + string

      Returns boolean

      -
    +
    @@ -633,7 +630,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 7507231a..62b755b4 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -58,8 +65,8 @@

    Interface ICache

    interface ICache {
        ICache + {
        Interface ICache >get<TT>(keyInterface ICache ><undefined | TT>;
        Interface ICache >set<TT>(key, @@ -151,7 +167,7 @@

    Implemented by

    tabindex="0" > - + Index @@ -164,28 +180,28 @@

    Methods

    href="ICache.html#allKeys" class="tsd-index-link tsd-is-external" > - allKeys? - get - remove - set
    @@ -202,7 +218,8 @@

    Optional allKeys +

      @@ -221,7 +238,8 @@

      href="#allKeys.allKeys-1" aria-label="Permalink" class="tsd-anchor-icon" - > +
    • @@ -248,7 +266,8 @@

      get +

        @@ -256,8 +275,10 @@

        get<TT>(key ><undefined | TT> +
      • @@ -282,14 +306,15 @@

        Type Parameters

        @@ -297,10 +322,10 @@

        Parameters

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

    @@ -309,8 +334,10 @@

    ><undefined | TT>

    @@ -385,7 +414,8 @@

    set +

      @@ -393,8 +423,10 @@

      set<TT>(key, @@ -409,7 +441,8 @@

      href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon" - > +
    • @@ -417,14 +450,15 @@

      Type Parameters

      @@ -432,18 +466,20 @@

      Parameters

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

    @@ -473,7 +509,7 @@

    - Settings

    @@ -598,41 +634,28 @@

    Theme

    - On This Page

    - + + allKeys + get + remove + set
    @@ -640,7 +663,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 0c0154ef..976aa87b 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -58,8 +65,8 @@

    Interface IdToken

    interface IdToken {
        IdToken + {
        __raw: stringIndexable

    tabindex="0" > - + Index @@ -276,266 +283,266 @@

    Properties

    href="IdToken.html#__raw" class="tsd-index-link tsd-is-external" > - __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,7 +558,8 @@

    Properties

    __raw +

    @@ -574,7 +582,8 @@

    Optional acr +

    @@ -597,7 +606,8 @@

    Optional address +

    @@ -620,7 +630,8 @@

    Optional amr +

    @@ -644,7 +655,8 @@

    Optional at_hash +

    @@ -667,7 +679,8 @@

    Optional aud +

    @@ -693,7 +706,8 @@

    href="#auth_time" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -716,7 +730,8 @@

    Optional azp +

    @@ -742,7 +757,8 @@

    href="#birthdate" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -765,7 +781,8 @@

    Optional c_hash +

    @@ -788,7 +805,8 @@

    Optional cnf +

    @@ -811,7 +829,8 @@

    Optional email +

    @@ -837,7 +856,8 @@

    href="#email_verified" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -860,7 +880,8 @@

    Optional exp +

    @@ -886,7 +907,8 @@

    href="#family_name" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -909,7 +931,8 @@

    Optional gender +

    @@ -935,7 +958,8 @@

    href="#given_name" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -958,7 +982,8 @@

    Optional iat +

    @@ -981,7 +1006,8 @@

    Optional iss +

    @@ -1004,7 +1030,8 @@

    Optional jti +

    @@ -1027,7 +1054,8 @@

    Optional locale +

    @@ -1053,7 +1081,8 @@

    href="#middle_name" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1076,7 +1105,8 @@

    Optional name +

    @@ -1099,7 +1129,8 @@

    Optional nbf +

    @@ -1125,7 +1156,8 @@

    href="#nickname" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1148,7 +1180,8 @@

    Optional nonce +

    @@ -1171,7 +1204,8 @@

    Optional org_id +

    @@ -1197,7 +1231,8 @@

    href="#org_name" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1223,7 +1258,8 @@

    href="#phone_number" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1249,7 +1285,8 @@

    href="#phone_number_verified" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1273,7 +1310,8 @@

    Optional picture +

    @@ -1299,7 +1337,8 @@

    href="#preferred_username" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1322,7 +1361,8 @@

    Optional profile +

    @@ -1345,7 +1385,8 @@

    Optional sid +

    @@ -1368,7 +1409,8 @@

    Optional sub_jwk +

    @@ -1394,7 +1436,8 @@

    href="#updated_at" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1417,7 +1460,8 @@

    Optional website +

    @@ -1443,7 +1487,8 @@

    href="#zoneinfo" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -1469,7 +1514,7 @@

    - Settings

    @@ -1594,279 +1639,164 @@

    Theme

    - 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
    @@ -1874,7 +1804,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 7fd92e0e..b8840710 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -58,8 +65,8 @@

    Interface LogoutOptions

    interface LogoutOptions {
        LogoutOptions + {
        clientId?: Hierarchy
  • Defined in projects/auth0-angular/src/lib/interfaces.ts:7projects/auth0-angular/src/lib/interfaces.ts:9
    • @@ -150,7 +157,7 @@

    Hierarchy

    tabindex="0" > - + Index @@ -163,21 +170,21 @@

    Properties

    href="LogoutOptions.html#clientId" class="tsd-index-link tsd-is-inherited tsd-is-external" > - clientId? - logoutParams? - openUrl?
    @@ -199,7 +206,8 @@

    href="#clientId" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -249,7 +257,8 @@

    href="#logoutParams" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -374,7 +383,8 @@

    Optional openUrl +

    @@ -427,10 +437,12 @@

    Type declaration

    Parameters

    • -
      - url: - string -
      + url: + string
    @@ -474,7 +486,7 @@

    Example

    - Settings

    @@ -599,36 +611,24 @@

    Theme

    - On This Page

    - + + clientId + logoutParams + openUrl
    @@ -636,7 +636,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index bb99c149..714cfc59 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -58,8 +65,8 @@

    Interface PopupConfigOptions

    interface PopupConfigOptions {
        PopupConfigOptions + {
        popup?: Interface PopupConfigOptions tabindex="0" > - + Index @@ -108,14 +115,14 @@

    Properties

    href="PopupConfigOptions.html#popup" class="tsd-index-link tsd-is-external" > - popup? - timeoutInSeconds?
    @@ -132,7 +139,8 @@

    Optional popup +

    @@ -167,7 +175,8 @@

    href="#timeoutInSeconds" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -201,7 +210,7 @@

    - Settings

    @@ -326,27 +335,20 @@

    Theme

    - On This Page

    - + + popup + timeoutInSeconds
    @@ -354,7 +356,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 3144d730..0e7ab602 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -58,8 +65,8 @@

    Interface PopupLoginOptions

    interface PopupLoginOptions {
        PopupLoginOptions + {
        Interface PopupLoginOptions >
    -

    Hierarchy

    +

    + Hierarchy (view full) +

    • BaseLoginOptions @@ -115,7 +128,7 @@

      Hierarchy

      tabindex="0" > - + Index @@ -128,7 +141,7 @@

      Properties

      href="PopupLoginOptions.html#authorizationParams" class="tsd-index-link tsd-is-inherited tsd-is-external" > - authorizationParams?
    @@ -150,7 +163,8 @@

    href="#authorizationParams" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -189,7 +203,7 @@

    - Settings

    @@ -314,22 +328,18 @@

    Theme

    - On This Page

    - + + authorizationParams
    @@ -337,7 +347,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index b82e4cce..167545a9 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -60,15 +67,23 @@

    Interface RedirectLoginOptions<TAppState>

    interface RedirectLoginOptions {
        RedirectLoginOptions<TAppState> + {
        appState?: TAppStateTAppState;
        Interface RedirectLoginOptions<TAppState>

    Type Parameters

     @@ -123,8 +141,10 @@

    Hierarchy

    ><SPARedirectLoginOptions<TAppStateTAppState>, "onRedirect"Hierarchy
  • Defined in projects/auth0-angular/src/lib/interfaces.ts:4projects/auth0-angular/src/lib/interfaces.ts:6
    • @@ -157,7 +177,7 @@

    Hierarchy

    tabindex="0" > - + Index @@ -170,28 +190,28 @@

    Properties

    href="RedirectLoginOptions.html#appState" class="tsd-index-link tsd-is-inherited tsd-is-external" > - appState? - authorizationParams? - fragment? - openUrl?
    @@ -213,14 +233,17 @@

    href="#appState" aria-label="Permalink" class="tsd-anchor-icon" - > +

    appState?: - TAppStateTAppState
    @@ -248,7 +271,8 @@

    href="#authorizationParams" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -289,7 +313,8 @@

    href="#fragment" aria-label="Permalink" class="tsd-anchor-icon" - > +

    @@ -319,7 +344,8 @@

    Optional openUrl +

    @@ -338,6 +364,12 @@

    >>)

    +
    +

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

    +

    Type declaration

      @@ -356,20 +388,16 @@

      Type declaration

      >>
    • -
      -

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

      -

      Parameters

      • -
        - url: - string -
        + url: + string
      @@ -381,19 +409,19 @@

      >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 });
        }
      });
-
      -
    +
    +

    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 });
      }
    });
+
    +
    @@ -582,7 +597,7 @@

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules.html b/docs/modules.html index a3e6704a..27057dda 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -58,7 +65,7 @@

    Enumerations

    - HttpMethod
    @@ -68,114 +75,114 @@

    Classes

    - AbstractNavigator - Auth0ClientFactory - AuthClientConfig - AuthGuard - AuthHttpInterceptor - AuthModule - AuthService - AuthState - AuthenticationError - GenericError - InMemoryCache - LocalStorageCache - MfaRequiredError - MissingRefreshTokenError - PopupCancelledError - PopupTimeoutError - TimeoutError - User
    @@ -185,33 +192,33 @@

    Interfaces

    - AppState - AuthConfig - AuthorizationParams - GetTokenSilentlyOptions - GetTokenWithPopupOptionsInterfaces href="interfaces/HttpInterceptorConfig.html" class="tsd-index-link" > - HttpInterceptorConfig - HttpInterceptorRouteConfigInterfaces href="interfaces/ICache.html" class="tsd-index-link tsd-is-external" > - ICache - IdToken - LogoutOptions - PopupConfigOptions - PopupLoginOptions - RedirectLoginOptions
    @@ -279,14 +286,14 @@

    Type Aliases

    - ApiRouteDefinition - Cacheable
    @@ -298,14 +305,14 @@

    Variables

    href="variables/Auth0ClientService.html" class="tsd-index-link" > - Auth0ClientService - AuthConfigService
    @@ -315,28 +322,28 @@

    Functions

    - authGuardFn - authHttpInterceptorFn - isHttpInterceptorRouteConfig - provideAuth0
    @@ -351,7 +358,7 @@

    Functions

    - Settings

    @@ -477,7 +484,7 @@

    Theme

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/types/ApiRouteDefinition.html b/docs/types/ApiRouteDefinition.html index dd97d3f1..cd431a57 100644 --- a/docs/types/ApiRouteDefinition.html +++ b/docs/types/ApiRouteDefinition.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -80,7 +87,7 @@

    Type alias ApiRouteDefinition

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:28
    • @@ -94,7 +101,7 @@

    Type alias ApiRouteDefinition

    - Settings

    @@ -220,7 +227,7 @@

    Theme

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index a3ae1b24..0f5b1d70 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > -
    @@ -79,7 +86,7 @@

    Type alias Cacheable

    - Settings

    @@ -205,7 +212,7 @@

    Theme

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/Auth0ClientService.html b/docs/variables/Auth0ClientService.html index 7eb021bc..58cfdeb7 100644 --- a/docs/variables/Auth0ClientService.html +++ b/docs/variables/Auth0ClientService.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -74,7 +81,7 @@

  • Defined in projects/auth0-angular/src/lib/auth.client.ts:29
    • @@ -88,7 +95,7 @@

    - Settings

    @@ -214,7 +221,7 @@

    Theme

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/AuthConfigService.html b/docs/variables/AuthConfigService.html index 02574375..77174c08 100644 --- a/docs/variables/AuthConfigService.html +++ b/docs/variables/AuthConfigService.html @@ -9,6 +9,7 @@ + @@ -16,6 +17,12 @@
    @@ -25,7 +32,7 @@ for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption" > -
    @@ -42,7 +49,7 @@ data-toggle="menu" aria-label="Menu" > - @@ -89,7 +96,7 @@

    Usage Notes

  • Defined in projects/auth0-angular/src/lib/auth.config.ts:166
    • @@ -103,7 +110,7 @@

    Usage Notes

    - Settings

    @@ -229,7 +236,7 @@

    Theme

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/projects/auth0-angular/package.json b/projects/auth0-angular/package.json index 19ee831c..32ddcdfe 100644 --- a/projects/auth0-angular/package.json +++ b/projects/auth0-angular/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/auth0-angular", - "version": "2.2.3", + "version": "2.3.0", "description": "Auth0 SDK for Angular Single Page Applications (SPA)", "keywords": [ "auth0",