diff --git a/.gitignore b/.gitignore index 930c9799..73decfb7 100644 --- a/.gitignore +++ b/.gitignore @@ -108,3 +108,4 @@ test-results cypress/screenshots cypress/videos +.npmrc diff --git a/.version b/.version index d80b4a81..7433fb30 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.5.0 \ No newline at end of file +v2.6.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index ed7ba15f..45b8d18a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.6.0](https://github.com/auth0/auth0-react/tree/v2.6.0) (2025-10-06) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.5.0...v2.6.0) + +**Added** +- Implement MRRT [\#906](https://github.com/auth0/auth0-react/pull/906) ([aridibag](https://github.com/aridibag)) + ## [v2.5.0](https://github.com/auth0/auth0-react/tree/v2.5.0) (2025-09-17) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.4.0...v2.5.0) diff --git a/docs/assets/main.js b/docs/assets/main.js index 19bbb7a7..64b80ab2 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,7 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(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,l],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(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,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 d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,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),c=0;c1?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 me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.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()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(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)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(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,l],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(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,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 d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,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),c=0;c1?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 me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.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()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(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)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 564dcefb..e1910df7 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,6 +1,6 @@ AuthenticationError | @auth0/auth0-react
@auth0/auth0-react
    Preparing search index...

    Class AuthenticationError

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

    -

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    appState error error_description @@ -15,4 +15,4 @@

    Constructors

    • Parameters

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

      Returns AuthenticationError

    Properties

    appState: any
    error: string
    error_description: string
    message: string
    name: string
    stack?: string
    state: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

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

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

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

      Returns GenericError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    • Parameters

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

      Returns GenericError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index a2f33d03..54de0e3e 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,5 +1,5 @@ GenericError | @auth0/auth0-react
    @auth0/auth0-react
      Preparing search index...

      Class GenericError

      Thrown when network requests to the Auth server fail.

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      error error_description message @@ -12,4 +12,4 @@

      Constructors

      • Parameters

        • error: string
        • error_description: string

        Returns GenericError

      Properties

      error: string
      error_description: string
      message: string
      name: string
      stack?: string
      prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

      Optional override for formatting stack traces

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

      stackTraceLimit: number

      Methods

      • Create .stack property on a target object

        -

        Parameters

        • targetObject: object
        • OptionalconstructorOpt: Function

        Returns void

      • Parameters

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

        Returns GenericError

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      +

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

      • Parameters

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

        Returns GenericError

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index dcdd75cb..1bd135ee 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,5 +1,5 @@ MfaRequiredError | @auth0/auth0-react
      @auth0/auth0-react
        Preparing search index...

        Class MfaRequiredError

        Error thrown when the token exchange results in a mfa_required error

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message @@ -13,4 +13,4 @@

        Constructors

        • Parameters

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

          Returns MfaRequiredError

        Properties

        error: string
        error_description: string
        message: string
        mfa_token: string
        name: string
        stack?: string
        prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

        Optional override for formatting stack traces

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

        stackTraceLimit: number

        Methods

        • Create .stack property on a target object

          -

          Parameters

          • targetObject: object
          • OptionalconstructorOpt: Function

          Returns void

        • Parameters

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

          Returns GenericError

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        +

        Parameters

        • targetObject: object
        • OptionalconstructorOpt: Function

        Returns void

        • Parameters

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

          Returns GenericError

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Methods
        diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 47599247..2ac73f73 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,5 +1,5 @@ MissingRefreshTokenError | @auth0/auth0-react
        @auth0/auth0-react
          Preparing search index...

          Class MissingRefreshTokenError

          Error thrown when there is no refresh token to use

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          audience error error_description @@ -14,4 +14,4 @@

          Constructors

          Properties

          audience: string
          error: string
          error_description: string
          message: string
          name: string
          scope: string
          stack?: string
          prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

          Optional override for formatting stack traces

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

          stackTraceLimit: number

          Methods

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          • Parameters

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

            Returns GenericError

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +

          Parameters

          • targetObject: object
          • OptionalconstructorOpt: Function

          Returns void

          • Parameters

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

            Returns GenericError

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 9e31978a..5ec6db88 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -1,7 +1,7 @@ OAuthError | @auth0/auth0-react
          @auth0/auth0-react
            Preparing search index...

            Class OAuthError

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

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

            -

            Hierarchy

            • Error
              • OAuthError
            Index

            Constructors

            constructor +

            Hierarchy

            • Error
              • OAuthError
            Index

            Constructors

            constructor

            Properties

            error error_description? message @@ -10,7 +10,7 @@ prepareStackTrace? stackTraceLimit

            Methods

            captureStackTrace -

            Constructors

            • Parameters

              • error: string
              • Optionalerror_description: string

              Returns OAuthError

            Properties

            error: string
            error_description?: string
            message: string
            name: string
            stack?: string
            prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

            Optional override for formatting stack traces

            +

            Constructors

            • Parameters

              • error: string
              • Optionalerror_description: string

              Returns OAuthError

            Properties

            error: string
            error_description?: string
            message: string
            name: string
            stack?: string
            prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

            Optional override for formatting stack traces

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

            stackTraceLimit: number

            Methods

            • Create .stack property on a target object

              -

              Parameters

              • targetObject: object
              • OptionalconstructorOpt: Function

              Returns void

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Methods
            +

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            Methods
            diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index a6df7f89..cedae710 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,5 +1,5 @@ PopupCancelledError | @auth0/auth0-react
            @auth0/auth0-react
              Preparing search index...

              Class PopupCancelledError

              Thrown when network requests to the Auth server fail.

              -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              error error_description message @@ -13,4 +13,4 @@

              Constructors

              Properties

              error: string
              error_description: string
              message: string
              name: string
              popup: Window
              stack?: string
              prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

              Optional override for formatting stack traces

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

              stackTraceLimit: number

              Methods

              • Create .stack property on a target object

                -

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              • Parameters

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

                Returns GenericError

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              +

              Parameters

              • targetObject: object
              • OptionalconstructorOpt: Function

              Returns void

              • Parameters

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

                Returns GenericError

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index fb5a68eb..7a7b072c 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,5 +1,5 @@ PopupTimeoutError | @auth0/auth0-react
              @auth0/auth0-react
                Preparing search index...

                Class PopupTimeoutError

                Error thrown when the login popup times out (if the user does not complete auth)

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                error error_description message @@ -13,4 +13,4 @@

                Constructors

                Properties

                error: string
                error_description: string
                message: string
                name: string
                popup: Window
                stack?: string
                prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                Optional override for formatting stack traces

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

                stackTraceLimit: number

                Methods

                • Create .stack property on a target object

                  -

                  Parameters

                  • targetObject: object
                  • OptionalconstructorOpt: Function

                  Returns void

                • Parameters

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

                  Returns GenericError

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Methods
                +

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

                • Parameters

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

                  Returns GenericError

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Methods
                diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 39ba0ae0..3ff9df6b 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,6 +1,6 @@ TimeoutError | @auth0/auth0-react
                @auth0/auth0-react
                  Preparing search index...

                  Class TimeoutError

                  Thrown when silent auth times out (usually due to a configuration issue) or when network requests to the Auth server timeout.

                  -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor +

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor

                  Properties

                  error error_description message @@ -13,4 +13,4 @@

                  Constructors

                  Properties

                  error: string
                  error_description: string
                  message: string
                  name: string
                  stack?: string
                  prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                  Optional override for formatting stack traces

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

                  stackTraceLimit: number

                  Methods

                  • Create .stack property on a target object

                    -

                    Parameters

                    • targetObject: object
                    • OptionalconstructorOpt: Function

                    Returns void

                  • Parameters

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

                    Returns GenericError

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  +

                  Parameters

                  • targetObject: object
                  • OptionalconstructorOpt: Function

                  Returns void

                  • Parameters

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

                    Returns GenericError

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index f61f0552..4f3183f2 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,5 +1,5 @@ UseDpopNonceError | @auth0/auth0-react
                  @auth0/auth0-react
                    Preparing search index...

                    Class UseDpopNonceError

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

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    error error_description message @@ -13,4 +13,4 @@

                    Constructors

                    Properties

                    error: string
                    error_description: string
                    message: string
                    name: string
                    newDpopNonce: undefined | string
                    stack?: string
                    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

                    Optional override for formatting stack traces

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

                    stackTraceLimit: number

                    Methods

                    • Create .stack property on a target object

                      -

                      Parameters

                      • targetObject: object
                      • OptionalconstructorOpt: Function

                      Returns void

                    • Parameters

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

                      Returns GenericError

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Methods
                    +

                    Parameters

                    • targetObject: object
                    • OptionalconstructorOpt: Function

                    Returns void

                    • Parameters

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

                      Returns GenericError

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Methods
                    diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 2fe95db0..38bea866 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -2,4 +2,4 @@

                    Provides the Auth0Context to its child components.

                    -

                    Type Parameters

                    Parameters

                    Returns Element

                    Settings

                    Member Visibility
                    +

                    Type Parameters

                    Parameters

                    Returns Element

                    Settings

                    Member Visibility
                    diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 191855f9..3f485e64 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -3,4 +3,4 @@

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

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

                    -

                    Type Parameters

                    Parameters

                    Returns Auth0ContextInterface<TUser>

                    Settings

                    Member Visibility
                    +

                    Type Parameters

                    Parameters

                    Returns Auth0ContextInterface<TUser>

                    Settings

                    Member Visibility
                    diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index 16cabf62..7af2d52e 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -4,4 +4,4 @@

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

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

                    -

                    Type Parameters

                    Parameters

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

                    Settings

                    Member Visibility
                    +

                    Type Parameters

                    Parameters

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

                    Settings

                    Member Visibility
                    diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index 885c8f90..49bb86f8 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -3,4 +3,4 @@

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

                    -

                    Type Parameters

                    • P extends object

                    Parameters

                    Returns FC<P>

                    Settings

                    Member Visibility
                    +

                    Type Parameters

                    • P extends object

                    Parameters

                    Returns FC<P>

                    Settings

                    Member Visibility
                    diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index a9547c79..5a6a8754 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,5 +1,5 @@ Auth0ContextInterface | @auth0/auth0-react
                    @auth0/auth0-react
                      Preparing search index...

                      Interface Auth0ContextInterface<TUser>

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

                      -
                      interface Auth0ContextInterface<TUser extends User = User> {
                          createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                              config?: FetcherConfig<TOutput>,
                          ) => Fetcher<TOutput>;
                          error: undefined | Error;
                          generateDpopProof: (
                              params: {
                                  accessToken: string;
                                  method: string;
                                  nonce?: string;
                                  url: string;
                              },
                          ) => Promise<string>;
                          getAccessTokenSilently: {
                              (
                                  options: GetTokenSilentlyOptions & { detailedResponse: true },
                              ): Promise<GetTokenSilentlyVerboseResponse>;
                              (options?: GetTokenSilentlyOptions): Promise<string>;
                              (
                                  options: GetTokenSilentlyOptions,
                              ): Promise<string | GetTokenSilentlyVerboseResponse>;
                          };
                          getAccessTokenWithPopup: (
                              options?: GetTokenWithPopupOptions,
                              config?: PopupConfigOptions,
                          ) => Promise<undefined | string>;
                          getDpopNonce: (id?: string) => Promise<undefined | string>;
                          getIdTokenClaims: () => Promise<undefined | IdToken>;
                          handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>;
                          isAuthenticated: boolean;
                          isLoading: boolean;
                          loginWithPopup: (
                              options?: PopupLoginOptions,
                              config?: PopupConfigOptions,
                          ) => Promise<void>;
                          loginWithRedirect: (
                              options?: RedirectLoginOptions<AppState>,
                          ) => Promise<void>;
                          logout: (options?: LogoutOptions) => Promise<void>;
                          setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                          user: undefined | TUser;
                      }

                      Type Parameters

                      Hierarchy

                      • AuthState<TUser>
                        • Auth0ContextInterface
                      Index

                      Properties

                      createFetcher +
                      interface Auth0ContextInterface<TUser extends User = User> {
                          createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                              config?: FetcherConfig<TOutput>,
                          ) => Fetcher<TOutput>;
                          error: undefined | Error;
                          generateDpopProof: (
                              params: {
                                  accessToken: string;
                                  method: string;
                                  nonce?: string;
                                  url: string;
                              },
                          ) => Promise<string>;
                          getAccessTokenSilently: {
                              (
                                  options: GetTokenSilentlyOptions & { detailedResponse: true },
                              ): Promise<GetTokenSilentlyVerboseResponse>;
                              (options?: GetTokenSilentlyOptions): Promise<string>;
                              (
                                  options: GetTokenSilentlyOptions,
                              ): Promise<string | GetTokenSilentlyVerboseResponse>;
                          };
                          getAccessTokenWithPopup: (
                              options?: GetTokenWithPopupOptions,
                              config?: PopupConfigOptions,
                          ) => Promise<undefined | string>;
                          getDpopNonce: (id?: string) => Promise<undefined | string>;
                          getIdTokenClaims: () => Promise<undefined | IdToken>;
                          handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult<any>>;
                          isAuthenticated: boolean;
                          isLoading: boolean;
                          loginWithPopup: (
                              options?: PopupLoginOptions,
                              config?: PopupConfigOptions,
                          ) => Promise<void>;
                          loginWithRedirect: (
                              options?: RedirectLoginOptions<AppState>,
                          ) => Promise<void>;
                          logout: (options?: LogoutOptions) => Promise<void>;
                          setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                          user: undefined | TUser;
                      }

                      Type Parameters

                      Hierarchy

                      • AuthState<TUser>
                        • Auth0ContextInterface
                      Index

                      Properties

                      createFetcher error generateDpopProof getAccessTokenSilently @@ -19,18 +19,18 @@ handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

                      Check the EXAMPLES.md file for a deeper look into this method.

                      -

                      Type declaration

                        • <TOutput extends CustomFetchMinimalOutput = Response>(
                              config?: FetcherConfig<TOutput>,
                          ): Fetcher<TOutput>

                        • Returns a new Fetcher class that will contain a fetchWithAuth() method. +

                          Type Declaration

                            • <TOutput extends CustomFetchMinimalOutput = Response>(
                                  config?: FetcherConfig<TOutput>,
                              ): Fetcher<TOutput>

                            • Returns a new Fetcher class that will contain a fetchWithAuth() method. This is a drop-in replacement for the Fetch API's fetch() method, but will handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

                              Check the EXAMPLES.md file for a deeper look into this method.

                              -

                              Type Parameters

                              • TOutput extends CustomFetchMinimalOutput = Response

                              Parameters

                              Returns Fetcher<TOutput>

                      error: undefined | Error
                      generateDpopProof: (
                          params: {
                              accessToken: string;
                              method: string;
                              nonce?: string;
                              url: string;
                          },
                      ) => Promise<string>

                      Returns a string to be used to demonstrate possession of the private +

                      Type Parameters

                      • TOutput extends CustomFetchMinimalOutput = Response

                      Parameters

                      Returns Fetcher<TOutput>

                      error: undefined | Error
                      generateDpopProof: (
                          params: {
                              accessToken: string;
                              method: string;
                              nonce?: string;
                              url: string;
                          },
                      ) => Promise<string>

                      Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                      It requires enabling the Auth0ClientOptions.useDpop option.

                      -

                      Type declaration

                        • (
                              params: {
                                  accessToken: string;
                                  method: string;
                                  nonce?: string;
                                  url: string;
                              },
                          ): Promise<string>

                        • Returns a string to be used to demonstrate possession of the private +

                          Type Declaration

                            • (
                                  params: {
                                      accessToken: string;
                                      method: string;
                                      nonce?: string;
                                      url: string;
                                  },
                              ): Promise<string>

                            • Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              -

                              Parameters

                              • params: { accessToken: string; method: string; nonce?: string; url: string }

                              Returns Promise<string>

                      getAccessTokenSilently: {
                          (
                              options: GetTokenSilentlyOptions & { detailedResponse: true },
                          ): Promise<GetTokenSilentlyVerboseResponse>;
                          (options?: GetTokenSilentlyOptions): Promise<string>;
                          (
                              options: GetTokenSilentlyOptions,
                          ): Promise<string | GetTokenSilentlyVerboseResponse>;
                      }
                      const token = await getAccessTokenSilently(options);
