diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 4285e4ba..95384e7a 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,25 +1,25 @@ :root { - --light-hl-0: #000000; - --dark-hl-0: #D4D4D4; - --light-hl-1: #AF00DB; - --dark-hl-1: #C586C0; - --light-hl-2: #001080; - --dark-hl-2: #9CDCFE; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #0000FF; - --dark-hl-4: #569CD6; - --light-hl-5: #0070C1; - --dark-hl-5: #4FC1FF; - --light-hl-6: #795E26; - --dark-hl-6: #DCDCAA; + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; --light-hl-7: #800000; --dark-hl-7: #808080; --light-hl-8: #800000; --dark-hl-8: #569CD6; --light-hl-9: #000000FF; --dark-hl-9: #D4D4D4; - --light-hl-10: #FF0000; + --light-hl-10: #E50000; --dark-hl-10: #9CDCFE; --light-hl-11: #0000FF; --dark-hl-11: #CE9178; diff --git a/docs/assets/main.js b/docs/assets/main.js index b949086c..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()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{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..ce83bf6a --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WVW0/CMBiG/8uuUWAKKndkIThFIAIaYwypW9kaSrv0YETjf7cbgR26U8Ztv2fP+3U9vf8aAn4LY2DY5AnuKNtbwPGh0TICIHw17GDAOeTtVPnSFzusmC0irjHomretA6d4wd0LxC+UEzICsPHXOiVMqAPwQlAGPFiQoiHNklYcMl0ejjbzDYNgIYBINIyIojbAUdpjMa02e/2kQAq/M8fSQ2QWCEQJz1dpWKX0RUILI0hEsfCE1JdVNpklq9RjCZhbZU1CVULK0A8IyTlgYFfszHCattb6j6FY0i0kC4TVlPG+bCIF7HnBr0j4cxrIoE5yFm4WbWeOaCLIzjmatbVu1GO+91BrJp5Qj8rSjZsiyvbXAVwxXG2LoWZdR+tkUbJBXlmYjp0Rpzovv4Y0qlnYM3QRg46ozMsDy9Yn2n7hUxGSsVHsAyVLFTOWzt1Nt2fWaj7SgE8Mc/1hobl7uFred9b29GFkLe3ZdP04eotTvgBDoV5dXzqWzrwyE1JwvEBj1UYSJ/qZ7VMxLehfJwQOg+oVi273PEWiXEtS2EsGKZFJXtzOsaZ9/vEPTqagcNMIAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index fd387688..cb213d80 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\"},\"rows\":[{\"kind\":64,\"name\":\"createAuth0\",\"url\":\"functions/createAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"useAuth0\",\"url\":\"functions/useAuth0.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":32,\"name\":\"AUTH0_INJECTION_KEY\",\"url\":\"variables/AUTH0_INJECTION_KEY.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"AppState\",\"url\":\"interfaces/AppState.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"target\",\"url\":\"interfaces/AppState.html#target\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AppState\"},{\"kind\":256,\"name\":\"Auth0PluginOptions\",\"url\":\"interfaces/Auth0PluginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"skipRedirectCallback\",\"url\":\"interfaces/Auth0PluginOptions.html#skipRedirectCallback\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0PluginOptions\"},{\"kind\":1024,\"name\":\"errorPath\",\"url\":\"interfaces/Auth0PluginOptions.html#errorPath\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0PluginOptions\"},{\"kind\":256,\"name\":\"Auth0VueClient\",\"url\":\"interfaces/Auth0VueClient.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"isLoading\",\"url\":\"interfaces/Auth0VueClient.html#isLoading\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":1024,\"name\":\"isAuthenticated\",\"url\":\"interfaces/Auth0VueClient.html#isAuthenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/Auth0VueClient.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":1024,\"name\":\"idTokenClaims\",\"url\":\"interfaces/Auth0VueClient.html#idTokenClaims\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/Auth0VueClient.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"loginWithPopup\",\"url\":\"interfaces/Auth0VueClient.html#loginWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"loginWithRedirect\",\"url\":\"interfaces/Auth0VueClient.html#loginWithRedirect\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"handleRedirectCallback\",\"url\":\"interfaces/Auth0VueClient.html#handleRedirectCallback\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"checkSession\",\"url\":\"interfaces/Auth0VueClient.html#checkSession\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"getAccessTokenSilently\",\"url\":\"interfaces/Auth0VueClient.html#getAccessTokenSilently\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"getAccessTokenWithPopup\",\"url\":\"interfaces/Auth0VueClient.html#getAccessTokenWithPopup\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":2048,\"name\":\"logout\",\"url\":\"interfaces/Auth0VueClient.html#logout\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"Auth0VueClient\"},{\"kind\":256,\"name\":\"Auth0VueClientOptions\",\"url\":\"interfaces/Auth0VueClientOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0VueClientOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0VueClientOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0VueClientOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"Auth0VueClientOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Auth0VueClientOptions.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Auth0VueClientOptions\"},{\"kind\":256,\"name\":\"LogoutOptions\",\"url\":\"interfaces/LogoutOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LogoutOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LogoutOptions\"},{\"kind\":256,\"name\":\"RedirectLoginOptions\",\"url\":\"interfaces/RedirectLoginOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/RedirectLoginOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"RedirectLoginOptions\"},{\"kind\":64,\"name\":\"createAuthGuard\",\"url\":\"functions/createAuthGuard.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createAuthGuard.html#createAuthGuard.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"createAuthGuard.createAuthGuard\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createAuthGuard.html#createAuthGuard-1.__type-2\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"createAuthGuard.createAuthGuard\"},{\"kind\":64,\"name\":\"authGuard\",\"url\":\"functions/authGuard.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"AuthGuardOptions\",\"url\":\"interfaces/AuthGuardOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"app\",\"url\":\"interfaces/AuthGuardOptions.html#app\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthGuardOptions\"},{\"kind\":1024,\"name\":\"redirectLoginOptions\",\"url\":\"interfaces/AuthGuardOptions.html#redirectLoginOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AuthGuardOptions\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,32.055]],[\"comment/0\",[]],[\"name/1\",[1,32.055]],[\"comment/1\",[]],[\"name/2\",[2,32.055]],[\"comment/2\",[]],[\"name/3\",[3,32.055]],[\"comment/3\",[]],[\"name/4\",[4,32.055]],[\"comment/4\",[]],[\"name/5\",[5,32.055]],[\"comment/5\",[]],[\"name/6\",[6,32.055]],[\"comment/6\",[]],[\"name/7\",[7,32.055]],[\"comment/7\",[]],[\"name/8\",[8,32.055]],[\"comment/8\",[]],[\"name/9\",[9,32.055]],[\"comment/9\",[]],[\"name/10\",[10,32.055]],[\"comment/10\",[]],[\"name/11\",[11,32.055]],[\"comment/11\",[]],[\"name/12\",[12,32.055]],[\"comment/12\",[]],[\"name/13\",[13,32.055]],[\"comment/13\",[]],[\"name/14\",[14,32.055]],[\"comment/14\",[]],[\"name/15\",[15,32.055]],[\"comment/15\",[]],[\"name/16\",[16,32.055]],[\"comment/16\",[]],[\"name/17\",[17,32.055]],[\"comment/17\",[]],[\"name/18\",[18,32.055]],[\"comment/18\",[]],[\"name/19\",[19,32.055]],[\"comment/19\",[]],[\"name/20\",[20,32.055]],[\"comment/20\",[]],[\"name/21\",[21,32.055]],[\"comment/21\",[]],[\"name/22\",[22,15.96]],[\"comment/22\",[]],[\"name/23\",[22,15.96]],[\"comment/23\",[]],[\"name/24\",[22,15.96]],[\"comment/24\",[]],[\"name/25\",[23,32.055]],[\"comment/25\",[]],[\"name/26\",[22,15.96]],[\"comment/26\",[]],[\"name/27\",[24,26.946]],[\"comment/27\",[]],[\"name/28\",[22,15.96]],[\"comment/28\",[]],[\"name/29\",[25,32.055]],[\"comment/29\",[]],[\"name/30\",[22,15.96]],[\"comment/30\",[]],[\"name/31\",[22,15.96]],[\"comment/31\",[]],[\"name/32\",[26,32.055]],[\"comment/32\",[]],[\"name/33\",[27,32.055]],[\"comment/33\",[]],[\"name/34\",[28,32.055]],[\"comment/34\",[]],[\"name/35\",[24,26.946]],[\"comment/35\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":22,\"name\":{\"22\":{},\"23\":{},\"24\":{},\"26\":{},\"28\":{},\"30\":{},\"31\":{}},\"comment\":{}}],[\"app\",{\"_index\":28,\"name\":{\"34\":{}},\"comment\":{}}],[\"appstate\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"auth0_injection_key\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"auth0pluginoptions\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"auth0vueclient\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"auth0vueclientoptions\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"authguard\",{\"_index\":26,\"name\":{\"32\":{}},\"comment\":{}}],[\"authguardoptions\",{\"_index\":27,\"name\":{\"33\":{}},\"comment\":{}}],[\"checksession\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"createauth0\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"createauthguard\",{\"_index\":25,\"name\":{\"29\":{}},\"comment\":{}}],[\"error\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"errorpath\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"getaccesstokensilently\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"getaccesstokenwithpopup\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"handleredirectcallback\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"idtokenclaims\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"isloading\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"loginwithpopup\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"loginwithredirect\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"logout\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"logoutoptions\",{\"_index\":23,\"name\":{\"25\":{}},\"comment\":{}}],[\"redirectloginoptions\",{\"_index\":24,\"name\":{\"27\":{},\"35\":{}},\"comment\":{}}],[\"skipredirectcallback\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"target\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"useauth0\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"user\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VZ227jNhD9F/nV62go39+CYNGmDXaDJt2iMAyDKzMxa1kSdMk2MPzvS1KWNJRJWa7Tp0DWOXM7w6HI7J0k+pE688Xe2fJw7czHw74T0h1z5o6fMJqx2zzbuE7fyZNA/PaSh37GozC9QW8Hm2wXCIgf0DRlwprjHPoGg3lqtVa+ajXlkcrU7Z/Pv7qr+y+/fb57vv/6ZfX7578rq2804fR7wNIbA6rVARmNaw9x/JSJDCuzPMxY8kJ9aff4rtUYuKROPaPJK8vO2upVOGSy78Q0YWGGg7LELEv4GOSvPPwaq8IaPZ6guueRbnn8B1vzhPnZHQ2C79TfXuCjZ+Fbsj1NxxIWS5IoeaTZ5pJYMOk/BHBS+G85uwu4ZNqCqBDdC87Th4iuefja0WgPE1qyqoO1OpY4AeC+aLh1d/dN2jVBiLGQdPV8xF6V8/o52rLwLqB8Z186zYwbpGsCUC3Z1XEJvtAhcYfTymEQid7+i2ebxyjO466eT1gfEkI5Fy6OAhGvCWRDw3XAOk+3RjRW9jUh+Rvmb59YmorZ0zWQBuca92IruvWFn1R1+BMPBDZ47xqIlf1xIV3cuXb6lS0c5Zf0bYG+1KV1wzm32TeBnT+CHlSoLeY1QGez5Sp5iNq/VEy4rh+b9ffpLzlN6v3L9AWrEO2GRyOvjn+1yt5j1tFkr/ljxTbr34Q3E/lfgvoEx7A+kY8IrJaBtghAO5W+2faKcabjMab7txaNrXPkxGCvANuXsBamxWHScR2YI7Cwu4a07AsXa/avM987byxR28XcIQNvMBPEF86CtTwYFrEKs9FuJ00tj+++Cc9RIhEF5EYc6xZu33MHY9dbLvuLkqFeqB8UDMQTmGCgwUQbLogJRjSYJ548E8zTYEPxNDTBhhpsJJ5GJthIg43F09gEG2uwiXiamGATDTYVT1MTbKrBhCiLmQk208srqw1GHaAhhFLCLIWuBciag1EN0OUAWXYwCgK6IiArD0ZNQBcFZPHBKAvouoCsPxiVAV0akBKAURzQ1QGpAhj1AV0gkEKAUSLQNSJSCGLUiOgaESkEMWpEGutFLRjzitE1IlII4vXJaDCcDXWkrhGRQhCjRkTXiEghyMhoU9eIjO1IXSMihSBGNYmuEZFCEKOaRNeISCGIUU2ia+S51ip5hUZqforBKU6598UcFZOw3IT3zuo4XEWux3G/d0Qt5vtD3xGZir+HeqjKJ+lCbSqIO0XcmZ2TFhdVNdGreZ6NJj8MBf4fpnbj1Za9a66R5zYLsbodicrdpzaA0h61GXjLmX+8NanJKO9pJ7IhALFs6hSgxcpr8XmCmGPEnJxjmlxPkAFbAuqclpbntJoMiAw278W3Fy1uU2uuW1Pds8zTvIco7KGFf7x1QPGiZgNbtylWrO7aaiZK1JanOK9RdV7L5Hktrc6QyD3qFbDVWjfzQxz74uLYh+zMkB3bWisO+eWHl18d8pEZ1DtgW+Z8reLwj1dGiI2WHdjWHU+pfsWG+KgBwNYBPA3KG8KaibK3Ja/uW8y1Q40Dtsap6El1XYMsoHEBtnlRHpxRx6J8iS3fgmZapnjI2apdRqvCNxlB7U+8Yr57tlDk9Xdb96DmsfVO+R+CmoSKb6t9np7OCjQebdOxuFJFFMwxksSmGPOYBTwUoMXycPgJrNV8i2EaAAA="; \ 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/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index eb140514..2a873451 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,15 +1,15 @@ -InMemoryCache | @auth0/auth0-vue
+InMemoryCache | @auth0/auth0-vue
-
+
-
+

Properties

-
-

enclosedCache

-
enclosedCache: ICache
-
+
+
-

Settings

 +

Settings

Member Visibility

@@ -61,18 +62,36 @@

Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    -
    -
    \ No newline at end of file +
  • constructor
    • +
  • enclosedCache
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index c6aa7bad..052b04ae 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,15 +1,15 @@ -LocalStorageCache | @auth0/auth0-vue
    +LocalStorageCache | @auth0/auth0-vue
    -
    +
    -
    +
    - +

    Constructors

    -
    constructor +
    constructor

    Methods

    -
    allKeys -get -remove -set +
    allKeys +get +remove +set

    Constructors

    -
    -

    constructor

    -
    +

    Returns LocalStorageCache

    Methods

    -
    -

    allKeys

    -
      - +
      +

      allKeys

      +
        +

      • Returns string[]

      -
      -

      get

      -
        - +
        +

        get

        +
          +
        • -
          +

          Type Parameters

          -
          +

          T = Cacheable

        Parameters

        • -
          key: string
        -

        Returns MaybePromise<undefined | T>

    +

    Returns MaybePromise<undefined | T>

    -
    -

    remove

    -
      - +
      +

      remove

      +
        +

      • Parameters

        • -
          key: string
        +
        key: string

    Returns void

    -
    -

    set

    -
      - +
      +

      set

      +

      Parameters

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

    Returns void

    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -126,21 +127,39 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • constructor
    • +
  • allKeys
    • +
  • get
    • +
  • remove
    • +
  • set
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/classes/User.html b/docs/classes/User.html index 1ccd8ca1..0f31b2a2 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,15 +1,15 @@ -User | @auth0/auth0-vue
    +User | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    • User
    -
    +

    Indexable

    [key: string]: any

    Properties

    -
    -

    Optional address

    -
    address?: string
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -178,37 +179,55 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    -
    -
    \ No newline at end of file +
  • constructor
    • +
  • address
    • +
  • birthdate
    • +
  • email
    • +
  • email_verified
    • +
  • family_name
    • +
  • gender
    • +
  • given_name
    • +
  • locale
    • +
  • middle_name
    • +
  • name
    • +
  • nickname
    • +
  • phone_number
    • +
  • phone_number_verified
    • +
  • picture
    • +
  • preferred_username
    • +
  • profile
    • +
  • sub
    • +
  • updated_at
    • +
  • website
    • +
  • zoneinfo
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/functions/authGuard.html b/docs/functions/authGuard.html index e6678c46..fd1546de 100644 --- a/docs/functions/authGuard.html +++ b/docs/functions/authGuard.html @@ -1,36 +1,37 @@ -authGuard | @auth0/auth0-vue
    +authGuard | @auth0/auth0-vue
    -
    +
    -
    +

    Function authGuard

    -
      - +
        +

      • Parameters

        • -
          to: RouteLocation
        -

        Returns Promise<boolean>

    +

    Returns Promise<boolean>

    -
    +
  • Defined in src/guard.ts:86
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -39,39 +40,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/functions/createAuth0.html b/docs/functions/createAuth0.html index d6260c54..3db8bcc2 100644 --- a/docs/functions/createAuth0.html +++ b/docs/functions/createAuth0.html @@ -1,46 +1,49 @@ -createAuth0 | @auth0/auth0-vue
    +createAuth0 | @auth0/auth0-vue
    -
    +
    -
    +

    Function createAuth0

    -
    -

    Returns Auth0Plugin

    +
    +

    Returns Auth0Plugin

    An instance of Auth0Plugin

    + +
    -
    +
  • Defined in src/index.ts:28
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -49,39 +52,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/functions/createAuthGuard.html b/docs/functions/createAuthGuard.html index 0c58cc18..bf028403 100644 --- a/docs/functions/createAuthGuard.html +++ b/docs/functions/createAuthGuard.html @@ -1,72 +1,77 @@ -createAuthGuard | @auth0/auth0-vue
    +createAuthGuard | @auth0/auth0-vue
    -
    +
    -
    +

    Function createAuthGuard

    -
      - +
        +

      • Parameters

        • -
          Optional app: App<any>
          +
          Optional app: App<any>

          The vue application

          -
        -

        Returns ((to: RouteLocation) => Promise<boolean>)

        +
    +
    +

    Returns ((to) => Promise<boolean>)

    • -
        -
      • (to: RouteLocation): Promise<boolean>
        • +
          +
        • (to): Promise<boolean>

        • Parameters

          • -
            to: RouteLocation
          -

          Returns Promise<boolean>

    +

    Returns Promise<boolean>

    +
    - +
  • Defined in src/guard.ts:56
    • +

  • Parameters

    -

    Returns ((to: RouteLocation) => Promise<boolean>)

    + +
    • +

    Returns ((to) => Promise<boolean>)

    • -
        -
      • (to: RouteLocation): Promise<boolean>
        • +
          +
        • (to): Promise<boolean>

        • Parameters

          • -
            to: RouteLocation
          -

          Returns Promise<boolean>

    +

    Returns Promise<boolean>

    +
    -
    +
  • Defined in src/guard.ts:64
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -75,39 +80,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 6f3b61ff..a0d9883c 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,35 +1,36 @@ -useAuth0 | @auth0/auth0-vue
    +useAuth0 | @auth0/auth0-vue
    -
    +
    -
    +

    Function useAuth0

    -
    -
    +
  • Defined in src/index.ts:40
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -38,39 +39,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 4a0a582e..2b5941ab 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,15 +1,15 @@ -@auth0/auth0-vue
    +@auth0/auth0-vue
    -
    +
    -
    +

    @auth0/auth0-vue

    Auth0 SDK for Vue 3 Single Page Applications

    @@ -19,42 +19,22 @@

    @auth0/auth0-vue

    License CircleCI

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

    - - -

    Documentation

    -     -
      +

      Documentation

      • Quickstart - our interactive guide for quickly adding login, logout and user information to a Vue 3 app using Auth0.
      • Sample App - a full-fledged Vue 3 application integrated with Auth0.
      • FAQs - frequently asked questions about the auth0-vue SDK.
      • Examples - code samples for common Vue 3 authentication scenario's.
      • Docs site - explore our docs site and learn more about Auth0.
      - - -

      Getting started

      -       - - -

      Requirements

      -       -

      This library supports Vue 3 applications. +

      Getting started

      Requirements

      This library supports Vue 3 applications. For integrating Auth0 with a Vue 2 application, please read the Vue 2 Tutorial.

      - - -

      Installation

      -       -

      Using npm:

      -
      npm install @auth0/auth0-vue
-
      +

      Installation

      Using npm:

      +
      npm install @auth0/auth0-vue
+

      Using yarn:

      -
      yarn add @auth0/auth0-vue
-
      - - -

      Configure Auth0

      -       -

      Create a Single Page Application in the Auth0 Dashboard.

      +
      yarn add @auth0/auth0-vue
+
      +

      Configure Auth0

      Create a Single Page Application in the Auth0 Dashboard.

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

        @@ -74,36 +54,24 @@

        Configure Auth0

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

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

      - - -

      Configure the SDK

      -       -

      Create an instance of the Auth0Plugin by calling createAuth0 and pass it to Vue's app.use().

      -
      import { createAuth0 } from '@auth0/auth0-vue';

      const app = createApp(App);

      app.use(
        createAuth0({
          domain: '<AUTH0_DOMAIN>',
          clientId: '<AUTH0_CLIENT_ID>',
          authorizationParams: {
            redirect_uri: '<MY_CALLBACK_URL>'
          }
        })
      );

      app.mount('#app');
-
      - - -

      Add login to your application

      -       -

      In order to add login to your application you can use the loginWithRedirect function that is exposed on the return value of useAuth0, which you can access in your component's setup function.

      -
      <script>
        import { useAuth0 } from '@auth0/auth0-vue';

        export default {
          setup() {
            const { loginWithRedirect } = useAuth0();

            return {
              login: () => {
                loginWithRedirect();
              }
            };
          }
        };
      </script>
-
      +

      Configure the SDK

      Create an instance of the Auth0Plugin by calling createAuth0 and pass it to Vue's app.use().

      +
      import { createAuth0 } from '@auth0/auth0-vue';

      const app = createApp(App);

      app.use(
        createAuth0({
          domain: '<AUTH0_DOMAIN>',
          clientId: '<AUTH0_CLIENT_ID>',
          authorizationParams: {
            redirect_uri: '<MY_CALLBACK_URL>'
          }
        })
      );

      app.mount('#app');
+
      +

      Add login to your application

      In order to add login to your application you can use the loginWithRedirect function that is exposed on the return value of useAuth0, which you can access in your component's setup function.

      +
      <script>
        import { useAuth0 } from '@auth0/auth0-vue';

        export default {
          setup() {
            const { loginWithRedirect } = useAuth0();

            return {
              login: () => {
                loginWithRedirect();
              }
            };
          }
        };
      </script>
+

      Once setup returns the correct method, you can call that method from your component's HTML.

      -
      <template>
        <div>
          <button @click="login">Log in</button>
        </div>
      </template>
-
      +
      <template>
        <div>
          <button @click="login">Log in</button>
        </div>
      </template>
+
      Using Options API -
      <template>
        <div>
          <button @click="login">Log in</button>
        </div>
      </template>

      <script>
        export default {
          methods: {
            login() {
              this.$auth0.loginWithRedirect();
            }
          }
        };
      </script>
-
      +
      <template>
        <div>
          <button @click="login">Log in</button>
        </div>
      </template>

      <script>
        export default {
          methods: {
            login() {
              this.$auth0.loginWithRedirect();
            }
          }
        };
      </script>
+

      For more code samples on how to integrate the auth0-vue SDK in your Vue 3 application, have a look at our examples.

      - - -

      API reference

      -       -

      Explore public API's available in auth0-vue.

      +

      API reference

      Explore public API's available in auth0-vue.

      - - -

      Feedback

      -       - - -

      Contributing

      -       -

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

      +

      Feedback

      Contributing

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

      - - -

      Raise an issue

      -       -

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

      - - -

      Vulnerability Reporting

      -       -

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

      +

      Raise an issue

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

      +

      Vulnerability Reporting

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

      @@ -147,10 +99,11 @@

      Vulnerability Reporting

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

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

    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -159,39 +112,54 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    -
    -
    \ No newline at end of file +
  • Contributing
    • +
  • Raise an issue
    • +
  • Vulnerability Reporting
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index bf5005e4..052cf0aa 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,15 +1,15 @@ -AppState | @auth0/auth0-vue
    +AppState | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    • AppState
    -
    +

    Indexable

    [key: string]: any
    +
  • Defined in src/interfaces/app-state.ts:2
    • - +

    Properties

    -
    target? +
    target?

    Properties

    -
    -

    Optional target

    -
    target?: string
    +
    +

    Optional target

    +
    target?: string

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

    -
    +
    -
    +
  • Defined in src/interfaces/app-state.ts:7
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -55,17 +57,35 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • target
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/Auth0PluginOptions.html b/docs/interfaces/Auth0PluginOptions.html index ac02ad39..2eec86a6 100644 --- a/docs/interfaces/Auth0PluginOptions.html +++ b/docs/interfaces/Auth0PluginOptions.html @@ -1,15 +1,15 @@ -Auth0PluginOptions | @auth0/auth0-vue
    +Auth0PluginOptions | @auth0/auth0-vue
    -
    +
    -
    +

    Additional Configuration for the Auth0 Vue plugin

    -
    +
    +

    Hierarchy

    • Auth0PluginOptions
    +
  • Defined in src/interfaces/auth0-plugin-options.ts:4
    • - +

    Properties

    -
    errorPath? -skipRedirectCallback? +
    errorPath? +skipRedirectCallback?

    Properties

    -
    -

    Optional errorPath

    -
    errorPath?: string
    +
    +

    Optional errorPath

    +
    errorPath?: string

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

    -
    +
    -
    -

    Optional skipRedirectCallback

    -
    skipRedirectCallback?: boolean
    +
  • Defined in src/interfaces/auth0-plugin-options.ts:29
    • +
    +

    Optional skipRedirectCallback

    +
    skipRedirectCallback?: boolean

    By default, if the page URL has code and state parameters, the SDK will assume it should handle it and attempt to exchange the code for a token.

    In situations where you are combining our SDK with other libraries that use the same code and state parameters, you will need to ensure our SDK can differentiate between requests it should and should not handle.

    In these cases you can instruct the client to ignore certain URLs by setting skipRedirectCallback.

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

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

    -
    +
    -
    +
  • Defined in src/interfaces/auth0-plugin-options.ts:23
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -70,18 +74,36 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • errorPath
    • +
  • skipRedirectCallback
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/Auth0VueClient.html b/docs/interfaces/Auth0VueClient.html index cf87b677..48034528 100644 --- a/docs/interfaces/Auth0VueClient.html +++ b/docs/interfaces/Auth0VueClient.html @@ -1,15 +1,15 @@ -Auth0VueClient | @auth0/auth0-vue
    +Auth0VueClient | @auth0/auth0-vue
    -
    +
    -
    +
    - +

    Properties

    -
    error -idTokenClaims -isAuthenticated -isLoading -user +
    error +idTokenClaims +isAuthenticated +isLoading +user

    Methods

    -
    checkSession -getAccessTokenSilently -getAccessTokenWithPopup -handleRedirectCallback -loginWithPopup -loginWithRedirect -logout +
    checkSession +getAccessTokenSilently +getAccessTokenWithPopup +handleRedirectCallback +loginWithPopup +loginWithRedirect +logout

    Properties

    -
    -

    error

    -
    error: Ref<any>
    +
    +

    error

    +
    error: Ref<any>

    Contains an error that occured in the SDK

    -
    +
    -
    -

    idTokenClaims

    -
    idTokenClaims: Ref<undefined | IdToken>
    +
  • Defined in src/interfaces/auth0-vue-client.ts:43
    • +
    +

    idTokenClaims

    +
    idTokenClaims: Ref<undefined | IdToken>

    Contains all claims from the id_token if available.

    -
    +
    -
    -

    isAuthenticated

    -
    isAuthenticated: Ref<boolean>
    +
  • Defined in src/interfaces/auth0-vue-client.ts:38
    • +
    +

    isAuthenticated

    +
    isAuthenticated: Ref<boolean>

    The authentication state, true if the user is authenticated, false if not.

    -
    +
    -
    -

    isLoading

    -
    isLoading: Ref<boolean>
    +
  • Defined in src/interfaces/auth0-vue-client.ts:28
    • +
    +

    isLoading

    +
    isLoading: Ref<boolean>

    The loading state of the SDK, true if the SDK is still processing the PKCE flow, false if the SDK has finished processing the PKCE flow.

    -
    +
    -
    -

    user

    -
    user: Ref<undefined | User>
    +
  • Defined in src/interfaces/auth0-vue-client.ts:23
    • +
    +

    user

    +
    user: Ref<undefined | User>

    Contains the information of the user if available.

    -
    +
  • Defined in src/interfaces/auth0-vue-client.ts:33

    • Methods

    -
    -

    checkSession

    -
    -
    -

    getAccessTokenSilently

    -
    +
    +

    getAccessTokenSilently

    +
      +

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

      @@ -116,11 +123,13 @@

      getAccessTokenSilentlyParameters

      -

      Returns Promise<GetTokenSilentlyVerboseResponse>

    +

    Returns Promise<GetTokenSilentlyVerboseResponse>

    +
    - +
  • Defined in src/interfaces/auth0-vue-client.ts:119
    • +

  • Fetches a new access token and returns it.

    @@ -128,17 +137,19 @@

    Returns PromiseParameters

    -

    Returns Promise<string>

    • +

    Returns Promise<string>

    +
    -
    -

    getAccessTokenWithPopup

    -
    +
    +

    getAccessTokenWithPopup

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

      Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, @@ -148,16 +159,19 @@

      getAccessTokenWithPopu

      Parameters

      -

      Returns Promise<undefined | string>

    +

    Returns Promise<undefined | string>

    +
    -
    -

    handleRedirectCallback

    -
    +
    +

    handleRedirectCallback

    + +

    Returns Promise<RedirectLoginResult<AppState>>

    +
    -
    -

    loginWithPopup

    -
    +
    +

    loginWithPopup

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

      Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, @@ -193,19 +208,22 @@

      loginWithPopupParameters

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    +
    -
    -

    loginWithRedirect

    -
    +
    +

    loginWithRedirect

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

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

      @@ -214,17 +232,19 @@

      loginWithRedirectParameters

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    +
    -
    -

    logout

    -
    +
    +

    logout

    +
      +
    • -
      logout();
-
      +
      logout();
+

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

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

      @@ -238,14 +258,17 @@

      logoutParameters

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    +
    -
    +
  • Defined in src/interfaces/auth0-vue-client.ts:165
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -254,28 +277,46 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • error
    • +
  • idTokenClaims
    • +
  • isAuthenticated
    • +
  • isLoading
    • +
  • user
    • +
  • checkSession
    • +
  • getAccessTokenSilently
    • +
  • getAccessTokenWithPopup
    • +
  • handleRedirectCallback
    • +
  • loginWithPopup
    • +
  • loginWithRedirect
    • +
  • logout
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/Auth0VueClientOptions.html b/docs/interfaces/Auth0VueClientOptions.html index f5f72c19..bbb4d7be 100644 --- a/docs/interfaces/Auth0VueClientOptions.html +++ b/docs/interfaces/Auth0VueClientOptions.html @@ -1,15 +1,15 @@ -Auth0VueClientOptions | @auth0/auth0-vue
    +Auth0VueClientOptions | @auth0/auth0-vue
    -
    +
    -
    +

    Configuration for the Auth0 Vue Client

    -
    +
    +

    Hierarchy

      -
    • Auth0ClientOptions +
    • Auth0ClientOptions
      • Auth0VueClientOptions
    +
  • Defined in src/interfaces/auth0-vue-client-options.ts:12
    • - +

    Properties

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

    Properties

    -
    -

    Optional Internal auth0Client

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

    Optional Internal auth0Client

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

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

    Type declaration

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

    Optional authorizationParams

    -
    authorizationParams?: AuthorizationParams
    +
    +

    Optional authorizationParams

    +
    authorizationParams?: AuthorizationParams

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

    -
    +
    -
    -

    Optional authorizeTimeoutInSeconds

    -
    authorizeTimeoutInSeconds?: number
    +
    +

    Optional authorizeTimeoutInSeconds

    +
    authorizeTimeoutInSeconds?: number

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

    -
    -
    -

    Optional cache

    -
    cache?: ICache
    +
    +

    Optional cache

    +
    cache?: ICache

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

    -
    -
    -

    Optional cacheLocation

    -
    cacheLocation?: CacheLocation
    +
    +

    Optional cacheLocation

    +
    cacheLocation?: CacheLocation

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

    Read more about changing storage options in the Auth0 docs

    -
    -
    -

    clientId

    -
    clientId: string
    +
    +

    clientId

    +
    clientId: string

    The Client ID found on your Application settings page

    -
    -
    -

    Optional cookieDomain

    -
    cookieDomain?: string
    +
    +

    Optional cookieDomain

    +
    cookieDomain?: string

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

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

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

    -
    -
    -

    domain

    -
    domain: string
    +
    +

    domain

    +
    domain: string

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

    -
    -
    -

    Optional httpTimeoutInSeconds

    -
    httpTimeoutInSeconds?: number
    +
    +

    Optional httpTimeoutInSeconds

    +
    httpTimeoutInSeconds?: number

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

    -
    -
    -

    Optional issuer

    -
    issuer?: string
    +
    +

    Optional issuer

    +
    issuer?: string

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

    -
    -
    -

    Optional leeway

    -
    leeway?: number
    +
    +

    Optional leeway

    +
    leeway?: number

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

    -
    -
    -

    Optional legacySameSiteCookie

    -
    legacySameSiteCookie?: boolean
    +
    +

    Optional legacySameSiteCookie

    +
    legacySameSiteCookie?: boolean

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

    -
    -
    -

    Optional nowProvider

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

    Optional nowProvider

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

    Type declaration

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

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

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

          -

          Returns number | Promise<number>

    -
    -

    Optional sessionCheckExpiryDays

    -
    sessionCheckExpiryDays?: number
    +
    +

    Optional sessionCheckExpiryDays

    +
    sessionCheckExpiryDays?: number

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

    -
    -
    -

    Optional useCookiesForTransactions

    -
    useCookiesForTransactions?: boolean
    +
    +

    Optional useCookiesForTransactions

    +
    useCookiesForTransactions?: boolean

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

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

    - -

    Notes

    You might want to enable this if you rely on your users being able to authenticate using flows that +

    +
    +

    Notes

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

    -
    -

    Optional useFormData

    -
    useFormData?: boolean
    +
    +

    Optional useFormData

    +
    useFormData?: boolean

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

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

    -
    -
    -

    Optional useRefreshTokens

    -
    useRefreshTokens?: boolean
    +
    +

    Optional useRefreshTokens

    +
    useRefreshTokens?: boolean

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

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

    -
    -
    -

    Optional useRefreshTokensFallback

    -
    useRefreshTokensFallback?: boolean
    +
    +

    Optional useRefreshTokensFallback

    +
    useRefreshTokensFallback?: boolean

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

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

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

    - -

    Example

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

    Example

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

    Settings

     +

    Settings

    Member Visibility

    @@ -267,34 +287,52 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • auth0Client
    • +
  • authorizationParams
    • +
  • authorizeTimeoutInSeconds
    • +
  • cache
    • +
  • cacheLocation
    • +
  • clientId
    • +
  • cookieDomain
    • +
  • domain
    • +
  • httpTimeoutInSeconds
    • +
  • issuer
    • +
  • leeway
    • +
  • legacySameSiteCookie
    • +
  • nowProvider
    • +
  • sessionCheckExpiryDays
    • +
  • useCookiesForTransactions
    • +
  • useFormData
    • +
  • useRefreshTokens
    • +
  • useRefreshTokensFallback
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/AuthGuardOptions.html b/docs/interfaces/AuthGuardOptions.html index f7baf8d5..041daa4c 100644 --- a/docs/interfaces/AuthGuardOptions.html +++ b/docs/interfaces/AuthGuardOptions.html @@ -1,15 +1,15 @@ -AuthGuardOptions | @auth0/auth0-vue
    +AuthGuardOptions | @auth0/auth0-vue
    -
    +
    -
    +

    The options used when creating an AuthGuard.

    -
    +
    +

    Hierarchy

    • AuthGuardOptions
    +
  • Defined in src/guard.ts:40
    • - +

    Properties

    -
    app? -redirectLoginOptions? +
    app? +redirectLoginOptions?

    Properties

    -
    -

    Optional app

    -
    app?: App<any>
    +
    +

    Optional app

    +
    app?: App<any>

    The vue application

    -
    -
    -

    Optional redirectLoginOptions

    -
    redirectLoginOptions?: RedirectLoginOptions<any>
    +
  • Defined in src/guard.ts:44
    • +
    +

    Optional redirectLoginOptions

    +
    redirectLoginOptions?: RedirectLoginOptions<any>

    Route specific options to use when being redirected to Auth0

    -
    -
    +
  • Defined in src/guard.ts:49
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -62,18 +66,36 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • app
    • +
  • redirectLoginOptions
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 01042773..d18ad50c 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,15 +1,15 @@ -AuthorizationParams | @auth0/auth0-vue
    +AuthorizationParams | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    • AuthorizationParams
    -
    +

    Indexable

    [key: string]: any
    -
    -

    Optional cacheMode

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

    Optional cacheMode

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

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

    -
    -
    -

    Optional detailedResponse

    -
    detailedResponse?: boolean
    +
    +

    Optional detailedResponse

    +
    detailedResponse?: boolean

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

    The default is false.

    -
    -
    -

    Optional timeoutInSeconds

    -
    timeoutInSeconds?: number
    +
    +

    Optional timeoutInSeconds

    +
    timeoutInSeconds?: number

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

    -
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -103,20 +111,38 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • authorizationParams
    • +
  • cacheMode
    • +
  • detailedResponse
    • +
  • timeoutInSeconds
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 7ae0d906..8c6103b3 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,15 +1,15 @@ -GetTokenWithPopupOptions | @auth0/auth0-vue
    +GetTokenWithPopupOptions | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    +
    -
    -

    Optional cacheMode

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

    Optional cacheMode

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

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

    -
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -65,18 +68,36 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • authorizationParams
    • +
  • cacheMode
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index f5f380cc..691c339b 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,15 +1,15 @@ -ICache | @auth0/auth0-vue
    +ICache | @auth0/auth0-vue
    -
    +
    -
    +
    - +

    Methods

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

    Methods

    -
    -

    Optional allKeys

    -
      - +
      +

      Optional allKeys

      +
        +
      • -

        Returns MaybePromise<string[]>

      -
      -

      get

      -
        - +
        +

        get

        +
          +
        • -
          +

          Type Parameters

          -
          +

          T = Cacheable

        Parameters

        • -
          key: string
        -

        Returns MaybePromise<undefined | T>

      +

      Returns MaybePromise<undefined | T>

    -
    -

    remove

    -
      - +
      +

      remove

      +
        +

      • Parameters

        • -
          key: string
        -

        Returns MaybePromise<void>

      +

      Returns MaybePromise<void>

    -
    -

    set

    -
      - +
      +

      set

      +
        +
      • -
        +

        Type Parameters

        -
        +

        T = Cacheable

      Parameters

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

      Returns MaybePromise<void>

    +

    Returns MaybePromise<void>

    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -110,20 +111,38 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • allKeys
    • +
  • get
    • +
  • remove
    • +
  • set
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index d5da033a..fd038031 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,15 +1,15 @@ -IdToken | @auth0/auth0-vue
    +IdToken | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    • IdToken
    -
    +

    Indexable

    [key: string]: any
    - +

    Properties

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

    Properties

    -
    -

    Optional clientId

    -
    clientId?: null | string
    +
    +

    Optional clientId

    +
    clientId?: null | string

    The clientId of your application.

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

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

    Read more about how redirecting after logout works

    -
    -
    -

    Optional logoutParams

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

    Optional logoutParams

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

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

    @@ -57,16 +58,17 @@

    OptionalType declaration

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

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

      -
      • + +
    • -
      Optional returnTo?: string
      +
      Optional returnTo?: string

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

      Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the @@ -75,29 +77,46 @@

      Optional returnToreturnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

      Read more about how redirecting after logout works

      -
    -
    -

    Optional openUrl

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

    Optional openUrl

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

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

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

    +
    +
    +

    Type declaration

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

        Parameters

        +
          +
        • +
          url: string
        +

        Returns void | Promise<void>

    +
    +

    Example

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

    Example

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

    Example

    import { Browser } from '@capacitor/browser';

    await auth0.logout({
      async openUrl(url) {
        await Browser.open({ url });
      }
    });
-
    +

    Example

    import { Browser } from '@capacitor/browser';

    await auth0.logout({
      async openUrl(url) {
        await Browser.open({ url });
      }
    });
+
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -106,19 +125,37 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • clientId
    • +
  • logoutParams
    • +
  • openUrl
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 2fdf21ca..3420d5ff 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,15 +1,15 @@ -LogoutUrlOptions | @auth0/auth0-vue
    +LogoutUrlOptions | @auth0/auth0-vue
    -
    +
    -
    +
    +
    -
    -

    Optional logoutParams

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

    Optional logoutParams

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

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

    @@ -53,16 +54,17 @@

    OptionalType declaration

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

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

      -
      • + +
    • -
      Optional returnTo?: string
      +
      Optional returnTo?: string

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

      Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the @@ -71,13 +73,16 @@

      Optional returnToreturnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

      Read more about how redirecting after logout works

      -
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -86,18 +91,36 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • clientId
    • +
  • logoutParams
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index e67a8db4..ec6d715c 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,15 +1,15 @@ -PopupConfigOptions | @auth0/auth0-vue
    +PopupConfigOptions | @auth0/auth0-vue
    -
    +
    -
    +
    • @auth0/auth0-vue
      • @@ -24,36 +24,39 @@

      Hierarchy

      - +

      Properties

      -
      popup? -timeoutInSeconds? +
      popup? +timeoutInSeconds?

      Properties

      -
      -

      Optional popup

      -
      popup?: any
      +
      +

      Optional popup

      +
      popup?: any

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

      -
    +
    -
    -

    Optional timeoutInSeconds

    -
    timeoutInSeconds?: number
    +
    +

    Optional timeoutInSeconds

    +
    timeoutInSeconds?: number

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

    -
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -62,18 +65,36 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • popup
    • +
  • timeoutInSeconds
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 47abb568..b881c696 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,15 +1,15 @@ -PopupLoginOptions | @auth0/auth0-vue
    +PopupLoginOptions | @auth0/auth0-vue
    -
    +
    -
    +

    Hierarchy

    - +

    Properties

    -
    authorizationParams? +
    authorizationParams?

    Properties

    -
    -

    Optional authorizationParams

    -
    authorizationParams?: AuthorizationParams
    +
    +

    Optional authorizationParams

    +
    authorizationParams?: AuthorizationParams

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

    -
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -57,17 +59,35 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • authorizationParams
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 5c5b8351..7eece458 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,103 +1,108 @@ -RedirectLoginOptions | @auth0/auth0-vue
    +RedirectLoginOptions | @auth0/auth0-vue
    -
    +
    -
    +

    Interface RedirectLoginOptions<TAppState>

    -
    +

    Type Parameters

    -
    +

    TAppState = AppState

    Hierarchy

      -
    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect"> +
    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
      • RedirectLoginOptions
    +
  • Defined in src/interfaces/auth0-vue-client-options.ts:15
    • - +

    Properties

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

    Properties

    -
    -

    Optional appState

    -
    appState?: TAppState
    +
    +

    Optional appState

    +
    appState?: TAppState

    Used to store state before doing the redirect

    -
    +
    -
    -

    Optional authorizationParams

    -
    authorizationParams?: AuthorizationParams
    +
    +

    Optional authorizationParams

    +
    authorizationParams?: AuthorizationParams

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

    -
    -
    -

    Optional fragment

    -
    fragment?: string
    +
    +

    Optional fragment

    +
    fragment?: string

    Used to add to the URL fragment before redirecting

    -
    -
    -

    Optional openUrl

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

    Optional openUrl

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

    Type declaration

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

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

          - -

          Example

          const client = new Auth0Client({
            openUrl(url) {
              window.location.replace(url);
            }
          });
-
          - -

          Example

          import { Browser } from '@capacitor/browser';

          const client = new Auth0Client({
            async openUrl(url) {
              await Browser.open({ url });
            }
          });
-

          Parameters

          • -
            url: string
          -

          Returns void | Promise<void>

    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -106,20 +111,38 @@

    Member Visibility

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    \ No newline at end of file +
  • appState
    • +
  • authorizationParams
    • +
  • fragment
    • +
  • openUrl
    • +
    +
    +
    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index ae11aeb2..f29a2f8e 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,15 +1,15 @@ -@auth0/auth0-vue
    +@auth0/auth0-vue
    -
    +
    -
    +

    @auth0/auth0-vue

    @@ -17,48 +17,49 @@

    @auth0/auth0-vue

    Index

    Classes

    -
    InMemoryCache -LocalStorageCache -User +
    InMemoryCache +LocalStorageCache +User

    Interfaces

    -
    AppState -Auth0PluginOptions -Auth0VueClient -Auth0VueClientOptions -AuthGuardOptions -AuthorizationParams -GetTokenSilentlyOptions -GetTokenWithPopupOptions -ICache -IdToken -LogoutOptions -LogoutUrlOptions -PopupConfigOptions -PopupLoginOptions -RedirectLoginOptions +
    AppState +Auth0PluginOptions +Auth0VueClient +Auth0VueClientOptions +AuthGuardOptions +AuthorizationParams +GetTokenSilentlyOptions +GetTokenWithPopupOptions +ICache +IdToken +LogoutOptions +LogoutUrlOptions +PopupConfigOptions +PopupLoginOptions +RedirectLoginOptions

    Type Aliases

    -
    CacheLocation -Cacheable +
    CacheLocation +Cacheable

    Variables

    -
    AUTH0_INJECTION_KEY +
    AUTH0_INJECTION_KEY

    Functions

    -
    authGuard -createAuth0 -createAuthGuard -useAuth0 +
    authGuard +createAuth0 +createAuthGuard +useAuth0
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -67,39 +68,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 99ada298..82d50335 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,29 +1,31 @@ -CacheLocation | @auth0/auth0-vue
    +CacheLocation | @auth0/auth0-vue
    -
    +
    -
    +

    Type alias CacheLocation

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

    The possible locations where tokens can be stored

    -
    +
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -32,39 +34,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index 1c3c4c9b..62740757 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1,27 +1,28 @@ -Cacheable | @auth0/auth0-vue
    +Cacheable | @auth0/auth0-vue
    -
    +
    -
    +

    Type alias Cacheable

    -
    Cacheable: WrappedCacheEntry | KeyManifestEntry
    -
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -30,39 +31,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file diff --git a/docs/variables/AUTH0_INJECTION_KEY.html b/docs/variables/AUTH0_INJECTION_KEY.html index fd3af2a3..a3b4b038 100644 --- a/docs/variables/AUTH0_INJECTION_KEY.html +++ b/docs/variables/AUTH0_INJECTION_KEY.html @@ -1,31 +1,33 @@ -AUTH0_INJECTION_KEY | @auth0/auth0-vue
    +AUTH0_INJECTION_KEY | @auth0/auth0-vue
    -
    +
    -
    +

    Variable AUTH0_INJECTION_KEYConst

    -
    AUTH0_INJECTION_KEY: InjectionKey<Auth0VueClient> = ...
    +
    AUTH0_INJECTION_KEY: InjectionKey<Auth0VueClient> = ...

    Injection token used to provide the Auth0VueClient instance. Can be used to pass to inject()

    -
    inject(AUTH0_INJECTION_KEY)
-
    -
    +
    -
    +
  • Defined in src/token.ts:16
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -34,39 +36,30 @@

    Member Visibility

    • -

    Theme

    - -
    -
    \ No newline at end of file +

    Theme

    +
    +
    +
    \ No newline at end of file