From 9617b16074fdd0faa95609c7d8a042cc0b149a95 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Thu, 2 Nov 2023 14:55:08 +0000 Subject: [PATCH] Release v2.17.1 (#534) --- CHANGELOG.md | 6 + docs/assets/main.js | 111 +-- docs/assets/navigation.js | 1 + docs/assets/search.js | 2 +- docs/assets/style.css | 866 ++++++++++-------- docs/functions/attemptSilentLogin.html | 77 +- docs/functions/auth.html | 86 +- docs/functions/claimCheck.html | 93 +- docs/functions/claimEquals.html | 88 +- docs/functions/claimIncludes.html | 88 +- docs/functions/requiresAuth.html | 91 +- docs/index.html | 115 +-- docs/interfaces/AccessToken.html | 136 +-- docs/interfaces/BackchannelLogoutOptions.html | 123 +-- docs/interfaces/CallbackOptions.html | 80 +- docs/interfaces/ConfigParams.html | 544 ++--------- docs/interfaces/CookieConfigParams.html | 126 +-- docs/interfaces/LoginOptions.html | 97 +- docs/interfaces/LogoutOptions.html | 89 +- docs/interfaces/OpenidRequest.html | 81 +- docs/interfaces/OpenidResponse.html | 81 +- docs/interfaces/RefreshParams.html | 66 +- docs/interfaces/RequestContext.html | 161 +--- docs/interfaces/ResponseContext.html | 144 +-- docs/interfaces/Session.html | 108 +-- docs/interfaces/SessionConfigParams.html | 174 +--- docs/interfaces/SessionStore.html | 166 +--- docs/interfaces/SessionStorePayload.html | 118 +-- docs/interfaces/TokenParameters.html | 72 +- package-lock.json | 4 +- package.json | 2 +- 31 files changed, 850 insertions(+), 3146 deletions(-) create mode 100644 docs/assets/navigation.js diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e77acd2..d6e70d4e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.17.1](https://github.com/auth0/express-openid-connect/tree/v2.17.1) (2023-11-02) +[Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.17.0...v2.17.1) + +**Fixed** +- Honor params passed to logout over defaults [\#533](https://github.com/auth0/express-openid-connect/pull/533) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v2.17.0](https://github.com/auth0/express-openid-connect/tree/v2.17.0) (2023-09-15) [Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.16.0...v2.17.0) diff --git a/docs/assets/main.js b/docs/assets/main.js index abd0485a..d0aa8d5f 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,54 +1,59 @@ "use strict"; -"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function fe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function pe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!se&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){H||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!H&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends k{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends k{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - */ -/*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - */ +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}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),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}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){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&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)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(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()]).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")}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)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),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)}}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 Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="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=>{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(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!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))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.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&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}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}`,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; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);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,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.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";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){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,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(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("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(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)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&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}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();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 00000000..acf35e0b --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE5WUwU7DMAxA/yXniUkIdthtTByQkDat3BCHkLpr1DTpGlcCIf4dqyss7VK3XOPnl9qO+/olED5QrMVGKfD+xRVgxUJUEnM61BahziRFlkH8JsfSEFRom4r17f3qe/GneZCqULm0FsyzO7oGdxVqZ33UOQZzF2ylMe+Ux3kHDKtzNtPHvaxlOeIKAF7kCg0zdEOMk1JXtOUqDYEJ0cQsZg9gV4HV6QFODXiMqnrElWohlJHeU0oKVQ1KIqQi4vcVfQiwF5yRf99wgKwGnzNT6hFcM7oiaZ7tQdwVIrzsXBBv6zGcLqF9pWFGNV1sRvrki45wM7QJujo+3BCYK9rLT+NkOunrOE7b/uHaMoAU8ZIHDKeTiFBWmGgDFtttvRizxqp23ZbXVN+5uguVDWXHJHTOpNFO6HKbgypiyZfolOLx1EjjRx3n8JTkySrTpDCu+QUYUU2LpWlNNyP9CONXmrcf39WmqvoGAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 630129c8..0acaf5ae 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\"},\"rows\":[{\"kind\":64,\"name\":\"auth\",\"url\":\"functions/auth.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"requiresAuth\",\"url\":\"functions/requiresAuth.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimEquals\",\"url\":\"functions/claimEquals.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimIncludes\",\"url\":\"functions/claimIncludes.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"claimCheck\",\"url\":\"functions/claimCheck.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"attemptSilentLogin\",\"url\":\"functions/attemptSilentLogin.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"Session\",\"url\":\"interfaces/Session.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"id_token\",\"url\":\"interfaces/Session.html#id_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"access_token\",\"url\":\"interfaces/Session.html#access_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"refresh_token\",\"url\":\"interfaces/Session.html#refresh_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"token_type\",\"url\":\"interfaces/Session.html#token_type\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Session\"},{\"kind\":1024,\"name\":\"expires_at\",\"url\":\"interfaces/Session.html#expires_at\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Session\"},{\"kind\":256,\"name\":\"OpenidRequest\",\"url\":\"interfaces/OpenidRequest.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"oidc\",\"url\":\"interfaces/OpenidRequest.html#oidc\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"OpenidRequest\"},{\"kind\":256,\"name\":\"OpenidResponse\",\"url\":\"interfaces/OpenidResponse.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"oidc\",\"url\":\"interfaces/OpenidResponse.html#oidc\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"OpenidResponse\"},{\"kind\":256,\"name\":\"RequestContext\",\"url\":\"interfaces/RequestContext.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/RequestContext.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/RequestContext.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":1024,\"name\":\"idToken\",\"url\":\"interfaces/RequestContext.html#idToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":1024,\"name\":\"accessToken\",\"url\":\"interfaces/RequestContext.html#accessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":1024,\"name\":\"refreshToken\",\"url\":\"interfaces/RequestContext.html#refreshToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":1024,\"name\":\"idTokenClaims\",\"url\":\"interfaces/RequestContext.html#idTokenClaims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/RequestContext.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":2048,\"name\":\"fetchUserInfo\",\"url\":\"interfaces/RequestContext.html#fetchUserInfo\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"RequestContext\"},{\"kind\":256,\"name\":\"ResponseContext\",\"url\":\"interfaces/ResponseContext.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"login\",\"url\":\"interfaces/ResponseContext.html#login\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ResponseContext.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":1024,\"name\":\"logout\",\"url\":\"interfaces/ResponseContext.html#logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ResponseContext.html#__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":1024,\"name\":\"callback\",\"url\":\"interfaces/ResponseContext.html#callback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ResponseContext.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ResponseContext\"},{\"kind\":256,\"name\":\"LoginOptions\",\"url\":\"interfaces/LoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/LoginOptions.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LoginOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"interfaces/LoginOptions.html#silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LoginOptions\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"returnTo\",\"url\":\"interfaces/LogoutOptions.html#returnTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":1024,\"name\":\"logoutParams\",\"url\":\"interfaces/LogoutOptions.html#logoutParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":256,\"name\":\"CallbackOptions\",\"url\":\"interfaces/CallbackOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"redirectUri\",\"url\":\"interfaces/CallbackOptions.html#redirectUri\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":1024,\"name\":\"tokenEndpointParams\",\"url\":\"interfaces/CallbackOptions.html#tokenEndpointParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallbackOptions\"},{\"kind\":256,\"name\":\"BackchannelLogoutOptions\",\"url\":\"interfaces/BackchannelLogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"store\",\"url\":\"interfaces/BackchannelLogoutOptions.html#store\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BackchannelLogoutOptions\"},{\"kind\":1024,\"name\":\"onLogoutToken\",\"url\":\"interfaces/BackchannelLogoutOptions.html#onLogoutToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BackchannelLogoutOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/BackchannelLogoutOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"BackchannelLogoutOptions\"},{\"kind\":1024,\"name\":\"isLoggedOut\",\"url\":\"interfaces/BackchannelLogoutOptions.html#isLoggedOut\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BackchannelLogoutOptions\"},{\"kind\":1024,\"name\":\"onLogin\",\"url\":\"interfaces/BackchannelLogoutOptions.html#onLogin\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BackchannelLogoutOptions\"},{\"kind\":256,\"name\":\"ConfigParams\",\"url\":\"interfaces/ConfigParams.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"secret\",\"url\":\"interfaces/ConfigParams.html#secret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"session\",\"url\":\"interfaces/ConfigParams.html#session\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"auth0Logout\",\"url\":\"interfaces/ConfigParams.html#auth0Logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"authorizationParams\",\"url\":\"interfaces/ConfigParams.html#authorizationParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"logoutParams\",\"url\":\"interfaces/ConfigParams.html#logoutParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ConfigParams.html#__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"baseURL\",\"url\":\"interfaces/ConfigParams.html#baseURL\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clientID\",\"url\":\"interfaces/ConfigParams.html#clientID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clientSecret\",\"url\":\"interfaces/ConfigParams.html#clientSecret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clockTolerance\",\"url\":\"interfaces/ConfigParams.html#clockTolerance\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"enableTelemetry\",\"url\":\"interfaces/ConfigParams.html#enableTelemetry\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"errorOnRequiredAuth\",\"url\":\"interfaces/ConfigParams.html#errorOnRequiredAuth\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"attemptSilentLogin\",\"url\":\"interfaces/ConfigParams.html#attemptSilentLogin\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"getLoginState\",\"url\":\"interfaces/ConfigParams.html#getLoginState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ConfigParams.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"afterCallback\",\"url\":\"interfaces/ConfigParams.html#afterCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ConfigParams.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"identityClaimFilter\",\"url\":\"interfaces/ConfigParams.html#identityClaimFilter\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"idpLogout\",\"url\":\"interfaces/ConfigParams.html#idpLogout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"idTokenSigningAlg\",\"url\":\"interfaces/ConfigParams.html#idTokenSigningAlg\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"issuerBaseURL\",\"url\":\"interfaces/ConfigParams.html#issuerBaseURL\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"legacySameSiteCookie\",\"url\":\"interfaces/ConfigParams.html#legacySameSiteCookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"authRequired\",\"url\":\"interfaces/ConfigParams.html#authRequired\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"pushedAuthorizationRequests\",\"url\":\"interfaces/ConfigParams.html#pushedAuthorizationRequests\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"backchannelLogout\",\"url\":\"interfaces/ConfigParams.html#backchannelLogout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"routes\",\"url\":\"interfaces/ConfigParams.html#routes\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ConfigParams.html#__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"login\",\"url\":\"interfaces/ConfigParams.html#__type-6.login\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"logout\",\"url\":\"interfaces/ConfigParams.html#__type-6.logout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"postLogoutRedirect\",\"url\":\"interfaces/ConfigParams.html#__type-6.postLogoutRedirect\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"callback\",\"url\":\"interfaces/ConfigParams.html#__type-6.callback\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"backchannelLogout\",\"url\":\"interfaces/ConfigParams.html#__type-6.backchannelLogout-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"transactionCookie\",\"url\":\"interfaces/ConfigParams.html#transactionCookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clientAuthMethod\",\"url\":\"interfaces/ConfigParams.html#clientAuthMethod\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clientAssertionSigningKey\",\"url\":\"interfaces/ConfigParams.html#clientAssertionSigningKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"clientAssertionSigningAlg\",\"url\":\"interfaces/ConfigParams.html#clientAssertionSigningAlg\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"tokenEndpointParams\",\"url\":\"interfaces/ConfigParams.html#tokenEndpointParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"discoveryCacheMaxAge\",\"url\":\"interfaces/ConfigParams.html#discoveryCacheMaxAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"httpTimeout\",\"url\":\"interfaces/ConfigParams.html#httpTimeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"httpAgent\",\"url\":\"interfaces/ConfigParams.html#httpAgent\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/ConfigParams.html#__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":1024,\"name\":\"http\",\"url\":\"interfaces/ConfigParams.html#__type-4.http\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"https\",\"url\":\"interfaces/ConfigParams.html#__type-4.https\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"http2\",\"url\":\"interfaces/ConfigParams.html#__type-4.http2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ConfigParams.__type\"},{\"kind\":1024,\"name\":\"httpUserAgent\",\"url\":\"interfaces/ConfigParams.html#httpUserAgent\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ConfigParams\"},{\"kind\":256,\"name\":\"SessionStorePayload\",\"url\":\"interfaces/SessionStorePayload.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"header\",\"url\":\"interfaces/SessionStorePayload.html#header\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionStorePayload\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SessionStorePayload.html#__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"SessionStorePayload\"},{\"kind\":1024,\"name\":\"iat\",\"url\":\"interfaces/SessionStorePayload.html#__type-1.iat\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SessionStorePayload.__type\"},{\"kind\":1024,\"name\":\"uat\",\"url\":\"interfaces/SessionStorePayload.html#__type-1.uat\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SessionStorePayload.__type\"},{\"kind\":1024,\"name\":\"exp\",\"url\":\"interfaces/SessionStorePayload.html#__type-1.exp\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SessionStorePayload.__type\"},{\"kind\":1024,\"name\":\"data\",\"url\":\"interfaces/SessionStorePayload.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionStorePayload\"},{\"kind\":1024,\"name\":\"cookie\",\"url\":\"interfaces/SessionStorePayload.html#cookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionStorePayload\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SessionStorePayload.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"SessionStorePayload\"},{\"kind\":1024,\"name\":\"expires\",\"url\":\"interfaces/SessionStorePayload.html#__type.expires\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SessionStorePayload.__type\"},{\"kind\":1024,\"name\":\"maxAge\",\"url\":\"interfaces/SessionStorePayload.html#__type.maxAge\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SessionStorePayload.__type\"},{\"kind\":256,\"name\":\"SessionStore\",\"url\":\"interfaces/SessionStore.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/SessionStore.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"SessionStore\"},{\"kind\":2048,\"name\":\"set\",\"url\":\"interfaces/SessionStore.html#set\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"SessionStore\"},{\"kind\":2048,\"name\":\"destroy\",\"url\":\"interfaces/SessionStore.html#destroy\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"SessionStore\"},{\"kind\":256,\"name\":\"SessionConfigParams\",\"url\":\"interfaces/SessionConfigParams.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/SessionConfigParams.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"store\",\"url\":\"interfaces/SessionConfigParams.html#store\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"genid\",\"url\":\"interfaces/SessionConfigParams.html#genid\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SessionConfigParams.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"signSessionStoreCookie\",\"url\":\"interfaces/SessionConfigParams.html#signSessionStoreCookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"requireSignedSessionStoreCookie\",\"url\":\"interfaces/SessionConfigParams.html#requireSignedSessionStoreCookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"rolling\",\"url\":\"interfaces/SessionConfigParams.html#rolling\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"rollingDuration\",\"url\":\"interfaces/SessionConfigParams.html#rollingDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"absoluteDuration\",\"url\":\"interfaces/SessionConfigParams.html#absoluteDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":1024,\"name\":\"cookie\",\"url\":\"interfaces/SessionConfigParams.html#cookie\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SessionConfigParams\"},{\"kind\":256,\"name\":\"CookieConfigParams\",\"url\":\"interfaces/CookieConfigParams.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"domain\",\"url\":\"interfaces/CookieConfigParams.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"interfaces/CookieConfigParams.html#path\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":1024,\"name\":\"transient\",\"url\":\"interfaces/CookieConfigParams.html#transient\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":1024,\"name\":\"httpOnly\",\"url\":\"interfaces/CookieConfigParams.html#httpOnly\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":1024,\"name\":\"secure\",\"url\":\"interfaces/CookieConfigParams.html#secure\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":1024,\"name\":\"sameSite\",\"url\":\"interfaces/CookieConfigParams.html#sameSite\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CookieConfigParams\"},{\"kind\":256,\"name\":\"AccessToken\",\"url\":\"interfaces/AccessToken.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"access_token\",\"url\":\"interfaces/AccessToken.html#access_token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":1024,\"name\":\"token_type\",\"url\":\"interfaces/AccessToken.html#token_type\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":1024,\"name\":\"expires_in\",\"url\":\"interfaces/AccessToken.html#expires_in\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":1024,\"name\":\"isExpired\",\"url\":\"interfaces/AccessToken.html#isExpired\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/AccessToken.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":2048,\"name\":\"refresh\",\"url\":\"interfaces/AccessToken.html#refresh\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"AccessToken\"},{\"kind\":256,\"name\":\"RefreshParams\",\"url\":\"interfaces/RefreshParams.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"tokenEndpointParams\",\"url\":\"interfaces/RefreshParams.html#tokenEndpointParams\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RefreshParams\"},{\"kind\":256,\"name\":\"TokenParameters\",\"url\":\"interfaces/TokenParameters.html\",\"classes\":\"tsd-kind-interface\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,45.29]],[\"comment/0\",[]],[\"name/1\",[1,45.29]],[\"comment/1\",[]],[\"name/2\",[2,45.29]],[\"comment/2\",[]],[\"name/3\",[3,45.29]],[\"comment/3\",[]],[\"name/4\",[4,45.29]],[\"comment/4\",[]],[\"name/5\",[5,40.182]],[\"comment/5\",[]],[\"name/6\",[6,40.182]],[\"comment/6\",[]],[\"name/7\",[7,45.29]],[\"comment/7\",[]],[\"name/8\",[8,40.182]],[\"comment/8\",[]],[\"name/9\",[9,45.29]],[\"comment/9\",[]],[\"name/10\",[10,40.182]],[\"comment/10\",[]],[\"name/11\",[11,45.29]],[\"comment/11\",[]],[\"name/12\",[12,45.29]],[\"comment/12\",[]],[\"name/13\",[13,40.182]],[\"comment/13\",[]],[\"name/14\",[14,45.29]],[\"comment/14\",[]],[\"name/15\",[13,40.182]],[\"comment/15\",[]],[\"name/16\",[15,45.29]],[\"comment/16\",[]],[\"name/17\",[16,45.29]],[\"comment/17\",[]],[\"name/18\",[17,21.936]],[\"comment/18\",[]],[\"name/19\",[18,45.29]],[\"comment/19\",[]],[\"name/20\",[19,40.182]],[\"comment/20\",[]],[\"name/21\",[20,45.29]],[\"comment/21\",[]],[\"name/22\",[21,45.29]],[\"comment/22\",[]],[\"name/23\",[22,45.29]],[\"comment/23\",[]],[\"name/24\",[23,45.29]],[\"comment/24\",[]],[\"name/25\",[24,45.29]],[\"comment/25\",[]],[\"name/26\",[25,40.182]],[\"comment/26\",[]],[\"name/27\",[17,21.936]],[\"comment/27\",[]],[\"name/28\",[26,40.182]],[\"comment/28\",[]],[\"name/29\",[17,21.936]],[\"comment/29\",[]],[\"name/30\",[27,40.182]],[\"comment/30\",[]],[\"name/31\",[17,21.936]],[\"comment/31\",[]],[\"name/32\",[28,45.29]],[\"comment/32\",[]],[\"name/33\",[29,40.182]],[\"comment/33\",[]],[\"name/34\",[30,40.182]],[\"comment/34\",[]],[\"name/35\",[31,45.29]],[\"comment/35\",[]],[\"name/36\",[32,45.29]],[\"comment/36\",[]],[\"name/37\",[30,40.182]],[\"comment/37\",[]],[\"name/38\",[33,40.182]],[\"comment/38\",[]],[\"name/39\",[17,21.936]],[\"comment/39\",[]],[\"name/40\",[34,45.29]],[\"comment/40\",[]],[\"name/41\",[35,45.29]],[\"comment/41\",[]],[\"name/42\",[36,36.817]],[\"comment/42\",[]],[\"name/43\",[37,45.29]],[\"comment/43\",[]],[\"name/44\",[38,40.182]],[\"comment/44\",[]],[\"name/45\",[39,45.29]],[\"comment/45\",[]],[\"name/46\",[17,21.936]],[\"comment/46\",[]],[\"name/47\",[40,45.29]],[\"comment/47\",[]],[\"name/48\",[41,45.29]],[\"comment/48\",[]],[\"name/49\",[42,45.29]],[\"comment/49\",[]],[\"name/50\",[43,45.29]],[\"comment/50\",[]],[\"name/51\",[6,40.182]],[\"comment/51\",[]],[\"name/52\",[44,45.29]],[\"comment/52\",[]],[\"name/53\",[29,40.182]],[\"comment/53\",[]],[\"name/54\",[33,40.182]],[\"comment/54\",[]],[\"name/55\",[17,21.936]],[\"comment/55\",[]],[\"name/56\",[45,45.29]],[\"comment/56\",[]],[\"name/57\",[46,45.29]],[\"comment/57\",[]],[\"name/58\",[47,45.29]],[\"comment/58\",[]],[\"name/59\",[48,45.29]],[\"comment/59\",[]],[\"name/60\",[49,45.29]],[\"comment/60\",[]],[\"name/61\",[50,45.29]],[\"comment/61\",[]],[\"name/62\",[5,40.182]],[\"comment/62\",[]],[\"name/63\",[51,45.29]],[\"comment/63\",[]],[\"name/64\",[17,21.936]],[\"comment/64\",[]],[\"name/65\",[52,45.29]],[\"comment/65\",[]],[\"name/66\",[17,21.936]],[\"comment/66\",[]],[\"name/67\",[53,45.29]],[\"comment/67\",[]],[\"name/68\",[54,45.29]],[\"comment/68\",[]],[\"name/69\",[55,45.29]],[\"comment/69\",[]],[\"name/70\",[56,45.29]],[\"comment/70\",[]],[\"name/71\",[57,45.29]],[\"comment/71\",[]],[\"name/72\",[58,45.29]],[\"comment/72\",[]],[\"name/73\",[59,45.29]],[\"comment/73\",[]],[\"name/74\",[60,40.182]],[\"comment/74\",[]],[\"name/75\",[61,45.29]],[\"comment/75\",[]],[\"name/76\",[17,21.936]],[\"comment/76\",[]],[\"name/77\",[25,40.182]],[\"comment/77\",[]],[\"name/78\",[26,40.182]],[\"comment/78\",[]],[\"name/79\",[62,45.29]],[\"comment/79\",[]],[\"name/80\",[27,40.182]],[\"comment/80\",[]],[\"name/81\",[60,40.182]],[\"comment/81\",[]],[\"name/82\",[63,45.29]],[\"comment/82\",[]],[\"name/83\",[64,45.29]],[\"comment/83\",[]],[\"name/84\",[65,45.29]],[\"comment/84\",[]],[\"name/85\",[66,45.29]],[\"comment/85\",[]],[\"name/86\",[36,36.817]],[\"comment/86\",[]],[\"name/87\",[67,45.29]],[\"comment/87\",[]],[\"name/88\",[68,45.29]],[\"comment/88\",[]],[\"name/89\",[69,45.29]],[\"comment/89\",[]],[\"name/90\",[17,21.936]],[\"comment/90\",[]],[\"name/91\",[70,45.29]],[\"comment/91\",[]],[\"name/92\",[71,45.29]],[\"comment/92\",[]],[\"name/93\",[72,45.29]],[\"comment/93\",[]],[\"name/94\",[73,45.29]],[\"comment/94\",[]],[\"name/95\",[74,45.29]],[\"comment/95\",[]],[\"name/96\",[75,45.29]],[\"comment/96\",[]],[\"name/97\",[17,21.936]],[\"comment/97\",[]],[\"name/98\",[76,45.29]],[\"comment/98\",[]],[\"name/99\",[77,45.29]],[\"comment/99\",[]],[\"name/100\",[78,45.29]],[\"comment/100\",[]],[\"name/101\",[79,45.29]],[\"comment/101\",[]],[\"name/102\",[80,40.182]],[\"comment/102\",[]],[\"name/103\",[17,21.936]],[\"comment/103\",[]],[\"name/104\",[81,45.29]],[\"comment/104\",[]],[\"name/105\",[82,45.29]],[\"comment/105\",[]],[\"name/106\",[83,45.29]],[\"comment/106\",[]],[\"name/107\",[84,45.29]],[\"comment/107\",[]],[\"name/108\",[85,45.29]],[\"comment/108\",[]],[\"name/109\",[86,45.29]],[\"comment/109\",[]],[\"name/110\",[87,45.29]],[\"comment/110\",[]],[\"name/111\",[88,45.29]],[\"comment/111\",[]],[\"name/112\",[38,40.182]],[\"comment/112\",[]],[\"name/113\",[89,45.29]],[\"comment/113\",[]],[\"name/114\",[17,21.936]],[\"comment/114\",[]],[\"name/115\",[90,45.29]],[\"comment/115\",[]],[\"name/116\",[91,45.29]],[\"comment/116\",[]],[\"name/117\",[92,45.29]],[\"comment/117\",[]],[\"name/118\",[93,45.29]],[\"comment/118\",[]],[\"name/119\",[94,45.29]],[\"comment/119\",[]],[\"name/120\",[80,40.182]],[\"comment/120\",[]],[\"name/121\",[95,45.29]],[\"comment/121\",[]],[\"name/122\",[96,45.29]],[\"comment/122\",[]],[\"name/123\",[97,45.29]],[\"comment/123\",[]],[\"name/124\",[98,45.29]],[\"comment/124\",[]],[\"name/125\",[99,45.29]],[\"comment/125\",[]],[\"name/126\",[100,45.29]],[\"comment/126\",[]],[\"name/127\",[101,45.29]],[\"comment/127\",[]],[\"name/128\",[19,40.182]],[\"comment/128\",[]],[\"name/129\",[8,40.182]],[\"comment/129\",[]],[\"name/130\",[10,40.182]],[\"comment/130\",[]],[\"name/131\",[102,45.29]],[\"comment/131\",[]],[\"name/132\",[103,45.29]],[\"comment/132\",[]],[\"name/133\",[17,21.936]],[\"comment/133\",[]],[\"name/134\",[104,45.29]],[\"comment/134\",[]],[\"name/135\",[105,45.29]],[\"comment/135\",[]],[\"name/136\",[36,36.817]],[\"comment/136\",[]],[\"name/137\",[106,45.29]],[\"comment/137\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":17,\"name\":{\"18\":{},\"27\":{},\"29\":{},\"31\":{},\"39\":{},\"46\":{},\"55\":{},\"64\":{},\"66\":{},\"76\":{},\"90\":{},\"97\":{},\"103\":{},\"114\":{},\"133\":{}},\"comment\":{}}],[\"absoluteduration\",{\"_index\":94,\"name\":{\"119\":{}},\"comment\":{}}],[\"access_token\",{\"_index\":8,\"name\":{\"8\":{},\"129\":{}},\"comment\":{}}],[\"accesstoken\",{\"_index\":19,\"name\":{\"20\":{},\"128\":{}},\"comment\":{}}],[\"aftercallback\",{\"_index\":52,\"name\":{\"65\":{}},\"comment\":{}}],[\"attemptsilentlogin\",{\"_index\":5,\"name\":{\"5\":{},\"62\":{}},\"comment\":{}}],[\"auth\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"auth0logout\",{\"_index\":44,\"name\":{\"52\":{}},\"comment\":{}}],[\"authorizationparams\",{\"_index\":29,\"name\":{\"33\":{},\"53\":{}},\"comment\":{}}],[\"authrequired\",{\"_index\":58,\"name\":{\"72\":{}},\"comment\":{}}],[\"backchannellogout\",{\"_index\":60,\"name\":{\"74\":{},\"81\":{}},\"comment\":{}}],[\"backchannellogoutoptions\",{\"_index\":37,\"name\":{\"43\":{}},\"comment\":{}}],[\"baseurl\",{\"_index\":45,\"name\":{\"56\":{}},\"comment\":{}}],[\"callback\",{\"_index\":27,\"name\":{\"30\":{},\"80\":{}},\"comment\":{}}],[\"callbackoptions\",{\"_index\":34,\"name\":{\"40\":{}},\"comment\":{}}],[\"claimcheck\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"claimequals\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"claimincludes\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"clientassertionsigningalg\",{\"_index\":66,\"name\":{\"85\":{}},\"comment\":{}}],[\"clientassertionsigningkey\",{\"_index\":65,\"name\":{\"84\":{}},\"comment\":{}}],[\"clientauthmethod\",{\"_index\":64,\"name\":{\"83\":{}},\"comment\":{}}],[\"clientid\",{\"_index\":46,\"name\":{\"57\":{}},\"comment\":{}}],[\"clientsecret\",{\"_index\":47,\"name\":{\"58\":{}},\"comment\":{}}],[\"clocktolerance\",{\"_index\":48,\"name\":{\"59\":{}},\"comment\":{}}],[\"configparams\",{\"_index\":42,\"name\":{\"49\":{}},\"comment\":{}}],[\"cookie\",{\"_index\":80,\"name\":{\"102\":{},\"120\":{}},\"comment\":{}}],[\"cookieconfigparams\",{\"_index\":95,\"name\":{\"121\":{}},\"comment\":{}}],[\"data\",{\"_index\":79,\"name\":{\"101\":{}},\"comment\":{}}],[\"destroy\",{\"_index\":86,\"name\":{\"109\":{}},\"comment\":{}}],[\"discoverycachemaxage\",{\"_index\":67,\"name\":{\"87\":{}},\"comment\":{}}],[\"domain\",{\"_index\":96,\"name\":{\"122\":{}},\"comment\":{}}],[\"enabletelemetry\",{\"_index\":49,\"name\":{\"60\":{}},\"comment\":{}}],[\"erroronrequiredauth\",{\"_index\":50,\"name\":{\"61\":{}},\"comment\":{}}],[\"exp\",{\"_index\":78,\"name\":{\"100\":{}},\"comment\":{}}],[\"expires\",{\"_index\":81,\"name\":{\"104\":{}},\"comment\":{}}],[\"expires_at\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"expires_in\",{\"_index\":102,\"name\":{\"131\":{}},\"comment\":{}}],[\"fetchuserinfo\",{\"_index\":23,\"name\":{\"24\":{}},\"comment\":{}}],[\"genid\",{\"_index\":89,\"name\":{\"113\":{}},\"comment\":{}}],[\"get\",{\"_index\":84,\"name\":{\"107\":{}},\"comment\":{}}],[\"getloginstate\",{\"_index\":51,\"name\":{\"63\":{}},\"comment\":{}}],[\"header\",{\"_index\":75,\"name\":{\"96\":{}},\"comment\":{}}],[\"http\",{\"_index\":70,\"name\":{\"91\":{}},\"comment\":{}}],[\"http2\",{\"_index\":72,\"name\":{\"93\":{}},\"comment\":{}}],[\"httpagent\",{\"_index\":69,\"name\":{\"89\":{}},\"comment\":{}}],[\"httponly\",{\"_index\":99,\"name\":{\"125\":{}},\"comment\":{}}],[\"https\",{\"_index\":71,\"name\":{\"92\":{}},\"comment\":{}}],[\"httptimeout\",{\"_index\":68,\"name\":{\"88\":{}},\"comment\":{}}],[\"httpuseragent\",{\"_index\":73,\"name\":{\"94\":{}},\"comment\":{}}],[\"iat\",{\"_index\":76,\"name\":{\"98\":{}},\"comment\":{}}],[\"id_token\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"identityclaimfilter\",{\"_index\":53,\"name\":{\"67\":{}},\"comment\":{}}],[\"idplogout\",{\"_index\":54,\"name\":{\"68\":{}},\"comment\":{}}],[\"idtoken\",{\"_index\":18,\"name\":{\"19\":{}},\"comment\":{}}],[\"idtokenclaims\",{\"_index\":21,\"name\":{\"22\":{}},\"comment\":{}}],[\"idtokensigningalg\",{\"_index\":55,\"name\":{\"69\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":16,\"name\":{\"17\":{}},\"comment\":{}}],[\"isexpired\",{\"_index\":103,\"name\":{\"132\":{}},\"comment\":{}}],[\"isloggedout\",{\"_index\":40,\"name\":{\"47\":{}},\"comment\":{}}],[\"issuerbaseurl\",{\"_index\":56,\"name\":{\"70\":{}},\"comment\":{}}],[\"legacysamesitecookie\",{\"_index\":57,\"name\":{\"71\":{}},\"comment\":{}}],[\"login\",{\"_index\":25,\"name\":{\"26\":{},\"77\":{}},\"comment\":{}}],[\"loginoptions\",{\"_index\":28,\"name\":{\"32\":{}},\"comment\":{}}],[\"logout\",{\"_index\":26,\"name\":{\"28\":{},\"78\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":32,\"name\":{\"36\":{}},\"comment\":{}}],[\"logoutparams\",{\"_index\":33,\"name\":{\"38\":{},\"54\":{}},\"comment\":{}}],[\"maxage\",{\"_index\":82,\"name\":{\"105\":{}},\"comment\":{}}],[\"name\",{\"_index\":88,\"name\":{\"111\":{}},\"comment\":{}}],[\"oidc\",{\"_index\":13,\"name\":{\"13\":{},\"15\":{}},\"comment\":{}}],[\"onlogin\",{\"_index\":41,\"name\":{\"48\":{}},\"comment\":{}}],[\"onlogouttoken\",{\"_index\":39,\"name\":{\"45\":{}},\"comment\":{}}],[\"openidrequest\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"openidresponse\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"path\",{\"_index\":97,\"name\":{\"123\":{}},\"comment\":{}}],[\"postlogoutredirect\",{\"_index\":62,\"name\":{\"79\":{}},\"comment\":{}}],[\"pushedauthorizationrequests\",{\"_index\":59,\"name\":{\"73\":{}},\"comment\":{}}],[\"redirecturi\",{\"_index\":35,\"name\":{\"41\":{}},\"comment\":{}}],[\"refresh\",{\"_index\":104,\"name\":{\"134\":{}},\"comment\":{}}],[\"refresh_token\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"refreshparams\",{\"_index\":105,\"name\":{\"135\":{}},\"comment\":{}}],[\"refreshtoken\",{\"_index\":20,\"name\":{\"21\":{}},\"comment\":{}}],[\"requestcontext\",{\"_index\":15,\"name\":{\"16\":{}},\"comment\":{}}],[\"requiresauth\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"requiresignedsessionstorecookie\",{\"_index\":91,\"name\":{\"116\":{}},\"comment\":{}}],[\"responsecontext\",{\"_index\":24,\"name\":{\"25\":{}},\"comment\":{}}],[\"returnto\",{\"_index\":30,\"name\":{\"34\":{},\"37\":{}},\"comment\":{}}],[\"rolling\",{\"_index\":92,\"name\":{\"117\":{}},\"comment\":{}}],[\"rollingduration\",{\"_index\":93,\"name\":{\"118\":{}},\"comment\":{}}],[\"routes\",{\"_index\":61,\"name\":{\"75\":{}},\"comment\":{}}],[\"samesite\",{\"_index\":101,\"name\":{\"127\":{}},\"comment\":{}}],[\"secret\",{\"_index\":43,\"name\":{\"50\":{}},\"comment\":{}}],[\"secure\",{\"_index\":100,\"name\":{\"126\":{}},\"comment\":{}}],[\"session\",{\"_index\":6,\"name\":{\"6\":{},\"51\":{}},\"comment\":{}}],[\"sessionconfigparams\",{\"_index\":87,\"name\":{\"110\":{}},\"comment\":{}}],[\"sessionstore\",{\"_index\":83,\"name\":{\"106\":{}},\"comment\":{}}],[\"sessionstorepayload\",{\"_index\":74,\"name\":{\"95\":{}},\"comment\":{}}],[\"set\",{\"_index\":85,\"name\":{\"108\":{}},\"comment\":{}}],[\"signsessionstorecookie\",{\"_index\":90,\"name\":{\"115\":{}},\"comment\":{}}],[\"silent\",{\"_index\":31,\"name\":{\"35\":{}},\"comment\":{}}],[\"store\",{\"_index\":38,\"name\":{\"44\":{},\"112\":{}},\"comment\":{}}],[\"token_type\",{\"_index\":10,\"name\":{\"10\":{},\"130\":{}},\"comment\":{}}],[\"tokenendpointparams\",{\"_index\":36,\"name\":{\"42\":{},\"86\":{},\"136\":{}},\"comment\":{}}],[\"tokenparameters\",{\"_index\":106,\"name\":{\"137\":{}},\"comment\":{}}],[\"transactioncookie\",{\"_index\":63,\"name\":{\"82\":{}},\"comment\":{}}],[\"transient\",{\"_index\":98,\"name\":{\"124\":{}},\"comment\":{}}],[\"uat\",{\"_index\":77,\"name\":{\"99\":{}},\"comment\":{}}],[\"user\",{\"_index\":22,\"name\":{\"23\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE71d3Y/bNhL/X7yv262ob+UtTXtAcC1SdNN7WQSBYnO9Qry2K8m95IL870dSlDxDzUiUneZp43i+yN/McDgS6S+r+vDfZvXi4cvqY7XfrF6k8e1qXz7L1YtVeWqfVrerU71THx5P+3VbHfbNj/q/757a5536br0rm0Yq/tXq6y0hopZ/napaNi9pUfBrX5Hq++r5l79O5a4hJIJvFwl8vV/vThvJiuy/XyT01ZNcf+Qkmi99xZVtK5+P7X21k/v218O22lPAjIgmxYdJOsi/l02jZAxCq30r68dyLZsf7VeTokQQnm2tNu/bw0c5K+wGEAKpt6tjWasBAKsYReVaiWw8lTnEFyms5aNy1idPjS71RSoN8/v281HO6kOkFymTn446Gt+X7awyROqrDHrcm6PcV5s/VAKQDakOEfh736HarP3E3VhS2nps3/QYmqMKPxIgTPHtRgHk+Q3DmkiPw47y1UEp+kSCgSkW5AKT2pUp1bps5cZT9M2YjR6dYzhInUkSncf3ng0gD+V376djyhHhms4mybdcEiFtGsgXTgSRMBcpxizXKLfpcJF2h+ca9XYGX+mlt1k47QPTNQacGln76rW0C9WFQZwP6h5lu376U8l5vX88+Op1mZYagHJKl3Imkwoi8c8qO1QAzUi86am5wWA7L8khnFKbOn4IfbXfdbbywz6cvGfyZiD/3gNXWvuRx0tGrq1lhr4ud7sPJSim58wADN91+L3e+VUDMw/20tFkqvk3R1PnU7bA7/3jSO/kDnX1v1Lz/V7WJZ0ZR8JvaEZ6pMh0dm1oT/X+LZmnxtoB9eUqG7NL8lM40C5S5+CnvHsawDOBP4IzE+eI9Jo5YOdkHpr0F1exw7JMuW9AzuidC0nMjiymQX1lY3YCVodkCbAbtb9at3/Wla/cG8xDD9K1eWrb+ct+czwopTzSpBk071Jz4ET/pCjWT+V+L3ezgcTR+k990x5q0r8mRd/0bPRA2SFwG8B9R8aWy9PGuOwXG+UbewvMmYtDVhQeFLvjVERbuXlDV0rTdmLmb4gkXa56TNpE5ephCMpWh/1jtZ2IZfD9gmCRa7WoeMm7GWiZXAANZNWxfUpKX098uUJd6QS/soX3WClmuE6xR21GG+Bbm/kYMrfajy3wWuwZ1b75Zlprv/1IvNRzaz2ahg9lI//841c/W87El8/7elcp4tc/+2kE1NeqvF8Q0g7HNaoP649vDztZl/u1J+IjnsvVy335YSffyp18lm392U//mOkKA+r6UL/Z/9E9ENug52XTRpCMV+Qd/knTdNqh+C43Yys7Ifdt2Xq6g8vynfIOUjvf8UECsMkcIo9K+6uJBggBhsPynaYCqZ0r8xA7Npht4eq2evvZtGP/Ve1auqE6totmvNw5q81xSUkAya9Raure+2q7r/bbl7utr/Ix2xVGNM1J1j8tWQtdlisqEbkt15/v1Yf7qpWvDoePlW9tQHNeV531Kde/LAMcl6s+npqnLs8PVZ5tyHuWZ9MCLjfsg7sf8a2VxmyXG1ErAdJzIgba75QeO339EpH6ZUZr5NInIbPa76YfixA29Al98dMJL1t8gfcz5nho2s6b/rBNscsMI+V8KyOnHmrMmzb7hGO5QRdGsGvZSMwP4hsa2apqvynNK09LlgCK7dqdks6hv0mVRz3XAILrahMUd60HZRf4f0vPzcsU+7c2yrtYmWK/3CjfZvbYZ5Z0sj0M2VTN+vC3rD+/KtdP8rfy08utp/cynJeb8tS2x7fVs/QOcsxwnWJlPP3ojVbbk3+nZXpQOf8Q22HuTZ0Y+qUm3FnmJXbMJFJN5xkIjD1+0bDIoPAqgzy33UsM0m/DLPRXyLLIZ4k3cu/1U6Xfy8+7Q0kuMgSZf/P+SZYbeg/Nib0ZWCbf+URWL4/JGe095nxVQQroLOc2tpPvvM5aclfNvwhLWDPjf6crjTr9E0bJT2QS8zaq4//GRm3KtlxklWW4xItxwcOWoKzq9XT5+Q+HUKd9rjlHsVu7p98dv9yWu7OEpTbNOMczW2h5WvY8XW8tMYxL8XPWTZ/kgC9+bulnNyNhN9uJRzbINEZR46uouVLRRjZtfSD3NWNlZ+JlCse4zD0wJ8j8l17zZ4HQG8swOSivJ+gz3kY8Rp98sWWB6q0+irBIdc9xieqFmZJR7pkonac62mr2vcPtHvog38PgAeFEXI2QPY+n991yc6WV87KuN/ew21V7srfAmzXwfCv1P59q00S/xAzAe7U55YfmsDu18iJ7COarDZqtjYgG0DW+gd920oLm33lyqfwz+ObwXHK9d1LqzcDBbQpHJnPd7ZJ7O4BWbOmvVWtaqBW7FaZ1Q6ZrDdCb6zf7HdPhpPUDnmvVN3J9otdOTvnAcbVq++hykfIzzwXqYTC9nD43Br5ecPZg5vCuK9TvAC+09KITtSO1HqdqPZT2x2XphDFSisgvVlo1vxg5ZM010gmpl6j0rbN4hXM1FuQ8W8lsFuyRQS8LzrRLBoxPuRkJ/AqDCPyjw/ORxVj6omcW2Hp6hGb0hkIqtaQVDgk1yne3imEjP61efFn9rWh0hfFiFd5Fd4WifKzkbqMIH/pt0frw/KxNfGe/+49cq8pRU3QkPwar24fgNk7uwuLdu9uHnsH8v/kPQyXUJ0FQCUQVqk8hQRUiqkh9igiqCFHF6lNMUMWIKlGfkts4uBN5iMgSRJaqTylFliKyTH3KCJ0ZosrVp5wSliMyBcdDQQgr8MTqeRYBJU44EBgMSBAwCkJPt6BwEBgIoWdcRKRuDIbQsy4oOATGQyS8SAyJ0FMvEkokBkXo2RcpRYhxEXr+RXYbirsiSjElhkZoDEROicTohAadghpOiNEJNQYhFUihEyMmSCgYQ4xOqCEIyXDC4IQagpCKqBCDE2oEQgrFEGMTagRCMq5CDE6YsXMeYnRCDUFIBmGI0QkLXiaGJ9IYhBklM8LwRIKVGWF8IoMP5RuRk8YMPqRvRBigSMMQkTEeYYQijUNEOUeEEYo0DBHlHBEGKMp43RigSKMQkaEbYYAiHqAIAxRrFCIyjWN8Yg1CRGWDGMMTaxBUlRSld7nIMCXGJzbrDJXOY2elMfCQGT3G8MQGHiqpxxieOGVnKMb4xBqEmMobMYYn1hjElGvEGJ1YQxBTrhFjcBINQUzljQSDkwhu+UwwOIlGIKbgTjA2CR87CQYniVmvTJxSIGHnPMHoJBqCmHK2BIOTGHCopSfB4CQGHMrXEgxOYsChskuCwUkNOJSrpRicVEOQUA6UYnDSkKuVUgxOqhFIKE9LMTZpzM54irFJTZ1G+WTqFGp84KQYm1QjkFDem2JsUo1AQjllirFJNQIJ5RYpxibTCCSUW2QYm8xgQ1aUGJvMYEO5RYaxyQw2lFtkGJtMA5CSeT/D2GQagZSCO8PYZDw2mVNHZ2z9kGFwMr4qyDA6mcYgpVwow+jkfFGQY3hywc5RjvHJNQop5Ww5xifXKKSUs+UYn9zgQzlbjuHJDTyUs+UYnjxlV8Ycw5NrDFLKLXNnp6MhSCm3zDE4uQGHcsscg1MErA8VGJxCI5BRea3A2BQagYzy3wJjU2gEMsqDCoxNoRHIKLQLjE2hEcgotAuMTaEByCi0CwxNwdfTBcam0AhklF8Uzj5UI5BRaBfuVlQjkJHbosDZiwYGHQrw7itIqlHImR2usyENInb43XeQVmORk/vhwNmUBhqNnNwRB86uNNB45BT23VeQVAOSk5viwNmZBqZnQG52A2drGmhQcnK7Gzh4mQZBTiErRr0DDUpOQut2D0yTgC6HhdtAMG2CnHQDt4Mg+GJBuE0E0yooqNgXbhfBNAsKuivi4GXaBQXpBW4nwfQLCtIL3FaC6RgUpBc4zQRhWgZMJDjtBGG6BgXpMaHb7tGgFKTHOC0FYToHBekxTlNBmN5BQXqM01YQpntQkF7gNBaEaR+obELSOnh1vYWAxNZpLgjTQqAbNcJpLwjTRKD92+kviGiiO+d0GETXYghI/3J6DMK0ElRGI2ndJt1ETnQaDcK0E1T6I+U6qJmOgsp/JK0DW8TXFsJpOIiog430R9tyMD3sv2Xdys3rrpf98DA87/iyem8b3GrQRqZudauwe/Hl6+1KAd/9Lbq/ama7v/az2l6bv2rLZ/6qjUj31/5/Zv+qaqP7a+Xp5aX7h7AcenLVP76ee+j6kx5O/4R/MzzhP9tcxMBmUXAS0BO4M3d+ZrbjFeG0jJEIFQSDjDDoheScEH1a+Hz+6SxGbdYGMWnCcXcn1btLvewpOCDiLKEHI+QEmbP2Z9bgzBpMsAT9abczZwzmP5lSN5zYPNonO2cZIZjCyLpFwjqDklUPp1HB6AGWGWcION81HkoKZiGzTpkLX0mH/mKns8AIxFPMjUdfuKGfS8E5hUimDB/lRCFQGFlfzDlAewGU4QDUmOXXR9LX3T3hwHbAOcUo7TXowHgQR1Oc1XDfOTAYjJvl1a9ylP0BraY7oFXqA1rABVKQELgopCV91OfPgCSAYc7PhJGkPPrZnqoDAsBM5tODqhBjDMaQZJOM/bVGgBl4UMIlMXN7SXu+vQSwgyBMuES6Nq9tjNNADDwg5pm716xADgdhqzc4NgOzbmsEcDYUADZd+NEyulfwz1xZAU1gufr3e4HtKWTkxjwcoVvrI3TP5adyi2YgBaDlHOL9K1xgrFB5yMVcd1VMe74qBgAGhp1y821ueTns+5TtrjwJQC/lZs4cvADTncNZYxX3L+WD6RaQkYtKeEE8WOch74Shw9svgDUAni0ijtlcYazvT67MFcYgM4L0FnJW2xeOwWChUwoug2xx/OewnAo4X1JMpvpouvtqAJpgklJOZX8QCwAKoq7gFrzuGCFgAp5TcHNqj9YBLgBFwVqouMruGByIMjCfOReqmvNg3tkDcQaBCLlVxZ5KBJaCuSy46NRcbX+2FdgKC1sujWte7W6jkWbA3wrO3yocHhlIJgWn8fyzGYARFF0smzSX4Jjl/9FeggOcDpib8jKO44ovAd6e8kaPa36YgDhXsHxrewM7CGcALJt2LTddpiQgXlJWf1PiXyIA9sPMz85YI/u36mAqi2AqY61vduY2SnezAEI25vXqW3eIsjgBVmdc1u/uy9EvkDZVK8fVQgL9jcsao61VCCY87He23AAMN1FVh8Br2JkbO2kIhh3aXWrGOSu/FwF5L+JSbMc9rooiWF9bExIuMYzrkxwufwGXAA0F5IJBxq643U+IAAdF/tmZKjiVKlO7SMcgOGNulg2fmqlRYohAqo9ZreaHTer+92OA7XCeOAfpuftfbgHscO3m0OleqAeLE+z5hNyCqC+T6YZcD5fJgNUG2J1x6ai7uwl1Aurh7iYQn2AGM86c3oiTvi4azD6I0phzmOHNWZjU4MxF3NQ5v4oE5hAsfdO849DSDUGgm/MZyz9SHYKMym5X7Dyv+9+zANqhci4r9D915pbusCCeYTUnqeyltuZQ3jgxF6i+5m3p/J4YSwhAZKus7hr5FpXXEZjDyPZ9Ii65D4ewgOUwbNnl1DKSPUyYswSXdPo7v0DcgSnLuBH3SyF2OjjZIWcy0R4AlibcEtwfHYH64B495MAdbj0GQwSFjl13OF+z3NzOPoeJTvC2n30UcUOIgpkBGO5jf/MFKHWBhxYsXs6GDEZowPmGDrCZ8IIIsAti/3MRIDiAp7DZaTRdEVi7476/zy5p8KAKdBo4cisj4oAzMqQ9PEBUMMCRYtsjytNeKIenEXoEJwigdbCGZtMFuLtrjEkKnCpnJ+d8Cg2gCWsjtiVwcrZoIAIKbqHqfr8JZFXYliXX43e3q2N1lCq5KaKHd1+//h+SWFpzmXMAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index e5093854..108428c3 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -2,38 +2,78 @@ /* 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: #707070; - --light-color-link: #4da6ff; - --light-color-ts: #db1373; - --light-color-ts-interface: #139d2c; - --light-color-ts-enum: #9c891a; - --light-color-ts-class: #2484e5; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --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-namespace: #b111c9; - --light-color-ts-private: #707070; - --light-color-ts-variable: #4d68ff; + --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: var(--light-color-ts-type-alias); + --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: #ff6492; - --dark-color-ts-interface: #6cff87; + + --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-class: #61b0ff; - --dark-color-ts-function: #9772ff; - --dark-color-ts-namespace: #e14dff; - --dark-color-ts-private: #e2e2e2; - --dark-color-ts-variable: #4d68ff; + --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: var(--dark-color-ts-type-alias); + --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; } @@ -42,19 +82,38 @@ :root { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); + --color-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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -64,19 +123,38 @@ :root { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); + --color-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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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); } @@ -93,19 +171,38 @@ body { :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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -113,23 +210,47 @@ body { :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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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; +} + h1, h2, h3, @@ -139,6 +260,16 @@ h6 { line-height: 1.2; } +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -173,12 +304,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -191,26 +316,10 @@ dd { } .container { - max-width: 1600px; + max-width: 1700px; padding: 0 2rem; } -@media (min-width: 640px) { - .container { - padding: 0 4rem; - } -} -@media (min-width: 1200px) { - .container { - padding: 0 8rem; - } -} -@media (min-width: 1600px) { - .container { - padding: 0 12rem; - } -} - /* Footer */ .tsd-generator { border-top: 1px solid var(--color-accent); @@ -226,26 +335,9 @@ dd { } .container-main { - display: flex; - justify-content: space-between; - position: relative; margin: 0 auto; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 2rem 1rem; -} - -.col-4 { - flex: 0 0 25%; -} -.col-8 { - flex: 1 0; - flex-wrap: wrap; - padding-left: 0; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { @@ -288,22 +380,6 @@ dd { opacity: 0; } } -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -352,13 +428,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + 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; +} blockquote { margin: 1em 0; @@ -374,13 +466,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -391,91 +482,18 @@ blockquote { .tsd-typography ol { margin: 1em 0; } - -@media (max-width: 1024px) { - html .col-content { - float: none; - max-width: 100%; - width: 100%; - padding-top: 3rem; - } - html .col-menu { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - max-width: 25rem; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-menu > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - align-items: center; - grid-template-rows: auto 1fr; - grid-gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } +.tsd-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); } .tsd-breadcrumb { @@ -656,43 +674,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { -o-page-break-inside: avoid; page-break-inside: avoid; } -.tsd-index-panel a, -.tsd-index-panel a.tsd-parent-kind-module { - color: var(--color-ts); -} -.tsd-index-panel a.tsd-parent-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-parent-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-parent-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-module { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-index-panel a.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-index-panel a.tsd-is-private { - color: var(--color-ts-private); -} .tsd-flag { display: inline-block; @@ -707,7 +688,7 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-anchor { - position: absolute; + position: relative; top: -100px; } @@ -721,108 +702,64 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-bottom: 0; border-bottom: none; } -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); + +.tsd-navigation.settings { + margin: 1rem 0; } -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); } - -.tsd-navigation a { - display: block; - margin: 0.4rem 0; - border-left: 2px solid transparent; +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; color: var(--color-text); text-decoration: none; - transition: border-left-color 0.1s; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); } -.tsd-navigation a:hover { +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { text-decoration: underline; } -.tsd-navigation ul { - margin: 0; +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } -.tsd-navigation li { +.tsd-navigation li, +.tsd-page-navigation li { padding: 0; + max-width: 100%; } - -.tsd-navigation.primary .tsd-accordion-details > ul { - margin-top: 0.75rem; -} -.tsd-navigation.primary a { - padding: 0.75rem 0.5rem; - margin: 0; +.tsd-nested-navigation { + margin-left: 3rem; } -.tsd-navigation.primary ul li a { - margin-left: 0.5rem; +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.primary ul li li a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } -.tsd-navigation.primary ul li li li a { - margin-left: 2.5rem; -} -.tsd-navigation.primary ul li li li li a { - margin-left: 3.5rem; -} -.tsd-navigation.primary ul li li li li li a { - margin-left: 4.5rem; -} -.tsd-navigation.primary ul li li li li li li a { - margin-left: 5.5rem; -} -.tsd-navigation.primary li.current > a { - border-left: 0.15rem var(--color-text) solid; -} -.tsd-navigation.primary li.selected > a { - font-weight: bold; - border-left: 0.2rem var(--color-text) solid; -} -.tsd-navigation.primary ul li a:hover { - border-left: 0.2rem var(--color-text-aside) solid; -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary > ul { - display: inline; - padding-right: 0.5rem; - transition: opacity 0.2s; +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); } -.tsd-navigation.secondary ul li a { - padding-left: 0; -} -.tsd-navigation.secondary ul li li a { - padding-left: 1.1rem; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 2.2rem; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 3.3rem; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 4.4rem; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 5.5rem; + +.tsd-page-navigation ul { + padding-left: 1.75rem; } #tsd-sidebar-links a { @@ -835,41 +772,40 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } a.tsd-index-link { - margin: 0.25rem 0; + 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 > h1, -.tsd-accordion-summary > h2, -.tsd-accordion-summary > h3, -.tsd-accordion-summary > h4, -.tsd-accordion-summary > h5 { - display: inline-flex; - align-items: center; - vertical-align: middle; - margin-bottom: 0; +.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; -} -.tsd-accordion-summary { - display: block; + 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-accordion-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -894,34 +830,6 @@ a.tsd-index-link { margin-right: 0.8rem; } -@media (min-width: 1024px) { - .col-content { - margin: 2rem auto; - } - - .menu-sticky-wrap { - position: sticky; - height: calc(100vh - 2rem); - top: 4rem; - right: 0; - padding: 0 1.5rem; - padding-top: 1rem; - margin-top: 3rem; - transition: 0.3s ease-in-out; - transition-property: top, padding-top, padding, height; - overflow-y: auto; - } - .col-menu { - border-left: 1px solid var(--color-accent); - } - .col-menu--hide { - top: 1rem; - } - .col-menu .tsd-navigation:not(:last-child) { - padding-bottom: 1.75rem; - } -} - .tsd-panel { margin-bottom: 2.5rem; } @@ -1002,8 +910,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -1011,12 +920,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#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: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -1127,7 +1039,7 @@ ul.tsd-type-parameter-list h5 { } .tsd-page-toolbar { - position: fixed; + position: sticky; z-index: 1; top: 0; left: 0; @@ -1167,16 +1079,14 @@ ul.tsd-type-parameter-list h5 { padding: 12px 0; } -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - .tsd-widget { display: inline-block; overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1198,12 +1108,6 @@ ul.tsd-type-parameter-list h5 { .tsd-widget.menu { display: none; } -@media (max-width: 1024px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} input[type="checkbox"] + .tsd-widget:before { background-position: -120px 0; } @@ -1234,7 +1138,85 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.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); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); } * { @@ -1255,3 +1237,147 @@ img { border-radius: 999rem; border: 0.25rem solid var(--color-icon-background); } + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .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); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .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%; + } +} + +/* 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; + } + + .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 - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* 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: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/functions/attemptSilentLogin.html b/docs/functions/attemptSilentLogin.html index ccfc04d4..37380038 100644 --- a/docs/functions/attemptSilentLogin.html +++ b/docs/functions/attemptSilentLogin.html @@ -1,74 +1,5 @@ -attemptSilentLogin | express-openid-connect
-
- -
-
-
-
- -

Function attemptSilentLogin

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/auth.html b/docs/functions/auth.html index fea2273e..8bc91f6e 100644 --- a/docs/functions/auth.html +++ b/docs/functions/auth.html @@ -1,81 +1,7 @@ -auth | express-openid-connect
-
- -
-
-
-
- -

Function auth

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/claimCheck.html b/docs/functions/claimCheck.html index 97dc54f2..95df8026 100644 --- a/docs/functions/claimCheck.html +++ b/docs/functions/claimCheck.html @@ -1,91 +1,4 @@ -claimCheck | express-openid-connect
-
- -
-
-
-
- -

Function claimCheck

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/claimEquals.html b/docs/functions/claimEquals.html index 76bc0040..3dfb526c 100644 --- a/docs/functions/claimEquals.html +++ b/docs/functions/claimEquals.html @@ -1,84 +1,6 @@ -claimEquals | express-openid-connect
-
- -
-
-
-
- -

Function claimEquals

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/claimIncludes.html b/docs/functions/claimIncludes.html index 2fcd7c1f..10885a25 100644 --- a/docs/functions/claimIncludes.html +++ b/docs/functions/claimIncludes.html @@ -1,84 +1,6 @@ -claimIncludes | express-openid-connect
-
- -
-
-
-
- -

Function claimIncludes

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/requiresAuth.html b/docs/functions/requiresAuth.html index 31a9051f..576cc6ef 100644 --- a/docs/functions/requiresAuth.html +++ b/docs/functions/requiresAuth.html @@ -1,90 +1,5 @@ -requiresAuth | express-openid-connect
-
- -
-
-
-
- -

Function requiresAuth

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 2424c871..208ea6d1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,91 +1,24 @@ -express-openid-connect
-
- -
-
-
-
-

express-openid-connect

-
-
-

Index

-
-

Interfaces

-
AccessToken -BackchannelLogoutOptions -CallbackOptions -ConfigParams -CookieConfigParams -LoginOptions -LogoutOptions -OpenidRequest -OpenidResponse -RefreshParams -RequestContext -ResponseContext -Session -SessionConfigParams -SessionStore -SessionStorePayload -TokenParameters -
-
-

Functions

-
attemptSilentLogin -auth -claimCheck -claimEquals -claimIncludes -requiresAuth -
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +express-openid-connect

express-openid-connect

Index

Interfaces

AccessToken +BackchannelLogoutOptions +CallbackOptions +ConfigParams +CookieConfigParams +LoginOptions +LogoutOptions +OpenidRequest +OpenidResponse +RefreshParams +RequestContext +ResponseContext +Session +SessionConfigParams +SessionStore +SessionStorePayload +TokenParameters +

Functions

attemptSilentLogin +auth +claimCheck +claimEquals +claimIncludes +requiresAuth +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/interfaces/AccessToken.html b/docs/interfaces/AccessToken.html index 05fac267..89873c29 100644 --- a/docs/interfaces/AccessToken.html +++ b/docs/interfaces/AccessToken.html @@ -1,125 +1,13 @@ -AccessToken | express-openid-connect
-
- -
-
-
-
- -

Interface AccessToken

-
-

Hierarchy

-
    -
  • AccessToken
-
-
-
- -
-
-

Properties

-
access_token -expires_in -isExpired -token_type -
-
-

Methods

-
refresh -
-
-

Properties

-
-

access_token

-
access_token: string
-

The access token itself, can be an opaque string, JWT, or non-JWT token.

-
-
-

expires_in

-
expires_in: number
-

Number of seconds until the access token expires.

-
-
-

isExpired

-
isExpired: (() => boolean)
-
-

Type declaration

-
    -
  • -
      -
    • (): boolean
      • -
    • -

      Returns true if the access_token has expired.

      -
      -

      Returns boolean

-
-

token_type

-
token_type: string
-

The type of access token, Usually "Bearer".

-
-
-

Methods

-
-

refresh

-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/BackchannelLogoutOptions.html b/docs/interfaces/BackchannelLogoutOptions.html index aa879432..21c0e325 100644 --- a/docs/interfaces/BackchannelLogoutOptions.html +++ b/docs/interfaces/BackchannelLogoutOptions.html @@ -1,127 +1,26 @@ -BackchannelLogoutOptions | express-openid-connect
-
- -
-
-
-
- -

Interface BackchannelLogoutOptions

-
-

Custom options to configure Back-Channel Logout on your application.

-
-
-

Hierarchy

-
    -
  • BackchannelLogoutOptions
-
-
-
- -
-
-

Properties

-
isLoggedOut? -onLogin? -onLogoutToken? -store? -
-
-

Properties

-
-

Optional isLoggedOut

-
isLoggedOut?: false | ((req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, config: ConfigParams) => boolean | Promise<boolean>)
-

When backchannelLogout is enabled all requests that have a session +BackchannelLogoutOptions | express-openid-connect

Interface BackchannelLogoutOptions

Custom options to configure Back-Channel Logout on your application.

+

Hierarchy

  • BackchannelLogoutOptions

Properties

isLoggedOut? +onLogin? +onLogoutToken? +store? +

Properties

Optional isLoggedOut

isLoggedOut?: false | ((req, config) => boolean | Promise<boolean>)

When backchannelLogout is enabled all requests that have a session will be checked for a previous Back-Channel logout. By default, this uses the sub and the sid (if available) from the session's ID token to look up a previous logout and logs the user out if one is found.

You can override this to implement your own Back-Channel Logout logic (See https://github.com/auth0/express-openid-connect/tree/master/examples/examples/backchannel-logout-custom-genid.js or https://github.com/auth0/express-openid-connect/tree/master/examples/examples/backchannel-logout-custom-query-store.js)

-
-
-

Optional onLogin

-
onLogin?: false | ((req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, config: ConfigParams) => void | Promise<void>)
-

When backchannelLogout is enabled, upon successful login the SDK will remove any existing Back-Channel +

Type declaration

    • (req, config): boolean | Promise<boolean>

    • Parameters

      • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
      • config: ConfigParams

      Returns boolean | Promise<boolean>

Optional onLogin

onLogin?: false | ((req, config) => void | Promise<void>)

When backchannelLogout is enabled, upon successful login the SDK will remove any existing Back-Channel logout entries for the same sub, to prevent the user from being logged out by an old Back-Channel logout.

You can override this to implement your own Back-Channel Logout logic (See https://github.com/auth0/express-openid-connect/tree/master/examples/examples/backchannel-logout-custom-genid.js or https://github.com/auth0/express-openid-connect/tree/master/examples/examples/backchannel-logout-custom-query-store.js)

-
-
-

Optional onLogoutToken

-
onLogoutToken?: ((decodedToken: object, config: ConfigParams) => void | Promise<void>)
-
-

Type declaration

-
    -
  • -
      -
    • (decodedToken: object, config: ConfigParams): void | Promise<void>
      • -
    • -

      On receipt of a Logout Token the SDK validates the token then by default stores 2 entries: one +

      Type declaration

        • (req, config): void | Promise<void>

        • Parameters

          • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
          • config: ConfigParams

          Returns void | Promise<void>

Optional onLogoutToken

onLogoutToken?: ((decodedToken, config) => void | Promise<void>)

Type declaration

-
-

Optional store

-
store?: SessionStore<Pick<SessionStorePayload<Session>, "cookie">>
-

Used to store Back-Channel Logout entries, you can specify a separate store -for this or just reuse store if you are using one already.

+

Parameters

Returns void | Promise<void>

Optional store

store?: SessionStore<Pick<SessionStorePayload<Session>, "cookie">>

Used to store Back-Channel Logout entries, you can specify a separate store +for this or just reuse SessionConfigParams.store if you are using one already.

The store should have get, set and destroy methods, making it compatible with express-session stores.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/CallbackOptions.html b/docs/interfaces/CallbackOptions.html index e595da02..88671eed 100644 --- a/docs/interfaces/CallbackOptions.html +++ b/docs/interfaces/CallbackOptions.html @@ -1,76 +1,6 @@ -CallbackOptions | express-openid-connect
-
- -
-
-
-
- -

Interface CallbackOptions

-
-

Hierarchy

-
    -
  • CallbackOptions
-
-
-
- -
-
-

Properties

-
redirectUri -tokenEndpointParams? -
-
-

Properties

-
-

redirectUri

-
redirectUri: string
-

This is useful to specify in addition to baseURL when your app runs on multiple domains, +CallbackOptions | express-openid-connect

Interface CallbackOptions

Hierarchy

  • CallbackOptions

Properties

redirectUri +tokenEndpointParams? +

Properties

redirectUri

redirectUri: string

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

-
-
-

Optional tokenEndpointParams

-
tokenEndpointParams?: TokenParameters
-

Additional request body properties to be sent to the `token_endpoint.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Optional tokenEndpointParams

tokenEndpointParams?: TokenParameters

Additional request body properties to be sent to the `token_endpoint.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/ConfigParams.html b/docs/interfaces/ConfigParams.html index 28f4253b..2733744c 100644 --- a/docs/interfaces/ConfigParams.html +++ b/docs/interfaces/ConfigParams.html @@ -1,511 +1,141 @@ -ConfigParams | express-openid-connect
-
- -
-
-
-
- -

Interface ConfigParams

-
-

Configuration parameters passed to the auth() middleware.

-

issuerBaseURL, baseURL, clientID -and secret are required but can be configured with environmental variables. clientSecret is not required but can also be configured this way.

+ConfigParams | express-openid-connect

Interface ConfigParams

Configuration parameters passed to the auth() middleware.

+

issuerBaseURL, baseURL, clientID +and secret are required but can be configured with environmental variables. clientSecret is not required but can also be configured this way.

# Required
ISSUER_BASE_URL=https://YOUR_DOMAIN
BASE_URL=https://YOUR_APPLICATION_ROOT_URL
CLIENT_ID=YOUR_CLIENT_ID
SECRET=LONG_RANDOM_VALUE

# Not required
CLIENT_SECRET=YOUR_CLIENT_SECRET
-
-
-
-

Hierarchy

-
    -
  • ConfigParams
-
-
-
- -
-
-

Properties

-
afterCallback? -attemptSilentLogin? -auth0Logout? -authRequired? -authorizationParams? -backchannelLogout? -baseURL? -clientAssertionSigningAlg? -clientAssertionSigningKey? -clientAuthMethod? -clientID? -clientSecret? -clockTolerance? -discoveryCacheMaxAge? -enableTelemetry? -errorOnRequiredAuth? -getLoginState? -httpAgent? -httpTimeout? -httpUserAgent? -idTokenSigningAlg? -identityClaimFilter? -idpLogout? -issuerBaseURL? -legacySameSiteCookie? -logoutParams? -pushedAuthorizationRequests? -routes? -secret? -session? -tokenEndpointParams? -transactionCookie? -
-
-

Properties

-
-

Optional afterCallback

-
afterCallback?: ((req: OpenidRequest, res: OpenidResponse, session: Session, decodedState: {
    [key: string]: any;
}) => Session | Promise<Session>)
-
-

Type declaration

-
    -
  • -
      -
    • (req: OpenidRequest, res: OpenidResponse, session: Session, decodedState: {
          [key: string]: any;
      }): Session | Promise<Session>
      • -
    • -

      Function for custom callback handling after receiving and validating the ID Token and before redirecting. + +

Hierarchy

  • ConfigParams

Properties

afterCallback? +attemptSilentLogin? +auth0Logout? +authRequired? +authorizationParams? +backchannelLogout? +baseURL? +clientAssertionSigningAlg? +clientAssertionSigningKey? +clientAuthMethod? +clientID? +clientSecret? +clockTolerance? +discoveryCacheMaxAge? +enableTelemetry? +errorOnRequiredAuth? +getLoginState? +httpAgent? +httpTimeout? +httpUserAgent? +idTokenSigningAlg? +identityClaimFilter? +idpLogout? +issuerBaseURL? +legacySameSiteCookie? +logoutParams? +pushedAuthorizationRequests? +routes? +secret? +session? +tokenEndpointParams? +transactionCookie? +

Properties

Optional afterCallback

afterCallback?: ((req, res, session, decodedState) => Session | Promise<Session>)

Type declaration

    • (req, res, session, decodedState): Session | Promise<Session>

    • Function for custom callback handling after receiving and validating the ID Token and before redirecting. This can be used for handling token storage, making userinfo calls, claim validation, etc.

      -

      ```js -app.use(auth({ - ... - afterCallback: async (req, res, session, decodedState) => { - const userProfile = await request(${issuerBaseURL}/userinfo); - return { - ...session, - userProfile // access using req.appSession.userProfile - }; - } -})) -``

      -
      -
      -

      Parameters

      -
      -

      Returns Session | Promise<Session>

-
-

Optional attemptSilentLogin

-
attemptSilentLogin?: boolean
-

Attempt silent login (prompt: 'none') on the first unauthenticated route the user visits. +

app.use(auth({
  ...
  afterCallback: async (req, res, session, decodedState) => {
    const userProfile = await request(`${issuerBaseURL}/userinfo`);
    return {
      ...session,
      userProfile // access using `req.appSession.userProfile`
    };
  }
}))
``
+
+

Parameters

Returns Session | Promise<Session>

Optional attemptSilentLogin

attemptSilentLogin?: boolean

Attempt silent login (prompt: 'none') on the first unauthenticated route the user visits. For protected routes this can be useful if your Identity Provider does not default to prompt: 'none' and you'd like to attempt this before requiring the user to interact with a login prompt. For unprotected routes this can be useful if you want to check the user's logged in state on their IDP, to show them a login/logout button for example. Default is false

-
-
-

Optional auth0Logout

-
auth0Logout?: boolean
-

Boolean value to enable idpLogout with an Auth0 custom domain

-
-
-

Optional authRequired

-
authRequired?: boolean
-

Require authentication for all routes.

-
-
-

Optional authorizationParams

-
authorizationParams?: AuthorizationParameters
-

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

+

Optional auth0Logout

auth0Logout?: boolean

Boolean value to enable idpLogout with an Auth0 custom domain

+

Optional authRequired

authRequired?: boolean

Require authentication for all routes.

+

Optional authorizationParams

authorizationParams?: AuthorizationParameters

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

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

{
  response_type: 'id_token',
  response_mode: 'form_post',
  scope: 'openid profile email'
}
-
+

New values can be passed in to change what is returned from the authorization server depending on your specific scenario.

For example, to receive an access token for an API, you could initialize like the sample below. Note that response_mode can be omitted because the OAuth2 default mode of query is fine:

app.use(
  auth({
    authorizationParams: {
      response_type: 'code',
      scope: 'openid profile email read:reports',
      audience: 'https://your-api-identifier',
    },
  })
);
-
+

Additional custom parameters can be added as well:

app.use(auth({
  authorizationParams: {
    // Note: you need to provide required parameters if this object is set.
    response_type: "id_token",
    response_mode: "form_post",
    scope: "openid profile email"
   // Additional parameters
   acr_value: "tenant:test-tenant",
   custom_param: "custom-value"
  }
}));
-
-
-
-

Optional backchannelLogout

-
backchannelLogout?: boolean | BackchannelLogoutOptions
-

Set to true to enable Back-Channel Logout in your application. -This will set up a web hook on your app at routes.backchannelLogout + +

Optional backchannelLogout

backchannelLogout?: boolean | BackchannelLogoutOptions

Set to true to enable Back-Channel Logout in your application. +This will set up a web hook on your app at routes.backchannelLogout On receipt of a Logout Token the webhook will store the token, then on any subsequent requests, will check the store for a Logout Token that corresponds to the current session. If it finds one, it will log the user out.

In order for this to work you need to specify a ConfigParams.backchannelLogout.store, which can be any express-session compatible store, or you can -reuse store if you are using one already.

+reuse SessionConfigParams.store if you are using one already.

See: https://openid.net/specs/openid-connect-backchannel-1_0.html

-
-
-

Optional baseURL

-
baseURL?: string
-

REQUIRED. The root URL for the application router, eg https://localhost +

Optional baseURL

baseURL?: string

REQUIRED. The root URL for the application router, eg https://localhost Can use env key BASE_URL instead.

Note: In the event that the URL has a path at the end, the auth middleware will need to be bound relative to that path. I.e

app.use('/some/path', auth({
 baseURL: "https://example.com/some/path"
 [...]
})
-
-
-
-

Optional clientAssertionSigningAlg

-
clientAssertionSigningAlg?: "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES256K" | "ES384" | "ES512" | "EdDSA"
-

The algorithm to sign the client assertion JWT. + +

Optional clientAssertionSigningAlg

clientAssertionSigningAlg?: "RS256" | "RS384" | "RS512" | "PS256" | "PS384" | "PS512" | "ES256" | "ES256K" | "ES384" | "ES512" | "EdDSA"

The algorithm to sign the client assertion JWT. Uses one of token_endpoint_auth_signing_alg_values_supported if not specified. If the Authorization Server discovery document does not list token_endpoint_auth_signing_alg_values_supported this property will be required.

-
-
-

Optional clientAssertionSigningKey

-
clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey
-

Private key for use with 'private_key_jwt' clients.

+

Optional clientAssertionSigningKey

clientAssertionSigningKey?: KeyObject | KeyInput | JSONWebKey

Private key for use with 'private_key_jwt' clients.

Can be a PEM:

app.use(auth({
  ...
  clientAssertionSigningKey: '-----BEGIN PRIVATE KEY-----\nMIIEo...PgCaw\n-----END PRIVATE KEY-----',
}))
-
+

Or JWK:

app.use(auth({
  ...
  clientAssertionSigningKey: {
    kty: 'RSA',
    n: 'u2fhZ...XIqhQ',
    e: 'AQAB',
    d: 'Cmvt9...g__Jw',
    p: 'y5iuh...dIMwM',
    q: '66Rex...IZcdc',
    dp: 'GVGVc...La4a0',
    dq: 'SyER8...Dnaes',
    qi: 'JTtu5...P2HMw'
  },
}))
-
+

Or KeyObject:

app.use(auth({
  ...
  clientAssertionSigningKey: crypto.createPrivateKey({ key: '-----BEGIN PRIVATE KEY-----\nMIIEo...PgCaw\n-----END PRIVATE KEY-----' }),
}))
-
-
-
-

Optional clientAuthMethod

-
clientAuthMethod?: string
-

String value for the client's authentication method. Default is none when using response_type='id_token', private_key_jwt when using a clientAssertionSigningKey, otherwise client_secret_basic.

-
-
-

Optional clientID

-
clientID?: string
-

REQUIRED. The Client ID for your application. + +

Optional clientAuthMethod

clientAuthMethod?: string

String value for the client's authentication method. Default is none when using response_type='id_token', private_key_jwt when using a clientAssertionSigningKey, otherwise client_secret_basic.

+

Optional clientID

clientID?: string

REQUIRED. The Client ID for your application. Can use env key CLIENT_ID instead.

-
-
-

Optional clientSecret

-
clientSecret?: string
-

The Client Secret for your application. +

Optional clientSecret

clientSecret?: string

The Client Secret for your application. Required when requesting access tokens. Can use env key CLIENT_SECRET instead.

-
-
-

Optional clockTolerance

-
clockTolerance?: number
-

Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.` +

Optional clockTolerance

clockTolerance?: number

Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.` Default is 60

-
-
-

Optional discoveryCacheMaxAge

-
discoveryCacheMaxAge?: number
-

Maximum time (in milliseconds) to wait before fetching the Identity Provider's Discovery document again. Default is 600000 (10 minutes).

-
-
-

Optional enableTelemetry

-
enableTelemetry?: boolean
-

To opt-out of sending the library and node version to your authorization server +

Optional discoveryCacheMaxAge

discoveryCacheMaxAge?: number

Maximum time (in milliseconds) to wait before fetching the Identity Provider's Discovery document again. Default is 600000 (10 minutes).

+

Optional enableTelemetry

enableTelemetry?: boolean

To opt-out of sending the library and node version to your authorization server via the Auth0-Client header. Default is `true

-
-
-

Optional errorOnRequiredAuth

-
errorOnRequiredAuth?: boolean
-

Throw a 401 error instead of triggering the login process for routes that require authentication. +

Optional errorOnRequiredAuth

errorOnRequiredAuth?: boolean

Throw a 401 error instead of triggering the login process for routes that require authentication. Default is false

-
-
-

Optional getLoginState

-
getLoginState?: ((req: OpenidRequest, options: LoginOptions) => object)
-
-

Type declaration

-

Optional getLoginState

getLoginState?: ((req, options) => object)

Type declaration

    • (req, options): object

    • Function that returns an object with URL-safe state values for res.oidc.login(). Used for passing custom state parameters to your authorization server.

      -

      ```js -app.use(auth({ - ... - getLoginState(req, options) { - return { - returnTo: options.returnTo || req.originalUrl, - customState: 'foo' - }; - } -})) -``

      -
      -
      -

      Parameters

      -
      -

      Returns object

-
-

Optional httpAgent

-
httpAgent?: {
    http?: false | Agent;
    http2?: unknown;
    https?: false | Agent;
}
-

Specify an Agent or Agents to pass to the underlying http client https://github.com/sindresorhus/got/

+
app.use(auth({
  ...
  getLoginState(req, options) {
    return {
      returnTo: options.returnTo || req.originalUrl,
      customState: 'foo'
    };
  }
}))
``
+
+

Parameters

Returns object

Optional httpAgent

httpAgent?: {
    http?: false | Agent;
    http2?: unknown;
    https?: false | Agent;
}

Specify an Agent or Agents to pass to the underlying http client https://github.com/sindresorhus/got/

An object representing http, https and http2 keys for http.Agent, https.Agent and http2wrapper.Agent instance.

See https://github.com/sindresorhus/got/blob/v11.8.6/readme.md#agent

For a proxy agent see https://www.npmjs.com/package/proxy-agent

-
-
-

Type declaration

-
    -
  • -
    Optional http?: false | Agent
    • -
  • -
    Optional http2?: unknown
    • -
  • -
    Optional https?: false | Agent
-
-

Optional httpTimeout

-
httpTimeout?: number
-

Http timeout for oidc client requests in milliseconds. Default is 5000. Minimum is 500.

-
-
-

Optional httpUserAgent

-
httpUserAgent?: string
-

Optional User-Agent header value for oidc client requests. Default is express-openid-connect/{version}.

-
-
-

Optional idTokenSigningAlg

-
idTokenSigningAlg?: string
-

String value for the expected ID token algorithm. Default is 'RS256'

-
-
-

Optional identityClaimFilter

-
identityClaimFilter?: string[]
-

Array value of claims to remove from the ID token before storing the cookie session. +

Type declaration

  • Optional http?: false | Agent
  • Optional http2?: unknown
  • Optional https?: false | Agent

Optional httpTimeout

httpTimeout?: number

Http timeout for oidc client requests in milliseconds. Default is 5000. Minimum is 500.

+

Optional httpUserAgent

httpUserAgent?: string

Optional User-Agent header value for oidc client requests. Default is express-openid-connect/{version}.

+

Optional idTokenSigningAlg

idTokenSigningAlg?: string

String value for the expected ID token algorithm. Default is 'RS256'

+

Optional identityClaimFilter

identityClaimFilter?: string[]

Array value of claims to remove from the ID token before storing the cookie session. Default is ['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash' ]

-
-
-

Optional idpLogout

-
idpLogout?: boolean
-

Boolean value to log the user out from the identity provider on application logout. Default is false

-
-
-

Optional issuerBaseURL

-
issuerBaseURL?: string
-

REQUIRED. The root URL for the token issuer with no trailing slash. +

Optional idpLogout

idpLogout?: boolean

Boolean value to log the user out from the identity provider on application logout. Default is false

+

Optional issuerBaseURL

issuerBaseURL?: string

REQUIRED. The root URL for the token issuer with no trailing slash. Can use env key ISSUER_BASE_URL instead.

-
-
-

Optional legacySameSiteCookie

-
legacySameSiteCookie?: boolean
-

Set a fallback cookie with no SameSite attribute when response_mode is form_post. +

Optional legacySameSiteCookie

legacySameSiteCookie?: boolean

Set a fallback cookie with no SameSite attribute when response_mode is form_post. Default is true

-
-
-

Optional logoutParams

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

Additional custom parameters to pass to the logout endpoint.

-
-
-

Type declaration

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

Optional pushedAuthorizationRequests

-
pushedAuthorizationRequests?: boolean
-

Perform a Pushed Authorization Request at the issuer's pushed_authorization_request_endpoint at login.

-
-
-

Optional routes

-
routes?: {
    backchannelLogout?: string;
    callback?: string | false;
    login?: string | false;
    logout?: string | false;
    postLogoutRedirect?: string;
}
-

Configuration for the login, logout, callback and postLogoutRedirect routes.

-
-
-

Type declaration

-
    -
  • -
    Optional backchannelLogout?: string
    -

    Relative path to the application's Back-Channel Logout web hook.

    -
    • -
  • -
    Optional callback?: string | false
    -

    Relative path to the application callback to process the response from the authorization server.

    -
    • -
  • -
    Optional login?: string | false
    -

    Relative path to application login.

    -
    • -
  • -
    Optional logout?: string | false
    -

    Relative path to application logout.

    -
    • -
  • -
    Optional postLogoutRedirect?: string
    -

    Either a relative path to the application or a valid URI to an external domain. +

Optional logoutParams

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

Additional custom parameters to pass to the logout endpoint.

+

Type declaration

  • [key: string]: any

Optional pushedAuthorizationRequests

pushedAuthorizationRequests?: boolean

Perform a Pushed Authorization Request at the issuer's pushed_authorization_request_endpoint at login.

+

Optional routes

routes?: {
    backchannelLogout?: string;
    callback?: string | false;
    login?: string | false;
    logout?: string | false;
    postLogoutRedirect?: string;
}

Configuration for the login, logout, callback and postLogoutRedirect routes.

+

Type declaration

  • Optional backchannelLogout?: string

    Relative path to the application's Back-Channel Logout web hook.

    +
  • Optional callback?: string | false

    Relative path to the application callback to process the response from the authorization server.

    +
  • Optional login?: string | false

    Relative path to application login.

    +
  • Optional logout?: string | false

    Relative path to application logout.

    +
  • Optional postLogoutRedirect?: string

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

    -
-
-

Optional secret

-
secret?: string | string[]
-

REQUIRED. The secret(s) used to derive an encryption key for the user identity in a stateless session cookie, +

Optional secret

secret?: string | string[]

REQUIRED. The secret(s) used to derive an encryption key for the user identity in a stateless session cookie, to sign the transient cookies used by the login callback and to sign the custom session store cookies if {@Link signSessionStoreCookie} is true. Use a single string key or array of keys. If an array of secrets is provided, only the first element will be used to sign or encrypt the values, while all the elements will be considered when decrypting or verifying the values.

Can use env key SECRET instead.

-
-
-

Optional session

-
session?: SessionConfigParams
-

Object defining application session cookie attributes.

-
-
-

Optional tokenEndpointParams

-
tokenEndpointParams?: TokenParameters
-

Additional request body properties to be sent to the token_endpoint during authorization code exchange or token refresh.

-
-
-

Optional transactionCookie

-
transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
    name?: string;
}
-

Configuration parameters used for the transaction cookie.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Optional session

session?: SessionConfigParams

Object defining application session cookie attributes.

+

Optional tokenEndpointParams

tokenEndpointParams?: TokenParameters

Additional request body properties to be sent to the token_endpoint during authorization code exchange or token refresh.

+

Optional transactionCookie

transactionCookie?: Pick<CookieConfigParams, "sameSite"> & {
    name?: string;
}

Configuration parameters used for the transaction cookie.

+

Type declaration

  • Optional name?: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/CookieConfigParams.html b/docs/interfaces/CookieConfigParams.html index 52c2a8df..6428531d 100644 --- a/docs/interfaces/CookieConfigParams.html +++ b/docs/interfaces/CookieConfigParams.html @@ -1,121 +1,23 @@ -CookieConfigParams | express-openid-connect
-
- -
-
-
-
- -

Interface CookieConfigParams

-
-

Hierarchy

-
    -
  • CookieConfigParams
-
-
-
- -
-
-

Properties

-
domain? -httpOnly? -path? -sameSite? -secure? -transient? -
-
-

Properties

-
-

Optional domain

-
domain?: string
-

Domain name for the cookie. +CookieConfigParams | express-openid-connect

Interface CookieConfigParams

Hierarchy

  • CookieConfigParams

Properties

domain? +httpOnly? +path? +sameSite? +secure? +transient? +

Properties

Optional domain

domain?: string

Domain name for the cookie. Passed to the Response cookie as domain

-
-
-

Optional httpOnly

-
httpOnly?: boolean
-

Flags the cookie to be accessible only by the web server. +

Optional httpOnly

httpOnly?: boolean

Flags the cookie to be accessible only by the web server. Passed to the Response cookie as httponly. Defaults to true.

-
-
-

Optional path

-
path?: string
-

Path for the cookie. +

Optional path

path?: string

Path for the cookie. Passed to the Response cookie as path

-
-
-

Optional sameSite

-
sameSite?: string
-

Value of the SameSite Set-Cookie attribute. +

Optional sameSite

sameSite?: string

Value of the SameSite Set-Cookie attribute. Passed to the Response cookie as samesite. Defaults to "Lax" but will be adjusted based on AuthorizationParameters.response_type. When setting to 'None' (uncommon), you should implement CSRF protection on your own routes

-
-
-

Optional secure

-
secure?: boolean
-

Marks the cookie to be used over secure channels only. +

Optional secure

secure?: boolean

Marks the cookie to be used over secure channels only. Passed to the Response cookie as secure. -Defaults to the protocol of baseURL.

-
-
-

Optional transient

-
transient?: boolean
-

Set to true to use a transient cookie (cookie without an explicit expiration). +Defaults to the protocol of ConfigParams.baseURL.

+

Optional transient

transient?: boolean

Set to true to use a transient cookie (cookie without an explicit expiration). Default is false

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/LoginOptions.html b/docs/interfaces/LoginOptions.html index e074b442..a0fa6c27 100644 --- a/docs/interfaces/LoginOptions.html +++ b/docs/interfaces/LoginOptions.html @@ -1,89 +1,10 @@ -LoginOptions | express-openid-connect
-
- -
-
-
-
- -

Interface LoginOptions

-
-

Custom options to pass to login.

-
-
-

Hierarchy

-
    -
  • LoginOptions
-
-
-
- -
-
-

Properties

-
authorizationParams? -returnTo? -silent? -
-
-

Properties

-
-

Optional authorizationParams

-
authorizationParams?: AuthorizationParameters
-

Override the default authorizationParams, if also passing a custom callback +LoginOptions | express-openid-connect

Interface LoginOptions

Custom options to pass to login.

+

Hierarchy

  • LoginOptions

Properties

authorizationParams? +returnTo? +silent? +

Properties

Optional authorizationParams

authorizationParams?: AuthorizationParameters

Override the default authorizationParams, if also passing a custom callback route then AuthorizationParameters.redirect_uri redirect_uri must be provided here or in -config

-
-
-

Optional returnTo

-
returnTo?: string
-

URL to return to after login, overrides the Default is Request.originalUrl

-
-
-

Optional silent

-
silent?: boolean
-

Used by attemptSilentLogin to swallow callback errors on silent login.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

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

+

Optional returnTo

returnTo?: string

URL to return to after login, overrides the Default is Request.originalUrl

+

Optional silent

silent?: boolean

Used by ConfigParams.attemptSilentLogin to swallow callback errors on silent login.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 9f0f08cb..f9d23f6e 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,83 +1,6 @@ -LogoutOptions | express-openid-connect
-
- -
-
-
-
- -

Interface LogoutOptions

-
-

Custom options to pass to logout.

-
-
-

Hierarchy

-
    -
  • LogoutOptions
-
-
-
- -
-
-

Properties

-
logoutParams? -returnTo? -
-
-

Properties

-
-

Optional logoutParams

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

Additional custom parameters to pass to the logout endpoint.

-
-
-

Type declaration

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

Optional returnTo

-
returnTo?: string
-

URL to returnTo after logout, overrides the Default in routes.postLogoutRedirect

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +LogoutOptions | express-openid-connect

Interface LogoutOptions

Custom options to pass to logout.

+

Hierarchy

  • LogoutOptions

Properties

logoutParams? +returnTo? +

Properties

Optional logoutParams

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

Additional custom parameters to pass to the logout endpoint.

+

Type declaration

  • [key: string]: any

Optional returnTo

returnTo?: string

URL to returnTo after logout, overrides the Default in routes.postLogoutRedirect

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/OpenidRequest.html b/docs/interfaces/OpenidRequest.html index 54aff34b..7a056d39 100644 --- a/docs/interfaces/OpenidRequest.html +++ b/docs/interfaces/OpenidRequest.html @@ -1,77 +1,8 @@ -OpenidRequest | express-openid-connect
-
- -
-
-
-
- -

Interface OpenidRequest

-
-

The Express.js Request with oidc context added by the auth middleware.

+OpenidRequest | express-openid-connect

Interface OpenidRequest

The Express.js Request with oidc context added by the auth middleware.

app.use(auth());

app.get('/profile', (req, res) => {
  const user = req.oidc.user;
  ...
})
-
- -

Deprecated

use the native the Request interface of express instead; it has + +

Deprecated

use the native the Request interface of express instead; it has been extended and now includes a built in oidc param.

-
-
-

Hierarchy

-
    -
  • Request -
      -
    • OpenidRequest
-
-
-
- -
-
-

Properties

-
oidc -
-
-

Properties

-
-

oidc

-
oidc: RequestContext
-

Library namespace for authentication methods and data.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Hierarchy

  • Request
    • OpenidRequest

Properties

oidc +

Properties

oidc

oidc: RequestContext

Library namespace for authentication methods and data.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/OpenidResponse.html b/docs/interfaces/OpenidResponse.html index 71734df1..a3ca6f4f 100644 --- a/docs/interfaces/OpenidResponse.html +++ b/docs/interfaces/OpenidResponse.html @@ -1,77 +1,8 @@ -OpenidResponse | express-openid-connect
-
- -
-
-
-
- -

Interface OpenidResponse

-
-

The Express.js Response with oidc context added by the auth middleware.

+OpenidResponse | express-openid-connect

Interface OpenidResponse

The Express.js Response with oidc context added by the auth middleware.

app.use(auth());

app.get('/login', (req, res) => {
  res.oidc.login();
})
-
- -

Deprecated

use the native the Response interface of express instead; it has + +

Deprecated

use the native the Response interface of express instead; it has been extended and now includes a built in oidc param.

-
-
-

Hierarchy

-
    -
  • Response -
      -
    • OpenidResponse
-
-
-
- -
-
-

Properties

-
oidc -
-
-

Properties

-
-

oidc

-
oidc: ResponseContext
-

Library namespace for authentication methods and data.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Hierarchy

  • Response
    • OpenidResponse

Properties

oidc +

Properties

oidc

oidc: ResponseContext

Library namespace for authentication methods and data.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/RefreshParams.html b/docs/interfaces/RefreshParams.html index 570d8ad4..5f6c56e5 100644 --- a/docs/interfaces/RefreshParams.html +++ b/docs/interfaces/RefreshParams.html @@ -1,64 +1,2 @@ -RefreshParams | express-openid-connect
-
- -
-
-
-
- -

Interface RefreshParams

-
-

Hierarchy

-
    -
  • RefreshParams
-
-
-
- -
-
-

Properties

-
tokenEndpointParams? -
-
-

Properties

-
-

Optional tokenEndpointParams

-
tokenEndpointParams?: TokenParameters
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +RefreshParams | express-openid-connect

Interface RefreshParams

Hierarchy

  • RefreshParams

Properties

tokenEndpointParams? +

Properties

Optional tokenEndpointParams

tokenEndpointParams?: TokenParameters

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/RequestContext.html b/docs/interfaces/RequestContext.html index 2a88465a..04287bea 100644 --- a/docs/interfaces/RequestContext.html +++ b/docs/interfaces/RequestContext.html @@ -1,148 +1,25 @@ -RequestContext | express-openid-connect
-
- -
-
-
-
- -

Interface RequestContext

-
-

The request authentication context found on the Express request when +RequestContext | express-openid-connect

Interface RequestContext

The request authentication context found on the Express request when OpenID Connect auth middleware is added to your application.

app.use(auth());

app.get('/profile', (req, res) => {
  const user = req.oidc.user;
  ...
})
-
-
-
-

Hierarchy

-
    -
  • RequestContext
-
-
-
- -
-
-

Properties

-
accessToken? -idToken? -idTokenClaims? -isAuthenticated -refreshToken? -user? -
-
-

Methods

-
fetchUserInfo -
-
-

Properties

-
-

Optional accessToken

-
accessToken?: AccessToken
-

Credentials that can be used by an application to access an API.

+ +

Hierarchy

  • RequestContext

Properties

accessToken? +idToken? +idTokenClaims? +isAuthenticated +refreshToken? +user? +

Methods

fetchUserInfo +

Properties

Optional accessToken

accessToken?: AccessToken

Credentials that can be used by an application to access an API.

See: https://auth0.com/docs/protocols/oidc#access-tokens

-
-
-

Optional idToken

-
idToken?: string
-

The OpenID Connect ID Token.

+

Optional idToken

idToken?: string

The OpenID Connect ID Token.

See: https://auth0.com/docs/protocols/oidc#id-tokens

-
-
-

Optional idTokenClaims

-
idTokenClaims?: IdTokenClaims
-

An object containing all the claims of the ID Token.

-
-
-

isAuthenticated

-
isAuthenticated: (() => boolean)
-
-

Type declaration

-
    -
  • -
      -
    • (): boolean
      • -
    • -

      Method to check the user's authenticated state, returns true if logged in.

      -
      -

      Returns boolean

-
-

Optional refreshToken

-
refreshToken?: string
-

Credentials that can be used to refresh an access token.

+

Optional idTokenClaims

idTokenClaims?: IdTokenClaims

An object containing all the claims of the ID Token.

+

isAuthenticated

isAuthenticated: (() => boolean)

Type declaration

    • (): boolean

    • Method to check the user's authenticated state, returns true if logged in.

      +

      Returns boolean

Optional refreshToken

refreshToken?: string

Credentials that can be used to refresh an access token.

See: https://auth0.com/docs/tokens/concepts/refresh-tokens

-
-
-

Optional user

-
user?: Record<string, any>
-

An object containing all the claims of the ID Token with the claims -specified in identityClaimFilter removed.

-
-
-

Methods

-
-

fetchUserInfo

-
    - -
  • -

    Fetches the OIDC userinfo response.

    +

Optional user

user?: Record<string, any>

An object containing all the claims of the ID Token with the claims +specified in identityClaimFilter removed.

+

Methods

fetchUserInfo

  • Fetches the OIDC userinfo response.

    app.use(auth());

    app.get('/user-info', async (req, res) => {
      const userInfo = await req.oidc.fetchUserInfo();
      res.json(userInfo);
    })
-
    -
    -

    Returns Promise<UserinfoResponse<UnknownObject, UnknownObject>>

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

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

Returns Promise<UserinfoResponse<UnknownObject, UnknownObject>>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/ResponseContext.html b/docs/interfaces/ResponseContext.html index 6d1c157c..4b9853d8 100644 --- a/docs/interfaces/ResponseContext.html +++ b/docs/interfaces/ResponseContext.html @@ -1,138 +1,20 @@ -ResponseContext | express-openid-connect
-
- -
-
-
-
- -

Interface ResponseContext

-
-

The response authentication context found on the Express response when +ResponseContext | express-openid-connect

Interface ResponseContext

The response authentication context found on the Express response when OpenID Connect auth middleware is added to your application.

app.use(auth());

app.get('/admin-login', (req, res) => {
  res.oidc.login({ returnTo: '/admin' })
})
-
-
-
-

Hierarchy

-
    -
  • ResponseContext
-
-
-
- -
-
-

Properties

-
callback -login -logout -
-
-

Properties

-
-

callback

-
callback: ((opts?: CallbackOptions) => Promise<void>)
-
-

Type declaration

-
    -
  • -
      -
    • (opts?: CallbackOptions): Promise<void>
      • -
    • -

      Provided by default via the /callback route. Call this to override or have other + +

Hierarchy

  • ResponseContext

Properties

callback +login +logout +

Properties

callback

callback: ((opts?) => Promise<void>)

Type declaration

    • (opts?): Promise<void>

    • Provided by default via the /callback route. Call this to override or have other callback routes with

      app.get('/callback', (req, res) => {
       res.oidc.callback({ redirectUri: 'https://example.com/callback' });
      });
-
      -
      -
      -

      Parameters

      -
      -

      Returns Promise<void>

-
-

login

-
login: ((opts?: LoginOptions) => Promise<void>)
-
-

Type declaration

-
    -
  • -
      -
    • (opts?: LoginOptions): Promise<void>
      • -
    • -

      Provided by default via the /login route. Call this to override or have other -login routes with custom authorizationParams or returnTo

      + +

      Parameters

      Returns Promise<void>

login

login: ((opts?) => Promise<void>)

Type declaration

    • (opts?): Promise<void>

    • Provided by default via the /login route. Call this to override or have other +login routes with custom authorizationParams or returnTo

      app.get('/admin-login', (req, res) => {
        res.oidc.login({
          returnTo: '/admin',
          authorizationParams: {
            scope: 'openid profile email admin:user',
          }
        });
      });
-
      -
      -
      -

      Parameters

      -
      -

      Returns Promise<void>

-
-

logout

-
logout: ((opts?: LogoutOptions) => Promise<void>)
-
-

Type declaration

-
    -
  • -
      -
    • (opts?: LogoutOptions): Promise<void>
      • -
    • -

      Provided by default via the /logout route. Call this to override or have other + +

      Parameters

      Returns Promise<void>

logout

logout: ((opts?) => Promise<void>)

Type declaration

    • (opts?): Promise<void>

    • Provided by default via the /logout route. Call this to override or have other logout routes with custom returnTo

      app.get('/admin-logout', (req, res) => {
        res.oidc.logout({ returnTo: '/admin-welcome' })
      });
-
      -
      -
      -

      Parameters

      -
      -

      Returns Promise<void>

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

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

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/Session.html b/docs/interfaces/Session.html index 5fb301d1..60fe0d36 100644 --- a/docs/interfaces/Session.html +++ b/docs/interfaces/Session.html @@ -1,100 +1,8 @@ -Session | express-openid-connect
-
- -
-
-
-
- -

Interface Session

-
-

Session object

-
-
-

Hierarchy

-
    -
  • Session
-
-

Indexable

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

Properties

-
access_token -expires_at -id_token -refresh_token -token_type -
-
-

Properties

-
-

access_token

-
access_token: string
-
-

expires_at

-
expires_at: string
-
-

id_token

-
id_token: string
-

Values stored in an authentication session

-
-
-

refresh_token

-
refresh_token: string
-
-

token_type

-
token_type: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +Session | express-openid-connect

Interface Session

Session object

+

Hierarchy

  • Session

Indexable

[key: string]: any

Properties

access_token +expires_at +id_token +refresh_token +token_type +

Properties

access_token

access_token: string

expires_at

expires_at: string

id_token

id_token: string

Values stored in an authentication session

+

refresh_token

refresh_token: string

token_type

token_type: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/SessionConfigParams.html b/docs/interfaces/SessionConfigParams.html index e0406751..702d9d6a 100644 --- a/docs/interfaces/SessionConfigParams.html +++ b/docs/interfaces/SessionConfigParams.html @@ -1,76 +1,19 @@ -SessionConfigParams | express-openid-connect
-
- -
-
-
-
- -

Interface SessionConfigParams

-
-

Configuration parameters used for the application session.

-
-
-

Hierarchy

-
    -
  • SessionConfigParams
-
-
-
- -
-
-

Properties

-
absoluteDuration? -cookie? -genid? -name? -requireSignedSessionStoreCookie? -rolling? -rollingDuration? -signSessionStoreCookie? -store? -
-
-

Properties

-
-

Optional absoluteDuration

-
absoluteDuration?: number | boolean
-

Integer value, in seconds, for application absolute rolling duration. +SessionConfigParams | express-openid-connect

Interface SessionConfigParams

Configuration parameters used for the application session.

+

Hierarchy

  • SessionConfigParams

Properties

absoluteDuration? +cookie? +genid? +name? +requireSignedSessionStoreCookie? +rolling? +rollingDuration? +signSessionStoreCookie? +store? +

Properties

Optional absoluteDuration

absoluteDuration?: number | boolean

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

-
-
-

Optional cookie

-
cookie?: CookieConfigParams
-

Configuration parameters used for the session cookie and transient cookies.

-
-
-

Optional genid

-
genid?: ((req: OpenidRequest) => string | Promise<string>)
-
-

Type declaration

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

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

Optional cookie

cookie?: CookieConfigParams

Configuration parameters used for the session cookie and transient cookies.

+

Optional genid

genid?: ((req) => string | Promise<string>)

Type declaration

    • (req): string | Promise<string>

    • A Function for generating a session id when using a custom session store. For full details see the documentation for express-session at genid.

      Be aware the default implementation is slightly different in this library as @@ -80,28 +23,10 @@

      Type declaration

      to hijack a session by guessing the session ID, you must use a suitable cryptographically strong random value of sufficient size or sign the cookie by setting {@Link signSessionStoreCookie} to true.

      -
      -
      -

      Parameters

      -
      -

      Returns string | Promise<string>

-
-

Optional name

-
name?: string
-

String value for the cookie name used for the internal session. +

Parameters

Returns string | Promise<string>

Optional name

name?: string

String value for the cookie name used for the internal session. This value must only include letters, numbers, and underscores. Default is appSession.

-
-
-

Optional requireSignedSessionStoreCookie

-
requireSignedSessionStoreCookie?: boolean
-

If you enable {@Link signSessionStoreCookie} your existing sessions will +

Optional requireSignedSessionStoreCookie

requireSignedSessionStoreCookie?: boolean

If you enable {@Link signSessionStoreCookie} your existing sessions will be invalidated. You can use this flag to temporarily allow unsigned cookies while you sign your user's session cookies. For example:

Set {@Link signSessionStoreCookie} to true and {@Link requireSignedSessionStoreCookie} to false. @@ -110,80 +35,21 @@

Optionaltrue.

Signed session store cookies will be mandatory in the next major release.

-

-
-

Optional rolling

-
rolling?: boolean
-

If you want your session duration to be rolling, eg reset everytime the +

Optional rolling

rolling?: boolean

If you want your session duration to be rolling, eg reset everytime the user is active on your site, set this to a true. If you want the session duration to be absolute, where the user is logged out a fixed time after login, regardless of activity, set this to false Default is true.

-
-
-

Optional rollingDuration

-
rollingDuration?: number
-

Integer value, in seconds, for application session rolling duration. +

Optional rollingDuration

rollingDuration?: number

Integer value, in seconds, for application session rolling duration. The amount of time for which the user must be idle for then to be logged out. Default is 86400 seconds (1 day).

-
-
-

Optional signSessionStoreCookie

-
signSessionStoreCookie?: boolean
-

Sign the session store cookies to reduce the chance of collisions +

Optional signSessionStoreCookie

signSessionStoreCookie?: boolean

Sign the session store cookies to reduce the chance of collisions and reduce the ability to hijack a session by guessing the session ID.

This is required if you override {@Link genid} and don't use a suitable cryptographically strong random value of sufficient size.

-
-
-

Optional store

-
store?: SessionStore<Session>
-

By default the session is stored in an encrypted cookie. But when the session +

Optional store

store?: SessionStore<Session>

By default the session is stored in an encrypted cookie. But when the session gets too large it can bump up against the limits of cookie storage. In these instances you can use a custom session store. The store should have get, set and destroy methods, making it compatible with express-session stores.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/SessionStore.html b/docs/interfaces/SessionStore.html index 360ac26c..7f6d9658 100644 --- a/docs/interfaces/SessionStore.html +++ b/docs/interfaces/SessionStore.html @@ -1,159 +1,7 @@ -SessionStore | express-openid-connect
-
- -
-
-
-
- -

Interface SessionStore<Data>

-
-

Type Parameters

-
-
-

Hierarchy

-
    -
  • SessionStore
-
-

Indexable

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

Methods

-
destroy -get -set -
-
-

Methods

-
-

destroy

-
    - -
  • -

    Destroys the session with the given session ID.

    -
    -
    -

    Parameters

    -
      -
    • -
      sid: string
      • -
    • -
      Optional callback: ((err?: any) => void)
      -
        -
      • -
          -
        • (err?: any): void
          • -
        • -
          -

          Parameters

          -
            -
          • -
            Optional err: any
          -

          Returns void

    -

    Returns void

-
-

get

-
    - -
  • -

    Gets the session from the store given a session ID and passes it to callback.

    -
    -
    -

    Parameters

    -
    -

    Returns void

-
-

set

-
    - -
  • -

    Upsert a session in the store given a session ID and SessionData

    -
    -
    -

    Parameters

    -
      -
    • -
      sid: string
      • -
    • -
      session: SessionStorePayload<Data>
      • -
    • -
      Optional callback: ((err?: any) => void)
      -
        -
      • -
          -
        • (err?: any): void
          • -
        • -
          -

          Parameters

          -
            -
          • -
            Optional err: any
          -

          Returns void

    -

    Returns void

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +SessionStore | express-openid-connect

Interface SessionStore<Data>

Type Parameters

Hierarchy

  • SessionStore

Indexable

[key: string]: any

Methods

destroy +get +set +

Methods

destroy

  • Destroys the session with the given session ID.

    +

    Parameters

    • sid: string
    • Optional callback: ((err?) => void)
        • (err?): void

        • Parameters

          • Optional err: any

          Returns void

    Returns void

get

  • Gets the session from the store given a session ID and passes it to callback.

    +

    Parameters

    • sid: string
    • callback: ((err, session?) => void)

    Returns void

set

  • Upsert a session in the store given a session ID and SessionData

    +

    Parameters

    • sid: string
    • session: SessionStorePayload<Data>
    • Optional callback: ((err?) => void)
        • (err?): void

        • Parameters

          • Optional err: any

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/SessionStorePayload.html b/docs/interfaces/SessionStorePayload.html index 7eb87188..ce79751d 100644 --- a/docs/interfaces/SessionStorePayload.html +++ b/docs/interfaces/SessionStorePayload.html @@ -1,110 +1,10 @@ -SessionStorePayload | express-openid-connect
-
- -
-
-
-
- -

Interface SessionStorePayload<Data>

-
-

Type Parameters

-
-
-

Hierarchy

-
    -
  • SessionStorePayload
-
-
-
- -
-
-

Properties

-
cookie -data -header -
-
-

Properties

-
-

cookie

-
cookie: {
    expires: number;
    maxAge: number;
}
-

This makes it compatible with some express-session stores that use this +SessionStorePayload | express-openid-connect

Interface SessionStorePayload<Data>

Type Parameters

Hierarchy

  • SessionStorePayload

Properties

cookie +data +header +

Properties

cookie

cookie: {
    expires: number;
    maxAge: number;
}

This makes it compatible with some express-session stores that use this to set their ttl.

-
-
-

Type declaration

-
    -
  • -
    expires: number
    • -
  • -
    maxAge: number
-
-

data

-
data: Data
-

The session data.

-
-
-

header

-
header: {
    exp: number;
    iat: number;
    uat: number;
}
-
-

Type declaration

-
    -
  • -
    exp: number
    -

    timestamp (in secs) when the session expires.

    -
    • -
  • -
    iat: number
    -

    timestamp (in secs) when the session was created.

    -
    • -
  • -
    uat: number
    -

    timestamp (in secs) when the session was last touched.

    -
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +

Type declaration

  • expires: number
  • maxAge: number

data

data: Data

The session data.

+

header

header: {
    exp: number;
    iat: number;
    uat: number;
}

Type declaration

  • exp: number

    timestamp (in secs) when the session expires.

    +
  • iat: number

    timestamp (in secs) when the session was created.

    +
  • uat: number

    timestamp (in secs) when the session was last touched.

    +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/TokenParameters.html b/docs/interfaces/TokenParameters.html index 630940d2..f37381b2 100644 --- a/docs/interfaces/TokenParameters.html +++ b/docs/interfaces/TokenParameters.html @@ -1,71 +1 @@ -TokenParameters | express-openid-connect
-
- -
-
-
-
- -

Interface TokenParameters

-
-

Hierarchy

-
    -
  • TokenParameters
-
-

Indexable

-
[key: string]: unknown
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

- -
-
\ No newline at end of file +TokenParameters | express-openid-connect

Interface TokenParameters

Hierarchy

  • TokenParameters

Indexable

[key: string]: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index adf2e9ee..92cdabe8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "express-openid-connect", - "version": "2.17.0", + "version": "2.17.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "express-openid-connect", - "version": "2.17.0", + "version": "2.17.1", "license": "MIT", "dependencies": { "base64url": "^3.0.1", diff --git a/package.json b/package.json index 1e23de16..98285af4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "express-openid-connect", - "version": "2.17.0", + "version": "2.17.1", "description": "Express middleware to protect web applications using OpenID Connect.", "repository": "auth0/express-openid-connect", "homepage": "https://github.com/auth0/express-openid-connect",