+

                      Parameters

                      • params: { accessToken: string; method: string; nonce?: string; url: string }

                      Returns Promise<string>

                      getAccessTokenSilently: {
                          (
                              options: GetTokenSilentlyOptions & { detailedResponse: true },
                          ): Promise<GetTokenSilentlyVerboseResponse>;
                          (options?: GetTokenSilentlyOptions): Promise<string>;
                          (
                              options: GetTokenSilentlyOptions,
                          ): Promise<string | GetTokenSilentlyVerboseResponse>;
                      }
                      const token = await getAccessTokenSilently(options);

                      If there's a valid token stored, return it. Otherwise, opens an @@ -49,7 +49,7 @@ back to using an iframe to make the token exchange.

                      Note that in all cases, falling back to an iframe requires access to the auth0 cookie.

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

                      Get an access token interactively.

                      @@ -57,31 +57,31 @@ provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

                      -
                      getDpopNonce: (id?: string) => Promise<undefined | string>

                      Returns the current DPoP nonce used for making requests to Auth0.

                      +
                      getDpopNonce: (id?: string) => Promise<undefined | string>

                      Returns the current DPoP nonce used for making requests to Auth0.

                      It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                      It requires enabling the Auth0ClientOptions.useDpop option.

                      -

                      Type declaration

                        • (id?: string): Promise<undefined | string>

                        • Returns the current DPoP nonce used for making requests to Auth0.

                          +

                          Type Declaration

                            • (id?: string): Promise<undefined | string>

                            • Returns the current DPoP nonce used for making requests to Auth0.

                              It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              Parameters

                              • Optionalid: string

                                The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                -

                              Returns Promise<undefined | string>

                          The nonce value.

                          +

                      Returns Promise<undefined | string>

                      The nonce value.

                      The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

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

                      Returns all claims from the id_token if available.

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

                      After the browser redirects back to the callback page, +

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

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

                      -

                      Type declaration

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

                        • Parameters

                          • Optionalurl: string

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

                            -

                          Returns Promise<RedirectLoginResult<any>>

                      isAuthenticated: boolean
                      isLoading: boolean
                      loginWithPopup: (
                          options?: PopupLoginOptions,
                          config?: PopupConfigOptions,
                      ) => Promise<void>
                      await loginWithPopup(options, config);
