From 1a77be4b2d0b8596bcfe40d6aaf1d8941c17d1cb Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Wed, 25 Mar 2026 10:50:23 +0530 Subject: [PATCH] Release v2.16.0 --- .version | 2 +- CHANGELOG.md | 9 ++ docs/assets/hierarchy.js | 2 +- docs/assets/main.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/AuthenticationError.html | 2 +- docs/classes/ConnectError.html | 2 +- docs/classes/GenericError.html | 2 +- docs/classes/MfaChallengeError.html | 2 +- docs/classes/MfaEnrollmentError.html | 2 +- docs/classes/MfaEnrollmentFactorsError.html | 2 +- docs/classes/MfaError.html | 2 +- docs/classes/MfaListAuthenticatorsError.html | 2 +- docs/classes/MfaRequiredError.html | 2 +- docs/classes/MfaVerifyError.html | 2 +- docs/classes/MissingRefreshTokenError.html | 2 +- docs/classes/OAuthError.html | 4 +- docs/classes/PopupCancelledError.html | 2 +- docs/classes/PopupOpenError.html | 2 +- docs/classes/PopupTimeoutError.html | 2 +- docs/classes/TimeoutError.html | 2 +- docs/classes/UseDpopNonceError.html | 2 +- docs/classes/User.html | 4 +- docs/enums/ResponseType.html | 4 +- docs/functions/Auth0Provider.html | 4 +- docs/functions/useAuth0.html | 2 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/hierarchy.html | 2 +- docs/interfaces/Auth0ContextInterface.html | 40 +++--- docs/interfaces/Auth0ProviderOptions.html | 129 ------------------ docs/interfaces/AuthorizationParams.html | 13 +- docs/interfaces/ClientConfiguration.html | 6 +- docs/interfaces/EnrollEmailParams.html | 2 +- docs/interfaces/EnrollOtpParams.html | 2 +- docs/interfaces/EnrollPushParams.html | 2 +- docs/interfaces/EnrollSmsParams.html | 2 +- docs/interfaces/EnrollVoiceParams.html | 2 +- docs/interfaces/GetTokenSilentlyOptions.html | 10 +- docs/interfaces/GetTokenWithPopupOptions.html | 6 +- docs/interfaces/IdToken.html | 4 +- docs/interfaces/LogoutOptions.html | 8 +- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 8 +- docs/interfaces/PopupLoginOptions.html | 4 +- .../RedirectConnectAccountOptions.html | 14 +- docs/interfaces/RedirectLoginOptions.html | 10 +- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +- docs/modules.html | 2 +- docs/types/AppState.html | 4 +- docs/types/Auth0ProviderOptions.html | 4 + .../types/Auth0ProviderWithClientOptions.html | 2 + .../types/Auth0ProviderWithConfigOptions.html | 3 + docs/types/CacheLocation.html | 2 +- docs/types/ConnectAccountRedirectResult.html | 2 +- docs/types/ConnectedAccount.html | 2 +- docs/types/TokenEndpointResponse.html | 4 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 62 files changed, 143 insertions(+), 249 deletions(-) delete mode 100644 docs/interfaces/Auth0ProviderOptions.html create mode 100644 docs/types/Auth0ProviderOptions.html create mode 100644 docs/types/Auth0ProviderWithClientOptions.html create mode 100644 docs/types/Auth0ProviderWithConfigOptions.html diff --git a/.version b/.version index 0c8f8801..1e29da15 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.15.1 \ No newline at end of file +v2.16.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 09d2f271..f4f101e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v2.16.0](https://github.com/auth0/auth0-react/tree/v2.16.0) (2026-03-25) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.15.1...v2.16.0) + +**Added** +- feat: add client prop to Auth0Provider [\#1041](https://github.com/auth0/auth0-react/pull/1041) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + +**Changed** +- chore(deps): bump @auth0/auth0-spa-js from 2.17.1 to 2.18.0 [\#1059](https://github.com/auth0/auth0-react/pull/1059) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.15.1](https://github.com/auth0/auth0-react/tree/v2.15.1) (2026-03-13) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.15.0...v2.15.1) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 2890eacb..36259c47 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlF9v2yAUxb8Lz3T1HzDYb1W6TZPSdeq67aHqA3JuYlQCHpCHqcp3n5xoEbaTQZ4s2ef6d8/lXN6RNcY71LxQVuOSElzQ+hUjC2sFrZdGO9S8o4LWw0OLLaAGfTP9rl+ajdSP/VGC0ZvUK9QUtMJoZxVqkNQe7Fq04G5n+g+d3yqEUauEc6hB3q1uhh/cnIqGj51UKwsaNS9FRV/3GBUVDbr4DP7ZvIH+JX13IKQ1c6ksoac9RiUlQQtfFqLtIAI8iq61XLJysFyyMuAtTSvUd2+s2MAYnRf8H/pAAHc7E19s4fhioNV5QHuWWzA7/9FaY/8HCnURxsgiYflgkeThqT6sxRP83kkLqyh4qo0bJIROc7wQugWlEnBn5AlElk+JqXOdiRNoNZvSHnvQaaiTMs6hRejqbuc70F62YtikKOyMPIFIQ+KDdE7qzROsLbjusM/xtFyoSWCzenTvaLCyjfJC3TVrUdY5JjnFhFBMaoZpkWNKc1xlFFeUYcazYW2qLIzyDwf3vem/Gt1CtLOZOD6CiobBWhitoY0nONTFGYxn44sg5QK4erw8qzAvC8wpx5wTXOeHcfKsGsOX0vkgqca6lHYuVMXN87KYmNfWKLUFHR/zXJ3Ao3zMW3RCKdCbeHxm4gQaJ2PaT7By/ScFFSjjnDqfRug0l0+iTT3E80Ux+n7/F31rFVU=" \ No newline at end of file +window.hierarchyData = "eJyVlE+P2yAQxb8LZ7YbY7Cxb1X6R5Wy3Wq7bQ+rPSAyidEScIEcqlW+e+WsGmE7KeRkyX7j37zhDa/IWRs8ap8YbXBJKCakecbIwUaDDMoaj9pXREgzPIzYAWrRN9vv+5XdKnPfv0kwelFmjVrCKoz2TqMWKRPAbYQEfzvTv+vCTiOMpBbeoxYFv74ZfnBzKho+dkqvHRjUPpGSPR8wIiWLuvgM4dG+gPmlQnck5DVzqSyjpwNGJaFRC1+WQnaQAL6JrrVc0nKwXNIy4q2sFPp7sE5sYYwuCP+HPhLA387EF1t4ezHQqiKiPaod2H346Jx1/wPFugRjZJHS4miRx6d6txEP8HuvHKyT4Kk2bZAWbJrjpTAStM7AnZFnEGkxJebOdSbOoFX1lHbfg8lDnZQZnCZ29X4fOjBBSTFsUhJ2Rp4mMhIT75T3ymwfYOPAd8d9TqflQk0Gmzaje8eAUzLJi3XXrEVZFbjkDNOCYVrVmDYFZqTArGa4IjWu2WJYG1bHUf7h4UNv+6/WSEh2NhOnR1CROFhLawzIdIJjXZpRs8X4Isi5AK4eb11XmC8I5oRjzijm/DjOuq7G8JXyIUqqdT6nnQtVafN8QSbmjbNa78CkxzxXZ/AIH/OWndAazDYdn5k4g8bomPYTnNr8yUFFygwOn0boNJdPQuYe4vmiFP1w+AtxOxU3" \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 64b80ab2..11d92ad6 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; } +`,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)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;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/assets/navigation.js b/docs/assets/navigation.js index 95d70afc..6c498a95 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJytmMFy0zAQht/F50DbQAvk1gltyUxKM0lbDgwHIW9iTWXJSHJpYHh3xnZsS5YlB5ljsr/+T5Ll1a6//o4UvKhoFq1BZpxJuN9nEE2iDKkkmkXA8lSe6LHXiUppNImeCIuj2ftJhCmSMppFSsaviHwFLwoEQzT6M2m8L3OVAFMEI0U4uxKCixZRjgd50iMyWWfT42hzzhhg5cDo0TD/G2AgCHb469Ew/wW7hZSL/RzhBGyAEQ4jLDlGdKO4QDtwUCxJGOl2i+YJohTYDhwbZkmCSVdMcEpTYK5nb2v+A+saYcWFPAapS8PJbtAo3yWRSnsHvUtyaIPZa/iREwGxm2gogjmPIMh276Zo8UAGkZKw3Rq2AmRyz5/Ale5cyjDuXfE0HKQ2ZnlrDiue5dkcMQyUOh9EjyhsvqXRXebcHTM+gnFPUuC5KyFYkjCSHzLe/0HCx4xnnznDrixqSYJJ/eaBfsXRO51zVvxcMAVii7B225D6r+r6t5QmdHp+0bVeCf5MYhB3WVE0SLdzRzhk3CQ2p2OjsKyO3hguyK+y2FkhgVL35Du6MGBzxxqT95B9A0ZOoa4n/dxaFQijBJiac7Ylu1yU29ePs3VhwOqav0oRoZ5dtVRjYG1N4WG1ojGoO5UNrqrRjAGtcpkMklrRGNQmlYOkRjMG9MgJhkGUpgqD3YAq64gNocAU3fuSokM7DvyFqORwcw+Tu+Iw9KLTv2igRU/fcrRtXM6x37eKhRkv+Y7nyrc/hsJ3T1XCB0GH3VpR2Kxvt+gyI1Wq7MXogjBEVVqWadi3Hls2ArfkO8IGaboqDLaGmAjA6vDt4RJjnjPvIfCOGDeJwUX3CX3nsGqaPOlNF4TNvcgVdRmX9UNMiW++tbL92FQ3l75dGRzlLSmzbKOQ0vKU2mdFdXf4vzP29MO7s/OpXswUmQx9p5ZBE+h1OK5QKiyKzz1miaT518ERDOMY1wdsDTKnykJ6tKNnAPHB10Ft4oNPJJeKp1Xb/oITxHZgnZ6Ds1MZvpq2srNL6YpqK8bSui+4zul9t/+BcA0KJyCqvN5FGMFwRtlUIqzIc9Ugf0Ispnq3W9EcsnDu7RZV5bf5Zb2iGcFwRnW6WJxx4j4SvaJwpt6wt6hnJEiRj8yG3qS8mXZt6u689dnmDJcvidm+m0YXbzWjXJad6mmfRx3zDP9Z3x9945vgEQb2BeFztNUW4ttfnHLhag==" \ No newline at end of file +window.navigationData = "eJytmcty2yAUht9F66S5tElb7zJukmYmqT12ki46XVB0bDFBoAJK43b67h1JlgTmIgd1GZ+f/wMEhwP59idR8KKSSbIAWXAm4X5TQHKQFEhlySQBVubySI+9yVROk4PkibA0mXw4SDBFUiaTRMn0kMhDeFEgGKLJ34PO+6JUGTBFMFKEs0shuOgRdXuQRw6RyTo53Y825YwBVh6MHo3zvwYGgmCPvx6N879hd5BzsZkinIENMMJxhFuOEV0qLtAaPBRLEke6W6FphigFtgbPhFmSaNIlE5zSHJjv29ua/8C6QlhxIfdB6tJ4sh80yveWSKXtweCQPNpo9gJ+lkRA6icaimjOIwiy2vgpWjySQaQkbL2AlQCZ3fMn8KU7nzKOO6u+hofUxyxvzWHOi7KYIoaBUu+HcIji+lsbzQrv7JjxEYx7kgMvfQnBksSRwpDx/g8SPhW8+MIZ9mVRSxJNcptH+lVL73jKWfXnDVMgVghrpw1pf2qOf0tpQk/Pzt1FhT4hO5adwrLau/9ckN91TTJHAuXSi9rRxQG7o9DofIAcajCyC23ZF+a2qkgYJcDUlLMVWZeinj43ztbFAZvT+DJHhAZm1VKNgfVHf4DVi8agZqoYHFWnGQOalzIbJPWiMahlLgdJnWYM6JETDIMoTRUHuwZVH/dLQoEpupkV1Wp2Iz3aceCvRGXbA3aYvCuOQ9/sXDM00I3jerG3bVr30e3bxOKMb/malyo0P4YidE41wgdBh916UVyv71booiBNqnRidEEcoqkA6zQcGo8tG4G75WvCBmm6Kg62gJQIwGr7RHCBMS9ZcBEEW4zrxOCgXcLQOmzuNoH0pgvi+l7lirqOmwteuCGmJNTfVtm/CbV3wNCsDLYKlpRFsVRIaXlKbYqqutv+vtP2+OP7k7PT3Wp3LvgzSUFYvdx6OTSv8q1G2OzgfQiW+vUs92b3sQJ73mLVmR/9oNaEdwGnw36FZWVRvWKZJaXm3wZHMIxt327IBciSKgsZ0I7uAaRbXw+1iw9+kVIqnjevES84Q2wNni/vV8aPpq+E7atHQ7UVY2m7CVHnOHPhKwhXoHAGotkTuwgjGM+o78oIK/Lc3Ps/I5ZS/RLf0DyyeO7dCjXXFfMfBg3NCMYzmtXF0oIT/5JwiuKZ+jtEj3pGglT5yHynMClvvWm091mVDNebxMycptH5O82olPXN/tjl0cYCzX+1562rfRfcw8A+UEOOttpCfP8HxJUsow==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 1d8ee25f..4637618c 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1ml1v2zYUhv8Lc6um5oft2Hdd1gEFirVYh+3CCApVomMiiqhJctoiyH8fqM9D8UihEvXOsHheviKfc0hJfCS5/l6Q/eGR3Kk0JnvKrgKShveS7Mmnd+fy9D7PdU4Ccs4TsidREhaFLN72ly5P5X1CgvYK2RPyFLRqa8o6tUinRZmfo/J5uQu7LZAOSBbmMi1td32HdMVE16P0sX7RtnpVL19jWUS5ykqlU78eBxEzemfrTde5ub661mkpf5Qf0lLmxzCSnQHV/lO8RRtOzp11k5FOUxmV76JIn9PyX1We/pKxymVUzuvsohEKa6HvqjzlvRA+CPg9jhnNZVjKP2QZnWQ+11sVe+xiF7BjI+hnwwWyLOI3qnij0pPMVSnjl9v5EZ3C9Fb+re9kOtdWE1s2sQuMzq1MZR6W8vdMZ59zrY8zLbXxcaazrIlfxJYBXRZFNUxfVCLTMvk525uBXBZFNV5FL7K4QZONn3V2zl7l0KRi1qgsY/Fap0d1e85Dqyh6e4sG4cuYMqj9qdO5RdIYMpSlTegyZj7E1QReJ6G6L+YbUnE1c1EbvoCpU5jGiWxr+3WYJN/C6G6mtVqkretRL7KAQVWY5jItVRTWlXCOM1WEg+hfUGRV8VGHsUpvZ5tLurhfYCvRt6qqFdfnotT3FXnvm5o+02klZQpGVElVFMpeaoFp7sy+pLB19hasZ52hF+57Ok/LbncSfavPL/BSBy1g4P4Yzuy9jlig6+Ll1bxYvJqfi9nbzSZkmVR3Hgo+5/pBxTL/VD1hjK8ug3YzHglOKonziW0kpnwBoiZGfWh+/KnEjMdMB13Q6w3o1HupRL3odN4q6WmruFPZ64wZhaWsQTQ/VqVngkmrwSSMULa92Y+myk6oY+28OzHVv73VDJW3W/inktmUrDwFL9rG+FwMTE7fSbMRUgbj/84ql/HE2D0bNOttwlje+vXybBI/f4dT6/yrR6Fe7nUns7BJnf4mjzqXdvAr7Or0WyUYDgUXN95m4Mj22NtvbuksbDOX5TlP/9avcFhLlHoRc2y129J1/yr1XZZ9KcOy3/WUPzNTzpu/Z7/Wk3HzYm9K8KJrHHaNR9aD1t7o8BaZTgv51fQy2eWw5Uv7G0wn3tUzE4b0MpyX6+nhHF6enCfO7P3c9aBmPoS5Cr8lgy3mpORG4FvETvN4TqOKPXtn4Ct6LqqKtEL02ku+Ut/bZQzR6q7NFXNTbULdbYx1dxMQlcbyB9k/kgeZF6Zq7gm75Jc7EpCjkklsvq7UTgIS6ft7WXER6+hc/bxpmv0jzdcO07hu/XZFgsMq4OtLthE3N8GhDa4uVH+0Gv0/VSAlwYFigdQJpFYgI8GBBXx1SddrK5A5gcwK5CQ4cKxH7gRyK1CQ4CCwQOEECitwTYLDGgtcO4FrK3BDgsMGC9w4gRsrcDs2OFsncGsFXpHgsMV6vHICr6zAHQkOV1jgzgnc2QAYHnYoAS47dABPRQ/KHUX4sQGiBguKs+cyRG2IqEGDMjTY5YjaIFGDB0UZpC5L1IaJGkQoyiF1eaI2UNRgQlEWqcsUtaGiBhWK8khdrqgNFjW4UBQt6rJFbbioQYaieFGXL2oDxgwzFCWMuYQxmzBmmGEoYcwljA1KVFWjUMIYUqVswphhhqGEMZcwZhPGDDMMJYy5hDGbMGaYYShhzCWM2YQxwwxDCWMuYcwmjFV1a4NWdZcwZhPGDDMMJYy5hDGbMGaYYShhzCWM2YRxwwxDCeMuYdwmjBtmOEoYdwnjNmHcMMNRwrhLGB8shNVKiBLGkbXQJowbZji+jrqEcZswvh6dZ+4Sxm3CuGGGo3hylzBuE8YNMxzFk7uEcZswbpjhaAHkLmHcJowbZvgWvWeXMG4TJgwzHMVTuIQJmzBREbbDehYuYcImTBhmBIqncAkTNmGCj96zcAkTg+2WGLeN7LhswoRhRqCJIVzChE2YMMwINDGES5iwCROGGYEmhnAJEzZhwjAj8E2mS5iwCROGGYGyLVzCmr+qZ4IHmZcy/lA/GxwOJMyyon5kfyRfm0cG3h21eiRiRfaPT0/9I8L+8Qk8JZhrpq/m5R/QYL0G5/4a3Qu0XkpQYGc9W6p7R2JpAkl/xax7MAVK4EbFZr5W9zKul2TAHfO74f7zBZBZAxk/Z1OnoHphoOvpznlDA0DZgfGjtYDwmxPrNF6vCHChvjpD5tgGjN22juOeN2uf1uo1gaTfbDQHroArYKqO2foL2Qf7wASARPVTsw9c9UrbXunKSwk5J9WrgSK081TDTzb1kgA16lfXRs8iAdxWQNUPOPcUEZCD+DJfOfDVGEgBXqjf3Lqnd4AcIIX6ZejYiRsgCmod9Usw57AMUAOlifolGTjdAnRArlK/HLO/rID0AjfI/SxNH2MBLkHCUb+MGx5BAWIg36hfwiFnR4AeSDbml2zt+Q9Q8EBuMb/cqkWwVRUY4n6GqiMhQAGkJvNLTV2hOqzj4K78jIx9BwOYAfK5H7HYR35wswAu5gfX4OsXMAfSiftptUqjaQXGkPuRMfhoA7ZwQEv4zWv/VQZYAiPGd81Oxq/sFiMVnMEV31MKPSEBJEGeM788PxfS2d8LsBgIP97qc0XACZBgfuuJKTauFbiZ96Or08nqIxNgEkGOcz8WWrE+MfPuMw5wCRJU+I37uDCWEHAf5zGaNwHJVCYTlUqyP9w8Pf0P5coctw=="; \ No newline at end of file +window.searchData = "eJy1mttu2zgQht+FuVVT82DH9l032wUKFNuiLXYvjKBQJToWqohaHXpAkHdfkDoNxbFKOeqdYXF+/iK/GVISH0mhvpdkf3gkX5MsJnvKtgHJwgdJ9uTdq7o6vS4KVZCA1EVK9iRKw7KU5cvh0vWpekhJ0F0he0Kegk5tTVmvFqmsrIo6qn4td2W3BdIBycNCZpXtbuiQrpjoe5Q+1q+6Vs/q5XMsy6hI8ipRmV+Po4gZvbP1pu9cX1/dqqySP6o3WSWLYxjJ3kDS/VO+RBtOzp11k5HKMhlVr6JI1Vn1b1KdPsg4KWRUzevsqhUKG6HvSXUqBiF8EPB7PGe0kGEl/5JVdJLFXG8m9tjHLmDHRtDPhgtkVcYvkvJFkp1kkVQyvtzOj+gUZvfyk/oqs7m22tiqjV1gdO5lJouwkn/mKn9fKHWcaamLj3OV5238IrY06LIszTB9TFKZVenP2d405LIszXiVg8jiBnU2vld5nT/LoU7FvFVZxuKtyo7JfV2EVlH09haNwpcxpVH7W2Vzi6Q2pCnL2tBlzLyJzQTepmHyUM43lMRm5qIufAFTpzCLU9nV9tswTb+E0deZ1hqRrq5Hg8gCBpNSN5dZlURhUwnnOEvKcBT9G4psUr5VYZxk97PNpX3cb7CVqvvE1IrbuqzUgyHvdVvTZzo1UrpgREbKUCgHqQWmuTd7SWHr7S1Yz3pDF+57ek/LbndSda/qC7w0QQsYeDiGM3tvIhboury8mpeLV/O6nL3dbEOWSXX4UPDWzO8782iBLitWg8mHACjbkf9WozyhjrXz7kSnmLnX94XKUXm7hf8jjK78K0/Bq64xTsbI5PSdtKtNorIP8r86KWQ8MXa/DJr1yKZhubyXq0FhehjO3+FUMX32KDQ1VfUyC5tU2R/yqAppBz/Drsq+GMFwLLi48S4Dz+xBvP0Wls7CNgtZ1UX2ST3DYSNRqUXMsdXuhq6H91Wv8vxjFVbD0lL9zHVBb/+e/e5Exu3bkynBq75x2Dc+szp19s4Ob5mrrJSfdS+TXY5bXtrfaDrxrn4xYUgvzry0hfdbEstiXETaTpEm0yvQVB9mz5wmMnOWVKQ3p/Ez+zUPwb79wsaz+r2dRnR8eVKbj27ndrQOfQuLJPySjvZGk5IbgY9Qr3mss8jctT0ovqJ1aar8CtHrLvlKfe+2BohWf22umFu+JtTdxlh3dwFJslj+IPtH8k0WpV6J9oRd8+sdCcgxkWmsPws0TgISqYcHabiIVVSbn3dts3+kfk2vGzetX65IcFgFXFxvN+LuLjh0weaC+aPTGP4xgZQEB4oFUieQWoGMBAcWsN31zXptBTInkFmBnAQHjvXInUBuBQoSHAQWKJxAYQWuSXBYY4FrJ3BtBW5IcNhggRsncGMF3pwbnBsn8MYK3JLgcIP1uHUCt1bgjgSHLRa4cwJ3NgCahx1KgMsOHcFj6EG5owg/NkBUY0Fx9lyGqA0R1WhQhga7HFEbJKrxoCiD1GWJ2jBRjQhFOaQuT9QGimpMKMoidZmiNlRUo0JRHqnLFbXBohoXiqJFXbaoDRfVyFAUL+ryRW3AmGaGooQxlzBmE8Y0MwwljLmEsVGJMjUKJYwhVcomjGlmGEoYcwljNmFMM8NQwphLGLMJY5oZhhLGXMKYTRjTzDCUMOYSxmzCmKlbKGHMJYzZhDHNDEMJYy5hzCaMaWYYShhzCWM2YVwzw1DCuEsYtwnjmhmOEsZdwrhNGNfMcJQw7hLGRwuhWQlRwjiyFtqEcc0M59gaw13CuE0Y18xwlDDuEsZtwrhmhq/Rnl3CuE0Y18xwlDDuEsZtwvj2/D27hHGbMK6Z4Sie3CWM24QJzQxH8RQuYcImTBjCUDyFS5iwCRPs7GgLlzBhEyY0MwJlW7iEidF2y+y3ULYFsuOyCROaGYGyLVzChE2Y0MwItHoKlzBhEyY0MwLfJ7qEtX+Znfk3WVQyftPs0A8HEuZ52byMeCSf24077x8UHglfk/3j09OwUd8/PoG9ur6m+2pfaw4a7GbQYFt/jf7V4CAlVoOU4LOl+rc/liaQ9FfM+8dDoESB1AVa/WtGMP5g7PhuvqT5gGZeFWDiW+B3daG4eR+Aie+AOPUSnzq3MwivB10/IN3XXcAlUOObRkAwX9nh/NigCBjwvusx5gyMHfebmNG5okFrM0htvJTao0HADUjfJubGX8g+ggYGHtyhn5p9NGhQAhniV1yQEz2DGkgJv3Q7dwZnkASTSf0m8+ypGYAZqITUDzT3vAuQg9j68W+fVgFSgBfqN7fuORMgB0ihfkX13NkQIAqKPvWrIs6xDqAGigj1SzJwDgPogFylfjlmf54C6QXw4H54TB+4AC5BwlG/jBsflgBiIN+oX8IhpxyAHkg25pds3UkFUPDA4DHvwVM1tsYyQBrzI80cXgAKIDWZX2oqg+q4joO78huZcx8TAWbAG/f0Zn/xA1qgbnC/utEpncsCBhKT+SXm6EMVsAeSk/sl5/AlCsjAhU80gdwvi8ozBZfBBdpv4OpSOtt0AWSEH6nN6RLgBNwc86vVOpFdK0BH+M1br5M3ZzqAKTBxzG/iOrEB+qL/JgJcwieH5wpj9ILayDxq411A8iSXaZJJsj/cPT39D0IndvA="; \ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index a0f26b3a..95a8e770 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 diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 33e0b760..afe6b2ef 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,6 +1,6 @@ ConnectError | @auth0/auth0-react
    @auth0/auth0-react
      Preparing search index...

      Class ConnectError

      Thrown when handling the redirect callback for the connect flow 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 connection error diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 5dacb583..eb7ff31a 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 diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index 823aeca5..d30b3828 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -2,7 +2,7 @@ 
        try {
          const challenge = await mfa.challenge({
            mfaToken: mfaToken,
            challengeType: 'otp',
            authenticatorId: 'otp|dev_123'
          });
        } catch (error) {
          if (error instanceof MfaChallengeError) {
            console.log(error.error); // 'too_many_attempts'
            console.log(error.error_description); // 'Rate limit exceeded'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index 5557cb5d..b858c25b 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -2,7 +2,7 @@ 
        try {
          const enrollment = await mfa.enroll({
            authenticator_types: ['otp']
          });
        } catch (error) {
          if (error instanceof MfaEnrollmentError) {
            console.log(error.error); // 'invalid_phone_number'
            console.log(error.error_description); // 'Invalid phone number format'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 6b5cc922..35067436 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -2,7 +2,7 @@ 
        try {
          const factors = await mfa.getEnrollmentFactors(mfaToken);
        } catch (error) {
          if (error instanceof MfaEnrollmentFactorsError) {
            console.log(error.error); // 'mfa_context_not_found'
            console.log(error.error_description); // 'MFA context not found...'
          }
        }
        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        error error_description message diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index 35797cd3..c953c01d 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,6 +1,6 @@ MfaError | @auth0/auth0-react
        @auth0/auth0-react
          Preparing search index...

          Class MfaError

          Base class for MFA-related errors in auth0-spa-js. Extends GenericError for unified error hierarchy across the SDK.

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          error error_description message diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index e1a6a845..ccee5473 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -2,7 +2,7 @@ 
          try {
            const authenticators = await mfa.getAuthenticators();
          } catch (error) {
            if (error instanceof MfaListAuthenticatorsError) {
              console.log(error.error); // 'access_denied'
              console.log(error.error_description); // 'Unauthorized'
            }
          }
          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          error error_description message diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index d589480a..60755ebb 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 diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index 665ce952..ab0fcb38 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -2,7 +2,7 @@ 
            try {
              const tokens = await mfa.verify({
                mfaToken: mfaToken,
                grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                otp: '123456'
              });
            } catch (error) {
              if (error instanceof MfaVerifyError) {
                console.log(error.error); // 'invalid_otp' or 'context_not_found'
                console.log(error.error_description); // Error details
              }
            }
            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            error error_description message diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 7d2401ca..d14192f7 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 diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index aa732719..e61c870f 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
                diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 9aabc1a4..970f3f2c 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 diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index 467a57c8..1ad90bd3 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,5 +1,5 @@ PopupOpenError | @auth0/auth0-react
                  @auth0/auth0-react
                    Preparing search index...

                    Class PopupOpenError

                    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 diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 8978767d..2d243a4a 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 diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index afe232b9..4534d23c 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 diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index c871dc95..c926a14b 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 diff --git a/docs/classes/User.html b/docs/classes/User.html index 3ddfa52c..9f5c711c 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,4 +1,4 @@ -User | @auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...

                            Class User

                            Indexable

                            • [key: string]: any
                            Index

                            Constructors

                            constructor +User | @auth0/auth0-react
                            @auth0/auth0-react
                              Preparing search index...

                              Class User

                              Indexable

                              • [key: string]: any
                              Index

                              Constructors

                              constructor

                              Properties

                              address? birthdate? email? @@ -19,4 +19,4 @@ updated_at? website? zoneinfo? -

                              Constructors

                              Properties

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

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              +

                              Constructors

                              Properties

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

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index c1ef09e6..ae6d48fc 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -3,6 +3,6 @@
                            • code: used for the standard login flow.
                            • connect_code: used for the connect account flow.
                              • -
                              Index

                              Enumeration Members

                              Code +
                              Index

                              Enumeration Members

                              Code ConnectCode -

                              Enumeration Members

                              Code: "code"
                              ConnectCode: "connect_code"

                              Settings

                              Member Visibility

                              On This Page

                              Enumeration Members
                              +

                              Enumeration Members

                              Code: "code"
                              ConnectCode: "connect_code"

                              Settings

                              Member Visibility

                              On This Page

                              Enumeration Members
                              diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 5d0369c1..a80bf5ef 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -1,5 +1,5 @@ -Auth0Provider | @auth0/auth0-react
                              @auth0/auth0-react
                                Preparing search index...

                                Function Auth0Provider

                                • <Auth0Provider
                                    domain={domain}
                                    clientId={clientId}
                                    authorizationParams={{ redirect_uri: window.location.origin }}>
                                    <MyApp />
                                  </Auth0Provider>
+Auth0Provider | @auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...
                                    Function Auth0Provider
                                    Settings
                                    Member Visibility
                                    
+

                                    Type Parameters

                                    Parameters

                                    Returns Element

                                  Settings

                                  Member Visibility
                                  diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 3d7063f3..58ce78f3 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 f9099fbc..691ef923 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 25f8f0c0..a704635d 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/hierarchy.html b/docs/hierarchy.html index 14669d30..8b3d4003 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...

                                    @auth0/auth0-react

                                    Hierarchy Summary

                                    Settings

                                    Member Visibility
                                    +@auth0/auth0-react
                                    @auth0/auth0-react
                                      Preparing search index...

                                      @auth0/auth0-react

                                      Hierarchy Summary

                                      Settings

                                      Member Visibility
                                      diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 3da0a917..6255b68c 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> {
                                            connectAccountWithRedirect: (
                                                options: RedirectConnectAccountOptions,
                                            ) => Promise<void>;
                                            createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                config?: FetcherConfig<TOutput>,
                                            ) => Fetcher<TOutput>;
                                            error: Error | undefined;
                                            exchangeToken: (
                                                options: CustomTokenExchangeOptions,
                                            ) => Promise<TokenEndpointResponse>;
                                            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<string | undefined>;
                                            getConfiguration: () => Readonly<ClientConfiguration>;
                                            getDpopNonce: (id?: string) => Promise<string | undefined>;
                                            getIdTokenClaims: () => Promise<IdToken | undefined>;
                                            handleRedirectCallback: (
                                                url?: string,
                                            ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
                                            isAuthenticated: boolean;
                                            isLoading: boolean;
                                            loginWithCustomTokenExchange: (
                                                options: CustomTokenExchangeOptions,
                                            ) => Promise<TokenEndpointResponse>;
                                            loginWithPopup: (
                                                options?: PopupLoginOptions,
                                                config?: PopupConfigOptions,
                                            ) => Promise<void>;
                                            loginWithRedirect: (
                                                options?: RedirectLoginOptions<AppState>,
                                            ) => Promise<void>;
                                            logout: (options?: LogoutOptions) => Promise<void>;
                                            mfa: MfaApiClient;
                                            setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                            user: TUser | undefined;
                                        }

                                        Type Parameters

                                        Hierarchy

                                        • AuthState<TUser>
                                          • Auth0ContextInterface
                                        Index

                                        Properties

                                        connectAccountWithRedirect +
                                        interface Auth0ContextInterface<TUser extends User = User> {
                                            connectAccountWithRedirect: (
                                                options: RedirectConnectAccountOptions,
                                            ) => Promise<void>;
                                            createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                config?: FetcherConfig<TOutput>,
                                            ) => Fetcher<TOutput>;
                                            error: Error | undefined;
                                            exchangeToken: (
                                                options: CustomTokenExchangeOptions,
                                            ) => Promise<TokenEndpointResponse>;
                                            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<string | undefined>;
                                            getConfiguration: () => Readonly<ClientConfiguration>;
                                            getDpopNonce: (id?: string) => Promise<string | undefined>;
                                            getIdTokenClaims: () => Promise<IdToken | undefined>;
                                            handleRedirectCallback: (
                                                url?: string,
                                            ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
                                            isAuthenticated: boolean;
                                            isLoading: boolean;
                                            loginWithCustomTokenExchange: (
                                                options: CustomTokenExchangeOptions,
                                            ) => Promise<TokenEndpointResponse>;
                                            loginWithPopup: (
                                                options?: PopupLoginOptions,
                                                config?: PopupConfigOptions,
                                            ) => Promise<void>;
                                            loginWithRedirect: (
                                                options?: RedirectLoginOptions<AppState>,
                                            ) => Promise<void>;
                                            logout: (options?: LogoutOptions) => Promise<void>;
                                            mfa: MfaApiClient;
                                            setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                            user: TUser | undefined;
                                        }

                                        Type Parameters

                                        Hierarchy

                                        • AuthState<TUser>
                                          • Auth0ContextInterface
                                        Index

                                        Properties

                                        connectAccountWithRedirect createFetcher error exchangeToken @@ -27,7 +27,7 @@ where the user can authenticate and authorize the account to be connected.

                                        If connecting the account is successful onRedirectCallback will be called with the details of the connected account.

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

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

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

                                        @@ -37,7 +37,7 @@ 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: Error | undefined
                                        exchangeToken: (
                                            options: CustomTokenExchangeOptions,
                                        ) => Promise<TokenEndpointResponse>

                                        Type Declaration

                                        error: Error | undefined
                                        exchangeToken: (
                                            options: CustomTokenExchangeOptions,
                                        ) => Promise<TokenEndpointResponse>

                                        Type Declaration

                                        Use loginWithCustomTokenExchange() instead. This method will be removed in the next major version.

                                        const tokenResponse = await exchangeToken({
                                          subject_token: 'external_token_value',
                                          subject_token_type: 'urn:acme:legacy-system-token',
                                          scope: 'openid profile email'
                                        });
@@ -51,13 +51,13 @@
 
                                        // Instead of:
                                        const tokens = await exchangeToken(options);

                                        // Use:
                                        const tokens = await loginWithCustomTokenExchange(options);
 
                                        
 
-
                                        generateDpopProof: (
                                            params: {
                                                accessToken: string;
                                                method: string;
                                                nonce?: string;
                                                url: string;
                                            },
                                        ) => Promise<string>

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

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

                                        If there's a valid token stored, return it. Otherwise, opens an @@ -76,7 +76,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<string | undefined>
                                        const token = await getTokenWithPopup(options, config);
+
                                        getAccessTokenWithPopup: (
                                            options?: GetTokenWithPopupOptions,
                                            config?: PopupConfigOptions,
                                        ) => Promise<string | undefined>
                                        const token = await getTokenWithPopup(options, config);

                                        Get an access token interactively.

                                        @@ -84,7 +84,7 @@ 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.

                                        -
                                        getConfiguration: () => Readonly<ClientConfiguration>
                                        const config = getConfiguration();
                                        // { domain: 'tenant.auth0.com', clientId: 'abc123' }
+
                                        getConfiguration: () => Readonly<ClientConfiguration>
                                        const config = getConfiguration();
                                        // { domain: 'tenant.auth0.com', clientId: 'abc123' }

                                        Returns a readonly copy of the initialization configuration @@ -94,14 +94,14 @@ 

                                        const auth0 = new Auth0Client({
                                          domain: 'tenant.auth0.com',
                                          clientId: 'abc123'
                                        });

                                        const config = auth0.getConfiguration();
                                        // { domain: 'tenant.auth0.com', clientId: 'abc123' }
                                        -
                                        getDpopNonce: (id?: string) => Promise<string | undefined>

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

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

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

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

                                            +

                                            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.

                                              @@ -109,16 +109,16 @@

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

                                        Returns all claims from the id_token if available.

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

                                        After the browser redirects back to the callback page, +

                                        handleRedirectCallback: (
                                            url?: string,
                                        ) => Promise<ConnectAccountRedirectResult | 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<ConnectAccountRedirectResult | 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<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                        isAuthenticated: boolean
                                        isLoading: boolean
                                        loginWithCustomTokenExchange: (
                                            options: CustomTokenExchangeOptions,
                                        ) => Promise<TokenEndpointResponse>
                                        await loginWithCustomTokenExchange(options);
+

                                        Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                        isAuthenticated: boolean
                                        isLoading: boolean
                                        loginWithCustomTokenExchange: (
                                            options: CustomTokenExchangeOptions,
                                        ) => Promise<TokenEndpointResponse>
                                        await loginWithCustomTokenExchange(options);

                                        Exchanges an external subject token for Auth0 tokens and logs the user in. @@ -142,7 +142,7 @@ 

                                        const options = {
                                          subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
                                          subject_token_type: 'urn:acme:legacy-system-token',
                                          scope: 'openid profile email',
                                          audience: 'https://api.example.com',
                                          organization: 'org_12345'
                                        };

                                        try {
                                          const tokenResponse = await loginWithCustomTokenExchange(options);
                                          console.log('Access token:', tokenResponse.access_token);

                                          // User is now logged in - access user info
                                          const user = await getUser();
                                          console.log('Logged in user:', user);
                                        } catch (error) {
                                          console.error('Token exchange failed:', error);
                                        }
                                        -
                                        loginWithPopup: (
                                            options?: PopupLoginOptions,
                                            config?: PopupConfigOptions,
                                        ) => Promise<void>
                                        await loginWithPopup(options, config);
+
                                        loginWithPopup: (
                                            options?: PopupLoginOptions,
                                            config?: PopupConfigOptions,
                                        ) => Promise<void>
                                        await loginWithPopup(options, config);

                                        Opens a popup with the /authorize URL using the parameters @@ -152,20 +152,20 @@

                                        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.

                                        -
                                        mfa: MfaApiClient
                                        const { mfa } = useAuth0();
                                        const authenticators = await mfa.getAuthenticators(mfaToken);
+
                                        mfa: MfaApiClient
                                        const { mfa } = useAuth0();
                                        const authenticators = await mfa.getAuthenticators(mfaToken);

                                        MFA API client for Multi-Factor Authentication operations.

                                        @@ -180,10 +180,10 @@ 
                                        const { mfa, getAccessTokenSilently } = useAuth0();

                                        try {
                                          await getAccessTokenSilently();
                                        } catch (error) {
                                          if (error.error === 'mfa_required') {
                                            // Check if enrollment is needed
                                            const factors = await mfa.getEnrollmentFactors(error.mfa_token);

                                            if (factors.length > 0) {
                                              // Enroll in OTP
                                              const enrollment = await mfa.enroll({
                                                mfaToken: error.mfa_token,
                                                factorType: 'otp'
                                              });
                                              console.log('QR Code:', enrollment.barcodeUri);
                                            }

                                            // Get authenticators and challenge
                                            const authenticators = await mfa.getAuthenticators(error.mfa_token);
                                            await mfa.challenge({
                                              mfaToken: error.mfa_token,
                                              challengeType: 'otp',
                                              authenticatorId: authenticators[0].id
                                            });

                                            // Verify with user's code
                                            const tokens = await mfa.verify({
                                              mfaToken: error.mfa_token,
                                              otp: userCode
                                            });
                                          }
                                        }
                                        -
                                        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.

                                            -

                                            It requires enabling the Auth0ClientOptions.useDpop option.

                                            +

                                            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 used for requests to Auth0. Otherwise, it will be used to @@ -192,4 +192,4 @@

                                              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: TUser | undefined

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Properties
                                        +
                                        user: TUser | undefined

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Properties
                                        diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html deleted file mode 100644 index 5aea9abd..00000000 --- a/docs/interfaces/Auth0ProviderOptions.html +++ /dev/null @@ -1,129 +0,0 @@ -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?: ClientAuthorizationParams;
                                              authorizeTimeoutInSeconds?: number;
                                              cache?: ICache;
                                              cacheLocation?: CacheLocation;
                                              children?: ReactNode;
                                              clientId: string;
                                              context?: Context<Auth0ContextInterface<TUser>>;
                                              cookieDomain?: string;
                                              domain: string;
                                              httpTimeoutInSeconds?: number;
                                              interactiveErrorHandler?: "popup";
                                              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;
                                              useMrrt?: boolean;
                                              useRefreshTokens?: boolean;
                                              useRefreshTokensFallback?: boolean;
                                              workerUrl?: string;
                                          }

                                          Type Parameters

                                          Hierarchy

                                          • Auth0ClientOptions
                                            • Auth0ProviderOptions
                                          Index

                                          Properties

                                          auth0Client? -authorizationParams? -authorizeTimeoutInSeconds? -cache? -cacheLocation? -children? -clientId -context? -cookieDomain? -domain -httpTimeoutInSeconds? -interactiveErrorHandler? -issuer? -leeway? -legacySameSiteCookie? -nowProvider? -onRedirectCallback? -sessionCheckExpiryDays? -skipRedirectCallback? -useCookiesForTransactions? -useDpop? -useFormData? -useMrrt? -useRefreshTokens? -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?: ClientAuthorizationParams

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

                                          -
                                          authorizeTimeoutInSeconds?: number

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

                                          -
                                          cache?: 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.

                                          -

                                          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.

                                          -

                                          When using multiple Auth0Providers in a single application you should do the following to ensure sessions are not -overwritten:

                                          -
                                            -
                                          • Configure a different redirect_uri for each Auth0Provider, and set skipRedirectCallback for each provider to ignore -the others redirect_uri
                                            • -
                                          • If using localstorage for both Auth0Providers, ensure that the audience and scope are different for so that the key -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 -the current domain, including the subdomain.

                                          -

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

                                          -

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

                                          -
                                          domain: string

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

                                          -
                                          httpTimeoutInSeconds?: number

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

                                          -
                                          interactiveErrorHandler?: "popup"

                                          Configures automatic handling of interactive authentication errors.

                                          -

                                          When set, the SDK intercepts mfa_required errors from getTokenSilently() -and handles them automatically instead of throwing to the caller.

                                          -
                                            -
                                          • 'popup': Opens Universal Login in a popup to complete MFA. -The original authorizationParams (audience, scope) are preserved. -On success, the token is returned. On failure, popup errors are thrown.
                                            • -
                                          -

                                          This option only affects getTokenSilently(). Other methods are not affected.

                                          -
                                          undefined (MFA errors are thrown to the caller)
-
                                          - -
                                          issuer?: string

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

                                          -
                                          leeway?: number

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

                                          -
                                          legacySameSiteCookie?: boolean

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

                                          -

                                          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. -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 -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 -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 -the user is going through the authentication flow on the authorization server.

                                          -

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

                                          -

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

                                          -
                                          useDpop?: boolean

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

                                          -

                                          The default setting is false.

                                          -
                                          useFormData?: boolean

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

                                          -

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

                                          -
                                          useMrrt?: boolean

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

                                          -
                                          useRefreshTokens?: boolean

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

                                          -

                                          Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. -Using a Custom Domain with this set to false is the most secure and recommended approach.

                                          -

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

                                          -
                                          useRefreshTokensFallback?: boolean

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

                                          -

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

                                          -

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

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

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

                                          -

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

                                          -

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 8bb8e8b6..c2d7a268 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,4 +1,4 @@ -AuthorizationParams | @auth0/auth0-react
                                          @auth0/auth0-react
                                            Preparing search index...

                                            Interface AuthorizationParams

                                            interface AuthorizationParams {
                                                acr_values?: string;
                                                audience?: string;
                                                connection?: string;
                                                display?: "popup" | "page" | "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, +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;
                                                    session_transfer_token?: 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? audience? @@ -13,12 +13,13 @@ redirect_uri? scope? screen_hint? +session_transfer_token? 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. If null, it will redirect to the Auth0 Login Page and show the Login Widget.

                                                -
                                                display?: "popup" | "page" | "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
                                                  • @@ -60,6 +61,10 @@ 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. +

                                                session_transfer_token?: string

                                                Session transfer token from a native application for Native to Web SSO. +When sessionTransferTokenQueryParamName is set, this is automatically +extracted from the specified URL query parameter if present.

                                                +

                                                https://auth0.com/docs/authenticate/single-sign-on/native-to-web

                                                +
                                                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/ClientConfiguration.html b/docs/interfaces/ClientConfiguration.html index bb09f74f..abeb92f1 100644 --- a/docs/interfaces/ClientConfiguration.html +++ b/docs/interfaces/ClientConfiguration.html @@ -1,6 +1,6 @@ ClientConfiguration | @auth0/auth0-react
                                              @auth0/auth0-react
                                                Preparing search index...

                                                Interface ClientConfiguration

                                                Configuration details exposed by the Auth0Client after initialization.

                                                -
                                                interface ClientConfiguration {
                                                    clientId: string;
                                                    domain: string;
                                                }
                                                Index

                                                Properties

                                                clientId +
                                                interface ClientConfiguration {
                                                    clientId: string;
                                                    domain: string;
                                                }
                                                Index

                                                Properties

                                                clientId domain

                                                Properties

                                                clientId: string

                                                The Auth0 client ID that was configured

                                                -
                                                domain: string

                                                The Auth0 domain that was configured

                                                -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Properties
                                                +
                                                domain: string

                                                The Auth0 domain that was configured

                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Properties
                                                diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index 69eab434..9e13ca2c 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -1,5 +1,5 @@ EnrollEmailParams | @auth0/auth0-react
                                                @auth0/auth0-react
                                                  Preparing search index...

                                                  Interface EnrollEmailParams

                                                  Email enrollment parameters

                                                  -
                                                  interface EnrollEmailParams {
                                                      email?: string;
                                                      factorType: "email";
                                                      mfaToken: string;
                                                  }

                                                  Hierarchy

                                                  • EnrollBaseParams
                                                    • EnrollEmailParams
                                                  Index

                                                  Properties

                                                  email? +
                                                  interface EnrollEmailParams {
                                                      email?: string;
                                                      factorType: "email";
                                                      mfaToken: string;
                                                  }

                                                  Hierarchy

                                                  • EnrollBaseParams
                                                    • EnrollEmailParams
                                                  Index

                                                  Properties

                                                  email? factorType mfaToken

                                                  Properties

                                                  email?: string

                                                  Email address (optional, uses user's email if not provided)

                                                  diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index ad1adf60..c3fd4831 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -1,5 +1,5 @@ EnrollOtpParams | @auth0/auth0-react
                                                  @auth0/auth0-react
                                                    Preparing search index...

                                                    Interface EnrollOtpParams

                                                    OTP (Time-based One-Time Password) enrollment parameters

                                                    -
                                                    interface EnrollOtpParams {
                                                        factorType: "otp";
                                                        mfaToken: string;
                                                    }

                                                    Hierarchy

                                                    • EnrollBaseParams
                                                      • EnrollOtpParams
                                                    Index

                                                    Properties

                                                    factorType +
                                                    interface EnrollOtpParams {
                                                        factorType: "otp";
                                                        mfaToken: string;
                                                    }

                                                    Hierarchy

                                                    • EnrollBaseParams
                                                      • EnrollOtpParams
                                                    Index

                                                    Properties

                                                    factorType mfaToken

                                                    Properties

                                                    factorType: "otp"

                                                    The factor type for enrollment

                                                    mfaToken: string

                                                    MFA token from mfa_required error

                                                    diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index 5ecad826..684c95f7 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -1,5 +1,5 @@ EnrollPushParams | @auth0/auth0-react
                                                    @auth0/auth0-react
                                                      Preparing search index...

                                                      Interface EnrollPushParams

                                                      Push notification enrollment parameters

                                                      -
                                                      interface EnrollPushParams {
                                                          factorType: "push";
                                                          mfaToken: string;
                                                      }

                                                      Hierarchy

                                                      • EnrollBaseParams
                                                        • EnrollPushParams
                                                      Index

                                                      Properties

                                                      factorType +
                                                      interface EnrollPushParams {
                                                          factorType: "push";
                                                          mfaToken: string;
                                                      }

                                                      Hierarchy

                                                      • EnrollBaseParams
                                                        • EnrollPushParams
                                                      Index

                                                      Properties

                                                      factorType mfaToken

                                                      Properties

                                                      factorType: "push"

                                                      The factor type for enrollment

                                                      mfaToken: string

                                                      MFA token from mfa_required error

                                                      diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index 8c172b20..cbe18d3f 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -1,5 +1,5 @@ EnrollSmsParams | @auth0/auth0-react
                                                      @auth0/auth0-react
                                                        Preparing search index...

                                                        Interface EnrollSmsParams

                                                        SMS enrollment parameters

                                                        -
                                                        interface EnrollSmsParams {
                                                            factorType: "sms";
                                                            mfaToken: string;
                                                            phoneNumber: string;
                                                        }

                                                        Hierarchy

                                                        • EnrollBaseParams
                                                          • EnrollSmsParams
                                                        Index

                                                        Properties

                                                        factorType +
                                                        interface EnrollSmsParams {
                                                            factorType: "sms";
                                                            mfaToken: string;
                                                            phoneNumber: string;
                                                        }

                                                        Hierarchy

                                                        • EnrollBaseParams
                                                          • EnrollSmsParams
                                                        Index

                                                        Properties

                                                        factorType mfaToken phoneNumber

                                                        Properties

                                                        factorType: "sms"

                                                        The factor type for enrollment

                                                        diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index 94dfb32a..f602feac 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -1,5 +1,5 @@ EnrollVoiceParams | @auth0/auth0-react
                                                        @auth0/auth0-react
                                                          Preparing search index...

                                                          Interface EnrollVoiceParams

                                                          Voice enrollment parameters

                                                          -
                                                          interface EnrollVoiceParams {
                                                              factorType: "voice";
                                                              mfaToken: string;
                                                              phoneNumber: string;
                                                          }

                                                          Hierarchy

                                                          • EnrollBaseParams
                                                            • EnrollVoiceParams
                                                          Index

                                                          Properties

                                                          factorType +
                                                          interface EnrollVoiceParams {
                                                              factorType: "voice";
                                                              mfaToken: string;
                                                              phoneNumber: string;
                                                          }

                                                          Hierarchy

                                                          • EnrollBaseParams
                                                            • EnrollVoiceParams
                                                          Index

                                                          Properties

                                                          factorType mfaToken phoneNumber

                                                          Properties

                                                          factorType: "voice"

                                                          The factor type for enrollment

                                                          diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index bbc065c0..e85280f0 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,4 +1,4 @@ -GetTokenSilentlyOptions | @auth0/auth0-react
                                                          @auth0/auth0-react
                                                            Preparing search index...

                                                            Interface GetTokenSilentlyOptions

                                                            interface GetTokenSilentlyOptions {
                                                                authorizationParams?: {
                                                                    audience?: string;
                                                                    redirect_uri?: string;
                                                                    scope?: string;
                                                                    [key: string]: any;
                                                                };
                                                                cacheMode?: "on"
                                                                | "off"
                                                                | "cache-only";
                                                                detailedResponse?: boolean;
                                                                timeoutInSeconds?: number;
                                                            }
                                                            Index

                                                            Properties

                                                            authorizationParams? +GetTokenSilentlyOptions | @auth0/auth0-react
                                                            @auth0/auth0-react
                                                              Preparing search index...

                                                              Interface GetTokenSilentlyOptions

                                                              interface GetTokenSilentlyOptions {
                                                                  authorizationParams?: {
                                                                      audience?: string;
                                                                      redirect_uri?: string;
                                                                      scope?: string;
                                                                      [key: string]: any;
                                                                  };
                                                                  cacheMode?: "on"
                                                                  | "off"
                                                                  | "cache-only";
                                                                  detailedResponse?: boolean;
                                                                  timeoutInSeconds?: number;
                                                              }
                                                              Index

                                                              Properties

                                                              authorizationParams? cacheMode? detailedResponse? timeoutInSeconds? @@ -13,13 +13,13 @@ 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 +

                                                              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 aec283e1..36200771 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,8 @@ -GetTokenWithPopupOptions | @auth0/auth0-react
                                                              @auth0/auth0-react
                                                                Preparing search index...

                                                                Interface GetTokenWithPopupOptions

                                                                interface GetTokenWithPopupOptions {
                                                                    authorizationParams?: AuthorizationParams;
                                                                    cacheMode?: "on" | "off" | "cache-only";
                                                                }

                                                                Hierarchy (View Summary)

                                                                Index

                                                                Properties

                                                                authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-react
                                                                @auth0/auth0-react
                                                                  Preparing search index...

                                                                  Interface GetTokenWithPopupOptions

                                                                  interface GetTokenWithPopupOptions {
                                                                      authorizationParams?: AuthorizationParams;
                                                                      cacheMode?: "on" | "off" | "cache-only";
                                                                  }

                                                                  Hierarchy (View Summary)

                                                                  Index

                                                                  Properties

                                                                  authorizationParams? 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/IdToken.html b/docs/interfaces/IdToken.html index c908197a..deea3a65 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,4 +1,4 @@ -IdToken | @auth0/auth0-react
                                                                  @auth0/auth0-react
                                                                    Preparing search index...

                                                                    Interface IdToken

                                                                    interface IdToken {
                                                                        __raw: string;
                                                                        acr?: string;
                                                                        address?: string;
                                                                        amr?: string[];
                                                                        at_hash?: string;
                                                                        aud?: string;
                                                                        auth_time?: string;
                                                                        azp?: string;
                                                                        birthdate?: string;
                                                                        c_hash?: string;
                                                                        cnf?: string;
                                                                        email?: string;
                                                                        email_verified?: boolean;
                                                                        exp?: number;
                                                                        family_name?: string;
                                                                        gender?: string;
                                                                        given_name?: string;
                                                                        iat?: number;
                                                                        iss?: string;
                                                                        jti?: string;
                                                                        locale?: string;
                                                                        middle_name?: string;
                                                                        name?: string;
                                                                        nbf?: number;
                                                                        nickname?: string;
                                                                        nonce?: string;
                                                                        org_id?: string;
                                                                        org_name?: string;
                                                                        phone_number?: string;
                                                                        phone_number_verified?: boolean;
                                                                        picture?: string;
                                                                        preferred_username?: string;
                                                                        profile?: string;
                                                                        sid?: string;
                                                                        sub_jwk?: string;
                                                                        updated_at?: string;
                                                                        website?: string;
                                                                        zoneinfo?: string;
                                                                        [key: string]: any;
                                                                    }

                                                                    Indexable

                                                                    • [key: string]: any
                                                                    Index

                                                                    Properties

                                                                    __raw +IdToken | @auth0/auth0-react
                                                                    @auth0/auth0-react
                                                                      Preparing search index...

                                                                      Interface IdToken

                                                                      interface IdToken {
                                                                          __raw: string;
                                                                          acr?: string;
                                                                          address?: string;
                                                                          amr?: string[];
                                                                          at_hash?: string;
                                                                          aud?: string;
                                                                          auth_time?: string;
                                                                          azp?: string;
                                                                          birthdate?: string;
                                                                          c_hash?: string;
                                                                          cnf?: string;
                                                                          email?: string;
                                                                          email_verified?: boolean;
                                                                          exp?: number;
                                                                          family_name?: string;
                                                                          gender?: string;
                                                                          given_name?: string;
                                                                          iat?: number;
                                                                          iss?: string;
                                                                          jti?: string;
                                                                          locale?: string;
                                                                          middle_name?: string;
                                                                          name?: string;
                                                                          nbf?: number;
                                                                          nickname?: string;
                                                                          nonce?: string;
                                                                          org_id?: string;
                                                                          org_name?: string;
                                                                          phone_number?: string;
                                                                          phone_number_verified?: boolean;
                                                                          picture?: string;
                                                                          preferred_username?: string;
                                                                          profile?: string;
                                                                          sid?: string;
                                                                          sub_jwk?: string;
                                                                          updated_at?: string;
                                                                          website?: string;
                                                                          zoneinfo?: string;
                                                                          [key: string]: any;
                                                                      }

                                                                      Indexable

                                                                      • [key: string]: any
                                                                      Index

                                                                      Properties

                                                                      __raw acr? address? amr? @@ -36,4 +36,4 @@ updated_at? website? zoneinfo? -

                                                                      Properties

                                                                      __raw

                                                                      __raw: string
                                                                      acr?: string
                                                                      address?: string
                                                                      amr?: string[]
                                                                      at_hash?: string
                                                                      aud?: string
                                                                      auth_time?: string
                                                                      azp?: string
                                                                      birthdate?: string
                                                                      c_hash?: string
                                                                      cnf?: string
                                                                      email?: string
                                                                      email_verified?: boolean
                                                                      exp?: number
                                                                      family_name?: string
                                                                      gender?: string
                                                                      given_name?: string
                                                                      iat?: number
                                                                      iss?: string
                                                                      jti?: string
                                                                      locale?: string
                                                                      middle_name?: string
                                                                      name?: string
                                                                      nbf?: number
                                                                      nickname?: string
                                                                      nonce?: string
                                                                      org_id?: string
                                                                      org_name?: string
                                                                      phone_number?: string
                                                                      phone_number_verified?: boolean
                                                                      picture?: string
                                                                      preferred_username?: string
                                                                      profile?: string
                                                                      sid?: string
                                                                      sub_jwk?: string
                                                                      updated_at?: string
                                                                      website?: string
                                                                      zoneinfo?: string

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      +

                                                                      Properties

                                                                      __raw

                                                                      __raw: string
                                                                      acr?: string
                                                                      address?: string
                                                                      amr?: string[]
                                                                      at_hash?: string
                                                                      aud?: string
                                                                      auth_time?: string
                                                                      azp?: string
                                                                      birthdate?: string
                                                                      c_hash?: string
                                                                      cnf?: string
                                                                      email?: string
                                                                      email_verified?: boolean
                                                                      exp?: number
                                                                      family_name?: string
                                                                      gender?: string
                                                                      given_name?: string
                                                                      iat?: number
                                                                      iss?: string
                                                                      jti?: string
                                                                      locale?: string
                                                                      middle_name?: string
                                                                      name?: string
                                                                      nbf?: number
                                                                      nickname?: string
                                                                      nonce?: string
                                                                      org_id?: string
                                                                      org_name?: string
                                                                      phone_number?: string
                                                                      phone_number_verified?: boolean
                                                                      picture?: string
                                                                      preferred_username?: string
                                                                      profile?: string
                                                                      sid?: string
                                                                      sub_jwk?: string
                                                                      updated_at?: string
                                                                      website?: string
                                                                      zoneinfo?: string

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Properties
                                                                      diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index d47e8e57..c2a8b3d0 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,11 +1,11 @@ -LogoutOptions | @auth0/auth0-react
                                                                      @auth0/auth0-react
                                                                        Preparing search index...

                                                                        Interface LogoutOptions

                                                                        interface LogoutOptions {
                                                                            clientId?: string | null;
                                                                            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?: string | null;
                                                                              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?: string | null

                                                                          The clientId of your application.

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

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

                                                                          Read more about how redirecting after logout works

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

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

                                                                          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, @@ -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);
                                                                            }
                                                                          });
                                                                          @@ -28,4 +28,4 @@ 
                                                                          import { Browser } from '@capacitor/browser';

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

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          +

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index f007cd11..a763c5e7 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,10 +1,10 @@ -LogoutUrlOptions | @auth0/auth0-react
                                                                          @auth0/auth0-react
                                                                            Preparing search index...

                                                                            Interface LogoutUrlOptions

                                                                            interface LogoutUrlOptions {
                                                                                clientId?: string | null;
                                                                                logoutParams?: {
                                                                                    federated?: boolean;
                                                                                    returnTo?: string;
                                                                                    [key: string]: any;
                                                                                };
                                                                            }
                                                                            Index

                                                                            Properties

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

                                                                              Interface LogoutUrlOptions

                                                                              interface LogoutUrlOptions {
                                                                                  clientId?: string | null;
                                                                                  logoutParams?: {
                                                                                      federated?: boolean;
                                                                                      returnTo?: string;
                                                                                      [key: string]: any;
                                                                                  };
                                                                              }
                                                                              Index

                                                                              Properties

                                                                              clientId? logoutParams?

                                                                              Properties

                                                                              clientId?: string | null

                                                                              The clientId of your application.

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

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

                                                                              Read more about how redirecting after logout works

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

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

                                                                              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, @@ -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 69a93874..b7c8b2f6 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,4 +1,4 @@ -PopupConfigOptions | @auth0/auth0-react
                                                                              @auth0/auth0-react
                                                                                Preparing search index...

                                                                                Interface PopupConfigOptions

                                                                                interface PopupConfigOptions {
                                                                                    closePopup?: boolean;
                                                                                    popup?: any;
                                                                                    timeoutInSeconds?: number;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                closePopup? +PopupConfigOptions | @auth0/auth0-react
                                                                                @auth0/auth0-react
                                                                                  Preparing search index...

                                                                                  Interface PopupConfigOptions

                                                                                  interface PopupConfigOptions {
                                                                                      closePopup?: boolean;
                                                                                      popup?: any;
                                                                                      timeoutInSeconds?: number;
                                                                                  }
                                                                                  Index

                                                                                  Properties

                                                                                  closePopup? popup? timeoutInSeconds?

                                                                                  Properties

                                                                                  closePopup?: boolean

                                                                                  Controls whether the SDK automatically closes the popup window.

                                                                                  @@ -16,9 +16,9 @@ 
                                                                                  true
                                                                                  -
                                                                                  popup?: any

                                                                                  Accepts an already-created popup window to use. If not specified, the SDK +

                                                                                  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 ae61822b..38620661 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? +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/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index 1ff50060..53f64978 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,4 +1,4 @@ -RedirectConnectAccountOptions | @auth0/auth0-react
                                                                                      @auth0/auth0-react
                                                                                        Preparing search index...

                                                                                        Interface RedirectConnectAccountOptions<TAppState>

                                                                                        interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                            appState?: TAppState;
                                                                                            authorization_params?: AuthorizationParams;
                                                                                            connection: string;
                                                                                            openUrl?: (url: string) => Promise<void>;
                                                                                            redirectUri?: string;
                                                                                            scopes?: string[];
                                                                                        }

                                                                                        Type Parameters

                                                                                        • TAppState = any
                                                                                        Index

                                                                                        Properties

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

                                                                                          Interface RedirectConnectAccountOptions<TAppState>

                                                                                          interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                              appState?: TAppState;
                                                                                              authorization_params?: AuthorizationParams;
                                                                                              connection: string;
                                                                                              openUrl?: (url: string) => Promise<void>;
                                                                                              redirectUri?: string;
                                                                                              scopes?: string[];
                                                                                          }

                                                                                          Type Parameters

                                                                                          • TAppState = any
                                                                                          Index

                                                                                          Properties

                                                                                          appState? authorization_params? connection openUrl? @@ -8,18 +8,18 @@ 
                                                                                          await auth0.connectAccountWithRedirect({
                                                                                            connection: 'google-oauth2',
                                                                                            appState: { returnTo: '/settings' }
                                                                                          });
                                                                                          -
                                                                                          authorization_params?: AuthorizationParams

                                                                                          Additional authorization parameters for the request.

                                                                                          +
                                                                                          authorization_params?: AuthorizationParams

                                                                                          Additional authorization parameters for the request.

                                                                                          await auth0.connectAccountWithRedirect({
                                                                                            connection: 'github',
                                                                                            authorization_params: {
                                                                                              audience: 'https://api.github.com'
                                                                                            }
                                                                                          });
                                                                                          -
                                                                                          connection: string

                                                                                          The name of the connection to link (e.g. 'google-oauth2').

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

                                                                                          Optional function to handle the redirect URL.

                                                                                          +
                                                                                          connection: string

                                                                                          The name of the connection to link (e.g. 'google-oauth2').

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

                                                                                          Optional function to handle the redirect URL.

                                                                                          await auth0.connectAccountWithRedirect({
                                                                                            connection: 'google-oauth2',
                                                                                            openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                          });
                                                                                          -
                                                                                          redirectUri?: string

                                                                                          The URI to redirect back to after connecting the account.

                                                                                          -
                                                                                          scopes?: string[]

                                                                                          Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                          +
                                                                                          redirectUri?: string

                                                                                          The URI to redirect back to after connecting the account.

                                                                                          +
                                                                                          scopes?: string[]

                                                                                          Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                          await auth0.connectAccountWithRedirect({
                                                                                            connection: 'google-oauth2',
                                                                                            scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                          });
                                                                                          -

                                                                                          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 0c373f67..7baa1188 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,16 +1,16 @@ -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);
                                                                                                }
                                                                                              });
 
                                                                                              import { Browser } from '@capacitor/browser';

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

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              +

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index ede4455c..0d5ac1ab 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 483b4fa4..c9d3ec25 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/modules.html b/docs/modules.html index caa1c8ad..71dda503 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -@auth0/auth0-react
                                                                                                  @auth0/auth0-react
                                                                                                    Preparing search index...

                                                                                                      @auth0/auth0-react

                                                                                                      Main

                                                                                                      ClientConfiguration

                                                                                                      Other

                                                                                                      ResponseType
                                                                                                      AuthenticationError
                                                                                                      ConnectError
                                                                                                      GenericError
                                                                                                      InMemoryCache
                                                                                                      LocalStorageCache
                                                                                                      MfaChallengeError
                                                                                                      MfaEnrollmentError
                                                                                                      MfaEnrollmentFactorsError
                                                                                                      MfaError
                                                                                                      MfaListAuthenticatorsError
                                                                                                      MfaRequiredError
                                                                                                      MfaVerifyError
                                                                                                      MissingRefreshTokenError
                                                                                                      OAuthError
                                                                                                      PopupCancelledError
                                                                                                      PopupOpenError
                                                                                                      PopupTimeoutError
                                                                                                      TimeoutError
                                                                                                      UseDpopNonceError
                                                                                                      User
                                                                                                      Auth0ContextInterface
                                                                                                      Auth0ProviderOptions
                                                                                                      Authenticator
                                                                                                      AuthorizationParams
                                                                                                      ChallengeAuthenticatorParams
                                                                                                      ChallengeResponse
                                                                                                      EnrollEmailParams
                                                                                                      EnrollmentFactor
                                                                                                      EnrollOtpParams
                                                                                                      EnrollPushParams
                                                                                                      EnrollSmsParams
                                                                                                      EnrollVoiceParams
                                                                                                      GetTokenSilentlyOptions
                                                                                                      GetTokenWithPopupOptions
                                                                                                      ICache
                                                                                                      IdToken
                                                                                                      LogoutOptions
                                                                                                      LogoutUrlOptions
                                                                                                      MfaApiClient
                                                                                                      PopupConfigOptions
                                                                                                      PopupLoginOptions
                                                                                                      RedirectConnectAccountOptions
                                                                                                      RedirectLoginOptions
                                                                                                      VerifyParams
                                                                                                      WithAuth0Props
                                                                                                      WithAuthenticationRequiredOptions
                                                                                                      AppState
                                                                                                      Cacheable
                                                                                                      CacheLocation
                                                                                                      ConnectAccountRedirectResult
                                                                                                      ConnectedAccount
                                                                                                      CustomTokenExchangeOptions
                                                                                                      EnrollmentResponse
                                                                                                      EnrollParams
                                                                                                      FetcherConfig
                                                                                                      InteractiveErrorHandler
                                                                                                      MfaFactorType
                                                                                                      TokenEndpointResponse
                                                                                                      Auth0Context
                                                                                                      Auth0Provider
                                                                                                      useAuth0
                                                                                                      withAuth0
                                                                                                      withAuthenticationRequired

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Main
                                                                                                      Other
                                                                                                      ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserAuth0ContextInterfaceAuth0ProviderOptionsAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentResponseEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypeTokenEndpointResponseAuth0ContextAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                                                      +@auth0/auth0-react
                                                                                                      @auth0/auth0-react
                                                                                                        Preparing search index...

                                                                                                          @auth0/auth0-react

                                                                                                          Main

                                                                                                          ClientConfiguration

                                                                                                          Other

                                                                                                          ResponseType
                                                                                                          AuthenticationError
                                                                                                          ConnectError
                                                                                                          GenericError
                                                                                                          InMemoryCache
                                                                                                          LocalStorageCache
                                                                                                          MfaChallengeError
                                                                                                          MfaEnrollmentError
                                                                                                          MfaEnrollmentFactorsError
                                                                                                          MfaError
                                                                                                          MfaListAuthenticatorsError
                                                                                                          MfaRequiredError
                                                                                                          MfaVerifyError
                                                                                                          MissingRefreshTokenError
                                                                                                          OAuthError
                                                                                                          PopupCancelledError
                                                                                                          PopupOpenError
                                                                                                          PopupTimeoutError
                                                                                                          TimeoutError
                                                                                                          UseDpopNonceError
                                                                                                          User
                                                                                                          Auth0ContextInterface
                                                                                                          Authenticator
                                                                                                          AuthorizationParams
                                                                                                          ChallengeAuthenticatorParams
                                                                                                          ChallengeResponse
                                                                                                          EnrollEmailParams
                                                                                                          EnrollmentFactor
                                                                                                          EnrollOtpParams
                                                                                                          EnrollPushParams
                                                                                                          EnrollSmsParams
                                                                                                          EnrollVoiceParams
                                                                                                          GetTokenSilentlyOptions
                                                                                                          GetTokenWithPopupOptions
                                                                                                          ICache
                                                                                                          IdToken
                                                                                                          LogoutOptions
                                                                                                          LogoutUrlOptions
                                                                                                          MfaApiClient
                                                                                                          PopupConfigOptions
                                                                                                          PopupLoginOptions
                                                                                                          RedirectConnectAccountOptions
                                                                                                          RedirectLoginOptions
                                                                                                          VerifyParams
                                                                                                          WithAuth0Props
                                                                                                          WithAuthenticationRequiredOptions
                                                                                                          AppState
                                                                                                          Auth0ProviderOptions
                                                                                                          Auth0ProviderWithClientOptions
                                                                                                          Auth0ProviderWithConfigOptions
                                                                                                          Cacheable
                                                                                                          CacheLocation
                                                                                                          ConnectAccountRedirectResult
                                                                                                          ConnectedAccount
                                                                                                          CustomTokenExchangeOptions
                                                                                                          EnrollmentResponse
                                                                                                          EnrollParams
                                                                                                          FetcherConfig
                                                                                                          InteractiveErrorHandler
                                                                                                          MfaFactorType
                                                                                                          TokenEndpointResponse
                                                                                                          Auth0Context
                                                                                                          Auth0Provider
                                                                                                          useAuth0
                                                                                                          withAuth0
                                                                                                          withAuthenticationRequired

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Main
                                                                                                          Other
                                                                                                          ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorOAuthErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentResponseEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypeTokenEndpointResponseAuth0ContextAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                                                          diff --git a/docs/types/AppState.html b/docs/types/AppState.html index feafe2f7..f9540870 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -1,6 +1,6 @@ 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 and any account that the user may have connected to.

                                                                                                            -
                                                                                                            type AppState = {
                                                                                                                connectedAccount?: ConnectedAccount;
                                                                                                                response_type?: ResponseType;
                                                                                                                returnTo?: string;
                                                                                                                [key: string]: any;
                                                                                                            }

                                                                                                            Indexable

                                                                                                            • [key: string]: any
                                                                                                            Index

                                                                                                            Properties

                                                                                                            connectedAccount? +
                                                                                                            type AppState = {
                                                                                                                connectedAccount?: ConnectedAccount;
                                                                                                                response_type?: ResponseType;
                                                                                                                returnTo?: string;
                                                                                                                [key: string]: any;
                                                                                                            }

                                                                                                            Indexable

                                                                                                            • [key: string]: any
                                                                                                            Index

                                                                                                            Properties

                                                                                                            connectedAccount? response_type? returnTo? -

                                                                                                            Properties

                                                                                                            connectedAccount?: ConnectedAccount
                                                                                                            response_type?: ResponseType
                                                                                                            returnTo?: string

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Properties
                                                                                                            +

                                                                                                            Properties

                                                                                                            connectedAccount?: ConnectedAccount
                                                                                                            response_type?: ResponseType
                                                                                                            returnTo?: string

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Properties
                                                                                                            diff --git a/docs/types/Auth0ProviderOptions.html b/docs/types/Auth0ProviderOptions.html new file mode 100644 index 00000000..621cf3dc --- /dev/null +++ b/docs/types/Auth0ProviderOptions.html @@ -0,0 +1,4 @@ +Auth0ProviderOptions | @auth0/auth0-react
                                                                                                            @auth0/auth0-react
                                                                                                              Preparing search index...

                                                                                                              Type Alias Auth0ProviderOptions<TUser>

                                                                                                              Auth0ProviderOptions:
                                                                                                                  | Auth0ProviderWithConfigOptions<TUser>
                                                                                                                  | Auth0ProviderWithClientOptions<TUser>

                                                                                                              The main configuration to instantiate the Auth0Provider.

                                                                                                              +

                                                                                                              Either provide domain and clientId (Auth0ProviderWithConfigOptions) +or a pre-configured client instance (Auth0ProviderWithClientOptions).

                                                                                                              +

                                                                                                              Type Parameters

                                                                                                              Settings

                                                                                                              Member Visibility
                                                                                                              diff --git a/docs/types/Auth0ProviderWithClientOptions.html b/docs/types/Auth0ProviderWithClientOptions.html new file mode 100644 index 00000000..6876a3db --- /dev/null +++ b/docs/types/Auth0ProviderWithClientOptions.html @@ -0,0 +1,2 @@ +Auth0ProviderWithClientOptions | @auth0/auth0-react
                                                                                                              @auth0/auth0-react
                                                                                                                Preparing search index...

                                                                                                                Type Alias Auth0ProviderWithClientOptions<TUser>

                                                                                                                Auth0ProviderWithClientOptions: Auth0ProviderBaseOptions<TUser> & {
                                                                                                                    client: Auth0Client;
                                                                                                                }

                                                                                                                Options for Auth0Provider when supplying a pre-configured Auth0Client instance.

                                                                                                                +

                                                                                                                Type Parameters

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                diff --git a/docs/types/Auth0ProviderWithConfigOptions.html b/docs/types/Auth0ProviderWithConfigOptions.html new file mode 100644 index 00000000..59c595fa --- /dev/null +++ b/docs/types/Auth0ProviderWithConfigOptions.html @@ -0,0 +1,3 @@ +Auth0ProviderWithConfigOptions | @auth0/auth0-react
                                                                                                                @auth0/auth0-react
                                                                                                                  Preparing search index...

                                                                                                                  Type Alias Auth0ProviderWithConfigOptions<TUser>

                                                                                                                  Auth0ProviderWithConfigOptions: Auth0ProviderBaseOptions<TUser> & Auth0ClientOptions & {
                                                                                                                      client?: never;
                                                                                                                  }

                                                                                                                  Options for Auth0Provider when configuring Auth0 via domain and clientId. +Use this type when building wrapper components around Auth0Provider.

                                                                                                                  +

                                                                                                                  Type Parameters

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index d8a111db..8447fbff 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/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 9b554992..bf46650b 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -7,4 +7,4 @@ 
                                                                                                                    const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                    console.log(result.appState); // Access persisted app state
                                                                                                                    console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                    console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
                                                                                                                    -

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index d45362b1..fd65c069 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,2 +1,2 @@ ConnectedAccount | @auth0/auth0-react
                                                                                                                    @auth0/auth0-react
                                                                                                                      Preparing search index...

                                                                                                                      Type Alias ConnectedAccount

                                                                                                                      ConnectedAccount: Omit<
                                                                                                                          ConnectAccountRedirectResult,
                                                                                                                          "appState"
                                                                                                                          | "response_type",
                                                                                                                      >

                                                                                                                      The account that has been connected during the connect flow.

                                                                                                                      -

                                                                                                                      Settings

                                                                                                                      Member Visibility
                                                                                                                      +

                                                                                                                      Settings

                                                                                                                      Member Visibility
                                                                                                                      diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index e82d8881..2d692890 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,7 +1,7 @@ -TokenEndpointResponse | @auth0/auth0-react
                                                                                                                      @auth0/auth0-react
                                                                                                                        Preparing search index...

                                                                                                                        Type Alias TokenEndpointResponse

                                                                                                                        type TokenEndpointResponse = {
                                                                                                                            access_token: string;
                                                                                                                            expires_in: number;
                                                                                                                            id_token: string;
                                                                                                                            refresh_token?: string;
                                                                                                                            scope?: string;
                                                                                                                            token_type: string;
                                                                                                                        }
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        access_token +TokenEndpointResponse | @auth0/auth0-react
                                                                                                                        @auth0/auth0-react
                                                                                                                          Preparing search index...

                                                                                                                          Type Alias TokenEndpointResponse

                                                                                                                          type TokenEndpointResponse = {
                                                                                                                              access_token: string;
                                                                                                                              expires_in: number;
                                                                                                                              id_token: string;
                                                                                                                              refresh_token?: string;
                                                                                                                              scope?: string;
                                                                                                                              token_type: string;
                                                                                                                          }
                                                                                                                          Index

                                                                                                                          Properties

                                                                                                                          access_token expires_in id_token refresh_token? scope? token_type -

                                                                                                                          Properties

                                                                                                                          access_token: string
                                                                                                                          expires_in: number
                                                                                                                          id_token: string
                                                                                                                          refresh_token?: string
                                                                                                                          scope?: string
                                                                                                                          token_type: string

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Properties
                                                                                                                          +

                                                                                                                          Properties

                                                                                                                          access_token: string
                                                                                                                          expires_in: number
                                                                                                                          id_token: string
                                                                                                                          refresh_token?: string
                                                                                                                          scope?: string
                                                                                                                          token_type: string

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Properties
                                                                                                                          diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 3209337b..6b23c899 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 680b91f1..c8397247 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.15.1", + "version": "2.16.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.15.1", + "version": "2.16.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.18.0" diff --git a/package.json b/package.json index 0a00b236..200cd725 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.15.1", + "version": "2.16.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",