+

                      Type Declaration

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

                        • Parameters

                          • Optionalurl: string

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

                            +

                          Returns Promise<RedirectLoginResult<any>>

                      isAuthenticated: boolean
                      isLoading: boolean
                      loginWithPopup: (
                          options?: PopupLoginOptions,
                          config?: PopupConfigOptions,
                      ) => Promise<void>
                      await loginWithPopup(options, config);

                      Opens a popup with the /authorize URL using the parameters @@ -91,29 +91,29 @@

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

                      -
                      loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                      await loginWithRedirect(options);
+
                      loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                      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.

                      -
                      logout: (options?: LogoutOptions) => Promise<void>
                      auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+
                      logout: (options?: LogoutOptions) => Promise<void>
                      auth0.logout({ logoutParams: { returnTo: window.location.origin } });

                      Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session. If the logoutParams.federated option is specified, it also clears the Identity Provider session. Read more about how Logout works at Auth0.

                      -
                      setDpopNonce: (nonce: string, id?: string) => Promise<void>

                      Sets the current DPoP nonce used for making requests to Auth0.

                      +
                      setDpopNonce: (nonce: string, id?: string) => Promise<void>

                      Sets the current DPoP nonce used for making requests to Auth0.

                      It requires enabling the Auth0ClientOptions.useDpop option.

                      -

                      Type declaration

                        • (nonce: string, id?: string): Promise<void>

                        • Sets the current DPoP nonce used for making requests to Auth0.

                          +

                          Type Declaration

                            • (nonce: string, id?: string): Promise<void>

                            • Sets the current DPoP nonce used for making requests to Auth0.

                              It requires enabling the Auth0ClientOptions.useDpop option.

                              Parameters

                              • nonce: string

                                The nonce value.

                                -
                              • Optionalid: string

                                The identifier of a nonce: if absent, it will set the nonce +

                              • Optionalid: string

                                The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                -

                              Returns Promise<void>

                          The nonce value.

                          +

                      Returns Promise<void>

                      The nonce value.

                      The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                      -
                      user: undefined | TUser

                      Settings

                      Member Visibility

                      On This Page

                      Properties
                      +
                      user: undefined | TUser

                      Settings

                      Member Visibility

                      On This Page

                      Properties
                      diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html index 50a221a2..8351ab7b 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -1,5 +1,5 @@ Auth0ProviderOptions | @auth0/auth0-react
                      @auth0/auth0-react
                        Preparing search index...

                        Interface Auth0ProviderOptions<TUser>

                        The main configuration to instantiate the Auth0Provider.

                        -
                        interface Auth0ProviderOptions<TUser extends User = User> {
                            auth0Client?: {
                                env?: { [key: string]: string };
                                name: string;
                                version: string;
                            };
                            authorizationParams?: AuthorizationParams;
                            authorizeTimeoutInSeconds?: number;
                            cache?: ICache;
                            cacheLocation?: CacheLocation;
                            children?: ReactNode;
                            clientId: string;
                            context?: Context<Auth0ContextInterface<TUser>>;
                            cookieDomain?: string;
                            domain: string;
                            httpTimeoutInSeconds?: number;
                            issuer?: string;
                            leeway?: number;
                            legacySameSiteCookie?: boolean;
                            nowProvider?: () => number | Promise<number>;
                            onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                            sessionCheckExpiryDays?: number;
                            skipRedirectCallback?: boolean;
                            useCookiesForTransactions?: boolean;
                            useDpop?: boolean;
                            useFormData?: boolean;
                            useRefreshTokens?: boolean;
                            useRefreshTokensFallback?: boolean;
                            workerUrl?: string;
                        }

                        Type Parameters

                        Hierarchy

                        • Auth0ClientOptions
                          • Auth0ProviderOptions
                        Index

                        Properties

                        auth0Client? +
                        interface Auth0ProviderOptions<TUser extends User = User> {
                            auth0Client?: {
                                env?: { [key: string]: string };
                                name: string;
                                version: string;
                            };
                            authorizationParams?: AuthorizationParams;
                            authorizeTimeoutInSeconds?: number;
                            cache?: ICache;
                            cacheLocation?: CacheLocation;
                            children?: ReactNode;
                            clientId: string;
                            context?: Context<Auth0ContextInterface<TUser>>;
                            cookieDomain?: string;
                            domain: string;
                            httpTimeoutInSeconds?: number;
                            issuer?: string;
                            leeway?: number;
                            legacySameSiteCookie?: boolean;
                            nowProvider?: () => number | Promise<number>;
                            onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
                            sessionCheckExpiryDays?: number;
                            skipRedirectCallback?: boolean;
                            useCookiesForTransactions?: boolean;
                            useDpop?: boolean;
                            useFormData?: boolean;
                            useRefreshTokens?: boolean;
                            useRefreshTokensFallback?: boolean;
                            workerUrl?: string;
                        }

                        Type Parameters

                        Hierarchy

                        • Auth0ClientOptions
                          • Auth0ProviderOptions
                        Index

                        Properties

                        auth0Client? authorizationParams? authorizeTimeoutInSeconds? cache? @@ -24,17 +24,17 @@ useRefreshTokensFallback? workerUrl?

                        Properties

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

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

                        -
                        authorizationParams?: AuthorizationParams

                        URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                        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.

                        -
                        authorizeTimeoutInSeconds?: number

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

                        authorizeTimeoutInSeconds?: number

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

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

                        -
                        cacheLocation?: CacheLocation

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

                        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.

                        +
                        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

                        -
                        children?: ReactNode

                        The child nodes your Provider has wrapped

                        -
                        clientId: string

                        The Client ID found on your Application settings page

                        -
                        context?: Context<Auth0ContextInterface<TUser>>

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

                        +
                        children?: ReactNode

                        The child nodes your Provider has wrapped

                        +
                        clientId: string

                        The Client ID found on your Application settings page

                        +
                        context?: Context<Auth0ContextInterface<TUser>>

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

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

                        @@ -47,40 +47,40 @@ used to store data is different

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

                        -
                        cookieDomain?: string

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

                        cookieDomain?: string

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

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

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

                        -
                        domain: string

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

                        domain: string

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

                        -
                        httpTimeoutInSeconds?: number

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

                        -
                        issuer?: string

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

                        -
                        leeway?: number

                        The value in seconds used to account for clock skew in JWT expirations. +

                        httpTimeoutInSeconds?: number

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

                        +
                        issuer?: string

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

                        +
                        leeway?: number

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

                        -
                        legacySameSiteCookie?: boolean

                        Sets an additional cookie with no SameSite attribute to support legacy browsers +

                        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

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

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

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

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

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

                        -
                        onRedirectCallback?: (appState?: AppState, user?: TUser) => void

                        By default this removes the code and state parameters from the url when you are redirected from the authorize page. +

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

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

                        -
                        sessionCheckExpiryDays?: number

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

                        sessionCheckExpiryDays?: number

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

                        -
                        skipRedirectCallback?: boolean

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

                        skipRedirectCallback?: boolean

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

                        <Auth0Provider
                          clientId={clientId}
                          domain={domain}
                          skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
                        >
                        -
                        useCookiesForTransactions?: boolean

                        If true, the SDK will use a cookie when storing information about the auth transaction while +

                        useCookiesForTransactions?: boolean

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

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

                        You might want to enable this if you rely on your users being able to authenticate using flows that @@ -89,13 +89,13 @@ will be used to cryptographically bind tokens to this specific browser so they can't be used from a different device in case of a leak.

                        The default setting is false.

                        -
                        useFormData?: boolean

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

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

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

                        useRefreshTokens?: boolean

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

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

                        -
                        useRefreshTokensFallback?: boolean

                        If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +

                        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). @@ -109,4 +109,4 @@ at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

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

                        -

                        Settings

                        Member Visibility

                        On This Page

                        Properties
                        +

                        Settings

                        Member Visibility

                        On This Page

                        Properties
                        diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 9e852fb2..28270848 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,6 +1,6 @@ AuthorizationParams | @auth0/auth0-react
                        @auth0/auth0-react
                          Preparing search index...

                          Interface AuthorizationParams

                          interface AuthorizationParams {
                              acr_values?: string;
                              audience?: string;
                              connection?: string;
                              display?: "page" | "popup" | "touch" | "wap";
                              id_token_hint?: string;
                              invitation?: string;
                              login_hint?: string;
                              max_age?: string | number;
                              organization?: string;
                              prompt?: "none" | "login" | "consent" | "select_account";
                              redirect_uri?: string;
                              scope?: string;
                              screen_hint?: string;
                              ui_locales?: string;
                              [key: string]: any;
                          }

                          Indexable

                          • [key: string]: any

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

                            -
                          Index

                          Properties

                          acr_values? +
                          Index

                          Properties

                          acr_values? audience? connection? display? @@ -15,25 +15,25 @@ screen_hint? ui_locales?

                          Properties

                          acr_values?: string
                          audience?: string

                          The default audience to be used for requesting API access.

                          -
                          connection?: string

                          The name of the connection configured for your application. +

                          connection?: string

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

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

                          Previously issued ID Token.

                          -
                          invitation?: string

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

                          -
                          login_hint?: string

                          The user's email address or other identifier. When your app knows +

                          id_token_hint?: string

                          Previously issued ID Token.

                          +
                          invitation?: string

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

                          +
                          login_hint?: string

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

                          This currently only affects the classic Lock experience.

                          -
                          max_age?: string | number

                          Maximum allowable elapsed time (in seconds) since authentication. +

                          max_age?: string | number

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

                          -
                          organization?: string

                          The organization to log in to.

                          +
                          organization?: string

                          The organization to log in to.

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

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

                          The default URL where Auth0 will redirect your browser to with +

                          redirect_uri?: string

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

                          -
                          scope?: string

                          The default scope to be used on authentication requests.

                          +
                          scope?: string

                          The default scope to be used on authentication requests.

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

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

                          -
                          screen_hint?: string

                          Provides a hint to Auth0 as to what flow should be displayed. +

                          screen_hint?: string

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

                          This only affects the New Universal Login Experience.

                          -
                          ui_locales?: string

                          The space-separated list of language tags, ordered by preference. +

                          ui_locales?: string

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

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 64eeff87..f144b6b8 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -3,23 +3,23 @@ detailedResponse? timeoutInSeconds?

                          Properties

                          authorizationParams?: {
                              audience?: string;
                              redirect_uri?: string;
                              scope?: string;
                              [key: string]: any;
                          }

                          Parameters that will be sent back to Auth0 as part of a request.

                          -

                          Type declaration

                          • [key: string]: any

                            If you need to send custom parameters to the Authorization Server, +

                            Type Declaration

                            • [key: string]: any

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

                              -
                            • Optionalaudience?: string

                              The audience that was used in the authentication request

                              -
                            • Optionalredirect_uri?: string

                              There's no actual redirect when getting a token silently, +

                            • Optionalaudience?: string

                              The audience that was used in the authentication request

                              +
                            • Optionalredirect_uri?: string

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

                              -
                            • Optionalscope?: string

                              The scope that was used in the authentication request

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

                          When off, ignores the cache and always sends a +

                        • Optionalscope?: string

                          The scope that was used in the authentication request

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

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

                          -
                          detailedResponse?: boolean

                          If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +

                          detailedResponse?: boolean

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

                          The default is false.

                          -
                          timeoutInSeconds?: number

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

                          timeoutInSeconds?: number

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

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 5c651601..d9e67880 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -2,7 +2,7 @@ cacheMode?

                          Properties

                          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.

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

                          When off, ignores the cache and always sends a request to Auth0. +

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

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

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          +

                          Settings

                          Member Visibility

                          On This Page

                          Properties
                          diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index fcc029e7..b868b768 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,5 @@ -ICache | @auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...

                            Interface ICache

                            interface ICache {
                                allKeys(): MaybePromise<string[]>;
                                get<T = Cacheable>(key: string): MaybePromise<undefined | T>;
                                remove(key: string): MaybePromise<void>;
                                set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                            }

                            Implemented by

                            Index

                            Methods

                            allKeys? +ICache | @auth0/auth0-react
                            @auth0/auth0-react
                              Preparing search index...

                              Interface ICache

                              interface ICache {
                                  allKeys?(): MaybePromise<string[]>;
                                  get<T = Cacheable>(key: string): MaybePromise<undefined | T>;
                                  remove(key: string): MaybePromise<void>;
                                  set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                              }

                              Implemented by

                              Index

                              Methods

                              allKeys? get remove set -

                              Methods

                              • Returns MaybePromise<string[]>

                              • Type Parameters

                                Parameters

                                • key: string

                                Returns MaybePromise<undefined | T>

                              • Parameters

                                • key: string

                                Returns MaybePromise<void>

                              • Type Parameters

                                Parameters

                                • key: string
                                • entry: T

                                Returns MaybePromise<void>

                              Settings

                              Member Visibility

                              On This Page

                              Methods
                              +

                              Methods

                              • Returns MaybePromise<string[]>

                              • Type Parameters

                                Parameters

                                • key: string

                                Returns MaybePromise<undefined | T>

                              • Parameters

                                • key: string

                                Returns MaybePromise<void>

                              • Type Parameters

                                Parameters

                                • key: string
                                • entry: T

                                Returns MaybePromise<void>

                              Settings

                              Member Visibility

                              On This Page

                              Methods
                              diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 73cfe7be..4baced9c 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,18 +1,18 @@ -LogoutOptions | @auth0/auth0-react
                              @auth0/auth0-react
                                Preparing search index...

                                Interface LogoutOptions

                                interface LogoutOptions {
                                    clientId?: null | string;
                                    logoutParams?: {
                                        federated?: boolean;
                                        returnTo?: string;
                                        [key: string]: any;
                                    };
                                    openUrl?: false
                                    | ((url: string) => void | Promise<void>);
                                }

                                Hierarchy

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

                                Properties

                                clientId? +LogoutOptions | @auth0/auth0-react
                                @auth0/auth0-react
                                  Preparing search index...

                                  Interface LogoutOptions

                                  interface LogoutOptions {
                                      clientId?: null | string;
                                      logoutParams?: {
                                          federated?: boolean;
                                          returnTo?: string;
                                          [key: string]: any;
                                      };
                                      openUrl?: false
                                      | ((url: string) => void | Promise<void>);
                                  }

                                  Hierarchy

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

                                  Properties

                                  clientId? logoutParams? openUrl?

                                  Properties

                                  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

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

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

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

                                  -

                                  Type declaration

                                  • [key: string]: any

                                    If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                    -
                                  • Optionalfederated?: boolean

                                    When supported by the upstream identity provider, +

                                    Type Declaration

                                    • [key: string]: any

                                      If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                      +
                                    • Optionalfederated?: boolean

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

                                      -
                                    • OptionalreturnTo?: string

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

                                      +
                                    • OptionalreturnTo?: string

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

                                      Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Auth0 dashboard. @@ -20,7 +20,7 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                      Read more about how redirecting after logout works

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

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

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

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

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

                                  await auth0.logout({
                                    openUrl(url) {
                                      window.location.replace(url);
                                    }
                                  });
                                  diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index f5181c56..39026df6 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -4,14 +4,14 @@

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

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

                                  Read more about how redirecting after logout works

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

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

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

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

                                  -

                                  Type declaration

                                  • [key: string]: any

                                    If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                    -
                                  • Optionalfederated?: boolean

                                    When supported by the upstream identity provider, +

                                    Type Declaration

                                    • [key: string]: any

                                      If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                      +
                                    • Optionalfederated?: boolean

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

                                      -
                                    • OptionalreturnTo?: string

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

                                      +
                                    • OptionalreturnTo?: string

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

                                      Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Auth0 dashboard. @@ -19,4 +19,4 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                      Read more about how redirecting after logout works

                                      -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 28d208cc..8ef191bb 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -3,6 +3,6 @@

                                  Properties

                                  popup?: any

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

                                  -
                                  timeoutInSeconds?: number

                                  The number of seconds to wait for a popup response before +

                                  timeoutInSeconds?: number

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

                                  -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Properties
                                  diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 942c0782..56730be5 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,4 @@ PopupLoginOptions | @auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...

                                    Interface PopupLoginOptions

                                    interface PopupLoginOptions {
                                        authorizationParams?: AuthorizationParams;
                                    }

                                    Hierarchy (View Summary)

                                    Index

                                    Properties

                                    authorizationParams?

                                    Properties

                                    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

                                    Member Visibility

                                    On This Page

                                    Properties
                                    +

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Properties
                                    diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index ed6ca603..a7410a91 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,12 +1,12 @@ -RedirectLoginOptions | @auth0/auth0-react
                                    @auth0/auth0-react
                                      Preparing search index...

                                      Interface RedirectLoginOptions<TAppState>

                                      interface RedirectLoginOptions<TAppState = AppState> {
                                          appState?: TAppState;
                                          authorizationParams?: AuthorizationParams;
                                          fragment?: string;
                                          openUrl?: (url: string) => void | Promise<void>;
                                      }

                                      Type Parameters

                                      Hierarchy

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

                                      Properties

                                      appState? +RedirectLoginOptions | @auth0/auth0-react
                                      @auth0/auth0-react
                                        Preparing search index...

                                        Interface RedirectLoginOptions<TAppState>

                                        interface RedirectLoginOptions<TAppState = AppState> {
                                            appState?: TAppState;
                                            authorizationParams?: AuthorizationParams;
                                            fragment?: string;
                                            openUrl?: (url: string) => void | Promise<void>;
                                        }

                                        Type Parameters

                                        Hierarchy

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

                                        Properties

                                        appState? authorizationParams? fragment? openUrl?

                                        Properties

                                        appState?: TAppState

                                        Used to store state before doing the redirect

                                        -
                                        authorizationParams?: AuthorizationParams

                                        URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                                        authorizationParams?: AuthorizationParams

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

                                        -
                                        fragment?: string

                                        Used to add to the URL fragment before redirecting

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

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

                                        +
                                        fragment?: string

                                        Used to add to the URL fragment before redirecting

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

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

                                        const client = new Auth0Client({
                                          openUrl(url) {
                                            window.location.replace(url);
                                          }
                                        });
                                        diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 6d19b90d..4ce06979 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -1,3 +1,3 @@ WithAuth0Props | @auth0/auth0-react
                                        @auth0/auth0-react
                                          Preparing search index...

                                          Interface WithAuth0Props

                                          Components wrapped in withAuth0 will have an additional auth0 prop

                                          -
                                          interface WithAuth0Props {
                                              auth0: Auth0ContextInterface;
                                          }
                                          Index

                                          Properties

                                          auth0 -

                                          Properties

                                          auth0: Auth0ContextInterface

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          +
                                          interface WithAuth0Props {
                                              auth0: Auth0ContextInterface;
                                          }
                                          Index

                                          Properties

                                          auth0 +

                                          Properties

                                          auth0: Auth0ContextInterface

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 886555c4..8c8371c1 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -1,5 +1,5 @@ WithAuthenticationRequiredOptions | @auth0/auth0-react
                                          @auth0/auth0-react
                                            Preparing search index...

                                            Interface WithAuthenticationRequiredOptions

                                            Options for the withAuthenticationRequired Higher Order Component

                                            -
                                            interface WithAuthenticationRequiredOptions {
                                                context?: Context<Auth0ContextInterface<User>>;
                                                loginOptions?: RedirectLoginOptions<AppState>;
                                                onBeforeAuthentication?: () => Promise<void>;
                                                onRedirecting?: () => Element;
                                                returnTo?: string | (() => string);
                                            }
                                            Index

                                            Properties

                                            context? +
                                            interface WithAuthenticationRequiredOptions {
                                                context?: Context<Auth0ContextInterface<User>>;
                                                loginOptions?: RedirectLoginOptions<AppState>;
                                                onBeforeAuthentication?: () => Promise<void>;
                                                onRedirecting?: () => Element;
                                                returnTo?: string | (() => string);
                                            }
                                            Index

                                            Properties

                                            context? loginOptions? onBeforeAuthentication? onRedirecting? @@ -7,20 +7,20 @@

                                            Properties

                                            context?: Context<Auth0ContextInterface<User>>

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

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

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

                                            -
                                            onBeforeAuthentication?: () => Promise<void>
                                            withAuthenticationRequired(Profile, {
                                              onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                            })
+
                                            onBeforeAuthentication?: () => Promise<void>
                                            withAuthenticationRequired(Profile, {
                                              onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                            })

                                            Allows executing logic before the user is redirected to the login page.

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

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

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

                                            or

                                            @@ -28,4 +28,4 @@

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

                                            -

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Properties
                                            +

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Properties
                                            diff --git a/docs/types/AppState.html b/docs/types/AppState.html index 29512f1d..02d22179 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -1,3 +1,3 @@ AppState | @auth0/auth0-react
                                            @auth0/auth0-react
                                              Preparing search index...

                                              Type Alias AppState

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

                                              -
                                              type AppState = {
                                                  returnTo?: string;
                                                  [key: string]: any;
                                              }

                                              Indexable

                                              • [key: string]: any
                                              Index

                                              Properties

                                              returnTo? -

                                              Properties

                                              returnTo?: string

                                              Settings

                                              Member Visibility

                                              On This Page

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

                                              Indexable

                                              • [key: string]: any
                                              Index

                                              Properties

                                              returnTo? +

                                              Properties

                                              returnTo?: string

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 08b27564..831a198d 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,2 +1,2 @@ CacheLocation | @auth0/auth0-react
                                              @auth0/auth0-react
                                                Preparing search index...

                                                Type Alias CacheLocation

                                                CacheLocation: "memory" | "localstorage"

                                                The possible locations where tokens can be stored

                                                -

                                                Settings

                                                Member Visibility
                                                +

                                                Settings

                                                Member Visibility
                                                diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 9407eeb1..6d089a50 100644 --- a/docs/variables/Auth0Context.html +++ b/docs/variables/Auth0Context.html @@ -1,2 +1,2 @@ Auth0Context | @auth0/auth0-react
                                                @auth0/auth0-react
                                                  Preparing search index...

                                                  Variable Auth0ContextConst

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

                                                  The Auth0 Context

                                                  -

                                                  Settings

                                                  Member Visibility
                                                  +

                                                  Settings

                                                  Member Visibility
                                                  diff --git a/package-lock.json b/package-lock.json index 0a897a2a..5bbeb1b8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.5.0", + "version": "2.6.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.5.0", + "version": "2.6.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.5.0" diff --git a/package.json b/package.json index 52220b29..c9a5d32b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.5.0", + "version": "2.6.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",